Compare commits

..
Author SHA1 Message Date
Дмитрий 4efc02e768 fix(paths): recognize long Windows rehearsal paths inside server 2026-10-13 07:18:03 +05:00
Corfirean be9641254a Merge pull request #92 from Corfirean/feat/client-races-1.6
feat(client): update custom races to verified 1.6 payloads
2026-10-13 07:14:35 +05:00
Дмитрий c18daac228 docs(changelog): record supported experimental bot race preset 2026-10-13 07:02:07 +05:00
Дмитрий 89c62abf80 fix(bots): align experimental race exclusions with upstream 1.6 2026-10-13 07:01:15 +05:00
Дмитрий a6471d79d0 feat(client): update verified custom race payloads to 1.6 2026-10-13 06:52:12 +05:00
Corfirean fd0eaafda2 Merge pull request #70 from lostmind84/feat/linux-b4-parity
feat: Docker server parity on Linux (realm online, game data folder, settings, sharing)
2026-10-13 06:50:56 +05:00
Corfirean fb1cc38773 Merge pull request #73 from LarsSeverson/fix/local-host-friends-mode
fix(friends): preserve local realm address
2026-10-13 06:42:46 +05:00
Corfirean 7a950f234b Merge pull request #91 from Corfirean/fix/export-maintenance-diagnostics
fix(diagnostics): log refused starts and export maintenance ownership
2026-10-13 06:42:42 +05:00
Corfirean 2f1df13b7a Merge pull request #90 from Corfirean/fix/operation-lock-contention
fix(startup): wait for update checks and identify active maintenance
2026-10-13 06:42:38 +05:00
Corfirean be705329c1 Merge pull request #89 from Corfirean/fix/show-installed-module-versions
feat(modules): display installed server revisions and client patch version
2026-10-13 06:42:34 +05:00
Corfirean 7e70409ca0 Merge pull request #88 from Corfirean/fix/client-patch-preservation
fix(client): preserve and repair custom race patch files safely
2026-10-13 06:42:08 +05:00
Corfirean 9e6a650d13 Merge pull request #87 from Corfirean/fix/startup-failure-service-logs
fix(diagnostics): show service errors behind failed update rehearsal
2026-10-13 06:42:04 +05:00
Corfirean 0398a5a6f9 Merge pull request #86 from Corfirean/fix/stock-bot-race-exclusions
fix(bots): keep the standard-races preset free of custom race IDs
2026-10-13 06:42:00 +05:00
Corfirean dd23e81dd4 Merge pull request #85 from Corfirean/fix/recheck-installed-release
fix(updates): allow checking the already installed release
2026-10-13 06:41:56 +05:00
Дмитрий ca2a555d7c fix(docker): request restart when remote client protocol changes 2026-10-13 06:41:16 +05:00
Дмитрий 8269a53db7 fix(diagnostics): record refused starts and export maintenance ownership 2026-10-13 06:26:46 +05:00
Дмитрий b97f86fc00 feat(modules): show installed revisions and client patch versions 2026-10-13 06:21:05 +05:00
Дмитрий 1a71f18def fix(client): create missing patch directories before publishing 2026-10-13 06:20:23 +05:00
Дмитрий 358f9f4f2b fix(bots): exclude every nonstandard race in the stock preset 2026-10-13 06:17:52 +05:00
Дмитрий 0c0d2db368 fix(startup): wait for checks and report operation lock owners 2026-10-13 06:17:17 +05:00
Дмитрий 7d7bc530ec fix(client): preserve originals and verify race patch lifecycle 2026-10-13 06:14:32 +05:00
Дмитрий acd04fae2f fix(diagnostics): include service errors after launcher readiness 2026-10-13 06:10:56 +05:00
Дмитрий 106a532092 fix(updates): accept rechecking the installed target release 2026-10-13 05:59:38 +05:00
Corfirean d86a1676fe Merge pull request #78 from Corfirean/fix/navigation-update-journal
Prevent quadratic recovery journal writes during large updates
2026-10-12 03:54:42 +05:00
Дмитрий 53a05820c8 Prepare recovery once for bulk updates and release Manager 0.6.15 2026-10-12 03:47:24 +05:00
Дмитрий 58c976a388 Prepare Manager version 0.6.14 2026-10-12 02:03:36 +05:00
Corfirean 35c4d03bdc Merge pull request #77 from Corfirean/fix/rehearsal-copy-prefix
Normalize rehearsal roots to avoid Windows path prefix errors
2026-10-12 02:01:55 +05:00
Дмитрий c45f962d02 Normalize rehearsal roots to avoid prefix errors on Windows 2026-10-12 01:03:35 +05:00
Corfirean f52bd8ba5f Merge pull request #75 from Corfirean/fix/upgrade-fixture-paths
Use absolute paths throughout Manager upgrade qualification
2026-10-11 22:03:49 +05:00
Дмитрий 247159e56c Normalize all upgrade qualification paths before update transactions 2026-10-11 22:03:09 +05:00
Corfirean cdd5be2365 Merge pull request #74 from Corfirean/fix/startup-fixture-paths
Fix relative startup fixture paths selecting old server binaries
2026-10-11 21:50:13 +05:00
Дмитрий 7e170744bf Exercise an explicitly relative fixture path in regression 2026-10-11 21:50:09 +05:00
Дмитрий 10daa9b74d Resolve startup fixture roots before copying candidate files 2026-10-11 21:49:44 +05:00
LarsSeverson 51ef88101e fix(friends): preserve local realm address 2026-10-11 11:35:24 -05:00
Corfirean ed7bf7262b Merge pull request #71 from Corfirean/fix/player-race-patches
Add custom race patch installation for remote players
2026-10-11 15:37:54 +05:00
Дмитрий 7c866b116d feat(client): install custom race patches in player mode 2026-10-11 15:37:44 +05:00
Fabien F. 4d8ca00e46 test: a Docker config built by a test has no database data directory 2026-10-11 08:57:43 +02:00
Fabien F. 36bfc6d31e docs: changelog entry for Docker server parity 2026-10-11 08:57:43 +02:00
Fabien F. 3fb4ee39c6 fix: the realm is not shown offline after a start on Docker
The auth server marks every realm offline when it starts, after the world server
cleared its own flag. Mark the active realm online once the auth server listens.
2026-10-11 08:57:43 +02:00
Fabien F. 0250b61c62 feat: a wrong game data folder is diagnosed, and it can be changed from Settings
The world refusing to start with the standard Data set (no CoA DBC) is now
reported as GameDataMismatch. A Settings card shows the folder in use and
changes it while the server is stopped, using the install checks.
2026-10-11 08:57:43 +02:00
Fabien F. dfd8a50975 fix: sharing with friends and the other screens work on a Docker server
Second part of the audit of every screen for a Docker server. What it found, and
what now happens:

- Play with friends. "Servers open" read the BindIP of the configuration files, which
  the containers force to 0.0.0.0, so it was green on a fresh server while who can
  connect is decided by the address the ports are published on (bindAddress in
  docker.json). Opening and closing now edit bindAddress (and set
  CoA.AllowRemoteClients), the open state is read from it, and enabling a mode no
  longer fails on netsh / PowerShell after it already rewrote the files. There is no
  firewall row on Linux (Docker publishes the ports itself); the Windows reply is
  unchanged.
- The "private services" check (Friends and Diagnostics) could never fail on Linux: it
  reads the Windows listener table. For a Docker server it is computed from how the
  ports are published: the database never, the console only on 127.0.0.1, the game
  servers on bindAddress.
- Console, Database tab: read a mysql log file that does not exist; it shows
  `docker logs` of the database container.
- The Overview showed a service that had stopped by itself as "Stopped"; it now says
  "Stopped unexpectedly".
- Settings: a Docker server that was added but never started had no
  worldserver.conf and the page failed; it is created from its template. A talent
  file path outside the Core folder is refused (the container cannot see it).
- Backups of configuration now include docker.json; verifying the files of an
  imported Docker server looked for worldserver.exe and reported it missing.
- Linux locations: the friend package and the diagnostics go to the desktop folder
  (from the user directories file) instead of /tmp, the problem report names the
  distribution, and the size advice for companions reads /proc/meminfo instead of
  assuming 8 GB.

Every Windows branch is the code that was there; the dispatch is the early return on
docker::is_docker (or the host flavor for the firewall).
2026-10-11 08:57:38 +02:00
Fabien F. 90c308615b fix: settings the Docker backend fixes are not offered, and the world restarts itself
Found by auditing every screen for a Docker server.

- Server settings: Ra.Enable, Ra.IP and Updates.EnableDatabases were on the page and
  written to worldserver.conf, but the containers get AC_RA_ENABLE, AC_RA_IP and
  AC_UPDATES_ENABLE_DATABASES, and the core reads those before the file: the change
  was accepted and had no effect, and the page showed the file's value while the
  container ran another. A Docker server no longer offers them (nor "restore
  recommended defaults" for them), and a change forced through is refused with the
  reason. The list is docker::FORCED_KEYS, and a test compares it to the variables
  the containers really get, so adding one without the other fails.
- `server restart` (and idlerestart) make the core exit with code 2 and expect a
  supervisor to start it again; the Docker world had none and showed "crashed". It now
  gets `--restart on-failure:3`, applied once the server is up (so a start that fails
  stays failed instead of looping); a stop or `server shutdown` (code 0) is never
  restarted.
2026-10-11 08:57:38 +02:00
Corfirean cfea54e203 Merge pull request #68 from Corfirean/release/0.6.13
Keep the next Manager release at 0.6.13
2026-10-11 01:39:57 +05:00
Дмитрий 57aa97da8a Revert "Prepare Manager version 0.7.0"
This reverts commit 6fd2130fc4.
2026-10-11 01:39:35 +05:00
Corfirean b9f89a4ae4 Merge pull request #67 from Corfirean/release/0.7.0
Prepare Manager 0.7.0
2026-10-11 01:38:56 +05:00
Дмитрий 6fd2130fc4 Prepare Manager version 0.7.0 2026-10-11 01:38:45 +05:00
Corfirean 346d97ee89 Merge pull request #62 from Corfirean/automation/immutable-channels
Prepare safe immutable updates and automatic recovery for Manager 0.6.13
2026-10-11 01:35:27 +05:00
Дмитрий 10a6744192 Normalize MySQL inventory roots consistently on Windows 2026-10-11 01:31:22 +05:00
Дмитрий 7557b347c5 Merge remote-tracking branch 'origin/master' into automation/immutable-channels 2026-10-11 01:31:22 +05:00
Corfirean 2abd64dfe2 Merge pull request #66 from Corfirean/feat/custom-races-bot-exclusions
feat(races): synchronize custom races bot setting with playerbots excluded races
2026-10-11 01:31:20 +05:00
Дмитрий 9ae5fb471b Rehearse Windows updates and preserve complete MySQL recovery 2026-10-10 23:34:29 +05:00
Дмитрий 59036867d7 Report all database objects blocking update recovery 2026-10-10 22:33:54 +05:00
Дмитрий 949614f11a fix(races): update excluded bot race IDs as requested by llusixn 2026-10-10 22:06:19 +05:00
Дмитрий 9ee0e9f6af Revert "Keep the RA test peer open until clients finish under parallel load"
This reverts commit 3405c89fe8.
2026-10-10 20:56:15 +05:00
Дмитрий 3405c89fe8 Keep the RA test peer open until clients finish under parallel load 2026-10-10 20:55:38 +05:00
Дмитрий 4c4d39f1de feat(races): synchronize custom races bot setting with playerbots excluded races 2026-10-10 20:55:27 +05:00
Дмитрий b101c79e96 Qualify upgrades through the real Manager transaction in isolated fixtures 2026-10-10 20:51:02 +05:00
Дмитрий 3b7f77d92e Check packaged MySQL Unicode regex support on fresh data 2026-10-10 19:52:07 +05:00
Дмитрий 0589722e71 Include persisted schema failures in diagnostic exports 2026-10-10 19:38:36 +05:00
Дмитрий a3717c08bb Retain each schema failure report during recovery validation 2026-10-10 19:37:13 +05:00
Дмитрий dc2bffc57e Keep complete schema diagnostics across update rollback 2026-10-10 19:34:52 +05:00
Дмитрий e34ab45443 Add full isolated server startup qualification for disposable Windows fixtures 2026-10-10 13:02:33 +05:00
Дмитрий 40f9feab84 Bind upgrade compatibility to signed database source contracts 2026-10-10 12:57:11 +05:00
Дмитрий 5b16842720 Isolate update startup checks and recover validation configurations 2026-10-10 12:34:48 +05:00
Дмитрий 02843bb6d1 Check release compatibility and recover unhealthy updates automatically 2026-10-10 12:22:14 +05:00
Дмитрий a9ab7ced7e Merge branch 'fix/module-base-update-replay' into automation/immutable-channels 2026-10-10 12:15:43 +05:00
Дмитрий 77318895ae Reproduce raid base SQL replay on disposable MySQL 2026-10-10 12:15:43 +05:00
Дмитрий 115c57f54e Separate module installation SQL from incremental update packages 2026-10-10 12:11:19 +05:00
Дмитрий 94fd5fb5b9 Resolve signed immutable server update channels 2026-10-10 12:05:14 +05:00
Дмитрий 94d4ade1c7 Fix headless world startup for issue #46 and release Manager 0.6.12 2026-10-10 07:59:03 +05:00
Дмитрий 376f1dbb46 Fix conditional settings hooks and release Manager 0.6.11 2026-10-10 07:49:41 +05:00
Дмитрий b0951dbee7 feat(races): update verified client assets to CoA Custom 1.5 2026-10-10 06:56:44 +05:00
Дмитрий 374a3f9c23 feat(races): ship client integration in Manager 0.6.9 2026-10-10 06:35:01 +05:00
Дмитрий d20d5a6410 Merge remote-tracking branch 'origin/master' into feat/custom-races
# Conflicts:
#	src/screens/ModulesPage.tsx
2026-10-10 06:29:49 +05:00
Дмитрий 1228807eaf feat(races): integrate client patch installation and controls 2026-10-10 06:29:32 +05:00
Дмитрий ee59708fbf Prepare Manager 0.6.8 release 2026-10-10 05:51:09 +05:00
Corfirean 3ed9c5dacd Merge pull request #48 from Corfirean/feat/unsaved-guard-and-auto-restart
feat: unsaved changes navigation guard and server auto-restart with crash analyzer
2026-10-10 05:50:58 +05:00
Дмитрий 9099168927 Merge master and preserve Linux installation and crash history mocks 2026-10-10 05:47:39 +05:00
Corfirean a27e0eb6ab Merge pull request #44 from Corfirean/fix/db-error-details
Do not report an SQL error as "the database is not running"
2026-10-10 05:46:39 +05:00
Corfirean c46edd2feb Merge pull request #38 from lostmind84/feat/linux-b3b-install-screen
feat: install screen, Wine/Proton client and realm profiles for a Docker server (Linux)
2026-10-10 05:46:36 +05:00
Fabien F. f934bef303 fix: find a running Wine client under both names of a linked home folder
On SteamOS and Bazzite /home is a link to /var/home; Wine keeps the path it was
given, so the resolved one alone can miss the command line. The start order is
unchanged (database up and healthy before the realm list is updated): a comment
says so.
2026-10-08 17:30:08 +02:00
Fabien F. c882a21334 docs: changelog entry for the Linux install screen 2026-10-08 17:28:59 +02:00
Fabien F. a625b065cf feat: start the game client under umu-launcher / Wine on Linux
client::launch started Ascension.exe directly, which cannot work on Linux, and
client::is_running found nothing (it reads the Windows process list). wine.rs is
the Linux counterpart, and both hand over to it on a Linux host.

It runs the command of the project's own launcher script: umu-run with a Proton
build (GAMEID=0, PROTONPATH, WINEPREFIX, started from the client folder), else
plain Wine, with WINEDLLOVERRIDES=divxtac=d (DivxTac.dll deadlocks the world
loading screen under wine-mono). The newest GE-Proton found for Steam is used, or
umu's own choice; COA_PROTONPATH, COA_WINEPREFIX and client-launch.json override
the detection; the prefix defaults to ~/Games/umu/coa-client. The game runs in its
own process group, so closing the Manager does not close it, and prints to
client.log. Whether it runs is read from /proc, where the command line holds the
Windows form of the client path. A clear message says what to install when neither
umu nor Wine is found.

Tests: detection (newest build, no build, Wine only, nothing, overrides), the
command, the /proc match, and a real spawn with a stand-in umu-run that records its
environment. Not run: the real client.
2026-10-08 17:28:59 +02:00
Fabien F. 5c3a9def0c feat: realm profiles (CoA / Wildcard) work on a Docker server
The Realm card showed "io: No such file or directory (os error 2)" on a Docker
server: the Wildcard check read Core/worldserver.exe. The card lets the owner
switch realm, so it is made to work rather than hidden.

What the repack's patched launcher did at each start is done by the Docker
backend: finish an interrupted switch (realms::before_start), name the realms in
the realm list, and give the containers the databases of the selected realm
(acore_world_wildcard, acore_characters_wildcard). The switch itself is the shared
code. prepare_launcher has nothing to patch on a Docker server, and Wildcard
support is read from Core/worldserver as it is from Core/worldserver.exe (the .exe
wins when both exist, so a repack is read as before).

Tests: the support check on both binary names, no launcher to adapt, and the
databases passed to the containers for each realm. Creating the Wildcard realm
itself needs a build and a database with the Wildcard migrations and was not run.
2026-10-08 17:28:59 +02:00
Fabien F. 25098b5a63 fix: a Docker server is never offered or given the repack's updates
Found by installing a server through the new screen: the update check of a Docker
server read the Windows "stable" channel and offered "0.261003.17 (you have
0.261003.1)". Applying it would have put the repack's executables, MySQL and
launcher into a Linux server folder.

Refused in the core (update::preview, apply and rollback), so no caller can do it.
The Settings tab says that updates are not available for Docker servers yet; the
background check stays quiet, as for any failed check.

A test applies the same update package to the same folder with and without
Settings/docker.json: refused and untouched with it, committed without it.
2026-10-08 17:28:59 +02:00
Fabien F. 45a699d2ca feat: install a new Docker server from the install screen (Linux)
The install commands ask coa_core::platform::flavor() once and hand a Docker
install to src-tauri/src/docker_install.rs; the repack arm of each command is
untouched (an early return and an extra optional parameter are all that changed
in lib.rs). New command install_environment tells the screen the kind of server,
the suggested folder (~/CoaServer) and why Docker cannot be used, if it cannot.

On Linux the install screen shows the game data folder (used in place, read-only)
and the server package (a folder or an address; there is no default address until
a signed Linux package is published), and disables Install until both are given
and Docker works. It shows Docker's own message with a "Check again" button when
Docker is missing, stopped or not allowed for the user. The Windows screen is
unchanged (checked side by side in the browser mock).

A debug build (tauri dev) accepts another package key named in
COA_DEV_TRUSTED_KEY, to try the installer on a package signed with a throwaway
key; a release build always uses the embedded key.

New text is English only for now (other languages fall back to it).
2026-10-08 17:28:52 +02:00
Дмитрий be68eb4341 Add unsaved changes navigation guard and server auto-restart with crash analyzer
- Add UnsavedChangesGuard modal (Save/Discard/Cancel) when navigating between tabs
- Wire guard into ModulesPage and SettingsPage with floating action bar
- Implement crash parser and explanation engine in coa-core
- Expose list_crashes Tauri command and CrashItem API
- Add auto-restart on unexpected server crash with crash loop protection
- Add crash counter badge and CrashHistoryModal with human-readable explanations and full crashlogs
- Support all 6 locales (en, ru, de, fr, es, zh)
2026-10-08 18:58:41 +05:00
Дмитрий 06ca748e80 feat(modules): add custom races module to catalog and UI 2026-10-08 14:13:43 +05:00
Corfirean 58c1e1aee0 Merge pull request #41 from lostmind84/feat/linux-release-fixture
feat: validate a release and export its baseline on Linux
2026-10-08 14:04:02 +05:00
ДмитрийandClaude Sonnet 5.5 ad69fb0401 Do not report an SQL error as "the database is not running"
Only the client's own connection errors (ERROR 2003 and 2002, "Can't connect") count as a stopped
database. The SQLSTATE 22003 of an out-of-range value contains "2003" and hid the real error of a
failing release migration. The message now also carries the client's last line.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 11:29:08 +05:00
Fabien F. 3f98ba3add test: the release fixture database arguments are a Linux case 2026-10-07 21:01:43 +02:00
Fabien F. 7a3fefaafd feat: validate a release and export its baseline on Linux
The signed base package holds the MySQL data directory of a Windows repack. On a
Linux computer extract-schema-base now turns it into a Docker server folder whose
database container opens that directory (mysqlData in docker.json), so the release
SQL, the schema contract and export-baseline run with the Docker installation code.
Windows is unchanged: it still bootstraps the repack's own database program.
2026-10-07 13:56:00 +02:00
110 changed files with 6339 additions and 224 deletions

No files matched your search

+2
View File
@@ -4,3 +4,5 @@ dist
*.log
.env
src-tauri/gen
# Disposable database fixtures and private recovery data
.cache/
Generated
+3 -3
View File
@@ -491,7 +491,7 @@ dependencies = [
[[package]]
name = "coa-core"
version = "0.6.7"
version = "0.6.15"
dependencies = [
"base64 0.22.1",
"chrono",
@@ -520,7 +520,7 @@ dependencies = [
[[package]]
name = "coa-release"
version = "0.6.7"
version = "0.6.15"
dependencies = [
"chrono",
"coa-core",
@@ -529,7 +529,7 @@ dependencies = [
[[package]]
name = "coa-server-manager"
version = "0.6.7"
version = "0.6.15"
dependencies = [
"coa-core",
"serde",
+1 -1
View File
@@ -3,7 +3,7 @@ resolver = "2"
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
[workspace.package]
version = "0.6.7"
version = "0.6.15"
edition = "2021"
license = "AGPL-3.0-only"
+29
View File
@@ -0,0 +1,29 @@
# TODO
## UI / UX
- [x] **Предупреждение о несохранённых изменениях при переходе между вкладками (Unsaved Changes Guard / Modal)**:
- Если у пользователя есть несохранённые изменения в настройках (`ModulesPage`, `SettingsPage` — сервер, боты и др.) и он переходит на другую вкладку (в боковом меню `Shell.tsx` или кнопками навигации), показывать pop-up диалог подтверждения.
- Опции в диалоге:
- **Сохранить (Save)** — сохранить внесённые изменения и перейти на выбранную страницу.
- **Сбросить (Discard)** — отменить несохранённые изменения и перейти на выбранную страницу.
- **Отмена (Cancel)** — остаться на текущей странице с сохранением введённых данных.
- *Контекст:* Предотвратит случайную потерю настроек, когда пользователь меняет параметры модуля/сервера и сразу уходит на вкладку Overview для запуска сервера (см. [Issue #45](https://github.com/Corfirean/coa-server-manager/issues/45)).
## Сервер и стабильность
- [x] **Автоподнятие сервера при падении (Auto-restart on crash) со счётчиком и расшифровкой крашей**:
- **Настройка:** Чекбокс «Автоматически перезапускать сервер при падении» в настройках сервера / менеджера.
- **Поведение автоподнятия:**
- Перезапускать процесс сервера только если падение произошло внезапно (процесс завершился с ненулевым exit code, крашем или без команды от менеджера).
- Если пользователь нажал кнопку «Стоп» (Stop Server), сервер останавливается полностью, автоподнятие не срабатывает.
- Защита от бесконечного цикла крашей (Crash Loop Protection): если за короткий интервал (например, 2-3 минуты) сервер падает более 3-5 раз, автоподнятие временно прекращается, а в UI выводится критическое оповещение.
- **Счётчик падений в интерфейсе:**
- Рядом со статусом сервера (или в шапке/панели состояния) показывать бейдж со счётчиком крашей с момента старта (например: `Крашей: 2`).
- При клике на счётчик открывать окно / модалку со списком последних падений с точным временем.
- **Расшифровка причин краша (Crash Explanation Engine):**
- *Как парсить и определять причину:*
1. Читать свежий текстовый файл из `Core/Crashes/<hash>_worldserver.exe_[date].txt`.
2. Смотреть `Exception code` (например, `C0000005` — нарушение доступа к памяти/access violation, `C0000420` — сработавший assert ядра, `C00000FD` — переполнение стека, `E06D7363` — исключение C++ / std::bad_alloc).
3. При `C0000420` парсить блок `ASSERTION FAILED` (`Location`, `Function`, `Condition`).
4. Анализировать последние строки `Core/Logs/Server.log` и `Errors.log` на критические маркеры (потеря соединения с MySQL, нехватка RAM/OOM, ошибка бинда портов).
5. Проверять по встроенному словарю известных сигнатур (паттерны частых крашей с понятным описанием, например: «Сбой удаления объекта из сетки карты», «Ошибка запроса к базе данных», «Нехватка оперативной памяти»).
- *Fallback:* Если сигнатура не опознана в словаре известных проблем, показывать краткую техническую выжимку (код исключения + сработавший ассерт или вершина Call Stack) и кнопку разворота полного текста крашлога / копирования.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Linux Docker servers follow Settings, sharing and backups (experimental)
---
Experimental. Settings the Docker backend fixes are hidden, friends sharing and logs work, the game data folder can be changed, and the realm no longer shows offline after a start.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Linux: install from the install screen, play with Wine or Proton (experimental)
---
Experimental. The install screen offers Docker installs on Linux, realm profiles and the Play button work on a Docker server, and updates are not offered for it.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: A failing database update is no longer reported as "database not running"
---
An SQL error whose message contained the number 2003, such as an out-of-range value, was shown as "The database is not running". The real error is now shown.
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: Failed server startup after an update automatically restores the previous version
---
The Manager restores server files and databases, then checks the recovered server. If recovery cannot be confirmed, it preserves the recovery point and blocks further startup until the problem is resolved.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Windows update recovery preserves database procedures triggers and views
---
A verified copy of stopped MySQL restores all databases and accounts together. Interrupted restoration can be retried, and the replaced database directory is retained.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Custom races bot setting synchronizes Playerbots excluded race lists
---
The "Bots can be custom races" setting now configures AiPlayerbot.ExcludedBotRaces in playerbots.conf. Off excludes all added races (recommended), while on allows stable added races (experimental).
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: Custom race client patches update to the latest races and appearances
---
The module card offers an upgrade for older patches. Archive downloads are verified before installation.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Custom races can be enabled and their client patches installed from Modules
---
Install the custom race client assets from the module card, then enable the module and restart the server.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Blocked updates identify database objects that prevent automatic recovery
---
Diagnostics include the complete list of unsupported database objects across the recovery point, helping resolve update failures without removing user data.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Background world servers no longer stop because the local console is closed
---
The Manager automatically disables the local interactive console before starting the world server. Its remote console remains available, and no manual configuration changes are needed.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Updates can follow signed channels that select a complete server release
---
The Manager checks the channel signature and downloads every package part from the same release. Existing installations continue using the previous download source until the new channel is published.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates check startup privately before allowing players to connect
---
Startup checks use temporary local ports. Original settings are restored before opening the server, and interrupted checks retain a recovery journal.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Local hosts can connect while sharing a server online
---
The Manager no longer replaces the realm's local address with its public address when Friends mode is enabled.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Updates repair missing database defaults from the verified release schema
---
Only missing literal defaults are restored when column properties match. Existing rows, custom defaults, types and nullability are preserved; unresolved incompatibilities still block the update.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates no longer replay module installation scripts on existing databases
---
Update packages contain incremental SQL only. Module table initialization and seed scripts remain available when preparing a clean installation, preventing existing content from being reset during updates.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Windows server updates are tested on a private copy before changing your installation
---
The Manager tests migrations and server startup using your databases and configurations. A failed rehearsal leaves the installed server unchanged and preserves a diagnostic report.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Server updates can require a tested combination of platform and installed version
---
Signed release metadata identifies core and module revisions, supported starting versions and database contracts. Incompatible packages are rejected before shutdown; changed schema contracts and incompatible databases block installation before migration.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Failed database checks keep a complete report after rollback
---
Schema errors show readable default values and save every detected difference for troubleshooting, including after the server is restored.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server and Bots settings open without a blank window
---
Opening settings no longer crashes the interface after loading. Unsaved changes can still be saved or discarded before leaving the page.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Unsaved settings are protected and crashed servers can restart automatically
---
The Manager asks before leaving unsaved settings. Optional automatic restart pauses after repeated crashes, and crash history explains common failures.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: Players can install custom race patches when connecting to a friend
---
Install the custom race client patch directly from the Game client section without hosting a server.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Large server updates no longer repeatedly rewrite the recovery journal
---
Updates containing rebuilt navigation data now prepare all recovery copies before replacing files. Interrupted updates remain recoverable without rewriting the full journal for every file.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Normalize rehearsal server roots to prevent Windows path prefix errors
---
Server update rehearsals now canonicalize the installation root before collecting files, resolving a "prefix not found" error during rehearsal preparation on Windows.
@@ -0,0 +1,7 @@
---
area: client
type: changed
audience: admins
title: Custom race client installation follows the current upstream release
---
The installer verifies the current race archives and includes the two additional MPQs. Legacy patch hashes remain available so upgrading never mistakes the old custom executable for an original launcher file.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Docker friend mode requests a restart when remote client support changes
---
Enabling remote CoA clients now requests a world restart even when the game ports were already open. Repeating the same unchanged setting does not request another restart.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Module cards show installed server revisions and the client race patch version
---
Module revisions come from the currently installed release metadata. The race card shows the client patch version separately; missing version metadata is reported honestly instead of showing a download version as installed.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates accept long Windows paths inside the private test server
---
Long SQL file paths no longer fail the folder safety check during update rehearsals. Files outside the server folder remain blocked.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Diagnostics record blocked startup requests and maintenance owner information
---
A start refused before the launcher runs is now logged with its reason. Exported diagnostics include the last recorded maintenance owner, while clearly distinguishing old metadata from a currently held operating-system lock.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Client race patches can be repaired and removed while preserving original files
---
Every overwritten client file gets an original backup. Switching preserves newer launcher files; checksums detect missing or replaced assets. Repair and removal are always available, with rollback if a file operation fails.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Checking an already installed server update no longer reports incompatibility
---
The installed release can be checked again even when its compatibility list only names earlier releases. Platform checks and protection against downgrades still apply.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Failed server startup shows service errors even when the launcher reported ready
---
Update rehearsal and startup failures include recent world, authentication and database error lines. Missing tables and late startup failures are visible directly in the error details, with secrets redacted.
+7
View File
@@ -0,0 +1,7 @@
---
area: bots
type: fixed
audience: admins
title: Disabling custom races for SQUID bots now excludes all nonstandard races
---
The standard-races preset keeps only the ten original playable races. High elves, worgen and other custom race IDs are excluded, and the displayed setting reads complete race IDs rather than matching number substrings.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Starting the server waits for update checks and identifies ongoing maintenance
---
Downloading an update manifest no longer blocks startup. A start waits up to 30 seconds for a check to finish; other active maintenance still blocks it safely and shows its operation, process and start time.
@@ -0,0 +1,7 @@
---
area: bots
type: changed
audience: admins
title: The experimental SQUID race preset follows the current race release
---
Custom-race bots now use the upstream supported-race preset, excluding Test Race, Skyborne and Darkfallen. The standard-races preset continues to exclude all custom races.
@@ -27,6 +27,7 @@ fn exercise(root: &Path) -> Result<()> {
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);")?;
db.query("CREATE VIEW acore_characters.manager_recovery_view AS SELECT id FROM acore_characters.manager_recovery_probe; CREATE TRIGGER acore_characters.manager_recovery_trigger BEFORE INSERT ON acore_characters.manager_recovery_probe FOR EACH ROW SET NEW.id=NEW.id+1; CREATE PROCEDURE acore_characters.manager_recovery_proc() SELECT id FROM acore_characters.manager_recovery_probe;")?;
Ok(())
})?;
let source = root.join("fixture-update-source");
@@ -54,13 +55,15 @@ fn exercise(root: &Path) -> Result<()> {
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!(error.to_string().contains("private update rehearsal failed"), "{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_eq!(db.query("SELECT id FROM acore_characters.manager_recovery_view;")?, "42");
assert_eq!(db.recovery_objects("acore_characters")?.iter().filter(|object| object["name"].as_str().is_some_and(|name| name.starts_with("manager_recovery_"))).count(), 3);
assert!(!coa_core::migrations::status(db, &manifest.migrations)?.iter().any(|m| m.status == coa_core::migrations::Status::Applied));
Ok(())
})?;
@@ -68,6 +71,6 @@ fn exercise(root: &Path) -> Result<()> {
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");
println!("PASS: private rehearsal caught failed SQL before changing the installed world, characters, ledger, objects, files or version; complete recovery succeeded");
Ok(())
}
+2 -1
View File
@@ -31,6 +31,7 @@ fn hidden(key: &str) -> bool {
k.contains("password")
|| k.contains("databaseinfo")
|| k.ends_with("port")
|| k == "console.enable"
|| k.starts_with("ra.")
|| k.starts_with("logger.")
|| k.starts_with("appender.")
@@ -229,7 +230,7 @@ mod tests {
#[test]
fn what_belongs_to_the_manager_is_hidden() {
for k in ["LoginDatabaseInfo", "WorldServerPort", "BindIP", "Ra.Enable", "Ra.Password", "Logger.root", "Appender.Console", "DataDir", "Updates.EnableDatabases", "LoginDatabase.WorkerThreads", "InstanceServerPort"] {
for k in ["LoginDatabaseInfo", "WorldServerPort", "BindIP", "Ra.Enable", "Ra.Password", "Console.Enable", "console.enable", "Logger.root", "Appender.Console", "DataDir", "Updates.EnableDatabases", "LoginDatabase.WorkerThreads", "InstanceServerPort"] {
assert!(hidden(k), "{k}");
}
for k in ["Rate.XP.Kill", "PlayerLimit", "SupportEnabled", "Instance.ResetTimeHour", "Warden.Enabled", "CharacterCreating.Disabled"] {
+17 -1
View File
@@ -67,6 +67,8 @@ pub struct RecoveryPoint {
pub components: Vec<Component>,
#[serde(default)]
pub realm: crate::realms::Mode,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub(crate) mysql_snapshot: Option<crate::mysql_snapshot::Snapshot>,
}
const LOCATION_FILE: &str = "backup-location.json";
@@ -210,7 +212,7 @@ pub fn config_files(root: &Path) -> Vec<String> {
for e in rd.flatten() {
let n = e.file_name().to_string_lossy().to_string();
// database.json holds generated database passwords; it is launcher state, not configuration.
if e.path().is_file() && (n.contains(".template") || n == "repack.json") {
if e.path().is_file() && (n.contains(".template") || n == "repack.json" || n == "docker.json") {
out.push(format!("Settings/{n}"));
}
}
@@ -334,6 +336,16 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
return Err(e);
}
};
let mysql_snapshot = if kind == Kind::Full && trigger == Trigger::BeforeUpdate && cfg!(windows) && !crate::docker::is_docker(root) {
progress("Saving a complete stopped MySQL recovery copy");
match crate::mysql_snapshot::capture(root, &partial) {
Ok(snapshot) => Some(snapshot),
Err(error) => {
if let Ok(owned) = fsx::ensure_within(&backups_dir(meta), &partial) { let _ = fs::remove_dir_all(owned); }
return Err(error);
}
}
} else { None };
let point = RecoveryPoint {
realm: crate::realms::state(root)?.active,
schema: 1,
@@ -344,6 +356,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
created_at: chrono::Utc::now().to_rfc3339(),
manager_version: crate::MANAGER_VERSION.into(),
components,
mysql_snapshot,
};
fsx::atomic_write_json(&partial.join("backup.json"), &point)?;
fs::rename(&partial, &final_dir)?;
@@ -375,6 +388,9 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
let point = get(meta, id)?;
let dir = point_dir(meta, id)?;
let mut problems = Vec::new();
if let Some(snapshot) = &point.mysql_snapshot {
if let Err(error) = crate::mysql_snapshot::verify(&dir, snapshot) { problems.push(error.to_string()); }
}
let mut names = std::collections::BTreeSet::new();
let mut schemas = std::collections::BTreeSet::new();
for c in &point.components {
+86
View File
@@ -0,0 +1,86 @@
//! Signed channel pointers select one immutable package for an entire transaction.
use serde::{Deserialize, Serialize};
use crate::{Error, Result};
use crate::pkgsource::{fetch_small, Source};
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct Pointer {
pub schema: u32,
pub channel: String,
pub version: String,
pub release_tag: String,
pub snapshot: String,
}
#[derive(Deserialize, Serialize)]
#[serde(deny_unknown_fields)]
pub struct Envelope {
pub payload: String,
pub signature: String,
}
pub fn verify(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> {
let envelope: Envelope = serde_json::from_slice(bytes).map_err(|e| Error::InvalidManifest(e.to_string()))?;
crate::signing::verify(envelope.payload.as_bytes(), &envelope.signature, key)?;
let pointer: Pointer = serde_json::from_str(&envelope.payload).map_err(|e| Error::InvalidManifest(e.to_string()))?;
if pointer.schema != 1 || pointer.channel != channel
|| pointer.release_tag != format!("server-{}", pointer.version)
|| pointer.version.is_empty()
|| !pointer.version.bytes().all(|b| b.is_ascii_digit() || b == b'.')
|| pointer.snapshot.len() != 64
|| !pointer.snapshot.bytes().all(|b| b.is_ascii_hexdigit()) {
return Err(Error::InvalidManifest("Invalid channel pointer".into()));
}
Ok(pointer)
}
pub fn resolve(channel: &str) -> Result<Source> {
if channel != "stable" && channel != "edge" {
return Err(Error::InvalidManifest("Unknown release channel".into()));
}
let source = Source::Url("https://raw.githubusercontent.com/Corfirean/coa-server-build/channels".into());
let bytes = fetch_small(&source, &format!("{channel}.json"))?;
let pointer = verify(&bytes, channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
Ok(Source::Url(format!("https://github.com/Corfirean/coa-server-build/releases/download/{}", pointer.release_tag)))
}
pub fn sign(pointer: &Pointer, seed: &str) -> Result<Vec<u8>> {
use base64::{engine::general_purpose::STANDARD, Engine};
use ed25519_dalek::{Signer, SigningKey};
let seed: [u8; 32] = STANDARD.decode(seed.trim()).map_err(|_| Error::Invalid("Invalid signing key".into()))?
.try_into().map_err(|_| Error::Invalid("Invalid signing key length".into()))?;
let payload = serde_json::to_string(pointer).map_err(|e| Error::Invalid(e.to_string()))?;
let signature = STANDARD.encode(SigningKey::from_bytes(&seed).sign(payload.as_bytes()).to_bytes());
let bytes = serde_json::to_vec(&Envelope { payload, signature }).map_err(|e| Error::Invalid(e.to_string()))?;
verify(&bytes, &pointer.channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
Ok(bytes)
}
#[cfg(test)]
mod tests {
use super::*;
use base64::{engine::general_purpose::STANDARD, Engine};
use ed25519_dalek::{Signer, SigningKey};
fn signed(pointer: &Pointer) -> (Vec<u8>, String) {
let sk = SigningKey::from_bytes(&[17; 32]);
let payload = serde_json::to_string(pointer).unwrap();
let signature = STANDARD.encode(sk.sign(payload.as_bytes()).to_bytes());
(serde_json::to_vec(&Envelope { payload, signature }).unwrap(), STANDARD.encode(sk.verifying_key().to_bytes()))
}
#[test]
fn verifies_identity_signature_and_immutable_tag() {
let mut p = Pointer { schema: 1, channel: "stable".into(), version: "0.261010.40".into(), release_tag: "server-0.261010.40".into(), snapshot: "a".repeat(64) };
let (bytes, key) = signed(&p);
assert_eq!(verify(&bytes, "stable", &key).unwrap().version, p.version);
assert!(verify(&bytes, "edge", &key).is_err());
let mut changed: Envelope = serde_json::from_slice(&bytes).unwrap();
changed.payload = changed.payload.replace("40", "41");
assert!(verify(&serde_json::to_vec(&changed).unwrap(), "stable", &key).is_err());
p.release_tag = "stable".into();
let (bytes, key) = signed(&p);
assert!(verify(&bytes, "stable", &key).is_err());
}
}
+3 -3
View File
@@ -10,7 +10,7 @@ use crate::backup;
use crate::error::{Error, Result};
use crate::fsx;
use crate::migrations::{apply_pending, status, Status};
use crate::release::{collect_bots_sql, collect_core_sql};
use crate::release::{collect_bots_sql, collect_core_install_sql};
pub struct Params<'a> {
pub repack: &'a Path,
@@ -177,7 +177,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
}
fsx::atomic_write_json(&repack_json, &cfg)?;
let mut sql = collect_core_sql(p.core)?;
let mut sql = collect_core_install_sql(p.core)?;
if let Some(b) = p.bots {
sql.extend(collect_bots_sql(b)?);
}
@@ -294,7 +294,7 @@ mod tests {
#[test]
fn scaffolding_keeps_the_launcher_and_drops_runtime_state_and_live_data() {
for keep in ["Runtime/python/python.exe", "Scripts/manage.py", "Settings/worldserver.conf.template", "mysql/bin/mysqld.exe", "mysql/share/english/errmsg.sys", "BugReport/relay.py", "Core/libssl-3-x64.dll", "README.txt"] {
for keep in ["Runtime/python/python.exe", "Scripts/manage.py", "Settings/worldserver.conf.template", "mysql/bin/mysqld.exe", "mysql/share/english/errmsg.sys", "mysql/lib/private/icudt.dat", "BugReport/relay.py", "Core/libssl-3-x64.dll", "README.txt"] {
assert!(scaffolding(keep), "{keep}");
}
for drop in [".state/world.json", "mysql/data/acore_world/x.ibd", "mysql/logs/error.log", "Core/worldserver.exe", "Core/Logs/Server.log", "BugReport/reports/a.json", "Source/server-source.zip", "Scripts/__pycache__/x.pyc", "Testing/notes.md", "mysql/data.7z"] {
+6
View File
@@ -17,6 +17,9 @@ pub const ADDON_NAME: &str = "CoABotUI";
const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"];
pub fn is_running(client: &Path) -> bool {
if crate::platform::flavor() == crate::platform::Flavor::Docker {
return crate::wine::is_running(client, &EXECUTABLES);
}
EXECUTABLES.iter().any(|exe| {
let path = client.join(exe);
let path = dunce::canonicalize(&path).unwrap_or(path);
@@ -307,6 +310,9 @@ pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> {
/// Start the game client. The caller is responsible for making sure the server is ready first.
pub fn launch(client: &Path) -> Result<u32> {
let exe = find_exe(client).ok_or_else(|| Error::Invalid("The game client was not found.".into()))?;
if crate::platform::flavor() == crate::platform::Flavor::Docker {
return crate::wine::launch(client, exe);
}
let child = Command::new(client.join(exe)).current_dir(client).spawn()?;
Ok(child.id())
}
+35
View File
@@ -206,6 +206,10 @@ pub fn drift(root: &Path) -> Result<Vec<String>> {
}
pub fn load(root: &Path, scope: Scope) -> Result<SettingsView> {
// A Docker server that was added but never started has no active world configuration yet; create it from its template.
if scope == Scope::Server && crate::docker::is_docker(root) {
let _ = crate::docker::ensure_main_configs(root);
}
let schema = scope.schema();
let t = targets(root, scope)?;
let conf = load_conf(&t.read)?;
@@ -213,9 +217,12 @@ pub fn load(root: &Path, scope: Scope) -> Result<SettingsView> {
let known: BTreeSet<&str> = schema.settings.iter().map(|s| s.key.as_str()).collect();
let unknown_keys = conf.entries().filter(|(k, _)| !known.contains(k)).count();
// On a Docker server some settings are fixed by the backend (environment beats the file): not offered.
let docker = scope == Scope::Server && crate::docker::is_docker(root);
let settings = schema
.settings
.iter()
.filter(|s| !(docker && crate::docker::managed_setting(&s.key)))
.map(|s| {
let raw = conf.get(&s.key);
let (value, problem) = match raw {
@@ -286,11 +293,19 @@ pub fn validate(root: &Path, scope: Scope, changes: &BTreeMap<String, Value>) ->
let schema = scope.schema();
let mut errors = Vec::new();
let mut raws = BTreeMap::new();
let docker = scope == Scope::Server && crate::docker::is_docker(root);
for (key, value) in changes {
match schema.get(key) {
None => errors.push(FieldError { key: key.clone(), message: "is not a setting the Manager can change".into() }),
Some(_) if docker && crate::docker::managed_setting(key) => {
errors.push(FieldError { key: key.clone(), message: "is set by the Docker backend; changing it in the file would have no effect".into() })
}
Some(s) => match s.to_raw(value) {
Ok(raw) => {
if let Some(problem) = crate::docker::setting_problem(key, &raw).filter(|_| crate::docker::is_docker(root)) {
errors.push(FieldError { key: key.clone(), message: problem.into() });
continue;
}
raws.insert(key.clone(), raw);
}
Err(m) => errors.push(FieldError { key: key.clone(), message: m }),
@@ -736,6 +751,26 @@ Spellbook.New = 5
assert!(list_snapshots(&meta).is_empty(), "no snapshot for a rejected save");
}
#[test]
fn a_docker_server_is_not_offered_the_settings_its_backend_fixes() {
let (_d, root, meta) = fixture();
let keys = |root: &Path| load(root, Scope::Server).unwrap().settings.into_iter().map(|s| s.meta.key).collect::<Vec<_>>();
for k in ["Ra.Enable", "Ra.IP", "Updates.EnableDatabases", "PlayerLimit"] {
assert!(keys(&root).iter().any(|x| x == k), "a repack offers {k}");
}
fs::write(root.join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
let docker = keys(&root);
for k in ["Ra.Enable", "Ra.IP", "Updates.EnableDatabases"] {
assert!(!docker.iter().any(|x| x == k), "a Docker server does not offer {k}: the containers' environment beats the file");
}
assert!(docker.iter().any(|x| x == "PlayerLimit"), "everything else is still offered");
// Forcing a change through is refused and says why, instead of being saved and ignored.
let err = save(&root, &meta, Scope::Server, &set(&[("Ra.Enable", json!(0))])).unwrap_err().to_string();
assert!(err.contains("Docker backend"), "{err}");
assert!(!fs::read_to_string(root.join("Core/configs/worldserver.conf")).unwrap().contains("Ra.Enable = 0"));
save(&root, &meta, Scope::Server, &set(&[("PlayerLimit", json!(77))])).unwrap();
}
#[test]
fn missing_key_is_appended_and_noop_saves_do_nothing() {
let (_d, root, meta) = fixture();
+13
View File
@@ -51,6 +51,19 @@ fn classify(l: &str) -> Level {
}
}
/// The last `max_lines` lines of some text (after filtering), classified and redacted like the lines of a log file.
pub fn lines_from_text(text: &str, filter: Option<&str>, max_lines: usize) -> Vec<Line> {
let needle = filter.map(str::to_lowercase).filter(|n| !n.is_empty());
let out: Vec<Line> = text
.lines()
.filter(|l| !l.trim().is_empty())
.filter(|l| needle.as_ref().map(|n| l.to_lowercase().contains(n)).unwrap_or(true))
.map(|l| Line { level: classify(l), text: crate::diag::redact(l) })
.collect();
let skip = out.len().saturating_sub(max_lines);
out.into_iter().skip(skip).collect()
}
/// The last `max_lines` lines (after filtering) from the last ~512 KB of a log. Works on multi-gigabyte files.
pub fn tail(path: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
const WINDOW: u64 = 512 * 1024;
+249
View File
@@ -0,0 +1,249 @@
//! Crash log discovery and human-friendly explanation for worldserver crashes.
use std::fs;
use std::path::{Path, PathBuf};
use std::time::SystemTime;
use serde::{Deserialize, Serialize};
use crate::error::Result;
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct CrashItem {
pub id: String,
pub timestamp_ms: u64,
pub date_str: String,
pub title: String,
pub explanation: String,
pub category: String,
pub exception_code: Option<String>,
pub location: Option<String>,
pub function: Option<String>,
pub condition: Option<String>,
pub preview: String,
pub full_log: String,
}
/// Lists recent crash reports from `Core/Crashes`, sorted newest first.
pub fn list(root: &Path, limit: usize) -> Result<Vec<CrashItem>> {
let dir = root.join("Core/Crashes");
let mut files: Vec<(PathBuf, SystemTime)> = Vec::new();
if let Ok(entries) = fs::read_dir(&dir) {
for entry in entries.flatten() {
let path = entry.path();
if path.is_file() && path.extension().and_then(|e| e.to_str()) == Some("txt") {
let mtime = entry.metadata().and_then(|m| m.modified()).unwrap_or(SystemTime::UNIX_EPOCH);
files.push((path, mtime));
}
}
}
files.sort_by_key(|(_, t)| std::cmp::Reverse(*t));
files.truncate(limit.max(1));
let mut items = Vec::new();
for (path, mtime) in files {
if let Ok(content) = fs::read_to_string(&path) {
let item = parse_crash_content(&path, mtime, &content);
items.push(item);
}
}
Ok(items)
}
/// Parses crash report content and generates human-friendly titles and explanations.
pub fn parse_crash_content(path: &Path, mtime: SystemTime, content: &str) -> CrashItem {
let filename = path.file_name().unwrap_or_default().to_string_lossy().into_owned();
let timestamp_ms = mtime.duration_since(SystemTime::UNIX_EPOCH).map(|d| d.as_millis() as u64).unwrap_or(0);
let mut date_str = String::new();
let mut exception_code = None;
let mut location = None;
let mut function = None;
let mut condition = None;
let lines: Vec<&str> = content.lines().collect();
let mut in_assertion = false;
for line in &lines {
let trimmed = line.trim();
if trimmed.starts_with("Date ") && date_str.is_empty() {
date_str = trimmed.to_string();
} else if trimmed.starts_with("Exception code:") {
let parts: Vec<&str> = trimmed.split_whitespace().collect();
if parts.len() >= 3 {
exception_code = Some(parts[2].to_string());
}
} else if trimmed.contains(">> ASSERTION FAILED") {
in_assertion = true;
} else if in_assertion {
if trimmed.starts_with("# Location:") {
let loc = trimmed.trim_start_matches("# Location:").trim();
let clean = loc.rsplit(['\\', '/']).take(2).collect::<Vec<_>>();
location = Some(if clean.len() == 2 { format!("{}/{}", clean[1], clean[0]) } else { loc.to_string() });
} else if trimmed.starts_with("# Function:") {
function = Some(trimmed.trim_start_matches("# Function:").trim().to_string());
} else if trimmed.starts_with("# Condition:") {
condition = Some(trimmed.trim_start_matches("# Condition:").trim().to_string());
} else if trimmed.starts_with("#---") && condition.is_some() {
in_assertion = false;
}
}
}
if date_str.is_empty() {
if let Some(pos) = filename.find("_[") {
if let Some(end) = filename[pos..].find(']') {
date_str = filename[pos + 2..pos + end].replace('_', " ");
}
}
}
let (category, title, explanation) = explain(exception_code.as_deref(), function.as_deref(), condition.as_deref(), content);
let preview_lines: Vec<&str> = lines.iter().take(25).copied().collect();
let preview = preview_lines.join("\n");
CrashItem {
id: filename,
timestamp_ms,
date_str,
title,
explanation,
category,
exception_code,
location,
function,
condition,
preview,
full_log: content.to_string(),
}
}
fn explain(code: Option<&str>, func: Option<&str>, cond: Option<&str>, full: &str) -> (String, String, String) {
let lower_full = full.to_lowercase();
let lower_func = func.map(|f| f.to_lowercase()).unwrap_or_default();
let lower_cond = cond.map(|c| c.to_lowercase()).unwrap_or_default();
if let Some(c) = code {
if c.eq_ignore_ascii_case("C0000420") {
if lower_func.contains("removefromgrid") || lower_cond.contains("isingrid") {
return (
"assertion".into(),
"Сбой удаления сущности из сетки карты (Grid / Despawn)".into(),
"Сервер попытался выгрузить объект (игрока, NPC или бота), который уже не находился в сетке карты. Обычно происходит при резком разрыве соединения, телепортации или одновременном деспавне нескольких сущностей.".into(),
);
}
if lower_func.contains("map::") || lower_func.contains("grid::") {
return (
"assertion".into(),
"Ошибка обновления сетки игрового мира (Map Grid)".into(),
"Сбой при загрузке или обновлении клеток локации (Grid/Cell). Может быть вызван перемещением сущностей через границы чанков.".into(),
);
}
if lower_func.contains("playerbot") || lower_func.contains("aiplayerbot") {
return (
"assertion".into(),
"Ошибка в модуле ботов (Playerbots)".into(),
"Внутренний сбой в логике ИИ ботов (экипировка, заклинание или поиск пути).".into(),
);
}
let cond_label = cond.unwrap_or("Assert condition failed");
return (
"assertion".into(),
format!("Сработала внутренняя проверка ядра ({cond_label})"),
format!("Сервер обнаружил нарушение целостности данных в функции {}. Выполнение было аварийно остановлено.", func.unwrap_or("неизвестно")),
);
} else if c.eq_ignore_ascii_case("C0000005") {
return (
"access_violation".into(),
"Нарушение доступа к памяти (Access Violation)".into(),
"Попытка чтения или записи по некорректному адресу памяти (разыменование null-указателя или освобождённого объекта).".into(),
);
} else if c.eq_ignore_ascii_case("C00000FD") {
return (
"stack_overflow".into(),
"Переполнение стека (Stack Overflow)".into(),
"Исчерпание стека вызовов, вызванное бесконечной рекурсией или слишком глубоким стеком вызовов функций.".into(),
);
} else if c.eq_ignore_ascii_case("E06D7363") {
if lower_full.contains("bad_alloc") {
return (
"out_of_memory".into(),
"Нехватка оперативной памяти (Out of Memory)".into(),
"Серверу не удалось выделить оперативную память (std::bad_alloc). Проверьте объем доступной RAM.".into(),
);
}
return (
"exception".into(),
"Необработанное исключение C++ (C++ Exception)".into(),
"Произошло критическое исключение C++, которое не было перехвачено ядром сервера.".into(),
);
}
}
if lower_full.contains("mysql server has gone away") || lower_full.contains("connection lost") {
return (
"database".into(),
"Потеряна связь с базой данных (MySQL)".into(),
"Связь сервера с СУБД MySQL была прервана или служба базы данных упала.".into(),
);
}
if lower_full.contains("address already in use") || lower_full.contains("bind failed") {
return (
"network".into(),
"Сетевой порт уже занят".into(),
"Порт мира, авторизации или базы данных уже занят другим приложением.".into(),
);
}
(
"generic".into(),
"Непредвиденный сбой процесса сервера".into(),
"Процесс worldserver аварийно завершился. Детали и стек вызовов доступны в полном тексте отчёта.".into(),
)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parses_assertion_report() {
let report = r#"Revision: AzerothCore rev. df5bcdf26092 2026-10-02 22:08:42 +0500 (coa-bots branch) (Win64, RelWithDebInfo, Static)
Date 3:10:2026. Time 20:20
//=====================================================
Exception code: C0000420 Ein Assertionsfehler ist aufgetreten.
Assertion message: #----------------------------------------------------------------------#
>> ASSERTION FAILED
# Location: D:\a\coa-server-build\src\server\game\Entities\Object\Object.h:376
# Function: GridObject<class Player>::RemoveFromGrid
# Condition: IsInGrid()
#----------------------------------------------------------------------#
Fault address: 00007FF7ECD3645E
"#;
let item = parse_crash_content(Path::new("dummy_worldserver.exe_[3-10_20-20-51].txt"), SystemTime::UNIX_EPOCH, report);
println!("ITEM: {item:#?}");
assert_eq!(item.exception_code.as_deref(), Some("C0000420"));
assert_eq!(item.category, "assertion");
assert_eq!(item.condition.as_deref(), Some("IsInGrid()"));
assert_eq!(item.function.as_deref(), Some("GridObject<class Player>::RemoveFromGrid"));
assert!(item.title.contains("Grid"));
assert!(item.explanation.contains("сетке карты"));
}
#[test]
fn parses_access_violation() {
let report = r#"Date 4:10:2026. Time 12:00
Exception code: C0000005 ACCESS_VIOLATION
Fault address: 00007FF7ECD3645E
"#;
let item = parse_crash_content(Path::new("crash.txt"), SystemTime::UNIX_EPOCH, report);
assert_eq!(item.exception_code.as_deref(), Some("C0000005"));
assert_eq!(item.category, "access_violation");
assert!(item.title.contains("Access Violation"));
}
}
+894
View File
@@ -0,0 +1,894 @@
//! Management of client-side patches and assets for Custom Races.
//!
//! Handles detecting, enabling/disabling (via `.disabled` extension renaming),
//! and downloading/extracting client patches (Esteria and additional races)
//! into the player's WoW client directory.
use std::fs::{self, File};
use std::io::{self, Read, Write};
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use crate::download::Cancel;
use crate::error::{Error, Result};
use crate::fsx;
pub const CLIENT_VERSION: &str = "1.6";
pub const MANIFEST_FILENAME: &str = "custom_races_patch_manifest.txt";
pub const ARCHIVES: &[(&str, &str)] = &[
(
"CoA-Custom-1.6-main-20261012-4dd3a4ec.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.6/CoA-Custom-1.6-main-20261012-4dd3a4ec.zip",
),
(
"CoA-Custom-1.6-client-part1.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.6/CoA-Custom-1.6-client-part1.zip",
),
(
"CoA-Custom-1.6-client-part2.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.6/CoA-Custom-1.6-client-part2.zip",
),
];
pub const RACE_MPQS: &[&str] = &[
"patch-T.MPQ",
"patch-ZE1.MPQ",
"patch-ZE2.MPQ",
"patch-ZE3.MPQ",
"patch-ZE5.MPQ",
"patch-ZE6.MPQ",
"patch-ZE7.MPQ",
"patch-ZE8.MPQ",
"patch-ZE9.MPQ",
"patch-ZEA.MPQ",
"patch-ZG.MPQ",
"patch-ZH.MPQ",
"patch-ZHA.MPQ",
"patch-ZHM.MPQ",
"patch-ZM.MPQ",
"patch-ZVU.MPQ",
"patch-ZES.MPQ",
"patch-ZJ.MPQ",
"patch-ZZE.MPQ",
"patch-ZZR.MPQ",
"patch-ZZS.MPQ",
"patch-ZZT.MPQ",
];
pub const EXCLUDED_BOT_RACES_RECOMMENDED: &str =
"9,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128";
pub const EXCLUDED_BOT_RACES_EXPERIMENTAL: &str =
"65,72,77,80,81";
/// Finds all active playerbots.conf files on this server (root, coa-bots folder, and secondary realm).
pub fn playerbots_conf_paths(root: &Path) -> Vec<PathBuf> {
let mut paths = Vec::new();
let candidates = [
root.join("Core/configs/modules/playerbots.conf"),
root.join("coa-bots/Core/configs/modules/playerbots.conf"),
root.join("coa-bots/core/configs/modules/playerbots.conf"),
crate::multiworld::root(root).join("Core/configs/modules/playerbots.conf"),
];
for path in candidates {
if path.is_file() {
paths.push(path);
}
}
if paths.is_empty() {
for dist in [
root.join("Core/configs/modules/playerbots.conf.dist"),
root.join("coa-bots/Core/configs/modules/playerbots.conf.dist"),
] {
if dist.is_file() {
let target = dist.with_extension("");
if fs::copy(&dist, &target).is_ok() {
paths.push(target);
break;
}
}
}
}
paths
}
/// Checks whether playerbots are configured to allow custom races.
/// Returns true if AiPlayerbot.ExcludedBotRaces exists and does not exclude general custom races.
pub fn is_bot_custom_races_allowed(root: &Path) -> Option<bool> {
for path in playerbots_conf_paths(root) {
if let Ok(bytes) = fs::read(&path) {
if let Ok(conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) {
if let Some(val) = conf.get("AiPlayerbot.ExcludedBotRaces") {
let clean = val.trim().trim_matches(['"', '\'']);
let excluded: std::collections::BTreeSet<u32> = clean.split(',').filter_map(|race| race.trim().parse().ok()).collect();
return Some((1..=128).filter(|race| ![1, 2, 3, 4, 5, 6, 7, 8, 10, 11].contains(race)).any(|race| !excluded.contains(&race)));
}
}
}
}
None
}
/// Sets AiPlayerbot.ExcludedBotRaces in all discovered playerbots.conf files.
pub fn sync_bot_races_config(root: &Path, allow_custom_races: bool) -> Result<()> {
let excluded = if allow_custom_races {
EXCLUDED_BOT_RACES_EXPERIMENTAL
} else {
EXCLUDED_BOT_RACES_RECOMMENDED
};
for path in playerbots_conf_paths(root) {
if let Ok(bytes) = fs::read(&path) {
if let Ok(mut conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) {
conf.set(
"AiPlayerbot.ExcludedBotRaces",
&format!("\"{excluded}\""),
&[
"CoA Custom: races new random bots never get",
"Off (recommended): excludes all added races",
"On (experimental): allows stable added races",
],
);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
}
}
}
Ok(())
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "kebab-case")]
pub enum ClientPatchState {
NotInstalled,
Enabled,
Disabled,
PartiallyInstalled,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ClientPatchStatus {
pub state: ClientPatchState,
pub version: Option<String>,
pub installed_mpqs: usize,
pub total_mpqs: usize,
pub has_root_files: bool,
pub client_path: Option<String>,
}
#[derive(Clone, Serialize, Deserialize)]
struct PatchFile {
path: String,
sha256: String,
}
fn patch_files(client: &Path) -> Result<Vec<PatchFile>> {
let manifest = fs::read_to_string(client.join(MANIFEST_FILENAME)).unwrap_or_default();
let hashes = if manifest.lines().any(|line| line == "# CoA Custom 1.5") { include_str!("custom_races_hashes_1_5.json") } else { include_str!("custom_races_hashes.json") };
let bundled: std::collections::BTreeMap<String, String> = serde_json::from_str(hashes)?;
let mut files = std::collections::BTreeMap::new();
for line in manifest.lines() {
let path = if let Some(name) = line.strip_prefix("MPQ:") {
if name.contains(['/', '\\']) { return Err(Error::Invalid("Invalid custom races patch manifest.".into())); }
Some(format!("Data/{name}"))
} else if let Some(name) = line.strip_prefix("ROOT:") {
if name.contains(['/', '\\']) { return Err(Error::Invalid("Invalid custom races patch manifest.".into())); }
Some(name.to_string())
} else { None };
if let Some(path) = path {
fsx::safe_join(client, &path)?;
files.insert(path.clone(), bundled.get(&path).cloned().unwrap_or_default());
}
}
if files.is_empty() { files = bundled; }
for line in manifest.lines().filter_map(|line| line.strip_prefix("SHA256:")) {
let (hash, path) = line.split_once(':').ok_or_else(|| Error::Invalid("Invalid custom races checksum.".into()))?;
if hash.len() != 64 || !hash.bytes().all(|b| b.is_ascii_hexdigit()) || !files.contains_key(path) {
return Err(Error::Invalid("Invalid custom races checksum.".into()));
}
files.insert(path.into(), hash.into());
}
Ok(files.into_iter().map(|(path, sha256)| PatchFile { path, sha256 }).collect())
}
fn suffix(path: &Path, extension: &str) -> PathBuf {
path.with_file_name(format!("{}.{extension}", path.file_name().unwrap_or_default().to_string_lossy()))
}
fn matches_patch(path: &Path, file: &PatchFile) -> bool {
path.is_file() && fsx::sha256_file(path).is_ok_and(|hash| hash == file.sha256)
}
/// Only complete, verified payloads are reported as enabled or disabled.
pub fn client_patch_status(client_path: &Path) -> ClientPatchStatus {
let data = client_path.join("Data");
let installed_mpqs = RACE_MPQS.iter().filter(|name| data.join(name).is_file() || suffix(&data.join(name), "disabled").is_file()).count();
let has_root_files = client_path.join("EsteriaAppearance.dll").is_file() || client_path.join("dinput8.dll").is_file() || client_path.join("dinput8.dll.disabled").is_file();
let manifest = fs::read_to_string(client_path.join(MANIFEST_FILENAME)).unwrap_or_default();
let current = manifest.lines().any(|line| line == format!("# CoA Custom {CLIENT_VERSION}"));
let state = if !manifest.is_empty() && current && !client_path.join(".coa-races-transaction").exists() {
match patch_files(client_path) {
Ok(files) if files.iter().all(|f| matches_patch(&client_path.join(&f.path), f) && !suffix(&client_path.join(&f.path), "disabled").exists()) => ClientPatchState::Enabled,
Ok(files) if files.iter().all(|f| matches_patch(&suffix(&client_path.join(&f.path), "disabled"), f)) => ClientPatchState::Disabled,
_ => ClientPatchState::PartiallyInstalled,
}
} else if !manifest.is_empty() || patch_files(client_path).is_ok_and(|files| files.iter().filter(|file| file.path.starts_with("Data/") && file.path != "Data/patch-T.MPQ").any(|file| matches_patch(&client_path.join(&file.path), file) || matches_patch(&suffix(&client_path.join(&file.path), "disabled"), file))) {
ClientPatchState::PartiallyInstalled
} else { ClientPatchState::NotInstalled };
let version = manifest.lines().find_map(|line| line.strip_prefix("# CoA Custom ").map(str::to_string));
ClientPatchStatus { state, version, installed_mpqs, total_mpqs: RACE_MPQS.len(), has_root_files,
client_path: Some(client_path.to_string_lossy().into_owned()) }
}
#[derive(Serialize, Deserialize)]
struct SavedFile { path: String, existed: bool }
struct PatchTransaction<'a> { root: &'a Path, entries: Vec<SavedFile>, finished: bool }
impl<'a> PatchTransaction<'a> {
fn new(root: &'a Path) -> Result<Self> {
recover_patch_transaction(root)?;
fs::create_dir(root.join(".coa-races-transaction"))?;
Ok(Self { root, entries: Vec::new(), finished: false })
}
fn save(&mut self, path: &Path) -> Result<()> {
let relative = path.strip_prefix(self.root).map_err(|_| Error::Invalid("Patch path escaped the client directory.".into()))?.to_string_lossy().replace('\\', "/");
fsx::safe_join(self.root, &relative)?;
if self.entries.iter().any(|entry| entry.path == relative) { return Ok(()); }
let index = self.entries.len();
self.entries.push(SavedFile { path: relative, existed: path.is_file() });
fsx::atomic_write_json(&self.root.join(".coa-races-transaction/journal.json"), &self.entries)?;
if path.is_file() { fs::rename(path, self.root.join(".coa-races-transaction").join(index.to_string()))?; }
Ok(())
}
fn copy(&mut self, source: &Path, target: &Path) -> Result<()> {
self.save(target)?;
fs::create_dir_all(target.parent().ok_or_else(|| Error::Invalid("Patch file has no parent directory.".into()))?)?;
fs::copy(source, target)?;
Ok(())
}
fn move_file(&mut self, source: &Path, target: &Path) -> Result<()> {
self.save(source)?;
let index = self.entries.iter().position(|entry| self.root.join(&entry.path) == source).unwrap();
// Copy from the journal so rollback retains the previous bytes.
let saved = self.root.join(".coa-races-transaction").join(index.to_string());
self.copy(&saved, target)
}
fn finish(mut self) -> Result<()> {
fsx::atomic_write(&self.root.join(".coa-races-transaction/committed"), b"committed")?;
self.finished = true;
fs::remove_dir_all(self.root.join(".coa-races-transaction"))?;
Ok(())
}
}
impl Drop for PatchTransaction<'_> {
fn drop(&mut self) { if !self.finished { let _ = recover_patch_transaction(self.root); } }
}
fn recover_patch_transaction(root: &Path) -> Result<()> {
let directory = root.join(".coa-races-transaction");
if !directory.is_dir() { return Ok(()); }
if !directory.join("committed").exists() && directory.join("journal.json").exists() {
let entries: Vec<SavedFile> = fsx::read_json(&directory.join("journal.json"))?;
for (index, entry) in entries.iter().enumerate().rev() {
let path = fsx::safe_join(root, &entry.path)?;
let saved = directory.join(index.to_string());
if saved.is_file() {
if path.is_file() { fs::remove_file(&path)?; }
fs::rename(saved, path)?;
} else if !entry.existed && path.is_file() { fs::remove_file(path)?; }
}
}
fs::remove_dir_all(directory)?;
Ok(())
}
fn patch_lock(client: &Path) -> Result<File> {
use fs4::fs_std::FileExt;
let lock = fs::OpenOptions::new().read(true).write(true).create(true).truncate(false).open(client.join(".coa-races.lock"))?;
if !lock.try_lock_exclusive()? { return Err(Error::Invalid("Another custom races operation is using this client.".into())); }
Ok(lock)
}
fn preserve_original(tx: &mut PatchTransaction<'_>, active: &Path) -> Result<()> {
let original = suffix(active, "original");
if original.is_file() && fsx::sha256_file(active)? == fsx::sha256_file(&original)? { return Ok(()); }
if original.is_file() {
let previous = suffix(active, &format!("original.previous-{}", uuid::Uuid::new_v4().simple()));
tx.copy(&original, &previous)?;
}
tx.copy(active, &original)
}
/// Preserve launcher replacements, and switch every file owned by the package.
pub fn set_client_patch_enabled(client: &Path, enabled: bool) -> Result<()> {
if !client.is_dir() { return Err(Error::Invalid("Game client directory not found.".into())); }
if crate::client::is_running(client) { return Err(Error::Invalid("Close the game before changing custom races patches.".into())); }
let _lock = patch_lock(client)?;
recover_patch_transaction(client)?;
if !client.join(MANIFEST_FILENAME).is_file() { return Ok(()); }
let files = patch_files(client)?;
if enabled {
for file in &files {
let active = client.join(&file.path);
if !matches_patch(&active, file) && !matches_patch(&suffix(&active, "disabled"), file) {
return Err(Error::Invalid(format!("Custom races file {} was replaced or is missing. Repair the client patch before enabling it.", file.path)));
}
}
}
let mut tx = PatchTransaction::new(client)?;
for file in files {
let active = client.join(&file.path);
let disabled = suffix(&active, "disabled");
let original = suffix(&active, "original");
if enabled {
if active.is_file() && !matches_patch(&active, &file) { preserve_original(&mut tx, &active)?; }
if matches_patch(&disabled, &file) { tx.move_file(&disabled, &active)?; }
} else if matches_patch(&active, &file) {
if disabled.is_file() && !matches_patch(&disabled, &file) {
tx.move_file(&disabled, &suffix(&disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?;
}
tx.move_file(&active, &disabled)?;
if original.is_file() { tx.copy(&original, &active)?; }
} else if active.is_file() {
preserve_original(&mut tx, &active)?;
}
}
tx.finish()
}
pub fn uninstall_client_patches(client: &Path) -> Result<()> {
if crate::client::is_running(client) { return Err(Error::Invalid("Close the game before removing custom races patches.".into())); }
let _lock = patch_lock(client)?;
recover_patch_transaction(client)?;
if !client.join(MANIFEST_FILENAME).is_file() { return Ok(()); }
let mut tx = PatchTransaction::new(client)?;
for file in patch_files(client)? {
let active = client.join(&file.path);
if matches_patch(&active, &file) {
tx.save(&active)?;
let original = suffix(&active, "original");
if original.is_file() { tx.copy(&original, &active)?; }
}
let disabled = suffix(&active, "disabled");
if active.is_file() && !matches_patch(&active, &file) && !suffix(&active, "original").is_file() {
tx.move_file(&active, &suffix(&active, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?;
}
if disabled.is_file() {
if !matches_patch(&disabled, &file) { tx.move_file(&disabled, &suffix(&disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?; }
else { tx.save(&disabled)?; }
}
}
tx.save(&client.join(MANIFEST_FILENAME))?;
tx.finish()
}
fn verify_archive(path: &Path, filename: &str) -> Result<()> {
let expected = match filename {
"CoA-Custom-1.6-main-20261012-4dd3a4ec.zip" => "dfe802ea70047c129ac2e0aaa557bab3110e3cc6926d36403b8c880a0e310ee4",
"CoA-Custom-1.6-client-part1.zip" => "1dbf1901ad5be61eba66973609df90712ffc78ef9e9b2c8549a5f3e36332bf12",
"CoA-Custom-1.6-client-part2.zip" => "689f7f946b4180fe977dabedc7cfe642e3e7f27431600c64c4dd5b7960b1bc66",
_ => return Err(Error::Invalid("Unknown custom races archive.".into())),
};
if fsx::sha256_file(path)? != expected {
return Err(Error::Invalid(format!("Custom races archive {filename} failed verification. Remove it and try again.")));
}
Ok(())
}
/// Locate an archive locally in Downloads or cache, or download it from GitHub.
fn resolve_or_download_archive(
filename: &str,
url: &str,
client: &reqwest::blocking::Client,
cancel: &Cancel,
report: &dyn Fn(&str, f32),
base_percent: f32,
percent_slice: f32,
) -> Result<PathBuf> {
// 1. Check user Downloads folder
if let Some(userprofile) = std::env::var_os("USERPROFILE") {
let downloads = PathBuf::from(userprofile).join("Downloads");
let candidate = downloads.join(filename);
if candidate.is_file() {
if let Ok(meta) = candidate.metadata() {
if meta.len() > 1000 {
tracing::info!(path = %candidate.display(), "using existing archive in Downloads");
verify_archive(&candidate, filename)?;
return Ok(candidate);
}
}
}
}
// 2. Check temp / cache directory
let cache_dir = std::env::temp_dir().join("coa-client-races");
fs::create_dir_all(&cache_dir)?;
let target = cache_dir.join(filename);
if target.is_file() {
if let Ok(meta) = target.metadata() {
if meta.len() > 1000 {
verify_archive(&target, filename)?;
return Ok(target);
}
}
}
// 3. Download from GitHub Releases
report(&format!("Downloading {filename}..."), base_percent);
let part_path = cache_dir.join(format!("{filename}.part"));
let resp = client
.get(url)
.send()
.map_err(|e| Error::NetworkUnreachable(format!("Could not reach download server: {e}")))?;
if !resp.status().is_success() {
return Err(Error::NetworkUnreachable(format!(
"Download failed with status {} for {url}",
resp.status()
)));
}
let total_bytes = resp.content_length().unwrap_or(0);
let mut downloaded = 0u64;
let mut src = resp;
let mut dst = File::create(&part_path)?;
let mut buf = [0u8; 64 * 1024];
let mut last_report = std::time::Instant::now();
loop {
if cancel.is_set() {
let _ = fs::remove_file(&part_path);
return Err(Error::Invalid("Operation cancelled.".into()));
}
let n = src
.read(&mut buf)
.map_err(|e| Error::NetworkUnreachable(format!("Download interrupted: {e}")))?;
if n == 0 {
break;
}
dst.write_all(&buf[..n])?;
downloaded += n as u64;
if last_report.elapsed() > std::time::Duration::from_millis(200) {
let ratio = if total_bytes > 0 {
(downloaded as f32 / total_bytes as f32).clamp(0.0, 1.0)
} else {
0.5
};
report(
&format!(
"Downloading {filename} ({:.1} MB)...",
downloaded as f64 / 1_048_576.0
),
base_percent + ratio * percent_slice,
);
last_report = std::time::Instant::now();
}
}
dst.flush()?;
drop(dst);
verify_archive(&part_path, filename)?;
fs::rename(&part_path, &target)?;
Ok(target)
}
/// Download (if needed) and extract custom races client assets into the target WoW client.
pub fn install_client_patches(
client_path: &Path,
cancel: &Cancel,
report: &dyn Fn(&str, f32),
) -> Result<()> {
if !client_path.is_dir() {
return Err(Error::Invalid("Game client directory does not exist.".into()));
}
if crate::client::is_running(client_path) {
return Err(Error::Invalid("Close the game before installing custom races patches.".into()));
}
let _lock = patch_lock(client_path)?;
recover_patch_transaction(client_path)?;
let staging = tempfile::Builder::new().prefix(".coa-races-stage-").tempdir_in(client_path)?;
let data_dir = staging.path().join("Data");
fs::create_dir_all(&data_dir)?;
// 2. Resolve/download archives (0.05 .. 0.50)
let http = reqwest::blocking::Client::builder()
.user_agent(concat!("CoA-Server-Manager/", env!("CARGO_PKG_VERSION")))
.timeout(std::time::Duration::from_secs(600))
.build()
.map_err(|e| Error::Invalid(format!("Cannot prepare downloader: {e}")))?;
let mut resolved_archives = Vec::new();
let n_archives = ARCHIVES.len() as f32;
for (i, (fname, url)) in ARCHIVES.iter().enumerate() {
let base_pct = 0.05 + (i as f32 / n_archives) * 0.45;
let slice = 0.45 / n_archives;
let archive_path =
resolve_or_download_archive(fname, url, &http, cancel, report, base_pct, slice)?;
resolved_archives.push(archive_path);
}
// 3. Extract archives (0.50 .. 0.95)
let mut installed_mpqs = Vec::new();
let mut installed_roots = Vec::new();
for (i, arch_path) in resolved_archives.iter().enumerate() {
if cancel.is_set() {
return Err(Error::Invalid("Operation cancelled.".into()));
}
let arch_name = arch_path
.file_name()
.map(|n| n.to_string_lossy().into_owned())
.unwrap_or_default();
report(
&format!("Unpacking {arch_name}..."),
0.50 + (i as f32 / n_archives) * 0.45,
);
let file = File::open(arch_path)?;
let mut zip = zip::ZipArchive::new(file)
.map_err(|e| Error::Invalid(format!("Failed to open zip {arch_name}: {e}")))?;
let num_files = zip.len();
for file_idx in 0..num_files {
if cancel.is_set() {
return Err(Error::Invalid("Operation cancelled.".into()));
}
let mut zfile = zip
.by_index(file_idx)
.map_err(|e| Error::Invalid(format!("Zip entry error in {arch_name}: {e}")))?;
if zfile.is_dir() {
continue;
}
let zname = zfile.name().to_string();
let zname_norm = zname.replace('\\', "/");
if zname_norm.contains("files/client/") {
let base = Path::new(&zname_norm)
.file_name()
.map(|n| n.to_string_lossy().into_owned())
.unwrap_or_default();
if base.to_ascii_lowercase().ends_with(".mpq") {
let dest = data_dir.join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = data_dir.join(format!("{base}.disabled"));
if disabled.is_file() { fs::remove_file(disabled)?; }
installed_mpqs.push(base);
} else if base.eq_ignore_ascii_case("dinput8.dll") {
let dest = staging.path().join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = staging.path().join(format!("{base}.disabled"));
if disabled.is_file() { fs::remove_file(disabled)?; }
installed_roots.push(base);
}
} else if zname_norm.contains("files/client_root/") {
let base = Path::new(&zname_norm)
.file_name()
.map(|n| n.to_string_lossy().into_owned())
.unwrap_or_default();
if !base.is_empty() {
let dest = staging.path().join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = staging.path().join(format!("{base}.disabled"));
if disabled.is_file() { fs::remove_file(disabled)?; }
installed_roots.push(base);
}
}
}
}
if !RACE_MPQS.iter().all(|name| installed_mpqs.iter().any(|installed| installed == name)) {
return Err(Error::Invalid("Custom races archives are missing required client patches.".into()));
}
// 4. Record manifest
report("Finalizing manifest...", 0.98);
let manifest_path = client_path.join(MANIFEST_FILENAME);
installed_mpqs.sort();
installed_mpqs.dedup();
installed_roots.sort();
installed_roots.dedup();
let mut manifest_body = format!("# CoA Custom {CLIENT_VERSION}\n# Custom Race MPQ files\n");
for m in &installed_mpqs {
manifest_body.push_str(&format!("MPQ:{m}\n"));
}
manifest_body.push_str("# Custom Race root files\n");
for r in &installed_roots {
manifest_body.push_str(&format!("ROOT:{r}\n"));
}
let bundled: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json"))?;
let mut payload = Vec::new();
for path in installed_mpqs.iter().map(|name| format!("Data/{name}")).chain(installed_roots.iter().cloned()) {
let staged = fsx::safe_join(staging.path(), &path)?;
let hash = fsx::sha256_file(&staged)?;
if bundled.get(&path) != Some(&hash) { return Err(Error::Invalid(format!("Custom races file {path} failed verification."))); }
manifest_body.push_str(&format!("SHA256:{hash}:{path}\n"));
payload.push(PatchFile { path, sha256: hash });
}
if cancel.is_set() { return Err(Error::Invalid("Operation cancelled.".into())); }
if payload.len() != bundled.len() { return Err(Error::Invalid("Custom races archives are missing required runtime files.".into())); }
let previous = patch_files(client_path)?;
let mut tx = PatchTransaction::new(client_path)?;
for file in payload {
let dest = fsx::safe_join(client_path, &file.path)?;
if dest.is_file() && !previous.iter().any(|old| old.path == file.path && matches_patch(&dest, old)) && !matches_patch(&dest, &file) {
preserve_original(&mut tx, &dest)?;
}
tx.copy(&staging.path().join(&file.path), &dest)?;
let disabled = suffix(&dest, "disabled");
if disabled.is_file() {
if !previous.iter().any(|old| old.path == file.path && matches_patch(&disabled, old)) && !matches_patch(&disabled, &file) {
tx.move_file(&disabled, &suffix(&disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?;
} else { tx.save(&disabled)?; }
}
}
tx.save(&manifest_path)?;
fsx::atomic_write(&manifest_path, manifest_body.as_bytes())?;
tx.finish()?;
report("Custom races client patches installed successfully!", 1.0);
tracing::info!(
mpqs = installed_mpqs.len(),
roots = installed_roots.len(),
"custom races client patch installation complete"
);
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
fn record_files(root: &Path, names: &[&str]) {
let mut manifest = format!("# CoA Custom {CLIENT_VERSION}\n");
for name in names {
let (kind, base) = name.strip_prefix("Data/").map_or(("ROOT", *name), |base| ("MPQ", base));
manifest.push_str(&format!("{kind}:{base}\nSHA256:{}:{name}\n", fsx::sha256_file(&root.join(name)).unwrap()));
}
fs::write(root.join(MANIFEST_FILENAME), manifest).unwrap();
}
#[test]
#[ignore = "Requires the three downloaded release archives"]
fn bundled_hashes_match_verified_release_archives() {
use sha2::{Digest, Sha256};
let folder = PathBuf::from(std::env::var_os("COA_RACES_ARCHIVE_DIR").expect("COA_RACES_ARCHIVE_DIR"));
let expected: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json")).unwrap();
let mut actual = std::collections::BTreeMap::new();
for (name, _) in ARCHIVES {
let path = folder.join(name);
verify_archive(&path, name).unwrap();
let mut archive = zip::ZipArchive::new(File::open(path).unwrap()).unwrap();
for index in 0..archive.len() {
let mut entry = archive.by_index(index).unwrap();
let name = entry.name().replace('\\', "/");
if entry.is_dir() { continue; }
let relative = if let Some(name) = name.split("files/client_root/").nth(1) { name.to_string() }
else if let Some(name) = name.split("files/client/").nth(1) { if name == "dinput8.dll" { name.to_string() } else { format!("Data/{name}") } }
else { continue };
let mut hash = Sha256::new();
let mut buffer = vec![0; 1024 * 1024];
loop { let read = entry.read(&mut buffer).unwrap(); if read == 0 { break; } hash.update(&buffer[..read]); }
actual.insert(relative, hex::encode(hash.finalize()));
}
}
assert_eq!(actual, expected);
}
#[test]
fn legacy_installation_uses_its_own_hashes_when_preserving_originals() {
let temp = tempfile::tempdir().unwrap();
fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.5\n").unwrap();
let legacy: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes_1_5.json")).unwrap();
let current: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json")).unwrap();
let files = patch_files(temp.path()).unwrap();
assert_eq!(files.iter().find(|file| file.path == "Ascension.exe").unwrap().sha256, legacy["Ascension.exe"]);
assert_eq!(files.len(), legacy.len());
assert!(current.len() > legacy.len());
assert!(!files.iter().any(|file| file.path == "Data/patch-ZZS.MPQ"));
}
#[test]
fn another_patch_operation_cannot_enter_the_same_client() {
let temp = tempfile::tempdir().unwrap();
let first = patch_lock(temp.path()).unwrap();
assert!(patch_lock(temp.path()).is_err());
drop(first);
patch_lock(temp.path()).unwrap();
}
#[test]
fn switching_preserves_launcher_updates_for_every_owned_file() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
fs::create_dir_all(root.join("Data")).unwrap();
let names = ["Data/patch-T.MPQ", "Data/patch-ZE1.MPQ", "Ascension.exe", "dinput8.dll", "EsteriaAppearance.dll"];
for name in names { fs::write(root.join(name), b"custom").unwrap(); fs::write(suffix(&root.join(name), "original"), b"old official").unwrap(); }
record_files(root, &names);
set_client_patch_enabled(root, false).unwrap();
for name in names { assert_eq!(fs::read(root.join(name)).unwrap(), b"old official"); fs::write(root.join(name), b"new official").unwrap(); }
set_client_patch_enabled(root, true).unwrap();
for name in names { assert_eq!(fs::read(root.join(name)).unwrap(), b"custom"); assert_eq!(fs::read(suffix(&root.join(name), "original")).unwrap(), b"new official"); }
// An official launcher can also replace a currently enabled file.
fs::write(root.join("Ascension.exe"), b"newest official").unwrap();
assert_eq!(client_patch_status(root).state, ClientPatchState::PartiallyInstalled);
set_client_patch_enabled(root, false).unwrap();
assert_eq!(fs::read(root.join("Ascension.exe")).unwrap(), b"newest official");
assert!(set_client_patch_enabled(root, true).unwrap_err().to_string().contains("Repair"));
uninstall_client_patches(root).unwrap();
assert_eq!(fs::read(root.join("Ascension.exe")).unwrap(), b"newest official");
assert_eq!(client_patch_status(root).state, ClientPatchState::NotInstalled);
}
#[test]
fn failed_and_interrupted_transactions_restore_previous_bytes() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let file = root.join("Ascension.exe");
fs::write(&file, b"previous").unwrap();
{
let mut tx = PatchTransaction::new(root).unwrap();
tx.save(&file).unwrap();
fs::write(&file, b"replacement").unwrap();
let staged = root.join("staged.dll");
fs::write(&staged, b"new").unwrap();
tx.copy(&staged, &root.join("Data/new.dll")).unwrap();
assert_eq!(fs::read(root.join("Data/new.dll")).unwrap(), b"new");
}
assert_eq!(fs::read(&file).unwrap(), b"previous");
assert!(!root.join("Data/new.dll").exists());
let mut tx = PatchTransaction::new(root).unwrap();
tx.save(&file).unwrap();
fs::write(&file, b"interrupted").unwrap();
std::mem::forget(tx);
recover_patch_transaction(root).unwrap();
assert_eq!(fs::read(&file).unwrap(), b"previous");
}
#[test]
fn existing_backups_and_foreign_disabled_files_are_retained() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let file = root.join("dinput8.dll");
fs::write(&file, b"custom").unwrap();
record_files(root, &["dinput8.dll"]);
fs::write(suffix(&file, "disabled"), b"third party").unwrap();
fs::write(suffix(&file, "original"), b"original").unwrap();
set_client_patch_enabled(root, false).unwrap();
assert_eq!(fs::read(&file).unwrap(), b"original");
assert!(fs::read_dir(root).unwrap().flatten().any(|entry| entry.file_name().to_string_lossy().contains("replaced-")));
fs::write(&file, b"updated original").unwrap();
set_client_patch_enabled(root, true).unwrap();
assert!(fs::read_dir(root).unwrap().flatten().any(|entry| entry.file_name().to_string_lossy().contains("original.previous-")));
}
#[test]
fn uninstall_moves_corrupted_custom_only_assets_out_of_the_active_client() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
fs::create_dir_all(root.join("Data")).unwrap();
let file = root.join("Data/patch-ZE1.MPQ");
fs::write(&file, b"custom").unwrap();
record_files(root, &["Data/patch-ZE1.MPQ"]);
fs::write(&file, b"corrupted custom").unwrap();
uninstall_client_patches(root).unwrap();
assert!(!file.exists());
assert!(fs::read_dir(root.join("Data")).unwrap().flatten().any(|entry| entry.file_name().to_string_lossy().contains("replaced-")));
assert_eq!(client_patch_status(root).state, ClientPatchState::NotInstalled);
}
#[test]
fn unknown_or_corrupt_bytes_are_not_reported_as_enabled() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
fs::create_dir_all(root.join("Data")).unwrap();
for name in RACE_MPQS { fs::write(root.join("Data").join(name), b"corrupt").unwrap(); }
fs::write(root.join("dinput8.dll"), b"corrupt").unwrap();
fs::write(root.join(MANIFEST_FILENAME), format!("# CoA Custom {CLIENT_VERSION}\n")).unwrap();
assert_eq!(client_patch_status(root).state, ClientPatchState::PartiallyInstalled);
}
#[test]
fn an_old_complete_installation_requires_an_update() {
let temp = tempfile::tempdir().unwrap();
fs::create_dir_all(temp.path().join("Data")).unwrap();
for name in RACE_MPQS { fs::write(temp.path().join("Data").join(name), b"old patch").unwrap(); }
fs::write(temp.path().join("dinput8.dll"), b"old runtime").unwrap();
fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.4\n").unwrap();
assert_eq!(client_patch_status(temp.path()).state, ClientPatchState::PartiallyInstalled);
}
#[test]
fn an_unpatched_client_is_left_untouched() {
let temp = tempfile::tempdir().unwrap();
fs::create_dir_all(temp.path().join("Data")).unwrap();
fs::write(temp.path().join("Data/patch-T.MPQ"), b"original").unwrap();
set_client_patch_enabled(temp.path(), false).unwrap();
assert_eq!(fs::read(temp.path().join("Data/patch-T.MPQ")).unwrap(), b"original");
}
#[test]
fn corrupt_downloads_are_rejected() {
let temp = tempfile::NamedTempFile::new().unwrap();
fs::write(temp.path(), b"corrupt archive").unwrap();
assert!(verify_archive(temp.path(), ARCHIVES[0].0).is_err());
}
#[test]
fn test_patch_status_and_toggle() {
let temp = tempfile::tempdir().unwrap();
let client_path = temp.path();
let data_dir = client_path.join("Data");
fs::create_dir_all(&data_dir).unwrap();
// 1. Initial state: Not installed
let st = client_patch_status(client_path);
assert_eq!(st.state, ClientPatchState::NotInstalled);
fs::write(client_path.join(MANIFEST_FILENAME), format!("# CoA Custom {CLIENT_VERSION}\n")).unwrap();
// 2. Create MPQs and root files
for mpq in RACE_MPQS {
fs::write(data_dir.join(mpq), b"test mpq content").unwrap();
}
fs::write(client_path.join("dinput8.dll"), b"test dll").unwrap();
fs::write(client_path.join("EsteriaAppearance.dll"), b"test dll").unwrap();
let names: Vec<String> = RACE_MPQS.iter().map(|name| format!("Data/{name}")).chain(["dinput8.dll".into(), "EsteriaAppearance.dll".into()]).collect();
record_files(client_path, &names.iter().map(String::as_str).collect::<Vec<_>>());
let st = client_patch_status(client_path);
assert_eq!(st.state, ClientPatchState::Enabled);
assert_eq!(st.installed_mpqs, RACE_MPQS.len());
// 3. Disable patches
set_client_patch_enabled(client_path, false).unwrap();
let st = client_patch_status(client_path);
assert_eq!(st.state, ClientPatchState::Disabled);
assert!(data_dir.join("patch-T.MPQ.disabled").is_file());
assert!(!data_dir.join("patch-T.MPQ").is_file());
assert!(client_path.join("dinput8.dll.disabled").is_file());
assert!(!client_path.join("dinput8.dll").is_file());
// 4. Re-enable patches
set_client_patch_enabled(client_path, true).unwrap();
let st = client_patch_status(client_path);
assert_eq!(st.state, ClientPatchState::Enabled);
assert!(data_dir.join("patch-T.MPQ").is_file());
assert!(!data_dir.join("patch-T.MPQ.disabled").is_file());
assert!(client_path.join("dinput8.dll").is_file());
assert!(!client_path.join("dinput8.dll.disabled").is_file());
}
#[test]
fn disabling_bot_custom_races_excludes_every_nonstandard_race() {
let temp = tempfile::tempdir().unwrap();
let conf = temp.path().join("Core/configs/modules/playerbots.conf");
fs::create_dir_all(conf.parent().unwrap()).unwrap();
fs::write(&conf, "AiPlayerbot.ExcludedBotRaces = \"\"\n").unwrap();
sync_bot_races_config(temp.path(), false).unwrap();
assert_eq!(is_bot_custom_races_allowed(temp.path()), Some(false));
let parsed = crate::config::parser::ConfFile::parse_bytes(&fs::read(conf).unwrap()).unwrap();
let value = parsed.get("AiPlayerbot.ExcludedBotRaces").unwrap().trim_matches('"');
let excluded: Vec<u32> = value.split(',').map(|race| race.parse().unwrap()).collect();
for race in 1..=128 {
assert_eq!(excluded.contains(&race), ![1, 2, 3, 4, 5, 6, 7, 8, 10, 11].contains(&race), "race {race}");
}
}
}
@@ -0,0 +1,52 @@
{
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"EsteriaAppearance.bin": "b3fb7c69b7600c39f888ea1925701be5667097dcb02bb6ddd830e5489306bb50",
"EsteriaAppearance.dll": "392c5a2a25f9a69d705bdf841bb899aab768d4a3ee62734d576286c7198710d8",
"EsteriaAppearanceGeometry.bin": "c95c53ca19c53c3434e12b99c1966f9c015ec3944c46dff7784d5e4ffc472d5d",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
"EsteriaSaberonCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaThinHuman.bin": "75794d192ea0c228b3da7bf7d0bdff1119f79d3f9bfef6650cd5e1a2b5d106eb",
"EsteriaThinHumanTextures.bin": "02aeb4c05893d06125b8b58fdb7c2a56fe3d66a7d094706a44b43cb503d1731e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"dinput8.dll": "f8de78606c241fb3911dce22faf68f5b9f9885b142b183c1e2c09ddc8f7e380c",
"Data/patch-T.MPQ": "9403e0680c74754eb0cb063718119aa6ace3616f7cecf488c8faf46f22505ae5",
"Data/patch-ZE5.MPQ": "476b5a1fcf69f64fdb281e3b445362b936d016066ccd12f897acfcf200d6c0cf",
"Data/patch-ZE6.MPQ": "762592c9ed950b4a7b6c7d85d45050b30fa3f35d53e348ee1e1516fdbb7e5484",
"Data/patch-ZE7.MPQ": "de54b0189d242763d2872223419a259b6b8a4b380c24b50a2ef9c6fa44466248",
"Data/patch-ZE8.MPQ": "1bc5691fb84a84f3e7a0a70baaa9192a97b4ec5906ee37c85838ffe08adef934",
"Data/patch-ZE9.MPQ": "d49c94463e9548e76378ce2c0454d8f204f0745c8c0de32b6dce7f0b0fd67c4a",
"Data/patch-ZES.MPQ": "a2d9348f917f745c7aa25b2eed96efa312f7b2d2f62cb86a4f2eaabc2dfa895f",
"Data/patch-ZG.MPQ": "48979e1fda775f8deb47bffa48e0a468595d4c71286fee518f51dc5801c5ca39",
"Data/patch-ZH.MPQ": "5e1d2fe287053abba703d7af381e10096c6525ba477ffed3971c2fc4f93e919c",
"Data/patch-ZHM.MPQ": "317d3ae00f0bd674b358af07544976acb7804aa6d8b19d1788ad96030e8c9bf0",
"Data/patch-ZJ.MPQ": "f821e99add86ef68d108c5ec466328c97677d3ed52f7944e200f3fe38c13b4de",
"Data/patch-ZM.MPQ": "424ab1978986e854551633983a94bd15beba6328aabea8c02f98eaa32f6f0b61",
"Data/patch-ZVU.MPQ": "c679b85a2e97344395756b54d2cf6abefe4e80e74944cb55b6e573ad17b7d020",
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
"Data/patch-ZE3.MPQ": "b587202c21b6f580682b601b7c2e905fbfa766276e74733db55c1bddbffb7f87",
"Data/patch-ZEA.MPQ": "78fd10ec5262ae2417eba9700d2172553bbc1e5cfb0b597aada8f1753ca46d9d",
"Data/patch-ZHA.MPQ": "0fc6ebeafe1d14192dc64bafc90bde3c49230df1297f98bf65900a3bcf953617",
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Data/patch-ZZS.MPQ": "533fd69d5784d83e872a5a28d27301dc9ab5d0cb925f8b2116926854e4a0a5b8",
"Data/patch-ZZT.MPQ": "aef3bbe4951333d62fb55224484724fbaa9c35773a19944ffb9935e250cfb59c"
}
@@ -0,0 +1,50 @@
{
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
"Data/patch-ZE3.MPQ": "b587202c21b6f580682b601b7c2e905fbfa766276e74733db55c1bddbffb7f87",
"Data/patch-ZEA.MPQ": "78fd10ec5262ae2417eba9700d2172553bbc1e5cfb0b597aada8f1753ca46d9d",
"Data/patch-ZHA.MPQ": "0fc6ebeafe1d14192dc64bafc90bde3c49230df1297f98bf65900a3bcf953617",
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"EsteriaAppearance.bin": "b3fb7c69b7600c39f888ea1925701be5667097dcb02bb6ddd830e5489306bb50",
"EsteriaAppearance.dll": "392c5a2a25f9a69d705bdf841bb899aab768d4a3ee62734d576286c7198710d8",
"EsteriaAppearanceGeometry.bin": "c95c53ca19c53c3434e12b99c1966f9c015ec3944c46dff7784d5e4ffc472d5d",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
"EsteriaSaberonCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaThinHuman.bin": "75794d192ea0c228b3da7bf7d0bdff1119f79d3f9bfef6650cd5e1a2b5d106eb",
"EsteriaThinHumanTextures.bin": "02aeb4c05893d06125b8b58fdb7c2a56fe3d66a7d094706a44b43cb503d1731e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"dinput8.dll": "f8de78606c241fb3911dce22faf68f5b9f9885b142b183c1e2c09ddc8f7e380c",
"Data/patch-T.MPQ": "9403e0680c74754eb0cb063718119aa6ace3616f7cecf488c8faf46f22505ae5",
"Data/patch-ZE5.MPQ": "476b5a1fcf69f64fdb281e3b445362b936d016066ccd12f897acfcf200d6c0cf",
"Data/patch-ZE6.MPQ": "762592c9ed950b4a7b6c7d85d45050b30fa3f35d53e348ee1e1516fdbb7e5484",
"Data/patch-ZE7.MPQ": "de54b0189d242763d2872223419a259b6b8a4b380c24b50a2ef9c6fa44466248",
"Data/patch-ZE8.MPQ": "1bc5691fb84a84f3e7a0a70baaa9192a97b4ec5906ee37c85838ffe08adef934",
"Data/patch-ZE9.MPQ": "d49c94463e9548e76378ce2c0454d8f204f0745c8c0de32b6dce7f0b0fd67c4a",
"Data/patch-ZES.MPQ": "a2d9348f917f745c7aa25b2eed96efa312f7b2d2f62cb86a4f2eaabc2dfa895f",
"Data/patch-ZG.MPQ": "48979e1fda775f8deb47bffa48e0a468595d4c71286fee518f51dc5801c5ca39",
"Data/patch-ZH.MPQ": "5e1d2fe287053abba703d7af381e10096c6525ba477ffed3971c2fc4f93e919c",
"Data/patch-ZHM.MPQ": "317d3ae00f0bd674b358af07544976acb7804aa6d8b19d1788ad96030e8c9bf0",
"Data/patch-ZJ.MPQ": "f821e99add86ef68d108c5ec466328c97677d3ed52f7944e200f3fe38c13b4de",
"Data/patch-ZM.MPQ": "424ab1978986e854551633983a94bd15beba6328aabea8c02f98eaa32f6f0b61",
"Data/patch-ZVU.MPQ": "c679b85a2e97344395756b54d2cf6abefe4e80e74944cb55b6e573ad17b7d020"
}
+37 -2
View File
@@ -176,10 +176,13 @@ impl Db {
fn fail(&self, stderr: &[u8]) -> Error {
let text = String::from_utf8_lossy(stderr);
let down = text.contains("2003") || text.contains("Can't connect") || text.contains("is not running") || text.contains("No such container");
// Only the client's own connection errors mean "not running": the number 2003 or the words can also appear inside
// the message of an ordinary SQL error (a duplicate entry, a row number) and must not hide it.
let down = text.contains("ERROR 2003") || text.contains("ERROR 2002") || text.contains("Can't connect to MySQL server")
|| text.contains("No such container") || text.contains("is not running");
let code = if down { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown };
match code {
ErrorCode::DatabaseNotRunning => Error::Invalid("The database is not running. Start the server first.".into()),
ErrorCode::DatabaseNotRunning => Error::Invalid(format!("The database is not running. Start the server first. ({})", text.trim().lines().last().unwrap_or("").chars().take(300).collect::<String>())),
_ => Error::Invalid(format!("database command failed: {}", text.trim().lines().last().unwrap_or(""))),
}
}
@@ -244,6 +247,13 @@ impl Db {
self.query(&sql)?.trim().parse().map_err(|_| Error::Invalid("unexpected reply".into()))
}
pub fn recovery_objects(&self, schema: &str) -> Result<Vec<serde_json::Value>> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) { return Err(Error::Invalid("bad schema name".into())); }
let sql = format!("SELECT routine_type,HEX(routine_name) FROM information_schema.routines WHERE routine_schema='{schema}' UNION ALL SELECT 'TRIGGER',HEX(trigger_name) FROM information_schema.triggers WHERE trigger_schema='{schema}' UNION ALL SELECT 'VIEW',HEX(table_name) FROM information_schema.views WHERE table_schema='{schema}' ORDER BY 1,2;");
parse_recovery_objects(&schema, &self.query(&sql)?)
}
/// 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)> {
let schema = self.realm_schema(schema);
@@ -331,6 +341,18 @@ impl Db {
}
}
fn parse_recovery_objects(schema: &str, text: &str) -> Result<Vec<serde_json::Value>> {
text.lines().filter(|line| !line.is_empty()).map(|line| {
let (kind, name) = line.split_once('\t').ok_or_else(|| Error::Invalid("unexpected database object reply".into()))?;
if !matches!(kind, "PROCEDURE" | "FUNCTION" | "TRIGGER" | "VIEW") {
return Err(Error::Invalid("unexpected database object type".into()));
}
let name = hex::decode(name).ok().and_then(|bytes| String::from_utf8(bytes).ok())
.filter(|name| !name.is_empty()).ok_or_else(|| Error::Invalid("unexpected database object name".into()))?;
Ok(serde_json::json!({ "database": schema, "kind": kind, "name": name }))
}).collect()
}
/// Name of the service account the Manager uses for the server console (RA). Accounts are stored upper-case.
pub const SERVICE_ACCOUNT: &str = "COAMANAGER";
@@ -418,6 +440,19 @@ mod tests {
const ROOT_PW: &str = "rootpw-ZZ1";
const APP_PW: &str = "apppw-QQ2";
#[test]
fn recovery_object_names_preserve_unicode_and_delimiters() {
let name = "view\tперсонажи\n";
let text = format!("VIEW\t{}\nTRIGGER\t74726967676572\n", hex::encode(name));
let objects = parse_recovery_objects("acore_characters", &text).unwrap();
assert_eq!(objects.len(), 2);
assert_eq!(objects[0]["name"], name);
assert_eq!(objects[1]["kind"], "TRIGGER");
assert!(parse_recovery_objects("test", "VIEW\tzz").is_err());
assert!(parse_recovery_objects("test", "UNKNOWN\t61").is_err());
assert!(parse_recovery_objects("test", "VIEW").is_err());
}
fn folder(docker: bool) -> (tempfile::TempDir, PathBuf) {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
+74 -1
View File
@@ -109,7 +109,8 @@ pub fn run(root: &Path, meta: &InstallMeta) -> Report {
c.push(if crate::client::detect(Path::new(path), None).is_some() { check("client", "Game client", Level::Ok, path.clone()) } else { check("client", "Game client", Level::Warn, "The saved game folder was not found; choose it again in Settings.") });
}
let exposed: Vec<&str> = crate::net::exposure(&ports).iter().filter(|e| (e.what == "database" || e.what == "server console") && e.reachable_from_network).map(|e| e.what).collect();
let exposure = if crate::docker::is_docker(root) { crate::docker::exposure(root, &ports) } else { crate::net::exposure(&ports) };
let exposed: Vec<&str> = exposure.iter().filter(|e| (e.what == "database" || e.what == "server console") && e.reachable_from_network).map(|e| e.what).collect();
c.push(if exposed.is_empty() { check("exposure", "Private services", Level::Ok, "Database and server console are not reachable from the network.") } else { check("exposure", "Private services", Level::Fail, format!("Reachable from the network: {}.", exposed.join(", "))) });
let problems = c.iter().filter(|x| x.level != Level::Ok).count();
@@ -347,6 +348,15 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
"wow_client_set": meta.client_path.is_some(),
});
add("summary.json", serde_json::to_string_pretty(&summary)?.as_bytes())?;
let owner = fs::read_to_string(meta_dir.join("update-lock-owner.json")).ok()
.and_then(|text| serde_json::from_str::<serde_json::Value>(&redact_json(&text)).ok());
let maintenance = serde_json::json!({
"lockFilePresent": meta_dir.join("update.lock").is_file(),
"lastRecordedOwner": owner,
"note": "The lock file and owner record may remain after completion. Their presence does not establish whether the OS lock is currently held."
});
add("maintenance.json", serde_json::to_string_pretty(&maintenance)?.as_bytes())?;
// Logs. The newest update logs of the repack's own updater are added under their own names.
let mut logs: Vec<(String, PathBuf)> = vec![
@@ -401,6 +411,19 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
add("processes.txt", processes_report(root, &ports).as_bytes())?;
// The newest update journals: the state of each update and the reason it failed.
for (path, size, _) in newest_files(&meta_dir.join("diagnostics"), "json", usize::MAX)
.into_iter().filter(|(path, _, _)| path.file_name().is_some_and(|name| {
let name = name.to_string_lossy();
name.starts_with("schema-validation-") || name.starts_with("database-recovery-")
|| name.starts_with("database-rehearsal-") || name.starts_with("database-restore-")
|| name.starts_with("database-repair-")
})).take(10) {
if size <= 4 * 1024 * 1024 {
if let Ok(text) = fs::read_to_string(&path) {
add(&format!("schema/{}", path.file_name().unwrap().to_string_lossy()), redact_json(&text).as_bytes())?;
}
}
}
let mut journals: Vec<_> = fs::read_dir(meta_dir.join("updates")).into_iter().flatten().flatten()
.filter(|e| e.file_type().is_ok_and(|t| t.is_dir()) && e.file_name().to_string_lossy().chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_')))
.collect();
@@ -451,16 +474,53 @@ pub fn stamp() -> String {
chrono::Local::now().format("%Y%m%d-%H%M%S").to_string()
}
#[cfg(windows)]
pub fn desktop_or_temp() -> PathBuf {
let d = std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop");
if d.is_dir() { d } else { std::env::temp_dir() }
}
/// Where a file meant for the person goes on Linux: the desktop folder they have (the XDG user directories file names it), else
/// `~/Desktop`, else `~/Downloads`, else the temporary folder.
#[cfg(not(windows))]
pub fn desktop_or_temp() -> PathBuf {
let Some(home) = std::env::var_os("HOME").map(PathBuf::from) else { return std::env::temp_dir() };
let dirs = std::fs::read_to_string(home.join(".config/user-dirs.dirs")).ok();
pick_desktop(&home, dirs.as_deref(), &|p| p.is_dir())
}
#[cfg(not(windows))]
fn pick_desktop(home: &Path, user_dirs: Option<&str>, exists: &dyn Fn(&Path) -> bool) -> PathBuf {
let named = user_dirs.and_then(|t| {
t.lines().find_map(|l| {
let v = l.trim().strip_prefix("XDG_DESKTOP_DIR=")?.trim_matches('"');
Some(PathBuf::from(v.replace("$HOME", &home.to_string_lossy())))
})
});
// A user without a desktop sets XDG_DESKTOP_DIR to the home folder itself: that is not a place to drop files into.
[named, Some(home.join("Desktop")), Some(home.join("Downloads"))].into_iter().flatten().filter(|p| p != home).find(|p| exists(p)).unwrap_or_else(std::env::temp_dir)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::registry::{InstallKind, InstallMeta};
#[cfg(not(windows))]
#[test]
fn the_desktop_folder_on_linux_follows_the_users_own_directories() {
let home = Path::new("/home/ana");
let only = |wanted: &'static [&'static str]| move |p: &Path| wanted.contains(&p.to_str().unwrap());
let dirs = "# comment\nXDG_DOWNLOAD_DIR=\"$HOME/Downloads\"\nXDG_DESKTOP_DIR=\"$HOME/Bureau\"\n";
assert_eq!(pick_desktop(home, Some(dirs), &only(&["/home/ana/Bureau", "/home/ana/Desktop"])), PathBuf::from("/home/ana/Bureau"));
assert_eq!(pick_desktop(home, None, &only(&["/home/ana/Desktop"])), PathBuf::from("/home/ana/Desktop"));
assert_eq!(pick_desktop(home, Some(dirs), &only(&["/home/ana/Downloads"])), PathBuf::from("/home/ana/Downloads"));
assert_eq!(pick_desktop(home, None, &only(&[])), std::env::temp_dir());
// No desktop: the user directories file names the home folder itself.
let none = "XDG_DESKTOP_DIR=\"$HOME/\"\n";
assert_eq!(pick_desktop(home, Some(none), &only(&["/home/ana", "/home/ana/Downloads"])), PathBuf::from("/home/ana/Downloads"));
}
#[test]
fn repeated_config_warnings_are_folded() {
let t = "start
@@ -586,6 +646,11 @@ real error
fs::write(root.join("Core/configs/worldserver.conf"), "LoginDatabaseInfo = \"127.0.0.1;3307;acore;SECRETPW;auth\"\nRate.XP.Kill = 1\n").unwrap();
let meta_dir = d.path().join("srv.manager");
fs::create_dir_all(&meta_dir).unwrap();
fs::write(meta_dir.join("update.lock"), b"").unwrap();
fs::write(meta_dir.join("update-lock-owner.json"), r#"{"operation":"checking updates","pid":1234,"started":"2026-10-13T01:00:00Z","token":"owner-secret"}"#).unwrap();
fs::create_dir_all(meta_dir.join("diagnostics")).unwrap();
fs::write(meta_dir.join("diagnostics/schema-validation-CoA-test.json"), r#"{"problems":[{"table":"creature_display_preset","column":"display_id","detail":"default mismatch"}],"password":"schema-secret"}"#).unwrap();
fs::write(meta_dir.join("diagnostics/database-recovery-test.json"), r#"{"objects":[{"database":"acore_characters","kind":"TRIGGER","name":"user_character_trigger"}],"password":"recovery-secret"}"#).unwrap();
let meta = InstallMeta::new(InstallKind::Imported, &root);
let report = run(&root, &meta);
let zip_path = d.path().join("diag.zip");
@@ -600,6 +665,14 @@ real error
}
assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included");
assert!(all.contains("v1.8") && all.contains("48c4786a"));
assert!(all.contains("creature_display_preset") && all.contains("default mismatch"));
assert!(!all.contains("schema-secret"));
assert!(all.contains("user_character_trigger") && all.contains("acore_characters"));
assert!(!all.contains("recovery-secret"));
assert!(all.contains("checking updates") && all.contains("1234"));
assert!(all.contains("lockFilePresent") && all.contains("does not establish"));
assert!(!all.contains("owner-secret"));
assert_eq!(fs::read(meta_dir.join("update.lock")).unwrap(), b"");
assert!(!all.contains("hunter2") && !all.contains("SECRETPW") && !all.contains("upstream-secret"));
}
}
+69
View File
@@ -0,0 +1,69 @@
//! The disposable database a release is validated against, on a Linux computer.
//!
//! A release is checked by applying its database changes to the database of the signed base package. The base carries the
//! MySQL data directory of a Windows repack, and a MySQL 8.4 server in Docker opens it as it is (with the repack's table
//! name setting). So the fixture is a Docker server folder whose database container uses that directory in place of a
//! volume; everything else (start, SQL, schema capture, dumps) is the code of a Docker installation.
use std::fs;
use std::path::Path;
use super::{Config, Docker, MARKER, MYSQL_IMAGE};
use crate::driver::{self, Verb};
use crate::error::{Error, Result};
use crate::{fsx, install, package};
/// Turn an extracted base package (`mysql/data`, `Settings/`) into a Docker server folder and start its database.
pub fn prepare(root: &Path) -> Result<()> {
prepare_with(&super::SystemDocker, root)
}
pub(crate) fn prepare_with(d: &dyn Docker, root: &Path) -> Result<()> {
let boot = root.join(package::BOOTSTRAP_CREDENTIALS);
if !boot.is_file() {
return Err(Error::Invalid("The package has no database bootstrap information.".into()));
}
let secrets: serde_json::Value = fsx::read_json(&boot)?;
let root_pw = secrets["rootPassword"].as_str().filter(|p| p.chars().all(|c| c.is_ascii_hexdigit()) && !p.is_empty())
.ok_or_else(|| Error::Invalid("The database bootstrap information is not usable.".into()))?.to_string();
fs::copy(&boot, root.join("Settings/database.json"))?;
let data = fs::canonicalize(root.join("mysql/data"))
.map_err(|_| Error::Invalid("The package has no database data directory.".into()))?;
let cfg = Config {
project: format!("schema-{}", install::random_hex(8)),
bind_address: "127.0.0.1".into(),
mysql_image: MYSQL_IMAGE.into(),
data_dir: None,
mysql_data: Some(data.to_string_lossy().into_owned()),
};
fsx::atomic_write_json(&root.join(MARKER), &cfg)?;
let started = driver::run(root, Verb::StartMysql)?;
if !started.ok {
return Err(Error::Invalid(started.human.map(|h| h.message.to_string()).unwrap_or_else(|| "The database could not be started.".into())));
}
// The repack's administrator account only exists for connections from the server itself (the socket); the Manager
// connects over TCP. The fixture is thrown away, so the account is simply added.
let sql = format!("CREATE USER IF NOT EXISTS 'root'@'127.0.0.1' IDENTIFIED BY '{root_pw}'; GRANT ALL ON *.* TO 'root'@'127.0.0.1' WITH GRANT OPTION;");
let mut call = super::Call::new(&["exec", "-i", "-e", "MYSQL_PWD", &cfg.names().db, "mysql", "--user=root"], std::time::Duration::from_secs(60));
call.env = vec![("MYSQL_PWD".into(), root_pw)];
call.stdin = Some(sql.as_bytes());
let o = d.run(&call)?;
if !o.ok() {
return Err(Error::Invalid(format!("The fixture database could not be opened to the Manager: {}", o.text())));
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_package_without_bootstrap_information_is_refused_before_anything_starts() {
let dir = tempfile::tempdir().unwrap();
let err = prepare(dir.path()).unwrap_err();
assert!(err.to_string().contains("bootstrap"), "{err}");
assert!(!dir.path().join(MARKER).exists());
}
}
+2 -2
View File
@@ -112,7 +112,7 @@ pub fn preflight(dest: &Path, data_dir: &Path, needed_bytes: u64, registry: &Reg
Preflight { ok: problems.is_empty(), problems, free_bytes }
}
fn data_problems(data_dir: &Path) -> Vec<crate::install::Problem> {
pub(crate) fn data_problems(data_dir: &Path) -> Vec<crate::install::Problem> {
let s = data_dir.to_string_lossy();
if !data_dir.is_absolute() || s.contains(':') {
return vec![problem("data_path", "Choose the game data folder with its full path, without a colon in it.")];
@@ -146,7 +146,7 @@ fn write_settings(root: &Path, data_dir: &Path) -> Result<Settings> {
let (auth, world, ra) = (pick_port(DEFAULT_PORTS.0)?, pick_port(DEFAULT_PORTS.1)?, pick_port(DEFAULT_PORTS.2)?);
let (root_password, app_password) = (random_hex(48), random_hex(48));
fs::create_dir_all(root.join("Settings"))?;
let docker = Config { project, bind_address: "127.0.0.1".into(), mysql_image: super::MYSQL_IMAGE.into(), data_dir: Some(data_dir.to_string_lossy().into_owned()) };
let docker = Config { project, bind_address: "127.0.0.1".into(), mysql_image: super::MYSQL_IMAGE.into(), data_dir: Some(data_dir.to_string_lossy().into_owned()), mysql_data: None };
fsx::atomic_write_json(&root.join(MARKER), &docker)?;
// Same file and keys as a repack, so the console, the ports and the settings screens work unchanged. The database is
// not published on the host; its port is only there to fill the key.
+140 -8
View File
@@ -210,7 +210,7 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
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.args = db_args(cfg, &n, owner_of(root).as_deref());
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() {
@@ -223,6 +223,10 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
return Ok(());
}
// Realm profiles (CoA / Wildcard): the database is running and healthy here (started and waited for above), which the
// realm list update below needs. Finish an interrupted switch, then make the realm list say what is selected. The repack's
// launcher did this when it started; here nothing else would.
let realm = prepare_realm(root, log)?;
ensure_image(d, log)?;
super::ensure_main_configs(root).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
std::fs::create_dir_all(root.join("Core/Logs")).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
@@ -234,22 +238,43 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
remove(d, &n.world);
let mut call = Call::new(&[], Duration::from_secs(60));
call.args = game_args(cfg, &n, GameKind::World, &host, &cfg.data_path(&host), ports.world, ports.ra, owner.as_deref());
call.env = database_env(&secrets, true);
call.env = database_env(&secrets, true, realm);
run_container(d, &call, &n.world, log)?;
}
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
// The core leaves with code 2 for `server restart` and expects a supervisor to start it again (the repack has one). Docker
// does that for any non-zero exit, but only once the server has come up: a start that fails must stay failed, not loop.
// A stop by `docker stop` or `server shutdown` (code 0) is never restarted.
let _ = docker(d, &["update", "--restart", "on-failure:3", &n.world], QUICK);
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, &cfg.data_path(&host), ports.auth, 0, owner.as_deref());
call.env = database_env(&secrets, false);
call.env = database_env(&secrets, false, realm);
run_container(d, &call, &n.auth, log)?;
}
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
mark_realm_online(d, &n, &secrets, realm, log);
Ok(())
}
/// The auth server marks every realm offline when it starts, and the world server (already up, see the order above) only
/// puts itself back after its next uptime update, ten minutes later by default: until then the client shows "Realm is
/// Offline". The world is known to be listening here, so say so for the realm it serves. The other realm of a Wildcard
/// install keeps the offline flag it is given on purpose (`realms::setup_realmlist`).
fn mark_realm_online(d: &dyn Docker, n: &Names, secrets: &Secrets, realm: crate::realms::Mode, log: &mut Log) {
let sql = format!("UPDATE acore_auth.realmlist SET flag = flag & ~2 WHERE id = {};", realm.realm_id());
let mut call = Call::new(&["exec", "-i", "-e", "MYSQL_PWD", &n.db, "mysql", "--user=root", "--protocol=tcp", "--host=127.0.0.1"], QUICK);
call.env = vec![("MYSQL_PWD".into(), secrets.root.clone())];
call.stdin = Some(sql.as_bytes());
match d.run(&call) {
Ok(o) if o.ok() => {}
Ok(o) => log.say(format!("the realm could not be marked online: {}", o.text().trim())),
Err(e) => log.say(format!("the realm could not be marked online: {e}")),
}
}
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));
@@ -333,12 +358,22 @@ fn connect_ip(cfg: &Config) -> IpAddr {
// ------------------------------------------------------------------------------------------------- argument lists
fn db_args(cfg: &Config, n: &Names) -> Vec<String> {
fn db_args(cfg: &Config, n: &Names, owner: Option<&str>) -> 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)]);
match &cfg.mysql_data {
Some(dir) => {
// A data directory from a Windows repack: it is written by the person who owns the folder, and its table names
// were folded to lower case (the repack's setting), which the server must be told because a Linux one does not.
a.extend(["--volume".into(), format!("{dir}:/var/lib/mysql")]);
if let Some(o) = owner {
a.extend(["--user".into(), o.into()]);
}
}
None => 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. It must go over TCP, like
@@ -349,6 +384,9 @@ fn db_args(cfg: &Config, n: &Names) -> Vec<String> {
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());
if cfg.mysql_data.is_some() {
a.push("--lower-case-table-names=1".into());
}
a
}
@@ -359,16 +397,47 @@ enum GameKind {
}
/// 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)> {
fn database_env(s: &Secrets, world: bool, realm: crate::realms::Mode) -> 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")));
// The databases of the selected realm (the Wildcard realm has its own world and characters databases).
let schema = |kind: &str| realm.schema(kind).unwrap_or("acore_world");
env.push(("AC_WORLD_DATABASE_INFO".into(), info(schema("world"))));
env.push(("AC_CHARACTER_DATABASE_INFO".into(), info(schema("characters"))));
}
env
}
/// Every setting variable (`AC_...`) the containers get, for the check that the screens know which settings are fixed.
#[cfg(test)]
pub(crate) fn forced_variables() -> Vec<String> {
let cfg = Config { project: "t".into(), bind_address: "127.0.0.1".into(), mysql_image: "mysql:8.4".into(), data_dir: None, mysql_data: None };
let n = cfg.names();
let mut found = Vec::new();
for kind in [GameKind::World, GameKind::Auth] {
let args = game_args(&cfg, &n, kind, Path::new("/s"), Path::new("/d"), 1, 2, None);
found.extend(args.iter().filter_map(|a| a.strip_prefix("AC_").map(|rest| format!("AC_{}", rest.split('=').next().unwrap()))));
}
found.sort();
found.dedup();
found
}
/// Realm profiles are only in play once a profile has been chosen on this server (`Settings/realm-profile.json`).
fn prepare_realm(root: &Path, log: &mut Log) -> Step<crate::realms::Mode> {
let fail_with = |e: crate::error::Error| Failure { code: ErrorCode::StartupFailed, output: e.to_string() };
crate::realms::before_start(root).map_err(fail_with)?;
let active = crate::realms::state(root).map_err(fail_with)?.active;
if root.join("Settings/realm-profile.json").exists() {
crate::realms::setup_realmlist(root).map_err(fail_with)?;
let db = crate::db::Db::from_repack(root, crate::db::Account::Admin).map_err(fail_with)?;
db.query("UPDATE acore_auth.realmlist SET name='Conquest of Azeroth' WHERE id=1; UPDATE acore_auth.realmlist SET name='Wildcard' WHERE id=2;").map_err(fail_with)?;
log.say(format!("realm {}", active.name()));
}
Ok(active)
}
fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, data: &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),
@@ -395,6 +464,10 @@ fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, data: &Path,
a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0"));
if kind == GameKind::World {
a.extend(["--volume".into(), format!("{}:{DATA}:ro", data.display())]);
let races = host.join("Data/dbc_races");
if races.is_dir() && races != data.join("dbc_races") {
a.extend(["--volume".into(), format!("{}:{DATA}/dbc_races:ro", races.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}")]);
@@ -633,6 +706,8 @@ mod tests {
}
out(0, "containerid\n", "")
}
["update", "--restart", _, _] => out(0, "", ""),
["exec", ..] => out(0, "", ""),
["stop", "--time", _, name] => {
self.running.borrow_mut().remove(*name);
self.exited.borrow_mut().insert(name.to_string(), (0, false));
@@ -675,6 +750,10 @@ mod tests {
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");
let exec = sim.calls_of("exec");
assert_eq!(exec.len(), 1, "the realm is marked online once the auth server is up");
assert!(exec[0].stdin && exec[0].env == [("MYSQL_PWD".to_string(), ROOT_PW.to_string())]);
assert!(!exec[0].args.iter().any(|a| a.contains(ROOT_PW)), "the password is not on the command line");
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");
}
@@ -698,6 +777,59 @@ mod tests {
assert!(runs[1].args.windows(2).any(|w| w == ["--env", "AC_WORLD_DATABASE_INFO"]), "name only, the value is in the environment");
}
// Unix only: the folder is a Linux path (a Windows path has a colon, which a Docker folder may not).
#[cfg(unix)]
#[test]
fn a_release_fixture_runs_its_database_on_the_package_data_directory_not_on_a_volume() {
let (_d, root) = server("t1");
fs::write(root.join("Settings/docker.json"), r#"{"project":"t1","mysqlData":"/work/fixture/mysql/data"}"#).unwrap();
let sim = Sim::new();
assert!(run_with(&sim, &root, Verb::StartMysql).unwrap().ok);
let db = &sim.calls_of("run")[0].args;
assert!(db.windows(2).any(|w| w == ["--volume", "/work/fixture/mysql/data:/var/lib/mysql"]), "{db:?}");
assert!(!db.iter().any(|a| a.starts_with("coa-t1-db:")), "no named volume: {db:?}");
assert!(db.iter().any(|a| a == "--user"), "the folder is written by its owner");
assert_eq!(db.last().map(String::as_str), Some("--lower-case-table-names=1"), "a server option, so after the image name");
// An installation never gets any of it.
let (_d2, root2) = server("t2");
let sim2 = Sim::new();
assert!(run_with(&sim2, &root2, Verb::StartMysql).unwrap().ok);
let plain = &sim2.calls_of("run")[0].args;
assert!(plain.windows(2).any(|w| w == ["--volume", "coa-t2-db:/var/lib/mysql"]), "{plain:?}");
assert!(!plain.iter().any(|a| a == "--lower-case-table-names=1" || a == "--user"));
}
#[test]
fn the_world_server_is_started_again_when_it_restarts_itself_but_only_once_it_is_up() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
let world_run = sim.calls_of("run").into_iter().find(|c| c.args.iter().any(|a| a == "coa-t1-world")).unwrap();
assert!(!world_run.args.iter().any(|a| a == "--restart"), "no restart while it is still starting");
let updates = sim.calls_of("update");
assert_eq!(updates.len(), 1);
assert_eq!(updates[0].args, ["update", "--restart", "on-failure:3", "coa-t1-world"]);
let verbs = sim.verbs();
let pos = |p: &str| verbs.iter().position(|v| v.starts_with(p)).unwrap();
assert!(pos("run --detach") < pos("update"), "after the container exists and listens");
}
#[test]
fn the_containers_use_the_databases_of_the_selected_realm() {
let s = Secrets { root: "r".into(), app: "apppw".into() };
let get = |env: &[(String, String)], k: &str| env.iter().find(|(n, _)| n == k).map(|(_, v)| v.clone());
let coa = database_env(&s, true, crate::realms::Mode::Coa);
assert_eq!(get(&coa, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world");
assert_eq!(get(&coa, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters");
let wild = database_env(&s, true, crate::realms::Mode::Wildcard);
assert_eq!(get(&wild, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world_wildcard");
assert_eq!(get(&wild, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters_wildcard");
// Accounts are shared by both realms; the auth server never sees the others.
assert_eq!(get(&wild, "AC_LOGIN_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_auth");
let auth = database_env(&s, false, crate::realms::Mode::Wildcard);
assert_eq!(auth.len(), 1);
}
#[test]
fn the_database_is_only_healthy_once_it_takes_tcp_connections() {
let (_d, root) = server("t1");
+72
View File
@@ -0,0 +1,72 @@
//! The database of a Docker server has no log file in the server folder: MySQL writes to its container's output.
use super::cli::{Call, Docker, SystemDocker};
use super::Config;
use crate::console::Line;
use crate::error::{Error, Result};
use std::path::Path;
use std::time::Duration;
/// The last lines MySQL wrote (what `docker logs` returns), filtered and classified like the lines of a log file.
pub fn database_log(root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
database_log_with(&SystemDocker, root, filter, max_lines)
}
pub fn database_log_with(d: &dyn Docker, root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
let name = Config::load(root)?.names().db;
// Ask for more than wanted: the filter may drop most of them.
let tail = (max_lines * 4).clamp(200, 8000).to_string();
let out = d.run(&Call::new(&["logs", "--tail", &tail, &name], Duration::from_secs(20)))?;
if !out.ok() {
return Err(Error::Invalid("This log does not exist yet.".into()));
}
// MySQL writes to the error stream.
Ok(crate::console::lines_from_text(&format!("{}\n{}", out.stderr, out.stdout), filter, max_lines))
}
#[cfg(test)]
mod tests {
use super::*;
use crate::docker::cli::Output;
use std::cell::RefCell;
struct Fake {
out: Output,
calls: RefCell<Vec<Vec<String>>>,
}
impl Docker for Fake {
fn run(&self, call: &Call) -> Result<Output> {
self.calls.borrow_mut().push(call.args.clone());
Ok(self.out.clone())
}
}
fn root() -> (tempfile::TempDir, std::path::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/docker.json"), r#"{"project":"t1"}"#).unwrap();
(d, root)
}
#[test]
fn the_database_log_is_what_the_container_printed() {
let (_d, root) = root();
let fake = Fake { out: Output { code: Some(0), stdout: "2026-10-04T10:00:00Z [System] ready\n".into(), stderr: "2026-10-04T10:00:01Z [ERROR] [MY-010] boom\n2026-10-04T10:00:02Z [Warning] slow\n".into() }, calls: Default::default() };
let lines = database_log_with(&fake, &root, None, 100).unwrap();
assert_eq!(fake.calls.borrow()[0][..2], ["logs", "--tail"]);
assert_eq!(fake.calls.borrow()[0].last().unwrap(), "coa-t1-db");
assert_eq!(lines.len(), 3);
assert!(lines.iter().any(|l| l.text.contains("boom") && l.level == crate::console::Level::Error));
let only = database_log_with(&fake, &root, Some("slow"), 100).unwrap();
assert_eq!(only.len(), 1);
}
#[test]
fn a_database_that_never_ran_has_no_log_yet() {
let (_d, root) = root();
let fake = Fake { out: Output { code: Some(1), stdout: String::new(), stderr: "Error: No such container: coa-t1-db".into() }, calls: Default::default() };
assert!(database_log_with(&fake, &root, None, 10).unwrap_err().to_string().contains("does not exist yet"));
}
}
+149 -3
View File
@@ -15,11 +15,15 @@
//! ```
mod cli;
pub mod fixture;
pub mod install;
mod lifecycle;
pub mod logs;
pub mod sharing;
pub use cli::{Call, Docker, Output, SystemDocker};
pub use lifecycle::{check_docker, observe, observe_with, run, run_with};
pub use sharing::{bind_is_open, exposure, set_open};
pub(crate) use lifecycle::destroy;
use std::net::IpAddr;
@@ -63,6 +67,10 @@ pub struct Config {
/// mounted read-only, so one copy can serve several servers.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub data_dir: Option<String>,
/// A MySQL data directory the database container uses in place of its volume. Only for the disposable fixture that
/// validates a release (the data directory of the signed base package); an installation never sets it.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub mysql_data: Option<String>,
}
pub(crate) struct Names {
@@ -96,10 +104,10 @@ impl Config {
if self.bind_address.parse::<IpAddr>().is_err() {
return Err(Error::Invalid(format!("{} is not an IP address.", self.bind_address)));
}
if let Some(d) = &self.data_dir {
// The folder goes into a `--volume host:container:ro` option, where a colon would be read as a separator.
for d in [&self.data_dir, &self.mysql_data].into_iter().flatten() {
// The folder goes into a `--volume host:container` option, where a colon would be read as a separator.
if !Path::new(d).is_absolute() || d.contains(':') {
return Err(Error::Invalid("The game data folder must be a full path without a colon.".into()));
return Err(Error::Invalid("A Docker folder must be a full path without a colon.".into()));
}
}
let image_ok = !self.mysql_image.is_empty() && self.mysql_image.chars().all(|c| c.is_ascii_alphanumeric() || "._/:@-".contains(c));
@@ -135,6 +143,84 @@ pub fn ensure_main_configs(root: &Path) -> Result<Vec<String>> {
Ok(created)
}
/// Settings the Docker backend gives the containers as environment variables. The core reads `AC_<KEY>` before the
/// configuration file, so a value written to the file for one of these keys is silently ignored. They are what makes the
/// containers work (where things are inside them, listening on every interface, the console, no built-in database
/// updater, the databases); the owner has no use for them and the screens do not offer them.
pub(crate) const FORCED_KEYS: [&str; 12] = [
"BindIP",
"WorldServerPort",
"RealmServerPort",
"LogsDir",
"DataDir",
"Updates.EnableDatabases",
"Ra.Enable",
"Ra.IP",
"Ra.Port",
"LoginDatabaseInfo",
"WorldDatabaseInfo",
"CharacterDatabaseInfo",
];
/// Is this setting fixed by the Docker backend (see `FORCED_KEYS`)?
pub fn managed_setting(key: &str) -> bool {
FORCED_KEYS.iter().any(|k| k.eq_ignore_ascii_case(key))
}
/// The environment variable the core reads for a setting: `AC_` and the key in upper snake case, a `_` between a lower-case
/// letter and a capital, and at letter / digit boundaries (the core's `IniKeyToEnvVarKey`).
#[cfg(test)]
pub(crate) fn env_name(key: &str) -> String {
let chars: Vec<char> = key.chars().collect();
let mut out = String::from("AC_");
for (i, &c) in chars.iter().enumerate() {
if matches!(c, ' ' | '.' | '-') {
out.push('_');
continue;
}
out.push(c.to_ascii_uppercase());
if let Some(&next) = chars.get(i + 1) {
let split = (!c.is_ascii_uppercase() && next.is_ascii_uppercase()) || (!c.is_ascii_digit() && next.is_ascii_digit()) || (c.is_ascii_digit() && !next.is_ascii_digit() && !matches!(next, ' ' | '.' | '-'));
if split {
out.push('_');
}
}
}
out
}
/// The folder mounted as the game data of this Docker server.
pub fn game_data_dir(root: &Path) -> Result<std::path::PathBuf> {
Ok(Config::load(root)?.data_path(root))
}
/// Point a Docker server at another game data folder (used in place, read-only). The containers are recreated at the next
/// start, so the servers must be stopped: a running one keeps the folder it has.
pub fn set_game_data(root: &Path, path: &Path) -> Result<()> {
let problems = install::data_problems(path);
if !problems.is_empty() {
return Err(Error::Invalid(problems.iter().map(|p| p.message.clone()).collect::<Vec<_>>().join(" ")));
}
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
let busy = |s: &crate::process::ServiceStatus| matches!(s.state, crate::process::ServiceState::Running | crate::process::ServiceState::Starting | crate::process::ServiceState::Stopping);
if busy(&observed.world) || busy(&observed.auth) {
return Err(Error::Invalid("Stop the server before changing the game data folder.".into()));
}
let mut cfg = Config::load(root)?;
cfg.data_dir = Some(path.to_string_lossy().into_owned());
cfg.validate()?;
fsx::atomic_write_json(&root.join(MARKER), &cfg)
}
/// A reason a value cannot work on a Docker server, for settings that name a path: the server runs in a container that sees only
/// its own `Core` folder (as `/srv/core`, its working directory), so a path elsewhere on this computer does not exist for it.
pub fn setting_problem(key: &str, raw: &str) -> Option<&'static str> {
let raw = raw.trim().trim_matches('"');
let outside = Path::new(raw).is_absolute() && !raw.starts_with("/srv/core/");
(key.eq_ignore_ascii_case("CoaBots.TalentBuildsPath") && !raw.is_empty() && outside)
.then_some("must be a path inside the server's Core folder (for example reference/ascensionsidekick-level-builds.json), because the server runs in a container that cannot see other folders")
}
/// 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])
@@ -201,6 +287,66 @@ mod tests {
use super::*;
use std::fs;
#[cfg(unix)]
#[test]
fn the_game_data_folder_can_be_changed_when_the_servers_are_stopped() {
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(MARKER), r#"{"project":"t1","dataDir":"/old/data"}"#).unwrap();
let good = d.path().join("data");
std::fs::create_dir_all(good.join("dbc")).unwrap();
std::fs::create_dir_all(good.join("maps")).unwrap();
assert_eq!(game_data_dir(&root).unwrap(), std::path::PathBuf::from("/old/data"));
set_game_data(&root, &good).unwrap();
assert_eq!(game_data_dir(&root).unwrap(), good);
assert_eq!(Config::load(&root).unwrap().project, "t1", "the other settings are kept");
// A folder that does not look like game data is refused and nothing changes.
let empty = d.path().join("empty");
std::fs::create_dir_all(&empty).unwrap();
assert!(set_game_data(&root, &empty).is_err());
assert_eq!(game_data_dir(&root).unwrap(), good);
assert!(set_game_data(&root, std::path::Path::new("relative/dir")).is_err());
}
#[cfg(unix)]
#[test]
fn a_path_outside_the_core_folder_is_refused_for_a_docker_server() {
let key = "CoaBots.TalentBuildsPath";
assert!(setting_problem(key, "reference/builds.json").is_none());
assert!(setting_problem(key, "").is_none());
assert!(setting_problem(key, "\"/srv/core/reference/builds.json\"").is_none());
assert!(setting_problem(key, "/home/ana/builds.json").is_some());
assert!(setting_problem("Rate.XP.Kill", "/home/ana/x").is_none(), "only settings that name a path");
}
#[test]
fn setting_names_become_the_variables_the_core_reads() {
for (key, var) in [
("BindIP", "AC_BIND_IP"),
("Ra.Enable", "AC_RA_ENABLE"),
("Ra.IP", "AC_RA_IP"),
("Updates.EnableDatabases", "AC_UPDATES_ENABLE_DATABASES"),
("WorldServerPort", "AC_WORLD_SERVER_PORT"),
("LoginDatabaseInfo", "AC_LOGIN_DATABASE_INFO"),
("DataDir", "AC_DATA_DIR"),
("Dynamic.XP.Reminder.Interval", "AC_DYNAMIC_XP_REMINDER_INTERVAL"),
("EtherealBazaar.Enable", "AC_ETHEREAL_BAZAAR_ENABLE"),
] {
assert_eq!(env_name(key), var, "{key}");
}
}
#[test]
fn the_settings_called_managed_are_exactly_the_variables_the_containers_get() {
// If a variable is added to the containers without being listed here (or the other way round), a screen would
// offer a setting that does nothing, or hide one that works.
let given: std::collections::BTreeSet<String> = lifecycle::forced_variables().into_iter().collect();
let listed: std::collections::BTreeSet<String> = FORCED_KEYS.iter().map(|k| env_name(k)).collect();
assert_eq!(given, listed);
assert!(managed_setting("ra.enable") && managed_setting("Updates.EnableDatabases") && !managed_setting("PlayerLimit"));
}
#[test]
fn the_main_configs_are_created_from_their_templates_and_never_overwritten() {
let d = tempfile::tempdir().unwrap();
+149
View File
@@ -0,0 +1,149 @@
//! Sharing a Docker server with friends. Who can reach the game is decided by the address the container ports are
//! published on (`bindAddress` in `Settings/docker.json`): `127.0.0.1` is this computer only, anything else is the network.
//! The `BindIP` of the configuration files is forced to `0.0.0.0` inside the containers and changes nothing, so the
//! repack's way of opening the servers (editing `BindIP`) is replaced here. The database is never published and the server
//! console is only ever published on the loopback address.
use std::fs;
use std::net::IpAddr;
use std::path::{Path, PathBuf};
use super::{Config, MARKER};
use crate::config::parser::ConfFile;
use crate::config::{take_snapshot, Scope};
use crate::error::Result;
use crate::fsx;
use crate::layout::Ports;
use crate::net::Exposure;
use crate::process::{ServiceState, ServiceStatus};
fn is_open(cfg: &Config) -> bool {
cfg.bind_address.parse::<IpAddr>().map(|ip| !ip.is_loopback()).unwrap_or(false)
}
/// Whether the login and world servers are published beyond this computer.
pub fn bind_is_open(root: &Path) -> bool {
Config::load(root).map(|c| is_open(&c)).unwrap_or(false)
}
/// Publish the login and world servers beyond this computer (`0.0.0.0`) or only on it (`127.0.0.1`). An address the owner chose
/// by hand (for example one network card) is kept when opening. Returns true if anything changed, which needs a restart of
/// the containers. The old files are snapshotted.
pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
let mut cfg = Config::load(root)?;
let mut originals: Vec<(PathBuf, Vec<u8>)> = Vec::new();
let mut changed = false;
if is_open(&cfg) != open {
originals.push((root.join(MARKER), fs::read(root.join(MARKER))?));
cfg.bind_address = if open { "0.0.0.0" } else { "127.0.0.1" }.into();
changed = true;
}
// Friends connect from other addresses, and the server only applies the CoA client protocol to loopback unless remote clients
// are allowed; opening switches that on (closing leaves it, it only matters while the servers listen beyond this computer).
let coa_conf = root.join("Core/configs/modules/coa.conf");
let mut coa_edit = None;
if open {
if let Ok(bytes) = fs::read(&coa_conf) {
let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("CoA.AllowRemoteClients").map(str::trim) != Some("1") {
conf.set("CoA.AllowRemoteClients", "1", &["Set by CoA Server Manager together with the friends mode"]);
originals.push((coa_conf.clone(), bytes));
coa_edit = Some(conf.to_text());
}
}
}
if !changed && coa_edit.is_none() {
return Ok(false);
}
take_snapshot(meta, Scope::Server, if open { "before opening the servers to friends" } else { "before closing the servers to friends" }, &originals)?;
if changed {
fsx::atomic_write_json(&root.join(MARKER), &cfg)?;
}
let remote_changed = coa_edit.is_some();
if let Some(text) = coa_edit {
fsx::atomic_write(&coa_conf, text.as_bytes())?;
}
Ok(changed || remote_changed)
}
/// What each service can be reached from, computed from how the containers publish their ports: the database is never published,
/// the console only on the loopback address, the game servers on `bindAddress`.
pub fn exposure(root: &Path, ports: &Ports) -> Vec<Exposure> {
let open = bind_is_open(root);
let observed = crate::process::observe(root, ports);
let up = |s: &ServiceStatus| matches!(s.state, ServiceState::Running | ServiceState::Starting);
vec![
Exposure { port: ports.mysql, what: "database", listening: up(&observed.mysql), reachable_from_network: false },
Exposure { port: ports.ra, what: "server console", listening: up(&observed.world), reachable_from_network: false },
Exposure { port: ports.auth, what: "login server", listening: up(&observed.auth), reachable_from_network: open && up(&observed.auth) },
Exposure { port: ports.world, what: "game world", listening: up(&observed.world), reachable_from_network: open && up(&observed.world) },
]
}
#[cfg(test)]
mod tests {
use super::*;
fn server(bind: Option<&str>) -> (tempfile::TempDir, PathBuf, PathBuf) {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
let meta = d.path().join("srv.manager");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(root.join("Core/configs/modules")).unwrap();
fs::create_dir_all(&meta).unwrap();
let extra = bind.map(|b| format!(r#","bindAddress":"{b}""#)).unwrap_or_default();
fs::write(root.join(MARKER), format!(r#"{{"project":"t1"{extra}}}"#)).unwrap();
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\n").unwrap();
(d, root, meta)
}
#[test]
fn opening_and_closing_changes_the_published_address_and_allows_remote_clients() {
let (_d, root, meta) = server(None);
assert!(!bind_is_open(&root));
assert!(set_open(&root, &meta, true).unwrap(), "a restart is needed");
assert!(bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap().contains("CoA.AllowRemoteClients = 1"));
assert!(!set_open(&root, &meta, true).unwrap(), "nothing left to change");
assert!(set_open(&root, &meta, false).unwrap());
assert!(!bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "127.0.0.1");
}
#[test]
fn enabling_remote_client_protocol_requires_restart_even_when_ports_are_open() {
let (_d, root, meta) = server(Some("0.0.0.0"));
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\nCoA.AllowRemoteClients = 0\n").unwrap();
assert!(set_open(&root, &meta, true).unwrap());
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(!set_open(&root, &meta, true).unwrap());
}
#[test]
fn an_address_chosen_by_hand_is_kept_when_opening_and_other_settings_survive() {
let (_d, root, meta) = server(Some("192.168.1.20"));
assert!(bind_is_open(&root), "any address but the loopback is the network");
set_open(&root, &meta, true).unwrap();
let cfg = Config::load(&root).unwrap();
assert_eq!(cfg.bind_address, "192.168.1.20");
assert_eq!(cfg.project, "t1");
}
#[test]
fn the_old_settings_are_snapshotted_before_a_change() {
let (_d, root, meta) = server(None);
set_open(&root, &meta, true).unwrap();
assert_eq!(crate::config::list_snapshots(&meta).len(), 1);
}
#[test]
fn the_database_and_the_console_are_never_reported_reachable() {
let (_d, root, _meta) = server(Some("0.0.0.0"));
let rows = exposure(&root, &Ports::default());
let by = |what: &str| rows.iter().find(|e| e.what == what).unwrap();
assert!(!by("database").reachable_from_network && !by("server console").reachable_from_network);
// Nothing runs in this test (docker is not asked to start anything), so nothing is reachable yet.
assert!(rows.iter().all(|e| !e.reachable_from_network));
}
}
+129 -4
View File
@@ -90,7 +90,12 @@ fn launcher(root: &Path) -> Result<(PathBuf, PathBuf)> {
/// Run a launcher verb to completion (blocking; call from a worker thread).
pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
run_inner(root, verb, false)
tracing::info!(?verb, root = %root.display(), "driver: launcher requested");
let result = run_inner(root, verb, false);
if let Err(error) = &result {
tracing::warn!(?verb, root = %root.display(), %error, "driver: launcher request failed before completion");
}
result
}
pub(crate) fn validate_update(root: &Path) -> Result<DriverOutcome> {
@@ -100,13 +105,14 @@ pub(crate) fn validate_update(root: &Path) -> Result<DriverOutcome> {
fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverOutcome> {
let root = fsx::canonicalize_lenient(root)?;
let _update_lock = if !validating_update && matches!(verb, Verb::StartAll | Verb::StartWorld) {
Some(crate::update::operation_lock(&crate::registry::metadata_dir_for(&root)?)?)
Some(crate::update::operation_lock_for(&crate::registry::metadata_dir_for(&root)?, "starting server", true)?)
} 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) {
prepare_headless_world(&root, verb)?;
return crate::docker::run(&root, verb);
}
if verb == Verb::StopAll { crate::multiworld::stop(&root)?; }
@@ -123,6 +129,7 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
}
if matches!(verb, Verb::StartAll | Verb::StartWorld) { crate::modules::ensure_bot_exclusivity(&root)?; }
let (python, script) = launcher(&root)?;
prepare_headless_world(&root, verb)?;
let original = std::fs::read_to_string(&script)?;
let patched = patch_launcher_imports(&original)?;
if original != patched {
@@ -198,6 +205,27 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
Ok(DriverOutcome { ok, exit_code, code, human: code.map(ErrorCode::human), output })
}
/// Background servers receive no interactive stdin. Keep CLI EOF from stopping the world server;
/// the Manager's console uses remote access instead. The template survives launcher regeneration.
fn prepare_headless_world(root: &Path, verb: Verb) -> Result<()> {
if !matches!(verb, Verb::StartAll | Verb::StartWorld) { return Ok(()); }
for relative in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
let path = root.join(relative);
let bytes = match std::fs::read(&path) {
Ok(bytes) => bytes,
Err(e) if e.kind() == std::io::ErrorKind::NotFound => continue,
Err(e) => return Err(e.into()),
};
let mut config = crate::config::parser::ConfFile::parse_bytes(&bytes)?;
config.set("Console.Enable", "0", &["Local console is disabled for background startup; the Manager uses remote access."]);
let text = config.to_text();
if text.as_bytes() != bytes {
fsx::atomic_write(&path, text.as_bytes())?;
}
}
Ok(())
}
/// The launcher keeps one JSON record per service in `.state`. A crash or power loss while it writes one can leave
/// a file of the right length that holds only zero bytes (NTFS keeps the length but not the data), and the launcher
/// then dies on every start with an unreadable record. Such a file carries no information, so remove it: the
@@ -256,14 +284,99 @@ pub(crate) fn startup_failure(root: &Path, started: &DriverOutcome) -> String {
let title = code.map(|c| c.human().title).unwrap_or("The server did not become ready");
let output = crate::diag::redact(&started.output);
let lines: Vec<_> = output.lines().rev().take(12).collect();
if lines.is_empty() { title.into() }
else { format!("{title}\n{}", lines.into_iter().rev().collect::<Vec<_>>().join("\n")) }
let mut reason = if lines.is_empty() { title.into() }
else { format!("{title}\n{}", lines.into_iter().rev().collect::<Vec<_>>().join("\n")) };
for relative in ["Core/Logs/world-console.log", "Core/Logs/auth-console.log", "mysql/logs/mysql-error.log"] {
let tail = crate::health::tail(&root.join(relative), 64 * 1024);
let failures: Vec<_> = tail.lines().filter(|line| {
let lower = line.to_ascii_lowercase();
crate::health::diagnose(line).is_some() || lower.contains("fatal") || lower.contains("error") || lower.contains("aborting")
}).rev().take(8).collect();
if !failures.is_empty() {
reason.push_str(&format!("\n{relative}:\n{}", crate::diag::redact(&failures.into_iter().rev().collect::<Vec<_>>().join("\n"))));
}
}
reason
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_blocked_start_is_logged_before_any_launcher_is_spawned() {
use std::io::Write;
use std::sync::{Arc, Mutex};
struct Capture(Arc<Mutex<Vec<u8>>>);
impl Write for Capture {
fn write(&mut self, bytes: &[u8]) -> std::io::Result<usize> { self.0.lock().unwrap().extend_from_slice(bytes); Ok(bytes.len()) }
fn flush(&mut self) -> std::io::Result<()> { Ok(()) }
}
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
std::fs::create_dir(&root).unwrap();
let metadata = crate::registry::metadata_dir_for(&root).unwrap();
let _maintenance = crate::update::operation_lock(&metadata).unwrap();
let buffer = Arc::new(Mutex::new(Vec::new()));
let writer = Arc::clone(&buffer);
let subscriber = tracing_subscriber::fmt().without_time().with_ansi(false).with_writer(move || Capture(Arc::clone(&writer))).finish();
let error = tracing::subscriber::with_default(subscriber, || run(&root, Verb::StartAll)).unwrap_err();
assert!(error.to_string().contains("in progress"));
let text = String::from_utf8(buffer.lock().unwrap().clone()).unwrap();
assert!(text.contains("launcher requested") && text.contains("StartAll"));
assert!(text.contains("launcher request failed before completion") && text.contains("in progress"));
assert!(!text.contains("starting launcher verb"));
}
#[test]
fn background_start_disables_cli_in_template_and_rendered_config() {
let folder = tempfile::tempdir().unwrap();
let root = folder.path();
std::fs::create_dir_all(root.join("Settings")).unwrap();
std::fs::create_dir_all(root.join("Core/configs")).unwrap();
let template = root.join("Settings/worldserver.conf.template");
let rendered = root.join("Core/configs/worldserver.conf");
let original = "\u{feff}# Custom settings\r\nConsole.Enable = 1\r\nRa.Enable = 1\r\nPlayerLimit = 42\r\n";
std::fs::write(&template, original).unwrap();
std::fs::write(&rendered, original).unwrap();
let auth = root.join("Core/configs/authserver.conf");
std::fs::write(&auth, "custom auth config").unwrap();
for verb in [Verb::StartMysql, Verb::StopAll] {
prepare_headless_world(root, verb).unwrap();
assert_eq!(std::fs::read_to_string(&template).unwrap(), original);
assert_eq!(std::fs::read_to_string(&rendered).unwrap(), original);
}
for verb in [Verb::StartAll, Verb::StartWorld] {
std::fs::write(&template, original).unwrap();
std::fs::write(&rendered, original).unwrap();
prepare_headless_world(root, verb).unwrap();
let expected = original.replace("Console.Enable = 1", "Console.Enable = 0");
assert_eq!(std::fs::read_to_string(&template).unwrap(), expected);
assert_eq!(std::fs::read_to_string(&rendered).unwrap(), expected);
prepare_headless_world(root, verb).unwrap();
assert_eq!(std::fs::read_to_string(&template).unwrap(), expected);
}
assert_eq!(std::fs::read_to_string(auth).unwrap(), "custom auth config");
}
#[test]
fn background_start_overrides_an_absent_or_duplicate_console_setting() {
let folder = tempfile::tempdir().unwrap();
let root = folder.path();
prepare_headless_world(root, Verb::StartAll).unwrap();
std::fs::create_dir_all(root.join("Core/configs")).unwrap();
let path = root.join("Core/configs/worldserver.conf");
for original in ["Ra.Enable = 1\n", "Console.Enable = 0\nConsole.Enable = 1\n"] {
std::fs::write(&path, original).unwrap();
prepare_headless_world(root, Verb::StartAll).unwrap();
let bytes = std::fs::read(&path).unwrap();
let config = crate::config::parser::ConfFile::parse_bytes(&bytes).unwrap();
assert_eq!(config.get("Console.Enable"), Some("0"));
prepare_headless_world(root, Verb::StartAll).unwrap();
assert_eq!(std::fs::read(&path).unwrap(), bytes);
}
}
#[test]
fn large_squid_provisioning_has_time_to_finish_without_extending_shutdown() {
let folder = tempfile::tempdir().unwrap();
@@ -309,6 +422,18 @@ mod tests {
assert!(run(dir.path(), Verb::StartAll).is_err());
}
#[test]
fn startup_failure_reports_late_world_errors_after_launcher_ready() {
let dir = tempfile::tempdir().unwrap();
std::fs::create_dir_all(dir.path().join("Core/Logs")).unwrap();
std::fs::write(dir.path().join("Core/Logs/world-console.log"), "ERROR [1146] Table 'acore_characters.playerbots_names' doesn't exist\nFATAL Could not prepare statements\n").unwrap();
let started = DriverOutcome { ok: true, code: None, exit_code: Some(0), human: None, output: "Worldserver and automatic bug reporting are ready.".into() };
let reason = startup_failure(dir.path(), &started);
assert!(reason.contains("playerbots_names"));
assert!(reason.contains("Core/Logs/world-console.log"));
assert!(reason.contains("Could not prepare statements"));
}
#[test]
fn startup_failure_keeps_the_launcher_reason_without_secrets() {
let dir = tempfile::tempdir().unwrap();
+6
View File
@@ -55,6 +55,7 @@ pub enum ErrorCode {
OperationInProgress,
StartupFailed,
DockerUnavailable,
GameDataMismatch,
HashMismatch,
PathRejected,
PackageNotPublished,
@@ -138,6 +139,11 @@ impl ErrorCode {
"This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
&[Retry, ShowDetails],
),
ErrorCode::GameDataMismatch => (
"The game data folder is not the CoA set",
"The server stopped because the DBC files in the game data folder are not the ones of the Conquest of Azeroth client. Choose the folder that holds the CoA data (Settings > Game data folder), then start again.",
&[ShowDetails],
),
ErrorCode::HashMismatch => (
"A downloaded file is damaged",
"The file did not match its checksum and was not used.",
+9 -2
View File
@@ -80,6 +80,9 @@ fn bind_targets(root: &Path) -> Vec<PathBuf> {
/// Whether the configuration currently lets other computers reach the login and world servers.
pub fn bind_is_open(root: &Path) -> bool {
if crate::docker::is_docker(root) {
return crate::docker::bind_is_open(root);
}
let files = bind_targets(root);
!files.is_empty()
&& files
@@ -90,6 +93,9 @@ pub fn bind_is_open(root: &Path) -> bool {
/// Open (`0.0.0.0`) or close (`127.0.0.1`) the login and world servers to other computers. The database and the server
/// console are never touched. Returns true if anything changed (a restart is then needed). The old files are snapshotted.
pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
if crate::docker::is_docker(root) {
return crate::docker::set_open(root, meta, open);
}
let want = if open { "\"0.0.0.0\"" } else { "\"127.0.0.1\"" };
let mut originals = Vec::new();
let mut edits = Vec::new();
@@ -125,7 +131,8 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
Ok(true)
}
/// Make the realm list advertise `host` (the launcher resets it to 127.0.0.1 at every start, so this runs after each start).
/// Make the realm list advertise `host` to remote clients (the launcher resets it to 127.0.0.1 at every start, so this
/// runs after each start).
pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
if !host_ok(host) {
return Err(Error::Invalid("That address is not valid.".into()));
@@ -133,7 +140,7 @@ pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
let db = Db::from_repack(root, Account::Admin)?;
let realm = crate::realms::state(root)?.active.realm_id();
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};"))?;
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}' WHERE {where_realms};"))?;
Ok(())
}
+42
View File
@@ -28,6 +28,19 @@ pub fn normalize_lexical(path: &Path) -> PathBuf {
fn key(path: &Path) -> Vec<String> {
path.components()
.map(|c| {
#[cfg(windows)]
if let Component::Prefix(prefix) = c {
use std::path::Prefix;
match prefix.kind() {
Prefix::Disk(drive) | Prefix::VerbatimDisk(drive) => {
return format!("{}:", char::from(drive).to_ascii_lowercase());
}
Prefix::UNC(server, share) | Prefix::VerbatimUNC(server, share) => {
return format!("\\\\{}\\{}", server.to_string_lossy(), share.to_string_lossy()).to_lowercase();
}
_ => {}
}
}
let c = c.as_os_str().to_string_lossy();
if cfg!(windows) { c.to_lowercase() } else { c.into_owned() }
})
@@ -262,6 +275,35 @@ mod tests {
}
}
#[cfg(windows)]
#[test]
fn containment_matches_verbatim_drive_and_unc_prefixes() {
assert!(starts_with_ci(Path::new(r"\\?\C:\server\Extras\file.sql"), Path::new(r"C:\server")));
assert!(starts_with_ci(Path::new(r"C:\server\Extras\file.sql"), Path::new(r"\\?\c:\server")));
assert!(starts_with_ci(Path::new(r"\\?\UNC\host\share\server\file.sql"), Path::new(r"\\host\share\server")));
assert!(!starts_with_ci(Path::new(r"\\?\D:\server\file.sql"), Path::new(r"C:\server")));
assert!(!starts_with_ci(Path::new(r"\\?\C:\server-other\file.sql"), Path::new(r"C:\server")));
assert!(!starts_with_ci(Path::new(r"\\?\UNC\host\other\server\file.sql"), Path::new(r"\\host\share\server")));
}
#[cfg(windows)]
#[test]
fn ensure_within_accepts_long_rehearsal_sql_path() {
let dir = tempfile::tempdir().unwrap();
let root = dir.path().join("server");
fs::create_dir_all(&root).unwrap();
let mut candidate = root.clone();
for _ in 0..5 {
candidate.push("long-private-rehearsal-directory-name-20261013");
}
fs::create_dir_all(&candidate).unwrap();
candidate.push("2026_06_13_00_ai_playerbot_missing_group_buff_reagent.sql");
fs::write(&candidate, b"SELECT 1;").unwrap();
assert!(candidate.as_os_str().len() > 260);
assert!(ensure_within(&root, &candidate).is_ok());
assert!(ensure_within(&root, &std::fs::canonicalize(candidate).unwrap()).is_ok());
}
#[test]
fn ensure_within_blocks_junction_escape() {
if !cfg!(windows) {
+9
View File
@@ -25,6 +25,8 @@ pub fn diagnose(text: &str) -> Option<ErrorCode> {
Some(ErrorCode::DatabaseNotRunning)
} else if l.contains("address already in use") || l.contains("could not bind") || l.contains("only one usage of each socket") {
Some(ErrorCode::PortInUse)
} else if l.contains("does not hold the coa client dbc set") || l.contains("_outdated_ dbc data") {
Some(ErrorCode::GameDataMismatch)
} else if l.contains("config::loadfile") && l.contains("failed open file") && l.contains("worldserver.conf") {
Some(ErrorCode::ServerFilesIncomplete)
} else {
@@ -57,6 +59,13 @@ pub fn diagnose_installation(root: &Path) -> Option<ErrorCode> {
mod tests {
use super::*;
#[test]
fn a_game_data_folder_without_the_coa_dbc_set_is_named_as_such() {
let log = "Using DataDir /srv/data/\nSpellAffect.dbc not found in /srv/data/dbc/\nDataDir does not hold the CoA client DBC set. Install it with apps/coa-dbc/client_dbc.py.";
assert_eq!(diagnose(log), Some(ErrorCode::GameDataMismatch));
assert_eq!(diagnose("You have _outdated_ DBC data. Please extract correct versions from current using client."), Some(ErrorCode::GameDataMismatch));
}
#[test]
fn recognises_missing_migrations() {
let log = "ERROR [sql.sql] [1146] Table 'acore_world.coa_boss' doesn't exist\nFATAL [sql.sql] Your database structure is not up to date.";
+7
View File
@@ -2,11 +2,13 @@ pub mod accounts;
pub mod backup;
pub mod cleanbase;
pub mod companions;
pub mod custom_races;
pub mod client;
pub mod remote_client;
pub mod clientdl;
pub mod config;
pub mod console;
pub mod crashes;
pub mod dashboard;
pub mod db;
pub mod diag;
@@ -31,6 +33,7 @@ pub mod repair;
pub mod schema_check;
pub mod net;
pub mod package;
pub mod platform;
pub mod ra;
pub mod allsettings;
pub mod modules;
@@ -41,8 +44,12 @@ pub mod release;
pub mod report;
pub mod release_schema;
pub mod update;
mod update_isolation;
mod mysql_snapshot;
pub mod wine;
pub mod upnp;
pub mod signing;
pub mod channels;
pub mod srp6;
pub use error::{Error, ErrorCode, Result};
+89
View File
@@ -78,9 +78,31 @@ pub struct Revision {
pub commit: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct SourceDatabase {
pub manifest_sha256: String,
pub schema_sha256: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
pub struct Compatibility {
pub schema: u32,
pub platform: String,
pub core_commit: String,
pub module_commits: std::collections::BTreeMap<String, String>,
pub client_patch_version: String,
pub source_versions: Vec<String>,
#[serde(default, skip_serializing_if = "std::collections::BTreeMap::is_empty")]
pub source_databases: std::collections::BTreeMap<String, SourceDatabase>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Manifest {
#[serde(default, skip_serializing_if = "Option::is_none")]
pub compatibility: Option<Compatibility>,
pub schema: u32,
pub kind: Kind,
pub version: String,
@@ -136,6 +158,26 @@ impl Manifest {
if parse_version(&self.min_manager_version).is_none() {
return bad(format!("bad minManagerVersion {:?}", self.min_manager_version));
}
if let Some(c) = &self.compatibility {
if parse_version(&self.min_manager_version).is_none_or(|v| v < (0, 6, 13)) {
return bad("Release compatibility matrices require Manager 0.6.13 or newer".into());
}
if c.schema != 1 || !matches!(c.platform.as_str(), "windows-x86_64" | "linux-x86_64")
|| !is_commit(&c.core_commit) || self.core.commit.as_deref() != Some(&c.core_commit)
|| c.module_commits.is_empty() || c.module_commits.values().any(|sha| !is_commit(sha))
|| self.bots.as_ref().and_then(|r| r.commit.as_ref()).is_some_and(|sha| c.module_commits.get("bots") != Some(sha))
|| parse_version(&c.client_patch_version).is_none()
|| c.source_versions.is_empty() || c.source_versions.iter().any(|v| parse_version(v).is_none())
|| c.source_versions.iter().collect::<HashSet<_>>().len() != c.source_versions.len() {
return bad("Invalid release compatibility matrix".into());
}
if !c.source_databases.is_empty() && (c.source_databases.len() != c.source_versions.len()
|| c.source_versions.iter().any(|v| !c.source_databases.contains_key(v))
|| c.source_databases.values().any(|s| !is_sha256(&s.manifest_sha256)
|| s.schema_sha256.as_ref().is_some_and(|sha| !is_sha256(sha)))) {
return bad("Invalid source database compatibility".into());
}
}
for migration in &self.migrations {
if !is_sha256(&migration.sha256) || migration.compatible_sha256.iter().any(|h| !is_sha256(h) || h == &"0".repeat(64)) {
return bad(format!("{}: invalid migration checksum compatibility", migration.id));
@@ -232,6 +274,53 @@ mod tests {
assert!(!m.compatible_with_manager("0.0.9"));
}
#[test]
fn compatibility_matrix_binds_core_and_requires_tested_sources() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into();
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.261010.32".into()] });
m.validate().unwrap();
m.compatibility.as_mut().unwrap().core_commit = "c".repeat(40);
assert!(m.validate().is_err());
m.compatibility.as_mut().unwrap().core_commit = "a".repeat(40);
m.compatibility.as_mut().unwrap().source_versions.clear();
assert!(m.validate().is_err());
}
#[test]
fn compatibility_cannot_claim_a_different_packaged_bot_revision() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into();
m.bots = Some(Revision { commit: Some("b".repeat(40)) });
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
core_commit: "a".repeat(40), module_commits: [("bots".into(), "c".repeat(40))].into(),
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()] });
assert!(m.validate().is_err());
m.compatibility.as_mut().unwrap().module_commits.insert("bots".into(), "b".repeat(40));
m.validate().unwrap();
m.compatibility.as_mut().unwrap().source_versions.push("0.2.0".into());
assert!(m.validate().is_err());
}
#[test]
fn source_database_contracts_must_cover_the_exact_upgrade_versions() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into();
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()],
source_databases: [("0.2.0".into(), SourceDatabase { manifest_sha256: "a".repeat(64), schema_sha256: None })].into() });
m.validate().unwrap();
m.compatibility.as_mut().unwrap().source_databases.get_mut("0.2.0").unwrap().schema_sha256 = Some("bad".into());
assert!(m.validate().is_err());
let c = m.compatibility.as_mut().unwrap();
c.source_databases.get_mut("0.2.0").unwrap().schema_sha256 = None;
c.source_versions = vec!["0.2.1".into()];
assert!(m.validate().is_err());
}
#[test]
fn rejects_traversal_bad_hash_duplicates_and_short_commit() {
let ok = "b".repeat(64);
+119 -6
View File
@@ -119,7 +119,26 @@ fn conf_name(root: &Path, e: &Entry) -> String {
}
}
fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
let Ok(directory) = crate::registry::metadata_dir_for(root) else { return Default::default() };
let Ok((_, meta)) = crate::registry::MetaDir::open(&directory) else { return Default::default() };
let Some(version) = meta.core.version else { return Default::default() };
let candidates = [directory.join("manifests").join(format!("update-{version}.json")), directory.join("manifests/base.json")];
for path in candidates {
let Ok(manifest) = crate::fsx::read_json::<serde_json::Value>(&path) else { continue };
if manifest.get("version").and_then(|value| value.as_str()) != Some(&version) { continue; }
if let Some(commits) = manifest.get("compatibility").and_then(|value| value.get("moduleCommits")).and_then(|value| value.as_object()) {
return commits.iter().filter_map(|(name, commit)| {
let commit = commit.as_str()?;
(commit.len() == 40 && commit.bytes().all(|byte| byte.is_ascii_hexdigit())).then(|| (name.clone(), commit.chars().take(8).collect()))
}).collect();
}
}
Default::default()
}
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let installed_commits = installed_module_commits(root);
let wildcard = crate::realms::state(root).map(|s| s.active == crate::realms::Mode::Wildcard).unwrap_or(true);
cat.iter()
.cloned()
@@ -141,6 +160,8 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let version = if e.id == "playerbots" { crate::squid::release(root).map(|release| {
[release.tag, release.commit.map(|commit| commit.chars().take(8).collect())].into_iter().flatten().collect::<Vec<_>>().join(" · ")
}) } else { None };
let key = match e.id.as_str() { "companions" => "bots", "playerbots" => "squid", "content-scaling" => "scaling", "custom-races" => "races", id => id };
let version = if installed { version.or_else(|| installed_commits.get(key).cloned()) } else { None };
ModuleView {
version,
compatibility: if blocked { "unsupported" } else if wildcard && e.id != "client-compat" { "experimental" } else { "compatible" }.into(),
@@ -203,6 +224,28 @@ pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
Some(lock)
} else { None };
if on { crate::realms::guard_module(root, id)?; }
if id == "custom-races" {
if let Ok(meta_content) = fs::read_to_string(meta.join("install.json")) {
if let Ok(install_meta) = serde_json::from_str::<crate::registry::InstallMeta>(&meta_content) {
if let Some(cp) = install_meta.client_path {
let client_path = PathBuf::from(cp);
if client_path.is_dir() {
crate::custom_races::set_client_patch_enabled(&client_path, on)?;
}
}
}
}
if !on {
let _ = crate::custom_races::sync_bot_races_config(root, false);
} else {
let allow = crate::custom_races::is_bot_custom_races_allowed(root).unwrap_or_else(|| {
read(&dir(root).join("coa_custom_races.conf"))
.and_then(|c| c.get("CoACustomRaces.BotsEnable").map(truthy))
.unwrap_or(false)
});
let _ = crate::custom_races::sync_bot_races_config(root, allow);
}
}
set_enabled_in(&catalog(), root, meta, id, on)
}
@@ -278,14 +321,27 @@ fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
}
}
}
let bot_custom_races_allowed = if id == "custom-races" {
crate::custom_races::is_bot_custom_races_allowed(root)
} else {
None
};
Ok(effective
.entries()
.map(|(k, v)| Setting {
key: k.to_string(),
value: fields.get(k).and_then(|field| field.default_if_missing.as_ref()).filter(|_| active.get(k).is_none()).and_then(crate::squid::scalar).unwrap_or_else(|| v.to_string()),
default: fields.get(k).and_then(|field| crate::squid::scalar(&field.default)).or_else(|| dist.as_ref().and_then(|d| d.get(k)).map(str::to_string)),
field: fields.get(k).cloned(),
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
.map(|(k, v)| {
let mut val = fields.get(k).and_then(|field| field.default_if_missing.as_ref()).filter(|_| active.get(k).is_none()).and_then(crate::squid::scalar).unwrap_or_else(|| v.to_string());
if k == "CoACustomRaces.BotsEnable" {
if let Some(allowed) = bot_custom_races_allowed {
val = if allowed { "1".into() } else { "0".into() };
}
}
Setting {
key: k.to_string(),
value: val,
default: fields.get(k).and_then(|field| crate::squid::scalar(&field.default)).or_else(|| dist.as_ref().and_then(|d| d.get(k)).map(str::to_string)),
field: fields.get(k).cloned(),
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
}
})
.collect())
}
@@ -341,6 +397,12 @@ fn save_settings_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, changes:
changed.push((key.clone(), value.to_string()));
}
}
if id == "custom-races" {
if let Some(bots_enable) = changes.get("CoACustomRaces.BotsEnable") {
let allow = truthy(bots_enable);
crate::custom_races::sync_bot_races_config(root, allow)?;
}
}
if changed.is_empty() {
return Ok(Vec::new());
}
@@ -384,6 +446,22 @@ mod tests {
(root, meta)
}
#[test]
fn module_revisions_come_from_the_installed_release_only() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
fs::create_dir_all(&root).unwrap();
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::Imported, &root);
meta.core.version = Some("2.0.0".into());
let directory = crate::registry::MetaDir::create(&root, &meta).unwrap();
let value = serde_json::json!({"version": "2.0.0", "compatibility": {"moduleCommits": {"races": "a".repeat(40), "bots": "b".repeat(40)}}});
fsx::atomic_write_json(&directory.root.join("manifests/update-2.0.0.json"), &value).unwrap();
assert_eq!(installed_module_commits(&root).get("races").map(String::as_str), Some("aaaaaaaa"));
let stale = serde_json::json!({"version": "1.0.0", "compatibility": {"moduleCommits": {"races": "c".repeat(40)}}});
fsx::atomic_write_json(&directory.root.join("manifests/update-2.0.0.json"), &stale).unwrap();
assert!(installed_module_commits(&root).is_empty());
}
#[test]
fn squid_missing_keys_use_code_defaults_and_saves_enforce_json_ranges() {
let d = tempfile::tempdir().unwrap();
@@ -660,4 +738,39 @@ mod tests {
assert!(fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("WarGames.Enable = 0"));
assert!(!list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled);
}
#[test]
fn custom_races_bot_settings_synchronize_playerbots_conf() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
let cat = catalog();
fs::write(dir(&root).join("coa_custom_races.conf.dist"), "CoACustomRaces.Enable = 1\nCoACustomRaces.BotsEnable = 0\n").unwrap();
fs::write(dir(&root).join("coa_custom_races.conf"), "CoACustomRaces.Enable = 1\nCoACustomRaces.BotsEnable = 0\n").unwrap();
fs::write(dir(&root).join("playerbots.conf"), "AiPlayerbot.Enabled = 1\n").unwrap();
// 1. Initially CoACustomRaces.BotsEnable is 0
let s = settings_in(&cat, &root, "custom-races").unwrap();
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "0");
// 2. Enable bots for custom races: should write experimental exclusions to playerbots.conf
let change_on = BTreeMap::from([("CoACustomRaces.BotsEnable".into(), "1".into())]);
assert_eq!(save_settings_in(&cat, &root, &meta, "custom-races", &change_on).unwrap(), ["CoACustomRaces.BotsEnable"]);
let pb = fs::read_to_string(dir(&root).join("playerbots.conf")).unwrap();
assert!(pb.contains("AiPlayerbot.ExcludedBotRaces"));
assert!(pb.contains(crate::custom_races::EXCLUDED_BOT_RACES_EXPERIMENTAL));
// Settings view now sees "1"
let s = settings_in(&cat, &root, "custom-races").unwrap();
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "1");
// 3. Disable bots for custom races: should write recommended exclusions to playerbots.conf
let change_off = BTreeMap::from([("CoACustomRaces.BotsEnable".into(), "0".into())]);
assert_eq!(save_settings_in(&cat, &root, &meta, "custom-races", &change_off).unwrap(), ["CoACustomRaces.BotsEnable"]);
let pb = fs::read_to_string(dir(&root).join("playerbots.conf")).unwrap();
assert!(pb.contains(crate::custom_races::EXCLUDED_BOT_RACES_RECOMMENDED));
// Settings view now sees "0"
let s = settings_in(&cat, &root, "custom-races").unwrap();
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "0");
}
}
+493
View File
@@ -0,0 +1,493 @@
use std::{collections::{BTreeMap, BTreeSet}, fs, path::{Path, PathBuf}};
use std::io::{BufReader, BufWriter, Write};
use serde::{Deserialize, Serialize};
use crate::{fsx, Error, Result};
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
pub(crate) struct Snapshot {
pub path: String,
pub files: BTreeMap<String, String>,
pub directories: BTreeSet<String>,
pub server_sha256: String,
#[serde(default)]
pub bytes: u64,
#[serde(default, skip_serializing_if = "Option::is_none")]
pub archive_sha256: Option<String>,
#[serde(default)]
pub expanded_bytes: u64,
}
fn reject_link(metadata: &fs::Metadata) -> Result<()> {
let linked = metadata.file_type().is_symlink();
#[cfg(windows)] let linked = { use std::os::windows::fs::MetadataExt; linked || metadata.file_attributes() & 0x400 != 0 };
if linked { return Err(Error::Invalid("Recovery copies cannot follow symbolic links or junctions.".into())); }
Ok(())
}
fn directories(root: &Path) -> Result<BTreeSet<String>> {
let canonical = fsx::canonicalize_lenient(root)?;
let root = canonical.as_path();
let mut result = BTreeSet::new();
let mut pending = vec![root.to_path_buf()];
while let Some(directory) = pending.pop() {
for entry in fs::read_dir(directory)? {
let entry = entry?;
reject_link(&fs::symlink_metadata(entry.path())?)?;
let path = fsx::ensure_within(root, &entry.path())?;
if entry.file_type()?.is_dir() {
let relative = path.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
result.insert(relative);
pending.push(path);
}
}
}
Ok(result)
}
fn copy_snapshot(point: &Path, snapshot: &Snapshot, target: &Path) -> Result<()> {
if snapshot.archive_sha256.is_some() {
verify(point, snapshot)?;
if target.exists() { return Err(Error::Invalid("The recovery destination already exists.".into())); }
let parent = target.parent().ok_or_else(|| Error::Invalid("Invalid recovery destination.".into()))?;
fs::create_dir_all(parent)?;
fsx::require_space(parent, snapshot.expanded_bytes)?;
fs::create_dir(target)?;
let input = fsx::ensure_within(point, &fsx::safe_join(point, &snapshot.path)?)?;
let decoder = zstd::Decoder::new(BufReader::new(fs::File::open(input)?))?;
let mut archive = tar::Archive::new(decoder);
let mut seen = BTreeSet::new();
let mut expanded = 0u64;
for entry in archive.entries()? {
let mut entry = entry?;
let name = entry.path()?.to_string_lossy().trim_end_matches('/').to_string();
if !seen.insert(name.clone()) { return Err(Error::Invalid("Duplicate entry in MySQL recovery archive.".into())); }
let output = fsx::ensure_within(target, &fsx::safe_join(target, &name)?)?;
if entry.header().entry_type().is_dir() && snapshot.directories.contains(&name) {
fs::create_dir_all(output)?;
} else if entry.header().entry_type().is_file() && snapshot.files.contains_key(&name) {
expanded = expanded.checked_add(entry.size()).filter(|bytes| *bytes <= snapshot.expanded_bytes)
.ok_or_else(|| Error::Invalid("MySQL recovery archive exceeds its declared size.".into()))?;
fs::create_dir_all(output.parent().unwrap())?;
let mut file = fs::OpenOptions::new().write(true).create_new(true).open(output)?;
if std::io::copy(&mut entry, &mut file)? != entry.size() { return Err(Error::Invalid("Truncated MySQL recovery file.".into())); }
file.flush()?;
} else { return Err(Error::Invalid("Unexpected entry in MySQL recovery archive.".into())); }
}
if expanded != snapshot.expanded_bytes || inventory(target)? != snapshot.files {
return Err(Error::Invalid("MySQL recovery files failed verification.".into()));
}
} else { copy_verified(&point.join(&snapshot.path), target, &snapshot.files)?; }
for directory in &snapshot.directories {
fs::create_dir_all(fsx::ensure_within(target, &fsx::safe_join(target, directory)?)?)?;
}
if directories(target)? != snapshot.directories { return Err(Error::Invalid("The recovery directory inventory differs.".into())); }
Ok(())
}
fn compress(source: &Path, point: &Path, snapshot: &mut Snapshot) -> Result<()> {
snapshot.path = "mysql-data.tar.zst".into();
let path = fsx::safe_join(point, &snapshot.path)?;
fs::create_dir_all(point)?;
fsx::require_space(point, snapshot.expanded_bytes)?;
let file = fs::OpenOptions::new().write(true).create_new(true).open(&path)?;
let encoder = zstd::Encoder::new(BufWriter::new(file), 3)?;
let mut archive = tar::Builder::new(encoder);
for directory in &snapshot.directories {
archive.append_dir(directory, fsx::ensure_within(source, &fsx::safe_join(source, directory)?)?)?;
}
for name in snapshot.files.keys() {
let input = fsx::ensure_within(source, &fsx::safe_join(source, name)?)?;
archive.append_file(name, &mut fs::File::open(input)?)?;
}
archive.into_inner()?.finish()?.flush()?;
snapshot.archive_sha256 = Some(fsx::sha256_file(&path)?);
snapshot.bytes = fs::metadata(path)?.len();
Ok(())
}
pub(crate) fn inventory(root: &Path) -> Result<BTreeMap<String, String>> {
let canonical = fsx::canonicalize_lenient(root)?;
let root = canonical.as_path();
let mut files = BTreeMap::new();
let mut directories = vec![root.to_path_buf()];
while let Some(directory) = directories.pop() {
for entry in fs::read_dir(directory)? {
let entry = entry?;
let metadata = fs::symlink_metadata(entry.path())?;
let path = fsx::ensure_within(root, &entry.path())?;
reject_link(&metadata)?;
if metadata.is_dir() { directories.push(path); continue; }
if !metadata.is_file() { return Err(Error::Invalid("Unsupported database snapshot file.".into())); }
let relative = path.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
fsx::safe_join(root, &relative)?;
if relative.ends_with(".isl") { return Err(Error::Invalid("External MySQL tablespaces require a separate recovery method.".into())); }
files.insert(relative, fsx::sha256_file(&path)?);
}
}
Ok(files)
}
pub(crate) fn copy_verified(source: &Path, target: &Path, files: &BTreeMap<String, String>) -> Result<()> {
if target.exists() { return Err(Error::Invalid("Database snapshot destination already exists.".into())); }
let bytes = files.keys().try_fold(0u64, |total, name| -> Result<u64> {
let path = fsx::ensure_within(source, &fsx::safe_join(source, name)?)?;
total.checked_add(fs::metadata(path)?.len()).ok_or_else(|| Error::Invalid("Snapshot size overflow.".into()))
})?;
let parent = target.parent().ok_or_else(|| Error::Invalid("Invalid snapshot destination.".into()))?;
fs::create_dir_all(parent)?;
fsx::require_space(parent, bytes)?;
fs::create_dir(target)?;
for (relative, expected) in files {
let source_file = fsx::ensure_within(source, &fsx::safe_join(source, relative)?)?;
let target_file = fsx::ensure_within(target, &fsx::safe_join(target, relative)?)?;
fs::create_dir_all(target_file.parent().unwrap())?;
fs::copy(&source_file, &target_file)?;
if fsx::sha256_file(&target_file)? != *expected { return Err(Error::Invalid(format!("Database snapshot file {relative} failed verification."))); }
}
if inventory(target)? != *files { return Err(Error::Invalid("Database snapshot inventory differs.".into())); }
Ok(())
}
pub(crate) fn stop(root: &Path) -> Result<()> {
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
if [observed.mysql.state, observed.auth.state, observed.world.state].iter().all(|state| *state == crate::process::ServiceState::Stopped)
&& !crate::multiworld::is_running(root) { return Ok(()); }
let outcome = crate::driver::run(root, crate::driver::Verb::StopAll)?;
let status = crate::process::observe(root, &crate::layout::read_ports(root));
if !outcome.ok || [status.mysql.state, status.auth.state, status.world.state].iter().any(|state| *state != crate::process::ServiceState::Stopped)
|| crate::multiworld::is_running(root) {
return Err(Error::Invalid("The complete server must be stopped before copying or restoring MySQL.".into()));
}
Ok(())
}
pub(crate) fn stop_previous_rehearsals(meta: &Path) -> Result<()> {
let location = meta.join("rehearsals");
if !location.exists() { return Ok(()); }
for entry in fs::read_dir(&location)? {
let entry = entry?;
let name = entry.file_name().to_string_lossy().into_owned();
if name.len() != 32 || !name.bytes().all(|byte| byte.is_ascii_hexdigit()) { continue; }
let fixture = fsx::ensure_within(&location, &entry.path().join("server"))?;
let metadata = crate::registry::metadata_dir_for(&fixture)?;
if !metadata.join("install.json").is_file() { continue; }
let (_, installed) = crate::registry::MetaDir::open(&metadata)?;
if fsx::canonicalize_lenient(Path::new(&installed.server_path))? != fsx::canonicalize_lenient(&fixture)? {
return Err(Error::Invalid("The interrupted rehearsal metadata does not match its private server.".into()));
}
stop(&fixture)?;
}
Ok(())
}
pub(crate) fn capture(root: &Path, partial: &Path) -> Result<Snapshot> {
if crate::docker::is_docker(root) || !cfg!(windows) { return Err(Error::Invalid("Cold MySQL snapshots require a Windows repack.".into())); }
crate::backup::with_database(root, |db| {
if db.query("SELECT COUNT(*) FROM performance_schema.replication_connection_configuration;")?.trim() != "0" {
return Err(Error::Invalid("A replicated MySQL instance requires a separate isolated recovery method.".into()));
}
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
for path in db.query("SELECT PATH FROM information_schema.INNODB_DATAFILES;")?.lines() {
fsx::ensure_within(&data, &data.join(path))?;
}
Ok(())
})?;
stop(root)?;
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
if !data.join("mysql").is_dir() || !data.join("ibdata1").is_file() {
return Err(Error::Invalid("The bundled MySQL data directory is incomplete.".into()));
}
let files = inventory(&data)?;
let bytes = files.keys().try_fold(0u64, |total, file| -> Result<u64> {
total.checked_add(fs::metadata(fsx::safe_join(&data, file)?)?.len()).ok_or_else(|| Error::Invalid("Snapshot size overflow.".into()))
})?;
let mut snapshot = Snapshot { path: "mysql-data".into(), files, directories:directories(&data)?, server_sha256: fsx::sha256_file(&root.join("mysql/bin/mysqld.exe"))?, bytes, expanded_bytes:bytes, archive_sha256:None };
compress(&data, partial, &mut snapshot)?;
verify(partial, &snapshot)?;
Ok(snapshot)
}
pub(crate) fn verify(point: &Path, snapshot: &Snapshot) -> Result<()> {
if snapshot.files.is_empty() || snapshot.server_sha256.len() != 64 {
return Err(Error::Invalid("Invalid cold MySQL recovery inventory.".into()));
}
let data = fsx::ensure_within(point, &fsx::safe_join(point, &snapshot.path)?)?;
if let Some(hash) = &snapshot.archive_sha256 {
if snapshot.path != "mysql-data.tar.zst" || snapshot.expanded_bytes == 0 || fsx::sha256_file(&data)? != *hash {
return Err(Error::Invalid("The compressed MySQL recovery copy is damaged.".into()));
}
for name in snapshot.files.keys().chain(snapshot.directories.iter()) { fsx::safe_join(point, name)?; }
return Ok(());
}
if snapshot.path != "mysql-data" { return Err(Error::Invalid("Unsupported MySQL recovery format.".into())); }
if inventory(&data)? != snapshot.files { return Err(Error::Invalid("The cold MySQL recovery copy is damaged or incomplete.".into())); }
if directories(&data)? != snapshot.directories { return Err(Error::Invalid("The cold MySQL recovery directories are incomplete.".into())); }
Ok(())
}
pub(crate) fn rehearsal_copy(root: &Path, meta: &Path, point: &Path, snapshot: &Snapshot) -> Result<PathBuf> {
verify(point, snapshot)?;
let canonical = fsx::canonicalize_lenient(root)?;
let root = canonical.as_path();
let destination = meta.join("rehearsals").join(uuid::Uuid::new_v4().simple().to_string()).join("server");
let mut files = BTreeMap::new();
let mut directories = vec![root.to_path_buf()];
while let Some(directory) = directories.pop() {
for entry in fs::read_dir(directory)? {
let entry = entry?;
let raw = entry.path();
let relative = raw.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
let lower = relative.to_ascii_lowercase();
let first = lower.split('/').next().unwrap();
if entry.file_type()?.is_dir() && !relative.contains('/')
&& !["core", "data", "scripts", "settings", "runtime", "mysql", ".realms", "bugreport", "extras", "licenses"].contains(&first) { continue; }
if lower == "mysql/data" || lower.starts_with("mysql/data-")
|| lower.split('/').any(|part| part == ".state")
|| lower == "bugreport/reports" || lower == "core/logs" || lower == "mysql/logs" { continue; }
let metadata = fs::symlink_metadata(&raw)?;
reject_link(&metadata)?;
let path = fsx::ensure_within(root, &raw)?;
if metadata.is_dir() { directories.push(path); }
else if metadata.is_file() { files.insert(relative, fsx::sha256_file(&path)?); }
else { return Err(Error::Invalid("Unsupported rehearsal file.".into())); }
}
}
copy_verified(root, &destination, &files)?;
copy_snapshot(point, snapshot, &destination.join("mysql/data"))?;
let (_, mut installed) = crate::registry::MetaDir::open(meta)?;
installed.id = uuid::Uuid::new_v4().to_string();
installed.server_path = destination.to_string_lossy().into_owned();
installed.client_path = None;
crate::registry::MetaDir::create(&destination, &installed)?;
Ok(destination)
}
pub(crate) fn isolate_connections(root: &Path) -> Result<()> {
for relative in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] {
let path = fsx::ensure_within(root, &root.join(relative))?;
if !path.is_file() {
if relative.ends_with(".template") { return Err(Error::Invalid("The private update copy lacks connection templates.".into())); }
continue;
}
let mut config = crate::config::parser::ConfFile::parse_bytes(&fs::read(&path)?)?;
for key in ["LoginDatabaseInfo", "WorldDatabaseInfo", "CharacterDatabaseInfo"] {
if relative.contains("worldserver") || key == "LoginDatabaseInfo" {
config.set(key, &format!("\"@{key}@\""), &[]);
}
}
config.set("BindIP", "\"127.0.0.1\"", &[]);
if relative.contains("worldserver") {
config.set("Ra.IP", "\"127.0.0.1\"", &[]);
config.set("DataDir", "\"@DATA@\"", &[]);
}
fsx::atomic_write(&path, config.to_text().as_bytes())?;
}
Ok(())
}
pub(crate) fn unchanged(root: &Path, snapshot: &Snapshot) -> Result<()> {
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
if inventory(&data)? != snapshot.files || directories(&data)? != snapshot.directories {
return Err(Error::Invalid("The installed database changed during the private rehearsal. Retry after stopping other database access.".into()));
}
Ok(())
}
pub(crate) fn validate_connections(templates: &Path, installation: &Path) -> Result<()> {
let port = crate::layout::read_ports(installation).mysql.to_string();
let (_, password) = crate::db::credentials(installation)?;
let realm = crate::realms::state(installation)?.active;
for relative in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template"] {
let path = fsx::ensure_within(templates, &templates.join(relative))?;
let config = crate::config::parser::ConfFile::parse_bytes(&fs::read(path)?)?;
for (key, kind) in [("LoginDatabaseInfo", "auth"), ("WorldDatabaseInfo", "world"), ("CharacterDatabaseInfo", "characters")] {
if relative.contains("authserver") && kind != "auth" { continue; }
let value = config.get(key).ok_or_else(|| Error::Invalid(format!("The update cannot isolate the missing {key} connection.")))?.trim().trim_matches('"');
if value == format!("@{key}@") { continue; }
let fields: Vec<_> = value.split(';').collect();
if fields.len() != 5 || !matches!(fields[0], "127.0.0.1" | "localhost") || fields[1] != port || fields[2] != "acore" || fields[3] != password || fields[4] != realm.schema(kind)? {
return Err(Error::Invalid(format!("The {key} connection does not use this repack's bundled database. A private update cannot safely qualify an external database.")));
}
}
}
Ok(())
}
// Keep the replaced data directory. If interrupted between renames, a retry can install a new verified copy.
pub(crate) fn swap(root: &Path, meta: &Path, point: &Path, snapshot: &Snapshot, fail_after_move: bool) -> Result<PathBuf> {
verify(point, snapshot)?;
if fsx::sha256_file(&root.join("mysql/bin/mysqld.exe"))? != snapshot.server_sha256 {
return Err(Error::Invalid("The MySQL executable differs from the recovery point.".into()));
}
let mysql = fsx::ensure_within(root, &root.join("mysql"))?;
let token = uuid::Uuid::new_v4().simple().to_string();
let staging = fsx::ensure_within(&mysql, &mysql.join(format!("data-restore-{token}")))?;
let previous = fsx::ensure_within(&mysql, &mysql.join(format!("data-before-restore-{token}")))?;
let live = fsx::ensure_within(&mysql, &mysql.join("data"))?;
copy_snapshot(point, snapshot, &staging)?;
let journal = meta.join("diagnostics").join(format!("database-restore-{token}.json"));
fsx::atomic_write_json(&journal, &serde_json::json!({"schema":1,"state":"prepared","previous":previous,"staging":staging}))?;
if live.exists() { fs::rename(&live, &previous)?; }
if fail_after_move { return Err(Error::Invalid("Simulated interruption after saving the previous MySQL directory.".into())); }
fs::rename(&staging, &live)?;
fsx::atomic_write_json(&journal, &serde_json::json!({"schema":1,"state":"restored","previous":previous}))?;
Ok(previous)
}
#[cfg(test)]
mod tests {
use super::*;
#[cfg(windows)]
#[test]
#[ignore = "requires COA_MYSQL_TEST_BIN pointing to the bundled MySQL tools"]
fn real_mysql_restores_objects_users_rows_and_missing_defaults() {
use std::process::{Child, Command, Stdio};
use std::os::windows::process::CommandExt;
struct Server(Child);
impl Drop for Server { fn drop(&mut self) { let _ = self.0.kill(); let _ = self.0.wait(); } }
let bin = PathBuf::from(std::env::var("COA_MYSQL_TEST_BIN").unwrap());
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
let meta = temp.path().join("metadata");
let point = temp.path().join("point");
copy_verified(&bin, &root.join("mysql/bin"), &inventory(&bin).unwrap()).unwrap();
let data = root.join("mysql/data");
let executable = root.join("mysql/bin/mysqld.exe");
let initialized = Command::new(&executable).args(["--no-defaults", "--initialize-insecure"])
.arg(format!("--datadir={}", data.display())).creation_flags(0x0800_0000).output().unwrap();
assert!(initialized.status.success(), "{}", String::from_utf8_lossy(&initialized.stderr));
let port = crate::install::free_port().unwrap();
fsx::atomic_write_json(&root.join("Settings/repack.json"), &serde_json::json!({"mysqlPort":port})).unwrap();
fsx::atomic_write_json(&root.join("Settings/database.json"), &serde_json::json!({"rootPassword":"","appPassword":""})).unwrap();
let db = crate::db::Db::from_repack(&root, crate::db::Account::Admin).unwrap();
let start = || {
let server = Server(Command::new(&executable).args(["--no-defaults", "--bind-address=127.0.0.1", "--mysqlx=0", "--skip-log-bin"])
.arg(format!("--datadir={}", data.display())).arg(format!("--port={port}"))
.arg(format!("--log-error={}", root.join("mysql-test.log").display()))
.stdout(Stdio::null()).stderr(Stdio::null()).creation_flags(0x0800_0000).spawn().unwrap());
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(60);
while !db.ping() { assert!(std::time::Instant::now() < deadline, "{}", fs::read_to_string(root.join("mysql-test.log")).unwrap_or_default()); std::thread::sleep(std::time::Duration::from_millis(200)); }
server
};
let mut server = start();
db.query("CREATE DATABASE acore_characters; CREATE DATABASE acore_world; CREATE DATABASE acore_auth; CREATE TABLE acore_characters.probe(id INT PRIMARY KEY, note VARCHAR(40)); CREATE TABLE acore_world.probe(id INT NOT NULL DEFAULT 0); INSERT INTO acore_world.probe VALUES(43); CREATE TABLE acore_auth.probe(id INT); INSERT INTO acore_auth.probe VALUES(44); CREATE USER 'fixture_user'@'localhost' IDENTIFIED BY 'fixture'; CREATE TRIGGER acore_characters.probe_insert BEFORE INSERT ON acore_characters.probe FOR EACH ROW SET NEW.note='triggered'; INSERT INTO acore_characters.probe VALUES(42,'original'); CREATE VIEW acore_characters.probe_view AS SELECT c.id,w.id AS world_id FROM acore_characters.probe c CROSS JOIN acore_world.probe w; CREATE PROCEDURE acore_characters.probe_proc() SELECT id FROM acore_characters.probe; CREATE FUNCTION acore_characters.probe_func() RETURNS INT DETERMINISTIC RETURN 73;").unwrap();
assert_eq!(db.recovery_objects("acore_characters").unwrap().len(), 4);
crate::schema_check::capture(&db, &root).unwrap();
let hash = fsx::sha256_file(&root.join(crate::schema_check::CONTRACT)).unwrap();
db.query("ALTER TABLE acore_world.probe ALTER COLUMN id DROP DEFAULT;").unwrap();
crate::schema_check::repair_missing_defaults(&db, &root, Some(&hash)).unwrap();
assert_eq!(db.query("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='acore_world' AND TABLE_NAME='probe' AND COLUMN_NAME='id';").unwrap(), "0");
assert_eq!(db.query("SELECT id FROM acore_world.probe;").unwrap(), "43");
db.query("ALTER TABLE acore_world.probe ALTER COLUMN id SET DEFAULT 99;").unwrap();
crate::schema_check::repair_missing_defaults(&db, &root, Some(&hash)).unwrap();
assert_eq!(db.query("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='acore_world' AND TABLE_NAME='probe' AND COLUMN_NAME='id';").unwrap(), "99");
db.query("SHUTDOWN;").unwrap(); server.0.wait().unwrap();
let files = inventory(&data).unwrap();
copy_verified(&data, &point.join("mysql-data"), &files).unwrap();
let expanded_bytes = files.keys().map(|name| fs::metadata(data.join(name)).unwrap().len()).sum();
let mut snapshot = Snapshot {path:"mysql-data".into(), files, directories:directories(&data).unwrap(), server_sha256:fsx::sha256_file(&executable).unwrap(), bytes:0, expanded_bytes, archive_sha256:None};
for directory in &snapshot.directories { fs::create_dir_all(point.join("mysql-data").join(directory)).unwrap(); }
compress(&data, &point, &mut snapshot).unwrap();
let mut changed = start();
db.query("DROP VIEW acore_characters.probe_view; DROP TRIGGER acore_characters.probe_insert; DROP PROCEDURE acore_characters.probe_proc; DROP FUNCTION acore_characters.probe_func; DELETE FROM acore_characters.probe; DROP USER 'fixture_user'@'localhost';").unwrap();
db.query("SHUTDOWN;").unwrap(); changed.0.wait().unwrap();
swap(&root, &meta, &point, &snapshot, false).unwrap();
let mut restored = start();
assert_eq!(db.recovery_objects("acore_characters").unwrap().len(), 4);
assert_eq!(db.query("SELECT * FROM acore_characters.probe_view; CALL acore_characters.probe_proc(); SELECT acore_characters.probe_func(); SELECT COUNT(*) FROM mysql.user WHERE user='fixture_user';").unwrap().replace("\r\n", "\n"), "42\t43\n42\n73\n1");
db.query("INSERT INTO acore_characters.probe VALUES(45,'check');").unwrap();
assert_eq!(db.query("SELECT note FROM acore_characters.probe WHERE id=45;").unwrap(), "triggered");
db.query("SHUTDOWN;").unwrap(); restored.0.wait().unwrap();
}
fn fixture() -> (tempfile::TempDir, PathBuf, PathBuf, PathBuf, Snapshot) {
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
let meta = temp.path().join("metadata");
let point = temp.path().join("point");
fsx::atomic_write(&root.join("mysql/bin/mysqld.exe"), b"same-engine").unwrap();
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"live").unwrap();
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"saved").unwrap();
fs::create_dir_all(point.join("mysql-data/empty_schema")).unwrap();
let snapshot = Snapshot { path:"mysql-data".into(), files:inventory(&point.join("mysql-data")).unwrap(), directories:directories(&point.join("mysql-data")).unwrap(), server_sha256:fsx::sha256_file(&root.join("mysql/bin/mysqld.exe")).unwrap(), bytes:5, expanded_bytes:5, archive_sha256:None };
(temp, root, meta, point, snapshot)
}
#[test]
fn interrupted_directory_swap_is_recoverable_and_keeps_previous_bytes() {
let (_temp, root, meta, point, snapshot) = fixture();
assert!(swap(&root, &meta, &point, &snapshot, true).is_err());
assert!(!root.join("mysql/data").exists());
let old = fs::read_dir(root.join("mysql")).unwrap().flatten().find(|e| e.file_name().to_string_lossy().starts_with("data-before-")).unwrap().path();
assert_eq!(fs::read(old.join("characters.ibd")).unwrap(), b"live");
swap(&root, &meta, &point, &snapshot, false).unwrap();
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"saved");
assert!(root.join("mysql/data/empty_schema").is_dir());
}
#[test]
fn corrupt_or_different_engine_snapshots_do_not_move_live_data() {
let (_temp, root, meta, point, snapshot) = fixture();
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"corrupt").unwrap();
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"live");
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"saved").unwrap();
fsx::atomic_write(&root.join("mysql/bin/mysqld.exe"), b"new-engine").unwrap();
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"live");
}
#[test]
fn compressed_snapshots_verify_every_file_and_reject_unlisted_entries() {
let (_temp, root, meta, point, mut snapshot) = fixture();
let source = point.join("mysql-data");
compress(&source, &point, &mut snapshot).unwrap();
assert!(snapshot.archive_sha256.is_some());
swap(&root, &meta, &point, &snapshot, false).unwrap();
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"saved");
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"preserve").unwrap();
let archive_path = point.join(&snapshot.path);
let encoder = zstd::Encoder::new(fs::File::create(&archive_path).unwrap(), 3).unwrap();
let mut archive = tar::Builder::new(encoder);
archive.append_file("unlisted.ibd", &mut fs::File::open(source.join("characters.ibd")).unwrap()).unwrap();
archive.into_inner().unwrap().finish().unwrap();
snapshot.archive_sha256 = Some(fsx::sha256_file(&archive_path).unwrap());
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"preserve");
fsx::atomic_write(&archive_path, b"damaged").unwrap();
assert!(verify(&point, &snapshot).is_err());
}
#[test]
fn private_rehearsals_reject_external_database_connections() {
let (_temp, root, _meta, _point, _snapshot) = fixture();
fsx::atomic_write_json(&root.join("Settings/repack.json"), &serde_json::json!({"mysqlPort":3307})).unwrap();
fsx::atomic_write_json(&root.join("Settings/database.json"), &serde_json::json!({"rootPassword":"test-root","appPassword":"test-app"})).unwrap();
fsx::atomic_write(&root.join("Settings/worldserver.conf.template"), b"LoginDatabaseInfo = \"@LoginDatabaseInfo@\"\nWorldDatabaseInfo = \"@WorldDatabaseInfo@\"\nCharacterDatabaseInfo = \"@CharacterDatabaseInfo@\"\n").unwrap();
fsx::atomic_write(&root.join("Settings/authserver.conf.template"), b"LoginDatabaseInfo = \"127.0.0.1;3307;acore;test-app;acore_auth\"\n").unwrap();
validate_connections(&root, &root).unwrap();
fsx::atomic_write(&root.join("Settings/authserver.conf.template"), b"LoginDatabaseInfo = \"192.0.2.1;3307;acore;test-app;acore_auth\"\n").unwrap();
let error = validate_connections(&root, &root).unwrap_err().to_string();
assert!(error.contains("external database"));
assert!(!error.contains("test-app"));
}
#[test]
fn a_changed_live_database_invalidates_the_rehearsal() {
let (_temp, root, _meta, _point, snapshot) = fixture();
assert!(unchanged(&root, &snapshot).is_err());
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"saved").unwrap();
fs::create_dir_all(root.join("mysql/data/empty_schema")).unwrap();
unchanged(&root, &snapshot).unwrap();
fsx::atomic_write(&root.join("mysql/data/extra.ibd"), b"new data").unwrap();
assert!(unchanged(&root, &snapshot).is_err());
}
#[test]
fn rehearsal_copy_succeeds_with_nested_directories_and_unnormalized_root() {
let (_temp, root, meta, point, snapshot) = fixture();
let meta_obj = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
fsx::atomic_write_json(&meta.join("install.json"), &meta_obj).unwrap();
fsx::atomic_write(&root.join("Core/worldserver.exe"), b"exe").unwrap();
fsx::atomic_write(&root.join("Core/configs/worldserver.conf"), b"conf").unwrap();
fsx::atomic_write(&root.join("Settings/repack.json"), b"{}").unwrap();
let dest = rehearsal_copy(&root, &meta, &point, &snapshot).unwrap();
assert_eq!(fs::read(dest.join("Core/configs/worldserver.conf")).unwrap(), b"conf");
assert_eq!(fs::read(dest.join("mysql/data/characters.ibd")).unwrap(), b"saved");
}
}
+2
View File
@@ -217,6 +217,7 @@ pub fn build(src: &Path, out: &Path, opts: &BuildOptions, progress: &dyn Fn(&str
split.close_current()?;
let manifest = Manifest {
compatibility: None,
schema: crate::manifest::SCHEMA,
kind: opts.kind,
version: opts.version.clone(),
@@ -503,6 +504,7 @@ mod tests {
fs::write(d.path().join(name), &bytes).unwrap();
let ok_sha = fsx::sha256_bytes(b"data");
let m = Manifest {
compatibility: None,
schema: 1,
kind: Kind::Base,
version: "0.1.0".into(),
+41
View File
@@ -0,0 +1,41 @@
//! Which kind of server a new installation is on this computer. This is the one place where the host decides: a Windows
//! computer installs a repack, anything else installs a Docker server. The screens and the commands ask here and then
//! call the code of that kind, so no platform check is scattered through shared code.
use serde::Serialize;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum Flavor {
/// The CoA Repack: Windows executables supervised by the repack's launcher.
Repack,
/// MySQL, the auth server and the world server in Docker containers.
Docker,
}
pub fn flavor() -> Flavor {
if cfg!(windows) {
Flavor::Repack
} else {
Flavor::Docker
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_host_decides_once() {
#[cfg(windows)]
assert_eq!(flavor(), Flavor::Repack);
#[cfg(not(windows))]
assert_eq!(flavor(), Flavor::Docker);
}
#[test]
fn the_screens_read_the_flavor_as_a_plain_word() {
assert_eq!(serde_json::to_string(&Flavor::Repack).unwrap(), "\"repack\"");
assert_eq!(serde_json::to_string(&Flavor::Docker).unwrap(), "\"docker\"");
}
}
+19 -1
View File
@@ -71,7 +71,15 @@ pub fn hardware() -> Hardware {
#[cfg(not(windows))]
pub fn hardware() -> Hardware {
Hardware { cores: std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(2), ram_gb: 8.0, free_ram_gb: 4.0 }
let (total, free) = std::fs::read_to_string("/proc/meminfo").ok().and_then(|t| parse_meminfo(&t)).unwrap_or((8.0, 4.0));
Hardware { cores: std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(2), ram_gb: total, free_ram_gb: free }
}
/// (total, available) memory in GB from the text of `/proc/meminfo`.
#[cfg(not(windows))]
fn parse_meminfo(text: &str) -> Option<(f64, f64)> {
let kb = |key: &str| -> Option<f64> { text.lines().find_map(|l| l.strip_prefix(key)?.trim().strip_suffix("kB")?.trim().parse::<f64>().ok()) };
Some((kb("MemTotal:")? / (1u64 << 20) as f64, kb("MemAvailable:")? / (1u64 << 20) as f64))
}
#[derive(Debug, Clone, Serialize)]
@@ -105,6 +113,16 @@ pub fn sizes(h: &Hardware) -> Vec<SizeOption> {
mod tests {
use super::*;
#[cfg(not(windows))]
#[test]
fn memory_is_read_from_proc_meminfo() {
let t = "MemTotal: 65536000 kB\nMemFree: 1000000 kB\nMemAvailable: 16777216 kB\nBuffers: 1 kB\n";
let (total, free) = parse_meminfo(t).unwrap();
assert!((total - 62.5).abs() < 0.01 && (free - 16.0).abs() < 0.01, "{total} {free}");
assert!(parse_meminfo("nothing useful").is_none());
assert!(hardware().ram_gb > 0.0);
}
#[test]
fn parses_counts_and_never_goes_negative() {
let p = parse_counts("12\t9\t400").unwrap();
+34 -1
View File
@@ -65,10 +65,16 @@ pub fn state(root: &Path) -> Result<RealmState> {
fsx::read_json(&root.join(STATE))
}
/// The world server executable of this folder: `worldserver.exe` in a repack, `worldserver` in a Docker server.
fn world_binary(root: &Path) -> std::path::PathBuf {
let exe = root.join("Core/worldserver.exe");
if exe.exists() { exe } else { root.join("Core/worldserver") }
}
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"))?
let supported = fs::read(world_binary(root))?
.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) })
}
@@ -269,6 +275,8 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
pub fn prepare_launcher(root: &Path) -> Result<()> {
// A Docker server has no launcher to adapt: the Docker backend reads the active realm itself.
if crate::docker::is_docker(root) { return Ok(()); }
let path = root.join("Scripts/manage.py");
let source = fs::read_to_string(&path)?;
let patched = patch_launcher(&source)?;
@@ -353,6 +361,31 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
mod tests {
use super::*;
#[test]
fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Core")).unwrap();
fs::create_dir_all(d.path().join("Settings")).unwrap();
fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
fs::write(d.path().join("Core/worldserver"), b"ELF...Wildcard synergy settings...").unwrap();
assert!(view(d.path()).unwrap().supported, "worldserver without .exe is read too");
fs::write(d.path().join("Core/worldserver"), b"ELF...an older build").unwrap();
assert!(!view(d.path()).unwrap().supported);
// The repack's executable still wins when both exist, so a repack is read as before.
fs::write(d.path().join("Core/worldserver.exe"), b"MZ...Wildcard synergy settings").unwrap();
assert!(view(d.path()).unwrap().supported);
}
#[test]
fn a_docker_server_has_no_launcher_to_adapt() {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Settings")).unwrap();
// No Scripts/manage.py anywhere: on a repack this fails, on a Docker server there is nothing to do.
assert!(prepare_launcher(d.path()).is_err());
fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
prepare_launcher(d.path()).unwrap();
}
#[test]
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
let mut f = Files::new();
+36 -3
View File
@@ -44,8 +44,17 @@ fn introduction_rank(repo: &Path, pathspecs: &[&str]) -> std::collections::HashM
rank
}
/// Every SQL script of a core checkout (released + pending updates, module base and update scripts), in application order.
/// Incremental SQL of a core checkout. Installation-only module bases must never be replayed on a live database.
pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
collect_core_sql_mode(core, false)
}
/// A clean installation also needs the module tables and initial seed data.
pub fn collect_core_install_sql(core: &Path) -> Result<Vec<SqlFile>> {
collect_core_sql_mode(core, true)
}
fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>> {
let mut out = Vec::new();
let mut push = |db: &str, id: String, abs: PathBuf, origin: String| -> Result<()> {
let sha256 = fsx::sha256_file(&abs)?;
@@ -69,7 +78,7 @@ pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
let mname = name.replace('-', "_");
for kind in ["auth", "characters", "world"] {
let base = m.path().join(format!("data/sql/db-{kind}"));
for f in sql_in(&base.join("base")) {
for f in if include_base { sql_in(&base.join("base")) } else { vec![] } {
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
let rel = format!("modules/{name}/data/sql/db-{kind}/base/{}", f.file_name().unwrap().to_string_lossy());
push(kind, format!("mod_{mname}__base__{stem}"), f, rel)?;
@@ -144,6 +153,9 @@ fn walk(root: &Path, dir: &Path, out: &mut Vec<String>) -> Result<()> {
/// Build a cumulative update: every file of `tree` that differs from the base, plus every SQL script. Unsigned.
pub fn pack_update(p: &UpdateParams, progress: &dyn Fn(&str)) -> Result<Manifest> {
if let Some(file) = p.sql.iter().find(|file| file.id.starts_with("mod_") && file.id.contains("__base__")) {
return Err(Error::Invalid(format!("Module installation SQL {} cannot be included in an update package.", file.id)));
}
let base: BTreeMap<String, &str> = p.base_manifest.files.iter().map(|f| (f.path.to_lowercase(), f.sha256.as_str())).collect();
let work = p.out.with_file_name(format!("{}-staging", p.out.file_name().unwrap().to_string_lossy()));
let _ = fs::remove_dir_all(&work);
@@ -218,7 +230,7 @@ mod tests {
write(c, "data/sql/updates/db_characters/2026_01_02_00.sql", "SELECT 3;");
write(c, "modules/mod-x/data/sql/db-world/base/01_a.sql", "SELECT 4;");
write(c, "modules/mod-x/data/sql/db-world/2026_02_02_00_b.sql", "SELECT 5;");
let v = collect_core_sql(c).unwrap();
let v = collect_core_install_sql(c).unwrap();
let ids: Vec<(&str, &str)> = v.iter().map(|f| (f.db.as_str(), f.id.as_str())).collect();
assert!(ids.contains(&("world", "2026_01_01_00")) && ids.contains(&("world", "rev_1")) && ids.contains(&("characters", "2026_01_02_00")));
assert!(ids.contains(&("world", "mod_mod_x__base__01_a")) && ids.contains(&("world", "mod_mod_x__2026_02_02_00_b")));
@@ -226,6 +238,27 @@ mod tests {
let base_pos = ids.iter().position(|x| x.1 == "mod_mod_x__base__01_a").unwrap();
let upd_pos = ids.iter().position(|x| x.1 == "mod_mod_x__2026_02_02_00_b").unwrap();
assert!(base_pos < upd_pos, "a module's base script precedes its updates");
let updates = collect_core_sql(c).unwrap();
assert!(!updates.iter().any(|f| f.id.contains("__base__")));
assert!(updates.iter().any(|f| f.id == "mod_mod_x__2026_02_02_00_b"));
}
#[test]
fn update_packaging_rejects_module_seed_sql_before_creating_output() {
let d = tempfile::tempdir().unwrap();
let base: Manifest = serde_json::from_value(serde_json::json!({
"schema": 1, "kind": "base", "version": "1.0.0", "core": {"commit": null},
"builtAt": "test", "minManagerVersion": "0.1.0", "files": []
})).unwrap();
let out = d.path().join("out");
let sql = vec![SqlFile { db: "world".into(), id: "mod_mod_raid__base__03_boss_schedule".into(),
origin: "modules/mod-raid/data/sql/db-world/base/03_boss_schedule.sql".into(),
abs: d.path().join("seed.sql"), sha256: "a".repeat(64) }];
let result = pack_update(&UpdateParams { tree: d.path(), base_manifest: &base, sql: &sql,
out: &out, version: "1.1.0".into(), core_commit: None, bots_commit: None, part_size: 1024 }, &|_| {});
assert!(result.unwrap_err().to_string().contains("installation SQL"));
assert!(!out.exists());
assert!(!d.path().join("out-staging").exists());
}
#[test]
+215 -1
View File
@@ -5,6 +5,90 @@ use crate::{backup, fsx, install, manifest::{Kind, Migration}, migrations, packa
const MARKER: &str = ".release-schema-fixture";
struct QualificationEnv<'a>(crate::update::RepackEnv<'a>);
impl crate::update::Env for QualificationEnv<'_> {
fn activate(&self) -> Result<()> { Ok(()) }
fn ensure_stopped(&self) -> Result<()> { self.0.ensure_stopped() }
fn preflight(&self, manifest: &crate::manifest::Manifest) -> Result<()> { self.0.preflight(manifest) }
fn snapshot(&self) -> Result<String> { self.0.snapshot() }
fn verify_snapshot(&self, id: &str) -> Result<()> { self.0.verify_snapshot(id) }
fn rehearse(&self, manifest: &crate::manifest::Manifest, tree: &Path, items: &[crate::update::PlanItem], point: &str) -> Result<()> { self.0.rehearse(manifest, tree, items, point) }
fn restore_snapshot(&self, id: &str) -> Result<()> { self.0.restore_snapshot(id) }
fn migrate(&self, manifest: &crate::manifest::Manifest, staged: &Path) -> Result<crate::migrations::ApplyReport> { self.0.migrate(manifest, staged) }
fn validate(&self) -> Result<()> { self.0.validate() }
fn validate_recovery(&self) -> Result<()> { self.0.validate_recovery() }
fn recover_validation(&self) -> Result<()> { self.0.recover_validation() }
fn automatic_rollback(&self) -> bool { true }
// Health checks use the normal private validation; qualification never opens game ports after commit.
}
pub fn qualify_upgrade(base: &Path, source: &Path, candidate: &Path, fixture: &Path, trusted_key: &str) -> Result<serde_json::Value> {
use crate::update::Env;
if !cfg!(windows) { return Err(Error::Invalid("Manager upgrade qualification requires a Windows fixture.".into())); }
if fixture.exists() || !fixture.file_name().is_some_and(|name| name.to_string_lossy().starts_with("coa-schema-fixture-")) {
return Err(Error::Invalid("Upgrade qualification requires a new disposable coa-schema-fixture-* directory.".into()));
}
let fixture_root = std::path::absolute(fixture)?;
let fixture = fixture_root.as_path();
let base_root = fsx::canonicalize_lenient(base)?;
let base = base_root.as_path();
let source_root = fsx::canonicalize_lenient(source)?;
let source = source_root.as_path();
let candidate_root = fsx::canonicalize_lenient(candidate)?;
let candidate = candidate_root.as_path();
let metadata = crate::registry::metadata_dir_for(fixture)?;
if metadata.exists() { return Err(Error::Invalid("Upgrade fixture metadata already exists.".into())); }
let (base_manifest, base_bytes) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(base.into()), trusted_key)?;
let (source_manifest, source_bytes) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(source.into()), trusted_key)?;
let (candidate_manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(candidate.into()), trusted_key)?;
if candidate_manifest.kind != Kind::Update || !matches!(source_manifest.kind, Kind::Base | Kind::Update)
|| (source_manifest.kind == Kind::Base && fsx::sha256_bytes(&base_bytes) != fsx::sha256_bytes(&source_bytes)) {
return Err(Error::Invalid("Invalid source or candidate package for upgrade qualification.".into()));
}
extract_base(base, fixture, trusted_key)?;
package::extract_selected(base, &base_manifest, fixture, &|path| path.starts_with("Data/"), &|_, _| {})?;
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, fixture);
meta.core.version = Some(base_manifest.version.clone());
meta.core.commit = base_manifest.core.commit.clone();
meta.original_hashes = base_manifest.files.iter().map(|file| (file.path.clone(), file.sha256.clone())).collect();
crate::registry::MetaDir::create(fixture, &meta)?;
let env = QualificationEnv(crate::update::RepackEnv { root: fixture, meta_dir: &metadata });
let apply = |package: &Path| -> Result<()> {
let outcome = crate::update::apply(&crate::update::Params {
root: fixture, meta_dir: &metadata, source: pkgsource::Source::Dir(package.into()),
trusted_key, cancel: crate::download::Cancel::default(), resolutions: Default::default(),
env: &env, fail_after_ops: None,
}, &|_, _| {})?;
if outcome.txn.state != crate::update::State::Committed {
return Err(Error::Invalid("Upgrade qualification did not commit.".into()));
}
env.ensure_stopped()
};
install::with_scratch_ports(fixture, || {
if source_manifest.kind == Kind::Update { apply(source)?; }
let user_file = fixture.join("Core/configs/coa-qualification-user.conf");
let user_bytes = b"Qualification.UserSetting = 7391\r\n";
fsx::atomic_write(&user_file, user_bytes)?;
apply(candidate)?;
if std::fs::read(&user_file)?.as_slice() != user_bytes {
return Err(Error::Invalid("The update changed a user configuration file.".into()));
}
let (_, installed) = crate::registry::MetaDir::open(&metadata)?;
if installed.core.version.as_deref() != Some(candidate_manifest.version.as_str())
|| crate::update_isolation::pending(&metadata) || crate::update::pending_checked(&metadata)?.is_some() {
return Err(Error::Invalid("The update left inconsistent metadata or an unfinished transaction.".into()));
}
Ok(())
})?;
Ok(serde_json::json!({
"schema": 1, "result": "passed", "fromVersion": source_manifest.version,
"toVersion": candidate_manifest.version, "fromManifestSha256": fsx::sha256_bytes(&source_bytes),
"fromSchemaSha256": source_manifest.files.iter().find(|file| file.path == schema_check::CONTRACT).map(|file| &file.sha256),
"checks": ["manager-transaction", "private-user-database-rehearsal", "database-schema", "private-auth-world-startup", "existing-identities", "user-file-preservation"],
}))
}
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)?); }
@@ -38,7 +122,12 @@ pub fn extract_base(source: &Path, fixture: &Path, trusted_key: &str) -> Result<
["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)
// A Linux computer has no Windows database program: the fixture is a Docker server over the package's data directory.
if cfg!(windows) {
install::bootstrap_database(fixture)
} else {
crate::docker::fixture::prepare(fixture)
}
}
pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<()> {
@@ -67,6 +156,69 @@ pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<(
}))
}
pub fn validate_startup(fixture: &Path, tree: &Path, base: &Path, trusted_key: &str) -> Result<()> {
use crate::update::Env;
if !cfg!(windows) {
return Err(Error::Invalid("Repack startup qualification requires a Windows runner.".into()));
}
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("Startup qualification requires a disposable release-schema fixture.".into()));
}
let fixture_root = fsx::canonicalize_lenient(fixture)?;
let fixture = fixture_root.as_path();
let tree_root = fsx::canonicalize_lenient(tree)?;
let tree = tree_root.as_path();
let metadata = crate::registry::metadata_dir_for(fixture)?;
if metadata.exists() { return Err(Error::Invalid("Startup fixture already has Manager metadata; use a fresh fixture.".into())); }
schema_check::require_release_contract(tree)?;
for name in ["worldserver.exe", "authserver.exe"] {
if !tree.join("Core").join(name).is_file() {
return Err(Error::Invalid(format!("Startup candidate is missing {name}.")));
}
}
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(base.into()), trusted_key)?;
if manifest.kind != Kind::Base { return Err(Error::Invalid("Startup qualification requires a signed base package.".into())); }
let mut directories = vec![tree.to_path_buf()];
let mut files = Vec::new();
while let Some(directory) = directories.pop() {
for entry in std::fs::read_dir(directory)? {
let entry = entry?;
let kind = entry.file_type()?;
if kind.is_symlink() { return Err(Error::Invalid("Startup release tree must not contain symbolic links.".into())); }
let path = entry.path();
fsx::ensure_within(tree, &path)?;
if kind.is_dir() { directories.push(path); continue; }
if !kind.is_file() { return Err(Error::Invalid("Startup release tree contains an unsupported file type.".into())); }
let relative = path.strip_prefix(tree).map_err(|e| Error::Invalid(e.to_string()))?.to_path_buf();
let first = relative.components().next().unwrap().as_os_str().to_string_lossy();
if !matches!(first.as_ref(), "Core" | "Scripts" | "Data" | "Extras" | "Licenses") {
return Err(Error::Invalid("Startup release tree contains installation-specific files.".into()));
}
fsx::ensure_within(fixture, &fixture.join(&relative))?;
files.push(relative);
}
}
package::extract_selected(base, &manifest, fixture, &|path| path.starts_with("Data/"), &|_, _| {})?;
for relative in files {
let target = fsx::ensure_within(fixture, &fixture.join(&relative))?;
fsx::atomic_write(&target, &std::fs::read(tree.join(&relative))?)?;
let expected = fsx::sha256_file(&tree.join(relative))?;
if fsx::sha256_file(&target)? != expected {
return Err(Error::Invalid("Startup candidate copy failed verification.".into()));
}
}
let meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, fixture);
crate::registry::MetaDir::create(fixture, &meta)?;
let env = crate::update::RepackEnv { root: fixture, meta_dir: &metadata };
env.validate()?;
env.ensure_stopped()?;
if crate::update_isolation::pending(&metadata) {
return Err(Error::Invalid("Startup qualification left unfinished isolated validation.".into()));
}
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) {
@@ -78,12 +230,49 @@ pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
Ok(())
}
pub fn verify_upgrade_fixture(dir: &Path, trusted_key: &str) -> Result<()> {
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
if !matches!(manifest.kind, Kind::Base | Kind::Update) {
return Err(Error::Invalid("Upgrade fixtures must be base or server update packages.".into()));
}
let scratch = tempfile::tempdir()?;
package::extract_selected(dir, &manifest, scratch.path(), &|path| path == schema_check::CONTRACT, &|_, _| {})?;
if manifest.kind == Kind::Update || manifest.files.iter().any(|file| file.path == 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 relative_startup_fixture_targets_replace_the_original_location() {
let directory = tempfile::Builder::new().prefix("coa-schema-fixture-path-test-").tempdir_in(".").unwrap();
let current = std::env::current_dir().unwrap();
let relative = directory.path().strip_prefix(&current).unwrap();
fsx::atomic_write(&relative.join("Core/worldserver.exe"), b"old").unwrap();
let root = fsx::canonicalize_lenient(relative).unwrap();
let target = fsx::ensure_within(&root, &root.join("Core/worldserver.exe")).unwrap();
fsx::atomic_write(&target, b"candidate").unwrap();
assert_eq!(std::fs::read(relative.join("Core/worldserver.exe")).unwrap(), b"candidate");
assert!(!root.join(relative).join("Core/worldserver.exe").exists());
}
#[test]
fn startup_qualification_refuses_real_server_folders_before_writes() {
let directory = tempfile::tempdir().unwrap();
let server = directory.path().join("live-server");
std::fs::create_dir(&server).unwrap();
fsx::atomic_write(&server.join("owner-data"), b"untouched").unwrap();
assert!(validate_startup(&server, directory.path(), directory.path(), "unused").is_err());
assert_eq!(std::fs::read(server.join("owner-data")).unwrap(), b"untouched");
assert!(!crate::registry::metadata_dir_for(&server).unwrap().exists());
}
#[test]
fn signed_packages_must_carry_a_real_complete_schema_contract() {
let dir = tempfile::tempdir().unwrap();
@@ -122,6 +311,31 @@ mod tests {
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!(qualify_upgrade(dir.path(), dir.path(), dir.path(), dir.path(), "irrelevant").is_err());
assert!(!dir.path().join(schema_check::CONTRACT).exists());
}
#[test]
fn only_legacy_base_fixtures_may_omit_the_schema_contract() {
let dir = tempfile::tempdir().unwrap();
let tree = dir.path().join("tree");
let out = dir.path().join("package");
fsx::atomic_write(&tree.join("Core/example.txt"), b"fixture").unwrap();
let key = SigningKey::from_bytes(&[29; 32]);
let public = STANDARD.encode(key.verifying_key().as_bytes());
let options = package::BuildOptions { kind: Kind::Base, version: "0.2.0".into(), core_commit: None, bots_commit: None, built_at: "test".into(), part_size: 1024 * 1024, migrations: vec![] };
package::build(&tree, &out, &options, &|_| {}).unwrap();
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();
};
sign();
verify_upgrade_fixture(&out, &public).unwrap();
assert!(verify_package(&out, &public).is_err());
let mut manifest: serde_json::Value = fsx::read_json(&out.join("manifest.json")).unwrap();
manifest["kind"] = "update".into();
fsx::atomic_write_json(&out.join("manifest.json"), &manifest).unwrap();
sign();
assert!(verify_upgrade_fixture(&out, &public).is_err());
}
}
+87 -1
View File
@@ -39,6 +39,35 @@ pub fn require_release_contract(root: &Path) -> Result<Contract> {
#[derive(Debug, Serialize)]
pub struct Problem { pub database: String, pub table: String, pub column: String, pub detail: String }
/// Keep all differences for support; never change a database to match a contract automatically.
pub fn check_with_report(db: &Db, root: &Path) -> Result<Vec<Problem>> {
let problems = check(db, root)?;
if problems.is_empty() { return Ok(problems); }
let report = serde_json::json!({
"schema": 1, "checkedAt": chrono::Utc::now().to_rfc3339(),
"realm": db.realm().name(), "problems": problems,
});
let path = crate::registry::metadata_dir_for(root)?.join("diagnostics")
.join(format!("schema-validation-{}-{}.json", db.realm().name(), uuid::Uuid::new_v4()));
// A log write failure must neither hide the original mismatch nor accept an invalid schema.
if let Err(error) = fsx::atomic_write_json(&path, &report) {
tracing::warn!(%error, path = %path.display(), "Could not save database schema report");
}
Ok(problems)
}
fn describe_signature(signature: &str) -> String {
let fields: Vec<_> = signature.split('|').collect();
if fields.len() != 4 { return signature.into(); }
let decode = |value: &str| -> String {
if value == "<NULL>" { return "no default".into(); }
if value == "<NONE>" { return "none".into(); }
hex::decode(value).ok().and_then(|bytes| String::from_utf8(bytes).ok())
.map(|text| format!("{text:?}")).unwrap_or_else(|| value.into())
};
format!("type={}, nullable={}, default={}, extra={}", fields[0], fields[1], decode(fields[2]), decode(fields[3]))
}
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;"))?;
@@ -56,6 +85,46 @@ pub fn capture(db: &Db, root: &Path) -> Result<()> {
fsx::atomic_write_json(&root.join(CONTRACT), &Contract { schema: 1, columns })
}
fn missing_default(expected: &str, actual: &str) -> Option<String> {
let expected: Vec<_> = expected.split('|').collect();
let actual: Vec<_> = actual.split('|').collect();
if expected.len() != 4 || actual.len() != 4 || expected[0] != actual[0]
|| expected[1] != "NO" || actual[1] != "NO" || expected[3] != "<NONE>" || actual[3] != "<NONE>"
|| actual[2] != "<NULL>" || matches!(expected[2], "<NULL>" | "<NONE>") { return None; }
String::from_utf8(hex::decode(expected[2]).ok()?).ok()
}
/// Only restore a missing literal default from the exact signed target contract. Never alter data or custom defaults.
pub(crate) fn repair_missing_defaults(db: &Db, root: &Path, signed_hash: Option<&str>) -> Result<()> {
let Some(signed_hash) = signed_hash else { return Ok(()); };
if fsx::sha256_file(&root.join(CONTRACT))? != signed_hash {
return Err(crate::Error::Invalid("The target schema contract differs from the signed update.".into()));
}
let contract = require_release_contract(root)?;
let mut repaired = Vec::new();
let quote = |identifier: &str| format!("`{}`", identifier.replace('`', "``"));
for (kind, tables) in &contract.columns {
let schema = db.realm_schema(crate::db::schema_of(kind)?);
let actual = read_columns(db, kind)?;
let base_tables: BTreeSet<_> = db.tables(crate::db::schema_of(kind)?)?.into_iter().collect();
for (table, columns) in tables {
if !base_tables.contains(table) { continue; }
if matches!(table.as_str(), "updates" | "updates_include" | "coa_manager_migrations") { continue; }
for (column, expected) in columns {
let Some(found) = actual.get(table).and_then(|columns| columns.get(column)) else { continue; };
let Some(value) = missing_default(expected, found) else { continue; };
db.query(&format!("SET SESSION sql_mode=CONCAT_WS(',',@@SESSION.sql_mode,'NO_BACKSLASH_ESCAPES'); ALTER TABLE {}.{} ALTER COLUMN {} SET DEFAULT '{}';", quote(schema), quote(table), quote(column), value.replace('\'', "''")))?;
repaired.push(serde_json::json!({"database":schema,"table":table,"column":column,"action":"restore-missing-default"}));
}
}
}
if !repaired.is_empty() {
let path = crate::registry::metadata_dir_for(root)?.join("diagnostics").join(format!("database-repair-{}.json", uuid::Uuid::new_v4()));
fsx::atomic_write_json(&path, &serde_json::json!({"schema":1,"checkedAt":chrono::Utc::now().to_rfc3339(),"contractSha256":signed_hash,"repairs":repaired}))?;
}
Ok(())
}
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))?;
@@ -98,7 +167,7 @@ pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
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()) });
problems.push(Problem { database: kind.clone(), table: table.clone(), column: column.clone(), detail: found.map(|s| format!("Expected {}, found {}", describe_signature(want), describe_signature(s))).unwrap_or_else(|| "Missing column".into()) });
}
}
}
@@ -146,6 +215,23 @@ fn missing_coa_starts(rows: &str) -> Vec<Problem> {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn default_repair_only_accepts_missing_literal_defaults_without_other_schema_changes() {
assert_eq!(missing_default("int unsigned|NO|30|<NONE>", "int unsigned|NO|<NULL>|<NONE>"), Some("0".into()));
for actual in ["int unsigned|NO|3939|<NONE>", "int|NO|<NULL>|<NONE>", "int unsigned|YES|<NULL>|<NONE>", "int unsigned|NO|<NULL>|6175746f5f696e6372656d656e74"] {
assert!(missing_default("int unsigned|NO|30|<NONE>", actual).is_none());
}
assert!(missing_default("timestamp|NO|43555252454e545f54494d455354414d50|44454641554c545f47454e455241544544", "timestamp|NO|<NULL>|<NONE>").is_none());
assert!(missing_default("int|NO|zz|<NONE>", "int|NO|<NULL>|<NONE>").is_none());
}
#[test]
fn schema_defaults_are_readable_and_not_conflated() {
assert_eq!(describe_signature("int unsigned|NO|30|<NONE>"), "type=int unsigned, nullable=NO, default=\"0\", extra=none");
assert!(describe_signature("int unsigned|NO|<NULL>|<NONE>").contains("default=no default"));
assert!(describe_signature("varchar(8)|YES||<NONE>").contains("default=\"\""));
assert_eq!(describe_signature("legacy"), "legacy");
}
#[test]
fn a_release_cannot_use_a_partial_or_empty_schema_contract() {
+562 -79
View File
@@ -85,9 +85,14 @@ fn legacy_databases_started() -> bool { true }
/// Everything the transaction needs from the outside world; tests provide a fake.
pub trait Env {
fn activate(&self) -> Result<()> { Ok(()) }
fn recover_validation(&self) -> Result<()> { Ok(()) }
fn automatic_rollback(&self) -> bool { false }
fn validate_recovery(&self) -> Result<()> { self.validate() }
fn ensure_stopped(&self) -> Result<()>;
fn preflight(&self, _manifest: &Manifest) -> Result<()> { Ok(()) }
fn verify_snapshot(&self, _id: &str) -> Result<()> { Ok(()) }
fn rehearse(&self, _manifest: &Manifest, _tree: &Path, _items: &[PlanItem], _point: &str) -> Result<()> { Ok(()) }
/// Create a recovery point for the databases and configuration; returns its id.
fn snapshot(&self) -> Result<String>;
fn restore_snapshot(&self, id: &str) -> Result<()>;
@@ -177,6 +182,9 @@ pub fn unfinished(meta: &Path) -> Option<Txn> {
}
pub fn ensure_recovered(meta: &Path) -> Result<()> {
if crate::update_isolation::pending(meta) {
return Err(Error::Invalid("Interrupted startup validation must be recovered before starting the server.".into()));
}
if let Some(t) = pending_checked(meta)? {
return Err(Error::Invalid(format!("Resolve unfinished update {} before changing or starting the server.", t.id)));
}
@@ -283,16 +291,29 @@ pub enum DatabaseAccess {
OnlyIfRunning,
}
/// The update packages are those of the Windows repack (executables, a bundled MySQL, a launcher): applying one to a Docker
/// server would put Windows files in a Linux server folder. Updating a Docker server is separate work.
fn refuse_for_docker(root: &Path) -> Result<()> {
if crate::docker::is_docker(root) {
return Err(Error::Invalid("Updates are not available for Docker servers yet.".into()));
}
Ok(())
}
/// Describe the update; a managed launcher may need a one-time authenticated payload check.
pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>) -> Result<Preview> {
preview_with(root, meta, source, trusted_key, resolutions, DatabaseAccess::Start)
}
pub fn preview_with(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>, access: DatabaseAccess) -> Result<Preview> {
refuse_for_docker(root)?;
let meta_dir = crate::registry::metadata_dir_for(root)?;
let _lock = operation_lock(&meta_dir)?;
ensure_recovered(&meta_dir)?;
let observed_version = MetaDir::open(&meta_dir)?.1.core.version;
let (m, _) = fetch_manifest(source, trusted_key)?;
let _lock = operation_lock_for(&meta_dir, "checking updates", false)?;
ensure_recovered(&meta_dir)?;
let (_, current_meta) = MetaDir::open(&meta_dir)?;
let meta = if current_meta.core.version != observed_version { &current_meta } else { meta };
check_manifest(&m)?;
reject_downgrade(meta, &m)?;
let mut items = plan(root, meta, &m, resolutions, None)?;
@@ -350,6 +371,15 @@ fn launcher_already_integrated(root: &Path, meta_dir: &Path, meta: &InstallMeta,
}
fn reject_downgrade(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
if let Some(c) = &manifest.compatibility {
let platform = if cfg!(windows) { "windows-x86_64" } else { "linux-x86_64" };
if c.platform != platform {
return Err(Error::Invalid(format!("This package targets {} rather than {platform}.", c.platform)));
}
if meta.core.version.as_ref().is_none_or(|version| version != &manifest.version && !c.source_versions.contains(version)) {
return Err(Error::Invalid("This server version is outside the release's tested compatibility matrix.".into()));
}
}
if let Some(installed) = meta.core.version.as_deref() {
if let (Some(have), Some(candidate)) = (crate::manifest::parse_version(installed), crate::manifest::parse_version(&manifest.version)) {
if candidate < have {
@@ -370,6 +400,11 @@ fn check_manifest(m: &Manifest) -> Result<()> {
Ok(())
}
pub fn validate_candidate(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
check_manifest(manifest)?;
reject_downgrade(meta, manifest)
}
pub struct Params<'a> {
pub root: &'a Path,
pub meta_dir: &'a Path,
@@ -396,6 +431,7 @@ fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) {
/// Run the whole update. On failure before the new build is validated the files are rolled back automatically;
/// 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> {
refuse_for_docker(p.root)?;
let (root, meta_dir) = (p.root, p.meta_dir);
let _lock = operation_lock(meta_dir)?;
ensure_recovered(meta_dir)?;
@@ -461,6 +497,14 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
txn.recovery_point = Some(p.env.snapshot().map_err(|e| Error::Invalid(format!("The update was not applied because the safety backup failed: {e}")))?);
let point_meta = crate::backup::point_json(meta_dir, txn.recovery_point.as_deref().unwrap())?;
if point_meta.is_file() { txn.recovery_hashes.insert("@point".into(), fsx::sha256_file(&point_meta)?); }
save(meta_dir, &txn)?;
step(report, "Testing the update on a private copy of your server", 54);
if let Err(error) = p.env.rehearse(&m, &tree, &items, txn.recovery_point.as_deref().unwrap()) {
txn.state = State::Failed;
txn.message = Some(format!("The private update rehearsal failed: {error}. The installed server was not updated."));
save(meta_dir, &txn)?;
return Err(Error::Invalid(txn.message.unwrap()));
}
txn.ops = items
.iter()
@@ -484,7 +528,7 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
// MySQL DDL can commit before a later statement fails. Restore the full recovery point on failure.
let mut migrated = None;
if !m.migrations.is_empty() {
if !m.migrations.is_empty() || m.files.iter().any(|file| file.path == crate::schema_check::CONTRACT) {
step(report, "Updating the database", 75);
txn.databases_started = true;
save(meta_dir, &txn)?;
@@ -503,7 +547,14 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
}
step(report, "Starting the updated server", 85);
// Core startup can apply SQL and write character data even when the package has no explicit migrations.
txn.databases_started = true;
save(meta_dir, &txn)?;
if let Err(e) = p.env.validate() {
if p.env.automatic_rollback() {
return fail_after_apply(p, &mut txn, &before, &tree,
format!("The updated server did not start correctly: {e}"), migrated);
}
txn.state = State::NeedsDecision;
txn.message = Some(format!("The updated server did not start correctly: {e}"));
save(meta_dir, &txn)?;
@@ -511,6 +562,7 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
}
finish(root, meta_dir, &mut meta, &m, &tree, &mut txn)?;
p.env.activate()?;
step(report, "Done", 100);
let _ = archive;
Ok(Outcome { txn, migrations: migrated })
@@ -583,17 +635,24 @@ pub fn retry_validation(root: &Path, meta_dir: &Path, id: &str, fallback: &Sourc
}
let (_, mut meta) = MetaDir::open(meta_dir)?;
finish(root, meta_dir, &mut meta, &manifest, &dir.join("tree"), &mut txn)?;
env.activate()?;
Ok(txn)
}
fn fail_after_apply(p: &Params, txn: &mut Txn, before: &Path, tree: &Path, why: String, report: Option<ApplyReport>) -> Result<Outcome> {
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);
let restored = restore_transaction(p.root, p.meta_dir, before, txn, p.env).and_then(|()| {
if p.env.automatic_rollback() { p.env.validate_recovery() } else { Ok(()) }
});
if restored.is_err() { let _ = p.env.ensure_stopped(); }
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.message = Some(match &restored { Ok(()) => why.clone(), Err(e) => format!("{why} Recovery failed: {e}") });
save(p.meta_dir, txn)?;
if restored.is_ok() { let _ = fs::remove_dir_all(tree); }
if restored.is_ok() {
let _ = fs::remove_dir_all(tree);
if p.env.automatic_rollback() { p.env.activate()?; }
}
let _ = report;
Err(Error::Invalid(match restored {
Ok(()) if txn.databases_started => format!("{why} The server files and databases were restored to the recovery point."),
@@ -617,6 +676,7 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
}
if !before.join("manager-install.json").is_file() { return Err(Error::Invalid("The saved installation metadata is missing; no restoration was started.".into())); }
env.ensure_stopped()?;
env.recover_validation()?;
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)?;
@@ -630,6 +690,25 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
}
fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn: &mut Txn, meta_dir: &Path, fail_after: Option<usize>) -> Result<()> {
if fail_after == Some(0) && !txn.ops.is_empty() {
return Err(Error::Invalid("simulated failure".into()));
}
let entries: BTreeMap<_, _> = files.iter().map(|entry| (entry.path.as_str(), entry)).collect();
// Prepare every recovery copy before changing any destination. One durable journal
// can then cover the entire file phase: recovery restores old files even if their
// replacement was not reached, and removes newly created files only by exact hash.
// Rewriting the full journal twice per file makes large navigation updates quadratic.
for op in &txn.ops {
let target = fsx::ensure_within(root, &fsx::safe_join(root, &op.path)?)?;
if op.had_previous {
let keep = fsx::safe_join(before, &op.path)?;
fs::create_dir_all(keep.parent().unwrap())?;
fsx::atomic_write(&keep, &fs::read(&target)?)?;
txn.recovery_hashes.insert(op.path.clone(), fsx::sha256_file(&keep)?);
}
}
for op in &mut txn.ops { op.started = true; }
save(meta_dir, txn)?;
let mut completed = 0usize;
for i in 0..txn.ops.len() {
if fail_after == Some(completed) {
@@ -638,17 +717,7 @@ fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn:
let (path, action) = (txn.ops[i].path.clone(), txn.ops[i].action);
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
let staged = fsx::safe_join(tree, &path)?;
let entry = files.iter().find(|f| f.path == path).expect("listed");
if target.is_file() {
let keep = fsx::safe_join(before, &path)?;
fs::create_dir_all(keep.parent().unwrap())?;
fsx::atomic_write(&keep, &fs::read(&target)?)?;
txn.recovery_hashes.insert(path.clone(), fsx::sha256_file(&keep)?);
}
// 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)?;
let entry = entries.get(path.as_str()).expect("listed");
fs::create_dir_all(target.parent().unwrap())?;
match action {
Action::Create | Action::Replace => {
@@ -673,10 +742,9 @@ fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn:
Action::Skip | Action::Conflict => {}
}
txn.ops[i].done = true;
save(meta_dir, txn)?;
completed += 1;
}
Ok(())
save(meta_dir, txn)
}
/// Put every touched file back the way it was. Files created by the update (no previous version) are removed only if
@@ -700,6 +768,7 @@ fn restore_files(root: &Path, before: &Path, txn: &mut Txn) -> Result<()> {
/// 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> {
refuse_for_docker(root)?;
let _lock = operation_lock(meta_dir)?;
let mut txn = load(meta_dir, id)?;
if matches!(txn.state, State::Committed | State::RolledBack) {
@@ -714,11 +783,26 @@ pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result
}
pub(crate) fn operation_lock(meta_dir: &Path) -> Result<fs::File> {
operation_lock_for(meta_dir, "server maintenance", false)
}
pub(crate) fn operation_lock_for(meta_dir: &Path, operation: &str, wait_for_check: bool) -> 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()));
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(30);
loop {
if fs4::fs_std::FileExt::try_lock_exclusive(&lock)? { break; }
let owner = fsx::read_json::<serde_json::Value>(&meta_dir.join("update-lock-owner.json")).ok();
let checking = owner.as_ref().and_then(|owner| owner.get("operation")).and_then(|value| value.as_str()) == Some("checking updates");
if wait_for_check && checking && std::time::Instant::now() < deadline {
std::thread::sleep(std::time::Duration::from_millis(100));
continue;
}
let details = owner.as_ref().and_then(|owner| Some(format!(" Operation: {}; Manager process: {}; started: {}.", owner.get("operation")?.as_str()?, owner.get("pid")?.as_u64()?, owner.get("started")?.as_str()?))).unwrap_or_default();
return Err(Error::Invalid(format!("Another update, repair or recovery is in progress.{details} Wait for that operation to finish, then retry.")));
}
let record = serde_json::json!({"operation": operation, "pid": std::process::id(), "started": chrono::Utc::now().to_rfc3339()});
fsx::atomic_write_json(&meta_dir.join("update-lock-owner.json"), &record)?;
Ok(lock)
}
@@ -803,13 +887,27 @@ impl RepackEnv<'_> {
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())); }
if let Some(snapshot) = &point.mysql_snapshot {
if fsx::sha256_file(&self.root.join("mysql/bin/mysqld.exe"))? != snapshot.server_sha256 {
return Err(Error::Invalid("The MySQL executable differs from the recovery point.".into()));
}
return Ok(());
}
crate::backup::with_database(self.root, |db| {
let db = db.clone().for_realm(crate::realms::Mode::Coa);
let mut objects = Vec::new();
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.")));
objects.extend(db.recovery_objects(schema)?);
}
if !objects.is_empty() {
let path = self.meta_dir.join("diagnostics").join(format!("database-recovery-{}.json", uuid::Uuid::new_v4()));
let report = serde_json::json!({ "schema": 1, "checkedAt": chrono::Utc::now().to_rfc3339(), "recoveryPoint": point.id, "objects": objects });
if let Err(error) = fsx::atomic_write_json(&path, &report) {
tracing::warn!(%error, "Could not save database recovery compatibility report");
}
let sample = objects.iter().take(3).map(|object| format!("{}.{} ({})", object["database"].as_str().unwrap_or("?"), object["name"].as_str().unwrap_or("?"), object["kind"].as_str().unwrap_or("?"))).collect::<Vec<_>>().join(", ");
return Err(Error::Invalid(format!("Automatic recovery does not support {} database objects: {sample}. Export diagnostics for the complete list. The update was not started.", objects.len())));
}
Ok(())
})
@@ -827,7 +925,116 @@ impl RepackEnv<'_> {
}
impl Env for RepackEnv<'_> {
fn recover_validation(&self) -> Result<()> {
crate::update_isolation::restore(self.root, self.meta_dir)
}
fn activate(&self) -> Result<()> {
ensure_recovered(self.meta_dir)?;
let outcome = crate::driver::validate_update(self.root)?;
if outcome.ok { Ok(()) } else {
Err(Error::Invalid(format!("The update transaction finished, but the server could not start: {}", crate::driver::startup_failure(self.root, &outcome))))
}
}
fn automatic_rollback(&self) -> bool { true }
fn rehearse(&self, manifest: &Manifest, tree: &Path, items: &[PlanItem], id: &str) -> Result<()> {
if items.iter().any(|item| item.action != Action::Skip && item.path.to_ascii_lowercase().starts_with("mysql/")) {
return Err(Error::Invalid("A server update cannot replace MySQL while using a cold recovery copy; a separate database engine upgrade is required.".into()));
}
let point = crate::backup::get(self.meta_dir, id)?;
let Some(snapshot) = &point.mysql_snapshot else {
// Docker uses its separate experimental release channel until its clone runner is qualified.
if crate::docker::is_docker(self.root) { return Ok(()); }
return Err(Error::Invalid("This installation has no complete MySQL recovery copy for an update rehearsal.".into()));
};
crate::mysql_snapshot::validate_connections(self.root, self.root)?;
crate::mysql_snapshot::stop(self.root)?;
let point_dir = crate::backup::point_json(self.meta_dir, id)?.parent().unwrap().to_path_buf();
let fixture = crate::mysql_snapshot::rehearsal_copy(self.root, self.meta_dir, &point_dir, snapshot)?;
let metadata = crate::registry::metadata_dir_for(&fixture)?;
let env = RepackEnv { root: &fixture, meta_dir: &metadata };
let result = crate::install::with_scratch_ports(&fixture, || {
let mut txn = Txn { id: "rehearsal".into(), state: State::Applying, from_version: None,
to_version: manifest.version.clone(), recovery_point: None, databases_started: false,
ops: items.iter().filter(|item| item.action != Action::Skip).map(|item| Op {
path: item.path.clone(), action: item.action, reason: item.reason.clone(),
new_sha256: manifest.files.iter().find(|file| file.path == item.path).unwrap().sha256.clone(),
had_previous: fsx::safe_join(&fixture, &item.path).is_ok_and(|path| path.is_file()), started:false, done:false,
}).collect(), message:None, recovery_hashes:BTreeMap::new() };
let before = txn_dir(&metadata, &txn.id)?.join("before");
fs::create_dir_all(&before)?;
apply_ops(&fixture, tree, &before, &manifest.files, &mut txn, &metadata, None)?;
crate::mysql_snapshot::validate_connections(&fixture, self.root)?;
crate::mysql_snapshot::isolate_connections(&fixture)?;
let identities = crate::backup::with_database(&fixture, |db| {
let identities = database_identities(db)?;
let realms = crate::realms::state(&fixture)?;
let mut modes = vec![realms.active];
if realms.wildcard_created { modes.push(if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa }); }
for (index, mode) in modes.into_iter().enumerate() {
let db = db.clone().for_realm(mode);
crate::schema_check::repair_missing_defaults(&db, &fixture, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
let list: Vec<_> = manifest.migrations.iter().filter(|migration| index == 0 || migration.db != "auth").cloned().collect();
let report = crate::migrations::apply_pending(&db, &list, &tree.join("_migrations"), &|| Ok("private rehearsal".into()))?;
if let Some((migration, error)) = report.failed { return Err(Error::Invalid(format!("Rehearsal migration {migration} failed: {error}"))); }
crate::schema_check::repair_missing_defaults(&db, &fixture, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
}
verify_database_identities(db, &identities)?;
Ok(identities)
})?;
env.validate()?;
crate::backup::with_database(&fixture, |db| verify_database_identities(db, &identities))?;
env.ensure_stopped()
});
let stopped = crate::mysql_snapshot::stop(&fixture);
let live_state = if result.is_ok() { crate::mysql_snapshot::stop(self.root).and_then(|()| crate::mysql_snapshot::unchanged(self.root, snapshot)) } else { Ok(()) };
let logs: BTreeMap<_, _> = ["Core/Logs/auth-console.log", "Core/Logs/world-console.log", "Core/Logs/supervisor.log", "mysql/logs/mysql-error.log"].into_iter()
.map(|path| (path, crate::diag::redact(&crate::health::tail(&fixture.join(path), 32768)))).collect();
let mut schema_reports = Vec::<serde_json::Value>::new();
if let Ok(entries) = fs::read_dir(metadata.join("diagnostics")) {
for entry in entries.flatten().filter(|entry| entry.file_name().to_string_lossy().starts_with("schema-validation-")) {
let path = fsx::ensure_within(&metadata, &entry.path())?;
if fs::metadata(&path)?.len() <= 4 * 1024 * 1024 { schema_reports.push(fsx::read_json(&path)?); }
}
}
let report = serde_json::json!({"schema":1,"checkedAt":chrono::Utc::now().to_rfc3339(),"toVersion":manifest.version,"recoveryPoint":id,
"result":if result.is_ok() && stopped.is_ok() && live_state.is_ok() {"passed"} else {"failed"}, "error":result.as_ref().err().map(ToString::to_string), "stopError":stopped.as_ref().err().map(ToString::to_string), "liveStateError":live_state.as_ref().err().map(ToString::to_string), "logs":logs,"schemaReports":schema_reports,"fixture":fixture});
let report_path = self.meta_dir.join("diagnostics").join(format!("database-rehearsal-{}.json", uuid::Uuid::new_v4()));
fsx::atomic_write_json(&report_path, &report)?;
stopped?;
let parent = fixture.parent().unwrap();
let owned = fsx::ensure_within(&self.meta_dir.join("rehearsals"), parent)?;
fs::remove_dir_all(owned)?;
live_state?;
result
}
fn preflight(&self, manifest: &Manifest) -> Result<()> {
crate::mysql_snapshot::stop_previous_rehearsals(self.meta_dir)?;
if let Some(compatibility) = &manifest.compatibility {
let (_, meta) = MetaDir::open(self.meta_dir)?;
if let Some(source) = meta.core.version.as_ref().and_then(|v| compatibility.source_databases.get(v)) {
if let Some(expected) = &source.schema_sha256 {
let contract = self.root.join("Scripts/database-schema.json");
if fsx::sha256_file(&contract)? != *expected {
return Err(Error::Invalid("The installed database schema contract differs from the qualified upgrade source; repair the installation first.".into()));
}
}
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(problem) = crate::schema_check::check_with_report(&db.clone().for_realm(mode), self.root)?.first() {
if crate::docker::is_docker(self.root) {
return Err(Error::Invalid(format!("The installed {} database does not match its upgrade source: {}.{}: {}", mode.name(), problem.database, problem.table, problem.detail)));
}
tracing::warn!(realm = mode.name(), table = %problem.table, "Installed schema differs; the private candidate rehearsal must qualify this database");
}
}
Ok(())
})?;
}
}
self.pending_migrations(manifest).map(|_| ())
}
@@ -861,6 +1068,13 @@ impl Env for RepackEnv<'_> {
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()));
}
if let Some(snapshot) = &point.mysql_snapshot {
crate::mysql_snapshot::stop(self.root)?;
let point_dir = crate::backup::point_json(self.meta_dir, id)?.parent().unwrap().to_path_buf();
crate::mysql_snapshot::swap(self.root, self.meta_dir, &point_dir, snapshot, false)?;
crate::backup::restore_configs(self.root, self.meta_dir, id)?;
return Ok(());
}
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
crate::backup::restore_database(self.root, self.meta_dir, id, &component.name)?;
}
@@ -872,12 +1086,17 @@ impl Env for RepackEnv<'_> {
let root = self.root;
crate::backup::with_database(root, |db| {
let realms = crate::realms::state(root)?;
if let Some(contract) = manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT) {
self.migration_snapshot()?;
crate::schema_check::repair_missing_defaults(db, root, Some(&contract.sha256))?;
}
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);
crate::schema_check::repair_missing_defaults(&other_db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
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, &|| {
@@ -888,13 +1107,15 @@ impl Env for RepackEnv<'_> {
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() {
crate::schema_check::repair_missing_defaults(&other_db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
if let Some(p) = crate::schema_check::check_with_report(&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)?;
crate::schema_check::repair_missing_defaults(db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
let problems = crate::schema_check::check_with_report(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())));
}
@@ -904,61 +1125,111 @@ impl Env for RepackEnv<'_> {
}
fn validate(&self) -> Result<()> {
use crate::process::{observe, ServiceState};
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 healthy = started.ok && {
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
let mut ready_since = None;
loop {
let o = observe(self.root, &ports);
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) {
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 {
break false;
}
std::thread::sleep(std::time::Duration::from_secs(2));
}
};
if healthy {
return Ok(());
}
let cause = crate::driver::startup_failure(self.root, &started);
// Leave the files unlocked so that a rollback can replace them.
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
Err(Error::Invalid(cause))
self.validate_server(true)
}
fn validate_recovery(&self) -> Result<()> {
self.validate_server(false)
}
}
impl RepackEnv<'_> {
fn validate_server(&self, check_schema: bool) -> Result<()> {
let stopped = crate::driver::run(self.root, crate::driver::Verb::StopAll)?;
if !stopped.ok { return Err(Error::Invalid("Could not stop the server before isolated validation.".into())); }
self.ensure_stopped()?;
self.recover_validation()?;
let result = (|| -> Result<()> {
crate::update_isolation::begin(self.root, self.meta_dir)?;
use crate::process::{observe, ServiceState};
if check_schema { 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_with_report(&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 healthy = started.ok && {
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
let mut ready_since = None;
loop {
let o = observe(self.root, &ports);
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) {
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 {
break false;
}
std::thread::sleep(std::time::Duration::from_secs(2));
}
};
if healthy {
return Ok(());
}
let cause = crate::driver::startup_failure(self.root, &started);
// Leave the files unlocked so that a rollback can replace them.
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
Err(Error::Invalid(cause))
})();
let stopped = crate::driver::run(self.root, crate::driver::Verb::StopAll)?;
if !stopped.ok {
return Err(Error::Invalid("Isolated validation could not stop the server; recovery configurations were preserved.".into()));
}
self.ensure_stopped()?;
self.recover_validation()?;
result
}
}
fn database_identities(db: &crate::db::Db) -> Result<BTreeMap<String, std::collections::BTreeSet<String>>> {
let db = db.clone().for_realm(crate::realms::Mode::Coa);
let mut identities = BTreeMap::new();
for (schema, table, columns) in [
("acore_characters", "characters", "guid,account,HEX(name)"),
("acore_characters_wildcard", "characters", "guid,account,HEX(name)"),
("acore_auth", "account", "id,HEX(username)"),
] {
if !db.schema_exists(schema)? || !db.tables(schema)?.iter().any(|name| name == table) { continue; }
let rows = db.query(&format!("SELECT {columns} FROM `{schema}`.`{table}`;"))?;
identities.insert(schema.into(), rows.lines().map(str::to_string).collect());
}
Ok(identities)
}
fn verify_database_identities(db: &crate::db::Db, before: &BTreeMap<String, std::collections::BTreeSet<String>>) -> Result<()> {
let after = database_identities(db)?;
for (schema, expected) in before {
if after.get(schema).is_none_or(|actual| !expected.is_subset(actual)) {
return Err(Error::Invalid(format!("The private update changed or removed existing character or account identities in {schema}.")));
}
}
Ok(())
}
#[cfg(test)]
@@ -971,6 +1242,11 @@ mod tests {
use std::cell::{Cell, RefCell};
struct Fake {
activation_expected: RefCell<Option<(PathBuf, String)>>,
activation_failed: Cell<bool>,
activated: Cell<bool>,
automatic_rollback: Cell<bool>,
recovery_healthy: Cell<bool>,
stopped: Cell<bool>,
healthy: Cell<bool>,
snapshot_ok: Cell<bool>,
@@ -978,15 +1254,32 @@ mod tests {
migrate_fail: Cell<bool>,
preflight_fail: Cell<bool>,
restore_fail: Cell<bool>,
rehearsal_fail: Cell<bool>,
}
impl 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), preflight_fail: Cell::new(false), restore_fail: Cell::new(false) }
Fake { activation_expected: RefCell::new(None), activation_failed: Cell::new(false), activated: Cell::new(false), automatic_rollback: Cell::new(false), recovery_healthy: Cell::new(true), stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false), preflight_fail: Cell::new(false), restore_fail: Cell::new(false), rehearsal_fail: Cell::new(false) }
}
}
impl Env for Fake {
fn rehearse(&self, _: &Manifest, _: &Path, _: &[PlanItem], _: &str) -> Result<()> {
if self.rehearsal_fail.get() { Err(Error::Invalid("SQL failed in the private copy".into())) } else { Ok(()) }
}
fn activate(&self) -> Result<()> {
if let Some((meta, version)) = self.activation_expected.borrow().as_ref() {
ensure_recovered(meta)?;
assert_eq!(MetaDir::open(meta)?.1.core.version.as_ref(), Some(version));
}
self.activated.set(true);
if self.activation_failed.get() { Err(Error::Invalid("Public startup failed".into())) } else { Ok(()) }
}
fn automatic_rollback(&self) -> bool { self.automatic_rollback.get() }
fn validate_recovery(&self) -> Result<()> {
self.calls.borrow_mut().push("validate-recovery");
if self.recovery_healthy.get() { Ok(()) } else { Err(Error::Invalid("Restored server is unhealthy".into())) }
}
fn preflight(&self, _: &Manifest) -> Result<()> {
if self.preflight_fail.get() { Err(Error::Invalid("Conflicting migration history".into())) } else { Ok(()) }
}
@@ -1083,6 +1376,25 @@ mod tests {
w
}
#[test]
fn startup_waits_for_an_update_check_but_not_for_active_maintenance() {
let temp = tempfile::tempdir().unwrap();
let checker = operation_lock_for(temp.path(), "checking updates", false).unwrap();
let root = temp.path().to_path_buf();
let release = std::thread::spawn(move || {
std::thread::sleep(std::time::Duration::from_millis(150));
drop(checker);
});
let start = operation_lock_for(&root, "starting server", true).unwrap();
release.join().unwrap();
let error = operation_lock(&root).unwrap_err().to_string();
assert!(error.contains("starting server"));
assert!(error.contains(&std::process::id().to_string()));
drop(start);
// Stale owner metadata is harmless once the OS lock is released.
operation_lock(&root).unwrap();
}
#[test]
fn legacy_manager_realm_launcher_is_replaced_during_update() {
let w = legacy_launcher_world(false);
@@ -1142,6 +1454,27 @@ mod tests {
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
}
#[test]
fn a_docker_server_is_never_given_the_repack_files() {
// Found by trying the installer: the update check of a Docker server read the Windows channel and offered its files.
let w = world(&[], false);
write(&w.root, "Settings/docker.json", br#"{"project":"t1"}"#);
let before = read(&w, "Core/worldserver.exe");
let meta = InstallMeta::new(InstallKind::New, &w.root);
let err = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap_err();
assert!(err.to_string().contains("Docker"), "{err}");
let err = run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err();
assert!(err.to_string().contains("Docker"), "{err}");
assert!(rollback(&w.root, &w.meta, "any", &Fake::ok()).is_err());
assert_eq!(read(&w, "Core/worldserver.exe"), before, "nothing was touched");
assert!(!w.root.join("Core/newfile.dll").exists());
// The same package is applied to the same folder once it is not a Docker server.
fs::remove_file(w.root.join("Settings/docker.json")).unwrap();
assert_eq!(run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap().txn.state, State::Committed);
}
#[test]
fn happy_path_replaces_creates_merges_and_records_ownership() {
let w = world(&[], false);
@@ -1162,6 +1495,26 @@ mod tests {
assert!(!w.root.join("Core/worldserver.exe.coa-new").exists());
}
#[test]
fn public_startup_requires_a_completed_transaction_and_saved_version() {
let w = world(&[], false);
let env = Fake::ok();
*env.activation_expected.borrow_mut() = Some((w.meta.clone(), "2.0.0".into()));
run(&w, &env, BTreeMap::new(), None).unwrap();
assert!(env.activated.get());
}
#[test]
fn startup_failure_after_commit_does_not_restore_a_live_database() {
let w = world(&[], true);
let env = Fake::ok();
env.activation_failed.set(true);
assert!(run(&w, &env, BTreeMap::new(), None).is_err());
assert!(ensure_recovered(&w.meta).is_ok());
assert_eq!(MetaDir::open(&w.meta).unwrap().1.core.version.as_deref(), Some("2.0.0"));
assert!(!env.calls.borrow().contains(&"restore-databases"));
}
#[test]
fn an_integrated_launcher_is_current_but_user_edits_and_new_package_bytes_are_not() {
let source = b"import sys\nfrom pathlib import Path\nfrom squid_playerbots import configure\nROOT = Path(__file__).resolve().parents[1]\n";
@@ -1236,6 +1589,46 @@ mod tests {
assert_eq!(fs::read(saved).unwrap(), b"my-custom-build", "the replaced custom build is kept for rollback");
}
#[test]
fn power_loss_during_bulk_files_restores_written_and_unwritten_files() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("root");
let meta = d.path().join("meta");
let tree = d.path().join("tree");
let before = meta.join("updates/bulk/before");
let mut files = Vec::new();
let mut ops = Vec::new();
for (path, previous) in [("Data/maps/first.map", true), ("Data/maps/new.map", false), ("Data/maps/last.map", true)] {
if previous { write(&root, path, b"old"); }
write(&tree, path, b"new");
let hash = fsx::sha256_file(&tree.join(path)).unwrap();
files.push(FileEntry { path: path.into(), sha256: hash.clone(), size: 3, policy: ReplacePolicy::Replace, owner: crate::manifest::Owner::Core });
ops.push(Op { path: path.into(), action: if previous { Action::Replace } else { Action::Create }, reason: None,
new_sha256: hash, had_previous: previous, started: false, done: false });
}
let mut txn = Txn { id: "bulk".into(), state: State::Applying, from_version: Some("1".into()), to_version: "2".into(),
recovery_point: None, databases_started: false, ops, message: None, recovery_hashes: BTreeMap::new() };
fs::create_dir_all(before.parent().unwrap()).unwrap();
assert!(apply_ops(&root, &tree, &before, &files, &mut txn, &meta, Some(2)).is_err());
// A power loss sees the pre-write checkpoint, not the in-memory completed flags.
let mut durable = load(&meta, "bulk").unwrap();
assert!(durable.ops.iter().all(|op| op.started && !op.done));
assert_eq!(fs::read(root.join("Data/maps/last.map")).unwrap(), b"old");
restore_files(&root, &before, &mut durable).unwrap();
assert_eq!(fs::read(root.join("Data/maps/first.map")).unwrap(), b"old");
assert_eq!(fs::read(root.join("Data/maps/last.map")).unwrap(), b"old");
assert!(!root.join("Data/maps/new.map").exists());
// If preparing any recovery copy fails, no destination may be changed.
for op in &mut durable.ops { op.started = false; op.done = false; }
durable.recovery_hashes.clear();
save(&meta, &durable).unwrap();
fs::remove_file(root.join("Data/maps/last.map")).unwrap();
assert!(apply_ops(&root, &tree, &before, &files, &mut durable, &meta, None).is_err());
assert_eq!(fs::read(root.join("Data/maps/first.map")).unwrap(), b"old");
assert!(!root.join("Data/maps/new.map").exists());
assert!(load(&meta, "bulk").unwrap().ops.iter().all(|op| !op.started));
}
#[test]
fn failure_in_the_middle_of_applying_restores_every_file_byte_for_byte() {
for fail_after in [0usize, 1, 2] {
@@ -1271,6 +1664,79 @@ mod tests {
assert!(rollback(&w.root, &w.meta, &out.txn.id, &env).is_err(), "already rolled back");
}
#[test]
fn automatic_health_failure_restores_databases_files_and_checks_recovery() {
let w = world(&[], true);
let env = Fake::ok();
env.automatic_rollback.set(true);
env.healthy.set(false);
assert!(run(&w, &env, BTreeMap::new(), None).unwrap_err().to_string().contains("restored"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(!w.root.join("Core/newfile.dll").exists());
assert!(env.calls.borrow().contains(&"restore-databases"));
assert!(env.calls.borrow().contains(&"validate-recovery"));
assert!(unfinished(&w.meta).is_none());
}
#[test]
fn incompatible_source_or_platform_is_rejected_without_touching_installation() {
let w = world(&[], false);
let (_, meta) = MetaDir::open(&w.meta).unwrap();
let mut manifest = Manifest::parse(&fs::read(w.pkg.join("manifest.json")).unwrap()).unwrap();
manifest.min_manager_version = "0.6.13".into();
manifest.core.commit = Some("a".repeat(40));
manifest.compatibility = Some(crate::manifest::Compatibility { schema: 1,
platform: if cfg!(windows) { "windows-x86_64" } else { "linux-x86_64" }.into(),
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["1.0.0".into()] });
manifest.validate().unwrap();
validate_candidate(&meta, &manifest).unwrap();
manifest.compatibility.as_mut().unwrap().source_versions = vec!["0.9.0".into()];
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("compatibility matrix"));
let mut already_updated = meta.clone();
already_updated.core.version = Some(manifest.version.clone());
validate_candidate(&already_updated, &manifest).unwrap();
manifest.compatibility.as_mut().unwrap().source_versions = vec!["1.0.0".into()];
manifest.compatibility.as_mut().unwrap().platform = if cfg!(windows) { "linux-x86_64" } else { "windows-x86_64" }.into();
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("targets"));
assert!(validate_candidate(&already_updated, &manifest).unwrap_err().to_string().contains("targets"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(unfinished(&w.meta).is_none());
}
#[test]
fn changed_installed_schema_contract_blocks_before_database_access() {
let w = world(&[], false);
write(&w.root, "Scripts/database-schema.json", b"modified schema contract");
let mut manifest = Manifest::parse(&fs::read(w.pkg.join("manifest.json")).unwrap()).unwrap();
manifest.compatibility = Some(crate::manifest::Compatibility { schema: 1,
platform: "windows-x86_64".into(), core_commit: "a".repeat(40),
module_commits: [("squid".into(), "b".repeat(40))].into(), client_patch_version: "1.5.1".into(),
source_versions: vec!["1.0.0".into()],
source_databases: [("1.0.0".into(), crate::manifest::SourceDatabase {
manifest_sha256: "a".repeat(64), schema_sha256: Some("b".repeat(64)) })].into() });
let env = RepackEnv { root: &w.root, meta_dir: &w.meta };
let error = env.preflight(&manifest).unwrap_err().to_string();
assert!(error.contains("schema contract differs"), "{error}");
assert!(!w.root.join("Runtime/python/python.exe").exists());
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(unfinished(&w.meta).is_none());
}
#[test]
fn unhealthy_restoration_preserves_recovery_and_blocks_startup() {
let w = world(&[], true);
let env = Fake::ok();
env.automatic_rollback.set(true);
env.healthy.set(false);
env.recovery_healthy.set(false);
assert!(run(&w, &env, BTreeMap::new(), None).unwrap_err().to_string().contains("Recovery failed"));
let pending = unfinished(&w.meta).unwrap();
assert_eq!(pending.state, State::Failed);
assert!(txn_dir(&w.meta, &pending.id).unwrap().join("before").exists());
assert!(ensure_recovered(&w.meta).is_err());
}
#[test]
fn retrying_startup_commits_without_reapplying_sql_or_restoring_databases() {
let w = world(&[], true);
@@ -1464,6 +1930,23 @@ mod tests {
assert!(fs::read_dir(w.meta.join("updates")).unwrap().next().is_none());
}
#[test]
fn failed_rehearsal_preserves_installed_files_version_and_recovery_point() {
let w = world(&[], true);
let env = Fake::ok();
env.rehearsal_fail.set(true);
let original = fsx::sha256_file(&w.meta.join("install.json")).unwrap();
let error = run(&w, &env, BTreeMap::new(), None).unwrap_err();
assert!(error.to_string().contains("installed server was not updated"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert_eq!(fsx::sha256_file(&w.meta.join("install.json")).unwrap(), original);
assert_eq!(&*env.calls.borrow(), &["stop", "snapshot"]);
assert!(pending_checked(&w.meta).unwrap().is_none());
let journal = journals(&w.meta).unwrap().remove(0);
assert_eq!(journal.recovery_point.as_deref(), Some("rp-1"));
assert!(!journal.databases_started && journal.ops.is_empty());
}
#[test]
fn missing_and_semantically_corrupt_journals_block_operations() {
let w = world(&[], false);
+163
View File
@@ -0,0 +1,163 @@
use std::{collections::BTreeMap, fs, path::Path};
use serde::{Deserialize, Serialize};
use crate::{config::parser::ConfFile, fsx, Error, Result};
const FILES: &[&str] = &[
"Settings/repack.json", "Settings/realm-profile.json",
"Settings/worldserver.conf.template", "Settings/authserver.conf.template",
"Core/configs/worldserver.conf", "Core/configs/authserver.conf",
"Settings/realm-profiles/coa.json", "Settings/realm-profiles/wildcard.json",
".realms/secondary/Settings/repack.json", ".realms/secondary/Settings/realm-profile.json",
".realms/secondary/Settings/worldserver.conf.template", ".realms/secondary/Settings/authserver.conf.template",
".realms/secondary/Core/configs/worldserver.conf", ".realms/secondary/Core/configs/authserver.conf",
];
#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
struct Saved { bytes: Option<Vec<u8>>, sha256: Option<String> }
pub(crate) fn pending(meta: &Path) -> bool { meta.join("validation-configs.json").exists() }
pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> {
if pending(meta) { return Err(Error::Invalid("Interrupted isolated validation must be recovered first.".into())); }
let mut saved = BTreeMap::new();
for rel in FILES {
let path = fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
let bytes = if path.exists() { Some(fs::read(path)?) } else { None };
let sha256 = bytes.as_ref().map(|b| fsx::sha256_bytes(b));
saved.insert(*rel, Saved { bytes, sha256 });
}
let mut settings: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json"))?;
let mut realm: Option<serde_json::Value> = if root.join("Settings/realm-profile.json").exists() {
Some(fsx::read_json(&root.join("Settings/realm-profile.json"))?)
} else { None };
let mut excluded: std::collections::BTreeSet<u64> = ["mysqlPort", "authPort", "worldPort", "raPort"].iter()
.filter_map(|key| settings[*key].as_u64()).collect();
if let Some(state) = &realm {
excluded.extend(["secondary_world_port", "secondary_ra_port"].iter().filter_map(|key| state[*key].as_u64()));
}
let mut sockets = Vec::new();
let mut reserve = || -> Result<u16> {
loop {
let socket = std::net::TcpListener::bind("127.0.0.1:0")?;
let port = socket.local_addr()?.port();
if excluded.insert(u64::from(port)) {
sockets.push(socket);
return Ok(port);
}
}
};
for key in ["authPort", "worldPort", "raPort"] { settings[key] = reserve()?.into(); }
if let Some(state) = &mut realm {
for key in ["secondary_world_port", "secondary_ra_port"] {
state[key] = reserve()?.into();
}
}
let mut configs = Vec::new();
for rel in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] {
let path = root.join(rel);
if !path.exists() && rel.ends_with(".template") {
return Err(Error::Invalid(format!("Cannot isolate validation without {rel}.")));
}
if path.exists() {
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("BindIP", "\"127.0.0.1\"", &[]);
if rel.contains("worldserver") { conf.set("Ra.IP", "\"127.0.0.1\"", &[]); }
configs.push((path, conf.to_text()));
}
}
fsx::atomic_write_json(&meta.join("validation-configs.json"), &saved)?;
fsx::atomic_write_json(&root.join("Settings/repack.json"), &settings)?;
if let Some(state) = realm { fsx::atomic_write_json(&root.join("Settings/realm-profile.json"), &state)?; }
for (path, text) in configs { fsx::atomic_write(&path, text.as_bytes())?; }
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
fn fixture() -> (tempfile::TempDir, std::path::PathBuf, std::path::PathBuf) {
let dir = tempfile::tempdir().unwrap();
let root = dir.path().join("server");
let meta = dir.path().join("metadata");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(&meta).unwrap();
fsx::atomic_write_json(&root.join(FILES[0]), &serde_json::json!({"mysqlPort":3306,"authPort":3724,"worldPort":8085,"raPort":3443})).unwrap();
fsx::atomic_write_json(&root.join(FILES[1]), &serde_json::json!({"simultaneous":true,"secondary_world_port":8086,"secondary_ra_port":3444})).unwrap();
for rel in [FILES[2], FILES[3]] {
fsx::atomic_write(&root.join(rel), b"BindIP = \"0.0.0.0\"\r\nRa.IP = \"0.0.0.0\"\r\n").unwrap();
}
(dir, root, meta)
}
#[test]
fn interrupted_validation_restores_original_bytes_and_absent_files() {
let (_dir, root, meta) = fixture();
let original: Vec<_> = FILES.iter().map(|p| fs::read(root.join(p)).ok()).collect();
begin(&root, &meta).unwrap();
assert!(crate::update::ensure_recovered(&meta).is_err());
assert!(begin(&root, &meta).is_err());
let settings: serde_json::Value = fsx::read_json(&root.join(FILES[0])).unwrap();
assert_eq!(settings["mysqlPort"], 3306);
let realm: serde_json::Value = fsx::read_json(&root.join(FILES[1])).unwrap();
let ports: std::collections::BTreeSet<_> = [settings["authPort"].as_u64(), settings["worldPort"].as_u64(), settings["raPort"].as_u64(), realm["secondary_world_port"].as_u64(), realm["secondary_ra_port"].as_u64()].into_iter().collect();
assert_eq!(ports.len(), 5);
let config = ConfFile::parse_bytes(&fs::read(root.join(FILES[2])).unwrap()).unwrap();
assert_eq!(config.get("BindIP"), Some("\"127.0.0.1\""));
fsx::atomic_write(&root.join(FILES[4]), b"rendered temporary configuration").unwrap();
restore(&root, &meta).unwrap();
for (rel, bytes) in FILES.iter().zip(original) { assert_eq!(fs::read(root.join(rel)).ok(), bytes); }
assert!(!pending(&meta));
restore(&root, &meta).unwrap();
}
#[test]
fn damaged_recovery_copy_blocks_all_restoration() {
let (_dir, root, meta) = fixture();
begin(&root, &meta).unwrap();
let journal = meta.join("validation-configs.json");
let mut saved: BTreeMap<String, Saved> = fsx::read_json(&journal).unwrap();
saved.get_mut(FILES[0]).unwrap().bytes = Some(b"damaged".to_vec());
fsx::atomic_write_json(&journal, &saved).unwrap();
let before = fs::read(root.join(FILES[2])).unwrap();
assert!(restore(&root, &meta).is_err());
assert_eq!(fs::read(root.join(FILES[2])).unwrap(), before);
assert!(pending(&meta));
}
#[test]
fn missing_template_fails_before_any_configuration_changes() {
let (_dir, root, meta) = fixture();
fs::remove_file(root.join(FILES[3])).unwrap();
let before = fs::read(root.join(FILES[0])).unwrap();
assert!(begin(&root, &meta).is_err());
assert!(!pending(&meta));
assert_eq!(fs::read(root.join(FILES[0])).unwrap(), before);
}
}
pub(crate) fn restore(root: &Path, meta: &Path) -> Result<()> {
if !pending(meta) { return Ok(()); }
let journal = meta.join("validation-configs.json");
let saved: BTreeMap<String, Saved> = fsx::read_json(&journal)?;
if saved.len() != FILES.len() || FILES.iter().any(|rel| !saved.contains_key(*rel)) {
return Err(Error::Invalid("Isolated validation configuration journal is incomplete.".into()));
}
for (rel, file) in &saved {
fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
if file.bytes.as_ref().map(|b| fsx::sha256_bytes(b)) != file.sha256 {
return Err(Error::Invalid(format!("Isolated validation recovery copy {rel} is damaged.")));
}
}
for (rel, file) in saved {
let path = fsx::ensure_within(root, &fsx::safe_join(root, &rel)?)?;
match file.bytes {
Some(bytes) => fsx::atomic_write(&path, &bytes)?,
None if path.exists() => fs::remove_file(path)?,
None => {},
}
}
fs::remove_file(journal)?;
Ok(())
}
+393
View File
@@ -0,0 +1,393 @@
//! Starting the game client on Linux. The client is a Windows program, so it runs under umu-launcher with a Proton build
//! (what the project's own guide uses), or under plain Wine when umu is not installed. This is the Linux counterpart of
//! starting `Ascension.exe` directly; `client::launch` hands over to it on a Linux host and Windows never comes here.
//!
//! The settings are found on their own and can all be overridden, from strongest to weakest: the environment
//! (`COA_PROTONPATH`, `COA_WINEPREFIX`), then `client-launch.json` in the Manager's folder, then what is installed.
use std::fs::{self, OpenOptions};
use std::io::Write;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use serde::Deserialize;
use crate::error::{Error, Result};
/// Prefix used when nothing else is said: the folder umu-launcher itself suggests for a game.
const DEFAULT_PREFIX: &str = "Games/umu/coa-client";
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Runner {
/// umu-launcher runs the game with a Proton build. `proton` is `None` when umu should pick and download one itself.
Umu { program: PathBuf, proton: Option<PathBuf> },
Wine { program: PathBuf },
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Launcher {
pub runner: Runner,
pub prefix: PathBuf,
}
/// What to run, in a form that can be checked without running anything.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Plan {
pub program: PathBuf,
pub args: Vec<String>,
pub env: Vec<(String, String)>,
pub cwd: PathBuf,
}
/// `client-launch.json`: every key is optional.
#[derive(Debug, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Overrides {
pub proton_path: Option<String>,
pub prefix: Option<String>,
/// "umu" or "wine": use this one even if the other is installed.
pub runner: Option<String>,
}
/// Everything detection looks at, so it can be tested without a real computer.
pub struct Host<'a> {
pub var: &'a dyn Fn(&str) -> Option<String>,
pub which: &'a dyn Fn(&str) -> Option<PathBuf>,
/// Names of the entries of a folder (empty when it does not exist).
pub list: &'a dyn Fn(&Path) -> Vec<String>,
pub is_file: &'a dyn Fn(&Path) -> bool,
}
fn proton_folders(home: &Path) -> Vec<PathBuf> {
vec![
home.join(".local/share/Steam/compatibilitytools.d"),
home.join(".steam/root/compatibilitytools.d"),
home.join(".steam/steam/compatibilitytools.d"),
home.join(".var/app/com.valvesoftware.Steam/.local/share/Steam/compatibilitytools.d"),
PathBuf::from("/usr/share/steam/compatibilitytools.d"),
]
}
/// Numbers of a name in order, so that GE-Proton10-9 sorts before GE-Proton10-34.
fn version_key(name: &str) -> Vec<u64> {
let mut out = Vec::new();
let mut cur = String::new();
for c in name.chars().chain(std::iter::once(' ')) {
if c.is_ascii_digit() {
cur.push(c);
} else if !cur.is_empty() {
out.push(cur.parse().unwrap_or(0));
cur.clear();
}
}
out
}
/// The newest GE-Proton build installed for Steam, if any. A folder only counts when it holds the `proton` script.
fn newest_proton(host: &Host, home: &Path) -> Option<PathBuf> {
proton_folders(home)
.into_iter()
.flat_map(|dir| (host.list)(&dir).into_iter().filter(|n| n.starts_with("GE-Proton")).map(move |n| (n.clone(), dir.join(n))))
.filter(|(_, path)| (host.is_file)(&path.join("proton")))
.max_by_key(|(name, _)| version_key(name))
.map(|(_, path)| path)
}
pub fn detect_with(host: &Host, overrides: &Overrides) -> Result<Launcher> {
let home = (host.var)("HOME").map(PathBuf::from).ok_or_else(|| Error::Invalid("The home folder of this user is not known.".into()))?;
let prefix = (host.var)("COA_WINEPREFIX").or_else(|| overrides.prefix.clone()).map(PathBuf::from).unwrap_or_else(|| home.join(DEFAULT_PREFIX));
let proton = (host.var)("COA_PROTONPATH").or_else(|| overrides.proton_path.clone()).map(PathBuf::from).or_else(|| newest_proton(host, &home));
let (umu, wine) = ((host.which)("umu-run"), (host.which)("wine"));
let runner = match (overrides.runner.as_deref(), umu, wine) {
(Some("wine"), _, Some(program)) => Runner::Wine { program },
(Some("umu"), Some(program), _) | (None, Some(program), _) => Runner::Umu { program, proton },
(_, None, Some(program)) => Runner::Wine { program },
_ => {
return Err(Error::Invalid(
"To play on Linux the game client needs umu-launcher (with a Proton build such as GE-Proton) or Wine. Install one of them and press Play again.".into(),
))
}
};
Ok(Launcher { runner, prefix })
}
/// The command line that starts `exe` from the client folder.
pub fn plan(launcher: &Launcher, client: &Path, exe: &str) -> Plan {
let mut env = vec![("WINEPREFIX".to_string(), launcher.prefix.to_string_lossy().into_owned())];
// DivxTac.dll is a mixed-mode .NET assembly: loaded through wine-mono it deadlocks the client on the world loading screen
// (100%). Disabling it has the same effect as removing the file.
env.push(("WINEDLLOVERRIDES".into(), "divxtac=d".into()));
let program = match &launcher.runner {
Runner::Umu { program, proton } => {
env.push(("GAMEID".into(), "0".into()));
if let Some(p) = proton {
env.push(("PROTONPATH".into(), p.to_string_lossy().into_owned()));
}
program.clone()
}
Runner::Wine { program } => program.clone(),
};
// The client reads Data/ relative to the working directory.
Plan { program, args: vec![exe.to_string()], env, cwd: client.to_path_buf() }
}
fn system_var(k: &str) -> Option<String> {
std::env::var(k).ok().filter(|v| !v.trim().is_empty())
}
fn find_on_path(program: &str) -> Option<PathBuf> {
std::env::split_paths(&std::env::var_os("PATH")?).map(|d| d.join(program)).find(|p| p.is_file())
}
fn list_names(dir: &Path) -> Vec<String> {
fs::read_dir(dir).map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| e.file_name().into_string().ok()).collect()).unwrap_or_default()
}
fn data_home() -> Option<PathBuf> {
system_var("XDG_DATA_HOME").map(PathBuf::from).filter(|p| p.is_absolute()).or_else(|| system_var("HOME").map(|h| PathBuf::from(h).join(".local/share")))
}
fn overrides_file() -> Option<PathBuf> {
data_home().map(|d| d.join("CoAServerManager/client-launch.json"))
}
pub fn detect() -> Result<Launcher> {
let overrides: Overrides = overrides_file().and_then(|p| crate::fsx::read_json(&p).ok()).unwrap_or_default();
detect_with(&Host { var: &system_var, which: &find_on_path, list: &list_names, is_file: &|p| p.is_file() }, &overrides)
}
/// Where what the client prints goes: the Manager's own log folder.
pub fn log_path() -> Option<PathBuf> {
data_home().map(|d| d.join("CoAServerManager/logs/client.log"))
}
/// Start the client and return at once; it keeps running when the Manager closes. Returns the process id.
pub fn launch(client: &Path, exe: &str) -> Result<u32> {
let launcher = detect()?;
let plan = plan(&launcher, client, exe);
let log = match log_path() {
Some(p) => {
if let Some(dir) = p.parent() {
fs::create_dir_all(dir)?;
}
let mut f = OpenOptions::new().create(true).append(true).open(&p)?;
writeln!(f, "=== {} {:?} in {}", plan.program.display(), plan.args, plan.cwd.display())?;
for (k, v) in &plan.env {
writeln!(f, " {k}={v}")?;
}
Some(f)
}
None => None,
};
let mut cmd = Command::new(&plan.program);
cmd.args(&plan.args).current_dir(&plan.cwd).envs(plan.env.iter().map(|(k, v)| (k, v))).stdin(Stdio::null());
match log {
Some(f) => {
cmd.stderr(f.try_clone()?).stdout(f);
}
None => {
cmd.stdout(Stdio::null()).stderr(Stdio::null());
}
}
#[cfg(unix)]
{
use std::os::unix::process::CommandExt;
cmd.process_group(0); // its own group: closing the Manager does not take the game with it
}
let mut child = cmd.spawn().map_err(|e| Error::Invalid(format!("The game client could not be started ({}): {e}", plan.program.display())))?;
let pid = child.id();
std::thread::spawn(move || {
let _ = child.wait(); // reap it when the game closes
});
Ok(pid)
}
/// Is a process running this client? Under Wine its command line carries the Windows form of the path
/// (`Z:\home\you\client\Ascension.exe`), which is the only trace of it that names the folder.
pub fn command_line_runs(cmdline: &str, client: &Path, exe: &str) -> bool {
let wanted = format!("{}/{}", client.to_string_lossy().trim_end_matches('/'), exe).to_lowercase();
cmdline.replace('\0', " ").replace('\\', "/").to_lowercase().contains(&wanted)
}
/// The folder as it was given and as the system resolves it. On an immutable distribution (SteamOS, Bazzite) `/home` is a
/// link to `/var/home`: Wine writes the path it was given, the resolved one differs, and either may be what the command
/// line of the running client holds.
fn spellings(client: &Path) -> Vec<PathBuf> {
let mut all = vec![client.to_path_buf()];
if let Ok(real) = fs::canonicalize(client) {
if real != client {
all.push(real);
}
}
all
}
pub fn is_running(client: &Path, exes: &[&str]) -> bool {
let folders = spellings(client);
let Ok(rd) = fs::read_dir("/proc") else { return false };
rd.filter_map(|e| e.ok())
.filter(|e| e.file_name().to_string_lossy().bytes().all(|b| b.is_ascii_digit()))
.filter_map(|e| fs::read(e.path().join("cmdline")).ok())
.any(|raw| {
let line = String::from_utf8_lossy(&raw);
folders.iter().any(|folder| exes.iter().any(|exe| command_line_runs(&line, folder, exe)))
})
}
// Linux only: the folders are written as Linux path strings.
#[cfg(all(test, unix))]
mod tests {
use super::*;
use std::collections::{BTreeMap, BTreeSet};
#[test]
fn a_client_folder_behind_a_link_is_looked_for_under_both_names() {
// SteamOS and Bazzite: /home is a link to /var/home.
let dir = tempfile::tempdir().unwrap();
fs::create_dir_all(dir.path().join("var/home/u/client")).unwrap();
std::os::unix::fs::symlink("var/home", dir.path().join("home")).unwrap();
let given = dir.path().join("home/u/client");
let both = spellings(&given);
assert_eq!(both.len(), 2);
assert_eq!(both[0], given);
assert!(both[1].starts_with(dir.path().canonicalize().unwrap().join("var/home")));
// Wine kept the name it was given, so the line holds the first one and not the resolved one.
let line = format!("Z:\\{}\\Ascension.exe", given.to_string_lossy().replace('/', "\\"));
assert!(!command_line_runs(&line, &both[1], "Ascension.exe"));
assert!(both.iter().any(|f| command_line_runs(&line, f, "Ascension.exe")));
}
/// A computer described in a few lines: variables, programs on the path, folders with their entries, and `proton` scripts.
struct Fake {
vars: BTreeMap<&'static str, &'static str>,
programs: BTreeSet<&'static str>,
folders: BTreeMap<&'static str, Vec<&'static str>>,
}
impl Fake {
fn new() -> Fake {
Fake { vars: BTreeMap::from([("HOME", "/home/ana")]), programs: BTreeSet::new(), folders: BTreeMap::new() }
}
fn detect(&self, overrides: &Overrides) -> Result<Launcher> {
let var = |k: &str| self.vars.get(k).map(|v| v.to_string());
let which = |p: &str| self.programs.contains(p).then(|| PathBuf::from(format!("/usr/bin/{p}")));
let list = |d: &Path| self.folders.get(d.to_str().unwrap()).map(|v| v.iter().map(|s| s.to_string()).collect()).unwrap_or_default();
// every listed build has its `proton` script
let is_file = |p: &Path| p.file_name().is_some_and(|n| n == "proton");
detect_with(&Host { var: &var, which: &which, list: &list, is_file: &is_file }, overrides)
}
}
const STEAM: &str = "/home/ana/.local/share/Steam/compatibilitytools.d";
#[test]
fn umu_with_the_newest_ge_proton_is_the_default() {
let mut c = Fake::new();
c.programs.extend(["umu-run", "wine"]);
c.folders.insert(STEAM, vec!["GE-Proton9-27", "GE-Proton10-9", "GE-Proton10-34", "Proton-Experimental", "notes.txt"]);
let l = c.detect(&Overrides::default()).unwrap();
assert_eq!(l.prefix, PathBuf::from("/home/ana/Games/umu/coa-client"));
match l.runner {
Runner::Umu { proton, program } => {
assert_eq!(program, PathBuf::from("/usr/bin/umu-run"));
assert_eq!(proton, Some(PathBuf::from(format!("{STEAM}/GE-Proton10-34"))), "10-34 is newer than 10-9");
}
other => panic!("{other:?}"),
}
}
#[test]
fn without_a_proton_build_umu_is_left_to_choose_one() {
let mut c = Fake::new();
c.programs.insert("umu-run");
let Runner::Umu { proton, .. } = c.detect(&Overrides::default()).unwrap().runner else { panic!() };
assert_eq!(proton, None);
}
#[test]
fn plain_wine_is_used_when_umu_is_not_installed() {
let mut c = Fake::new();
c.programs.insert("wine");
assert!(matches!(c.detect(&Overrides::default()).unwrap().runner, Runner::Wine { .. }));
}
#[test]
fn without_umu_or_wine_the_person_is_told_what_to_install() {
let err = Fake::new().detect(&Overrides::default()).unwrap_err().to_string();
assert!(err.contains("umu-launcher") && err.contains("Wine"), "{err}");
}
#[test]
fn settings_override_what_is_installed_and_the_environment_overrides_the_file() {
let mut c = Fake::new();
c.programs.extend(["umu-run", "wine"]);
c.folders.insert(STEAM, vec!["GE-Proton10-34"]);
let file = Overrides { proton_path: Some("/opt/proton-a".into()), prefix: Some("/data/prefix-a".into()), runner: None };
let l = c.detect(&file).unwrap();
assert_eq!(l.prefix, PathBuf::from("/data/prefix-a"));
assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-a")));
c.vars.insert("COA_PROTONPATH", "/opt/proton-b");
c.vars.insert("COA_WINEPREFIX", "/data/prefix-b");
let l = c.detect(&file).unwrap();
assert_eq!(l.prefix, PathBuf::from("/data/prefix-b"));
assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-b")));
// Forcing Wine works when it is installed, and falls back to umu when it is not.
let wine = Overrides { runner: Some("wine".into()), ..Default::default() };
assert!(matches!(c.detect(&wine).unwrap().runner, Runner::Wine { .. }));
}
#[test]
fn the_command_is_the_one_of_the_projects_own_launcher_script() {
let l = Launcher { runner: Runner::Umu { program: "/usr/bin/umu-run".into(), proton: Some("/p/GE-Proton11-6".into()) }, prefix: "/home/ana/Games/umu/coa-client".into() };
let p = plan(&l, Path::new("/home/ana/CoaServer/client/ascension-live"), "Ascension.exe");
assert_eq!(p.program, PathBuf::from("/usr/bin/umu-run"));
assert_eq!(p.args, ["Ascension.exe"]);
assert_eq!(p.cwd, PathBuf::from("/home/ana/CoaServer/client/ascension-live"), "the client reads Data/ from its working directory");
let env: BTreeMap<_, _> = p.env.iter().cloned().collect();
assert_eq!(env["GAMEID"], "0");
assert_eq!(env["PROTONPATH"], "/p/GE-Proton11-6");
assert_eq!(env["WINEPREFIX"], "/home/ana/Games/umu/coa-client");
assert_eq!(env["WINEDLLOVERRIDES"], "divxtac=d", "DivxTac.dll deadlocks the world loading screen under wine-mono");
// Wine has no GAMEID / PROTONPATH.
let w = plan(&Launcher { runner: Runner::Wine { program: "/usr/bin/wine".into() }, prefix: "/pre".into() }, Path::new("/c"), "Wow.exe");
assert!(w.env.iter().all(|(k, _)| k != "GAMEID" && k != "PROTONPATH") && w.args == ["Wow.exe"]);
}
#[test]
fn a_wine_command_line_names_the_client_folder_in_windows_form() {
let client = Path::new("/home/ana/CoaServer/client/ascension-live");
assert!(command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe\0", client, "Ascension.exe"));
assert!(command_line_runs("C:\\windows\\system32\\start.exe /exec Z:\\HOME\\ANA\\coaserver\\client\\ascension-live\\ascension.exe", client, "Ascension.exe"), "case does not matter");
assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-lab\\Ascension.exe", client, "Ascension.exe"), "another client folder");
assert!(!command_line_runs("umu-run Ascension.exe", client, "Ascension.exe"), "the launcher alone does not name the folder");
assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe.ORIGINAL", Path::new("/other"), "Ascension.exe"));
}
#[test]
fn newer_versions_sort_after_older_ones() {
assert!(version_key("GE-Proton10-9") < version_key("GE-Proton10-34"));
assert!(version_key("GE-Proton9-27") < version_key("GE-Proton10-1"));
assert!(version_key("GE-Proton11-6-x86_64") < version_key("GE-Proton11-7-x86_64"));
}
#[cfg(unix)]
#[test]
fn a_real_launch_runs_the_program_in_the_client_folder_with_the_right_environment() {
use std::os::unix::fs::PermissionsExt;
let d = tempfile::tempdir().unwrap();
let client = d.path().join("client");
fs::create_dir_all(&client).unwrap();
let out = d.path().join("seen.txt");
let script = d.path().join("umu-run");
fs::write(&script, format!("#!/bin/sh\n{{ echo \"cwd=$(pwd)\"; echo \"arg=$1\"; echo \"prefix=$WINEPREFIX\"; echo \"gameid=$GAMEID\"; echo \"dll=$WINEDLLOVERRIDES\"; }} > '{}'\n", out.display())).unwrap();
fs::set_permissions(&script, fs::Permissions::from_mode(0o755)).unwrap();
let launcher = Launcher { runner: Runner::Umu { program: script, proton: None }, prefix: d.path().join("prefix") };
let p = plan(&launcher, &client, "Ascension.exe");
let mut child = Command::new(&p.program).args(&p.args).current_dir(&p.cwd).envs(p.env.iter().map(|(k, v)| (k, v))).spawn().unwrap();
assert!(child.wait().unwrap().success());
let seen = fs::read_to_string(&out).unwrap();
assert!(seen.contains(&format!("cwd={}", fs::canonicalize(&client).unwrap().display())), "{seen}");
assert!(seen.contains("arg=Ascension.exe") && seen.contains("gameid=0") && seen.contains("dll=divxtac=d") && seen.contains("prefix="), "{seen}");
}
}
+40
View File
@@ -47,6 +47,36 @@ fn run() -> Result<(), String> {
let e = |x: coa_core::Error| x.to_string();
let part = a.get("part-size").and_then(|v| v.parse().ok()).unwrap_or(DEFAULT_PART_SIZE);
match cmd.as_str() {
"qualify-upgrade" => {
let report = coa_core::release_schema::qualify_upgrade(
&PathBuf::from(need(&a, "base")?), &PathBuf::from(need(&a, "source")?),
&PathBuf::from(need(&a, "candidate")?), &PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?;
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report).map_err(e)?;
println!("Manager upgrade transaction passed isolated qualification");
}
"qualify-startup" => {
coa_core::release_schema::validate_startup(
&PathBuf::from(need(&a, "fixture")?), &PathBuf::from(need(&a, "tree")?),
&PathBuf::from(need(&a, "base")?), coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?;
println!("authserver and worldserver passed isolated startup qualification");
}
"verify-channel" => {
let bytes = std::fs::read(need(&a, "file")?).map_err(|x| x.to_string())?;
let pointer = coa_core::channels::verify(&bytes, need(&a, "channel")?, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("{}", serde_json::to_string(&pointer).map_err(|x| x.to_string())?);
}
"verify-manifest" => {
let source = coa_core::pkgsource::Source::Dir(PathBuf::from(need(&a, "dir")?));
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&source, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("verified signed manifest {}", manifest.version);
}
"verify-upgrade-fixture" => {
coa_core::release_schema::verify_upgrade_fixture(&PathBuf::from(need(&a, "dir")?), coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("verified signed upgrade fixture and every archive file");
}
"extract-schema-base" => {
coa_core::release_schema::extract_base(
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?),
@@ -112,6 +142,16 @@ fn run() -> Result<(), String> {
coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("signature, archive contents and database schema contract OK");
}
"sign-channel" => {
let pointer = coa_core::channels::Pointer {
schema: 1, channel: need(&a, "channel")?.clone(),
version: need(&a, "version")?.clone(),
release_tag: format!("server-{}", need(&a, "version")?),
snapshot: need(&a, "snapshot")?.clone(),
};
let bytes = coa_core::channels::sign(&pointer, &signing_key()?).map_err(e)?;
coa_core::fsx::atomic_write(&PathBuf::from(need(&a, "out")?), &bytes).map_err(e)?;
}
other => return Err(format!("unknown command {other}")),
}
Ok(())
+44 -2
View File
@@ -392,8 +392,50 @@ hand over to `coa_core::docker`; nothing else needed to change for start, stop,
so replaying the SQL files from the base scripts fails, in any order. `coa-release export-baseline --server DIR --out DIR`
produces the dumps from a prepared server (repack or Docker). The game data stays where the person has it
(`dataDir` in `docker.json`, mounted read-only). A failure removes the containers, the volume and the staging folder.
* **Not done yet**: wiring the installer into the screens, downloading the game data, updates, port conflict detection,
the firewall and exposure checks, the Wildcard realm profiles, and the client under Wine/Proton.
* **Validating a release on Linux** (`docker/fixture.rs`, used by `coa-release extract-schema-base` and `schema-contract` where
there is no Windows database program): the signed base package carries the MySQL data directory of a Windows repack, and a
MySQL 8.4 container opens it as it is (`--lower-case-table-names=1`, the repack's setting). The fixture is a Docker server
folder (`docker.json` with `mysqlData`: the database container uses that directory in place of a volume; an installation
never sets it), plus a `root` account for TCP, which the repack only has for its socket. The release SQL is then applied and the
schema contract captured by the same code as on Windows, and `export-baseline` dumps the result: that is how a Linux build
produces `Database/baseline` without anyone's live database. The migration checksums recorded in the base are those of
files checked out on Windows (CRLF line endings, `core.autocrlf`): the SQL of the core, the modules and SQUID must be
checked out the same way for the checksums to match, or every applied migration looks edited.
* **In the screens** the host is asked once per command (`coa_core::platform::flavor()`: repack on Windows, Docker
elsewhere) and the Docker half lives in `src-tauri/src/docker_install.rs`; the repack arm of each install command is the
code that was there. `install_environment` tells the install screen the kind of server, the suggested folder
(`~/CoaServer`) and why Docker cannot be used, if it cannot. On Docker the screen also asks for the game data folder and
the package, and there is no default package address until a signed Linux package is published. Packages are checked with
the embedded key; only a debug build (`tauri dev`) accepts another one, named in `COA_DEV_TRUSTED_KEY`, to try the
installer on a package signed with a throwaway key.
* **Updates are refused for a Docker server, never half done.** `update::preview`, `apply` and `rollback` refuse it: the
update packages are the repack's (executables, a bundled MySQL, a launcher) and applying one would put Windows files in a
Linux folder. Found by installing a server with the screen: the update check had read the Windows channel and offered one.
* **Realm profiles (CoA / Wildcard) work on a Docker server.** What the repack's patched launcher did at each start is done
by the Docker backend: finish an interrupted switch (`realms::before_start`), name the realms in the realm list, and give
the containers the databases of the selected realm (`acore_world_wildcard` ...). The switch itself (configuration swap,
database copy, journal) is the shared code; `prepare_launcher` has nothing to patch, and Wildcard support is read from
`Core/worldserver` as it is from `Core/worldserver.exe`.
* **The game client starts under Wine on a Linux host** (`wine.rs`; `client::launch` and `client::is_running` hand over):
umu-launcher with a Proton build when `umu-run` is installed (the newest GE-Proton found for Steam, or umu's own choice),
else plain Wine; `WINEPREFIX` defaults to `~/Games/umu/coa-client`; `WINEDLLOVERRIDES=divxtac=d` is always set, because
DivxTac.dll deadlocks the world loading screen under wine-mono. `COA_PROTONPATH`, `COA_WINEPREFIX` or
`client-launch.json` in the Manager's folder (`proton_path`, `prefix`, `runner`) override the detection. Whether the client
runs is read from `/proc` (under Wine the command line holds the Windows form of the path). Output goes to `client.log`.
* **Sharing with friends** (`docker/sharing.rs`): who can reach the game is decided by the address the container ports are
published on, `bindAddress` in `docker.json`; the `BindIP` of the configuration files is forced to `0.0.0.0` inside the
containers and changes nothing. Opening and closing therefore edit `bindAddress` (and set `CoA.AllowRemoteClients`), "servers
open" and the exposure check are computed from it (the database is never published, the console only on `127.0.0.1`), and
there is no firewall row on Linux. Settings the backend fixes (`docker::FORCED_KEYS`) are not offered; a test keeps that list
equal to the variables the containers get. A world that restarts itself (exit code 2) is restarted by Docker once it has come
up. The database console shows `docker logs`, and the file-based screens read Linux locations (the desktop folder from the
user directories file, memory from `/proc/meminfo`, the distribution name for the problem report).
* **Game data folder** (`docker::game_data_dir` / `set_game_data`, Settings card): `dataDir` in `docker.json` can be changed
after the install, only while the world and auth are stopped, and only to a folder that passes the install checks. A world
that stops with "does not hold the CoA client dbc set" is reported as `GameDataMismatch` (wrong data set: the standard one,
not Conquest of Azeroth's) instead of a bare failure.
* **Not done yet**: downloading the game data, updates, port conflict detection, the firewall and exposure checks, the
Wildcard realm profiles, and the client under Wine/Proton.
### D14. Keeping Windows and Linux apart
+18
View File
@@ -121,6 +121,24 @@
"default_on": false,
"page": "bots"
},
{
"id": "custom-races",
"name": "Custom Races",
"description": {
"en": "Playable custom races (Esteria and additional races) with extended appearances.",
"ru": "Пользовательские расы (Esteria и дополнительные расы) с расширенной внешностью.",
"de": "Spielbare benutzerdefinierte Völker (Esteria und weitere Völker) mit erweitertem Aussehen.",
"fr": "Races personnalisées jouables (Esteria et autres) avec apparences étendues.",
"es": "Razas personalizadas jugables (Esteria y razas adicionales) con apariencias ampliadas."
},
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
"conf": "coa_custom_races.conf",
"switchable": true,
"status": "beta",
"icon": "races",
"enable_key": "CoACustomRaces.Enable",
"default_on": false
},
{
"id": "client-compat",
"name": "Client compatibility",
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "coa-server-manager",
"version": "0.6.7",
"version": "0.6.15",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "coa-server-manager",
"version": "0.6.7",
"version": "0.6.15",
"dependencies": {
"@tauri-apps/api": "^2.12.0",
"@tauri-apps/plugin-dialog": "^2.8.0",
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "coa-server-manager",
"private": true,
"version": "0.6.7",
"version": "0.6.15",
"license": "AGPL-3.0-only",
"type": "module",
"scripts": {
+125
View File
@@ -0,0 +1,125 @@
//! The Linux (Docker) side of the install commands. `lib.rs` asks `coa_core::platform::flavor()` once per command and
//! calls this module for a Docker install; the code for a repack install stays where it was and is not changed by what
//! happens here.
use std::path::{Path, PathBuf};
use coa_core::docker::{self, install as core_install, SystemDocker};
use coa_core::download::Cancel;
use coa_core::install::{Preflight, Source};
use coa_core::registry::Registry;
use coa_core::{Error, Result};
use serde::Serialize;
use tauri::{AppHandle, Emitter, State};
use super::{blocking, data_dir, summary, AppState, InstallRequirements, ServerSummary, UiError};
/// What the install screen needs to know about this computer before it asks anything.
#[derive(Serialize)]
pub struct Environment {
pub flavor: coa_core::platform::Flavor,
pub default_dir: String,
/// Why Docker cannot be used (not installed, not running, no permission), in Docker's own words; none when it works.
pub docker_problem: Option<String>,
}
pub fn default_dir() -> String {
default_dir_in(std::env::var("HOME").ok().as_deref())
}
fn default_dir_in(home: Option<&str>) -> String {
match home.map(|h| h.trim_end_matches('/')).filter(|h| !h.is_empty()) {
Some(h) => format!("{h}/CoaServer"),
None => "/srv/coa".into(),
}
}
pub fn docker_problem() -> Option<String> {
docker::check_docker(&SystemDocker).err().map(|e| e.to_string())
}
pub fn environment() -> Environment {
Environment { flavor: coa_core::platform::flavor(), default_dir: default_dir(), docker_problem: docker_problem() }
}
pub fn preflight(dest: &str, data: Option<String>, needed: Option<u64>, registry: &Registry) -> Preflight {
// The size comes from the signed package list when the screen already has it; it is checked again at install time.
core_install::preflight(Path::new(dest), Path::new(data.as_deref().unwrap_or("")), needed.unwrap_or(1024 * 1024 * 1024), registry)
}
/// The Linux package has no default address yet: it is published only after the maintainer has signed it.
pub fn package_source(custom: Option<String>) -> Result<Source> {
let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_PACKAGE_SOURCE").ok().filter(|s| !s.trim().is_empty()));
match pick {
Some(p) if p.to_ascii_lowercase().starts_with("http") => Ok(Source::Url(p)),
Some(p) => Ok(Source::Dir(PathBuf::from(p))),
None => Err(Error::Invalid("Choose the Linux server package (a folder or an address): none is published yet.".into())),
}
}
/// The key a Linux package must be signed with. A debug build (`tauri dev`) may name another one in `COA_DEV_TRUSTED_KEY`,
/// to try the installer on a package signed with a throwaway key; a release build always uses the embedded key.
pub fn trusted_key() -> String {
#[cfg(debug_assertions)]
if let Ok(k) = std::env::var("COA_DEV_TRUSTED_KEY") {
if !k.trim().is_empty() {
return k.trim().to_string();
}
}
coa_core::signing::EMBEDDED_PUBLIC_KEY.to_string()
}
pub async fn requirements(package: Option<String>) -> std::result::Result<InstallRequirements, UiError> {
blocking(move || {
let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package)?, &trusted_key())?;
let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
Ok(InstallRequirements { download_bytes: archive.parts.iter().map(|p| p.size).sum(), unpacked_bytes: archive.unpacked_size, version: m.version })
})
.await
}
pub async fn install(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>, data: Option<String>) -> std::result::Result<ServerSummary, UiError> {
let source = package_source(package)?;
let data_dir_path = PathBuf::from(data.filter(|d| !d.trim().is_empty()).ok_or_else(|| Error::Invalid("Choose the folder that holds the game data.".into()))?);
let cancel = Cancel::default();
*state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone());
let registry = Registry::at(data_dir().join("installs.json"));
let dest_path = PathBuf::from(dest);
let key = trusted_key();
let result = tauri::async_runtime::spawn_blocking(move || {
core_install::install(
&core_install::Params { source, dest: dest_path, data_dir: data_dir_path, trusted_key: &key, registry: &registry, cancel },
&|step| {
let _ = app.emit("install-progress", step);
},
)
})
.await;
if let Ok(mut c) = state.install_cancel.lock() {
*c = None;
}
let done = result.map_err(|e| Error::Invalid(e.to_string()))??;
Ok(summary(done.id, PathBuf::from(done.path)))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_default_folder_is_in_the_home_folder() {
assert_eq!(default_dir_in(Some("/home/ana")), "/home/ana/CoaServer");
assert_eq!(default_dir_in(Some("/home/ana/")), "/home/ana/CoaServer");
assert_eq!(default_dir_in(None), "/srv/coa");
assert_eq!(default_dir_in(Some("")), "/srv/coa");
}
#[test]
fn a_linux_package_must_be_named_there_is_no_default() {
std::env::remove_var("COA_PACKAGE_SOURCE");
assert!(package_source(None).is_err());
assert!(package_source(Some(" ".into())).is_err());
assert!(matches!(package_source(Some("/tmp/pkg".into())).unwrap(), Source::Dir(_)));
assert!(matches!(package_source(Some("https://example.org/pkg".into())).unwrap(), Source::Url(_)));
}
}
+155 -17
View File
@@ -5,11 +5,14 @@ use std::collections::HashSet;
use std::path::PathBuf;
use std::sync::Mutex;
mod docker_install;
use coa_core::backup::{self, Kind, RecoveryPoint, Trigger, VerifyReport};
use coa_core::config::{self, Scope, SettingsView};
use coa_core::download::Cancel;
use coa_core::driver::{self, DriverOutcome, Verb};
use coa_core::install::{self, Preflight, Source};
use coa_core::platform::{self, Flavor};
use coa_core::ra::Ra;
use coa_core::update::{self, Resolution};
use coa_core::error::UiError;
@@ -36,12 +39,16 @@ struct AppState {
/// Where signed update packages are published; override with COA_UPDATE_SOURCE (URL or local package folder).
const DEFAULT_UPDATE_URL: &str = "https://github.com/Corfirean/coa-server-build/releases/download/stable";
fn update_source(custom: Option<String>) -> Source {
fn update_source(custom: Option<String>) -> Result<Source> {
let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_UPDATE_SOURCE").ok());
match pick {
Some(p) if p.to_ascii_lowercase().starts_with("http") => Source::Url(p),
Some(p) => Source::Dir(PathBuf::from(p)),
None => Source::Url(DEFAULT_UPDATE_URL.into()),
Some(p) if p.to_ascii_lowercase().starts_with("http") => Ok(Source::Url(p)),
Some(p) => Ok(Source::Dir(PathBuf::from(p))),
None => match coa_core::channels::resolve("stable") {
Ok(source) => Ok(source),
Err(Error::PackageNotPublished(_)) => Ok(Source::Url(DEFAULT_UPDATE_URL.into())),
Err(error) => Err(error),
},
}
}
@@ -103,11 +110,46 @@ fn summary(id: String, path: PathBuf) -> ServerSummary {
ServerSummary { id, name, path: path.to_string_lossy().into_owned() }
}
/// The game data folder of a Docker server; none for a repack, whose data is inside its own folder.
#[tauri::command]
fn game_data_folder(state: State<'_, AppState>, id: String) -> std::result::Result<Option<String>, UiError> {
let root = path_of(&state, &id)?;
if !coa_core::docker::is_docker(&root) {
return Ok(None);
}
Ok(Some(coa_core::docker::game_data_dir(&root)?.to_string_lossy().into_owned()))
}
/// Point a Docker server at another game data folder. The servers must be stopped.
#[tauri::command]
async fn set_game_data_folder(state: State<'_, AppState>, id: String, path: String) -> std::result::Result<String, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
if !coa_core::docker::is_docker(&root) {
return Err(Error::Invalid("The game data of this server is inside its folder.".into()));
}
coa_core::docker::set_game_data(&root, std::path::Path::new(&path))?;
Ok(path)
})
.await
}
#[tauri::command]
fn default_install_dir() -> String {
if platform::flavor() == Flavor::Docker {
return docker_install::default_dir();
}
"C:\\Games\\CoA Server".into()
}
/// What the install screen needs to know about this computer: the kind of server it installs, the suggested folder, and
/// whether Docker can be used.
#[tauri::command]
async fn install_environment() -> docker_install::Environment {
tauri::async_runtime::spawn_blocking(docker_install::environment).await.unwrap_or_else(|_| docker_install::Environment { flavor: platform::flavor(), default_dir: default_install_dir(), docker_problem: None })
}
#[tauri::command]
async fn scan_server(path: String) -> std::result::Result<ScanReport, UiError> {
tauri::async_runtime::spawn_blocking(move || layout::scan(std::path::Path::new(&path)))
@@ -139,7 +181,9 @@ async fn add_server(state: State<'_, AppState>, path: String) -> std::result::Re
meta.core.version = report.banner_revision.clone();
meta.database.port = Some(report.ports.mysql);
meta.database.schemas = report.database_schemas.clone();
for (rel, exe) in [("Core/worldserver.exe", &report.worldserver), ("Core/authserver.exe", &report.authserver)] {
// The executables are `worldserver.exe` in a repack and `worldserver` in a Docker server; the file check reads these names.
let exe_names = if coa_core::docker::is_docker(std::path::Path::new(&report.path)) { ("Core/worldserver", "Core/authserver") } else { ("Core/worldserver.exe", "Core/authserver.exe") };
for (rel, exe) in [(exe_names.0, &report.worldserver), (exe_names.1, &report.authserver)] {
if let Some(e) = exe {
meta.original_hashes.insert(rel.into(), e.sha256.clone());
}
@@ -450,7 +494,10 @@ async fn restore_backup_database(state: State<'_, AppState>, id: String, backup_
}
#[tauri::command]
fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option<u64>) -> Preflight {
fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option<u64>, game_data: Option<String>) -> Preflight {
if platform::flavor() == Flavor::Docker {
return docker_install::preflight(&dest, game_data, needed, &state.registry);
}
// `needed` is the real size from the signed package list when the screen already has it; the real size is checked
// again at install time either way.
install::preflight(std::path::Path::new(&dest), needed.unwrap_or(6 * 1024 * 1024 * 1024), &state.registry)
@@ -468,6 +515,9 @@ struct InstallRequirements {
/// How big the server is, read from the package's signed list before anything is downloaded.
#[tauri::command]
async fn install_requirements(package: Option<String>) -> std::result::Result<InstallRequirements, UiError> {
if platform::flavor() == Flavor::Docker {
return docker_install::requirements(package).await;
}
blocking(move || {
let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package), coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
@@ -477,7 +527,10 @@ async fn install_requirements(package: Option<String>) -> std::result::Result<In
}
#[tauri::command]
async fn install_new(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>) -> std::result::Result<ServerSummary, UiError> {
async fn install_new(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>, game_data: Option<String>) -> std::result::Result<ServerSummary, UiError> {
if platform::flavor() == Flavor::Docker {
return docker_install::install(app, state, dest, package, game_data).await;
}
let cancel = Cancel::default();
*state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone());
let source = package_source(package);
@@ -623,7 +676,7 @@ async fn repair_server(app: AppHandle, state: State<'_, AppState>, id: String) -
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| {
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
@@ -639,6 +692,57 @@ async fn module_set_enabled(state: State<'_, AppState>, id: String, module: Stri
})
.await
}
#[tauri::command]
async fn custom_races_status(state: State<'_, AppState>, id: String) -> std::result::Result<Option<coa_core::custom_races::ClientPatchStatus>, UiError> {
let ctx = client_context(&state, &id)?;
blocking(move || {
let client = ctx.linked();
Ok(client.as_deref().map(coa_core::custom_races::client_patch_status))
})
.await
}
#[tauri::command]
async fn custom_races_install(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> {
let ctx = client_context(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
let cancel = begin_client_job(&state)?;
let sid = id.clone();
let result = blocking(move || {
let client = ctx.require()?;
coa_core::custom_races::install_client_patches(&client, &cancel, &|step, percent| {
let _ = app.emit("custom-races-progress", serde_json::json!({
"id": sid,
"step": step,
"percent": percent,
}));
})?;
let enabled = ctx.root.as_ref().map_or(true, |root| coa_core::modules::list(root).iter().any(|module| module.id == "custom-races" && module.enabled));
coa_core::custom_races::set_client_patch_enabled(&client, enabled)
})
.await;
end_client_job(&state);
result
}
#[tauri::command]
async fn custom_races_uninstall(state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> {
let ctx = client_context(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || coa_core::custom_races::uninstall_client_patches(&ctx.require()?)).await
}
#[tauri::command]
async fn custom_races_toggle_client(state: State<'_, AppState>, id: String, enabled: bool) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is linked to this server.".into()))?;
coa_core::custom_races::set_client_patch_enabled(&client, enabled)
})
.await
}
#[tauri::command]
async fn module_settings(state: State<'_, AppState>, id: String, module: String) -> std::result::Result<Vec<coa_core::modules::Setting>, UiError> {
@@ -731,11 +835,12 @@ fn install_meta(root: &std::path::Path) -> Result<(PathBuf, InstallMeta)> {
#[tauri::command]
async fn check_update(state: State<'_, AppState>, id: String, source: Option<String>, background: Option<bool>) -> std::result::Result<update::Preview, UiError> {
let root = path_of(&state, &id)?;
let src = update_source(source);
// The check that repeats every few minutes must not start and stop the database of a stopped server.
let access = if background.unwrap_or(false) { update::DatabaseAccess::OnlyIfRunning } else { update::DatabaseAccess::Start };
blocking(move || {
let (_, meta) = install_meta(&root)?;
let src = update_source(source)?;
update::preview_with(&root, &meta, &src, coa_core::signing::EMBEDDED_PUBLIC_KEY, &Default::default(), access)
})
.await
@@ -756,10 +861,13 @@ async fn apply_update(
resolutions: BTreeMap<String, Resolution>,
) -> std::result::Result<update::Outcome, UiError> {
let root = path_of(&state, &id)?;
let src = update_source(source);
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
let src = update_source(source)?;
let (dir, meta) = install_meta(&root)?;
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&src, coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
update::validate_candidate(&meta, &manifest)?;
// Files cannot be replaced while the server runs: stop it first (gracefully), like the Stop button.
let observed = coa_core::process::observe(&root, &layout::read_ports(&root));
if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped || coa_core::multiworld::is_running(&root) {
@@ -1300,7 +1408,7 @@ struct FriendsStatus {
exposure: Vec<coa_core::net::Exposure>,
/// The configuration lets other computers reach the login and world servers.
servers_open: bool,
firewall: coa_core::firewall::Status,
firewall: Option<coa_core::firewall::Status>,
tailscale: coa_core::net::Tailscale,
server_running: bool,
auth_port: u16,
@@ -1345,7 +1453,18 @@ fn report_targets() -> Vec<coa_core::report::Target> {
coa_core::report::targets()
}
/// The distribution on Linux ("Linux (Arch Linux)"), from `/etc/os-release`; empty if it cannot be read.
#[cfg(not(windows))]
fn windows_version() -> String {
std::fs::read_to_string("/etc/os-release")
.ok()
.and_then(|t| t.lines().find_map(|l| l.strip_prefix("PRETTY_NAME=").map(|v| v.trim_matches('"').to_string())))
.map(|name| format!("Linux ({name})"))
.unwrap_or_default()
}
/// "Windows 11 (build 26200)" from `ver`; empty if it cannot be read.
#[cfg(windows)]
fn windows_version() -> String {
let mut cmd = std::process::Command::new("cmd.exe");
cmd.args(["/C", "ver"]);
@@ -1394,9 +1513,10 @@ async fn friends_status(state: State<'_, AppState>, id: String) -> std::result::
settings: coa_core::friends::load(&meta),
lan_ip: automatic.map(|a| a.to_string()),
lan_addresses: coa_core::net::lan_addresses(automatic).unwrap_or_default(),
exposure: coa_core::net::exposure(&ports),
exposure: if coa_core::docker::is_docker(&root) { coa_core::docker::exposure(&root, &ports) } else { coa_core::net::exposure(&ports) },
servers_open: coa_core::friends::bind_is_open(&root),
firewall: coa_core::firewall::status(),
// The Windows firewall exists only on Windows; on Linux Docker publishes the ports itself.
firewall: (platform::flavor() == Flavor::Repack).then(coa_core::firewall::status),
tailscale: coa_core::net::tailscale(),
server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running,
auth_port: ports.auth,
@@ -1466,7 +1586,7 @@ async fn friends_enable(
};
let open = mode != Mode::Local;
let changed = friends::set_open(&root, &meta, open)?;
if open {
if open && platform::flavor() == Flavor::Repack {
coa_core::firewall::ensure_rules_with_secondary(&ports, secondary)?;
}
if mode == Mode::Direct && use_upnp {
@@ -1499,7 +1619,7 @@ async fn friends_package(state: State<'_, AppState>, id: String) -> std::result:
blocking(move || {
let meta = meta_dir(&root)?;
let host = coa_core::friends::load(&meta).host.ok_or_else(|| Error::Invalid("Choose how friends connect first.".into()))?;
let desktop = std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop");
let desktop = if platform::flavor() == Flavor::Docker { coa_core::diag::desktop_or_temp() } else { std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop") };
let out = if desktop.is_dir() { desktop } else { std::env::temp_dir() }.join("CoA-Friend-Setup.zip");
coa_core::friends::make_friend_package(&root, &host, true, &out)?;
Ok(out.to_string_lossy().into_owned())
@@ -1543,6 +1663,12 @@ async fn export_diagnostics(state: State<'_, AppState>, id: String) -> std::resu
.await
}
#[tauri::command]
async fn list_crashes(state: State<'_, AppState>, id: String, limit: Option<usize>) -> std::result::Result<Vec<coa_core::crashes::CrashItem>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::crashes::list(&root, limit.unwrap_or(10))).await
}
#[tauri::command]
async fn console_tail(
@@ -1554,6 +1680,10 @@ async fn console_tail(
) -> std::result::Result<Vec<coa_core::console::Line>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
// A Docker server's database writes to its container's output, not to a file.
if coa_core::docker::is_docker(&root) && matches!(source, coa_core::console::Source::Database) {
return coa_core::docker::logs::database_log(&root, filter.as_deref(), lines.unwrap_or(300).min(2000));
}
let path = coa_core::console::log_path(&root, &data_dir().join("logs").join("manager.log"), source);
coa_core::console::tail(&path, filter.as_deref(), lines.unwrap_or(300).min(2000))
})
@@ -1590,6 +1720,9 @@ pub fn run() {
.manage(AppState { registry: Registry::at(dir.join("installs.json")), busy: Mutex::new(HashSet::new()), install_cancel: Mutex::new(None), client_cancel: Mutex::new(None) })
.invoke_handler(tauri::generate_handler![
default_install_dir,
game_data_folder,
set_game_data_folder,
install_environment,
scan_server,
add_server,
list_servers,
@@ -1677,9 +1810,14 @@ pub fn run() {
run_diagnostics,
verify_files,
export_diagnostics,
list_crashes,
console_tail,
console_risk,
console_command
console_command,
custom_races_status,
custom_races_install,
custom_races_uninstall,
custom_races_toggle_client
])
.run(tauri::generate_context!())
.expect("error while running CoA Server Manager");
+1 -1
View File
@@ -1,7 +1,7 @@
{
"$schema": "https://schema.tauri.app/config/2",
"productName": "CoA Server Manager",
"version": "0.6.7",
"version": "0.6.15",
"identifier": "com.coa.servermanager",
"build": {
"beforeDevCommand": "npm run dev",
+4
View File
@@ -91,6 +91,10 @@ export {};
if(cmd==="report_targets") return [{id:"manager",repo:"Corfirean/coa-server-manager",ours:true},{id:"companions",repo:"Corfirean/mod-coa-playerbots",ours:true},{id:"squid",repo:"Zyth45/mod-playerbots",ours:false}];
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==="list_crashes") return [];
if(cmd==="game_data_folder") return new URLSearchParams(location.search).get("flavor")==="docker"?"/srv/coa/server-data":null;
if(cmd==="set_game_data_folder") return args.path;
if(cmd==="install_environment"){const docker=new URLSearchParams(location.search).get("flavor")==="docker";return docker?{flavor:"docker",default_dir:"/home/you/CoaServer",docker_problem:new URLSearchParams(location.search).has("nodocker")?"permission denied while trying to connect to the Docker daemon socket":null}:{flavor:"repack",default_dir:"C:\\Games\\CoA Server",docker_problem:null};}
if(cmd==="install_preflight") return {ok:true,problems:[],free_bytes:210*2**30};
if(cmd==="install_requirements") return {download_bytes:Math.round(5.9*2**30),unpacked_bytes:Math.round(11.4*2**30),version:"0.2.0"};
if(cmd==="list_accounts"){const w=window as any;w.__acc=w.__acc??[{id:2,name:"ALICE",access:3,online:true,last_login:"2026-10-01 12:04:11",characters:4},{id:5,name:"BOB",access:0,online:false,last_login:null,characters:0},{id:6,name:"CAROL",access:2,online:false,last_login:"2026-09-30 21:40:02",characters:2}];return w.__acc;}
+16
View File
@@ -195,6 +195,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
"comp.saved": "Gespeichert. {n} Begleiter werden beim Serverstart erstellt.",
// Client
"client.races.install": "Patch für benutzerdefinierte Völker installieren",
"client.title": "Spielclient",
"client.looking": "Suche …",
"client.intro": "Sag dem Manager, wo dein Spiel installiert ist, um einen SPIELEN-Button zu erhalten. Deine Spieldateien werden nie geändert, außer der Serveradresse und dem Begleiter-Addon.",
@@ -867,6 +868,21 @@ const de: Partial<Record<keyof typeof en, string>> = {
"fr.lan.unavailable": "Ausgewählte Adresse nicht verfügbar",
"fr.lan.unavailableText": "Die ausgewählte Adresse ist derzeit keinem erkannten lokalen Netzwerkadapter zugewiesen. Wählen Sie eine andere Adresse oder Automatisch, oder behalten Sie diese Adresse bewusst bei.",
"fr.lan.invalid": "Ungültige IPv4-Adresse",
"unsaved.title": "Nicht gespeicherte Änderungen",
"unsaved.message": "Sie haben nicht gespeicherte Änderungen. Möchten Sie diese vor dem Verlassen der Seite speichern?",
"unsaved.saveFailed": "Änderungen konnten nicht gespeichert werden. Bitte Eingaben überprüfen.",
"crash.autoRestart": "Automatischer Neustart bei Absturz",
"crash.autoRestartDesc": "Startet den Server automatisch neu, falls er unerwartet abstürzt.",
"crash.badge": "Abstürze: {n}",
"crash.historyTitle": "Absturzverlauf des Servers",
"crash.noCrashes": "Keine Absturzberichte gefunden.",
"crash.restartNotice": "Der Server ist abgestürzt und wurde automatisch neu gestartet (Absturz #{n}).",
"crash.loopPaused": "Automatischer Neustart pausiert: Der Server ist mehrfach kurz hintereinander abgestürzt.",
"crash.details": "Absturzdetails",
"crash.viewRaw": "Vollständigen Bericht anzeigen",
"crash.hideRaw": "Vollständigen Bericht verbergen",
"crash.copyReport": "Bericht kopieren",
"crash.copied": "Kopiert!",
};
export default de;
+32
View File
@@ -101,6 +101,7 @@ const en = {
"status.attention": "Needs attention",
"status.running": "Running",
"status.stopped": "Stopped",
"status.crashed": "Stopped unexpectedly",
"btn.start": "START SERVER",
"btn.stop": "STOP SERVER",
@@ -143,6 +144,8 @@ const en = {
"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.message": "A service stopped while starting. Check the details for the cause.",
"err.game_data_mismatch.title": "The game data folder is not the CoA set",
"err.game_data_mismatch.message": "The server stopped because the DBC files in the game data folder are not the ones of the Conquest of Azeroth client. Choose the folder that holds the CoA data (Settings > Game data folder), then start again.",
"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",
@@ -190,6 +193,19 @@ const en = {
"install.localPkg": "Install from a local package folder instead of downloading",
"install.localPkgHint": "(leave empty to download)",
"install.button": "Install",
"gamedata.title": "Game data folder",
"gamedata.text": "The folder with the game's dbc, maps, vmaps and mmaps that this server reads. It is used where it is and never changed. It must be the Conquest of Azeroth set, not the standard one. Stop the server before changing it.",
"gamedata.change": "Change…",
"gamedata.dialog": "Choose the game data folder",
"gamedata.saved": "Saved. It is used the next time the server starts.",
"install.docker.title": "Docker is needed",
"install.docker.text": "On Linux the server runs in Docker. Install Docker and start it, or allow your user to use it, then check again.",
"install.docker.retry": "Check again",
"install.data.label": "Game data folder",
"install.data.hint": "The folder with the game's dbc, maps, vmaps and mmaps. It is used where it is and never changed.",
"install.data.dialogTitle": "Choose the game data folder",
"install.linuxPkg.label": "Server package",
"install.linuxPkg.hint": "A folder or an address of the Linux server package",
"install.progressTitle": "Preparing your server",
"install.progressText": "This can take a few minutes. You can leave this window open.",
"install.step.checking": "Checking your computer",
@@ -230,6 +246,7 @@ const en = {
"comp.saved": "Saved. {n} companions will be created when the server starts.",
// Client
"client.races.install": "Install custom race patch",
"client.title": "Game client",
"client.looking": "Looking…",
"client.intro": "Tell Manager where your game is installed to get a PLAY button. Your game files are never changed except the server address and the companion addon.",
@@ -890,6 +907,21 @@ const en = {
"fr.lan.unavailable": "Selected address unavailable",
"fr.lan.unavailableText": "The selected address is not currently assigned to a detected local interface. Choose another address or switch to Automatic, or keep this address intentionally.",
"fr.lan.invalid": "Invalid IPv4 address",
"unsaved.title": "Unsaved changes",
"unsaved.message": "You have unsaved changes. Do you want to save them before leaving this page?",
"unsaved.saveFailed": "Failed to save changes. Please check fields for errors.",
"crash.autoRestart": "Auto-restart on crash",
"crash.autoRestartDesc": "Automatically restart the world server if it crashes or stops unexpectedly.",
"crash.badge": "Crashes: {n}",
"crash.historyTitle": "Server Crash History",
"crash.noCrashes": "No crash reports found.",
"crash.restartNotice": "Server crashed and was automatically restarted (Crash #{n}).",
"crash.loopPaused": "Auto-restart paused: the server crashed repeatedly in a short period.",
"crash.details": "Crash Details",
"crash.viewRaw": "View full crash report",
"crash.hideRaw": "Hide full report",
"crash.copyReport": "Copy crash report",
"crash.copied": "Copied!",
} as const;
export default en;
+16
View File
@@ -195,6 +195,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
"comp.saved": "Guardado. Se crearán {n} compañeros cuando se inicie el servidor.",
// Client
"client.races.install": "Instalar parche de razas personalizadas",
"client.title": "Cliente del juego",
"client.looking": "Buscando…",
"client.intro": "Indica al Manager dónde está instalado el juego para obtener un botón JUGAR. Tus archivos del juego nunca se modifican, salvo la dirección del servidor y el addon de compañeros.",
@@ -867,6 +868,21 @@ const es: Partial<Record<keyof typeof en, string>> = {
"fr.lan.unavailable": "Dirección seleccionada no disponible",
"fr.lan.unavailableText": "La dirección seleccionada no está asignada actualmente a ninguna interfaz local detectada. Elige otra dirección o Automática, o conserva esta dirección si así lo deseas.",
"fr.lan.invalid": "Dirección IPv4 no válida",
"unsaved.title": "Cambios sin guardar",
"unsaved.message": "¿Tienes cambios sin guardar. ¿Quieres guardarlos antes de salir de esta página?",
"unsaved.saveFailed": "Error al guardar los cambios. Revisa los campos.",
"crash.autoRestart": "Reinicio automático tras caída",
"crash.autoRestartDesc": "Reinicia automáticamente el servidor si se detiene de forma inesperada.",
"crash.badge": "Caídas: {n}",
"crash.historyTitle": "Historial de caídas del servidor",
"crash.noCrashes": "No se encontraron informes de caídas.",
"crash.restartNotice": "El servidor se cayó y se reinició automáticamente (Caída #{n}).",
"crash.loopPaused": "Reinicio automático pausado: el servidor se ha caído varias veces en poco tiempo.",
"crash.details": "Detalles de la caída",
"crash.viewRaw": "Ver informe completo",
"crash.hideRaw": "Ocultar informe completo",
"crash.copyReport": "Copiar informe",
"crash.copied": "¡Copiado!",
};
export default es;
+16
View File
@@ -195,6 +195,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"comp.saved": "Enregistré. {n} compagnons seront créés au démarrage du serveur.",
// Client
"client.races.install": "Installer le patch des races personnalisées",
"client.title": "Client du jeu",
"client.looking": "Recherche…",
"client.intro": "Indiquez au Manager où le jeu est installé pour obtenir un bouton JOUER. Vos fichiers de jeu ne sont jamais modifiés, sauf l’adresse du serveur et l’addon des compagnons.",
@@ -867,6 +868,21 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"fr.lan.unavailable": "Adresse sélectionnée indisponible",
"fr.lan.unavailableText": "Cette adresse n’est actuellement attribuée à aucune interface locale détectée. Choisissez une autre adresse ou le mode Automatique, ou conservez volontairement cette adresse.",
"fr.lan.invalid": "Adresse IPv4 non valide",
"unsaved.title": "Modifications non enregistrées",
"unsaved.message": "Vous avez des modifications non enregistrées. Voulez-vous les enregistrer avant de quitter cette page ?",
"unsaved.saveFailed": "Échec de l’enregistrement. Veuillez vérifier les champs.",
"crash.autoRestart": "Redémarrage automatique en cas de plantage",
"crash.autoRestartDesc": "Redémarre automatiquement le serveur s’il plante ou s’arrête de manière inattendue.",
"crash.badge": "Plantages : {n}",
"crash.historyTitle": "Historique des plantages du serveur",
"crash.noCrashes": "Aucun rapport de plantage trouvé.",
"crash.restartNotice": "Le serveur a planté et a été redémarré automatiquement (Plantage #{n}).",
"crash.loopPaused": "Redémarrage automatique suspendu : le serveur a planté plusieurs fois successivement.",
"crash.details": "Détails du plantage",
"crash.viewRaw": "Afficher le rapport complet",
"crash.hideRaw": "Masquer le rapport complet",
"crash.copyReport": "Copier le rapport",
"crash.copied": "Copié !",
};
export default fr;
+16
View File
@@ -228,6 +228,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"comp.saved": "Сохранено. Компаньоны ({n}) будут созданы при запуске сервера.",
// Client
"client.races.install": "Установить патч кастомных рас",
"client.title": "Клиент игры",
"client.looking": "Ищу…",
"client.intro": "Укажите, где установлена игра, чтобы появилась кнопка «Играть». Файлы игры не изменяются, кроме адреса сервера и аддона компаньонов.",
@@ -888,6 +889,21 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"fr.lan.unavailable": "Выбранный адрес недоступен",
"fr.lan.unavailableText": "Выбранный адрес сейчас не назначен обнаруженному сетевому интерфейсу. Выберите другой адрес, переключитесь на автоматический выбор или намеренно сохраните этот адрес.",
"fr.lan.invalid": "Некорректный IPv4-адрес",
"unsaved.title": "Несохранённые изменения",
"unsaved.message": "У вас есть несохранённые изменения. Сохранить их перед переходом на другую страницу?",
"unsaved.saveFailed": "Не удалось сохранить настройки. Проверьте правильность значений.",
"crash.autoRestart": "Автоподнятие при падении",
"crash.autoRestartDesc": "Автоматически перезапускать сервер при внезапном падении или сбое.",
"crash.badge": "Крашей: {n}",
"crash.historyTitle": "История падений сервера",
"crash.noCrashes": "Отчётов о падениях не найдено.",
"crash.restartNotice": "Сервер упал и был автоматически перезапущен (Сбой #{n}).",
"crash.loopPaused": "Автоподнятие приостановлено: сервер упал несколько раз подряд за короткое время.",
"crash.details": "Подробности сбоя",
"crash.viewRaw": "Показать полный отчёт",
"crash.hideRaw": "Скрыть полный отчёт",
"crash.copyReport": "Скопировать отчёт",
"crash.copied": "Скопировано!",
};
export default ru;
+16
View File
@@ -207,6 +207,7 @@ const zh = {
"comp.saved": "已保存。{n} 名随从将在服务器启动时创建。",
// Client
"client.races.install": "安装自定义种族补丁",
"client.title": "游戏客户端",
"client.looking": "正在寻找…",
"client.intro": "指定游戏客户端安装路径即可启用“开始游戏”按钮。除服务器地址和随从插件外,你的游戏文件绝不会被修改。",
@@ -869,6 +870,21 @@ const zh = {
"fr.lan.unavailable": "所选地址不可用",
"fr.lan.unavailableText": "所选地址目前未分配给检测到的本地网络接口。请选择其他地址、切换到自动,或有意保留此地址。",
"fr.lan.invalid": "无效的 IPv4 地址",
"unsaved.title": "未保存的修改",
"unsaved.message": "您有未保存的修改。是否在离开前保存?",
"unsaved.saveFailed": "保存失败,请检查填写内容。",
"crash.autoRestart": "崩溃后自动重启",
"crash.autoRestartDesc": "如果服务器意外崩溃或停止,自动重新拉起。",
"crash.badge": "崩溃次数: {n}",
"crash.historyTitle": "服务器崩溃记录",
"crash.noCrashes": "未找到崩溃日志。",
"crash.restartNotice": "服务器崩溃并已自动重新拉起(崩溃 #{n})。",
"crash.loopPaused": "自动重启已暂停:服务器在短时间内连续崩溃。",
"crash.details": "崩溃详情",
"crash.viewRaw": "查看完整日志",
"crash.hideRaw": "隐藏完整日志",
"crash.copyReport": "复制崩溃报告",
"crash.copied": "已复制!",
} as const;
export default zh;
+56 -3
View File
@@ -186,6 +186,7 @@ export interface RecoveryPoint {
label: string | null;
created_at: string;
components: { name: string; path: string; bytes: number; tables: number | null; files: string[] | null }[];
mysql_snapshot?: { bytes: number } | null;
}
export interface DbRestore {
@@ -265,6 +266,16 @@ export interface ReportTarget {
ours: boolean;
}
/** The kind of server this computer installs: a repack (Windows) or Docker containers (Linux). */
export type Flavor = "repack" | "docker";
export interface InstallEnvironment {
flavor: Flavor;
default_dir: string;
/** Why Docker cannot be used, in its own words; null when it works. */
docker_problem: string | null;
}
export interface InstallRequirements {
download_bytes: number;
unpacked_bytes: number;
@@ -379,6 +390,23 @@ export interface ClientDownloadCheck {
dest: string;
}
export type ClientPatchState = "not-installed" | "enabled" | "disabled" | "partially-installed";
export interface CustomRacesClientStatus {
version: string | null;
state: ClientPatchState;
installedMpqs: number;
totalMpqs: number;
hasRootFiles: boolean;
clientPath: string | null;
}
export interface CustomRacesProgress {
id: string;
step: string;
percent: number;
}
export type FriendsMode = "local" | "lan" | "direct" | "private";
export interface LanAddress {
@@ -393,7 +421,8 @@ export interface FriendsStatus {
lan_addresses: LanAddress[];
exposure: { port: number; what: string; reachable_from_network: boolean; listening: boolean }[];
servers_open: boolean;
firewall: { auth: boolean; world: boolean };
/** null where there is no Windows firewall to ask about (Linux). */
firewall: { auth: boolean; world: boolean } | null;
tailscale: { installed: boolean; ip: string | null; connected: boolean };
server_running: boolean;
auth_port: number;
@@ -421,6 +450,21 @@ export interface ConsoleLine {
level: "info" | "warn" | "error";
}
export interface CrashItem {
id: string;
timestamp_ms: number;
date_str: string;
title: string;
explanation: string;
category: "assertion" | "access_violation" | "stack_overflow" | "out_of_memory" | "database" | "network" | "exception" | "generic";
exception_code?: string | null;
location?: string | null;
function?: string | null;
condition?: string | null;
preview: string;
full_log: string;
}
export const api = {
remoteConnection: () => invoke<RemoteConnection>("remote_connection"),
remoteConnect: (host: string) => invoke<RemoteConnection>("remote_connect", { host }),
@@ -454,7 +498,11 @@ export const api = {
deleteBackup: (id: string, backupId: string) => invoke<void>("delete_backup", { id, backupId }),
restoreConfigs: (id: string, backupId: string) => invoke<RecoveryPoint>("restore_backup_configs", { id, backupId }),
restoreDatabase: (id: string, backupId: string, database: string) => invoke<DbRestore>("restore_backup_database", { id, backupId, database }),
installPreflight: (dest: string, needed?: number) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null }),
installEnvironment: () => invoke<InstallEnvironment>("install_environment"),
/** The game data folder of a Docker server; null for a repack. */
gameDataFolder: (id: string) => invoke<string | null>("game_data_folder", { id }),
setGameDataFolder: (id: string, path: string) => invoke<string>("set_game_data_folder", { id, path }),
installPreflight: (dest: string, needed?: number, gameData?: string) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null, gameData: gameData ?? null }),
installRequirements: (pkg?: string) => invoke<InstallRequirements>("install_requirements", { package: pkg ?? null }),
realmlistProfiles: (id: string) => invoke<{ profiles: RealmProfile[]; active: string | null }>("realmlist_profiles", { id }),
realmlistSave: (id: string, profileId: string | null, name: string, data: string) => invoke<RealmProfile>("realmlist_save", { id, profileId, name, data }),
@@ -473,7 +521,7 @@ export const api = {
accountSetAccess: (id: string, name: string, level: number) => invoke<void>("account_set_access", { id, name, level }),
accountRename: (id: string, name: string, newName: string, password: string) => invoke<void>("account_rename", { id, name, newName, password }),
accountDelete: (id: string, name: string) => invoke<void>("account_delete", { id, name }),
installNew: (dest: string, pkg?: string) => invoke<ServerSummary>("install_new", { dest, package: pkg ?? null }),
installNew: (dest: string, pkg?: string, gameData?: string) => invoke<ServerSummary>("install_new", { dest, package: pkg ?? null, gameData: gameData ?? null }),
cancelInstall: () => invoke<void>("cancel_install"),
createAccount: (id: string, username: string, password: string, administrator: boolean) =>
invoke<void>("create_account", { id, username, password, administrator }),
@@ -503,6 +551,10 @@ export const api = {
clientSync: (id: string, keepModified: boolean) => invoke<void>("client_sync", { id, keepModified }),
clientDownload: (id: string, parent: string) => invoke<ClientInfo>("client_download", { id, parent }),
clientCancel: () => invoke<void>("client_cancel"),
customRacesStatus: (id: string) => invoke<CustomRacesClientStatus | null>("custom_races_status", { id }),
customRacesUninstall: (id: string) => invoke<void>("custom_races_uninstall", { id }),
customRacesInstall: (id: string) => invoke<void>("custom_races_install", { id }),
customRacesToggleClient: (id: string, enabled: boolean) => invoke<void>("custom_races_toggle_client", { id, enabled }),
play: (id: string) => invoke<DriverOutcome>("play", { id }),
friendsStatus: (id: string) => invoke<FriendsStatus>("friends_status", { id }),
friendsCheckInternet: () => invoke<InternetCheck>("friends_check_internet"),
@@ -512,6 +564,7 @@ export const api = {
runDiagnostics: (id: string) => invoke<{ checks: DiagCheck[]; problems: number }>("run_diagnostics", { id }),
verifyFiles: (id: string) => invoke<{ path: string; kind: "missing" | "changed" }[]>("verify_files", { id }),
exportDiagnostics: (id: string) => invoke<string>("export_diagnostics", { id }),
listCrashes: (id: string, limit?: number) => invoke<CrashItem[]>("list_crashes", { id, limit: limit ?? null }),
consoleTail: (id: string, source: ConsoleSource, filter?: string, lines = 300) =>
invoke<ConsoleLine[]>("console_tail", { id, source, filter: filter ?? null, lines }),
consoleRisk: (command: string) => invoke<"normal" | "dangerous">("console_risk", { command }),
+32
View File
@@ -0,0 +1,32 @@
import { useState } from "react";
const key = (id: string) => `coa-auto-restart-on-crash:${id}`;
const fallback = () => false;
export function autoRestartOnCrash(id: string): boolean {
try {
const value = localStorage.getItem(key(id));
return value === null ? fallback() : value === "1";
} catch {
return fallback();
}
}
export function setAutoRestartOnCrash(id: string, on: boolean) {
try {
localStorage.setItem(key(id), on ? "1" : "0");
} catch {
/* storage unavailable */
}
}
export function useAutoRestart(id: string): [boolean, (on: boolean) => void] {
const [on, setOn] = useState(() => autoRestartOnCrash(id));
return [
on,
(next) => {
setAutoRestartOnCrash(id, next);
setOn(next);
},
];
}
+12
View File
@@ -85,6 +85,18 @@ for (const [key, title, desc] of [
] as [string, string[], string[]][]) add(`Enchanter.${key}`, "int", title, desc, { min: 0, advanced: true });
for (let n = 1; n <= 3; n++) add(`EC.P${n}`, "string", [`NPC phrase ${n}`, `Реплика НПС ${n}`, `NPC-Satz ${n}`, `Phrase du PNJ ${n}`, `Frase del PNJ ${n}`, `NPC台词 ${n}`], ["Text spoken by the NPC. Keep the enclosing quotes.", "Текст реплики НПС. Сохраните кавычки вокруг текста.", "Gesprochener Text. Anführungszeichen beibehalten.", "Texte prononcé. Conservez les guillemets.", "Texto hablado. Conserva las comillas.", "NPC发言内容,请保留外层引号。"], { advanced: true });
add("CoACustomRaces.BotsEnable", "bool",
["Bots can be custom races", "Боты кастомных рас", "Bots benutzerdefinierter Völker", "Bots de races personnalisées", "Bots de razas personalizadas", "允许机器人为自定义种族"],
[
"Allow Playerbots to spawn as custom races (experimental). Off excludes all custom races; on allows stable custom races.",
"Разрешает ботам-игрокам появляться кастомными расами (экспериментально). Выключено — исключает все кастомные расы, включено — разрешает стабильные.",
"Erlaubt Spieler-Bots, benutzerdefinierte Völker zu nutzen (experimentell). Aus schließt alle benutzerdefinierten Völker aus; An erlaubt stabile.",
"Autorise les bots joueurs à s’incarner avec des races personnalisées (expérimental). Désactivé exclut toutes les races personnalisées ; activé autorise les stables.",
"Permite a los bots jugadores crearse con razas personalizadas (experimental). Desactivado excluye todas las razas personalizadas; activado permite las estables.",
"允许玩家机器人扮演自定义种族(实验性)。关闭将排除所有自定义种族,开启允许稳定的自定义种族。"
]
);
const ah = "AuctionHouseBot.";
add(ah + "GUIDs", "string", ["Auction characters", "Персонажи аукциона", "Auktionscharaktere", "Personnages d’enchères", "Personajes de subasta", "拍卖角色"], ["Leave 0 and the server creates and uses its own auction character. To use your own, enter GUIDs separated by commas, without spaces; use dedicated offline characters, not companion bots.", "Оставьте 0, и сервер сам создаст и будет использовать своего персонажа аукциона. Чтобы использовать своих, укажите GUID через запятую без пробелов; нужны отдельные офлайн-персонажи, не боты-компаньоны.", "Bei 0 legt der Server selbst einen Auktionscharakter an und nutzt ihn. Eigene Charaktere: GUIDs durch Kommas, ohne Leerzeichen; separate Offline-Charaktere verwenden, keine Begleiter-Bots.", "Laissez 0 : le serveur crée et utilise son propre personnage d’enchères. Pour les vôtres, indiquez des GUID séparés par des virgules sans espaces ; personnages dédiés hors ligne, pas des bots compagnons.", "Deja 0 y el servidor crea y usa su propio personaje de subastas. Para usar los tuyos, indica GUID separados por comas sin espacios; personajes dedicados desconectados, no bots acompañantes.", "保持0时由服务器自动创建并使用拍卖角色。要使用自己的角色,请以逗号分隔填写GUID,不加空格;使用专用离线角色,勿用伙伴机器人。"], { advanced: true });
add(ah + "EnableSeller", "bool", ["Post auctions", "Выставлять лоты", "Auktionen einstellen", "Publier des enchères", "Publicar subastas", "发布拍卖"], ["Let the auction characters sell items. The module switch is also required.", "Разрешает персонажам продавать предметы. Нужен включённый модуль.", "Erlaubt Verkäufe. Der Modulschalter muss ebenfalls aktiv sein.", "Autorise les ventes. Le module doit aussi être activé.", "Permite vender. También requiere el módulo activado.", "允许拍卖角色出售物品,还需启用模块。"]);
+5
View File
@@ -0,0 +1,5 @@
export interface UnsavedChangesGuard {
isDirty: () => boolean;
save: () => Promise<boolean>;
discard: () => void;
}
+24
View File
@@ -0,0 +1,24 @@
import { Card } from "@/components/ui/card";
import { useT } from "@/i18n";
import { useAutoRestart } from "@/lib/autoRestartPrefs";
export function AutoRestartSettings({ serverId }: { serverId: string }) {
const t = useT();
const [autoRestart, setAutoRestart] = useAutoRestart(serverId);
return (
<Card className="mt-6 p-6">
<h2 className="font-semibold">{t("crash.autoRestart")}</h2>
<label className="mt-3 flex cursor-pointer items-center gap-3">
<input
type="checkbox"
checked={autoRestart}
onChange={(e) => setAutoRestart(e.target.checked)}
className="h-4 w-4 accent-[#c9a24a]"
/>
<span className="text-sm font-medium">{t("crash.autoRestart")}</span>
</label>
<p className="mt-2 text-sm text-muted">{t("crash.autoRestartDesc")}</p>
</Card>
);
}
+1 -1
View File
@@ -198,7 +198,7 @@ export function BackupsPage({ serverId }: { serverId: string }) {
<div>
<p className="font-medium">{p.label && p.trigger === "manual" && p.label !== "e2e" ? p.label : trigger(p.trigger)}</p>
<p className="text-sm text-muted">
{w(p.created_at)} · {p.realm === "wildcard" ? "Wildcard" : "CoA"} · {t(`bk.kind.${p.kind}` as Key)} · {size(p.components.reduce((a, c) => a + c.bytes, 0))}
{w(p.created_at)} · {p.realm === "wildcard" ? "Wildcard" : "CoA"} · {t(`bk.kind.${p.kind}` as Key)} · {size(p.components.reduce((a, c) => a + c.bytes, p.mysql_snapshot?.bytes ?? 0))}
</p>
</div>
<div className="flex shrink-0 gap-1">
+9
View File
@@ -1,4 +1,5 @@
import { useEffect, useState } from "react";
import { listen } from "@tauri-apps/api/event";
import { open } from "@tauri-apps/plugin-dialog";
import { api, asUiError, type ClientInfo, type ClientStatus, type UiError } from "@/lib/api";
import { checkClient } from "@/lib/clientUpdate";
@@ -16,6 +17,7 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
const [note, setNote] = useState<string | null>(null);
const [busy, setBusy] = useState(false);
const [status, setStatus] = useState<ClientStatus | null>(null);
const [patchProgress, setPatchProgress] = useState<string | null>(null);
const [dialog, setDialog] = useState<ClientDialogMode | null>(null);
const [playAfter, setPlayAfter] = useStartAfterUpdate("client", serverId);
@@ -25,6 +27,10 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
};
useEffect(() => {
void refresh();
const unlisten = listen<{ id: string; step: string; percent: number }>("custom-races-progress", e => {
if (e.payload.id === serverId) setPatchProgress(`${e.payload.step} (${Math.round(e.payload.percent * 100)}%)`);
});
return () => { void unlisten.then(f => f()); };
}, [serverId]); // eslint-disable-line react-hooks/exhaustive-deps
async function run(fn: () => Promise<string | void>) {
@@ -40,6 +46,7 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
setError(asUiError(e));
} finally {
setBusy(false);
setPatchProgress(null);
}
}
@@ -111,11 +118,13 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
{status && !status.managed && (
<Button size="sm" disabled={busy} onClick={() => setDialog("track")}>{t("client.track.button")}</Button>
)}
{remote && <Button size="sm" disabled={busy} onClick={() => void run(() => api.customRacesInstall(serverId))}>{t("client.races.install")}</Button>}
<Button size="sm" variant="ghost" disabled={busy} onClick={() => void choose()}>{t("client.changeFolder")}</Button>
<Button size="sm" variant="ghost" disabled={busy} onClick={() => setDialog("setup")}>{t("client.downloadInstead")}</Button>
</div>
</>
)}
{patchProgress && <p className="mt-3 text-sm text-muted" role="status">{patchProgress}</p>}
{note && <p className="mt-3 text-sm text-ok" role="status">{note}</p>}
{error && <p className="mt-3 text-sm text-bad" role="alert">{error.human.code === "unknown" ? error.technical : human(error.human).message}</p>}
{dialog && (
+198
View File
@@ -0,0 +1,198 @@
import { useEffect, useState } from "react";
import { AlertTriangle, Check, ChevronDown, ChevronUp, Copy, Loader2, X } from "lucide-react";
import { api, type CrashItem } from "@/lib/api";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useT } from "@/i18n";
export function CrashHistoryModal({
serverId,
onClose,
}: {
serverId: string;
onClose: () => void;
}) {
const t = useT();
const [loading, setLoading] = useState(true);
const [crashes, setCrashes] = useState<CrashItem[]>([]);
const [expandedId, setExpandedId] = useState<string | null>(null);
const [copiedId, setCopiedId] = useState<string | null>(null);
useEffect(() => {
let alive = true;
void api
.listCrashes(serverId, 30)
.then((items) => {
if (alive) {
setCrashes(items);
setLoading(false);
}
})
.catch(() => {
if (alive) setLoading(false);
});
return () => {
alive = false;
};
}, [serverId]);
useEffect(() => {
const onKey = (e: KeyboardEvent) => {
if (e.key === "Escape") onClose();
};
window.addEventListener("keydown", onKey);
return () => window.removeEventListener("keydown", onKey);
}, [onClose]);
const copyReport = async (item: CrashItem) => {
try {
await navigator.clipboard.writeText(item.full_log);
setCopiedId(item.id);
setTimeout(() => setCopiedId(null), 2500);
} catch {
/* clipboard write failed */
}
};
const getCategoryColor = (category: CrashItem["category"]) => {
switch (category) {
case "assertion":
return "bg-amber-500/15 text-amber-400 border-amber-500/30";
case "access_violation":
case "stack_overflow":
case "out_of_memory":
return "bg-bad/15 text-bad border-bad/30";
case "network":
case "database":
return "bg-blue-500/15 text-blue-400 border-blue-500/30";
default:
return "bg-muted/15 text-muted border-line";
}
};
return (
<div
className="fixed inset-0 z-50 flex items-center justify-center bg-black/60 p-4 md:p-6"
role="presentation"
onClick={(e) => {
if (e.target === e.currentTarget) onClose();
}}
>
<Card
className="flex max-h-[85vh] w-full max-w-2xl flex-col p-6 shadow-2xl"
role="dialog"
aria-modal="true"
aria-label={t("crash.historyTitle")}
>
<div className="flex items-center justify-between border-b border-line pb-4">
<div className="flex items-center gap-2.5">
<AlertTriangle className="h-5 w-5 text-warn" aria-hidden />
<h2 className="text-lg font-semibold">{t("crash.historyTitle")}</h2>
</div>
<button
type="button"
onClick={onClose}
className="cursor-pointer text-muted transition-colors hover:text-ink"
aria-label={t("btn.close")}
>
<X className="h-5 w-5" aria-hidden />
</button>
</div>
<div className="flex-1 overflow-y-auto py-4">
{loading ? (
<div className="flex items-center justify-center py-12 text-muted">
<Loader2 className="h-6 w-6 animate-spin" aria-hidden />
</div>
) : crashes.length === 0 ? (
<div className="py-12 text-center text-muted">
<p>{t("crash.noCrashes")}</p>
</div>
) : (
<div className="space-y-4">
{crashes.map((item) => {
const isExpanded = expandedId === item.id;
const isCopied = copiedId === item.id;
return (
<div
key={item.id}
className="rounded-lg border border-line bg-card-2 p-4 text-sm transition-all"
>
<div className="flex flex-wrap items-start justify-between gap-2">
<div>
<span
className={`inline-block rounded border px-2 py-0.5 text-xs font-medium uppercase tracking-wide ${getCategoryColor(
item.category,
)}`}
>
{item.exception_code ? `${item.category} (${item.exception_code})` : item.category}
</span>
<h3 className="mt-1.5 font-semibold text-ink">{item.title}</h3>
</div>
<span className="text-xs text-muted tabular-nums">{item.date_str}</span>
</div>
<p className="mt-2 text-xs leading-relaxed text-muted">{item.explanation}</p>
<div className="mt-3 flex items-center justify-between border-t border-line/50 pt-2.5">
<button
type="button"
onClick={() => setExpandedId(isExpanded ? null : item.id)}
className="inline-flex cursor-pointer items-center gap-1.5 text-xs font-medium text-gold transition-colors hover:underline"
>
{isExpanded ? (
<>
<ChevronUp className="h-3.5 w-3.5" aria-hidden />
{t("crash.hideRaw")}
</>
) : (
<>
<ChevronDown className="h-3.5 w-3.5" aria-hidden />
{t("crash.viewRaw")}
</>
)}
</button>
<Button
variant="ghost"
size="sm"
onClick={() => void copyReport(item)}
className="h-7 gap-1.5 px-2 text-xs text-muted hover:text-ink"
>
{isCopied ? (
<>
<Check className="h-3.5 w-3.5 text-ok" aria-hidden />
<span className="text-ok">{t("crash.copied")}</span>
</>
) : (
<>
<Copy className="h-3.5 w-3.5" aria-hidden />
<span>{t("crash.copyReport")}</span>
</>
)}
</Button>
</div>
{isExpanded && (
<div className="mt-3">
<pre className="selectable max-h-56 overflow-x-auto overflow-y-auto rounded border border-line bg-black/40 p-3 font-mono text-[11px] leading-relaxed text-muted">
{item.full_log}
</pre>
</div>
)}
</div>
);
})}
</div>
)}
</div>
<div className="flex justify-end border-t border-line pt-4">
<Button variant="secondary" onClick={onClose}>
{t("btn.close")}
</Button>
</div>
</Card>
</div>
);
}
Loaded 100 of 110 files, more files were not shown because too many files have changed in this diff. Show more