mirror of
https://github.com/Corfirean/coa-server-manager.git
synced 2026-11-19 11:25:56 +00:00
Compare commits
80
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b97f86fc00 | ||
|
|
1a71f18def | ||
|
|
7d7bc530ec | ||
|
|
d86a1676fe | ||
|
|
53a05820c8 | ||
|
|
58c976a388 | ||
|
|
35c4d03bdc | ||
|
|
c45f962d02 | ||
|
|
f52bd8ba5f | ||
|
|
247159e56c | ||
|
|
cdd5be2365 | ||
|
|
7e170744bf | ||
|
|
10daa9b74d | ||
|
|
ed7bf7262b | ||
|
|
7c866b116d | ||
|
|
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 |
No files matched your search
@@ -4,3 +4,5 @@ dist
|
|||||||
*.log
|
*.log
|
||||||
.env
|
.env
|
||||||
src-tauri/gen
|
src-tauri/gen
|
||||||
|
# Disposable database fixtures and private recovery data
|
||||||
|
.cache/
|
||||||
Generated
+3
-3
@@ -491,7 +491,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-core"
|
name = "coa-core"
|
||||||
version = "0.6.6"
|
version = "0.6.15"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"base64 0.22.1",
|
"base64 0.22.1",
|
||||||
"chrono",
|
"chrono",
|
||||||
@@ -520,7 +520,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-release"
|
name = "coa-release"
|
||||||
version = "0.6.6"
|
version = "0.6.15"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"chrono",
|
"chrono",
|
||||||
"coa-core",
|
"coa-core",
|
||||||
@@ -529,7 +529,7 @@ dependencies = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "coa-server-manager"
|
name = "coa-server-manager"
|
||||||
version = "0.6.6"
|
version = "0.6.15"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"coa-core",
|
"coa-core",
|
||||||
"serde",
|
"serde",
|
||||||
|
|||||||
+1
-1
@@ -3,7 +3,7 @@ resolver = "2"
|
|||||||
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
|
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
|
||||||
|
|
||||||
[workspace.package]
|
[workspace.package]
|
||||||
version = "0.6.6"
|
version = "0.6.15"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
license = "AGPL-3.0-only"
|
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: Linux: install from the install screen, play with Wine or Proton (experimental)
|
||||||
|
---
|
||||||
|
Experimental. The install screen offers Docker installs on Linux, realm profiles and the Play button work on a Docker server, and updates are not offered for it.
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
area: manager
|
||||||
|
type: 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: 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: 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: 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.
|
||||||
@@ -27,6 +27,7 @@ fn exercise(root: &Path) -> Result<()> {
|
|||||||
MetaDir::create(root, &installed)?;
|
MetaDir::create(root, &installed)?;
|
||||||
backup::with_database(root, |db| {
|
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 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(())
|
Ok(())
|
||||||
})?;
|
})?;
|
||||||
let source = root.join("fixture-update-source");
|
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,
|
cancel: Cancel::default(), resolutions: BTreeMap::new(), env: &env, fail_after_ops: None,
|
||||||
}, &|step, pct| println!("{pct}% {step}" )).unwrap_err();
|
}, &|step, pct| println!("{pct}% {step}" )).unwrap_err();
|
||||||
assert!(error.to_string().contains("probe_world"), "{error}");
|
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!(!root.join("Core/recovery-probe.txt").exists());
|
||||||
assert!(update::unfinished(&meta).is_none());
|
assert!(update::unfinished(&meta).is_none());
|
||||||
assert_eq!(MetaDir::open(&meta)?.1.core.version.as_deref(), Some("1.0.0"));
|
assert_eq!(MetaDir::open(&meta)?.1.core.version.as_deref(), Some("1.0.0"));
|
||||||
backup::with_database(root, |db| {
|
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_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_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));
|
assert!(!coa_core::migrations::status(db, &manifest.migrations)?.iter().any(|m| m.status == coa_core::migrations::Status::Applied));
|
||||||
Ok(())
|
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()))?;
|
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)?;
|
env.restore_snapshot(&point.id)?;
|
||||||
assert_eq!(Db::from_repack(root, Account::Admin)?.realm(), coa_core::realms::Mode::Coa);
|
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(())
|
Ok(())
|
||||||
}
|
}
|
||||||
@@ -27,7 +27,18 @@ const LIST_SQL: &str = "SELECT a.id, a.username, \
|
|||||||
a.online, IFNULL(a.last_login, ''), \
|
a.online, IFNULL(a.last_login, ''), \
|
||||||
(SELECT COUNT(*) FROM acore_characters.characters c WHERE c.account = a.id) \
|
(SELECT COUNT(*) FROM acore_characters.characters c WHERE c.account = a.id) \
|
||||||
FROM acore_auth.account a \
|
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.
|
/// Rows of tab-separated columns as the `mysql` client prints them.
|
||||||
pub fn parse_list(out: &str) -> Vec<AccountInfo> {
|
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>> {
|
pub fn list(root: &Path) -> Result<Vec<AccountInfo>> {
|
||||||
let db = Db::from_repack(root, Account::Admin)?;
|
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> {
|
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<()> {
|
pub fn rename(root: &Path, ra: &mut Ra, old: &str, new: &str, password: &str) -> Result<()> {
|
||||||
let (old, new) = (upper(old)?, upper(new)?);
|
let (old, new) = (upper(old)?, upper(new)?);
|
||||||
validate_account(&new, password)?;
|
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 {
|
if old == new {
|
||||||
return Err(Error::Invalid("That is already the name of this account.".into()));
|
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.
|
/// 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<()> {
|
pub fn delete(root: &Path, ra: &mut Ra, name: &str) -> Result<()> {
|
||||||
let name = upper(name)?;
|
let name = upper(name)?;
|
||||||
if is_reserved(&name) {
|
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 companions and cannot be deleted.".into()));
|
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)?;
|
let db = Db::from_repack(root, Account::Admin)?;
|
||||||
match db.query(&format!("SELECT online FROM acore_auth.account WHERE username = '{name}';"))?.trim() {
|
match db.query(&format!("SELECT online FROM acore_auth.account WHERE username = '{name}';"))?.trim() {
|
||||||
@@ -125,7 +139,19 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn the_internal_accounts_are_filtered_out_by_the_query() {
|
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]
|
#[test]
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ fn hidden(key: &str) -> bool {
|
|||||||
k.contains("password")
|
k.contains("password")
|
||||||
|| k.contains("databaseinfo")
|
|| k.contains("databaseinfo")
|
||||||
|| k.ends_with("port")
|
|| k.ends_with("port")
|
||||||
|
|| k == "console.enable"
|
||||||
|| k.starts_with("ra.")
|
|| k.starts_with("ra.")
|
||||||
|| k.starts_with("logger.")
|
|| k.starts_with("logger.")
|
||||||
|| k.starts_with("appender.")
|
|| k.starts_with("appender.")
|
||||||
@@ -229,7 +230,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn what_belongs_to_the_manager_is_hidden() {
|
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}");
|
assert!(hidden(k), "{k}");
|
||||||
}
|
}
|
||||||
for k in ["Rate.XP.Kill", "PlayerLimit", "SupportEnabled", "Instance.ResetTimeHour", "Warden.Enabled", "CharacterCreating.Disabled"] {
|
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>,
|
pub components: Vec<Component>,
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub realm: crate::realms::Mode,
|
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")
|
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 {
|
fn id_ok(id: &str) -> bool {
|
||||||
!id.is_empty() && id.len() < 100 && id.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')) && !id.contains("..")
|
!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) {
|
if !id_ok(id) {
|
||||||
return Err(Error::PathRejected(format!("bad backup id {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))
|
Ok(backups_dir(meta).join(id))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn list(meta: &Path) -> Vec<RecoveryPoint> {
|
pub fn list(meta: &Path) -> Vec<RecoveryPoint> {
|
||||||
let mut out: Vec<RecoveryPoint> = fs::read_dir(backups_dir(meta))
|
let mut out: Vec<RecoveryPoint> = Vec::new();
|
||||||
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| fsx::read_json(&e.path().join("backup.json")).ok()).collect())
|
for root in backup_roots(meta) {
|
||||||
.unwrap_or_default();
|
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.sort_by(|a, b| b.id.cmp(&a.id));
|
||||||
out
|
out
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn get(meta: &Path, id: &str) -> Result<RecoveryPoint> {
|
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."))); }
|
if point.id != id || point.schema != 1 { return Err(Error::Invalid(format!("Backup {id} has inconsistent identity or an unsupported schema."))); }
|
||||||
Ok(point)
|
Ok(point)
|
||||||
}
|
}
|
||||||
@@ -163,7 +250,8 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
|
|||||||
if !mysql_was_up {
|
if !mysql_was_up {
|
||||||
let out = driver::run(root, Verb::StartMysql)?;
|
let out = driver::run(root, Verb::StartMysql)?;
|
||||||
if !out.ok {
|
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);
|
let result = f(&db);
|
||||||
@@ -176,6 +264,14 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
|
|||||||
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] {
|
fn wanted_databases(kind: Kind) -> &'static [&'static str] {
|
||||||
match kind {
|
match kind {
|
||||||
Kind::Quick | Kind::Database => &["characters", "auth"],
|
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);
|
return Err(e);
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
let mysql_snapshot = if kind == Kind::Full && trigger == Trigger::BeforeUpdate && cfg!(windows) && !crate::docker::is_docker(root) {
|
||||||
|
progress("Saving a complete stopped MySQL recovery copy");
|
||||||
|
match crate::mysql_snapshot::capture(root, &partial) {
|
||||||
|
Ok(snapshot) => Some(snapshot),
|
||||||
|
Err(error) => {
|
||||||
|
if let Ok(owned) = fsx::ensure_within(&backups_dir(meta), &partial) { let _ = fs::remove_dir_all(owned); }
|
||||||
|
return Err(error);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else { None };
|
||||||
let point = RecoveryPoint {
|
let point = RecoveryPoint {
|
||||||
realm: crate::realms::state(root)?.active,
|
realm: crate::realms::state(root)?.active,
|
||||||
schema: 1,
|
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(),
|
created_at: chrono::Utc::now().to_rfc3339(),
|
||||||
manager_version: crate::MANAGER_VERSION.into(),
|
manager_version: crate::MANAGER_VERSION.into(),
|
||||||
components,
|
components,
|
||||||
|
mysql_snapshot,
|
||||||
};
|
};
|
||||||
fsx::atomic_write_json(&partial.join("backup.json"), &point)?;
|
fsx::atomic_write_json(&partial.join("backup.json"), &point)?;
|
||||||
fs::rename(&partial, &final_dir)?;
|
fs::rename(&partial, &final_dir)?;
|
||||||
@@ -281,6 +388,9 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
|
|||||||
let point = get(meta, id)?;
|
let point = get(meta, id)?;
|
||||||
let dir = point_dir(meta, id)?;
|
let dir = point_dir(meta, id)?;
|
||||||
let mut problems = Vec::new();
|
let mut problems = Vec::new();
|
||||||
|
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 names = std::collections::BTreeSet::new();
|
||||||
let mut schemas = std::collections::BTreeSet::new();
|
let mut schemas = std::collections::BTreeSet::new();
|
||||||
for c in &point.components {
|
for c in &point.components {
|
||||||
@@ -490,6 +600,34 @@ mod tests {
|
|||||||
assert!(list(&meta).len() >= 2);
|
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]
|
#[test]
|
||||||
fn verify_detects_tampering_and_restore_refuses_damaged_backup() {
|
fn verify_detects_tampering_and_restore_refuses_damaged_backup() {
|
||||||
let (_d, root, meta) = setup();
|
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::error::{Error, Result};
|
||||||
use crate::fsx;
|
use crate::fsx;
|
||||||
use crate::migrations::{apply_pending, status, Status};
|
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 struct Params<'a> {
|
||||||
pub repack: &'a Path,
|
pub repack: &'a Path,
|
||||||
@@ -177,7 +177,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
|
|||||||
}
|
}
|
||||||
fsx::atomic_write_json(&repack_json, &cfg)?;
|
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 {
|
if let Some(b) = p.bots {
|
||||||
sql.extend(collect_bots_sql(b)?);
|
sql.extend(collect_bots_sql(b)?);
|
||||||
}
|
}
|
||||||
@@ -294,7 +294,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn scaffolding_keeps_the_launcher_and_drops_runtime_state_and_live_data() {
|
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}");
|
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"] {
|
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"];
|
const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"];
|
||||||
|
|
||||||
pub fn is_running(client: &Path) -> bool {
|
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| {
|
EXECUTABLES.iter().any(|exe| {
|
||||||
let path = client.join(exe);
|
let path = client.join(exe);
|
||||||
let path = dunce::canonicalize(&path).unwrap_or(path);
|
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.
|
/// Start the game client. The caller is responsible for making sure the server is ready first.
|
||||||
pub fn launch(client: &Path) -> Result<u32> {
|
pub fn launch(client: &Path) -> Result<u32> {
|
||||||
let exe = find_exe(client).ok_or_else(|| Error::Invalid("The game client was not found.".into()))?;
|
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()?;
|
let child = Command::new(client.join(exe)).current_dir(client).spawn()?;
|
||||||
Ok(child.id())
|
Ok(child.id())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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,860 @@
|
|||||||
|
//! 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.5";
|
||||||
|
pub const MANIFEST_FILENAME: &str = "custom_races_patch_manifest.txt";
|
||||||
|
pub const ARCHIVES: &[(&str, &str)] = &[
|
||||||
|
(
|
||||||
|
"CoA-Custom-1.5-main-20261009-cb2a0ca4.zip",
|
||||||
|
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-main-20261009-cb2a0ca4.zip",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
"CoA-Custom-1.5-client-part1.zip",
|
||||||
|
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-client-part1.zip",
|
||||||
|
),
|
||||||
|
(
|
||||||
|
"CoA-Custom-1.5-client-part2.zip",
|
||||||
|
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-client-part2.zip",
|
||||||
|
),
|
||||||
|
];
|
||||||
|
|
||||||
|
pub const RACE_MPQS: &[&str] = &[
|
||||||
|
"patch-T.MPQ",
|
||||||
|
"patch-ZE1.MPQ",
|
||||||
|
"patch-ZE2.MPQ",
|
||||||
|
"patch-ZE3.MPQ",
|
||||||
|
"patch-ZE5.MPQ",
|
||||||
|
"patch-ZE6.MPQ",
|
||||||
|
"patch-ZE7.MPQ",
|
||||||
|
"patch-ZE8.MPQ",
|
||||||
|
"patch-ZE9.MPQ",
|
||||||
|
"patch-ZEA.MPQ",
|
||||||
|
"patch-ZG.MPQ",
|
||||||
|
"patch-ZH.MPQ",
|
||||||
|
"patch-ZHA.MPQ",
|
||||||
|
"patch-ZHM.MPQ",
|
||||||
|
"patch-ZM.MPQ",
|
||||||
|
"patch-ZVU.MPQ",
|
||||||
|
"patch-ZES.MPQ",
|
||||||
|
"patch-ZJ.MPQ",
|
||||||
|
"patch-ZZE.MPQ",
|
||||||
|
"patch-ZZR.MPQ",
|
||||||
|
];
|
||||||
|
|
||||||
|
pub const EXCLUDED_BOT_RACES_RECOMMENDED: &str =
|
||||||
|
"19,27,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 =
|
||||||
|
"16,19,27,32,50,52,53,65,66,67,68,69,70,71,72,74,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(['"', '\'']);
|
||||||
|
return Some(!clean.contains("33") && !clean.contains("128"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
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 bundled: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json"))?;
|
||||||
|
let manifest = fs::read_to_string(client.join(MANIFEST_FILENAME)).unwrap_or_default();
|
||||||
|
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.5-main-20261009-cb2a0ca4.zip" => "117f5d99add18191676be6648fb0f2e99019a06c18705c71454e371e7df2afd2",
|
||||||
|
"CoA-Custom-1.5-client-part1.zip" => "19eb372805b3268653914da03377d67f056e5b50d818a8a06a5f260aad03211e",
|
||||||
|
"CoA-Custom-1.5-client-part2.zip" => "122f2882da255913e01610e33c6446ded897fecbe60b6d5ee026149becf8f278",
|
||||||
|
_ => return Err(Error::Invalid("Unknown custom races archive.".into())),
|
||||||
|
};
|
||||||
|
if fsx::sha256_file(path)? != expected {
|
||||||
|
return Err(Error::Invalid(format!("Custom races archive {filename} failed verification. Remove it and try again.")));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Locate an archive locally in Downloads or cache, or download it from GitHub.
|
||||||
|
fn resolve_or_download_archive(
|
||||||
|
filename: &str,
|
||||||
|
url: &str,
|
||||||
|
client: &reqwest::blocking::Client,
|
||||||
|
cancel: &Cancel,
|
||||||
|
report: &dyn Fn(&str, f32),
|
||||||
|
base_percent: f32,
|
||||||
|
percent_slice: f32,
|
||||||
|
) -> Result<PathBuf> {
|
||||||
|
// 1. Check user Downloads folder
|
||||||
|
if let Some(userprofile) = std::env::var_os("USERPROFILE") {
|
||||||
|
let downloads = PathBuf::from(userprofile).join("Downloads");
|
||||||
|
let candidate = downloads.join(filename);
|
||||||
|
if candidate.is_file() {
|
||||||
|
if let Ok(meta) = candidate.metadata() {
|
||||||
|
if meta.len() > 1000 {
|
||||||
|
tracing::info!(path = %candidate.display(), "using existing archive in Downloads");
|
||||||
|
verify_archive(&candidate, filename)?;
|
||||||
|
return Ok(candidate);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. Check temp / cache directory
|
||||||
|
let cache_dir = std::env::temp_dir().join("coa-client-races");
|
||||||
|
fs::create_dir_all(&cache_dir)?;
|
||||||
|
let target = cache_dir.join(filename);
|
||||||
|
if target.is_file() {
|
||||||
|
if let Ok(meta) = target.metadata() {
|
||||||
|
if meta.len() > 1000 {
|
||||||
|
verify_archive(&target, filename)?;
|
||||||
|
return Ok(target);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. Download from GitHub Releases
|
||||||
|
report(&format!("Downloading {filename}..."), base_percent);
|
||||||
|
let part_path = cache_dir.join(format!("{filename}.part"));
|
||||||
|
|
||||||
|
let resp = client
|
||||||
|
.get(url)
|
||||||
|
.send()
|
||||||
|
.map_err(|e| Error::NetworkUnreachable(format!("Could not reach download server: {e}")))?;
|
||||||
|
|
||||||
|
if !resp.status().is_success() {
|
||||||
|
return Err(Error::NetworkUnreachable(format!(
|
||||||
|
"Download failed with status {} for {url}",
|
||||||
|
resp.status()
|
||||||
|
)));
|
||||||
|
}
|
||||||
|
|
||||||
|
let total_bytes = resp.content_length().unwrap_or(0);
|
||||||
|
let mut downloaded = 0u64;
|
||||||
|
let mut src = resp;
|
||||||
|
let mut dst = File::create(&part_path)?;
|
||||||
|
|
||||||
|
let mut buf = [0u8; 64 * 1024];
|
||||||
|
let mut last_report = std::time::Instant::now();
|
||||||
|
|
||||||
|
loop {
|
||||||
|
if cancel.is_set() {
|
||||||
|
let _ = fs::remove_file(&part_path);
|
||||||
|
return Err(Error::Invalid("Operation cancelled.".into()));
|
||||||
|
}
|
||||||
|
|
||||||
|
let n = src
|
||||||
|
.read(&mut buf)
|
||||||
|
.map_err(|e| Error::NetworkUnreachable(format!("Download interrupted: {e}")))?;
|
||||||
|
if n == 0 {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
dst.write_all(&buf[..n])?;
|
||||||
|
downloaded += n as u64;
|
||||||
|
|
||||||
|
if last_report.elapsed() > std::time::Duration::from_millis(200) {
|
||||||
|
let ratio = if total_bytes > 0 {
|
||||||
|
(downloaded as f32 / total_bytes as f32).clamp(0.0, 1.0)
|
||||||
|
} else {
|
||||||
|
0.5
|
||||||
|
};
|
||||||
|
report(
|
||||||
|
&format!(
|
||||||
|
"Downloading {filename} ({:.1} MB)...",
|
||||||
|
downloaded as f64 / 1_048_576.0
|
||||||
|
),
|
||||||
|
base_percent + ratio * percent_slice,
|
||||||
|
);
|
||||||
|
last_report = std::time::Instant::now();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dst.flush()?;
|
||||||
|
drop(dst);
|
||||||
|
|
||||||
|
verify_archive(&part_path, filename)?;
|
||||||
|
fs::rename(&part_path, &target)?;
|
||||||
|
Ok(target)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Download (if needed) and extract custom races client assets into the target WoW client.
|
||||||
|
pub fn install_client_patches(
|
||||||
|
client_path: &Path,
|
||||||
|
cancel: &Cancel,
|
||||||
|
report: &dyn Fn(&str, f32),
|
||||||
|
) -> Result<()> {
|
||||||
|
if !client_path.is_dir() {
|
||||||
|
return Err(Error::Invalid("Game client directory does not exist.".into()));
|
||||||
|
}
|
||||||
|
|
||||||
|
if crate::client::is_running(client_path) {
|
||||||
|
return Err(Error::Invalid("Close the game before installing custom races patches.".into()));
|
||||||
|
}
|
||||||
|
let _lock = patch_lock(client_path)?;
|
||||||
|
recover_patch_transaction(client_path)?;
|
||||||
|
let staging = tempfile::Builder::new().prefix(".coa-races-stage-").tempdir_in(client_path)?;
|
||||||
|
let data_dir = staging.path().join("Data");
|
||||||
|
fs::create_dir_all(&data_dir)?;
|
||||||
|
|
||||||
|
// 2. Resolve/download archives (0.05 .. 0.50)
|
||||||
|
let http = reqwest::blocking::Client::builder()
|
||||||
|
.user_agent(concat!("CoA-Server-Manager/", env!("CARGO_PKG_VERSION")))
|
||||||
|
.timeout(std::time::Duration::from_secs(600))
|
||||||
|
.build()
|
||||||
|
.map_err(|e| Error::Invalid(format!("Cannot prepare downloader: {e}")))?;
|
||||||
|
|
||||||
|
let mut resolved_archives = Vec::new();
|
||||||
|
let n_archives = ARCHIVES.len() as f32;
|
||||||
|
for (i, (fname, url)) in ARCHIVES.iter().enumerate() {
|
||||||
|
let base_pct = 0.05 + (i as f32 / n_archives) * 0.45;
|
||||||
|
let slice = 0.45 / n_archives;
|
||||||
|
let archive_path =
|
||||||
|
resolve_or_download_archive(fname, url, &http, cancel, report, base_pct, slice)?;
|
||||||
|
resolved_archives.push(archive_path);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 3. Extract archives (0.50 .. 0.95)
|
||||||
|
let mut installed_mpqs = Vec::new();
|
||||||
|
let mut installed_roots = Vec::new();
|
||||||
|
|
||||||
|
for (i, arch_path) in resolved_archives.iter().enumerate() {
|
||||||
|
if cancel.is_set() {
|
||||||
|
return Err(Error::Invalid("Operation cancelled.".into()));
|
||||||
|
}
|
||||||
|
|
||||||
|
let arch_name = arch_path
|
||||||
|
.file_name()
|
||||||
|
.map(|n| n.to_string_lossy().into_owned())
|
||||||
|
.unwrap_or_default();
|
||||||
|
report(
|
||||||
|
&format!("Unpacking {arch_name}..."),
|
||||||
|
0.50 + (i as f32 / n_archives) * 0.45,
|
||||||
|
);
|
||||||
|
|
||||||
|
let file = File::open(arch_path)?;
|
||||||
|
let mut zip = zip::ZipArchive::new(file)
|
||||||
|
.map_err(|e| Error::Invalid(format!("Failed to open zip {arch_name}: {e}")))?;
|
||||||
|
|
||||||
|
let num_files = zip.len();
|
||||||
|
for file_idx in 0..num_files {
|
||||||
|
if cancel.is_set() {
|
||||||
|
return Err(Error::Invalid("Operation cancelled.".into()));
|
||||||
|
}
|
||||||
|
|
||||||
|
let mut zfile = zip
|
||||||
|
.by_index(file_idx)
|
||||||
|
.map_err(|e| Error::Invalid(format!("Zip entry error in {arch_name}: {e}")))?;
|
||||||
|
|
||||||
|
if zfile.is_dir() {
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
let zname = zfile.name().to_string();
|
||||||
|
let zname_norm = zname.replace('\\', "/");
|
||||||
|
|
||||||
|
if zname_norm.contains("files/client/") {
|
||||||
|
let base = Path::new(&zname_norm)
|
||||||
|
.file_name()
|
||||||
|
.map(|n| n.to_string_lossy().into_owned())
|
||||||
|
.unwrap_or_default();
|
||||||
|
|
||||||
|
if base.to_ascii_lowercase().ends_with(".mpq") {
|
||||||
|
let dest = data_dir.join(&base);
|
||||||
|
let mut out = File::create(&dest)?;
|
||||||
|
io::copy(&mut zfile, &mut out)?;
|
||||||
|
let disabled = data_dir.join(format!("{base}.disabled"));
|
||||||
|
if disabled.is_file() { fs::remove_file(disabled)?; }
|
||||||
|
installed_mpqs.push(base);
|
||||||
|
} else if base.eq_ignore_ascii_case("dinput8.dll") {
|
||||||
|
let dest = staging.path().join(&base);
|
||||||
|
let mut out = File::create(&dest)?;
|
||||||
|
io::copy(&mut zfile, &mut out)?;
|
||||||
|
let disabled = staging.path().join(format!("{base}.disabled"));
|
||||||
|
if disabled.is_file() { fs::remove_file(disabled)?; }
|
||||||
|
installed_roots.push(base);
|
||||||
|
}
|
||||||
|
} else if zname_norm.contains("files/client_root/") {
|
||||||
|
let base = Path::new(&zname_norm)
|
||||||
|
.file_name()
|
||||||
|
.map(|n| n.to_string_lossy().into_owned())
|
||||||
|
.unwrap_or_default();
|
||||||
|
|
||||||
|
if !base.is_empty() {
|
||||||
|
let dest = staging.path().join(&base);
|
||||||
|
let mut out = File::create(&dest)?;
|
||||||
|
io::copy(&mut zfile, &mut out)?;
|
||||||
|
let disabled = staging.path().join(format!("{base}.disabled"));
|
||||||
|
if disabled.is_file() { fs::remove_file(disabled)?; }
|
||||||
|
installed_roots.push(base);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if !RACE_MPQS.iter().all(|name| installed_mpqs.iter().any(|installed| installed == name)) {
|
||||||
|
return Err(Error::Invalid("Custom races archives are missing required client patches.".into()));
|
||||||
|
}
|
||||||
|
|
||||||
|
// 4. Record manifest
|
||||||
|
report("Finalizing manifest...", 0.98);
|
||||||
|
let manifest_path = client_path.join(MANIFEST_FILENAME);
|
||||||
|
installed_mpqs.sort();
|
||||||
|
installed_mpqs.dedup();
|
||||||
|
installed_roots.sort();
|
||||||
|
installed_roots.dedup();
|
||||||
|
|
||||||
|
let mut manifest_body = format!("# CoA Custom {CLIENT_VERSION}\n# Custom Race MPQ files\n");
|
||||||
|
for m in &installed_mpqs {
|
||||||
|
manifest_body.push_str(&format!("MPQ:{m}\n"));
|
||||||
|
}
|
||||||
|
manifest_body.push_str("# Custom Race root files\n");
|
||||||
|
for r in &installed_roots {
|
||||||
|
manifest_body.push_str(&format!("ROOT:{r}\n"));
|
||||||
|
}
|
||||||
|
|
||||||
|
let bundled: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json"))?;
|
||||||
|
let mut payload = Vec::new();
|
||||||
|
for path in installed_mpqs.iter().map(|name| format!("Data/{name}")).chain(installed_roots.iter().cloned()) {
|
||||||
|
let staged = fsx::safe_join(staging.path(), &path)?;
|
||||||
|
let hash = fsx::sha256_file(&staged)?;
|
||||||
|
if bundled.get(&path) != Some(&hash) { return Err(Error::Invalid(format!("Custom races file {path} failed verification."))); }
|
||||||
|
manifest_body.push_str(&format!("SHA256:{hash}:{path}\n"));
|
||||||
|
payload.push(PatchFile { path, sha256: hash });
|
||||||
|
}
|
||||||
|
if cancel.is_set() { return Err(Error::Invalid("Operation cancelled.".into())); }
|
||||||
|
if payload.len() != bundled.len() { return Err(Error::Invalid("Custom races archives are missing required runtime files.".into())); }
|
||||||
|
let previous = patch_files(client_path)?;
|
||||||
|
let mut tx = PatchTransaction::new(client_path)?;
|
||||||
|
for file in payload {
|
||||||
|
let dest = fsx::safe_join(client_path, &file.path)?;
|
||||||
|
if dest.is_file() && !previous.iter().any(|old| old.path == file.path && matches_patch(&dest, old)) && !matches_patch(&dest, &file) {
|
||||||
|
preserve_original(&mut tx, &dest)?;
|
||||||
|
}
|
||||||
|
tx.copy(&staging.path().join(&file.path), &dest)?;
|
||||||
|
let disabled = suffix(&dest, "disabled");
|
||||||
|
if disabled.is_file() {
|
||||||
|
if !previous.iter().any(|old| old.path == file.path && matches_patch(&disabled, old)) && !matches_patch(&disabled, &file) {
|
||||||
|
tx.move_file(&disabled, &suffix(&disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?;
|
||||||
|
} else { tx.save(&disabled)?; }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
tx.save(&manifest_path)?;
|
||||||
|
fsx::atomic_write(&manifest_path, manifest_body.as_bytes())?;
|
||||||
|
tx.finish()?;
|
||||||
|
report("Custom races client patches installed successfully!", 1.0);
|
||||||
|
tracing::info!(
|
||||||
|
mpqs = installed_mpqs.len(),
|
||||||
|
roots = installed_roots.len(),
|
||||||
|
"custom races client patch installation complete"
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
fn record_files(root: &Path, names: &[&str]) {
|
||||||
|
let mut manifest = format!("# CoA Custom {CLIENT_VERSION}\n");
|
||||||
|
for name in names {
|
||||||
|
let (kind, base) = name.strip_prefix("Data/").map_or(("ROOT", *name), |base| ("MPQ", base));
|
||||||
|
manifest.push_str(&format!("{kind}:{base}\nSHA256:{}:{name}\n", fsx::sha256_file(&root.join(name)).unwrap()));
|
||||||
|
}
|
||||||
|
fs::write(root.join(MANIFEST_FILENAME), manifest).unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[ignore = "Requires the three downloaded release archives"]
|
||||||
|
fn bundled_hashes_match_verified_release_archives() {
|
||||||
|
use sha2::{Digest, Sha256};
|
||||||
|
let folder = PathBuf::from(std::env::var_os("COA_RACES_ARCHIVE_DIR").expect("COA_RACES_ARCHIVE_DIR"));
|
||||||
|
let expected: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json")).unwrap();
|
||||||
|
let mut actual = std::collections::BTreeMap::new();
|
||||||
|
for (name, _) in ARCHIVES {
|
||||||
|
let path = folder.join(name);
|
||||||
|
verify_archive(&path, name).unwrap();
|
||||||
|
let mut archive = zip::ZipArchive::new(File::open(path).unwrap()).unwrap();
|
||||||
|
for index in 0..archive.len() {
|
||||||
|
let mut entry = archive.by_index(index).unwrap();
|
||||||
|
let name = entry.name().replace('\\', "/");
|
||||||
|
if entry.is_dir() { continue; }
|
||||||
|
let relative = if let Some(name) = name.split("files/client_root/").nth(1) { name.to_string() }
|
||||||
|
else if let Some(name) = name.split("files/client/").nth(1) { if name == "dinput8.dll" { name.to_string() } else { format!("Data/{name}") } }
|
||||||
|
else { continue };
|
||||||
|
let mut hash = Sha256::new();
|
||||||
|
let mut buffer = vec![0; 1024 * 1024];
|
||||||
|
loop { let read = entry.read(&mut buffer).unwrap(); if read == 0 { break; } hash.update(&buffer[..read]); }
|
||||||
|
actual.insert(relative, hex::encode(hash.finalize()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert_eq!(actual, expected);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn 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());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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,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 {
|
fn fail(&self, stderr: &[u8]) -> Error {
|
||||||
let text = String::from_utf8_lossy(stderr);
|
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 };
|
let code = if down { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown };
|
||||||
match code {
|
match code {
|
||||||
ErrorCode::DatabaseNotRunning => Error::Invalid("The database is not running. Start the server first.".into()),
|
ErrorCode::DatabaseNotRunning => Error::Invalid(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(""))),
|
_ => 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()))
|
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).
|
/// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file).
|
||||||
pub fn dump_to(&self, schema: &str, out: &Path) -> Result<(u64, String)> {
|
pub fn dump_to(&self, schema: &str, out: &Path) -> Result<(u64, String)> {
|
||||||
let schema = self.realm_schema(schema);
|
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.
|
/// Name of the service account the Manager uses for the server console (RA). Accounts are stored upper-case.
|
||||||
pub const SERVICE_ACCOUNT: &str = "COAMANAGER";
|
pub const SERVICE_ACCOUNT: &str = "COAMANAGER";
|
||||||
|
|
||||||
@@ -418,6 +440,19 @@ mod tests {
|
|||||||
const ROOT_PW: &str = "rootpw-ZZ1";
|
const ROOT_PW: &str = "rootpw-ZZ1";
|
||||||
const APP_PW: &str = "apppw-QQ2";
|
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) {
|
fn folder(docker: bool) -> (tempfile::TempDir, PathBuf) {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
let root = d.path().join("srv");
|
let root = d.path().join("srv");
|
||||||
|
|||||||
@@ -401,6 +401,19 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
|
|||||||
add("processes.txt", processes_report(root, &ports).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.
|
// 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()
|
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, '-' | '_')))
|
.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();
|
.collect();
|
||||||
@@ -586,6 +599,9 @@ 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();
|
fs::write(root.join("Core/configs/worldserver.conf"), "LoginDatabaseInfo = \"127.0.0.1;3307;acore;SECRETPW;auth\"\nRate.XP.Kill = 1\n").unwrap();
|
||||||
let meta_dir = d.path().join("srv.manager");
|
let meta_dir = d.path().join("srv.manager");
|
||||||
fs::create_dir_all(&meta_dir).unwrap();
|
fs::create_dir_all(&meta_dir).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 meta = InstallMeta::new(InstallKind::Imported, &root);
|
||||||
let report = run(&root, &meta);
|
let report = run(&root, &meta);
|
||||||
let zip_path = d.path().join("diag.zip");
|
let zip_path = d.path().join("diag.zip");
|
||||||
@@ -600,6 +616,10 @@ real error
|
|||||||
}
|
}
|
||||||
assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included");
|
assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included");
|
||||||
assert!(all.contains("v1.8") && all.contains("48c4786a"));
|
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("hunter2") && !all.contains("SECRETPW") && !all.contains("upstream-secret"));
|
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());
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -146,7 +146,7 @@ fn write_settings(root: &Path, data_dir: &Path) -> Result<Settings> {
|
|||||||
let (auth, world, ra) = (pick_port(DEFAULT_PORTS.0)?, pick_port(DEFAULT_PORTS.1)?, pick_port(DEFAULT_PORTS.2)?);
|
let (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));
|
let (root_password, app_password) = (random_hex(48), random_hex(48));
|
||||||
fs::create_dir_all(root.join("Settings"))?;
|
fs::create_dir_all(root.join("Settings"))?;
|
||||||
let docker = Config { project, bind_address: "127.0.0.1".into(), mysql_image: super::MYSQL_IMAGE.into(), data_dir: Some(data_dir.to_string_lossy().into_owned()) };
|
let docker = Config { project, bind_address: "127.0.0.1".into(), mysql_image: super::MYSQL_IMAGE.into(), data_dir: Some(data_dir.to_string_lossy().into_owned()), mysql_data: None };
|
||||||
fsx::atomic_write_json(&root.join(MARKER), &docker)?;
|
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
|
// 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.
|
// not published on the host; its port is only there to fill the key.
|
||||||
|
|||||||
@@ -210,7 +210,7 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
|
|||||||
if !state.get(&n.db).is_some_and(Container::running) {
|
if !state.get(&n.db).is_some_and(Container::running) {
|
||||||
remove(d, &n.db);
|
remove(d, &n.db);
|
||||||
let mut call = Call::new(&[], Duration::from_secs(120));
|
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())];
|
call.env = vec![("MYSQL_ROOT_PASSWORD".into(), secrets.root.clone())];
|
||||||
let o = d.run(&call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
|
let o = d.run(&call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
|
||||||
if !o.ok() {
|
if !o.ok() {
|
||||||
@@ -223,6 +223,10 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
|
|||||||
return Ok(());
|
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)?;
|
ensure_image(d, log)?;
|
||||||
super::ensure_main_configs(root).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
|
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() })?;
|
std::fs::create_dir_all(root.join("Core/Logs")).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
|
||||||
@@ -234,7 +238,7 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
|
|||||||
remove(d, &n.world);
|
remove(d, &n.world);
|
||||||
let mut call = Call::new(&[], Duration::from_secs(60));
|
let mut call = Call::new(&[], Duration::from_secs(60));
|
||||||
call.args = game_args(cfg, &n, GameKind::World, &host, &cfg.data_path(&host), ports.world, ports.ra, owner.as_deref());
|
call.args = game_args(cfg, &n, GameKind::World, &host, &cfg.data_path(&host), ports.world, ports.ra, owner.as_deref());
|
||||||
call.env = database_env(&secrets, true);
|
call.env = database_env(&secrets, true, realm);
|
||||||
run_container(d, &call, &n.world, log)?;
|
run_container(d, &call, &n.world, log)?;
|
||||||
}
|
}
|
||||||
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
|
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
|
||||||
@@ -243,7 +247,7 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
|
|||||||
remove(d, &n.auth);
|
remove(d, &n.auth);
|
||||||
let mut call = Call::new(&[], Duration::from_secs(60));
|
let mut call = Call::new(&[], Duration::from_secs(60));
|
||||||
call.args = game_args(cfg, &n, GameKind::Auth, &host, &cfg.data_path(&host), ports.auth, 0, owner.as_deref());
|
call.args = game_args(cfg, &n, GameKind::Auth, &host, &cfg.data_path(&host), ports.auth, 0, owner.as_deref());
|
||||||
call.env = database_env(&secrets, false);
|
call.env = database_env(&secrets, false, realm);
|
||||||
run_container(d, &call, &n.auth, log)?;
|
run_container(d, &call, &n.auth, log)?;
|
||||||
}
|
}
|
||||||
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
|
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
|
||||||
@@ -333,12 +337,22 @@ fn connect_ip(cfg: &Config) -> IpAddr {
|
|||||||
|
|
||||||
// ------------------------------------------------------------------------------------------------- argument lists
|
// ------------------------------------------------------------------------------------------------- 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();
|
let mut a: Vec<String> = ["run", "--detach", "--name"].iter().map(|s| s.to_string()).collect();
|
||||||
a.push(n.db.clone());
|
a.push(n.db.clone());
|
||||||
a.extend(["--network".into(), n.network.clone(), "--network-alias".into(), "db".into()]);
|
a.extend(["--network".into(), n.network.clone(), "--network-alias".into(), "db".into()]);
|
||||||
a.extend(["--label".into(), format!("coa.project={}", cfg.project)]);
|
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.
|
// The password comes from the environment of the docker client, not from this command line.
|
||||||
a.extend(["--env".into(), "MYSQL_ROOT_PASSWORD".into()]);
|
a.extend(["--env".into(), "MYSQL_ROOT_PASSWORD".into()]);
|
||||||
// "mysqladmin ping" succeeds as soon as the server answers, with or without a login. It must go over TCP, like
|
// "mysqladmin ping" succeeds as soon as the server answers, with or without a login. It must go over TCP, like
|
||||||
@@ -349,6 +363,9 @@ fn db_args(cfg: &Config, n: &Names) -> Vec<String> {
|
|||||||
a.extend(["--health-interval".into(), "5s".into(), "--health-timeout".into(), "5s".into(), "--health-retries".into(), "40".into()]);
|
a.extend(["--health-interval".into(), "5s".into(), "--health-timeout".into(), "5s".into(), "--health-retries".into(), "40".into()]);
|
||||||
a.extend(["--stop-timeout".into(), "60".into()]);
|
a.extend(["--stop-timeout".into(), "60".into()]);
|
||||||
a.push(cfg.mysql_image.clone());
|
a.push(cfg.mysql_image.clone());
|
||||||
|
if cfg.mysql_data.is_some() {
|
||||||
|
a.push("--lower-case-table-names=1".into());
|
||||||
|
}
|
||||||
a
|
a
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -359,16 +376,32 @@ enum GameKind {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Connection strings: host;port;user;password;database. They hold the password, so they travel by environment.
|
/// 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 info = |db: &str| format!("db;3306;acore;{};{db}", s.app);
|
||||||
let mut env = vec![("AC_LOGIN_DATABASE_INFO".to_string(), info("acore_auth"))];
|
let mut env = vec![("AC_LOGIN_DATABASE_INFO".to_string(), info("acore_auth"))];
|
||||||
if world {
|
if world {
|
||||||
env.push(("AC_WORLD_DATABASE_INFO".into(), info("acore_world")));
|
// The databases of the selected realm (the Wildcard realm has its own world and characters databases).
|
||||||
env.push(("AC_CHARACTER_DATABASE_INFO".into(), info("acore_characters")));
|
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
|
env
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// 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> {
|
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 {
|
let (name, alias, binary, conf, inner_port) = match kind {
|
||||||
GameKind::World => (&n.world, "world", "./worldserver", "configs/worldserver.conf", WORLD_PORT),
|
GameKind::World => (&n.world, "world", "./worldserver", "configs/worldserver.conf", WORLD_PORT),
|
||||||
@@ -395,6 +428,10 @@ fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, data: &Path,
|
|||||||
a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0"));
|
a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0"));
|
||||||
if kind == GameKind::World {
|
if kind == GameKind::World {
|
||||||
a.extend(["--volume".into(), format!("{}:{DATA}:ro", 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));
|
a.extend(env("AC_DATA_DIR", DATA));
|
||||||
// The remote console is only ever reachable from this computer.
|
// The remote console is only ever reachable from this computer.
|
||||||
a.extend(["--publish".into(), format!("127.0.0.1:{ra_port}:{RA_PORT}")]);
|
a.extend(["--publish".into(), format!("127.0.0.1:{ra_port}:{RA_PORT}")]);
|
||||||
@@ -698,6 +735,44 @@ mod tests {
|
|||||||
assert!(runs[1].args.windows(2).any(|w| w == ["--env", "AC_WORLD_DATABASE_INFO"]), "name only, the value is in the environment");
|
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_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]
|
#[test]
|
||||||
fn the_database_is_only_healthy_once_it_takes_tcp_connections() {
|
fn the_database_is_only_healthy_once_it_takes_tcp_connections() {
|
||||||
let (_d, root) = server("t1");
|
let (_d, root) = server("t1");
|
||||||
|
|||||||
@@ -15,6 +15,7 @@
|
|||||||
//! ```
|
//! ```
|
||||||
|
|
||||||
mod cli;
|
mod cli;
|
||||||
|
pub mod fixture;
|
||||||
pub mod install;
|
pub mod install;
|
||||||
mod lifecycle;
|
mod lifecycle;
|
||||||
|
|
||||||
@@ -63,6 +64,10 @@ pub struct Config {
|
|||||||
/// mounted read-only, so one copy can serve several servers.
|
/// mounted read-only, so one copy can serve several servers.
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
pub data_dir: Option<String>,
|
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 {
|
pub(crate) struct Names {
|
||||||
@@ -96,10 +101,10 @@ impl Config {
|
|||||||
if self.bind_address.parse::<IpAddr>().is_err() {
|
if self.bind_address.parse::<IpAddr>().is_err() {
|
||||||
return Err(Error::Invalid(format!("{} is not an IP address.", self.bind_address)));
|
return Err(Error::Invalid(format!("{} is not an IP address.", self.bind_address)));
|
||||||
}
|
}
|
||||||
if let Some(d) = &self.data_dir {
|
for d in [&self.data_dir, &self.mysql_data].into_iter().flatten() {
|
||||||
// The folder goes into a `--volume host:container:ro` option, where a colon would be read as a separator.
|
// 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(':') {
|
if !Path::new(d).is_absolute() || d.contains(':') {
|
||||||
return Err(Error::Invalid("The game data folder must be a full path without a colon.".into()));
|
return Err(Error::Invalid("A Docker folder must be a full path without a colon.".into()));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let image_ok = !self.mysql_image.is_empty() && self.mysql_image.chars().all(|c| c.is_ascii_alphanumeric() || "._/:@-".contains(c));
|
let image_ok = !self.mysql_image.is_empty() && self.mysql_image.chars().all(|c| c.is_ascii_alphanumeric() || "._/:@-".contains(c));
|
||||||
|
|||||||
@@ -107,6 +107,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)?; }
|
if matches!(verb, Verb::StartAll | Verb::StartWorld) { crate::modules::ensure_bot_exclusivity(&root)?; }
|
||||||
if crate::docker::is_docker(&root) {
|
if crate::docker::is_docker(&root) {
|
||||||
|
prepare_headless_world(&root, verb)?;
|
||||||
return crate::docker::run(&root, verb);
|
return crate::docker::run(&root, verb);
|
||||||
}
|
}
|
||||||
if verb == Verb::StopAll { crate::multiworld::stop(&root)?; }
|
if verb == Verb::StopAll { crate::multiworld::stop(&root)?; }
|
||||||
@@ -123,6 +124,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)?; }
|
if matches!(verb, Verb::StartAll | Verb::StartWorld) { crate::modules::ensure_bot_exclusivity(&root)?; }
|
||||||
let (python, script) = launcher(&root)?;
|
let (python, script) = launcher(&root)?;
|
||||||
|
prepare_headless_world(&root, verb)?;
|
||||||
let original = std::fs::read_to_string(&script)?;
|
let original = std::fs::read_to_string(&script)?;
|
||||||
let patched = patch_launcher_imports(&original)?;
|
let patched = patch_launcher_imports(&original)?;
|
||||||
if original != patched {
|
if original != patched {
|
||||||
@@ -136,6 +138,7 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
discard_damaged_launcher_state(&root);
|
||||||
let mut cmd = Command::new(&python);
|
let mut cmd = Command::new(&python);
|
||||||
cmd.arg("-B").arg("-c").arg(LAUNCH_SCRIPT).arg(&script).arg(verb.arg())
|
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());
|
.current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped());
|
||||||
@@ -188,10 +191,55 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
tracing::info!(?verb, ok, ?code, "driver: launcher verb finished");
|
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)?; }
|
if ok && verb == Verb::StartAll { crate::multiworld::start(&root)?; }
|
||||||
Ok(DriverOutcome { ok, exit_code, code, human: code.map(ErrorCode::human), output })
|
Ok(DriverOutcome { ok, exit_code, code, human: code.map(ErrorCode::human), output })
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// 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
|
||||||
|
}
|
||||||
|
|
||||||
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__')";
|
const LAUNCH_SCRIPT: &str = "import runpy,sys;from pathlib import Path;script=sys.argv[1];sys.path.insert(0,str(Path(script).resolve().parent));sys.argv=sys.argv[1:];runpy.run_path(script,run_name='__main__')";
|
||||||
|
|
||||||
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
|
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
|
||||||
@@ -239,6 +287,55 @@ pub(crate) fn startup_failure(root: &Path, started: &DriverOutcome) -> String {
|
|||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
|
#[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]
|
#[test]
|
||||||
fn large_squid_provisioning_has_time_to_finish_without_extending_shutdown() {
|
fn large_squid_provisioning_has_time_to_finish_without_extending_shutdown() {
|
||||||
let folder = tempfile::tempdir().unwrap();
|
let folder = tempfile::tempdir().unwrap();
|
||||||
@@ -251,6 +348,24 @@ mod tests {
|
|||||||
assert_eq!(Verb::StartWorld.timeout(folder.path()), Duration::from_secs(420));
|
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]
|
#[test]
|
||||||
fn translates_known_launcher_messages() {
|
fn translates_known_launcher_messages() {
|
||||||
assert_eq!(translate("RuntimeError: Port 8085 is already used. Stop the other server"), ErrorCode::PortInUse);
|
assert_eq!(translate("RuntimeError: Port 8085 is already used. Stop the other server"), ErrorCode::PortInUse);
|
||||||
|
|||||||
@@ -183,7 +183,7 @@ fn bootstrap_database_inner(root: &Path) -> Result<()> {
|
|||||||
|
|
||||||
let started = driver::run(root, Verb::StartMysql)?;
|
let started = driver::run(root, Verb::StartMysql)?;
|
||||||
if !started.ok {
|
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 result = (|| -> Result<()> {
|
||||||
let db = Db::from_repack(root, Account::Admin)?;
|
let db = Db::from_repack(root, Account::Admin)?;
|
||||||
@@ -210,8 +210,14 @@ fn bootstrap_database_inner(root: &Path) -> Result<()> {
|
|||||||
}
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
})();
|
})();
|
||||||
let _ = driver::run(root, Verb::StopAll);
|
let stopped = driver::run(root, Verb::StopAll);
|
||||||
result?;
|
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)?;
|
fs::remove_file(&boot)?;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
@@ -250,7 +256,7 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
|||||||
if staging_root.join(MARKER).is_file() {
|
if staging_root.join(MARKER).is_file() {
|
||||||
fs::remove_dir_all(&staging_root)?; // leftover of an earlier failed attempt that we created
|
fs::remove_dir_all(&staging_root)?; // leftover of an earlier failed attempt that we created
|
||||||
} else {
|
} 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)?;
|
fs::create_dir_all(&staging_root)?;
|
||||||
@@ -268,9 +274,8 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
|||||||
}
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
})?;
|
})?;
|
||||||
fs::remove_file(staging_root.join(MARKER))?;
|
// 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.
|
||||||
// 4. Commit: the only moment the destination changes.
|
|
||||||
say("Finishing", 95, None);
|
say("Finishing", 95, None);
|
||||||
if dest.exists() {
|
if dest.exists() {
|
||||||
fs::remove_dir(&dest)?; // only succeeds for an empty folder (preflight verified)
|
fs::remove_dir(&dest)?; // only succeeds for an empty folder (preflight verified)
|
||||||
@@ -288,15 +293,24 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
|
|||||||
}
|
}
|
||||||
let md = MetaDir::create(&dest, &meta)?;
|
let md = MetaDir::create(&dest, &meta)?;
|
||||||
fsx::atomic_write(&md.root.join("manifests").join("base.json"), &manifest_bytes)?;
|
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)?;
|
p.registry.register(&meta.id, &dest)?;
|
||||||
say("Ready", 100, None);
|
say("Ready", 100, None);
|
||||||
Ok(Installed { id: meta.id, path: dest.to_string_lossy().into_owned(), version: m.version.clone() })
|
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() {
|
if result.is_err() {
|
||||||
// Unfinished work of ours; the destination was never touched.
|
if staging_root.join(MARKER).exists() {
|
||||||
let _ = driver::run(&staging_root, Verb::StopAll);
|
// Unfinished work of ours; the destination was never touched.
|
||||||
let _ = fs::remove_dir_all(&staging_root);
|
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
|
result
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,11 +2,14 @@ pub mod accounts;
|
|||||||
pub mod backup;
|
pub mod backup;
|
||||||
pub mod cleanbase;
|
pub mod cleanbase;
|
||||||
pub mod companions;
|
pub mod companions;
|
||||||
|
pub mod custom_races;
|
||||||
pub mod client;
|
pub mod client;
|
||||||
pub mod remote_client;
|
pub mod remote_client;
|
||||||
pub mod clientdl;
|
pub mod clientdl;
|
||||||
pub mod config;
|
pub mod config;
|
||||||
pub mod console;
|
pub mod console;
|
||||||
|
pub mod crashes;
|
||||||
|
pub mod dashboard;
|
||||||
pub mod db;
|
pub mod db;
|
||||||
pub mod diag;
|
pub mod diag;
|
||||||
pub mod docker;
|
pub mod docker;
|
||||||
@@ -30,6 +33,7 @@ pub mod repair;
|
|||||||
pub mod schema_check;
|
pub mod schema_check;
|
||||||
pub mod net;
|
pub mod net;
|
||||||
pub mod package;
|
pub mod package;
|
||||||
|
pub mod platform;
|
||||||
pub mod ra;
|
pub mod ra;
|
||||||
pub mod allsettings;
|
pub mod allsettings;
|
||||||
pub mod modules;
|
pub mod modules;
|
||||||
@@ -40,8 +44,12 @@ pub mod release;
|
|||||||
pub mod report;
|
pub mod report;
|
||||||
pub mod release_schema;
|
pub mod release_schema;
|
||||||
pub mod update;
|
pub mod update;
|
||||||
|
mod update_isolation;
|
||||||
|
mod mysql_snapshot;
|
||||||
|
pub mod wine;
|
||||||
pub mod upnp;
|
pub mod upnp;
|
||||||
pub mod signing;
|
pub mod signing;
|
||||||
|
pub mod channels;
|
||||||
pub mod srp6;
|
pub mod srp6;
|
||||||
|
|
||||||
pub use error::{Error, ErrorCode, Result};
|
pub use error::{Error, ErrorCode, Result};
|
||||||
|
|||||||
@@ -78,9 +78,31 @@ pub struct Revision {
|
|||||||
pub commit: Option<String>,
|
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)]
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
#[serde(rename_all = "camelCase")]
|
#[serde(rename_all = "camelCase")]
|
||||||
pub struct Manifest {
|
pub struct Manifest {
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub compatibility: Option<Compatibility>,
|
||||||
pub schema: u32,
|
pub schema: u32,
|
||||||
pub kind: Kind,
|
pub kind: Kind,
|
||||||
pub version: String,
|
pub version: String,
|
||||||
@@ -136,6 +158,26 @@ impl Manifest {
|
|||||||
if parse_version(&self.min_manager_version).is_none() {
|
if parse_version(&self.min_manager_version).is_none() {
|
||||||
return bad(format!("bad minManagerVersion {:?}", self.min_manager_version));
|
return bad(format!("bad minManagerVersion {:?}", self.min_manager_version));
|
||||||
}
|
}
|
||||||
|
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 {
|
for migration in &self.migrations {
|
||||||
if !is_sha256(&migration.sha256) || migration.compatible_sha256.iter().any(|h| !is_sha256(h) || h == &"0".repeat(64)) {
|
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));
|
return bad(format!("{}: invalid migration checksum compatibility", migration.id));
|
||||||
@@ -232,6 +274,53 @@ mod tests {
|
|||||||
assert!(!m.compatible_with_manager("0.0.9"));
|
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]
|
#[test]
|
||||||
fn rejects_traversal_bad_hash_duplicates_and_short_commit() {
|
fn rejects_traversal_bad_hash_duplicates_and_short_commit() {
|
||||||
let ok = "b".repeat(64);
|
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)
|
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 {
|
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)
|
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))
|
&& !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.
|
/// Inspect recorded history without creating a ledger or executing migrations.
|
||||||
@@ -275,6 +292,18 @@ mod tests {
|
|||||||
use super::*;
|
use super::*;
|
||||||
use std::cell::RefCell;
|
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)]
|
#[derive(Default)]
|
||||||
struct Mem {
|
struct Mem {
|
||||||
rows: RefCell<Vec<LedgerRow>>,
|
rows: RefCell<Vec<LedgerRow>>,
|
||||||
|
|||||||
@@ -119,7 +119,26 @@ fn conf_name(root: &Path, e: &Entry) -> String {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
|
||||||
|
let Ok(directory) = crate::registry::metadata_dir_for(root) else { return Default::default() };
|
||||||
|
let Ok((_, meta)) = crate::registry::MetaDir::open(&directory) else { return Default::default() };
|
||||||
|
let Some(version) = meta.core.version else { return Default::default() };
|
||||||
|
let candidates = [directory.join("manifests").join(format!("update-{version}.json")), directory.join("manifests/base.json")];
|
||||||
|
for path in candidates {
|
||||||
|
let Ok(manifest) = crate::fsx::read_json::<serde_json::Value>(&path) else { continue };
|
||||||
|
if manifest.get("version").and_then(|value| value.as_str()) != Some(&version) { continue; }
|
||||||
|
if let Some(commits) = manifest.get("compatibility").and_then(|value| value.get("moduleCommits")).and_then(|value| value.as_object()) {
|
||||||
|
return commits.iter().filter_map(|(name, commit)| {
|
||||||
|
let commit = commit.as_str()?;
|
||||||
|
(commit.len() == 40 && commit.bytes().all(|byte| byte.is_ascii_hexdigit())).then(|| (name.clone(), commit.chars().take(8).collect()))
|
||||||
|
}).collect();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Default::default()
|
||||||
|
}
|
||||||
|
|
||||||
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
||||||
|
let installed_commits = installed_module_commits(root);
|
||||||
let wildcard = crate::realms::state(root).map(|s| s.active == crate::realms::Mode::Wildcard).unwrap_or(true);
|
let wildcard = crate::realms::state(root).map(|s| s.active == crate::realms::Mode::Wildcard).unwrap_or(true);
|
||||||
cat.iter()
|
cat.iter()
|
||||||
.cloned()
|
.cloned()
|
||||||
@@ -141,6 +160,8 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
|
|||||||
let version = if e.id == "playerbots" { crate::squid::release(root).map(|release| {
|
let version = if e.id == "playerbots" { crate::squid::release(root).map(|release| {
|
||||||
[release.tag, release.commit.map(|commit| commit.chars().take(8).collect())].into_iter().flatten().collect::<Vec<_>>().join(" · ")
|
[release.tag, release.commit.map(|commit| commit.chars().take(8).collect())].into_iter().flatten().collect::<Vec<_>>().join(" · ")
|
||||||
}) } else { None };
|
}) } else { None };
|
||||||
|
let key = match e.id.as_str() { "companions" => "bots", "playerbots" => "squid", "content-scaling" => "scaling", "custom-races" => "races", id => id };
|
||||||
|
let version = if installed { version.or_else(|| installed_commits.get(key).cloned()) } else { None };
|
||||||
ModuleView {
|
ModuleView {
|
||||||
version,
|
version,
|
||||||
compatibility: if blocked { "unsupported" } else if wildcard && e.id != "client-compat" { "experimental" } else { "compatible" }.into(),
|
compatibility: if blocked { "unsupported" } else if wildcard && e.id != "client-compat" { "experimental" } else { "compatible" }.into(),
|
||||||
@@ -203,6 +224,28 @@ pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
|
|||||||
Some(lock)
|
Some(lock)
|
||||||
} else { None };
|
} else { None };
|
||||||
if on { crate::realms::guard_module(root, id)?; }
|
if on { crate::realms::guard_module(root, id)?; }
|
||||||
|
if id == "custom-races" {
|
||||||
|
if let Ok(meta_content) = fs::read_to_string(meta.join("install.json")) {
|
||||||
|
if let Ok(install_meta) = serde_json::from_str::<crate::registry::InstallMeta>(&meta_content) {
|
||||||
|
if let Some(cp) = install_meta.client_path {
|
||||||
|
let client_path = PathBuf::from(cp);
|
||||||
|
if client_path.is_dir() {
|
||||||
|
crate::custom_races::set_client_patch_enabled(&client_path, on)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !on {
|
||||||
|
let _ = crate::custom_races::sync_bot_races_config(root, false);
|
||||||
|
} else {
|
||||||
|
let allow = crate::custom_races::is_bot_custom_races_allowed(root).unwrap_or_else(|| {
|
||||||
|
read(&dir(root).join("coa_custom_races.conf"))
|
||||||
|
.and_then(|c| c.get("CoACustomRaces.BotsEnable").map(truthy))
|
||||||
|
.unwrap_or(false)
|
||||||
|
});
|
||||||
|
let _ = crate::custom_races::sync_bot_races_config(root, allow);
|
||||||
|
}
|
||||||
|
}
|
||||||
set_enabled_in(&catalog(), root, meta, id, on)
|
set_enabled_in(&catalog(), root, meta, id, on)
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -278,14 +321,27 @@ fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
let bot_custom_races_allowed = if id == "custom-races" {
|
||||||
|
crate::custom_races::is_bot_custom_races_allowed(root)
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
Ok(effective
|
Ok(effective
|
||||||
.entries()
|
.entries()
|
||||||
.map(|(k, v)| Setting {
|
.map(|(k, v)| {
|
||||||
key: k.to_string(),
|
let mut val = fields.get(k).and_then(|field| field.default_if_missing.as_ref()).filter(|_| active.get(k).is_none()).and_then(crate::squid::scalar).unwrap_or_else(|| v.to_string());
|
||||||
value: fields.get(k).and_then(|field| field.default_if_missing.as_ref()).filter(|_| active.get(k).is_none()).and_then(crate::squid::scalar).unwrap_or_else(|| v.to_string()),
|
if k == "CoACustomRaces.BotsEnable" {
|
||||||
default: fields.get(k).and_then(|field| crate::squid::scalar(&field.default)).or_else(|| dist.as_ref().and_then(|d| d.get(k)).map(str::to_string)),
|
if let Some(allowed) = bot_custom_races_allowed {
|
||||||
field: fields.get(k).cloned(),
|
val = if allowed { "1".into() } else { "0".into() };
|
||||||
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
|
}
|
||||||
|
}
|
||||||
|
Setting {
|
||||||
|
key: k.to_string(),
|
||||||
|
value: val,
|
||||||
|
default: fields.get(k).and_then(|field| crate::squid::scalar(&field.default)).or_else(|| dist.as_ref().and_then(|d| d.get(k)).map(str::to_string)),
|
||||||
|
field: fields.get(k).cloned(),
|
||||||
|
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
|
||||||
|
}
|
||||||
})
|
})
|
||||||
.collect())
|
.collect())
|
||||||
}
|
}
|
||||||
@@ -341,6 +397,12 @@ fn save_settings_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, changes:
|
|||||||
changed.push((key.clone(), value.to_string()));
|
changed.push((key.clone(), value.to_string()));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
if id == "custom-races" {
|
||||||
|
if let Some(bots_enable) = changes.get("CoACustomRaces.BotsEnable") {
|
||||||
|
let allow = truthy(bots_enable);
|
||||||
|
crate::custom_races::sync_bot_races_config(root, allow)?;
|
||||||
|
}
|
||||||
|
}
|
||||||
if changed.is_empty() {
|
if changed.is_empty() {
|
||||||
return Ok(Vec::new());
|
return Ok(Vec::new());
|
||||||
}
|
}
|
||||||
@@ -384,6 +446,22 @@ mod tests {
|
|||||||
(root, meta)
|
(root, meta)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn module_revisions_come_from_the_installed_release_only() {
|
||||||
|
let temp = tempfile::tempdir().unwrap();
|
||||||
|
let root = temp.path().join("server");
|
||||||
|
fs::create_dir_all(&root).unwrap();
|
||||||
|
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::Imported, &root);
|
||||||
|
meta.core.version = Some("2.0.0".into());
|
||||||
|
let directory = crate::registry::MetaDir::create(&root, &meta).unwrap();
|
||||||
|
let value = serde_json::json!({"version": "2.0.0", "compatibility": {"moduleCommits": {"races": "a".repeat(40), "bots": "b".repeat(40)}}});
|
||||||
|
fsx::atomic_write_json(&directory.root.join("manifests/update-2.0.0.json"), &value).unwrap();
|
||||||
|
assert_eq!(installed_module_commits(&root).get("races").map(String::as_str), Some("aaaaaaaa"));
|
||||||
|
let stale = serde_json::json!({"version": "1.0.0", "compatibility": {"moduleCommits": {"races": "c".repeat(40)}}});
|
||||||
|
fsx::atomic_write_json(&directory.root.join("manifests/update-2.0.0.json"), &stale).unwrap();
|
||||||
|
assert!(installed_module_commits(&root).is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn squid_missing_keys_use_code_defaults_and_saves_enforce_json_ranges() {
|
fn squid_missing_keys_use_code_defaults_and_saves_enforce_json_ranges() {
|
||||||
let d = tempfile::tempdir().unwrap();
|
let d = tempfile::tempdir().unwrap();
|
||||||
@@ -660,4 +738,39 @@ mod tests {
|
|||||||
assert!(fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("WarGames.Enable = 0"));
|
assert!(fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("WarGames.Enable = 0"));
|
||||||
assert!(!list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled);
|
assert!(!list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled);
|
||||||
}
|
}
|
||||||
|
#[test]
|
||||||
|
fn custom_races_bot_settings_synchronize_playerbots_conf() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let (root, meta) = server(d.path());
|
||||||
|
let cat = catalog();
|
||||||
|
fs::write(dir(&root).join("coa_custom_races.conf.dist"), "CoACustomRaces.Enable = 1\nCoACustomRaces.BotsEnable = 0\n").unwrap();
|
||||||
|
fs::write(dir(&root).join("coa_custom_races.conf"), "CoACustomRaces.Enable = 1\nCoACustomRaces.BotsEnable = 0\n").unwrap();
|
||||||
|
fs::write(dir(&root).join("playerbots.conf"), "AiPlayerbot.Enabled = 1\n").unwrap();
|
||||||
|
|
||||||
|
// 1. Initially CoACustomRaces.BotsEnable is 0
|
||||||
|
let s = settings_in(&cat, &root, "custom-races").unwrap();
|
||||||
|
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "0");
|
||||||
|
|
||||||
|
// 2. Enable bots for custom races: should write experimental exclusions to playerbots.conf
|
||||||
|
let change_on = BTreeMap::from([("CoACustomRaces.BotsEnable".into(), "1".into())]);
|
||||||
|
assert_eq!(save_settings_in(&cat, &root, &meta, "custom-races", &change_on).unwrap(), ["CoACustomRaces.BotsEnable"]);
|
||||||
|
let pb = fs::read_to_string(dir(&root).join("playerbots.conf")).unwrap();
|
||||||
|
assert!(pb.contains("AiPlayerbot.ExcludedBotRaces"));
|
||||||
|
assert!(pb.contains(crate::custom_races::EXCLUDED_BOT_RACES_EXPERIMENTAL));
|
||||||
|
|
||||||
|
// Settings view now sees "1"
|
||||||
|
let s = settings_in(&cat, &root, "custom-races").unwrap();
|
||||||
|
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "1");
|
||||||
|
|
||||||
|
// 3. Disable bots for custom races: should write recommended exclusions to playerbots.conf
|
||||||
|
let change_off = BTreeMap::from([("CoACustomRaces.BotsEnable".into(), "0".into())]);
|
||||||
|
assert_eq!(save_settings_in(&cat, &root, &meta, "custom-races", &change_off).unwrap(), ["CoACustomRaces.BotsEnable"]);
|
||||||
|
let pb = fs::read_to_string(dir(&root).join("playerbots.conf")).unwrap();
|
||||||
|
assert!(pb.contains(crate::custom_races::EXCLUDED_BOT_RACES_RECOMMENDED));
|
||||||
|
|
||||||
|
// Settings view now sees "0"
|
||||||
|
let s = settings_in(&cat, &root, "custom-races").unwrap();
|
||||||
|
assert_eq!(s.iter().find(|s| s.key == "CoACustomRaces.BotsEnable").unwrap().value, "0");
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -0,0 +1,493 @@
|
|||||||
|
use std::{collections::{BTreeMap, BTreeSet}, fs, path::{Path, PathBuf}};
|
||||||
|
use std::io::{BufReader, BufWriter, Write};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use crate::{fsx, Error, Result};
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Serialize, Deserialize)]
|
||||||
|
#[serde(deny_unknown_fields)]
|
||||||
|
pub(crate) struct Snapshot {
|
||||||
|
pub path: String,
|
||||||
|
pub files: BTreeMap<String, String>,
|
||||||
|
pub directories: BTreeSet<String>,
|
||||||
|
pub server_sha256: String,
|
||||||
|
#[serde(default)]
|
||||||
|
pub bytes: u64,
|
||||||
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
|
pub archive_sha256: Option<String>,
|
||||||
|
#[serde(default)]
|
||||||
|
pub expanded_bytes: u64,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn reject_link(metadata: &fs::Metadata) -> Result<()> {
|
||||||
|
let linked = metadata.file_type().is_symlink();
|
||||||
|
#[cfg(windows)] let linked = { use std::os::windows::fs::MetadataExt; linked || metadata.file_attributes() & 0x400 != 0 };
|
||||||
|
if linked { return Err(Error::Invalid("Recovery copies cannot follow symbolic links or junctions.".into())); }
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn directories(root: &Path) -> Result<BTreeSet<String>> {
|
||||||
|
let canonical = fsx::canonicalize_lenient(root)?;
|
||||||
|
let root = canonical.as_path();
|
||||||
|
let mut result = BTreeSet::new();
|
||||||
|
let mut pending = vec![root.to_path_buf()];
|
||||||
|
while let Some(directory) = pending.pop() {
|
||||||
|
for entry in fs::read_dir(directory)? {
|
||||||
|
let entry = entry?;
|
||||||
|
reject_link(&fs::symlink_metadata(entry.path())?)?;
|
||||||
|
let path = fsx::ensure_within(root, &entry.path())?;
|
||||||
|
if entry.file_type()?.is_dir() {
|
||||||
|
let relative = path.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
|
||||||
|
result.insert(relative);
|
||||||
|
pending.push(path);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(result)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn copy_snapshot(point: &Path, snapshot: &Snapshot, target: &Path) -> Result<()> {
|
||||||
|
if snapshot.archive_sha256.is_some() {
|
||||||
|
verify(point, snapshot)?;
|
||||||
|
if target.exists() { return Err(Error::Invalid("The recovery destination already exists.".into())); }
|
||||||
|
let parent = target.parent().ok_or_else(|| Error::Invalid("Invalid recovery destination.".into()))?;
|
||||||
|
fs::create_dir_all(parent)?;
|
||||||
|
fsx::require_space(parent, snapshot.expanded_bytes)?;
|
||||||
|
fs::create_dir(target)?;
|
||||||
|
let input = fsx::ensure_within(point, &fsx::safe_join(point, &snapshot.path)?)?;
|
||||||
|
let decoder = zstd::Decoder::new(BufReader::new(fs::File::open(input)?))?;
|
||||||
|
let mut archive = tar::Archive::new(decoder);
|
||||||
|
let mut seen = BTreeSet::new();
|
||||||
|
let mut expanded = 0u64;
|
||||||
|
for entry in archive.entries()? {
|
||||||
|
let mut entry = entry?;
|
||||||
|
let name = entry.path()?.to_string_lossy().trim_end_matches('/').to_string();
|
||||||
|
if !seen.insert(name.clone()) { return Err(Error::Invalid("Duplicate entry in MySQL recovery archive.".into())); }
|
||||||
|
let output = fsx::ensure_within(target, &fsx::safe_join(target, &name)?)?;
|
||||||
|
if entry.header().entry_type().is_dir() && snapshot.directories.contains(&name) {
|
||||||
|
fs::create_dir_all(output)?;
|
||||||
|
} else if entry.header().entry_type().is_file() && snapshot.files.contains_key(&name) {
|
||||||
|
expanded = expanded.checked_add(entry.size()).filter(|bytes| *bytes <= snapshot.expanded_bytes)
|
||||||
|
.ok_or_else(|| Error::Invalid("MySQL recovery archive exceeds its declared size.".into()))?;
|
||||||
|
fs::create_dir_all(output.parent().unwrap())?;
|
||||||
|
let mut file = fs::OpenOptions::new().write(true).create_new(true).open(output)?;
|
||||||
|
if std::io::copy(&mut entry, &mut file)? != entry.size() { return Err(Error::Invalid("Truncated MySQL recovery file.".into())); }
|
||||||
|
file.flush()?;
|
||||||
|
} else { return Err(Error::Invalid("Unexpected entry in MySQL recovery archive.".into())); }
|
||||||
|
}
|
||||||
|
if expanded != snapshot.expanded_bytes || inventory(target)? != snapshot.files {
|
||||||
|
return Err(Error::Invalid("MySQL recovery files failed verification.".into()));
|
||||||
|
}
|
||||||
|
} else { copy_verified(&point.join(&snapshot.path), target, &snapshot.files)?; }
|
||||||
|
for directory in &snapshot.directories {
|
||||||
|
fs::create_dir_all(fsx::ensure_within(target, &fsx::safe_join(target, directory)?)?)?;
|
||||||
|
}
|
||||||
|
if directories(target)? != snapshot.directories { return Err(Error::Invalid("The recovery directory inventory differs.".into())); }
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn compress(source: &Path, point: &Path, snapshot: &mut Snapshot) -> Result<()> {
|
||||||
|
snapshot.path = "mysql-data.tar.zst".into();
|
||||||
|
let path = fsx::safe_join(point, &snapshot.path)?;
|
||||||
|
fs::create_dir_all(point)?;
|
||||||
|
fsx::require_space(point, snapshot.expanded_bytes)?;
|
||||||
|
let file = fs::OpenOptions::new().write(true).create_new(true).open(&path)?;
|
||||||
|
let encoder = zstd::Encoder::new(BufWriter::new(file), 3)?;
|
||||||
|
let mut archive = tar::Builder::new(encoder);
|
||||||
|
for directory in &snapshot.directories {
|
||||||
|
archive.append_dir(directory, fsx::ensure_within(source, &fsx::safe_join(source, directory)?)?)?;
|
||||||
|
}
|
||||||
|
for name in snapshot.files.keys() {
|
||||||
|
let input = fsx::ensure_within(source, &fsx::safe_join(source, name)?)?;
|
||||||
|
archive.append_file(name, &mut fs::File::open(input)?)?;
|
||||||
|
}
|
||||||
|
archive.into_inner()?.finish()?.flush()?;
|
||||||
|
snapshot.archive_sha256 = Some(fsx::sha256_file(&path)?);
|
||||||
|
snapshot.bytes = fs::metadata(path)?.len();
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn inventory(root: &Path) -> Result<BTreeMap<String, String>> {
|
||||||
|
let canonical = fsx::canonicalize_lenient(root)?;
|
||||||
|
let root = canonical.as_path();
|
||||||
|
let mut files = BTreeMap::new();
|
||||||
|
let mut directories = vec![root.to_path_buf()];
|
||||||
|
while let Some(directory) = directories.pop() {
|
||||||
|
for entry in fs::read_dir(directory)? {
|
||||||
|
let entry = entry?;
|
||||||
|
let metadata = fs::symlink_metadata(entry.path())?;
|
||||||
|
let path = fsx::ensure_within(root, &entry.path())?;
|
||||||
|
reject_link(&metadata)?;
|
||||||
|
if metadata.is_dir() { directories.push(path); continue; }
|
||||||
|
if !metadata.is_file() { return Err(Error::Invalid("Unsupported database snapshot file.".into())); }
|
||||||
|
let relative = path.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
|
||||||
|
fsx::safe_join(root, &relative)?;
|
||||||
|
if relative.ends_with(".isl") { return Err(Error::Invalid("External MySQL tablespaces require a separate recovery method.".into())); }
|
||||||
|
files.insert(relative, fsx::sha256_file(&path)?);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(files)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn copy_verified(source: &Path, target: &Path, files: &BTreeMap<String, String>) -> Result<()> {
|
||||||
|
if target.exists() { return Err(Error::Invalid("Database snapshot destination already exists.".into())); }
|
||||||
|
let bytes = files.keys().try_fold(0u64, |total, name| -> Result<u64> {
|
||||||
|
let path = fsx::ensure_within(source, &fsx::safe_join(source, name)?)?;
|
||||||
|
total.checked_add(fs::metadata(path)?.len()).ok_or_else(|| Error::Invalid("Snapshot size overflow.".into()))
|
||||||
|
})?;
|
||||||
|
let parent = target.parent().ok_or_else(|| Error::Invalid("Invalid snapshot destination.".into()))?;
|
||||||
|
fs::create_dir_all(parent)?;
|
||||||
|
fsx::require_space(parent, bytes)?;
|
||||||
|
fs::create_dir(target)?;
|
||||||
|
for (relative, expected) in files {
|
||||||
|
let source_file = fsx::ensure_within(source, &fsx::safe_join(source, relative)?)?;
|
||||||
|
let target_file = fsx::ensure_within(target, &fsx::safe_join(target, relative)?)?;
|
||||||
|
fs::create_dir_all(target_file.parent().unwrap())?;
|
||||||
|
fs::copy(&source_file, &target_file)?;
|
||||||
|
if fsx::sha256_file(&target_file)? != *expected { return Err(Error::Invalid(format!("Database snapshot file {relative} failed verification."))); }
|
||||||
|
}
|
||||||
|
if inventory(target)? != *files { return Err(Error::Invalid("Database snapshot inventory differs.".into())); }
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn stop(root: &Path) -> Result<()> {
|
||||||
|
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
|
||||||
|
if [observed.mysql.state, observed.auth.state, observed.world.state].iter().all(|state| *state == crate::process::ServiceState::Stopped)
|
||||||
|
&& !crate::multiworld::is_running(root) { return Ok(()); }
|
||||||
|
let outcome = crate::driver::run(root, crate::driver::Verb::StopAll)?;
|
||||||
|
let status = crate::process::observe(root, &crate::layout::read_ports(root));
|
||||||
|
if !outcome.ok || [status.mysql.state, status.auth.state, status.world.state].iter().any(|state| *state != crate::process::ServiceState::Stopped)
|
||||||
|
|| crate::multiworld::is_running(root) {
|
||||||
|
return Err(Error::Invalid("The complete server must be stopped before copying or restoring MySQL.".into()));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn stop_previous_rehearsals(meta: &Path) -> Result<()> {
|
||||||
|
let location = meta.join("rehearsals");
|
||||||
|
if !location.exists() { return Ok(()); }
|
||||||
|
for entry in fs::read_dir(&location)? {
|
||||||
|
let entry = entry?;
|
||||||
|
let name = entry.file_name().to_string_lossy().into_owned();
|
||||||
|
if name.len() != 32 || !name.bytes().all(|byte| byte.is_ascii_hexdigit()) { continue; }
|
||||||
|
let fixture = fsx::ensure_within(&location, &entry.path().join("server"))?;
|
||||||
|
let metadata = crate::registry::metadata_dir_for(&fixture)?;
|
||||||
|
if !metadata.join("install.json").is_file() { continue; }
|
||||||
|
let (_, installed) = crate::registry::MetaDir::open(&metadata)?;
|
||||||
|
if fsx::canonicalize_lenient(Path::new(&installed.server_path))? != fsx::canonicalize_lenient(&fixture)? {
|
||||||
|
return Err(Error::Invalid("The interrupted rehearsal metadata does not match its private server.".into()));
|
||||||
|
}
|
||||||
|
stop(&fixture)?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn capture(root: &Path, partial: &Path) -> Result<Snapshot> {
|
||||||
|
if crate::docker::is_docker(root) || !cfg!(windows) { return Err(Error::Invalid("Cold MySQL snapshots require a Windows repack.".into())); }
|
||||||
|
crate::backup::with_database(root, |db| {
|
||||||
|
if db.query("SELECT COUNT(*) FROM performance_schema.replication_connection_configuration;")?.trim() != "0" {
|
||||||
|
return Err(Error::Invalid("A replicated MySQL instance requires a separate isolated recovery method.".into()));
|
||||||
|
}
|
||||||
|
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
|
||||||
|
for path in db.query("SELECT PATH FROM information_schema.INNODB_DATAFILES;")?.lines() {
|
||||||
|
fsx::ensure_within(&data, &data.join(path))?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
stop(root)?;
|
||||||
|
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
|
||||||
|
if !data.join("mysql").is_dir() || !data.join("ibdata1").is_file() {
|
||||||
|
return Err(Error::Invalid("The bundled MySQL data directory is incomplete.".into()));
|
||||||
|
}
|
||||||
|
let files = inventory(&data)?;
|
||||||
|
let bytes = files.keys().try_fold(0u64, |total, file| -> Result<u64> {
|
||||||
|
total.checked_add(fs::metadata(fsx::safe_join(&data, file)?)?.len()).ok_or_else(|| Error::Invalid("Snapshot size overflow.".into()))
|
||||||
|
})?;
|
||||||
|
let mut snapshot = Snapshot { path: "mysql-data".into(), files, directories:directories(&data)?, server_sha256: fsx::sha256_file(&root.join("mysql/bin/mysqld.exe"))?, bytes, expanded_bytes:bytes, archive_sha256:None };
|
||||||
|
compress(&data, partial, &mut snapshot)?;
|
||||||
|
verify(partial, &snapshot)?;
|
||||||
|
Ok(snapshot)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn verify(point: &Path, snapshot: &Snapshot) -> Result<()> {
|
||||||
|
if snapshot.files.is_empty() || snapshot.server_sha256.len() != 64 {
|
||||||
|
return Err(Error::Invalid("Invalid cold MySQL recovery inventory.".into()));
|
||||||
|
}
|
||||||
|
let data = fsx::ensure_within(point, &fsx::safe_join(point, &snapshot.path)?)?;
|
||||||
|
if let Some(hash) = &snapshot.archive_sha256 {
|
||||||
|
if snapshot.path != "mysql-data.tar.zst" || snapshot.expanded_bytes == 0 || fsx::sha256_file(&data)? != *hash {
|
||||||
|
return Err(Error::Invalid("The compressed MySQL recovery copy is damaged.".into()));
|
||||||
|
}
|
||||||
|
for name in snapshot.files.keys().chain(snapshot.directories.iter()) { fsx::safe_join(point, name)?; }
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
if snapshot.path != "mysql-data" { return Err(Error::Invalid("Unsupported MySQL recovery format.".into())); }
|
||||||
|
if inventory(&data)? != snapshot.files { return Err(Error::Invalid("The cold MySQL recovery copy is damaged or incomplete.".into())); }
|
||||||
|
if directories(&data)? != snapshot.directories { return Err(Error::Invalid("The cold MySQL recovery directories are incomplete.".into())); }
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn rehearsal_copy(root: &Path, meta: &Path, point: &Path, snapshot: &Snapshot) -> Result<PathBuf> {
|
||||||
|
verify(point, snapshot)?;
|
||||||
|
let canonical = fsx::canonicalize_lenient(root)?;
|
||||||
|
let root = canonical.as_path();
|
||||||
|
let destination = meta.join("rehearsals").join(uuid::Uuid::new_v4().simple().to_string()).join("server");
|
||||||
|
let mut files = BTreeMap::new();
|
||||||
|
let mut directories = vec![root.to_path_buf()];
|
||||||
|
while let Some(directory) = directories.pop() {
|
||||||
|
for entry in fs::read_dir(directory)? {
|
||||||
|
let entry = entry?;
|
||||||
|
let raw = entry.path();
|
||||||
|
let relative = raw.strip_prefix(root).map_err(|e| Error::Invalid(e.to_string()))?.to_string_lossy().replace('\\', "/");
|
||||||
|
let lower = relative.to_ascii_lowercase();
|
||||||
|
let first = lower.split('/').next().unwrap();
|
||||||
|
if entry.file_type()?.is_dir() && !relative.contains('/')
|
||||||
|
&& !["core", "data", "scripts", "settings", "runtime", "mysql", ".realms", "bugreport", "extras", "licenses"].contains(&first) { continue; }
|
||||||
|
if lower == "mysql/data" || lower.starts_with("mysql/data-")
|
||||||
|
|| lower.split('/').any(|part| part == ".state")
|
||||||
|
|| lower == "bugreport/reports" || lower == "core/logs" || lower == "mysql/logs" { continue; }
|
||||||
|
let metadata = fs::symlink_metadata(&raw)?;
|
||||||
|
reject_link(&metadata)?;
|
||||||
|
let path = fsx::ensure_within(root, &raw)?;
|
||||||
|
if metadata.is_dir() { directories.push(path); }
|
||||||
|
else if metadata.is_file() { files.insert(relative, fsx::sha256_file(&path)?); }
|
||||||
|
else { return Err(Error::Invalid("Unsupported rehearsal file.".into())); }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
copy_verified(root, &destination, &files)?;
|
||||||
|
copy_snapshot(point, snapshot, &destination.join("mysql/data"))?;
|
||||||
|
let (_, mut installed) = crate::registry::MetaDir::open(meta)?;
|
||||||
|
installed.id = uuid::Uuid::new_v4().to_string();
|
||||||
|
installed.server_path = destination.to_string_lossy().into_owned();
|
||||||
|
installed.client_path = None;
|
||||||
|
crate::registry::MetaDir::create(&destination, &installed)?;
|
||||||
|
Ok(destination)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn isolate_connections(root: &Path) -> Result<()> {
|
||||||
|
for relative in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] {
|
||||||
|
let path = fsx::ensure_within(root, &root.join(relative))?;
|
||||||
|
if !path.is_file() {
|
||||||
|
if relative.ends_with(".template") { return Err(Error::Invalid("The private update copy lacks connection templates.".into())); }
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
let mut config = crate::config::parser::ConfFile::parse_bytes(&fs::read(&path)?)?;
|
||||||
|
for key in ["LoginDatabaseInfo", "WorldDatabaseInfo", "CharacterDatabaseInfo"] {
|
||||||
|
if relative.contains("worldserver") || key == "LoginDatabaseInfo" {
|
||||||
|
config.set(key, &format!("\"@{key}@\""), &[]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
config.set("BindIP", "\"127.0.0.1\"", &[]);
|
||||||
|
if relative.contains("worldserver") {
|
||||||
|
config.set("Ra.IP", "\"127.0.0.1\"", &[]);
|
||||||
|
config.set("DataDir", "\"@DATA@\"", &[]);
|
||||||
|
}
|
||||||
|
fsx::atomic_write(&path, config.to_text().as_bytes())?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn unchanged(root: &Path, snapshot: &Snapshot) -> Result<()> {
|
||||||
|
let data = fsx::ensure_within(root, &root.join("mysql/data"))?;
|
||||||
|
if inventory(&data)? != snapshot.files || directories(&data)? != snapshot.directories {
|
||||||
|
return Err(Error::Invalid("The installed database changed during the private rehearsal. Retry after stopping other database access.".into()));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn validate_connections(templates: &Path, installation: &Path) -> Result<()> {
|
||||||
|
let port = crate::layout::read_ports(installation).mysql.to_string();
|
||||||
|
let (_, password) = crate::db::credentials(installation)?;
|
||||||
|
let realm = crate::realms::state(installation)?.active;
|
||||||
|
for relative in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template"] {
|
||||||
|
let path = fsx::ensure_within(templates, &templates.join(relative))?;
|
||||||
|
let config = crate::config::parser::ConfFile::parse_bytes(&fs::read(path)?)?;
|
||||||
|
for (key, kind) in [("LoginDatabaseInfo", "auth"), ("WorldDatabaseInfo", "world"), ("CharacterDatabaseInfo", "characters")] {
|
||||||
|
if relative.contains("authserver") && kind != "auth" { continue; }
|
||||||
|
let value = config.get(key).ok_or_else(|| Error::Invalid(format!("The update cannot isolate the missing {key} connection.")))?.trim().trim_matches('"');
|
||||||
|
if value == format!("@{key}@") { continue; }
|
||||||
|
let fields: Vec<_> = value.split(';').collect();
|
||||||
|
if fields.len() != 5 || !matches!(fields[0], "127.0.0.1" | "localhost") || fields[1] != port || fields[2] != "acore" || fields[3] != password || fields[4] != realm.schema(kind)? {
|
||||||
|
return Err(Error::Invalid(format!("The {key} connection does not use this repack's bundled database. A private update cannot safely qualify an external database.")));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
// Keep the replaced data directory. If interrupted between renames, a retry can install a new verified copy.
|
||||||
|
pub(crate) fn swap(root: &Path, meta: &Path, point: &Path, snapshot: &Snapshot, fail_after_move: bool) -> Result<PathBuf> {
|
||||||
|
verify(point, snapshot)?;
|
||||||
|
if fsx::sha256_file(&root.join("mysql/bin/mysqld.exe"))? != snapshot.server_sha256 {
|
||||||
|
return Err(Error::Invalid("The MySQL executable differs from the recovery point.".into()));
|
||||||
|
}
|
||||||
|
let mysql = fsx::ensure_within(root, &root.join("mysql"))?;
|
||||||
|
let token = uuid::Uuid::new_v4().simple().to_string();
|
||||||
|
let staging = fsx::ensure_within(&mysql, &mysql.join(format!("data-restore-{token}")))?;
|
||||||
|
let previous = fsx::ensure_within(&mysql, &mysql.join(format!("data-before-restore-{token}")))?;
|
||||||
|
let live = fsx::ensure_within(&mysql, &mysql.join("data"))?;
|
||||||
|
copy_snapshot(point, snapshot, &staging)?;
|
||||||
|
let journal = meta.join("diagnostics").join(format!("database-restore-{token}.json"));
|
||||||
|
fsx::atomic_write_json(&journal, &serde_json::json!({"schema":1,"state":"prepared","previous":previous,"staging":staging}))?;
|
||||||
|
if live.exists() { fs::rename(&live, &previous)?; }
|
||||||
|
if fail_after_move { return Err(Error::Invalid("Simulated interruption after saving the previous MySQL directory.".into())); }
|
||||||
|
fs::rename(&staging, &live)?;
|
||||||
|
fsx::atomic_write_json(&journal, &serde_json::json!({"schema":1,"state":"restored","previous":previous}))?;
|
||||||
|
Ok(previous)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
#[cfg(windows)]
|
||||||
|
#[test]
|
||||||
|
#[ignore = "requires COA_MYSQL_TEST_BIN pointing to the bundled MySQL tools"]
|
||||||
|
fn real_mysql_restores_objects_users_rows_and_missing_defaults() {
|
||||||
|
use std::process::{Child, Command, Stdio};
|
||||||
|
use std::os::windows::process::CommandExt;
|
||||||
|
struct Server(Child);
|
||||||
|
impl Drop for Server { fn drop(&mut self) { let _ = self.0.kill(); let _ = self.0.wait(); } }
|
||||||
|
let bin = PathBuf::from(std::env::var("COA_MYSQL_TEST_BIN").unwrap());
|
||||||
|
let temp = tempfile::tempdir().unwrap();
|
||||||
|
let root = temp.path().join("server");
|
||||||
|
let meta = temp.path().join("metadata");
|
||||||
|
let point = temp.path().join("point");
|
||||||
|
copy_verified(&bin, &root.join("mysql/bin"), &inventory(&bin).unwrap()).unwrap();
|
||||||
|
let data = root.join("mysql/data");
|
||||||
|
let executable = root.join("mysql/bin/mysqld.exe");
|
||||||
|
let initialized = Command::new(&executable).args(["--no-defaults", "--initialize-insecure"])
|
||||||
|
.arg(format!("--datadir={}", data.display())).creation_flags(0x0800_0000).output().unwrap();
|
||||||
|
assert!(initialized.status.success(), "{}", String::from_utf8_lossy(&initialized.stderr));
|
||||||
|
let port = crate::install::free_port().unwrap();
|
||||||
|
fsx::atomic_write_json(&root.join("Settings/repack.json"), &serde_json::json!({"mysqlPort":port})).unwrap();
|
||||||
|
fsx::atomic_write_json(&root.join("Settings/database.json"), &serde_json::json!({"rootPassword":"","appPassword":""})).unwrap();
|
||||||
|
let db = crate::db::Db::from_repack(&root, crate::db::Account::Admin).unwrap();
|
||||||
|
let start = || {
|
||||||
|
let server = Server(Command::new(&executable).args(["--no-defaults", "--bind-address=127.0.0.1", "--mysqlx=0", "--skip-log-bin"])
|
||||||
|
.arg(format!("--datadir={}", data.display())).arg(format!("--port={port}"))
|
||||||
|
.arg(format!("--log-error={}", root.join("mysql-test.log").display()))
|
||||||
|
.stdout(Stdio::null()).stderr(Stdio::null()).creation_flags(0x0800_0000).spawn().unwrap());
|
||||||
|
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(60);
|
||||||
|
while !db.ping() { assert!(std::time::Instant::now() < deadline, "{}", fs::read_to_string(root.join("mysql-test.log")).unwrap_or_default()); std::thread::sleep(std::time::Duration::from_millis(200)); }
|
||||||
|
server
|
||||||
|
};
|
||||||
|
let mut server = start();
|
||||||
|
db.query("CREATE DATABASE acore_characters; CREATE DATABASE acore_world; CREATE DATABASE acore_auth; CREATE TABLE acore_characters.probe(id INT PRIMARY KEY, note VARCHAR(40)); CREATE TABLE acore_world.probe(id INT NOT NULL DEFAULT 0); INSERT INTO acore_world.probe VALUES(43); CREATE TABLE acore_auth.probe(id INT); INSERT INTO acore_auth.probe VALUES(44); CREATE USER 'fixture_user'@'localhost' IDENTIFIED BY 'fixture'; CREATE TRIGGER acore_characters.probe_insert BEFORE INSERT ON acore_characters.probe FOR EACH ROW SET NEW.note='triggered'; INSERT INTO acore_characters.probe VALUES(42,'original'); CREATE VIEW acore_characters.probe_view AS SELECT c.id,w.id AS world_id FROM acore_characters.probe c CROSS JOIN acore_world.probe w; CREATE PROCEDURE acore_characters.probe_proc() SELECT id FROM acore_characters.probe; CREATE FUNCTION acore_characters.probe_func() RETURNS INT DETERMINISTIC RETURN 73;").unwrap();
|
||||||
|
assert_eq!(db.recovery_objects("acore_characters").unwrap().len(), 4);
|
||||||
|
crate::schema_check::capture(&db, &root).unwrap();
|
||||||
|
let hash = fsx::sha256_file(&root.join(crate::schema_check::CONTRACT)).unwrap();
|
||||||
|
db.query("ALTER TABLE acore_world.probe ALTER COLUMN id DROP DEFAULT;").unwrap();
|
||||||
|
crate::schema_check::repair_missing_defaults(&db, &root, Some(&hash)).unwrap();
|
||||||
|
assert_eq!(db.query("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='acore_world' AND TABLE_NAME='probe' AND COLUMN_NAME='id';").unwrap(), "0");
|
||||||
|
assert_eq!(db.query("SELECT id FROM acore_world.probe;").unwrap(), "43");
|
||||||
|
db.query("ALTER TABLE acore_world.probe ALTER COLUMN id SET DEFAULT 99;").unwrap();
|
||||||
|
crate::schema_check::repair_missing_defaults(&db, &root, Some(&hash)).unwrap();
|
||||||
|
assert_eq!(db.query("SELECT COLUMN_DEFAULT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='acore_world' AND TABLE_NAME='probe' AND COLUMN_NAME='id';").unwrap(), "99");
|
||||||
|
db.query("SHUTDOWN;").unwrap(); server.0.wait().unwrap();
|
||||||
|
let files = inventory(&data).unwrap();
|
||||||
|
copy_verified(&data, &point.join("mysql-data"), &files).unwrap();
|
||||||
|
let expanded_bytes = files.keys().map(|name| fs::metadata(data.join(name)).unwrap().len()).sum();
|
||||||
|
let mut snapshot = Snapshot {path:"mysql-data".into(), files, directories:directories(&data).unwrap(), server_sha256:fsx::sha256_file(&executable).unwrap(), bytes:0, expanded_bytes, archive_sha256:None};
|
||||||
|
for directory in &snapshot.directories { fs::create_dir_all(point.join("mysql-data").join(directory)).unwrap(); }
|
||||||
|
compress(&data, &point, &mut snapshot).unwrap();
|
||||||
|
let mut changed = start();
|
||||||
|
db.query("DROP VIEW acore_characters.probe_view; DROP TRIGGER acore_characters.probe_insert; DROP PROCEDURE acore_characters.probe_proc; DROP FUNCTION acore_characters.probe_func; DELETE FROM acore_characters.probe; DROP USER 'fixture_user'@'localhost';").unwrap();
|
||||||
|
db.query("SHUTDOWN;").unwrap(); changed.0.wait().unwrap();
|
||||||
|
swap(&root, &meta, &point, &snapshot, false).unwrap();
|
||||||
|
let mut restored = start();
|
||||||
|
assert_eq!(db.recovery_objects("acore_characters").unwrap().len(), 4);
|
||||||
|
assert_eq!(db.query("SELECT * FROM acore_characters.probe_view; CALL acore_characters.probe_proc(); SELECT acore_characters.probe_func(); SELECT COUNT(*) FROM mysql.user WHERE user='fixture_user';").unwrap().replace("\r\n", "\n"), "42\t43\n42\n73\n1");
|
||||||
|
db.query("INSERT INTO acore_characters.probe VALUES(45,'check');").unwrap();
|
||||||
|
assert_eq!(db.query("SELECT note FROM acore_characters.probe WHERE id=45;").unwrap(), "triggered");
|
||||||
|
db.query("SHUTDOWN;").unwrap(); restored.0.wait().unwrap();
|
||||||
|
}
|
||||||
|
fn fixture() -> (tempfile::TempDir, PathBuf, PathBuf, PathBuf, Snapshot) {
|
||||||
|
let temp = tempfile::tempdir().unwrap();
|
||||||
|
let root = temp.path().join("server");
|
||||||
|
let meta = temp.path().join("metadata");
|
||||||
|
let point = temp.path().join("point");
|
||||||
|
fsx::atomic_write(&root.join("mysql/bin/mysqld.exe"), b"same-engine").unwrap();
|
||||||
|
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"live").unwrap();
|
||||||
|
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"saved").unwrap();
|
||||||
|
fs::create_dir_all(point.join("mysql-data/empty_schema")).unwrap();
|
||||||
|
let snapshot = Snapshot { path:"mysql-data".into(), files:inventory(&point.join("mysql-data")).unwrap(), directories:directories(&point.join("mysql-data")).unwrap(), server_sha256:fsx::sha256_file(&root.join("mysql/bin/mysqld.exe")).unwrap(), bytes:5, expanded_bytes:5, archive_sha256:None };
|
||||||
|
(temp, root, meta, point, snapshot)
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn interrupted_directory_swap_is_recoverable_and_keeps_previous_bytes() {
|
||||||
|
let (_temp, root, meta, point, snapshot) = fixture();
|
||||||
|
assert!(swap(&root, &meta, &point, &snapshot, true).is_err());
|
||||||
|
assert!(!root.join("mysql/data").exists());
|
||||||
|
let old = fs::read_dir(root.join("mysql")).unwrap().flatten().find(|e| e.file_name().to_string_lossy().starts_with("data-before-")).unwrap().path();
|
||||||
|
assert_eq!(fs::read(old.join("characters.ibd")).unwrap(), b"live");
|
||||||
|
swap(&root, &meta, &point, &snapshot, false).unwrap();
|
||||||
|
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"saved");
|
||||||
|
assert!(root.join("mysql/data/empty_schema").is_dir());
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn corrupt_or_different_engine_snapshots_do_not_move_live_data() {
|
||||||
|
let (_temp, root, meta, point, snapshot) = fixture();
|
||||||
|
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"corrupt").unwrap();
|
||||||
|
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
|
||||||
|
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"live");
|
||||||
|
fsx::atomic_write(&point.join("mysql-data/characters.ibd"), b"saved").unwrap();
|
||||||
|
fsx::atomic_write(&root.join("mysql/bin/mysqld.exe"), b"new-engine").unwrap();
|
||||||
|
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
|
||||||
|
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"live");
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn compressed_snapshots_verify_every_file_and_reject_unlisted_entries() {
|
||||||
|
let (_temp, root, meta, point, mut snapshot) = fixture();
|
||||||
|
let source = point.join("mysql-data");
|
||||||
|
compress(&source, &point, &mut snapshot).unwrap();
|
||||||
|
assert!(snapshot.archive_sha256.is_some());
|
||||||
|
swap(&root, &meta, &point, &snapshot, false).unwrap();
|
||||||
|
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"saved");
|
||||||
|
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"preserve").unwrap();
|
||||||
|
let archive_path = point.join(&snapshot.path);
|
||||||
|
let encoder = zstd::Encoder::new(fs::File::create(&archive_path).unwrap(), 3).unwrap();
|
||||||
|
let mut archive = tar::Builder::new(encoder);
|
||||||
|
archive.append_file("unlisted.ibd", &mut fs::File::open(source.join("characters.ibd")).unwrap()).unwrap();
|
||||||
|
archive.into_inner().unwrap().finish().unwrap();
|
||||||
|
snapshot.archive_sha256 = Some(fsx::sha256_file(&archive_path).unwrap());
|
||||||
|
assert!(swap(&root, &meta, &point, &snapshot, false).is_err());
|
||||||
|
assert_eq!(fs::read(root.join("mysql/data/characters.ibd")).unwrap(), b"preserve");
|
||||||
|
fsx::atomic_write(&archive_path, b"damaged").unwrap();
|
||||||
|
assert!(verify(&point, &snapshot).is_err());
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn private_rehearsals_reject_external_database_connections() {
|
||||||
|
let (_temp, root, _meta, _point, _snapshot) = fixture();
|
||||||
|
fsx::atomic_write_json(&root.join("Settings/repack.json"), &serde_json::json!({"mysqlPort":3307})).unwrap();
|
||||||
|
fsx::atomic_write_json(&root.join("Settings/database.json"), &serde_json::json!({"rootPassword":"test-root","appPassword":"test-app"})).unwrap();
|
||||||
|
fsx::atomic_write(&root.join("Settings/worldserver.conf.template"), b"LoginDatabaseInfo = \"@LoginDatabaseInfo@\"\nWorldDatabaseInfo = \"@WorldDatabaseInfo@\"\nCharacterDatabaseInfo = \"@CharacterDatabaseInfo@\"\n").unwrap();
|
||||||
|
fsx::atomic_write(&root.join("Settings/authserver.conf.template"), b"LoginDatabaseInfo = \"127.0.0.1;3307;acore;test-app;acore_auth\"\n").unwrap();
|
||||||
|
validate_connections(&root, &root).unwrap();
|
||||||
|
fsx::atomic_write(&root.join("Settings/authserver.conf.template"), b"LoginDatabaseInfo = \"192.0.2.1;3307;acore;test-app;acore_auth\"\n").unwrap();
|
||||||
|
let error = validate_connections(&root, &root).unwrap_err().to_string();
|
||||||
|
assert!(error.contains("external database"));
|
||||||
|
assert!(!error.contains("test-app"));
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
fn a_changed_live_database_invalidates_the_rehearsal() {
|
||||||
|
let (_temp, root, _meta, _point, snapshot) = fixture();
|
||||||
|
assert!(unchanged(&root, &snapshot).is_err());
|
||||||
|
fsx::atomic_write(&root.join("mysql/data/characters.ibd"), b"saved").unwrap();
|
||||||
|
fs::create_dir_all(root.join("mysql/data/empty_schema")).unwrap();
|
||||||
|
unchanged(&root, &snapshot).unwrap();
|
||||||
|
fsx::atomic_write(&root.join("mysql/data/extra.ibd"), b"new data").unwrap();
|
||||||
|
assert!(unchanged(&root, &snapshot).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn rehearsal_copy_succeeds_with_nested_directories_and_unnormalized_root() {
|
||||||
|
let (_temp, root, meta, point, snapshot) = fixture();
|
||||||
|
let meta_obj = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, &root);
|
||||||
|
fsx::atomic_write_json(&meta.join("install.json"), &meta_obj).unwrap();
|
||||||
|
fsx::atomic_write(&root.join("Core/worldserver.exe"), b"exe").unwrap();
|
||||||
|
fsx::atomic_write(&root.join("Core/configs/worldserver.conf"), b"conf").unwrap();
|
||||||
|
fsx::atomic_write(&root.join("Settings/repack.json"), b"{}").unwrap();
|
||||||
|
let dest = rehearsal_copy(&root, &meta, &point, &snapshot).unwrap();
|
||||||
|
assert_eq!(fs::read(dest.join("Core/configs/worldserver.conf")).unwrap(), b"conf");
|
||||||
|
assert_eq!(fs::read(dest.join("mysql/data/characters.ibd")).unwrap(), b"saved");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -217,6 +217,7 @@ pub fn build(src: &Path, out: &Path, opts: &BuildOptions, progress: &dyn Fn(&str
|
|||||||
split.close_current()?;
|
split.close_current()?;
|
||||||
|
|
||||||
let manifest = Manifest {
|
let manifest = Manifest {
|
||||||
|
compatibility: None,
|
||||||
schema: crate::manifest::SCHEMA,
|
schema: crate::manifest::SCHEMA,
|
||||||
kind: opts.kind,
|
kind: opts.kind,
|
||||||
version: opts.version.clone(),
|
version: opts.version.clone(),
|
||||||
@@ -503,6 +504,7 @@ mod tests {
|
|||||||
fs::write(d.path().join(name), &bytes).unwrap();
|
fs::write(d.path().join(name), &bytes).unwrap();
|
||||||
let ok_sha = fsx::sha256_bytes(b"data");
|
let ok_sha = fsx::sha256_bytes(b"data");
|
||||||
let m = Manifest {
|
let m = Manifest {
|
||||||
|
compatibility: None,
|
||||||
schema: 1,
|
schema: 1,
|
||||||
kind: Kind::Base,
|
kind: Kind::Base,
|
||||||
version: "0.1.0".into(),
|
version: "0.1.0".into(),
|
||||||
|
|||||||
@@ -0,0 +1,41 @@
|
|||||||
|
//! Which kind of server a new installation is on this computer. This is the one place where the host decides: a Windows
|
||||||
|
//! computer installs a repack, anything else installs a Docker server. The screens and the commands ask here and then
|
||||||
|
//! call the code of that kind, so no platform check is scattered through shared code.
|
||||||
|
|
||||||
|
use serde::Serialize;
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
|
||||||
|
#[serde(rename_all = "kebab-case")]
|
||||||
|
pub enum Flavor {
|
||||||
|
/// The CoA Repack: Windows executables supervised by the repack's launcher.
|
||||||
|
Repack,
|
||||||
|
/// MySQL, the auth server and the world server in Docker containers.
|
||||||
|
Docker,
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn flavor() -> Flavor {
|
||||||
|
if cfg!(windows) {
|
||||||
|
Flavor::Repack
|
||||||
|
} else {
|
||||||
|
Flavor::Docker
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_host_decides_once() {
|
||||||
|
#[cfg(windows)]
|
||||||
|
assert_eq!(flavor(), Flavor::Repack);
|
||||||
|
#[cfg(not(windows))]
|
||||||
|
assert_eq!(flavor(), Flavor::Docker);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_screens_read_the_flavor_as_a_plain_word() {
|
||||||
|
assert_eq!(serde_json::to_string(&Flavor::Repack).unwrap(), "\"repack\"");
|
||||||
|
assert_eq!(serde_json::to_string(&Flavor::Docker).unwrap(), "\"docker\"");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -278,12 +278,24 @@ fn uptime_secs(p: &ProcessIdentity) -> Option<u64> {
|
|||||||
(now >= p.created).then(|| (now - p.created) / 10_000_000)
|
(now >= p.created).then(|| (now - p.created) / 10_000_000)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The world server of the `coa-bots` repack folder lives inside the server folder and is started by its own
|
||||||
|
/// launcher (`coa-bots\Core\worldserver.exe`). It serves the same realm, so it counts as this server's world.
|
||||||
|
fn world_alternatives(root: &Path) -> Vec<PathBuf> {
|
||||||
|
vec![root.join("coa-bots").join("Core").join("worldserver.exe")]
|
||||||
|
}
|
||||||
|
|
||||||
fn service(root: &Path, name: &'static str, exe: PathBuf, port: u16, listen: &[(u16, u32)]) -> ServiceStatus {
|
fn service(root: &Path, name: &'static str, exe: PathBuf, port: u16, listen: &[(u16, u32)]) -> ServiceStatus {
|
||||||
|
service_with(root, name, exe, &[], port, listen)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn service_with(root: &Path, name: &'static str, exe: PathBuf, alternatives: &[PathBuf], port: u16, listen: &[(u16, u32)]) -> ServiceStatus {
|
||||||
// Prefer the repack's own record when it still matches a live process; otherwise discover by exact exe path.
|
// Prefer the repack's own record when it still matches a live process; otherwise discover by exact exe path.
|
||||||
|
let norm = |p: &Path| p.to_string_lossy().replace('/', "\\");
|
||||||
|
let expected: Vec<String> = std::iter::once(&exe).chain(alternatives).map(|p| norm(p)).collect();
|
||||||
let proc = read_state_record(root, name)
|
let proc = read_state_record(root, name)
|
||||||
.filter(is_alive)
|
.filter(is_alive)
|
||||||
.filter(|r| r.exe.eq_ignore_ascii_case(&exe.to_string_lossy().replace('/', "\\")))
|
.filter(|r| expected.iter().any(|e| r.exe.eq_ignore_ascii_case(e)))
|
||||||
.or_else(|| find_by_exe(&exe).into_iter().next());
|
.or_else(|| std::iter::once(&exe).chain(alternatives).find_map(|p| find_by_exe(p).into_iter().next()));
|
||||||
|
|
||||||
let owner = listen.iter().find(|(p, _)| *p == port).map(|(_, pid)| *pid);
|
let owner = listen.iter().find(|(p, _)| *p == port).map(|(_, pid)| *pid);
|
||||||
let (state, port_ready, conflict) = match (&proc, owner) {
|
let (state, port_ready, conflict) = match (&proc, owner) {
|
||||||
@@ -319,7 +331,7 @@ pub fn observe(root: &Path, ports: &Ports) -> Observed {
|
|||||||
Observed {
|
Observed {
|
||||||
mysql: service(root, "mysql", mysql, ports.mysql, &listen),
|
mysql: service(root, "mysql", mysql, ports.mysql, &listen),
|
||||||
auth: service(root, "auth", auth, ports.auth, &listen),
|
auth: service(root, "auth", auth, ports.auth, &listen),
|
||||||
world: service(root, "world", world, ports.world, &listen),
|
world: service_with(root, "world", world, &world_alternatives(root), ports.world, &listen),
|
||||||
secondary_world,
|
secondary_world,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -65,10 +65,16 @@ pub fn state(root: &Path) -> Result<RealmState> {
|
|||||||
fsx::read_json(&root.join(STATE))
|
fsx::read_json(&root.join(STATE))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// The world server executable of this folder: `worldserver.exe` in a repack, `worldserver` in a Docker server.
|
||||||
|
fn world_binary(root: &Path) -> std::path::PathBuf {
|
||||||
|
let exe = root.join("Core/worldserver.exe");
|
||||||
|
if exe.exists() { exe } else { root.join("Core/worldserver") }
|
||||||
|
}
|
||||||
|
|
||||||
pub fn view(root: &Path) -> Result<View> {
|
pub fn view(root: &Path) -> Result<View> {
|
||||||
let s = state(root)?;
|
let s = state(root)?;
|
||||||
// Inspect the binary itself; templates or an old log cannot prove installed support.
|
// Inspect the binary itself; templates or an old log cannot prove installed support.
|
||||||
let supported = fs::read(root.join("Core/worldserver.exe"))?
|
let supported = fs::read(world_binary(root))?
|
||||||
.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings");
|
.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings");
|
||||||
Ok(View { active: s.active, wildcard_created: s.wildcard_created, supported, recovery_pending: root.join(JOURNAL).exists(), simultaneous: s.simultaneous, secondary_world_port: s.secondary_world_port, secondary_running: crate::multiworld::is_running(root) })
|
Ok(View { active: s.active, wildcard_created: s.wildcard_created, supported, recovery_pending: root.join(JOURNAL).exists(), simultaneous: s.simultaneous, secondary_world_port: s.secondary_world_port, secondary_running: crate::multiworld::is_running(root) })
|
||||||
}
|
}
|
||||||
@@ -269,6 +275,8 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
|
|||||||
|
|
||||||
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
|
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
|
||||||
pub fn prepare_launcher(root: &Path) -> Result<()> {
|
pub fn prepare_launcher(root: &Path) -> Result<()> {
|
||||||
|
// A Docker server has no launcher to adapt: the Docker backend reads the active realm itself.
|
||||||
|
if crate::docker::is_docker(root) { return Ok(()); }
|
||||||
let path = root.join("Scripts/manage.py");
|
let path = root.join("Scripts/manage.py");
|
||||||
let source = fs::read_to_string(&path)?;
|
let source = fs::read_to_string(&path)?;
|
||||||
let patched = patch_launcher(&source)?;
|
let patched = patch_launcher(&source)?;
|
||||||
@@ -353,6 +361,31 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
|
|||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
fs::create_dir_all(d.path().join("Core")).unwrap();
|
||||||
|
fs::create_dir_all(d.path().join("Settings")).unwrap();
|
||||||
|
fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
|
||||||
|
fs::write(d.path().join("Core/worldserver"), b"ELF...Wildcard synergy settings...").unwrap();
|
||||||
|
assert!(view(d.path()).unwrap().supported, "worldserver without .exe is read too");
|
||||||
|
fs::write(d.path().join("Core/worldserver"), b"ELF...an older build").unwrap();
|
||||||
|
assert!(!view(d.path()).unwrap().supported);
|
||||||
|
// The repack's executable still wins when both exist, so a repack is read as before.
|
||||||
|
fs::write(d.path().join("Core/worldserver.exe"), b"MZ...Wildcard synergy settings").unwrap();
|
||||||
|
assert!(view(d.path()).unwrap().supported);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_docker_server_has_no_launcher_to_adapt() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
fs::create_dir_all(d.path().join("Settings")).unwrap();
|
||||||
|
// No Scripts/manage.py anywhere: on a repack this fails, on a Docker server there is nothing to do.
|
||||||
|
assert!(prepare_launcher(d.path()).is_err());
|
||||||
|
fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
|
||||||
|
prepare_launcher(d.path()).unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
|
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
|
||||||
let mut f = Files::new();
|
let mut f = Files::new();
|
||||||
|
|||||||
@@ -44,8 +44,17 @@ fn introduction_rank(repo: &Path, pathspecs: &[&str]) -> std::collections::HashM
|
|||||||
rank
|
rank
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Every SQL script of a core checkout (released + pending updates, module base and update scripts), in application order.
|
/// Incremental SQL of a core checkout. Installation-only module bases must never be replayed on a live database.
|
||||||
pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
|
pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
|
||||||
|
collect_core_sql_mode(core, false)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A clean installation also needs the module tables and initial seed data.
|
||||||
|
pub fn collect_core_install_sql(core: &Path) -> Result<Vec<SqlFile>> {
|
||||||
|
collect_core_sql_mode(core, true)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn collect_core_sql_mode(core: &Path, include_base: bool) -> Result<Vec<SqlFile>> {
|
||||||
let mut out = Vec::new();
|
let mut out = Vec::new();
|
||||||
let mut push = |db: &str, id: String, abs: PathBuf, origin: String| -> Result<()> {
|
let mut push = |db: &str, id: String, abs: PathBuf, origin: String| -> Result<()> {
|
||||||
let sha256 = fsx::sha256_file(&abs)?;
|
let sha256 = fsx::sha256_file(&abs)?;
|
||||||
@@ -69,7 +78,7 @@ pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
|
|||||||
let mname = name.replace('-', "_");
|
let mname = name.replace('-', "_");
|
||||||
for kind in ["auth", "characters", "world"] {
|
for kind in ["auth", "characters", "world"] {
|
||||||
let base = m.path().join(format!("data/sql/db-{kind}"));
|
let base = m.path().join(format!("data/sql/db-{kind}"));
|
||||||
for f in sql_in(&base.join("base")) {
|
for f in if include_base { sql_in(&base.join("base")) } else { vec![] } {
|
||||||
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
let stem = f.file_stem().unwrap().to_string_lossy().into_owned();
|
||||||
let rel = format!("modules/{name}/data/sql/db-{kind}/base/{}", f.file_name().unwrap().to_string_lossy());
|
let rel = format!("modules/{name}/data/sql/db-{kind}/base/{}", f.file_name().unwrap().to_string_lossy());
|
||||||
push(kind, format!("mod_{mname}__base__{stem}"), f, rel)?;
|
push(kind, format!("mod_{mname}__base__{stem}"), f, rel)?;
|
||||||
@@ -144,6 +153,9 @@ fn walk(root: &Path, dir: &Path, out: &mut Vec<String>) -> Result<()> {
|
|||||||
|
|
||||||
/// Build a cumulative update: every file of `tree` that differs from the base, plus every SQL script. Unsigned.
|
/// Build a cumulative update: every file of `tree` that differs from the base, plus every SQL script. Unsigned.
|
||||||
pub fn pack_update(p: &UpdateParams, progress: &dyn Fn(&str)) -> Result<Manifest> {
|
pub fn pack_update(p: &UpdateParams, progress: &dyn Fn(&str)) -> Result<Manifest> {
|
||||||
|
if let Some(file) = p.sql.iter().find(|file| file.id.starts_with("mod_") && file.id.contains("__base__")) {
|
||||||
|
return Err(Error::Invalid(format!("Module installation SQL {} cannot be included in an update package.", file.id)));
|
||||||
|
}
|
||||||
let base: BTreeMap<String, &str> = p.base_manifest.files.iter().map(|f| (f.path.to_lowercase(), f.sha256.as_str())).collect();
|
let base: BTreeMap<String, &str> = p.base_manifest.files.iter().map(|f| (f.path.to_lowercase(), f.sha256.as_str())).collect();
|
||||||
let work = p.out.with_file_name(format!("{}-staging", p.out.file_name().unwrap().to_string_lossy()));
|
let work = p.out.with_file_name(format!("{}-staging", p.out.file_name().unwrap().to_string_lossy()));
|
||||||
let _ = fs::remove_dir_all(&work);
|
let _ = fs::remove_dir_all(&work);
|
||||||
@@ -218,7 +230,7 @@ mod tests {
|
|||||||
write(c, "data/sql/updates/db_characters/2026_01_02_00.sql", "SELECT 3;");
|
write(c, "data/sql/updates/db_characters/2026_01_02_00.sql", "SELECT 3;");
|
||||||
write(c, "modules/mod-x/data/sql/db-world/base/01_a.sql", "SELECT 4;");
|
write(c, "modules/mod-x/data/sql/db-world/base/01_a.sql", "SELECT 4;");
|
||||||
write(c, "modules/mod-x/data/sql/db-world/2026_02_02_00_b.sql", "SELECT 5;");
|
write(c, "modules/mod-x/data/sql/db-world/2026_02_02_00_b.sql", "SELECT 5;");
|
||||||
let v = collect_core_sql(c).unwrap();
|
let v = collect_core_install_sql(c).unwrap();
|
||||||
let ids: Vec<(&str, &str)> = v.iter().map(|f| (f.db.as_str(), f.id.as_str())).collect();
|
let ids: Vec<(&str, &str)> = v.iter().map(|f| (f.db.as_str(), f.id.as_str())).collect();
|
||||||
assert!(ids.contains(&("world", "2026_01_01_00")) && ids.contains(&("world", "rev_1")) && ids.contains(&("characters", "2026_01_02_00")));
|
assert!(ids.contains(&("world", "2026_01_01_00")) && ids.contains(&("world", "rev_1")) && ids.contains(&("characters", "2026_01_02_00")));
|
||||||
assert!(ids.contains(&("world", "mod_mod_x__base__01_a")) && ids.contains(&("world", "mod_mod_x__2026_02_02_00_b")));
|
assert!(ids.contains(&("world", "mod_mod_x__base__01_a")) && ids.contains(&("world", "mod_mod_x__2026_02_02_00_b")));
|
||||||
@@ -226,6 +238,27 @@ mod tests {
|
|||||||
let base_pos = ids.iter().position(|x| x.1 == "mod_mod_x__base__01_a").unwrap();
|
let base_pos = ids.iter().position(|x| x.1 == "mod_mod_x__base__01_a").unwrap();
|
||||||
let upd_pos = ids.iter().position(|x| x.1 == "mod_mod_x__2026_02_02_00_b").unwrap();
|
let upd_pos = ids.iter().position(|x| x.1 == "mod_mod_x__2026_02_02_00_b").unwrap();
|
||||||
assert!(base_pos < upd_pos, "a module's base script precedes its updates");
|
assert!(base_pos < upd_pos, "a module's base script precedes its updates");
|
||||||
|
let updates = collect_core_sql(c).unwrap();
|
||||||
|
assert!(!updates.iter().any(|f| f.id.contains("__base__")));
|
||||||
|
assert!(updates.iter().any(|f| f.id == "mod_mod_x__2026_02_02_00_b"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn update_packaging_rejects_module_seed_sql_before_creating_output() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let base: Manifest = serde_json::from_value(serde_json::json!({
|
||||||
|
"schema": 1, "kind": "base", "version": "1.0.0", "core": {"commit": null},
|
||||||
|
"builtAt": "test", "minManagerVersion": "0.1.0", "files": []
|
||||||
|
})).unwrap();
|
||||||
|
let out = d.path().join("out");
|
||||||
|
let sql = vec![SqlFile { db: "world".into(), id: "mod_mod_raid__base__03_boss_schedule".into(),
|
||||||
|
origin: "modules/mod-raid/data/sql/db-world/base/03_boss_schedule.sql".into(),
|
||||||
|
abs: d.path().join("seed.sql"), sha256: "a".repeat(64) }];
|
||||||
|
let result = pack_update(&UpdateParams { tree: d.path(), base_manifest: &base, sql: &sql,
|
||||||
|
out: &out, version: "1.1.0".into(), core_commit: None, bots_commit: None, part_size: 1024 }, &|_| {});
|
||||||
|
assert!(result.unwrap_err().to_string().contains("installation SQL"));
|
||||||
|
assert!(!out.exists());
|
||||||
|
assert!(!d.path().join("out-staging").exists());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
|||||||
@@ -5,6 +5,90 @@ use crate::{backup, fsx, install, manifest::{Kind, Migration}, migrations, packa
|
|||||||
|
|
||||||
const MARKER: &str = ".release-schema-fixture";
|
const MARKER: &str = ".release-schema-fixture";
|
||||||
|
|
||||||
|
struct QualificationEnv<'a>(crate::update::RepackEnv<'a>);
|
||||||
|
|
||||||
|
impl crate::update::Env for QualificationEnv<'_> {
|
||||||
|
fn activate(&self) -> Result<()> { Ok(()) }
|
||||||
|
fn ensure_stopped(&self) -> Result<()> { self.0.ensure_stopped() }
|
||||||
|
fn preflight(&self, manifest: &crate::manifest::Manifest) -> Result<()> { self.0.preflight(manifest) }
|
||||||
|
fn snapshot(&self) -> Result<String> { self.0.snapshot() }
|
||||||
|
fn verify_snapshot(&self, id: &str) -> Result<()> { self.0.verify_snapshot(id) }
|
||||||
|
fn rehearse(&self, manifest: &crate::manifest::Manifest, tree: &Path, items: &[crate::update::PlanItem], point: &str) -> Result<()> { self.0.rehearse(manifest, tree, items, point) }
|
||||||
|
fn restore_snapshot(&self, id: &str) -> Result<()> { self.0.restore_snapshot(id) }
|
||||||
|
fn migrate(&self, manifest: &crate::manifest::Manifest, staged: &Path) -> Result<crate::migrations::ApplyReport> { self.0.migrate(manifest, staged) }
|
||||||
|
fn validate(&self) -> Result<()> { self.0.validate() }
|
||||||
|
fn validate_recovery(&self) -> Result<()> { self.0.validate_recovery() }
|
||||||
|
fn recover_validation(&self) -> Result<()> { self.0.recover_validation() }
|
||||||
|
fn automatic_rollback(&self) -> bool { true }
|
||||||
|
// Health checks use the normal private validation; qualification never opens game ports after commit.
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn qualify_upgrade(base: &Path, source: &Path, candidate: &Path, fixture: &Path, trusted_key: &str) -> Result<serde_json::Value> {
|
||||||
|
use crate::update::Env;
|
||||||
|
if !cfg!(windows) { return Err(Error::Invalid("Manager upgrade qualification requires a Windows fixture.".into())); }
|
||||||
|
if fixture.exists() || !fixture.file_name().is_some_and(|name| name.to_string_lossy().starts_with("coa-schema-fixture-")) {
|
||||||
|
return Err(Error::Invalid("Upgrade qualification requires a new disposable coa-schema-fixture-* directory.".into()));
|
||||||
|
}
|
||||||
|
let fixture_root = std::path::absolute(fixture)?;
|
||||||
|
let fixture = fixture_root.as_path();
|
||||||
|
let base_root = fsx::canonicalize_lenient(base)?;
|
||||||
|
let base = base_root.as_path();
|
||||||
|
let source_root = fsx::canonicalize_lenient(source)?;
|
||||||
|
let source = source_root.as_path();
|
||||||
|
let candidate_root = fsx::canonicalize_lenient(candidate)?;
|
||||||
|
let candidate = candidate_root.as_path();
|
||||||
|
let metadata = crate::registry::metadata_dir_for(fixture)?;
|
||||||
|
if metadata.exists() { return Err(Error::Invalid("Upgrade fixture metadata already exists.".into())); }
|
||||||
|
let (base_manifest, base_bytes) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(base.into()), trusted_key)?;
|
||||||
|
let (source_manifest, source_bytes) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(source.into()), trusted_key)?;
|
||||||
|
let (candidate_manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(candidate.into()), trusted_key)?;
|
||||||
|
if candidate_manifest.kind != Kind::Update || !matches!(source_manifest.kind, Kind::Base | Kind::Update)
|
||||||
|
|| (source_manifest.kind == Kind::Base && fsx::sha256_bytes(&base_bytes) != fsx::sha256_bytes(&source_bytes)) {
|
||||||
|
return Err(Error::Invalid("Invalid source or candidate package for upgrade qualification.".into()));
|
||||||
|
}
|
||||||
|
extract_base(base, fixture, trusted_key)?;
|
||||||
|
package::extract_selected(base, &base_manifest, fixture, &|path| path.starts_with("Data/"), &|_, _| {})?;
|
||||||
|
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, fixture);
|
||||||
|
meta.core.version = Some(base_manifest.version.clone());
|
||||||
|
meta.core.commit = base_manifest.core.commit.clone();
|
||||||
|
meta.original_hashes = base_manifest.files.iter().map(|file| (file.path.clone(), file.sha256.clone())).collect();
|
||||||
|
crate::registry::MetaDir::create(fixture, &meta)?;
|
||||||
|
let env = QualificationEnv(crate::update::RepackEnv { root: fixture, meta_dir: &metadata });
|
||||||
|
let apply = |package: &Path| -> Result<()> {
|
||||||
|
let outcome = crate::update::apply(&crate::update::Params {
|
||||||
|
root: fixture, meta_dir: &metadata, source: pkgsource::Source::Dir(package.into()),
|
||||||
|
trusted_key, cancel: crate::download::Cancel::default(), resolutions: Default::default(),
|
||||||
|
env: &env, fail_after_ops: None,
|
||||||
|
}, &|_, _| {})?;
|
||||||
|
if outcome.txn.state != crate::update::State::Committed {
|
||||||
|
return Err(Error::Invalid("Upgrade qualification did not commit.".into()));
|
||||||
|
}
|
||||||
|
env.ensure_stopped()
|
||||||
|
};
|
||||||
|
install::with_scratch_ports(fixture, || {
|
||||||
|
if source_manifest.kind == Kind::Update { apply(source)?; }
|
||||||
|
let user_file = fixture.join("Core/configs/coa-qualification-user.conf");
|
||||||
|
let user_bytes = b"Qualification.UserSetting = 7391\r\n";
|
||||||
|
fsx::atomic_write(&user_file, user_bytes)?;
|
||||||
|
apply(candidate)?;
|
||||||
|
if std::fs::read(&user_file)?.as_slice() != user_bytes {
|
||||||
|
return Err(Error::Invalid("The update changed a user configuration file.".into()));
|
||||||
|
}
|
||||||
|
let (_, installed) = crate::registry::MetaDir::open(&metadata)?;
|
||||||
|
if installed.core.version.as_deref() != Some(candidate_manifest.version.as_str())
|
||||||
|
|| crate::update_isolation::pending(&metadata) || crate::update::pending_checked(&metadata)?.is_some() {
|
||||||
|
return Err(Error::Invalid("The update left inconsistent metadata or an unfinished transaction.".into()));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
Ok(serde_json::json!({
|
||||||
|
"schema": 1, "result": "passed", "fromVersion": source_manifest.version,
|
||||||
|
"toVersion": candidate_manifest.version, "fromManifestSha256": fsx::sha256_bytes(&source_bytes),
|
||||||
|
"fromSchemaSha256": source_manifest.files.iter().find(|file| file.path == schema_check::CONTRACT).map(|file| &file.sha256),
|
||||||
|
"checks": ["manager-transaction", "private-user-database-rehearsal", "database-schema", "private-auth-world-startup", "existing-identities", "user-file-preservation"],
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
|
||||||
pub fn collect(core: &Path, bots: Option<&Path>, repairs: Option<&Path>) -> Result<Vec<SqlFile>> {
|
pub fn collect(core: &Path, bots: Option<&Path>, repairs: Option<&Path>) -> Result<Vec<SqlFile>> {
|
||||||
let mut files = release::collect_core_sql(core)?;
|
let mut files = release::collect_core_sql(core)?;
|
||||||
if let Some(bots) = bots { files.extend(release::collect_bots_sql(bots)?); }
|
if let Some(bots) = bots { files.extend(release::collect_bots_sql(bots)?); }
|
||||||
@@ -38,7 +122,12 @@ pub fn extract_base(source: &Path, fixture: &Path, trusted_key: &str) -> Result<
|
|||||||
["mysql/", "settings/", "runtime/", "scripts/", "core/", "bugreport/"].iter().any(|prefix| path.starts_with(prefix))
|
["mysql/", "settings/", "runtime/", "scripts/", "core/", "bugreport/"].iter().any(|prefix| path.starts_with(prefix))
|
||||||
}, &|_, _| {})?;
|
}, &|_, _| {})?;
|
||||||
fsx::atomic_write(&fixture.join(MARKER), b"disposable release-schema fixture")?;
|
fsx::atomic_write(&fixture.join(MARKER), b"disposable release-schema fixture")?;
|
||||||
install::bootstrap_database(fixture)
|
// A Linux computer has no Windows database program: the fixture is a Docker server over the package's data directory.
|
||||||
|
if cfg!(windows) {
|
||||||
|
install::bootstrap_database(fixture)
|
||||||
|
} else {
|
||||||
|
crate::docker::fixture::prepare(fixture)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<()> {
|
pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<()> {
|
||||||
@@ -67,6 +156,69 @@ pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<(
|
|||||||
}))
|
}))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn validate_startup(fixture: &Path, tree: &Path, base: &Path, trusted_key: &str) -> Result<()> {
|
||||||
|
use crate::update::Env;
|
||||||
|
if !cfg!(windows) {
|
||||||
|
return Err(Error::Invalid("Repack startup qualification requires a Windows runner.".into()));
|
||||||
|
}
|
||||||
|
if !fixture.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-schema-fixture-"))
|
||||||
|
|| std::fs::read(fixture.join(MARKER)).ok().as_deref() != Some(b"disposable release-schema fixture") {
|
||||||
|
return Err(Error::Invalid("Startup qualification requires a disposable release-schema fixture.".into()));
|
||||||
|
}
|
||||||
|
let fixture_root = fsx::canonicalize_lenient(fixture)?;
|
||||||
|
let fixture = fixture_root.as_path();
|
||||||
|
let tree_root = fsx::canonicalize_lenient(tree)?;
|
||||||
|
let tree = tree_root.as_path();
|
||||||
|
let metadata = crate::registry::metadata_dir_for(fixture)?;
|
||||||
|
if metadata.exists() { return Err(Error::Invalid("Startup fixture already has Manager metadata; use a fresh fixture.".into())); }
|
||||||
|
schema_check::require_release_contract(tree)?;
|
||||||
|
for name in ["worldserver.exe", "authserver.exe"] {
|
||||||
|
if !tree.join("Core").join(name).is_file() {
|
||||||
|
return Err(Error::Invalid(format!("Startup candidate is missing {name}.")));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(base.into()), trusted_key)?;
|
||||||
|
if manifest.kind != Kind::Base { return Err(Error::Invalid("Startup qualification requires a signed base package.".into())); }
|
||||||
|
let mut directories = vec![tree.to_path_buf()];
|
||||||
|
let mut files = Vec::new();
|
||||||
|
while let Some(directory) = directories.pop() {
|
||||||
|
for entry in std::fs::read_dir(directory)? {
|
||||||
|
let entry = entry?;
|
||||||
|
let kind = entry.file_type()?;
|
||||||
|
if kind.is_symlink() { return Err(Error::Invalid("Startup release tree must not contain symbolic links.".into())); }
|
||||||
|
let path = entry.path();
|
||||||
|
fsx::ensure_within(tree, &path)?;
|
||||||
|
if kind.is_dir() { directories.push(path); continue; }
|
||||||
|
if !kind.is_file() { return Err(Error::Invalid("Startup release tree contains an unsupported file type.".into())); }
|
||||||
|
let relative = path.strip_prefix(tree).map_err(|e| Error::Invalid(e.to_string()))?.to_path_buf();
|
||||||
|
let first = relative.components().next().unwrap().as_os_str().to_string_lossy();
|
||||||
|
if !matches!(first.as_ref(), "Core" | "Scripts" | "Data" | "Extras" | "Licenses") {
|
||||||
|
return Err(Error::Invalid("Startup release tree contains installation-specific files.".into()));
|
||||||
|
}
|
||||||
|
fsx::ensure_within(fixture, &fixture.join(&relative))?;
|
||||||
|
files.push(relative);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
package::extract_selected(base, &manifest, fixture, &|path| path.starts_with("Data/"), &|_, _| {})?;
|
||||||
|
for relative in files {
|
||||||
|
let target = fsx::ensure_within(fixture, &fixture.join(&relative))?;
|
||||||
|
fsx::atomic_write(&target, &std::fs::read(tree.join(&relative))?)?;
|
||||||
|
let expected = fsx::sha256_file(&tree.join(relative))?;
|
||||||
|
if fsx::sha256_file(&target)? != expected {
|
||||||
|
return Err(Error::Invalid("Startup candidate copy failed verification.".into()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::New, fixture);
|
||||||
|
crate::registry::MetaDir::create(fixture, &meta)?;
|
||||||
|
let env = crate::update::RepackEnv { root: fixture, meta_dir: &metadata };
|
||||||
|
env.validate()?;
|
||||||
|
env.ensure_stopped()?;
|
||||||
|
if crate::update_isolation::pending(&metadata) {
|
||||||
|
return Err(Error::Invalid("Startup qualification left unfinished isolated validation.".into()));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
|
pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
|
||||||
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
|
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
|
||||||
if !manifest.files.iter().any(|f| f.path == schema_check::CONTRACT && f.size > 0) {
|
if !manifest.files.iter().any(|f| f.path == schema_check::CONTRACT && f.size > 0) {
|
||||||
@@ -78,12 +230,49 @@ pub fn verify_package(dir: &Path, trusted_key: &str) -> Result<()> {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn verify_upgrade_fixture(dir: &Path, trusted_key: &str) -> Result<()> {
|
||||||
|
let (manifest, _) = pkgsource::fetch_manifest(&pkgsource::Source::Dir(dir.into()), trusted_key)?;
|
||||||
|
if !matches!(manifest.kind, Kind::Base | Kind::Update) {
|
||||||
|
return Err(Error::Invalid("Upgrade fixtures must be base or server update packages.".into()));
|
||||||
|
}
|
||||||
|
let scratch = tempfile::tempdir()?;
|
||||||
|
package::extract_selected(dir, &manifest, scratch.path(), &|path| path == schema_check::CONTRACT, &|_, _| {})?;
|
||||||
|
if manifest.kind == Kind::Update || manifest.files.iter().any(|file| file.path == schema_check::CONTRACT) {
|
||||||
|
schema_check::require_release_contract(scratch.path())?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
use base64::{engine::general_purpose::STANDARD, Engine};
|
use base64::{engine::general_purpose::STANDARD, Engine};
|
||||||
use ed25519_dalek::{Signer, SigningKey};
|
use ed25519_dalek::{Signer, SigningKey};
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn relative_startup_fixture_targets_replace_the_original_location() {
|
||||||
|
let directory = tempfile::Builder::new().prefix("coa-schema-fixture-path-test-").tempdir_in(".").unwrap();
|
||||||
|
let current = std::env::current_dir().unwrap();
|
||||||
|
let relative = directory.path().strip_prefix(¤t).unwrap();
|
||||||
|
fsx::atomic_write(&relative.join("Core/worldserver.exe"), b"old").unwrap();
|
||||||
|
let root = fsx::canonicalize_lenient(relative).unwrap();
|
||||||
|
let target = fsx::ensure_within(&root, &root.join("Core/worldserver.exe")).unwrap();
|
||||||
|
fsx::atomic_write(&target, b"candidate").unwrap();
|
||||||
|
assert_eq!(std::fs::read(relative.join("Core/worldserver.exe")).unwrap(), b"candidate");
|
||||||
|
assert!(!root.join(relative).join("Core/worldserver.exe").exists());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn startup_qualification_refuses_real_server_folders_before_writes() {
|
||||||
|
let directory = tempfile::tempdir().unwrap();
|
||||||
|
let server = directory.path().join("live-server");
|
||||||
|
std::fs::create_dir(&server).unwrap();
|
||||||
|
fsx::atomic_write(&server.join("owner-data"), b"untouched").unwrap();
|
||||||
|
assert!(validate_startup(&server, directory.path(), directory.path(), "unused").is_err());
|
||||||
|
assert_eq!(std::fs::read(server.join("owner-data")).unwrap(), b"untouched");
|
||||||
|
assert!(!crate::registry::metadata_dir_for(&server).unwrap().exists());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn signed_packages_must_carry_a_real_complete_schema_contract() {
|
fn signed_packages_must_carry_a_real_complete_schema_contract() {
|
||||||
let dir = tempfile::tempdir().unwrap();
|
let dir = tempfile::tempdir().unwrap();
|
||||||
@@ -122,6 +311,31 @@ mod tests {
|
|||||||
let dir = tempfile::tempdir().unwrap();
|
let dir = tempfile::tempdir().unwrap();
|
||||||
assert!(extract_base(dir.path(), dir.path(), "irrelevant").is_err());
|
assert!(extract_base(dir.path(), dir.path(), "irrelevant").is_err());
|
||||||
assert!(capture_release(dir.path(), dir.path(), &[]).is_err());
|
assert!(capture_release(dir.path(), dir.path(), &[]).is_err());
|
||||||
|
assert!(qualify_upgrade(dir.path(), dir.path(), dir.path(), dir.path(), "irrelevant").is_err());
|
||||||
assert!(!dir.path().join(schema_check::CONTRACT).exists());
|
assert!(!dir.path().join(schema_check::CONTRACT).exists());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn only_legacy_base_fixtures_may_omit_the_schema_contract() {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let tree = dir.path().join("tree");
|
||||||
|
let out = dir.path().join("package");
|
||||||
|
fsx::atomic_write(&tree.join("Core/example.txt"), b"fixture").unwrap();
|
||||||
|
let key = SigningKey::from_bytes(&[29; 32]);
|
||||||
|
let public = STANDARD.encode(key.verifying_key().as_bytes());
|
||||||
|
let options = package::BuildOptions { kind: Kind::Base, version: "0.2.0".into(), core_commit: None, bots_commit: None, built_at: "test".into(), part_size: 1024 * 1024, migrations: vec![] };
|
||||||
|
package::build(&tree, &out, &options, &|_| {}).unwrap();
|
||||||
|
let sign = || {
|
||||||
|
let bytes = std::fs::read(out.join("manifest.json")).unwrap();
|
||||||
|
fsx::atomic_write(&out.join("manifest.json.sig"), STANDARD.encode(key.sign(&bytes).to_bytes()).as_bytes()).unwrap();
|
||||||
|
};
|
||||||
|
sign();
|
||||||
|
verify_upgrade_fixture(&out, &public).unwrap();
|
||||||
|
assert!(verify_package(&out, &public).is_err());
|
||||||
|
let mut manifest: serde_json::Value = fsx::read_json(&out.join("manifest.json")).unwrap();
|
||||||
|
manifest["kind"] = "update".into();
|
||||||
|
fsx::atomic_write_json(&out.join("manifest.json"), &manifest).unwrap();
|
||||||
|
sign();
|
||||||
|
assert!(verify_upgrade_fixture(&out, &public).is_err());
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -39,6 +39,35 @@ pub fn require_release_contract(root: &Path) -> Result<Contract> {
|
|||||||
#[derive(Debug, Serialize)]
|
#[derive(Debug, Serialize)]
|
||||||
pub struct Problem { pub database: String, pub table: String, pub column: String, pub detail: String }
|
pub struct Problem { pub database: String, pub table: String, pub column: String, pub detail: String }
|
||||||
|
|
||||||
|
/// Keep all differences for support; never change a database to match a contract automatically.
|
||||||
|
pub fn check_with_report(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
||||||
|
let problems = check(db, root)?;
|
||||||
|
if problems.is_empty() { return Ok(problems); }
|
||||||
|
let report = serde_json::json!({
|
||||||
|
"schema": 1, "checkedAt": chrono::Utc::now().to_rfc3339(),
|
||||||
|
"realm": db.realm().name(), "problems": problems,
|
||||||
|
});
|
||||||
|
let path = crate::registry::metadata_dir_for(root)?.join("diagnostics")
|
||||||
|
.join(format!("schema-validation-{}-{}.json", db.realm().name(), uuid::Uuid::new_v4()));
|
||||||
|
// A log write failure must neither hide the original mismatch nor accept an invalid schema.
|
||||||
|
if let Err(error) = fsx::atomic_write_json(&path, &report) {
|
||||||
|
tracing::warn!(%error, path = %path.display(), "Could not save database schema report");
|
||||||
|
}
|
||||||
|
Ok(problems)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn describe_signature(signature: &str) -> String {
|
||||||
|
let fields: Vec<_> = signature.split('|').collect();
|
||||||
|
if fields.len() != 4 { return signature.into(); }
|
||||||
|
let decode = |value: &str| -> String {
|
||||||
|
if value == "<NULL>" { return "no default".into(); }
|
||||||
|
if value == "<NONE>" { return "none".into(); }
|
||||||
|
hex::decode(value).ok().and_then(|bytes| String::from_utf8(bytes).ok())
|
||||||
|
.map(|text| format!("{text:?}")).unwrap_or_else(|| value.into())
|
||||||
|
};
|
||||||
|
format!("type={}, nullable={}, default={}, extra={}", fields[0], fields[1], decode(fields[2]), decode(fields[3]))
|
||||||
|
}
|
||||||
|
|
||||||
fn read_columns(db: &Db, kind: &str) -> Result<BTreeMap<String, BTreeMap<String, String>>> {
|
fn read_columns(db: &Db, kind: &str) -> Result<BTreeMap<String, BTreeMap<String, String>>> {
|
||||||
let schema = db.realm_schema(crate::db::schema_of(kind)?);
|
let schema = db.realm_schema(crate::db::schema_of(kind)?);
|
||||||
let text = db.query(&format!("SELECT TABLE_NAME,COLUMN_NAME,CONCAT(COLUMN_TYPE,'|',IS_NULLABLE,'|',IF(COLUMN_DEFAULT IS NULL,'<NULL>',HEX(COLUMN_DEFAULT)),'|',IF(EXTRA='','<NONE>',HEX(EXTRA))) FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{schema}' ORDER BY TABLE_NAME,ORDINAL_POSITION;"))?;
|
let text = db.query(&format!("SELECT TABLE_NAME,COLUMN_NAME,CONCAT(COLUMN_TYPE,'|',IS_NULLABLE,'|',IF(COLUMN_DEFAULT IS NULL,'<NULL>',HEX(COLUMN_DEFAULT)),'|',IF(EXTRA='','<NONE>',HEX(EXTRA))) FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='{schema}' ORDER BY TABLE_NAME,ORDINAL_POSITION;"))?;
|
||||||
@@ -56,6 +85,46 @@ pub fn capture(db: &Db, root: &Path) -> Result<()> {
|
|||||||
fsx::atomic_write_json(&root.join(CONTRACT), &Contract { schema: 1, columns })
|
fsx::atomic_write_json(&root.join(CONTRACT), &Contract { schema: 1, columns })
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn missing_default(expected: &str, actual: &str) -> Option<String> {
|
||||||
|
let expected: Vec<_> = expected.split('|').collect();
|
||||||
|
let actual: Vec<_> = actual.split('|').collect();
|
||||||
|
if expected.len() != 4 || actual.len() != 4 || expected[0] != actual[0]
|
||||||
|
|| expected[1] != "NO" || actual[1] != "NO" || expected[3] != "<NONE>" || actual[3] != "<NONE>"
|
||||||
|
|| actual[2] != "<NULL>" || matches!(expected[2], "<NULL>" | "<NONE>") { return None; }
|
||||||
|
String::from_utf8(hex::decode(expected[2]).ok()?).ok()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Only restore a missing literal default from the exact signed target contract. Never alter data or custom defaults.
|
||||||
|
pub(crate) fn repair_missing_defaults(db: &Db, root: &Path, signed_hash: Option<&str>) -> Result<()> {
|
||||||
|
let Some(signed_hash) = signed_hash else { return Ok(()); };
|
||||||
|
if fsx::sha256_file(&root.join(CONTRACT))? != signed_hash {
|
||||||
|
return Err(crate::Error::Invalid("The target schema contract differs from the signed update.".into()));
|
||||||
|
}
|
||||||
|
let contract = require_release_contract(root)?;
|
||||||
|
let mut repaired = Vec::new();
|
||||||
|
let quote = |identifier: &str| format!("`{}`", identifier.replace('`', "``"));
|
||||||
|
for (kind, tables) in &contract.columns {
|
||||||
|
let schema = db.realm_schema(crate::db::schema_of(kind)?);
|
||||||
|
let actual = read_columns(db, kind)?;
|
||||||
|
let base_tables: BTreeSet<_> = db.tables(crate::db::schema_of(kind)?)?.into_iter().collect();
|
||||||
|
for (table, columns) in tables {
|
||||||
|
if !base_tables.contains(table) { continue; }
|
||||||
|
if matches!(table.as_str(), "updates" | "updates_include" | "coa_manager_migrations") { continue; }
|
||||||
|
for (column, expected) in columns {
|
||||||
|
let Some(found) = actual.get(table).and_then(|columns| columns.get(column)) else { continue; };
|
||||||
|
let Some(value) = missing_default(expected, found) else { continue; };
|
||||||
|
db.query(&format!("SET SESSION sql_mode=CONCAT_WS(',',@@SESSION.sql_mode,'NO_BACKSLASH_ESCAPES'); ALTER TABLE {}.{} ALTER COLUMN {} SET DEFAULT '{}';", quote(schema), quote(table), quote(column), value.replace('\'', "''")))?;
|
||||||
|
repaired.push(serde_json::json!({"database":schema,"table":table,"column":column,"action":"restore-missing-default"}));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !repaired.is_empty() {
|
||||||
|
let path = crate::registry::metadata_dir_for(root)?.join("diagnostics").join(format!("database-repair-{}.json", uuid::Uuid::new_v4()));
|
||||||
|
fsx::atomic_write_json(&path, &serde_json::json!({"schema":1,"checkedAt":chrono::Utc::now().to_rfc3339(),"contractSha256":signed_hash,"repairs":repaired}))?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
||||||
let contract = if root.join(CONTRACT).is_file() {
|
let contract = if root.join(CONTRACT).is_file() {
|
||||||
let contract: Contract = fsx::read_json(&root.join(CONTRACT))?;
|
let contract: Contract = fsx::read_json(&root.join(CONTRACT))?;
|
||||||
@@ -98,7 +167,7 @@ pub fn check(db: &Db, root: &Path) -> Result<Vec<Problem>> {
|
|||||||
for (column, want) in cols {
|
for (column, want) in cols {
|
||||||
let found = actual[table].get(column);
|
let found = actual[table].get(column);
|
||||||
if found.is_none() || (!want.is_empty() && found != Some(want)) {
|
if found.is_none() || (!want.is_empty() && found != Some(want)) {
|
||||||
problems.push(Problem { database: kind.clone(), table: table.clone(), column: column.clone(), detail: found.map(|s| format!("Expected {want}, found {s}")).unwrap_or_else(|| "Missing column".into()) });
|
problems.push(Problem { database: kind.clone(), table: table.clone(), column: column.clone(), detail: found.map(|s| format!("Expected {}, found {}", describe_signature(want), describe_signature(s))).unwrap_or_else(|| "Missing column".into()) });
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -146,6 +215,23 @@ fn missing_coa_starts(rows: &str) -> Vec<Problem> {
|
|||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn default_repair_only_accepts_missing_literal_defaults_without_other_schema_changes() {
|
||||||
|
assert_eq!(missing_default("int unsigned|NO|30|<NONE>", "int unsigned|NO|<NULL>|<NONE>"), Some("0".into()));
|
||||||
|
for actual in ["int unsigned|NO|3939|<NONE>", "int|NO|<NULL>|<NONE>", "int unsigned|YES|<NULL>|<NONE>", "int unsigned|NO|<NULL>|6175746f5f696e6372656d656e74"] {
|
||||||
|
assert!(missing_default("int unsigned|NO|30|<NONE>", actual).is_none());
|
||||||
|
}
|
||||||
|
assert!(missing_default("timestamp|NO|43555252454e545f54494d455354414d50|44454641554c545f47454e455241544544", "timestamp|NO|<NULL>|<NONE>").is_none());
|
||||||
|
assert!(missing_default("int|NO|zz|<NONE>", "int|NO|<NULL>|<NONE>").is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn schema_defaults_are_readable_and_not_conflated() {
|
||||||
|
assert_eq!(describe_signature("int unsigned|NO|30|<NONE>"), "type=int unsigned, nullable=NO, default=\"0\", extra=none");
|
||||||
|
assert!(describe_signature("int unsigned|NO|<NULL>|<NONE>").contains("default=no default"));
|
||||||
|
assert!(describe_signature("varchar(8)|YES||<NONE>").contains("default=\"\""));
|
||||||
|
assert_eq!(describe_signature("legacy"), "legacy");
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn a_release_cannot_use_a_partial_or_empty_schema_contract() {
|
fn a_release_cannot_use_a_partial_or_empty_schema_contract() {
|
||||||
|
|||||||
@@ -44,6 +44,15 @@ pub struct Field {
|
|||||||
pub default_if_missing: Option<serde_json::Value>,
|
pub default_if_missing: Option<serde_json::Value>,
|
||||||
pub min: Option<f64>,
|
pub min: Option<f64>,
|
||||||
pub max: Option<f64>,
|
pub max: Option<f64>,
|
||||||
|
/// A fixed list of allowed values with their labels (SQUID 1.9+); the editor shows it as a drop-down.
|
||||||
|
#[serde(default, skip_serializing_if = "Vec::is_empty")]
|
||||||
|
pub choices: Vec<Choice>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq)]
|
||||||
|
pub struct Choice {
|
||||||
|
pub value: serde_json::Value,
|
||||||
|
pub label: String,
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Deserialize)]
|
#[derive(Deserialize)]
|
||||||
@@ -71,12 +80,20 @@ pub fn fields(root: &Path) -> crate::Result<std::collections::BTreeMap<String, F
|
|||||||
|| field.min.zip(field.max).is_some_and(|(min,max)| min > max)
|
|| field.min.zip(field.max).is_some_and(|(min,max)| min > max)
|
||||||
|| !default_type(&field.kind, &field.default)
|
|| !default_type(&field.kind, &field.default)
|
||||||
|| field.default_if_missing.as_ref().is_some_and(|value| !default_type(&field.kind, value))
|
|| field.default_if_missing.as_ref().is_some_and(|value| !default_type(&field.kind, value))
|
||||||
|
|| !valid_choices(&field)
|
||||||
|| fields.contains_key(&field.key) { continue; }
|
|| fields.contains_key(&field.key) { continue; }
|
||||||
fields.insert(field.key.clone(), field);
|
fields.insert(field.key.clone(), field);
|
||||||
}
|
}
|
||||||
Ok(fields)
|
Ok(fields)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A list of choices must be small, labelled, free of repeats and made of values of the field's own type.
|
||||||
|
fn valid_choices(field: &Field) -> bool {
|
||||||
|
field.choices.len() <= 64
|
||||||
|
&& field.choices.iter().all(|c| !c.label.trim().is_empty() && c.label.len() <= 80 && default_type(&field.kind, &c.value))
|
||||||
|
&& field.choices.iter().enumerate().all(|(i, c)| field.choices[..i].iter().all(|earlier| scalar(&earlier.value) != scalar(&c.value)))
|
||||||
|
}
|
||||||
|
|
||||||
fn default_type(kind: &str, value: &serde_json::Value) -> bool {
|
fn default_type(kind: &str, value: &serde_json::Value) -> bool {
|
||||||
match kind {
|
match kind {
|
||||||
"bool" => value.is_boolean(),
|
"bool" => value.is_boolean(),
|
||||||
@@ -104,13 +121,28 @@ pub fn validate(field: &Field, value: &str) -> crate::Result<()> {
|
|||||||
&& field.min.is_none_or(|min| number >= min) && field.max.is_none_or(|max| number <= max)),
|
&& field.min.is_none_or(|min| number >= min) && field.max.is_none_or(|max| number <= max)),
|
||||||
"string" => true,
|
"string" => true,
|
||||||
_ => false,
|
_ => false,
|
||||||
};
|
} && (field.choices.is_empty() || field.choices.iter().any(|c| scalar(&c.value).as_deref() == Some(value)));
|
||||||
if valid { Ok(()) } else { Err(crate::Error::Invalid(format!("{} must match its documented SquidBots type and range.", field.key))) }
|
if valid { Ok(()) } else { Err(crate::Error::Invalid(format!("{} must match its documented SquidBots type and range.", field.key))) }
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use super::*;
|
use super::*;
|
||||||
|
#[test]
|
||||||
|
fn a_setting_with_choices_only_accepts_one_of_them() {
|
||||||
|
let root = tempfile::tempdir().unwrap();
|
||||||
|
crate::fsx::atomic_write(&root.path().join("Core/configs/modules/playerbots.conf.settings.json"), br#"{"format":1,"settings":[
|
||||||
|
{"key":"AiPlayerbot.BotTextLocale","type":"int","group":"chat","title":"Language","description":"x","default":-1,"min":-1,"max":8,
|
||||||
|
"choices":[{"value":-1,"label":"Auto"},{"value":0,"label":"English"},{"value":8,"label":"Russian"}]},
|
||||||
|
{"key":"AiPlayerbot.Broken","type":"int","group":"chat","title":"b","description":"x","default":0,"choices":[{"value":"a","label":"wrong type"}]}]}"#).unwrap();
|
||||||
|
let fields = fields(root.path()).unwrap();
|
||||||
|
let locale = &fields["AiPlayerbot.BotTextLocale"];
|
||||||
|
assert_eq!(locale.choices.len(), 3);
|
||||||
|
for ok in ["-1", "0", "8"] { assert!(validate(locale, ok).is_ok(), "{ok}"); }
|
||||||
|
for bad in ["1", "7", "x"] { assert!(validate(locale, bad).is_err(), "{bad}"); }
|
||||||
|
assert!(!fields.contains_key("AiPlayerbot.Broken"), "a choice of the wrong type invalidates the setting");
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn upstream_settings_preserve_types_ranges_and_distinct_defaults() {
|
fn upstream_settings_preserve_types_ranges_and_distinct_defaults() {
|
||||||
let root = tempfile::tempdir().unwrap();
|
let root = tempfile::tempdir().unwrap();
|
||||||
|
|||||||
+579
-82
@@ -85,9 +85,14 @@ fn legacy_databases_started() -> bool { true }
|
|||||||
|
|
||||||
/// Everything the transaction needs from the outside world; tests provide a fake.
|
/// Everything the transaction needs from the outside world; tests provide a fake.
|
||||||
pub trait Env {
|
pub trait Env {
|
||||||
|
fn activate(&self) -> Result<()> { Ok(()) }
|
||||||
|
fn recover_validation(&self) -> Result<()> { Ok(()) }
|
||||||
|
fn automatic_rollback(&self) -> bool { false }
|
||||||
|
fn validate_recovery(&self) -> Result<()> { self.validate() }
|
||||||
fn ensure_stopped(&self) -> Result<()>;
|
fn ensure_stopped(&self) -> Result<()>;
|
||||||
fn preflight(&self, _manifest: &Manifest) -> Result<()> { Ok(()) }
|
fn preflight(&self, _manifest: &Manifest) -> Result<()> { Ok(()) }
|
||||||
fn verify_snapshot(&self, _id: &str) -> Result<()> { Ok(()) }
|
fn verify_snapshot(&self, _id: &str) -> Result<()> { Ok(()) }
|
||||||
|
fn rehearse(&self, _manifest: &Manifest, _tree: &Path, _items: &[PlanItem], _point: &str) -> Result<()> { Ok(()) }
|
||||||
/// Create a recovery point for the databases and configuration; returns its id.
|
/// Create a recovery point for the databases and configuration; returns its id.
|
||||||
fn snapshot(&self) -> Result<String>;
|
fn snapshot(&self) -> Result<String>;
|
||||||
fn restore_snapshot(&self, id: &str) -> Result<()>;
|
fn restore_snapshot(&self, id: &str) -> Result<()>;
|
||||||
@@ -177,6 +182,9 @@ pub fn unfinished(meta: &Path) -> Option<Txn> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
pub fn ensure_recovered(meta: &Path) -> Result<()> {
|
pub fn ensure_recovered(meta: &Path) -> Result<()> {
|
||||||
|
if crate::update_isolation::pending(meta) {
|
||||||
|
return Err(Error::Invalid("Interrupted startup validation must be recovered before starting the server.".into()));
|
||||||
|
}
|
||||||
if let Some(t) = pending_checked(meta)? {
|
if let Some(t) = pending_checked(meta)? {
|
||||||
return Err(Error::Invalid(format!("Resolve unfinished update {} before changing or starting the server.", t.id)));
|
return Err(Error::Invalid(format!("Resolve unfinished update {} before changing or starting the server.", t.id)));
|
||||||
}
|
}
|
||||||
@@ -197,8 +205,15 @@ pub struct PlanItem {
|
|||||||
/// What an update would do to this installation. Read-only.
|
/// What an update would do to this installation. Read-only.
|
||||||
pub fn plan(root: &Path, meta: &InstallMeta, manifest: &Manifest, resolutions: &BTreeMap<String, Resolution>, staged: Option<&Path>) -> Result<Vec<PlanItem>> {
|
pub fn plan(root: &Path, meta: &InstallMeta, manifest: &Manifest, resolutions: &BTreeMap<String, Resolution>, staged: Option<&Path>) -> Result<Vec<PlanItem>> {
|
||||||
let mut out = Vec::new();
|
let mut out = Vec::new();
|
||||||
|
// An update is decided by version. The same version has the same files, so a file the owner edited (or removed)
|
||||||
|
// is not an update: Repair lists such files and restores them on request.
|
||||||
|
let same_version = meta.core.version.as_deref().is_some_and(|installed| installed == manifest.version);
|
||||||
for f in manifest.files.iter().filter(|f| !f.path.starts_with(STAGED_PREFIX)) {
|
for f in manifest.files.iter().filter(|f| !f.path.starts_with(STAGED_PREFIX)) {
|
||||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, &f.path)?)?;
|
let target = fsx::ensure_within(root, &fsx::safe_join(root, &f.path)?)?;
|
||||||
|
if same_version {
|
||||||
|
out.push(PlanItem { path: f.path.clone(), action: Action::Skip, reason: Some("same version; Repair restores changed files".into()) });
|
||||||
|
continue;
|
||||||
|
}
|
||||||
let cur = sha_if_exists(&target);
|
let cur = sha_if_exists(&target);
|
||||||
let recorded = meta.original_hashes.get(&f.path);
|
let recorded = meta.original_hashes.get(&f.path);
|
||||||
let (action, reason) = match (f.policy, &cur) {
|
let (action, reason) = match (f.policy, &cur) {
|
||||||
@@ -259,10 +274,39 @@ pub struct Preview {
|
|||||||
pub migrations: usize,
|
pub migrations: usize,
|
||||||
pub pending_migrations: usize,
|
pub pending_migrations: usize,
|
||||||
pub download_bytes: u64,
|
pub download_bytes: u64,
|
||||||
|
/// False when the pending SQL was not counted (database stopped during a background check, or an error).
|
||||||
|
pub database_checked: bool,
|
||||||
|
/// Why the database could not be inspected. The check still answers about the files; applying the update starts
|
||||||
|
/// the database itself and reports its own failure.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub database_check_error: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Whether looking for an update may start the database to count pending SQL.
|
||||||
|
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
|
||||||
|
pub enum DatabaseAccess {
|
||||||
|
/// An explicit check: start the database if it is stopped (and stop it again afterwards).
|
||||||
|
Start,
|
||||||
|
/// The background check that repeats every few minutes must not start and stop MySQL on a stopped server.
|
||||||
|
OnlyIfRunning,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The update packages are those of the Windows repack (executables, a bundled MySQL, a launcher): applying one to a Docker
|
||||||
|
/// server would put Windows files in a Linux server folder. Updating a Docker server is separate work.
|
||||||
|
fn refuse_for_docker(root: &Path) -> Result<()> {
|
||||||
|
if crate::docker::is_docker(root) {
|
||||||
|
return Err(Error::Invalid("Updates are not available for Docker servers yet.".into()));
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Describe the update; a managed launcher may need a one-time authenticated payload check.
|
/// Describe the update; a managed launcher may need a one-time authenticated payload check.
|
||||||
pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>) -> Result<Preview> {
|
pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>) -> Result<Preview> {
|
||||||
|
preview_with(root, meta, source, trusted_key, resolutions, DatabaseAccess::Start)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn preview_with(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>, access: DatabaseAccess) -> Result<Preview> {
|
||||||
|
refuse_for_docker(root)?;
|
||||||
let meta_dir = crate::registry::metadata_dir_for(root)?;
|
let meta_dir = crate::registry::metadata_dir_for(root)?;
|
||||||
let _lock = operation_lock(&meta_dir)?;
|
let _lock = operation_lock(&meta_dir)?;
|
||||||
ensure_recovered(&meta_dir)?;
|
ensure_recovered(&meta_dir)?;
|
||||||
@@ -277,7 +321,16 @@ pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &s
|
|||||||
item.reason = Some("already up to date with Manager integration".into());
|
item.reason = Some("already up to date with Manager integration".into());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let pending_migrations = (RepackEnv { root, meta_dir: &meta_dir }).pending_migrations(&m)?;
|
// Counting pending SQL needs the database. If it cannot be started the files can still be compared, so report
|
||||||
|
// that instead of failing the whole check.
|
||||||
|
let (pending_migrations, database_checked, database_check_error) = match (RepackEnv { root, meta_dir: &meta_dir }).pending_migrations_with(&m, access) {
|
||||||
|
Ok(Some(count)) => (count, true, None),
|
||||||
|
Ok(None) => (m.migrations.len(), false, None),
|
||||||
|
Err(error) => {
|
||||||
|
tracing::warn!(%error, "update check: the database could not be inspected");
|
||||||
|
(m.migrations.len(), false, Some(error.to_string()))
|
||||||
|
}
|
||||||
|
};
|
||||||
Ok(Preview {
|
Ok(Preview {
|
||||||
from_version: meta.core.version.clone(),
|
from_version: meta.core.version.clone(),
|
||||||
to_version: m.version.clone(),
|
to_version: m.version.clone(),
|
||||||
@@ -286,6 +339,8 @@ pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &s
|
|||||||
migrations: m.migrations.len(),
|
migrations: m.migrations.len(),
|
||||||
pending_migrations,
|
pending_migrations,
|
||||||
download_bytes: m.archive.as_ref().map(|a| a.parts.iter().map(|p| p.size).sum()).unwrap_or(0),
|
download_bytes: m.archive.as_ref().map(|a| a.parts.iter().map(|p| p.size).sum()).unwrap_or(0),
|
||||||
|
database_checked,
|
||||||
|
database_check_error,
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -313,6 +368,15 @@ fn launcher_already_integrated(root: &Path, meta_dir: &Path, meta: &InstallMeta,
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn reject_downgrade(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
|
fn reject_downgrade(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
|
||||||
|
if let Some(c) = &manifest.compatibility {
|
||||||
|
let platform = if cfg!(windows) { "windows-x86_64" } else { "linux-x86_64" };
|
||||||
|
if c.platform != platform {
|
||||||
|
return Err(Error::Invalid(format!("This package targets {} rather than {platform}.", c.platform)));
|
||||||
|
}
|
||||||
|
if meta.core.version.as_ref().is_none_or(|version| !c.source_versions.contains(version)) {
|
||||||
|
return Err(Error::Invalid("This server version is outside the release's tested compatibility matrix.".into()));
|
||||||
|
}
|
||||||
|
}
|
||||||
if let Some(installed) = meta.core.version.as_deref() {
|
if let Some(installed) = meta.core.version.as_deref() {
|
||||||
if let (Some(have), Some(candidate)) = (crate::manifest::parse_version(installed), crate::manifest::parse_version(&manifest.version)) {
|
if let (Some(have), Some(candidate)) = (crate::manifest::parse_version(installed), crate::manifest::parse_version(&manifest.version)) {
|
||||||
if candidate < have {
|
if candidate < have {
|
||||||
@@ -333,6 +397,11 @@ fn check_manifest(m: &Manifest) -> Result<()> {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn validate_candidate(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
|
||||||
|
check_manifest(manifest)?;
|
||||||
|
reject_downgrade(meta, manifest)
|
||||||
|
}
|
||||||
|
|
||||||
pub struct Params<'a> {
|
pub struct Params<'a> {
|
||||||
pub root: &'a Path,
|
pub root: &'a Path,
|
||||||
pub meta_dir: &'a Path,
|
pub meta_dir: &'a Path,
|
||||||
@@ -359,6 +428,7 @@ fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) {
|
|||||||
/// Run the whole update. On failure before the new build is validated the files are rolled back automatically;
|
/// Run the whole update. On failure before the new build is validated the files are rolled back automatically;
|
||||||
/// a build that is applied but unhealthy is left in `NeedsDecision` so the owner chooses.
|
/// a build that is applied but unhealthy is left in `NeedsDecision` so the owner chooses.
|
||||||
pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
||||||
|
refuse_for_docker(p.root)?;
|
||||||
let (root, meta_dir) = (p.root, p.meta_dir);
|
let (root, meta_dir) = (p.root, p.meta_dir);
|
||||||
let _lock = operation_lock(meta_dir)?;
|
let _lock = operation_lock(meta_dir)?;
|
||||||
ensure_recovered(meta_dir)?;
|
ensure_recovered(meta_dir)?;
|
||||||
@@ -422,8 +492,16 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
|||||||
p.env.ensure_stopped()?;
|
p.env.ensure_stopped()?;
|
||||||
step(report, "Saving a recovery point", 52);
|
step(report, "Saving a recovery point", 52);
|
||||||
txn.recovery_point = Some(p.env.snapshot().map_err(|e| Error::Invalid(format!("The update was not applied because the safety backup failed: {e}")))?);
|
txn.recovery_point = Some(p.env.snapshot().map_err(|e| Error::Invalid(format!("The update was not applied because the safety backup failed: {e}")))?);
|
||||||
let point_meta = meta_dir.join("backups").join(txn.recovery_point.as_deref().unwrap()).join("backup.json");
|
let point_meta = crate::backup::point_json(meta_dir, txn.recovery_point.as_deref().unwrap())?;
|
||||||
if point_meta.is_file() { txn.recovery_hashes.insert("@point".into(), fsx::sha256_file(&point_meta)?); }
|
if point_meta.is_file() { txn.recovery_hashes.insert("@point".into(), fsx::sha256_file(&point_meta)?); }
|
||||||
|
save(meta_dir, &txn)?;
|
||||||
|
step(report, "Testing the update on a private copy of your server", 54);
|
||||||
|
if let Err(error) = p.env.rehearse(&m, &tree, &items, txn.recovery_point.as_deref().unwrap()) {
|
||||||
|
txn.state = State::Failed;
|
||||||
|
txn.message = Some(format!("The private update rehearsal failed: {error}. The installed server was not updated."));
|
||||||
|
save(meta_dir, &txn)?;
|
||||||
|
return Err(Error::Invalid(txn.message.unwrap()));
|
||||||
|
}
|
||||||
|
|
||||||
txn.ops = items
|
txn.ops = items
|
||||||
.iter()
|
.iter()
|
||||||
@@ -447,7 +525,7 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
|||||||
|
|
||||||
// MySQL DDL can commit before a later statement fails. Restore the full recovery point on failure.
|
// MySQL DDL can commit before a later statement fails. Restore the full recovery point on failure.
|
||||||
let mut migrated = None;
|
let mut migrated = None;
|
||||||
if !m.migrations.is_empty() {
|
if !m.migrations.is_empty() || m.files.iter().any(|file| file.path == crate::schema_check::CONTRACT) {
|
||||||
step(report, "Updating the database", 75);
|
step(report, "Updating the database", 75);
|
||||||
txn.databases_started = true;
|
txn.databases_started = true;
|
||||||
save(meta_dir, &txn)?;
|
save(meta_dir, &txn)?;
|
||||||
@@ -455,14 +533,25 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
|||||||
Ok(r) if r.failed.is_none() => migrated = Some(r),
|
Ok(r) if r.failed.is_none() => migrated = Some(r),
|
||||||
Ok(r) => {
|
Ok(r) => {
|
||||||
let (mid, why) = r.failed.clone().unwrap();
|
let (mid, why) = r.failed.clone().unwrap();
|
||||||
|
step(report, "Undoing the update", 76);
|
||||||
return fail_after_apply(p, &mut txn, &before, &tree, format!("Database update {mid} failed: {why}"), Some(r));
|
return fail_after_apply(p, &mut txn, &before, &tree, format!("Database update {mid} failed: {why}"), Some(r));
|
||||||
}
|
}
|
||||||
Err(e) => return fail_after_apply(p, &mut txn, &before, &tree, e.to_string(), None),
|
Err(e) => {
|
||||||
|
step(report, "Undoing the update", 76);
|
||||||
|
return fail_after_apply(p, &mut txn, &before, &tree, e.to_string(), None);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
step(report, "Starting the updated server", 85);
|
step(report, "Starting the updated server", 85);
|
||||||
|
// Core startup can apply SQL and write character data even when the package has no explicit migrations.
|
||||||
|
txn.databases_started = true;
|
||||||
|
save(meta_dir, &txn)?;
|
||||||
if let Err(e) = p.env.validate() {
|
if let Err(e) = p.env.validate() {
|
||||||
|
if p.env.automatic_rollback() {
|
||||||
|
return fail_after_apply(p, &mut txn, &before, &tree,
|
||||||
|
format!("The updated server did not start correctly: {e}"), migrated);
|
||||||
|
}
|
||||||
txn.state = State::NeedsDecision;
|
txn.state = State::NeedsDecision;
|
||||||
txn.message = Some(format!("The updated server did not start correctly: {e}"));
|
txn.message = Some(format!("The updated server did not start correctly: {e}"));
|
||||||
save(meta_dir, &txn)?;
|
save(meta_dir, &txn)?;
|
||||||
@@ -470,6 +559,7 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
finish(root, meta_dir, &mut meta, &m, &tree, &mut txn)?;
|
finish(root, meta_dir, &mut meta, &m, &tree, &mut txn)?;
|
||||||
|
p.env.activate()?;
|
||||||
step(report, "Done", 100);
|
step(report, "Done", 100);
|
||||||
let _ = archive;
|
let _ = archive;
|
||||||
Ok(Outcome { txn, migrations: migrated })
|
Ok(Outcome { txn, migrations: migrated })
|
||||||
@@ -542,17 +632,24 @@ pub fn retry_validation(root: &Path, meta_dir: &Path, id: &str, fallback: &Sourc
|
|||||||
}
|
}
|
||||||
let (_, mut meta) = MetaDir::open(meta_dir)?;
|
let (_, mut meta) = MetaDir::open(meta_dir)?;
|
||||||
finish(root, meta_dir, &mut meta, &manifest, &dir.join("tree"), &mut txn)?;
|
finish(root, meta_dir, &mut meta, &manifest, &dir.join("tree"), &mut txn)?;
|
||||||
|
env.activate()?;
|
||||||
Ok(txn)
|
Ok(txn)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn fail_after_apply(p: &Params, txn: &mut Txn, before: &Path, tree: &Path, why: String, report: Option<ApplyReport>) -> Result<Outcome> {
|
fn fail_after_apply(p: &Params, txn: &mut Txn, before: &Path, tree: &Path, why: String, report: Option<ApplyReport>) -> Result<Outcome> {
|
||||||
tracing::error!(transaction = %txn.id, databases_started = txn.databases_started, "server update failed; restoring recovery point");
|
tracing::error!(transaction = %txn.id, databases_started = txn.databases_started, "server update failed; restoring recovery point");
|
||||||
let restored = restore_transaction(p.root, p.meta_dir, before, txn, p.env);
|
let restored = restore_transaction(p.root, p.meta_dir, before, txn, p.env).and_then(|()| {
|
||||||
|
if p.env.automatic_rollback() { p.env.validate_recovery() } else { Ok(()) }
|
||||||
|
});
|
||||||
|
if restored.is_err() { let _ = p.env.ensure_stopped(); }
|
||||||
tracing::info!(transaction = %txn.id, recovered = restored.is_ok(), "server update recovery finished");
|
tracing::info!(transaction = %txn.id, recovered = restored.is_ok(), "server update recovery finished");
|
||||||
txn.state = if restored.is_ok() { State::RolledBack } else { State::Failed };
|
txn.state = if restored.is_ok() { State::RolledBack } else { State::Failed };
|
||||||
txn.message = Some(match &restored { Ok(()) => why.clone(), Err(e) => format!("{why} Recovery failed: {e}") });
|
txn.message = Some(match &restored { Ok(()) => why.clone(), Err(e) => format!("{why} Recovery failed: {e}") });
|
||||||
save(p.meta_dir, txn)?;
|
save(p.meta_dir, txn)?;
|
||||||
if restored.is_ok() { let _ = fs::remove_dir_all(tree); }
|
if restored.is_ok() {
|
||||||
|
let _ = fs::remove_dir_all(tree);
|
||||||
|
if p.env.automatic_rollback() { p.env.activate()?; }
|
||||||
|
}
|
||||||
let _ = report;
|
let _ = report;
|
||||||
Err(Error::Invalid(match restored {
|
Err(Error::Invalid(match restored {
|
||||||
Ok(()) if txn.databases_started => format!("{why} The server files and databases were restored to the recovery point."),
|
Ok(()) if txn.databases_started => format!("{why} The server files and databases were restored to the recovery point."),
|
||||||
@@ -565,7 +662,7 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
|
|||||||
for (rel, expected) in &txn.recovery_hashes {
|
for (rel, expected) in &txn.recovery_hashes {
|
||||||
let saved = match rel.as_str() {
|
let saved = match rel.as_str() {
|
||||||
"@install" => before.join("manager-install.json"),
|
"@install" => before.join("manager-install.json"),
|
||||||
"@point" => meta.join("backups").join(txn.recovery_point.as_deref().ok_or_else(|| Error::Invalid("The recovery point identity is missing.".into()))?).join("backup.json"),
|
"@point" => crate::backup::point_json(meta, txn.recovery_point.as_deref().ok_or_else(|| Error::Invalid("The recovery point identity is missing.".into()))?)?,
|
||||||
_ => fsx::safe_join(before, rel)?,
|
_ => fsx::safe_join(before, rel)?,
|
||||||
};
|
};
|
||||||
if fsx::sha256_file(&saved)? != *expected { return Err(Error::Invalid(format!("Recovery copy {rel} is damaged; no restoration was started."))); }
|
if fsx::sha256_file(&saved)? != *expected { return Err(Error::Invalid(format!("Recovery copy {rel} is damaged; no restoration was started."))); }
|
||||||
@@ -576,6 +673,7 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
|
|||||||
}
|
}
|
||||||
if !before.join("manager-install.json").is_file() { return Err(Error::Invalid("The saved installation metadata is missing; no restoration was started.".into())); }
|
if !before.join("manager-install.json").is_file() { return Err(Error::Invalid("The saved installation metadata is missing; no restoration was started.".into())); }
|
||||||
env.ensure_stopped()?;
|
env.ensure_stopped()?;
|
||||||
|
env.recover_validation()?;
|
||||||
if txn.databases_started {
|
if txn.databases_started {
|
||||||
let id = txn.recovery_point.as_deref().ok_or_else(|| Error::Invalid("The database recovery point is missing.".into()))?;
|
let id = txn.recovery_point.as_deref().ok_or_else(|| Error::Invalid("The database recovery point is missing.".into()))?;
|
||||||
env.restore_snapshot(id)?;
|
env.restore_snapshot(id)?;
|
||||||
@@ -589,6 +687,25 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn: &mut Txn, meta_dir: &Path, fail_after: Option<usize>) -> Result<()> {
|
fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn: &mut Txn, meta_dir: &Path, fail_after: Option<usize>) -> Result<()> {
|
||||||
|
if fail_after == Some(0) && !txn.ops.is_empty() {
|
||||||
|
return Err(Error::Invalid("simulated failure".into()));
|
||||||
|
}
|
||||||
|
let entries: BTreeMap<_, _> = files.iter().map(|entry| (entry.path.as_str(), entry)).collect();
|
||||||
|
// Prepare every recovery copy before changing any destination. One durable journal
|
||||||
|
// can then cover the entire file phase: recovery restores old files even if their
|
||||||
|
// replacement was not reached, and removes newly created files only by exact hash.
|
||||||
|
// Rewriting the full journal twice per file makes large navigation updates quadratic.
|
||||||
|
for op in &txn.ops {
|
||||||
|
let target = fsx::ensure_within(root, &fsx::safe_join(root, &op.path)?)?;
|
||||||
|
if op.had_previous {
|
||||||
|
let keep = fsx::safe_join(before, &op.path)?;
|
||||||
|
fs::create_dir_all(keep.parent().unwrap())?;
|
||||||
|
fsx::atomic_write(&keep, &fs::read(&target)?)?;
|
||||||
|
txn.recovery_hashes.insert(op.path.clone(), fsx::sha256_file(&keep)?);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for op in &mut txn.ops { op.started = true; }
|
||||||
|
save(meta_dir, txn)?;
|
||||||
let mut completed = 0usize;
|
let mut completed = 0usize;
|
||||||
for i in 0..txn.ops.len() {
|
for i in 0..txn.ops.len() {
|
||||||
if fail_after == Some(completed) {
|
if fail_after == Some(completed) {
|
||||||
@@ -597,17 +714,7 @@ fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn:
|
|||||||
let (path, action) = (txn.ops[i].path.clone(), txn.ops[i].action);
|
let (path, action) = (txn.ops[i].path.clone(), txn.ops[i].action);
|
||||||
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
|
let target = fsx::ensure_within(root, &fsx::safe_join(root, &path)?)?;
|
||||||
let staged = fsx::safe_join(tree, &path)?;
|
let staged = fsx::safe_join(tree, &path)?;
|
||||||
let entry = files.iter().find(|f| f.path == path).expect("listed");
|
let entry = entries.get(path.as_str()).expect("listed");
|
||||||
if target.is_file() {
|
|
||||||
let keep = fsx::safe_join(before, &path)?;
|
|
||||||
fs::create_dir_all(keep.parent().unwrap())?;
|
|
||||||
fsx::atomic_write(&keep, &fs::read(&target)?)?;
|
|
||||||
txn.recovery_hashes.insert(path.clone(), fsx::sha256_file(&keep)?);
|
|
||||||
}
|
|
||||||
// Journal only after the old bytes are safely saved; a crash during backup must not
|
|
||||||
// turn an untouched file into a rollback operation with a missing saved copy.
|
|
||||||
txn.ops[i].started = true;
|
|
||||||
save(meta_dir, txn)?;
|
|
||||||
fs::create_dir_all(target.parent().unwrap())?;
|
fs::create_dir_all(target.parent().unwrap())?;
|
||||||
match action {
|
match action {
|
||||||
Action::Create | Action::Replace => {
|
Action::Create | Action::Replace => {
|
||||||
@@ -632,10 +739,9 @@ fn apply_ops(root: &Path, tree: &Path, before: &Path, files: &[FileEntry], txn:
|
|||||||
Action::Skip | Action::Conflict => {}
|
Action::Skip | Action::Conflict => {}
|
||||||
}
|
}
|
||||||
txn.ops[i].done = true;
|
txn.ops[i].done = true;
|
||||||
save(meta_dir, txn)?;
|
|
||||||
completed += 1;
|
completed += 1;
|
||||||
}
|
}
|
||||||
Ok(())
|
save(meta_dir, txn)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Put every touched file back the way it was. Files created by the update (no previous version) are removed only if
|
/// Put every touched file back the way it was. Files created by the update (no previous version) are removed only if
|
||||||
@@ -659,6 +765,7 @@ fn restore_files(root: &Path, before: &Path, txn: &mut Txn) -> Result<()> {
|
|||||||
|
|
||||||
/// Restore the database recovery point first, then restore binaries and configuration.
|
/// Restore the database recovery point first, then restore binaries and configuration.
|
||||||
pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result<Txn> {
|
pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result<Txn> {
|
||||||
|
refuse_for_docker(root)?;
|
||||||
let _lock = operation_lock(meta_dir)?;
|
let _lock = operation_lock(meta_dir)?;
|
||||||
let mut txn = load(meta_dir, id)?;
|
let mut txn = load(meta_dir, id)?;
|
||||||
if matches!(txn.state, State::Committed | State::RolledBack) {
|
if matches!(txn.state, State::Committed | State::RolledBack) {
|
||||||
@@ -735,8 +842,13 @@ pub struct RepackEnv<'a> {
|
|||||||
|
|
||||||
impl RepackEnv<'_> {
|
impl RepackEnv<'_> {
|
||||||
pub fn pending_migrations(&self, manifest: &Manifest) -> Result<usize> {
|
pub fn pending_migrations(&self, manifest: &Manifest) -> Result<usize> {
|
||||||
if manifest.migrations.is_empty() { return Ok(0); }
|
Ok(self.pending_migrations_with(manifest, DatabaseAccess::Start)?.unwrap_or(0))
|
||||||
crate::backup::with_database(self.root, |db| {
|
}
|
||||||
|
|
||||||
|
/// `None` when the database is not running and `access` forbids starting it.
|
||||||
|
pub fn pending_migrations_with(&self, manifest: &Manifest, access: DatabaseAccess) -> Result<Option<usize>> {
|
||||||
|
if manifest.migrations.is_empty() { return Ok(Some(0)); }
|
||||||
|
let count = |db: &crate::db::Db| -> Result<usize> {
|
||||||
let realms = crate::realms::state(self.root)?;
|
let realms = crate::realms::state(self.root)?;
|
||||||
let mut modes = vec![realms.active];
|
let mut modes = vec![realms.active];
|
||||||
if realms.wildcard_created { modes.push(if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa }); }
|
if realms.wildcard_created { modes.push(if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa }); }
|
||||||
@@ -746,20 +858,38 @@ impl RepackEnv<'_> {
|
|||||||
count += crate::migrations::pending_count(&db.clone().for_realm(mode), &list)?;
|
count += crate::migrations::pending_count(&db.clone().for_realm(mode), &list)?;
|
||||||
}
|
}
|
||||||
Ok(count)
|
Ok(count)
|
||||||
})
|
};
|
||||||
|
match access {
|
||||||
|
DatabaseAccess::Start => crate::backup::with_database(self.root, count).map(Some),
|
||||||
|
DatabaseAccess::OnlyIfRunning => crate::backup::with_running_database(self.root, count),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
pub(crate) fn verify_recovery_point(&self, point: &crate::backup::RecoveryPoint) -> Result<()> {
|
pub(crate) fn verify_recovery_point(&self, point: &crate::backup::RecoveryPoint) -> Result<()> {
|
||||||
if point.kind != crate::backup::Kind::Full || !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) {
|
if point.kind != crate::backup::Kind::Full || !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) {
|
||||||
return Err(Error::Invalid("The update recovery point does not contain every required database and configuration.".into()));
|
return Err(Error::Invalid("The update recovery point does not contain every required database and configuration.".into()));
|
||||||
}
|
}
|
||||||
if !crate::backup::verify(self.meta_dir, &point.id)?.ok { return Err(Error::Invalid("The recovery point failed verification.".into())); }
|
if !crate::backup::verify(self.meta_dir, &point.id)?.ok { return Err(Error::Invalid("The recovery point failed verification.".into())); }
|
||||||
|
if let Some(snapshot) = &point.mysql_snapshot {
|
||||||
|
if fsx::sha256_file(&self.root.join("mysql/bin/mysqld.exe"))? != snapshot.server_sha256 {
|
||||||
|
return Err(Error::Invalid("The MySQL executable differs from the recovery point.".into()));
|
||||||
|
}
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
crate::backup::with_database(self.root, |db| {
|
crate::backup::with_database(self.root, |db| {
|
||||||
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||||
|
let mut objects = Vec::new();
|
||||||
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
|
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
|
||||||
let schema = if component.name.contains('-') || component.name == "playerbots" { crate::db::schema_of(&component.name)? } else { point.realm.schema(&component.name)? };
|
let schema = if component.name.contains('-') || component.name == "playerbots" { crate::db::schema_of(&component.name)? } else { point.realm.schema(&component.name)? };
|
||||||
if db.extra_objects(schema)? != 0 {
|
objects.extend(db.recovery_objects(schema)?);
|
||||||
return Err(Error::Invalid(format!("Database {schema} has routines, triggers or views that automatic recovery cannot restore. The update was not started.")));
|
}
|
||||||
|
if !objects.is_empty() {
|
||||||
|
let path = self.meta_dir.join("diagnostics").join(format!("database-recovery-{}.json", uuid::Uuid::new_v4()));
|
||||||
|
let report = serde_json::json!({ "schema": 1, "checkedAt": chrono::Utc::now().to_rfc3339(), "recoveryPoint": point.id, "objects": objects });
|
||||||
|
if let Err(error) = fsx::atomic_write_json(&path, &report) {
|
||||||
|
tracing::warn!(%error, "Could not save database recovery compatibility report");
|
||||||
}
|
}
|
||||||
|
let sample = objects.iter().take(3).map(|object| format!("{}.{} ({})", object["database"].as_str().unwrap_or("?"), object["name"].as_str().unwrap_or("?"), object["kind"].as_str().unwrap_or("?"))).collect::<Vec<_>>().join(", ");
|
||||||
|
return Err(Error::Invalid(format!("Automatic recovery does not support {} database objects: {sample}. Export diagnostics for the complete list. The update was not started.", objects.len())));
|
||||||
}
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
})
|
})
|
||||||
@@ -777,7 +907,116 @@ impl RepackEnv<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
impl Env for RepackEnv<'_> {
|
impl Env for RepackEnv<'_> {
|
||||||
|
fn recover_validation(&self) -> Result<()> {
|
||||||
|
crate::update_isolation::restore(self.root, self.meta_dir)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn activate(&self) -> Result<()> {
|
||||||
|
ensure_recovered(self.meta_dir)?;
|
||||||
|
let outcome = crate::driver::validate_update(self.root)?;
|
||||||
|
if outcome.ok { Ok(()) } else {
|
||||||
|
Err(Error::Invalid(format!("The update transaction finished, but the server could not start: {}", crate::driver::startup_failure(self.root, &outcome))))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn automatic_rollback(&self) -> bool { true }
|
||||||
|
fn rehearse(&self, manifest: &Manifest, tree: &Path, items: &[PlanItem], id: &str) -> Result<()> {
|
||||||
|
if items.iter().any(|item| item.action != Action::Skip && item.path.to_ascii_lowercase().starts_with("mysql/")) {
|
||||||
|
return Err(Error::Invalid("A server update cannot replace MySQL while using a cold recovery copy; a separate database engine upgrade is required.".into()));
|
||||||
|
}
|
||||||
|
let point = crate::backup::get(self.meta_dir, id)?;
|
||||||
|
let Some(snapshot) = &point.mysql_snapshot else {
|
||||||
|
// Docker uses its separate experimental release channel until its clone runner is qualified.
|
||||||
|
if crate::docker::is_docker(self.root) { return Ok(()); }
|
||||||
|
return Err(Error::Invalid("This installation has no complete MySQL recovery copy for an update rehearsal.".into()));
|
||||||
|
};
|
||||||
|
crate::mysql_snapshot::validate_connections(self.root, self.root)?;
|
||||||
|
crate::mysql_snapshot::stop(self.root)?;
|
||||||
|
let point_dir = crate::backup::point_json(self.meta_dir, id)?.parent().unwrap().to_path_buf();
|
||||||
|
let fixture = crate::mysql_snapshot::rehearsal_copy(self.root, self.meta_dir, &point_dir, snapshot)?;
|
||||||
|
let metadata = crate::registry::metadata_dir_for(&fixture)?;
|
||||||
|
let env = RepackEnv { root: &fixture, meta_dir: &metadata };
|
||||||
|
let result = crate::install::with_scratch_ports(&fixture, || {
|
||||||
|
let mut txn = Txn { id: "rehearsal".into(), state: State::Applying, from_version: None,
|
||||||
|
to_version: manifest.version.clone(), recovery_point: None, databases_started: false,
|
||||||
|
ops: items.iter().filter(|item| item.action != Action::Skip).map(|item| Op {
|
||||||
|
path: item.path.clone(), action: item.action, reason: item.reason.clone(),
|
||||||
|
new_sha256: manifest.files.iter().find(|file| file.path == item.path).unwrap().sha256.clone(),
|
||||||
|
had_previous: fsx::safe_join(&fixture, &item.path).is_ok_and(|path| path.is_file()), started:false, done:false,
|
||||||
|
}).collect(), message:None, recovery_hashes:BTreeMap::new() };
|
||||||
|
let before = txn_dir(&metadata, &txn.id)?.join("before");
|
||||||
|
fs::create_dir_all(&before)?;
|
||||||
|
apply_ops(&fixture, tree, &before, &manifest.files, &mut txn, &metadata, None)?;
|
||||||
|
crate::mysql_snapshot::validate_connections(&fixture, self.root)?;
|
||||||
|
crate::mysql_snapshot::isolate_connections(&fixture)?;
|
||||||
|
let identities = crate::backup::with_database(&fixture, |db| {
|
||||||
|
let identities = database_identities(db)?;
|
||||||
|
let realms = crate::realms::state(&fixture)?;
|
||||||
|
let mut modes = vec![realms.active];
|
||||||
|
if realms.wildcard_created { modes.push(if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa }); }
|
||||||
|
for (index, mode) in modes.into_iter().enumerate() {
|
||||||
|
let db = db.clone().for_realm(mode);
|
||||||
|
crate::schema_check::repair_missing_defaults(&db, &fixture, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||||
|
let list: Vec<_> = manifest.migrations.iter().filter(|migration| index == 0 || migration.db != "auth").cloned().collect();
|
||||||
|
let report = crate::migrations::apply_pending(&db, &list, &tree.join("_migrations"), &|| Ok("private rehearsal".into()))?;
|
||||||
|
if let Some((migration, error)) = report.failed { return Err(Error::Invalid(format!("Rehearsal migration {migration} failed: {error}"))); }
|
||||||
|
crate::schema_check::repair_missing_defaults(&db, &fixture, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||||
|
}
|
||||||
|
verify_database_identities(db, &identities)?;
|
||||||
|
Ok(identities)
|
||||||
|
})?;
|
||||||
|
env.validate()?;
|
||||||
|
crate::backup::with_database(&fixture, |db| verify_database_identities(db, &identities))?;
|
||||||
|
env.ensure_stopped()
|
||||||
|
});
|
||||||
|
let stopped = crate::mysql_snapshot::stop(&fixture);
|
||||||
|
let live_state = if result.is_ok() { crate::mysql_snapshot::stop(self.root).and_then(|()| crate::mysql_snapshot::unchanged(self.root, snapshot)) } else { Ok(()) };
|
||||||
|
let logs: BTreeMap<_, _> = ["Core/Logs/auth-console.log", "Core/Logs/world-console.log", "Core/Logs/supervisor.log", "mysql/logs/mysql-error.log"].into_iter()
|
||||||
|
.map(|path| (path, crate::diag::redact(&crate::health::tail(&fixture.join(path), 32768)))).collect();
|
||||||
|
let mut schema_reports = Vec::<serde_json::Value>::new();
|
||||||
|
if let Ok(entries) = fs::read_dir(metadata.join("diagnostics")) {
|
||||||
|
for entry in entries.flatten().filter(|entry| entry.file_name().to_string_lossy().starts_with("schema-validation-")) {
|
||||||
|
let path = fsx::ensure_within(&metadata, &entry.path())?;
|
||||||
|
if fs::metadata(&path)?.len() <= 4 * 1024 * 1024 { schema_reports.push(fsx::read_json(&path)?); }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let report = serde_json::json!({"schema":1,"checkedAt":chrono::Utc::now().to_rfc3339(),"toVersion":manifest.version,"recoveryPoint":id,
|
||||||
|
"result":if result.is_ok() && stopped.is_ok() && live_state.is_ok() {"passed"} else {"failed"}, "error":result.as_ref().err().map(ToString::to_string), "stopError":stopped.as_ref().err().map(ToString::to_string), "liveStateError":live_state.as_ref().err().map(ToString::to_string), "logs":logs,"schemaReports":schema_reports,"fixture":fixture});
|
||||||
|
let report_path = self.meta_dir.join("diagnostics").join(format!("database-rehearsal-{}.json", uuid::Uuid::new_v4()));
|
||||||
|
fsx::atomic_write_json(&report_path, &report)?;
|
||||||
|
stopped?;
|
||||||
|
let parent = fixture.parent().unwrap();
|
||||||
|
let owned = fsx::ensure_within(&self.meta_dir.join("rehearsals"), parent)?;
|
||||||
|
fs::remove_dir_all(owned)?;
|
||||||
|
live_state?;
|
||||||
|
result
|
||||||
|
}
|
||||||
fn preflight(&self, manifest: &Manifest) -> Result<()> {
|
fn preflight(&self, manifest: &Manifest) -> Result<()> {
|
||||||
|
crate::mysql_snapshot::stop_previous_rehearsals(self.meta_dir)?;
|
||||||
|
if let Some(compatibility) = &manifest.compatibility {
|
||||||
|
let (_, meta) = MetaDir::open(self.meta_dir)?;
|
||||||
|
if let Some(source) = meta.core.version.as_ref().and_then(|v| compatibility.source_databases.get(v)) {
|
||||||
|
if let Some(expected) = &source.schema_sha256 {
|
||||||
|
let contract = self.root.join("Scripts/database-schema.json");
|
||||||
|
if fsx::sha256_file(&contract)? != *expected {
|
||||||
|
return Err(Error::Invalid("The installed database schema contract differs from the qualified upgrade source; repair the installation first.".into()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
crate::backup::with_database(self.root, |db| {
|
||||||
|
let mut modes = vec![crate::realms::Mode::Coa];
|
||||||
|
if crate::realms::state(self.root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
|
||||||
|
for mode in modes {
|
||||||
|
if let Some(problem) = crate::schema_check::check_with_report(&db.clone().for_realm(mode), self.root)?.first() {
|
||||||
|
if crate::docker::is_docker(self.root) {
|
||||||
|
return Err(Error::Invalid(format!("The installed {} database does not match its upgrade source: {}.{}: {}", mode.name(), problem.database, problem.table, problem.detail)));
|
||||||
|
}
|
||||||
|
tracing::warn!(realm = mode.name(), table = %problem.table, "Installed schema differs; the private candidate rehearsal must qualify this database");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
})?;
|
||||||
|
}
|
||||||
|
}
|
||||||
self.pending_migrations(manifest).map(|_| ())
|
self.pending_migrations(manifest).map(|_| ())
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -811,6 +1050,13 @@ impl Env for RepackEnv<'_> {
|
|||||||
if !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) || !crate::backup::verify(self.meta_dir, id)?.ok {
|
if !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) || !crate::backup::verify(self.meta_dir, id)?.ok {
|
||||||
return Err(Error::Invalid("The full database recovery point is incomplete or damaged.".into()));
|
return Err(Error::Invalid("The full database recovery point is incomplete or damaged.".into()));
|
||||||
}
|
}
|
||||||
|
if let Some(snapshot) = &point.mysql_snapshot {
|
||||||
|
crate::mysql_snapshot::stop(self.root)?;
|
||||||
|
let point_dir = crate::backup::point_json(self.meta_dir, id)?.parent().unwrap().to_path_buf();
|
||||||
|
crate::mysql_snapshot::swap(self.root, self.meta_dir, &point_dir, snapshot, false)?;
|
||||||
|
crate::backup::restore_configs(self.root, self.meta_dir, id)?;
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
|
for component in point.components.iter().filter(|c| c.sha256.is_some()) {
|
||||||
crate::backup::restore_database(self.root, self.meta_dir, id, &component.name)?;
|
crate::backup::restore_database(self.root, self.meta_dir, id, &component.name)?;
|
||||||
}
|
}
|
||||||
@@ -822,12 +1068,17 @@ impl Env for RepackEnv<'_> {
|
|||||||
let root = self.root;
|
let root = self.root;
|
||||||
crate::backup::with_database(root, |db| {
|
crate::backup::with_database(root, |db| {
|
||||||
let realms = crate::realms::state(root)?;
|
let realms = crate::realms::state(root)?;
|
||||||
|
if let Some(contract) = manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT) {
|
||||||
|
self.migration_snapshot()?;
|
||||||
|
crate::schema_check::repair_missing_defaults(db, root, Some(&contract.sha256))?;
|
||||||
|
}
|
||||||
let mut result = crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| {
|
let mut result = crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| {
|
||||||
self.migration_snapshot()
|
self.migration_snapshot()
|
||||||
})?;
|
})?;
|
||||||
if realms.wildcard_created && result.failed.is_none() {
|
if realms.wildcard_created && result.failed.is_none() {
|
||||||
let other = if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa };
|
let other = if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa };
|
||||||
let other_db = db.clone().for_realm(other);
|
let other_db = db.clone().for_realm(other);
|
||||||
|
crate::schema_check::repair_missing_defaults(&other_db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||||
let shared_snapshot = result.snapshot.clone();
|
let shared_snapshot = result.snapshot.clone();
|
||||||
let migrations: Vec<_> = manifest.migrations.iter().filter(|m| m.db != "auth").cloned().collect();
|
let migrations: Vec<_> = manifest.migrations.iter().filter(|m| m.db != "auth").cloned().collect();
|
||||||
let extra = crate::migrations::apply_pending(&other_db, &migrations, staged, &|| {
|
let extra = crate::migrations::apply_pending(&other_db, &migrations, staged, &|| {
|
||||||
@@ -838,13 +1089,15 @@ impl Env for RepackEnv<'_> {
|
|||||||
result.failed = extra.failed;
|
result.failed = extra.failed;
|
||||||
if result.snapshot.is_none() { result.snapshot = extra.snapshot; }
|
if result.snapshot.is_none() { result.snapshot = extra.snapshot; }
|
||||||
if result.failed.is_none() {
|
if result.failed.is_none() {
|
||||||
if let Some(p) = crate::schema_check::check(&other_db, root)?.first() {
|
crate::schema_check::repair_missing_defaults(&other_db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||||
|
if let Some(p) = crate::schema_check::check_with_report(&other_db, root)?.first() {
|
||||||
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", other.name(), p.table, p.column, p.detail)));
|
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", other.name(), p.table, p.column, p.detail)));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
if result.failed.is_none() {
|
if result.failed.is_none() {
|
||||||
let problems = crate::schema_check::check(db, root)?;
|
crate::schema_check::repair_missing_defaults(db, root, manifest.files.iter().find(|file| file.path == crate::schema_check::CONTRACT).map(|file| file.sha256.as_str()))?;
|
||||||
|
let problems = crate::schema_check::check_with_report(db, root)?;
|
||||||
if let Some(p) = problems.first() {
|
if let Some(p) = problems.first() {
|
||||||
return Err(Error::Invalid(format!("Database validation failed: {}.{}.{}: {} ({} problems).", p.database, p.table, p.column, p.detail, problems.len())));
|
return Err(Error::Invalid(format!("Database validation failed: {}.{}.{}: {} ({} problems).", p.database, p.table, p.column, p.detail, problems.len())));
|
||||||
}
|
}
|
||||||
@@ -854,61 +1107,111 @@ impl Env for RepackEnv<'_> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn validate(&self) -> Result<()> {
|
fn validate(&self) -> Result<()> {
|
||||||
use crate::process::{observe, ServiceState};
|
self.validate_server(true)
|
||||||
crate::backup::with_database(self.root, |db| {
|
|
||||||
let mut modes = vec![crate::realms::Mode::Coa];
|
|
||||||
if crate::realms::state(self.root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
|
|
||||||
for mode in modes {
|
|
||||||
if let Some(p) = crate::schema_check::check(&db.clone().for_realm(mode), self.root)?.first() {
|
|
||||||
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", mode.name(), p.database, p.table, p.detail)));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Ok(())
|
|
||||||
})?;
|
|
||||||
// The check start is the first start of the new build: give the module configs the settings the update added
|
|
||||||
// (as a normal start does), or the server logs a "missing property" line for every one of them.
|
|
||||||
match crate::registry::MetaDir::open(self.meta_dir) {
|
|
||||||
Ok((_, meta)) if meta.kind == crate::registry::InstallKind::New => {
|
|
||||||
let _ = crate::config::materialize_module_configs(self.root);
|
|
||||||
}
|
|
||||||
// An imported server gets the files it lacks (nothing it has is changed).
|
|
||||||
_ => {
|
|
||||||
let _ = crate::config::create_missing_module_configs(self.root);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
let started = match crate::driver::validate_update(self.root) {
|
|
||||||
Ok(out) => out,
|
|
||||||
Err(e) => {
|
|
||||||
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
|
||||||
return Err(e);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
let ports = crate::layout::read_ports(self.root);
|
|
||||||
let healthy = started.ok && {
|
|
||||||
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
|
|
||||||
let mut ready_since = None;
|
|
||||||
loop {
|
|
||||||
let o = observe(self.root, &ports);
|
|
||||||
if o.mysql.state == ServiceState::Running && o.auth.state == ServiceState::Running && o.world.state == ServiceState::Running && o.secondary_world.as_ref().is_none_or(|s| s.state == ServiceState::Running) {
|
|
||||||
let since = ready_since.get_or_insert_with(std::time::Instant::now);
|
|
||||||
if since.elapsed() >= std::time::Duration::from_secs(10) { break true; }
|
|
||||||
} else {
|
|
||||||
ready_since = None;
|
|
||||||
}
|
|
||||||
if std::time::Instant::now() > deadline {
|
|
||||||
break false;
|
|
||||||
}
|
|
||||||
std::thread::sleep(std::time::Duration::from_secs(2));
|
|
||||||
}
|
|
||||||
};
|
|
||||||
if healthy {
|
|
||||||
return Ok(());
|
|
||||||
}
|
|
||||||
let cause = crate::driver::startup_failure(self.root, &started);
|
|
||||||
// Leave the files unlocked so that a rollback can replace them.
|
|
||||||
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
|
||||||
Err(Error::Invalid(cause))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn validate_recovery(&self) -> Result<()> {
|
||||||
|
self.validate_server(false)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl RepackEnv<'_> {
|
||||||
|
fn validate_server(&self, check_schema: bool) -> Result<()> {
|
||||||
|
let stopped = crate::driver::run(self.root, crate::driver::Verb::StopAll)?;
|
||||||
|
if !stopped.ok { return Err(Error::Invalid("Could not stop the server before isolated validation.".into())); }
|
||||||
|
self.ensure_stopped()?;
|
||||||
|
self.recover_validation()?;
|
||||||
|
let result = (|| -> Result<()> {
|
||||||
|
crate::update_isolation::begin(self.root, self.meta_dir)?;
|
||||||
|
use crate::process::{observe, ServiceState};
|
||||||
|
if check_schema { crate::backup::with_database(self.root, |db| {
|
||||||
|
let mut modes = vec![crate::realms::Mode::Coa];
|
||||||
|
if crate::realms::state(self.root)?.wildcard_created { modes.push(crate::realms::Mode::Wildcard); }
|
||||||
|
for mode in modes {
|
||||||
|
if let Some(p) = crate::schema_check::check_with_report(&db.clone().for_realm(mode), self.root)?.first() {
|
||||||
|
return Err(Error::Invalid(format!("Database validation failed on {}: {}.{}: {}", mode.name(), p.database, p.table, p.detail)));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
})?; }
|
||||||
|
// The check start is the first start of the new build: give the module configs the settings the update added
|
||||||
|
// (as a normal start does), or the server logs a "missing property" line for every one of them.
|
||||||
|
match crate::registry::MetaDir::open(self.meta_dir) {
|
||||||
|
Ok((_, meta)) if meta.kind == crate::registry::InstallKind::New => {
|
||||||
|
let _ = crate::config::materialize_module_configs(self.root);
|
||||||
|
}
|
||||||
|
// An imported server gets the files it lacks (nothing it has is changed).
|
||||||
|
_ => {
|
||||||
|
let _ = crate::config::create_missing_module_configs(self.root);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let started = match crate::driver::validate_update(self.root) {
|
||||||
|
Ok(out) => out,
|
||||||
|
Err(e) => {
|
||||||
|
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
||||||
|
return Err(e);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let ports = crate::layout::read_ports(self.root);
|
||||||
|
let healthy = started.ok && {
|
||||||
|
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(180);
|
||||||
|
let mut ready_since = None;
|
||||||
|
loop {
|
||||||
|
let o = observe(self.root, &ports);
|
||||||
|
if o.mysql.state == ServiceState::Running && o.auth.state == ServiceState::Running && o.world.state == ServiceState::Running && o.secondary_world.as_ref().is_none_or(|s| s.state == ServiceState::Running) {
|
||||||
|
let since = ready_since.get_or_insert_with(std::time::Instant::now);
|
||||||
|
if since.elapsed() >= std::time::Duration::from_secs(10) { break true; }
|
||||||
|
} else {
|
||||||
|
ready_since = None;
|
||||||
|
}
|
||||||
|
if std::time::Instant::now() > deadline {
|
||||||
|
break false;
|
||||||
|
}
|
||||||
|
std::thread::sleep(std::time::Duration::from_secs(2));
|
||||||
|
}
|
||||||
|
};
|
||||||
|
if healthy {
|
||||||
|
return Ok(());
|
||||||
|
}
|
||||||
|
let cause = crate::driver::startup_failure(self.root, &started);
|
||||||
|
// Leave the files unlocked so that a rollback can replace them.
|
||||||
|
let _ = crate::driver::run(self.root, crate::driver::Verb::StopAll);
|
||||||
|
Err(Error::Invalid(cause))
|
||||||
|
})();
|
||||||
|
let stopped = crate::driver::run(self.root, crate::driver::Verb::StopAll)?;
|
||||||
|
if !stopped.ok {
|
||||||
|
return Err(Error::Invalid("Isolated validation could not stop the server; recovery configurations were preserved.".into()));
|
||||||
|
}
|
||||||
|
self.ensure_stopped()?;
|
||||||
|
self.recover_validation()?;
|
||||||
|
result
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
fn database_identities(db: &crate::db::Db) -> Result<BTreeMap<String, std::collections::BTreeSet<String>>> {
|
||||||
|
let db = db.clone().for_realm(crate::realms::Mode::Coa);
|
||||||
|
let mut identities = BTreeMap::new();
|
||||||
|
for (schema, table, columns) in [
|
||||||
|
("acore_characters", "characters", "guid,account,HEX(name)"),
|
||||||
|
("acore_characters_wildcard", "characters", "guid,account,HEX(name)"),
|
||||||
|
("acore_auth", "account", "id,HEX(username)"),
|
||||||
|
] {
|
||||||
|
if !db.schema_exists(schema)? || !db.tables(schema)?.iter().any(|name| name == table) { continue; }
|
||||||
|
let rows = db.query(&format!("SELECT {columns} FROM `{schema}`.`{table}`;"))?;
|
||||||
|
identities.insert(schema.into(), rows.lines().map(str::to_string).collect());
|
||||||
|
}
|
||||||
|
Ok(identities)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn verify_database_identities(db: &crate::db::Db, before: &BTreeMap<String, std::collections::BTreeSet<String>>) -> Result<()> {
|
||||||
|
let after = database_identities(db)?;
|
||||||
|
for (schema, expected) in before {
|
||||||
|
if after.get(schema).is_none_or(|actual| !expected.is_subset(actual)) {
|
||||||
|
return Err(Error::Invalid(format!("The private update changed or removed existing character or account identities in {schema}.")));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
@@ -921,6 +1224,11 @@ mod tests {
|
|||||||
use std::cell::{Cell, RefCell};
|
use std::cell::{Cell, RefCell};
|
||||||
|
|
||||||
struct Fake {
|
struct Fake {
|
||||||
|
activation_expected: RefCell<Option<(PathBuf, String)>>,
|
||||||
|
activation_failed: Cell<bool>,
|
||||||
|
activated: Cell<bool>,
|
||||||
|
automatic_rollback: Cell<bool>,
|
||||||
|
recovery_healthy: Cell<bool>,
|
||||||
stopped: Cell<bool>,
|
stopped: Cell<bool>,
|
||||||
healthy: Cell<bool>,
|
healthy: Cell<bool>,
|
||||||
snapshot_ok: Cell<bool>,
|
snapshot_ok: Cell<bool>,
|
||||||
@@ -928,15 +1236,32 @@ mod tests {
|
|||||||
migrate_fail: Cell<bool>,
|
migrate_fail: Cell<bool>,
|
||||||
preflight_fail: Cell<bool>,
|
preflight_fail: Cell<bool>,
|
||||||
restore_fail: Cell<bool>,
|
restore_fail: Cell<bool>,
|
||||||
|
rehearsal_fail: Cell<bool>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Fake {
|
impl Fake {
|
||||||
fn ok() -> Fake {
|
fn ok() -> Fake {
|
||||||
Fake { stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false), preflight_fail: Cell::new(false), restore_fail: Cell::new(false) }
|
Fake { activation_expected: RefCell::new(None), activation_failed: Cell::new(false), activated: Cell::new(false), automatic_rollback: Cell::new(false), recovery_healthy: Cell::new(true), stopped: Cell::new(true), healthy: Cell::new(true), snapshot_ok: Cell::new(true), calls: Default::default(), migrate_fail: Cell::new(false), preflight_fail: Cell::new(false), restore_fail: Cell::new(false), rehearsal_fail: Cell::new(false) }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Env for Fake {
|
impl Env for Fake {
|
||||||
|
fn rehearse(&self, _: &Manifest, _: &Path, _: &[PlanItem], _: &str) -> Result<()> {
|
||||||
|
if self.rehearsal_fail.get() { Err(Error::Invalid("SQL failed in the private copy".into())) } else { Ok(()) }
|
||||||
|
}
|
||||||
|
fn activate(&self) -> Result<()> {
|
||||||
|
if let Some((meta, version)) = self.activation_expected.borrow().as_ref() {
|
||||||
|
ensure_recovered(meta)?;
|
||||||
|
assert_eq!(MetaDir::open(meta)?.1.core.version.as_ref(), Some(version));
|
||||||
|
}
|
||||||
|
self.activated.set(true);
|
||||||
|
if self.activation_failed.get() { Err(Error::Invalid("Public startup failed".into())) } else { Ok(()) }
|
||||||
|
}
|
||||||
|
fn automatic_rollback(&self) -> bool { self.automatic_rollback.get() }
|
||||||
|
fn validate_recovery(&self) -> Result<()> {
|
||||||
|
self.calls.borrow_mut().push("validate-recovery");
|
||||||
|
if self.recovery_healthy.get() { Ok(()) } else { Err(Error::Invalid("Restored server is unhealthy".into())) }
|
||||||
|
}
|
||||||
fn preflight(&self, _: &Manifest) -> Result<()> {
|
fn preflight(&self, _: &Manifest) -> Result<()> {
|
||||||
if self.preflight_fail.get() { Err(Error::Invalid("Conflicting migration history".into())) } else { Ok(()) }
|
if self.preflight_fail.get() { Err(Error::Invalid("Conflicting migration history".into())) } else { Ok(()) }
|
||||||
}
|
}
|
||||||
@@ -1092,6 +1417,27 @@ mod tests {
|
|||||||
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_docker_server_is_never_given_the_repack_files() {
|
||||||
|
// Found by trying the installer: the update check of a Docker server read the Windows channel and offered its files.
|
||||||
|
let w = world(&[], false);
|
||||||
|
write(&w.root, "Settings/docker.json", br#"{"project":"t1"}"#);
|
||||||
|
let before = read(&w, "Core/worldserver.exe");
|
||||||
|
let meta = InstallMeta::new(InstallKind::New, &w.root);
|
||||||
|
|
||||||
|
let err = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap_err();
|
||||||
|
assert!(err.to_string().contains("Docker"), "{err}");
|
||||||
|
let err = run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err();
|
||||||
|
assert!(err.to_string().contains("Docker"), "{err}");
|
||||||
|
assert!(rollback(&w.root, &w.meta, "any", &Fake::ok()).is_err());
|
||||||
|
assert_eq!(read(&w, "Core/worldserver.exe"), before, "nothing was touched");
|
||||||
|
assert!(!w.root.join("Core/newfile.dll").exists());
|
||||||
|
|
||||||
|
// The same package is applied to the same folder once it is not a Docker server.
|
||||||
|
fs::remove_file(w.root.join("Settings/docker.json")).unwrap();
|
||||||
|
assert_eq!(run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap().txn.state, State::Committed);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn happy_path_replaces_creates_merges_and_records_ownership() {
|
fn happy_path_replaces_creates_merges_and_records_ownership() {
|
||||||
let w = world(&[], false);
|
let w = world(&[], false);
|
||||||
@@ -1112,6 +1458,26 @@ mod tests {
|
|||||||
assert!(!w.root.join("Core/worldserver.exe.coa-new").exists());
|
assert!(!w.root.join("Core/worldserver.exe.coa-new").exists());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn public_startup_requires_a_completed_transaction_and_saved_version() {
|
||||||
|
let w = world(&[], false);
|
||||||
|
let env = Fake::ok();
|
||||||
|
*env.activation_expected.borrow_mut() = Some((w.meta.clone(), "2.0.0".into()));
|
||||||
|
run(&w, &env, BTreeMap::new(), None).unwrap();
|
||||||
|
assert!(env.activated.get());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn startup_failure_after_commit_does_not_restore_a_live_database() {
|
||||||
|
let w = world(&[], true);
|
||||||
|
let env = Fake::ok();
|
||||||
|
env.activation_failed.set(true);
|
||||||
|
assert!(run(&w, &env, BTreeMap::new(), None).is_err());
|
||||||
|
assert!(ensure_recovered(&w.meta).is_ok());
|
||||||
|
assert_eq!(MetaDir::open(&w.meta).unwrap().1.core.version.as_deref(), Some("2.0.0"));
|
||||||
|
assert!(!env.calls.borrow().contains(&"restore-databases"));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn an_integrated_launcher_is_current_but_user_edits_and_new_package_bytes_are_not() {
|
fn an_integrated_launcher_is_current_but_user_edits_and_new_package_bytes_are_not() {
|
||||||
let source = b"import sys\nfrom pathlib import Path\nfrom squid_playerbots import configure\nROOT = Path(__file__).resolve().parents[1]\n";
|
let source = b"import sys\nfrom pathlib import Path\nfrom squid_playerbots import configure\nROOT = Path(__file__).resolve().parents[1]\n";
|
||||||
@@ -1131,6 +1497,11 @@ mod tests {
|
|||||||
changed.files.iter_mut().find(|file| file.path == "Scripts/manage.py").unwrap().sha256 = fsx::sha256_bytes(b"new launcher");
|
changed.files.iter_mut().find(|file| file.path == "Scripts/manage.py").unwrap().sha256 = fsx::sha256_bytes(b"new launcher");
|
||||||
assert!(launcher_already_integrated(&w.root, &w.meta, &meta, &changed, &Source::Dir(w.pkg.clone())).is_err());
|
assert!(launcher_already_integrated(&w.root, &w.meta, &meta, &changed, &Source::Dir(w.pkg.clone())).is_err());
|
||||||
write(&w.root, "Scripts/manage.py", format!("{integrated}\n# user edit\n").as_bytes());
|
write(&w.root, "Scripts/manage.py", format!("{integrated}\n# user edit\n").as_bytes());
|
||||||
|
// Same version: the owner's edit is not an update (Repair lists and restores it).
|
||||||
|
let p = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap();
|
||||||
|
assert!(p.items.iter().all(|item| item.action == Action::Skip) && p.conflicts.is_empty());
|
||||||
|
// An older installed build with the same edit does need a decision.
|
||||||
|
meta.core.version = Some("1.0.0".into());
|
||||||
let p = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap();
|
let p = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap();
|
||||||
assert_eq!(p.items.iter().find(|item| item.path == "Scripts/manage.py").unwrap().action, Action::Conflict);
|
assert_eq!(p.items.iter().find(|item| item.path == "Scripts/manage.py").unwrap().action, Action::Conflict);
|
||||||
meta.original_hashes.insert("Scripts/manage.py".into(), fsx::sha256_file(&w.root.join("Scripts/manage.py")).unwrap());
|
meta.original_hashes.insert("Scripts/manage.py".into(), fsx::sha256_file(&w.root.join("Scripts/manage.py")).unwrap());
|
||||||
@@ -1181,6 +1552,46 @@ mod tests {
|
|||||||
assert_eq!(fs::read(saved).unwrap(), b"my-custom-build", "the replaced custom build is kept for rollback");
|
assert_eq!(fs::read(saved).unwrap(), b"my-custom-build", "the replaced custom build is kept for rollback");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn power_loss_during_bulk_files_restores_written_and_unwritten_files() {
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let root = d.path().join("root");
|
||||||
|
let meta = d.path().join("meta");
|
||||||
|
let tree = d.path().join("tree");
|
||||||
|
let before = meta.join("updates/bulk/before");
|
||||||
|
let mut files = Vec::new();
|
||||||
|
let mut ops = Vec::new();
|
||||||
|
for (path, previous) in [("Data/maps/first.map", true), ("Data/maps/new.map", false), ("Data/maps/last.map", true)] {
|
||||||
|
if previous { write(&root, path, b"old"); }
|
||||||
|
write(&tree, path, b"new");
|
||||||
|
let hash = fsx::sha256_file(&tree.join(path)).unwrap();
|
||||||
|
files.push(FileEntry { path: path.into(), sha256: hash.clone(), size: 3, policy: ReplacePolicy::Replace, owner: crate::manifest::Owner::Core });
|
||||||
|
ops.push(Op { path: path.into(), action: if previous { Action::Replace } else { Action::Create }, reason: None,
|
||||||
|
new_sha256: hash, had_previous: previous, started: false, done: false });
|
||||||
|
}
|
||||||
|
let mut txn = Txn { id: "bulk".into(), state: State::Applying, from_version: Some("1".into()), to_version: "2".into(),
|
||||||
|
recovery_point: None, databases_started: false, ops, message: None, recovery_hashes: BTreeMap::new() };
|
||||||
|
fs::create_dir_all(before.parent().unwrap()).unwrap();
|
||||||
|
assert!(apply_ops(&root, &tree, &before, &files, &mut txn, &meta, Some(2)).is_err());
|
||||||
|
// A power loss sees the pre-write checkpoint, not the in-memory completed flags.
|
||||||
|
let mut durable = load(&meta, "bulk").unwrap();
|
||||||
|
assert!(durable.ops.iter().all(|op| op.started && !op.done));
|
||||||
|
assert_eq!(fs::read(root.join("Data/maps/last.map")).unwrap(), b"old");
|
||||||
|
restore_files(&root, &before, &mut durable).unwrap();
|
||||||
|
assert_eq!(fs::read(root.join("Data/maps/first.map")).unwrap(), b"old");
|
||||||
|
assert_eq!(fs::read(root.join("Data/maps/last.map")).unwrap(), b"old");
|
||||||
|
assert!(!root.join("Data/maps/new.map").exists());
|
||||||
|
// If preparing any recovery copy fails, no destination may be changed.
|
||||||
|
for op in &mut durable.ops { op.started = false; op.done = false; }
|
||||||
|
durable.recovery_hashes.clear();
|
||||||
|
save(&meta, &durable).unwrap();
|
||||||
|
fs::remove_file(root.join("Data/maps/last.map")).unwrap();
|
||||||
|
assert!(apply_ops(&root, &tree, &before, &files, &mut durable, &meta, None).is_err());
|
||||||
|
assert_eq!(fs::read(root.join("Data/maps/first.map")).unwrap(), b"old");
|
||||||
|
assert!(!root.join("Data/maps/new.map").exists());
|
||||||
|
assert!(load(&meta, "bulk").unwrap().ops.iter().all(|op| !op.started));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn failure_in_the_middle_of_applying_restores_every_file_byte_for_byte() {
|
fn failure_in_the_middle_of_applying_restores_every_file_byte_for_byte() {
|
||||||
for fail_after in [0usize, 1, 2] {
|
for fail_after in [0usize, 1, 2] {
|
||||||
@@ -1216,6 +1627,75 @@ mod tests {
|
|||||||
assert!(rollback(&w.root, &w.meta, &out.txn.id, &env).is_err(), "already rolled back");
|
assert!(rollback(&w.root, &w.meta, &out.txn.id, &env).is_err(), "already rolled back");
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn automatic_health_failure_restores_databases_files_and_checks_recovery() {
|
||||||
|
let w = world(&[], true);
|
||||||
|
let env = Fake::ok();
|
||||||
|
env.automatic_rollback.set(true);
|
||||||
|
env.healthy.set(false);
|
||||||
|
assert!(run(&w, &env, BTreeMap::new(), None).unwrap_err().to_string().contains("restored"));
|
||||||
|
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||||
|
assert!(!w.root.join("Core/newfile.dll").exists());
|
||||||
|
assert!(env.calls.borrow().contains(&"restore-databases"));
|
||||||
|
assert!(env.calls.borrow().contains(&"validate-recovery"));
|
||||||
|
assert!(unfinished(&w.meta).is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn incompatible_source_or_platform_is_rejected_without_touching_installation() {
|
||||||
|
let w = world(&[], false);
|
||||||
|
let (_, meta) = MetaDir::open(&w.meta).unwrap();
|
||||||
|
let mut manifest = Manifest::parse(&fs::read(w.pkg.join("manifest.json")).unwrap()).unwrap();
|
||||||
|
manifest.min_manager_version = "0.6.13".into();
|
||||||
|
manifest.core.commit = Some("a".repeat(40));
|
||||||
|
manifest.compatibility = Some(crate::manifest::Compatibility { schema: 1,
|
||||||
|
platform: if cfg!(windows) { "windows-x86_64" } else { "linux-x86_64" }.into(),
|
||||||
|
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
|
||||||
|
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["1.0.0".into()] });
|
||||||
|
manifest.validate().unwrap();
|
||||||
|
validate_candidate(&meta, &manifest).unwrap();
|
||||||
|
manifest.compatibility.as_mut().unwrap().source_versions = vec!["0.9.0".into()];
|
||||||
|
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("compatibility matrix"));
|
||||||
|
manifest.compatibility.as_mut().unwrap().source_versions = vec!["1.0.0".into()];
|
||||||
|
manifest.compatibility.as_mut().unwrap().platform = if cfg!(windows) { "linux-x86_64" } else { "windows-x86_64" }.into();
|
||||||
|
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("targets"));
|
||||||
|
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||||
|
assert!(unfinished(&w.meta).is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn changed_installed_schema_contract_blocks_before_database_access() {
|
||||||
|
let w = world(&[], false);
|
||||||
|
write(&w.root, "Scripts/database-schema.json", b"modified schema contract");
|
||||||
|
let mut manifest = Manifest::parse(&fs::read(w.pkg.join("manifest.json")).unwrap()).unwrap();
|
||||||
|
manifest.compatibility = Some(crate::manifest::Compatibility { schema: 1,
|
||||||
|
platform: "windows-x86_64".into(), core_commit: "a".repeat(40),
|
||||||
|
module_commits: [("squid".into(), "b".repeat(40))].into(), client_patch_version: "1.5.1".into(),
|
||||||
|
source_versions: vec!["1.0.0".into()],
|
||||||
|
source_databases: [("1.0.0".into(), crate::manifest::SourceDatabase {
|
||||||
|
manifest_sha256: "a".repeat(64), schema_sha256: Some("b".repeat(64)) })].into() });
|
||||||
|
let env = RepackEnv { root: &w.root, meta_dir: &w.meta };
|
||||||
|
let error = env.preflight(&manifest).unwrap_err().to_string();
|
||||||
|
assert!(error.contains("schema contract differs"), "{error}");
|
||||||
|
assert!(!w.root.join("Runtime/python/python.exe").exists());
|
||||||
|
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||||
|
assert!(unfinished(&w.meta).is_none());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn unhealthy_restoration_preserves_recovery_and_blocks_startup() {
|
||||||
|
let w = world(&[], true);
|
||||||
|
let env = Fake::ok();
|
||||||
|
env.automatic_rollback.set(true);
|
||||||
|
env.healthy.set(false);
|
||||||
|
env.recovery_healthy.set(false);
|
||||||
|
assert!(run(&w, &env, BTreeMap::new(), None).unwrap_err().to_string().contains("Recovery failed"));
|
||||||
|
let pending = unfinished(&w.meta).unwrap();
|
||||||
|
assert_eq!(pending.state, State::Failed);
|
||||||
|
assert!(txn_dir(&w.meta, &pending.id).unwrap().join("before").exists());
|
||||||
|
assert!(ensure_recovered(&w.meta).is_err());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn retrying_startup_commits_without_reapplying_sql_or_restoring_databases() {
|
fn retrying_startup_commits_without_reapplying_sql_or_restoring_databases() {
|
||||||
let w = world(&[], true);
|
let w = world(&[], true);
|
||||||
@@ -1409,6 +1889,23 @@ mod tests {
|
|||||||
assert!(fs::read_dir(w.meta.join("updates")).unwrap().next().is_none());
|
assert!(fs::read_dir(w.meta.join("updates")).unwrap().next().is_none());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn failed_rehearsal_preserves_installed_files_version_and_recovery_point() {
|
||||||
|
let w = world(&[], true);
|
||||||
|
let env = Fake::ok();
|
||||||
|
env.rehearsal_fail.set(true);
|
||||||
|
let original = fsx::sha256_file(&w.meta.join("install.json")).unwrap();
|
||||||
|
let error = run(&w, &env, BTreeMap::new(), None).unwrap_err();
|
||||||
|
assert!(error.to_string().contains("installed server was not updated"));
|
||||||
|
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
|
||||||
|
assert_eq!(fsx::sha256_file(&w.meta.join("install.json")).unwrap(), original);
|
||||||
|
assert_eq!(&*env.calls.borrow(), &["stop", "snapshot"]);
|
||||||
|
assert!(pending_checked(&w.meta).unwrap().is_none());
|
||||||
|
let journal = journals(&w.meta).unwrap().remove(0);
|
||||||
|
assert_eq!(journal.recovery_point.as_deref(), Some("rp-1"));
|
||||||
|
assert!(!journal.databases_started && journal.ops.is_empty());
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn missing_and_semantically_corrupt_journals_block_operations() {
|
fn missing_and_semantically_corrupt_journals_block_operations() {
|
||||||
let w = world(&[], false);
|
let w = world(&[], false);
|
||||||
|
|||||||
@@ -0,0 +1,163 @@
|
|||||||
|
use std::{collections::BTreeMap, fs, path::Path};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use crate::{config::parser::ConfFile, fsx, Error, Result};
|
||||||
|
|
||||||
|
const FILES: &[&str] = &[
|
||||||
|
"Settings/repack.json", "Settings/realm-profile.json",
|
||||||
|
"Settings/worldserver.conf.template", "Settings/authserver.conf.template",
|
||||||
|
"Core/configs/worldserver.conf", "Core/configs/authserver.conf",
|
||||||
|
"Settings/realm-profiles/coa.json", "Settings/realm-profiles/wildcard.json",
|
||||||
|
".realms/secondary/Settings/repack.json", ".realms/secondary/Settings/realm-profile.json",
|
||||||
|
".realms/secondary/Settings/worldserver.conf.template", ".realms/secondary/Settings/authserver.conf.template",
|
||||||
|
".realms/secondary/Core/configs/worldserver.conf", ".realms/secondary/Core/configs/authserver.conf",
|
||||||
|
];
|
||||||
|
|
||||||
|
#[derive(Serialize, Deserialize)]
|
||||||
|
#[serde(deny_unknown_fields)]
|
||||||
|
struct Saved { bytes: Option<Vec<u8>>, sha256: Option<String> }
|
||||||
|
|
||||||
|
pub(crate) fn pending(meta: &Path) -> bool { meta.join("validation-configs.json").exists() }
|
||||||
|
|
||||||
|
pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> {
|
||||||
|
if pending(meta) { return Err(Error::Invalid("Interrupted isolated validation must be recovered first.".into())); }
|
||||||
|
let mut saved = BTreeMap::new();
|
||||||
|
for rel in FILES {
|
||||||
|
let path = fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
|
||||||
|
let bytes = if path.exists() { Some(fs::read(path)?) } else { None };
|
||||||
|
let sha256 = bytes.as_ref().map(|b| fsx::sha256_bytes(b));
|
||||||
|
saved.insert(*rel, Saved { bytes, sha256 });
|
||||||
|
}
|
||||||
|
let mut settings: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json"))?;
|
||||||
|
let mut realm: Option<serde_json::Value> = if root.join("Settings/realm-profile.json").exists() {
|
||||||
|
Some(fsx::read_json(&root.join("Settings/realm-profile.json"))?)
|
||||||
|
} else { None };
|
||||||
|
let mut excluded: std::collections::BTreeSet<u64> = ["mysqlPort", "authPort", "worldPort", "raPort"].iter()
|
||||||
|
.filter_map(|key| settings[*key].as_u64()).collect();
|
||||||
|
if let Some(state) = &realm {
|
||||||
|
excluded.extend(["secondary_world_port", "secondary_ra_port"].iter().filter_map(|key| state[*key].as_u64()));
|
||||||
|
}
|
||||||
|
let mut sockets = Vec::new();
|
||||||
|
let mut reserve = || -> Result<u16> {
|
||||||
|
loop {
|
||||||
|
let socket = std::net::TcpListener::bind("127.0.0.1:0")?;
|
||||||
|
let port = socket.local_addr()?.port();
|
||||||
|
if excluded.insert(u64::from(port)) {
|
||||||
|
sockets.push(socket);
|
||||||
|
return Ok(port);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
for key in ["authPort", "worldPort", "raPort"] { settings[key] = reserve()?.into(); }
|
||||||
|
if let Some(state) = &mut realm {
|
||||||
|
for key in ["secondary_world_port", "secondary_ra_port"] {
|
||||||
|
state[key] = reserve()?.into();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
let mut configs = Vec::new();
|
||||||
|
for rel in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] {
|
||||||
|
let path = root.join(rel);
|
||||||
|
if !path.exists() && rel.ends_with(".template") {
|
||||||
|
return Err(Error::Invalid(format!("Cannot isolate validation without {rel}.")));
|
||||||
|
}
|
||||||
|
if path.exists() {
|
||||||
|
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
|
||||||
|
conf.set("BindIP", "\"127.0.0.1\"", &[]);
|
||||||
|
if rel.contains("worldserver") { conf.set("Ra.IP", "\"127.0.0.1\"", &[]); }
|
||||||
|
configs.push((path, conf.to_text()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fsx::atomic_write_json(&meta.join("validation-configs.json"), &saved)?;
|
||||||
|
fsx::atomic_write_json(&root.join("Settings/repack.json"), &settings)?;
|
||||||
|
if let Some(state) = realm { fsx::atomic_write_json(&root.join("Settings/realm-profile.json"), &state)?; }
|
||||||
|
for (path, text) in configs { fsx::atomic_write(&path, text.as_bytes())?; }
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
fn fixture() -> (tempfile::TempDir, std::path::PathBuf, std::path::PathBuf) {
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
let root = dir.path().join("server");
|
||||||
|
let meta = dir.path().join("metadata");
|
||||||
|
fs::create_dir_all(root.join("Settings")).unwrap();
|
||||||
|
fs::create_dir_all(&meta).unwrap();
|
||||||
|
fsx::atomic_write_json(&root.join(FILES[0]), &serde_json::json!({"mysqlPort":3306,"authPort":3724,"worldPort":8085,"raPort":3443})).unwrap();
|
||||||
|
fsx::atomic_write_json(&root.join(FILES[1]), &serde_json::json!({"simultaneous":true,"secondary_world_port":8086,"secondary_ra_port":3444})).unwrap();
|
||||||
|
for rel in [FILES[2], FILES[3]] {
|
||||||
|
fsx::atomic_write(&root.join(rel), b"BindIP = \"0.0.0.0\"\r\nRa.IP = \"0.0.0.0\"\r\n").unwrap();
|
||||||
|
}
|
||||||
|
(dir, root, meta)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn interrupted_validation_restores_original_bytes_and_absent_files() {
|
||||||
|
let (_dir, root, meta) = fixture();
|
||||||
|
let original: Vec<_> = FILES.iter().map(|p| fs::read(root.join(p)).ok()).collect();
|
||||||
|
begin(&root, &meta).unwrap();
|
||||||
|
assert!(crate::update::ensure_recovered(&meta).is_err());
|
||||||
|
assert!(begin(&root, &meta).is_err());
|
||||||
|
let settings: serde_json::Value = fsx::read_json(&root.join(FILES[0])).unwrap();
|
||||||
|
assert_eq!(settings["mysqlPort"], 3306);
|
||||||
|
let realm: serde_json::Value = fsx::read_json(&root.join(FILES[1])).unwrap();
|
||||||
|
let ports: std::collections::BTreeSet<_> = [settings["authPort"].as_u64(), settings["worldPort"].as_u64(), settings["raPort"].as_u64(), realm["secondary_world_port"].as_u64(), realm["secondary_ra_port"].as_u64()].into_iter().collect();
|
||||||
|
assert_eq!(ports.len(), 5);
|
||||||
|
let config = ConfFile::parse_bytes(&fs::read(root.join(FILES[2])).unwrap()).unwrap();
|
||||||
|
assert_eq!(config.get("BindIP"), Some("\"127.0.0.1\""));
|
||||||
|
fsx::atomic_write(&root.join(FILES[4]), b"rendered temporary configuration").unwrap();
|
||||||
|
restore(&root, &meta).unwrap();
|
||||||
|
for (rel, bytes) in FILES.iter().zip(original) { assert_eq!(fs::read(root.join(rel)).ok(), bytes); }
|
||||||
|
assert!(!pending(&meta));
|
||||||
|
restore(&root, &meta).unwrap();
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn damaged_recovery_copy_blocks_all_restoration() {
|
||||||
|
let (_dir, root, meta) = fixture();
|
||||||
|
begin(&root, &meta).unwrap();
|
||||||
|
let journal = meta.join("validation-configs.json");
|
||||||
|
let mut saved: BTreeMap<String, Saved> = fsx::read_json(&journal).unwrap();
|
||||||
|
saved.get_mut(FILES[0]).unwrap().bytes = Some(b"damaged".to_vec());
|
||||||
|
fsx::atomic_write_json(&journal, &saved).unwrap();
|
||||||
|
let before = fs::read(root.join(FILES[2])).unwrap();
|
||||||
|
assert!(restore(&root, &meta).is_err());
|
||||||
|
assert_eq!(fs::read(root.join(FILES[2])).unwrap(), before);
|
||||||
|
assert!(pending(&meta));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn missing_template_fails_before_any_configuration_changes() {
|
||||||
|
let (_dir, root, meta) = fixture();
|
||||||
|
fs::remove_file(root.join(FILES[3])).unwrap();
|
||||||
|
let before = fs::read(root.join(FILES[0])).unwrap();
|
||||||
|
assert!(begin(&root, &meta).is_err());
|
||||||
|
assert!(!pending(&meta));
|
||||||
|
assert_eq!(fs::read(root.join(FILES[0])).unwrap(), before);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub(crate) fn restore(root: &Path, meta: &Path) -> Result<()> {
|
||||||
|
if !pending(meta) { return Ok(()); }
|
||||||
|
let journal = meta.join("validation-configs.json");
|
||||||
|
let saved: BTreeMap<String, Saved> = fsx::read_json(&journal)?;
|
||||||
|
if saved.len() != FILES.len() || FILES.iter().any(|rel| !saved.contains_key(*rel)) {
|
||||||
|
return Err(Error::Invalid("Isolated validation configuration journal is incomplete.".into()));
|
||||||
|
}
|
||||||
|
for (rel, file) in &saved {
|
||||||
|
fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
|
||||||
|
if file.bytes.as_ref().map(|b| fsx::sha256_bytes(b)) != file.sha256 {
|
||||||
|
return Err(Error::Invalid(format!("Isolated validation recovery copy {rel} is damaged.")));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
for (rel, file) in saved {
|
||||||
|
let path = fsx::ensure_within(root, &fsx::safe_join(root, &rel)?)?;
|
||||||
|
match file.bytes {
|
||||||
|
Some(bytes) => fsx::atomic_write(&path, &bytes)?,
|
||||||
|
None if path.exists() => fs::remove_file(path)?,
|
||||||
|
None => {},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fs::remove_file(journal)?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -0,0 +1,393 @@
|
|||||||
|
//! Starting the game client on Linux. The client is a Windows program, so it runs under umu-launcher with a Proton build
|
||||||
|
//! (what the project's own guide uses), or under plain Wine when umu is not installed. This is the Linux counterpart of
|
||||||
|
//! starting `Ascension.exe` directly; `client::launch` hands over to it on a Linux host and Windows never comes here.
|
||||||
|
//!
|
||||||
|
//! The settings are found on their own and can all be overridden, from strongest to weakest: the environment
|
||||||
|
//! (`COA_PROTONPATH`, `COA_WINEPREFIX`), then `client-launch.json` in the Manager's folder, then what is installed.
|
||||||
|
|
||||||
|
use std::fs::{self, OpenOptions};
|
||||||
|
use std::io::Write;
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
use std::process::{Command, Stdio};
|
||||||
|
|
||||||
|
use serde::Deserialize;
|
||||||
|
|
||||||
|
use crate::error::{Error, Result};
|
||||||
|
|
||||||
|
/// Prefix used when nothing else is said: the folder umu-launcher itself suggests for a game.
|
||||||
|
const DEFAULT_PREFIX: &str = "Games/umu/coa-client";
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub enum Runner {
|
||||||
|
/// umu-launcher runs the game with a Proton build. `proton` is `None` when umu should pick and download one itself.
|
||||||
|
Umu { program: PathBuf, proton: Option<PathBuf> },
|
||||||
|
Wine { program: PathBuf },
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct Launcher {
|
||||||
|
pub runner: Runner,
|
||||||
|
pub prefix: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// What to run, in a form that can be checked without running anything.
|
||||||
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
pub struct Plan {
|
||||||
|
pub program: PathBuf,
|
||||||
|
pub args: Vec<String>,
|
||||||
|
pub env: Vec<(String, String)>,
|
||||||
|
pub cwd: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// `client-launch.json`: every key is optional.
|
||||||
|
#[derive(Debug, Default, Deserialize)]
|
||||||
|
#[serde(rename_all = "camelCase")]
|
||||||
|
pub struct Overrides {
|
||||||
|
pub proton_path: Option<String>,
|
||||||
|
pub prefix: Option<String>,
|
||||||
|
/// "umu" or "wine": use this one even if the other is installed.
|
||||||
|
pub runner: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Everything detection looks at, so it can be tested without a real computer.
|
||||||
|
pub struct Host<'a> {
|
||||||
|
pub var: &'a dyn Fn(&str) -> Option<String>,
|
||||||
|
pub which: &'a dyn Fn(&str) -> Option<PathBuf>,
|
||||||
|
/// Names of the entries of a folder (empty when it does not exist).
|
||||||
|
pub list: &'a dyn Fn(&Path) -> Vec<String>,
|
||||||
|
pub is_file: &'a dyn Fn(&Path) -> bool,
|
||||||
|
}
|
||||||
|
|
||||||
|
fn proton_folders(home: &Path) -> Vec<PathBuf> {
|
||||||
|
vec![
|
||||||
|
home.join(".local/share/Steam/compatibilitytools.d"),
|
||||||
|
home.join(".steam/root/compatibilitytools.d"),
|
||||||
|
home.join(".steam/steam/compatibilitytools.d"),
|
||||||
|
home.join(".var/app/com.valvesoftware.Steam/.local/share/Steam/compatibilitytools.d"),
|
||||||
|
PathBuf::from("/usr/share/steam/compatibilitytools.d"),
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Numbers of a name in order, so that GE-Proton10-9 sorts before GE-Proton10-34.
|
||||||
|
fn version_key(name: &str) -> Vec<u64> {
|
||||||
|
let mut out = Vec::new();
|
||||||
|
let mut cur = String::new();
|
||||||
|
for c in name.chars().chain(std::iter::once(' ')) {
|
||||||
|
if c.is_ascii_digit() {
|
||||||
|
cur.push(c);
|
||||||
|
} else if !cur.is_empty() {
|
||||||
|
out.push(cur.parse().unwrap_or(0));
|
||||||
|
cur.clear();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
out
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The newest GE-Proton build installed for Steam, if any. A folder only counts when it holds the `proton` script.
|
||||||
|
fn newest_proton(host: &Host, home: &Path) -> Option<PathBuf> {
|
||||||
|
proton_folders(home)
|
||||||
|
.into_iter()
|
||||||
|
.flat_map(|dir| (host.list)(&dir).into_iter().filter(|n| n.starts_with("GE-Proton")).map(move |n| (n.clone(), dir.join(n))))
|
||||||
|
.filter(|(_, path)| (host.is_file)(&path.join("proton")))
|
||||||
|
.max_by_key(|(name, _)| version_key(name))
|
||||||
|
.map(|(_, path)| path)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn detect_with(host: &Host, overrides: &Overrides) -> Result<Launcher> {
|
||||||
|
let home = (host.var)("HOME").map(PathBuf::from).ok_or_else(|| Error::Invalid("The home folder of this user is not known.".into()))?;
|
||||||
|
let prefix = (host.var)("COA_WINEPREFIX").or_else(|| overrides.prefix.clone()).map(PathBuf::from).unwrap_or_else(|| home.join(DEFAULT_PREFIX));
|
||||||
|
let proton = (host.var)("COA_PROTONPATH").or_else(|| overrides.proton_path.clone()).map(PathBuf::from).or_else(|| newest_proton(host, &home));
|
||||||
|
let (umu, wine) = ((host.which)("umu-run"), (host.which)("wine"));
|
||||||
|
let runner = match (overrides.runner.as_deref(), umu, wine) {
|
||||||
|
(Some("wine"), _, Some(program)) => Runner::Wine { program },
|
||||||
|
(Some("umu"), Some(program), _) | (None, Some(program), _) => Runner::Umu { program, proton },
|
||||||
|
(_, None, Some(program)) => Runner::Wine { program },
|
||||||
|
_ => {
|
||||||
|
return Err(Error::Invalid(
|
||||||
|
"To play on Linux the game client needs umu-launcher (with a Proton build such as GE-Proton) or Wine. Install one of them and press Play again.".into(),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
};
|
||||||
|
Ok(Launcher { runner, prefix })
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The command line that starts `exe` from the client folder.
|
||||||
|
pub fn plan(launcher: &Launcher, client: &Path, exe: &str) -> Plan {
|
||||||
|
let mut env = vec![("WINEPREFIX".to_string(), launcher.prefix.to_string_lossy().into_owned())];
|
||||||
|
// DivxTac.dll is a mixed-mode .NET assembly: loaded through wine-mono it deadlocks the client on the world loading screen
|
||||||
|
// (100%). Disabling it has the same effect as removing the file.
|
||||||
|
env.push(("WINEDLLOVERRIDES".into(), "divxtac=d".into()));
|
||||||
|
let program = match &launcher.runner {
|
||||||
|
Runner::Umu { program, proton } => {
|
||||||
|
env.push(("GAMEID".into(), "0".into()));
|
||||||
|
if let Some(p) = proton {
|
||||||
|
env.push(("PROTONPATH".into(), p.to_string_lossy().into_owned()));
|
||||||
|
}
|
||||||
|
program.clone()
|
||||||
|
}
|
||||||
|
Runner::Wine { program } => program.clone(),
|
||||||
|
};
|
||||||
|
// The client reads Data/ relative to the working directory.
|
||||||
|
Plan { program, args: vec![exe.to_string()], env, cwd: client.to_path_buf() }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn system_var(k: &str) -> Option<String> {
|
||||||
|
std::env::var(k).ok().filter(|v| !v.trim().is_empty())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn find_on_path(program: &str) -> Option<PathBuf> {
|
||||||
|
std::env::split_paths(&std::env::var_os("PATH")?).map(|d| d.join(program)).find(|p| p.is_file())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn list_names(dir: &Path) -> Vec<String> {
|
||||||
|
fs::read_dir(dir).map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| e.file_name().into_string().ok()).collect()).unwrap_or_default()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn data_home() -> Option<PathBuf> {
|
||||||
|
system_var("XDG_DATA_HOME").map(PathBuf::from).filter(|p| p.is_absolute()).or_else(|| system_var("HOME").map(|h| PathBuf::from(h).join(".local/share")))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn overrides_file() -> Option<PathBuf> {
|
||||||
|
data_home().map(|d| d.join("CoAServerManager/client-launch.json"))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn detect() -> Result<Launcher> {
|
||||||
|
let overrides: Overrides = overrides_file().and_then(|p| crate::fsx::read_json(&p).ok()).unwrap_or_default();
|
||||||
|
detect_with(&Host { var: &system_var, which: &find_on_path, list: &list_names, is_file: &|p| p.is_file() }, &overrides)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Where what the client prints goes: the Manager's own log folder.
|
||||||
|
pub fn log_path() -> Option<PathBuf> {
|
||||||
|
data_home().map(|d| d.join("CoAServerManager/logs/client.log"))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Start the client and return at once; it keeps running when the Manager closes. Returns the process id.
|
||||||
|
pub fn launch(client: &Path, exe: &str) -> Result<u32> {
|
||||||
|
let launcher = detect()?;
|
||||||
|
let plan = plan(&launcher, client, exe);
|
||||||
|
let log = match log_path() {
|
||||||
|
Some(p) => {
|
||||||
|
if let Some(dir) = p.parent() {
|
||||||
|
fs::create_dir_all(dir)?;
|
||||||
|
}
|
||||||
|
let mut f = OpenOptions::new().create(true).append(true).open(&p)?;
|
||||||
|
writeln!(f, "=== {} {:?} in {}", plan.program.display(), plan.args, plan.cwd.display())?;
|
||||||
|
for (k, v) in &plan.env {
|
||||||
|
writeln!(f, " {k}={v}")?;
|
||||||
|
}
|
||||||
|
Some(f)
|
||||||
|
}
|
||||||
|
None => None,
|
||||||
|
};
|
||||||
|
let mut cmd = Command::new(&plan.program);
|
||||||
|
cmd.args(&plan.args).current_dir(&plan.cwd).envs(plan.env.iter().map(|(k, v)| (k, v))).stdin(Stdio::null());
|
||||||
|
match log {
|
||||||
|
Some(f) => {
|
||||||
|
cmd.stderr(f.try_clone()?).stdout(f);
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
cmd.stdout(Stdio::null()).stderr(Stdio::null());
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#[cfg(unix)]
|
||||||
|
{
|
||||||
|
use std::os::unix::process::CommandExt;
|
||||||
|
cmd.process_group(0); // its own group: closing the Manager does not take the game with it
|
||||||
|
}
|
||||||
|
let mut child = cmd.spawn().map_err(|e| Error::Invalid(format!("The game client could not be started ({}): {e}", plan.program.display())))?;
|
||||||
|
let pid = child.id();
|
||||||
|
std::thread::spawn(move || {
|
||||||
|
let _ = child.wait(); // reap it when the game closes
|
||||||
|
});
|
||||||
|
Ok(pid)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Is a process running this client? Under Wine its command line carries the Windows form of the path
|
||||||
|
/// (`Z:\home\you\client\Ascension.exe`), which is the only trace of it that names the folder.
|
||||||
|
pub fn command_line_runs(cmdline: &str, client: &Path, exe: &str) -> bool {
|
||||||
|
let wanted = format!("{}/{}", client.to_string_lossy().trim_end_matches('/'), exe).to_lowercase();
|
||||||
|
cmdline.replace('\0', " ").replace('\\', "/").to_lowercase().contains(&wanted)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The folder as it was given and as the system resolves it. On an immutable distribution (SteamOS, Bazzite) `/home` is a
|
||||||
|
/// link to `/var/home`: Wine writes the path it was given, the resolved one differs, and either may be what the command
|
||||||
|
/// line of the running client holds.
|
||||||
|
fn spellings(client: &Path) -> Vec<PathBuf> {
|
||||||
|
let mut all = vec![client.to_path_buf()];
|
||||||
|
if let Ok(real) = fs::canonicalize(client) {
|
||||||
|
if real != client {
|
||||||
|
all.push(real);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
all
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn is_running(client: &Path, exes: &[&str]) -> bool {
|
||||||
|
let folders = spellings(client);
|
||||||
|
let Ok(rd) = fs::read_dir("/proc") else { return false };
|
||||||
|
rd.filter_map(|e| e.ok())
|
||||||
|
.filter(|e| e.file_name().to_string_lossy().bytes().all(|b| b.is_ascii_digit()))
|
||||||
|
.filter_map(|e| fs::read(e.path().join("cmdline")).ok())
|
||||||
|
.any(|raw| {
|
||||||
|
let line = String::from_utf8_lossy(&raw);
|
||||||
|
folders.iter().any(|folder| exes.iter().any(|exe| command_line_runs(&line, folder, exe)))
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
// Linux only: the folders are written as Linux path strings.
|
||||||
|
#[cfg(all(test, unix))]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use std::collections::{BTreeMap, BTreeSet};
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_client_folder_behind_a_link_is_looked_for_under_both_names() {
|
||||||
|
// SteamOS and Bazzite: /home is a link to /var/home.
|
||||||
|
let dir = tempfile::tempdir().unwrap();
|
||||||
|
fs::create_dir_all(dir.path().join("var/home/u/client")).unwrap();
|
||||||
|
std::os::unix::fs::symlink("var/home", dir.path().join("home")).unwrap();
|
||||||
|
let given = dir.path().join("home/u/client");
|
||||||
|
let both = spellings(&given);
|
||||||
|
assert_eq!(both.len(), 2);
|
||||||
|
assert_eq!(both[0], given);
|
||||||
|
assert!(both[1].starts_with(dir.path().canonicalize().unwrap().join("var/home")));
|
||||||
|
// Wine kept the name it was given, so the line holds the first one and not the resolved one.
|
||||||
|
let line = format!("Z:\\{}\\Ascension.exe", given.to_string_lossy().replace('/', "\\"));
|
||||||
|
assert!(!command_line_runs(&line, &both[1], "Ascension.exe"));
|
||||||
|
assert!(both.iter().any(|f| command_line_runs(&line, f, "Ascension.exe")));
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A computer described in a few lines: variables, programs on the path, folders with their entries, and `proton` scripts.
|
||||||
|
struct Fake {
|
||||||
|
vars: BTreeMap<&'static str, &'static str>,
|
||||||
|
programs: BTreeSet<&'static str>,
|
||||||
|
folders: BTreeMap<&'static str, Vec<&'static str>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Fake {
|
||||||
|
fn new() -> Fake {
|
||||||
|
Fake { vars: BTreeMap::from([("HOME", "/home/ana")]), programs: BTreeSet::new(), folders: BTreeMap::new() }
|
||||||
|
}
|
||||||
|
|
||||||
|
fn detect(&self, overrides: &Overrides) -> Result<Launcher> {
|
||||||
|
let var = |k: &str| self.vars.get(k).map(|v| v.to_string());
|
||||||
|
let which = |p: &str| self.programs.contains(p).then(|| PathBuf::from(format!("/usr/bin/{p}")));
|
||||||
|
let list = |d: &Path| self.folders.get(d.to_str().unwrap()).map(|v| v.iter().map(|s| s.to_string()).collect()).unwrap_or_default();
|
||||||
|
// every listed build has its `proton` script
|
||||||
|
let is_file = |p: &Path| p.file_name().is_some_and(|n| n == "proton");
|
||||||
|
detect_with(&Host { var: &var, which: &which, list: &list, is_file: &is_file }, overrides)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const STEAM: &str = "/home/ana/.local/share/Steam/compatibilitytools.d";
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn umu_with_the_newest_ge_proton_is_the_default() {
|
||||||
|
let mut c = Fake::new();
|
||||||
|
c.programs.extend(["umu-run", "wine"]);
|
||||||
|
c.folders.insert(STEAM, vec!["GE-Proton9-27", "GE-Proton10-9", "GE-Proton10-34", "Proton-Experimental", "notes.txt"]);
|
||||||
|
let l = c.detect(&Overrides::default()).unwrap();
|
||||||
|
assert_eq!(l.prefix, PathBuf::from("/home/ana/Games/umu/coa-client"));
|
||||||
|
match l.runner {
|
||||||
|
Runner::Umu { proton, program } => {
|
||||||
|
assert_eq!(program, PathBuf::from("/usr/bin/umu-run"));
|
||||||
|
assert_eq!(proton, Some(PathBuf::from(format!("{STEAM}/GE-Proton10-34"))), "10-34 is newer than 10-9");
|
||||||
|
}
|
||||||
|
other => panic!("{other:?}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn without_a_proton_build_umu_is_left_to_choose_one() {
|
||||||
|
let mut c = Fake::new();
|
||||||
|
c.programs.insert("umu-run");
|
||||||
|
let Runner::Umu { proton, .. } = c.detect(&Overrides::default()).unwrap().runner else { panic!() };
|
||||||
|
assert_eq!(proton, None);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn plain_wine_is_used_when_umu_is_not_installed() {
|
||||||
|
let mut c = Fake::new();
|
||||||
|
c.programs.insert("wine");
|
||||||
|
assert!(matches!(c.detect(&Overrides::default()).unwrap().runner, Runner::Wine { .. }));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn without_umu_or_wine_the_person_is_told_what_to_install() {
|
||||||
|
let err = Fake::new().detect(&Overrides::default()).unwrap_err().to_string();
|
||||||
|
assert!(err.contains("umu-launcher") && err.contains("Wine"), "{err}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn settings_override_what_is_installed_and_the_environment_overrides_the_file() {
|
||||||
|
let mut c = Fake::new();
|
||||||
|
c.programs.extend(["umu-run", "wine"]);
|
||||||
|
c.folders.insert(STEAM, vec!["GE-Proton10-34"]);
|
||||||
|
let file = Overrides { proton_path: Some("/opt/proton-a".into()), prefix: Some("/data/prefix-a".into()), runner: None };
|
||||||
|
let l = c.detect(&file).unwrap();
|
||||||
|
assert_eq!(l.prefix, PathBuf::from("/data/prefix-a"));
|
||||||
|
assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-a")));
|
||||||
|
c.vars.insert("COA_PROTONPATH", "/opt/proton-b");
|
||||||
|
c.vars.insert("COA_WINEPREFIX", "/data/prefix-b");
|
||||||
|
let l = c.detect(&file).unwrap();
|
||||||
|
assert_eq!(l.prefix, PathBuf::from("/data/prefix-b"));
|
||||||
|
assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-b")));
|
||||||
|
// Forcing Wine works when it is installed, and falls back to umu when it is not.
|
||||||
|
let wine = Overrides { runner: Some("wine".into()), ..Default::default() };
|
||||||
|
assert!(matches!(c.detect(&wine).unwrap().runner, Runner::Wine { .. }));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_command_is_the_one_of_the_projects_own_launcher_script() {
|
||||||
|
let l = Launcher { runner: Runner::Umu { program: "/usr/bin/umu-run".into(), proton: Some("/p/GE-Proton11-6".into()) }, prefix: "/home/ana/Games/umu/coa-client".into() };
|
||||||
|
let p = plan(&l, Path::new("/home/ana/CoaServer/client/ascension-live"), "Ascension.exe");
|
||||||
|
assert_eq!(p.program, PathBuf::from("/usr/bin/umu-run"));
|
||||||
|
assert_eq!(p.args, ["Ascension.exe"]);
|
||||||
|
assert_eq!(p.cwd, PathBuf::from("/home/ana/CoaServer/client/ascension-live"), "the client reads Data/ from its working directory");
|
||||||
|
let env: BTreeMap<_, _> = p.env.iter().cloned().collect();
|
||||||
|
assert_eq!(env["GAMEID"], "0");
|
||||||
|
assert_eq!(env["PROTONPATH"], "/p/GE-Proton11-6");
|
||||||
|
assert_eq!(env["WINEPREFIX"], "/home/ana/Games/umu/coa-client");
|
||||||
|
assert_eq!(env["WINEDLLOVERRIDES"], "divxtac=d", "DivxTac.dll deadlocks the world loading screen under wine-mono");
|
||||||
|
// Wine has no GAMEID / PROTONPATH.
|
||||||
|
let w = plan(&Launcher { runner: Runner::Wine { program: "/usr/bin/wine".into() }, prefix: "/pre".into() }, Path::new("/c"), "Wow.exe");
|
||||||
|
assert!(w.env.iter().all(|(k, _)| k != "GAMEID" && k != "PROTONPATH") && w.args == ["Wow.exe"]);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_wine_command_line_names_the_client_folder_in_windows_form() {
|
||||||
|
let client = Path::new("/home/ana/CoaServer/client/ascension-live");
|
||||||
|
assert!(command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe\0", client, "Ascension.exe"));
|
||||||
|
assert!(command_line_runs("C:\\windows\\system32\\start.exe /exec Z:\\HOME\\ANA\\coaserver\\client\\ascension-live\\ascension.exe", client, "Ascension.exe"), "case does not matter");
|
||||||
|
assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-lab\\Ascension.exe", client, "Ascension.exe"), "another client folder");
|
||||||
|
assert!(!command_line_runs("umu-run Ascension.exe", client, "Ascension.exe"), "the launcher alone does not name the folder");
|
||||||
|
assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe.ORIGINAL", Path::new("/other"), "Ascension.exe"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn newer_versions_sort_after_older_ones() {
|
||||||
|
assert!(version_key("GE-Proton10-9") < version_key("GE-Proton10-34"));
|
||||||
|
assert!(version_key("GE-Proton9-27") < version_key("GE-Proton10-1"));
|
||||||
|
assert!(version_key("GE-Proton11-6-x86_64") < version_key("GE-Proton11-7-x86_64"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(unix)]
|
||||||
|
#[test]
|
||||||
|
fn a_real_launch_runs_the_program_in_the_client_folder_with_the_right_environment() {
|
||||||
|
use std::os::unix::fs::PermissionsExt;
|
||||||
|
let d = tempfile::tempdir().unwrap();
|
||||||
|
let client = d.path().join("client");
|
||||||
|
fs::create_dir_all(&client).unwrap();
|
||||||
|
let out = d.path().join("seen.txt");
|
||||||
|
let script = d.path().join("umu-run");
|
||||||
|
fs::write(&script, format!("#!/bin/sh\n{{ echo \"cwd=$(pwd)\"; echo \"arg=$1\"; echo \"prefix=$WINEPREFIX\"; echo \"gameid=$GAMEID\"; echo \"dll=$WINEDLLOVERRIDES\"; }} > '{}'\n", out.display())).unwrap();
|
||||||
|
fs::set_permissions(&script, fs::Permissions::from_mode(0o755)).unwrap();
|
||||||
|
let launcher = Launcher { runner: Runner::Umu { program: script, proton: None }, prefix: d.path().join("prefix") };
|
||||||
|
let p = plan(&launcher, &client, "Ascension.exe");
|
||||||
|
let mut child = Command::new(&p.program).args(&p.args).current_dir(&p.cwd).envs(p.env.iter().map(|(k, v)| (k, v))).spawn().unwrap();
|
||||||
|
assert!(child.wait().unwrap().success());
|
||||||
|
let seen = fs::read_to_string(&out).unwrap();
|
||||||
|
assert!(seen.contains(&format!("cwd={}", fs::canonicalize(&client).unwrap().display())), "{seen}");
|
||||||
|
assert!(seen.contains("arg=Ascension.exe") && seen.contains("gameid=0") && seen.contains("dll=divxtac=d") && seen.contains("prefix="), "{seen}");
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -47,6 +47,36 @@ fn run() -> Result<(), String> {
|
|||||||
let e = |x: coa_core::Error| x.to_string();
|
let e = |x: coa_core::Error| x.to_string();
|
||||||
let part = a.get("part-size").and_then(|v| v.parse().ok()).unwrap_or(DEFAULT_PART_SIZE);
|
let part = a.get("part-size").and_then(|v| v.parse().ok()).unwrap_or(DEFAULT_PART_SIZE);
|
||||||
match cmd.as_str() {
|
match cmd.as_str() {
|
||||||
|
"qualify-upgrade" => {
|
||||||
|
let report = coa_core::release_schema::qualify_upgrade(
|
||||||
|
&PathBuf::from(need(&a, "base")?), &PathBuf::from(need(&a, "source")?),
|
||||||
|
&PathBuf::from(need(&a, "candidate")?), &PathBuf::from(need(&a, "fixture")?),
|
||||||
|
coa_core::signing::EMBEDDED_PUBLIC_KEY,
|
||||||
|
).map_err(e)?;
|
||||||
|
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report).map_err(e)?;
|
||||||
|
println!("Manager upgrade transaction passed isolated qualification");
|
||||||
|
}
|
||||||
|
"qualify-startup" => {
|
||||||
|
coa_core::release_schema::validate_startup(
|
||||||
|
&PathBuf::from(need(&a, "fixture")?), &PathBuf::from(need(&a, "tree")?),
|
||||||
|
&PathBuf::from(need(&a, "base")?), coa_core::signing::EMBEDDED_PUBLIC_KEY,
|
||||||
|
).map_err(e)?;
|
||||||
|
println!("authserver and worldserver passed isolated startup qualification");
|
||||||
|
}
|
||||||
|
"verify-channel" => {
|
||||||
|
let bytes = std::fs::read(need(&a, "file")?).map_err(|x| x.to_string())?;
|
||||||
|
let pointer = coa_core::channels::verify(&bytes, need(&a, "channel")?, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||||
|
println!("{}", serde_json::to_string(&pointer).map_err(|x| x.to_string())?);
|
||||||
|
}
|
||||||
|
"verify-manifest" => {
|
||||||
|
let source = coa_core::pkgsource::Source::Dir(PathBuf::from(need(&a, "dir")?));
|
||||||
|
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&source, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||||
|
println!("verified signed manifest {}", manifest.version);
|
||||||
|
}
|
||||||
|
"verify-upgrade-fixture" => {
|
||||||
|
coa_core::release_schema::verify_upgrade_fixture(&PathBuf::from(need(&a, "dir")?), coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||||
|
println!("verified signed upgrade fixture and every archive file");
|
||||||
|
}
|
||||||
"extract-schema-base" => {
|
"extract-schema-base" => {
|
||||||
coa_core::release_schema::extract_base(
|
coa_core::release_schema::extract_base(
|
||||||
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?),
|
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?),
|
||||||
@@ -112,6 +142,16 @@ fn run() -> Result<(), String> {
|
|||||||
coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
coa_core::release_schema::verify_package(&dir, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
|
||||||
println!("signature, archive contents and database schema contract OK");
|
println!("signature, archive contents and database schema contract OK");
|
||||||
}
|
}
|
||||||
|
"sign-channel" => {
|
||||||
|
let pointer = coa_core::channels::Pointer {
|
||||||
|
schema: 1, channel: need(&a, "channel")?.clone(),
|
||||||
|
version: need(&a, "version")?.clone(),
|
||||||
|
release_tag: format!("server-{}", need(&a, "version")?),
|
||||||
|
snapshot: need(&a, "snapshot")?.clone(),
|
||||||
|
};
|
||||||
|
let bytes = coa_core::channels::sign(&pointer, &signing_key()?).map_err(e)?;
|
||||||
|
coa_core::fsx::atomic_write(&PathBuf::from(need(&a, "out")?), &bytes).map_err(e)?;
|
||||||
|
}
|
||||||
other => return Err(format!("unknown command {other}")),
|
other => return Err(format!("unknown command {other}")),
|
||||||
}
|
}
|
||||||
Ok(())
|
Ok(())
|
||||||
|
|||||||
+32
-2
@@ -392,8 +392,38 @@ hand over to `coa_core::docker`; nothing else needed to change for start, stop,
|
|||||||
so replaying the SQL files from the base scripts fails, in any order. `coa-release export-baseline --server DIR --out DIR`
|
so replaying the SQL files from the base scripts fails, in any order. `coa-release export-baseline --server DIR --out DIR`
|
||||||
produces the dumps from a prepared server (repack or Docker). The game data stays where the person has it
|
produces the dumps from a prepared server (repack or Docker). The game data stays where the person has it
|
||||||
(`dataDir` in `docker.json`, mounted read-only). A failure removes the containers, the volume and the staging folder.
|
(`dataDir` in `docker.json`, mounted read-only). A failure removes the containers, the volume and the staging folder.
|
||||||
* **Not done yet**: wiring the installer into the screens, downloading the game data, updates, port conflict detection,
|
* **Validating a release on Linux** (`docker/fixture.rs`, used by `coa-release extract-schema-base` and `schema-contract` where
|
||||||
the firewall and exposure checks, the Wildcard realm profiles, and the client under Wine/Proton.
|
there is no Windows database program): the signed base package carries the MySQL data directory of a Windows repack, and a
|
||||||
|
MySQL 8.4 container opens it as it is (`--lower-case-table-names=1`, the repack's setting). The fixture is a Docker server
|
||||||
|
folder (`docker.json` with `mysqlData`: the database container uses that directory in place of a volume; an installation
|
||||||
|
never sets it), plus a `root` account for TCP, which the repack only has for its socket. The release SQL is then applied and the
|
||||||
|
schema contract captured by the same code as on Windows, and `export-baseline` dumps the result: that is how a Linux build
|
||||||
|
produces `Database/baseline` without anyone's live database. The migration checksums recorded in the base are those of
|
||||||
|
files checked out on Windows (CRLF line endings, `core.autocrlf`): the SQL of the core, the modules and SQUID must be
|
||||||
|
checked out the same way for the checksums to match, or every applied migration looks edited.
|
||||||
|
* **In the screens** the host is asked once per command (`coa_core::platform::flavor()`: repack on Windows, Docker
|
||||||
|
elsewhere) and the Docker half lives in `src-tauri/src/docker_install.rs`; the repack arm of each install command is the
|
||||||
|
code that was there. `install_environment` tells the install screen the kind of server, the suggested folder
|
||||||
|
(`~/CoaServer`) and why Docker cannot be used, if it cannot. On Docker the screen also asks for the game data folder and
|
||||||
|
the package, and there is no default package address until a signed Linux package is published. Packages are checked with
|
||||||
|
the embedded key; only a debug build (`tauri dev`) accepts another one, named in `COA_DEV_TRUSTED_KEY`, to try the
|
||||||
|
installer on a package signed with a throwaway key.
|
||||||
|
* **Updates are refused for a Docker server, never half done.** `update::preview`, `apply` and `rollback` refuse it: the
|
||||||
|
update packages are the repack's (executables, a bundled MySQL, a launcher) and applying one would put Windows files in a
|
||||||
|
Linux folder. Found by installing a server with the screen: the update check had read the Windows channel and offered one.
|
||||||
|
* **Realm profiles (CoA / Wildcard) work on a Docker server.** What the repack's patched launcher did at each start is done
|
||||||
|
by the Docker backend: finish an interrupted switch (`realms::before_start`), name the realms in the realm list, and give
|
||||||
|
the containers the databases of the selected realm (`acore_world_wildcard` ...). The switch itself (configuration swap,
|
||||||
|
database copy, journal) is the shared code; `prepare_launcher` has nothing to patch, and Wildcard support is read from
|
||||||
|
`Core/worldserver` as it is from `Core/worldserver.exe`.
|
||||||
|
* **The game client starts under Wine on a Linux host** (`wine.rs`; `client::launch` and `client::is_running` hand over):
|
||||||
|
umu-launcher with a Proton build when `umu-run` is installed (the newest GE-Proton found for Steam, or umu's own choice),
|
||||||
|
else plain Wine; `WINEPREFIX` defaults to `~/Games/umu/coa-client`; `WINEDLLOVERRIDES=divxtac=d` is always set, because
|
||||||
|
DivxTac.dll deadlocks the world loading screen under wine-mono. `COA_PROTONPATH`, `COA_WINEPREFIX` or
|
||||||
|
`client-launch.json` in the Manager's folder (`proton_path`, `prefix`, `runner`) override the detection. Whether the client
|
||||||
|
runs is read from `/proc` (under Wine the command line holds the Windows form of the path). Output goes to `client.log`.
|
||||||
|
* **Not done yet**: downloading the game data, updates, port conflict detection, the firewall and exposure checks, the
|
||||||
|
Wildcard realm profiles, and the client under Wine/Proton.
|
||||||
|
|
||||||
### D14. Keeping Windows and Linux apart
|
### D14. Keeping Windows and Linux apart
|
||||||
|
|
||||||
|
|||||||
@@ -121,6 +121,24 @@
|
|||||||
"default_on": false,
|
"default_on": false,
|
||||||
"page": "bots"
|
"page": "bots"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"id": "custom-races",
|
||||||
|
"name": "Custom Races",
|
||||||
|
"description": {
|
||||||
|
"en": "Playable custom races (Esteria and additional races) with extended appearances.",
|
||||||
|
"ru": "Пользовательские расы (Esteria и дополнительные расы) с расширенной внешностью.",
|
||||||
|
"de": "Spielbare benutzerdefinierte Völker (Esteria und weitere Völker) mit erweitertem Aussehen.",
|
||||||
|
"fr": "Races personnalisées jouables (Esteria et autres) avec apparences étendues.",
|
||||||
|
"es": "Razas personalizadas jugables (Esteria y razas adicionales) con apariencias ampliadas."
|
||||||
|
},
|
||||||
|
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
|
||||||
|
"conf": "coa_custom_races.conf",
|
||||||
|
"switchable": true,
|
||||||
|
"status": "beta",
|
||||||
|
"icon": "races",
|
||||||
|
"enable_key": "CoACustomRaces.Enable",
|
||||||
|
"default_on": false
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"id": "client-compat",
|
"id": "client-compat",
|
||||||
"name": "Client compatibility",
|
"name": "Client compatibility",
|
||||||
|
|||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "coa-server-manager",
|
"name": "coa-server-manager",
|
||||||
"version": "0.6.6",
|
"version": "0.6.15",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "coa-server-manager",
|
"name": "coa-server-manager",
|
||||||
"version": "0.6.6",
|
"version": "0.6.15",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@tauri-apps/api": "^2.12.0",
|
"@tauri-apps/api": "^2.12.0",
|
||||||
"@tauri-apps/plugin-dialog": "^2.8.0",
|
"@tauri-apps/plugin-dialog": "^2.8.0",
|
||||||
|
|||||||
+1
-1
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "coa-server-manager",
|
"name": "coa-server-manager",
|
||||||
"private": true,
|
"private": true,
|
||||||
"version": "0.6.6",
|
"version": "0.6.15",
|
||||||
"license": "AGPL-3.0-only",
|
"license": "AGPL-3.0-only",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
|||||||
+1
-1
@@ -770,7 +770,7 @@
|
|||||||
"type": "bool",
|
"type": "bool",
|
||||||
"category": "gameplay",
|
"category": "gameplay",
|
||||||
"title": "Skills always at maximum for level",
|
"title": "Skills always at maximum for level",
|
||||||
"description": "Weapon and other skills are always at their maximum for the character's level, no training needed.",
|
"description": "Weapon and other skills are always at their maximum for the character's level, no training needed. The Wildcard realm always turns this on for itself.",
|
||||||
"default": false,
|
"default": false,
|
||||||
"advanced": false,
|
"advanced": false,
|
||||||
"restartRequired": "world",
|
"restartRequired": "world",
|
||||||
|
|||||||
@@ -0,0 +1,125 @@
|
|||||||
|
//! The Linux (Docker) side of the install commands. `lib.rs` asks `coa_core::platform::flavor()` once per command and
|
||||||
|
//! calls this module for a Docker install; the code for a repack install stays where it was and is not changed by what
|
||||||
|
//! happens here.
|
||||||
|
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
|
||||||
|
use coa_core::docker::{self, install as core_install, SystemDocker};
|
||||||
|
use coa_core::download::Cancel;
|
||||||
|
use coa_core::install::{Preflight, Source};
|
||||||
|
use coa_core::registry::Registry;
|
||||||
|
use coa_core::{Error, Result};
|
||||||
|
use serde::Serialize;
|
||||||
|
use tauri::{AppHandle, Emitter, State};
|
||||||
|
|
||||||
|
use super::{blocking, data_dir, summary, AppState, InstallRequirements, ServerSummary, UiError};
|
||||||
|
|
||||||
|
/// What the install screen needs to know about this computer before it asks anything.
|
||||||
|
#[derive(Serialize)]
|
||||||
|
pub struct Environment {
|
||||||
|
pub flavor: coa_core::platform::Flavor,
|
||||||
|
pub default_dir: String,
|
||||||
|
/// Why Docker cannot be used (not installed, not running, no permission), in Docker's own words; none when it works.
|
||||||
|
pub docker_problem: Option<String>,
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn default_dir() -> String {
|
||||||
|
default_dir_in(std::env::var("HOME").ok().as_deref())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn default_dir_in(home: Option<&str>) -> String {
|
||||||
|
match home.map(|h| h.trim_end_matches('/')).filter(|h| !h.is_empty()) {
|
||||||
|
Some(h) => format!("{h}/CoaServer"),
|
||||||
|
None => "/srv/coa".into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn docker_problem() -> Option<String> {
|
||||||
|
docker::check_docker(&SystemDocker).err().map(|e| e.to_string())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn environment() -> Environment {
|
||||||
|
Environment { flavor: coa_core::platform::flavor(), default_dir: default_dir(), docker_problem: docker_problem() }
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn preflight(dest: &str, data: Option<String>, needed: Option<u64>, registry: &Registry) -> Preflight {
|
||||||
|
// The size comes from the signed package list when the screen already has it; it is checked again at install time.
|
||||||
|
core_install::preflight(Path::new(dest), Path::new(data.as_deref().unwrap_or("")), needed.unwrap_or(1024 * 1024 * 1024), registry)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The Linux package has no default address yet: it is published only after the maintainer has signed it.
|
||||||
|
pub fn package_source(custom: Option<String>) -> Result<Source> {
|
||||||
|
let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_PACKAGE_SOURCE").ok().filter(|s| !s.trim().is_empty()));
|
||||||
|
match pick {
|
||||||
|
Some(p) if p.to_ascii_lowercase().starts_with("http") => Ok(Source::Url(p)),
|
||||||
|
Some(p) => Ok(Source::Dir(PathBuf::from(p))),
|
||||||
|
None => Err(Error::Invalid("Choose the Linux server package (a folder or an address): none is published yet.".into())),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// The key a Linux package must be signed with. A debug build (`tauri dev`) may name another one in `COA_DEV_TRUSTED_KEY`,
|
||||||
|
/// to try the installer on a package signed with a throwaway key; a release build always uses the embedded key.
|
||||||
|
pub fn trusted_key() -> String {
|
||||||
|
#[cfg(debug_assertions)]
|
||||||
|
if let Ok(k) = std::env::var("COA_DEV_TRUSTED_KEY") {
|
||||||
|
if !k.trim().is_empty() {
|
||||||
|
return k.trim().to_string();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
coa_core::signing::EMBEDDED_PUBLIC_KEY.to_string()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn requirements(package: Option<String>) -> std::result::Result<InstallRequirements, UiError> {
|
||||||
|
blocking(move || {
|
||||||
|
let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package)?, &trusted_key())?;
|
||||||
|
let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
|
||||||
|
Ok(InstallRequirements { download_bytes: archive.parts.iter().map(|p| p.size).sum(), unpacked_bytes: archive.unpacked_size, version: m.version })
|
||||||
|
})
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn install(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>, data: Option<String>) -> std::result::Result<ServerSummary, UiError> {
|
||||||
|
let source = package_source(package)?;
|
||||||
|
let data_dir_path = PathBuf::from(data.filter(|d| !d.trim().is_empty()).ok_or_else(|| Error::Invalid("Choose the folder that holds the game data.".into()))?);
|
||||||
|
let cancel = Cancel::default();
|
||||||
|
*state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone());
|
||||||
|
let registry = Registry::at(data_dir().join("installs.json"));
|
||||||
|
let dest_path = PathBuf::from(dest);
|
||||||
|
let key = trusted_key();
|
||||||
|
let result = tauri::async_runtime::spawn_blocking(move || {
|
||||||
|
core_install::install(
|
||||||
|
&core_install::Params { source, dest: dest_path, data_dir: data_dir_path, trusted_key: &key, registry: ®istry, cancel },
|
||||||
|
&|step| {
|
||||||
|
let _ = app.emit("install-progress", step);
|
||||||
|
},
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.await;
|
||||||
|
if let Ok(mut c) = state.install_cancel.lock() {
|
||||||
|
*c = None;
|
||||||
|
}
|
||||||
|
let done = result.map_err(|e| Error::Invalid(e.to_string()))??;
|
||||||
|
Ok(summary(done.id, PathBuf::from(done.path)))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn the_default_folder_is_in_the_home_folder() {
|
||||||
|
assert_eq!(default_dir_in(Some("/home/ana")), "/home/ana/CoaServer");
|
||||||
|
assert_eq!(default_dir_in(Some("/home/ana/")), "/home/ana/CoaServer");
|
||||||
|
assert_eq!(default_dir_in(None), "/srv/coa");
|
||||||
|
assert_eq!(default_dir_in(Some("")), "/srv/coa");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn a_linux_package_must_be_named_there_is_no_default() {
|
||||||
|
std::env::remove_var("COA_PACKAGE_SOURCE");
|
||||||
|
assert!(package_source(None).is_err());
|
||||||
|
assert!(package_source(Some(" ".into())).is_err());
|
||||||
|
assert!(matches!(package_source(Some("/tmp/pkg".into())).unwrap(), Source::Dir(_)));
|
||||||
|
assert!(matches!(package_source(Some("https://example.org/pkg".into())).unwrap(), Source::Url(_)));
|
||||||
|
}
|
||||||
|
}
|
||||||
+160
-13
@@ -5,11 +5,14 @@ use std::collections::HashSet;
|
|||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
use std::sync::Mutex;
|
use std::sync::Mutex;
|
||||||
|
|
||||||
|
mod docker_install;
|
||||||
|
|
||||||
use coa_core::backup::{self, Kind, RecoveryPoint, Trigger, VerifyReport};
|
use coa_core::backup::{self, Kind, RecoveryPoint, Trigger, VerifyReport};
|
||||||
use coa_core::config::{self, Scope, SettingsView};
|
use coa_core::config::{self, Scope, SettingsView};
|
||||||
use coa_core::download::Cancel;
|
use coa_core::download::Cancel;
|
||||||
use coa_core::driver::{self, DriverOutcome, Verb};
|
use coa_core::driver::{self, DriverOutcome, Verb};
|
||||||
use coa_core::install::{self, Preflight, Source};
|
use coa_core::install::{self, Preflight, Source};
|
||||||
|
use coa_core::platform::{self, Flavor};
|
||||||
use coa_core::ra::Ra;
|
use coa_core::ra::Ra;
|
||||||
use coa_core::update::{self, Resolution};
|
use coa_core::update::{self, Resolution};
|
||||||
use coa_core::error::UiError;
|
use coa_core::error::UiError;
|
||||||
@@ -36,12 +39,16 @@ struct AppState {
|
|||||||
/// Where signed update packages are published; override with COA_UPDATE_SOURCE (URL or local package folder).
|
/// Where signed update packages are published; override with COA_UPDATE_SOURCE (URL or local package folder).
|
||||||
const DEFAULT_UPDATE_URL: &str = "https://github.com/Corfirean/coa-server-build/releases/download/stable";
|
const DEFAULT_UPDATE_URL: &str = "https://github.com/Corfirean/coa-server-build/releases/download/stable";
|
||||||
|
|
||||||
fn update_source(custom: Option<String>) -> Source {
|
fn update_source(custom: Option<String>) -> Result<Source> {
|
||||||
let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_UPDATE_SOURCE").ok());
|
let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_UPDATE_SOURCE").ok());
|
||||||
match pick {
|
match pick {
|
||||||
Some(p) if p.to_ascii_lowercase().starts_with("http") => Source::Url(p),
|
Some(p) if p.to_ascii_lowercase().starts_with("http") => Ok(Source::Url(p)),
|
||||||
Some(p) => Source::Dir(PathBuf::from(p)),
|
Some(p) => Ok(Source::Dir(PathBuf::from(p))),
|
||||||
None => Source::Url(DEFAULT_UPDATE_URL.into()),
|
None => match coa_core::channels::resolve("stable") {
|
||||||
|
Ok(source) => Ok(source),
|
||||||
|
Err(Error::PackageNotPublished(_)) => Ok(Source::Url(DEFAULT_UPDATE_URL.into())),
|
||||||
|
Err(error) => Err(error),
|
||||||
|
},
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -105,9 +112,19 @@ fn summary(id: String, path: PathBuf) -> ServerSummary {
|
|||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
fn default_install_dir() -> String {
|
fn default_install_dir() -> String {
|
||||||
|
if platform::flavor() == Flavor::Docker {
|
||||||
|
return docker_install::default_dir();
|
||||||
|
}
|
||||||
"C:\\Games\\CoA Server".into()
|
"C:\\Games\\CoA Server".into()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// What the install screen needs to know about this computer: the kind of server it installs, the suggested folder, and
|
||||||
|
/// whether Docker can be used.
|
||||||
|
#[tauri::command]
|
||||||
|
async fn install_environment() -> docker_install::Environment {
|
||||||
|
tauri::async_runtime::spawn_blocking(docker_install::environment).await.unwrap_or_else(|_| docker_install::Environment { flavor: platform::flavor(), default_dir: default_install_dir(), docker_problem: None })
|
||||||
|
}
|
||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
async fn scan_server(path: String) -> std::result::Result<ScanReport, UiError> {
|
async fn scan_server(path: String) -> std::result::Result<ScanReport, UiError> {
|
||||||
tauri::async_runtime::spawn_blocking(move || layout::scan(std::path::Path::new(&path)))
|
tauri::async_runtime::spawn_blocking(move || layout::scan(std::path::Path::new(&path)))
|
||||||
@@ -353,6 +370,51 @@ impl Drop for BusyGuard<'_> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
fn backup_location(state: State<'_, AppState>, id: String) -> std::result::Result<backup::BackupLocation, UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
Ok(backup::location(&meta_dir(&root)?))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn set_backup_location(state: State<'_, AppState>, id: String, path: Option<String>) -> std::result::Result<backup::BackupLocation, UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
blocking(move || backup::set_location(&root, &meta_dir(&root)?, path.as_deref())).await
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn dashboard_status(state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::dashboard::Status, UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
blocking(move || Ok(coa_core::dashboard::status(&root))).await
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn dashboard_install(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::dashboard::Status, UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
blocking(move || coa_core::dashboard::install(&root, &|step| { let _ = app.emit("dashboard-progress", step); })).await
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn dashboard_open(state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
let status = blocking(move || Ok(coa_core::dashboard::status(&root))).await?;
|
||||||
|
if !status.running { return Err(Error::Invalid("The dashboard is not running.".into()).into()); }
|
||||||
|
tauri_plugin_opener::open_url(&status.url, None::<&str>).map_err(|e| Error::Invalid(e.to_string()))?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn dashboard_start(state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::dashboard::Status, UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
blocking(move || coa_core::dashboard::start(&root)).await
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn dashboard_stop(state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::dashboard::Status, UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
blocking(move || { coa_core::dashboard::stop(&root)?; Ok(coa_core::dashboard::status(&root)) }).await
|
||||||
|
}
|
||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
fn list_backups(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<RecoveryPoint>, UiError> {
|
fn list_backups(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<RecoveryPoint>, UiError> {
|
||||||
let root = path_of(&state, &id)?;
|
let root = path_of(&state, &id)?;
|
||||||
@@ -405,7 +467,10 @@ async fn restore_backup_database(state: State<'_, AppState>, id: String, backup_
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option<u64>) -> Preflight {
|
fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option<u64>, game_data: Option<String>) -> Preflight {
|
||||||
|
if platform::flavor() == Flavor::Docker {
|
||||||
|
return docker_install::preflight(&dest, game_data, needed, &state.registry);
|
||||||
|
}
|
||||||
// `needed` is the real size from the signed package list when the screen already has it; the real size is checked
|
// `needed` is the real size from the signed package list when the screen already has it; the real size is checked
|
||||||
// again at install time either way.
|
// again at install time either way.
|
||||||
install::preflight(std::path::Path::new(&dest), needed.unwrap_or(6 * 1024 * 1024 * 1024), &state.registry)
|
install::preflight(std::path::Path::new(&dest), needed.unwrap_or(6 * 1024 * 1024 * 1024), &state.registry)
|
||||||
@@ -423,6 +488,9 @@ struct InstallRequirements {
|
|||||||
/// How big the server is, read from the package's signed list before anything is downloaded.
|
/// How big the server is, read from the package's signed list before anything is downloaded.
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
async fn install_requirements(package: Option<String>) -> std::result::Result<InstallRequirements, UiError> {
|
async fn install_requirements(package: Option<String>) -> std::result::Result<InstallRequirements, UiError> {
|
||||||
|
if platform::flavor() == Flavor::Docker {
|
||||||
|
return docker_install::requirements(package).await;
|
||||||
|
}
|
||||||
blocking(move || {
|
blocking(move || {
|
||||||
let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package), coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
|
let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package), coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
|
||||||
let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
|
let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
|
||||||
@@ -432,7 +500,10 @@ async fn install_requirements(package: Option<String>) -> std::result::Result<In
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
async fn install_new(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>) -> std::result::Result<ServerSummary, UiError> {
|
async fn install_new(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>, game_data: Option<String>) -> std::result::Result<ServerSummary, UiError> {
|
||||||
|
if platform::flavor() == Flavor::Docker {
|
||||||
|
return docker_install::install(app, state, dest, package, game_data).await;
|
||||||
|
}
|
||||||
let cancel = Cancel::default();
|
let cancel = Cancel::default();
|
||||||
*state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone());
|
*state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone());
|
||||||
let source = package_source(package);
|
let source = package_source(package);
|
||||||
@@ -578,7 +649,7 @@ async fn repair_server(app: AppHandle, state: State<'_, AppState>, id: String) -
|
|||||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||||
blocking(move || {
|
blocking(move || {
|
||||||
let dir = meta_dir(&root)?;
|
let dir = meta_dir(&root)?;
|
||||||
coa_core::repair::run(&root, &dir, &package_source(None), &update_source(None), coa_core::signing::EMBEDDED_PUBLIC_KEY, &|step,percent| {
|
coa_core::repair::run(&root, &dir, &package_source(None), &update_source(None)?, coa_core::signing::EMBEDDED_PUBLIC_KEY, &|step,percent| {
|
||||||
let _ = app.emit("repair-progress", serde_json::json!({ "id": id, "step": step, "percent": percent }));
|
let _ = app.emit("repair-progress", serde_json::json!({ "id": id, "step": step, "percent": percent }));
|
||||||
})
|
})
|
||||||
}).await
|
}).await
|
||||||
@@ -594,6 +665,57 @@ async fn module_set_enabled(state: State<'_, AppState>, id: String, module: Stri
|
|||||||
})
|
})
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn custom_races_status(state: State<'_, AppState>, id: String) -> std::result::Result<Option<coa_core::custom_races::ClientPatchStatus>, UiError> {
|
||||||
|
let ctx = client_context(&state, &id)?;
|
||||||
|
blocking(move || {
|
||||||
|
let client = ctx.linked();
|
||||||
|
Ok(client.as_deref().map(coa_core::custom_races::client_patch_status))
|
||||||
|
})
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn custom_races_install(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> {
|
||||||
|
let ctx = client_context(&state, &id)?;
|
||||||
|
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||||
|
let cancel = begin_client_job(&state)?;
|
||||||
|
let sid = id.clone();
|
||||||
|
let result = blocking(move || {
|
||||||
|
let client = ctx.require()?;
|
||||||
|
coa_core::custom_races::install_client_patches(&client, &cancel, &|step, percent| {
|
||||||
|
let _ = app.emit("custom-races-progress", serde_json::json!({
|
||||||
|
"id": sid,
|
||||||
|
"step": step,
|
||||||
|
"percent": percent,
|
||||||
|
}));
|
||||||
|
})?;
|
||||||
|
let enabled = ctx.root.as_ref().map_or(true, |root| coa_core::modules::list(root).iter().any(|module| module.id == "custom-races" && module.enabled));
|
||||||
|
coa_core::custom_races::set_client_patch_enabled(&client, enabled)
|
||||||
|
})
|
||||||
|
.await;
|
||||||
|
end_client_job(&state);
|
||||||
|
result
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn custom_races_uninstall(state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> {
|
||||||
|
let ctx = client_context(&state, &id)?;
|
||||||
|
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||||
|
blocking(move || coa_core::custom_races::uninstall_client_patches(&ctx.require()?)).await
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn custom_races_toggle_client(state: State<'_, AppState>, id: String, enabled: bool) -> std::result::Result<(), UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||||
|
blocking(move || {
|
||||||
|
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is linked to this server.".into()))?;
|
||||||
|
coa_core::custom_races::set_client_patch_enabled(&client, enabled)
|
||||||
|
})
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
async fn module_settings(state: State<'_, AppState>, id: String, module: String) -> std::result::Result<Vec<coa_core::modules::Setting>, UiError> {
|
async fn module_settings(state: State<'_, AppState>, id: String, module: String) -> std::result::Result<Vec<coa_core::modules::Setting>, UiError> {
|
||||||
@@ -684,12 +806,15 @@ fn install_meta(root: &std::path::Path) -> Result<(PathBuf, InstallMeta)> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
async fn check_update(state: State<'_, AppState>, id: String, source: Option<String>) -> std::result::Result<update::Preview, UiError> {
|
async fn check_update(state: State<'_, AppState>, id: String, source: Option<String>, background: Option<bool>) -> std::result::Result<update::Preview, UiError> {
|
||||||
let root = path_of(&state, &id)?;
|
let root = path_of(&state, &id)?;
|
||||||
let src = update_source(source);
|
|
||||||
|
// The check that repeats every few minutes must not start and stop the database of a stopped server.
|
||||||
|
let access = if background.unwrap_or(false) { update::DatabaseAccess::OnlyIfRunning } else { update::DatabaseAccess::Start };
|
||||||
blocking(move || {
|
blocking(move || {
|
||||||
let (_, meta) = install_meta(&root)?;
|
let (_, meta) = install_meta(&root)?;
|
||||||
update::preview(&root, &meta, &src, coa_core::signing::EMBEDDED_PUBLIC_KEY, &Default::default())
|
let src = update_source(source)?;
|
||||||
|
update::preview_with(&root, &meta, &src, coa_core::signing::EMBEDDED_PUBLIC_KEY, &Default::default(), access)
|
||||||
})
|
})
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
@@ -709,10 +834,13 @@ async fn apply_update(
|
|||||||
resolutions: BTreeMap<String, Resolution>,
|
resolutions: BTreeMap<String, Resolution>,
|
||||||
) -> std::result::Result<update::Outcome, UiError> {
|
) -> std::result::Result<update::Outcome, UiError> {
|
||||||
let root = path_of(&state, &id)?;
|
let root = path_of(&state, &id)?;
|
||||||
let src = update_source(source);
|
|
||||||
let _guard = BusyGuard::acquire(&state, &id)?;
|
let _guard = BusyGuard::acquire(&state, &id)?;
|
||||||
blocking(move || {
|
blocking(move || {
|
||||||
let (dir, _) = install_meta(&root)?;
|
let src = update_source(source)?;
|
||||||
|
let (dir, meta) = install_meta(&root)?;
|
||||||
|
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&src, coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
|
||||||
|
update::validate_candidate(&meta, &manifest)?;
|
||||||
// Files cannot be replaced while the server runs: stop it first (gracefully), like the Stop button.
|
// Files cannot be replaced while the server runs: stop it first (gracefully), like the Stop button.
|
||||||
let observed = coa_core::process::observe(&root, &layout::read_ports(&root));
|
let observed = coa_core::process::observe(&root, &layout::read_ports(&root));
|
||||||
if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped || coa_core::multiworld::is_running(&root) {
|
if observed.world.state != coa_core::process::ServiceState::Stopped || observed.auth.state != coa_core::process::ServiceState::Stopped || coa_core::multiworld::is_running(&root) {
|
||||||
@@ -1496,6 +1624,12 @@ async fn export_diagnostics(state: State<'_, AppState>, id: String) -> std::resu
|
|||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tauri::command]
|
||||||
|
async fn list_crashes(state: State<'_, AppState>, id: String, limit: Option<usize>) -> std::result::Result<Vec<coa_core::crashes::CrashItem>, UiError> {
|
||||||
|
let root = path_of(&state, &id)?;
|
||||||
|
blocking(move || coa_core::crashes::list(&root, limit.unwrap_or(10))).await
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
#[tauri::command]
|
#[tauri::command]
|
||||||
async fn console_tail(
|
async fn console_tail(
|
||||||
@@ -1543,6 +1677,7 @@ pub fn run() {
|
|||||||
.manage(AppState { registry: Registry::at(dir.join("installs.json")), busy: Mutex::new(HashSet::new()), install_cancel: Mutex::new(None), client_cancel: Mutex::new(None) })
|
.manage(AppState { registry: Registry::at(dir.join("installs.json")), busy: Mutex::new(HashSet::new()), install_cancel: Mutex::new(None), client_cancel: Mutex::new(None) })
|
||||||
.invoke_handler(tauri::generate_handler![
|
.invoke_handler(tauri::generate_handler![
|
||||||
default_install_dir,
|
default_install_dir,
|
||||||
|
install_environment,
|
||||||
scan_server,
|
scan_server,
|
||||||
add_server,
|
add_server,
|
||||||
list_servers,
|
list_servers,
|
||||||
@@ -1557,6 +1692,13 @@ pub fn run() {
|
|||||||
list_config_snapshots,
|
list_config_snapshots,
|
||||||
restore_config_snapshot,
|
restore_config_snapshot,
|
||||||
list_backups,
|
list_backups,
|
||||||
|
dashboard_status,
|
||||||
|
dashboard_install,
|
||||||
|
dashboard_start,
|
||||||
|
dashboard_open,
|
||||||
|
dashboard_stop,
|
||||||
|
backup_location,
|
||||||
|
set_backup_location,
|
||||||
create_backup,
|
create_backup,
|
||||||
verify_backup,
|
verify_backup,
|
||||||
delete_backup,
|
delete_backup,
|
||||||
@@ -1623,9 +1765,14 @@ pub fn run() {
|
|||||||
run_diagnostics,
|
run_diagnostics,
|
||||||
verify_files,
|
verify_files,
|
||||||
export_diagnostics,
|
export_diagnostics,
|
||||||
|
list_crashes,
|
||||||
console_tail,
|
console_tail,
|
||||||
console_risk,
|
console_risk,
|
||||||
console_command
|
console_command,
|
||||||
|
custom_races_status,
|
||||||
|
custom_races_install,
|
||||||
|
custom_races_uninstall,
|
||||||
|
custom_races_toggle_client
|
||||||
])
|
])
|
||||||
.run(tauri::generate_context!())
|
.run(tauri::generate_context!())
|
||||||
.expect("error while running CoA Server Manager");
|
.expect("error while running CoA Server Manager");
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"$schema": "https://schema.tauri.app/config/2",
|
"$schema": "https://schema.tauri.app/config/2",
|
||||||
"productName": "CoA Server Manager",
|
"productName": "CoA Server Manager",
|
||||||
"version": "0.6.6",
|
"version": "0.6.15",
|
||||||
"identifier": "com.coa.servermanager",
|
"identifier": "com.coa.servermanager",
|
||||||
"build": {
|
"build": {
|
||||||
"beforeDevCommand": "npm run dev",
|
"beforeDevCommand": "npm run dev",
|
||||||
@@ -21,7 +21,7 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"security": {
|
"security": {
|
||||||
"csp": "default-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self' ipc: http://ipc.localhost"
|
"csp": "default-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; connect-src 'self' ipc: http://ipc.localhost; frame-src http://localhost:* http://127.0.0.1:*"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"bundle": {
|
"bundle": {
|
||||||
|
|||||||
@@ -91,6 +91,8 @@ export {};
|
|||||||
if(cmd==="report_targets") return [{id:"manager",repo:"Corfirean/coa-server-manager",ours:true},{id:"companions",repo:"Corfirean/mod-coa-playerbots",ours:true},{id:"squid",repo:"Zyth45/mod-playerbots",ours:false}];
|
if(cmd==="report_targets") return [{id:"manager",repo:"Corfirean/coa-server-manager",ours:true},{id:"companions",repo:"Corfirean/mod-coa-playerbots",ours:true},{id:"squid",repo:"Zyth45/mod-playerbots",ours:false}];
|
||||||
if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;}
|
if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;}
|
||||||
if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip";
|
if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip";
|
||||||
|
if(cmd==="list_crashes") return [];
|
||||||
|
if(cmd==="install_environment"){const docker=new URLSearchParams(location.search).get("flavor")==="docker";return docker?{flavor:"docker",default_dir:"/home/you/CoaServer",docker_problem:new URLSearchParams(location.search).has("nodocker")?"permission denied while trying to connect to the Docker daemon socket":null}:{flavor:"repack",default_dir:"C:\\Games\\CoA Server",docker_problem:null};}
|
||||||
if(cmd==="install_preflight") return {ok:true,problems:[],free_bytes:210*2**30};
|
if(cmd==="install_preflight") return {ok:true,problems:[],free_bytes:210*2**30};
|
||||||
if(cmd==="install_requirements") return {download_bytes:Math.round(5.9*2**30),unpacked_bytes:Math.round(11.4*2**30),version:"0.2.0"};
|
if(cmd==="install_requirements") return {download_bytes:Math.round(5.9*2**30),unpacked_bytes:Math.round(11.4*2**30),version:"0.2.0"};
|
||||||
if(cmd==="list_accounts"){const w=window as any;w.__acc=w.__acc??[{id:2,name:"ALICE",access:3,online:true,last_login:"2026-10-01 12:04:11",characters:4},{id:5,name:"BOB",access:0,online:false,last_login:null,characters:0},{id:6,name:"CAROL",access:2,online:false,last_login:"2026-09-30 21:40:02",characters:2}];return w.__acc;}
|
if(cmd==="list_accounts"){const w=window as any;w.__acc=w.__acc??[{id:2,name:"ALICE",access:3,online:true,last_login:"2026-10-01 12:04:11",characters:4},{id:5,name:"BOB",access:0,online:false,last_login:null,characters:0},{id:6,name:"CAROL",access:2,online:false,last_login:"2026-09-30 21:40:02",characters:2}];return w.__acc;}
|
||||||
|
|||||||
+50
-4
@@ -20,7 +20,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"nav.overview": "Übersicht",
|
"nav.overview": "Übersicht",
|
||||||
"nav.bots": "Bots",
|
"nav.bots": "Bots",
|
||||||
"nav.server": "Server",
|
"nav.server": "Server",
|
||||||
"nav.players": "Spieler",
|
"nav.players": "Konten",
|
||||||
"nav.friends": "Mit Freunden spielen",
|
"nav.friends": "Mit Freunden spielen",
|
||||||
"nav.backups": "Sicherungen",
|
"nav.backups": "Sicherungen",
|
||||||
"nav.console": "Konsole",
|
"nav.console": "Konsole",
|
||||||
@@ -32,7 +32,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"q.overview": "Läuft mein Server?",
|
"q.overview": "Läuft mein Server?",
|
||||||
"q.bots": "Wie sind meine Bots eingestellt?",
|
"q.bots": "Wie sind meine Bots eingestellt?",
|
||||||
"q.server": "Wie verhält sich mein Server?",
|
"q.server": "Wie verhält sich mein Server?",
|
||||||
"q.players": "Wer spielt gerade?",
|
"q.players": "Wer kann sich im Spiel anmelden?",
|
||||||
"q.friends": "Wie kann mein Freund beitreten?",
|
"q.friends": "Wie kann mein Freund beitreten?",
|
||||||
"q.backups": "Sind meine Daten sicher?",
|
"q.backups": "Sind meine Daten sicher?",
|
||||||
"q.console": "Was macht der Server gerade?",
|
"q.console": "Was macht der Server gerade?",
|
||||||
@@ -167,7 +167,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"install.open": "MEINEN SERVER ÖFFNEN",
|
"install.open": "MEINEN SERVER ÖFFNEN",
|
||||||
|
|
||||||
// Players
|
// Players
|
||||||
"players.title": "Spieler",
|
"players.title": "Konten",
|
||||||
"players.createTitle": "Erstelle dein Konto",
|
"players.createTitle": "Erstelle dein Konto",
|
||||||
"players.createText": "Das sind der Name und das Passwort, mit denen du dich im Spiel anmeldest.",
|
"players.createText": "Das sind der Name und das Passwort, mit denen du dich im Spiel anmeldest.",
|
||||||
"players.startFirst": "Starte zuerst den Server – Konten werden erstellt, solange er läuft.",
|
"players.startFirst": "Starte zuerst den Server – Konten werden erstellt, solange er läuft.",
|
||||||
@@ -195,6 +195,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"comp.saved": "Gespeichert. {n} Begleiter werden beim Serverstart erstellt.",
|
"comp.saved": "Gespeichert. {n} Begleiter werden beim Serverstart erstellt.",
|
||||||
|
|
||||||
// Client
|
// Client
|
||||||
|
"client.races.install": "Patch für benutzerdefinierte Völker installieren",
|
||||||
"client.title": "Spielclient",
|
"client.title": "Spielclient",
|
||||||
"client.looking": "Suche …",
|
"client.looking": "Suche …",
|
||||||
"client.intro": "Sag dem Manager, wo dein Spiel installiert ist, um einen SPIELEN-Button zu erhalten. Deine Spieldateien werden nie geändert, außer der Serveradresse und dem Begleiter-Addon.",
|
"client.intro": "Sag dem Manager, wo dein Spiel installiert ist, um einen SPIELEN-Button zu erhalten. Deine Spieldateien werden nie geändert, außer der Serveradresse und dem Begleiter-Addon.",
|
||||||
@@ -495,7 +496,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"ustep.Updating the database": "Datenbank wird aktualisiert",
|
"ustep.Updating the database": "Datenbank wird aktualisiert",
|
||||||
"ustep.Starting the updated server": "Aktualisierter Server wird gestartet",
|
"ustep.Starting the updated server": "Aktualisierter Server wird gestartet",
|
||||||
"ustep.Finishing": "Abschluss",
|
"ustep.Finishing": "Abschluss",
|
||||||
"ustep.Undoing the update": "Update wird rückgängig gemacht",
|
"ustep.Undoing the update": "Update wird rückgängig gemacht (das Wiederherstellen der Datenbanken kann mehrere Minuten dauern)",
|
||||||
"ustep.Done": "Fertig",
|
"ustep.Done": "Fertig",
|
||||||
|
|
||||||
// Companion sizes
|
// Companion sizes
|
||||||
@@ -827,6 +828,36 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"set.searchAll": "Alle Einstellungen nach Name oder Beschreibung durchsuchen…",
|
"set.searchAll": "Alle Einstellungen nach Name oder Beschreibung durchsuchen…",
|
||||||
"set.search": "Einstellungen durchsuchen…",
|
"set.search": "Einstellungen durchsuchen…",
|
||||||
"upd.current": "Du bist auf dem neuesten Stand (Version {v}).",
|
"upd.current": "Du bist auf dem neuesten Stand (Version {v}).",
|
||||||
|
"nav.dashboard": "Dashboard",
|
||||||
|
"q.dashboard": "Was tun die Bots gerade?",
|
||||||
|
"dash.title": "Bot-Dashboard",
|
||||||
|
"dash.intro": "SQUIDs Live-Seite zu den Bots: wo sie sind, was sie tun, was sie finden. Läuft nur auf diesem Computer.",
|
||||||
|
"dash.notInstalled": "Das Dashboard ist noch nicht installiert.",
|
||||||
|
"dash.willInstall": "Die zu deinen Bots {v} passende Version wird heruntergeladen.",
|
||||||
|
"dash.noSquid": "Die Version deiner SQUID-Bots konnte nicht gelesen werden.",
|
||||||
|
"dash.install": "Dashboard herunterladen",
|
||||||
|
"dash.versions": "Dashboard {dash} für Bots {bots}",
|
||||||
|
"dash.running": "läuft",
|
||||||
|
"dash.stopped": "angehalten",
|
||||||
|
"dash.mismatch": "Dieses Dashboard gehört nicht zu deinen Bots {bots}. Aktualisiere es, damit die Versionen passen.",
|
||||||
|
"dash.start": "Dashboard starten",
|
||||||
|
"dash.stop": "Dashboard anhalten",
|
||||||
|
"dash.openBrowser": "Im Browser öffnen",
|
||||||
|
"dash.update": "Dashboard aktualisieren",
|
||||||
|
"upd.startAfter": "Server nach dem Update starten (sonst bleibt ein angehaltener Server angehalten)",
|
||||||
|
"client.startAfter": "Spiel nach dem Client-Update starten",
|
||||||
|
"bk.folder": "Sicherungsordner",
|
||||||
|
"bk.folderDefault": "Standard",
|
||||||
|
"bk.folderNote": "Neue Sicherungen werden hier gespeichert, zum Beispiel auf einem anderen Laufwerk. Frühere Sicherungen bleiben, wo sie sind, und werden weiter aufgelistet. Der Ordner muss außerhalb des Serverordners liegen.",
|
||||||
|
"bk.folderChange": "Ordner ändern…",
|
||||||
|
"bk.folderReset": "Standardordner verwenden",
|
||||||
|
"bk.folderChanged": "Sicherungsordner geändert.",
|
||||||
|
"remove.title": "Diesen Server aus dem Manager entfernen",
|
||||||
|
"remove.text": "Der Manager zeigt diesen Server nicht mehr an. Es werden keine Dateien, Datenbanken oder Sicherungen gelöscht; den Ordner kannst du später über „Weiteren Server verwalten“ wieder hinzufügen.",
|
||||||
|
"remove.button": "Aus dem Manager entfernen",
|
||||||
|
"remove.stopFirst": "Halte zuerst den Server an.",
|
||||||
|
"remove.confirm": "Diesen Server aus dem Manager entfernen?\n\n{path}\n\nEs werden keine Dateien gelöscht.",
|
||||||
|
"upd.dbUnchecked": "Die Datenbank konnte nicht geprüft werden, daher sind offene Datenbankänderungen unbekannt: {why}",
|
||||||
"client.job.checking": "Client wird geprüft…",
|
"client.job.checking": "Client wird geprüft…",
|
||||||
"client.job.updating": "Client wird aktualisiert",
|
"client.job.updating": "Client wird aktualisiert",
|
||||||
"fr.lan.address": "Netzwerkadresse",
|
"fr.lan.address": "Netzwerkadresse",
|
||||||
@@ -837,6 +868,21 @@ const de: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"fr.lan.unavailable": "Ausgewählte Adresse nicht verfügbar",
|
"fr.lan.unavailable": "Ausgewählte Adresse nicht verfügbar",
|
||||||
"fr.lan.unavailableText": "Die ausgewählte Adresse ist derzeit keinem erkannten lokalen Netzwerkadapter zugewiesen. Wählen Sie eine andere Adresse oder Automatisch, oder behalten Sie diese Adresse bewusst bei.",
|
"fr.lan.unavailableText": "Die ausgewählte Adresse ist derzeit keinem erkannten lokalen Netzwerkadapter zugewiesen. Wählen Sie eine andere Adresse oder Automatisch, oder behalten Sie diese Adresse bewusst bei.",
|
||||||
"fr.lan.invalid": "Ungültige IPv4-Adresse",
|
"fr.lan.invalid": "Ungültige IPv4-Adresse",
|
||||||
|
"unsaved.title": "Nicht gespeicherte Änderungen",
|
||||||
|
"unsaved.message": "Sie haben nicht gespeicherte Änderungen. Möchten Sie diese vor dem Verlassen der Seite speichern?",
|
||||||
|
"unsaved.saveFailed": "Änderungen konnten nicht gespeichert werden. Bitte Eingaben überprüfen.",
|
||||||
|
"crash.autoRestart": "Automatischer Neustart bei Absturz",
|
||||||
|
"crash.autoRestartDesc": "Startet den Server automatisch neu, falls er unerwartet abstürzt.",
|
||||||
|
"crash.badge": "Abstürze: {n}",
|
||||||
|
"crash.historyTitle": "Absturzverlauf des Servers",
|
||||||
|
"crash.noCrashes": "Keine Absturzberichte gefunden.",
|
||||||
|
"crash.restartNotice": "Der Server ist abgestürzt und wurde automatisch neu gestartet (Absturz #{n}).",
|
||||||
|
"crash.loopPaused": "Automatischer Neustart pausiert: Der Server ist mehrfach kurz hintereinander abgestürzt.",
|
||||||
|
"crash.details": "Absturzdetails",
|
||||||
|
"crash.viewRaw": "Vollständigen Bericht anzeigen",
|
||||||
|
"crash.hideRaw": "Vollständigen Bericht verbergen",
|
||||||
|
"crash.copyReport": "Bericht kopieren",
|
||||||
|
"crash.copied": "Kopiert!",
|
||||||
};
|
};
|
||||||
|
|
||||||
export default de;
|
export default de;
|
||||||
+60
-4
@@ -32,6 +32,8 @@ const en = {
|
|||||||
"repair.result": "Restored files: {files}. Applied database updates: {sql}.",
|
"repair.result": "Restored files: {files}. Applied database updates: {sql}.",
|
||||||
"repair.backup": "Backup: {id}",
|
"repair.backup": "Backup: {id}",
|
||||||
"repair.fileCount": "Files that differ or are missing: {n}",
|
"repair.fileCount": "Files that differ or are missing: {n}",
|
||||||
|
"repair.fileMissing": "missing",
|
||||||
|
"repair.fileChanged": "changed",
|
||||||
"repair.dbCount": "Schema/start-data problems: {columns}. Pending or failed SQL updates: {sql}.",
|
"repair.dbCount": "Schema/start-data problems: {columns}. Pending or failed SQL updates: {sql}.",
|
||||||
"repair.limited": "This older package has no full schema contract. Only character-save columns and starting data are checked.",
|
"repair.limited": "This older package has no full schema contract. Only character-save columns and starting data are checked.",
|
||||||
"repair.unresolved": "Database problems remain. Repair does not replay already applied SQL or invent column changes. Export diagnostics with the listed problems for a corrective server update.",
|
"repair.unresolved": "Database problems remain. Repair does not replay already applied SQL or invent column changes. Export diagnostics with the listed problems for a corrective server update.",
|
||||||
@@ -51,7 +53,7 @@ const en = {
|
|||||||
"nav.overview": "Overview",
|
"nav.overview": "Overview",
|
||||||
"nav.bots": "Bots",
|
"nav.bots": "Bots",
|
||||||
"nav.server": "Server",
|
"nav.server": "Server",
|
||||||
"nav.players": "Players",
|
"nav.players": "Accounts",
|
||||||
"nav.friends": "Play with Friends",
|
"nav.friends": "Play with Friends",
|
||||||
"nav.backups": "Backups",
|
"nav.backups": "Backups",
|
||||||
"nav.console": "Console",
|
"nav.console": "Console",
|
||||||
@@ -63,7 +65,7 @@ const en = {
|
|||||||
"q.overview": "Is my server running?",
|
"q.overview": "Is my server running?",
|
||||||
"q.bots": "How are my bots configured?",
|
"q.bots": "How are my bots configured?",
|
||||||
"q.server": "How does my server behave?",
|
"q.server": "How does my server behave?",
|
||||||
"q.players": "Who is playing right now?",
|
"q.players": "Who can log in to the game?",
|
||||||
"q.friends": "How can my friend join?",
|
"q.friends": "How can my friend join?",
|
||||||
"q.backups": "Is my data safe?",
|
"q.backups": "Is my data safe?",
|
||||||
"q.console": "What is the server doing?",
|
"q.console": "What is the server doing?",
|
||||||
@@ -188,6 +190,14 @@ const en = {
|
|||||||
"install.localPkg": "Install from a local package folder instead of downloading",
|
"install.localPkg": "Install from a local package folder instead of downloading",
|
||||||
"install.localPkgHint": "(leave empty to download)",
|
"install.localPkgHint": "(leave empty to download)",
|
||||||
"install.button": "Install",
|
"install.button": "Install",
|
||||||
|
"install.docker.title": "Docker is needed",
|
||||||
|
"install.docker.text": "On Linux the server runs in Docker. Install Docker and start it, or allow your user to use it, then check again.",
|
||||||
|
"install.docker.retry": "Check again",
|
||||||
|
"install.data.label": "Game data folder",
|
||||||
|
"install.data.hint": "The folder with the game's dbc, maps, vmaps and mmaps. It is used where it is and never changed.",
|
||||||
|
"install.data.dialogTitle": "Choose the game data folder",
|
||||||
|
"install.linuxPkg.label": "Server package",
|
||||||
|
"install.linuxPkg.hint": "A folder or an address of the Linux server package",
|
||||||
"install.progressTitle": "Preparing your server",
|
"install.progressTitle": "Preparing your server",
|
||||||
"install.progressText": "This can take a few minutes. You can leave this window open.",
|
"install.progressText": "This can take a few minutes. You can leave this window open.",
|
||||||
"install.step.checking": "Checking your computer",
|
"install.step.checking": "Checking your computer",
|
||||||
@@ -200,7 +210,7 @@ const en = {
|
|||||||
"install.open": "OPEN MY SERVER",
|
"install.open": "OPEN MY SERVER",
|
||||||
|
|
||||||
// Players
|
// Players
|
||||||
"players.title": "Players",
|
"players.title": "Accounts",
|
||||||
"players.createTitle": "Create your account",
|
"players.createTitle": "Create your account",
|
||||||
"players.createText": "This is the name and password you use to log in to the game.",
|
"players.createText": "This is the name and password you use to log in to the game.",
|
||||||
"players.startFirst": "Start the server first — accounts are created while it is running.",
|
"players.startFirst": "Start the server first — accounts are created while it is running.",
|
||||||
@@ -228,6 +238,7 @@ const en = {
|
|||||||
"comp.saved": "Saved. {n} companions will be created when the server starts.",
|
"comp.saved": "Saved. {n} companions will be created when the server starts.",
|
||||||
|
|
||||||
// Client
|
// Client
|
||||||
|
"client.races.install": "Install custom race patch",
|
||||||
"client.title": "Game client",
|
"client.title": "Game client",
|
||||||
"client.looking": "Looking…",
|
"client.looking": "Looking…",
|
||||||
"client.intro": "Tell Manager where your game is installed to get a PLAY button. Your game files are never changed except the server address and the companion addon.",
|
"client.intro": "Tell Manager where your game is installed to get a PLAY button. Your game files are never changed except the server address and the companion addon.",
|
||||||
@@ -528,7 +539,7 @@ const en = {
|
|||||||
"ustep.Updating the database": "Updating the database",
|
"ustep.Updating the database": "Updating the database",
|
||||||
"ustep.Starting the updated server": "Starting the updated server",
|
"ustep.Starting the updated server": "Starting the updated server",
|
||||||
"ustep.Finishing": "Finishing",
|
"ustep.Finishing": "Finishing",
|
||||||
"ustep.Undoing the update": "Undoing the update",
|
"ustep.Undoing the update": "Undoing the update (restoring the databases can take several minutes)",
|
||||||
"ustep.Done": "Done",
|
"ustep.Done": "Done",
|
||||||
|
|
||||||
// Companion sizes
|
// Companion sizes
|
||||||
@@ -848,6 +859,36 @@ const en = {
|
|||||||
"set.searchAll": "Search all settings by name or description…",
|
"set.searchAll": "Search all settings by name or description…",
|
||||||
"set.search": "Search settings…",
|
"set.search": "Search settings…",
|
||||||
"upd.current": "You are up to date (version {v}).",
|
"upd.current": "You are up to date (version {v}).",
|
||||||
|
"nav.dashboard": "Dashboard",
|
||||||
|
"q.dashboard": "What are the bots doing right now?",
|
||||||
|
"dash.title": "Bot dashboard",
|
||||||
|
"dash.intro": "SQUID's live page for the bots: where they are, what they do, what they find. It runs on this computer only.",
|
||||||
|
"dash.notInstalled": "The dashboard is not installed yet.",
|
||||||
|
"dash.willInstall": "The release that matches your bots {v} will be downloaded.",
|
||||||
|
"dash.noSquid": "The version of your SQUID bots could not be read.",
|
||||||
|
"dash.install": "Download the dashboard",
|
||||||
|
"dash.versions": "Dashboard {dash} for bots {bots}",
|
||||||
|
"dash.running": "running",
|
||||||
|
"dash.stopped": "stopped",
|
||||||
|
"dash.mismatch": "This dashboard does not belong to your bots {bots}. Update it so that they match.",
|
||||||
|
"dash.start": "Start the dashboard",
|
||||||
|
"dash.stop": "Stop the dashboard",
|
||||||
|
"dash.openBrowser": "Open in the browser",
|
||||||
|
"dash.update": "Update the dashboard",
|
||||||
|
"upd.startAfter": "Start the server after updating it (otherwise a stopped server stays stopped)",
|
||||||
|
"client.startAfter": "Start the game after the client has been updated",
|
||||||
|
"bk.folder": "Backup folder",
|
||||||
|
"bk.folderDefault": "default",
|
||||||
|
"bk.folderNote": "New backups are saved here, for example on another drive. Backups made earlier stay where they are and are still listed. The folder must be outside the server folder.",
|
||||||
|
"bk.folderChange": "Change folder…",
|
||||||
|
"bk.folderReset": "Use the default folder",
|
||||||
|
"bk.folderChanged": "Backup folder changed.",
|
||||||
|
"remove.title": "Remove this server from the Manager",
|
||||||
|
"remove.text": "The Manager stops listing this server. No files, databases or backups are deleted, and you can add the folder again later with “Manage another server”.",
|
||||||
|
"remove.button": "Remove from Manager",
|
||||||
|
"remove.stopFirst": "Stop the server first.",
|
||||||
|
"remove.confirm": "Remove this server from the Manager?\n\n{path}\n\nNo files are deleted.",
|
||||||
|
"upd.dbUnchecked": "The database could not be checked, so pending database changes are unknown: {why}",
|
||||||
"client.job.checking": "Checking the client…",
|
"client.job.checking": "Checking the client…",
|
||||||
"client.job.updating": "Updating the client",
|
"client.job.updating": "Updating the client",
|
||||||
"fr.lan.address": "Network address",
|
"fr.lan.address": "Network address",
|
||||||
@@ -858,6 +899,21 @@ const en = {
|
|||||||
"fr.lan.unavailable": "Selected address unavailable",
|
"fr.lan.unavailable": "Selected address unavailable",
|
||||||
"fr.lan.unavailableText": "The selected address is not currently assigned to a detected local interface. Choose another address or switch to Automatic, or keep this address intentionally.",
|
"fr.lan.unavailableText": "The selected address is not currently assigned to a detected local interface. Choose another address or switch to Automatic, or keep this address intentionally.",
|
||||||
"fr.lan.invalid": "Invalid IPv4 address",
|
"fr.lan.invalid": "Invalid IPv4 address",
|
||||||
|
"unsaved.title": "Unsaved changes",
|
||||||
|
"unsaved.message": "You have unsaved changes. Do you want to save them before leaving this page?",
|
||||||
|
"unsaved.saveFailed": "Failed to save changes. Please check fields for errors.",
|
||||||
|
"crash.autoRestart": "Auto-restart on crash",
|
||||||
|
"crash.autoRestartDesc": "Automatically restart the world server if it crashes or stops unexpectedly.",
|
||||||
|
"crash.badge": "Crashes: {n}",
|
||||||
|
"crash.historyTitle": "Server Crash History",
|
||||||
|
"crash.noCrashes": "No crash reports found.",
|
||||||
|
"crash.restartNotice": "Server crashed and was automatically restarted (Crash #{n}).",
|
||||||
|
"crash.loopPaused": "Auto-restart paused: the server crashed repeatedly in a short period.",
|
||||||
|
"crash.details": "Crash Details",
|
||||||
|
"crash.viewRaw": "View full crash report",
|
||||||
|
"crash.hideRaw": "Hide full report",
|
||||||
|
"crash.copyReport": "Copy crash report",
|
||||||
|
"crash.copied": "Copied!",
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
export default en;
|
export default en;
|
||||||
+50
-4
@@ -20,7 +20,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"nav.overview": "Resumen",
|
"nav.overview": "Resumen",
|
||||||
"nav.bots": "Bots",
|
"nav.bots": "Bots",
|
||||||
"nav.server": "Servidor",
|
"nav.server": "Servidor",
|
||||||
"nav.players": "Jugadores",
|
"nav.players": "Cuentas",
|
||||||
"nav.friends": "Jugar con amigos",
|
"nav.friends": "Jugar con amigos",
|
||||||
"nav.backups": "Copias de seguridad",
|
"nav.backups": "Copias de seguridad",
|
||||||
"nav.console": "Consola",
|
"nav.console": "Consola",
|
||||||
@@ -32,7 +32,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"q.overview": "¿Está funcionando mi servidor?",
|
"q.overview": "¿Está funcionando mi servidor?",
|
||||||
"q.bots": "¿Cómo están configurados mis bots?",
|
"q.bots": "¿Cómo están configurados mis bots?",
|
||||||
"q.server": "¿Cómo se comporta mi servidor?",
|
"q.server": "¿Cómo se comporta mi servidor?",
|
||||||
"q.players": "¿Quién está jugando ahora?",
|
"q.players": "¿Quién puede entrar al juego?",
|
||||||
"q.friends": "¿Cómo puede unirse mi amigo?",
|
"q.friends": "¿Cómo puede unirse mi amigo?",
|
||||||
"q.backups": "¿Están seguros mis datos?",
|
"q.backups": "¿Están seguros mis datos?",
|
||||||
"q.console": "¿Qué está haciendo el servidor?",
|
"q.console": "¿Qué está haciendo el servidor?",
|
||||||
@@ -167,7 +167,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"install.open": "ABRIR MI SERVIDOR",
|
"install.open": "ABRIR MI SERVIDOR",
|
||||||
|
|
||||||
// Players
|
// Players
|
||||||
"players.title": "Jugadores",
|
"players.title": "Cuentas",
|
||||||
"players.createTitle": "Crea tu cuenta",
|
"players.createTitle": "Crea tu cuenta",
|
||||||
"players.createText": "Este es el nombre y la contraseña con los que inicias sesión en el juego.",
|
"players.createText": "Este es el nombre y la contraseña con los que inicias sesión en el juego.",
|
||||||
"players.startFirst": "Inicia primero el servidor: las cuentas se crean mientras está en marcha.",
|
"players.startFirst": "Inicia primero el servidor: las cuentas se crean mientras está en marcha.",
|
||||||
@@ -195,6 +195,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"comp.saved": "Guardado. Se crearán {n} compañeros cuando se inicie el servidor.",
|
"comp.saved": "Guardado. Se crearán {n} compañeros cuando se inicie el servidor.",
|
||||||
|
|
||||||
// Client
|
// Client
|
||||||
|
"client.races.install": "Instalar parche de razas personalizadas",
|
||||||
"client.title": "Cliente del juego",
|
"client.title": "Cliente del juego",
|
||||||
"client.looking": "Buscando…",
|
"client.looking": "Buscando…",
|
||||||
"client.intro": "Indica al Manager dónde está instalado el juego para obtener un botón JUGAR. Tus archivos del juego nunca se modifican, salvo la dirección del servidor y el addon de compañeros.",
|
"client.intro": "Indica al Manager dónde está instalado el juego para obtener un botón JUGAR. Tus archivos del juego nunca se modifican, salvo la dirección del servidor y el addon de compañeros.",
|
||||||
@@ -495,7 +496,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"ustep.Updating the database": "Actualizando la base de datos",
|
"ustep.Updating the database": "Actualizando la base de datos",
|
||||||
"ustep.Starting the updated server": "Iniciando el servidor actualizado",
|
"ustep.Starting the updated server": "Iniciando el servidor actualizado",
|
||||||
"ustep.Finishing": "Finalizando",
|
"ustep.Finishing": "Finalizando",
|
||||||
"ustep.Undoing the update": "Deshaciendo la actualización",
|
"ustep.Undoing the update": "Deshaciendo la actualización (restaurar las bases de datos puede tardar varios minutos)",
|
||||||
"ustep.Done": "Hecho",
|
"ustep.Done": "Hecho",
|
||||||
|
|
||||||
// Companion sizes
|
// Companion sizes
|
||||||
@@ -827,6 +828,36 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"set.searchAll": "Buscar en todos los ajustes por nombre o descripción…",
|
"set.searchAll": "Buscar en todos los ajustes por nombre o descripción…",
|
||||||
"set.search": "Buscar ajustes…",
|
"set.search": "Buscar ajustes…",
|
||||||
"upd.current": "Estás al día (versión {v}).",
|
"upd.current": "Estás al día (versión {v}).",
|
||||||
|
"nav.dashboard": "Panel",
|
||||||
|
"q.dashboard": "¿Qué están haciendo los bots ahora?",
|
||||||
|
"dash.title": "Panel de bots",
|
||||||
|
"dash.intro": "La página en vivo de SQUID sobre los bots: dónde están, qué hacen, qué encuentran. Funciona solo en este equipo.",
|
||||||
|
"dash.notInstalled": "El panel aún no está instalado.",
|
||||||
|
"dash.willInstall": "Se descargará la versión que corresponde a tus bots {v}.",
|
||||||
|
"dash.noSquid": "No se pudo leer la versión de tus bots SQUID.",
|
||||||
|
"dash.install": "Descargar el panel",
|
||||||
|
"dash.versions": "Panel {dash} para bots {bots}",
|
||||||
|
"dash.running": "en marcha",
|
||||||
|
"dash.stopped": "detenido",
|
||||||
|
"dash.mismatch": "Este panel no corresponde a tus bots {bots}. Actualízalo para que coincidan.",
|
||||||
|
"dash.start": "Iniciar el panel",
|
||||||
|
"dash.stop": "Detener el panel",
|
||||||
|
"dash.openBrowser": "Abrir en el navegador",
|
||||||
|
"dash.update": "Actualizar el panel",
|
||||||
|
"upd.startAfter": "Iniciar el servidor tras actualizarlo (si no, un servidor detenido sigue detenido)",
|
||||||
|
"client.startAfter": "Iniciar el juego tras actualizar el cliente",
|
||||||
|
"bk.folder": "Carpeta de copias de seguridad",
|
||||||
|
"bk.folderDefault": "predeterminada",
|
||||||
|
"bk.folderNote": "Las copias nuevas se guardan aquí, por ejemplo en otra unidad. Las anteriores se quedan donde están y siguen en la lista. La carpeta debe estar fuera de la carpeta del servidor.",
|
||||||
|
"bk.folderChange": "Cambiar carpeta…",
|
||||||
|
"bk.folderReset": "Usar la carpeta predeterminada",
|
||||||
|
"bk.folderChanged": "Carpeta de copias cambiada.",
|
||||||
|
"remove.title": "Quitar este servidor del Manager",
|
||||||
|
"remove.text": "El Manager deja de mostrar este servidor. No se borran archivos, bases de datos ni copias de seguridad, y puedes volver a añadir la carpeta con «Gestionar otro servidor».",
|
||||||
|
"remove.button": "Quitar del Manager",
|
||||||
|
"remove.stopFirst": "Detén primero el servidor.",
|
||||||
|
"remove.confirm": "¿Quitar este servidor del Manager?\n\n{path}\n\nNo se borra ningún archivo.",
|
||||||
|
"upd.dbUnchecked": "No se pudo comprobar la base de datos, así que se desconocen los cambios pendientes: {why}",
|
||||||
"client.job.checking": "Comprobando el cliente…",
|
"client.job.checking": "Comprobando el cliente…",
|
||||||
"client.job.updating": "Actualizando el cliente",
|
"client.job.updating": "Actualizando el cliente",
|
||||||
"fr.lan.address": "Dirección de red",
|
"fr.lan.address": "Dirección de red",
|
||||||
@@ -837,6 +868,21 @@ const es: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"fr.lan.unavailable": "Dirección seleccionada no disponible",
|
"fr.lan.unavailable": "Dirección seleccionada no disponible",
|
||||||
"fr.lan.unavailableText": "La dirección seleccionada no está asignada actualmente a ninguna interfaz local detectada. Elige otra dirección o Automática, o conserva esta dirección si así lo deseas.",
|
"fr.lan.unavailableText": "La dirección seleccionada no está asignada actualmente a ninguna interfaz local detectada. Elige otra dirección o Automática, o conserva esta dirección si así lo deseas.",
|
||||||
"fr.lan.invalid": "Dirección IPv4 no válida",
|
"fr.lan.invalid": "Dirección IPv4 no válida",
|
||||||
|
"unsaved.title": "Cambios sin guardar",
|
||||||
|
"unsaved.message": "¿Tienes cambios sin guardar. ¿Quieres guardarlos antes de salir de esta página?",
|
||||||
|
"unsaved.saveFailed": "Error al guardar los cambios. Revisa los campos.",
|
||||||
|
"crash.autoRestart": "Reinicio automático tras caída",
|
||||||
|
"crash.autoRestartDesc": "Reinicia automáticamente el servidor si se detiene de forma inesperada.",
|
||||||
|
"crash.badge": "Caídas: {n}",
|
||||||
|
"crash.historyTitle": "Historial de caídas del servidor",
|
||||||
|
"crash.noCrashes": "No se encontraron informes de caídas.",
|
||||||
|
"crash.restartNotice": "El servidor se cayó y se reinició automáticamente (Caída #{n}).",
|
||||||
|
"crash.loopPaused": "Reinicio automático pausado: el servidor se ha caído varias veces en poco tiempo.",
|
||||||
|
"crash.details": "Detalles de la caída",
|
||||||
|
"crash.viewRaw": "Ver informe completo",
|
||||||
|
"crash.hideRaw": "Ocultar informe completo",
|
||||||
|
"crash.copyReport": "Copiar informe",
|
||||||
|
"crash.copied": "¡Copiado!",
|
||||||
};
|
};
|
||||||
|
|
||||||
export default es;
|
export default es;
|
||||||
+50
-4
@@ -20,7 +20,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"nav.overview": "Vue d’ensemble",
|
"nav.overview": "Vue d’ensemble",
|
||||||
"nav.bots": "Bots",
|
"nav.bots": "Bots",
|
||||||
"nav.server": "Serveur",
|
"nav.server": "Serveur",
|
||||||
"nav.players": "Joueurs",
|
"nav.players": "Comptes",
|
||||||
"nav.friends": "Jouer avec des amis",
|
"nav.friends": "Jouer avec des amis",
|
||||||
"nav.backups": "Sauvegardes",
|
"nav.backups": "Sauvegardes",
|
||||||
"nav.console": "Console",
|
"nav.console": "Console",
|
||||||
@@ -32,7 +32,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"q.overview": "Mon serveur fonctionne-t-il ?",
|
"q.overview": "Mon serveur fonctionne-t-il ?",
|
||||||
"q.bots": "Comment mes bots sont-ils configurés ?",
|
"q.bots": "Comment mes bots sont-ils configurés ?",
|
||||||
"q.server": "Comment se comporte mon serveur ?",
|
"q.server": "Comment se comporte mon serveur ?",
|
||||||
"q.players": "Qui joue en ce moment ?",
|
"q.players": "Qui peut se connecter au jeu ?",
|
||||||
"q.friends": "Comment mon ami peut-il se connecter ?",
|
"q.friends": "Comment mon ami peut-il se connecter ?",
|
||||||
"q.backups": "Mes données sont-elles en sécurité ?",
|
"q.backups": "Mes données sont-elles en sécurité ?",
|
||||||
"q.console": "Que fait le serveur ?",
|
"q.console": "Que fait le serveur ?",
|
||||||
@@ -167,7 +167,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"install.open": "OUVRIR MON SERVEUR",
|
"install.open": "OUVRIR MON SERVEUR",
|
||||||
|
|
||||||
// Players
|
// Players
|
||||||
"players.title": "Joueurs",
|
"players.title": "Comptes",
|
||||||
"players.createTitle": "Créez votre compte",
|
"players.createTitle": "Créez votre compte",
|
||||||
"players.createText": "C’est le nom et le mot de passe que vous utilisez pour vous connecter au jeu.",
|
"players.createText": "C’est le nom et le mot de passe que vous utilisez pour vous connecter au jeu.",
|
||||||
"players.startFirst": "Démarrez d’abord le serveur : les comptes sont créés pendant qu’il fonctionne.",
|
"players.startFirst": "Démarrez d’abord le serveur : les comptes sont créés pendant qu’il fonctionne.",
|
||||||
@@ -195,6 +195,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"comp.saved": "Enregistré. {n} compagnons seront créés au démarrage du serveur.",
|
"comp.saved": "Enregistré. {n} compagnons seront créés au démarrage du serveur.",
|
||||||
|
|
||||||
// Client
|
// Client
|
||||||
|
"client.races.install": "Installer le patch des races personnalisées",
|
||||||
"client.title": "Client du jeu",
|
"client.title": "Client du jeu",
|
||||||
"client.looking": "Recherche…",
|
"client.looking": "Recherche…",
|
||||||
"client.intro": "Indiquez au Manager où le jeu est installé pour obtenir un bouton JOUER. Vos fichiers de jeu ne sont jamais modifiés, sauf l’adresse du serveur et l’addon des compagnons.",
|
"client.intro": "Indiquez au Manager où le jeu est installé pour obtenir un bouton JOUER. Vos fichiers de jeu ne sont jamais modifiés, sauf l’adresse du serveur et l’addon des compagnons.",
|
||||||
@@ -495,7 +496,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"ustep.Updating the database": "Mise à jour de la base de données",
|
"ustep.Updating the database": "Mise à jour de la base de données",
|
||||||
"ustep.Starting the updated server": "Démarrage du serveur mis à jour",
|
"ustep.Starting the updated server": "Démarrage du serveur mis à jour",
|
||||||
"ustep.Finishing": "Finalisation",
|
"ustep.Finishing": "Finalisation",
|
||||||
"ustep.Undoing the update": "Annulation de la mise à jour",
|
"ustep.Undoing the update": "Annulation de la mise à jour (la restauration des bases de données peut prendre plusieurs minutes)",
|
||||||
"ustep.Done": "Terminé",
|
"ustep.Done": "Terminé",
|
||||||
|
|
||||||
// Companion sizes
|
// Companion sizes
|
||||||
@@ -827,6 +828,36 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"set.searchAll": "Rechercher dans tous les réglages par nom ou description…",
|
"set.searchAll": "Rechercher dans tous les réglages par nom ou description…",
|
||||||
"set.search": "Rechercher un réglage…",
|
"set.search": "Rechercher un réglage…",
|
||||||
"upd.current": "Vous êtes à jour (version {v}).",
|
"upd.current": "Vous êtes à jour (version {v}).",
|
||||||
|
"nav.dashboard": "Tableau de bord",
|
||||||
|
"q.dashboard": "Que font les bots en ce moment ?",
|
||||||
|
"dash.title": "Tableau de bord des bots",
|
||||||
|
"dash.intro": "La page en direct de SQUID sur les bots : où ils sont, ce qu’ils font, ce qu’ils trouvent. Elle ne tourne que sur cet ordinateur.",
|
||||||
|
"dash.notInstalled": "Le tableau de bord n’est pas encore installé.",
|
||||||
|
"dash.willInstall": "La version qui correspond à vos bots {v} sera téléchargée.",
|
||||||
|
"dash.noSquid": "La version de vos bots SQUID n’a pas pu être lue.",
|
||||||
|
"dash.install": "Télécharger le tableau de bord",
|
||||||
|
"dash.versions": "Tableau de bord {dash} pour les bots {bots}",
|
||||||
|
"dash.running": "en cours",
|
||||||
|
"dash.stopped": "arrêté",
|
||||||
|
"dash.mismatch": "Ce tableau de bord ne correspond pas à vos bots {bots}. Mettez-le à jour pour que les versions concordent.",
|
||||||
|
"dash.start": "Démarrer le tableau de bord",
|
||||||
|
"dash.stop": "Arrêter le tableau de bord",
|
||||||
|
"dash.openBrowser": "Ouvrir dans le navigateur",
|
||||||
|
"dash.update": "Mettre à jour le tableau de bord",
|
||||||
|
"upd.startAfter": "Démarrer le serveur après la mise à jour (sinon un serveur arrêté reste arrêté)",
|
||||||
|
"client.startAfter": "Lancer le jeu après la mise à jour du client",
|
||||||
|
"bk.folder": "Dossier des sauvegardes",
|
||||||
|
"bk.folderDefault": "par défaut",
|
||||||
|
"bk.folderNote": "Les nouvelles sauvegardes sont enregistrées ici, par exemple sur un autre disque. Les précédentes restent où elles sont et figurent toujours dans la liste. Le dossier doit se trouver hors du dossier du serveur.",
|
||||||
|
"bk.folderChange": "Changer de dossier…",
|
||||||
|
"bk.folderReset": "Utiliser le dossier par défaut",
|
||||||
|
"bk.folderChanged": "Dossier des sauvegardes modifié.",
|
||||||
|
"remove.title": "Retirer ce serveur du Manager",
|
||||||
|
"remove.text": "Le Manager n’affiche plus ce serveur. Aucun fichier, base de données ni sauvegarde n’est supprimé, et vous pourrez rajouter le dossier plus tard avec « Gérer un autre serveur ».",
|
||||||
|
"remove.button": "Retirer du Manager",
|
||||||
|
"remove.stopFirst": "Arrêtez d’abord le serveur.",
|
||||||
|
"remove.confirm": "Retirer ce serveur du Manager ?\n\n{path}\n\nAucun fichier n’est supprimé.",
|
||||||
|
"upd.dbUnchecked": "La base de données n'a pas pu être vérifiée ; les modifications en attente sont donc inconnues : {why}",
|
||||||
"client.job.checking": "Vérification du client…",
|
"client.job.checking": "Vérification du client…",
|
||||||
"client.job.updating": "Mise à jour du client",
|
"client.job.updating": "Mise à jour du client",
|
||||||
"fr.lan.address": "Adresse réseau",
|
"fr.lan.address": "Adresse réseau",
|
||||||
@@ -837,6 +868,21 @@ const fr: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"fr.lan.unavailable": "Adresse sélectionnée indisponible",
|
"fr.lan.unavailable": "Adresse sélectionnée indisponible",
|
||||||
"fr.lan.unavailableText": "Cette adresse n’est actuellement attribuée à aucune interface locale détectée. Choisissez une autre adresse ou le mode Automatique, ou conservez volontairement cette adresse.",
|
"fr.lan.unavailableText": "Cette adresse n’est actuellement attribuée à aucune interface locale détectée. Choisissez une autre adresse ou le mode Automatique, ou conservez volontairement cette adresse.",
|
||||||
"fr.lan.invalid": "Adresse IPv4 non valide",
|
"fr.lan.invalid": "Adresse IPv4 non valide",
|
||||||
|
"unsaved.title": "Modifications non enregistrées",
|
||||||
|
"unsaved.message": "Vous avez des modifications non enregistrées. Voulez-vous les enregistrer avant de quitter cette page ?",
|
||||||
|
"unsaved.saveFailed": "Échec de l’enregistrement. Veuillez vérifier les champs.",
|
||||||
|
"crash.autoRestart": "Redémarrage automatique en cas de plantage",
|
||||||
|
"crash.autoRestartDesc": "Redémarre automatiquement le serveur s’il plante ou s’arrête de manière inattendue.",
|
||||||
|
"crash.badge": "Plantages : {n}",
|
||||||
|
"crash.historyTitle": "Historique des plantages du serveur",
|
||||||
|
"crash.noCrashes": "Aucun rapport de plantage trouvé.",
|
||||||
|
"crash.restartNotice": "Le serveur a planté et a été redémarré automatiquement (Plantage #{n}).",
|
||||||
|
"crash.loopPaused": "Redémarrage automatique suspendu : le serveur a planté plusieurs fois successivement.",
|
||||||
|
"crash.details": "Détails du plantage",
|
||||||
|
"crash.viewRaw": "Afficher le rapport complet",
|
||||||
|
"crash.hideRaw": "Masquer le rapport complet",
|
||||||
|
"crash.copyReport": "Copier le rapport",
|
||||||
|
"crash.copied": "Copié !",
|
||||||
};
|
};
|
||||||
|
|
||||||
export default fr;
|
export default fr;
|
||||||
+52
-4
@@ -34,6 +34,8 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"repair.result": "Восстановлено файлов: {files}. Применено обновлений БД: {sql}.",
|
"repair.result": "Восстановлено файлов: {files}. Применено обновлений БД: {sql}.",
|
||||||
"repair.backup": "Резервная копия: {id}",
|
"repair.backup": "Резервная копия: {id}",
|
||||||
"repair.fileCount": "Изменённых или отсутствующих файлов: {n}",
|
"repair.fileCount": "Изменённых или отсутствующих файлов: {n}",
|
||||||
|
"repair.fileMissing": "нет файла",
|
||||||
|
"repair.fileChanged": "изменён",
|
||||||
"repair.dbCount": "Проблем структуры БД/стартовых данных: {columns}. Ожидающих или неудачных SQL: {sql}.",
|
"repair.dbCount": "Проблем структуры БД/стартовых данных: {columns}. Ожидающих или неудачных SQL: {sql}.",
|
||||||
"repair.limited": "В старом пакете нет полного описания схемы. Проверяются только колонки сохранения персонажей и стартовые данные.",
|
"repair.limited": "В старом пакете нет полного описания схемы. Проверяются только колонки сохранения персонажей и стартовые данные.",
|
||||||
"repair.unresolved": "Проблемы БД остались. Repair не повторяет уже применённые SQL и не добавляет колонки наугад. Экспортируйте диагностику с этим списком для исправляющего обновления сервера.",
|
"repair.unresolved": "Проблемы БД остались. Repair не повторяет уже применённые SQL и не добавляет колонки наугад. Экспортируйте диагностику с этим списком для исправляющего обновления сервера.",
|
||||||
@@ -51,7 +53,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"nav.overview": "Обзор",
|
"nav.overview": "Обзор",
|
||||||
"nav.bots": "Боты",
|
"nav.bots": "Боты",
|
||||||
"nav.server": "Сервер",
|
"nav.server": "Сервер",
|
||||||
"nav.players": "Игроки",
|
"nav.players": "Аккаунты",
|
||||||
"nav.friends": "Игра с друзьями",
|
"nav.friends": "Игра с друзьями",
|
||||||
"nav.backups": "Резервные копии",
|
"nav.backups": "Резервные копии",
|
||||||
"nav.console": "Консоль",
|
"nav.console": "Консоль",
|
||||||
@@ -63,7 +65,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"q.overview": "Мой сервер работает?",
|
"q.overview": "Мой сервер работает?",
|
||||||
"q.bots": "Как настроены мои боты?",
|
"q.bots": "Как настроены мои боты?",
|
||||||
"q.server": "Как ведёт себя мой сервер?",
|
"q.server": "Как ведёт себя мой сервер?",
|
||||||
"q.players": "Кто сейчас играет?",
|
"q.players": "Кто может войти в игру?",
|
||||||
"q.friends": "Как подключиться другу?",
|
"q.friends": "Как подключиться другу?",
|
||||||
"q.backups": "Мои данные в безопасности?",
|
"q.backups": "Мои данные в безопасности?",
|
||||||
"q.console": "Что делает сервер?",
|
"q.console": "Что делает сервер?",
|
||||||
@@ -198,7 +200,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"install.open": "ОТКРЫТЬ МОЙ СЕРВЕР",
|
"install.open": "ОТКРЫТЬ МОЙ СЕРВЕР",
|
||||||
|
|
||||||
// Players
|
// Players
|
||||||
"players.title": "Игроки",
|
"players.title": "Аккаунты",
|
||||||
"players.createTitle": "Создайте свою учётную запись",
|
"players.createTitle": "Создайте свою учётную запись",
|
||||||
"players.createText": "Это имя и пароль, с которыми вы входите в игру.",
|
"players.createText": "Это имя и пароль, с которыми вы входите в игру.",
|
||||||
"players.startFirst": "Сначала запустите сервер — учётные записи создаются, пока он работает.",
|
"players.startFirst": "Сначала запустите сервер — учётные записи создаются, пока он работает.",
|
||||||
@@ -226,6 +228,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"comp.saved": "Сохранено. Компаньоны ({n}) будут созданы при запуске сервера.",
|
"comp.saved": "Сохранено. Компаньоны ({n}) будут созданы при запуске сервера.",
|
||||||
|
|
||||||
// Client
|
// Client
|
||||||
|
"client.races.install": "Установить патч кастомных рас",
|
||||||
"client.title": "Клиент игры",
|
"client.title": "Клиент игры",
|
||||||
"client.looking": "Ищу…",
|
"client.looking": "Ищу…",
|
||||||
"client.intro": "Укажите, где установлена игра, чтобы появилась кнопка «Играть». Файлы игры не изменяются, кроме адреса сервера и аддона компаньонов.",
|
"client.intro": "Укажите, где установлена игра, чтобы появилась кнопка «Играть». Файлы игры не изменяются, кроме адреса сервера и аддона компаньонов.",
|
||||||
@@ -526,7 +529,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"ustep.Updating the database": "Обновление базы данных",
|
"ustep.Updating the database": "Обновление базы данных",
|
||||||
"ustep.Starting the updated server": "Запуск обновлённого сервера",
|
"ustep.Starting the updated server": "Запуск обновлённого сервера",
|
||||||
"ustep.Finishing": "Завершение",
|
"ustep.Finishing": "Завершение",
|
||||||
"ustep.Undoing the update": "Откат обновления",
|
"ustep.Undoing the update": "Отмена обновления (восстановление баз данных может занять несколько минут)",
|
||||||
"ustep.Done": "Готово",
|
"ustep.Done": "Готово",
|
||||||
|
|
||||||
// Companion sizes
|
// Companion sizes
|
||||||
@@ -846,6 +849,36 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"set.searchAll": "Поиск по всем настройкам: название или описание…",
|
"set.searchAll": "Поиск по всем настройкам: название или описание…",
|
||||||
"set.search": "Поиск по настройкам…",
|
"set.search": "Поиск по настройкам…",
|
||||||
"upd.current": "У вас последняя версия ({v}).",
|
"upd.current": "У вас последняя версия ({v}).",
|
||||||
|
"nav.dashboard": "Панель",
|
||||||
|
"q.dashboard": "Что сейчас делают боты?",
|
||||||
|
"dash.title": "Панель ботов",
|
||||||
|
"dash.intro": "Страница SQUID о ботах в реальном времени: где они, что делают, что находят. Работает только на этом компьютере.",
|
||||||
|
"dash.notInstalled": "Панель ещё не установлена.",
|
||||||
|
"dash.willInstall": "Будет скачан выпуск, подходящий к вашим ботам {v}.",
|
||||||
|
"dash.noSquid": "Не удалось определить версию ботов SQUID.",
|
||||||
|
"dash.install": "Скачать панель",
|
||||||
|
"dash.versions": "Панель {dash} для ботов {bots}",
|
||||||
|
"dash.running": "работает",
|
||||||
|
"dash.stopped": "остановлена",
|
||||||
|
"dash.mismatch": "Эта панель не соответствует вашим ботам {bots}. Обновите её, чтобы версии совпадали.",
|
||||||
|
"dash.start": "Запустить панель",
|
||||||
|
"dash.stop": "Остановить панель",
|
||||||
|
"dash.openBrowser": "Открыть в браузере",
|
||||||
|
"dash.update": "Обновить панель",
|
||||||
|
"upd.startAfter": "Запускать сервер после обновления (иначе выключенный сервер останется выключенным)",
|
||||||
|
"client.startAfter": "Запускать игру после обновления клиента",
|
||||||
|
"bk.folder": "Папка резервных копий",
|
||||||
|
"bk.folderDefault": "по умолчанию",
|
||||||
|
"bk.folderNote": "Новые копии сохраняются сюда, например на другой диск. Прежние копии остаются на месте и по-прежнему в списке. Папка должна быть вне папки сервера.",
|
||||||
|
"bk.folderChange": "Выбрать папку…",
|
||||||
|
"bk.folderReset": "Папка по умолчанию",
|
||||||
|
"bk.folderChanged": "Папка резервных копий изменена.",
|
||||||
|
"remove.title": "Убрать сервер из Manager",
|
||||||
|
"remove.text": "Manager перестанет показывать этот сервер. Файлы, базы данных и резервные копии не удаляются, папку можно добавить снова через «Управлять другим сервером».",
|
||||||
|
"remove.button": "Убрать из Manager",
|
||||||
|
"remove.stopFirst": "Сначала остановите сервер.",
|
||||||
|
"remove.confirm": "Убрать этот сервер из Manager?\n\n{path}\n\nФайлы не удаляются.",
|
||||||
|
"upd.dbUnchecked": "Не удалось проверить базу данных, поэтому неизвестно, нужны ли ей изменения: {why}",
|
||||||
"client.job.checking": "Проверка клиента…",
|
"client.job.checking": "Проверка клиента…",
|
||||||
"client.job.updating": "Обновление клиента",
|
"client.job.updating": "Обновление клиента",
|
||||||
"fr.lan.address": "Сетевой адрес",
|
"fr.lan.address": "Сетевой адрес",
|
||||||
@@ -856,6 +889,21 @@ const ru: Partial<Record<keyof typeof en, string>> = {
|
|||||||
"fr.lan.unavailable": "Выбранный адрес недоступен",
|
"fr.lan.unavailable": "Выбранный адрес недоступен",
|
||||||
"fr.lan.unavailableText": "Выбранный адрес сейчас не назначен обнаруженному сетевому интерфейсу. Выберите другой адрес, переключитесь на автоматический выбор или намеренно сохраните этот адрес.",
|
"fr.lan.unavailableText": "Выбранный адрес сейчас не назначен обнаруженному сетевому интерфейсу. Выберите другой адрес, переключитесь на автоматический выбор или намеренно сохраните этот адрес.",
|
||||||
"fr.lan.invalid": "Некорректный IPv4-адрес",
|
"fr.lan.invalid": "Некорректный IPv4-адрес",
|
||||||
|
"unsaved.title": "Несохранённые изменения",
|
||||||
|
"unsaved.message": "У вас есть несохранённые изменения. Сохранить их перед переходом на другую страницу?",
|
||||||
|
"unsaved.saveFailed": "Не удалось сохранить настройки. Проверьте правильность значений.",
|
||||||
|
"crash.autoRestart": "Автоподнятие при падении",
|
||||||
|
"crash.autoRestartDesc": "Автоматически перезапускать сервер при внезапном падении или сбое.",
|
||||||
|
"crash.badge": "Крашей: {n}",
|
||||||
|
"crash.historyTitle": "История падений сервера",
|
||||||
|
"crash.noCrashes": "Отчётов о падениях не найдено.",
|
||||||
|
"crash.restartNotice": "Сервер упал и был автоматически перезапущен (Сбой #{n}).",
|
||||||
|
"crash.loopPaused": "Автоподнятие приостановлено: сервер упал несколько раз подряд за короткое время.",
|
||||||
|
"crash.details": "Подробности сбоя",
|
||||||
|
"crash.viewRaw": "Показать полный отчёт",
|
||||||
|
"crash.hideRaw": "Скрыть полный отчёт",
|
||||||
|
"crash.copyReport": "Скопировать отчёт",
|
||||||
|
"crash.copied": "Скопировано!",
|
||||||
};
|
};
|
||||||
|
|
||||||
export default ru;
|
export default ru;
|
||||||
+50
-4
@@ -32,7 +32,7 @@ const zh = {
|
|||||||
"nav.overview": "概览",
|
"nav.overview": "概览",
|
||||||
"nav.bots": "机器人",
|
"nav.bots": "机器人",
|
||||||
"nav.server": "服务器",
|
"nav.server": "服务器",
|
||||||
"nav.players": "玩家",
|
"nav.players": "账号",
|
||||||
"nav.friends": "好友联机",
|
"nav.friends": "好友联机",
|
||||||
"nav.backups": "备份",
|
"nav.backups": "备份",
|
||||||
"nav.console": "控制台",
|
"nav.console": "控制台",
|
||||||
@@ -44,7 +44,7 @@ const zh = {
|
|||||||
"q.overview": "服务器当前是否正在运行?",
|
"q.overview": "服务器当前是否正在运行?",
|
||||||
"q.bots": "机器人目前是如何配置的?",
|
"q.bots": "机器人目前是如何配置的?",
|
||||||
"q.server": "服务器机制与规则是如何运行的?",
|
"q.server": "服务器机制与规则是如何运行的?",
|
||||||
"q.players": "当前有哪些玩家在线?",
|
"q.players": "谁可以登录游戏?",
|
||||||
"q.friends": "好友如何加入我的服务器?",
|
"q.friends": "好友如何加入我的服务器?",
|
||||||
"q.backups": "我的数据是否安全?",
|
"q.backups": "我的数据是否安全?",
|
||||||
"q.console": "服务器正在输出什么日志?",
|
"q.console": "服务器正在输出什么日志?",
|
||||||
@@ -179,7 +179,7 @@ const zh = {
|
|||||||
"install.open": "打开我的服务器",
|
"install.open": "打开我的服务器",
|
||||||
|
|
||||||
// Players
|
// Players
|
||||||
"players.title": "玩家",
|
"players.title": "账号",
|
||||||
"players.createTitle": "创建游戏账号",
|
"players.createTitle": "创建游戏账号",
|
||||||
"players.createText": "用于登录游戏的账号名称和密码。",
|
"players.createText": "用于登录游戏的账号名称和密码。",
|
||||||
"players.startFirst": "请先启动服务器 —— 账号需要在服务器运行时创建。",
|
"players.startFirst": "请先启动服务器 —— 账号需要在服务器运行时创建。",
|
||||||
@@ -207,6 +207,7 @@ const zh = {
|
|||||||
"comp.saved": "已保存。{n} 名随从将在服务器启动时创建。",
|
"comp.saved": "已保存。{n} 名随从将在服务器启动时创建。",
|
||||||
|
|
||||||
// Client
|
// Client
|
||||||
|
"client.races.install": "安装自定义种族补丁",
|
||||||
"client.title": "游戏客户端",
|
"client.title": "游戏客户端",
|
||||||
"client.looking": "正在寻找…",
|
"client.looking": "正在寻找…",
|
||||||
"client.intro": "指定游戏客户端安装路径即可启用“开始游戏”按钮。除服务器地址和随从插件外,你的游戏文件绝不会被修改。",
|
"client.intro": "指定游戏客户端安装路径即可启用“开始游戏”按钮。除服务器地址和随从插件外,你的游戏文件绝不会被修改。",
|
||||||
@@ -507,7 +508,7 @@ const zh = {
|
|||||||
"ustep.Updating the database": "正在更新数据库结构",
|
"ustep.Updating the database": "正在更新数据库结构",
|
||||||
"ustep.Starting the updated server": "正在启动更新后的服务器",
|
"ustep.Starting the updated server": "正在启动更新后的服务器",
|
||||||
"ustep.Finishing": "正在收尾完成",
|
"ustep.Finishing": "正在收尾完成",
|
||||||
"ustep.Undoing the update": "正在撤销更新并回滚",
|
"ustep.Undoing the update": "正在撤销更新(恢复数据库可能需要几分钟)",
|
||||||
"ustep.Done": "已完成",
|
"ustep.Done": "已完成",
|
||||||
|
|
||||||
// Companion sizes
|
// Companion sizes
|
||||||
@@ -827,6 +828,36 @@ const zh = {
|
|||||||
"set.searchAll": "按名称或描述搜索全部设置…",
|
"set.searchAll": "按名称或描述搜索全部设置…",
|
||||||
"set.search": "搜索设置…",
|
"set.search": "搜索设置…",
|
||||||
"upd.current": "当前已是最新版本 ({v})。",
|
"upd.current": "当前已是最新版本 ({v})。",
|
||||||
|
"nav.dashboard": "仪表盘",
|
||||||
|
"q.dashboard": "机器人现在在做什么?",
|
||||||
|
"dash.title": "机器人仪表盘",
|
||||||
|
"dash.intro": "SQUID 的机器人实时页面:它们在哪里、在做什么、发现了什么。仅在本机运行。",
|
||||||
|
"dash.notInstalled": "尚未安装仪表盘。",
|
||||||
|
"dash.willInstall": "将下载与你的机器人 {v} 对应的版本。",
|
||||||
|
"dash.noSquid": "无法读取你的 SQUID 机器人版本。",
|
||||||
|
"dash.install": "下载仪表盘",
|
||||||
|
"dash.versions": "适用于机器人 {bots} 的仪表盘 {dash}",
|
||||||
|
"dash.running": "运行中",
|
||||||
|
"dash.stopped": "已停止",
|
||||||
|
"dash.mismatch": "此仪表盘与你的机器人 {bots} 不匹配。请更新使版本一致。",
|
||||||
|
"dash.start": "启动仪表盘",
|
||||||
|
"dash.stop": "停止仪表盘",
|
||||||
|
"dash.openBrowser": "在浏览器中打开",
|
||||||
|
"dash.update": "更新仪表盘",
|
||||||
|
"upd.startAfter": "更新后启动服务器(否则已停止的服务器保持停止)",
|
||||||
|
"client.startAfter": "更新客户端后启动游戏",
|
||||||
|
"bk.folder": "备份文件夹",
|
||||||
|
"bk.folderDefault": "默认",
|
||||||
|
"bk.folderNote": "新备份将保存在这里,例如另一个驱动器上。之前的备份保留在原处,仍会列出。该文件夹必须位于服务器文件夹之外。",
|
||||||
|
"bk.folderChange": "更改文件夹…",
|
||||||
|
"bk.folderReset": "使用默认文件夹",
|
||||||
|
"bk.folderChanged": "备份文件夹已更改。",
|
||||||
|
"remove.title": "从 Manager 中移除此服务器",
|
||||||
|
"remove.text": "Manager 将不再列出此服务器。不会删除任何文件、数据库或备份,之后可通过“管理其他服务器”重新添加该文件夹。",
|
||||||
|
"remove.button": "从 Manager 中移除",
|
||||||
|
"remove.stopFirst": "请先停止服务器。",
|
||||||
|
"remove.confirm": "要从 Manager 中移除此服务器吗?\n\n{path}\n\n不会删除任何文件。",
|
||||||
|
"upd.dbUnchecked": "无法检查数据库,因此不清楚是否有待应用的数据库更改:{why}",
|
||||||
"client.job.checking": "正在检查游戏客户端…",
|
"client.job.checking": "正在检查游戏客户端…",
|
||||||
"client.job.updating": "正在更新游戏客户端",
|
"client.job.updating": "正在更新游戏客户端",
|
||||||
"err.docker_unavailable.title": "Docker 不可用",
|
"err.docker_unavailable.title": "Docker 不可用",
|
||||||
@@ -839,6 +870,21 @@ const zh = {
|
|||||||
"fr.lan.unavailable": "所选地址不可用",
|
"fr.lan.unavailable": "所选地址不可用",
|
||||||
"fr.lan.unavailableText": "所选地址目前未分配给检测到的本地网络接口。请选择其他地址、切换到自动,或有意保留此地址。",
|
"fr.lan.unavailableText": "所选地址目前未分配给检测到的本地网络接口。请选择其他地址、切换到自动,或有意保留此地址。",
|
||||||
"fr.lan.invalid": "无效的 IPv4 地址",
|
"fr.lan.invalid": "无效的 IPv4 地址",
|
||||||
|
"unsaved.title": "未保存的修改",
|
||||||
|
"unsaved.message": "您有未保存的修改。是否在离开前保存?",
|
||||||
|
"unsaved.saveFailed": "保存失败,请检查填写内容。",
|
||||||
|
"crash.autoRestart": "崩溃后自动重启",
|
||||||
|
"crash.autoRestartDesc": "如果服务器意外崩溃或停止,自动重新拉起。",
|
||||||
|
"crash.badge": "崩溃次数: {n}",
|
||||||
|
"crash.historyTitle": "服务器崩溃记录",
|
||||||
|
"crash.noCrashes": "未找到崩溃日志。",
|
||||||
|
"crash.restartNotice": "服务器崩溃并已自动重新拉起(崩溃 #{n})。",
|
||||||
|
"crash.loopPaused": "自动重启已暂停:服务器在短时间内连续崩溃。",
|
||||||
|
"crash.details": "崩溃详情",
|
||||||
|
"crash.viewRaw": "查看完整日志",
|
||||||
|
"crash.hideRaw": "隐藏完整日志",
|
||||||
|
"crash.copyReport": "复制崩溃报告",
|
||||||
|
"crash.copied": "已复制!",
|
||||||
} as const;
|
} as const;
|
||||||
|
|
||||||
export default zh;
|
export default zh;
|
||||||
@@ -525,7 +525,7 @@
|
|||||||
},
|
},
|
||||||
"AlwaysMaxSkillForLevel": {
|
"AlwaysMaxSkillForLevel": {
|
||||||
"t": "Fertigkeiten immer auf Maximum der Stufe",
|
"t": "Fertigkeiten immer auf Maximum der Stufe",
|
||||||
"d": "Waffen- und andere Fertigkeiten sind immer auf dem Maximum der Charakterstufe, Training ist nicht nötig."
|
"d": "Waffen- und andere Fertigkeiten sind immer auf dem Maximum der Charakterstufe, Training ist nicht nötig. Der Wildcard-Realm schaltet dies für sich immer ein."
|
||||||
},
|
},
|
||||||
"ActivateWeather": {
|
"ActivateWeather": {
|
||||||
"t": "Wetter",
|
"t": "Wetter",
|
||||||
|
|||||||
@@ -525,7 +525,7 @@
|
|||||||
},
|
},
|
||||||
"AlwaysMaxSkillForLevel": {
|
"AlwaysMaxSkillForLevel": {
|
||||||
"t": "Habilidades siempre al máximo del nivel",
|
"t": "Habilidades siempre al máximo del nivel",
|
||||||
"d": "Las habilidades de armas y otras están siempre al máximo para el nivel del personaje, sin entrenar."
|
"d": "Las habilidades de armas y otras están siempre al máximo para el nivel del personaje, sin entrenar. El reino Wildcard lo activa siempre para sí mismo."
|
||||||
},
|
},
|
||||||
"ActivateWeather": {
|
"ActivateWeather": {
|
||||||
"t": "Clima",
|
"t": "Clima",
|
||||||
|
|||||||
@@ -525,7 +525,7 @@
|
|||||||
},
|
},
|
||||||
"AlwaysMaxSkillForLevel": {
|
"AlwaysMaxSkillForLevel": {
|
||||||
"t": "Compétences toujours au maximum du niveau",
|
"t": "Compétences toujours au maximum du niveau",
|
||||||
"d": "Les compétences d'armes et autres sont toujours au maximum du niveau du personnage, sans entraînement."
|
"d": "Les compétences d'armes et autres sont toujours au maximum du niveau du personnage, sans entraînement. Le royaume Wildcard l’active toujours pour lui-même."
|
||||||
},
|
},
|
||||||
"ActivateWeather": {
|
"ActivateWeather": {
|
||||||
"t": "Météo",
|
"t": "Météo",
|
||||||
|
|||||||
@@ -525,7 +525,7 @@
|
|||||||
},
|
},
|
||||||
"AlwaysMaxSkillForLevel": {
|
"AlwaysMaxSkillForLevel": {
|
||||||
"t": "Навыки всегда на максимуме для уровня",
|
"t": "Навыки всегда на максимуме для уровня",
|
||||||
"d": "Навыки оружия и другие навыки всегда на максимуме для уровня персонажа, учиться не нужно."
|
"d": "Навыки оружия и другие навыки всегда на максимуме для уровня персонажа, учиться не нужно. Реалм Wildcard всегда включает это для себя."
|
||||||
},
|
},
|
||||||
"ActivateWeather": {
|
"ActivateWeather": {
|
||||||
"t": "Погода",
|
"t": "Погода",
|
||||||
|
|||||||
@@ -525,7 +525,7 @@
|
|||||||
},
|
},
|
||||||
"AlwaysMaxSkillForLevel": {
|
"AlwaysMaxSkillForLevel": {
|
||||||
"t": "武器技能自动升满",
|
"t": "武器技能自动升满",
|
||||||
"d": "武器及其他熟练度技能自动保持在当前角色等级上限,无需反复练习。"
|
"d": "武器及其他熟练度技能自动保持在当前角色等级上限,无需反复练习。 Wildcard 领域会始终为自己开启此项。"
|
||||||
},
|
},
|
||||||
"ActivateWeather": {
|
"ActivateWeather": {
|
||||||
"t": "天气系统",
|
"t": "天气系统",
|
||||||
|
|||||||
+82
-4
@@ -78,6 +78,22 @@ export interface DriverOutcome {
|
|||||||
output: string;
|
output: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface DashboardStatus {
|
||||||
|
installed: boolean;
|
||||||
|
tag: string | null;
|
||||||
|
squid_tag: string | null;
|
||||||
|
matches: boolean;
|
||||||
|
running: boolean;
|
||||||
|
port: number;
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface BackupLocation {
|
||||||
|
path: string;
|
||||||
|
default_path: string;
|
||||||
|
is_default: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
export interface ServerSummary {
|
export interface ServerSummary {
|
||||||
id: string;
|
id: string;
|
||||||
name: string;
|
name: string;
|
||||||
@@ -170,6 +186,7 @@ export interface RecoveryPoint {
|
|||||||
label: string | null;
|
label: string | null;
|
||||||
created_at: string;
|
created_at: string;
|
||||||
components: { name: string; path: string; bytes: number; tables: number | null; files: string[] | null }[];
|
components: { name: string; path: string; bytes: number; tables: number | null; files: string[] | null }[];
|
||||||
|
mysql_snapshot?: { bytes: number } | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface DbRestore {
|
export interface DbRestore {
|
||||||
@@ -217,7 +234,7 @@ export interface ModuleSetting {
|
|||||||
value: string;
|
value: string;
|
||||||
default: string | null;
|
default: string | null;
|
||||||
doc: string;
|
doc: string;
|
||||||
field?: { key: string; type: string; title: string; description: string; group: string; group_title?: string | null; min?: number | null; max?: number | null } | null;
|
field?: { key: string; type: string; title: string; description: string; group: string; group_title?: string | null; min?: number | null; max?: number | null; choices?: { value: string | number | boolean; label: string }[] | null } | null;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface AllSetting {
|
export interface AllSetting {
|
||||||
@@ -249,6 +266,16 @@ export interface ReportTarget {
|
|||||||
ours: boolean;
|
ours: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/** The kind of server this computer installs: a repack (Windows) or Docker containers (Linux). */
|
||||||
|
export type Flavor = "repack" | "docker";
|
||||||
|
|
||||||
|
export interface InstallEnvironment {
|
||||||
|
flavor: Flavor;
|
||||||
|
default_dir: string;
|
||||||
|
/** Why Docker cannot be used, in its own words; null when it works. */
|
||||||
|
docker_problem: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
export interface InstallRequirements {
|
export interface InstallRequirements {
|
||||||
download_bytes: number;
|
download_bytes: number;
|
||||||
unpacked_bytes: number;
|
unpacked_bytes: number;
|
||||||
@@ -285,6 +312,10 @@ export interface UpdatePreview {
|
|||||||
migrations: number;
|
migrations: number;
|
||||||
pending_migrations?: number;
|
pending_migrations?: number;
|
||||||
download_bytes: number;
|
download_bytes: number;
|
||||||
|
/** False when pending database changes were not counted (stopped server during a background check, or an error). */
|
||||||
|
database_checked?: boolean;
|
||||||
|
/** Set when the database could not be inspected; the file comparison is still valid. */
|
||||||
|
database_check_error?: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface UpdateTxn {
|
export interface UpdateTxn {
|
||||||
@@ -359,6 +390,23 @@ export interface ClientDownloadCheck {
|
|||||||
dest: string;
|
dest: string;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export type ClientPatchState = "not-installed" | "enabled" | "disabled" | "partially-installed";
|
||||||
|
|
||||||
|
export interface CustomRacesClientStatus {
|
||||||
|
version: string | null;
|
||||||
|
state: ClientPatchState;
|
||||||
|
installedMpqs: number;
|
||||||
|
totalMpqs: number;
|
||||||
|
hasRootFiles: boolean;
|
||||||
|
clientPath: string | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CustomRacesProgress {
|
||||||
|
id: string;
|
||||||
|
step: string;
|
||||||
|
percent: number;
|
||||||
|
}
|
||||||
|
|
||||||
export type FriendsMode = "local" | "lan" | "direct" | "private";
|
export type FriendsMode = "local" | "lan" | "direct" | "private";
|
||||||
|
|
||||||
export interface LanAddress {
|
export interface LanAddress {
|
||||||
@@ -401,6 +449,21 @@ export interface ConsoleLine {
|
|||||||
level: "info" | "warn" | "error";
|
level: "info" | "warn" | "error";
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export interface CrashItem {
|
||||||
|
id: string;
|
||||||
|
timestamp_ms: number;
|
||||||
|
date_str: string;
|
||||||
|
title: string;
|
||||||
|
explanation: string;
|
||||||
|
category: "assertion" | "access_violation" | "stack_overflow" | "out_of_memory" | "database" | "network" | "exception" | "generic";
|
||||||
|
exception_code?: string | null;
|
||||||
|
location?: string | null;
|
||||||
|
function?: string | null;
|
||||||
|
condition?: string | null;
|
||||||
|
preview: string;
|
||||||
|
full_log: string;
|
||||||
|
}
|
||||||
|
|
||||||
export const api = {
|
export const api = {
|
||||||
remoteConnection: () => invoke<RemoteConnection>("remote_connection"),
|
remoteConnection: () => invoke<RemoteConnection>("remote_connection"),
|
||||||
remoteConnect: (host: string) => invoke<RemoteConnection>("remote_connect", { host }),
|
remoteConnect: (host: string) => invoke<RemoteConnection>("remote_connect", { host }),
|
||||||
@@ -421,12 +484,21 @@ export const api = {
|
|||||||
save: (id: string, scope: Scope, changes: Record<string, JsonValue>) => invoke<SaveReport>("save_settings", { id, scope, changes }),
|
save: (id: string, scope: Scope, changes: Record<string, JsonValue>) => invoke<SaveReport>("save_settings", { id, scope, changes }),
|
||||||
presets: (scope: Scope) => invoke<PresetInfo[]>("list_presets", { scope }),
|
presets: (scope: Scope) => invoke<PresetInfo[]>("list_presets", { scope }),
|
||||||
backups: (id: string) => invoke<RecoveryPoint[]>("list_backups", { id }),
|
backups: (id: string) => invoke<RecoveryPoint[]>("list_backups", { id }),
|
||||||
|
dashboardStatus: (id: string) => invoke<DashboardStatus>("dashboard_status", { id }),
|
||||||
|
dashboardInstall: (id: string) => invoke<DashboardStatus>("dashboard_install", { id }),
|
||||||
|
dashboardOpen: (id: string) => invoke<void>("dashboard_open", { id }),
|
||||||
|
dashboardStart: (id: string) => invoke<DashboardStatus>("dashboard_start", { id }),
|
||||||
|
dashboardStop: (id: string) => invoke<DashboardStatus>("dashboard_stop", { id }),
|
||||||
|
backupLocation: (id: string) => invoke<BackupLocation>("backup_location", { id }),
|
||||||
|
/** `null` goes back to the default folder next to the server. */
|
||||||
|
setBackupLocation: (id: string, path: string | null) => invoke<BackupLocation>("set_backup_location", { id, path }),
|
||||||
createBackup: (id: string, kind: BackupKind, label?: string) => invoke<RecoveryPoint>("create_backup", { id, kind, label: label ?? null }),
|
createBackup: (id: string, kind: BackupKind, label?: string) => invoke<RecoveryPoint>("create_backup", { id, kind, label: label ?? null }),
|
||||||
verifyBackup: (id: string, backupId: string) => invoke<{ ok: boolean; problems: string[] }>("verify_backup", { id, backupId }),
|
verifyBackup: (id: string, backupId: string) => invoke<{ ok: boolean; problems: string[] }>("verify_backup", { id, backupId }),
|
||||||
deleteBackup: (id: string, backupId: string) => invoke<void>("delete_backup", { id, backupId }),
|
deleteBackup: (id: string, backupId: string) => invoke<void>("delete_backup", { id, backupId }),
|
||||||
restoreConfigs: (id: string, backupId: string) => invoke<RecoveryPoint>("restore_backup_configs", { id, backupId }),
|
restoreConfigs: (id: string, backupId: string) => invoke<RecoveryPoint>("restore_backup_configs", { id, backupId }),
|
||||||
restoreDatabase: (id: string, backupId: string, database: string) => invoke<DbRestore>("restore_backup_database", { id, backupId, database }),
|
restoreDatabase: (id: string, backupId: string, database: string) => invoke<DbRestore>("restore_backup_database", { id, backupId, database }),
|
||||||
installPreflight: (dest: string, needed?: number) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null }),
|
installEnvironment: () => invoke<InstallEnvironment>("install_environment"),
|
||||||
|
installPreflight: (dest: string, needed?: number, gameData?: string) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null, gameData: gameData ?? null }),
|
||||||
installRequirements: (pkg?: string) => invoke<InstallRequirements>("install_requirements", { package: pkg ?? null }),
|
installRequirements: (pkg?: string) => invoke<InstallRequirements>("install_requirements", { package: pkg ?? null }),
|
||||||
realmlistProfiles: (id: string) => invoke<{ profiles: RealmProfile[]; active: string | null }>("realmlist_profiles", { id }),
|
realmlistProfiles: (id: string) => invoke<{ profiles: RealmProfile[]; active: string | null }>("realmlist_profiles", { id }),
|
||||||
realmlistSave: (id: string, profileId: string | null, name: string, data: string) => invoke<RealmProfile>("realmlist_save", { id, profileId, name, data }),
|
realmlistSave: (id: string, profileId: string | null, name: string, data: string) => invoke<RealmProfile>("realmlist_save", { id, profileId, name, data }),
|
||||||
@@ -445,11 +517,12 @@ export const api = {
|
|||||||
accountSetAccess: (id: string, name: string, level: number) => invoke<void>("account_set_access", { id, name, level }),
|
accountSetAccess: (id: string, name: string, level: number) => invoke<void>("account_set_access", { id, name, level }),
|
||||||
accountRename: (id: string, name: string, newName: string, password: string) => invoke<void>("account_rename", { id, name, newName, password }),
|
accountRename: (id: string, name: string, newName: string, password: string) => invoke<void>("account_rename", { id, name, newName, password }),
|
||||||
accountDelete: (id: string, name: string) => invoke<void>("account_delete", { id, name }),
|
accountDelete: (id: string, name: string) => invoke<void>("account_delete", { id, name }),
|
||||||
installNew: (dest: string, pkg?: string) => invoke<ServerSummary>("install_new", { dest, package: pkg ?? null }),
|
installNew: (dest: string, pkg?: string, gameData?: string) => invoke<ServerSummary>("install_new", { dest, package: pkg ?? null, gameData: gameData ?? null }),
|
||||||
cancelInstall: () => invoke<void>("cancel_install"),
|
cancelInstall: () => invoke<void>("cancel_install"),
|
||||||
createAccount: (id: string, username: string, password: string, administrator: boolean) =>
|
createAccount: (id: string, username: string, password: string, administrator: boolean) =>
|
||||||
invoke<void>("create_account", { id, username, password, administrator }),
|
invoke<void>("create_account", { id, username, password, administrator }),
|
||||||
checkUpdate: (id: string, source?: string) => invoke<UpdatePreview>("check_update", { id, source: source ?? null }),
|
/** `background`: the repeating check, which must not start the database of a stopped server. */
|
||||||
|
checkUpdate: (id: string, source?: string, background?: boolean) => invoke<UpdatePreview>("check_update", { id, source: source ?? null, background: background ?? false }),
|
||||||
pendingUpdate: (id: string) => invoke<UpdateTxn | null>("pending_update", { id }),
|
pendingUpdate: (id: string) => invoke<UpdateTxn | null>("pending_update", { id }),
|
||||||
applyUpdate: (id: string, resolutions: Record<string, "keep" | "replace">, source?: string) =>
|
applyUpdate: (id: string, resolutions: Record<string, "keep" | "replace">, source?: string) =>
|
||||||
invoke<{ txn: UpdateTxn }>("apply_update", { id, source: source ?? null, resolutions }),
|
invoke<{ txn: UpdateTxn }>("apply_update", { id, source: source ?? null, resolutions }),
|
||||||
@@ -474,6 +547,10 @@ export const api = {
|
|||||||
clientSync: (id: string, keepModified: boolean) => invoke<void>("client_sync", { id, keepModified }),
|
clientSync: (id: string, keepModified: boolean) => invoke<void>("client_sync", { id, keepModified }),
|
||||||
clientDownload: (id: string, parent: string) => invoke<ClientInfo>("client_download", { id, parent }),
|
clientDownload: (id: string, parent: string) => invoke<ClientInfo>("client_download", { id, parent }),
|
||||||
clientCancel: () => invoke<void>("client_cancel"),
|
clientCancel: () => invoke<void>("client_cancel"),
|
||||||
|
customRacesStatus: (id: string) => invoke<CustomRacesClientStatus | null>("custom_races_status", { id }),
|
||||||
|
customRacesUninstall: (id: string) => invoke<void>("custom_races_uninstall", { id }),
|
||||||
|
customRacesInstall: (id: string) => invoke<void>("custom_races_install", { id }),
|
||||||
|
customRacesToggleClient: (id: string, enabled: boolean) => invoke<void>("custom_races_toggle_client", { id, enabled }),
|
||||||
play: (id: string) => invoke<DriverOutcome>("play", { id }),
|
play: (id: string) => invoke<DriverOutcome>("play", { id }),
|
||||||
friendsStatus: (id: string) => invoke<FriendsStatus>("friends_status", { id }),
|
friendsStatus: (id: string) => invoke<FriendsStatus>("friends_status", { id }),
|
||||||
friendsCheckInternet: () => invoke<InternetCheck>("friends_check_internet"),
|
friendsCheckInternet: () => invoke<InternetCheck>("friends_check_internet"),
|
||||||
@@ -483,6 +560,7 @@ export const api = {
|
|||||||
runDiagnostics: (id: string) => invoke<{ checks: DiagCheck[]; problems: number }>("run_diagnostics", { id }),
|
runDiagnostics: (id: string) => invoke<{ checks: DiagCheck[]; problems: number }>("run_diagnostics", { id }),
|
||||||
verifyFiles: (id: string) => invoke<{ path: string; kind: "missing" | "changed" }[]>("verify_files", { id }),
|
verifyFiles: (id: string) => invoke<{ path: string; kind: "missing" | "changed" }[]>("verify_files", { id }),
|
||||||
exportDiagnostics: (id: string) => invoke<string>("export_diagnostics", { id }),
|
exportDiagnostics: (id: string) => invoke<string>("export_diagnostics", { id }),
|
||||||
|
listCrashes: (id: string, limit?: number) => invoke<CrashItem[]>("list_crashes", { id, limit: limit ?? null }),
|
||||||
consoleTail: (id: string, source: ConsoleSource, filter?: string, lines = 300) =>
|
consoleTail: (id: string, source: ConsoleSource, filter?: string, lines = 300) =>
|
||||||
invoke<ConsoleLine[]>("console_tail", { id, source, filter: filter ?? null, lines }),
|
invoke<ConsoleLine[]>("console_tail", { id, source, filter: filter ?? null, lines }),
|
||||||
consoleRisk: (command: string) => invoke<"normal" | "dangerous">("console_risk", { command }),
|
consoleRisk: (command: string) => invoke<"normal" | "dangerous">("console_risk", { command }),
|
||||||
|
|||||||
@@ -0,0 +1,32 @@
|
|||||||
|
import { useState } from "react";
|
||||||
|
|
||||||
|
const key = (id: string) => `coa-auto-restart-on-crash:${id}`;
|
||||||
|
const fallback = () => false;
|
||||||
|
|
||||||
|
export function autoRestartOnCrash(id: string): boolean {
|
||||||
|
try {
|
||||||
|
const value = localStorage.getItem(key(id));
|
||||||
|
return value === null ? fallback() : value === "1";
|
||||||
|
} catch {
|
||||||
|
return fallback();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function setAutoRestartOnCrash(id: string, on: boolean) {
|
||||||
|
try {
|
||||||
|
localStorage.setItem(key(id), on ? "1" : "0");
|
||||||
|
} catch {
|
||||||
|
/* storage unavailable */
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useAutoRestart(id: string): [boolean, (on: boolean) => void] {
|
||||||
|
const [on, setOn] = useState(() => autoRestartOnCrash(id));
|
||||||
|
return [
|
||||||
|
on,
|
||||||
|
(next) => {
|
||||||
|
setAutoRestartOnCrash(id, next);
|
||||||
|
setOn(next);
|
||||||
|
},
|
||||||
|
];
|
||||||
|
}
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import { startAfterUpdate } from "./updatePrefs";
|
||||||
import { useSyncExternalStore } from "react";
|
import { useSyncExternalStore } from "react";
|
||||||
import { listen } from "@tauri-apps/api/event";
|
import { listen } from "@tauri-apps/api/event";
|
||||||
import { api, asUiError, type ClientPlan, type ClientStep, type UiError } from "@/lib/api";
|
import { api, asUiError, type ClientPlan, type ClientStep, type UiError } from "@/lib/api";
|
||||||
@@ -85,6 +86,7 @@ export async function syncClient(id: string, keepModified: boolean): Promise<voi
|
|||||||
try {
|
try {
|
||||||
await api.clientSync(id, keepModified);
|
await api.clientSync(id, keepModified);
|
||||||
set(id, { phase: "done", step: null });
|
set(id, { phase: "done", step: null });
|
||||||
|
if (startAfterUpdate("client", id)) void api.play(id).catch(() => undefined);
|
||||||
void refresh(id);
|
void refresh(id);
|
||||||
setTimeout(() => {
|
setTimeout(() => {
|
||||||
if (get(id).phase === "done") set(id, { phase: "idle" });
|
if (get(id).phase === "done") set(id, { phase: "idle" });
|
||||||
|
|||||||
@@ -85,6 +85,18 @@ for (const [key, title, desc] of [
|
|||||||
] as [string, string[], string[]][]) add(`Enchanter.${key}`, "int", title, desc, { min: 0, advanced: true });
|
] as [string, string[], string[]][]) add(`Enchanter.${key}`, "int", title, desc, { min: 0, advanced: true });
|
||||||
for (let n = 1; n <= 3; n++) add(`EC.P${n}`, "string", [`NPC phrase ${n}`, `Реплика НПС ${n}`, `NPC-Satz ${n}`, `Phrase du PNJ ${n}`, `Frase del PNJ ${n}`, `NPC台词 ${n}`], ["Text spoken by the NPC. Keep the enclosing quotes.", "Текст реплики НПС. Сохраните кавычки вокруг текста.", "Gesprochener Text. Anführungszeichen beibehalten.", "Texte prononcé. Conservez les guillemets.", "Texto hablado. Conserva las comillas.", "NPC发言内容,请保留外层引号。"], { advanced: true });
|
for (let n = 1; n <= 3; n++) add(`EC.P${n}`, "string", [`NPC phrase ${n}`, `Реплика НПС ${n}`, `NPC-Satz ${n}`, `Phrase du PNJ ${n}`, `Frase del PNJ ${n}`, `NPC台词 ${n}`], ["Text spoken by the NPC. Keep the enclosing quotes.", "Текст реплики НПС. Сохраните кавычки вокруг текста.", "Gesprochener Text. Anführungszeichen beibehalten.", "Texte prononcé. Conservez les guillemets.", "Texto hablado. Conserva las comillas.", "NPC发言内容,请保留外层引号。"], { advanced: true });
|
||||||
|
|
||||||
|
add("CoACustomRaces.BotsEnable", "bool",
|
||||||
|
["Bots can be custom races", "Боты кастомных рас", "Bots benutzerdefinierter Völker", "Bots de races personnalisées", "Bots de razas personalizadas", "允许机器人为自定义种族"],
|
||||||
|
[
|
||||||
|
"Allow Playerbots to spawn as custom races (experimental). Off excludes all custom races; on allows stable custom races.",
|
||||||
|
"Разрешает ботам-игрокам появляться кастомными расами (экспериментально). Выключено — исключает все кастомные расы, включено — разрешает стабильные.",
|
||||||
|
"Erlaubt Spieler-Bots, benutzerdefinierte Völker zu nutzen (experimentell). Aus schließt alle benutzerdefinierten Völker aus; An erlaubt stabile.",
|
||||||
|
"Autorise les bots joueurs à s’incarner avec des races personnalisées (expérimental). Désactivé exclut toutes les races personnalisées ; activé autorise les stables.",
|
||||||
|
"Permite a los bots jugadores crearse con razas personalizadas (experimental). Desactivado excluye todas las razas personalizadas; activado permite las estables.",
|
||||||
|
"允许玩家机器人扮演自定义种族(实验性)。关闭将排除所有自定义种族,开启允许稳定的自定义种族。"
|
||||||
|
]
|
||||||
|
);
|
||||||
|
|
||||||
const ah = "AuctionHouseBot.";
|
const ah = "AuctionHouseBot.";
|
||||||
add(ah + "GUIDs", "string", ["Auction characters", "Персонажи аукциона", "Auktionscharaktere", "Personnages d’enchères", "Personajes de subasta", "拍卖角色"], ["Leave 0 and the server creates and uses its own auction character. To use your own, enter GUIDs separated by commas, without spaces; use dedicated offline characters, not companion bots.", "Оставьте 0, и сервер сам создаст и будет использовать своего персонажа аукциона. Чтобы использовать своих, укажите GUID через запятую без пробелов; нужны отдельные офлайн-персонажи, не боты-компаньоны.", "Bei 0 legt der Server selbst einen Auktionscharakter an und nutzt ihn. Eigene Charaktere: GUIDs durch Kommas, ohne Leerzeichen; separate Offline-Charaktere verwenden, keine Begleiter-Bots.", "Laissez 0 : le serveur crée et utilise son propre personnage d’enchères. Pour les vôtres, indiquez des GUID séparés par des virgules sans espaces ; personnages dédiés hors ligne, pas des bots compagnons.", "Deja 0 y el servidor crea y usa su propio personaje de subastas. Para usar los tuyos, indica GUID separados por comas sin espacios; personajes dedicados desconectados, no bots acompañantes.", "保持0时由服务器自动创建并使用拍卖角色。要使用自己的角色,请以逗号分隔填写GUID,不加空格;使用专用离线角色,勿用伙伴机器人。"], { advanced: true });
|
add(ah + "GUIDs", "string", ["Auction characters", "Персонажи аукциона", "Auktionscharaktere", "Personnages d’enchères", "Personajes de subasta", "拍卖角色"], ["Leave 0 and the server creates and uses its own auction character. To use your own, enter GUIDs separated by commas, without spaces; use dedicated offline characters, not companion bots.", "Оставьте 0, и сервер сам создаст и будет использовать своего персонажа аукциона. Чтобы использовать своих, укажите GUID через запятую без пробелов; нужны отдельные офлайн-персонажи, не боты-компаньоны.", "Bei 0 legt der Server selbst einen Auktionscharakter an und nutzt ihn. Eigene Charaktere: GUIDs durch Kommas, ohne Leerzeichen; separate Offline-Charaktere verwenden, keine Begleiter-Bots.", "Laissez 0 : le serveur crée et utilise son propre personnage d’enchères. Pour les vôtres, indiquez des GUID séparés par des virgules sans espaces ; personnages dédiés hors ligne, pas des bots compagnons.", "Deja 0 y el servidor crea y usa su propio personaje de subastas. Para usar los tuyos, indica GUID separados por comas sin espacios; personajes dedicados desconectados, no bots acompañantes.", "保持0时由服务器自动创建并使用拍卖角色。要使用自己的角色,请以逗号分隔填写GUID,不加空格;使用专用离线角色,勿用伙伴机器人。"], { advanced: true });
|
||||||
add(ah + "EnableSeller", "bool", ["Post auctions", "Выставлять лоты", "Auktionen einstellen", "Publier des enchères", "Publicar subastas", "发布拍卖"], ["Let the auction characters sell items. The module switch is also required.", "Разрешает персонажам продавать предметы. Нужен включённый модуль.", "Erlaubt Verkäufe. Der Modulschalter muss ebenfalls aktiv sein.", "Autorise les ventes. Le module doit aussi être activé.", "Permite vender. También requiere el módulo activado.", "允许拍卖角色出售物品,还需启用模块。"]);
|
add(ah + "EnableSeller", "bool", ["Post auctions", "Выставлять лоты", "Auktionen einstellen", "Publier des enchères", "Publicar subastas", "发布拍卖"], ["Let the auction characters sell items. The module switch is also required.", "Разрешает персонажам продавать предметы. Нужен включённый модуль.", "Erlaubt Verkäufe. Der Modulschalter muss ebenfalls aktiv sein.", "Autorise les ventes. Le module doit aussi être activé.", "Permite vender. También requiere el módulo activado.", "允许拍卖角色出售物品,还需启用模块。"]);
|
||||||
@@ -175,7 +187,11 @@ for (const [category, categoryNames] of Object.entries(auctionCategories)) {
|
|||||||
}
|
}
|
||||||
export function moduleField(key: string, locale: Locale, metadata?: ModuleSetting["field"]): ModuleField | undefined {
|
export function moduleField(key: string, locale: Locale, metadata?: ModuleSetting["field"]): ModuleField | undefined {
|
||||||
const translated = locale !== "en" ? fields.find(f => f.key === key) : undefined;
|
const translated = locale !== "en" ? fields.find(f => f.key === key) : undefined;
|
||||||
if (metadata) return { title: translated ? text(translated.title, locale) : metadata.title, description: translated ? text(translated.description, locale) : metadata.description, type: metadata.type, category: metadata.group, advanced: false, min: metadata.min ?? undefined, max: metadata.max ?? undefined };
|
if (metadata) {
|
||||||
|
// A fixed list of values is edited as a drop-down; the values stay strings, as they are written to the config.
|
||||||
|
const options = metadata.choices?.length ? metadata.choices.map(c => ({ value: String(c.value), label: c.label })) : undefined;
|
||||||
|
return { title: translated ? text(translated.title, locale) : metadata.title, description: translated ? text(translated.description, locale) : metadata.description, type: options ? "enum" : metadata.type, category: metadata.group, advanced: false, min: metadata.min ?? undefined, max: metadata.max ?? undefined, ...(options ? { options } : {}) } as ModuleField;
|
||||||
|
}
|
||||||
const field = fields.find(f => f.key === key);
|
const field = fields.find(f => f.key === key);
|
||||||
if (field) return { ...field, title: text(field.title, locale), description: text(field.description, locale), category: "general", advanced: field.advanced ?? false, step: field.type === "range" ? 0.05 : undefined, options: field.options?.map(o => ({ value: o.value, label: text(o.label, locale) })) };
|
if (field) return { ...field, title: text(field.title, locale), description: text(field.description, locale), category: "general", advanced: field.advanced ?? false, step: field.type === "range" ? 0.05 : undefined, options: field.options?.map(o => ({ value: o.value, label: text(o.label, locale) })) };
|
||||||
const existing = [...bots.settings, ...server.settings].find(s => s.key === key);
|
const existing = [...bots.settings, ...server.settings].find(s => s.key === key);
|
||||||
|
|||||||
@@ -2,6 +2,7 @@ import { useSyncExternalStore } from "react";
|
|||||||
import { listen } from "@tauri-apps/api/event";
|
import { listen } from "@tauri-apps/api/event";
|
||||||
import { api, asUiError, type UiError, type UpdatePreview, type UpdateTxn } from "@/lib/api";
|
import { api, asUiError, type UiError, type UpdatePreview, type UpdateTxn } from "@/lib/api";
|
||||||
import { isUpdateCurrent } from "./serverUpdateStatus";
|
import { isUpdateCurrent } from "./serverUpdateStatus";
|
||||||
|
import { startAfterUpdate } from "./updatePrefs";
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Server update status for the main screen and the navigation: checked when the app starts and every five minutes,
|
* Server update status for the main screen and the navigation: checked when the app starts and every five minutes,
|
||||||
@@ -34,12 +35,12 @@ function set(id: string, next: Partial<ServerUpdateState>) {
|
|||||||
listeners.forEach((l) => l());
|
listeners.forEach((l) => l());
|
||||||
}
|
}
|
||||||
|
|
||||||
export async function checkServerUpdate(id: string): Promise<void> {
|
export async function checkServerUpdate(id: string, background = false): Promise<void> {
|
||||||
const cur = get(id);
|
const cur = get(id);
|
||||||
if (cur.applying || cur.checking) return;
|
if (cur.applying || cur.checking) return;
|
||||||
set(id, { checking: true });
|
set(id, { checking: true });
|
||||||
try {
|
try {
|
||||||
const p = await api.checkUpdate(id);
|
const p = await api.checkUpdate(id, undefined, background);
|
||||||
set(id, { preview: p, available: !isUpdateCurrent(p), error: null });
|
set(id, { preview: p, available: !isUpdateCurrent(p), error: null });
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
// A cached offer is no longer safe after an update or failed recheck.
|
// A cached offer is no longer safe after an update or failed recheck.
|
||||||
@@ -51,8 +52,8 @@ export async function checkServerUpdate(id: string): Promise<void> {
|
|||||||
|
|
||||||
/** Check now and then every five minutes. Returns the function that stops it. */
|
/** Check now and then every five minutes. Returns the function that stops it. */
|
||||||
export function startServerUpdatePolling(id: string): () => void {
|
export function startServerUpdatePolling(id: string): () => void {
|
||||||
void checkServerUpdate(id);
|
void checkServerUpdate(id, true);
|
||||||
const t = setInterval(() => void checkServerUpdate(id), CHECK_EVERY_MS);
|
const t = setInterval(() => void checkServerUpdate(id, true), CHECK_EVERY_MS);
|
||||||
return () => clearInterval(t);
|
return () => clearInterval(t);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -85,6 +86,9 @@ export async function applyServerUpdate(id: string, opts?: { choices: Record<str
|
|||||||
const current = get(id);
|
const current = get(id);
|
||||||
if (current.applying || current.stateError || (current.result && "pending" in current.result)) return false;
|
if (current.applying || current.stateError || (current.result && "pending" in current.result)) return false;
|
||||||
if (!opts && (!p || p.conflicts.length > 0)) return false;
|
if (!opts && (!p || p.conflicts.length > 0)) return false;
|
||||||
|
// The update stops a running server and proves the new build by starting it; a server that was stopped stays stopped
|
||||||
|
// unless the owner asked for it to start.
|
||||||
|
const wasRunning = await api.status(id).then((s) => [s.observed.mysql, s.observed.auth, s.observed.world].some((x) => x.state === "running" || x.state === "starting")).catch(() => true);
|
||||||
set(id, { applying: true, step: null, percent: 0, error: null, uiError: null, result: null });
|
set(id, { applying: true, step: null, percent: 0, error: null, uiError: null, result: null });
|
||||||
let un: (() => void) | undefined;
|
let un: (() => void) | undefined;
|
||||||
try {
|
try {
|
||||||
@@ -95,6 +99,7 @@ export async function applyServerUpdate(id: string, opts?: { choices: Record<str
|
|||||||
try {
|
try {
|
||||||
const out = await api.applyUpdate(id, opts?.choices ?? {}, opts?.source);
|
const out = await api.applyUpdate(id, opts?.choices ?? {}, opts?.source);
|
||||||
set(id, { result: out.txn.state === "committed" ? { committed: out.txn.to_version ?? "" } : { pending: out.txn } });
|
set(id, { result: out.txn.state === "committed" ? { committed: out.txn.to_version ?? "" } : { pending: out.txn } });
|
||||||
|
if (out.txn.state === "committed" && !wasRunning && !startAfterUpdate("server", id)) await api.stop(id).catch(() => undefined);
|
||||||
return true;
|
return true;
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
const ui = asUiError(e);
|
const ui = asUiError(e);
|
||||||
|
|||||||
@@ -3,5 +3,5 @@ import type { UpdatePreview } from "./api";
|
|||||||
export function isUpdateCurrent(preview: UpdatePreview): boolean {
|
export function isUpdateCurrent(preview: UpdatePreview): boolean {
|
||||||
return preview.from_version === preview.to_version
|
return preview.from_version === preview.to_version
|
||||||
&& preview.items.every((item) => item.action === "skip")
|
&& preview.items.every((item) => item.action === "skip")
|
||||||
&& (preview.pending_migrations ?? (preview.migrations === 0 ? 0 : undefined)) === 0;
|
&& (preview.database_check_error !== undefined || preview.database_checked === false || (preview.pending_migrations ?? (preview.migrations === 0 ? 0 : undefined)) === 0);
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
export interface UnsavedChangesGuard {
|
||||||
|
isDirty: () => boolean;
|
||||||
|
save: () => Promise<boolean>;
|
||||||
|
discard: () => void;
|
||||||
|
}
|
||||||
@@ -0,0 +1,28 @@
|
|||||||
|
import { useState } from "react";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether a finished update starts things. Off by default for both: updating a stopped server leaves it stopped (a
|
||||||
|
* server that was running is started again, as the update had to stop it) and a client update does not open the game.
|
||||||
|
*/
|
||||||
|
export type AfterUpdate = "server" | "client";
|
||||||
|
|
||||||
|
const key = (kind: AfterUpdate, id: string) => `coa-start-after-${kind}-update:${id}`;
|
||||||
|
const fallback = (_kind: AfterUpdate) => false;
|
||||||
|
|
||||||
|
export function startAfterUpdate(kind: AfterUpdate, id: string): boolean {
|
||||||
|
try {
|
||||||
|
const value = localStorage.getItem(key(kind, id));
|
||||||
|
return value === null ? fallback(kind) : value === "1";
|
||||||
|
} catch {
|
||||||
|
return fallback(kind);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function setStartAfterUpdate(kind: AfterUpdate, id: string, on: boolean) {
|
||||||
|
try { localStorage.setItem(key(kind, id), on ? "1" : "0"); } catch { /* storage unavailable: the default applies */ }
|
||||||
|
}
|
||||||
|
|
||||||
|
export function useStartAfterUpdate(kind: AfterUpdate, id: string): [boolean, (on: boolean) => void] {
|
||||||
|
const [on, setOn] = useState(() => startAfterUpdate(kind, id));
|
||||||
|
return [on, (next) => { setStartAfterUpdate(kind, id, next); setOn(next); }];
|
||||||
|
}
|
||||||
Loaded 100 of 117 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user