Compare commits

..
33 Commits
Author SHA1 Message Date
Corfirean b90b377fc3 Merge pull request #17 from Corfirean/codex/reliable-server-updates
Recover failed updates and validate release database schemas
2026-10-05 02:38:57 +05:00
Дмитрий a02130f587 Prepare Manager 0.6.2 release 2026-10-05 02:31:56 +05:00
Дмитрий f4e36f21eb Merge remote-tracking branch 'origin/master' into codex/reliable-server-updates 2026-10-05 02:31:00 +05:00
Дмитрий 65c9945626 Validate release databases and require full schema contracts 2026-10-05 01:56:36 +05:00
Corfirean f13398bbd7 Merge pull request #13 from lostmind84/feat/linux-b2-container-db
feat: database access through the container for Docker installations
2026-10-05 01:45:07 +05:00
Дмитрий e8367354ef Record update stages and migration results for support diagnosis 2026-10-05 00:14:15 +05:00
Дмитрий 461fa035d0 Validate race-class starts and protect existing character visibility 2026-10-04 23:58:51 +05:00
Дмитрий 3edc600f97 Recover database and file updates together after failures 2026-10-04 23:55:15 +05:00
Дмитрий c3d87e1ff2 Keep bot settings release note within changelog limit 2026-10-04 20:40:54 +05:00
Дмитрий d2496603e7 Configure both bot systems exclusively in the shared Bots tab 2026-10-04 20:40:36 +05:00
Дмитрий 2eea0e117c Add translated module settings and exclusive SQUID Playerbots controls 2026-10-04 20:26:39 +05:00
Дмитрий 2e3fb24e1a Run release socket tests without parallel timing contention 2026-10-04 15:43:50 +05:00
Дмитрий 146b1c50b9 Release Manager 0.6.1 and preserve Docker lifecycle compatibility 2026-10-04 15:43:29 +05:00
Дмитрий c02c635463 Fix settings input, client launch, server repair and simultaneous realms 2026-10-04 15:40:06 +05:00
Fabien F. 58b5ddeb07 feat: database access through the container for Docker installations
Db runs mysql, mysqldump and mysqladmin inside the database container with
docker exec -i when the server folder is a Docker installation, connecting over
TCP on the container's loopback like the repack's commands do on the host. The
password still travels only in MYSQL_PWD. Every caller keeps using Db unchanged
(accounts, backups, population, migrations, the RA service account), and the
host needs no MySQL client. The repack path is untouched: one line before its
tools are looked up. A stopped container or a missing one is reported as a
database that is not running.

Tested: 4 new tests (commands built for the container, no password on a command
line, repack unchanged, error classification), and a real run against the
Docker folder: SQL queries, a quick backup (156 characters tables), restore with
the previous database kept, a damaged backup refused, the RA service account
created by SQL, the world server console reached through its published
loopback port, an account created through it and listed by the Manager.
2026-10-03 21:21:26 +02:00
Дмитрий 162bfd1e04 Release Manager 0.6.0 with Chinese localization, realm sync and Linux preview 2026-10-03 22:50:01 +05:00
Дмитрий 85963b0bf0 Merge branch 'review/pr11' into release/0.6.0 2026-10-03 22:45:53 +05:00
Дмитрий 79d293e120 Merge branch 'review/pr5' into release/0.6.0
# Conflicts:
#	src-tauri/src/lib.rs
2026-10-03 22:45:53 +05:00
Дмитрий 46ba3fa3dc Merge branch 'review/pr9' into release/0.6.0 2026-10-03 22:45:37 +05:00
Дмитрий beb3b03010 Merge branch 'review/pr4' into release/0.6.0 2026-10-03 22:45:37 +05:00
Fabien F. 3da9628b79 feat: Docker runtime backend for Linux (start, stop, status)
A server folder with Settings/docker.json is a Docker installation: MySQL, the
auth server and the world server run in containers controlled through the
docker command line. Every other folder is a repack and goes through the
unchanged Windows code. driver::run, process::observe and layout::scan check
for the marker first and hand over to coa_core::docker.

- start: network, runtime image (libraries only, binaries are mounted from
  Core/), database healthy, world listening, then auth. A container that stops
  while starting reports the cause found in its log (DatabaseNotRunning,
  PortInUse, ...). New error code DockerUnavailable (docker missing, stopped,
  or not usable by this user).
- stop: world (180 s to save), auth, database; exit code 0 observed.
- observe: container state, health and port readiness mapped to the existing
  ServiceState. Readiness is a connection that stays open, because Docker's
  proxy accepts connections before the server inside listens.
- passwords go by environment, never on a command line; the remote console is
  published on 127.0.0.1 only; the server's own database updater is turned off
  (it needs a mysql client the image does not have and stops the server).

Tested: 18 new tests with an in-memory Docker, and a real run through
examples/drive: database, world (ready in 11 s) and auth started from a
package-shaped folder, stopped with exit code 0 and restarted.
Not included: installation, database setup, backups and SQL through the
container, updates, firewall/exposure, the client under Wine/Proton.
2026-10-03 12:44:20 +02:00
Corfirean 1bcef5f8c2 Add CoA / Wildcard realm profiles for v0.5.0 (#10)
* Add isolated Wildcard realm profiles and release v0.5.0

* Document realm validation and align npm lock version
2026-10-03 11:12:04 +05:00
Дмитрий e7113f3ceb Test the content-scaling master switch against the bundled catalog 2026-10-03 07:24:21 +05:00
CorfireanandClaude Sonnet 5.5 831685dbd7 Changelog fragments (changelog.d) and the shared rules for people and AIs
Rules and format: https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 07:05:52 +05:00
CorfireanandClaude Sonnet 5.5 50b48e8af5 Changelog fragments (changelog.d) and the shared rules for people and AIs
Rules and format: https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 07:05:07 +05:00
Дмитрий c0c414f5a8 fix(report): open GitHub reports with the system URL opener (#8) 2026-10-03 06:22:49 +05:00
CorfireanandClaude Sonnet 5.5 5c21ef106d fix(config): an imported server gets the module config files it lacks at start and after an update
A server without a module's active file (an old repack updated by the Manager) made two modules log a
'missing property' line on every world tick.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 05:39:12 +05:00
CorfireanandClaude Sonnet 5.5 375be1b2c5 fix(nav): a module's page is hidden when the module is not on the server at all
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-03 05:18:14 +05:00
CorfireanandClaude Sonnet 5.5 1181b920d3 fix(modules): announced (Soon) modules stay greyed out, with no 'always on' note or settings
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 22:54:25 +05:00
CorfireanandClaude Sonnet 5.5 42dbdeae1f feat(client): updating the game client shows a progress bar on its button, no window over the app
A choice about files the owner changed appears in place below the buttons. First-time client setup keeps its dialog.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 22:49:36 +05:00
CorfireanandClaude Sonnet 5.5 dffb4811aa fix(update): add the new module config keys before the update's check start
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 21:45:56 +05:00
Fabien F. e889e0a789 feat: the Manager starts and finds its folders on Linux
- main: set WEBKIT_DISABLE_DMABUF_RENDERER=1 on Linux unless the user did.
  WebKitGTK's DMA-BUF renderer ended the process at startup with a Wayland
  "Protocol error" (seen with an NVIDIA card on Wayland).
- data_dir: use $XDG_DATA_HOME (absolute only) or ~/.local/share on Linux
  instead of the temp folder. Windows keeps %LOCALAPPDATA%.
- open_link: xdg-open on Linux, explorer.exe on Windows as before.
- tailscale_exe: look in the usual Linux locations.

Every Windows branch is the previous code unchanged.
2026-10-02 18:40:07 +02:00
Fabien F. d638bf3304 fix: snapshot ids, file modes and path case on Linux
- config snapshots: two snapshots of the same scope in the same millisecond
  shared one folder. A restore snapshots the current state just before reading
  the snapshot it restores, so on a fast disk the snapshot being restored was
  overwritten with the current files and the restore did nothing. Each snapshot
  now gets its own folder (numeric suffix when the name is taken). This was the
  intermittent failure of snapshot_restore_roundtrip_is_byte_exact_and_undoable.
- package extract: restore the execute bit on ELF binaries and #! scripts (the
  archive carries no modes). No effect on Windows.
- fsx::starts_with_ci: case-insensitive on Windows only; /srv/CoA and /srv/coa
  are different folders on Linux.
- registry test: use a root path that is a root on the running OS.

cargo test --workspace on Linux: 157 passed, 0 failed.
2026-10-02 18:40:07 +02:00
127 changed files with 7624 additions and 243 deletions

No files matched your search

+14
View File
@@ -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
+28
View File
@@ -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
+1 -1
View File
@@ -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:
+31
View File
@@ -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 -->
+25
View File
@@ -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.
+1
View File
@@ -0,0 +1 @@
@AGENTS.md
Generated
+448 -3
View File
@@ -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.4.0" version = "0.6.2"
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.4.0" version = "0.6.2"
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.4.0" version = "0.6.2"
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
View File
@@ -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.4.0" version = "0.6.2"
edition = "2021" edition = "2021"
license = "AGPL-3.0-only" license = "AGPL-3.0-only"
+1
View File
@@ -0,0 +1 @@
@AGENTS.md
+8
View File
@@ -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.
+7
View File
@@ -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
---
+7
View File
@@ -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.
+7
View File
@@ -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: 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.
+7
View File
@@ -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: 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.
+7
View File
@@ -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.
+1 -1
View File
@@ -24,9 +24,9 @@ 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"] }
@@ -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(())
}
+92
View File
@@ -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 { 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(())
}
+62
View File
@@ -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 { 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(())
}
+26
View File
@@ -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(())
}
@@ -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 { 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,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 { 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 { 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(())
}
+37 -11
View File
@@ -63,6 +63,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 {
@@ -127,6 +129,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
} }
@@ -158,7 +162,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 +179,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 +188,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 })
})?; })?;
components.push(component); components.push(component);
} }
@@ -219,6 +234,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,
@@ -280,6 +296,9 @@ 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<()> {
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 +308,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 +336,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 +367,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 +383,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() })
}) })
} }
@@ -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"
]
}
+11 -2
View File
@@ -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"))?;
+103 -2
View File
@@ -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,
@@ -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();
+64 -3
View File
@@ -131,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) };
@@ -155,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);
@@ -328,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());
@@ -423,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)?;
@@ -630,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] {
@@ -716,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();
+219 -5
View File
@@ -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"));
}
}
+8 -1
View File
@@ -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" }),
@@ -241,6 +245,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)
} }
@@ -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/*
+151
View File
@@ -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();
}
}
+913
View File
@@ -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");
}
}
+164
View File
@@ -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,
})
}
+35 -1
View File
@@ -17,6 +17,7 @@ use crate::fsx;
pub enum Verb { pub enum Verb {
StartAll, StartAll,
StartMysql, StartMysql,
StartWorld,
StopAll, StopAll,
} }
@@ -25,13 +26,14 @@ 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) -> Duration {
match self { match self {
Verb::StartAll => Duration::from_secs(420), 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),
} }
@@ -79,7 +81,38 @@ 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 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(&script).arg(verb.arg()).current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped());
@@ -132,6 +165,7 @@ 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 })
} }
+11
View File
@@ -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,
+10 -2
View File
@@ -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()))
+3 -1
View File
@@ -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(())
} }
+5 -2
View File
@@ -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[..]
+9 -2
View File
@@ -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.
+7 -4
View File
@@ -110,15 +110,15 @@ pub struct ScanReport {
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;
@@ -192,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)
@@ -204,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();
+6
View File
@@ -8,6 +8,7 @@ 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,14 +24,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 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;
+68 -8
View File
@@ -19,6 +19,7 @@ pub enum Status {
Applied, Applied,
Pending, Pending,
Failed, Failed,
Running,
} }
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
@@ -55,7 +56,8 @@ impl Store for Db {
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 +66,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 +88,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 +128,29 @@ 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)
}
/// 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,7 +178,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(); 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)));
}
}
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();
@@ -191,12 +215,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));
@@ -254,6 +282,28 @@ 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] #[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 +354,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;")]);
+212 -8
View File
@@ -91,12 +91,15 @@ pub struct ModuleView {
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 switchable: bool,
pub status: String, pub status: String,
pub icon: String, pub icon: String,
pub page: Option<String>, pub page: Option<String>,
pub hidden: bool, pub hidden: bool,
pub compatibility: String,
} }
pub fn list(root: &Path) -> Vec<ModuleView> { pub fn list(root: &Path) -> Vec<ModuleView> {
@@ -116,6 +119,7 @@ fn conf_name(root: &Path, e: &Entry) -> String {
} }
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| {
@@ -123,17 +127,26 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let conf = dir(root).join(&name); let conf = dir(root).join(&name);
let dist = dir(root).join(format!("{name}.dist")); 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 = !e.switchable let enabled = if matches!(e.id.as_str(), "companions" | "playerbots") {
|| read(&conf).or_else(|| read(&dist)).and_then(|c| c.get(&e.enable_key).map(truthy)).unwrap_or(e.default_on); 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");
ModuleView { ModuleView {
compatibility: if blocked { "unsupported" } else if wildcard && e.id != "client-compat" { "experimental" } else { "compatible" }.into(),
id: e.id, id: e.id,
name: e.name, name: e.name,
description: e.description, description: e.description,
repo: e.repo, repo: e.repo,
installed, installed,
enabled, has_settings,
switchable: e.switchable, enabled: enabled && !blocked,
switchable: e.switchable && !blocked,
status: e.status, status: e.status,
icon: e.icon, icon: e.icon,
page: e.page, page: e.page,
@@ -163,15 +176,61 @@ 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() { if !e.switchable || e.enable_key.is_empty() {
return Err(Error::Invalid("This part cannot be switched off.".into())); 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).unwrap_or(e.default_on) == on && file.get(&e.enable_key).is_some() { if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on && file.get(&e.enable_key).is_some() {
@@ -204,7 +263,15 @@ fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
let conf = dir(root).join(&name); let conf = dir(root).join(&name);
let dist = read(&dir(root).join(format!("{name}.dist"))); 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 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(),
@@ -217,6 +284,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)
} }
@@ -224,13 +292,30 @@ 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 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 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 == "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) {
@@ -280,6 +365,40 @@ mod tests {
(root, meta) (root, meta)
} }
#[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();
@@ -287,7 +406,7 @@ mod tests {
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/") && e.conf.ends_with(".conf"), "{}", e.id); assert!(e.repo.starts_with("https://github.com/") && e.conf.ends_with(".conf"), "{}", e.id);
assert!(!e.switchable || e.enable_key.ends_with(".Enable"), "{} needs the setting that switches it", e.id); assert!(!e.switchable || (e.enable_key.ends_with(".Enable") || e.enable_key.ends_with(".Enabled")), "{} needs the setting that switches it", e.id);
assert!(["soon", "early", "beta", "release"].contains(&e.status.as_str()), "{} has an unknown status", e.id); assert!(["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); assert!(e.status != "soon" || !e.switchable, "{} is only announced, so it cannot be switched", e.id);
} }
@@ -342,6 +461,91 @@ 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 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] #[test]
fn an_older_file_name_is_used_when_the_current_one_is_missing_and_a_part_that_cannot_be_switched_stays_on() { 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 d = tempfile::tempdir().unwrap();
+164
View File
@@ -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());
}
}
+6
View File
@@ -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)
} }
+64 -5
View File
@@ -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/")
@@ -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);
} }
@@ -373,6 +394,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();
+9
View File
@@ -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,
} }
} }
+427
View File
@@ -0,0 +1,427 @@
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(())
}
pub(crate) fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v1") { return Ok(source.into()); }
let replacements = [
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
];
let mut out = source.to_string();
for (from, to) in replacements {
if !out.contains(from) { return Err(Error::Invalid("This launcher does not support realm profiles. Update the server package first.".into())); }
out = out.replace(from, to);
}
let insert = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
// Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) { return Err(Error::Invalid("Unrecognised server launcher entry point.".into())); }
Ok(out.replace(marker, &format!("{insert}{marker}")))
}
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);
}
}
+2 -1
View File
@@ -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());
} }
} }
+4 -1
View File
@@ -139,7 +139,7 @@ pub fn pack_update(p: &UpdateParams, progress: &dyn Fn(&str)) -> Result<Manifest
let mut changed = 0; let mut changed = 0;
for rel in &rels { for rel in &rels {
let src = fsx::safe_join(p.tree, rel)?; let src = fsx::safe_join(p.tree, rel)?;
if base.get(&rel.to_lowercase()).map(|h| h.eq_ignore_ascii_case(&fsx::sha256_file(&src).unwrap_or_default())).unwrap_or(false) { if rel != crate::schema_check::CONTRACT && base.get(&rel.to_lowercase()).map(|h| h.eq_ignore_ascii_case(&fsx::sha256_file(&src).unwrap_or_default())).unwrap_or(false) {
continue; continue;
} }
let dst = fsx::safe_join(&work, rel)?; let dst = fsx::safe_join(&work, rel)?;
@@ -219,10 +219,12 @@ mod tests {
let (base_src, base_out, tree, upd_out, sqldir) = (d.path().join("bs"), d.path().join("bo"), d.path().join("tree"), d.path().join("uo"), d.path().join("sql")); let (base_src, base_out, tree, upd_out, sqldir) = (d.path().join("bs"), d.path().join("bo"), d.path().join("tree"), d.path().join("uo"), d.path().join("sql"));
write(&base_src, "Core/worldserver.exe", "v1"); write(&base_src, "Core/worldserver.exe", "v1");
write(&base_src, "Core/authserver.exe", "same"); write(&base_src, "Core/authserver.exe", "same");
write(&base_src, crate::schema_check::CONTRACT, "same contract");
let base = package::build(&base_src, &base_out, &BuildOptions { kind: Kind::Base, version: "1.0.0".into(), core_commit: None, built_at: "x".into(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap(); let base = package::build(&base_src, &base_out, &BuildOptions { kind: Kind::Base, version: "1.0.0".into(), core_commit: None, built_at: "x".into(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap();
write(&tree, "Core/worldserver.exe", "v2"); write(&tree, "Core/worldserver.exe", "v2");
write(&tree, "Core/authserver.exe", "same"); write(&tree, "Core/authserver.exe", "same");
write(&tree, "Core/newlib.dll", "n"); write(&tree, "Core/newlib.dll", "n");
write(&tree, crate::schema_check::CONTRACT, "same contract");
write(&sqldir, "world.sql", "SELECT 1;"); write(&sqldir, "world.sql", "SELECT 1;");
let sql = vec![SqlFile { db: "world".into(), id: "m1".into(), origin: "x".into(), abs: sqldir.join("world.sql"), sha256: fsx::sha256_file(&sqldir.join("world.sql")).unwrap() }]; let sql = vec![SqlFile { db: "world".into(), id: "m1".into(), origin: "x".into(), abs: sqldir.join("world.sql"), sha256: fsx::sha256_file(&sqldir.join("world.sql")).unwrap() }];
let m = pack_update(&UpdateParams { tree: &tree, base_manifest: &base, sql: &sql, out: &upd_out, version: "1.1.0".into(), core_commit: Some("a".repeat(40)), bots_commit: Some("b".repeat(40)), part_size: 1 << 20 }, &|_| {}).unwrap(); let m = pack_update(&UpdateParams { tree: &tree, base_manifest: &base, sql: &sql, out: &upd_out, version: "1.1.0".into(), core_commit: Some("a".repeat(40)), bots_commit: Some("b".repeat(40)), part_size: 1 << 20 }, &|_| {}).unwrap();
@@ -230,6 +232,7 @@ mod tests {
assert!(paths.contains(&"Core/worldserver.exe") && paths.contains(&"Core/newlib.dll")); assert!(paths.contains(&"Core/worldserver.exe") && paths.contains(&"Core/newlib.dll"));
assert!(!paths.contains(&"Core/authserver.exe"), "identical to the base: not shipped"); assert!(!paths.contains(&"Core/authserver.exe"), "identical to the base: not shipped");
assert!(paths.contains(&"_migrations/world/m1.sql")); assert!(paths.contains(&"_migrations/world/m1.sql"));
assert!(paths.contains(&crate::schema_check::CONTRACT), "the contract ships even when identical to the base");
assert_eq!(m.kind, Kind::Update); assert_eq!(m.kind, Kind::Update);
assert_eq!(m.migrations.len(), 1); assert_eq!(m.migrations.len(), 1);
assert_eq!(m.bots.as_ref().and_then(|b| b.commit.clone()), Some("b".repeat(40))); assert_eq!(m.bots.as_ref().and_then(|b| b.commit.clone()), Some("b".repeat(40)));
+127
View File
@@ -0,0 +1,127 @@
//! Database acceptance for release packages, using a freshly extracted signed base fixture.
use std::collections::HashSet;
use std::path::Path;
use crate::{backup, fsx, install, manifest::{Kind, Migration}, migrations, package, pkgsource, release::{self, SqlFile}, schema_check, Error, Result};
const MARKER: &str = ".release-schema-fixture";
pub fn collect(core: &Path, bots: Option<&Path>, repairs: Option<&Path>) -> Result<Vec<SqlFile>> {
let mut files = release::collect_core_sql(core)?;
if let Some(bots) = bots { files.extend(release::collect_bots_sql(bots)?); }
if let Some(repairs) = repairs {
for kind in ["auth", "characters", "world"] {
let dir = repairs.join(kind);
if !dir.exists() { continue; }
let mut paths: Vec<_> = std::fs::read_dir(&dir)?.map(|e| e.map(|e| e.path())).collect::<std::io::Result<_>>()?;
paths.sort();
for path in paths.into_iter().filter(|p| p.extension().is_some_and(|e| e == "sql")) {
let stem = path.file_stem().unwrap().to_string_lossy();
files.push(SqlFile { db: kind.into(), id: format!("manager_repair__{stem}"), origin: format!("{kind}/{stem}.sql"), sha256: fsx::sha256_file(&path)?, abs: path });
}
}
}
let mut seen = HashSet::new();
for file in &files {
if !seen.insert((&file.db, &file.id)) { return Err(Error::Invalid(format!("Duplicate release migration: {} / {}", file.db, file.id))); }
}
Ok(files)
}
pub fn extract_base(source: &Path, fixture: &Path, trusted_key: &str) -> Result<()> {
if fixture.exists() || !fixture.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-schema-fixture-")) {
return Err(Error::Invalid("Use a new coa-schema-fixture-* directory for release validation.".into()));
}
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(source.into()), trusted_key)?;
if manifest.kind != Kind::Base { return Err(Error::Invalid("Release schema validation needs a signed base package.".into())); }
package::extract_selected(source, &manifest, fixture, &|path| {
let path = path.to_ascii_lowercase();
["mysql/", "settings/", "runtime/", "scripts/", "core/", "bugreport/"].iter().any(|prefix| path.starts_with(prefix))
}, &|_, _| {})?;
fsx::atomic_write(&fixture.join(MARKER), b"disposable release-schema fixture")?;
install::bootstrap_database(fixture)
}
pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<()> {
if !fixture.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-schema-fixture-"))
|| std::fs::read(fixture.join(MARKER)).ok().as_deref() != Some(b"disposable release-schema fixture") {
return Err(Error::Invalid("Refusing to apply release SQL to a non-fixture server.".into()));
}
let staging = tempfile::tempdir()?;
let migrations: Vec<_> = sql.iter().map(|f| Migration { db: f.db.clone(), id: f.id.clone(), sha256: f.sha256.clone(), destructive: false }).collect();
for file in sql {
let path = fsx::safe_join(staging.path(), &format!("{}/{}.sql", file.db, file.id))?;
fsx::atomic_write(&path, &std::fs::read(&file.abs)?)?;
}
install::with_scratch_ports(fixture, || backup::with_database(fixture, |db| {
let db = db.clone().for_realm(crate::realms::Mode::Coa);
let report = migrations::apply_pending(&db, &migrations, staging.path(), &|| Ok("disposable release fixture".into()))?;
if let Some((id, why)) = report.failed { return Err(Error::Invalid(format!("Release migration {id} failed: {why}"))); }
// Validate known critical feature effects before capturing; history may be stale in the base.
let previous = tree.join(schema_check::CONTRACT);
if previous.exists() { return Err(Error::Invalid("Release tree already contains a schema contract; generate it from a fresh tree.".into())); }
let problems = schema_check::check(&db, tree)?;
if let Some(p) = problems.first() { return Err(Error::Invalid(format!("Release database failed validation: {}.{}.{}: {}", p.database, p.table, p.column, p.detail))); }
schema_check::capture(&db, tree)?;
schema_check::require_release_contract(tree)?;
Ok(())
}))
}
pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
if !manifest.files.iter().any(|f| f.path == schema_check::CONTRACT && f.size > 0) {
return Err(Error::Invalid("The release is missing its database schema contract.".into()));
}
let scratch = tempfile::tempdir()?;
package::extract_selected(dir, &manifest, scratch.path(), &|p| p == schema_check::CONTRACT, &|_, _| {})?;
schema_check::require_release_contract(scratch.path())?;
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use base64::{engine::general_purpose::STANDARD, Engine};
use ed25519_dalek::{Signer, SigningKey};
#[test]
fn signed_packages_must_carry_a_real_complete_schema_contract() {
let dir = tempfile::tempdir().unwrap();
let tree = dir.path().join("tree");
let out = dir.path().join("out");
fsx::atomic_write(&tree.join("Core/worldserver.exe"), b"fixture").unwrap();
let key = SigningKey::from_bytes(&[7; 32]);
let public = STANDARD.encode(key.verifying_key().as_bytes());
let opts = package::BuildOptions { kind: Kind::Update, version: "1.0.0".into(), core_commit: None, bots_commit: None, built_at: "test".into(), part_size: 1024 * 1024, migrations: vec![] };
let sign = || {
let bytes = std::fs::read(out.join("manifest.json")).unwrap();
fsx::atomic_write(&out.join("manifest.json.sig"), STANDARD.encode(key.sign(&bytes).to_bytes()).as_bytes()).unwrap();
};
package::build(&tree, &out, &opts, &|_| {}).unwrap(); sign();
assert!(verify_package(&out, &public).is_err());
fsx::atomic_write(&tree.join(schema_check::CONTRACT), br#"{"schema":1,"columns":{}}"#).unwrap();
package::build(&tree, &out, &opts, &|_| {}).unwrap(); sign();
assert!(verify_package(&out, &public).is_err());
fsx::atomic_write(&tree.join(schema_check::CONTRACT), br#"{"schema":1,"columns":{"auth":{"account":{"id":"int"}},"characters":{"characters":{"guid":"int"}},"world":{"creature":{"id":"int"}}}}"#).unwrap();
package::build(&tree, &out, &opts, &|_| {}).unwrap(); sign();
verify_package(&out, &public).unwrap();
}
#[test]
fn repair_sql_has_new_ids_and_runs_after_original_sql() {
let dir = tempfile::tempdir().unwrap();
let core = dir.path().join("core");
let repairs = dir.path().join("repairs");
fsx::atomic_write(&core.join("data/sql/updates/pending_db_characters/old.sql"), b"SELECT 1;").unwrap();
fsx::atomic_write(&repairs.join("characters/20261005_wildcard.sql"), b"SELECT 2;").unwrap();
let files = collect(&core, None, Some(&repairs)).unwrap();
assert_eq!(files.iter().map(|f| f.id.as_str()).collect::<Vec<_>>(), ["old", "manager_repair__20261005_wildcard"]);
assert_eq!(files[1].db, "characters");
}
#[test]
fn existing_server_cannot_be_used_for_schema_generation() {
let dir = tempfile::tempdir().unwrap();
assert!(extract_base(dir.path(), dir.path(), "irrelevant").is_err());
assert!(capture_release(dir.path(), dir.path(), &[]).is_err());
assert!(!dir.path().join(schema_check::CONTRACT).exists());
}
}
+194
View File
@@ -0,0 +1,194 @@
//! Repair official files and pending SQL from signed packages without replacing player databases or settings.
use std::{collections::BTreeMap, fs, path::Path};
use serde::Serialize;
use crate::{Error, Result, fsx, manifest::{Manifest, Kind, FileEntry, ReplacePolicy}, pkgsource::{self, Source}, registry::{InstallMeta, MetaDir}, update::{Env, RepackEnv}, download::Cancel};
#[derive(Debug, Serialize)]
pub struct DatabaseCheck {
pub realm: crate::realms::Mode,
pub migrations: Vec<crate::migrations::Item>,
pub problems: Vec<crate::schema_check::Problem>,
pub full_schema: bool,
}
fn installed_manifest(meta: &InstallMeta, dir: &Path) -> Result<Manifest> {
let version = meta.core.version.as_deref().ok_or_else(|| Error::Invalid("This imported server has no verified package version. Install an official server package first.".into()))?;
let update = dir.join("manifests").join(format!("update-{version}.json"));
let bytes = fs::read(if update.exists() { update } else { dir.join("manifests/base.json") })?;
let m = Manifest::parse(&bytes)?;
if m.version != version { return Err(Error::Invalid("The installed package manifest is missing. Update the server to restore its package information.".into())); }
Ok(m)
}
pub fn check(root: &Path, dir: &Path) -> Result<Vec<DatabaseCheck>> {
let (_, meta) = MetaDir::open(dir)?;
let m = installed_manifest(&meta, dir)?;
let checks = crate::backup::with_database(root, |db| {
let mut modes = vec![crate::realms::Mode::Coa];
if crate::realms::state(root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
let mut checks = Vec::new();
for mode in modes {
let db = db.clone().for_realm(mode);
let migrations: Vec<_> = m.migrations.iter().filter(|m| mode == crate::realms::Mode::Coa || m.db != "auth").cloned().collect();
checks.push(DatabaseCheck { realm: mode, migrations: crate::migrations::status(&db, &migrations)?, problems: crate::schema_check::check(&db, root)?, full_schema: root.join(crate::schema_check::CONTRACT).exists() });
}
Ok(checks)
})?;
fsx::atomic_write_json(&dir.join("logs/database-checks.json"), &checks)?;
Ok(checks)
}
#[derive(Debug, Serialize)]
pub struct Report {
pub restored: Vec<String>,
pub applied: Vec<String>,
pub backup: String,
pub database: Vec<DatabaseCheck>,
pub error: Option<String>,
}
fn repairable(f: &FileEntry) -> bool {
let path = f.path.to_lowercase();
f.owner != crate::manifest::Owner::User && matches!(f.policy, ReplacePolicy::Replace | ReplacePolicy::ReplaceIfPristine)
&& !path.starts_with("settings/") && !path.starts_with("core/configs/")
&& !path.starts_with("mysql/data/") && !path.starts_with("_migrations/")
}
fn restore_files(root: &Path, work: &Path, before: &Path, broken: &[(&FileEntry, bool)]) -> Result<Vec<String>> {
let mut plan = Vec::new();
// Back up every target before changing the first one, and retain a crash-recovery inventory.
for (entry, _) in broken {
let target = fsx::ensure_within(root, &fsx::safe_join(root, &entry.path)?)?;
let existed = target.is_file();
if existed {
let saved = fsx::safe_join(before, &entry.path)?;
fs::create_dir_all(saved.parent().unwrap())?;
fs::copy(&target, saved)?;
}
plan.push((entry.path.clone(), existed));
}
fsx::atomic_write_json(&before.join("files.json"), &plan)?;
let mut restored = Vec::new();
let result: Result<()> = (|| {
for (entry, latest) in broken {
let target = fsx::ensure_within(root, &fsx::safe_join(root, &entry.path)?)?;
let source = fsx::safe_join(&work.join(if *latest { "update" } else { "base" }), &entry.path)?;
fsx::atomic_write(&target, &fs::read(&source)?)?;
restored.push(entry.path.clone());
}
Ok(())
})();
if let Err(e) = result {
for (path, existed) in &plan {
let target = fsx::ensure_within(root, &fsx::safe_join(root, path)?)?;
if *existed { fsx::atomic_write(&target, &fs::read(fsx::safe_join(before, path)?)?)?; }
else if target.is_file() { fs::remove_file(target)?; }
}
return Err(e);
}
Ok(restored)
}
pub fn run(root: &Path, dir: &Path, base_source: &Source, update_source: &Source, key: &str, progress: &dyn Fn(&str, u8)) -> Result<Report> {
let _lock = crate::update::operation_lock(dir)?;
let env = RepackEnv { root, meta_dir: dir };
env.ensure_stopped()?;
crate::update::ensure_recovered(dir)?;
let (_, mut meta) = MetaDir::open(dir)?;
progress("Checking signed packages", 2);
let (update, _) = pkgsource::fetch_manifest(update_source, key)?;
if update.kind != Kind::Update || !update.compatible_with_manager(crate::MANAGER_VERSION) || meta.core.version.as_deref() != Some(&update.version) {
return Err(Error::Invalid("Update the server to the latest compatible package before repairing it. Repair never changes its version.".into()));
}
let (base, _) = pkgsource::fetch_manifest(base_source, key)?;
let installed_base = Manifest::parse(&fs::read(dir.join("manifests/base.json"))?)?;
if base.kind != Kind::Base || base.version != installed_base.version || base.core.commit != installed_base.core.commit {
return Err(Error::Invalid("The matching base package is no longer available. Your server was left unchanged.".into()));
}
let work = dir.join("staging").join(format!("repair-{}", uuid::Uuid::new_v4()));
fs::create_dir_all(&work)?;
let result = (|| {
let mut files: BTreeMap<String, (&FileEntry, bool)> = base.files.iter().filter(|f| repairable(f)).map(|f| (f.path.clone(), (f, false))).collect();
for f in update.files.iter().filter(|f| repairable(f)) { files.insert(f.path.clone(), (f, true)); }
let mut broken = Vec::new();
for (path, (entry, latest)) in files {
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
if fsx::sha256_file(&target).ok().as_deref() != Some(&entry.sha256) { broken.push((entry, latest)); }
}
let cancel = Cancel::default();
let update_parts = pkgsource::fetch_parts(update_source, &update, &dir.join("staging/download"), &cancel, &|f,_| progress("Downloading repair files", 5 + (f * 30.0) as u8))?;
crate::package::extract(&update_parts, &update, &work.join("update"), &|_,_| {})?;
if broken.iter().any(|(_,latest)| !latest) {
let base_parts = pkgsource::fetch_parts(base_source, &base, &dir.join("staging/repair-base-download"), &cancel, &|f,_| progress("Downloading base files", 35 + (f * 25.0) as u8))?;
crate::package::extract(&base_parts, &base, &work.join("base"), &|_,_| {})?;
}
// Verify all sources before taking a backup or replacing any target.
for (entry, latest) in &broken {
let src = fsx::safe_join(&work.join(if *latest { "update" } else { "base" }), &entry.path)?;
if fsx::sha256_file(&src)? != entry.sha256 { return Err(Error::Invalid("A repair file failed verification.".into())); }
}
progress("Backing up before repair", 65);
let backup = crate::backup::create(root, dir, crate::backup::Kind::Full, crate::backup::Trigger::Manual, Some("before repair".into()), &|_| {})?.id;
env.verify_recovery_point(&crate::backup::get(dir, &backup)?)?;
let repair_files: Vec<_> = broken.iter().map(|(file, _)| (*file).clone()).collect();
let mut txn = crate::update::begin_repair(root, dir, &update.version, &backup, &repair_files)?;
let before = dir.join("repairs").join(&backup);
fs::create_dir_all(&before)?;
fsx::require_space(root, broken.iter().map(|(e,_)| e.size.saturating_mul(2)).sum())?;
let restored = restore_files(root, &work, &before, &broken)?;
for (entry, _) in &broken {
meta.original_hashes.insert(entry.path.clone(), entry.sha256.clone());
}
fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
progress("Repairing pending database updates", 80);
crate::update::repair_migrating(dir, &mut txn)?;
let (applied, error) = match env.migrate(&update, &work.join("update/_migrations")) {
Ok(r) => (r.applied, r.failed.map(|(id,why)| format!("{id}: {why}"))),
Err(e) => (Vec::new(), Some(e.to_string())),
};
if error.is_some() {
crate::update::finish_repair(root, dir, &mut txn, false, &env)?;
let report = Report { restored: Vec::new(), applied: Vec::new(), backup, database: check(root, dir)?, error };
fsx::atomic_write_json(&before.join("report.json"), &report)?;
return Ok(report);
}
crate::config::create_missing_module_configs(root)?;
progress("Checking database after repair", 95);
let database = check(root, dir)?;
let report = Report { restored, applied, backup, database, error };
fsx::atomic_write_json(&before.join("report.json"), &report)?;
crate::update::finish_repair(root, dir, &mut txn, true, &env)?;
progress("Done", 100);
Ok(report)
})();
// Only the UUID staging directory created above is discarded; backups are retained.
let _ = fs::remove_dir_all(work);
result
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn repair_never_replaces_player_data_or_settings() {
for path in ["mysql/data/acore_characters/characters.ibd", "Settings/repack.json", "Core/configs/worldserver.conf", "_migrations/world/x.sql"] {
let entry = FileEntry { path: path.into(), sha256: "a".repeat(64), size: 1, owner: crate::manifest::Owner::Core, policy: ReplacePolicy::Replace };
assert!(!repairable(&entry));
}
}
#[test]
fn file_failure_restores_every_original_and_keeps_recovery_inventory() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("server");
let work = d.path().join("work");
let before = d.path().join("before");
fsx::atomic_write(&root.join("Core/a.dll"), b"original").unwrap();
fsx::atomic_write(&work.join("update/Core/a.dll"), b"repaired").unwrap();
let entries: Vec<_> = ["Core/a.dll", "Core/missing.dll"].into_iter().map(|path| FileEntry { path: path.into(), sha256: "a".repeat(64), size: 1, owner: crate::manifest::Owner::Core, policy: ReplacePolicy::Replace }).collect();
assert!(restore_files(&root, &work, &before, &[(&entries[0], true), (&entries[1], true)]).is_err());
assert_eq!(fs::read(root.join("Core/a.dll")).unwrap(), b"original");
assert!(!root.join("Core/missing.dll").exists());
assert!(before.join("files.json").is_file());
}
}
+176
View File
@@ -0,0 +1,176 @@
//! Read-only database structure checks. A release can ship a contract captured from its clean database.
use std::collections::{BTreeMap, BTreeSet};
use std::path::Path;
use serde::{Deserialize, Serialize};
use crate::{db::Db, error::Result, fsx};
pub const CONTRACT: &str = "Scripts/database-schema.json";
pub const WILDCARD_TABLES: &[(&str, &[&str])] = &[
("world", &["ascension_wildcard_boss_marks", "ascension_wildcard_tooltip_links"]),
("characters", &["coa_wildcard_skill_card", "coa_wildcard_skill_card_pending", "coa_wildcard_skill_card_account", "coa_wildcard_skill_card_purchase", "coa_wildcard_specialization_cache"]),
];
const WILDCARD_COLUMNS: &[(&str, &str, &[&str])] = &[
("world", "ascension_wildcard_boss_marks", &["CreatureEntry", "Amount"]),
("world", "ascension_wildcard_tooltip_links", &["Talent", "Ability"]),
("characters", "coa_wildcard_skill_card", &["account", "card", "progress"]),
("characters", "coa_wildcard_skill_card_pending", &["account", "id", "card"]),
("characters", "coa_wildcard_skill_card_account", &["account", "bonus_progress"]),
("characters", "coa_wildcard_skill_card_purchase", &["account", "type", "count"]),
("characters", "coa_wildcard_specialization_cache", &["account", "claimed_at"]),
];
type Columns = BTreeMap<String, BTreeMap<String, BTreeMap<String, String>>>;
#[derive(Debug, Serialize, Deserialize)]
pub struct Contract {
pub schema: u32,
pub columns: Columns,
}
pub fn require_release_contract(root: &Path) -> Result<Contract> {
let contract: Contract = fsx::read_json(&root.join(CONTRACT))?;
if contract.schema != 1 || ["auth", "characters", "world"].iter().any(|kind| {
contract.columns.get(*kind).is_none_or(|tables| tables.is_empty() || tables.values().any(|columns| columns.is_empty()))
}) {
return Err(crate::Error::Invalid("The release must include a complete supported database schema contract.".into()));
}
Ok(contract)
}
#[derive(Debug, Serialize)]
pub struct Problem { pub database: String, pub table: String, pub column: String, pub detail: String }
fn read_columns(db: &Db, kind: &str) -> Result<BTreeMap<String, BTreeMap<String, String>>> {
let schema = db.realm_schema(crate::db::schema_of(kind)?);
let text = db.query(&format!("SELECT TABLE_NAME,COLUMN_NAME,CONCAT(COLUMN_TYPE,'|',IS_NULLABLE,'|',IF(COLUMN_DEFAULT IS NULL,'<NULL>',HEX(COLUMN_DEFAULT)),'|',IF(EXTRA='','<NONE>',HEX(EXTRA))) FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{schema}' ORDER BY TABLE_NAME,ORDINAL_POSITION;"))?;
let mut tables: BTreeMap<String, BTreeMap<String, String>> = BTreeMap::new();
for line in text.lines() {
let fields: Vec<_> = line.split('\t').collect();
if fields.len() == 3 { tables.entry(fields[0].into()).or_default().insert(fields[1].into(), fields[2].into()); }
}
Ok(tables)
}
pub fn capture(db: &Db, root: &Path) -> Result<()> {
let mut columns = Columns::new();
for kind in ["auth", "characters", "world"] { columns.insert(kind.into(), read_columns(db, kind)?); }
fsx::atomic_write_json(&root.join(CONTRACT), &Contract { schema: 1, columns })
}
pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
let contract = if root.join(CONTRACT).is_file() {
let contract: Contract = fsx::read_json(&root.join(CONTRACT))?;
if contract.schema != 1 { return Err(crate::Error::Invalid("Unsupported database schema contract.".into())); }
contract
} else {
// Older packages have no full contract. Check the columns used by initial character saves.
let tables: BTreeMap<String, Vec<String>> = serde_json::from_str(include_str!("character-save-columns.json"))?;
Contract { schema: 1, columns: BTreeMap::from([("characters".into(), tables.into_iter().map(|(t, cols)| (t, cols.into_iter().map(|c| (c, String::new())).collect())).collect())]) }
};
let mut problems = Vec::new();
// Older releases omit a schema contract. Still verify the feature's actual tables,
// independently of its migration history, before declaring an update healthy.
if std::fs::read(root.join("Core/worldserver.exe")).is_ok_and(|bytes| bytes.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings")) {
for (kind, tables) in WILDCARD_TABLES {
let actual = read_columns(db, kind)?;
for table in *tables {
if !actual.contains_key(*table) {
problems.push(Problem { database: (*kind).into(), table: (*table).into(), column: String::new(), detail: "Missing required Wildcard table; migration history is not proof of its presence".into() });
} else {
for (_, _, columns) in WILDCARD_COLUMNS.iter().filter(|(k, t, _)| k == kind && t == table) {
for column in *columns {
if !actual[*table].contains_key(*column) {
problems.push(Problem { database: (*kind).into(), table: (*table).into(), column: (*column).into(), detail: "Missing required Wildcard column".into() });
}
}
}
}
}
}
}
for (kind, expected) in &contract.columns {
let actual = read_columns(db, kind)?;
for (table, cols) in expected {
if matches!(table.as_str(), "updates" | "updates_include" | "coa_manager_migrations") { continue; }
if !actual.contains_key(table) {
problems.push(Problem { database: kind.clone(), table: table.clone(), column: String::new(), detail: "Missing table".into() });
continue;
}
for (column, want) in cols {
let found = actual[table].get(column);
if found.is_none() || (!want.is_empty() && found != Some(want)) {
problems.push(Problem { database: kind.clone(), table: table.clone(), column: column.clone(), detail: found.map(|s| format!("Expected {want}, found {s}")).unwrap_or_else(|| "Missing column".into()) });
}
}
}
}
// A custom NOT NULL column without a default can reject every INSERT even when all standard columns exist.
let supplied: BTreeMap<String, Vec<String>> = serde_json::from_str(include_str!("character-save-columns.json"))?;
let schema = db.realm_schema("acore_characters");
let required = db.query(&format!("SELECT TABLE_NAME,COLUMN_NAME FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{schema}' AND IS_NULLABLE='NO' AND COLUMN_DEFAULT IS NULL AND EXTRA NOT LIKE '%auto_increment%' AND EXTRA NOT LIKE '%GENERATED%';"))?;
for (table, column) in required.lines().filter_map(|l| l.split_once('\t')) {
if supplied.get(table).is_some_and(|cols| !cols.iter().any(|c| c == column)) {
problems.push(Problem { database: "characters".into(), table: table.into(), column: column.into(), detail: "Required column has no default and is not supplied by character creation".into() });
}
}
// The any-race/class migration supports every standard playable race for all CoA classes.
// A class existing for just one race does not protect character creation or enumeration.
if db.realm() == crate::realms::Mode::Coa {
let rows = db.query("SELECT race,class FROM acore_world.playercreateinfo;")?;
problems.extend(missing_coa_starts(&rows));
}
// Check owned characters too, including legacy classes and Wildcard characters. Their rows
// must not silently disappear from character selection after an otherwise healthy update.
let missing = db.query("SELECT c.race,c.class,COUNT(*) FROM acore_characters.characters c LEFT JOIN acore_world.playercreateinfo p ON p.race=c.race AND p.class=c.class WHERE p.race IS NULL GROUP BY c.race,c.class;")?;
for row in missing.lines() {
let fields: Vec<_> = row.split('\t').collect();
if fields.len() == 3 {
problems.push(Problem { database: "world".into(), table: "playercreateinfo".into(), column: String::new(), detail: format!("{} existing characters have no starting data for race {} / class {} and would be hidden from character selection", fields[2], fields[0], fields[1]) });
}
}
Ok(problems)
}
fn missing_coa_starts(rows: &str) -> Vec<Problem> {
let pairs: BTreeSet<_> = rows.lines().filter_map(|l| l.split_once('\t')).map(|(a,b)| (a.to_owned(),b.to_owned())).collect();
let mut problems = Vec::new();
for race in [1, 2, 3, 4, 5, 6, 7, 8, 10, 11] {
for class in 12..=32 {
if !pairs.contains(&(race.to_string(), class.to_string())) {
problems.push(Problem { database: "world".into(), table: "playercreateinfo".into(), column: String::new(), detail: format!("No starting data for CoA race {race} / class {class}") });
}
}
}
problems
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_release_cannot_use_a_partial_or_empty_schema_contract() {
let dir = tempfile::tempdir().unwrap();
assert!(require_release_contract(dir.path()).is_err());
fsx::atomic_write_json(&dir.path().join(CONTRACT), &Contract { schema: 1, columns: Columns::new() }).unwrap();
assert!(require_release_contract(dir.path()).is_err());
let mut columns = Columns::new();
for kind in ["auth", "characters", "world"] {
columns.insert(kind.into(), BTreeMap::from([("table".into(), BTreeMap::from([("id".into(), "int|NO|<NULL>|<NONE>".into())]))]));
}
fsx::atomic_write_json(&dir.path().join(CONTRACT), &Contract { schema: 1, columns }).unwrap();
assert!(require_release_contract(dir.path()).is_ok());
}
#[test]
fn detects_a_missing_orc_class_pair_even_when_the_class_exists_for_other_races() {
let mut rows = String::new();
for race in [1, 2, 3, 4, 5, 6, 7, 8, 10, 11] {
for class in 12..=32 { rows.push_str(&format!("{race}\t{class}\n")); }
}
assert!(missing_coa_starts(&rows).is_empty());
let incomplete = rows.lines().filter(|line| *line != "2\t30").collect::<Vec<_>>().join("\n");
let problems = missing_coa_starts(&incomplete);
assert_eq!(problems.len(), 1);
assert!(problems[0].detail.contains("race 2 / class 30"));
}
}
+321 -34
View File
@@ -3,7 +3,7 @@
//! Nothing is changed until the signed package is downloaded, verified and extracted into staging. Every file that is //! Nothing is changed until the signed package is downloaded, verified and extracted into staging. Every file that is
//! about to change is first copied into the transaction's `before/` folder, each operation is journaled, and a crash or //! about to change is first copied into the transaction's `before/` folder, each operation is journaled, and a crash or
//! failure at any point leaves the installation recoverable: `rollback` restores binaries and configuration exactly. //! failure at any point leaves the installation recoverable: `rollback` restores binaries and configuration exactly.
//! Databases are never rolled back automatically (players may have progressed); restoring one is a separate action. //! Full recovery points protect database changes as well as files. Interrupted updates must be resolved first.
use std::collections::BTreeMap; use std::collections::BTreeMap;
use std::fs; use std::fs;
@@ -73,15 +73,20 @@ pub struct Txn {
pub from_version: Option<String>, pub from_version: Option<String>,
pub to_version: String, pub to_version: String,
pub recovery_point: Option<String>, pub recovery_point: Option<String>,
#[serde(default = "legacy_databases_started")]
pub databases_started: bool,
pub ops: Vec<Op>, pub ops: Vec<Op>,
pub message: Option<String>, pub message: Option<String>,
} }
fn legacy_databases_started() -> bool { true }
/// Everything the transaction needs from the outside world; tests provide a fake. /// Everything the transaction needs from the outside world; tests provide a fake.
pub trait Env { pub trait Env {
fn ensure_stopped(&self) -> Result<()>; fn ensure_stopped(&self) -> Result<()>;
/// Create a recovery point for the databases and configuration; returns its id. /// Create a recovery point for the databases and configuration; returns its id.
fn snapshot(&self) -> Result<String>; fn snapshot(&self) -> Result<String>;
fn restore_snapshot(&self, id: &str) -> Result<()>;
fn migrate(&self, manifest: &Manifest, staged_migrations: &Path) -> Result<ApplyReport>; fn migrate(&self, manifest: &Manifest, staged_migrations: &Path) -> Result<ApplyReport>;
/// Start the server and confirm it becomes healthy. /// Start the server and confirm it becomes healthy.
fn validate(&self) -> Result<()>; fn validate(&self) -> Result<()>;
@@ -111,7 +116,27 @@ pub fn unfinished(meta: &Path) -> Option<Txn> {
let rd = fs::read_dir(updates_dir(meta)).ok()?; let rd = fs::read_dir(updates_dir(meta)).ok()?;
let mut all: Vec<Txn> = rd.flatten().filter_map(|e| fsx::read_json::<Txn>(&e.path().join("txn.json")).ok()).collect(); let mut all: Vec<Txn> = rd.flatten().filter_map(|e| fsx::read_json::<Txn>(&e.path().join("txn.json")).ok()).collect();
all.sort_by(|a, b| b.id.cmp(&a.id)); all.sort_by(|a, b| b.id.cmp(&a.id));
all.into_iter().find(|t| !matches!(t.state, State::Committed | State::RolledBack | State::Failed | State::Prepared)) all.into_iter().find(|t| !matches!(t.state, State::Committed | State::RolledBack | State::Prepared) && (t.state != State::Failed || t.databases_started || t.ops.iter().any(|o| o.started)))
}
pub fn ensure_recovered(meta: &Path) -> Result<()> {
match fs::read_dir(updates_dir(meta)) {
Ok(entries) => {
for entry in entries {
let entry = entry?;
let journal = entry.path().join("txn.json");
if journal.exists() {
fsx::read_json::<Txn>(&journal).map_err(|e| Error::Invalid(format!("Update journal {} cannot be read: {e}. Recover it before changing or starting the server.", journal.display())))?;
}
}
}
Err(e) if e.kind() == std::io::ErrorKind::NotFound => {}
Err(e) => return Err(e.into()),
}
if let Some(t) = unfinished(meta) {
return Err(Error::Invalid(format!("Resolve unfinished update {} before changing or starting the server.", t.id)));
}
Ok(())
} }
fn sha_if_exists(p: &Path) -> Option<String> { fn sha_if_exists(p: &Path) -> Option<String> {
@@ -220,6 +245,7 @@ pub struct Outcome {
} }
fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) { fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) {
tracing::info!(step = name, percent = pct, "server update progress");
report(name, pct); report(name, pct);
} }
@@ -227,19 +253,23 @@ fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) {
/// a build that is applied but unhealthy is left in `NeedsDecision` so the owner chooses. /// a build that is applied but unhealthy is left in `NeedsDecision` so the owner chooses.
pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> { pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
let (root, meta_dir) = (p.root, p.meta_dir); let (root, meta_dir) = (p.root, p.meta_dir);
let _lock = operation_lock(meta_dir)?;
ensure_recovered(meta_dir)?;
let (md, mut meta) = MetaDir::open(meta_dir)?; let (md, mut meta) = MetaDir::open(meta_dir)?;
let _ = md; let _ = md;
step(report, "Checking the update", 2); step(report, "Checking the update", 2);
let (m, _) = fetch_manifest(&p.source, p.trusted_key)?; let (m, _) = fetch_manifest(&p.source, p.trusted_key)?;
tracing::info!(root = %root.display(), from_version = ?meta.core.version, to_version = %m.version, migrations = m.migrations.len(), "server update selected");
check_manifest(&m)?; check_manifest(&m)?;
let archive = m.archive.clone().ok_or_else(|| Error::InvalidManifest("no archive".into()))?; let archive = m.archive.clone().ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
let id = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), m.version.replace('.', "_")); let id = format!("{}-{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), m.version.replace('.', "_"), uuid::Uuid::new_v4().simple());
let tdir = txn_dir(meta_dir, &id)?; let tdir = txn_dir(meta_dir, &id)?;
let (tree, before) = (tdir.join("tree"), tdir.join("before")); let (tree, before) = (tdir.join("tree"), tdir.join("before"));
fs::create_dir_all(&before)?; fs::create_dir_all(&before)?;
fsx::atomic_write(&before.join("manager-install.json"), &fs::read(meta_dir.join("install.json"))?)?;
let mut txn = Txn { id: id.clone(), state: State::Prepared, from_version: meta.core.version.clone(), to_version: m.version.clone(), recovery_point: None, ops: Vec::new(), message: None }; let mut txn = Txn { id: id.clone(), state: State::Prepared, from_version: meta.core.version.clone(), to_version: m.version.clone(), recovery_point: None, databases_started: false, ops: Vec::new(), message: None };
save(meta_dir, &txn)?; save(meta_dir, &txn)?;
// Nothing has touched the installation yet; failures up to here just discard the staging area. // Nothing has touched the installation yet; failures up to here just discard the staging area.
@@ -293,20 +323,17 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
let applied = apply_ops(root, &tree, &before, &m.files, &mut txn, meta_dir, p.fail_after_ops); let applied = apply_ops(root, &tree, &before, &m.files, &mut txn, meta_dir, p.fail_after_ops);
if let Err(e) = applied { if let Err(e) = applied {
step(report, "Undoing the update", 70); step(report, "Undoing the update", 70);
let restore = restore_files(root, &before, &mut txn); return fail_after_apply(p, &mut txn, &before, &tree, e.to_string(), None);
txn.state = if restore.is_ok() { State::RolledBack } else { State::Failed };
txn.message = Some(e.to_string());
save(meta_dir, &txn)?;
let _ = fs::remove_dir_all(&tree);
return Err(e);
} }
txn.state = State::Applied; txn.state = State::Applied;
save(meta_dir, &txn)?; save(meta_dir, &txn)?;
// Database migrations: a failure here undoes the file changes; the databases are left as they are. // MySQL DDL can commit before a later statement fails. Restore the full recovery point on failure.
let mut migrated = None; let mut migrated = None;
if !m.migrations.is_empty() { if !m.migrations.is_empty() {
step(report, "Updating the database", 75); step(report, "Updating the database", 75);
txn.databases_started = true;
save(meta_dir, &txn)?;
match p.env.migrate(&m, &tree.join("_migrations")) { match p.env.migrate(&m, &tree.join("_migrations")) {
Ok(r) if r.failed.is_none() => migrated = Some(r), Ok(r) if r.failed.is_none() => migrated = Some(r),
Ok(r) => { Ok(r) => {
@@ -330,7 +357,14 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
meta.core.version = Some(m.version.clone()); meta.core.version = Some(m.version.clone());
meta.core.commit = m.core.commit.clone().or(meta.core.commit); meta.core.commit = m.core.commit.clone().or(meta.core.commit);
for op in &txn.ops { for op in &txn.ops {
meta.original_hashes.insert(op.path.clone(), op.new_sha256.clone()); let hash = if op.path == "Scripts/manage.py" {
let staged = fs::read_to_string(tree.join(&op.path)).ok().and_then(|s| crate::realms::patch_launcher(&s).ok());
match (staged, fs::read(root.join(&op.path))) {
(Some(expected), Ok(actual)) if expected.as_bytes() == actual => fsx::sha256_bytes(&actual),
_ => op.new_sha256.clone(),
}
} else { op.new_sha256.clone() };
meta.original_hashes.insert(op.path.clone(), hash);
if !meta.managed_files.contains(&op.path) { if !meta.managed_files.contains(&op.path) {
meta.managed_files.push(op.path.clone()); meta.managed_files.push(op.path.clone());
} }
@@ -352,13 +386,33 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
} }
fn fail_after_apply(p: &Params, txn: &mut Txn, before: &Path, tree: &Path, why: String, report: Option<ApplyReport>) -> Result<Outcome> { fn fail_after_apply(p: &Params, txn: &mut Txn, before: &Path, tree: &Path, why: String, report: Option<ApplyReport>) -> Result<Outcome> {
let restored = restore_files(p.root, before, txn); tracing::error!(transaction = %txn.id, databases_started = txn.databases_started, "server update failed; restoring recovery point");
let restored = restore_transaction(p.root, p.meta_dir, before, txn, p.env);
tracing::info!(transaction = %txn.id, recovered = restored.is_ok(), "server update recovery finished");
txn.state = if restored.is_ok() { State::RolledBack } else { State::Failed }; txn.state = if restored.is_ok() { State::RolledBack } else { State::Failed };
txn.message = Some(why.clone()); txn.message = Some(match &restored { Ok(()) => why.clone(), Err(e) => format!("{why} Recovery failed: {e}") });
save(p.meta_dir, txn)?; save(p.meta_dir, txn)?;
let _ = fs::remove_dir_all(tree); if restored.is_ok() { let _ = fs::remove_dir_all(tree); }
let _ = report; let _ = report;
Err(Error::Invalid(format!("{why} Your files were restored and your databases were not touched by the restore."))) Err(Error::Invalid(match restored {
Ok(()) if txn.databases_started => format!("{why} The server files and databases were restored to the recovery point."),
Ok(()) => format!("{why} The server files were restored."),
Err(e) => format!("{why} Recovery failed: {e}. Resolve the unfinished update before starting the server."),
}))
}
fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, env: &dyn Env) -> Result<()> {
env.ensure_stopped()?;
if txn.databases_started {
let id = txn.recovery_point.as_deref().ok_or_else(|| Error::Invalid("The database recovery point is missing.".into()))?;
env.restore_snapshot(id)?;
}
restore_files(root, before, txn)?;
let saved_meta = before.join("manager-install.json");
if saved_meta.exists() {
fsx::atomic_write(&meta.join("install.json"), &fs::read(saved_meta)?)?;
}
Ok(())
} }
fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn: &mut Txn, meta_dir: &Path, fail_after: Option<usize>) -> Result<()> { fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn: &mut Txn, meta_dir: &Path, fail_after: Option<usize>) -> Result<()> {
@@ -371,14 +425,15 @@ fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn:
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?; let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
let staged = fsx::safe_join(tree, &path)?; let staged = fsx::safe_join(tree, &path)?;
let entry = files.iter().find(|f| f.path == path).expect("listed"); let entry = files.iter().find(|f| f.path == path).expect("listed");
txn.ops[i].started = true;
save(meta_dir, txn)?;
if target.is_file() { if target.is_file() {
let keep = fsx::safe_join(before, &path)?; let keep = fsx::safe_join(before, &path)?;
fs::create_dir_all(keep.parent().unwrap())?; fs::create_dir_all(keep.parent().unwrap())?;
fs::copy(&target, &keep)?; fsx::atomic_write(&keep, &fs::read(&target)?)?;
} }
// Journal only after the old bytes are safely saved; a crash during backup must not
// turn an untouched file into a rollback operation with a missing saved copy.
txn.ops[i].started = true;
save(meta_dir, txn)?;
fs::create_dir_all(target.parent().unwrap())?; fs::create_dir_all(target.parent().unwrap())?;
match action { match action {
Action::Create | Action::Replace => { Action::Create | Action::Replace => {
@@ -428,14 +483,14 @@ fn restore_files(root: &Path, before: &Path, txn: &mut Txn) -> Result<()> {
Ok(()) Ok(())
} }
/// Roll a transaction back (binaries and configuration only; databases are never touched). /// Restore the database recovery point first, then restore binaries and configuration.
pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result<Txn> { pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result<Txn> {
let _lock = operation_lock(meta_dir)?;
let mut txn = load(meta_dir, id)?; let mut txn = load(meta_dir, id)?;
if matches!(txn.state, State::Committed | State::RolledBack) { if matches!(txn.state, State::Committed | State::RolledBack) {
return Err(Error::Invalid("This update cannot be rolled back.".into())); return Err(Error::Invalid("This update cannot be rolled back.".into()));
} }
env.ensure_stopped()?; restore_transaction(root, meta_dir, &txn_dir(meta_dir, id)?.join("before"), &mut txn, env)?;
restore_files(root, &txn_dir(meta_dir, id)?.join("before"), &mut txn)?;
txn.state = State::RolledBack; txn.state = State::RolledBack;
txn.message = Some("rolled back".into()); txn.message = Some("rolled back".into());
save(meta_dir, &txn)?; save(meta_dir, &txn)?;
@@ -443,9 +498,47 @@ pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result
Ok(txn) Ok(txn)
} }
pub(crate) fn operation_lock(meta_dir: &Path) -> Result<fs::File> {
fs::create_dir_all(meta_dir)?;
let lock = fs::OpenOptions::new().read(true).write(true).create(true).truncate(false).open(meta_dir.join("update.lock"))?;
if !fs4::fs_std::FileExt::try_lock_exclusive(&lock)? {
return Err(Error::Invalid("Another update, repair or recovery is in progress.".into()));
}
Ok(lock)
}
/// Repair uses the same durable recovery journal as an update. Its caller holds operation_lock.
pub(crate) fn begin_repair(root: &Path, meta_dir: &Path, version: &str, backup: &str, files: &[FileEntry]) -> Result<Txn> {
let id = format!("{}-repair-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), uuid::Uuid::new_v4().simple());
let before = txn_dir(meta_dir, &id)?.join("before");
fsx::atomic_write(&before.join("manager-install.json"), &fs::read(meta_dir.join("install.json"))?)?;
let mut ops = Vec::new();
for file in files {
let target = fsx::ensure_within(root, &fsx::safe_join(root, &file.path)?)?;
let had_previous = target.is_file();
if had_previous { fsx::atomic_write(&fsx::safe_join(&before, &file.path)?, &fs::read(&target)?)?; }
ops.push(Op { path: file.path.clone(), action: if had_previous { Action::Replace } else { Action::Create }, reason: None, new_sha256: file.sha256.clone(), had_previous, started: true, done: false });
}
let txn = Txn { id, state: State::Applying, from_version: Some(version.into()), to_version: version.into(), recovery_point: Some(backup.into()), databases_started: false, ops, message: Some("Repair is in progress.".into()) };
save(meta_dir, &txn)?;
Ok(txn)
}
pub(crate) fn repair_migrating(meta_dir: &Path, txn: &mut Txn) -> Result<()> {
txn.state = State::Applied;
txn.databases_started = true;
save(meta_dir, txn)
}
pub(crate) fn finish_repair(root: &Path, meta_dir: &Path, txn: &mut Txn, success: bool, env: &dyn Env) -> Result<()> {
if !success { restore_transaction(root, meta_dir, &txn_dir(meta_dir, &txn.id)?.join("before"), txn, env)?; }
txn.state = if success { State::Committed } else { State::RolledBack };
save(meta_dir, txn)
}
fn prune(meta_dir: &Path, keep: usize) { fn prune(meta_dir: &Path, keep: usize) {
let Ok(rd) = fs::read_dir(updates_dir(meta_dir)) else { return }; let Ok(rd) = fs::read_dir(updates_dir(meta_dir)) else { return };
let mut dirs: Vec<_> = rd.flatten().filter(|e| e.path().join("txn.json").is_file()).map(|e| e.path()).collect(); let mut dirs: Vec<_> = rd.flatten().filter(|e| fsx::read_json::<Txn>(&e.path().join("txn.json")).is_ok_and(|t| matches!(t.state, State::Committed | State::RolledBack))).map(|e| e.path()).collect();
dirs.sort(); dirs.sort();
while dirs.len() > keep { while dirs.len() > keep {
let _ = fs::remove_dir_all(dirs.remove(0)); let _ = fs::remove_dir_all(dirs.remove(0));
@@ -458,11 +551,40 @@ pub struct RepackEnv<'a> {
pub meta_dir: &'a Path, pub meta_dir: &'a Path,
} }
impl RepackEnv<'_> {
pub(crate) fn verify_recovery_point(&self, point: &crate::backup::RecoveryPoint) -> Result<()> {
if point.kind != crate::backup::Kind::Full || !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) {
return Err(Error::Invalid("The update recovery point does not contain every required database and configuration.".into()));
}
if !crate::backup::verify(self.meta_dir, &point.id)?.ok { return Err(Error::Invalid("The recovery point failed verification.".into())); }
crate::backup::with_database(self.root, |db| {
let db = db.clone().for_realm(crate::realms::Mode::Coa);
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
let schema = if component.name.contains('-') || component.name == "playerbots" { crate::db::schema_of(&component.name)? } else { point.realm.schema(&component.name)? };
if db.extra_objects(schema)? != 0 {
return Err(Error::Invalid(format!("Database {schema} has routines, triggers or views that automatic recovery cannot restore. The update was not started.")));
}
}
Ok(())
})
}
fn migration_snapshot(&self) -> Result<String> {
if let Some(id) = unfinished(self.meta_dir).and_then(|t| t.recovery_point) {
if crate::backup::get(self.meta_dir, &id)?.kind == crate::backup::Kind::Full && crate::backup::verify(self.meta_dir, &id)?.ok {
return Ok(id);
}
return Err(Error::Invalid("The update recovery point is incomplete or damaged.".into()));
}
Ok(crate::backup::create(self.root, self.meta_dir, crate::backup::Kind::Full, crate::backup::Trigger::BeforeMigration, None, &|_| {})?.id)
}
}
impl Env for RepackEnv<'_> { impl Env for RepackEnv<'_> {
fn ensure_stopped(&self) -> Result<()> { fn ensure_stopped(&self) -> Result<()> {
use crate::process::{observe, ServiceState}; use crate::process::{observe, ServiceState};
let o = observe(self.root, &crate::layout::read_ports(self.root)); let o = observe(self.root, &crate::layout::read_ports(self.root));
if o.world.state != ServiceState::Stopped || o.auth.state != ServiceState::Stopped { if o.world.state != ServiceState::Stopped || o.auth.state != ServiceState::Stopped || crate::multiworld::is_running(self.root) {
return Err(Error::Invalid("Stop the server before updating it; files cannot be replaced while it is running.".into())); return Err(Error::Invalid("Stop the server before updating it; files cannot be replaced while it is running.".into()));
} }
Ok(()) Ok(())
@@ -470,28 +592,100 @@ impl Env for RepackEnv<'_> {
fn snapshot(&self) -> Result<String> { fn snapshot(&self) -> Result<String> {
let label = Some("before update".to_string()); let label = Some("before update".to_string());
Ok(crate::backup::create(self.root, self.meta_dir, crate::backup::Kind::Quick, crate::backup::Trigger::BeforeUpdate, label, &|_| {})?.id) let point = crate::backup::create(self.root, self.meta_dir, crate::backup::Kind::Full, crate::backup::Trigger::BeforeUpdate, label, &|_| {})?;
self.verify_recovery_point(&point)?;
Ok(point.id)
}
fn restore_snapshot(&self, id: &str) -> Result<()> {
let point = crate::backup::get(self.meta_dir, id)?;
if point.kind != crate::backup::Kind::Full { return Err(Error::Invalid("Database rollback requires a full recovery point.".into())); }
if !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) || !crate::backup::verify(self.meta_dir, id)?.ok {
return Err(Error::Invalid("The full database recovery point is incomplete or damaged.".into()));
}
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
crate::backup::restore_database(self.root, self.meta_dir, id, &component.name)?;
}
crate::backup::restore_configs(self.root, self.meta_dir, id)?;
Ok(())
} }
fn migrate(&self, manifest: &Manifest, staged: &Path) -> Result<ApplyReport> { fn migrate(&self, manifest: &Manifest, staged: &Path) -> Result<ApplyReport> {
let (root, meta) = (self.root, self.meta_dir); let root = self.root;
crate::backup::with_database(root, |db| { crate::backup::with_database(root, |db| {
crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| { let realms = crate::realms::state(root)?;
Ok(crate::backup::create(root, meta, crate::backup::Kind::Database, crate::backup::Trigger::BeforeMigration, None, &|_| {})?.id) let mut result = crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| {
}) self.migration_snapshot()
})?;
if realms.wildcard_created && result.failed.is_none() {
let other = if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa };
let other_db = db.clone().for_realm(other);
let shared_snapshot = result.snapshot.clone();
let migrations: Vec<_> = manifest.migrations.iter().filter(|m| m.db != "auth").cloned().collect();
let extra = crate::migrations::apply_pending(&other_db, &migrations, staged, &|| {
if let Some(id) = &shared_snapshot { return Ok(id.clone()); }
self.migration_snapshot()
})?;
result.applied.extend(extra.applied);
result.failed = extra.failed;
if result.snapshot.is_none() { result.snapshot = extra.snapshot; }
if result.failed.is_none() {
if let Some(p) = crate::schema_check::check(&other_db, root)?.first() {
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", other.name(), p.table, p.column, p.detail)));
}
}
}
if result.failed.is_none() {
let problems = crate::schema_check::check(db, root)?;
if let Some(p) = problems.first() {
return Err(Error::Invalid(format!("Database validation failed: {}.{}.{}: {} ({} problems).", p.database, p.table, p.column, p.detail, problems.len())));
}
}
Ok(result)
}) })
} }
fn validate(&self) -> Result<()> { fn validate(&self) -> Result<()> {
use crate::process::{observe, ServiceState}; use crate::process::{observe, ServiceState};
let started = crate::driver::run(self.root, crate::driver::Verb::StartAll)?; crate::backup::with_database(self.root, |db| {
let mut modes = vec![crate::realms::Mode::Coa];
if crate::realms::state(self.root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
for mode in modes {
if let Some(p) = crate::schema_check::check(&db.clone().for_realm(mode), self.root)?.first() {
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", mode.name(), p.database, p.table, p.detail)));
}
}
Ok(())
})?;
// The check start is the first start of the new build: give the module configs the settings the update added
// (as a normal start does), or the server logs a "missing property" line for every one of them.
match crate::registry::MetaDir::open(self.meta_dir) {
Ok((_, meta)) if meta.kind == crate::registry::InstallKind::New => {
let _ = crate::config::materialize_module_configs(self.root);
}
// An imported server gets the files it lacks (nothing it has is changed).
_ => {
let _ = crate::config::create_missing_module_configs(self.root);
}
}
let started = match crate::driver::validate_update(self.root) {
Ok(out) => out,
Err(e) => {
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
return Err(e);
}
};
let ports = crate::layout::read_ports(self.root); let ports = crate::layout::read_ports(self.root);
let healthy = started.ok && { let healthy = started.ok && {
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180); let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
let mut ready_since = None;
loop { loop {
let o = observe(self.root, &ports); let o = observe(self.root, &ports);
if o.mysql.state == ServiceState::Running && o.auth.state == ServiceState::Running && o.world.state == ServiceState::Running { if o.mysql.state == ServiceState::Running && o.auth.state == ServiceState::Running && o.world.state == ServiceState::Running && o.secondary_world.as_ref().is_none_or(|s| s.state == ServiceState::Running) {
break true; let since = ready_since.get_or_insert_with(std::time::Instant::now);
if since.elapsed() >= std::time::Duration::from_secs(10) { break true; }
} else {
ready_since = None;
} }
if std::time::Instant::now() > deadline { if std::time::Instant::now() > deadline {
break false; break false;
@@ -524,11 +718,12 @@ mod tests {
snapshot_ok: Cell<bool>, snapshot_ok: Cell<bool>,
calls: RefCell<Vec<&'static str>>, calls: RefCell<Vec<&'static str>>,
migrate_fail: Cell<bool>, migrate_fail: Cell<bool>,
restore_fail: Cell<bool>,
} }
impl Fake { impl Fake {
fn ok() -> Fake { fn ok() -> Fake {
Fake { stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false) } Fake { stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false), restore_fail: Cell::new(false) }
} }
} }
@@ -545,6 +740,10 @@ mod tests {
self.calls.borrow_mut().push("migrate"); self.calls.borrow_mut().push("migrate");
Ok(ApplyReport { applied: vec![], failed: self.migrate_fail.get().then(|| ("m1".to_string(), "syntax".to_string())), snapshot: None }) Ok(ApplyReport { applied: vec![], failed: self.migrate_fail.get().then(|| ("m1".to_string(), "syntax".to_string())), snapshot: None })
} }
fn restore_snapshot(&self, _id: &str) -> Result<()> {
self.calls.borrow_mut().push("restore-databases");
if self.restore_fail.get() { Err(Error::Invalid("recovery disk unavailable".into())) } else { Ok(()) }
}
fn validate(&self) -> Result<()> { fn validate(&self) -> Result<()> {
self.calls.borrow_mut().push("validate"); self.calls.borrow_mut().push("validate");
if self.healthy.get() { Ok(()) } else { Err(Error::Invalid("worldserver exited".into())) } if self.healthy.get() { Ok(()) } else { Err(Error::Invalid("worldserver exited".into())) }
@@ -743,6 +942,7 @@ mod tests {
let e = run(&w, &env, BTreeMap::new(), None).unwrap_err(); let e = run(&w, &env, BTreeMap::new(), None).unwrap_err();
assert!(e.to_string().contains("Database update m1 failed")); assert!(e.to_string().contains("Database update m1 failed"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1"); assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(env.calls.borrow().contains(&"restore-databases"));
assert!(!env.calls.borrow().contains(&"validate"), "the new build is never started after a failed migration"); assert!(!env.calls.borrow().contains(&"validate"), "the new build is never started after a failed migration");
let ok = Fake::ok(); let ok = Fake::ok();
let out = run(&w, &ok, BTreeMap::new(), None).unwrap(); let out = run(&w, &ok, BTreeMap::new(), None).unwrap();
@@ -750,6 +950,93 @@ mod tests {
assert_eq!(*ok.calls.borrow(), ["stop", "snapshot", "migrate", "validate"]); assert_eq!(*ok.calls.borrow(), ["stop", "snapshot", "migrate", "validate"]);
} }
#[test]
fn failed_database_recovery_keeps_new_files_and_blocks_retry_until_recovered() {
let w = world(&[], true);
let env = Fake::ok();
env.migrate_fail.set(true);
env.restore_fail.set(true);
let error = run(&w, &env, BTreeMap::new(), None).unwrap_err();
assert!(error.to_string().contains("Recovery failed"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v2");
let pending = unfinished(&w.meta).unwrap();
assert_eq!(pending.state, State::Failed);
assert!(pending.databases_started);
assert!(txn_dir(&w.meta, &pending.id).unwrap().join("tree").exists());
assert!(run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err().to_string().contains("unfinished"));
rollback(&w.root, &w.meta, &pending.id, &Fake::ok()).unwrap();
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(unfinished(&w.meta).is_none());
}
#[test]
fn interrupted_migration_is_restored_before_files_and_never_replayed() {
let w = world(&[], true);
let env = Fake::ok();
env.healthy.set(false);
let out = run(&w, &env, BTreeMap::new(), None).unwrap();
let recovery = Fake::ok();
rollback(&w.root, &w.meta, &out.txn.id, &recovery).unwrap();
assert_eq!(*recovery.calls.borrow(), ["stop", "restore-databases"]);
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
}
#[test]
fn concurrent_updates_are_rejected_without_changes() {
let w = world(&[], false);
let _lock = operation_lock(&w.meta).unwrap();
assert!(run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err().to_string().contains("in progress"));
assert!(crate::driver::run(&w.root, crate::driver::Verb::StartAll).unwrap_err().to_string().contains("in progress"));
assert!(crate::modules::set_enabled(&w.root, &w.meta, "companions", true).unwrap_err().to_string().contains("in progress"));
assert!(crate::realms::select(&w.root, crate::realms::Mode::Wildcard).unwrap_err().to_string().contains("in progress"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
}
#[test]
fn interrupted_repair_restores_files_databases_and_ownership_metadata() {
let w = world(&[], false);
let files = vec![
FileEntry { path: "Core/worldserver.exe".into(), sha256: fsx::sha256_bytes(b"repaired"), size: 8, owner: crate::manifest::Owner::Core, policy: ReplacePolicy::Replace },
FileEntry { path: "Core/repair-created.dll".into(), sha256: fsx::sha256_bytes(b"created"), size: 7, owner: crate::manifest::Owner::Core, policy: ReplacePolicy::Replace },
];
let mut txn = begin_repair(&w.root, &w.meta, "1.0.0", "full-backup", &files).unwrap();
write(&w.root, "Core/worldserver.exe", b"repaired");
write(&w.root, "Core/repair-created.dll", b"created");
repair_migrating(&w.meta, &mut txn).unwrap();
assert_eq!(unfinished(&w.meta).unwrap().id, txn.id);
let env = Fake::ok();
rollback(&w.root, &w.meta, &txn.id, &env).unwrap();
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(!w.root.join("Core/repair-created.dll").exists());
assert_eq!(*env.calls.borrow(), ["stop", "restore-databases"]);
assert!(unfinished(&w.meta).is_none());
}
#[test]
fn unreadable_update_journal_blocks_changes_and_startup() {
let w = world(&[], false);
write(&w.meta, "updates/broken/txn.json", b"{truncated");
assert!(run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err().to_string().contains("cannot be read"));
assert!(crate::driver::run(&w.root, crate::driver::Verb::StartAll).unwrap_err().to_string().contains("cannot be read"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
}
#[test]
fn crash_during_commit_restores_the_original_installation_metadata() {
let w = world(&[], false);
let env = Fake::ok();
env.healthy.set(false);
let out = run(&w, &env, BTreeMap::new(), None).unwrap();
let (_, mut meta) = MetaDir::open(&w.meta).unwrap();
meta.core.version = Some("2.0.0".into());
meta.core.commit = Some("a".repeat(40));
fsx::atomic_write_json(&w.meta.join("install.json"), &meta).unwrap();
rollback(&w.root, &w.meta, &out.txn.id, &Fake::ok()).unwrap();
let (_, restored) = MetaDir::open(&w.meta).unwrap();
assert_eq!(restored.core.version.as_deref(), Some("1.0.0"));
assert_eq!(restored.core.commit, None);
}
#[test] #[test]
fn bad_signature_and_wrong_package_kind_change_nothing() { fn bad_signature_and_wrong_package_kind_change_nothing() {
let w = world(&[], false); let w = world(&[], false);
+41 -11
View File
@@ -2,7 +2,9 @@
//! //!
//! coa-release pack-base --tree DIR --out DIR --version X [--core-commit SHA] [--part-size BYTES] //! coa-release pack-base --tree DIR --out DIR --version X [--core-commit SHA] [--part-size BYTES]
//! coa-release pack-update --tree DIR --base-manifest FILE --core DIR --out DIR --version X //! coa-release pack-update --tree DIR --base-manifest FILE --core DIR --out DIR --version X
//! [--bots DIR] [--core-commit SHA] [--bots-commit SHA] [--part-size BYTES] //! [--bots DIR] [--repairs DIR] [--core-commit SHA] [--bots-commit SHA] [--part-size BYTES]
//! coa-release extract-schema-base --package DIR --fixture NEW-coa-schema-fixture-DIR
//! coa-release schema-contract --repack FIXTURE --tree DIR --core DIR [--bots DIR] [--repairs DIR]
//! coa-release clean-base --repack DIR --core DIR --tree DIR --out DIR [--bots DIR] [--data DIR] //! coa-release clean-base --repack DIR --core DIR --tree DIR --out DIR [--bots DIR] [--data DIR]
//! coa-release sign --dir DIR (key: env COA_SIGNING_KEY, or ~/.coa-manager/signing/manifest-signing.key) //! coa-release sign --dir DIR (key: env COA_SIGNING_KEY, or ~/.coa-manager/signing/manifest-signing.key)
//! coa-release verify --dir DIR (against the public key built into this tool) //! coa-release verify --dir DIR (against the public key built into this tool)
@@ -12,7 +14,7 @@ use std::path::PathBuf;
use coa_core::manifest::{Kind, Manifest}; use coa_core::manifest::{Kind, Manifest};
use coa_core::package::{build, BuildOptions, DEFAULT_PART_SIZE}; use coa_core::package::{build, BuildOptions, DEFAULT_PART_SIZE};
use coa_core::release::{collect_bots_sql, collect_core_sql, pack_update, sign_manifest, UpdateParams}; use coa_core::release::{pack_update, sign_manifest, UpdateParams};
fn args(rest: &[String]) -> HashMap<String, String> { fn args(rest: &[String]) -> HashMap<String, String> {
let mut m = HashMap::new(); let mut m = HashMap::new();
@@ -44,17 +46,38 @@ fn run() -> Result<(), String> {
let e = |x: coa_core::Error| x.to_string(); let e = |x: coa_core::Error| x.to_string();
let part = a.get("part-size").and_then(|v| v.parse().ok()).unwrap_or(DEFAULT_PART_SIZE); let part = a.get("part-size").and_then(|v| v.parse().ok()).unwrap_or(DEFAULT_PART_SIZE);
match cmd.as_str() { match cmd.as_str() {
"extract-schema-base" => {
coa_core::release_schema::extract_base(
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?;
println!("signed base extracted into a disposable database fixture");
}
"schema-contract" => {
let repack = PathBuf::from(need(&a, "repack")?);
let tree = PathBuf::from(need(&a, "tree")?);
if let Some(core) = a.get("core") {
let bots = a.get("bots").map(PathBuf::from);
let repairs = a.get("repairs").map(PathBuf::from);
let sql = coa_core::release_schema::collect(&PathBuf::from(core), bots.as_deref(), repairs.as_deref()).map_err(e)?;
coa_core::release_schema::capture_release(&repack, &tree, &sql).map_err(e)?;
} else {
coa_core::backup::with_database(&repack, |db| coa_core::schema_check::capture(db, &tree)).map_err(e)?;
}
println!("database schema contract captured");
}
"pack-base" => { "pack-base" => {
coa_core::schema_check::require_release_contract(&PathBuf::from(need(&a, "tree")?)).map_err(e)?;
let opts = BuildOptions { kind: Kind::Base, version: need(&a, "version")?.clone(), core_commit: a.get("core-commit").cloned(), built_at: chrono_now(), part_size: part, bots_commit: a.get("bots-commit").cloned(), migrations: vec![] }; let opts = BuildOptions { kind: Kind::Base, version: need(&a, "version")?.clone(), core_commit: a.get("core-commit").cloned(), built_at: chrono_now(), part_size: part, bots_commit: a.get("bots-commit").cloned(), migrations: vec![] };
let m = build(&PathBuf::from(need(&a, "tree")?), &PathBuf::from(need(&a, "out")?), &opts, &|s| eprintln!("{s}")).map_err(e)?; let m = build(&PathBuf::from(need(&a, "tree")?), &PathBuf::from(need(&a, "out")?), &opts, &|s| eprintln!("{s}")).map_err(e)?;
println!("base {}: {} files, {} parts", m.version, m.files.len(), m.archive.as_ref().map(|x| x.parts.len()).unwrap_or(0)); println!("base {}: {} files, {} parts", m.version, m.files.len(), m.archive.as_ref().map(|x| x.parts.len()).unwrap_or(0));
} }
"pack-update" => { "pack-update" => {
let base: Manifest = Manifest::parse(&std::fs::read(need(&a, "base-manifest")?).map_err(|x| x.to_string())?).map_err(e)?; let base: Manifest = Manifest::parse(&std::fs::read(need(&a, "base-manifest")?).map_err(|x| x.to_string())?).map_err(e)?;
let mut sql = collect_core_sql(&PathBuf::from(need(&a, "core")?)).map_err(e)?; coa_core::schema_check::require_release_contract(&PathBuf::from(need(&a, "tree")?)).map_err(e)?;
if let Some(b) = a.get("bots") { let bots = a.get("bots").map(PathBuf::from);
sql.extend(collect_bots_sql(&PathBuf::from(b)).map_err(e)?); let repairs = a.get("repairs").map(PathBuf::from);
} let sql = coa_core::release_schema::collect(&PathBuf::from(need(&a, "core")?), bots.as_deref(), repairs.as_deref()).map_err(e)?;
let out = PathBuf::from(need(&a, "out")?); let out = PathBuf::from(need(&a, "out")?);
let m = pack_update( let m = pack_update(
&UpdateParams { tree: &PathBuf::from(need(&a, "tree")?), base_manifest: &base, sql: &sql, out: &out, version: need(&a, "version")?.clone(), core_commit: a.get("core-commit").cloned(), bots_commit: a.get("bots-commit").cloned(), part_size: part }, &UpdateParams { tree: &PathBuf::from(need(&a, "tree")?), base_manifest: &base, sql: &sql, out: &out, version: need(&a, "version")?.clone(), core_commit: a.get("core-commit").cloned(), bots_commit: a.get("bots-commit").cloned(), part_size: part },
@@ -72,22 +95,29 @@ fn run() -> Result<(), String> {
} }
"sign" => { "sign" => {
let dir = PathBuf::from(need(&a, "dir")?); let dir = PathBuf::from(need(&a, "dir")?);
require_contract_entry(&dir)?;
sign_manifest(&dir, &signing_key()?).map_err(e)?; sign_manifest(&dir, &signing_key()?).map_err(e)?;
coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("signed {}", dir.join("manifest.json").display()); println!("signed {}", dir.join("manifest.json").display());
} }
"verify" => { "verify" => {
let dir = PathBuf::from(need(&a, "dir")?); let dir = PathBuf::from(need(&a, "dir")?);
let bytes = std::fs::read(dir.join("manifest.json")).map_err(|x| x.to_string())?; coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
let sig = std::fs::read_to_string(dir.join("manifest.json.sig")).map_err(|x| x.to_string())?; println!("signature, archive contents and database schema contract OK");
coa_core::signing::verify_embedded(&bytes, &sig).map_err(e)?;
Manifest::parse(&bytes).map_err(e)?;
println!("signature and manifest OK");
} }
other => return Err(format!("unknown command {other}")), other => return Err(format!("unknown command {other}")),
} }
Ok(()) Ok(())
} }
fn require_contract_entry(dir: &std::path::Path) -> Result<(), String> {
let manifest = Manifest::parse(&std::fs::read(dir.join("manifest.json")).map_err(|e| e.to_string())?).map_err(|e| e.to_string())?;
if !manifest.files.iter().any(|f| f.path == coa_core::schema_check::CONTRACT && f.size > 0) {
return Err("The release is missing its database schema contract; refusing to sign or publish it.".into());
}
Ok(())
}
fn chrono_now() -> String { fn chrono_now() -> String {
chrono::Utc::now().to_rfc3339() chrono::Utc::now().to_rfc3339()
} }
+52 -9
View File
@@ -233,18 +233,21 @@ hash**: current == recorded → safe to replace; current ≠ recorded → *modif
2. **Download** to `staging\<txid>\dl\` with `.part` files, HTTP Range resume, retry/backoff, cancel, progress. 2. **Download** to `staging\<txid>\dl\` with `.part` files, HTTP Range resume, retry/backoff, cancel, progress.
3. **Verify** — SHA-256 of every artefact; nothing is executed or extracted into the live tree before this. 3. **Verify** — SHA-256 of every artefact; nothing is executed or extracted into the live tree before this.
4. **Snapshot** — server must be stopped (never copy over a running worldserver); create recovery point: 4. **Snapshot** — server must be stopped (never copy over a running worldserver); create recovery point:
replaced binaries, changed managed configs, module state, `characters`+`auth` dump (world optional); replaced binaries, changed managed configs, module state, full dumps of every managed realm database;
write `txn.json {state: Snapshotted}`. write `txn.json {state: Snapshotted}`.
5. **Apply** into `staging\<txid>\tree\`, resolve ownership conflicts, merge configs, then swap file-by-file with 5. **Apply** into `staging\<txid>\tree\`, resolve ownership conflicts, merge configs, then swap file-by-file with
same-volume atomic renames, journaling each step (`txn.json` lists done/undone operations). same-volume atomic renames, journaling each step (`txn.json` lists done/undone operations).
6. **Migrate** — run pending SQL through the tracked runner (D7); failure ⇒ stop, keep DB backup, offer restore. 6. **Migrate** — durably mark SQL as running before execution. Failure restores the full database recovery point
7. **Validate** — start server, health check (D3) with timeout. before restoring files. Interrupted SQL is never automatically replayed.
7. **Validate** — check database structure, start server, require ten seconds of continuous readiness with timeout.
8. **Commit** — ownership table + `install.json` version bump, mark txn `Committed`, prune staging. 8. **Commit** — ownership table + `install.json` version bump, mark txn `Committed`, prune staging.
Any crash before Commit leaves `txn.json` in a non-terminal state; on next launch the Manager detects it and Any crash before Commit leaves `txn.json` in a non-terminal state; on next launch the Manager detects it and
offers *Roll forward* or *Roll back* — the install is "recoverable" by construction. offers *Roll forward* or *Roll back* — the install is "recoverable" by construction.
Rollback = binaries + managed config state + module state only. Database restore is a **separate explicit Rollback restores files, configuration and installation metadata. Once migrations started, it also restores all
action** (spec §19–20). databases from the full pre-update recovery point. Failed recovery remains unfinished and blocks startup and another
update. The same journal protects Repair. Old transactions without a full recovery point cannot roll back database
changes automatically. Independent database restore remains available for other recovery points.
### D7. Database strategy (`db` module) ### D7. Database strategy (`db` module)
@@ -253,14 +256,15 @@ action** (spec §19–20).
native Rust client (`mysql_async`) is used for health pings and migration ledger reads. native Rust client (`mysql_async`) is used for health pings and migration ledger reads.
* Ledger: table `acore_world.coa_manager_migrations(id, db, sha256, applied_at, status, error)` (created by the * Ledger: table `acore_world.coa_manager_migrations(id, db, sha256, applied_at, status, error)` (created by the
Manager, in a dedicated table — no core schema is changed) mirrored to `.manager\migrations\`. Manager, in a dedicated table — no core schema is changed) mirrored to `.manager\migrations\`.
Statuses `Applied | Pending | Failed`. Each file runs in a single connection; DDL is not transactional, so Statuses `Applied | Pending | Failed | Running`. Each file runs in a single connection; DDL is not transactional, so
"destructive" migrations (flag in manifest, or heuristic scan for `DROP|TRUNCATE|DELETE|ALTER ... DROP`) force "destructive" migrations (flag in manifest, or heuristic scan for `DROP|TRUNCATE|DELETE|ALTER ... DROP`) force
a fresh DB backup first and require explicit confirmation. a fresh DB backup first and require explicit confirmation.
* Backups: `mysqldump --single-transaction --routines --quick` per DB. Quick = characters + auth + configs + * Backups: `mysqldump --single-transaction --routines --quick` per DB. Quick = characters + auth + configs +
metadata; Full adds world (large); Config-only; DB-only. Compressed with zstd. Restore is always to a metadata; Full adds world (large); Config-only; DB-only. Compressed with zstd. Restore is always to a
staging schema first (`…_restore`), swapped only after a row-count sanity check, with the current DB dumped staging schema first (`…_restore`), swapped only after a row-count sanity check, with the current DB dumped
beforehand. beforehand.
* Never: `DROP DATABASE`, resetting characters, overwriting DBs, or restoring DB on a binary rollback. Delete/ * Never: `DROP DATABASE` or resetting characters. Update recovery restores databases into staging schemas and
keeps the replaced tables in separate schemas. Delete/
reset lives only in **Settings → Advanced → Danger Zone**, deletes tracked files only, and refuses to remove a reset lives only in **Settings → Advanced → Danger Zone**, deletes tracked files only, and refuses to remove a
directory that still contains untracked files. directory that still contains untracked files.
* Clean install: extract `mysql\data.7z` (packaged data dir), then **rotate** root/app passwords to fresh random * Clean install: extract `mysql\data.7z` (packaged data dir), then **rotate** root/app passwords to fresh random
@@ -337,6 +341,42 @@ Base package (≈3.2 GB; Data 3.8 GB + mysql data) is split into ≤ 1.9 GB part
with a parts manifest. Reproducibility: pinned runner image label, recorded compiler/vcpkg versions, source SHAs, with a parts manifest. Reproducibility: pinned runner image label, recorded compiler/vcpkg versions, source SHAs,
build timestamp written into RELEASE.json. build timestamp written into RELEASE.json.
### D13. Linux: the servers run in Docker (experimental)
Linux has no repack launcher and no Win32 process API, and the host should need nothing but Docker. A server folder
that contains `Settings/docker.json` is a **Docker installation**; every other folder is a repack, handled by the
code above without any change. `driver::run`, `process::observe` and `layout::scan` check for the marker first and
hand over to `coa_core::docker`; nothing else needed to change for start, stop, status and the server list.
* **Containers** (`docker/lifecycle.rs`): `coa-<project>-db` (official `mysql:8.4`, data in a named volume, not
published on the host), `-world` and `-auth` (a small runtime image holding only the shared libraries; the
binaries are mounted from `Core/`, so an update replaces files and never rebuilds an image). The image tag is a
hash of its Dockerfile.
* **Why the `docker` command line and not `docker compose`**: the compose plugin is missing from some distributions'
Docker packages, and the plan is to ask for as little as possible on the host. The command line is wrapped by a
`Docker` trait (`docker/cli.rs`), so the logic is tested with an in-memory fake.
* **Same folder shape as a repack where it matters**: `Core/configs`, `Core/Logs`, `Settings/repack.json`
(ports, RA login), `Settings/database.json` and `Data/`. Configuration editing, log tailing and the RA console
therefore work as they do on Windows. The container runs as the owner of the folder and starts in `Core/`.
* **Settings forced by environment** (the core reads `AC_<KEY>` before the `.conf`): `AC_BIND_IP=0.0.0.0` (the
published address, `bindAddress`, decides who can connect), `AC_DATA_DIR`, `AC_LOGS_DIR`, `AC_RA_ENABLE`,
`AC_RA_IP`, and `AC_UPDATES_ENABLE_DATABASES=0`: the server's own database updater needs a `mysql` client program and
stops the server without one; the Manager applies database updates itself (section 1.4). The remote console is published
on `127.0.0.1` only.
* **Secrets** go to `docker` by environment (`--env NAME` without a value), never on a command line.
* **Order**: database healthy, then world listening, then auth. The auth server exits when no realm is online.
Readiness is a connection that stays open: Docker's proxy accepts connections on a published port before the server
inside listens, so a plain connect proves nothing.
* **Configuration path in the binaries**: Linux builds must use `-DCONF_DIR=configs` (see `coa-server-build`),
otherwise the core looks for module configs in a path baked in at build time.
* **Database access** (`db.rs`): for a Docker installation `Db` runs `mysql`, `mysqldump` and `mysqladmin` inside the
database container with `docker exec -i`, connecting over TCP on the container's loopback exactly as the repack's
commands do on the host (password through `MYSQL_PWD`, never on a command line). Nothing else changes: accounts,
backups, the population query, migrations and the RA service account all go through `Db`, and the host needs no
MySQL client. A repack keeps using its bundled tools.
* **Not done yet**: installation and the database setup (schemas, `acore` user), updates, port conflict detection,
the firewall and exposure checks, the Wildcard realm profiles, and the client under Wine/Proton.
--------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------
## 3. Flows ## 3. Flows
@@ -361,8 +401,11 @@ files the running server itself changes, diffed before/after.
disk-full at write n, network cut at byte n, migration returns error, new worldserver exits non-zero, port disk-full at write n, network cut at byte n, migration returns error, new worldserver exits non-zero, port
taken, exe quarantined (file vanishes), folder moved, user-modified managed file, unknown config keys. taken, exe quarantined (file vanishes), folder moved, user-modified managed file, unknown config keys.
### 3.4 Rollback — restore recovery point's binaries/configs/module state; database untouched unless the user ### 3.4 Rollback — restore the pre-update databases when migrations started, followed by files and metadata
picks "Restore database" separately (shows dump timestamp and warns that progress since then is lost).
The UI explains that progress after the recovery point is lost. SQL failures before startup recover automatically;
failed health checks keep the installation blocked until the owner chooses recovery. Every recovery point and staging
schema has a unique identifier, and corrupt update journals fail closed.
--------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------
+44
View File
@@ -0,0 +1,44 @@
# Database checks, repair and simultaneous worlds
Settings includes **Check files and database**, **Repair**, and **Start CoA and Wildcard together**.
Database checks inspect both realm schemas when Wildcard exists, the migration ledger, character-save columns and CoA starting class data. Results are saved in the installation metadata's `logs/database-checks.json` and included in exported diagnostics. Hash checks skip mutable MySQL data and configuration files.
Repair requires both worlds and auth to be stopped, no unfinished update, and the installed version to match the currently published signed update. The signed base must match the installed base as well. It verifies packages before changing files, creates a full database/config backup, saves every replaced file and a recovery inventory under `<server>.manager/repairs/<backup-id>/`, then restores official files and applies pending migrations to both worlds. Settings and player databases are not replaced. A failure during file replacement restores the original files. Interrupted repair can be retried; its file inventory and backups remain available.
Repair reports unresolved schema damage. It does not guess ALTER statements or replay already applied SQL: those cases need a new corrective migration. Applied SQL whose recorded SHA-256 changed is reported and rejected. Manager failure records take precedence over the core's old `updates` entries.
## Release schema contracts
`clean-base` clears the character migration ledger after rebuilding the character database and captures `Scripts/database-schema.json`. It contains expected table/column names and column types. Installation and migration validation inspect this contract; older packages receive the narrower character-save checks, clearly labelled in the UI.
For each update, capture a fresh contract **from a disposable database already migrated to the exact packaged core**, into the release tree before `pack-update`:
```powershell
cargo run -p coa-release -- extract-schema-base --package C:\games\signed-base --fixture C:\games\coa-schema-fixture-build
cargo run -p coa-release -- schema-contract --repack C:\games\coa-schema-fixture-build --tree C:\games\release-tree --core C:\games\release-core --bots C:\games\release-bots --repairs C:\games\release-repairs
```
The first command verifies every entry in the signed base archive and extracts only the runtime needed for a disposable database. The second applies the release SQL with temporary ports, checks critical feature tables independently of migration history, and captures the resulting schema. It requires the disposable fixture marker and never starts a world server.
Base and update packaging require a complete contract for all three databases. Cumulative updates always carry it, even when unchanged. Signing and verification check the archive contents and contract before publication. Never capture it from a user's server or from an unmigrated previous release database.
Corrective SQL under `repairs/{auth,characters,world}` receives new `manager_repair__` migration IDs and runs after historical SQL. Missing Wildcard tables can therefore be restored without replaying historical data deletion. Existing malformed tables still fail schema checks; creating a missing table does not recover its lost rows.
## Simultaneous worlds
On Windows the checkbox creates Wildcard when needed and saves distinct secondary world/RA ports. Both worlds start with one shared authserver/MySQL and separate world/character databases. The second world has its own executable copy, config, supervisor, logs and report spool in `.realms/secondary`; Data is read through the primary installation's absolute path. This runtime folder is excluded from packages.
The selected realm remains the primary world used by the Manager's console, companions, settings and Play. Selecting another realm still stops/restarts both to preserve that relationship. CoA companion restrictions on Wildcard remain in force. Both world statuses are shown on Overview.
Stop shuts down the secondary supervisor/world before the primary launcher may stop the shared database. Database restores, updates and profile changes reject a running secondary world. Each start refreshes its executable/config copies, so server updates cannot leave an old secondary binary behind. The secondary world inherits the primary network bind setting; its RA console remains on loopback. Enabling friends networking opens/maps both world ports. If networking was enabled before the second realm, enable it again to add the second port's rule/mapping.
## Disposable probes
```powershell
cargo run -p coa-core --example multiworld_e2e -- C:\games\your-fixture
cargo run -p coa-core --example repair_e2e -- C:\games\your-fixture
cargo run -p coa-core --example schema_e2e -- C:\games\your-fixture
```
The first checks both processes, ports, shared services and graceful shutdown. The second uses a test-only signing key, corrupts a fixture file, applies SQL to both worlds, verifies backups and account/character counts, and drops a column only in Wildcard to prove schema checks are isolated. These probes modify the fixture; never use a real server.
+42
View File
@@ -0,0 +1,42 @@
# Realm profiles
Overview offers CoA and Wildcard. The installed worldserver must contain Wildcard support and the database must
already have its Wildcard migrations. The Manager refuses an unsupported binary, an occupied realm ID 2 or an
existing destination database rather than overwrite them.
The first switch copies the CoA world into `acore_world_wildcard` and creates `acore_characters_wildcard` from
the character schema and neutral server seed tables. Existing characters, card collections and progress are not
copied. Accounts remain in shared `acore_auth`. Realm IDs 1 and 2 share the world port; only the selected world
runs, and the inactive realm is listed offline. A switch while running stops the server gracefully and restarts it.
Configuration profiles are saved under `Settings/realm-profiles`. An interrupted switch can restore its previous
configuration from the journal. CoA companion bots cannot be enabled on Wildcard. Content Scaling and the other
optional modules retain their settings but show experimental compatibility; class mechanics need separate gameplay
validation. Switching back restores the CoA module settings.
Quick/database backups include both character databases and shared auth. Full backups also include both worlds.
Recovery points identify their active realm; select that realm before restoring them. Server migrations apply to
both realms, with auth applied once. The server updater can replace its launcher: the Manager reapplies the realm
adapter before the next start.
![Wildcard overview](screenshots/wildcard-demo/overview.jpg)
![Module compatibility](screenshots/wildcard-demo/modules.jpg)
## Validation for v0.5.0
- `cargo test --workspace`: 178 core tests passed; command layer and examples compiled.
- `npm run build`, translation key checks and changelog validation passed.
- Native disposable fixture on offset ports: fresh Wildcard creation and startup, CoA startup after switching back,
separate probe values and restored CoA configuration. A second fresh creation verified the arena-season seed fix.
- Full backup verified both worlds, both character databases, shared auth and configurations.
- Native migration probe applied once to each realm and once to auth; repeating it did nothing.
- Restoring Wildcard characters removed a fixture-only change and preserved the CoA probe value.
- Core gameplay wrapper: `VERIFY ALL: PASSED`, gameplay stage only, real clock. First login (7 assertions),
level rolls/reroll (31), skill card rolls (13), stat path (12). The level-roll and skill-card scenarios passed on isolated
reruns after failing in the shared batch; the wrapper records two batch-sensitive cases.
- Browser demo verified active profile, hidden Bots navigation and module compatibility labels. Screenshots show
mock IPC; native checks above exercised the actual backend and server.
The gameplay harness required fixture-only synchronization of already applied migration history by verified SQL
hashes and its normal Windows module config path. Owned server files and databases were not modified.
Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

+11 -6
View File
@@ -76,10 +76,12 @@
"fr": "Remplit l'hôtel des ventes d'annonces réalistes et réglables.", "fr": "Remplit l'hôtel des ventes d'annonces réalistes et réglables.",
"es": "Llena la casa de subastas con ofertas realistas y ajustables." "es": "Llena la casa de subastas con ofertas realistas y ajustables."
}, },
"repo": "https://github.com/NathanHandley/mod-ah-bot-plus", "repo": "https://github.com/Corfirean/azerothcore-wotlk-coa/tree/coa-bots/modules/mod-ah-bot-plus",
"conf": "mod_ahbot.conf", "conf": "mod_ahbot.conf",
"switchable": false, "enable_key": "AuctionHouseBot.Enable",
"status": "soon", "default_on": false,
"switchable": true,
"status": "early",
"icon": "gavel" "icon": "gavel"
}, },
{ {
@@ -112,9 +114,12 @@
}, },
"repo": "https://github.com/Zyth45/mod-playerbots", "repo": "https://github.com/Zyth45/mod-playerbots",
"conf": "playerbots.conf", "conf": "playerbots.conf",
"switchable": false, "switchable": true,
"status": "soon", "status": "early",
"icon": "swords" "icon": "swords",
"enable_key": "AiPlayerbot.Enabled",
"default_on": false,
"page": "bots"
}, },
{ {
"id": "client-compat", "id": "client-compat",
+2 -2
View File
@@ -1,12 +1,12 @@
{ {
"name": "coa-server-manager", "name": "coa-server-manager",
"version": "0.1.0", "version": "0.6.2",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "coa-server-manager", "name": "coa-server-manager",
"version": "0.1.0", "version": "0.6.2",
"dependencies": { "dependencies": {
"@tauri-apps/api": "^2.12.0", "@tauri-apps/api": "^2.12.0",
"@tauri-apps/plugin-dialog": "^2.8.0", "@tauri-apps/plugin-dialog": "^2.8.0",
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"name": "coa-server-manager", "name": "coa-server-manager",
"private": true, "private": true,
"version": "0.4.0", "version": "0.6.2",
"license": "AGPL-3.0-only", "license": "AGPL-3.0-only",
"type": "module", "type": "module",
"scripts": { "scripts": {
+3 -3
View File
@@ -157,7 +157,7 @@
"type": "float", "type": "float",
"category": "rates", "category": "rates",
"title": "Rested bonus while playing", "title": "Rested bonus while playing",
"description": "Speed at which rested experience is used up while you play.", "description": "Speed at which rested experience accumulates while online in a rest area.",
"default": 1, "default": 1,
"advanced": true, "advanced": true,
"restartRequired": "world", "restartRequired": "world",
@@ -637,8 +637,8 @@
"key": "Rate.Talent", "key": "Rate.Talent",
"type": "float", "type": "float",
"category": "rates", "category": "rates",
"title": "Talent points", "title": "Standard talent points (AzerothCore)",
"description": "Multiplier for the talent points a character earns per level.", "description": "Only affects standard AzerothCore talents. CoA class and specialization points come from client data and ignore this multiplier.",
"default": 1, "default": 1,
"advanced": true, "advanced": true,
"restartRequired": "world", "restartRequired": "world",
+1
View File
@@ -16,6 +16,7 @@ tauri = { version = "2", features = [] }
tauri-plugin-dialog = "2" tauri-plugin-dialog = "2"
tauri-plugin-updater = "2" tauri-plugin-updater = "2"
tauri-plugin-process = "2" tauri-plugin-process = "2"
tauri-plugin-opener = "2"
serde = { version = "1", features = ["derive"] } serde = { version = "1", features = ["derive"] }
serde_json = "1" serde_json = "1"
coa-core = { path = "../crates/coa-core" } coa-core = { path = "../crates/coa-core" }
+128 -17
View File
@@ -70,11 +70,24 @@ struct StatusView {
path_exists: bool, path_exists: bool,
} }
/// Where the Manager keeps its own state (server list, logs). `%LOCALAPPDATA%` on Windows, the XDG data folder elsewhere.
fn data_dir() -> PathBuf { fn data_dir() -> PathBuf {
#[cfg(windows)]
let base = std::env::var_os("LOCALAPPDATA").map(PathBuf::from).unwrap_or_else(std::env::temp_dir); let base = std::env::var_os("LOCALAPPDATA").map(PathBuf::from).unwrap_or_else(std::env::temp_dir);
#[cfg(not(windows))]
let base = unix_data_home(std::env::var_os("XDG_DATA_HOME"), std::env::var_os("HOME"));
base.join("CoAServerManager") base.join("CoAServerManager")
} }
/// `$XDG_DATA_HOME` when it is an absolute path (the spec says to ignore relative ones), else `~/.local/share`.
#[cfg(not(windows))]
fn unix_data_home(xdg: Option<std::ffi::OsString>, home: Option<std::ffi::OsString>) -> PathBuf {
xdg.map(PathBuf::from)
.filter(|p| p.is_absolute())
.or_else(|| home.map(|h| PathBuf::from(h).join(".local/share")))
.unwrap_or_else(std::env::temp_dir)
}
fn path_of(state: &AppState, id: &str) -> Result<PathBuf> { fn path_of(state: &AppState, id: &str) -> Result<PathBuf> {
state state
.registry .registry
@@ -189,13 +202,17 @@ async fn run_verb(state: &AppState, id: String, verb: Verb) -> std::result::Resu
#[tauri::command] #[tauri::command]
async fn start_server(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> { async fn start_server(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> {
let _guard = BusyGuard::acquire(&state, &id)?;
// Servers installed before module configs were created automatically get them now (missing files only). Imported // Servers installed before module configs were created automatically get them now (missing files only). Imported
// servers are never written to by the Manager outside the launcher's own start-up. // servers only get the module files they lack (see below); nothing they have is changed.
if let Ok(root) = path_of(&state, &id) { if let Ok(root) = path_of(&state, &id) {
let _ = tauri::async_runtime::spawn_blocking(move || { let _ = tauri::async_runtime::spawn_blocking(move || {
let (_, meta) = install_meta(&root)?; let (_, meta) = install_meta(&root)?;
if meta.kind == coa_core::registry::InstallKind::New { if meta.kind == coa_core::registry::InstallKind::New {
coa_core::config::materialize_module_configs(&root)?; coa_core::config::materialize_module_configs(&root)?;
} else {
// Imported: only the module files that are missing (a module without its file logs every setting it reads).
let _ = coa_core::config::create_missing_module_configs(&root);
} }
let dir = meta_dir(&root)?; let dir = meta_dir(&root)?;
coa_core::friends::ensure_bind(&root, &dir)?; coa_core::friends::ensure_bind(&root, &dir)?;
@@ -206,12 +223,14 @@ async fn start_server(state: State<'_, AppState>, id: String) -> std::result::Re
}) })
.await; .await;
} }
let out = run_verb(&state, id.clone(), Verb::StartAll).await?; let root = path_of(&state, &id)?;
let out = blocking(move || driver::run(&root, Verb::StartAll)).await?;
if out.ok { if out.ok {
if let Ok(root) = path_of(&state, &id) { if let Ok(root) = path_of(&state, &id) {
// Companions requested while the server was stopped are created now (once; a failure is only logged). // Companions requested while the server was stopped are created now (once; a failure is only logged).
let r = root.clone(); let r = root.clone();
let _ = tauri::async_runtime::spawn_blocking(move || -> Result<()> { let _ = tauri::async_runtime::spawn_blocking(move || -> Result<()> {
if coa_core::realms::guard_module(&r, "companions").is_err() { return Ok(()); }
let pending = meta_dir(&r)?.join("companions.pending.json"); let pending = meta_dir(&r)?.join("companions.pending.json");
if let Ok(v) = coa_core::fsx::read_json::<serde_json::Value>(&pending) { if let Ok(v) = coa_core::fsx::read_json::<serde_json::Value>(&pending) {
let _ = std::fs::remove_file(&pending); let _ = std::fs::remove_file(&pending);
@@ -275,6 +294,7 @@ async fn save_settings(
changes: BTreeMap<String, Value>, changes: BTreeMap<String, Value>,
) -> std::result::Result<config::SaveReport, UiError> { ) -> std::result::Result<config::SaveReport, UiError> {
let root = path_of(&state, &id)?; let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || { blocking(move || {
let meta = meta_dir(&root)?; let meta = meta_dir(&root)?;
config::save(&root, &meta, scope, &changes) config::save(&root, &meta, scope, &changes)
@@ -509,9 +529,65 @@ async fn modules_list(state: State<'_, AppState>, id: String) -> std::result::Re
blocking(move || Ok(coa_core::modules::list(&root))).await blocking(move || Ok(coa_core::modules::list(&root))).await
} }
#[tauri::command]
async fn realm_profiles(state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::realms::View, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::realms::view(&root)).await
}
#[tauri::command]
async fn realm_select(state: State<'_, AppState>, id: String, mode: coa_core::realms::Mode, restart: bool) -> std::result::Result<coa_core::realms::View, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
let result = blocking(move || {
if restart {
let out = driver::run(&root, Verb::StopAll)?;
if !out.ok { return Err(Error::Invalid(out.output)); }
}
let view = coa_core::realms::select(&root, mode)?;
let (dir, meta) = install_meta(&root)?;
if let Some(client) = meta.client_path {
coa_core::client::sync_realm(std::path::Path::new(&client), &dir, view.active)?;
}
if restart {
let out = driver::run(&root, Verb::StartAll)?;
if !out.ok { return Err(Error::Invalid(format!("Realm selected, but startup failed: {}", out.output))); }
}
Ok(view)
}).await;
result
}
#[tauri::command]
async fn realm_simultaneous(state: State<'_, AppState>, id: String, enabled: bool) -> std::result::Result<coa_core::realms::View, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || coa_core::multiworld::set_enabled(&root, enabled)).await
}
#[tauri::command]
async fn check_database(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<coa_core::repair::DatabaseCheck>, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || coa_core::repair::check(&root, &meta_dir(&root)?)).await
}
#[tauri::command]
async fn repair_server(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::repair::Report, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let dir = meta_dir(&root)?;
coa_core::repair::run(&root, &dir, &package_source(None), &update_source(None), coa_core::signing::EMBEDDED_PUBLIC_KEY, &|step,percent| {
let _ = app.emit("repair-progress", serde_json::json!({ "id": id, "step": step, "percent": percent }));
})
}).await
}
#[tauri::command] #[tauri::command]
async fn module_set_enabled(state: State<'_, AppState>, id: String, module: String, enabled: bool) -> std::result::Result<(), UiError> { async fn module_set_enabled(state: State<'_, AppState>, id: String, module: String, enabled: bool) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?; let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || { blocking(move || {
let (dir, _) = install_meta(&root)?; let (dir, _) = install_meta(&root)?;
coa_core::modules::set_enabled(&root, &dir, &module, enabled) coa_core::modules::set_enabled(&root, &dir, &module, enabled)
@@ -528,6 +604,7 @@ async fn module_settings(state: State<'_, AppState>, id: String, module: String)
#[tauri::command] #[tauri::command]
async fn module_save_settings(state: State<'_, AppState>, id: String, module: String, changes: BTreeMap<String, String>) -> std::result::Result<Vec<String>, UiError> { async fn module_save_settings(state: State<'_, AppState>, id: String, module: String, changes: BTreeMap<String, String>) -> std::result::Result<Vec<String>, UiError> {
let root = path_of(&state, &id)?; let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || { blocking(move || {
let (dir, _) = install_meta(&root)?; let (dir, _) = install_meta(&root)?;
coa_core::modules::save_settings(&root, &dir, &module, &changes) coa_core::modules::save_settings(&root, &dir, &module, &changes)
@@ -544,6 +621,7 @@ async fn all_settings(state: State<'_, AppState>, id: String) -> std::result::Re
#[tauri::command] #[tauri::command]
async fn all_settings_save(state: State<'_, AppState>, id: String, changes: BTreeMap<String, String>) -> std::result::Result<Vec<String>, UiError> { async fn all_settings_save(state: State<'_, AppState>, id: String, changes: BTreeMap<String, String>) -> std::result::Result<Vec<String>, UiError> {
let root = path_of(&state, &id)?; let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || { blocking(move || {
let (dir, _) = install_meta(&root)?; let (dir, _) = install_meta(&root)?;
coa_core::allsettings::save(&root, &dir, &changes) coa_core::allsettings::save(&root, &dir, &changes)
@@ -637,7 +715,7 @@ async fn apply_update(
let (dir, _) = install_meta(&root)?; let (dir, _) = install_meta(&root)?;
// Files cannot be replaced while the server runs: stop it first (gracefully), like the Stop button. // Files cannot be replaced while the server runs: stop it first (gracefully), like the Stop button.
let observed = coa_core::process::observe(&root, &layout::read_ports(&root)); let observed = coa_core::process::observe(&root, &layout::read_ports(&root));
if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped { if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped || coa_core::multiworld::is_running(&root) {
let out = driver::run(&root, Verb::StopAll)?; let out = driver::run(&root, Verb::StopAll)?;
if !out.ok { if !out.ok {
return Err(Error::Invalid("The server could not be stopped, so the update was not started.".into())); return Err(Error::Invalid("The server could not be stopped, so the update was not started.".into()));
@@ -1068,23 +1146,20 @@ fn end_client_job(state: &AppState) {
} }
} }
/// Start the server if needed, wait until it is ready, then launch the game client. /// Launch the game client independently of the local server.
#[tauri::command] #[tauri::command]
async fn play(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> { async fn play(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> {
let root = path_of(&state, &id)?; let root = path_of(&state, &id)?;
let (_, _, client) = client_of(&root)?; let (dir, _, client) = client_of(&root)?;
let client = client.unwrap(); let client = client.unwrap();
let ready = { if coa_core::client::is_running(&client) {
let o = coa_core::process::observe(&root, &layout::read_ports(&root)); return Err(Error::Invalid("Close the game client before pressing Play so its selected realm can be updated.".into()).into());
[&o.mysql, &o.auth, &o.world].iter().all(|s| s.state == coa_core::process::ServiceState::Running)
};
if !ready {
let out = run_verb(&state, id, Verb::StartAll).await?;
if !out.ok {
return Ok(out);
}
} }
blocking(move || { blocking(move || {
let mode = coa_core::realms::state(&root)?.active;
if !coa_core::client::sync_realm(&client, &dir, mode)? {
return Err(Error::Invalid("Close the game client before pressing Play so its selected realm can be updated.".into()));
}
coa_core::client::launch(&client)?; coa_core::client::launch(&client)?;
Ok(DriverOutcome { ok: true, exit_code: None, code: None, human: None, output: String::new() }) Ok(DriverOutcome { ok: true, exit_code: None, code: None, human: None, output: String::new() })
}) })
@@ -1103,6 +1178,7 @@ struct FriendsStatus {
server_running: bool, server_running: bool,
auth_port: u16, auth_port: u16,
world_port: u16, world_port: u16,
secondary_world_port: Option<u16>,
} }
/// Open one of a few known help pages in the default browser. Anything else is refused, so a page can never ask the /// Open one of a few known help pages in the default browser. Anything else is refused, so a page can never ask the
@@ -1120,8 +1196,7 @@ fn open_link(url: String) -> std::result::Result<(), UiError> {
if !(issue || catalog || ALLOWED.iter().any(|p| url.starts_with(p))) || !chars_ok || url.len() > 12_000 { if !(issue || catalog || ALLOWED.iter().any(|p| url.starts_with(p))) || !chars_ok || url.len() > 12_000 {
return Err(Error::Invalid("That link is not allowed.".into()).into()); return Err(Error::Invalid("That link is not allowed.".into()).into());
} }
// explorer.exe opens the address in the default browser without going through a shell. tauri_plugin_opener::open_url(&url, None::<&str>).map_err(|e| Error::Invalid(e.to_string()))?;
std::process::Command::new("explorer.exe").arg(&url).spawn().map_err(|e| Error::Invalid(e.to_string()))?;
Ok(()) Ok(())
} }
@@ -1184,6 +1259,7 @@ async fn friends_status(state: State<'_, AppState>, id: String) -> std::result::
server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running, server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running,
auth_port: ports.auth, auth_port: ports.auth,
world_port: ports.world, world_port: ports.world,
secondary_world_port: coa_core::realms::state(&root)?.secondary_world_port.filter(|_| coa_core::realms::state(&root).is_ok_and(|s| s.simultaneous)),
}) })
}) })
.await .await
@@ -1237,6 +1313,8 @@ async fn friends_enable(
let meta = meta_dir(&root)?; let meta = meta_dir(&root)?;
let ports = layout::read_ports(&root); let ports = layout::read_ports(&root);
let mut note = None; let mut note = None;
let realms = coa_core::realms::state(&root)?;
let secondary = realms.secondary_world_port.filter(|_| realms.simultaneous);
let host = match mode { let host = match mode {
Mode::Local => "127.0.0.1".to_string(), Mode::Local => "127.0.0.1".to_string(),
Mode::Lan => coa_core::net::lan_ip().ok_or_else(|| Error::Invalid("This computer has no network address.".into()))?.to_string(), Mode::Lan => coa_core::net::lan_ip().ok_or_else(|| Error::Invalid("This computer has no network address.".into()))?.to_string(),
@@ -1246,7 +1324,7 @@ async fn friends_enable(
let open = mode != Mode::Local; let open = mode != Mode::Local;
let changed = friends::set_open(&root, &meta, open)?; let changed = friends::set_open(&root, &meta, open)?;
if open { if open {
coa_core::firewall::ensure_rules(&ports)?; coa_core::firewall::ensure_rules_with_secondary(&ports, secondary)?;
} }
if mode == Mode::Direct && use_upnp { if mode == Mode::Direct && use_upnp {
match coa_core::upnp::discover() { match coa_core::upnp::discover() {
@@ -1254,6 +1332,7 @@ async fn friends_enable(
let lan = coa_core::net::lan_ip().ok_or_else(|| Error::Invalid("No local address.".into()))?; let lan = coa_core::net::lan_ip().ok_or_else(|| Error::Invalid("No local address.".into()))?;
coa_core::upnp::add_mapping(&gw, ports.auth, lan, "Auth")?; coa_core::upnp::add_mapping(&gw, ports.auth, lan, "Auth")?;
coa_core::upnp::add_mapping(&gw, ports.world, lan, "World")?; coa_core::upnp::add_mapping(&gw, ports.world, lan, "World")?;
if let Some(port) = secondary { coa_core::upnp::add_mapping(&gw, port, lan, "Second world")?; }
note = Some("Your router was asked to forward the game ports.".to_string()); note = Some("Your router was asked to forward the game ports.".to_string());
} }
None => note = Some("Your router does not support automatic setup; forward the two game ports by hand or use the private network.".to_string()), None => note = Some("Your router does not support automatic setup; forward the two game ports by hand or use the private network.".to_string()),
@@ -1392,6 +1471,11 @@ pub fn run() {
realmlist_delete, realmlist_delete,
realmlist_activate, realmlist_activate,
modules_list, modules_list,
realm_profiles,
realm_select,
realm_simultaneous,
check_database,
repair_server,
module_set_enabled, module_set_enabled,
module_settings, module_settings,
module_save_settings, module_save_settings,
@@ -1442,3 +1526,30 @@ pub fn run() {
.run(tauri::generate_context!()) .run(tauri::generate_context!())
.expect("error while running CoA Server Manager"); .expect("error while running CoA Server Manager");
} }
#[cfg(all(test, not(windows)))]
mod tests {
use super::unix_data_home;
use std::ffi::OsString;
use std::path::PathBuf;
fn os(s: &str) -> Option<OsString> {
Some(s.into())
}
#[test]
fn data_home_prefers_an_absolute_xdg_folder() {
assert_eq!(unix_data_home(os("/data/xdg"), os("/home/u")), PathBuf::from("/data/xdg"));
}
#[test]
fn data_home_ignores_a_relative_xdg_folder_and_falls_back_to_home() {
assert_eq!(unix_data_home(os("relative/dir"), os("/home/u")), PathBuf::from("/home/u/.local/share"));
assert_eq!(unix_data_home(None, os("/home/u")), PathBuf::from("/home/u/.local/share"));
}
#[test]
fn data_home_without_any_variable_uses_the_temp_folder() {
assert_eq!(unix_data_home(None, None), std::env::temp_dir());
}
}
+6
View File
@@ -1,5 +1,11 @@
#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
fn main() { fn main() {
// WebKitGTK's DMA-BUF renderer ends the process with a Wayland "Protocol error" on some graphics stacks (seen with
// an NVIDIA card on Wayland). The path without it works everywhere; a value set by the user is left alone.
#[cfg(target_os = "linux")]
if std::env::var_os("WEBKIT_DISABLE_DMABUF_RENDERER").is_none() {
std::env::set_var("WEBKIT_DISABLE_DMABUF_RENDERER", "1");
}
coa_server_manager_lib::run() coa_server_manager_lib::run()
} }
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"$schema": "https://schema.tauri.app/config/2", "$schema": "https://schema.tauri.app/config/2",
"productName": "CoA Server Manager", "productName": "CoA Server Manager",
"version": "0.4.0", "version": "0.6.2",
"identifier": "com.coa.servermanager", "identifier": "com.coa.servermanager",
"build": { "build": {
"beforeDevCommand": "npm run dev", "beforeDevCommand": "npm run dev",
+22 -10
View File
@@ -1,4 +1,5 @@
// Dev-only: lets the UI run in a plain browser for visual review. Never bundled in production builds. // Dev-only: lets the UI run in a plain browser for visual review. Never bundled in production builds.
import { auctionCategories, auctionQualities } from "../lib/moduleSettings";
import botsSchema from "../../schemas/bots.json"; import botsSchema from "../../schemas/bots.json";
import serverSchema from "../../schemas/server.json"; import serverSchema from "../../schemas/server.json";
import botsPresets from "../../schemas/presets/bots.json"; import botsPresets from "../../schemas/presets/bots.json";
@@ -6,9 +7,12 @@ import serverPresets from "../../schemas/presets/server.json";
export {}; export {};
(() => { (() => {
let added = false, running = false; let added = new URLSearchParams(location.search).has("demo"), running = false;
let realm: "coa" | "wildcard" = "coa", wildcardCreated = false;
let simultaneous = false;
const moduleEdits: Record<string, Record<string, string>> = {};
const modState: Record<string, boolean> = { "companions": true, "content-scaling": true, "client-compat": true, "tbc-content": true, "wotlk-content": true, "npc-enchanter": true }; const modState: Record<string, boolean> = { "companions": true, "content-scaling": true, "client-compat": true, "tbc-content": true, "wotlk-content": true, "npc-enchanter": true };
const report = {path:"C:\games\CoA-Repack",classification:"healthy",items:[ const report = {path:"C:\\games\\CoA-Repack",classification:"healthy",items:[
{key:"worldserver",label:"World server",status:"found",detail:null}, {key:"worldserver",label:"World server",status:"found",detail:null},
{key:"authserver",label:"Auth server",status:"found",detail:null}, {key:"authserver",label:"Auth server",status:"found",detail:null},
{key:"database_content",label:"Auth / Characters / World databases",status:"found",detail:"acore_auth, acore_characters, acore_world"}, {key:"database_content",label:"Auth / Characters / World databases",status:"found",detail:"acore_auth, acore_characters, acore_world"},
@@ -17,16 +21,22 @@ export {};
worldserver:null,authserver:null,banner_revision:"3567e2f8e9d5",bot_config_keys:71,client:null, worldserver:null,authserver:null,banner_revision:"3567e2f8e9d5",bot_config_keys:71,client:null,
notes:["worldserver.exe differs from the one listed in RELEASE.json (release 2026-09-11); this looks like a customised build."],modifies_files:false}; notes:["worldserver.exe differs from the one listed in RELEASE.json (release 2026-09-11); this looks like a customised build."],modifies_files:false};
const svc=(n: string,p: number,st: string)=>({name:n,state:st,pid:st==="running"?100:null,port:p,port_ready:st==="running",conflict:null,uptime_secs:st==="running"?4206:null}); const svc=(n: string,p: number,st: string)=>({name:n,state:st,pid:st==="running"?100:null,port:p,port_ready:st==="running",conflict:null,uptime_secs:st==="running"?4206:null});
{ const q = new URLSearchParams(location.search); const w0 = window as any; if (q.get("client")) w0.__client = q.get("client"); if (q.get("modified")) w0.__modified = true; }
(window as any).__TAURI_INTERNALS__ = { (window as any).__TAURI_INTERNALS__ = {
transformCallback: (cb: unknown)=>cb, unregisterCallback(){}, convertFileSrc:(x: unknown)=>x, transformCallback: (cb: unknown)=>cb, unregisterCallback(){}, convertFileSrc:(x: unknown)=>x,
invoke: async (cmd: string, args?: any)=>{ invoke: async (cmd: string, args?: any)=>{
if(cmd==="realm_profiles") return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:simultaneous&&running};
if(cmd==="realm_simultaneous") { if(running) throw new Error("Stop both realms before changing simultaneous startup."); simultaneous=args.enabled; wildcardCreated ||= simultaneous; return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:false}; }
if(cmd==="check_database") return [{realm, migrations:[],problems:[],full_schema:false}];
if(cmd==="repair_server") { if(running) throw new Error("Stop the server before repairing it."); return {restored:[],applied:[],backup:"demo-before-repair",database:[{realm,migrations:[],problems:[],full_schema:false}],error:null}; }
if(cmd==="realm_select"){await new Promise(r=>setTimeout(r,600));realm=args.mode;wildcardCreated ||= realm==="wildcard";modState.companions=realm==="coa";return {active:realm,wildcard_created:wildcardCreated,supported:true,recovery_pending:false,simultaneous,secondary_world_port:simultaneous?8086:null,secondary_running:simultaneous&&running};}
if(cmd==="list_servers") return added?[{id:"1",name:"CoA-Repack",path:report.path}]:[]; if(cmd==="list_servers") return added?[{id:"1",name:"CoA-Repack",path:report.path}]:[];
if(cmd==="scan_server") return report; if(cmd==="scan_server") return report;
if(cmd==="add_server"){added=true;return {id:"1",name:"CoA-Repack",path:report.path};} if(cmd==="add_server"){added=true;return {id:"1",name:"CoA-Repack",path:report.path};}
if(cmd==="server_status"){const s=running?"running":"stopped";return {observed:{mysql:svc("mysql",3307,s),auth:svc("auth",3724,s),world:svc("world",8085,s)},busy:false,path_exists:true};} if(cmd==="server_status"){const s=running?"running":"stopped";return {observed:{mysql:svc("mysql",3307,s),auth:svc("auth",3724,s),world:svc("world",8085,s),secondary_world:simultaneous?svc("world-secondary",8086,s):null},busy:false,path_exists:true};}
if(cmd==="start_server"){await new Promise((r: any)=>setTimeout(r,1500));running=true;return {ok:true,exit_code:0,code:null,human:null,output:""};} if(cmd==="start_server"){await new Promise((r: any)=>setTimeout(r,1500));running=true;return {ok:true,exit_code:0,code:null,human:null,output:""};}
if(cmd==="stop_server"){await new Promise((r: any)=>setTimeout(r,1500));running=false;return {ok:true,exit_code:0,code:null,human:null,output:""};} if(cmd==="stop_server"){await new Promise((r: any)=>setTimeout(r,1500));running=false;return {ok:true,exit_code:0,code:null,human:null,output:""};}
if(cmd.startsWith("plugin:dialog")) return "C:\games\CoA-Repack"; if(cmd.startsWith("plugin:dialog")) return "C:\\games\\CoA-Repack";
if(cmd==="get_settings"){const sc=args?.scope==="server"?serverSchema:botsSchema;return {scope:args?.scope,categories:sc.categories,settings:(sc.settings as any[]).map(x=>({...x,options:x.options??[],value:x.default,is_default:true,present:true,problem:null,drift:false})),unknown_keys:3,drift_keys:[],files:[]};} if(cmd==="get_settings"){const sc=args?.scope==="server"?serverSchema:botsSchema;return {scope:args?.scope,categories:sc.categories,settings:(sc.settings as any[]).map(x=>({...x,options:x.options??[],value:x.default,is_default:true,present:true,problem:null,drift:false})),unknown_keys:3,drift_keys:[],files:[]};}
if(cmd==="list_presets"){const pr=args?.scope==="server"?serverPresets:botsPresets;return (pr.presets as any[]).map(p=>({id:p.id,title:p.title,description:p.description}));} if(cmd==="list_presets"){const pr=args?.scope==="server"?serverPresets:botsPresets;return (pr.presets as any[]).map(p=>({id:p.id,title:p.title,description:p.description}));}
if(cmd==="preview_preset"){const a=args;const sc=a.scope==="server"?serverSchema:botsSchema;const pr=(a.scope==="server"?serverPresets:botsPresets).presets as any[];const p=pr.find(x=>x.id===a.preset)??{id:a.preset??"defaults",title:"Recommended defaults",description:"Every setting returns to its default value."};const st=(sc.settings as any[]).filter(x=>x.type==="int"||x.type==="float"||x.type==="enum").slice(0,3);return {id:p.id,title:p.title,description:p.description,changes:st.map(x=>({key:x.key,title:x.title,from:x.default,to:x.type==="enum"?(x.options?.[1]?.value??x.default):(Number(x.default)||1)*2,dangerous:false}))};} if(cmd==="preview_preset"){const a=args;const sc=a.scope==="server"?serverSchema:botsSchema;const pr=(a.scope==="server"?serverPresets:botsPresets).presets as any[];const p=pr.find(x=>x.id===a.preset)??{id:a.preset??"defaults",title:"Recommended defaults",description:"Every setting returns to its default value."};const st=(sc.settings as any[]).filter(x=>x.type==="int"||x.type==="float"||x.type==="enum").slice(0,3);return {id:p.id,title:p.title,description:p.description,changes:st.map(x=>({key:x.key,title:x.title,from:x.default,to:x.type==="enum"?(x.options?.[1]?.value??x.default):(Number(x.default)||1)*2,dangerous:false}))};}
@@ -55,22 +65,24 @@ export {};
if(cmd==="realmlist_save"){const w=window as any;const rl=w.__rl;if(args.profileId){const p=rl.profiles.find((x: any)=>x.id===args.profileId);p.name=args.name;p.data=args.data;return p;}if(rl.profiles.some((x: any)=>x.name.toLowerCase()===String(args.name).toLowerCase()))throw {human:{code:"unknown",title:"",message:"",actions:[]},technical:"A realmlist with that name already exists."};const p={id:String(args.name).toLowerCase().replace(/[^a-z0-9]+/g,"-"),name:args.name,data:(/\s/.test(args.data.trim())?args.data.trim():"set realmlist "+args.data.trim())+"\r\n"};rl.profiles.push(p);return p;} if(cmd==="realmlist_save"){const w=window as any;const rl=w.__rl;if(args.profileId){const p=rl.profiles.find((x: any)=>x.id===args.profileId);p.name=args.name;p.data=args.data;return p;}if(rl.profiles.some((x: any)=>x.name.toLowerCase()===String(args.name).toLowerCase()))throw {human:{code:"unknown",title:"",message:"",actions:[]},technical:"A realmlist with that name already exists."};const p={id:String(args.name).toLowerCase().replace(/[^a-z0-9]+/g,"-"),name:args.name,data:(/\s/.test(args.data.trim())?args.data.trim():"set realmlist "+args.data.trim())+"\r\n"};rl.profiles.push(p);return p;}
if(cmd==="realmlist_delete"){const rl=(window as any).__rl;rl.profiles=rl.profiles.filter((x: any)=>x.id!==args.profileId);return null;} if(cmd==="realmlist_delete"){const rl=(window as any).__rl;rl.profiles=rl.profiles.filter((x: any)=>x.id!==args.profileId);return null;}
if(cmd==="account_delete") return null; if(cmd==="account_delete") return null;
if(cmd==="modules_list") return [{id:"companions",name:"CoA Companions",description:{en:"Companion bots for groups, dungeons and your guild.",ru:"Боты-компаньоны для групп, подземелий и гильдии."},repo:"https://github.com/Corfirean/mod-coa-playerbots",installed:true,enabled:modState["companions"],switchable:true,status:"beta",icon:"bot",page:"bots"},{id:"content-scaling",name:"Content Scaling",description:{en:"Scales dungeons and raids to your group, with solo modes.",ru:"Подстраивает подземелья и рейды под вашу группу, есть соло-режимы."},repo:"https://github.com/Corfirean/mod-coa-content-scaling",installed:true,enabled:modState["content-scaling"],switchable:true,status:"early",icon:"scaling",page:null},{id:"tbc-content",name:"TBC Content",description:{en:"Outland dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Запределья, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-tbc-content",installed:true,enabled:modState["tbc-content"],switchable:true,status:"early",icon:"tbc",page:null},{id:"wotlk-content",name:"WotLK Content",description:{en:"Northrend dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Нордскола, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-wotlk-content",installed:true,enabled:modState["wotlk-content"],switchable:true,status:"early",icon:"wotlk",page:null},{id:"ah-bot",name:"Auction House Bot",description:{en:"Fills the auction house with realistic, adjustable listings.",ru:"Наполняет аукцион реалистичными настраиваемыми лотами."},repo:"https://github.com/NathanHandley/mod-ah-bot-plus",installed:false,enabled:false,switchable:false,status:"soon",icon:"gavel",page:null,hidden:false},{id:"npc-enchanter",name:"NPC Enchanter",description:{en:"An NPC that enchants your gear for you.",ru:"НПС, который зачаровывает ваше снаряжение."},repo:"https://github.com/azerothcore/mod-npc-enchanter",installed:true,enabled:modState["npc-enchanter"],switchable:true,status:"early",icon:"sparkles",page:null,hidden:false},{id:"playerbots",name:"SQUID's Playerbots",description:{en:"An alternative bot system with random bots and full AI.",ru:"Альтернативная система ботов со случайными ботами и полным ИИ."},repo:"https://github.com/Zyth45/mod-playerbots",installed:false,enabled:false,switchable:false,status:"soon",icon:"swords",page:null,hidden:false},{id:"client-compat",name:"Client compatibility",description:{en:"Client-server link and appearance unlocks.",ru:"Связь клиента с сервером и разблокировка внешних видов."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["client-compat"],switchable:false,status:"release",icon:"plug",page:null,hidden:true}]; if(cmd==="modules_list") return [{id:"companions",name:"CoA Companions",description:{en:"Companion bots for groups, dungeons and your guild.",ru:"Боты-компаньоны для групп, подземелий и гильдии."},repo:"https://github.com/Corfirean/mod-coa-playerbots",installed:true,enabled:modState["companions"],switchable:true,status:"beta",icon:"bot",page:"bots"},{id:"content-scaling",name:"Content Scaling",description:{en:"Scales dungeons and raids to your group, with solo modes.",ru:"Подстраивает подземелья и рейды под вашу группу, есть соло-режимы."},repo:"https://github.com/Corfirean/mod-coa-content-scaling",installed:true,enabled:modState["content-scaling"],switchable:true,status:"early",icon:"scaling",page:null},{id:"tbc-content",name:"TBC Content",description:{en:"Outland dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Запределья, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-tbc-content",installed:true,enabled:modState["tbc-content"],switchable:true,status:"early",icon:"tbc",page:null},{id:"wotlk-content",name:"WotLK Content",description:{en:"Northrend dungeons and raids, scaled to your level range.",ru:"Подземелья и рейды Нордскола, подогнанные под ваши уровни."},repo:"https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-wotlk-content",installed:true,enabled:modState["wotlk-content"],switchable:true,status:"early",icon:"wotlk",page:null},{id:"ah-bot",name:"Auction House Bot",description:{en:"Fills the auction house with realistic, adjustable listings.",ru:"Наполняет аукцион реалистичными настраиваемыми лотами."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["ah-bot"] ?? false,switchable:true,status:"early",icon:"gavel",page:null,hidden:false},{id:"npc-enchanter",name:"NPC Enchanter",description:{en:"An NPC that enchants your gear for you.",ru:"НПС, который зачаровывает ваше снаряжение."},repo:"https://github.com/azerothcore/mod-npc-enchanter",installed:true,enabled:modState["npc-enchanter"],switchable:true,status:"early",icon:"sparkles",page:null,hidden:false},{id:"playerbots",name:"SQUID's Playerbots",description:{en:"An alternative bot system with random bots and full AI.",ru:"Альтернативная система ботов со случайными ботами и полным ИИ."},repo:"https://github.com/Zyth45/mod-playerbots",installed:true,enabled:modState["playerbots"] ?? false,switchable:true,status:"early",icon:"swords",page:"bots",hidden:false},{id:"client-compat",name:"Client compatibility",description:{en:"Client-server link and appearance unlocks.",ru:"Связь клиента с сервером и разблокировка внешних видов."},repo:"https://github.com/Corfirean/azerothcore-wotlk-coa",installed:true,enabled:modState["client-compat"],switchable:false,status:"release",icon:"plug",page:null,hidden:true}].map(m => ({...m, has_settings: !["tbc-content", "wotlk-content"].includes(m.id), compatibility: realm === "wildcard" ? (["companions", "playerbots"].includes(m.id) ? "unsupported" : m.id === "client-compat" ? "compatible" : "experimental") : "compatible", switchable: realm === "wildcard" && ["companions", "playerbots"].includes(m.id) ? false : m.switchable}));
if(cmd==="module_set_enabled"){ modState[args.module]=args.enabled; return null; } if(cmd==="module_set_enabled"){ if(args.enabled && ["companions","playerbots"].includes(args.module) && modState[args.module === "companions" ? "playerbots" : "companions"]) throw {human:{code:"bot_modules_conflict",title:"",message:"",actions:[]},technical:"Only one bot system may be enabled."}; modState[args.module]=args.enabled; return null; }
if(cmd==="all_settings") return [{key:"Visibility.Distance.Continents",value:"100",default:"90",doc:"Description: Visibility distance on continents. Range: 45-250 Default: 90",changed:true},{key:"Death.SicknessLevel",value:"11",default:"11",doc:"Description: Character level up to which characters get resurrection sickness. Default: 11",changed:false},{key:"Rate.Drop.Item.Epic",value:"3",default:"1",doc:"Description: Drop rates for money and items based on quality. Default: 1",changed:true},{key:"Instance.ResetTimeHour",value:"4",default:"4",doc:"Description: Hour of the day when the global instance reset occurs. Range: 0-23 Default: 4 - (04:00 AM)",changed:false},{key:"PlayerLimit",value:"1000",default:"1000",doc:"Description: Maximum number of players in the world.",changed:false}]; if(cmd==="all_settings") return [{key:"Visibility.Distance.Continents",value:"100",default:"90",doc:"Description: Visibility distance on continents. Range: 45-250 Default: 90",changed:true},{key:"Death.SicknessLevel",value:"11",default:"11",doc:"Description: Character level up to which characters get resurrection sickness. Default: 11",changed:false},{key:"Rate.Drop.Item.Epic",value:"3",default:"1",doc:"Description: Drop rates for money and items based on quality. Default: 1",changed:true},{key:"Instance.ResetTimeHour",value:"4",default:"4",doc:"Description: Hour of the day when the global instance reset occurs. Range: 0-23 Default: 4 - (04:00 AM)",changed:false},{key:"PlayerLimit",value:"1000",default:"1000",doc:"Description: Maximum number of players in the world.",changed:false}];
if(cmd==="all_settings_save") return Object.keys(args&&args.changes||{}); if(cmd==="all_settings_save") return Object.keys(args&&args.changes||{});
if(cmd==="module_settings" && args.module==="client-compat") return [{key:"CoA.UnlockLocalAppearanceCatalog",value:"1",default:"1",doc:""},{key:"CoA.UnlockAllVanity",value:"1",default:"1",doc:""},{key:"CoA.AutoCollectAppearances",value:"0",default:"1",doc:""},{key:"CoA.LearnOwnedCompanions",value:"1",default:"1",doc:""},{key:"CoA.MaxRidingFromStart",value:"1",default:"1",doc:""}]; if(cmd==="module_settings" && args.module==="client-compat") return [{key:"CoA.UnlockLocalAppearanceCatalog",value:"1",default:"1",doc:""},{key:"CoA.UnlockAllVanity",value:"1",default:"1",doc:""},{key:"CoA.AutoCollectAppearances",value:"0",default:"1",doc:""},{key:"CoA.LearnOwnedCompanions",value:"1",default:"1",doc:""},{key:"CoA.MaxRidingFromStart",value:"1",default:"1",doc:""}];
if(cmd==="module_settings"){ if(cmd==="module_settings"){
const S:Record<string,{key:string;value:string;default:string;doc:string}[]>={ const S:Record<string,{key:string;value:string;default:string;doc:string}[]>={
"npc-enchanter":[{key:"Enchanter.Enable",value:"1",default:"1",doc:"Enable the module."},{key:"Enchanter.Announce",value:"0",default:"0",doc:"Announce the module when the player logs in."},{key:"Enchanter.CostCopper",value:"0",default:"0",doc:"What one enchantment costs, in copper (10000 = 1 gold). 0 = free."},{key:"Enchanter.MessageTimer",value:"60000",default:"60000",doc:"How often the NPC emotes, in milliseconds."}], "npc-enchanter":[{key:"Enchanter.Enable",value:"1",default:"1",doc:"Enable the module."},{key:"Enchanter.Announce",value:"0",default:"0",doc:"Announce the module when the player logs in."},{key:"Enchanter.CostCopper",value:"0",default:"0",doc:"What one enchantment costs, in copper (10000 = 1 gold). 0 = free."},{key:"Enchanter.MessageTimer",value:"60000",default:"60000",doc:"How often the NPC emotes, in milliseconds."}],
"companions":[{key:"CoaBots.Enable",value:"1",default:"1",doc:"Master switch of the companion bots."},{key:"CoaBots.MaxPerPlayer",value:"4",default:"4",doc:"How many bots one player can have at a time."}], "playerbots":[{"key": "AiPlayerbot.RandomBotAutologin", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.MinRandomBots", "value": "500", "default": "500", "doc": ""}, {"key": "AiPlayerbot.MaxRandomBots", "value": "500", "default": "500", "doc": ""}, {"key": "AiPlayerbot.RandomBotAccountCount", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotMinLevel", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotMaxLevel", "value": "60", "default": "60", "doc": ""}, {"key": "AiPlayerbot.SyncLevelWithPlayers", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotInvitePlayer", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotJoinLfg", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotJoinBG", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotAutoJoinBG", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotTalk", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotEmote", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotSuggestDungeons", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaClassesOnly", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSmartHeal", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSmartTank", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaSpecRotations", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaInterruptCoordination", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.MaxAddedBots", "value": "40", "default": "40", "doc": ""}, {"key": "AiPlayerbot.BotAutologin", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.DisabledWithoutRealPlayer", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.AddClassCommand", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.KeepAltsInGroup", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.CoaRecruitSameFaction", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.CoaLfgBots", "value": "1", "default": "1", "doc": ""}, {"key": "AiPlayerbot.RandomBotXPRate", "value": "1.0", "default": "1.0", "doc": ""}, {"key": "AiPlayerbot.FollowDistance", "value": "1.5", "default": "1.5", "doc": ""}, {"key": "AiPlayerbot.Enabled", "value": "0", "default": "0", "doc": ""}, {"key": "AiPlayerbot.RandomBotAccountPrefix", "value": "\"rndbot\"", "default": "\"rndbot\"", "doc": ""}, {"key": "AiPlayerbot.RandomBotUpdateInterval", "value": "20", "default": "20", "doc": ""}],
"content-scaling":[{key:"CoAContentScaling.Enable",value:"1",default:"1",doc:"Scale dungeons and raids to the group."}], "companions":[{key:"CoaBots.Enable",value:"1",default:"1",doc:"Master switch of the companion bots."},{key:"CoaBots.RandomSpawn.DefaultCount",value:"10",default:"10",doc:""}],
"content-scaling":[{key:"CoAContentScaling.Enable",value:"1",default:"1",doc:"Scale dungeons and raids to the group."}, ...[{key:"CoAContentScaling.Difficulty.DamageMultiplier",value:"1.0"},{key:"CoAContentScaling.SoloAssist.Mode",value:"1"},{key:"CoAContentScaling.GroupScaling.Enable",value:"1"},{key:"CoAContentScaling.LFG.DefaultMode",value:"CurrentParty"},{key:"CoAContentScaling.LFG.DefaultChallengeSize",value:"0"},{key:"CoAContentScaling.Debug",value:"0"}].map(s=>({...s,default:s.value,doc:""}))],
"ah-bot":[...Object.keys(auctionCategories).flatMap(category => Object.keys(auctionQualities).map(quality => ({key:`AuctionHouseBot.ListProportion.Category${category}.Quality${quality}`,value:String(quality === "Normal" && !["Quest","Key","Generic","Reagent"].includes(category) ? 50 : quality === "Rare" && ["Armor","Weapon"].includes(category) ? 5 : 0),default:String(quality === "Normal" && !["Quest","Key","Generic","Reagent"].includes(category) ? 50 : quality === "Rare" && ["Armor","Weapon"].includes(category) ? 5 : 0),doc:""}))), {key:"AuctionHouseBot.Enable",value:"false",default:"false",doc:""}, ...[{key:"AuctionHouseBot.GUIDs",value:"0"},{key:"AuctionHouseBot.EnableSeller",value:"true"},{key:"AuctionHouseBot.CoA.ObtainableItemsOnly",value:"true"},{key:"AuctionHouseBot.ItemsPerCycle",value:"150"},{key:"AuctionHouseBot.MinutesBetweenSellCycle",value:"1"},{key:"AuctionHouseBot.Alliance.MinItems",value:"15000"},{key:"AuctionHouseBot.Alliance.MaxItems",value:"15000"}].map(s=>({...s,default:s.value,doc:""}))],
"tbc-content":[{key:"CoATBC.Enable",value:"1",default:"1",doc:"Outland dungeons and raids."}], "tbc-content":[{key:"CoATBC.Enable",value:"1",default:"1",doc:"Outland dungeons and raids."}],
"wotlk-content":[{key:"CoAWotLK.Enable",value:"1",default:"1",doc:"Northrend dungeons and raids."}], "wotlk-content":[{key:"CoAWotLK.Enable",value:"1",default:"1",doc:"Northrend dungeons and raids."}],
}; };
return S[args.module]??[]; return (S[args.module]??[]).map(s => ({...s, value: moduleEdits[args.module]?.[s.key] ?? s.value}));
} }
if(cmd==="module_save_settings") return Object.keys(args.changes); if(cmd==="module_save_settings") { moduleEdits[args.module] = {...moduleEdits[args.module], ...args.changes}; return Object.keys(args.changes); }
if(cmd==="report_context") return {manager_version:"0.3.1",windows:"Windows 11 (build 26200)",install_kind:"new",server_version:"0.261001.10"}; if(cmd==="report_context") return {manager_version:"0.3.1",windows:"Windows 11 (build 26200)",install_kind:"new",server_version:"0.261001.10"};
if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;} if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;}
if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip"; if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip";
+6 -3
View File
@@ -4,12 +4,14 @@ import ru from "./locales/ru";
import de from "./locales/de"; import de from "./locales/de";
import fr from "./locales/fr"; import fr from "./locales/fr";
import es from "./locales/es"; import es from "./locales/es";
import zh from "./locales/zh";
import ruSchema from "./schema/ru.json"; import ruSchema from "./schema/ru.json";
import deSchema from "./schema/de.json"; import deSchema from "./schema/de.json";
import frSchema from "./schema/fr.json"; import frSchema from "./schema/fr.json";
import esSchema from "./schema/es.json"; import esSchema from "./schema/es.json";
import zhSchema from "./schema/zh.json";
export type Locale = "en" | "ru" | "de" | "fr" | "es"; export type Locale = "en" | "ru" | "de" | "fr" | "es" | "zh";
export type Key = keyof typeof en; export type Key = keyof typeof en;
type Vars = Record<string, string | number>; type Vars = Record<string, string | number>;
@@ -19,9 +21,10 @@ export const LOCALES: { id: Locale; name: string }[] = [
{ id: "de", name: "Deutsch" }, { id: "de", name: "Deutsch" },
{ id: "fr", name: "Français" }, { id: "fr", name: "Français" },
{ id: "es", name: "Español" }, { id: "es", name: "Español" },
{ id: "zh", name: "简体中文" },
]; ];
const DICTS: Record<Locale, Partial<Record<Key, string>>> = { en, ru, de, fr, es }; const DICTS: Record<Locale, Partial<Record<Key, string>>> = { en, ru, de, fr, es, zh };
const STORAGE_KEY = "coa-locale"; const STORAGE_KEY = "coa-locale";
function initialLocale(): Locale { function initialLocale(): Locale {
@@ -95,7 +98,7 @@ interface SchemaOverlay {
options: Record<string, string>; options: Record<string, string>;
presets: Record<string, { t: string; d: string }>; presets: Record<string, { t: string; d: string }>;
} }
const SCHEMA: Partial<Record<Locale, SchemaOverlay>> = { ru: ruSchema, de: deSchema, fr: frSchema, es: esSchema }; const SCHEMA: Partial<Record<Locale, SchemaOverlay>> = { ru: ruSchema, de: deSchema, fr: frSchema, es: esSchema, zh: zhSchema };
export function useSchemaText() { export function useSchemaText() {
const { locale } = useContext(I18n); const { locale } = useContext(I18n);
+25 -1
View File
@@ -349,7 +349,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
"upd.pendingBad": "Der aktualisierte Server ist nicht korrekt gestartet", "upd.pendingBad": "Der aktualisierte Server ist nicht korrekt gestartet",
"upd.pendingUnfinished": "Ein früheres Update wurde nicht abgeschlossen", "upd.pendingUnfinished": "Ein früheres Update wurde nicht abgeschlossen",
"upd.safeBack": "Du kannst sicher zur vorherigen Version zurückkehren.", "upd.safeBack": "Du kannst sicher zur vorherigen Version zurückkehren.",
"upd.backNote": "Das Zurückkehren stellt Programmdateien und Einstellungen wieder her. Charaktere und Konten werden nie automatisch zurückgesetzt.", "upd.backNote": "Die Rückkehr stellt Dateien und Einstellungen wieder her. Wurden Datenbankupdates begonnen, werden auch alle Datenbanken aus der Sicherung vor dem Update wiederhergestellt. Späterer Fortschritt geht verloren.",
"upd.goBackTo": "Zu Version {v} zurückkehren", "upd.goBackTo": "Zu Version {v} zurückkehren",
"upd.goBackBefore": "Zur Version vor dem Update zurückkehren", "upd.goBackBefore": "Zur Version vor dem Update zurückkehren",
"upd.title": "Server-Updates", "upd.title": "Server-Updates",
@@ -697,6 +697,18 @@ const de: Partial<Record<keyof typeof en, string>> = {
"rep.copied": "In die Zwischenablage kopiert.", "rep.copied": "In die Zwischenablage kopiert.",
// Realmlist switcher and modules page // Realmlist switcher and modules page
"realm.profileLabel": "Realm",
"realm.switching": "Realm wird gewechselt…",
"realm.create": "Wildcard-Realm erstellen",
"realm.restart": "Wechseln und neu starten",
"realm.select": "Realm auswählen",
"realm.active": "Aktiv: {name}",
"realm.separate": "Es läuft jeweils eine Welt. Jeder Realm behält eigene Charaktere, Fortschritte und Moduleinstellungen.",
"realm.modules": "CoA-Begleiter sind hier nicht verfügbar. Content Scaling und andere Module sind auf Wildcard experimentell.",
"realm.update": "Aktualisiere den Server auf eine Version mit Wildcard-Unterstützung, um diesen Realm zu erstellen.",
"realm.recovery": "Ein Realm-Wechsel wurde unterbrochen. Wähle einen Realm, um die gespeicherte Konfiguration wiederherzustellen.",
"realm.unsupported": "Auf Wildcard nicht verfügbar: Die Klassenmechanik wurde noch nicht geprüft.",
"realm.experimental": "Experimentell auf Wildcard · Spielkompatibilität noch nicht geprüft.",
"realm.label": "Realm", "realm.label": "Realm",
"realm.other": "Anderer", "realm.other": "Anderer",
"realm.add": "Realmlist hinzufügen …", "realm.add": "Realmlist hinzufügen …",
@@ -712,6 +724,16 @@ const de: Partial<Record<keyof typeof en, string>> = {
"realm.confirmDelete": "Realmlist „{name}“ entfernen? Der Spielclient behält die aktuelle Datei.", "realm.confirmDelete": "Realmlist „{name}“ entfernen? Der Spielclient behält die aktuelle Datei.",
"nav.modules": "Module", "nav.modules": "Module",
"q.modules": "Welche Zusatzfunktionen hat der Server?", "q.modules": "Welche Zusatzfunktionen hat der Server?",
"mod.ahbot.types": "Verkaufte Gegenstandstypen",
"mod.ahbot.typesHint": "Typen für neue Angebote auswählen. Bestehende Auktionen bleiben. Einschalten stellt die vorherigen Gewichte dieser Sitzung oder die Standardwerte wieder her.",
"mod.ahbot.qualityWeights": "Qualität und Häufigkeit",
"mod.ahbot.weightsHint": "Relative Gewichte, keine Prozente. 0 schließt eine Qualität aus; höhere Werte erhöhen die Häufigkeit. Sind alle Standardwerte 0, wird gewöhnliche Qualität gewählt. Andere Filter gelten weiterhin.",
"mod.ahbot.noTypes": "Alle Typen sind deaktiviert. Der Verkäufer hat keine Typen für neue Angebote.",
"mod.noSettings": "Keine weiteren Einstellungen. Verwende den Modulschalter oben.",
"err.bot_modules_conflict.title": "Zwei Bot-Module sind aktiviert",
"err.bot_modules_conflict.message": "Deaktiviere CoA Companions oder SQUID Playerbots unter Module vor dem Serverstart.",
"mod.ahbot.setup": "GUID eines separaten Auktionscharakters eintragen, Verkäufer und Modul aktivieren. Der Charakter muss offline sein. Der CoA-Filter nutzt Beute-, Händler- und Berufstabellen; Stufengrenzen gelten zusätzlich. Erfordert einen Serverbuild mit CoA-Auktionsfilter.",
"mod.ahbot.allSettings": "Alle Auktionseinstellungen",
"mod.title": "Module", "mod.title": "Module",
"mod.intro": "Zusatzfunktionen, die im Server eingebaut sind. Schalte die gewünschten ein oder aus, öffne ihre GitHub-Seite oder ändere ihre Einstellungen.", "mod.intro": "Zusatzfunktionen, die im Server eingebaut sind. Schalte die gewünschten ein oder aus, öffne ihre GitHub-Seite oder ändere ihre Einstellungen.",
"mod.restart": "Änderungen werden nach einem Neustart des Weltservers wirksam.", "mod.restart": "Änderungen werden nach einem Neustart des Weltservers wirksam.",
@@ -773,6 +795,8 @@ const de: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Alle Einstellungen nach Name oder Beschreibung durchsuchen…", "set.searchAll": "Alle Einstellungen nach Name oder Beschreibung durchsuchen…",
"set.search": "Einstellungen durchsuchen…", "set.search": "Einstellungen durchsuchen…",
"upd.current": "Du bist auf dem neuesten Stand (Version {v}).", "upd.current": "Du bist auf dem neuesten Stand (Version {v}).",
"client.job.checking": "Client wird geprüft…",
"client.job.updating": "Client wird aktualisiert",
}; };
export default de; export default de;
+46 -1
View File
@@ -1,5 +1,36 @@
/** English is the source of truth: every key must exist here; other locales fall back to it. */ /** English is the source of truth: every key must exist here; other locales fall back to it. */
const en = { const en = {
"realm.profileLabel": "Realm",
"realm.startupTitle": "Realm startup",
"realm.secondWorld": "Second world",
"realm.simultaneous": "Start CoA and Wildcard together",
"realm.simultaneousHint": "Stop the server before changing this option. Start runs both worlds with separate characters, settings and ports, sharing accounts. Two worlds need more memory. The first setup creates Wildcard if needed.",
"realm.secondPort": "Second world port: {port}",
"realm.preparing": "Preparing realm databases…",
"realm.bothRunning": "Both worlds start together. Each realm keeps its own characters, progress and module settings.",
"repair.title": "Check and repair server",
"repair.hint": "Stop both realms and update to the latest server package before repair. Repair backs up databases and replaced files, restores official program files and applies pending SQL. Your characters and existing settings are preserved.",
"repair.check": "Check files and database",
"repair.checking": "Checking…",
"repair.run": "Repair",
"repair.running": "Repairing… {n}%",
"repair.result": "Restored files: {files}. Applied database updates: {sql}.",
"repair.backup": "Backup: {id}",
"repair.fileCount": "Files that differ or are missing: {n}",
"repair.dbCount": "Schema/start-data problems: {columns}. Pending or failed SQL updates: {sql}.",
"repair.limited": "This older package has no full schema contract. Only character-save columns and starting data are checked.",
"repair.unresolved": "Database problems remain. Repair does not replay already applied SQL or invent column changes. Export diagnostics with the listed problems for a corrective server update.",
"realm.switching": "Switching realm…",
"realm.create": "Create Wildcard realm",
"realm.restart": "Switch and restart",
"realm.select": "Select realm",
"realm.active": "Active: {name}",
"realm.separate": "One world runs at a time. Each realm keeps its own characters, progress and module settings.",
"realm.modules": "CoA companions are unavailable here. Content Scaling and other modules remain experimental on Wildcard.",
"realm.update": "Update the server to a build with Wildcard support to create this realm.",
"realm.recovery": "A realm switch was interrupted. Select a realm to recover the saved configuration.",
"realm.unsupported": "Unavailable on Wildcard: class mechanics have not been validated.",
"realm.experimental": "Experimental on Wildcard · gameplay compatibility is not yet verified.",
"app.name": "CoA Server Manager", "app.name": "CoA Server Manager",
"nav.overview": "Overview", "nav.overview": "Overview",
@@ -92,6 +123,8 @@ const en = {
"err.operation_in_progress.message": "The server is busy starting or stopping. Wait a moment and try again.", "err.operation_in_progress.message": "The server is busy starting or stopping. Wait a moment and try again.",
"err.startup_failed.title": "Server could not start", "err.startup_failed.title": "Server could not start",
"err.startup_failed.message": "A service stopped while starting. Check the details for the cause.", "err.startup_failed.message": "A service stopped while starting. Check the details for the cause.",
"err.docker_unavailable.title": "Docker is not available",
"err.docker_unavailable.message": "This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
"err.hash_mismatch.title": "A downloaded file is damaged", "err.hash_mismatch.title": "A downloaded file is damaged",
"err.hash_mismatch.message": "The file did not match its checksum and was not used.", "err.hash_mismatch.message": "The file did not match its checksum and was not used.",
"err.path_rejected.title": "That location is not allowed", "err.path_rejected.title": "That location is not allowed",
@@ -349,7 +382,7 @@ const en = {
"upd.pendingBad": "The updated server did not start correctly", "upd.pendingBad": "The updated server did not start correctly",
"upd.pendingUnfinished": "An earlier update did not finish", "upd.pendingUnfinished": "An earlier update did not finish",
"upd.safeBack": "You can safely go back to the previous version.", "upd.safeBack": "You can safely go back to the previous version.",
"upd.backNote": "Going back restores program files and settings. Characters and accounts are never rolled back automatically.", "upd.backNote": "Going back restores files and settings. If database updates started, it also restores all databases to the backup taken before the update. Later progress will be lost.",
"upd.goBackTo": "Go back to version {v}", "upd.goBackTo": "Go back to version {v}",
"upd.goBackBefore": "Go back to the version before the update", "upd.goBackBefore": "Go back to the version before the update",
"upd.title": "Server updates", "upd.title": "Server updates",
@@ -712,6 +745,16 @@ const en = {
"realm.confirmDelete": "Remove the realmlist “{name}”? The game client keeps whatever file it has now.", "realm.confirmDelete": "Remove the realmlist “{name}”? The game client keeps whatever file it has now.",
"nav.modules": "Modules", "nav.modules": "Modules",
"q.modules": "What extra features does the server have?", "q.modules": "What extra features does the server have?",
"mod.ahbot.types": "Item types for sale",
"mod.ahbot.typesHint": "Choose types for new listings. Existing auctions remain. Enabling a type restores its previous weights in this session, or the configured defaults.",
"mod.ahbot.qualityWeights": "Quality and frequency",
"mod.ahbot.weightsHint": "Relative weights, not percentages. 0 excludes a quality; larger values make it more frequent. If all defaults are zero, enabling selects common quality. Other item filters still apply.",
"mod.ahbot.noTypes": "All types are disabled. The seller has no types to choose for new listings.",
"mod.noSettings": "There are no additional settings. Use the module switch above.",
"mod.ahbot.setup": "Enter a dedicated auction character GUID, enable the seller and the module. Keep that character offline. The CoA filter selects items from loot tables, vendors and professions; level restrictions also apply. Requires a server build with the CoA auction filter.",
"mod.ahbot.allSettings": "All settings",
"err.bot_modules_conflict.title": "Two bot modules are enabled",
"err.bot_modules_conflict.message": "Disable CoA Companions or SQUID Playerbots in Modules before starting the server.",
"mod.title": "Modules", "mod.title": "Modules",
"mod.intro": "Extra features built into the server. Switch the ones you want on or off, open their GitHub page, or change their settings.", "mod.intro": "Extra features built into the server. Switch the ones you want on or off, open their GitHub page, or change their settings.",
"mod.restart": "Changes apply after the world server restarts.", "mod.restart": "Changes apply after the world server restarts.",
@@ -773,6 +816,8 @@ const en = {
"set.searchAll": "Search all settings by name or description…", "set.searchAll": "Search all settings by name or description…",
"set.search": "Search settings…", "set.search": "Search settings…",
"upd.current": "You are up to date (version {v}).", "upd.current": "You are up to date (version {v}).",
"client.job.checking": "Checking the client…",
"client.job.updating": "Updating the client",
} as const; } as const;
export default en; export default en;
+25 -1
View File
@@ -349,7 +349,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
"upd.pendingBad": "El servidor actualizado no se inició correctamente", "upd.pendingBad": "El servidor actualizado no se inició correctamente",
"upd.pendingUnfinished": "Una actualización anterior no terminó", "upd.pendingUnfinished": "Una actualización anterior no terminó",
"upd.safeBack": "Puedes volver con seguridad a la versión anterior.", "upd.safeBack": "Puedes volver con seguridad a la versión anterior.",
"upd.backNote": "Volver restaura los archivos del programa y los ajustes. Los personajes y cuentas nunca se revierten automáticamente.", "upd.backNote": "Volver restaura los archivos y los ajustes. Si comenzaron las actualizaciones de las bases de datos, también se restauran todas las bases desde la copia anterior a la actualización. Se perderá el progreso posterior.",
"upd.goBackTo": "Volver a la versión {v}", "upd.goBackTo": "Volver a la versión {v}",
"upd.goBackBefore": "Volver a la versión anterior a la actualización", "upd.goBackBefore": "Volver a la versión anterior a la actualización",
"upd.title": "Actualizaciones del servidor", "upd.title": "Actualizaciones del servidor",
@@ -697,6 +697,18 @@ const es: Partial<Record<keyof typeof en, string>> = {
"rep.copied": "Copiado al portapapeles.", "rep.copied": "Copiado al portapapeles.",
// Realmlist switcher and modules page // Realmlist switcher and modules page
"realm.profileLabel": "Reino",
"realm.switching": "Cambiando de reino…",
"realm.create": "Crear reino Wildcard",
"realm.restart": "Cambiar y reiniciar",
"realm.select": "Seleccionar reino",
"realm.active": "Activo: {name}",
"realm.separate": "Solo funciona un mundo a la vez. Cada reino conserva sus personajes, progreso y ajustes de módulos.",
"realm.modules": "Los compañeros de CoA no están disponibles aquí. Content Scaling y los demás módulos siguen siendo experimentales en Wildcard.",
"realm.update": "Actualiza el servidor a una versión compatible con Wildcard para crear este reino.",
"realm.recovery": "Se interrumpió un cambio de reino. Selecciona un reino para recuperar la configuración guardada.",
"realm.unsupported": "No disponible en Wildcard: las mecánicas de clase aún no se han validado.",
"realm.experimental": "Experimental en Wildcard · compatibilidad en juego sin verificar.",
"realm.label": "Reino", "realm.label": "Reino",
"realm.other": "Otro", "realm.other": "Otro",
"realm.add": "Añadir una realmlist…", "realm.add": "Añadir una realmlist…",
@@ -712,6 +724,16 @@ const es: Partial<Record<keyof typeof en, string>> = {
"realm.confirmDelete": "¿Eliminar la realmlist «{name}»? El cliente conserva el archivo actual.", "realm.confirmDelete": "¿Eliminar la realmlist «{name}»? El cliente conserva el archivo actual.",
"nav.modules": "Módulos", "nav.modules": "Módulos",
"q.modules": "¿Qué funciones adicionales tiene el servidor?", "q.modules": "¿Qué funciones adicionales tiene el servidor?",
"mod.ahbot.types": "Tipos de objetos en venta",
"mod.ahbot.typesHint": "Elige tipos para nuevos anuncios. Las subastas existentes permanecen. Al activar se restauran los pesos de esta sesión o los valores predeterminados.",
"mod.ahbot.qualityWeights": "Calidad y frecuencia",
"mod.ahbot.weightsHint": "Pesos relativos, no porcentajes. 0 excluye una calidad; valores mayores aumentan su frecuencia. Si todos los valores predeterminados son cero, se elige calidad común. Los demás filtros siguen activos.",
"mod.ahbot.noTypes": "Todos los tipos están desactivados. El vendedor no tiene tipos para nuevos anuncios.",
"mod.noSettings": "No hay ajustes adicionales. Usa el interruptor del módulo de arriba.",
"err.bot_modules_conflict.title": "Hay dos módulos de bots activos",
"err.bot_modules_conflict.message": "Desactiva CoA Companions o SQUID Playerbots en Módulos antes de iniciar el servidor.",
"mod.ahbot.setup": "Indica el GUID de un personaje dedicado a subastas y activa vendedor y módulo. El personaje debe estar desconectado. El filtro CoA usa botín, vendedores y profesiones; los límites de nivel se aplican además. Requiere un servidor con filtro de subastas CoA.",
"mod.ahbot.allSettings": "Todos los ajustes de subastas",
"mod.title": "Módulos", "mod.title": "Módulos",
"mod.intro": "Funciones adicionales integradas en el servidor. Activa o desactiva las que quieras, abre su página de GitHub o cambia sus ajustes.", "mod.intro": "Funciones adicionales integradas en el servidor. Activa o desactiva las que quieras, abre su página de GitHub o cambia sus ajustes.",
"mod.restart": "Los cambios se aplican al reiniciar el servidor del mundo.", "mod.restart": "Los cambios se aplican al reiniciar el servidor del mundo.",
@@ -773,6 +795,8 @@ const es: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Buscar en todos los ajustes por nombre o descripción…", "set.searchAll": "Buscar en todos los ajustes por nombre o descripción…",
"set.search": "Buscar ajustes…", "set.search": "Buscar ajustes…",
"upd.current": "Estás al día (versión {v}).", "upd.current": "Estás al día (versión {v}).",
"client.job.checking": "Comprobando el cliente…",
"client.job.updating": "Actualizando el cliente",
}; };
export default es; export default es;
+25 -1
View File
@@ -349,7 +349,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"upd.pendingBad": "Le serveur mis à jour n’a pas démarré correctement", "upd.pendingBad": "Le serveur mis à jour n’a pas démarré correctement",
"upd.pendingUnfinished": "Une mise à jour précédente ne s’est pas terminée", "upd.pendingUnfinished": "Une mise à jour précédente ne s’est pas terminée",
"upd.safeBack": "Vous pouvez revenir en toute sécurité à la version précédente.", "upd.safeBack": "Vous pouvez revenir en toute sécurité à la version précédente.",
"upd.backNote": "Le retour restaure les fichiers du programme et les paramètres. Les personnages et comptes ne sont jamais restaurés automatiquement.", "upd.backNote": "Le retour restaure les fichiers et les paramètres. Si la mise à jour des bases a commencé, toutes les bases sont aussi restaurées depuis la sauvegarde précédant la mise à jour. La progression ultérieure sera perdue.",
"upd.goBackTo": "Revenir à la version {v}", "upd.goBackTo": "Revenir à la version {v}",
"upd.goBackBefore": "Revenir à la version d’avant la mise à jour", "upd.goBackBefore": "Revenir à la version d’avant la mise à jour",
"upd.title": "Mises à jour du serveur", "upd.title": "Mises à jour du serveur",
@@ -697,6 +697,18 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"rep.copied": "Copié dans le presse-papiers.", "rep.copied": "Copié dans le presse-papiers.",
// Realmlist switcher and modules page // Realmlist switcher and modules page
"realm.profileLabel": "Royaume",
"realm.switching": "Changement de royaume…",
"realm.create": "Créer le royaume Wildcard",
"realm.restart": "Changer et redémarrer",
"realm.select": "Choisir le royaume",
"realm.active": "Actif : {name}",
"realm.separate": "Un seul monde fonctionne à la fois. Chaque royaume conserve ses personnages, sa progression et les paramètres de ses modules.",
"realm.modules": "Les compagnons CoA sont indisponibles ici. Content Scaling et les autres modules restent expérimentaux sur Wildcard.",
"realm.update": "Mettez le serveur à jour vers une version compatible avec Wildcard pour créer ce royaume.",
"realm.recovery": "Un changement de royaume a été interrompu. Choisissez un royaume pour restaurer la configuration enregistrée.",
"realm.unsupported": "Indisponible sur Wildcard : les mécaniques de classe ne sont pas encore validées.",
"realm.experimental": "Expérimental sur Wildcard · compatibilité en jeu non vérifiée.",
"realm.label": "Royaume", "realm.label": "Royaume",
"realm.other": "Autre", "realm.other": "Autre",
"realm.add": "Ajouter une realmlist…", "realm.add": "Ajouter une realmlist…",
@@ -712,6 +724,16 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"realm.confirmDelete": "Supprimer la realmlist « {name} » ? Le client garde le fichier actuel.", "realm.confirmDelete": "Supprimer la realmlist « {name} » ? Le client garde le fichier actuel.",
"nav.modules": "Modules", "nav.modules": "Modules",
"q.modules": "Quelles fonctions supplémentaires le serveur propose-t-il ?", "q.modules": "Quelles fonctions supplémentaires le serveur propose-t-il ?",
"mod.ahbot.types": "Types d’objets à vendre",
"mod.ahbot.typesHint": "Choisissez les types des nouvelles annonces. Les enchères existantes restent. L’activation restaure les poids de cette session ou les valeurs par défaut.",
"mod.ahbot.qualityWeights": "Qualité et fréquence",
"mod.ahbot.weightsHint": "Poids relatifs, pas des pourcentages. 0 exclut une qualité ; un poids supérieur augmente sa fréquence. Si tous les défauts sont nuls, la qualité commune est choisie. Les autres filtres restent actifs.",
"mod.ahbot.noTypes": "Tous les types sont désactivés. Le vendeur n’a aucun type à choisir.",
"mod.noSettings": "Aucun réglage supplémentaire. Utilisez l’interrupteur du module ci-dessus.",
"err.bot_modules_conflict.title": "Deux modules de bots sont activés",
"err.bot_modules_conflict.message": "Désactivez CoA Companions ou SQUID Playerbots dans Modules avant de démarrer le serveur.",
"mod.ahbot.setup": "Indiquez le GUID d’un personnage dédié aux enchères, activez le vendeur et le module. Le personnage doit être hors ligne. Le filtre CoA utilise le butin, les vendeurs et les métiers ; les limites de niveau s’ajoutent. Nécessite un serveur avec le filtre d’enchères CoA.",
"mod.ahbot.allSettings": "Tous les réglages d’enchères",
"mod.title": "Modules", "mod.title": "Modules",
"mod.intro": "Fonctions supplémentaires intégrées au serveur. Activez ou désactivez celles que vous voulez, ouvrez leur page GitHub ou modifiez leurs réglages.", "mod.intro": "Fonctions supplémentaires intégrées au serveur. Activez ou désactivez celles que vous voulez, ouvrez leur page GitHub ou modifiez leurs réglages.",
"mod.restart": "Les changements s’appliquent après le redémarrage du serveur de monde.", "mod.restart": "Les changements s’appliquent après le redémarrage du serveur de monde.",
@@ -773,6 +795,8 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Rechercher dans tous les réglages par nom ou description…", "set.searchAll": "Rechercher dans tous les réglages par nom ou description…",
"set.search": "Rechercher un réglage…", "set.search": "Rechercher un réglage…",
"upd.current": "Vous êtes à jour (version {v}).", "upd.current": "Vous êtes à jour (version {v}).",
"client.job.checking": "Vérification du client…",
"client.job.updating": "Mise à jour du client",
}; };
export default fr; export default fr;
+44 -1
View File
@@ -2,6 +2,37 @@ import type en from "./en";
/** Русский. Черновой перевод; требует проверки носителем перед релизом. */ /** Русский. Черновой перевод; требует проверки носителем перед релизом. */
const ru: Partial<Record<keyof typeof en, string>> = { const ru: Partial<Record<keyof typeof en, string>> = {
"realm.profileLabel": "Реалм",
"realm.startupTitle": "Запуск реалмов",
"realm.secondWorld": "Второй мир",
"realm.simultaneous": "Запускать CoA и Wildcard одновременно",
"realm.simultaneousHint": "Остановите сервер перед изменением настройки. Запуск поднимет оба мира с отдельными персонажами, настройками и портами, но общими аккаунтами. Два мира требуют больше памяти. При первом включении Wildcard будет создан, если его ещё нет.",
"realm.secondPort": "Порт второго мира: {port}",
"realm.preparing": "Подготовка баз реалма…",
"realm.bothRunning": "Оба мира запускаются одновременно. У каждого свои персонажи, прогресс и настройки модулей.",
"repair.title": "Проверка и восстановление сервера",
"repair.hint": "Перед восстановлением остановите оба реалма и обновите сервер до последнего пакета. Repair сохранит резервную копию БД и заменяемых файлов, восстановит файлы программы и применит недостающие SQL. Персонажи и существующие настройки сохраняются.",
"repair.check": "Проверить файлы и БД",
"repair.checking": "Проверка…",
"repair.run": "Восстановить",
"repair.running": "Восстановление… {n}%",
"repair.result": "Восстановлено файлов: {files}. Применено обновлений БД: {sql}.",
"repair.backup": "Резервная копия: {id}",
"repair.fileCount": "Изменённых или отсутствующих файлов: {n}",
"repair.dbCount": "Проблем структуры БД/стартовых данных: {columns}. Ожидающих или неудачных SQL: {sql}.",
"repair.limited": "В старом пакете нет полного описания схемы. Проверяются только колонки сохранения персонажей и стартовые данные.",
"repair.unresolved": "Проблемы БД остались. Repair не повторяет уже применённые SQL и не добавляет колонки наугад. Экспортируйте диагностику с этим списком для исправляющего обновления сервера.",
"realm.switching": "Переключение реалма…",
"realm.create": "Создать реалм Wildcard",
"realm.restart": "Переключить и перезапустить",
"realm.select": "Выбрать реалм",
"realm.active": "Активен: {name}",
"realm.separate": "Работает один мир. У каждого реалма свои персонажи, прогресс и настройки модулей.",
"realm.modules": "CoA-боты здесь недоступны. Скалирование и другие модули пока экспериментальны для Wildcard.",
"realm.update": "Для создания реалма обновите сервер до сборки с поддержкой Wildcard.",
"realm.recovery": "Переключение прервалось. Выберите реалм, чтобы восстановить сохранённые настройки.",
"realm.unsupported": "Недоступен в Wildcard: классовые механики ещё не проверены.",
"realm.experimental": "Экспериментально в Wildcard · игровая совместимость пока не проверена.",
"nav.overview": "Обзор", "nav.overview": "Обзор",
"nav.bots": "Боты", "nav.bots": "Боты",
"nav.server": "Сервер", "nav.server": "Сервер",
@@ -349,7 +380,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"upd.pendingBad": "Обновлённый сервер запустился некорректно", "upd.pendingBad": "Обновлённый сервер запустился некорректно",
"upd.pendingUnfinished": "Предыдущее обновление не завершилось", "upd.pendingUnfinished": "Предыдущее обновление не завершилось",
"upd.safeBack": "Можно безопасно вернуться к предыдущей версии.", "upd.safeBack": "Можно безопасно вернуться к предыдущей версии.",
"upd.backNote": "Возврат восстанавливает файлы программы и настройки. Персонажи и учётные записи автоматически не откатываются никогда.", "upd.backNote": "Возврат восстанавливает файлы и настройки. Если обновление баз уже началось, все базы также восстанавливаются из копии перед обновлением. Более поздний прогресс будет потерян.",
"upd.goBackTo": "Вернуться к версии {v}", "upd.goBackTo": "Вернуться к версии {v}",
"upd.goBackBefore": "Вернуться к версии до обновления", "upd.goBackBefore": "Вернуться к версии до обновления",
"upd.title": "Обновления сервера", "upd.title": "Обновления сервера",
@@ -712,6 +743,16 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"realm.confirmDelete": "Удалить реалмлист «{name}»? В игровом клиенте останется текущий файл.", "realm.confirmDelete": "Удалить реалмлист «{name}»? В игровом клиенте останется текущий файл.",
"nav.modules": "Модули", "nav.modules": "Модули",
"q.modules": "Какие дополнительные возможности есть у сервера?", "q.modules": "Какие дополнительные возможности есть у сервера?",
"mod.ahbot.types": "Типы предметов в продаже",
"mod.ahbot.typesHint": "Выберите типы для новых лотов. Уже выставленные лоты останутся. При включении возвращаются прежние веса этой сессии или значения по умолчанию.",
"mod.ahbot.qualityWeights": "Качество и частота",
"mod.ahbot.weightsHint": "Это относительные веса, а не проценты. 0 исключает качество; большее значение повышает частоту. Если все значения по умолчанию равны нулю, включается обычное качество. Остальные фильтры продолжают действовать.",
"mod.ahbot.noTypes": "Все типы отключены. Продавцу не из чего выбирать новые лоты.",
"mod.noSettings": "Дополнительных настроек нет. Используйте переключатель модуля выше.",
"mod.ahbot.setup": "Укажите GUID отдельного персонажа аукциониста, включите продавца и модуль. Персонаж должен быть офлайн. Фильтр CoA оставляет предметы из таблиц добычи, торговцев и профессий; ограничения уровней применяются дополнительно. Нужна сборка сервера с фильтром аукциона CoA.",
"mod.ahbot.allSettings": "Все настройки",
"err.bot_modules_conflict.title": "Включены две системы ботов",
"err.bot_modules_conflict.message": "Выключите CoA Companions или SQUID Playerbots в разделе «Модули» перед запуском сервера.",
"mod.title": "Модули", "mod.title": "Модули",
"mod.intro": "Дополнительные возможности, встроенные в сервер. Включайте и выключайте нужные, открывайте их страницу на GitHub или меняйте настройки.", "mod.intro": "Дополнительные возможности, встроенные в сервер. Включайте и выключайте нужные, открывайте их страницу на GitHub или меняйте настройки.",
"mod.restart": "Изменения применятся после перезапуска игрового сервера.", "mod.restart": "Изменения применятся после перезапуска игрового сервера.",
@@ -773,6 +814,8 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Поиск по всем настройкам: название или описание…", "set.searchAll": "Поиск по всем настройкам: название или описание…",
"set.search": "Поиск по настройкам…", "set.search": "Поиск по настройкам…",
"upd.current": "У вас последняя версия ({v}).", "upd.current": "У вас последняя версия ({v}).",
"client.job.checking": "Проверка клиента…",
"client.job.updating": "Обновление клиента",
}; };
export default ru; export default ru;
+804
View File
@@ -0,0 +1,804 @@
/** Simplified Chinese localization (zh-CN) */
const zh = {
"realm.profileLabel": "服务器",
"realm.switching": "正在切换服务器…",
"realm.create": "创建 Wildcard 服务器",
"realm.restart": "切换并重启",
"realm.select": "选择服务器",
"realm.active": "当前活跃:{name}",
"realm.separate": "同时仅运行一个世界服务器。每个服务器保留独立的角色、进度和模块设置。",
"realm.modules": "此处无法使用 CoA 随从。动态难度等级缩放及其他模块在 Wildcard 上仍处于实验阶段。",
"realm.update": "请先将服务器更新至支持 Wildcard 的版本以创建此服务器。",
"realm.recovery": "服务器切换被中断。请选择一个服务器以恢复保存的配置。",
"realm.unsupported": "在 Wildcard 上不可用:职业机制尚未验证通过。",
"realm.experimental": "在 Wildcard 上处于实验阶段 · 游戏玩法兼容性尚未验证。",
"app.name": "CoA Server Manager",
"nav.overview": "概览",
"nav.bots": "机器人",
"nav.server": "服务器",
"nav.players": "玩家",
"nav.friends": "好友联机",
"nav.backups": "备份",
"nav.console": "控制台",
"nav.settings": "设置",
"nav.addAnother": "管理另一个服务器",
"nav.main": "主要",
"nav.serverPicker": "服务器",
"q.overview": "服务器当前是否正在运行?",
"q.bots": "机器人目前是如何配置的?",
"q.server": "服务器机制与规则是如何运行的?",
"q.players": "当前有哪些玩家在线?",
"q.friends": "好友如何加入我的服务器?",
"q.backups": "我的数据是否安全?",
"q.console": "服务器正在输出什么日志?",
"q.settings": "管理器自身如何运行?",
"welcome.title": "欢迎使用 CoA Server Manager",
"welcome.subtitle": "轻松运行专属的征服艾泽拉斯 (CoA) 服务器 —— 无需任何技术知识。",
"welcome.install.title": "安装全新服务器",
"welcome.install.text": "一键自动配置,包含运行所需的所有内容。",
"welcome.import.title": "已有服务器",
"welcome.import.text": "添加现有服务器。仅进行读取,不会更改任何原始文件。",
"welcome.back": "返回我的服务器",
"overview.server": "服务器",
"overview.database": "数据库",
"overview.auth": "登录服务器",
"overview.world": "世界服务器",
"overview.uptime": "运行时间",
"overview.players": "在线玩家",
"overview.companions": "+ {n} 名随从",
"overview.checking": "正在检查服务器状态…",
"overview.partial": "部分服务正在运行。点击“启动”运行其余服务,或点击“停止”完全关闭。",
"overview.portTitle": "服务器所需的端口已被占用",
"overview.portText": "端口 {port} 正在被其他程序占用:{exe}。",
"overview.missingTitle": "未找到服务器文件夹",
"overview.missingText": "{path} 缺失或已被移动。",
"overview.forget": "从管理器中移除(不会删除任何文件)",
"status.online": "在线",
"status.offline": "离线",
"status.starting": "正在启动…",
"status.stopping": "正在停止…",
"status.attention": "需要注意",
"status.running": "运行中",
"status.stopped": "已停止",
"btn.start": "启动服务器",
"btn.stop": "停止服务器",
"btn.stopSmall": "停止",
"btn.restart": "重启",
"btn.play": "开始游戏",
"btn.startPlay": "启动并开始游戏",
"btn.startingCaps": "正在启动…",
"btn.stoppingCaps": "正在停止…",
"common.viewDetails": "查看详情",
"common.hideDetails": "隐藏详情",
"common.copyError": "复制错误信息",
"common.noOutput": "(无输出)",
"common.cancel": "取消",
"common.save": "保存",
"settings.title": "设置",
"settings.language": "语言",
"settings.languageHint": "选择程序界面语言。翻译由母语者校对;尚未翻译的内容将显示为英文。",
"err.database_not_running.title": "数据库未运行",
"err.database_not_running.message": "服务器启动需要数据库支持。请先启动数据库。",
"err.port_in_use.title": "服务器端口已被占用",
"err.port_in_use.message": "其他程序(或另一个服务器)正在使用此服务器所需的端口。",
"err.server_files_incomplete.title": "服务器文件不完整",
"err.server_files_incomplete.message": "部分服务器文件缺失或损坏。",
"err.world_db_incompatible.title": "世界数据库与当前版本不兼容",
"err.world_db_incompatible.message": "此服务器版本启动前需要先执行数据库更新。",
"err.worldserver_already_running.title": "另一个 worldserver 进程已在运行",
"err.worldserver_already_running.message": "请在启动此服务器前先停止另一个服务器。",
"err.invalid_config_value.title": "服务器配置包含无效值",
"err.invalid_config_value.message": "请修正高亮显示的设置并重新保存。",
"err.disk_full.title": "磁盘可用空间不足",
"err.disk_full.message": "请清理部分空间或选择其他驱动器,然后重试。",
"err.operation_in_progress.title": "另一项操作仍在进行中",
"err.operation_in_progress.message": "服务器正忙于启动或停止。请稍等片刻后重试。",
"err.startup_failed.title": "服务器无法启动",
"err.startup_failed.message": "某个服务在启动过程中停止。请查看详细信息了解原因。",
"err.hash_mismatch.title": "下载的文件已损坏",
"err.hash_mismatch.message": "文件校验和不匹配,已放弃使用。",
"err.path_rejected.title": "不允许使用该路径",
"err.path_rejected.message": "请求的文件路径超出了服务器文件夹范围。",
"err.unknown.title": "出现异常",
"err.unknown.message": "请查看技术详情。",
// Import server
"import.title": "添加现有服务器",
"import.subtitle": "选择服务器运行所在的文件夹。仅进行读取。",
"import.dialogTitle": "选择服务器文件夹",
"import.choose": "选择文件夹…",
"import.chooseAnother": "选择其他文件夹",
"import.looking": "正在检查服务器…",
"import.healthy.title": "检测到现有服务器",
"import.healthy.text": "运行此服务器所需的所有文件均已找到。",
"import.partial.title": "服务器部分文件已找到",
"import.partial.text": "缺少部分组件。你仍可添加它;不会自动修复任何内容。",
"import.custom.title": "检测到自定义服务器",
"import.custom.text": "无法识别该构建版本。部分更新和安装功能将被禁用。",
"import.incompatible.title": "这不是有效的服务器文件夹",
"import.incompatible.text": "请选择主服务器文件夹:即包含 Core、Data、mysql、Scripts 和 Settings 的文件夹(而不是 Core 文件夹本身)。",
"import.techDetails": "显示技术详情",
"import.detected": "已检测到",
"import.notInstalled": "未安装",
"import.notFound": "未找到",
"import.noChanges": "导入过程中不会更改任何文件。",
"import.add": "添加服务器",
// Install server
"install.title": "安装全新服务器",
"install.subtitle": "选择一个文件夹,或使用推荐位置。其余所有配置都会为你自动完成。",
"install.installTo": "安装到",
"install.browse": "浏览…",
"install.dialogTitle": "选择服务器安装位置",
"install.pkgDialogTitle": "选择服务器离线安装包文件夹",
"install.ready": "此文件夹已就绪。剩余可用空间 {gb} GB。",
"install.failedTitle": "安装未能完成",
"install.nothingInstalled": "未安装任何内容。你可以重试;已下载的文件会保留。",
"install.showTech": "显示技术详情",
"install.hideTech": "隐藏技术详情",
"install.advanced": "高级选项",
"install.localPkg": "从本地离线包文件夹安装,无需在线下载",
"install.localPkgHint": "(留空则在线下载)",
"install.button": "安装",
"install.progressTitle": "正在准备服务器",
"install.progressText": "这可能需要几分钟。你可以保持此窗口开启。",
"install.step.checking": "检查电脑环境",
"install.step.downloading": "下载服务器",
"install.step.unpacking": "解压文件",
"install.step.database": "准备数据库",
"install.step.finishing": "完成安装",
"install.doneTitle": "服务器已就绪",
"install.doneText": "所有组件均已安装完成。可在下一个界面中启动它。",
"install.open": "打开我的服务器",
// Players
"players.title": "玩家",
"players.createTitle": "创建游戏账号",
"players.createText": "用于登录游戏的账号名称和密码。",
"players.startFirst": "请先启动服务器 —— 账号需要在服务器运行时创建。",
"players.username": "账号名",
"players.password": "密码",
"players.admin": "设为管理员账号",
"players.adminHint": "管理员可以在游戏中使用 GM 命令。请仅对信任的账号开启。",
"players.create": "创建账号",
"players.created": "账号“{name}”创建成功。现在可以使用它登录游戏了。",
// Companions
"comp.title": "AI 随从伙伴",
"comp.population": "当前在线 {online} · 共创建 {total}",
"comp.reading": "正在读取当前人口…",
"comp.startToSee": "启动服务器以查看在线随从数量。",
"comp.wantMore": "想要添加更多随从吗?",
"comp.custom": "自定义",
"comp.numberLabel": "随从数量",
"comp.largeWarning": "较大的人口规模可能需要更多 CPU 和内存。建议逐步增加。",
"comp.hardware": "当前电脑:{cores} 核心,{ram} GB 内存。",
"comp.add": "添加 {n} 名随从",
"comp.addPlain": "添加随从",
"comp.stoppedHint": "服务器已停止:随从将在下次服务器运行时创建。",
"comp.spawned": "正在创建 {n} 名随从。它们将在接下来的几分钟内陆续上线。",
"comp.saved": "已保存。{n} 名随从将在服务器启动时创建。",
// Client
"client.title": "游戏客户端",
"client.looking": "正在寻找…",
"client.intro": "指定游戏客户端安装路径即可启用“开始游戏”按钮。除服务器地址和随从插件外,你的游戏文件绝不会被修改。",
"client.chooseFolder": "选择游戏文件夹…",
"client.dialogTitle": "选择游戏客户端文件夹",
"client.connectsTo": "连接到",
"client.thisComputer": "✓ 本机",
"client.notThisServer": "非此服务器",
"client.addon": "随从管理插件",
"client.installedVersion": "已安装 (版本 {v})",
"client.installed": "已安装",
"client.addonNotInstalled": "未安装",
"client.updateAvailable": "有可用更新",
"client.otherAddons": "其他插件",
"client.leftAsIs": "{n} 个 —— 完全保持原样",
"client.pointLocal": "将游戏连接指向此服务器",
"client.pointedNote": "游戏现在将连接到本机。先前的地址已备份保存。",
"client.installAddon": "安装随从插件",
"client.updateAddon": "更新随从插件",
"client.addonNote": "随从插件已安装。其他插件未受任何影响。",
"client.changeFolder": "更换文件夹…",
// Diagnostics
"diag.title": "诊断",
"diag.text": "检查常见问题。不会修改任何文件。",
"diag.run": "运行诊断",
"diag.verify": "校验服务器文件",
"diag.export": "导出诊断包",
"diag.saved": "已保存供问题反馈使用:{path}",
"diag.allGood": "一切运行正常。",
"diag.problems_one": "发现 {n} 处需要注意",
"diag.problems_few": "发现 {n} 处需要注意",
"diag.problems_many": "发现 {n} 处需要注意",
"diag.problems_other": "发现 {n} 处需要注意",
"diag.word.ok": "正常",
"diag.word.warn": "注意",
"diag.word.fail": "异常",
"diag.filesOk": "所有程序文件完好无损。",
"diag.filesDiffer": "{n} 个程序文件与原始安装不一致。你自己的配置文件绝不会出现在这里。“检查更新”可恢复缺失的文件。",
"diag.fileMissing": "缺失",
"diag.fileChanged": "已修改",
// About Manager
"about.version": "版本 {v}。程序本身的更新绝不会改动你的服务器数据。",
"about.check": "检查新版本",
"about.install": "安装 {v} 并重启",
"about.upToDate": "CoA Server Manager 已是最新版本。",
"about.checkFailed": "检查新版本失败。请检查网络连接后重试。",
"about.installFailed": "无法安装更新。你的服务器未受任何影响。",
// Backups
"bk.title": "备份",
"bk.trigger.manual": "手动备份",
"bk.trigger.automatic": "自动备份",
"bk.trigger.before-update": "更新前自动备份",
"bk.trigger.before-restore": "还原前安全备份",
"bk.trigger.before-migration": "数据库升级前备份",
"bk.trigger.before-bots": "安装随从前备份",
"bk.trigger.before-repair": "修复前备份",
"bk.trigger.before-dangerous-change": "高风险更改前备份",
"bk.kind.quick": "角色、账号与设置",
"bk.kind.full": "完整数据(含世界数据库)",
"bk.kind.config": "仅配置文件",
"bk.kind.database": "角色与账号数据",
"bk.db.characters": "角色数据",
"bk.db.auth": "账号数据",
"bk.db.world": "世界数据",
"bk.today": "今天 {time}",
"bk.yesterday": "昨天 {time}",
"bk.created": "备份创建成功。",
"bk.last": "上次备份:{when}",
"bk.none": "暂无备份",
"bk.keptNext": "备份存放在服务器目录旁,绝不会覆盖你的线上数据。",
"bk.backUpNow": "立即备份",
"bk.full": "完整备份",
"bk.fullHint": "同时保存体积较大的世界数据库",
"bk.settingsOnly": "仅配置文件",
"bk.working": "正在处理…",
"bk.failed": "操作未能完成",
"bk.restoreFrom": "还原来自 {what} 的备份({when})",
"bk.restoreNote": "不会删除任何数据。当前数据会先被安全备份,被替换的数据库将以新名称保留。",
"bk.stopFirst": "请先停止服务器 —— 数据库仅可在服务器停止时还原。",
"bk.settingsRestored": "设置已还原。先前的配置已生成安全副本。",
"bk.restoreSettings": "还原设置",
"bk.confirmDb": "是否从该备份还原 {db} 数据库?自 {when} 以来的新进度将被归档保留(不会被删除)。",
"bk.dbRestored": "成功还原 {n} 张数据表。先前的数据已保留为 {schema}。",
"bk.restoreDb": "还原 {db}",
"bk.loading": "正在加载…",
"bk.empty": "你的备份将显示在此处。",
"bk.restore": "还原",
"bk.verify": "校验",
"bk.intact": "该备份完整无损。",
"bk.problem": "发现问题:{details}",
"bk.delete": "删除",
"bk.confirmDelete": "确定删除此备份吗?仅会删除此备份文件,服务器本身不受影响。",
// Friends
"fr.title": "好友联机",
"fr.looking": "正在检测连接状态…",
"fr.ok": "正常",
"fr.notYet": "尚未就绪",
"fr.mode.lan.title": "局域网联机",
"fr.mode.lan.text": "适用于处于同一家庭网络或 Wi-Fi 下的好友。",
"fr.mode.direct.title": "公网直连",
"fr.mode.direct.text": "跨互联网联机。需要你的路由器支持并开放端口映射。",
"fr.mode.private.title": "虚拟私有网",
"fr.mode.private.text": "跨互联网联机,无需配置路由器。使用免费的 Tailscale 软件。",
"fr.restartToApply": "重启服务器以使配置生效。",
"fr.ready": "已准备好接受好友连接。",
"fr.exposedTitle": "私有服务正暴露在网络中",
"fr.exposedText": "{what} 当前允许来自其他电脑的连接。请通过本管理器重启服务器以关闭外部访问。",
"fr.what.database": "数据库",
"fr.what.console": "服务器控制台",
"fr.and": " 和 ",
"fr.status": "状态",
"fr.st.running": "服务器正在运行",
"fr.st.open": "登录与游戏服务器已向其他电脑开放",
"fr.st.firewall": "Windows 防火墙已放行游戏端口",
"fr.st.private": "数据库与控制台仅限本机访问",
"fr.inUse": "使用中",
"fr.yourLan": "你在局域网中的 IP 地址:",
"fr.unknown": "未知",
"fr.checkConn": "检查我的网络连接",
"fr.cgnat": "你的宽带运营商处于大内网环境 (CGNAT),不支持公网直连。请改用虚拟私有网模式。",
"fr.publicAddr": "你的公网 IP 地址:",
"fr.noRouter": " · 路由器无法自动设置;请手动转发两个游戏端口",
"fr.noInternet": "无法连接到互联网以获取公网 IP 地址。",
"fr.tsMissing": "尚未安装 Tailscale。请下载并安装该免费应用、登录账号后重试。",
"fr.tsOff": "Tailscale 已安装但未连接。请先登录该软件。",
"fr.privateAddr": "你的私有 IP 地址:",
"fr.checkFirst": "请先检测网络连接",
"fr.reapply": "重新应用",
"fr.enable": "启用",
"fr.onlyLocal": "当前仅限本机连接。",
"fr.stopSharing": "停止共享(仅本机连接)",
"fr.giveTitle": "将此信息发送给好友",
"fr.giveText": "好友只需将这行配置写入游戏客户端的 realmlist.wtf 文件。密码与敏感设置绝不会泄露。",
"fr.copied": "已复制",
"fr.copy": "复制连接信息",
"fr.pkg": "打包好友联机补丁 (zip)",
"fr.pkgSaved": "已保存:{path}",
// Console
"con.title": "控制台",
"con.tab.world": "世界",
"con.tab.auth": "登录",
"con.tab.database": "数据库",
"con.tab.manager": "管理器",
"con.searchLabel": "搜索日志",
"con.search": "搜索…",
"con.follow": "滚动到底部",
"con.copied": "已复制",
"con.copyErrors": "仅复制错误日志",
"con.empty": "暂无日志输出。",
"con.commandsNote": "命令将直接发送给正在运行的世界服务器。高风险操作(关机、删除、封禁)会要求二次确认。",
"con.commandLabel": "命令",
"con.send": "发送",
"con.confirmRisky": "指令“{cmd}”可能导致停机或批量修改数据。确定发送吗?",
// Server updates
"upd.act.create": "新增文件",
"upd.act.replace": "已更新",
"upd.act.merge-config": "已合并新配置项",
"upd.act.skip": "保持不变",
"upd.act.conflict": "需要手动决定",
"upd.updatedTo": "已成功更新至版本 {v}。",
"upd.confirmBack": "是否回滚至上一个版本?你的角色与账号数据不会受到影响。",
"upd.wentBack": "已回滚至上一个版本。你的个人数据完好无损。",
"upd.dialogTitle": "选择更新包文件夹",
"upd.pendingBad": "更新后的服务器未能正常启动",
"upd.pendingUnfinished": "先前的更新尚未完成",
"upd.safeBack": "你可以安全回滚至先前的稳定版本。",
"upd.backNote": "回滚将恢复文件和设置。如果数据库更新已开始,所有数据库也将从更新前的备份恢复。之后的进度将丢失。",
"upd.goBackTo": "回滚至版本 {v}",
"upd.goBackBefore": "回滚至更新前的版本",
"upd.title": "服务器更新",
"upd.text": "更新均经过真实性签名校验,并在执行前自动备份,随时可安全撤销。",
"upd.check": "检查更新",
"upd.folderLabel": "更新包文件夹",
"upd.folderHint": "更新包文件夹(留空则从官方源下载)",
"upd.available": "检测到新版本 {to}",
"upd.availableFrom": "检测到新版本 {to}(当前为 {from})",
"upd.summary": "需下载 {size} · 变更 {files} 个文件",
"upd.summaryDb": "需下载 {size} · 变更 {files} 个文件 · {db} 次数据库升级",
"upd.conflict": "此文件曾在管理器外部被手动修改。",
"upd.keep": "保留我的本地文件",
"upd.replace": "使用更新覆盖",
"upd.now": "立即更新",
"upd.stopNote": "更新期间服务器将暂时停止,并在完成后重新启动以验证可用性。",
// Settings editor
"set.restart.runtime": "立即生效",
"set.restart.world": "需要重启世界服务器",
"set.restart.full": "需要完全重启服务器",
"set.on": "开启",
"set.off": "关闭",
"set.enterNumber": "输入数值",
"set.enterInt": "输入整数",
"set.atLeast": "不得小于 {n}",
"set.atMost": "不得大于 {n}",
"set.careful": "谨慎修改",
"set.changed": "已修改",
"set.default": "默认:{v}",
"set.range": "有效范围 {min}–{max}",
"set.badValue": "文件中包含无法使用的值 ({problem});当前显示默认值。",
"set.drift": "在生成的配置文件中被手动修改 —— 除非在此处保存,否则下次启动时管理器将重置该项。",
"set.reset": "恢复默认值",
"set.resetItem": "将 {name} 恢复为默认值",
"set.nothingYet": "暂无需要配置的内容",
"set.loading": "正在加载设置…",
"set.confirmCareful": "你正在修改 {n} 项标记为“谨慎修改”的设置。当前配置已先保存为快照以供撤销。是否继续?",
"set.driftTitle": "有 {n} 项设置曾在外部被手动修改",
"set.driftText": "服务器每次启动都会从模板重新生成 worldserver.conf,以下手动修改的内容将会丢失:",
"set.presets": "预设方案:",
"set.restoreDefaults": "恢复推荐默认值",
"set.matches": "无需更改 —— 你的设置已完全一致。",
"set.willChange_one": "将更改 {n} 项设置:",
"set.willChange_few": "将更改 {n} 项设置:",
"set.willChange_many": "将更改 {n} 项设置:",
"set.willChange_other": "将更改 {n} 项设置:",
"set.apply": "应用",
"set.nothingChanged": "未做任何修改。",
"set.saved": "已保存。",
"set.restartRequired_one": "应用这 {n} 项设置需要重启服务器。",
"set.restartRequired_few": "应用这 {n} 项设置需要重启服务器。",
"set.restartRequired_many": "应用这 {n} 项设置需要重启服务器。",
"set.restartRequired_other": "应用这 {n} 项设置需要重启服务器。",
"set.appliesNextStart": "更改将在下次服务器启动时生效。",
"set.restartNow": "立即重启",
"set.later": "稍后",
"set.notSaved": "未保存任何更改。请修正高亮项后重试。",
"set.advanced": "高级设置 ({n})",
"set.unknownKept": "配置文件中的其他 {n} 项设置完全保持原样。",
"set.unsaved_one": "{n} 项未保存的修改",
"set.unsaved_few": "{n} 项未保存的修改",
"set.unsaved_many": "{n} 项未保存的修改",
"set.unsaved_other": "{n} 项未保存的修改",
"set.discard": "放弃修改",
"set.save": "保存修改",
// Download errors
"err.package_not_published.title": "该服务器安装包尚未发布",
"err.package_not_published.message": "下载源中未找到对应包。请稍后重试,或通过“高级选项”从本地文件夹安装。",
"err.network_unreachable.title": "无法连接到下载服务器",
"err.network_unreachable.message": "请检查网络连接后重试。",
// Manager self-update
"selfupd.ready": "管理器 {v} 已就绪可安装",
"selfupd.onClose": "将在退出管理器时自动安装。你的服务器将继续保持运行。",
"selfupd.installing": "正在安装… 管理器即将关闭。",
"selfupd.now": "立即安装",
"about.auto": "在后台自动下载更新并在退出管理器时安装",
"about.autoHint": "管理器的更新绝不会中断或改动你的游戏服务器。",
// Friends line
"fr.copyLine": "复制配置行",
// Diagnostics checks
"dg.title.files": "服务器文件",
"dg.title.missing_parts": "缺失组件",
"dg.title.mysql": "数据库",
"dg.title.auth": "登录服务器",
"dg.title.world": "世界服务器",
"dg.title.configs": "配置文件",
"dg.title.config_values": "配置数值",
"dg.title.disk": "磁盘可用空间",
"dg.title.permissions": "文件权限",
"dg.title.client": "游戏客户端",
"dg.title.exposure": "私有服务",
"dg.files.ok": "已找到所有预期的服务器组件。",
"dg.files.partial": "部分服务器组件缺失。",
"dg.files.custom": "这是自定义服务器版本;部分功能受限。",
"dg.files.bad": "该文件夹看起来不像有效的 CoA 服务器目录。",
"dg.svc.running": "运行中",
"dg.svc.port": "端口 {port} 正被其他程序占用 (进程 PID {pid})。",
"dg.svc.starting": "正在启动,尚未开始监听响应。",
"dg.svc.stopped": "未运行。",
"dg.configs.ok": "配置文件读取正常。",
"dg.configs.bad": "无法读取以下文件:{files}",
"dg.values.bad": "以下项包含无效值:{keys}",
"dg.disk.ok": "剩余 {gb} GB 可用空间",
"dg.disk.low": "仅剩 {gb} GB 可用空间;备份与更新需要更多存储空间。",
"dg.perm.ok": "服务器目录具有正常写入权限。",
"dg.perm.bad": "管理器无法写入服务器目录(请尝试更换路径或以管理员身份运行一次)。",
"dg.client.missing": "未找到先前设置的游戏客户端路径;请在“设置”中重新选择。",
"dg.exposure.ok": "数据库与控制台未向外部网络暴露。",
"dg.exposure.bad": "以下服务暴露于外部网络中:{what}。",
// Update steps
"ustep.Starting": "正在启动",
"ustep.Checking the update": "正在检查更新",
"ustep.Downloading the update": "正在下载更新",
"ustep.Verifying the update": "正在校验更新包",
"ustep.Making sure the server is stopped": "正在确认服务器已停止",
"ustep.Saving a recovery point": "正在创建恢复点",
"ustep.Applying the update": "正在应用更新文件",
"ustep.Updating the database": "正在更新数据库结构",
"ustep.Starting the updated server": "正在启动更新后的服务器",
"ustep.Finishing": "正在收尾完成",
"ustep.Undoing the update": "正在撤销更新并回滚",
"ustep.Done": "已完成",
// Companion sizes
"comp.size.small": "小型",
"comp.size.medium": "中型",
"comp.size.large": "大型",
"comp.warnHardware": "{n} 名随从可能需要超出本机硬件配置的 CPU 和内存资源(本机:{cores} 核,{ram} GB)。",
"comp.warnMemory": "请先释放部分系统内存;其他程序当前占用了大部分可用内存。",
// Friends notes
"fr.note.forwarded": "已向路由器请求自动端口映射。",
"fr.note.manual": "你的路由器不支持自动端口映射;请手动转发两个游戏端口或使用虚拟私有网。",
// Import labels and placeholder
"scan.label.worldserver": "世界服务器 (worldserver)",
"scan.label.authserver": "登录服务器 (authserver)",
"scan.label.database_content": "账号 / 角色 / 世界数据库",
"scan.label.companions": "CoA 随从伙伴 (机器人)",
"scan.label.client": "游戏客户端",
"placeholder.soon": "该模块将在后续版本中开放支持。",
// Tick rate
"overview.tick": "世界运算帧率",
"overview.tickUnit": "次心跳/秒",
"overview.tickGood": "流畅",
"overview.tickBusy": "负载较高",
"overview.tickLag": "存在卡顿",
"overview.tickDetail": "平均心跳延迟 {mean} ms · 95% 低于 {p95} ms · 峰值 {max} ms",
"overview.tickHint": "世界服务器的循环处理速度。高于每秒 20 次心跳时体验流畅;低于 10 次会出现明显延迟感。",
// Companions start
"err.companion_templates_missing.title": "尚未生成随从模板数据",
"err.companion_templates_missing.message": "新随从基于各职业的 80 级角色模板克隆。请在任意普通玩家账号下为每个职业创建一个 80 级角色,然后重试。",
// Friends guides
"fr.tsDownload": "下载 Tailscale (免费)",
"fr.guide": "联机配置指南",
"fr.g.net.1": "点击“检查我的网络连接”:管理器会自动获取你的公网 IP,并尝试通过 UPnP 自动配置路由器端口转发。",
"fr.g.net.2": "如果无法自动打开,请登录路由器管理后台(通常为 192.168.0.1 或 192.168.1.1),找到“端口转发 (Port Forwarding)”或“虚拟服务器 / NAT”。",
"fr.g.net.3": "将两个 TCP 端口映射到本机的内网 IP ({lan}):{auth}(登录)与 {world}(游戏)。内外部端口号保持一致。",
"fr.g.net.4": "切勿转发数据库端口 (3307) 或服务器控制台端口 (3443)。",
"fr.g.net.5": "点击“启用”,重启服务器,并将上方的配置行(“set realmlist …”)发送给好友。好友将其写入游戏目录下的 realmlist.wtf 文件即可。",
"fr.g.net.6": "如果你的宽带是运营商大内网 (CGNAT),将无法开放公网端口:请改用下方的虚拟私有网方案。",
"fr.g.routerHelp": "常见路由器端口转发分步指南 (portforward.com)",
"fr.g.ts.1": "你和好友均下载安装免费的 Tailscale 客户端(上方链接)并登录账号。",
"fr.g.ts.2": "将你的电脑共享给好友:打开 Tailscale 后台管理页面,在设备列表中找到本机,选择“Share…”,将邀请链接发给好友。好友在自己的 Tailscale 账号中接受即可。",
"fr.g.ts.3": "无需任何路由器配置。点击“启用”,重启服务器,并将包含你 Tailscale IP 的配置行发送给好友。",
"fr.g.ts.4": "联机游玩期间双方均需保持 Tailscale 客户端在后台运行。",
"fr.g.ts.admin": "打开 Tailscale 管理控制台",
"fr.g.ts.share": "了解设备共享机制 (tailscale.com)",
// Bots at start
"comp.startTitle": "服务器启动时随从设置",
"comp.startAuto": "服务器启动时自动让随从上线",
"comp.startCount": "自动登录随从数量",
"comp.startSave": "保存",
"comp.startSaved": "已保存。将在下次服务器启动时生效。",
"comp.startHint": "未登录的随从仍保留在数据库中,随时可在需要时手动调出上线。",
"comp.startInvalid": "请输入 0 到 5000 之间的整数。",
// Overview start bots
"overview.startBots": "开机自动登录随从:{n}",
"overview.startBotsOff": "开机自动登录随从:关闭",
// Offline bots
"comp.offlineDone": "已成功创建 {n} 名随从及初始装备。它们将在下次服务器启动时登录游戏。",
// Companions progress
"comp.progress": "已添加 {done} / {target}",
"comp.progressDone": "所有 {n} 名随从创建完毕。正在陆续登录上线。",
"comp.progressOffline": "正在为 {n} 名随从配置装备与数据… 这需要几分钟时间。",
"comp.progressStalled": "正在等待服务器完成批量生成…",
// Companions control
"comp.stop": "停止创建",
"comp.stopped": "已停止。排队中的 {n} 名随从已取消创建;已经生成的随从将保留。",
"comp.manageTitle": "管理现有随从",
"comp.offline": "全部下线",
"comp.offlineConfirm": "是否将所有随从踢出游戏?它们的数据仍完好保存在数据库中,可在下次启动或手动添加时重新上线。",
"comp.offlineDone2": "已将 {n} 名随从下线。数据已保留。",
"comp.delete": "永久删除所有随从…",
"comp.deleteConfirm": "是否彻底删除所有 {n} 名随从?系统会先自动保存恢复点。你自己的玩家角色绝不会受影响。",
"comp.deleteDone": "所有随从已成功删除。操作前已保存安全恢复点。",
"err.companion_command_unsupported.title": "当前服务器核心版本不支持该命令",
"err.companion_command_unsupported.message": "当前构建版本的随从模块缺少该指令。请更新服务器,或通过重启服务器来中止当前任务。",
// Despawn some
"comp.despawnSome": "减少 {n} 名随从",
"comp.despawnCount": "让多少名随从下线",
"comp.despawnHint": "可立即降低服务器负载:每个在线随从都会消耗计算资源。随从数据保留在数据库中,若开启了自动登录则会在下次启动时恢复。",
"comp.despawnSomeDone": "已让 {n} 名随从下线。数据已保存。",
// Server update button
"btn.update": "更新",
"btn.updating": "正在更新…",
"btn.updateTo": "更新至 {v}",
"overview.updateAvail": "检测到服务器新版本:{to}(当前为 {from})。",
"overview.updateConflicts": "部分文件被你手动修改过。请在“设置”中选择如何处理冲突。",
"overview.openUpdates": "打开更新界面",
"overview.updatingNote": "正在更新:服务器将自动停止、备份、应用更新并重新启动以验证可用性。",
"nav.updateDot": "有可用更新",
// Game client download and update
"btn.close": "关闭",
"btn.setupClient": "配置游戏客户端",
"btn.updateClient": "更新客户端",
"client.setup.title": "配置游戏客户端",
"client.setup.intro": "进行游戏需要安装匹配的客户端。你可以关联已有的游戏客户端,也可以让管理器为你自动下载。",
"client.setup.have": "已有游戏客户端",
"client.setup.download": "下载全新客户端",
"client.setup.downloadHint": "约 43 GB",
"client.dl.pickParent": "选择游戏客户端存放位置",
"client.dl.confirmText": "版本 {v},体积 {size}。将被保存在以下文件夹中:",
"client.dl.free": "该驱动器剩余空间:{free}。",
"client.dl.notEnough": "磁盘剩余空间不足:需要 {need},可用 {free}。请选择其他驱动器。",
"client.dl.otherFolder": "选择其他文件夹…",
"client.dl.start": "开始下载",
"client.dl.back": "返回",
"client.dl.retry": "重试",
"client.dl.resume": "继续下载",
"client.dl.cancel": "停止",
"client.dl.cancelled": "下载已暂停。已下载的文件将被保留;随时可继续断点续传。",
"client.dl.scanning": "正在比对文件…",
"client.dl.downloading": "正在下载",
"client.dl.progress": "{done} / {total}",
"client.dl.speed": "{speed}/秒",
"client.dl.done": "游戏客户端已就绪",
"client.dl.doneText": "已成功关联至此服务器。你可以点击“开始游戏”了。",
"client.upd.title": "客户端更新",
"client.upd.available": "检测到更新的游戏客户端版本:{v}。",
"client.upd.summary": "需下载 {n} 个文件,共计 {size}。",
"client.upd.upToDate": "你的客户端已与版本 {v} 完全一致。",
"client.upd.modifiedTitle": "检测到 {n} 个文件曾被你修改",
"client.upd.modifiedText": "例如打过补丁的可执行程序。你可以选择保留它们,或替换为官方版本;被替换的文件将保存在客户端的 .coa-manager 文件夹中以作备份。图形渲染增强补丁(如 d3d9.dll 等)及配置文件始终会保留原样。",
"client.upd.keep": "保留我修改过的文件",
"client.upd.more": "… 以及另外 {n} 个",
"client.upd.start": "更新客户端",
"client.upd.later": "暂不更新",
"client.upd.playAnyway": "跳过更新直接进入游戏",
"client.upd.done": "游戏客户端已是最新版本",
"client.upd.doneText": "当发布更高版本时,管理器会及时提醒你。",
"client.track.title": "保持客户端为最新版本",
"client.track.text": "管理器会先比对你的客户端与官方版本,并在后续像检查服务器更新一样检测新版本。除非你明确选择,否则你修改过的文件绝不会被自动替换。",
"client.track.start": "保持更新",
"client.track.startUpdate": "更新并保持同步",
"client.track.button": "为该客户端开启自动检查更新…",
"client.version": "客户端版本",
"client.versionUntracked": "未由管理器追踪",
"client.versionUnfinished": "下载尚未完成",
"client.downloadInstead": "下载全新客户端…",
// Accounts panel, password toggle, install size, addon explanation
"pw.show": "显示密码",
"pw.hide": "隐藏密码",
"install.size": "服务器安装将占用约 {size} 磁盘空间。下载包体积为 {download};安装过程中峰值约需 {peak} 临时空间。",
"client.addonWhat": "在游戏内通过小地图图标打开的管理面板,用于指挥你的随从:补齐五人小队、分配坦克治疗输出职责与阵型、下达攻击/拉怪/停留等指令,并实时查看他们的装备与任务状态。即使不安装插件游戏也能正常运行,此时随从将完全由其自主 AI 驱动。",
"acc.title": "账号管理",
"acc.text": "可登录该服务器的所有账号。修改密码及权限需要服务器处于运行状态。",
"acc.refresh": "刷新列表",
"acc.unavailable": "账号列表当前不可用。请启动服务器后重试。",
"acc.empty": "暂无账号。可在上方创建第一个账号。",
"acc.col.name": "账号",
"acc.col.chars": "角色数量",
"acc.col.access": "权限等级",
"acc.col.last": "最后登录",
"acc.online": "在线",
"acc.never": "从未登录",
"acc.level.0": "普通玩家",
"acc.level.1": "版主 (Moderator)",
"acc.level.2": "游戏管理员 (GM)",
"acc.level.3": "最高管理员 (Admin)",
"acc.changePassword": "修改密码",
"acc.rename": "重命名",
"acc.needsRunning": "请先启动服务器再管理账号。",
"acc.changeFor": "为 {name} 设置新密码",
"acc.renameFor": "重命名账号 {name}",
"acc.newName": "新账号名称",
"acc.newPassword": "新密码",
"acc.nameRule": "3–17 位英文字母或数字。",
"acc.passRule": "6–16 位字符,不可包含空格或引号。",
"acc.renameNote": "由于魔兽认证协议中的密码散列依赖账号名称,重命名后必须设置新密码。玩家将使用新账号名和此密码登录。操作时该账号必须处于离线状态。",
"acc.save": "保存",
"acc.passwordChanged": "账号 {name} 的密码已成功修改。",
"acc.renamed": "账号 {name} 现已更名为 {new}。",
"acc.accessChanged": "账号 {name} 的权限现已调整为:{level}。",
// Problem report (GitHub issue)
"nav.report": "问题反馈",
"q.report": "遇到了功能异常?",
"rep.title": "报告问题",
"rep.intro": "描述遇到的问题。管理器会据此生成一份 GitHub Issue 报告并在浏览器中打开;你可以在网页上核对内容、添加截图并提交。需要免费的 GitHub 账号。本窗口不会直接向外发送任何数据。",
"rep.autoTitle": "自动填充的系统环境",
"rep.manager": "管理器版本",
"rep.windows": "Windows 版本",
"rep.kind": "服务器类型",
"rep.kindNew": "全新安装",
"rep.kindImported": "导入现有服务器",
"rep.server": "服务器核心版本",
"rep.summary": "问题简述",
"rep.summaryHint": "例如:创建角色后卡在加载画面",
"rep.what": "具体发生了什么?",
"rep.whatHint": "详细描述故障现象。",
"rep.expected": "你预期的行为是什么?",
"rep.expectedHint": "描述你期望的正常表现。",
"rep.steps": "复现步骤",
"rep.attachTitle": "日志与截图附件",
"rep.attachText": "生成一份诊断包文件(已自动脱敏密码与私有 IP 等敏感信息),并在浏览器打开 GitHub 页面后,将其连同截图或录屏一起拖拽上传。",
"rep.makeFile": "生成诊断包文件",
"rep.fileSaved": "已保存至 {path}。请将该文件拖入 GitHub Issue 中。",
"rep.privacy": "上传前请注意检查并移除日志中可能包含的私有密码、Token 或其他敏感隐私信息。",
"rep.open": "在 GitHub 上打开报告",
"rep.copy": "复制报告文本",
"rep.preview": "预览报告文本",
"rep.needFields": "请先填写问题简述和发生的情况。",
"rep.githubNote": "报告内容会自动整理为英文以便开发者阅读;你填写的文字将按原样保留。",
"rep.opened": "已在浏览器中打开 GitHub。请检查内容、附上日志文件并点击“Submit new issue”。",
"rep.openedLong": "报告内容较长超出 URL 长度限制,已自动复制到剪贴板。请在已打开的 GitHub 页面中按 Ctrl+V 粘贴描述,附上文件后提交。",
"rep.copied": "已复制到剪贴板。",
// Realmlist switcher and modules page
"realm.label": "服务器列表",
"realm.other": "其他",
"realm.add": "添加服务器地址…",
"realm.addTitle": "新增 realmlist 配置",
"realm.editTitle": "编辑 realmlist 配置",
"realm.name": "名称",
"realm.nameHint": "例如 单机服 或 PTR测试服",
"realm.data": "Realmlist 地址",
"realm.dataHint": "即 realmlist.wtf 文件的内容,例如:set realmlist play.example.com。也可以直接输入域名或 IP。选择该项会将其写入游戏客户端,先前的配置会自动备份。",
"realm.switched": "游戏客户端现已切换至“{name}”。",
"realm.edit": "编辑 {name}",
"realm.delete": "删除 {name}",
"realm.confirmDelete": "是否删除 realmlist 配置“{name}”?游戏客户端将继续保留其当前的文件内容。",
"nav.modules": "扩展模块",
"q.modules": "服务器支持哪些扩展模块?",
"mod.ahbot.types": "出售物品类型",
"mod.ahbot.typesHint": "选择新拍卖的物品类型,已有拍卖不受影响。启用会恢复本次会话的权重或默认值。",
"mod.ahbot.qualityWeights": "品质与频率",
"mod.ahbot.weightsHint": "相对权重而非百分比。0排除该品质,数值越大越常见。如果默认值全为0,启用时选择普通品质。其他筛选仍生效。",
"mod.ahbot.noTypes": "所有类型均已关闭,卖家没有可供新拍卖选择的类型。",
"mod.noSettings": "没有其他设置,请使用上方模块开关。",
"err.bot_modules_conflict.title": "已启用两个机器人模块",
"err.bot_modules_conflict.message": "启动服务器前,请在模块中关闭CoA Companions或SQUID Playerbots。",
"mod.ahbot.setup": "填写独立拍卖角色的GUID,并启用卖家和模块。角色必须离线。CoA筛选使用掉落、商人和专业物品表,等级限制另行生效。需要包含CoA拍卖筛选的服务器版本。",
"mod.ahbot.allSettings": "所有拍卖设置",
"mod.title": "模块管理",
"mod.intro": "服务器内置的可选扩展特性。可按需开关、访问其 GitHub 页面或调整独立参数。",
"mod.restart": "更改将在世界服务器重启后生效。",
"mod.switch": "开启或关闭 {name}",
"mod.notHere": "未包含在当前服务器中",
"mod.github": "GitHub 页面",
"mod.settings": "模块设置",
"mod.default": "恢复为默认值 ({v})",
"mod.saved": "已保存(修改了 {n} 项)。",
// Modules page: nothing yet
"mod.empty": "此处暂无内容。随着后续添加,可选模块将展示在此页面。",
// Settings page: the full searchable list
"all.title": "所有服务器设置",
"all.intro": "世界服务器的全部其他已收录设置项及详细说明。其他选项卡已有的设置此处不重复罗列,但上方搜索框可全局检索。请仅修改你理解的选项:错误的配置可能导致服务器无法启动。修改前会自动保存旧配置以供随时恢复。",
"all.search": "按名称或描述搜索…",
"all.onlyChanged": "仅显示已修改",
"all.count": "正在显示 {shown} / {total} 项。使用搜索可快速缩小范围。",
"all.none": "未找到匹配的设置项。",
"all.changed": "已修改",
"all.useDefault": "恢复默认值 ({v})",
"all.save": "保存 {n} 项修改",
"all.saved": "已保存。请重启服务器使更改生效。",
"import.suggest.title": "你是否是指此文件夹?",
"import.suggest.text": "所选文件夹属于某个服务器子目录。检测到的主服务器根目录为:",
"import.suggest.use": "使用该主文件夹",
"import.notRepack": "该目录看起来是独立的 AzerothCore 原版服务器。本管理器专为 CoA Repack 架构设计(包含 Core、mysql、Scripts 和 Settings 的目录)。请使用“安装全新服务器”或导入 CoA Repack。",
"acc.delete": "删除",
"acc.deleteFor": "删除账号 {name}?",
"acc.deleteWarn": "此操作将永久删除该账号及其名下的所有角色 ({n})。该操作无法撤销;如有需要请先创建备份。",
"acc.deleteConfirm": "请输入 {name} 以确认删除",
"acc.deleteButton": "彻底删除账号",
"acc.deleted": "账号 {name} 已成功删除。",
"mod.status.early": "早期预览",
"mod.status.beta": "测试版",
"mod.status.release": "正式版",
"mod.hint.early": "实验性功能:可能变更或不稳定。",
"mod.hint.beta": "功能正常,仍在持续测试中。",
"mod.hint.release": "稳定可靠。",
"mod.legend": "模块状态",
"mod.alwaysOn": "始终启用",
"mod.settingsOf": "{name}:详细设置",
"col.title": "外观与收藏",
"col.intro": "游戏客户端的外观收集与便利功能开关。将在世界服务器重启后生效。",
"col.appearances": "解锁全部幻化外观",
"col.appearances.text": "所有装备外观从一开始就直接收录在试衣间衣橱中。",
"col.vanity": "解锁全部 Vanity 物品收藏",
"col.vanity.text": "所有 Vanity 收藏品默认对全服每个账号开放拥有。",
"col.auto": "自动收集装备外观",
"col.auto.text": "角色获得的装备会自动加入账号幻化外观库。",
"col.companions": "自动学会已拥有的坐骑与宠物",
"col.companions.text": "背包中的坐骑与宠物直接永久学会。",
"col.riding": "出生即可拥有满级骑术",
"col.riding.text": "1 级即可掌握所有级别骑术及寒冷飞行技能。",
"mod.status.soon": "即将推出",
"mod.hint.soon": "规划中:当前版本尚不可用。",
"set.tab.collections": "外观收藏",
"set.tab.all": "其他设置",
"set.searchAll": "按名称或描述搜索全部设置…",
"set.search": "搜索设置…",
"upd.current": "当前已是最新版本 ({v})。",
"client.job.checking": "正在检查游戏客户端…",
"client.job.updating": "正在更新游戏客户端",
"err.docker_unavailable.title": "Docker 不可用",
"err.docker_unavailable.message": "此服务器通过 Docker 运行。请安装并启动 Docker,确保当前用户有权使用它,然后重试。",
} as const;
export default zh;
+3 -3
View File
@@ -349,7 +349,7 @@
}, },
"Rate.Rest.InGame": { "Rate.Rest.InGame": {
"t": "Ruhebonus beim Spielen", "t": "Ruhebonus beim Spielen",
"d": "Geschwindigkeit, mit der Ruhe-Erfahrung beim Spielen aufgebraucht wird." "d": "Geschwindigkeit, mit der Erholungsbonus online in einem Ruhebereich aufgebaut wird."
}, },
"Rate.Creature.Normal.Damage": { "Rate.Creature.Normal.Damage": {
"t": "Monsterschaden", "t": "Monsterschaden",
@@ -484,8 +484,8 @@
"d": "Multiplikator dafür, wie oft legendäre (orange) Gegenstände fallen." "d": "Multiplikator dafür, wie oft legendäre (orange) Gegenstände fallen."
}, },
"Rate.Talent": { "Rate.Talent": {
"t": "Talentpunkte", "t": "Standard-Talentpunkte (AzerothCore)",
"d": "Multiplikator für die Talentpunkte, die ein Charakter pro Stufe erhält." "d": "Gilt nur für Standardtalente von AzerothCore. CoA-Klassen- und Spezialisierungspunkte stammen aus Clientdaten und ignorieren diesen Multiplikator."
}, },
"Rate.Skill.Discovery": { "Rate.Skill.Discovery": {
"t": "Chance auf Rezeptentdeckung", "t": "Chance auf Rezeptentdeckung",
Loaded 100 of 127 files, more files were not shown because too many files have changed in this diff. Show more