mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-18 19:25:56 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
cda7875a9a | ||
|
|
f53c7cb221 | ||
|
|
ca6bcf0052 | ||
|
|
d6a6384f9c | ||
|
|
21ddc1e7d8 | ||
|
|
16396407ad | ||
|
|
093dbfcadc | ||
|
|
dc323df681 | ||
|
|
46785f7978 | ||
|
|
97c024d95c | ||
|
|
52b80232fa | ||
|
|
be2f252593 | ||
|
|
24d593d787 | ||
|
|
4a9760b864 | ||
|
|
482bbfcdfd | ||
|
|
b45e2502ec | ||
|
|
6a955bd670 | ||
|
|
d5f441de0c | ||
|
|
4efc02e768 | ||
|
|
be9641254a | ||
|
|
c18daac228 | ||
|
|
89c62abf80 | ||
|
|
a6471d79d0 | ||
|
|
fd0eaafda2 | ||
|
|
fb1cc38773 | ||
|
|
7a950f234b | ||
|
|
2f1df13b7a | ||
|
|
be705329c1 | ||
|
|
7e70409ca0 | ||
|
|
9e6a650d13 | ||
|
|
0398a5a6f9 | ||
|
|
dd23e81dd4 | ||
|
|
ca2a555d7c | ||
|
|
8269a53db7 | ||
|
|
b97f86fc00 | ||
|
|
1a71f18def | ||
|
|
358f9f4f2b | ||
|
|
0c0d2db368 | ||
|
|
7d7bc530ec | ||
|
|
acd04fae2f | ||
|
|
106a532092 | ||
|
|
d86a1676fe | ||
|
|
53a05820c8 | ||
|
|
58c976a388 | ||
|
|
35c4d03bdc | ||
|
|
c45f962d02 | ||
|
|
f52bd8ba5f | ||
|
|
247159e56c | ||
|
|
cdd5be2365 | ||
|
|
7e170744bf | ||
|
|
10daa9b74d | ||
|
|
51ef88101e | ||
|
|
ed7bf7262b | ||
|
|
7c866b116d | ||
|
|
4d8ca00e46 | ||
|
|
36bfc6d31e | ||
|
|
3fb4ee39c6 | ||
|
|
0250b61c62 | ||
|
|
dfd8a50975 | ||
|
|
90c308615b | ||
|
|
cfea54e203 | ||
|
|
57aa97da8a | ||
|
|
b9f89a4ae4 | ||
|
|
6fd2130fc4 | ||
|
|
346d97ee89 | ||
|
|
10a6744192 | ||
|
|
7557b347c5 | ||
|
|
2abd64dfe2 | ||
|
|
9ae5fb471b | ||
|
|
59036867d7 | ||
|
|
949614f11a | ||
|
|
9ee0e9f6af | ||
|
|
3405c89fe8 | ||
|
|
4c4d39f1de | ||
|
|
b101c79e96 | ||
|
|
3b7f77d92e | ||
|
|
0589722e71 | ||
|
|
a3717c08bb | ||
|
|
dc2bffc57e | ||
|
|
e34ab45443 | ||
|
|
40f9feab84 | ||
|
|
5b16842720 | ||
|
|
02843bb6d1 | ||
|
|
a9ab7ced7e | ||
|
|
77318895ae | ||
|
|
115c57f54e | ||
|
|
94fd5fb5b9 | ||
|
|
94d4ade1c7 | ||
|
|
376f1dbb46 | ||
|
|
b0951dbee7 | ||
|
|
374a3f9c23 | ||
|
|
d20d5a6410 | ||
|
|
1228807eaf | ||
|
|
ee59708fbf | ||
|
|
3ed9c5dacd | ||
|
|
9099168927 | ||
|
|
a27e0eb6ab | ||
|
|
c46edd2feb | ||
|
|
f934bef303 | ||
|
|
c882a21334 | ||
|
|
a625b065cf | ||
|
|
5c3a9def0c | ||
|
|
25098b5a63 | ||
|
|
45a699d2ca | ||
|
|
be68eb4341 | ||
|
|
06ca748e80 | ||
|
|
58c1e1aee0 | ||
|
|
ad69fb0401 | ||
|
|
7540527d30 | ||
|
|
5328709826 | ||
|
|
478ea8a960 | ||
|
|
c8a0f6872f | ||
|
|
c3791f80f1 | ||
|
|
1acbcc2bb5 | ||
|
|
838cc07e73 | ||
|
|
4c4f8bbb3e | ||
|
|
d85d86a3dc | ||
|
|
0a050a40a2 | ||
|
|
017b977bfa | ||
|
|
337418afe0 | ||
|
|
f920ff8a59 | ||
|
|
072a657649 | ||
|
|
c6e8a34509 | ||
|
|
3f98ba3add | ||
|
|
7a3fefaafd | ||
|
|
fac6ce469a | ||
|
|
f22cedd963 | ||
|
|
0b5f12941c | ||
|
|
f3fc14b55a | ||
|
|
beaec7d27e | ||
|
|
8490dc9983 | ||
|
|
3f8abcbbe8 | ||
|
|
b3c50a7b39 | ||
|
|
bbdad37e40 | ||
|
|
0ed4d5e268 | ||
|
|
b13ee55bb9 | ||
|
|
51a45db8cb | ||
|
|
3f700ee8f4 | ||
|
|
f25a1d425d | ||
|
|
b5e4a38d7d |
No files matched your search
@@ -4,3 +4,5 @@ dist
|
||||
*.log
|
||||
.env
|
||||
src-tauri/gen
|
||||
# Disposable database fixtures and private recovery data
|
||||
.cache/
|
||||
Generated
+14
-3
@@ -491,7 +491,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-core"
|
||||
version = "0.6.5"
|
||||
version = "0.6.19"
|
||||
dependencies = [
|
||||
"base64 0.22.1",
|
||||
"chrono",
|
||||
@@ -499,6 +499,7 @@ dependencies = [
|
||||
"ed25519-dalek",
|
||||
"fs4",
|
||||
"hex",
|
||||
"if-addrs",
|
||||
"num-bigint",
|
||||
"rand_core",
|
||||
"reqwest 0.12.28",
|
||||
@@ -519,7 +520,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-release"
|
||||
version = "0.6.5"
|
||||
version = "0.6.19"
|
||||
dependencies = [
|
||||
"chrono",
|
||||
"coa-core",
|
||||
@@ -528,7 +529,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "coa-server-manager"
|
||||
version = "0.6.5"
|
||||
version = "0.6.19"
|
||||
dependencies = [
|
||||
"coa-core",
|
||||
"serde",
|
||||
@@ -1913,6 +1914,16 @@ dependencies = [
|
||||
"icu_properties",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "if-addrs"
|
||||
version = "0.15.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c0a05c691e1fae256cf7013d99dad472dc52d5543322761f83ec8d47eab40d2b"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"windows-sys 0.61.2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "indexmap"
|
||||
version = "1.9.3"
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@ resolver = "2"
|
||||
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
|
||||
|
||||
[workspace.package]
|
||||
version = "0.6.5"
|
||||
version = "0.6.19"
|
||||
edition = "2021"
|
||||
license = "AGPL-3.0-only"
|
||||
|
||||
|
||||
@@ -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: Install a server from a package on Linux, running in Docker (experimental)
|
||||
---
|
||||
Experimental. The Manager creates the database, imports the packaged baseline and starts the server in Docker containers. It needs a Linux server package and your own game data folder.
|
||||
@@ -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,8 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: The Auction House Bot card no longer asks for a character GUID
|
||||
---
|
||||
Turning the module and the seller on is enough: a server build with the automatic auction character creates its own account and character. The GUID field moved to the advanced settings.
|
||||
The buyer option hint no longer says it spends the auction character's gold.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Choose and remember the local network address friends use to connect
|
||||
---
|
||||
Select an adapter or custom IPv4 address when sharing on LAN. Your choice survives restarts and mode changes; unavailable addresses show a warning instead of silently switching adapters.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: The NPC Enchanter card explains how to place and remove the NPC
|
||||
---
|
||||
The card now shows the two commands: `.npc add 601015` where you stand, and `.npc delete` on the targeted NPC.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Diagnostic files with database checks stay readable after secrets are removed
|
||||
---
|
||||
Removing a line that mentioned a secret could break the JSON files in a diagnostic package. Secret values are now replaced instead, so the files stay valid.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: One button collects all diagnostics, including crashes and Windows crash records
|
||||
---
|
||||
Report a problem collects logs, crash reports and small dumps, Windows crash records, update journals and the running server programs in one file, then shows its folder. Crashes without a server crash report are no longer missing.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Problem reports go to the right project
|
||||
---
|
||||
Choose what the problem is about: Manager and other modules, CoA Companions, or SQUID Playerbots. The report opens in that project's GitHub page with the versions filled in. The bot system that is switched on is preselected.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: Choose where backups are stored, for example on another drive
|
||||
---
|
||||
Backups can now live in any folder outside the server folder. Existing backups stay listed. A backups folder that you moved and linked from the old place also works again for updates.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Bot settings with a fixed list of values show a drop-down
|
||||
---
|
||||
SQUID bots 1.9 describes the chat language as a list of languages. The Manager shows it as a drop-down with names instead of a bare number.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: The bot dashboard loads completely and can be opened in the browser
|
||||
---
|
||||
The dashboard no longer fails on large pages, starts again after a crash left its history files empty, and its Open in the browser button works. With both realms started together the realm drop-down is hidden.
|
||||
@@ -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: fixed
|
||||
audience: admins
|
||||
title: Accounts of the SQUID bots are hidden from the Accounts list
|
||||
---
|
||||
The RNDBOT accounts that hold the random bots no longer fill the Accounts tab, and they cannot be renamed or deleted from there.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: A Dashboard tab shows what the SQUID bots are doing
|
||||
---
|
||||
With SQUID Playerbots on, the Dashboard tab downloads the dashboard release that matches your bots, starts it on this computer and shows it inside the Manager.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: added
|
||||
audience: admins
|
||||
title: A stopped server stays stopped after an update, unless you ask it to start
|
||||
---
|
||||
Updating no longer leaves a server running that was stopped before. Settings has a switch to start it afterwards, and the client card has one to open the game after a client update.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Checking for updates no longer fails with "Something went wrong" after a crash
|
||||
---
|
||||
A crash or power loss could leave a damaged status file that made every database start fail. The Manager now removes such files itself, still compares the files when the database is unavailable, and shows the real reason.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server updates no longer stop with "has a different checksum" on the Wildcard repair
|
||||
---
|
||||
Servers that applied one of the two published versions of the Wildcard table repair can now update to the other. Nothing in the database changes.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: A world server started from the coa-bots folder is recognised
|
||||
---
|
||||
The Manager no longer reports a port conflict when the world server runs from the coa-bots folder inside the server folder, and a failed update now says that undoing it can take several minutes.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Already running MySQL is recognized before startup readiness checks
|
||||
---
|
||||
A verified MySQL listener replaces a stale or supervisor-only launcher record before startup. Existing databases are reused instead of waiting for a port owned by a different process from the same executable.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: New servers install the current stable build directly
|
||||
---
|
||||
A clean installation downloads the complete package of the selected stable release, including its prepared database. It no longer installs an old base and asks for a separate update. Missing or mismatched full packages stop installation before changing the destination.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: players
|
||||
title: Install the matching client patches for Grummle
|
||||
---
|
||||
Custom race installation includes the new Grummle appearance and voices while retaining the existing race assets. Older installations can still be safely switched off or removed.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Failed repairs restore the previous server after final verification errors
|
||||
---
|
||||
Errors after file replacement now undo the repair using its verified recovery point, including final file or database check errors. If recovery fails, the journal retains the cause and further server actions remain blocked.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Failed server updates show an error on the Overview screen
|
||||
---
|
||||
The error stays visible after the progress bar disappears, with technical details and a copy button. Recovery-state errors are shown there too.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: changed
|
||||
audience: admins
|
||||
title: Private update checks show preparation stages and stop failure details
|
||||
---
|
||||
Private-copy preparation reports checked and copied file counts, database tests and startup stages. Failed shutdown reports the server folder, remaining processes and launcher reason. Port conflicts identify the owning process and executable.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Repair recovery copies preserve all bundled database objects and accounts
|
||||
---
|
||||
Windows repairs now save a verified copy of stopped MySQL before changing server files or SQL. Recovery preserves procedures, triggers, views and database accounts as well as player rows.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Server checks report interrupted SQUID database imports
|
||||
---
|
||||
Check and Repair now report SQUID pending imports and missing bot character tables separately from package migrations. Interrupted imports retain their records and require verified database recovery.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Shutdown remains available when startup templates or database records are damaged
|
||||
---
|
||||
Stop uses existing shutdown settings instead of rendering startup templates. Missing or stale MySQL records are recovered only from the exact installed executable and its owned port; foreign processes are never adopted.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Successful server repairs no longer block later server actions
|
||||
---
|
||||
Repair verifies restored files before completing its recovery record. Older completed repair records are accepted only when every repaired file still matches its expected content.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Older servers find a tested intermediate update instead of being blocked
|
||||
---
|
||||
When the latest release cannot update an older server directly, Manager offers a signed intermediate release from its compatibility matrix and explains how to continue to the latest version.
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
area: manager
|
||||
type: fixed
|
||||
audience: admins
|
||||
title: Update checks no longer download a server archive to compare its launcher
|
||||
---
|
||||
Manager recognizes its supported launcher edits against the signed file hash locally. Overlapping checks wait briefly for one another, and the private update copy checks combined program and database space before copying.
|
||||
@@ -25,6 +25,7 @@ zip = { version = "2", default-features = false, features = ["deflate"] }
|
||||
sha1 = "0.10"
|
||||
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "std"] }
|
||||
tempfile = "3"
|
||||
if-addrs = "0.15"
|
||||
|
||||
[dev-dependencies]
|
||||
rand_core = { version = "0.6", features = ["getrandom"] }
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
//! Install a new Docker server from a package folder, for a manual end-to-end check on Linux (needs docker).
|
||||
//! usage: docker_install <package folder> <destination> <game data folder> <public key (base64)>
|
||||
//! The key is the one the package was signed with (the production key is only used by the Manager itself).
|
||||
use coa_core::docker::install::{install, Params};
|
||||
use coa_core::download::Cancel;
|
||||
use coa_core::install::Source;
|
||||
use coa_core::registry::Registry;
|
||||
use std::path::PathBuf;
|
||||
|
||||
fn main() {
|
||||
let a: Vec<String> = std::env::args().skip(1).collect();
|
||||
assert!(a.len() == 4, "usage: docker_install <package folder> <destination> <game data folder> <public key>");
|
||||
let registry = Registry::at(std::env::temp_dir().join("coa-docker-install/installs.json"));
|
||||
let t = std::time::Instant::now();
|
||||
let done = install(
|
||||
&Params { source: Source::Dir(PathBuf::from(&a[0])), dest: PathBuf::from(&a[1]), data_dir: PathBuf::from(&a[2]), trusted_key: &a[3], registry: ®istry, cancel: Cancel::default() },
|
||||
&|s| eprintln!(" {:>3}% {} {}", s.percent, s.step, s.detail.unwrap_or_default()),
|
||||
)
|
||||
.unwrap_or_else(|e| panic!("install failed: {e}"));
|
||||
println!("installed {} at {} in {:?}", done.version, done.path, t.elapsed());
|
||||
}
|
||||
@@ -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(())
|
||||
}
|
||||
@@ -27,7 +27,18 @@ const LIST_SQL: &str = "SELECT a.id, a.username, \
|
||||
a.online, IFNULL(a.last_login, ''), \
|
||||
(SELECT COUNT(*) FROM acore_characters.characters c WHERE c.account = a.id) \
|
||||
FROM acore_auth.account a \
|
||||
WHERE a.username NOT LIKE 'COABOTHOST%' AND a.username <> 'COAMANAGER' ORDER BY a.id;";
|
||||
WHERE a.username NOT LIKE 'COABOTHOST%' AND a.username <> 'COAMANAGER' AND a.username NOT LIKE '{SQUID}%' ORDER BY a.id;";
|
||||
|
||||
/// The accounts of SQUID's random bots share a name prefix (`AiPlayerbot.RandomBotAccountPrefix`, default `rndbot`).
|
||||
/// They belong to the bot system like the companions' accounts and are never listed or touched here.
|
||||
pub fn squid_bot_prefix(root: &Path) -> String {
|
||||
std::fs::read(root.join("Core/configs/modules/playerbots.conf"))
|
||||
.ok()
|
||||
.and_then(|bytes| crate::config::parser::ConfFile::parse_bytes(&bytes).ok())
|
||||
.and_then(|conf| conf.get("AiPlayerbot.RandomBotAccountPrefix").map(|v| crate::config::parser::unquote(v).to_string()))
|
||||
.filter(|prefix| !prefix.is_empty() && prefix.len() <= 32 && prefix.chars().all(|c| c.is_ascii_alphanumeric()))
|
||||
.unwrap_or_else(|| "rndbot".into())
|
||||
}
|
||||
|
||||
/// Rows of tab-separated columns as the `mysql` client prints them.
|
||||
pub fn parse_list(out: &str) -> Vec<AccountInfo> {
|
||||
@@ -51,7 +62,7 @@ pub fn parse_list(out: &str) -> Vec<AccountInfo> {
|
||||
|
||||
pub fn list(root: &Path) -> Result<Vec<AccountInfo>> {
|
||||
let db = Db::from_repack(root, Account::Admin)?;
|
||||
Ok(parse_list(&db.query(LIST_SQL)?))
|
||||
Ok(parse_list(&db.query(&LIST_SQL.replace("{SQUID}", &squid_bot_prefix(root).to_ascii_uppercase()))?))
|
||||
}
|
||||
|
||||
fn upper(name: &str) -> Result<String> {
|
||||
@@ -64,6 +75,9 @@ fn upper(name: &str) -> Result<String> {
|
||||
pub fn rename(root: &Path, ra: &mut Ra, old: &str, new: &str, password: &str) -> Result<()> {
|
||||
let (old, new) = (upper(old)?, upper(new)?);
|
||||
validate_account(&new, password)?;
|
||||
if is_reserved(&old) || old.starts_with(&squid_bot_prefix(root).to_ascii_uppercase()) {
|
||||
return Err(Error::Invalid("This account belongs to the Manager or the bots and cannot be renamed.".into()));
|
||||
}
|
||||
if old == new {
|
||||
return Err(Error::Invalid("That is already the name of this account.".into()));
|
||||
}
|
||||
@@ -93,8 +107,8 @@ fn is_reserved(upper_name: &str) -> bool {
|
||||
/// companions' own accounts, an account that is not there and one that is logged in right now.
|
||||
pub fn delete(root: &Path, ra: &mut Ra, name: &str) -> Result<()> {
|
||||
let name = upper(name)?;
|
||||
if is_reserved(&name) {
|
||||
return Err(Error::Invalid("This account belongs to the Manager or the companions and cannot be deleted.".into()));
|
||||
if is_reserved(&name) || name.starts_with(&squid_bot_prefix(root).to_ascii_uppercase()) {
|
||||
return Err(Error::Invalid("This account belongs to the Manager or the bots and cannot be deleted.".into()));
|
||||
}
|
||||
let db = Db::from_repack(root, Account::Admin)?;
|
||||
match db.query(&format!("SELECT online FROM acore_auth.account WHERE username = '{name}';"))?.trim() {
|
||||
@@ -125,7 +139,19 @@ mod tests {
|
||||
|
||||
#[test]
|
||||
fn the_internal_accounts_are_filtered_out_by_the_query() {
|
||||
assert!(LIST_SQL.contains("COABOTHOST%") && LIST_SQL.contains("COAMANAGER"));
|
||||
assert!(LIST_SQL.contains("COABOTHOST%") && LIST_SQL.contains("COAMANAGER") && LIST_SQL.contains("{SQUID}%"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_squid_bot_prefix_comes_from_the_bot_settings_and_defaults_to_rndbot() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
assert_eq!(squid_bot_prefix(root.path()), "rndbot");
|
||||
let conf = root.path().join("Core/configs/modules/playerbots.conf");
|
||||
std::fs::create_dir_all(conf.parent().unwrap()).unwrap();
|
||||
std::fs::write(&conf, "AiPlayerbot.RandomBotAccountPrefix = \"MyBots\"\n").unwrap();
|
||||
assert_eq!(squid_bot_prefix(root.path()), "MyBots");
|
||||
std::fs::write(&conf, "AiPlayerbot.RandomBotAccountPrefix = \"x' OR 1=1 --\"\n").unwrap();
|
||||
assert_eq!(squid_bot_prefix(root.path()), "rndbot", "an unsafe prefix is ignored");
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
@@ -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"] {
|
||||
|
||||
@@ -67,12 +67,86 @@ 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>,
|
||||
}
|
||||
|
||||
fn backups_dir(meta: &Path) -> PathBuf {
|
||||
const LOCATION_FILE: &str = "backup-location.json";
|
||||
|
||||
#[derive(Serialize, Deserialize)]
|
||||
struct StoredLocation {
|
||||
path: String,
|
||||
}
|
||||
|
||||
fn default_dir(meta: &Path) -> PathBuf {
|
||||
meta.join("backups")
|
||||
}
|
||||
|
||||
/// The folder the owner chose for backups (for example on another drive), if any.
|
||||
fn custom_dir(meta: &Path) -> Option<PathBuf> {
|
||||
let stored: StoredLocation = fsx::read_json(&meta.join(LOCATION_FILE)).ok()?;
|
||||
let path = PathBuf::from(stored.path.trim());
|
||||
path.is_absolute().then_some(path)
|
||||
}
|
||||
|
||||
/// Where new backups go.
|
||||
fn backups_dir(meta: &Path) -> PathBuf {
|
||||
custom_dir(meta).unwrap_or_else(|| default_dir(meta))
|
||||
}
|
||||
|
||||
/// Every folder that may hold backups: the chosen one first, then the default one, so backups made before the
|
||||
/// folder was changed stay visible and restorable.
|
||||
fn backup_roots(meta: &Path) -> Vec<PathBuf> {
|
||||
let mut roots: Vec<PathBuf> = custom_dir(meta).into_iter().collect();
|
||||
let default = default_dir(meta);
|
||||
if !roots.contains(&default) { roots.push(default); }
|
||||
roots
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct BackupLocation {
|
||||
pub path: String,
|
||||
pub default_path: String,
|
||||
pub is_default: bool,
|
||||
}
|
||||
|
||||
pub fn location(meta: &Path) -> BackupLocation {
|
||||
let default = default_dir(meta);
|
||||
let current = backups_dir(meta);
|
||||
BackupLocation { is_default: current == default, path: current.to_string_lossy().into_owned(), default_path: default.to_string_lossy().into_owned() }
|
||||
}
|
||||
|
||||
/// Choose where new backups are stored (`None` = the default folder next to the server). Existing backups stay where
|
||||
/// they are and remain listed.
|
||||
pub fn set_location(root: &Path, meta: &Path, path: Option<&str>) -> Result<BackupLocation> {
|
||||
let _lock = crate::update::operation_lock(meta)?;
|
||||
crate::update::ensure_recovered(meta)?;
|
||||
match path.map(str::trim).filter(|p| !p.is_empty()) {
|
||||
None => {
|
||||
let file = meta.join(LOCATION_FILE);
|
||||
if file.exists() { fs::remove_file(file)?; }
|
||||
}
|
||||
Some(chosen) => {
|
||||
let dir = PathBuf::from(chosen);
|
||||
if !dir.is_absolute() { return Err(Error::Invalid("Choose a full folder path, for example D:\\CoA backups.".into())); }
|
||||
if fsx::ensure_within(root, &dir).is_ok() {
|
||||
return Err(Error::Invalid("Backups cannot be stored inside the server folder: they would be part of what is being backed up.".into()));
|
||||
}
|
||||
fs::create_dir_all(&dir).map_err(|e| Error::Invalid(format!("The folder cannot be created: {e}")))?;
|
||||
let probe = dir.join(format!(".coa-write-test-{}", uuid::Uuid::new_v4().simple()));
|
||||
fs::write(&probe, b"x").map_err(|e| Error::Invalid(format!("The folder is not writable: {e}")))?;
|
||||
let _ = fs::remove_file(&probe);
|
||||
fsx::atomic_write_json(&meta.join(LOCATION_FILE), &StoredLocation { path: dir.to_string_lossy().into_owned() })?;
|
||||
}
|
||||
}
|
||||
Ok(location(meta))
|
||||
}
|
||||
|
||||
/// The `backup.json` of a recovery point, wherever its folder is.
|
||||
pub(crate) fn point_json(meta: &Path, id: &str) -> Result<PathBuf> {
|
||||
Ok(point_dir(meta, id)?.join("backup.json"))
|
||||
}
|
||||
|
||||
fn id_ok(id: &str) -> bool {
|
||||
!id.is_empty() && id.len() < 100 && id.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')) && !id.contains("..")
|
||||
}
|
||||
@@ -81,19 +155,32 @@ fn point_dir(meta: &Path, id: &str) -> Result<PathBuf> {
|
||||
if !id_ok(id) {
|
||||
return Err(Error::PathRejected(format!("bad backup id {id:?}")));
|
||||
}
|
||||
if let Some(found) = backup_roots(meta).into_iter().map(|root| root.join(id)).find(|dir| dir.is_dir()) {
|
||||
return Ok(found);
|
||||
}
|
||||
Ok(backups_dir(meta).join(id))
|
||||
}
|
||||
|
||||
pub fn list(meta: &Path) -> Vec<RecoveryPoint> {
|
||||
let mut out: Vec<RecoveryPoint> = fs::read_dir(backups_dir(meta))
|
||||
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| fsx::read_json(&e.path().join("backup.json")).ok()).collect())
|
||||
.unwrap_or_default();
|
||||
let mut out: Vec<RecoveryPoint> = Vec::new();
|
||||
for root in backup_roots(meta) {
|
||||
let found: Vec<RecoveryPoint> = fs::read_dir(&root)
|
||||
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| fsx::read_json(&e.path().join("backup.json")).ok()).collect())
|
||||
.unwrap_or_default();
|
||||
for point in found {
|
||||
if !out.iter().any(|p| p.id == point.id) { out.push(point); }
|
||||
}
|
||||
}
|
||||
out.sort_by(|a, b| b.id.cmp(&a.id));
|
||||
out
|
||||
}
|
||||
|
||||
pub fn get(meta: &Path, id: &str) -> Result<RecoveryPoint> {
|
||||
let point: RecoveryPoint = fsx::read_json(&fsx::ensure_within(meta, &point_dir(meta, id)?.join("backup.json"))?).map_err(|_| Error::Invalid(format!("backup {id} was not found or its metadata is damaged")))?;
|
||||
let dir = point_dir(meta, id)?;
|
||||
// The folder holding the backups may itself be a junction or symlink to another drive (the owner moved it there);
|
||||
// what must hold is that the recovery point stays inside that folder.
|
||||
let holder = dir.parent().ok_or_else(|| Error::PathRejected(format!("bad backup folder for {id}")))?;
|
||||
let point: RecoveryPoint = fsx::read_json(&fsx::ensure_within(holder, &dir.join("backup.json"))?).map_err(|_| Error::Invalid(format!("backup {id} was not found or its metadata is damaged")))?;
|
||||
if point.id != id || point.schema != 1 { return Err(Error::Invalid(format!("Backup {id} has inconsistent identity or an unsupported schema."))); }
|
||||
Ok(point)
|
||||
}
|
||||
@@ -125,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}"));
|
||||
}
|
||||
}
|
||||
@@ -163,7 +250,8 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
|
||||
if !mysql_was_up {
|
||||
let out = driver::run(root, Verb::StartMysql)?;
|
||||
if !out.ok {
|
||||
return Err(Error::Invalid(out.human.map(|h| h.title.to_string()).unwrap_or_else(|| "The database could not be started.".into())));
|
||||
// Keep the launcher's own last lines: the title alone ("Something went wrong") hides the cause.
|
||||
return Err(Error::Invalid(format!("The database could not be started. {}", driver::startup_failure(root, &out))));
|
||||
}
|
||||
}
|
||||
let result = f(&db);
|
||||
@@ -176,6 +264,14 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
|
||||
result
|
||||
}
|
||||
|
||||
/// Run `f` only if the database is already up; `None` (and nothing started) otherwise.
|
||||
pub fn with_running_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result<Option<T>> {
|
||||
let db = Db::from_repack(root, Account::Admin)?;
|
||||
let observed = process::observe(root, &read_ports(root));
|
||||
if observed.mysql.state != ServiceState::Running || !db.ping() { return Ok(None); }
|
||||
f(&db).map(Some)
|
||||
}
|
||||
|
||||
fn wanted_databases(kind: Kind) -> &'static [&'static str] {
|
||||
match kind {
|
||||
Kind::Quick | Kind::Database => &["characters", "auth"],
|
||||
@@ -240,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 && matches!(trigger, Trigger::BeforeUpdate | Trigger::BeforeRepair) && 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,
|
||||
@@ -250,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)?;
|
||||
@@ -281,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 {
|
||||
@@ -490,6 +600,34 @@ mod tests {
|
||||
assert!(list(&meta).len() >= 2);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn backups_can_live_in_a_chosen_folder_and_old_ones_stay_visible() {
|
||||
let (d, root, meta) = setup();
|
||||
let before = create(&root, &meta, Kind::Config, Trigger::Manual, Some("default folder".into()), &|_| {}).unwrap();
|
||||
assert!(location(&meta).is_default);
|
||||
|
||||
// inside the server folder is refused, a relative path is refused
|
||||
assert!(set_location(&root, &meta, Some(root.join("backups").to_str().unwrap())).is_err());
|
||||
assert!(set_location(&root, &meta, Some("backups")).is_err());
|
||||
|
||||
let elsewhere = d.path().join("other drive").join("CoA backups");
|
||||
let loc = set_location(&root, &meta, Some(elsewhere.to_str().unwrap())).unwrap();
|
||||
assert!(!loc.is_default && elsewhere.is_dir());
|
||||
let after = create(&root, &meta, Kind::Config, Trigger::Manual, Some("chosen folder".into()), &|_| {}).unwrap();
|
||||
assert!(elsewhere.join(&after.id).join("backup.json").is_file(), "new backups go to the chosen folder");
|
||||
assert!(!default_dir(&meta).join(&after.id).exists());
|
||||
let ids: Vec<_> = list(&meta).into_iter().map(|p| p.id).collect();
|
||||
assert!(ids.contains(&before.id) && ids.contains(&after.id), "the old backup is still listed");
|
||||
assert!(verify(&meta, &before.id).unwrap().ok && verify(&meta, &after.id).unwrap().ok);
|
||||
assert_eq!(point_json(&meta, &after.id).unwrap(), elsewhere.join(&after.id).join("backup.json"));
|
||||
restore_configs(&root, &meta, &after.id).unwrap();
|
||||
delete(&meta, &after.id).unwrap();
|
||||
assert!(!elsewhere.join(&after.id).exists());
|
||||
|
||||
assert!(set_location(&root, &meta, None).unwrap().is_default);
|
||||
assert!(list(&meta).iter().any(|p| p.id == before.id));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn verify_detects_tampering_and_restore_refuses_damaged_backup() {
|
||||
let (_d, root, meta) = setup();
|
||||
|
||||
@@ -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());
|
||||
}
|
||||
}
|
||||
@@ -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,
|
||||
@@ -24,7 +24,7 @@ pub struct Params<'a> {
|
||||
}
|
||||
|
||||
/// Auth tables that hold player data. Everything else (permissions, build info, realmlist) is configuration.
|
||||
const AUTH_PLAYER_TABLES: [&str; 11] =
|
||||
pub(crate) const AUTH_PLAYER_TABLES: [&str; 11] =
|
||||
["account", "account_access", "account_banned", "account_muted", "account_password_history", "ip_banned", "logs", "logs_ip_actions", "realmcharacters", "uptime", "rbac_account_permissions"];
|
||||
|
||||
fn copy_dir(src: &Path, dst: &Path, skip: &dyn Fn(&str) -> bool, base: &Path) -> Result<u64> {
|
||||
@@ -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"] {
|
||||
|
||||
@@ -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())
|
||||
}
|
||||
|
||||
@@ -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();
|
||||
|
||||
@@ -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;
|
||||
|
||||
@@ -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"));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,916 @@
|
||||
//! 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.7";
|
||||
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",
|
||||
),
|
||||
(
|
||||
"CoA-Custom-1.7-client.zip",
|
||||
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.7/CoA-Custom-1.7-client.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",
|
||||
"patch-ZZU.MPQ",
|
||||
"patch-ZZV.MPQ",
|
||||
"patch-ZZW.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 if manifest.lines().any(|line| line == "# CoA Custom 1.6") { include_str!("custom_races_hashes_1_6.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",
|
||||
"CoA-Custom-1.7-client.zip" => "ad389ef486f44f269445f80807b25b214c39fc5d21272b5708bfeac8b1efefa0",
|
||||
_ => 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 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 previous_release_uses_its_own_hashes_for_upgrade_and_removal() {
|
||||
let temp = tempfile::tempdir().unwrap();
|
||||
fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.6\n").unwrap();
|
||||
let legacy: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes_1_6.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.len(), legacy.len());
|
||||
assert_eq!(files.iter().find(|file| file.path == "Data/patch-T.MPQ").unwrap().sha256, legacy["Data/patch-T.MPQ"]);
|
||||
assert_ne!(legacy["Data/patch-T.MPQ"], current["Data/patch-T.MPQ"]);
|
||||
assert!(!files.iter().any(|file| file.path == "Data/patch-ZZW.MPQ"));
|
||||
assert!(legacy.keys().all(|key| current.contains_key(key)));
|
||||
}
|
||||
|
||||
#[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,55 @@
|
||||
{
|
||||
"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": "fe597138ab7f56881b5f4f27d6dc9d81bb278b483ca0d91b7207ffd4a5ae7bfd",
|
||||
"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",
|
||||
"Data/patch-ZZU.MPQ": "8ee1839415b56d46c6eff7eb4dfbaf6fbafc4c6b29b39380d69f4d827d02a99e",
|
||||
"Data/patch-ZZV.MPQ": "8d5e61d37008abf70478e5d5f46ec7afb0490b9a643323bd75a1c70cadd63290",
|
||||
"Data/patch-ZZW.MPQ": "ed452a0a0118c9f4deaf02db753064ac95b6e4a84022bdabd39a7e70d775223f"
|
||||
}
|
||||
@@ -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"
|
||||
}
|
||||
@@ -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,382 @@
|
||||
//! SQUID's bot dashboard (<https://github.com/Zyth45/squidbots-dashboard>): a small web page, written in Python with
|
||||
//! no dependencies, that shows where the bots are and what they do. It is kept in `Extras/SquidDashboard` of the server
|
||||
//! folder and always comes from the release that matches the installed SQUID bots (same major and minor version), so the
|
||||
//! page and the bots agree on what the database and the logs contain.
|
||||
//!
|
||||
//! The dashboard finds the repack by itself (`Settings/database.json` and `Settings/repack.json` two folders up), so the
|
||||
//! Manager only has to download it and start it on a free port. Only the process the Manager started and recorded is ever
|
||||
//! stopped, identified by PID and creation time.
|
||||
|
||||
use std::io::Read;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use serde::{Deserialize, Serialize};
|
||||
|
||||
use crate::error::{Error, Result};
|
||||
use crate::fsx;
|
||||
use crate::process::{self, ProcessIdentity};
|
||||
|
||||
const REPO: &str = "Zyth45/squidbots-dashboard";
|
||||
const DIR: &str = "Extras/SquidDashboard";
|
||||
const MARKER: &str = ".manager-dashboard.json";
|
||||
const PROCESS: &str = ".manager-dashboard-process.json";
|
||||
const FIRST_PORT: u16 = 8088;
|
||||
const MAX_ARCHIVE: u64 = 60 * 1024 * 1024;
|
||||
const MAX_UNPACKED: u64 = 150 * 1024 * 1024;
|
||||
|
||||
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||
struct Marker {
|
||||
/// The dashboard release that is installed.
|
||||
tag: String,
|
||||
/// The SQUID release it was chosen for.
|
||||
squid_tag: String,
|
||||
port: u16,
|
||||
}
|
||||
|
||||
#[derive(Debug, Serialize)]
|
||||
pub struct Status {
|
||||
pub installed: bool,
|
||||
/// Dashboard release installed.
|
||||
pub tag: Option<String>,
|
||||
/// SQUID bots release found in the server.
|
||||
pub squid_tag: Option<String>,
|
||||
/// The installed dashboard belongs to the installed bots' release series.
|
||||
pub matches: bool,
|
||||
pub running: bool,
|
||||
pub port: u16,
|
||||
pub url: String,
|
||||
}
|
||||
|
||||
fn dir(root: &Path) -> PathBuf {
|
||||
root.join(DIR)
|
||||
}
|
||||
|
||||
fn read_marker(root: &Path) -> Option<Marker> {
|
||||
fsx::read_json(&dir(root).join(MARKER)).ok()
|
||||
}
|
||||
|
||||
/// `v1.9.1` -> `[1, 9, 1]`.
|
||||
fn parse_tag(tag: &str) -> Option<Vec<u32>> {
|
||||
let parts: Vec<u32> = tag.trim().trim_start_matches('v').split('.').map(|p| p.parse().ok()).collect::<Option<_>>()?;
|
||||
(parts.len() >= 2).then_some(parts)
|
||||
}
|
||||
|
||||
/// Same major and minor version.
|
||||
fn same_series(a: &str, b: &str) -> bool {
|
||||
matches!((parse_tag(a), parse_tag(b)), (Some(a), Some(b)) if a[..2] == b[..2])
|
||||
}
|
||||
|
||||
/// The newest dashboard release of the bots' series (`v1.9` serves bots `v1.9` and `v1.9.1`).
|
||||
fn pick_tag(squid_tag: &str, available: &[String]) -> Option<String> {
|
||||
available.iter()
|
||||
.filter(|tag| same_series(tag, squid_tag))
|
||||
.max_by_key(|tag| parse_tag(tag).unwrap_or_default())
|
||||
.cloned()
|
||||
}
|
||||
|
||||
fn safe_tag(tag: &str) -> bool {
|
||||
!tag.is_empty() && tag.len() <= 40 && tag.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'))
|
||||
}
|
||||
|
||||
fn squid_tag(root: &Path) -> Option<String> {
|
||||
crate::squid::release(root).and_then(|r| r.tag).filter(|t| safe_tag(t))
|
||||
}
|
||||
|
||||
fn record_alive(root: &Path) -> Option<ProcessIdentity> {
|
||||
let record: ProcessIdentity = fsx::read_json(&dir(root).join(PROCESS)).ok()?;
|
||||
let inside = Path::new(&record.exe).starts_with(root);
|
||||
(inside && process::is_alive(&record)).then_some(record)
|
||||
}
|
||||
|
||||
pub fn status(root: &Path) -> Status {
|
||||
let marker = read_marker(root);
|
||||
let installed = dir(root).join("squidbots.py").is_file() && marker.is_some();
|
||||
let squid = squid_tag(root);
|
||||
let port = marker.as_ref().map(|m| m.port).unwrap_or(FIRST_PORT);
|
||||
let running = installed && record_alive(root).is_some_and(|r| process::listeners().iter().any(|(p, pid)| *p == port && *pid == r.pid));
|
||||
Status {
|
||||
installed,
|
||||
matches: matches!((&marker, &squid), (Some(m), Some(s)) if same_series(&m.tag, s)),
|
||||
tag: marker.map(|m| m.tag),
|
||||
squid_tag: squid,
|
||||
running,
|
||||
port,
|
||||
url: format!("http://127.0.0.1:{port}"),
|
||||
}
|
||||
}
|
||||
|
||||
fn http() -> Result<reqwest::blocking::Client> {
|
||||
reqwest::blocking::Client::builder()
|
||||
.user_agent(concat!("CoA-Server-Manager/", env!("CARGO_PKG_VERSION")))
|
||||
.timeout(std::time::Duration::from_secs(120))
|
||||
.build()
|
||||
.map_err(|e| Error::Invalid(format!("Cannot prepare the download: {e}")))
|
||||
}
|
||||
|
||||
fn download_error(e: impl std::fmt::Display) -> Error {
|
||||
Error::NetworkUnreachable(e.to_string())
|
||||
}
|
||||
|
||||
fn available_tags(client: &reqwest::blocking::Client) -> Result<Vec<String>> {
|
||||
#[derive(Deserialize)]
|
||||
struct Tag { name: String }
|
||||
let response = client.get(format!("https://api.github.com/repos/{REPO}/tags?per_page=100")).send().map_err(download_error)?;
|
||||
if !response.status().is_success() { return Err(download_error(format!("GitHub answered {}", response.status()))); }
|
||||
let tags: Vec<Tag> = serde_json::from_str(&response.text().map_err(download_error)?).map_err(download_error)?;
|
||||
Ok(tags.into_iter().map(|t| t.name).filter(|t| safe_tag(t)).collect())
|
||||
}
|
||||
|
||||
/// Download the dashboard release that matches the installed bots and unpack it. A running dashboard is stopped first;
|
||||
/// maps the owner extracted and other files of theirs are left alone.
|
||||
pub fn install(root: &Path, report: &dyn Fn(&str)) -> Result<Status> {
|
||||
let squid = squid_tag(root).ok_or_else(|| Error::Invalid("The version of the SQUID bots could not be read, so the matching dashboard cannot be chosen.".into()))?;
|
||||
report("Looking for the matching dashboard");
|
||||
let client = http()?;
|
||||
let tag = pick_tag(&squid, &available_tags(&client)?)
|
||||
.ok_or_else(|| Error::Invalid(format!("There is no dashboard release for SQUID bots {squid} yet.")))?;
|
||||
report("Downloading the dashboard");
|
||||
let response = client.get(format!("https://codeload.github.com/{REPO}/zip/refs/tags/{tag}")).send().map_err(download_error)?;
|
||||
if !response.status().is_success() { return Err(download_error(format!("GitHub answered {}", response.status()))); }
|
||||
let mut bytes = Vec::new();
|
||||
response.take(MAX_ARCHIVE + 1).read_to_end(&mut bytes).map_err(download_error)?;
|
||||
if bytes.len() as u64 > MAX_ARCHIVE { return Err(Error::Invalid("The dashboard download is larger than expected and was rejected.".into())); }
|
||||
|
||||
stop(root)?;
|
||||
report("Unpacking the dashboard");
|
||||
let target = dir(root);
|
||||
std::fs::create_dir_all(&target)?;
|
||||
let mut archive = zip::ZipArchive::new(std::io::Cursor::new(bytes)).map_err(|e| Error::Invalid(format!("The dashboard download is damaged: {e}")))?;
|
||||
let mut total = 0u64;
|
||||
let mut wrote_main = false;
|
||||
for index in 0..archive.len() {
|
||||
let mut file = archive.by_index(index).map_err(|e| Error::Invalid(format!("The dashboard download is damaged: {e}")))?;
|
||||
if file.is_dir() { continue; }
|
||||
// GitHub wraps everything in one folder named after the repository and release.
|
||||
let Some(relative) = file.name().split_once('/').map(|(_, rest)| rest.to_string()) else { continue; };
|
||||
if relative.is_empty() || relative.starts_with(".github/") || relative.starts_with("docs/") { continue; }
|
||||
total += file.size();
|
||||
if total > MAX_UNPACKED { return Err(Error::Invalid("The dashboard download unpacks to more than expected and was rejected.".into())); }
|
||||
let destination = fsx::safe_join(&target, &relative)?;
|
||||
let mut content = Vec::with_capacity(file.size() as usize);
|
||||
file.read_to_end(&mut content)?;
|
||||
fsx::atomic_write(&destination, &content)?;
|
||||
wrote_main |= relative == "squidbots.py";
|
||||
}
|
||||
if !wrote_main { return Err(Error::Invalid("The dashboard download did not contain the dashboard.".into())); }
|
||||
let port = read_marker(root).map(|m| m.port).unwrap_or(FIRST_PORT);
|
||||
fsx::atomic_write_json(&target.join(MARKER), &Marker { tag, squid_tag: squid, port })?;
|
||||
Ok(status(root))
|
||||
}
|
||||
|
||||
fn free_port(preferred: u16) -> Result<u16> {
|
||||
let used: Vec<u16> = process::listeners().into_iter().map(|(port, _)| port).collect();
|
||||
std::iter::once(preferred).chain(FIRST_PORT..FIRST_PORT + 40).find(|p| !used.contains(p))
|
||||
.ok_or_else(|| Error::Invalid("No free port was found for the dashboard.".into()))
|
||||
}
|
||||
|
||||
/// A crash or power loss while the dashboard saves its history can leave a file of the right length that holds only
|
||||
/// zero bytes, and the dashboard then fails to start on it. Those files carry nothing, and the dashboard recreates them,
|
||||
/// so they are removed. The files that come with the release are never touched here (reinstalling restores them).
|
||||
fn discard_damaged_data(folder: &Path) -> Vec<String> {
|
||||
const SHIPPED: &[&str] = &["worldmap.json", "dashboard.example.json"];
|
||||
let mut removed = Vec::new();
|
||||
let Ok(entries) = std::fs::read_dir(folder) else { return removed; };
|
||||
for entry in entries.flatten() {
|
||||
let name = entry.file_name().to_string_lossy().into_owned();
|
||||
let path = entry.path();
|
||||
if !name.ends_with(".json") || name.starts_with('.') || SHIPPED.contains(&name.as_str()) || !path.is_file() { continue; }
|
||||
let Ok(bytes) = std::fs::read(&path) else { continue; };
|
||||
if !bytes.is_empty() && bytes.iter().all(|b| *b == 0) && std::fs::remove_file(&path).is_ok() {
|
||||
tracing::warn!(file = %path.display(), "dashboard: removed a data file damaged by an interrupted write");
|
||||
removed.push(name);
|
||||
}
|
||||
}
|
||||
removed
|
||||
}
|
||||
|
||||
/// The dashboard reads `coa-level-builds.json` (class and specialization names) from its own folder; the CoA Bots repack
|
||||
/// ships it, the GitHub release does not. The server's own reference file has the same content and shape.
|
||||
fn ensure_builds_file(root: &Path) {
|
||||
let target = dir(root).join("coa-level-builds.json");
|
||||
if target.is_file() { return; }
|
||||
let reference = root.join("Core/reference/ascensionsidekick-level-builds.json");
|
||||
let content = std::fs::read(&reference).ok().filter(|bytes| serde_json::from_slice::<serde_json::Value>(bytes).is_ok_and(|v| v.is_object()));
|
||||
let _ = fsx::atomic_write(&target, content.as_deref().unwrap_or(b"{}"));
|
||||
}
|
||||
|
||||
/// Python's HTTP server closes each connection with `shutdown(SHUT_WR)` straight after the answer. On Windows that can
|
||||
/// throw away what is still queued: any answer above about 64 KB (the dashboard's statistics are 400 KB) arrives cut
|
||||
/// off, and the page fails to load. This small launcher waits for the client to finish reading and close instead, queues
|
||||
/// more waiting connections than Python's five, and then runs the dashboard unchanged.
|
||||
const LAUNCHER: &str = r#"import runpy, socketserver, sys, http.server
|
||||
|
||||
http.server.ThreadingHTTPServer.request_queue_size = 256
|
||||
|
||||
|
||||
def shutdown_request(self, request):
|
||||
try:
|
||||
request.settimeout(5)
|
||||
while request.recv(4096):
|
||||
pass
|
||||
except OSError:
|
||||
pass
|
||||
self.close_request(request)
|
||||
|
||||
|
||||
socketserver.TCPServer.shutdown_request = shutdown_request
|
||||
script = sys.argv[1]
|
||||
sys.argv = [script]
|
||||
runpy.run_path(script, run_name="__main__")
|
||||
"#;
|
||||
|
||||
/// Start the dashboard with the repack's own Python. Returns when it answers on its port.
|
||||
pub fn start(root: &Path) -> Result<Status> {
|
||||
let current = status(root);
|
||||
if !current.installed { return Err(Error::Invalid("The dashboard is not installed.".into())); }
|
||||
if current.running { return Ok(current); }
|
||||
let python = root.join("Runtime/python/python.exe");
|
||||
if !python.is_file() { return Err(Error::Invalid("This server has no bundled Python, so the dashboard cannot run.".into())); }
|
||||
let folder = dir(root);
|
||||
let mut marker = read_marker(root).ok_or_else(|| Error::Invalid("The dashboard installation is incomplete.".into()))?;
|
||||
marker.port = free_port(marker.port)?;
|
||||
fsx::atomic_write_json(&folder.join(MARKER), &marker)?;
|
||||
|
||||
let log_path = folder.join("dashboard.log");
|
||||
let log = std::fs::File::create(&log_path)?;
|
||||
let mut command = std::process::Command::new(&python);
|
||||
ensure_builds_file(root);
|
||||
discard_damaged_data(&folder);
|
||||
let script = folder.join("squidbots.py");
|
||||
let launcher = folder.join("manager_launch.py");
|
||||
fsx::atomic_write(&launcher, LAUNCHER.as_bytes())?;
|
||||
command.arg("-B").arg(&launcher).arg(&script).current_dir(&folder).env("COA_DASHBOARD_PORT", marker.port.to_string())
|
||||
.stdin(std::process::Stdio::null()).stdout(log.try_clone()?).stderr(log);
|
||||
#[cfg(windows)]
|
||||
{
|
||||
use std::os::windows::process::CommandExt;
|
||||
command.creation_flags(0x0800_0000); // CREATE_NO_WINDOW
|
||||
}
|
||||
let mut child = command.spawn()?;
|
||||
let identity = process::identity(child.id()).ok_or_else(|| Error::Invalid("The dashboard exited at once.".into()))?;
|
||||
fsx::atomic_write_json(&folder.join(PROCESS), &identity)?;
|
||||
|
||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(20);
|
||||
loop {
|
||||
if process::listeners().iter().any(|(port, pid)| *port == marker.port && *pid == identity.pid) { return Ok(status(root)); }
|
||||
if let Ok(Some(_)) = child.try_wait() {
|
||||
let _ = std::fs::remove_file(folder.join(PROCESS));
|
||||
let tail = std::fs::read_to_string(&log_path).unwrap_or_default();
|
||||
let lines: Vec<&str> = tail.lines().rev().take(8).collect();
|
||||
return Err(Error::Invalid(format!("The dashboard stopped right after starting. {}", lines.into_iter().rev().collect::<Vec<_>>().join("\n"))));
|
||||
}
|
||||
if std::time::Instant::now() > deadline {
|
||||
let _ = stop(root);
|
||||
return Err(Error::Invalid("The dashboard did not start in time. See Extras/SquidDashboard/dashboard.log.".into()));
|
||||
}
|
||||
std::thread::sleep(std::time::Duration::from_millis(300));
|
||||
}
|
||||
}
|
||||
|
||||
/// Stop the dashboard this Manager started (by recorded PID and creation time, never by name).
|
||||
pub fn stop(root: &Path) -> Result<()> {
|
||||
let record_file = dir(root).join(PROCESS);
|
||||
if let Some(record) = record_alive(root) {
|
||||
let mut command = std::process::Command::new("taskkill");
|
||||
command.args(["/PID", &record.pid.to_string(), "/T", "/F"]).stdout(std::process::Stdio::null()).stderr(std::process::Stdio::null());
|
||||
#[cfg(windows)]
|
||||
{
|
||||
use std::os::windows::process::CommandExt;
|
||||
command.creation_flags(0x0800_0000);
|
||||
}
|
||||
let _ = command.status();
|
||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(10);
|
||||
while process::is_alive(&record) && std::time::Instant::now() < deadline {
|
||||
std::thread::sleep(std::time::Duration::from_millis(200));
|
||||
}
|
||||
if process::is_alive(&record) { return Err(Error::Invalid("The dashboard could not be stopped.".into())); }
|
||||
}
|
||||
let _ = std::fs::remove_file(record_file);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
fn tags(list: &[&str]) -> Vec<String> { list.iter().map(|s| s.to_string()).collect() }
|
||||
|
||||
#[test]
|
||||
fn the_dashboard_follows_the_bots_release_series() {
|
||||
let available = tags(&["v1.8", "v1.9", "v1.9.2", "v2.0"]);
|
||||
assert_eq!(pick_tag("v1.9", &available).as_deref(), Some("v1.9.2"), "the newest of the same series");
|
||||
assert_eq!(pick_tag("v1.9.1", &tags(&["v1.8", "v1.9"])).as_deref(), Some("v1.9"), "bots 1.9.1 use dashboard 1.9");
|
||||
assert_eq!(pick_tag("v1.8.1", &available).as_deref(), Some("v1.8"));
|
||||
assert_eq!(pick_tag("v1.10", &available), None, "a later series has none yet");
|
||||
assert_eq!(pick_tag("main", &available), None);
|
||||
assert!(same_series("v1.9", "v1.9.1") && !same_series("v1.9", "v1.8.9"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn zero_filled_history_files_are_removed_but_shipped_and_valid_files_stay() {
|
||||
let folder = tempfile::tempdir().unwrap();
|
||||
std::fs::write(folder.path().join("history.json"), vec![0u8; 358]).unwrap();
|
||||
std::fs::write(folder.path().join("levels.json"), vec![0u8; 100]).unwrap();
|
||||
std::fs::write(folder.path().join("xp-history.json"), "[1, 2]").unwrap();
|
||||
std::fs::write(folder.path().join("worldmap.json"), vec![0u8; 50]).unwrap();
|
||||
std::fs::write(folder.path().join("empty.json"), "").unwrap();
|
||||
let mut removed = discard_damaged_data(folder.path());
|
||||
removed.sort();
|
||||
assert_eq!(removed, ["history.json", "levels.json"]);
|
||||
assert!(folder.path().join("xp-history.json").exists() && folder.path().join("worldmap.json").exists() && folder.path().join("empty.json").exists());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn tags_are_checked_before_they_reach_a_url() {
|
||||
assert!(safe_tag("v1.9.1") && !safe_tag("v1.9/../x") && !safe_tag("") && !safe_tag("a b"));
|
||||
}
|
||||
|
||||
/// Needs the network: `cargo test -p coa-core dashboard -- --ignored`.
|
||||
#[test]
|
||||
#[ignore]
|
||||
fn the_matching_release_is_downloaded_and_unpacked() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
let settings = root.path().join("Core/configs/modules/playerbots.conf.settings.json");
|
||||
fsx::atomic_write(&settings, br#"{"format":1,"tag":"v1.9.1","settings":[]}"#).unwrap();
|
||||
let installed = install(root.path(), &|step| println!("{step}")).unwrap();
|
||||
assert!(installed.installed && installed.matches);
|
||||
assert_eq!(installed.tag.as_deref(), Some("v1.9"));
|
||||
assert!(root.path().join("Extras/SquidDashboard/squidbots.py").is_file());
|
||||
assert!(!installed.running);
|
||||
}
|
||||
|
||||
/// Needs a real server folder (`COA_TEST_ROOT`) whose bots are installed and whose database runs:
|
||||
/// `COA_TEST_ROOT=... cargo test -p coa-core dashboard -- --ignored --nocapture`.
|
||||
#[test]
|
||||
#[ignore]
|
||||
fn the_started_dashboard_delivers_its_large_statistics() {
|
||||
let root = PathBuf::from(std::env::var("COA_TEST_ROOT").expect("COA_TEST_ROOT"));
|
||||
let started = start(&root).unwrap();
|
||||
assert!(started.running, "{started:?}");
|
||||
let client = reqwest::blocking::Client::builder().timeout(std::time::Duration::from_secs(90)).build().unwrap();
|
||||
let body = client.get(format!("{}/api/stats", started.url)).send().unwrap().bytes().unwrap();
|
||||
println!("stats: {} bytes: {}", body.len(), String::from_utf8_lossy(&body[..body.len().min(300)]));
|
||||
let live = client.get(format!("{}/api/live", started.url)).send().unwrap().bytes().unwrap();
|
||||
stop(&root).unwrap();
|
||||
assert!(!status(&root).running);
|
||||
if String::from_utf8_lossy(&body).starts_with("{\"error\"") {
|
||||
println!("the database of this server is not running, so the large answer could not be checked");
|
||||
} else {
|
||||
assert!(body.len() > 100_000, "the statistics must arrive whole, got {} bytes", body.len());
|
||||
}
|
||||
assert!(!live.is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_folder_without_the_dashboard_is_not_installed_or_running() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
let s = status(root.path());
|
||||
assert!(!s.installed && !s.running && !s.matches);
|
||||
assert!(start(root.path()).is_err());
|
||||
assert!(stop(root.path()).is_ok());
|
||||
}
|
||||
}
|
||||
@@ -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");
|
||||
|
||||
+335
-6
@@ -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();
|
||||
@@ -172,19 +173,158 @@ pub fn squash_repeated_config_warnings(text: &str) -> String {
|
||||
s
|
||||
}
|
||||
|
||||
const SENSITIVE: [&str; 7] = ["password", "passwd", "secret", "token", "apikey", "api_key", "databaseinfo"];
|
||||
|
||||
/// Remove things that must never leave the machine from log text.
|
||||
pub fn redact(text: &str) -> String {
|
||||
let mut out = Vec::new();
|
||||
for line in text.lines() {
|
||||
let l = line.to_lowercase();
|
||||
let sensitive = ["password", "passwd", "secret", "token", "apikey", "api_key", "databaseinfo"].iter().any(|k| l.contains(k));
|
||||
let sensitive = SENSITIVE.iter().any(|k| l.contains(k));
|
||||
out.push(if sensitive { "[line removed: may contain a secret]".to_string() } else { line.to_string() });
|
||||
}
|
||||
out.join("\n")
|
||||
}
|
||||
|
||||
/// The same for JSON: values under a sensitive key and strings that look like `password=...` are replaced, and the
|
||||
/// result stays valid JSON (removing a whole line would break the file for whoever reads it). Text that is not JSON
|
||||
/// falls back to the line rule.
|
||||
pub fn redact_json(text: &str) -> String {
|
||||
fn scrub(v: &mut serde_json::Value) {
|
||||
use serde_json::Value;
|
||||
match v {
|
||||
Value::Object(map) => {
|
||||
for (key, value) in map.iter_mut() {
|
||||
let k = key.to_lowercase();
|
||||
if SENSITIVE.iter().any(|s| k.contains(s)) && !value.is_object() && !value.is_array() {
|
||||
*value = Value::String("[redacted]".into());
|
||||
} else {
|
||||
scrub(value);
|
||||
}
|
||||
}
|
||||
}
|
||||
Value::Array(items) => items.iter_mut().for_each(scrub),
|
||||
Value::String(s) => {
|
||||
let l = s.to_lowercase();
|
||||
if ["password=", "passwd=", "secret=", "token=", "apikey=", "api_key=", "password:"].iter().any(|k| l.contains(k)) {
|
||||
*s = "[redacted]".into();
|
||||
}
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
}
|
||||
match serde_json::from_str::<serde_json::Value>(text) {
|
||||
Ok(mut v) => {
|
||||
scrub(&mut v);
|
||||
serde_json::to_string_pretty(&v).unwrap_or_else(|_| redact(text))
|
||||
}
|
||||
Err(_) => redact(text),
|
||||
}
|
||||
}
|
||||
|
||||
/// Keep the events of a `wevtutil ... /f:text` listing that mention one of `needles` (compared without case), in the
|
||||
/// order listed, at most `max` of them.
|
||||
pub fn filter_event_blocks(listing: &str, needles: &[&str], max: usize) -> String {
|
||||
let mut blocks: Vec<Vec<&str>> = Vec::new();
|
||||
for line in listing.lines() {
|
||||
if line.starts_with("Event[") || blocks.is_empty() {
|
||||
blocks.push(Vec::new());
|
||||
}
|
||||
if let Some(b) = blocks.last_mut() { b.push(line); }
|
||||
}
|
||||
blocks
|
||||
.into_iter()
|
||||
.map(|b| b.join("\n"))
|
||||
.filter(|b| { let l = b.to_lowercase(); needles.iter().any(|n| l.contains(n)) })
|
||||
.take(max)
|
||||
.collect::<Vec<_>>()
|
||||
.join("\n\n")
|
||||
}
|
||||
|
||||
/// Drop the lines of an event listing that name the person or the computer.
|
||||
pub fn drop_identity_lines(listing: &str) -> String {
|
||||
listing
|
||||
.lines()
|
||||
.filter(|l| { let t = l.trim_start(); !(t.starts_with("User:") || t.starts_with("User Name:") || t.starts_with("Computer:")) })
|
||||
.collect::<Vec<_>>()
|
||||
.join("\n")
|
||||
}
|
||||
|
||||
/// `wevtutil /uni:true` writes UTF-16 with a byte order mark; anything else is read as UTF-8 (lossy).
|
||||
fn decode_console_output(bytes: &[u8]) -> String {
|
||||
if bytes.starts_with(&[0xFF, 0xFE]) {
|
||||
let units: Vec<u16> = bytes[2..].chunks_exact(2).map(|c| u16::from_le_bytes([c[0], c[1]])).collect();
|
||||
String::from_utf16_lossy(&units)
|
||||
} else {
|
||||
String::from_utf8_lossy(bytes).into_owned()
|
||||
}
|
||||
}
|
||||
|
||||
/// Crashes and hangs Windows recorded for the server programs in the last two weeks. This is the only trace of a crash
|
||||
/// that ends the process without the server's own crash report (a stack buffer overrun, for example). The lines that
|
||||
/// name the user and the computer are left out.
|
||||
#[cfg(windows)]
|
||||
fn windows_events() -> String {
|
||||
use std::os::windows::process::CommandExt;
|
||||
let query = "*[System[(Provider[@Name='Application Error' or @Name='Windows Error Reporting' or @Name='Application Hang']) and TimeCreated[timediff(@SystemTime) <= 1209600000]]]";
|
||||
let out = std::process::Command::new("wevtutil")
|
||||
.args(["qe", "Application", &format!("/q:{query}"), "/c:300", "/rd:true", "/f:text", "/uni:true"])
|
||||
.creation_flags(0x0800_0000)
|
||||
.output();
|
||||
match out {
|
||||
Ok(o) if o.status.success() => {
|
||||
let text = filter_event_blocks(&decode_console_output(&o.stdout), &["worldserver", "authserver", "mysqld", "coa server manager", "coa-server-manager"], 40);
|
||||
if text.is_empty() { "No crash or hang of the server programs was recorded by Windows in the last 14 days.".into() } else { drop_identity_lines(&text) }
|
||||
}
|
||||
Ok(o) => format!("Windows event log could not be read: {}", decode_console_output(&o.stderr).trim()),
|
||||
Err(e) => format!("Windows event log could not be read: {e}"),
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(not(windows))]
|
||||
fn windows_events() -> String {
|
||||
String::new()
|
||||
}
|
||||
|
||||
/// Newest files of a folder with the given extension (compared without case): path, size, modified time.
|
||||
fn newest_files(dir: &Path, ext: &str, limit: usize) -> Vec<(PathBuf, u64, std::time::SystemTime)> {
|
||||
let Ok(rd) = fs::read_dir(dir) else { return Vec::new() };
|
||||
let mut v: Vec<_> = rd
|
||||
.flatten()
|
||||
.filter(|e| e.path().extension().is_some_and(|x| x.eq_ignore_ascii_case(ext)))
|
||||
.filter_map(|e| { let m = e.metadata().ok()?; m.is_file().then(|| (e.path(), m.len(), m.modified().unwrap_or(std::time::UNIX_EPOCH))) })
|
||||
.collect();
|
||||
v.sort_by(|a, b| b.2.cmp(&a.2));
|
||||
v.truncate(limit);
|
||||
v
|
||||
}
|
||||
|
||||
/// Which server programs run right now and from where, next to what the Manager made of it. A program started from a
|
||||
/// folder or a copy the Manager does not know shows up here even when the Manager reports "port in use".
|
||||
fn processes_report(root: &Path, ports: &layout::Ports) -> String {
|
||||
let here = root.to_string_lossy().to_lowercase().replace('/', "\\");
|
||||
let listen = process::listeners_detailed();
|
||||
let mut out = String::from("Server programs running now (any folder):\n");
|
||||
let found = process::find_by_file_names(&["worldserver.exe", "authserver.exe", "mysqld.exe"]);
|
||||
if found.is_empty() { out.push_str(" none\n"); }
|
||||
for p in found {
|
||||
let ports_of: Vec<String> = listen.iter().filter(|l| l.pid == p.pid).map(|l| l.port.to_string()).collect();
|
||||
let inside = p.exe.to_lowercase().replace('/', "\\").starts_with(&here);
|
||||
out.push_str(&format!(" pid {} {} | listening on: {} | {}\n", p.pid, p.exe, if ports_of.is_empty() { "-".into() } else { ports_of.join(", ") }, if inside { "inside this server folder" } else { "OUTSIDE this server folder" }));
|
||||
}
|
||||
let o = process::observe(root, ports);
|
||||
out.push_str("\nThe Manager's view:\n");
|
||||
for s in [Some(&o.mysql), Some(&o.auth), Some(&o.world), o.secondary_world.as_ref()].into_iter().flatten() {
|
||||
out.push_str(&format!(" {:<16} {:?} port {} {}{}\n", s.name, s.state, s.port, s.pid.map(|p| format!("pid {p}")).unwrap_or_default(), s.conflict.as_ref().map(|c| format!(" | port held by pid {} {}", c.pid, c.exe.clone().unwrap_or_default())).unwrap_or_default()));
|
||||
}
|
||||
out
|
||||
}
|
||||
|
||||
/// Zip with what a maintainer needs to debug a problem, with secrets removed. Returns the number of files inside.
|
||||
/// One call collects everything: the Manager's and the server's logs, crash reports and small crash dumps, Windows'
|
||||
/// own record of crashes, the update journals, the running server programs and the settings the client depends on.
|
||||
pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &InstallMeta, report: &Report, out_zip: &Path) -> Result<usize> {
|
||||
const DUMP_FILE_MAX: u64 = 30 * 1024 * 1024;
|
||||
let file = fs::File::create(out_zip)?;
|
||||
let mut zip = zip::ZipWriter::new(file);
|
||||
let opts = zip::write::SimpleFileOptions::default().compression_method(zip::CompressionMethod::Deflated);
|
||||
@@ -195,8 +335,10 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
||||
n += 1;
|
||||
Ok(())
|
||||
};
|
||||
let ports = layout::read_ports(root);
|
||||
let summary = serde_json::json!({
|
||||
"manager": crate::MANAGER_VERSION,
|
||||
"exported_utc": chrono::Utc::now().to_rfc3339(),
|
||||
"core": meta.core,
|
||||
"bots": meta.bots,
|
||||
"squid_bots": crate::squid::release(root),
|
||||
@@ -206,7 +348,34 @@ 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())?;
|
||||
for (name, path) in [("manager.log", manager_log.to_path_buf()), ("manager-install.log", meta_dir.join("logs/manager.log")), ("Server.log.tail", root.join("Core/Logs/Server.log")), ("Errors.log.tail", root.join("Core/Logs/Errors.log")), ("Auth.log.tail", root.join("Core/Logs/Auth.log")), ("world-console.log.tail", root.join("Core/Logs/world-console.log")), ("mysql-error.log.tail", root.join("mysql/logs/mysql-error.log"))] {
|
||||
let 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![
|
||||
("manager.log".into(), manager_log.to_path_buf()),
|
||||
("manager-install.log".into(), meta_dir.join("logs/manager.log")),
|
||||
("Server.log.tail".into(), root.join("Core/Logs/Server.log")),
|
||||
("Errors.log.tail".into(), root.join("Core/Logs/Errors.log")),
|
||||
("Auth.log.tail".into(), root.join("Core/Logs/Auth.log")),
|
||||
("world-console.log.tail".into(), root.join("Core/Logs/world-console.log")),
|
||||
("CoaBots.log.tail".into(), root.join("Core/Logs/CoaBots.log")),
|
||||
("Playerbots.log.tail".into(), root.join("Core/Logs/Playerbots.log")),
|
||||
("supervisor.log.tail".into(), root.join("Core/Logs/supervisor.log")),
|
||||
("mysql-error.log.tail".into(), root.join("mysql/logs/mysql-error.log")),
|
||||
];
|
||||
let updater_logs = newest_files(&root.join("Core/Logs"), "log", usize::MAX).into_iter().filter(|(p, _, _)| p.file_name().is_some_and(|f| f.to_string_lossy().to_lowercase().starts_with("update-")));
|
||||
for (p, _, _) in updater_logs.take(2) {
|
||||
logs.push((format!("{}.tail", p.file_name().unwrap_or_default().to_string_lossy()), p));
|
||||
}
|
||||
for (name, path) in logs {
|
||||
// A module that reads a missing setting on every tick fills a log with one warning, thousands of times; read far
|
||||
// enough back to see past that, fold the repeats, then keep the last part.
|
||||
let bytes = tail(&path, 8 * 1024 * 1024);
|
||||
@@ -214,9 +383,57 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
||||
let text = squash_repeated_config_warnings(&String::from_utf8_lossy(&bytes));
|
||||
let keep = text.len().saturating_sub(512 * 1024);
|
||||
let start = (keep..text.len()).find(|i| text.is_char_boundary(*i)).unwrap_or(text.len());
|
||||
add(name, redact(&text[start..]).as_bytes())?;
|
||||
add(&name, redact(&text[start..]).as_bytes())?;
|
||||
}
|
||||
}
|
||||
|
||||
// Crash reports of the server (text, and the small dumps next to them), and what Windows recorded for the programs.
|
||||
let crashes = root.join("Core/Crashes");
|
||||
let mut listing = String::new();
|
||||
for (p, len, _) in newest_files(&crashes, "txt", 10) {
|
||||
let name = p.file_name().unwrap_or_default().to_string_lossy().into_owned();
|
||||
listing.push_str(&format!("{name} ({len} bytes)\n"));
|
||||
let text = String::from_utf8_lossy(&tail(&p, 1024 * 1024)).into_owned();
|
||||
add(&format!("crashes/{name}"), redact(&text).as_bytes())?;
|
||||
}
|
||||
for (p, len, _) in newest_files(&crashes, "dmp", 3) {
|
||||
let name = p.file_name().unwrap_or_default().to_string_lossy().into_owned();
|
||||
if len > DUMP_FILE_MAX {
|
||||
listing.push_str(&format!("{name} ({len} bytes) not included: larger than {} MB\n", DUMP_FILE_MAX >> 20));
|
||||
} else if let Ok(bytes) = fs::read(&p) {
|
||||
listing.push_str(&format!("{name} ({len} bytes) included\n"));
|
||||
add(&format!("crashes/{name}"), &bytes)?;
|
||||
}
|
||||
}
|
||||
add("crashes.txt", if listing.is_empty() { "No crash reports in Core/Crashes.".to_string() } else { listing }.as_bytes())?;
|
||||
let events = windows_events();
|
||||
if !events.is_empty() { add("windows-events.txt", events.as_bytes())?; }
|
||||
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();
|
||||
journals.sort_by_key(|e| std::cmp::Reverse(e.file_name()));
|
||||
for e in journals.into_iter().take(5) {
|
||||
if let Ok(text) = fs::read_to_string(e.path().join("txn.json")) {
|
||||
add(&format!("updates/{}-txn.json", e.file_name().to_string_lossy()), redact_json(&text).as_bytes())?;
|
||||
}
|
||||
}
|
||||
|
||||
// Which files the server's own configuration folders hold, and the two CoA switches that decide whether the game
|
||||
// client can talk to the world server at all.
|
||||
let mut present = String::new();
|
||||
@@ -244,10 +461,10 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
||||
}
|
||||
}
|
||||
if let Ok(b) = fs::read(root.join("RELEASE.json")) {
|
||||
add("RELEASE.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?;
|
||||
add("RELEASE.json", redact_json(&String::from_utf8_lossy(&b)).as_bytes())?;
|
||||
}
|
||||
if let Ok(b) = fs::read(meta_dir.join("logs/database-checks.json")) {
|
||||
add("database-checks.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?;
|
||||
add("database-checks.json", redact_json(&String::from_utf8_lossy(&b)).as_bytes())?;
|
||||
}
|
||||
zip.finish().map_err(|e| Error::Invalid(e.to_string()))?;
|
||||
Ok(n)
|
||||
@@ -257,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
|
||||
@@ -289,6 +543,68 @@ real error
|
||||
assert!(!t.contains("PASS") && !t.contains("abc"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn json_redaction_keeps_the_file_valid_and_hides_the_secrets() {
|
||||
let t = redact_json(r#"{"id":"rev_20261006_token_cache","password":"hunter2","nested":{"apiKey":"k","note":"login with password=abc"},"list":[{"secret":1},"ok"]}"#);
|
||||
let v: serde_json::Value = serde_json::from_str(&t).expect("still JSON");
|
||||
assert_eq!(v["id"], "rev_20261006_token_cache", "an id that merely contains a word is kept");
|
||||
assert_eq!(v["password"], "[redacted]");
|
||||
assert_eq!(v["nested"]["apiKey"], "[redacted]");
|
||||
assert_eq!(v["nested"]["note"], "[redacted]");
|
||||
assert_eq!(v["list"][0]["secret"], "[redacted]");
|
||||
assert_eq!(v["list"][1], "ok");
|
||||
assert!(!t.contains("hunter2") && !t.contains("abc"));
|
||||
assert!(redact_json("not json\nPassword=1").contains("[line removed"), "text falls back to the line rule");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn windows_events_are_filtered_to_the_server_programs() {
|
||||
let listing = "Event[0]:\n Provider Name: Application Error\n Description: Faulting application name: worldserver.exe, version: 0.0.0.0\n\nEvent[1]:\n Provider Name: Application Error\n Description: Faulting application name: notepad.exe\n\nEvent[2]:\n Description: Faulting application name: MYSQLD.EXE\n";
|
||||
let out = filter_event_blocks(listing, &["worldserver", "mysqld"], 10);
|
||||
assert!(out.contains("worldserver.exe") && out.contains("MYSQLD.EXE") && !out.contains("notepad"));
|
||||
assert_eq!(filter_event_blocks(listing, &["worldserver", "mysqld"], 1).matches("Event[").count(), 1);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn event_text_loses_the_user_and_computer_lines_and_reads_utf16() {
|
||||
let out = drop_identity_lines("Event[0]\n Source: Application Error\n User: S-1-5-21-1\n User Name: PC\\Dion\n Computer: PC\n Description: worldserver.exe");
|
||||
assert!(out.contains("Source") && out.contains("worldserver.exe"));
|
||||
assert!(!out.contains("S-1-5") && !out.contains("Dion") && !out.contains("Computer"));
|
||||
let mut bytes = vec![0xFF, 0xFE];
|
||||
for u in "Сбой worldserver".encode_utf16() { bytes.extend_from_slice(&u.to_le_bytes()); }
|
||||
assert_eq!(decode_console_output(&bytes), "Сбой worldserver");
|
||||
assert_eq!(decode_console_output(b"plain"), "plain");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_package_carries_crash_reports_update_journals_and_the_process_view() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
layout::testkit::fake_repack(&root);
|
||||
fs::create_dir_all(root.join("Core/Crashes")).unwrap();
|
||||
fs::write(root.join("Core/Crashes/567e_worldserver.exe_[4-10_21-25-31].txt"), "Exception code: C0000005\nRCX:0\n").unwrap();
|
||||
fs::write(root.join("Core/Crashes/567e_worldserver.exe_[4-10_21-25-31].dmp"), b"MDMP-small").unwrap();
|
||||
fs::write(root.join("Core/Logs/CoaBots.log"), "bot line\n").unwrap();
|
||||
fs::write(root.join("Core/Logs/update-1.8-20261005.log"), "updater line\n").unwrap();
|
||||
let meta_dir = d.path().join("srv.manager");
|
||||
fs::create_dir_all(meta_dir.join("updates/20261006-082021-0_261006_1-abc")).unwrap();
|
||||
fs::write(meta_dir.join("updates/20261006-082021-0_261006_1-abc/txn.json"), r#"{"state":"rolled-back","message":"Database update 2026_02_24_00 failed: duplicate column"}"#).unwrap();
|
||||
fs::create_dir_all(meta_dir.join("updates/not a journal!")).unwrap();
|
||||
let meta = InstallMeta::new(InstallKind::Imported, &root);
|
||||
let report = run(&root, &meta);
|
||||
let zip_path = d.path().join("diag.zip");
|
||||
export_package(&root, &meta_dir, &d.path().join("none.log"), &meta, &report, &zip_path).unwrap();
|
||||
let mut z = zip::ZipArchive::new(fs::File::open(&zip_path).unwrap()).unwrap();
|
||||
let names: Vec<String> = (0..z.len()).map(|i| z.by_index(i).unwrap().name().to_string()).collect();
|
||||
for want in ["crashes.txt", "processes.txt", "CoaBots.log.tail", "update-1.8-20261005.log.tail", "updates/20261006-082021-0_261006_1-abc-txn.json", "crashes/567e_worldserver.exe_[4-10_21-25-31].txt", "crashes/567e_worldserver.exe_[4-10_21-25-31].dmp"] {
|
||||
assert!(names.iter().any(|n| n == want), "{want} is in the package: {names:?}");
|
||||
}
|
||||
assert!(!names.iter().any(|n| n.contains("not a journal")));
|
||||
let mut listing = String::new();
|
||||
z.by_name("crashes.txt").unwrap().read_to_string(&mut listing).unwrap();
|
||||
assert!(listing.contains("included"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn verify_reports_missing_and_changed_managed_files_only() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
@@ -330,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");
|
||||
@@ -344,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"));
|
||||
}
|
||||
}
|
||||
@@ -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());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,574 @@
|
||||
//! Installing a new server as a Docker installation, from a Linux package.
|
||||
//!
|
||||
//! The order of events is the one of `install::install_base`: nothing appears at the destination until the package is
|
||||
//! signed-off, downloaded, verified, extracted and its database built, all of it in a sibling `<dest>.installing`
|
||||
//! folder. But this is code of its own: the Windows installer is not touched and nothing here is specific to the
|
||||
//! Windows layout. What both installers use is platform-neutral: the signed manifest, the download, the extraction,
|
||||
//! the migration ledger and the registry.
|
||||
//!
|
||||
//! The databases start from the package's own dumps (`Database/baseline/<kind>.sql.zst`, the format of the Manager's
|
||||
//! backups), as a Windows package starts from its prepared database: they hold the state in which every migration of the
|
||||
//! package is already applied, and the installer records them as such. They cannot be rebuilt from the repository's
|
||||
//! SQL files: some migrations are guards that only apply to the maintainers' own database. The game data is not part
|
||||
//! of the package: the person points at a folder they already have.
|
||||
|
||||
use std::fs;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
use super::cli::{Docker, SystemDocker};
|
||||
use super::{Config, MARKER};
|
||||
use crate::db::{self, Account, Db};
|
||||
use crate::download::Cancel;
|
||||
use crate::driver::Verb;
|
||||
use crate::error::{Error, Result};
|
||||
use crate::fsx;
|
||||
use crate::install::{free_port, problem, random_hex, Installed, Preflight, Step};
|
||||
use crate::manifest::{self, Migration};
|
||||
use crate::migrations;
|
||||
use crate::package::BASELINE_DIR;
|
||||
use crate::pkgsource::{fetch_manifest, fetch_parts, Source};
|
||||
use crate::registry::{metadata_dir_for, InstallKind, InstallMeta, MetaDir, Registry, LAYOUT_DOCKER_V1};
|
||||
|
||||
/// Created in the staging folder so a leftover of an earlier attempt can be told from somebody else's folder.
|
||||
const STAGING_MARKER: &str = ".coa-installing";
|
||||
/// The three game databases: kind (the name of the dump), schema.
|
||||
const DATABASES: [(&str, &str); 3] = [("auth", "acore_auth"), ("characters", "acore_characters"), ("world", "acore_world")];
|
||||
/// Ports the game uses by default on this computer.
|
||||
const DEFAULT_PORTS: (u16, u16, u16) = (3724, 8085, 3443);
|
||||
|
||||
pub struct Params<'a> {
|
||||
pub source: Source,
|
||||
pub dest: PathBuf,
|
||||
/// A folder with the game data (dbc, maps, vmaps, mmaps) that the person already has. Used in place, read-only.
|
||||
pub data_dir: PathBuf,
|
||||
/// Public key to verify the manifest with (production: `signing::EMBEDDED_PUBLIC_KEY`).
|
||||
pub trusted_key: &'a str,
|
||||
pub registry: &'a Registry,
|
||||
pub cancel: Cancel,
|
||||
}
|
||||
|
||||
/// Checks whether `dest` and the game data folder are sensible for a new server on Linux.
|
||||
pub fn preflight(dest: &Path, data_dir: &Path, needed_bytes: u64, registry: &Registry) -> Preflight {
|
||||
let mut problems = Vec::new();
|
||||
let s = dest.to_string_lossy();
|
||||
|
||||
if !dest.is_absolute() {
|
||||
problems.push(problem("relative", "Choose a full folder path, such as /home/you/CoaServer."));
|
||||
}
|
||||
if s.contains(':') {
|
||||
problems.push(problem("colon", "Choose a folder whose path has no colon in it."));
|
||||
}
|
||||
let trimmed = s.trim_end_matches('/');
|
||||
const SYSTEM: [&str; 13] = ["", "/bin", "/boot", "/dev", "/etc", "/lib", "/lib64", "/proc", "/run", "/sbin", "/sys", "/usr", "/var"];
|
||||
if SYSTEM.iter().any(|p| trimmed == *p || (!p.is_empty() && trimmed.starts_with(&format!("{p}/")))) {
|
||||
problems.push(problem("system_folder", "Please choose a normal folder for your games, not a system location."));
|
||||
}
|
||||
if let Some(home) = std::env::var_os("HOME") {
|
||||
let home = home.to_string_lossy().trim_end_matches('/').to_string();
|
||||
let special = ["", "/Documents", "/Desktop", "/Downloads", "/Pictures", "/Music", "/Videos", "/.config", "/.local", "/.local/share"];
|
||||
if !home.is_empty() && special.iter().any(|sfx| trimmed == format!("{home}{sfx}")) {
|
||||
problems.push(problem("personal_folder", "This folder contains unrelated files. Choose another folder or create a new CoA Server folder."));
|
||||
}
|
||||
}
|
||||
|
||||
if dest.exists() {
|
||||
match fs::read_dir(dest) {
|
||||
Ok(mut rd) => {
|
||||
if rd.next().is_some() {
|
||||
match crate::layout::scan(dest).map(|r| r.classification) {
|
||||
Ok(crate::layout::Classification::Incompatible) | Err(_) => {
|
||||
if dest.join("Wow.exe").is_file() || dest.join("Ascension.exe").is_file() {
|
||||
problems.push(problem("client_folder", "This is a game client folder, not a place for a server."));
|
||||
} else {
|
||||
problems.push(problem("not_empty", "This folder contains unrelated files. Choose another folder or create a new CoA Server folder."));
|
||||
}
|
||||
}
|
||||
Ok(_) => problems.push(problem("already_server", "A server is already in this folder. Use \"I already have a server\" to add it instead.")),
|
||||
}
|
||||
}
|
||||
}
|
||||
Err(_) => problems.push(problem("unreadable", "This folder cannot be read. Choose another one.")),
|
||||
}
|
||||
}
|
||||
|
||||
if let Ok(list) = registry.list() {
|
||||
for (_, existing) in list {
|
||||
if let (Ok(a), Ok(b)) = (fsx::canonicalize_lenient(dest), fsx::canonicalize_lenient(&existing)) {
|
||||
if fsx::starts_with_ci(&a, &b) || fsx::starts_with_ci(&b, &a) {
|
||||
problems.push(problem("registered", "A server is already registered at or around this location."));
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
problems.extend(data_problems(data_dir));
|
||||
|
||||
let free_bytes = fsx::free_space(dest).unwrap_or(0);
|
||||
let need = needed_bytes.saturating_add(needed_bytes / 5).saturating_add(512 * 1024 * 1024);
|
||||
if free_bytes < need {
|
||||
problems.push(problem("space", &format!("Not enough free space: about {} GB needed, {} GB available.", need / (1 << 30) + 1, free_bytes / (1 << 30))));
|
||||
}
|
||||
Preflight { ok: problems.is_empty(), problems, free_bytes }
|
||||
}
|
||||
|
||||
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.")];
|
||||
}
|
||||
let missing: Vec<&str> = ["dbc", "maps"].into_iter().filter(|d| !data_dir.join(d).is_dir()).collect();
|
||||
if missing.is_empty() {
|
||||
Vec::new()
|
||||
} else {
|
||||
vec![problem("data_missing", &format!("This folder does not look like the game data: {} not found in it. It should hold dbc, maps, vmaps and mmaps.", missing.join(" and ")))]
|
||||
}
|
||||
}
|
||||
|
||||
/// Port the game should use: the usual one when it is free on this computer, else any free one.
|
||||
fn pick_port(preferred: u16) -> Result<u16> {
|
||||
if std::net::TcpListener::bind(("127.0.0.1", preferred)).is_ok() {
|
||||
Ok(preferred)
|
||||
} else {
|
||||
free_port()
|
||||
}
|
||||
}
|
||||
|
||||
/// Settings of a new installation: which containers belong to it, where the game data is, the ports, the passwords.
|
||||
/// Written before anything runs, so the database can be started from the staging folder.
|
||||
struct Settings {
|
||||
app_password: String,
|
||||
world_port: u16,
|
||||
}
|
||||
|
||||
fn write_settings(root: &Path, data_dir: &Path) -> Result<Settings> {
|
||||
let project = random_hex(10);
|
||||
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()), 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.
|
||||
fsx::atomic_write_json(
|
||||
&root.join("Settings/repack.json"),
|
||||
&serde_json::json!({ "mysqlPort": 3307, "authPort": auth, "worldPort": world, "raPort": ra, "raUsername": db::SERVICE_ACCOUNT, "raPassword": "" }),
|
||||
)?;
|
||||
let secrets = root.join("Settings/database.json");
|
||||
fsx::atomic_write_json(&secrets, &serde_json::json!({ "rootPassword": root_password, "appPassword": app_password }))?;
|
||||
#[cfg(unix)]
|
||||
{
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
fs::set_permissions(&secrets, fs::Permissions::from_mode(0o600))?;
|
||||
}
|
||||
Ok(Settings { app_password, world_port: world })
|
||||
}
|
||||
|
||||
/// The package must hold what a Docker installation is made of; say what is missing instead of failing later.
|
||||
fn check_extracted(root: &Path) -> Result<()> {
|
||||
let mut missing = Vec::new();
|
||||
for rel in ["Core/worldserver", "Core/authserver", "Core/configs/worldserver.conf.dist", "Core/configs/authserver.conf.dist"] {
|
||||
if !root.join(rel).is_file() {
|
||||
missing.push(rel.to_string());
|
||||
}
|
||||
}
|
||||
for (kind, _) in DATABASES {
|
||||
if !root.join(BASELINE_DIR).join(format!("{kind}.sql.zst")).is_file() {
|
||||
missing.push(format!("{BASELINE_DIR}/{kind}.sql.zst"));
|
||||
}
|
||||
}
|
||||
if missing.is_empty() {
|
||||
Ok(())
|
||||
} else {
|
||||
Err(Error::Invalid(format!("This package is not a complete Linux server package; missing: {}.", missing.join(", "))))
|
||||
}
|
||||
}
|
||||
|
||||
/// Record every migration of the package as applied without running it, in a few statements (one `docker exec` for each
|
||||
/// of more than a thousand would take minutes). Same ledger rows as `migrations::baseline`.
|
||||
fn baseline_statements(list: &[Migration]) -> Result<Vec<String>> {
|
||||
let ok = |t: &str| !t.is_empty() && t.len() <= 190 && t.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '_' | '.' | '-'));
|
||||
let mut rows = Vec::with_capacity(list.len());
|
||||
for m in list {
|
||||
if !matches!(m.db.as_str(), "auth" | "characters" | "world") || !ok(&m.id) || m.sha256.len() != 64 || !m.sha256.chars().all(|c| c.is_ascii_hexdigit()) {
|
||||
return Err(Error::InvalidManifest(format!("migration {:?} is not valid", m.id)));
|
||||
}
|
||||
rows.push(format!("('{}','{}','{}','applied',NOW(),NULL,1)", m.db, m.id, m.sha256));
|
||||
}
|
||||
Ok(rows
|
||||
.chunks(400)
|
||||
.map(|c| format!("REPLACE INTO `acore_world`.`coa_manager_migrations` (`db`,`id`,`sha256`,`status`,`applied_at`,`error`,`baseline`) VALUES {};", c.join(",")))
|
||||
.collect())
|
||||
}
|
||||
|
||||
/// Create the three schemas and the game servers' account, load the starting databases and record the package's migrations
|
||||
/// as applied. The database container is started from `root` and stopped again by the caller.
|
||||
fn build_database(d: &dyn Docker, root: &Path, list: &[Migration], s: &Settings, say: &dyn Fn(u8, String)) -> Result<()> {
|
||||
let started = super::run_with(d, 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())));
|
||||
}
|
||||
let db = Db::from_repack(root, Account::Admin)?;
|
||||
let mut sql = String::new();
|
||||
for (_, schema) in DATABASES {
|
||||
sql.push_str(&format!("CREATE DATABASE `{schema}` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;\n"));
|
||||
}
|
||||
// The pattern also covers the schemas of other realms (acore_world_wildcard, ...).
|
||||
sql.push_str(&format!("CREATE USER 'acore'@'%' IDENTIFIED BY '{}';\nGRANT ALL PRIVILEGES ON `acore\\_%`.* TO 'acore'@'%';\nFLUSH PRIVILEGES;\n", s.app_password));
|
||||
db.query(&sql)?;
|
||||
|
||||
for (i, (kind, schema)) in DATABASES.iter().enumerate() {
|
||||
say(83 + (i * 4) as u8, format!("Loading the {kind} database"));
|
||||
db.import_from(schema, &root.join(BASELINE_DIR).join(format!("{kind}.sql.zst")))?;
|
||||
}
|
||||
|
||||
say(95 - 3, format!("Recording {} database updates as applied", list.len()));
|
||||
// The ledger table is created by the first read of it.
|
||||
migrations::Store::load(&db)?;
|
||||
for statement in baseline_statements(list)? {
|
||||
db.query(&statement)?;
|
||||
}
|
||||
|
||||
// The realm advertises the port the game server really uses on this computer.
|
||||
db.query(&format!("UPDATE acore_auth.realmlist SET port={} WHERE id=1;", s.world_port))?;
|
||||
// The server console gets its own account with a random password.
|
||||
let console_pw = db.provision_service_account()?;
|
||||
db::write_console_credentials(root, &console_pw)?;
|
||||
if !Db::from_repack(root, Account::Admin)?.ping() {
|
||||
return Err(Error::Invalid("The database did not answer after it was set up.".into()));
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn install(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
||||
install_with(&SystemDocker, p, report)
|
||||
}
|
||||
|
||||
pub fn install_with(d: &dyn Docker, p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
||||
let say = |step: &'static str, percent: u8, detail: Option<String>| report(Step { step, percent, detail });
|
||||
let dest = p.dest.clone();
|
||||
let staging_root = {
|
||||
let mut n = dest.file_name().ok_or_else(|| Error::Invalid("bad destination".into()))?.to_os_string();
|
||||
n.push(".installing");
|
||||
dest.with_file_name(n)
|
||||
};
|
||||
let meta_dir = metadata_dir_for(&dest)?;
|
||||
|
||||
say("Checking your computer", 2, None);
|
||||
super::check_docker(d)?;
|
||||
// The manifest first: it is signed, and tells us how much space we need.
|
||||
let (m, manifest_bytes) = fetch_manifest(&p.source, p.trusted_key)?;
|
||||
if !matches!(m.kind, manifest::Kind::Base | manifest::Kind::Update) || !m.compatible_with_manager(crate::MANAGER_VERSION) {
|
||||
return Err(Error::Invalid("This package needs a newer version of CoA Server Manager.".into()));
|
||||
}
|
||||
let archive = m.archive.clone().ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
|
||||
let download_size: u64 = archive.parts.iter().map(|x| x.size).sum();
|
||||
|
||||
let pre = preflight(&dest, &p.data_dir, archive.unpacked_size + download_size, p.registry);
|
||||
if !pre.ok {
|
||||
return Err(Error::Invalid(pre.problems.iter().map(|x| x.message.clone()).collect::<Vec<_>>().join(" ")));
|
||||
}
|
||||
|
||||
let parts_dir = fetch_parts(&p.source, &m, &meta_dir.join("staging").join("download"), &p.cancel, &|frac, detail| say("Downloading server", 5 + (frac * 45.0) as u8, detail))?;
|
||||
|
||||
if staging_root.exists() {
|
||||
if staging_root.join(STAGING_MARKER).is_file() {
|
||||
fs::remove_dir_all(&staging_root)?; // leftover of an earlier failed attempt that we created
|
||||
} else {
|
||||
return Err(Error::Invalid(format!("{} already exists and was not created by the Manager.", staging_root.display())));
|
||||
}
|
||||
}
|
||||
fs::create_dir_all(&staging_root)?;
|
||||
fs::write(staging_root.join(STAGING_MARKER), b"")?;
|
||||
|
||||
let mut project: Option<Config> = None;
|
||||
let result = (|| -> Result<Installed> {
|
||||
say("Unpacking", 50, None);
|
||||
crate::package::extract(&parts_dir, &m, &staging_root, &|done, total| say("Unpacking", 50 + (done * 30 / total.max(1)) as u8, None))?;
|
||||
check_extracted(&staging_root)?;
|
||||
|
||||
say("Preparing database", 82, None);
|
||||
let settings = write_settings(&staging_root, &p.data_dir)?;
|
||||
project = Some(Config::load(&staging_root)?);
|
||||
let progress = |percent: u8, detail: String| say("Preparing database", percent, Some(detail));
|
||||
let built = build_database(d, &staging_root, &m.migrations, &settings, &progress);
|
||||
let _ = super::run_with(d, &staging_root, Verb::StopAll);
|
||||
built?;
|
||||
fs::remove_file(staging_root.join(STAGING_MARKER))?;
|
||||
|
||||
// Commit: the only moment the destination changes. The database lives in a docker volume, so it does not care
|
||||
// that the folder moves.
|
||||
say("Finishing", 95, None);
|
||||
if dest.exists() {
|
||||
fs::remove_dir(&dest)?; // only succeeds for an empty folder (preflight verified)
|
||||
}
|
||||
fs::rename(&staging_root, &dest)?;
|
||||
super::ensure_main_configs(&dest)?;
|
||||
crate::config::materialize_module_configs(&dest)?;
|
||||
|
||||
let mut meta = InstallMeta::new(InstallKind::New, &dest);
|
||||
meta.layout = LAYOUT_DOCKER_V1.into();
|
||||
meta.core.commit = m.core.commit.clone();
|
||||
meta.core.version = Some(m.version.clone());
|
||||
meta.database.schemas = DATABASES.iter().map(|(_, s)| s.to_string()).collect();
|
||||
meta.managed_files = m.files.iter().map(|f| f.path.clone()).collect();
|
||||
for f in &m.files {
|
||||
meta.original_hashes.insert(f.path.clone(), f.sha256.clone());
|
||||
}
|
||||
let md = MetaDir::create(&dest, &meta)?;
|
||||
fsx::atomic_write(&md.root.join("manifests").join("base.json"), &manifest_bytes)?;
|
||||
p.registry.register(&meta.id, &dest)?;
|
||||
say("Ready", 100, None);
|
||||
Ok(Installed { id: meta.id, path: dest.to_string_lossy().into_owned(), version: m.version.clone() })
|
||||
})();
|
||||
|
||||
if result.is_err() && staging_root.join(STAGING_MARKER).exists() {
|
||||
// Unfinished work of ours; the destination was never touched. Give back what docker holds for it.
|
||||
if let Some(cfg) = &project {
|
||||
super::destroy(d, cfg);
|
||||
}
|
||||
let _ = fs::remove_dir_all(&staging_root);
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::docker::cli::{Call, Output};
|
||||
use crate::package::{self, BuildOptions};
|
||||
use base64::Engine;
|
||||
use ed25519_dalek::{Signer, SigningKey};
|
||||
use std::cell::RefCell;
|
||||
|
||||
struct Fake {
|
||||
calls: RefCell<Vec<Vec<String>>>,
|
||||
unavailable: bool,
|
||||
}
|
||||
|
||||
impl Fake {
|
||||
fn new(unavailable: bool) -> Fake {
|
||||
Fake { calls: Default::default(), unavailable }
|
||||
}
|
||||
}
|
||||
|
||||
impl Docker for Fake {
|
||||
fn run(&self, call: &Call) -> Result<Output> {
|
||||
self.calls.borrow_mut().push(call.args.clone());
|
||||
if self.unavailable {
|
||||
return Err(Error::Invalid("docker could not be started: not found".into()));
|
||||
}
|
||||
Ok(Output { code: Some(0), stdout: "27.3.1".into(), stderr: String::new() })
|
||||
}
|
||||
|
||||
fn pause(&self, _d: std::time::Duration) {}
|
||||
}
|
||||
|
||||
fn reg(d: &Path) -> Registry {
|
||||
Registry::at(d.join("reg/installs.json"))
|
||||
}
|
||||
|
||||
fn codes(p: &Preflight) -> Vec<&'static str> {
|
||||
p.problems.iter().map(|x| x.code).collect()
|
||||
}
|
||||
|
||||
fn data_folder(d: &Path) -> PathBuf {
|
||||
let data = d.join("data");
|
||||
fs::create_dir_all(data.join("dbc")).unwrap();
|
||||
fs::create_dir_all(data.join("maps")).unwrap();
|
||||
data
|
||||
}
|
||||
|
||||
/// A signed package folder holding `files`, and the key that verifies it.
|
||||
fn signed_package(d: &Path, files: &[(&str, &str)]) -> (PathBuf, String) {
|
||||
let src = d.join("src");
|
||||
for (rel, content) in files {
|
||||
let p = src.join(rel);
|
||||
fs::create_dir_all(p.parent().unwrap()).unwrap();
|
||||
fs::write(p, content).unwrap();
|
||||
}
|
||||
let pkg = d.join("pkg");
|
||||
let opts = BuildOptions { kind: manifest::Kind::Update, version: "0.1.0".into(), core_commit: None, built_at: "x".into(), part_size: 1 << 20, bots_commit: None, migrations: vec![] };
|
||||
package::build(&src, &pkg, &opts, &|_| {}).unwrap();
|
||||
let key = SigningKey::generate(&mut rand_core::OsRng);
|
||||
let engine = base64::engine::general_purpose::STANDARD;
|
||||
let sig = engine.encode(key.sign(&fs::read(pkg.join("manifest.json")).unwrap()).to_bytes());
|
||||
fs::write(pkg.join("manifest.json.sig"), sig).unwrap();
|
||||
(pkg, engine.encode(key.verifying_key().to_bytes()))
|
||||
}
|
||||
|
||||
const FULL: [(&str, &str); 7] = [
|
||||
("Core/worldserver", "w"),
|
||||
("Core/authserver", "a"),
|
||||
("Core/configs/worldserver.conf.dist", "x"),
|
||||
("Core/configs/authserver.conf.dist", "x"),
|
||||
("Database/baseline/auth.sql.zst", "dump"),
|
||||
("Database/baseline/characters.sql.zst", "dump"),
|
||||
("Database/baseline/world.sql.zst", "dump"),
|
||||
];
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn the_destination_rules_fit_a_linux_computer() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let data = data_folder(d.path());
|
||||
let ok = |dest: &Path| codes(&preflight(dest, &data, 1000, ®(d.path())));
|
||||
assert!(!ok(&d.path().join("CoaServer")).iter().any(|c| *c != "space"), "a new folder is fine");
|
||||
for bad in ["/usr/local/coa", "/etc", "/", "/proc/x"] {
|
||||
assert!(ok(Path::new(bad)).contains(&"system_folder"), "{bad}");
|
||||
}
|
||||
assert!(ok(Path::new("relative/dir")).contains(&"relative"));
|
||||
assert!(ok(Path::new("/srv/with:colon")).contains(&"colon"));
|
||||
let existing = d.path().join("existing");
|
||||
fs::create_dir_all(&existing).unwrap();
|
||||
fs::write(existing.join("notes.txt"), b"x").unwrap();
|
||||
assert!(ok(&existing).contains(&"not_empty"));
|
||||
let r = reg(d.path());
|
||||
r.register("1", &existing).unwrap();
|
||||
assert!(codes(&preflight(&existing.join("inner"), &data, 1000, &r)).contains(&"registered"));
|
||||
// The same name in another case is another folder on Linux.
|
||||
assert!(!codes(&preflight(&d.path().join("EXISTING"), &data, 1000, &r)).contains(&"registered"));
|
||||
}
|
||||
|
||||
// The tests marked for unix use absolute folders of the temporary directory, which on Windows start with a drive letter and a
|
||||
// colon; the Docker backend refuses a colon in a folder it mounts (it would be read as a separator of `--volume`) and only runs
|
||||
// on Linux, so Windows has nothing to check here.
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn the_game_data_folder_must_look_like_game_data() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let reg = reg(d.path());
|
||||
let dest = d.path().join("srv");
|
||||
let empty = d.path().join("empty");
|
||||
fs::create_dir_all(&empty).unwrap();
|
||||
assert!(codes(&preflight(&dest, &empty, 1, ®)).contains(&"data_missing"));
|
||||
assert!(codes(&preflight(&dest, Path::new("relative/data"), 1, ®)).contains(&"data_path"));
|
||||
assert!(!codes(&preflight(&dest, &data_folder(d.path()), 1, ®)).iter().any(|c| c.starts_with("data")));
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn new_settings_name_the_containers_and_keep_the_secrets_private() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path().join("srv");
|
||||
let data = data_folder(d.path());
|
||||
let s = write_settings(&root, &data).unwrap();
|
||||
|
||||
let cfg = Config::load(&root).unwrap();
|
||||
assert_eq!(cfg.bind_address, "127.0.0.1", "this computer only until the person opens it");
|
||||
assert_eq!(cfg.project.len(), 10);
|
||||
assert_eq!(cfg.data_path(&root), data);
|
||||
|
||||
let ports = crate::layout::read_ports(&root);
|
||||
assert_eq!(ports.world, s.world_port);
|
||||
assert!(ports.auth > 0 && ports.ra > 0);
|
||||
let repack: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json")).unwrap();
|
||||
assert_eq!(repack["raUsername"], db::SERVICE_ACCOUNT);
|
||||
|
||||
let (root_pw, app_pw) = db::credentials(&root).unwrap();
|
||||
assert!(root_pw.len() == 48 && app_pw.len() == 48 && root_pw != app_pw);
|
||||
assert_eq!(app_pw, s.app_password);
|
||||
#[cfg(unix)]
|
||||
{
|
||||
use std::os::unix::fs::PermissionsExt;
|
||||
let mode = fs::metadata(root.join("Settings/database.json")).unwrap().permissions().mode() & 0o777;
|
||||
assert_eq!(mode, 0o600, "the passwords are for their owner only");
|
||||
}
|
||||
// Two installations never share a project name.
|
||||
let other = write_settings(&d.path().join("srv2"), &data).unwrap();
|
||||
assert_ne!(Config::load(&d.path().join("srv2")).unwrap().project, cfg.project);
|
||||
let _ = other;
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_busy_default_port_is_replaced_by_a_free_one() {
|
||||
let held = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
let busy = held.local_addr().unwrap().port();
|
||||
let got = pick_port(busy).unwrap();
|
||||
assert_ne!(got, busy);
|
||||
drop(held);
|
||||
assert_eq!(pick_port(busy).unwrap(), busy, "free again: the usual port is used");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_package_is_checked_for_everything_an_installation_needs() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let root = d.path();
|
||||
assert!(check_extracted(root).unwrap_err().to_string().contains("Core/worldserver"));
|
||||
for (rel, c) in FULL {
|
||||
let p = root.join(rel);
|
||||
fs::create_dir_all(p.parent().unwrap()).unwrap();
|
||||
fs::write(p, c).unwrap();
|
||||
}
|
||||
check_extracted(root).unwrap();
|
||||
fs::remove_file(root.join("Database/baseline/world.sql.zst")).unwrap();
|
||||
assert!(check_extracted(root).unwrap_err().to_string().contains("Database/baseline/world.sql.zst"));
|
||||
}
|
||||
|
||||
fn migration(db: &str, id: &str) -> Migration {
|
||||
Migration { db: db.into(), id: id.into(), sha256: "ab".repeat(32), destructive: false, compatible_sha256: vec![] }
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_package_migrations_are_recorded_as_applied_in_a_few_statements() {
|
||||
let list: Vec<Migration> = (0..1000).map(|i| migration(["auth", "characters", "world"][i % 3], &format!("rev_{i}"))).collect();
|
||||
let statements = baseline_statements(&list).unwrap();
|
||||
assert_eq!(statements.len(), 3, "400 rows at most in a statement");
|
||||
assert!(statements[0].starts_with("REPLACE INTO `acore_world`.`coa_manager_migrations`"));
|
||||
assert_eq!(statements.iter().map(|s| s.matches("'applied'").count()).sum::<usize>(), 1000);
|
||||
assert!(statements[0].contains("('auth','rev_0',") && statements[0].contains(",NOW(),NULL,1)"), "marked as a baseline");
|
||||
assert!(baseline_statements(&[]).unwrap().is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn a_migration_that_could_carry_sql_is_refused_before_anything_is_written() {
|
||||
for bad in [migration("world", "x'); DROP TABLE y;--"), migration("mysql", "ok"), migration("world", ""), Migration { sha256: "zz".into(), ..migration("world", "ok") }] {
|
||||
assert!(baseline_statements(&[migration("auth", "fine"), bad]).is_err());
|
||||
}
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn without_docker_nothing_is_downloaded_or_created() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (pkg, key) = signed_package(d.path(), &FULL);
|
||||
let dest = d.path().join("dest");
|
||||
let r = reg(d.path());
|
||||
let fake = Fake::new(true);
|
||||
let err = install_with(&fake, &Params { source: Source::Dir(pkg), dest: dest.clone(), data_dir: data_folder(d.path()), trusted_key: &key, registry: &r, cancel: Cancel::default() }, &|_| {}).unwrap_err();
|
||||
assert!(err.to_string().to_lowercase().contains("docker"), "{err}");
|
||||
assert!(!dest.exists() && !dest.with_file_name("dest.installing").exists());
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn a_package_without_the_server_is_refused_and_leaves_nothing() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (pkg, key) = signed_package(d.path(), &[("Core/configs/worldserver.conf.dist", "x"), ("README.txt", "hello")]);
|
||||
let dest = d.path().join("dest");
|
||||
let r = reg(d.path());
|
||||
let fake = Fake::new(false);
|
||||
let err = install_with(&fake, &Params { source: Source::Dir(pkg), dest: dest.clone(), data_dir: data_folder(d.path()), trusted_key: &key, registry: &r, cancel: Cancel::default() }, &|_| {}).unwrap_err();
|
||||
assert!(err.to_string().contains("not a complete Linux server package"), "{err}");
|
||||
assert!(!dest.exists() && !dest.with_file_name("dest.installing").exists());
|
||||
assert!(r.list().unwrap().is_empty());
|
||||
}
|
||||
|
||||
#[cfg(unix)]
|
||||
#[test]
|
||||
fn a_failed_database_setup_gives_back_what_docker_holds_and_leaves_no_server() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let (pkg, key) = signed_package(d.path(), &FULL);
|
||||
let dest = d.path().join("dest");
|
||||
let r = reg(d.path());
|
||||
// This fake docker answers every command with success and no container, so the database never becomes ready.
|
||||
let fake = Fake::new(false);
|
||||
let err = install_with(&fake, &Params { source: Source::Dir(pkg), dest: dest.clone(), data_dir: data_folder(d.path()), trusted_key: &key, registry: &r, cancel: Cancel::default() }, &|_| {}).unwrap_err();
|
||||
assert!(err.to_string().to_lowercase().contains("database"), "{err}");
|
||||
assert!(!dest.exists() && !dest.with_file_name("dest.installing").exists(), "no half-installed server");
|
||||
assert!(r.list().unwrap().is_empty());
|
||||
let calls = fake.calls.borrow();
|
||||
let removed = |suffix: &str| calls.iter().any(|c| c[0] == "rm" && c.last().is_some_and(|n| n.starts_with("coa-") && n.ends_with(suffix)));
|
||||
assert!(removed("-db") && removed("-world") && removed("-auth"), "containers removed: {calls:?}");
|
||||
assert!(calls.iter().any(|c| c[..2] == ["volume", "rm"]) && calls.iter().any(|c| c[..2] == ["network", "rm"]));
|
||||
}
|
||||
}
|
||||
@@ -80,6 +80,26 @@ fn docker(d: &dyn Docker, args: &[&str], timeout: Duration) -> Step<super::cli::
|
||||
d.run(&Call::new(args, timeout)).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))
|
||||
}
|
||||
|
||||
/// Is docker usable by this user? Returns its version, or the reason in docker's own words.
|
||||
pub fn check_docker(d: &dyn Docker) -> Result<String> {
|
||||
let mut log = Log::default();
|
||||
match preflight(d, &mut log) {
|
||||
Ok(()) => Ok(log.0.join(" ")),
|
||||
Err(f) => Err(crate::error::Error::Invalid(format!("{} {}", f.code.human().message, f.output.trim()).trim().to_string())),
|
||||
}
|
||||
}
|
||||
|
||||
/// Remove everything docker holds for an installation: containers, network and the database volume. Used when an
|
||||
/// installation fails before it is finished, and later to uninstall. Missing pieces are not an error.
|
||||
pub(crate) fn destroy(d: &dyn Docker, cfg: &Config) {
|
||||
let n = cfg.names();
|
||||
for name in [&n.auth, &n.world, &n.db] {
|
||||
let _ = d.run(&Call::new(&["rm", "--force", name], QUICK));
|
||||
}
|
||||
let _ = d.run(&Call::new(&["network", "rm", &n.network], QUICK));
|
||||
let _ = d.run(&Call::new(&["volume", "rm", &n.volume], QUICK));
|
||||
}
|
||||
|
||||
fn preflight(d: &dyn Docker, log: &mut Log) -> Step<()> {
|
||||
let o = docker(d, &["version", "--format", "{{.Server.Version}}"], QUICK)?;
|
||||
if !o.ok() {
|
||||
@@ -190,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() {
|
||||
@@ -203,7 +223,12 @@ 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() })?;
|
||||
let owner = owner_of(root);
|
||||
let host = std::fs::canonicalize(root).unwrap_or_else(|_| root.to_path_buf());
|
||||
@@ -212,23 +237,44 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
|
||||
if !state.get(&n.world).is_some_and(Container::running) {
|
||||
remove(d, &n.world);
|
||||
let mut call = Call::new(&[], Duration::from_secs(60));
|
||||
call.args = game_args(cfg, &n, GameKind::World, &host, ports.world, ports.ra, owner.as_deref());
|
||||
call.env = database_env(&secrets, true);
|
||||
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, 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, ports.auth, 0, owner.as_deref());
|
||||
call.env = database_env(&secrets, false);
|
||||
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, 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));
|
||||
@@ -312,19 +358,35 @@ 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.
|
||||
a.extend(["--health-cmd".into(), "mysqladmin ping --silent".into()]);
|
||||
// "mysqladmin ping" succeeds as soon as the server answers, with or without a login. It must go over TCP, like
|
||||
// everything the Manager sends: while a new database initialises, the image first runs a temporary server that
|
||||
// answers on its socket but takes no network connection, and a socket ping would call the container healthy for a few
|
||||
// seconds in which every TCP connection is still refused.
|
||||
a.extend(["--health-cmd".into(), "mysqladmin ping --protocol=tcp --host=127.0.0.1 --silent".into()]);
|
||||
a.extend(["--health-interval".into(), "5s".into(), "--health-timeout".into(), "5s".into(), "--health-retries".into(), "40".into()]);
|
||||
a.extend(["--stop-timeout".into(), "60".into()]);
|
||||
a.push(cfg.mysql_image.clone());
|
||||
if cfg.mysql_data.is_some() {
|
||||
a.push("--lower-case-table-names=1".into());
|
||||
}
|
||||
a
|
||||
}
|
||||
|
||||
@@ -335,17 +397,48 @@ 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
|
||||
}
|
||||
|
||||
fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, port: u16, ra_port: u16, owner: Option<&str>) -> Vec<String> {
|
||||
/// 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),
|
||||
GameKind::Auth => (&n.auth, "auth", "./authserver", "configs/authserver.conf", AUTH_PORT),
|
||||
@@ -370,7 +463,11 @@ fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, port: u16, ra
|
||||
// the container and stops the server when it cannot find one.
|
||||
a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0"));
|
||||
if kind == GameKind::World {
|
||||
a.extend(["--volume".into(), format!("{}:{DATA}:ro", host.join("Data").display())]);
|
||||
a.extend(["--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}")]);
|
||||
@@ -609,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));
|
||||
@@ -651,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");
|
||||
}
|
||||
@@ -674,6 +777,70 @@ 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");
|
||||
let sim = Sim::new();
|
||||
assert!(start_all(&sim, &root).ok);
|
||||
let db = &sim.calls_of("run")[0].args;
|
||||
let i = db.iter().position(|a| a == "--health-cmd").expect("the database has a health check");
|
||||
// Found on a new volume: a socket-only ping reported healthy about four seconds before TCP worked.
|
||||
assert!(db[i + 1].contains("--protocol=tcp") && db[i + 1].contains("--host=127.0.0.1"), "{}", db[i + 1]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn the_world_container_is_wired_like_the_repack_layout() {
|
||||
let (_d, root) = server("t1");
|
||||
@@ -714,8 +881,8 @@ mod tests {
|
||||
let (_d, root) = server("ports");
|
||||
let cfg = Config::load(&root).unwrap();
|
||||
let n = cfg.names();
|
||||
let world = game_args(&cfg, &n, GameKind::World, &root, 18085, 13443, None);
|
||||
let auth = game_args(&cfg, &n, GameKind::Auth, &root, 13724, 0, None);
|
||||
let world = game_args(&cfg, &n, GameKind::World, &root, &root.join("Data"), 18085, 13443, None);
|
||||
let auth = game_args(&cfg, &n, GameKind::Auth, &root, &root.join("Data"), 13724, 0, None);
|
||||
assert!(world.iter().any(|a| a == "127.0.0.1:18085:8085"));
|
||||
assert!(world.iter().any(|a| a == "127.0.0.1:13443:3443"));
|
||||
assert!(world.iter().any(|a| a == "AC_WORLD_SERVER_PORT=8085"));
|
||||
|
||||
@@ -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"));
|
||||
}
|
||||
}
|
||||
@@ -15,10 +15,16 @@
|
||||
//! ```
|
||||
|
||||
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::{observe, observe_with, run, run_with};
|
||||
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;
|
||||
use std::path::Path;
|
||||
@@ -31,7 +37,7 @@ use crate::layout::{self, Classification, ScanReport};
|
||||
|
||||
/// Present in a Docker installation, absent from a repack.
|
||||
pub const MARKER: &str = "Settings/docker.json";
|
||||
const MYSQL_IMAGE: &str = "mysql:8.4";
|
||||
pub(crate) const MYSQL_IMAGE: &str = "mysql:8.4";
|
||||
const RUNTIME_DOCKERFILE: &str = include_str!("Dockerfile.runtime");
|
||||
|
||||
pub fn is_docker(root: &Path) -> bool {
|
||||
@@ -57,6 +63,14 @@ pub struct Config {
|
||||
pub bind_address: String,
|
||||
#[serde(default = "mysql_image")]
|
||||
pub mysql_image: String,
|
||||
/// Where the game data (dbc, maps, vmaps, mmaps) is, when it is not the `Data` folder of the server. Used in place and
|
||||
/// 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 {
|
||||
@@ -74,6 +88,11 @@ impl Config {
|
||||
Ok(cfg)
|
||||
}
|
||||
|
||||
/// The folder mounted as the game data.
|
||||
pub fn data_path(&self, root: &Path) -> std::path::PathBuf {
|
||||
self.data_dir.as_deref().map(std::path::PathBuf::from).unwrap_or_else(|| root.join("Data"))
|
||||
}
|
||||
|
||||
fn validate(&self) -> Result<()> {
|
||||
let name_ok = !self.project.is_empty()
|
||||
&& self.project.len() <= 32
|
||||
@@ -85,6 +104,12 @@ impl Config {
|
||||
if self.bind_address.parse::<IpAddr>().is_err() {
|
||||
return Err(Error::Invalid(format!("{} is not an IP address.", self.bind_address)));
|
||||
}
|
||||
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("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));
|
||||
if !image_ok {
|
||||
return Err(Error::Invalid("The database image name is not valid.".into()));
|
||||
@@ -103,6 +128,99 @@ impl Config {
|
||||
}
|
||||
}
|
||||
|
||||
/// Create the world and auth configuration files from their `.dist` templates when they do not exist. A package only
|
||||
/// carries the templates, and on Windows the launcher writes the active files at every start; here nothing else would.
|
||||
/// An existing file is never touched, so the person's settings survive updates. Returns the files created.
|
||||
pub fn ensure_main_configs(root: &Path) -> Result<Vec<String>> {
|
||||
let mut created = Vec::new();
|
||||
for name in ["worldserver", "authserver"] {
|
||||
let (conf, dist) = (root.join(format!("Core/configs/{name}.conf")), root.join(format!("Core/configs/{name}.conf.dist")));
|
||||
if !conf.exists() && dist.is_file() {
|
||||
std::fs::copy(&dist, &conf)?;
|
||||
created.push(format!("{name}.conf"));
|
||||
}
|
||||
}
|
||||
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])
|
||||
@@ -123,7 +241,8 @@ pub(crate) fn scan(root: &Path) -> Result<ScanReport> {
|
||||
let bot_active = modules_dir.join("mod_coa_playerbots.conf");
|
||||
let bot_conf = if bot_active.is_file() { bot_active } else { modules_dir.join("mod_coa_playerbots.conf.dist") };
|
||||
let bot_config_keys = layout::count_bot_keys(&bot_conf);
|
||||
let has_data = layout::exists(root, "Data/dbc") && layout::exists(root, "Data/maps");
|
||||
let data = cfg.as_ref().map(|c| c.data_path(root)).unwrap_or_else(|_| root.join("Data"));
|
||||
let has_data = data.join("dbc").is_dir() && data.join("maps").is_dir();
|
||||
let has_confs = layout::exists(root, "Core/configs/worldserver.conf") && layout::exists(root, "Core/configs/authserver.conf");
|
||||
|
||||
let items = vec![
|
||||
@@ -162,3 +281,90 @@ pub(crate) fn scan(root: &Path) -> Result<ScanReport> {
|
||||
})
|
||||
}
|
||||
|
||||
|
||||
#[cfg(test)]
|
||||
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();
|
||||
let cfg = d.path().join("Core/configs");
|
||||
fs::create_dir_all(&cfg).unwrap();
|
||||
fs::write(cfg.join("worldserver.conf.dist"), "Setting = default\n").unwrap();
|
||||
fs::write(cfg.join("authserver.conf.dist"), "Auth = default\n").unwrap();
|
||||
|
||||
assert_eq!(ensure_main_configs(d.path()).unwrap(), ["worldserver.conf", "authserver.conf"]);
|
||||
assert_eq!(fs::read_to_string(cfg.join("worldserver.conf")).unwrap(), "Setting = default\n");
|
||||
|
||||
// The person's own settings survive the next start.
|
||||
fs::write(cfg.join("worldserver.conf"), "Setting = mine\n").unwrap();
|
||||
assert!(ensure_main_configs(d.path()).unwrap().is_empty());
|
||||
assert_eq!(fs::read_to_string(cfg.join("worldserver.conf")).unwrap(), "Setting = mine\n");
|
||||
// Without a template there is nothing to create and nothing fails.
|
||||
fs::remove_file(cfg.join("authserver.conf")).unwrap();
|
||||
fs::remove_file(cfg.join("authserver.conf.dist")).unwrap();
|
||||
assert!(ensure_main_configs(d.path()).unwrap().is_empty());
|
||||
}
|
||||
}
|
||||
@@ -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));
|
||||
}
|
||||
}
|
||||
@@ -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 {
|
||||
@@ -136,6 +143,8 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
|
||||
}
|
||||
}
|
||||
}
|
||||
discard_damaged_launcher_state(&root);
|
||||
if matches!(verb, Verb::StopAll | Verb::StartMysql | Verb::StartAll) { recover_mysql_launcher_state(&root, verb != Verb::StopAll)?; }
|
||||
let mut cmd = Command::new(&python);
|
||||
cmd.arg("-B").arg("-c").arg(LAUNCH_SCRIPT).arg(&script).arg(verb.arg())
|
||||
.current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped());
|
||||
@@ -172,7 +181,7 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
|
||||
};
|
||||
let mut output = out_t.join().unwrap_or_default();
|
||||
output.push_str(&err_t.join().unwrap_or_default());
|
||||
let output = output.trim().to_string();
|
||||
let mut output = output.trim().to_string();
|
||||
let (ok, exit_code) = match status {
|
||||
Some(st) => (st.success(), st.code()),
|
||||
None => (false, None),
|
||||
@@ -187,12 +196,95 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
|
||||
other => Some(other),
|
||||
}
|
||||
};
|
||||
if code == Some(ErrorCode::PortInUse) {
|
||||
let observed = crate::process::observe(&root, &crate::layout::read_ports(&root));
|
||||
for service in [&observed.mysql, &observed.auth, &observed.world].into_iter().chain(observed.secondary_world.iter()) {
|
||||
if let Some(conflict) = &service.conflict {
|
||||
output.push_str(&format!("\nPort {} is used by process {} ({}).", conflict.port, conflict.pid, conflict.exe.as_deref().unwrap_or("executable unavailable")));
|
||||
}
|
||||
}
|
||||
}
|
||||
tracing::info!(?verb, ok, ?code, "driver: launcher verb finished");
|
||||
if !ok && !output.is_empty() {
|
||||
let redacted = crate::diag::redact(&output);
|
||||
let tail: Vec<_> = redacted.lines().rev().take(12).collect();
|
||||
tracing::warn!(?verb, exit_code, output = %tail.into_iter().rev().collect::<Vec<_>>().join("\n"), "driver: launcher verb failed");
|
||||
}
|
||||
if ok && verb == Verb::StartAll { crate::multiworld::start(&root)?; }
|
||||
Ok(DriverOutcome { ok, exit_code, code, human: code.map(ErrorCode::human), output })
|
||||
}
|
||||
|
||||
const LAUNCH_SCRIPT: &str = "import runpy,sys;from pathlib import Path;script=sys.argv[1];sys.path.insert(0,str(Path(script).resolve().parent));sys.argv=sys.argv[1:];runpy.run_path(script,run_name='__main__')";
|
||||
/// 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
|
||||
/// launcher treats a missing record as "not running". Only empty or all-zero `*.json` files are touched.
|
||||
pub(crate) fn discard_damaged_launcher_state(root: &Path) -> Vec<PathBuf> {
|
||||
let mut removed = Vec::new();
|
||||
let Ok(entries) = std::fs::read_dir(root.join(".state")) else { return removed; };
|
||||
for entry in entries.flatten() {
|
||||
let path = entry.path();
|
||||
if path.extension().is_none_or(|e| !e.eq_ignore_ascii_case("json")) || !path.is_file() { continue; }
|
||||
let Ok(bytes) = std::fs::read(&path) else { continue; };
|
||||
if bytes.iter().all(|b| *b == 0) && std::fs::remove_file(&path).is_ok() {
|
||||
tracing::warn!(file = %path.display(), bytes = bytes.len(), "driver: removed a launcher state file damaged by an interrupted write");
|
||||
removed.push(path);
|
||||
}
|
||||
}
|
||||
removed
|
||||
}
|
||||
|
||||
/// A lost launcher record must not hide this installation's running MySQL from
|
||||
/// graceful shutdown. Adopt only the exact executable owning its configured port.
|
||||
fn recover_mysql_launcher_state(root: &Path, prefer_listener: bool) -> Result<()> {
|
||||
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
|
||||
if observed.mysql.state != crate::process::ServiceState::Running || !observed.mysql.port_ready { return Ok(()); }
|
||||
let Some(pid) = observed.mysql.pid else { return Ok(()); };
|
||||
let Some(identity) = crate::process::identity(pid) else { return Ok(()); };
|
||||
let (_, _, executable) = crate::layout::executables(root);
|
||||
if !crate::process::find_by_exe(&executable).iter().any(|candidate| candidate.same_as(&identity))
|
||||
|| !crate::process::listeners().contains(&(observed.mysql.port, pid)) { return Ok(()); }
|
||||
if let Some(saved) = crate::process::read_state_record(root, "mysql") {
|
||||
if saved.same_as(&identity) { return Ok(()); }
|
||||
if crate::process::is_alive(&saved) {
|
||||
// A valid record may describe the MySQL supervisor rather than its
|
||||
// listening child. The launcher can gracefully stop either record.
|
||||
if crate::process::find_by_exe(&executable).iter().any(|candidate| candidate.same_as(&saved)) {
|
||||
if !prefer_listener { return Ok(()); }
|
||||
} else {
|
||||
return Err(Error::Invalid("The MySQL launcher record identifies a different live process. No database action was requested.".into()));
|
||||
}
|
||||
}
|
||||
}
|
||||
let state = root.join(".state/mysql.json");
|
||||
let previous = root.join(".state/mysql-before-shutdown-recovery.json");
|
||||
if state.is_file() && !previous.exists() { fsx::atomic_write(&previous, &std::fs::read(&state)?)?; }
|
||||
fsx::atomic_write_json(&state, &identity)?;
|
||||
tracing::warn!(pid, root = %root.display(), "Recovered MySQL launcher identity from the installed executable owning its port");
|
||||
Ok(())
|
||||
}
|
||||
|
||||
const LAUNCH_SCRIPT: &str = "import runpy,sys\nfrom pathlib import Path\nscript=sys.argv[1]\nsys.path.insert(0,str(Path(script).resolve().parent))\nsys.argv=sys.argv[1:]\nif sys.argv[1]=='stop-all':\n launcher=runpy.run_path(script,run_name='coa_manager_shutdown')\n config=launcher['settings']()\n with launcher['control_lock']():\n launcher['stop_all'](config)\nelse:\n runpy.run_path(script,run_name='__main__')";
|
||||
|
||||
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
|
||||
let line = "sys.path.insert(0, str(Path(__file__).resolve().parent))";
|
||||
@@ -231,14 +323,111 @@ 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::*;
|
||||
|
||||
#[cfg(windows)]
|
||||
#[test]
|
||||
fn shutdown_recovery_never_adopts_a_foreign_port_listener() {
|
||||
let root = tempfile::tempdir().unwrap();
|
||||
let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
fsx::atomic_write_json(&root.path().join("Settings/repack.json"), &serde_json::json!({"mysqlPort":listener.local_addr().unwrap().port()})).unwrap();
|
||||
recover_mysql_launcher_state(root.path(), false).unwrap();
|
||||
recover_mysql_launcher_state(root.path(), true).unwrap();
|
||||
assert!(!root.path().join(".state/mysql.json").exists());
|
||||
assert!(crate::process::identity(std::process::id()).is_some());
|
||||
}
|
||||
|
||||
#[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();
|
||||
@@ -251,6 +440,24 @@ mod tests {
|
||||
assert_eq!(Verb::StartWorld.timeout(folder.path()), Duration::from_secs(420));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn zero_filled_launcher_state_is_discarded_and_valid_state_is_kept() {
|
||||
let folder = tempfile::tempdir().unwrap();
|
||||
let state = folder.path().join(".state");
|
||||
std::fs::create_dir_all(&state).unwrap();
|
||||
std::fs::write(state.join("mysql.json"), vec![0u8; 116]).unwrap();
|
||||
std::fs::write(state.join("configuration.json"), Vec::<u8>::new()).unwrap();
|
||||
std::fs::write(state.join("world.json"), "{\"pid\": 4}\n").unwrap();
|
||||
std::fs::write(state.join("stop-relay"), Vec::<u8>::new()).unwrap();
|
||||
std::fs::write(state.join("auth.json"), "{\"pid\": 0}").unwrap();
|
||||
let mut removed: Vec<_> = discard_damaged_launcher_state(folder.path()).iter().map(|p| p.file_name().unwrap().to_string_lossy().into_owned()).collect();
|
||||
removed.sort();
|
||||
assert_eq!(removed, ["configuration.json", "mysql.json"]);
|
||||
assert!(state.join("world.json").exists() && state.join("auth.json").exists() && state.join("stop-relay").exists());
|
||||
assert!(discard_damaged_launcher_state(folder.path()).is_empty());
|
||||
assert!(discard_damaged_launcher_state(&folder.path().join("missing")).is_empty());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn translates_known_launcher_messages() {
|
||||
assert_eq!(translate("RuntimeError: Port 8085 is already used. Stop the other server"), ErrorCode::PortInUse);
|
||||
@@ -266,6 +473,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();
|
||||
|
||||
@@ -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.",
|
||||
|
||||
@@ -31,11 +31,25 @@ pub struct Settings {
|
||||
pub mode: Mode,
|
||||
/// The address friends type into their client for this mode.
|
||||
pub host: Option<String>,
|
||||
/// Independent of the effective host of the current mode. None means automatic LAN detection.
|
||||
#[serde(default)]
|
||||
pub lan_address_override: Option<String>,
|
||||
}
|
||||
|
||||
impl Default for Settings {
|
||||
fn default() -> Self {
|
||||
Settings { mode: Mode::Local, host: None }
|
||||
Settings { mode: Mode::Local, host: None, lan_address_override: None }
|
||||
}
|
||||
}
|
||||
|
||||
impl Settings {
|
||||
/// Only LAN application changes the LAN preference. Other modes keep it for the next LAN session.
|
||||
pub fn select_mode(&mut self, mode: Mode, host: String, lan_override: Option<String>) {
|
||||
if mode == Mode::Lan {
|
||||
self.lan_address_override = lan_override;
|
||||
}
|
||||
self.mode = mode;
|
||||
self.host = Some(host);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -66,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
|
||||
@@ -76,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();
|
||||
@@ -111,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()));
|
||||
@@ -119,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(())
|
||||
}
|
||||
|
||||
@@ -233,7 +254,7 @@ CoA.AllowRemoteClients = 0
|
||||
fn a_shared_server_gets_its_bind_address_back_before_start_and_a_local_one_is_left_alone() {
|
||||
let (_d, root, meta) = setup();
|
||||
assert!(!ensure_bind(&root, &meta).unwrap(), "local mode: nothing to do");
|
||||
save(&meta, &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()) }).unwrap();
|
||||
save(&meta, &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()), ..Settings::default() }).unwrap();
|
||||
assert!(ensure_bind(&root, &meta).unwrap(), "templates were reset to 127.0.0.1 -> reopened");
|
||||
assert!(bind_is_open(&root));
|
||||
assert!(!ensure_bind(&root, &meta).unwrap(), "already open: idempotent");
|
||||
@@ -243,11 +264,39 @@ CoA.AllowRemoteClients = 0
|
||||
fn settings_round_trip_and_default_to_local() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
assert_eq!(load(d.path()).mode, Mode::Local);
|
||||
save(d.path(), &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()) }).unwrap();
|
||||
save(d.path(), &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()), ..Settings::default() }).unwrap();
|
||||
let s = load(d.path());
|
||||
assert_eq!((s.mode, s.host.as_deref()), (Mode::Private, Some("100.64.1.2")));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn old_settings_load_without_migrating_effective_host_to_override() {
|
||||
let s: Settings = serde_json::from_str(r#"{"mode":"lan","host":"192.168.1.50"}"#).unwrap();
|
||||
assert_eq!(s.mode, Mode::Lan);
|
||||
assert_eq!(s.host.as_deref(), Some("192.168.1.50"));
|
||||
assert_eq!(s.lan_address_override, None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn lan_preference_survives_save_load_and_every_other_mode_and_can_be_cleared() {
|
||||
let d = tempfile::tempdir().unwrap();
|
||||
let mut s = Settings::default();
|
||||
s.select_mode(Mode::Lan, "192.168.1.50".into(), Some("192.168.1.50".into()));
|
||||
for (mode, host) in [(Mode::Private, "100.101.20.5"), (Mode::Direct, "203.0.113.9"), (Mode::Local, "127.0.0.1")] {
|
||||
s.select_mode(mode, host.into(), None);
|
||||
save(d.path(), &s).unwrap();
|
||||
s = load(d.path());
|
||||
assert_eq!(s.lan_address_override.as_deref(), Some("192.168.1.50"));
|
||||
assert_eq!(s.host.as_deref(), Some(host));
|
||||
let lan = crate::net::resolve_lan_host(s.lan_address_override.as_deref(), Some("192.168.0.169".parse().unwrap())).unwrap();
|
||||
s.select_mode(Mode::Lan, lan, s.lan_address_override.clone());
|
||||
assert_eq!(s.host.as_deref(), Some("192.168.1.50"));
|
||||
}
|
||||
s.select_mode(Mode::Lan, "192.168.0.169".into(), None);
|
||||
save(d.path(), &s).unwrap();
|
||||
assert_eq!(load(d.path()).lan_address_override, None);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn friend_package_contains_only_whitelisted_files() {
|
||||
let (d, root, _m) = setup();
|
||||
@@ -274,4 +323,23 @@ CoA.AllowRemoteClients = 0
|
||||
}
|
||||
assert!(make_friend_package(&root, "bad host; x", false, &d.path().join("x.zip")).is_err());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn manual_lan_host_survives_startup_bind_restoration_and_drives_friend_package() {
|
||||
let (d, root, meta) = setup();
|
||||
let mut s = Settings::default();
|
||||
s.select_mode(Mode::Lan, "192.168.1.50".into(), Some("192.168.1.50".into()));
|
||||
save(&meta, &s).unwrap();
|
||||
assert!(ensure_bind(&root, &meta).unwrap());
|
||||
assert!(bind_is_open(&root));
|
||||
let restored = load(&meta);
|
||||
assert_eq!(restored.host.as_deref(), Some("192.168.1.50"));
|
||||
assert_eq!(restored.lan_address_override.as_deref(), Some("192.168.1.50"));
|
||||
let package = d.path().join("manual-lan.zip");
|
||||
make_friend_package(&root, restored.host.as_deref().unwrap(), false, &package).unwrap();
|
||||
let mut zip = zip::ZipArchive::new(fs::File::open(package).unwrap()).unwrap();
|
||||
let mut realm = String::new();
|
||||
std::io::Read::read_to_string(&mut zip.by_name("realmlist.wtf").unwrap(), &mut realm).unwrap();
|
||||
assert_eq!(realm, "set realmlist 192.168.1.50\r\n");
|
||||
}
|
||||
}
|
||||
@@ -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) {
|
||||
|
||||
@@ -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.";
|
||||
|
||||
@@ -35,7 +35,7 @@ pub struct Preflight {
|
||||
pub free_bytes: u64,
|
||||
}
|
||||
|
||||
fn problem(code: &'static str, message: &str) -> Problem {
|
||||
pub(crate) fn problem(code: &'static str, message: &str) -> Problem {
|
||||
Problem { code, message: message.into() }
|
||||
}
|
||||
|
||||
@@ -133,7 +133,7 @@ pub struct Installed {
|
||||
pub version: String,
|
||||
}
|
||||
|
||||
fn random_hex(n: usize) -> String {
|
||||
pub(crate) fn random_hex(n: usize) -> String {
|
||||
let mut s = String::new();
|
||||
while s.len() < n {
|
||||
s.push_str(&uuid::Uuid::new_v4().simple().to_string());
|
||||
@@ -148,7 +148,7 @@ pub(crate) fn bootstrap_database(root: &Path) -> Result<()> {
|
||||
with_scratch_ports(root, || bootstrap_database_inner(root))
|
||||
}
|
||||
|
||||
fn free_port() -> Result<u16> {
|
||||
pub(crate) fn free_port() -> Result<u16> {
|
||||
Ok(std::net::TcpListener::bind("127.0.0.1:0")?.local_addr()?.port())
|
||||
}
|
||||
|
||||
@@ -183,7 +183,7 @@ fn bootstrap_database_inner(root: &Path) -> Result<()> {
|
||||
|
||||
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())));
|
||||
return Err(Error::Invalid(format!("The database could not be started. {}", driver::startup_failure(root, &started))));
|
||||
}
|
||||
let result = (|| -> Result<()> {
|
||||
let db = Db::from_repack(root, Account::Admin)?;
|
||||
@@ -201,6 +201,10 @@ fn bootstrap_database_inner(root: &Path) -> Result<()> {
|
||||
sql.push_str("FLUSH PRIVILEGES;\n");
|
||||
db.query(&sql)?;
|
||||
fsx::atomic_write_json(&target, &serde_json::json!({ "rootPassword": root_pw, "appPassword": app_pw }))?;
|
||||
fsx::atomic_write(&root.join("mysql/admin-client.ini"), format!(
|
||||
"[client]\nuser=root\npassword={root_pw}\nhost=127.0.0.1\nport={}\nprotocol=tcp\ndefault-character-set=utf8mb4\n",
|
||||
crate::layout::read_ports(root).mysql,
|
||||
).as_bytes())?;
|
||||
// The server console gets its own account with a random password instead of a shared default.
|
||||
let console_pw = Db::from_repack(root, Account::Admin)?.provision_service_account()?; // new root password
|
||||
db::write_console_credentials(root, &console_pw)?;
|
||||
@@ -210,8 +214,14 @@ fn bootstrap_database_inner(root: &Path) -> Result<()> {
|
||||
}
|
||||
Ok(())
|
||||
})();
|
||||
let _ = driver::run(root, Verb::StopAll);
|
||||
let stopped = driver::run(root, Verb::StopAll);
|
||||
result?;
|
||||
// A database that keeps running locks its files, and the folder could not be moved into place afterwards.
|
||||
match stopped {
|
||||
Ok(out) if out.ok => {}
|
||||
Ok(out) => return Err(Error::Invalid(format!("The database could not be stopped after preparing it. {}", driver::startup_failure(root, &out)))),
|
||||
Err(e) => return Err(e),
|
||||
}
|
||||
fs::remove_file(&boot)?;
|
||||
Ok(())
|
||||
}
|
||||
@@ -250,7 +260,7 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
||||
if staging_root.join(MARKER).is_file() {
|
||||
fs::remove_dir_all(&staging_root)?; // leftover of an earlier failed attempt that we created
|
||||
} else {
|
||||
return Err(Error::Invalid(format!("{} already exists and was not created by the Manager.", staging_root.display())));
|
||||
return Err(Error::Invalid(format!("{} is left over from an earlier installation that did not finish, and the Manager cannot tell whether it may be deleted. Delete that folder yourself, then try again.", staging_root.display())));
|
||||
}
|
||||
}
|
||||
fs::create_dir_all(&staging_root)?;
|
||||
@@ -268,9 +278,8 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
||||
}
|
||||
Ok(())
|
||||
})?;
|
||||
fs::remove_file(staging_root.join(MARKER))?;
|
||||
|
||||
// 4. Commit: the only moment the destination changes.
|
||||
// 4. Commit: the only moment the destination changes. The marker stays until everything is done, so an
|
||||
// unfinished install can always be recognised as ours (and cleaned up), wherever it stopped.
|
||||
say("Finishing", 95, None);
|
||||
if dest.exists() {
|
||||
fs::remove_dir(&dest)?; // only succeeds for an empty folder (preflight verified)
|
||||
@@ -288,15 +297,24 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
||||
}
|
||||
let md = MetaDir::create(&dest, &meta)?;
|
||||
fsx::atomic_write(&md.root.join("manifests").join("base.json"), &manifest_bytes)?;
|
||||
// Complete from here on: the marker goes just before the server is listed.
|
||||
fs::remove_file(dest.join(MARKER))?;
|
||||
p.registry.register(&meta.id, &dest)?;
|
||||
say("Ready", 100, None);
|
||||
Ok(Installed { id: meta.id, path: dest.to_string_lossy().into_owned(), version: m.version.clone() })
|
||||
})();
|
||||
|
||||
if result.is_err() && staging_root.join(MARKER).exists() {
|
||||
// Unfinished work of ours; the destination was never touched.
|
||||
let _ = driver::run(&staging_root, Verb::StopAll);
|
||||
let _ = fs::remove_dir_all(&staging_root);
|
||||
if result.is_err() {
|
||||
if staging_root.join(MARKER).exists() {
|
||||
// Unfinished work of ours; the destination was never touched.
|
||||
let _ = driver::run(&staging_root, Verb::StopAll);
|
||||
let _ = fs::remove_dir_all(&staging_root);
|
||||
} else if dest.join(MARKER).is_file() {
|
||||
// Failed after the folder was moved into place. The destination was empty or absent before (preflight),
|
||||
// so what carries our marker is only our unfinished install.
|
||||
let _ = driver::run(&dest, Verb::StopAll);
|
||||
let _ = fs::remove_dir_all(&dest);
|
||||
}
|
||||
}
|
||||
result
|
||||
}
|
||||
|
||||
@@ -2,11 +2,14 @@ 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;
|
||||
pub mod docker;
|
||||
@@ -30,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;
|
||||
@@ -37,10 +41,16 @@ pub mod realmlist;
|
||||
pub mod realms;
|
||||
pub mod registry;
|
||||
pub mod release;
|
||||
pub mod report;
|
||||
pub mod release_schema;
|
||||
pub mod update;
|
||||
pub mod update_route;
|
||||
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};
|
||||
|
||||
@@ -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);
|
||||
|
||||
@@ -154,9 +154,26 @@ fn recorded<'a>(rows: &'a [LedgerRow], m: &Migration) -> Option<&'a LedgerRow> {
|
||||
rows.iter().rev().find(|r| r.db == m.db && r.id == m.id)
|
||||
}
|
||||
|
||||
/// Migrations that were published with different bytes but have the same effect, so a server that applied either
|
||||
/// version accepts the other. The Wildcard table repair went out as `c1d8…` (0.261005.0, 0.261006.1) and as `9e4a…`
|
||||
/// (0.261005.22, 0.261007.24); the packages carry no list of compatible versions, so the Manager knows this pair.
|
||||
const SAME_EFFECT: &[(&str, &[&str])] = &[(
|
||||
"manager_repair__20261005_missing_wildcard_tables",
|
||||
&[
|
||||
"c1d8dbf2271234283a48a39e4b4aea1106b83b70581f1e3c4aa9fff438e8e4d2",
|
||||
"9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638",
|
||||
],
|
||||
)];
|
||||
|
||||
fn same_effect(id: &str, a: &str, b: &str) -> bool {
|
||||
SAME_EFFECT.iter().any(|(known, hashes)| *known == id
|
||||
&& hashes.iter().any(|h| h.eq_ignore_ascii_case(a)) && hashes.iter().any(|h| h.eq_ignore_ascii_case(b)))
|
||||
}
|
||||
|
||||
fn hash_changed(row: &LedgerRow, m: &Migration) -> bool {
|
||||
row.status == Status::Applied && row.sha256 != "0".repeat(64) && !row.sha256.eq_ignore_ascii_case(&m.sha256)
|
||||
&& !m.compatible_sha256.iter().any(|hash| hash.eq_ignore_ascii_case(&row.sha256))
|
||||
&& !same_effect(&m.id, &row.sha256, &m.sha256)
|
||||
}
|
||||
|
||||
/// Inspect recorded history without creating a ledger or executing migrations.
|
||||
@@ -275,6 +292,18 @@ mod tests {
|
||||
use super::*;
|
||||
use std::cell::RefCell;
|
||||
|
||||
#[test]
|
||||
fn the_two_published_versions_of_the_wildcard_table_repair_are_interchangeable() {
|
||||
let (old, new) = ("c1d8dbf2271234283a48a39e4b4aea1106b83b70581f1e3c4aa9fff438e8e4d2", "9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638");
|
||||
let id = "manager_repair__20261005_missing_wildcard_tables";
|
||||
let row = |id: &str, sha: &str| LedgerRow { db: "characters".into(), id: id.into(), sha256: sha.into(), status: Status::Applied, error: None, baseline: false };
|
||||
let migration = |id: &str, sha: &str| Migration { compatible_sha256: vec![], id: id.into(), db: "characters".into(), sha256: sha.into(), destructive: false };
|
||||
assert!(!hash_changed(&row(id, old), &migration(id, new)), "applied as c1d8, offered as 9e4a");
|
||||
assert!(!hash_changed(&row(id, new), &migration(id, old)), "applied as 9e4a, offered as c1d8");
|
||||
assert!(hash_changed(&row(id, &"a".repeat(64)), &migration(id, new)), "an unknown version is still a change");
|
||||
assert!(hash_changed(&row("other_migration", old), &migration("other_migration", new)), "only the known pair is exempt");
|
||||
}
|
||||
|
||||
#[derive(Default)]
|
||||
struct Mem {
|
||||
rows: RefCell<Vec<LedgerRow>>,
|
||||
|
||||
Loaded 100 of 173 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user