Compare commits

...
52 Commits
Author SHA1 Message Date
Дмитрий 376f1dbb46 Fix conditional settings hooks and release Manager 0.6.11 2026-10-10 07:49:41 +05:00
Дмитрий b0951dbee7 feat(races): update verified client assets to CoA Custom 1.5 2026-10-10 06:56:44 +05:00
Дмитрий 374a3f9c23 feat(races): ship client integration in Manager 0.6.9 2026-10-10 06:35:01 +05:00
Дмитрий d20d5a6410 Merge remote-tracking branch 'origin/master' into feat/custom-races
# Conflicts:
#	src/screens/ModulesPage.tsx
2026-10-10 06:29:49 +05:00
Дмитрий 1228807eaf feat(races): integrate client patch installation and controls 2026-10-10 06:29:32 +05:00
Дмитрий ee59708fbf Prepare Manager 0.6.8 release 2026-10-10 05:51:09 +05:00
Corfirean 3ed9c5dacd Merge pull request #48 from Corfirean/feat/unsaved-guard-and-auto-restart
feat: unsaved changes navigation guard and server auto-restart with crash analyzer
2026-10-10 05:50:58 +05:00
Дмитрий 9099168927 Merge master and preserve Linux installation and crash history mocks 2026-10-10 05:47:39 +05:00
Corfirean a27e0eb6ab Merge pull request #44 from Corfirean/fix/db-error-details
Do not report an SQL error as "the database is not running"
2026-10-10 05:46:39 +05:00
Corfirean c46edd2feb Merge pull request #38 from lostmind84/feat/linux-b3b-install-screen
feat: install screen, Wine/Proton client and realm profiles for a Docker server (Linux)
2026-10-10 05:46:36 +05:00
Fabien F. f934bef303 fix: find a running Wine client under both names of a linked home folder
On SteamOS and Bazzite /home is a link to /var/home; Wine keeps the path it was
given, so the resolved one alone can miss the command line. The start order is
unchanged (database up and healthy before the realm list is updated): a comment
says so.
2026-10-08 17:30:08 +02:00
Fabien F. c882a21334 docs: changelog entry for the Linux install screen 2026-10-08 17:28:59 +02:00
Fabien F. a625b065cf feat: start the game client under umu-launcher / Wine on Linux
client::launch started Ascension.exe directly, which cannot work on Linux, and
client::is_running found nothing (it reads the Windows process list). wine.rs is
the Linux counterpart, and both hand over to it on a Linux host.

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

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

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

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

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

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

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

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

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

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 11:29:08 +05:00
Corfirean 7540527d30 Merge pull request #43 from Corfirean/release/0.6.7
Release Manager 0.6.7
2026-10-08 09:49:45 +05:00
ДмитрийandClaude Sonnet 5.5 5328709826 Release Manager 0.6.7
Version bump only. Collects: the update check no longer fails after a crash and no longer
starts MySQL in the background, the Wildcard table repair checksum error, same-version files
edited by hand are not an update, a stopped server stays stopped after an update, the layout
fixes, one card per realm, remove-server and backup-folder settings, the Accounts tab
(bot accounts hidden), a world server started from the coa-bots folder, and the new
SQUID bot Dashboard tab.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 09:41:37 +05:00
Corfirean 478ea8a960 Merge pull request #42 from Corfirean/fix/update-check-resilience
Fix the update check, add the dashboard tab and a batch of Manager fixes
2026-10-08 09:40:59 +05:00
ДмитрийandClaude Sonnet 5.5 c8a0f6872f Hide the SQUID bot accounts from the Accounts list
Accounts named with AiPlayerbot.RandomBotAccountPrefix (default rndbot) belong to the bot
system like the companions' accounts: they are not listed and cannot be renamed or deleted.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 09:33:46 +05:00
ДмитрийandClaude Sonnet 5.5 c3791f80f1 Shorten two changelog titles to the 90 character limit
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 08:58:25 +05:00
ДмитрийandClaude Sonnet 5.5 1acbcc2bb5 Fix the dashboard tab: large answers, damaged history files, browser link and realm drop-down
The dashboard now runs through a small launcher that avoids the immediate socket shutdown that
cut answers above 64 KB on Windows, supplies the missing level-builds file, removes history
files zeroed by a crash, is addressed as 127.0.0.1 and opens in the browser through its own
command. The realm drop-down is hidden while both worlds start together.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 08:33:36 +05:00
ДмитрийandClaude Sonnet 5.5 838cc07e73 Add the SQUID dashboard tab and make a stopped server stay stopped after updating
The Dashboard tab (shown with SQUID Playerbots) downloads the dashboard release of the
bots' release series, starts it on a free local port and shows it in the window. After an
update, a server that was stopped stays stopped unless the owner asked for it to start.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:33:07 +05:00
ДмитрийandClaude Sonnet 5.5 4c4f8bbb3e Accept both published versions of the Wildcard table repair
The migration manager_repair__20261005_missing_wildcard_tables was published with two
different checksums; a server that applied one refused the update carrying the other.
Both versions have the same effect, so the Manager treats them as interchangeable.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:12:51 +05:00
ДмитрийandClaude Sonnet 5.5 d85d86a3dc Recognise the coa-bots world server and explain the undo step
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:12:01 +05:00
ДмитрийandClaude Sonnet 5.5 0a050a40a2 Add start-after-update options and clarify the always-max-skills setting
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:11:08 +05:00
ДмитрийandClaude Sonnet 5.5 017b977bfa Same version is never an update; Repair lists the files that differ
An update is decided by version: files the owner edited at the same version no longer
open a keep/replace decision. Repair shows which files differ or are missing.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:09:33 +05:00
ДмитрийandClaude Sonnet 5.5 337418afe0 Add a configurable backup folder and drop-down bot settings
Backups can be stored in a chosen folder (new backups go there, older ones stay listed),
and a backups folder that is a link to another drive no longer fails the update's safety
backup check. SQUID settings that declare a fixed list of choices are edited as a drop-down
and validated against it.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:08:09 +05:00
ДмитрийandClaude Sonnet 5.5 f920ff8a59 Fix the stray window scrollbar, the Overview button overflow and show one card per realm
- The main area and the console log are now positioning contexts, so screen-reader-only
  text inside them can no longer extend the whole window (the second scrollbar in the update
  dialog and the window scroll on the Console database tab).
- The client button group on the server card wraps instead of leaving the card.
- With both worlds starting together, each realm gets its own card.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:04:29 +05:00
ДмитрийandClaude Sonnet 5.5 072a657649 Remove-server card, Accounts tab, quiet background update check, safer install cleanup
- Settings: a card removes a stopped server from the Manager (no files deleted).
- The Players tab is now Accounts in all languages.
- The five-minute background check no longer starts and stops MySQL on a stopped
  server; only an explicit check may start it.
- A failed install keeps its marker until the folder is complete, cleans up after a
  failure that happens after the move, and reports the launcher's output; install and
  update errors have a Copy button.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 07:01:20 +05:00
ДмитрийandClaude Sonnet 5.5 c6e8a34509 Make the update check survive damaged launcher state and an unavailable database
A crash during a launcher write can leave .state/*.json zero-filled, which made
every launcher start (and so the update check) fail with "Something went wrong".
Zero-filled state files are now discarded before each launcher verb, the check
degrades to a warning when the database cannot be inspected, and database start
failures carry the launcher's own output.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 06:56:03 +05:00
Fabien F. 3f98ba3add test: the release fixture database arguments are a Linux case 2026-10-07 21:01:43 +02:00
Fabien F. 7a3fefaafd feat: validate a release and export its baseline on Linux
The signed base package holds the MySQL data directory of a Windows repack. On a
Linux computer extract-schema-base now turns it into a Docker server folder whose
database container opens that directory (mysqlData in docker.json), so the release
SQL, the schema contract and export-baseline run with the Docker installation code.
Windows is unchanged: it still bootstraps the repack's own database program.
2026-10-07 13:56:00 +02:00
Corfirean fac6ce469a Merge pull request #35 from Corfirean/release/0.6.6
Release Manager 0.6.6 (version bump)
2026-10-07 10:35:07 +05:00
ДмитрийandClaude Sonnet 5.5 f22cedd963 Release Manager 0.6.6
Version bump only. Collects: one-click diagnostics and report routing, LAN
address selector, Auction House Bot card without a GUID, experimental Linux
Docker installer, and the fixes already on master since 0.6.5.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-07 10:20:40 +05:00
Corfirean 0b5f12941c Merge pull request #29 from Corfirean/feat/ahbot-auto-character
AH bot card: no character GUID needed
2026-10-07 06:53:31 +05:00
Corfirean f3fc14b55a Merge pull request #34 from Corfirean/fix/lan-address-selector
Choose and remember the LAN address friends connect to
2026-10-07 06:53:22 +05:00
Corfirean beaec7d27e Merge pull request #33 from Corfirean/feat/diagnostics-routing
One-click diagnostics and report routing to Manager, Companions and SQUID
2026-10-07 06:48:04 +05:00
ДмитрийandClaude Sonnet 5.5 8490dc9983 Let the person choose and keep the LAN address friends connect to
Sharing on the local network used to take whatever address the Manager found
first, which is often a virtual adapter. The Friends page now lists the usable
IPv4 addresses of the computer (the automatic one marked) and accepts a custom
one. The choice is kept independently of the sharing mode, so it survives
restarts and switching to other modes. A chosen address that is not available
is reported instead of silently switching to another adapter.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-07 06:44:34 +05:00
ДмитрийandClaude Sonnet 5.5 3f8abcbbe8 Merge pull request #20 from lostmind84/feat/linux-b3a-installer
feat: install a new server as a Docker installation (Linux)

Also give the installer's test helper the compatible_sha256 field that master
added to manifest::Migration after the pull request was branched.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-07 06:37:13 +05:00
ДмитрийandClaude Sonnet 5.5 b3c50a7b39 Collect all diagnostics in one click and route reports to the right project
- The diagnostic package now also holds crash reports and small crash dumps from
  Core/Crashes, Windows' own crash records for the server programs (needed for
  crashes that bypass the server's crash handler), the newest update journals,
  the bot, supervisor and updater logs, and a view of which server programs run
  and from where. The folder with the file opens after export.
- JSON files in the package keep valid JSON after secrets are removed.
- The problem report asks what the problem is about and opens the new-issue page
  of the Manager, CoA Companions or SQUID Playerbots, preselecting the bot system
  that is switched on. One button collects diagnostics and opens the report.
- Targets come from the module catalog; only their new-issue pages may be opened.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-07 06:21:11 +05:00
ДмитрийandClaude Sonnet 5.5 bbdad37e40 NPC Enchanter card: hint how to place and remove the NPC
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-06 15:40:23 +05:00
ДмитрийandClaude Sonnet 5.5 0ed4d5e268 AH bot card: shorter buyer hint
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-06 13:49:20 +05:00
ДмитрийandClaude Sonnet 5.5 b13ee55bb9 AH bot card: the buyer does not spend gold
The module never deducts money from the auction character when it bids or buys, so the hint no longer says the character needs gold.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-06 13:41:42 +05:00
ДмитрийandClaude Sonnet 5.5 51a45db8cb AH bot card: no GUID needed, the server creates its own auction character
The GUID setting moves to the advanced list and the card text and the seller hint no longer ask for a character.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-06 13:35:32 +05:00
Corfirean 3f700ee8f4 Merge pull request #28 from Corfirean/codex/release-065-coordinated
Release 0.6.5: reliable update guards and coordinated SQUID integration
2026-10-06 11:19:07 +05:00
Fabien F. f25a1d425d docs: changelog entry for the Linux installer 2026-10-05 10:10:53 +02:00
Fabien F. b5e4a38d7d feat: install a new server as a Docker installation (Linux)
docker::install is the Linux counterpart of install::install_base and shares none
of its code (the Windows installer and its folder checks are untouched). Same
order of events: signed manifest, folder / space / game data checks, verified
download, extraction into <dest>.installing, database, one rename. Docker must be
usable; a failure removes the containers, the volume and the staging folder.

The databases start from the package's own dumps, Database/baseline/<kind>.sql.zst,
in the format of the Manager's backups, taken in a state where every migration of
the package is applied. The installer imports them, records the migrations as
applied (baseline) in a few bulk statements, and creates the acore account, the
realm port and the console account. Rebuilding from the repository's SQL does not
work: pending migrations such as rev_20260903_01_live_class_baseline are guards
generated from the maintainers' live database and refuse to run on a database
built from the base scripts, whatever the order.

- coa-release export-baseline --server DIR --out DIR produces the dumps from a
  prepared server (repack or Docker).
- The game data stays where the person has it (dataDir in docker.json, mounted
  read-only), checked at install time.
- ensure_main_configs creates worldserver.conf / authserver.conf from their
  .dist templates when missing, at install and at every start, never overwriting.
- Fix (affects the backend merged in 0.6.0): the database container's health check
  is now a ping over TCP. On a new volume the image first runs a temporary server
  that answers on its socket but takes no network connection, so the container was
  healthy about four seconds (10 s against 14 s measured) before TCP worked.
- docs/ARCHITECTURE.md: D13 (installation, package contract) and D14 (how Windows
  and Linux code are kept apart).

Tested: 12 new tests (folder rules, settings, package checks, bulk ledger SQL,
failure cleanup with an in-memory docker), and real runs of the whole chain
through examples/docker_install: baseline dumps exported from a prepared
server, package signed with a throwaway key, installed in 171 s, started by the
Manager (database healthy, world ready in 8 s, auth up), console reached with the
account the installer created, 1630 migrations recorded as applied.
2026-10-05 10:03:09 +02:00
104 changed files with 5895 additions and 285 deletions

No files matched your search

Generated
+14 -3
View File
@@ -491,7 +491,7 @@ dependencies = [
[[package]]
name = "coa-core"
version = "0.6.5"
version = "0.6.11"
dependencies = [
"base64 0.22.1",
"chrono",
@@ -499,6 +499,7 @@ dependencies = [
"ed25519-dalek",
"fs4",
"hex",
"if-addrs",
"num-bigint",
"rand_core",
"reqwest 0.12.28",
@@ -519,7 +520,7 @@ dependencies = [
[[package]]
name = "coa-release"
version = "0.6.5"
version = "0.6.11"
dependencies = [
"chrono",
"coa-core",
@@ -528,7 +529,7 @@ dependencies = [
[[package]]
name = "coa-server-manager"
version = "0.6.5"
version = "0.6.11"
dependencies = [
"coa-core",
"serde",
@@ -1913,6 +1914,16 @@ dependencies = [
"icu_properties",
]
[[package]]
name = "if-addrs"
version = "0.15.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c0a05c691e1fae256cf7013d99dad472dc52d5543322761f83ec8d47eab40d2b"
dependencies = [
"libc",
"windows-sys 0.61.2",
]
[[package]]
name = "indexmap"
version = "1.9.3"
+1 -1
View File
@@ -3,7 +3,7 @@ resolver = "2"
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
[workspace.package]
version = "0.6.5"
version = "0.6.11"
edition = "2021"
license = "AGPL-3.0-only"
+29
View File
@@ -0,0 +1,29 @@
# TODO
## UI / UX
- [x] **Предупреждение о несохранённых изменениях при переходе между вкладками (Unsaved Changes Guard / Modal)**:
- Если у пользователя есть несохранённые изменения в настройках (`ModulesPage`, `SettingsPage` — сервер, боты и др.) и он переходит на другую вкладку (в боковом меню `Shell.tsx` или кнопками навигации), показывать pop-up диалог подтверждения.
- Опции в диалоге:
- **Сохранить (Save)** — сохранить внесённые изменения и перейти на выбранную страницу.
- **Сбросить (Discard)** — отменить несохранённые изменения и перейти на выбранную страницу.
- **Отмена (Cancel)** — остаться на текущей странице с сохранением введённых данных.
- *Контекст:* Предотвратит случайную потерю настроек, когда пользователь меняет параметры модуля/сервера и сразу уходит на вкладку Overview для запуска сервера (см. [Issue #45](https://github.com/Corfirean/coa-server-manager/issues/45)).
## Сервер и стабильность
- [x] **Автоподнятие сервера при падении (Auto-restart on crash) со счётчиком и расшифровкой крашей**:
- **Настройка:** Чекбокс «Автоматически перезапускать сервер при падении» в настройках сервера / менеджера.
- **Поведение автоподнятия:**
- Перезапускать процесс сервера только если падение произошло внезапно (процесс завершился с ненулевым exit code, крашем или без команды от менеджера).
- Если пользователь нажал кнопку «Стоп» (Stop Server), сервер останавливается полностью, автоподнятие не срабатывает.
- Защита от бесконечного цикла крашей (Crash Loop Protection): если за короткий интервал (например, 2-3 минуты) сервер падает более 3-5 раз, автоподнятие временно прекращается, а в UI выводится критическое оповещение.
- **Счётчик падений в интерфейсе:**
- Рядом со статусом сервера (или в шапке/панели состояния) показывать бейдж со счётчиком крашей с момента старта (например: `Крашей: 2`).
- При клике на счётчик открывать окно / модалку со списком последних падений с точным временем.
- **Расшифровка причин краша (Crash Explanation Engine):**
- *Как парсить и определять причину:*
1. Читать свежий текстовый файл из `Core/Crashes/<hash>_worldserver.exe_[date].txt`.
2. Смотреть `Exception code` (например, `C0000005` — нарушение доступа к памяти/access violation, `C0000420` — сработавший assert ядра, `C00000FD` — переполнение стека, `E06D7363` — исключение C++ / std::bad_alloc).
3. При `C0000420` парсить блок `ASSERTION FAILED` (`Location`, `Function`, `Condition`).
4. Анализировать последние строки `Core/Logs/Server.log` и `Errors.log` на критические маркеры (потеря соединения с MySQL, нехватка RAM/OOM, ошибка бинда портов).
5. Проверять по встроенному словарю известных сигнатур (паттерны частых крашей с понятным описанием, например: «Сбой удаления объекта из сетки карты», «Ошибка запроса к базе данных», «Нехватка оперативной памяти»).
- *Fallback:* Если сигнатура не опознана в словаре известных проблем, показывать краткую техническую выжимку (код исключения + сработавший ассерт или вершина Call Stack) и кнопку разворота полного текста крашлога / копирования.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Install a server from a package on Linux, running in Docker (experimental)
---
Experimental. The Manager creates the database, imports the packaged baseline and starts the server in Docker containers. It needs a Linux server package and your own game data folder.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Linux: install from the install screen, play with Wine or Proton (experimental)
---
Experimental. The install screen offers Docker installs on Linux, realm profiles and the Play button work on a Docker server, and updates are not offered for it.
@@ -0,0 +1,8 @@
---
area: manager
type: changed
audience: admins
title: The Auction House Bot card no longer asks for a character GUID
---
Turning the module and the seller on is enough: a server build with the automatic auction character creates its own account and character. The GUID field moved to the advanced settings.
The buyer option hint no longer says it spends the auction character's gold.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Choose and remember the local network address friends use to connect
---
Select an adapter or custom IPv4 address when sharing on LAN. Your choice survives restarts and mode changes; unavailable addresses show a warning instead of silently switching adapters.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: The NPC Enchanter card explains how to place and remove the NPC
---
The card now shows the two commands: `.npc add 601015` where you stand, and `.npc delete` on the targeted NPC.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Diagnostic files with database checks stay readable after secrets are removed
---
Removing a line that mentioned a secret could break the JSON files in a diagnostic package. Secret values are now replaced instead, so the files stay valid.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: One button collects all diagnostics, including crashes and Windows crash records
---
Report a problem collects logs, crash reports and small dumps, Windows crash records, update journals and the running server programs in one file, then shows its folder. Crashes without a server crash report are no longer missing.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Problem reports go to the right project
---
Choose what the problem is about: Manager and other modules, CoA Companions, or SQUID Playerbots. The report opens in that project's GitHub page with the versions filled in. The bot system that is switched on is preselected.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Choose where backups are stored, for example on another drive
---
Backups can now live in any folder outside the server folder. Existing backups stay listed. A backups folder that you moved and linked from the old place also works again for updates.
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: Bot settings with a fixed list of values show a drop-down
---
SQUID bots 1.9 describes the chat language as a list of languages. The Manager shows it as a drop-down with names instead of a bare number.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: The bot dashboard loads completely and can be opened in the browser
---
The dashboard no longer fails on large pages, starts again after a crash left its history files empty, and its Open in the browser button works. With both realms started together the realm drop-down is hidden.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: A failing database update is no longer reported as "database not running"
---
An SQL error whose message contained the number 2003, such as an out-of-range value, was shown as "The database is not running". The real error is now shown.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Accounts of the SQUID bots are hidden from the Accounts list
---
The RNDBOT accounts that hold the random bots no longer fill the Accounts tab, and they cannot be renamed or deleted from there.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: A Dashboard tab shows what the SQUID bots are doing
---
With SQUID Playerbots on, the Dashboard tab downloads the dashboard release that matches your bots, starts it on this computer and shows it inside the Manager.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: A stopped server stays stopped after an update, unless you ask it to start
---
Updating no longer leaves a server running that was stopped before. Settings has a switch to start it afterwards, and the client card has one to open the game after a client update.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Checking for updates no longer fails with "Something went wrong" after a crash
---
A crash or power loss could leave a damaged status file that made every database start fail. The Manager now removes such files itself, still compares the files when the database is unavailable, and shows the real reason.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates no longer stop with "has a different checksum" on the Wildcard repair
---
Servers that applied one of the two published versions of the Wildcard table repair can now update to the other. Nothing in the database changes.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: A world server started from the coa-bots folder is recognised
---
The Manager no longer reports a port conflict when the world server runs from the coa-bots folder inside the server folder, and a failed update now says that undoing it can take several minutes.
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: Custom race client patches update to the latest races and appearances
---
The module card offers an upgrade for older patches. Archive downloads are verified before installation.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Custom races can be enabled and their client patches installed from Modules
---
Install the custom race client assets from the module card, then enable the module and restart the server.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: 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.
+1
View File
@@ -25,6 +25,7 @@ zip = { version = "2", default-features = false, features = ["deflate"] }
sha1 = "0.10"
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "std"] }
tempfile = "3"
if-addrs = "0.15"
[dev-dependencies]
rand_core = { version = "0.6", features = ["getrandom"] }
@@ -0,0 +1,21 @@
//! Install a new Docker server from a package folder, for a manual end-to-end check on Linux (needs docker).
//! usage: docker_install <package folder> <destination> <game data folder> <public key (base64)>
//! The key is the one the package was signed with (the production key is only used by the Manager itself).
use coa_core::docker::install::{install, Params};
use coa_core::download::Cancel;
use coa_core::install::Source;
use coa_core::registry::Registry;
use std::path::PathBuf;
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
assert!(a.len() == 4, "usage: docker_install <package folder> <destination> <game data folder> <public key>");
let registry = Registry::at(std::env::temp_dir().join("coa-docker-install/installs.json"));
let t = std::time::Instant::now();
let done = install(
&Params { source: Source::Dir(PathBuf::from(&a[0])), dest: PathBuf::from(&a[1]), data_dir: PathBuf::from(&a[2]), trusted_key: &a[3], registry: &registry, cancel: Cancel::default() },
&|s| eprintln!(" {:>3}% {} {}", s.percent, s.step, s.detail.unwrap_or_default()),
)
.unwrap_or_else(|e| panic!("install failed: {e}"));
println!("installed {} at {} in {:?}", done.version, done.path, t.elapsed());
}
+31 -5
View File
@@ -27,7 +27,18 @@ const LIST_SQL: &str = "SELECT a.id, a.username, \
a.online, IFNULL(a.last_login, ''), \
(SELECT COUNT(*) FROM acore_characters.characters c WHERE c.account = a.id) \
FROM acore_auth.account a \
WHERE a.username NOT LIKE 'COABOTHOST%' AND a.username <> 'COAMANAGER' ORDER BY a.id;";
WHERE a.username NOT LIKE 'COABOTHOST%' AND a.username <> 'COAMANAGER' AND a.username NOT LIKE '{SQUID}%' ORDER BY a.id;";
/// The accounts of SQUID's random bots share a name prefix (`AiPlayerbot.RandomBotAccountPrefix`, default `rndbot`).
/// They belong to the bot system like the companions' accounts and are never listed or touched here.
pub fn squid_bot_prefix(root: &Path) -> String {
std::fs::read(root.join("Core/configs/modules/playerbots.conf"))
.ok()
.and_then(|bytes| crate::config::parser::ConfFile::parse_bytes(&bytes).ok())
.and_then(|conf| conf.get("AiPlayerbot.RandomBotAccountPrefix").map(|v| crate::config::parser::unquote(v).to_string()))
.filter(|prefix| !prefix.is_empty() && prefix.len() <= 32 && prefix.chars().all(|c| c.is_ascii_alphanumeric()))
.unwrap_or_else(|| "rndbot".into())
}
/// Rows of tab-separated columns as the `mysql` client prints them.
pub fn parse_list(out: &str) -> Vec<AccountInfo> {
@@ -51,7 +62,7 @@ pub fn parse_list(out: &str) -> Vec<AccountInfo> {
pub fn list(root: &Path) -> Result<Vec<AccountInfo>> {
let db = Db::from_repack(root, Account::Admin)?;
Ok(parse_list(&db.query(LIST_SQL)?))
Ok(parse_list(&db.query(&LIST_SQL.replace("{SQUID}", &squid_bot_prefix(root).to_ascii_uppercase()))?))
}
fn upper(name: &str) -> Result<String> {
@@ -64,6 +75,9 @@ fn upper(name: &str) -> Result<String> {
pub fn rename(root: &Path, ra: &mut Ra, old: &str, new: &str, password: &str) -> Result<()> {
let (old, new) = (upper(old)?, upper(new)?);
validate_account(&new, password)?;
if is_reserved(&old) || old.starts_with(&squid_bot_prefix(root).to_ascii_uppercase()) {
return Err(Error::Invalid("This account belongs to the Manager or the bots and cannot be renamed.".into()));
}
if old == new {
return Err(Error::Invalid("That is already the name of this account.".into()));
}
@@ -93,8 +107,8 @@ fn is_reserved(upper_name: &str) -> bool {
/// companions' own accounts, an account that is not there and one that is logged in right now.
pub fn delete(root: &Path, ra: &mut Ra, name: &str) -> Result<()> {
let name = upper(name)?;
if is_reserved(&name) {
return Err(Error::Invalid("This account belongs to the Manager or the companions and cannot be deleted.".into()));
if is_reserved(&name) || name.starts_with(&squid_bot_prefix(root).to_ascii_uppercase()) {
return Err(Error::Invalid("This account belongs to the Manager or the bots and cannot be deleted.".into()));
}
let db = Db::from_repack(root, Account::Admin)?;
match db.query(&format!("SELECT online FROM acore_auth.account WHERE username = '{name}';"))?.trim() {
@@ -125,7 +139,19 @@ mod tests {
#[test]
fn the_internal_accounts_are_filtered_out_by_the_query() {
assert!(LIST_SQL.contains("COABOTHOST%") && LIST_SQL.contains("COAMANAGER"));
assert!(LIST_SQL.contains("COABOTHOST%") && LIST_SQL.contains("COAMANAGER") && LIST_SQL.contains("{SQUID}%"));
}
#[test]
fn the_squid_bot_prefix_comes_from_the_bot_settings_and_defaults_to_rndbot() {
let root = tempfile::tempdir().unwrap();
assert_eq!(squid_bot_prefix(root.path()), "rndbot");
let conf = root.path().join("Core/configs/modules/playerbots.conf");
std::fs::create_dir_all(conf.parent().unwrap()).unwrap();
std::fs::write(&conf, "AiPlayerbot.RandomBotAccountPrefix = \"MyBots\"\n").unwrap();
assert_eq!(squid_bot_prefix(root.path()), "MyBots");
std::fs::write(&conf, "AiPlayerbot.RandomBotAccountPrefix = \"x' OR 1=1 --\"\n").unwrap();
assert_eq!(squid_bot_prefix(root.path()), "rndbot", "an unsafe prefix is ignored");
}
#[test]
+128 -6
View File
@@ -69,10 +69,82 @@ pub struct RecoveryPoint {
pub realm: crate::realms::Mode,
}
fn backups_dir(meta: &Path) -> PathBuf {
const LOCATION_FILE: &str = "backup-location.json";
#[derive(Serialize, Deserialize)]
struct StoredLocation {
path: String,
}
fn default_dir(meta: &Path) -> PathBuf {
meta.join("backups")
}
/// The folder the owner chose for backups (for example on another drive), if any.
fn custom_dir(meta: &Path) -> Option<PathBuf> {
let stored: StoredLocation = fsx::read_json(&meta.join(LOCATION_FILE)).ok()?;
let path = PathBuf::from(stored.path.trim());
path.is_absolute().then_some(path)
}
/// Where new backups go.
fn backups_dir(meta: &Path) -> PathBuf {
custom_dir(meta).unwrap_or_else(|| default_dir(meta))
}
/// Every folder that may hold backups: the chosen one first, then the default one, so backups made before the
/// folder was changed stay visible and restorable.
fn backup_roots(meta: &Path) -> Vec<PathBuf> {
let mut roots: Vec<PathBuf> = custom_dir(meta).into_iter().collect();
let default = default_dir(meta);
if !roots.contains(&default) { roots.push(default); }
roots
}
#[derive(Debug, Serialize)]
pub struct BackupLocation {
pub path: String,
pub default_path: String,
pub is_default: bool,
}
pub fn location(meta: &Path) -> BackupLocation {
let default = default_dir(meta);
let current = backups_dir(meta);
BackupLocation { is_default: current == default, path: current.to_string_lossy().into_owned(), default_path: default.to_string_lossy().into_owned() }
}
/// Choose where new backups are stored (`None` = the default folder next to the server). Existing backups stay where
/// they are and remain listed.
pub fn set_location(root: &Path, meta: &Path, path: Option<&str>) -> Result<BackupLocation> {
let _lock = crate::update::operation_lock(meta)?;
crate::update::ensure_recovered(meta)?;
match path.map(str::trim).filter(|p| !p.is_empty()) {
None => {
let file = meta.join(LOCATION_FILE);
if file.exists() { fs::remove_file(file)?; }
}
Some(chosen) => {
let dir = PathBuf::from(chosen);
if !dir.is_absolute() { return Err(Error::Invalid("Choose a full folder path, for example D:\\CoA backups.".into())); }
if fsx::ensure_within(root, &dir).is_ok() {
return Err(Error::Invalid("Backups cannot be stored inside the server folder: they would be part of what is being backed up.".into()));
}
fs::create_dir_all(&dir).map_err(|e| Error::Invalid(format!("The folder cannot be created: {e}")))?;
let probe = dir.join(format!(".coa-write-test-{}", uuid::Uuid::new_v4().simple()));
fs::write(&probe, b"x").map_err(|e| Error::Invalid(format!("The folder is not writable: {e}")))?;
let _ = fs::remove_file(&probe);
fsx::atomic_write_json(&meta.join(LOCATION_FILE), &StoredLocation { path: dir.to_string_lossy().into_owned() })?;
}
}
Ok(location(meta))
}
/// The `backup.json` of a recovery point, wherever its folder is.
pub(crate) fn point_json(meta: &Path, id: &str) -> Result<PathBuf> {
Ok(point_dir(meta, id)?.join("backup.json"))
}
fn id_ok(id: &str) -> bool {
!id.is_empty() && id.len() < 100 && id.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')) && !id.contains("..")
}
@@ -81,19 +153,32 @@ fn point_dir(meta: &Path, id: &str) -> Result<PathBuf> {
if !id_ok(id) {
return Err(Error::PathRejected(format!("bad backup id {id:?}")));
}
if let Some(found) = backup_roots(meta).into_iter().map(|root| root.join(id)).find(|dir| dir.is_dir()) {
return Ok(found);
}
Ok(backups_dir(meta).join(id))
}
pub fn list(meta: &Path) -> Vec<RecoveryPoint> {
let mut out: Vec<RecoveryPoint> = fs::read_dir(backups_dir(meta))
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| fsx::read_json(&e.path().join("backup.json")).ok()).collect())
.unwrap_or_default();
let mut out: Vec<RecoveryPoint> = Vec::new();
for root in backup_roots(meta) {
let found: Vec<RecoveryPoint> = fs::read_dir(&root)
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| fsx::read_json(&e.path().join("backup.json")).ok()).collect())
.unwrap_or_default();
for point in found {
if !out.iter().any(|p| p.id == point.id) { out.push(point); }
}
}
out.sort_by(|a, b| b.id.cmp(&a.id));
out
}
pub fn get(meta: &Path, id: &str) -> Result<RecoveryPoint> {
let point: RecoveryPoint = fsx::read_json(&fsx::ensure_within(meta, &point_dir(meta, id)?.join("backup.json"))?).map_err(|_| Error::Invalid(format!("backup {id} was not found or its metadata is damaged")))?;
let dir = point_dir(meta, id)?;
// The folder holding the backups may itself be a junction or symlink to another drive (the owner moved it there);
// what must hold is that the recovery point stays inside that folder.
let holder = dir.parent().ok_or_else(|| Error::PathRejected(format!("bad backup folder for {id}")))?;
let point: RecoveryPoint = fsx::read_json(&fsx::ensure_within(holder, &dir.join("backup.json"))?).map_err(|_| Error::Invalid(format!("backup {id} was not found or its metadata is damaged")))?;
if point.id != id || point.schema != 1 { return Err(Error::Invalid(format!("Backup {id} has inconsistent identity or an unsupported schema."))); }
Ok(point)
}
@@ -163,7 +248,8 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
if !mysql_was_up {
let out = driver::run(root, Verb::StartMysql)?;
if !out.ok {
return Err(Error::Invalid(out.human.map(|h| h.title.to_string()).unwrap_or_else(|| "The database could not be started.".into())));
// Keep the launcher's own last lines: the title alone ("Something went wrong") hides the cause.
return Err(Error::Invalid(format!("The database could not be started. {}", driver::startup_failure(root, &out))));
}
}
let result = f(&db);
@@ -176,6 +262,14 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
result
}
/// Run `f` only if the database is already up; `None` (and nothing started) otherwise.
pub fn with_running_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result<Option<T>> {
let db = Db::from_repack(root, Account::Admin)?;
let observed = process::observe(root, &read_ports(root));
if observed.mysql.state != ServiceState::Running || !db.ping() { return Ok(None); }
f(&db).map(Some)
}
fn wanted_databases(kind: Kind) -> &'static [&'static str] {
match kind {
Kind::Quick | Kind::Database => &["characters", "auth"],
@@ -490,6 +584,34 @@ mod tests {
assert!(list(&meta).len() >= 2);
}
#[test]
fn backups_can_live_in_a_chosen_folder_and_old_ones_stay_visible() {
let (d, root, meta) = setup();
let before = create(&root, &meta, Kind::Config, Trigger::Manual, Some("default folder".into()), &|_| {}).unwrap();
assert!(location(&meta).is_default);
// inside the server folder is refused, a relative path is refused
assert!(set_location(&root, &meta, Some(root.join("backups").to_str().unwrap())).is_err());
assert!(set_location(&root, &meta, Some("backups")).is_err());
let elsewhere = d.path().join("other drive").join("CoA backups");
let loc = set_location(&root, &meta, Some(elsewhere.to_str().unwrap())).unwrap();
assert!(!loc.is_default && elsewhere.is_dir());
let after = create(&root, &meta, Kind::Config, Trigger::Manual, Some("chosen folder".into()), &|_| {}).unwrap();
assert!(elsewhere.join(&after.id).join("backup.json").is_file(), "new backups go to the chosen folder");
assert!(!default_dir(&meta).join(&after.id).exists());
let ids: Vec<_> = list(&meta).into_iter().map(|p| p.id).collect();
assert!(ids.contains(&before.id) && ids.contains(&after.id), "the old backup is still listed");
assert!(verify(&meta, &before.id).unwrap().ok && verify(&meta, &after.id).unwrap().ok);
assert_eq!(point_json(&meta, &after.id).unwrap(), elsewhere.join(&after.id).join("backup.json"));
restore_configs(&root, &meta, &after.id).unwrap();
delete(&meta, &after.id).unwrap();
assert!(!elsewhere.join(&after.id).exists());
assert!(set_location(&root, &meta, None).unwrap().is_default);
assert!(list(&meta).iter().any(|p| p.id == before.id));
}
#[test]
fn verify_detects_tampering_and_restore_refuses_damaged_backup() {
let (_d, root, meta) = setup();
+6
View File
@@ -17,6 +17,9 @@ pub const ADDON_NAME: &str = "CoABotUI";
const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"];
pub fn is_running(client: &Path) -> bool {
if crate::platform::flavor() == crate::platform::Flavor::Docker {
return crate::wine::is_running(client, &EXECUTABLES);
}
EXECUTABLES.iter().any(|exe| {
let path = client.join(exe);
let path = dunce::canonicalize(&path).unwrap_or(path);
@@ -307,6 +310,9 @@ pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> {
/// Start the game client. The caller is responsible for making sure the server is ready first.
pub fn launch(client: &Path) -> Result<u32> {
let exe = find_exe(client).ok_or_else(|| Error::Invalid("The game client was not found.".into()))?;
if crate::platform::flavor() == crate::platform::Flavor::Docker {
return crate::wine::launch(client, exe);
}
let child = Command::new(client.join(exe)).current_dir(client).spawn()?;
Ok(child.id())
}
+249
View File
@@ -0,0 +1,249 @@
//! Crash log discovery and human-friendly explanation for worldserver crashes.
use std::fs;
use std::path::{Path, PathBuf};
use std::time::SystemTime;
use serde::{Deserialize, Serialize};
use crate::error::Result;
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct CrashItem {
pub id: String,
pub timestamp_ms: u64,
pub date_str: String,
pub title: String,
pub explanation: String,
pub category: String,
pub exception_code: Option<String>,
pub location: Option<String>,
pub function: Option<String>,
pub condition: Option<String>,
pub preview: String,
pub full_log: String,
}
/// Lists recent crash reports from `Core/Crashes`, sorted newest first.
pub fn list(root: &Path, limit: usize) -> Result<Vec<CrashItem>> {
let dir = root.join("Core/Crashes");
let mut files: Vec<(PathBuf, SystemTime)> = Vec::new();
if let Ok(entries) = fs::read_dir(&dir) {
for entry in entries.flatten() {
let path = entry.path();
if path.is_file() && path.extension().and_then(|e| e.to_str()) == Some("txt") {
let mtime = entry.metadata().and_then(|m| m.modified()).unwrap_or(SystemTime::UNIX_EPOCH);
files.push((path, mtime));
}
}
}
files.sort_by_key(|(_, t)| std::cmp::Reverse(*t));
files.truncate(limit.max(1));
let mut items = Vec::new();
for (path, mtime) in files {
if let Ok(content) = fs::read_to_string(&path) {
let item = parse_crash_content(&path, mtime, &content);
items.push(item);
}
}
Ok(items)
}
/// Parses crash report content and generates human-friendly titles and explanations.
pub fn parse_crash_content(path: &Path, mtime: SystemTime, content: &str) -> CrashItem {
let filename = path.file_name().unwrap_or_default().to_string_lossy().into_owned();
let timestamp_ms = mtime.duration_since(SystemTime::UNIX_EPOCH).map(|d| d.as_millis() as u64).unwrap_or(0);
let mut date_str = String::new();
let mut exception_code = None;
let mut location = None;
let mut function = None;
let mut condition = None;
let lines: Vec<&str> = content.lines().collect();
let mut in_assertion = false;
for line in &lines {
let trimmed = line.trim();
if trimmed.starts_with("Date ") && date_str.is_empty() {
date_str = trimmed.to_string();
} else if trimmed.starts_with("Exception code:") {
let parts: Vec<&str> = trimmed.split_whitespace().collect();
if parts.len() >= 3 {
exception_code = Some(parts[2].to_string());
}
} else if trimmed.contains(">> ASSERTION FAILED") {
in_assertion = true;
} else if in_assertion {
if trimmed.starts_with("# Location:") {
let loc = trimmed.trim_start_matches("# Location:").trim();
let clean = loc.rsplit(['\\', '/']).take(2).collect::<Vec<_>>();
location = Some(if clean.len() == 2 { format!("{}/{}", clean[1], clean[0]) } else { loc.to_string() });
} else if trimmed.starts_with("# Function:") {
function = Some(trimmed.trim_start_matches("# Function:").trim().to_string());
} else if trimmed.starts_with("# Condition:") {
condition = Some(trimmed.trim_start_matches("# Condition:").trim().to_string());
} else if trimmed.starts_with("#---") && condition.is_some() {
in_assertion = false;
}
}
}
if date_str.is_empty() {
if let Some(pos) = filename.find("_[") {
if let Some(end) = filename[pos..].find(']') {
date_str = filename[pos + 2..pos + end].replace('_', " ");
}
}
}
let (category, title, explanation) = explain(exception_code.as_deref(), function.as_deref(), condition.as_deref(), content);
let preview_lines: Vec<&str> = lines.iter().take(25).copied().collect();
let preview = preview_lines.join("\n");
CrashItem {
id: filename,
timestamp_ms,
date_str,
title,
explanation,
category,
exception_code,
location,
function,
condition,
preview,
full_log: content.to_string(),
}
}
fn explain(code: Option<&str>, func: Option<&str>, cond: Option<&str>, full: &str) -> (String, String, String) {
let lower_full = full.to_lowercase();
let lower_func = func.map(|f| f.to_lowercase()).unwrap_or_default();
let lower_cond = cond.map(|c| c.to_lowercase()).unwrap_or_default();
if let Some(c) = code {
if c.eq_ignore_ascii_case("C0000420") {
if lower_func.contains("removefromgrid") || lower_cond.contains("isingrid") {
return (
"assertion".into(),
"Сбой удаления сущности из сетки карты (Grid / Despawn)".into(),
"Сервер попытался выгрузить объект (игрока, NPC или бота), который уже не находился в сетке карты. Обычно происходит при резком разрыве соединения, телепортации или одновременном деспавне нескольких сущностей.".into(),
);
}
if lower_func.contains("map::") || lower_func.contains("grid::") {
return (
"assertion".into(),
"Ошибка обновления сетки игрового мира (Map Grid)".into(),
"Сбой при загрузке или обновлении клеток локации (Grid/Cell). Может быть вызван перемещением сущностей через границы чанков.".into(),
);
}
if lower_func.contains("playerbot") || lower_func.contains("aiplayerbot") {
return (
"assertion".into(),
"Ошибка в модуле ботов (Playerbots)".into(),
"Внутренний сбой в логике ИИ ботов (экипировка, заклинание или поиск пути).".into(),
);
}
let cond_label = cond.unwrap_or("Assert condition failed");
return (
"assertion".into(),
format!("Сработала внутренняя проверка ядра ({cond_label})"),
format!("Сервер обнаружил нарушение целостности данных в функции {}. Выполнение было аварийно остановлено.", func.unwrap_or("неизвестно")),
);
} else if c.eq_ignore_ascii_case("C0000005") {
return (
"access_violation".into(),
"Нарушение доступа к памяти (Access Violation)".into(),
"Попытка чтения или записи по некорректному адресу памяти (разыменование null-указателя или освобождённого объекта).".into(),
);
} else if c.eq_ignore_ascii_case("C00000FD") {
return (
"stack_overflow".into(),
"Переполнение стека (Stack Overflow)".into(),
"Исчерпание стека вызовов, вызванное бесконечной рекурсией или слишком глубоким стеком вызовов функций.".into(),
);
} else if c.eq_ignore_ascii_case("E06D7363") {
if lower_full.contains("bad_alloc") {
return (
"out_of_memory".into(),
"Нехватка оперативной памяти (Out of Memory)".into(),
"Серверу не удалось выделить оперативную память (std::bad_alloc). Проверьте объем доступной RAM.".into(),
);
}
return (
"exception".into(),
"Необработанное исключение C++ (C++ Exception)".into(),
"Произошло критическое исключение C++, которое не было перехвачено ядром сервера.".into(),
);
}
}
if lower_full.contains("mysql server has gone away") || lower_full.contains("connection lost") {
return (
"database".into(),
"Потеряна связь с базой данных (MySQL)".into(),
"Связь сервера с СУБД MySQL была прервана или служба базы данных упала.".into(),
);
}
if lower_full.contains("address already in use") || lower_full.contains("bind failed") {
return (
"network".into(),
"Сетевой порт уже занят".into(),
"Порт мира, авторизации или базы данных уже занят другим приложением.".into(),
);
}
(
"generic".into(),
"Непредвиденный сбой процесса сервера".into(),
"Процесс worldserver аварийно завершился. Детали и стек вызовов доступны в полном тексте отчёта.".into(),
)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn parses_assertion_report() {
let report = r#"Revision: AzerothCore rev. df5bcdf26092 2026-10-02 22:08:42 +0500 (coa-bots branch) (Win64, RelWithDebInfo, Static)
Date 3:10:2026. Time 20:20
//=====================================================
Exception code: C0000420 Ein Assertionsfehler ist aufgetreten.
Assertion message: #----------------------------------------------------------------------#
>> ASSERTION FAILED
# Location: D:\a\coa-server-build\src\server\game\Entities\Object\Object.h:376
# Function: GridObject<class Player>::RemoveFromGrid
# Condition: IsInGrid()
#----------------------------------------------------------------------#
Fault address: 00007FF7ECD3645E
"#;
let item = parse_crash_content(Path::new("dummy_worldserver.exe_[3-10_20-20-51].txt"), SystemTime::UNIX_EPOCH, report);
println!("ITEM: {item:#?}");
assert_eq!(item.exception_code.as_deref(), Some("C0000420"));
assert_eq!(item.category, "assertion");
assert_eq!(item.condition.as_deref(), Some("IsInGrid()"));
assert_eq!(item.function.as_deref(), Some("GridObject<class Player>::RemoveFromGrid"));
assert!(item.title.contains("Grid"));
assert!(item.explanation.contains("сетке карты"));
}
#[test]
fn parses_access_violation() {
let report = r#"Date 4:10:2026. Time 12:00
Exception code: C0000005 ACCESS_VIOLATION
Fault address: 00007FF7ECD3645E
"#;
let item = parse_crash_content(Path::new("crash.txt"), SystemTime::UNIX_EPOCH, report);
assert_eq!(item.exception_code.as_deref(), Some("C0000005"));
assert_eq!(item.category, "access_violation");
assert!(item.title.contains("Access Violation"));
}
}
+541
View File
@@ -0,0 +1,541 @@
//! 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",
];
#[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 installed_mpqs: usize,
pub total_mpqs: usize,
pub has_root_files: bool,
pub client_path: Option<String>,
}
/// Inspect the client folder and determine the state of custom races patches.
pub fn client_patch_status(client_path: &Path) -> ClientPatchStatus {
let data_dir = client_path.join("Data");
let mut enabled_count = 0;
let mut disabled_count = 0;
for mpq in RACE_MPQS {
if data_dir.join(format!("{mpq}.disabled")).is_file() {
disabled_count += 1;
} else if data_dir.join(mpq).is_file() {
enabled_count += 1;
}
}
let has_root = client_path.join("EsteriaAppearance.dll").is_file()
|| client_path.join("dinput8.dll").is_file()
|| client_path.join("dinput8.dll.disabled").is_file();
let total = RACE_MPQS.len();
let current_version = fs::read_to_string(client_path.join(MANIFEST_FILENAME)).ok()
.is_some_and(|manifest| manifest.lines().any(|line| line == format!("# CoA Custom {CLIENT_VERSION}")));
let state = if enabled_count == total && current_version && client_path.join("dinput8.dll").is_file() {
ClientPatchState::Enabled
} else if disabled_count == total && current_version && client_path.join("dinput8.dll.disabled").is_file() {
ClientPatchState::Disabled
} else if (enabled_count + disabled_count) > 0 {
ClientPatchState::PartiallyInstalled
} else {
ClientPatchState::NotInstalled
};
ClientPatchStatus {
state,
installed_mpqs: enabled_count + disabled_count,
total_mpqs: total,
has_root_files: has_root,
client_path: Some(client_path.to_string_lossy().into_owned()),
}
}
/// Enable or disable client patches by renaming MPQs and `dinput8.dll` with `.disabled`.
pub fn set_client_patch_enabled(client_path: &Path, enabled: bool) -> Result<()> {
if !client_path.is_dir() {
return Err(Error::Invalid("Game client directory not found.".into()));
}
if crate::client::is_running(client_path) {
return Err(Error::Invalid("Close the game before changing custom races patches.".into()));
}
if !client_path.join(MANIFEST_FILENAME).is_file()
&& !RACE_MPQS.iter().skip(1).any(|name| client_path.join("Data").join(name).is_file()
|| client_path.join("Data").join(format!("{name}.disabled")).is_file()) {
return Ok(());
}
let mut paths: Vec<PathBuf> = RACE_MPQS.iter().map(|name| client_path.join("Data").join(name)).collect();
if let Ok(manifest) = fs::read_to_string(client_path.join(MANIFEST_FILENAME)) {
for line in manifest.lines() {
if let Some(name) = line.strip_prefix("MPQ:") {
if name.contains(['/', '\\']) || !name.to_ascii_lowercase().ends_with(".mpq") {
return Err(Error::Invalid("Invalid custom races patch manifest.".into()));
}
paths.push(fsx::safe_join(&client_path.join("Data"), name)?);
}
}
}
paths.sort();
paths.dedup();
paths.push(client_path.join("dinput8.dll"));
paths.push(client_path.join("Ascension.exe"));
for active in paths {
let disabled = active.with_extension(format!("{}.disabled", active.extension().unwrap_or_default().to_string_lossy()));
let original = active.with_extension(format!("{}.original", active.extension().unwrap_or_default().to_string_lossy()));
if enabled && disabled.is_file() {
if active.is_file() {
if !original.is_file() {
return Err(Error::Invalid(format!("Cannot replace existing {} without an original backup.", active.display())));
}
fs::remove_file(&active)?;
}
fs::rename(&disabled, &active)?;
} else if !enabled && active.is_file() && !disabled.is_file() {
if active.file_name().is_some_and(|name| name == "Ascension.exe") && !original.is_file() {
continue;
}
fs::rename(&active, &disabled)?;
if original.is_file() {
fs::copy(&original, &active)?;
}
}
}
tracing::info!(enabled, "custom races client patches toggled");
Ok(())
}
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 data_dir = client_path.join("Data");
fs::create_dir_all(&data_dir)?;
// 1. Back up original Ascension.exe and patch-T.MPQ if they exist and haven't been backed up yet
let exe = client_path.join("Ascension.exe");
let exe_bak = client_path.join("Ascension.exe.original");
if exe.is_file() && !exe_bak.is_file() {
report("Backing up original Ascension.exe...", 0.02);
fs::copy(&exe, &exe_bak)?;
}
let t_mpq = data_dir.join("patch-T.MPQ");
let t_mpq_bak = data_dir.join("patch-T.MPQ.original");
if t_mpq.is_file() && !t_mpq_bak.is_file() {
report("Backing up original patch-T.MPQ...", 0.04);
fs::copy(&t_mpq, &t_mpq_bak)?;
}
let dll = client_path.join("dinput8.dll");
let dll_backup = client_path.join("dinput8.dll.original");
if dll.is_file() && !dll_backup.is_file() {
fs::copy(&dll, &dll_backup)?;
}
// 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 = client_path.join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = client_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 = client_path.join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = client_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"));
}
fsx::atomic_write(&manifest_path, manifest_body.as_bytes())?;
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::*;
#[test]
fn disabling_restores_original_client_files_and_enabling_restores_custom_files() {
let temp = tempfile::tempdir().unwrap();
let data = temp.path().join("Data");
fs::create_dir_all(&data).unwrap();
for path in [data.join("patch-T.MPQ"), temp.path().join("Ascension.exe"), temp.path().join("dinput8.dll")] {
fs::write(&path, b"custom").unwrap();
let backup = path.with_extension(format!("{}.original", path.extension().unwrap().to_string_lossy()));
fs::write(&backup, b"original").unwrap();
}
fs::write(temp.path().join(MANIFEST_FILENAME), "MPQ:patch-T.MPQ\n").unwrap();
set_client_patch_enabled(temp.path(), false).unwrap();
assert_eq!(fs::read(data.join("patch-T.MPQ")).unwrap(), b"original");
assert_eq!(fs::read(temp.path().join("Ascension.exe")).unwrap(), b"original");
set_client_patch_enabled(temp.path(), true).unwrap();
assert_eq!(fs::read(data.join("patch-T.MPQ")).unwrap(), b"custom");
assert_eq!(fs::read(temp.path().join("Ascension.exe")).unwrap(), b"custom");
}
#[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 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());
}
}
+382
View File
@@ -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());
}
}
+5 -2
View File
@@ -176,10 +176,13 @@ impl Db {
fn fail(&self, stderr: &[u8]) -> Error {
let text = String::from_utf8_lossy(stderr);
let down = text.contains("2003") || text.contains("Can't connect") || text.contains("is not running") || text.contains("No such container");
// Only the client's own connection errors mean "not running": the number 2003 or the words can also appear inside
// the message of an ordinary SQL error (a duplicate entry, a row number) and must not hide it.
let down = text.contains("ERROR 2003") || text.contains("ERROR 2002") || text.contains("Can't connect to MySQL server")
|| text.contains("No such container") || text.contains("is not running");
let code = if down { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown };
match code {
ErrorCode::DatabaseNotRunning => Error::Invalid("The database is not running. Start the server first.".into()),
ErrorCode::DatabaseNotRunning => Error::Invalid(format!("The database is not running. Start the server first. ({})", text.trim().lines().last().unwrap_or("").chars().take(300).collect::<String>())),
_ => Error::Invalid(format!("database command failed: {}", text.trim().lines().last().unwrap_or(""))),
}
}
+261 -5
View File
@@ -172,19 +172,158 @@ pub fn squash_repeated_config_warnings(text: &str) -> String {
s
}
const SENSITIVE: [&str; 7] = ["password", "passwd", "secret", "token", "apikey", "api_key", "databaseinfo"];
/// Remove things that must never leave the machine from log text.
pub fn redact(text: &str) -> String {
let mut out = Vec::new();
for line in text.lines() {
let l = line.to_lowercase();
let sensitive = ["password", "passwd", "secret", "token", "apikey", "api_key", "databaseinfo"].iter().any(|k| l.contains(k));
let sensitive = SENSITIVE.iter().any(|k| l.contains(k));
out.push(if sensitive { "[line removed: may contain a secret]".to_string() } else { line.to_string() });
}
out.join("\n")
}
/// The same for JSON: values under a sensitive key and strings that look like `password=...` are replaced, and the
/// result stays valid JSON (removing a whole line would break the file for whoever reads it). Text that is not JSON
/// falls back to the line rule.
pub fn redact_json(text: &str) -> String {
fn scrub(v: &mut serde_json::Value) {
use serde_json::Value;
match v {
Value::Object(map) => {
for (key, value) in map.iter_mut() {
let k = key.to_lowercase();
if SENSITIVE.iter().any(|s| k.contains(s)) && !value.is_object() && !value.is_array() {
*value = Value::String("[redacted]".into());
} else {
scrub(value);
}
}
}
Value::Array(items) => items.iter_mut().for_each(scrub),
Value::String(s) => {
let l = s.to_lowercase();
if ["password=", "passwd=", "secret=", "token=", "apikey=", "api_key=", "password:"].iter().any(|k| l.contains(k)) {
*s = "[redacted]".into();
}
}
_ => {}
}
}
match serde_json::from_str::<serde_json::Value>(text) {
Ok(mut v) => {
scrub(&mut v);
serde_json::to_string_pretty(&v).unwrap_or_else(|_| redact(text))
}
Err(_) => redact(text),
}
}
/// Keep the events of a `wevtutil ... /f:text` listing that mention one of `needles` (compared without case), in the
/// order listed, at most `max` of them.
pub fn filter_event_blocks(listing: &str, needles: &[&str], max: usize) -> String {
let mut blocks: Vec<Vec<&str>> = Vec::new();
for line in listing.lines() {
if line.starts_with("Event[") || blocks.is_empty() {
blocks.push(Vec::new());
}
if let Some(b) = blocks.last_mut() { b.push(line); }
}
blocks
.into_iter()
.map(|b| b.join("\n"))
.filter(|b| { let l = b.to_lowercase(); needles.iter().any(|n| l.contains(n)) })
.take(max)
.collect::<Vec<_>>()
.join("\n\n")
}
/// Drop the lines of an event listing that name the person or the computer.
pub fn drop_identity_lines(listing: &str) -> String {
listing
.lines()
.filter(|l| { let t = l.trim_start(); !(t.starts_with("User:") || t.starts_with("User Name:") || t.starts_with("Computer:")) })
.collect::<Vec<_>>()
.join("\n")
}
/// `wevtutil /uni:true` writes UTF-16 with a byte order mark; anything else is read as UTF-8 (lossy).
fn decode_console_output(bytes: &[u8]) -> String {
if bytes.starts_with(&[0xFF, 0xFE]) {
let units: Vec<u16> = bytes[2..].chunks_exact(2).map(|c| u16::from_le_bytes([c[0], c[1]])).collect();
String::from_utf16_lossy(&units)
} else {
String::from_utf8_lossy(bytes).into_owned()
}
}
/// Crashes and hangs Windows recorded for the server programs in the last two weeks. This is the only trace of a crash
/// that ends the process without the server's own crash report (a stack buffer overrun, for example). The lines that
/// name the user and the computer are left out.
#[cfg(windows)]
fn windows_events() -> String {
use std::os::windows::process::CommandExt;
let query = "*[System[(Provider[@Name='Application Error' or @Name='Windows Error Reporting' or @Name='Application Hang']) and TimeCreated[timediff(@SystemTime) <= 1209600000]]]";
let out = std::process::Command::new("wevtutil")
.args(["qe", "Application", &format!("/q:{query}"), "/c:300", "/rd:true", "/f:text", "/uni:true"])
.creation_flags(0x0800_0000)
.output();
match out {
Ok(o) if o.status.success() => {
let text = filter_event_blocks(&decode_console_output(&o.stdout), &["worldserver", "authserver", "mysqld", "coa server manager", "coa-server-manager"], 40);
if text.is_empty() { "No crash or hang of the server programs was recorded by Windows in the last 14 days.".into() } else { drop_identity_lines(&text) }
}
Ok(o) => format!("Windows event log could not be read: {}", decode_console_output(&o.stderr).trim()),
Err(e) => format!("Windows event log could not be read: {e}"),
}
}
#[cfg(not(windows))]
fn windows_events() -> String {
String::new()
}
/// Newest files of a folder with the given extension (compared without case): path, size, modified time.
fn newest_files(dir: &Path, ext: &str, limit: usize) -> Vec<(PathBuf, u64, std::time::SystemTime)> {
let Ok(rd) = fs::read_dir(dir) else { return Vec::new() };
let mut v: Vec<_> = rd
.flatten()
.filter(|e| e.path().extension().is_some_and(|x| x.eq_ignore_ascii_case(ext)))
.filter_map(|e| { let m = e.metadata().ok()?; m.is_file().then(|| (e.path(), m.len(), m.modified().unwrap_or(std::time::UNIX_EPOCH))) })
.collect();
v.sort_by(|a, b| b.2.cmp(&a.2));
v.truncate(limit);
v
}
/// Which server programs run right now and from where, next to what the Manager made of it. A program started from a
/// folder or a copy the Manager does not know shows up here even when the Manager reports "port in use".
fn processes_report(root: &Path, ports: &layout::Ports) -> String {
let here = root.to_string_lossy().to_lowercase().replace('/', "\\");
let listen = process::listeners_detailed();
let mut out = String::from("Server programs running now (any folder):\n");
let found = process::find_by_file_names(&["worldserver.exe", "authserver.exe", "mysqld.exe"]);
if found.is_empty() { out.push_str(" none\n"); }
for p in found {
let ports_of: Vec<String> = listen.iter().filter(|l| l.pid == p.pid).map(|l| l.port.to_string()).collect();
let inside = p.exe.to_lowercase().replace('/', "\\").starts_with(&here);
out.push_str(&format!(" pid {} {} | listening on: {} | {}\n", p.pid, p.exe, if ports_of.is_empty() { "-".into() } else { ports_of.join(", ") }, if inside { "inside this server folder" } else { "OUTSIDE this server folder" }));
}
let o = process::observe(root, ports);
out.push_str("\nThe Manager's view:\n");
for s in [Some(&o.mysql), Some(&o.auth), Some(&o.world), o.secondary_world.as_ref()].into_iter().flatten() {
out.push_str(&format!(" {:<16} {:?} port {} {}{}\n", s.name, s.state, s.port, s.pid.map(|p| format!("pid {p}")).unwrap_or_default(), s.conflict.as_ref().map(|c| format!(" | port held by pid {} {}", c.pid, c.exe.clone().unwrap_or_default())).unwrap_or_default()));
}
out
}
/// Zip with what a maintainer needs to debug a problem, with secrets removed. Returns the number of files inside.
/// One call collects everything: the Manager's and the server's logs, crash reports and small crash dumps, Windows'
/// own record of crashes, the update journals, the running server programs and the settings the client depends on.
pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &InstallMeta, report: &Report, out_zip: &Path) -> Result<usize> {
const DUMP_FILE_MAX: u64 = 30 * 1024 * 1024;
let file = fs::File::create(out_zip)?;
let mut zip = zip::ZipWriter::new(file);
let opts = zip::write::SimpleFileOptions::default().compression_method(zip::CompressionMethod::Deflated);
@@ -195,8 +334,10 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
n += 1;
Ok(())
};
let ports = layout::read_ports(root);
let summary = serde_json::json!({
"manager": crate::MANAGER_VERSION,
"exported_utc": chrono::Utc::now().to_rfc3339(),
"core": meta.core,
"bots": meta.bots,
"squid_bots": crate::squid::release(root),
@@ -206,7 +347,25 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
"wow_client_set": meta.client_path.is_some(),
});
add("summary.json", serde_json::to_string_pretty(&summary)?.as_bytes())?;
for (name, path) in [("manager.log", manager_log.to_path_buf()), ("manager-install.log", meta_dir.join("logs/manager.log")), ("Server.log.tail", root.join("Core/Logs/Server.log")), ("Errors.log.tail", root.join("Core/Logs/Errors.log")), ("Auth.log.tail", root.join("Core/Logs/Auth.log")), ("world-console.log.tail", root.join("Core/Logs/world-console.log")), ("mysql-error.log.tail", root.join("mysql/logs/mysql-error.log"))] {
// Logs. The newest update logs of the repack's own updater are added under their own names.
let mut logs: Vec<(String, PathBuf)> = vec![
("manager.log".into(), manager_log.to_path_buf()),
("manager-install.log".into(), meta_dir.join("logs/manager.log")),
("Server.log.tail".into(), root.join("Core/Logs/Server.log")),
("Errors.log.tail".into(), root.join("Core/Logs/Errors.log")),
("Auth.log.tail".into(), root.join("Core/Logs/Auth.log")),
("world-console.log.tail".into(), root.join("Core/Logs/world-console.log")),
("CoaBots.log.tail".into(), root.join("Core/Logs/CoaBots.log")),
("Playerbots.log.tail".into(), root.join("Core/Logs/Playerbots.log")),
("supervisor.log.tail".into(), root.join("Core/Logs/supervisor.log")),
("mysql-error.log.tail".into(), root.join("mysql/logs/mysql-error.log")),
];
let updater_logs = newest_files(&root.join("Core/Logs"), "log", usize::MAX).into_iter().filter(|(p, _, _)| p.file_name().is_some_and(|f| f.to_string_lossy().to_lowercase().starts_with("update-")));
for (p, _, _) in updater_logs.take(2) {
logs.push((format!("{}.tail", p.file_name().unwrap_or_default().to_string_lossy()), p));
}
for (name, path) in logs {
// A module that reads a missing setting on every tick fills a log with one warning, thousands of times; read far
// enough back to see past that, fold the repeats, then keep the last part.
let bytes = tail(&path, 8 * 1024 * 1024);
@@ -214,9 +373,44 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
let text = squash_repeated_config_warnings(&String::from_utf8_lossy(&bytes));
let keep = text.len().saturating_sub(512 * 1024);
let start = (keep..text.len()).find(|i| text.is_char_boundary(*i)).unwrap_or(text.len());
add(name, redact(&text[start..]).as_bytes())?;
add(&name, redact(&text[start..]).as_bytes())?;
}
}
// Crash reports of the server (text, and the small dumps next to them), and what Windows recorded for the programs.
let crashes = root.join("Core/Crashes");
let mut listing = String::new();
for (p, len, _) in newest_files(&crashes, "txt", 10) {
let name = p.file_name().unwrap_or_default().to_string_lossy().into_owned();
listing.push_str(&format!("{name} ({len} bytes)\n"));
let text = String::from_utf8_lossy(&tail(&p, 1024 * 1024)).into_owned();
add(&format!("crashes/{name}"), redact(&text).as_bytes())?;
}
for (p, len, _) in newest_files(&crashes, "dmp", 3) {
let name = p.file_name().unwrap_or_default().to_string_lossy().into_owned();
if len > DUMP_FILE_MAX {
listing.push_str(&format!("{name} ({len} bytes) not included: larger than {} MB\n", DUMP_FILE_MAX >> 20));
} else if let Ok(bytes) = fs::read(&p) {
listing.push_str(&format!("{name} ({len} bytes) included\n"));
add(&format!("crashes/{name}"), &bytes)?;
}
}
add("crashes.txt", if listing.is_empty() { "No crash reports in Core/Crashes.".to_string() } else { listing }.as_bytes())?;
let events = windows_events();
if !events.is_empty() { add("windows-events.txt", events.as_bytes())?; }
add("processes.txt", processes_report(root, &ports).as_bytes())?;
// The newest update journals: the state of each update and the reason it failed.
let mut journals: Vec<_> = fs::read_dir(meta_dir.join("updates")).into_iter().flatten().flatten()
.filter(|e| e.file_type().is_ok_and(|t| t.is_dir()) && e.file_name().to_string_lossy().chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_')))
.collect();
journals.sort_by_key(|e| std::cmp::Reverse(e.file_name()));
for e in journals.into_iter().take(5) {
if let Ok(text) = fs::read_to_string(e.path().join("txn.json")) {
add(&format!("updates/{}-txn.json", e.file_name().to_string_lossy()), redact_json(&text).as_bytes())?;
}
}
// Which files the server's own configuration folders hold, and the two CoA switches that decide whether the game
// client can talk to the world server at all.
let mut present = String::new();
@@ -244,10 +438,10 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
}
}
if let Ok(b) = fs::read(root.join("RELEASE.json")) {
add("RELEASE.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?;
add("RELEASE.json", redact_json(&String::from_utf8_lossy(&b)).as_bytes())?;
}
if let Ok(b) = fs::read(meta_dir.join("logs/database-checks.json")) {
add("database-checks.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?;
add("database-checks.json", redact_json(&String::from_utf8_lossy(&b)).as_bytes())?;
}
zip.finish().map_err(|e| Error::Invalid(e.to_string()))?;
Ok(n)
@@ -289,6 +483,68 @@ real error
assert!(!t.contains("PASS") && !t.contains("abc"));
}
#[test]
fn json_redaction_keeps_the_file_valid_and_hides_the_secrets() {
let t = redact_json(r#"{"id":"rev_20261006_token_cache","password":"hunter2","nested":{"apiKey":"k","note":"login with password=abc"},"list":[{"secret":1},"ok"]}"#);
let v: serde_json::Value = serde_json::from_str(&t).expect("still JSON");
assert_eq!(v["id"], "rev_20261006_token_cache", "an id that merely contains a word is kept");
assert_eq!(v["password"], "[redacted]");
assert_eq!(v["nested"]["apiKey"], "[redacted]");
assert_eq!(v["nested"]["note"], "[redacted]");
assert_eq!(v["list"][0]["secret"], "[redacted]");
assert_eq!(v["list"][1], "ok");
assert!(!t.contains("hunter2") && !t.contains("abc"));
assert!(redact_json("not json\nPassword=1").contains("[line removed"), "text falls back to the line rule");
}
#[test]
fn windows_events_are_filtered_to_the_server_programs() {
let listing = "Event[0]:\n Provider Name: Application Error\n Description: Faulting application name: worldserver.exe, version: 0.0.0.0\n\nEvent[1]:\n Provider Name: Application Error\n Description: Faulting application name: notepad.exe\n\nEvent[2]:\n Description: Faulting application name: MYSQLD.EXE\n";
let out = filter_event_blocks(listing, &["worldserver", "mysqld"], 10);
assert!(out.contains("worldserver.exe") && out.contains("MYSQLD.EXE") && !out.contains("notepad"));
assert_eq!(filter_event_blocks(listing, &["worldserver", "mysqld"], 1).matches("Event[").count(), 1);
}
#[test]
fn event_text_loses_the_user_and_computer_lines_and_reads_utf16() {
let out = drop_identity_lines("Event[0]\n Source: Application Error\n User: S-1-5-21-1\n User Name: PC\\Dion\n Computer: PC\n Description: worldserver.exe");
assert!(out.contains("Source") && out.contains("worldserver.exe"));
assert!(!out.contains("S-1-5") && !out.contains("Dion") && !out.contains("Computer"));
let mut bytes = vec![0xFF, 0xFE];
for u in "Сбой worldserver".encode_utf16() { bytes.extend_from_slice(&u.to_le_bytes()); }
assert_eq!(decode_console_output(&bytes), "Сбой worldserver");
assert_eq!(decode_console_output(b"plain"), "plain");
}
#[test]
fn the_package_carries_crash_reports_update_journals_and_the_process_view() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
layout::testkit::fake_repack(&root);
fs::create_dir_all(root.join("Core/Crashes")).unwrap();
fs::write(root.join("Core/Crashes/567e_worldserver.exe_[4-10_21-25-31].txt"), "Exception code: C0000005\nRCX:0\n").unwrap();
fs::write(root.join("Core/Crashes/567e_worldserver.exe_[4-10_21-25-31].dmp"), b"MDMP-small").unwrap();
fs::write(root.join("Core/Logs/CoaBots.log"), "bot line\n").unwrap();
fs::write(root.join("Core/Logs/update-1.8-20261005.log"), "updater line\n").unwrap();
let meta_dir = d.path().join("srv.manager");
fs::create_dir_all(meta_dir.join("updates/20261006-082021-0_261006_1-abc")).unwrap();
fs::write(meta_dir.join("updates/20261006-082021-0_261006_1-abc/txn.json"), r#"{"state":"rolled-back","message":"Database update 2026_02_24_00 failed: duplicate column"}"#).unwrap();
fs::create_dir_all(meta_dir.join("updates/not a journal!")).unwrap();
let meta = InstallMeta::new(InstallKind::Imported, &root);
let report = run(&root, &meta);
let zip_path = d.path().join("diag.zip");
export_package(&root, &meta_dir, &d.path().join("none.log"), &meta, &report, &zip_path).unwrap();
let mut z = zip::ZipArchive::new(fs::File::open(&zip_path).unwrap()).unwrap();
let names: Vec<String> = (0..z.len()).map(|i| z.by_index(i).unwrap().name().to_string()).collect();
for want in ["crashes.txt", "processes.txt", "CoaBots.log.tail", "update-1.8-20261005.log.tail", "updates/20261006-082021-0_261006_1-abc-txn.json", "crashes/567e_worldserver.exe_[4-10_21-25-31].txt", "crashes/567e_worldserver.exe_[4-10_21-25-31].dmp"] {
assert!(names.iter().any(|n| n == want), "{want} is in the package: {names:?}");
}
assert!(!names.iter().any(|n| n.contains("not a journal")));
let mut listing = String::new();
z.by_name("crashes.txt").unwrap().read_to_string(&mut listing).unwrap();
assert!(listing.contains("included"));
}
#[test]
fn verify_reports_missing_and_changed_managed_files_only() {
let d = tempfile::tempdir().unwrap();
+69
View File
@@ -0,0 +1,69 @@
//! The disposable database a release is validated against, on a Linux computer.
//!
//! A release is checked by applying its database changes to the database of the signed base package. The base carries the
//! MySQL data directory of a Windows repack, and a MySQL 8.4 server in Docker opens it as it is (with the repack's table
//! name setting). So the fixture is a Docker server folder whose database container uses that directory in place of a
//! volume; everything else (start, SQL, schema capture, dumps) is the code of a Docker installation.
use std::fs;
use std::path::Path;
use super::{Config, Docker, MARKER, MYSQL_IMAGE};
use crate::driver::{self, Verb};
use crate::error::{Error, Result};
use crate::{fsx, install, package};
/// Turn an extracted base package (`mysql/data`, `Settings/`) into a Docker server folder and start its database.
pub fn prepare(root: &Path) -> Result<()> {
prepare_with(&super::SystemDocker, root)
}
pub(crate) fn prepare_with(d: &dyn Docker, root: &Path) -> Result<()> {
let boot = root.join(package::BOOTSTRAP_CREDENTIALS);
if !boot.is_file() {
return Err(Error::Invalid("The package has no database bootstrap information.".into()));
}
let secrets: serde_json::Value = fsx::read_json(&boot)?;
let root_pw = secrets["rootPassword"].as_str().filter(|p| p.chars().all(|c| c.is_ascii_hexdigit()) && !p.is_empty())
.ok_or_else(|| Error::Invalid("The database bootstrap information is not usable.".into()))?.to_string();
fs::copy(&boot, root.join("Settings/database.json"))?;
let data = fs::canonicalize(root.join("mysql/data"))
.map_err(|_| Error::Invalid("The package has no database data directory.".into()))?;
let cfg = Config {
project: format!("schema-{}", install::random_hex(8)),
bind_address: "127.0.0.1".into(),
mysql_image: MYSQL_IMAGE.into(),
data_dir: None,
mysql_data: Some(data.to_string_lossy().into_owned()),
};
fsx::atomic_write_json(&root.join(MARKER), &cfg)?;
let started = driver::run(root, Verb::StartMysql)?;
if !started.ok {
return Err(Error::Invalid(started.human.map(|h| h.message.to_string()).unwrap_or_else(|| "The database could not be started.".into())));
}
// The repack's administrator account only exists for connections from the server itself (the socket); the Manager
// connects over TCP. The fixture is thrown away, so the account is simply added.
let sql = format!("CREATE USER IF NOT EXISTS 'root'@'127.0.0.1' IDENTIFIED BY '{root_pw}'; GRANT ALL ON *.* TO 'root'@'127.0.0.1' WITH GRANT OPTION;");
let mut call = super::Call::new(&["exec", "-i", "-e", "MYSQL_PWD", &cfg.names().db, "mysql", "--user=root"], std::time::Duration::from_secs(60));
call.env = vec![("MYSQL_PWD".into(), root_pw)];
call.stdin = Some(sql.as_bytes());
let o = d.run(&call)?;
if !o.ok() {
return Err(Error::Invalid(format!("The fixture database could not be opened to the Manager: {}", o.text())));
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_package_without_bootstrap_information_is_refused_before_anything_starts() {
let dir = tempfile::tempdir().unwrap();
let err = prepare(dir.path()).unwrap_err();
assert!(err.to_string().contains("bootstrap"), "{err}");
assert!(!dir.path().join(MARKER).exists());
}
}
+574
View File
@@ -0,0 +1,574 @@
//! Installing a new server as a Docker installation, from a Linux package.
//!
//! The order of events is the one of `install::install_base`: nothing appears at the destination until the package is
//! signed-off, downloaded, verified, extracted and its database built, all of it in a sibling `<dest>.installing`
//! folder. But this is code of its own: the Windows installer is not touched and nothing here is specific to the
//! Windows layout. What both installers use is platform-neutral: the signed manifest, the download, the extraction,
//! the migration ledger and the registry.
//!
//! The databases start from the package's own dumps (`Database/baseline/<kind>.sql.zst`, the format of the Manager's
//! backups), as a Windows package starts from its prepared database: they hold the state in which every migration of the
//! package is already applied, and the installer records them as such. They cannot be rebuilt from the repository's
//! SQL files: some migrations are guards that only apply to the maintainers' own database. The game data is not part
//! of the package: the person points at a folder they already have.
use std::fs;
use std::path::{Path, PathBuf};
use super::cli::{Docker, SystemDocker};
use super::{Config, MARKER};
use crate::db::{self, Account, Db};
use crate::download::Cancel;
use crate::driver::Verb;
use crate::error::{Error, Result};
use crate::fsx;
use crate::install::{free_port, problem, random_hex, Installed, Preflight, Step};
use crate::manifest::{self, Migration};
use crate::migrations;
use crate::package::BASELINE_DIR;
use crate::pkgsource::{fetch_manifest, fetch_parts, Source};
use crate::registry::{metadata_dir_for, InstallKind, InstallMeta, MetaDir, Registry, LAYOUT_DOCKER_V1};
/// Created in the staging folder so a leftover of an earlier attempt can be told from somebody else's folder.
const STAGING_MARKER: &str = ".coa-installing";
/// The three game databases: kind (the name of the dump), schema.
const DATABASES: [(&str, &str); 3] = [("auth", "acore_auth"), ("characters", "acore_characters"), ("world", "acore_world")];
/// Ports the game uses by default on this computer.
const DEFAULT_PORTS: (u16, u16, u16) = (3724, 8085, 3443);
pub struct Params<'a> {
pub source: Source,
pub dest: PathBuf,
/// A folder with the game data (dbc, maps, vmaps, mmaps) that the person already has. Used in place, read-only.
pub data_dir: PathBuf,
/// Public key to verify the manifest with (production: `signing::EMBEDDED_PUBLIC_KEY`).
pub trusted_key: &'a str,
pub registry: &'a Registry,
pub cancel: Cancel,
}
/// Checks whether `dest` and the game data folder are sensible for a new server on Linux.
pub fn preflight(dest: &Path, data_dir: &Path, needed_bytes: u64, registry: &Registry) -> Preflight {
let mut problems = Vec::new();
let s = dest.to_string_lossy();
if !dest.is_absolute() {
problems.push(problem("relative", "Choose a full folder path, such as /home/you/CoaServer."));
}
if s.contains(':') {
problems.push(problem("colon", "Choose a folder whose path has no colon in it."));
}
let trimmed = s.trim_end_matches('/');
const SYSTEM: [&str; 13] = ["", "/bin", "/boot", "/dev", "/etc", "/lib", "/lib64", "/proc", "/run", "/sbin", "/sys", "/usr", "/var"];
if SYSTEM.iter().any(|p| trimmed == *p || (!p.is_empty() && trimmed.starts_with(&format!("{p}/")))) {
problems.push(problem("system_folder", "Please choose a normal folder for your games, not a system location."));
}
if let Some(home) = std::env::var_os("HOME") {
let home = home.to_string_lossy().trim_end_matches('/').to_string();
let special = ["", "/Documents", "/Desktop", "/Downloads", "/Pictures", "/Music", "/Videos", "/.config", "/.local", "/.local/share"];
if !home.is_empty() && special.iter().any(|sfx| trimmed == format!("{home}{sfx}")) {
problems.push(problem("personal_folder", "This folder contains unrelated files. Choose another folder or create a new CoA Server folder."));
}
}
if dest.exists() {
match fs::read_dir(dest) {
Ok(mut rd) => {
if rd.next().is_some() {
match crate::layout::scan(dest).map(|r| r.classification) {
Ok(crate::layout::Classification::Incompatible) | Err(_) => {
if dest.join("Wow.exe").is_file() || dest.join("Ascension.exe").is_file() {
problems.push(problem("client_folder", "This is a game client folder, not a place for a server."));
} else {
problems.push(problem("not_empty", "This folder contains unrelated files. Choose another folder or create a new CoA Server folder."));
}
}
Ok(_) => problems.push(problem("already_server", "A server is already in this folder. Use \"I already have a server\" to add it instead.")),
}
}
}
Err(_) => problems.push(problem("unreadable", "This folder cannot be read. Choose another one.")),
}
}
if let Ok(list) = registry.list() {
for (_, existing) in list {
if let (Ok(a), Ok(b)) = (fsx::canonicalize_lenient(dest), fsx::canonicalize_lenient(&existing)) {
if fsx::starts_with_ci(&a, &b) || fsx::starts_with_ci(&b, &a) {
problems.push(problem("registered", "A server is already registered at or around this location."));
break;
}
}
}
}
problems.extend(data_problems(data_dir));
let free_bytes = fsx::free_space(dest).unwrap_or(0);
let need = needed_bytes.saturating_add(needed_bytes / 5).saturating_add(512 * 1024 * 1024);
if free_bytes < need {
problems.push(problem("space", &format!("Not enough free space: about {} GB needed, {} GB available.", need / (1 << 30) + 1, free_bytes / (1 << 30))));
}
Preflight { ok: problems.is_empty(), problems, free_bytes }
}
fn data_problems(data_dir: &Path) -> Vec<crate::install::Problem> {
let s = data_dir.to_string_lossy();
if !data_dir.is_absolute() || s.contains(':') {
return vec![problem("data_path", "Choose the game data folder with its full path, without a colon in it.")];
}
let missing: Vec<&str> = ["dbc", "maps"].into_iter().filter(|d| !data_dir.join(d).is_dir()).collect();
if missing.is_empty() {
Vec::new()
} else {
vec![problem("data_missing", &format!("This folder does not look like the game data: {} not found in it. It should hold dbc, maps, vmaps and mmaps.", missing.join(" and ")))]
}
}
/// Port the game should use: the usual one when it is free on this computer, else any free one.
fn pick_port(preferred: u16) -> Result<u16> {
if std::net::TcpListener::bind(("127.0.0.1", preferred)).is_ok() {
Ok(preferred)
} else {
free_port()
}
}
/// Settings of a new installation: which containers belong to it, where the game data is, the ports, the passwords.
/// Written before anything runs, so the database can be started from the staging folder.
struct Settings {
app_password: String,
world_port: u16,
}
fn write_settings(root: &Path, data_dir: &Path) -> Result<Settings> {
let project = random_hex(10);
let (auth, world, ra) = (pick_port(DEFAULT_PORTS.0)?, pick_port(DEFAULT_PORTS.1)?, pick_port(DEFAULT_PORTS.2)?);
let (root_password, app_password) = (random_hex(48), random_hex(48));
fs::create_dir_all(root.join("Settings"))?;
let docker = Config { project, bind_address: "127.0.0.1".into(), mysql_image: super::MYSQL_IMAGE.into(), data_dir: Some(data_dir.to_string_lossy().into_owned()), mysql_data: None };
fsx::atomic_write_json(&root.join(MARKER), &docker)?;
// Same file and keys as a repack, so the console, the ports and the settings screens work unchanged. The database is
// not published on the host; its port is only there to fill the key.
fsx::atomic_write_json(
&root.join("Settings/repack.json"),
&serde_json::json!({ "mysqlPort": 3307, "authPort": auth, "worldPort": world, "raPort": ra, "raUsername": db::SERVICE_ACCOUNT, "raPassword": "" }),
)?;
let secrets = root.join("Settings/database.json");
fsx::atomic_write_json(&secrets, &serde_json::json!({ "rootPassword": root_password, "appPassword": app_password }))?;
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
fs::set_permissions(&secrets, fs::Permissions::from_mode(0o600))?;
}
Ok(Settings { app_password, world_port: world })
}
/// The package must hold what a Docker installation is made of; say what is missing instead of failing later.
fn check_extracted(root: &Path) -> Result<()> {
let mut missing = Vec::new();
for rel in ["Core/worldserver", "Core/authserver", "Core/configs/worldserver.conf.dist", "Core/configs/authserver.conf.dist"] {
if !root.join(rel).is_file() {
missing.push(rel.to_string());
}
}
for (kind, _) in DATABASES {
if !root.join(BASELINE_DIR).join(format!("{kind}.sql.zst")).is_file() {
missing.push(format!("{BASELINE_DIR}/{kind}.sql.zst"));
}
}
if missing.is_empty() {
Ok(())
} else {
Err(Error::Invalid(format!("This package is not a complete Linux server package; missing: {}.", missing.join(", "))))
}
}
/// Record every migration of the package as applied without running it, in a few statements (one `docker exec` for each
/// of more than a thousand would take minutes). Same ledger rows as `migrations::baseline`.
fn baseline_statements(list: &[Migration]) -> Result<Vec<String>> {
let ok = |t: &str| !t.is_empty() && t.len() <= 190 && t.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '_' | '.' | '-'));
let mut rows = Vec::with_capacity(list.len());
for m in list {
if !matches!(m.db.as_str(), "auth" | "characters" | "world") || !ok(&m.id) || m.sha256.len() != 64 || !m.sha256.chars().all(|c| c.is_ascii_hexdigit()) {
return Err(Error::InvalidManifest(format!("migration {:?} is not valid", m.id)));
}
rows.push(format!("('{}','{}','{}','applied',NOW(),NULL,1)", m.db, m.id, m.sha256));
}
Ok(rows
.chunks(400)
.map(|c| format!("REPLACE INTO `acore_world`.`coa_manager_migrations` (`db`,`id`,`sha256`,`status`,`applied_at`,`error`,`baseline`) VALUES {};", c.join(",")))
.collect())
}
/// Create the three schemas and the game servers' account, load the starting databases and record the package's migrations
/// as applied. The database container is started from `root` and stopped again by the caller.
fn build_database(d: &dyn Docker, root: &Path, list: &[Migration], s: &Settings, say: &dyn Fn(u8, String)) -> Result<()> {
let started = super::run_with(d, root, Verb::StartMysql)?;
if !started.ok {
return Err(Error::Invalid(started.human.map(|h| h.message.to_string()).unwrap_or_else(|| "The database could not be started.".into())));
}
let db = Db::from_repack(root, Account::Admin)?;
let mut sql = String::new();
for (_, schema) in DATABASES {
sql.push_str(&format!("CREATE DATABASE `{schema}` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;\n"));
}
// The pattern also covers the schemas of other realms (acore_world_wildcard, ...).
sql.push_str(&format!("CREATE USER 'acore'@'%' IDENTIFIED BY '{}';\nGRANT ALL PRIVILEGES ON `acore\\_%`.* TO 'acore'@'%';\nFLUSH PRIVILEGES;\n", s.app_password));
db.query(&sql)?;
for (i, (kind, schema)) in DATABASES.iter().enumerate() {
say(83 + (i * 4) as u8, format!("Loading the {kind} database"));
db.import_from(schema, &root.join(BASELINE_DIR).join(format!("{kind}.sql.zst")))?;
}
say(95 - 3, format!("Recording {} database updates as applied", list.len()));
// The ledger table is created by the first read of it.
migrations::Store::load(&db)?;
for statement in baseline_statements(list)? {
db.query(&statement)?;
}
// The realm advertises the port the game server really uses on this computer.
db.query(&format!("UPDATE acore_auth.realmlist SET port={} WHERE id=1;", s.world_port))?;
// The server console gets its own account with a random password.
let console_pw = db.provision_service_account()?;
db::write_console_credentials(root, &console_pw)?;
if !Db::from_repack(root, Account::Admin)?.ping() {
return Err(Error::Invalid("The database did not answer after it was set up.".into()));
}
Ok(())
}
pub fn install(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
install_with(&SystemDocker, p, report)
}
pub fn install_with(d: &dyn Docker, p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
let say = |step: &'static str, percent: u8, detail: Option<String>| report(Step { step, percent, detail });
let dest = p.dest.clone();
let staging_root = {
let mut n = dest.file_name().ok_or_else(|| Error::Invalid("bad destination".into()))?.to_os_string();
n.push(".installing");
dest.with_file_name(n)
};
let meta_dir = metadata_dir_for(&dest)?;
say("Checking your computer", 2, None);
super::check_docker(d)?;
// The manifest first: it is signed, and tells us how much space we need.
let (m, manifest_bytes) = fetch_manifest(&p.source, p.trusted_key)?;
if !matches!(m.kind, manifest::Kind::Base | manifest::Kind::Update) || !m.compatible_with_manager(crate::MANAGER_VERSION) {
return Err(Error::Invalid("This package needs a newer version of CoA Server Manager.".into()));
}
let archive = m.archive.clone().ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
let download_size: u64 = archive.parts.iter().map(|x| x.size).sum();
let pre = preflight(&dest, &p.data_dir, archive.unpacked_size + download_size, p.registry);
if !pre.ok {
return Err(Error::Invalid(pre.problems.iter().map(|x| x.message.clone()).collect::<Vec<_>>().join(" ")));
}
let parts_dir = fetch_parts(&p.source, &m, &meta_dir.join("staging").join("download"), &p.cancel, &|frac, detail| say("Downloading server", 5 + (frac * 45.0) as u8, detail))?;
if staging_root.exists() {
if staging_root.join(STAGING_MARKER).is_file() {
fs::remove_dir_all(&staging_root)?; // leftover of an earlier failed attempt that we created
} else {
return Err(Error::Invalid(format!("{} already exists and was not created by the Manager.", staging_root.display())));
}
}
fs::create_dir_all(&staging_root)?;
fs::write(staging_root.join(STAGING_MARKER), b"")?;
let mut project: Option<Config> = None;
let result = (|| -> Result<Installed> {
say("Unpacking", 50, None);
crate::package::extract(&parts_dir, &m, &staging_root, &|done, total| say("Unpacking", 50 + (done * 30 / total.max(1)) as u8, None))?;
check_extracted(&staging_root)?;
say("Preparing database", 82, None);
let settings = write_settings(&staging_root, &p.data_dir)?;
project = Some(Config::load(&staging_root)?);
let progress = |percent: u8, detail: String| say("Preparing database", percent, Some(detail));
let built = build_database(d, &staging_root, &m.migrations, &settings, &progress);
let _ = super::run_with(d, &staging_root, Verb::StopAll);
built?;
fs::remove_file(staging_root.join(STAGING_MARKER))?;
// Commit: the only moment the destination changes. The database lives in a docker volume, so it does not care
// that the folder moves.
say("Finishing", 95, None);
if dest.exists() {
fs::remove_dir(&dest)?; // only succeeds for an empty folder (preflight verified)
}
fs::rename(&staging_root, &dest)?;
super::ensure_main_configs(&dest)?;
crate::config::materialize_module_configs(&dest)?;
let mut meta = InstallMeta::new(InstallKind::New, &dest);
meta.layout = LAYOUT_DOCKER_V1.into();
meta.core.commit = m.core.commit.clone();
meta.core.version = Some(m.version.clone());
meta.database.schemas = DATABASES.iter().map(|(_, s)| s.to_string()).collect();
meta.managed_files = m.files.iter().map(|f| f.path.clone()).collect();
for f in &m.files {
meta.original_hashes.insert(f.path.clone(), f.sha256.clone());
}
let md = MetaDir::create(&dest, &meta)?;
fsx::atomic_write(&md.root.join("manifests").join("base.json"), &manifest_bytes)?;
p.registry.register(&meta.id, &dest)?;
say("Ready", 100, None);
Ok(Installed { id: meta.id, path: dest.to_string_lossy().into_owned(), version: m.version.clone() })
})();
if result.is_err() && staging_root.join(STAGING_MARKER).exists() {
// Unfinished work of ours; the destination was never touched. Give back what docker holds for it.
if let Some(cfg) = &project {
super::destroy(d, cfg);
}
let _ = fs::remove_dir_all(&staging_root);
}
result
}
#[cfg(test)]
mod tests {
use super::*;
use crate::docker::cli::{Call, Output};
use crate::package::{self, BuildOptions};
use base64::Engine;
use ed25519_dalek::{Signer, SigningKey};
use std::cell::RefCell;
struct Fake {
calls: RefCell<Vec<Vec<String>>>,
unavailable: bool,
}
impl Fake {
fn new(unavailable: bool) -> Fake {
Fake { calls: Default::default(), unavailable }
}
}
impl Docker for Fake {
fn run(&self, call: &Call) -> Result<Output> {
self.calls.borrow_mut().push(call.args.clone());
if self.unavailable {
return Err(Error::Invalid("docker could not be started: not found".into()));
}
Ok(Output { code: Some(0), stdout: "27.3.1".into(), stderr: String::new() })
}
fn pause(&self, _d: std::time::Duration) {}
}
fn reg(d: &Path) -> Registry {
Registry::at(d.join("reg/installs.json"))
}
fn codes(p: &Preflight) -> Vec<&'static str> {
p.problems.iter().map(|x| x.code).collect()
}
fn data_folder(d: &Path) -> PathBuf {
let data = d.join("data");
fs::create_dir_all(data.join("dbc")).unwrap();
fs::create_dir_all(data.join("maps")).unwrap();
data
}
/// A signed package folder holding `files`, and the key that verifies it.
fn signed_package(d: &Path, files: &[(&str, &str)]) -> (PathBuf, String) {
let src = d.join("src");
for (rel, content) in files {
let p = src.join(rel);
fs::create_dir_all(p.parent().unwrap()).unwrap();
fs::write(p, content).unwrap();
}
let pkg = d.join("pkg");
let opts = BuildOptions { kind: manifest::Kind::Update, version: "0.1.0".into(), core_commit: None, built_at: "x".into(), part_size: 1 << 20, bots_commit: None, migrations: vec![] };
package::build(&src, &pkg, &opts, &|_| {}).unwrap();
let key = SigningKey::generate(&mut rand_core::OsRng);
let engine = base64::engine::general_purpose::STANDARD;
let sig = engine.encode(key.sign(&fs::read(pkg.join("manifest.json")).unwrap()).to_bytes());
fs::write(pkg.join("manifest.json.sig"), sig).unwrap();
(pkg, engine.encode(key.verifying_key().to_bytes()))
}
const FULL: [(&str, &str); 7] = [
("Core/worldserver", "w"),
("Core/authserver", "a"),
("Core/configs/worldserver.conf.dist", "x"),
("Core/configs/authserver.conf.dist", "x"),
("Database/baseline/auth.sql.zst", "dump"),
("Database/baseline/characters.sql.zst", "dump"),
("Database/baseline/world.sql.zst", "dump"),
];
#[cfg(unix)]
#[test]
fn the_destination_rules_fit_a_linux_computer() {
let d = tempfile::tempdir().unwrap();
let data = data_folder(d.path());
let ok = |dest: &Path| codes(&preflight(dest, &data, 1000, &reg(d.path())));
assert!(!ok(&d.path().join("CoaServer")).iter().any(|c| *c != "space"), "a new folder is fine");
for bad in ["/usr/local/coa", "/etc", "/", "/proc/x"] {
assert!(ok(Path::new(bad)).contains(&"system_folder"), "{bad}");
}
assert!(ok(Path::new("relative/dir")).contains(&"relative"));
assert!(ok(Path::new("/srv/with:colon")).contains(&"colon"));
let existing = d.path().join("existing");
fs::create_dir_all(&existing).unwrap();
fs::write(existing.join("notes.txt"), b"x").unwrap();
assert!(ok(&existing).contains(&"not_empty"));
let r = reg(d.path());
r.register("1", &existing).unwrap();
assert!(codes(&preflight(&existing.join("inner"), &data, 1000, &r)).contains(&"registered"));
// The same name in another case is another folder on Linux.
assert!(!codes(&preflight(&d.path().join("EXISTING"), &data, 1000, &r)).contains(&"registered"));
}
// The tests marked for unix use absolute folders of the temporary directory, which on Windows start with a drive letter and a
// colon; the Docker backend refuses a colon in a folder it mounts (it would be read as a separator of `--volume`) and only runs
// on Linux, so Windows has nothing to check here.
#[cfg(unix)]
#[test]
fn the_game_data_folder_must_look_like_game_data() {
let d = tempfile::tempdir().unwrap();
let reg = reg(d.path());
let dest = d.path().join("srv");
let empty = d.path().join("empty");
fs::create_dir_all(&empty).unwrap();
assert!(codes(&preflight(&dest, &empty, 1, &reg)).contains(&"data_missing"));
assert!(codes(&preflight(&dest, Path::new("relative/data"), 1, &reg)).contains(&"data_path"));
assert!(!codes(&preflight(&dest, &data_folder(d.path()), 1, &reg)).iter().any(|c| c.starts_with("data")));
}
#[cfg(unix)]
#[test]
fn new_settings_name_the_containers_and_keep_the_secrets_private() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
let data = data_folder(d.path());
let s = write_settings(&root, &data).unwrap();
let cfg = Config::load(&root).unwrap();
assert_eq!(cfg.bind_address, "127.0.0.1", "this computer only until the person opens it");
assert_eq!(cfg.project.len(), 10);
assert_eq!(cfg.data_path(&root), data);
let ports = crate::layout::read_ports(&root);
assert_eq!(ports.world, s.world_port);
assert!(ports.auth > 0 && ports.ra > 0);
let repack: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json")).unwrap();
assert_eq!(repack["raUsername"], db::SERVICE_ACCOUNT);
let (root_pw, app_pw) = db::credentials(&root).unwrap();
assert!(root_pw.len() == 48 && app_pw.len() == 48 && root_pw != app_pw);
assert_eq!(app_pw, s.app_password);
#[cfg(unix)]
{
use std::os::unix::fs::PermissionsExt;
let mode = fs::metadata(root.join("Settings/database.json")).unwrap().permissions().mode() & 0o777;
assert_eq!(mode, 0o600, "the passwords are for their owner only");
}
// Two installations never share a project name.
let other = write_settings(&d.path().join("srv2"), &data).unwrap();
assert_ne!(Config::load(&d.path().join("srv2")).unwrap().project, cfg.project);
let _ = other;
}
#[test]
fn a_busy_default_port_is_replaced_by_a_free_one() {
let held = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
let busy = held.local_addr().unwrap().port();
let got = pick_port(busy).unwrap();
assert_ne!(got, busy);
drop(held);
assert_eq!(pick_port(busy).unwrap(), busy, "free again: the usual port is used");
}
#[test]
fn a_package_is_checked_for_everything_an_installation_needs() {
let d = tempfile::tempdir().unwrap();
let root = d.path();
assert!(check_extracted(root).unwrap_err().to_string().contains("Core/worldserver"));
for (rel, c) in FULL {
let p = root.join(rel);
fs::create_dir_all(p.parent().unwrap()).unwrap();
fs::write(p, c).unwrap();
}
check_extracted(root).unwrap();
fs::remove_file(root.join("Database/baseline/world.sql.zst")).unwrap();
assert!(check_extracted(root).unwrap_err().to_string().contains("Database/baseline/world.sql.zst"));
}
fn migration(db: &str, id: &str) -> Migration {
Migration { db: db.into(), id: id.into(), sha256: "ab".repeat(32), destructive: false, compatible_sha256: vec![] }
}
#[test]
fn the_package_migrations_are_recorded_as_applied_in_a_few_statements() {
let list: Vec<Migration> = (0..1000).map(|i| migration(["auth", "characters", "world"][i % 3], &format!("rev_{i}"))).collect();
let statements = baseline_statements(&list).unwrap();
assert_eq!(statements.len(), 3, "400 rows at most in a statement");
assert!(statements[0].starts_with("REPLACE INTO `acore_world`.`coa_manager_migrations`"));
assert_eq!(statements.iter().map(|s| s.matches("'applied'").count()).sum::<usize>(), 1000);
assert!(statements[0].contains("('auth','rev_0',") && statements[0].contains(",NOW(),NULL,1)"), "marked as a baseline");
assert!(baseline_statements(&[]).unwrap().is_empty());
}
#[test]
fn a_migration_that_could_carry_sql_is_refused_before_anything_is_written() {
for bad in [migration("world", "x'); DROP TABLE y;--"), migration("mysql", "ok"), migration("world", ""), Migration { sha256: "zz".into(), ..migration("world", "ok") }] {
assert!(baseline_statements(&[migration("auth", "fine"), bad]).is_err());
}
}
#[test]
fn without_docker_nothing_is_downloaded_or_created() {
let d = tempfile::tempdir().unwrap();
let (pkg, key) = signed_package(d.path(), &FULL);
let dest = d.path().join("dest");
let r = reg(d.path());
let fake = Fake::new(true);
let err = install_with(&fake, &Params { source: Source::Dir(pkg), dest: dest.clone(), data_dir: data_folder(d.path()), trusted_key: &key, registry: &r, cancel: Cancel::default() }, &|_| {}).unwrap_err();
assert!(err.to_string().to_lowercase().contains("docker"), "{err}");
assert!(!dest.exists() && !dest.with_file_name("dest.installing").exists());
}
#[cfg(unix)]
#[test]
fn a_package_without_the_server_is_refused_and_leaves_nothing() {
let d = tempfile::tempdir().unwrap();
let (pkg, key) = signed_package(d.path(), &[("Core/configs/worldserver.conf.dist", "x"), ("README.txt", "hello")]);
let dest = d.path().join("dest");
let r = reg(d.path());
let fake = Fake::new(false);
let err = install_with(&fake, &Params { source: Source::Dir(pkg), dest: dest.clone(), data_dir: data_folder(d.path()), trusted_key: &key, registry: &r, cancel: Cancel::default() }, &|_| {}).unwrap_err();
assert!(err.to_string().contains("not a complete Linux server package"), "{err}");
assert!(!dest.exists() && !dest.with_file_name("dest.installing").exists());
assert!(r.list().unwrap().is_empty());
}
#[cfg(unix)]
#[test]
fn a_failed_database_setup_gives_back_what_docker_holds_and_leaves_no_server() {
let d = tempfile::tempdir().unwrap();
let (pkg, key) = signed_package(d.path(), &FULL);
let dest = d.path().join("dest");
let r = reg(d.path());
// This fake docker answers every command with success and no container, so the database never becomes ready.
let fake = Fake::new(false);
let err = install_with(&fake, &Params { source: Source::Dir(pkg), dest: dest.clone(), data_dir: data_folder(d.path()), trusted_key: &key, registry: &r, cancel: Cancel::default() }, &|_| {}).unwrap_err();
assert!(err.to_string().to_lowercase().contains("database"), "{err}");
assert!(!dest.exists() && !dest.with_file_name("dest.installing").exists(), "no half-installed server");
assert!(r.list().unwrap().is_empty());
let calls = fake.calls.borrow();
let removed = |suffix: &str| calls.iter().any(|c| c[0] == "rm" && c.last().is_some_and(|n| n.starts_with("coa-") && n.ends_with(suffix)));
assert!(removed("-db") && removed("-world") && removed("-auth"), "containers removed: {calls:?}");
assert!(calls.iter().any(|c| c[..2] == ["volume", "rm"]) && calls.iter().any(|c| c[..2] == ["network", "rm"]));
}
}
+126 -16
View File
@@ -80,6 +80,26 @@ fn docker(d: &dyn Docker, args: &[&str], timeout: Duration) -> Step<super::cli::
d.run(&Call::new(args, timeout)).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))
}
/// Is docker usable by this user? Returns its version, or the reason in docker's own words.
pub fn check_docker(d: &dyn Docker) -> Result<String> {
let mut log = Log::default();
match preflight(d, &mut log) {
Ok(()) => Ok(log.0.join(" ")),
Err(f) => Err(crate::error::Error::Invalid(format!("{} {}", f.code.human().message, f.output.trim()).trim().to_string())),
}
}
/// Remove everything docker holds for an installation: containers, network and the database volume. Used when an
/// installation fails before it is finished, and later to uninstall. Missing pieces are not an error.
pub(crate) fn destroy(d: &dyn Docker, cfg: &Config) {
let n = cfg.names();
for name in [&n.auth, &n.world, &n.db] {
let _ = d.run(&Call::new(&["rm", "--force", name], QUICK));
}
let _ = d.run(&Call::new(&["network", "rm", &n.network], QUICK));
let _ = d.run(&Call::new(&["volume", "rm", &n.volume], QUICK));
}
fn preflight(d: &dyn Docker, log: &mut Log) -> Step<()> {
let o = docker(d, &["version", "--format", "{{.Server.Version}}"], QUICK)?;
if !o.ok() {
@@ -190,7 +210,7 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
if !state.get(&n.db).is_some_and(Container::running) {
remove(d, &n.db);
let mut call = Call::new(&[], Duration::from_secs(120));
call.args = db_args(cfg, &n);
call.args = db_args(cfg, &n, owner_of(root).as_deref());
call.env = vec![("MYSQL_ROOT_PASSWORD".into(), secrets.root.clone())];
let o = d.run(&call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
if !o.ok() {
@@ -203,7 +223,12 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
return Ok(());
}
// Realm profiles (CoA / Wildcard): the database is running and healthy here (started and waited for above), which the
// realm list update below needs. Finish an interrupted switch, then make the realm list say what is selected. The repack's
// launcher did this when it started; here nothing else would.
let realm = prepare_realm(root, log)?;
ensure_image(d, log)?;
super::ensure_main_configs(root).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
std::fs::create_dir_all(root.join("Core/Logs")).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
let owner = owner_of(root);
let host = std::fs::canonicalize(root).unwrap_or_else(|_| root.to_path_buf());
@@ -212,8 +237,8 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
if !state.get(&n.world).is_some_and(Container::running) {
remove(d, &n.world);
let mut call = Call::new(&[], Duration::from_secs(60));
call.args = game_args(cfg, &n, GameKind::World, &host, ports.world, ports.ra, owner.as_deref());
call.env = database_env(&secrets, true);
call.args = game_args(cfg, &n, GameKind::World, &host, &cfg.data_path(&host), ports.world, ports.ra, owner.as_deref());
call.env = database_env(&secrets, true, realm);
run_container(d, &call, &n.world, log)?;
}
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
@@ -221,8 +246,8 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
if !state.get(&n.auth).is_some_and(Container::running) {
remove(d, &n.auth);
let mut call = Call::new(&[], Duration::from_secs(60));
call.args = game_args(cfg, &n, GameKind::Auth, &host, ports.auth, 0, owner.as_deref());
call.env = database_env(&secrets, false);
call.args = game_args(cfg, &n, GameKind::Auth, &host, &cfg.data_path(&host), ports.auth, 0, owner.as_deref());
call.env = database_env(&secrets, false, realm);
run_container(d, &call, &n.auth, log)?;
}
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
@@ -312,19 +337,35 @@ fn connect_ip(cfg: &Config) -> IpAddr {
// ------------------------------------------------------------------------------------------------- argument lists
fn db_args(cfg: &Config, n: &Names) -> Vec<String> {
fn db_args(cfg: &Config, n: &Names, owner: Option<&str>) -> Vec<String> {
let mut a: Vec<String> = ["run", "--detach", "--name"].iter().map(|s| s.to_string()).collect();
a.push(n.db.clone());
a.extend(["--network".into(), n.network.clone(), "--network-alias".into(), "db".into()]);
a.extend(["--label".into(), format!("coa.project={}", cfg.project)]);
a.extend(["--volume".into(), format!("{}:/var/lib/mysql", n.volume)]);
match &cfg.mysql_data {
Some(dir) => {
// A data directory from a Windows repack: it is written by the person who owns the folder, and its table names
// were folded to lower case (the repack's setting), which the server must be told because a Linux one does not.
a.extend(["--volume".into(), format!("{dir}:/var/lib/mysql")]);
if let Some(o) = owner {
a.extend(["--user".into(), o.into()]);
}
}
None => a.extend(["--volume".into(), format!("{}:/var/lib/mysql", n.volume)]),
}
// The password comes from the environment of the docker client, not from this command line.
a.extend(["--env".into(), "MYSQL_ROOT_PASSWORD".into()]);
// "mysqladmin ping" succeeds as soon as the server answers, with or without a login.
a.extend(["--health-cmd".into(), "mysqladmin ping --silent".into()]);
// "mysqladmin ping" succeeds as soon as the server answers, with or without a login. It must go over TCP, like
// everything the Manager sends: while a new database initialises, the image first runs a temporary server that
// answers on its socket but takes no network connection, and a socket ping would call the container healthy for a few
// seconds in which every TCP connection is still refused.
a.extend(["--health-cmd".into(), "mysqladmin ping --protocol=tcp --host=127.0.0.1 --silent".into()]);
a.extend(["--health-interval".into(), "5s".into(), "--health-timeout".into(), "5s".into(), "--health-retries".into(), "40".into()]);
a.extend(["--stop-timeout".into(), "60".into()]);
a.push(cfg.mysql_image.clone());
if cfg.mysql_data.is_some() {
a.push("--lower-case-table-names=1".into());
}
a
}
@@ -335,17 +376,33 @@ enum GameKind {
}
/// Connection strings: host;port;user;password;database. They hold the password, so they travel by environment.
fn database_env(s: &Secrets, world: bool) -> Vec<(String, String)> {
fn database_env(s: &Secrets, world: bool, realm: crate::realms::Mode) -> Vec<(String, String)> {
let info = |db: &str| format!("db;3306;acore;{};{db}", s.app);
let mut env = vec![("AC_LOGIN_DATABASE_INFO".to_string(), info("acore_auth"))];
if world {
env.push(("AC_WORLD_DATABASE_INFO".into(), info("acore_world")));
env.push(("AC_CHARACTER_DATABASE_INFO".into(), info("acore_characters")));
// The databases of the selected realm (the Wildcard realm has its own world and characters databases).
let schema = |kind: &str| realm.schema(kind).unwrap_or("acore_world");
env.push(("AC_WORLD_DATABASE_INFO".into(), info(schema("world"))));
env.push(("AC_CHARACTER_DATABASE_INFO".into(), info(schema("characters"))));
}
env
}
fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, port: u16, ra_port: u16, owner: Option<&str>) -> Vec<String> {
/// Realm profiles are only in play once a profile has been chosen on this server (`Settings/realm-profile.json`).
fn prepare_realm(root: &Path, log: &mut Log) -> Step<crate::realms::Mode> {
let fail_with = |e: crate::error::Error| Failure { code: ErrorCode::StartupFailed, output: e.to_string() };
crate::realms::before_start(root).map_err(fail_with)?;
let active = crate::realms::state(root).map_err(fail_with)?.active;
if root.join("Settings/realm-profile.json").exists() {
crate::realms::setup_realmlist(root).map_err(fail_with)?;
let db = crate::db::Db::from_repack(root, crate::db::Account::Admin).map_err(fail_with)?;
db.query("UPDATE acore_auth.realmlist SET name='Conquest of Azeroth' WHERE id=1; UPDATE acore_auth.realmlist SET name='Wildcard' WHERE id=2;").map_err(fail_with)?;
log.say(format!("realm {}", active.name()));
}
Ok(active)
}
fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, data: &Path, port: u16, ra_port: u16, owner: Option<&str>) -> Vec<String> {
let (name, alias, binary, conf, inner_port) = match kind {
GameKind::World => (&n.world, "world", "./worldserver", "configs/worldserver.conf", WORLD_PORT),
GameKind::Auth => (&n.auth, "auth", "./authserver", "configs/authserver.conf", AUTH_PORT),
@@ -370,7 +427,11 @@ fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, port: u16, ra
// the container and stops the server when it cannot find one.
a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0"));
if kind == GameKind::World {
a.extend(["--volume".into(), format!("{}:{DATA}:ro", host.join("Data").display())]);
a.extend(["--volume".into(), format!("{}:{DATA}:ro", data.display())]);
let races = host.join("Data/dbc_races");
if races.is_dir() && races != data.join("dbc_races") {
a.extend(["--volume".into(), format!("{}:{DATA}/dbc_races:ro", races.display())]);
}
a.extend(env("AC_DATA_DIR", DATA));
// The remote console is only ever reachable from this computer.
a.extend(["--publish".into(), format!("127.0.0.1:{ra_port}:{RA_PORT}")]);
@@ -674,6 +735,55 @@ mod tests {
assert!(runs[1].args.windows(2).any(|w| w == ["--env", "AC_WORLD_DATABASE_INFO"]), "name only, the value is in the environment");
}
// Unix only: the folder is a Linux path (a Windows path has a colon, which a Docker folder may not).
#[cfg(unix)]
#[test]
fn a_release_fixture_runs_its_database_on_the_package_data_directory_not_on_a_volume() {
let (_d, root) = server("t1");
fs::write(root.join("Settings/docker.json"), r#"{"project":"t1","mysqlData":"/work/fixture/mysql/data"}"#).unwrap();
let sim = Sim::new();
assert!(run_with(&sim, &root, Verb::StartMysql).unwrap().ok);
let db = &sim.calls_of("run")[0].args;
assert!(db.windows(2).any(|w| w == ["--volume", "/work/fixture/mysql/data:/var/lib/mysql"]), "{db:?}");
assert!(!db.iter().any(|a| a.starts_with("coa-t1-db:")), "no named volume: {db:?}");
assert!(db.iter().any(|a| a == "--user"), "the folder is written by its owner");
assert_eq!(db.last().map(String::as_str), Some("--lower-case-table-names=1"), "a server option, so after the image name");
// An installation never gets any of it.
let (_d2, root2) = server("t2");
let sim2 = Sim::new();
assert!(run_with(&sim2, &root2, Verb::StartMysql).unwrap().ok);
let plain = &sim2.calls_of("run")[0].args;
assert!(plain.windows(2).any(|w| w == ["--volume", "coa-t2-db:/var/lib/mysql"]), "{plain:?}");
assert!(!plain.iter().any(|a| a == "--lower-case-table-names=1" || a == "--user"));
}
#[test]
fn the_containers_use_the_databases_of_the_selected_realm() {
let s = Secrets { root: "r".into(), app: "apppw".into() };
let get = |env: &[(String, String)], k: &str| env.iter().find(|(n, _)| n == k).map(|(_, v)| v.clone());
let coa = database_env(&s, true, crate::realms::Mode::Coa);
assert_eq!(get(&coa, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world");
assert_eq!(get(&coa, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters");
let wild = database_env(&s, true, crate::realms::Mode::Wildcard);
assert_eq!(get(&wild, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world_wildcard");
assert_eq!(get(&wild, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters_wildcard");
// Accounts are shared by both realms; the auth server never sees the others.
assert_eq!(get(&wild, "AC_LOGIN_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_auth");
let auth = database_env(&s, false, crate::realms::Mode::Wildcard);
assert_eq!(auth.len(), 1);
}
#[test]
fn the_database_is_only_healthy_once_it_takes_tcp_connections() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
let db = &sim.calls_of("run")[0].args;
let i = db.iter().position(|a| a == "--health-cmd").expect("the database has a health check");
// Found on a new volume: a socket-only ping reported healthy about four seconds before TCP worked.
assert!(db[i + 1].contains("--protocol=tcp") && db[i + 1].contains("--host=127.0.0.1"), "{}", db[i + 1]);
}
#[test]
fn the_world_container_is_wired_like_the_repack_layout() {
let (_d, root) = server("t1");
@@ -714,8 +824,8 @@ mod tests {
let (_d, root) = server("ports");
let cfg = Config::load(&root).unwrap();
let n = cfg.names();
let world = game_args(&cfg, &n, GameKind::World, &root, 18085, 13443, None);
let auth = game_args(&cfg, &n, GameKind::Auth, &root, 13724, 0, None);
let world = game_args(&cfg, &n, GameKind::World, &root, &root.join("Data"), 18085, 13443, None);
let auth = game_args(&cfg, &n, GameKind::Auth, &root, &root.join("Data"), 13724, 0, None);
assert!(world.iter().any(|a| a == "127.0.0.1:18085:8085"));
assert!(world.iter().any(|a| a == "127.0.0.1:13443:3443"));
assert!(world.iter().any(|a| a == "AC_WORLD_SERVER_PORT=8085"));
+68 -3
View File
@@ -15,10 +15,13 @@
//! ```
mod cli;
pub mod fixture;
pub mod install;
mod lifecycle;
pub use cli::{Call, Docker, Output, SystemDocker};
pub use lifecycle::{observe, observe_with, run, run_with};
pub use lifecycle::{check_docker, observe, observe_with, run, run_with};
pub(crate) use lifecycle::destroy;
use std::net::IpAddr;
use std::path::Path;
@@ -31,7 +34,7 @@ use crate::layout::{self, Classification, ScanReport};
/// Present in a Docker installation, absent from a repack.
pub const MARKER: &str = "Settings/docker.json";
const MYSQL_IMAGE: &str = "mysql:8.4";
pub(crate) const MYSQL_IMAGE: &str = "mysql:8.4";
const RUNTIME_DOCKERFILE: &str = include_str!("Dockerfile.runtime");
pub fn is_docker(root: &Path) -> bool {
@@ -57,6 +60,14 @@ pub struct Config {
pub bind_address: String,
#[serde(default = "mysql_image")]
pub mysql_image: String,
/// Where the game data (dbc, maps, vmaps, mmaps) is, when it is not the `Data` folder of the server. Used in place and
/// mounted read-only, so one copy can serve several servers.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub data_dir: Option<String>,
/// A MySQL data directory the database container uses in place of its volume. Only for the disposable fixture that
/// validates a release (the data directory of the signed base package); an installation never sets it.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub mysql_data: Option<String>,
}
pub(crate) struct Names {
@@ -74,6 +85,11 @@ impl Config {
Ok(cfg)
}
/// The folder mounted as the game data.
pub fn data_path(&self, root: &Path) -> std::path::PathBuf {
self.data_dir.as_deref().map(std::path::PathBuf::from).unwrap_or_else(|| root.join("Data"))
}
fn validate(&self) -> Result<()> {
let name_ok = !self.project.is_empty()
&& self.project.len() <= 32
@@ -85,6 +101,12 @@ impl Config {
if self.bind_address.parse::<IpAddr>().is_err() {
return Err(Error::Invalid(format!("{} is not an IP address.", self.bind_address)));
}
for d in [&self.data_dir, &self.mysql_data].into_iter().flatten() {
// The folder goes into a `--volume host:container` option, where a colon would be read as a separator.
if !Path::new(d).is_absolute() || d.contains(':') {
return Err(Error::Invalid("A Docker folder must be a full path without a colon.".into()));
}
}
let image_ok = !self.mysql_image.is_empty() && self.mysql_image.chars().all(|c| c.is_ascii_alphanumeric() || "._/:@-".contains(c));
if !image_ok {
return Err(Error::Invalid("The database image name is not valid.".into()));
@@ -103,6 +125,21 @@ impl Config {
}
}
/// Create the world and auth configuration files from their `.dist` templates when they do not exist. A package only
/// carries the templates, and on Windows the launcher writes the active files at every start; here nothing else would.
/// An existing file is never touched, so the person's settings survive updates. Returns the files created.
pub fn ensure_main_configs(root: &Path) -> Result<Vec<String>> {
let mut created = Vec::new();
for name in ["worldserver", "authserver"] {
let (conf, dist) = (root.join(format!("Core/configs/{name}.conf")), root.join(format!("Core/configs/{name}.conf.dist")));
if !conf.exists() && dist.is_file() {
std::fs::copy(&dist, &conf)?;
created.push(format!("{name}.conf"));
}
}
Ok(created)
}
/// Name of the runtime image: it follows the content of its Dockerfile, so changing the libraries builds a new image.
pub(crate) fn runtime_image() -> String {
format!("coa-runtime:{}", &fsx::sha256_bytes(RUNTIME_DOCKERFILE.as_bytes())[..12])
@@ -123,7 +160,8 @@ pub(crate) fn scan(root: &Path) -> Result<ScanReport> {
let bot_active = modules_dir.join("mod_coa_playerbots.conf");
let bot_conf = if bot_active.is_file() { bot_active } else { modules_dir.join("mod_coa_playerbots.conf.dist") };
let bot_config_keys = layout::count_bot_keys(&bot_conf);
let has_data = layout::exists(root, "Data/dbc") && layout::exists(root, "Data/maps");
let data = cfg.as_ref().map(|c| c.data_path(root)).unwrap_or_else(|_| root.join("Data"));
let has_data = data.join("dbc").is_dir() && data.join("maps").is_dir();
let has_confs = layout::exists(root, "Core/configs/worldserver.conf") && layout::exists(root, "Core/configs/authserver.conf");
let items = vec![
@@ -162,3 +200,30 @@ pub(crate) fn scan(root: &Path) -> Result<ScanReport> {
})
}
#[cfg(test)]
mod tests {
use super::*;
use std::fs;
#[test]
fn the_main_configs_are_created_from_their_templates_and_never_overwritten() {
let d = tempfile::tempdir().unwrap();
let cfg = d.path().join("Core/configs");
fs::create_dir_all(&cfg).unwrap();
fs::write(cfg.join("worldserver.conf.dist"), "Setting = default\n").unwrap();
fs::write(cfg.join("authserver.conf.dist"), "Auth = default\n").unwrap();
assert_eq!(ensure_main_configs(d.path()).unwrap(), ["worldserver.conf", "authserver.conf"]);
assert_eq!(fs::read_to_string(cfg.join("worldserver.conf")).unwrap(), "Setting = default\n");
// The person's own settings survive the next start.
fs::write(cfg.join("worldserver.conf"), "Setting = mine\n").unwrap();
assert!(ensure_main_configs(d.path()).unwrap().is_empty());
assert_eq!(fs::read_to_string(cfg.join("worldserver.conf")).unwrap(), "Setting = mine\n");
// Without a template there is nothing to create and nothing fails.
fs::remove_file(cfg.join("authserver.conf")).unwrap();
fs::remove_file(cfg.join("authserver.conf.dist")).unwrap();
assert!(ensure_main_configs(d.path()).unwrap().is_empty());
}
}
+43
View File
@@ -136,6 +136,7 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
}
}
}
discard_damaged_launcher_state(&root);
let mut cmd = Command::new(&python);
cmd.arg("-B").arg("-c").arg(LAUNCH_SCRIPT).arg(&script).arg(verb.arg())
.current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped());
@@ -188,10 +189,34 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
}
};
tracing::info!(?verb, ok, ?code, "driver: launcher verb finished");
if !ok && !output.is_empty() {
let redacted = crate::diag::redact(&output);
let tail: Vec<_> = redacted.lines().rev().take(12).collect();
tracing::warn!(?verb, exit_code, output = %tail.into_iter().rev().collect::<Vec<_>>().join("\n"), "driver: launcher verb failed");
}
if ok && verb == Verb::StartAll { crate::multiworld::start(&root)?; }
Ok(DriverOutcome { ok, exit_code, code, human: code.map(ErrorCode::human), output })
}
/// 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__')";
pub(crate) fn patch_launcher_imports(text: &str) -> Result<String> {
@@ -251,6 +276,24 @@ mod tests {
assert_eq!(Verb::StartWorld.timeout(folder.path()), Duration::from_secs(420));
}
#[test]
fn zero_filled_launcher_state_is_discarded_and_valid_state_is_kept() {
let folder = tempfile::tempdir().unwrap();
let state = folder.path().join(".state");
std::fs::create_dir_all(&state).unwrap();
std::fs::write(state.join("mysql.json"), vec![0u8; 116]).unwrap();
std::fs::write(state.join("configuration.json"), Vec::<u8>::new()).unwrap();
std::fs::write(state.join("world.json"), "{\"pid\": 4}\n").unwrap();
std::fs::write(state.join("stop-relay"), Vec::<u8>::new()).unwrap();
std::fs::write(state.join("auth.json"), "{\"pid\": 0}").unwrap();
let mut removed: Vec<_> = discard_damaged_launcher_state(folder.path()).iter().map(|p| p.file_name().unwrap().to_string_lossy().into_owned()).collect();
removed.sort();
assert_eq!(removed, ["configuration.json", "mysql.json"]);
assert!(state.join("world.json").exists() && state.join("auth.json").exists() && state.join("stop-relay").exists());
assert!(discard_damaged_launcher_state(folder.path()).is_empty());
assert!(discard_damaged_launcher_state(&folder.path().join("missing")).is_empty());
}
#[test]
fn translates_known_launcher_messages() {
assert_eq!(translate("RuntimeError: Port 8085 is already used. Stop the other server"), ErrorCode::PortInUse);
+64 -3
View File
@@ -31,11 +31,25 @@ pub struct Settings {
pub mode: Mode,
/// The address friends type into their client for this mode.
pub host: Option<String>,
/// Independent of the effective host of the current mode. None means automatic LAN detection.
#[serde(default)]
pub lan_address_override: Option<String>,
}
impl Default for Settings {
fn default() -> Self {
Settings { mode: Mode::Local, host: None }
Settings { mode: Mode::Local, host: None, lan_address_override: None }
}
}
impl Settings {
/// Only LAN application changes the LAN preference. Other modes keep it for the next LAN session.
pub fn select_mode(&mut self, mode: Mode, host: String, lan_override: Option<String>) {
if mode == Mode::Lan {
self.lan_address_override = lan_override;
}
self.mode = mode;
self.host = Some(host);
}
}
@@ -233,7 +247,7 @@ CoA.AllowRemoteClients = 0
fn a_shared_server_gets_its_bind_address_back_before_start_and_a_local_one_is_left_alone() {
let (_d, root, meta) = setup();
assert!(!ensure_bind(&root, &meta).unwrap(), "local mode: nothing to do");
save(&meta, &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()) }).unwrap();
save(&meta, &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()), ..Settings::default() }).unwrap();
assert!(ensure_bind(&root, &meta).unwrap(), "templates were reset to 127.0.0.1 -> reopened");
assert!(bind_is_open(&root));
assert!(!ensure_bind(&root, &meta).unwrap(), "already open: idempotent");
@@ -243,11 +257,39 @@ CoA.AllowRemoteClients = 0
fn settings_round_trip_and_default_to_local() {
let d = tempfile::tempdir().unwrap();
assert_eq!(load(d.path()).mode, Mode::Local);
save(d.path(), &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()) }).unwrap();
save(d.path(), &Settings { mode: Mode::Private, host: Some("100.64.1.2".into()), ..Settings::default() }).unwrap();
let s = load(d.path());
assert_eq!((s.mode, s.host.as_deref()), (Mode::Private, Some("100.64.1.2")));
}
#[test]
fn old_settings_load_without_migrating_effective_host_to_override() {
let s: Settings = serde_json::from_str(r#"{"mode":"lan","host":"192.168.1.50"}"#).unwrap();
assert_eq!(s.mode, Mode::Lan);
assert_eq!(s.host.as_deref(), Some("192.168.1.50"));
assert_eq!(s.lan_address_override, None);
}
#[test]
fn lan_preference_survives_save_load_and_every_other_mode_and_can_be_cleared() {
let d = tempfile::tempdir().unwrap();
let mut s = Settings::default();
s.select_mode(Mode::Lan, "192.168.1.50".into(), Some("192.168.1.50".into()));
for (mode, host) in [(Mode::Private, "100.101.20.5"), (Mode::Direct, "203.0.113.9"), (Mode::Local, "127.0.0.1")] {
s.select_mode(mode, host.into(), None);
save(d.path(), &s).unwrap();
s = load(d.path());
assert_eq!(s.lan_address_override.as_deref(), Some("192.168.1.50"));
assert_eq!(s.host.as_deref(), Some(host));
let lan = crate::net::resolve_lan_host(s.lan_address_override.as_deref(), Some("192.168.0.169".parse().unwrap())).unwrap();
s.select_mode(Mode::Lan, lan, s.lan_address_override.clone());
assert_eq!(s.host.as_deref(), Some("192.168.1.50"));
}
s.select_mode(Mode::Lan, "192.168.0.169".into(), None);
save(d.path(), &s).unwrap();
assert_eq!(load(d.path()).lan_address_override, None);
}
#[test]
fn friend_package_contains_only_whitelisted_files() {
let (d, root, _m) = setup();
@@ -274,4 +316,23 @@ CoA.AllowRemoteClients = 0
}
assert!(make_friend_package(&root, "bad host; x", false, &d.path().join("x.zip")).is_err());
}
#[test]
fn manual_lan_host_survives_startup_bind_restoration_and_drives_friend_package() {
let (d, root, meta) = setup();
let mut s = Settings::default();
s.select_mode(Mode::Lan, "192.168.1.50".into(), Some("192.168.1.50".into()));
save(&meta, &s).unwrap();
assert!(ensure_bind(&root, &meta).unwrap());
assert!(bind_is_open(&root));
let restored = load(&meta);
assert_eq!(restored.host.as_deref(), Some("192.168.1.50"));
assert_eq!(restored.lan_address_override.as_deref(), Some("192.168.1.50"));
let package = d.path().join("manual-lan.zip");
make_friend_package(&root, restored.host.as_deref().unwrap(), false, &package).unwrap();
let mut zip = zip::ZipArchive::new(fs::File::open(package).unwrap()).unwrap();
let mut realm = String::new();
std::io::Read::read_to_string(&mut zip.by_name("realmlist.wtf").unwrap(), &mut realm).unwrap();
assert_eq!(realm, "set realmlist 192.168.1.50\r\n");
}
}
+27 -13
View File
@@ -35,7 +35,7 @@ pub struct Preflight {
pub free_bytes: u64,
}
fn problem(code: &'static str, message: &str) -> Problem {
pub(crate) fn problem(code: &'static str, message: &str) -> Problem {
Problem { code, message: message.into() }
}
@@ -133,7 +133,7 @@ pub struct Installed {
pub version: String,
}
fn random_hex(n: usize) -> String {
pub(crate) fn random_hex(n: usize) -> String {
let mut s = String::new();
while s.len() < n {
s.push_str(&uuid::Uuid::new_v4().simple().to_string());
@@ -148,7 +148,7 @@ pub(crate) fn bootstrap_database(root: &Path) -> Result<()> {
with_scratch_ports(root, || bootstrap_database_inner(root))
}
fn free_port() -> Result<u16> {
pub(crate) fn free_port() -> Result<u16> {
Ok(std::net::TcpListener::bind("127.0.0.1:0")?.local_addr()?.port())
}
@@ -183,7 +183,7 @@ fn bootstrap_database_inner(root: &Path) -> Result<()> {
let started = driver::run(root, Verb::StartMysql)?;
if !started.ok {
return Err(Error::Invalid(started.human.map(|h| h.message.to_string()).unwrap_or_else(|| "The database could not be started.".into())));
return Err(Error::Invalid(format!("The database could not be started. {}", driver::startup_failure(root, &started))));
}
let result = (|| -> Result<()> {
let db = Db::from_repack(root, Account::Admin)?;
@@ -210,8 +210,14 @@ fn bootstrap_database_inner(root: &Path) -> Result<()> {
}
Ok(())
})();
let _ = driver::run(root, Verb::StopAll);
let stopped = driver::run(root, Verb::StopAll);
result?;
// A database that keeps running locks its files, and the folder could not be moved into place afterwards.
match stopped {
Ok(out) if out.ok => {}
Ok(out) => return Err(Error::Invalid(format!("The database could not be stopped after preparing it. {}", driver::startup_failure(root, &out)))),
Err(e) => return Err(e),
}
fs::remove_file(&boot)?;
Ok(())
}
@@ -250,7 +256,7 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
if staging_root.join(MARKER).is_file() {
fs::remove_dir_all(&staging_root)?; // leftover of an earlier failed attempt that we created
} else {
return Err(Error::Invalid(format!("{} already exists and was not created by the Manager.", staging_root.display())));
return Err(Error::Invalid(format!("{} is left over from an earlier installation that did not finish, and the Manager cannot tell whether it may be deleted. Delete that folder yourself, then try again.", staging_root.display())));
}
}
fs::create_dir_all(&staging_root)?;
@@ -268,9 +274,8 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
}
Ok(())
})?;
fs::remove_file(staging_root.join(MARKER))?;
// 4. Commit: the only moment the destination changes.
// 4. Commit: the only moment the destination changes. The marker stays until everything is done, so an
// unfinished install can always be recognised as ours (and cleaned up), wherever it stopped.
say("Finishing", 95, None);
if dest.exists() {
fs::remove_dir(&dest)?; // only succeeds for an empty folder (preflight verified)
@@ -288,15 +293,24 @@ pub fn install_base(p: &Params, report: &dyn Fn(Step)) -> Result<Installed> {
}
let md = MetaDir::create(&dest, &meta)?;
fsx::atomic_write(&md.root.join("manifests").join("base.json"), &manifest_bytes)?;
// Complete from here on: the marker goes just before the server is listed.
fs::remove_file(dest.join(MARKER))?;
p.registry.register(&meta.id, &dest)?;
say("Ready", 100, None);
Ok(Installed { id: meta.id, path: dest.to_string_lossy().into_owned(), version: m.version.clone() })
})();
if result.is_err() && staging_root.join(MARKER).exists() {
// Unfinished work of ours; the destination was never touched.
let _ = driver::run(&staging_root, Verb::StopAll);
let _ = fs::remove_dir_all(&staging_root);
if result.is_err() {
if staging_root.join(MARKER).exists() {
// Unfinished work of ours; the destination was never touched.
let _ = driver::run(&staging_root, Verb::StopAll);
let _ = fs::remove_dir_all(&staging_root);
} else if dest.join(MARKER).is_file() {
// Failed after the folder was moved into place. The destination was empty or absent before (preflight),
// so what carries our marker is only our unfinished install.
let _ = driver::run(&dest, Verb::StopAll);
let _ = fs::remove_dir_all(&dest);
}
}
result
}
+6
View File
@@ -2,11 +2,14 @@ pub mod accounts;
pub mod backup;
pub mod cleanbase;
pub mod companions;
pub mod custom_races;
pub mod client;
pub mod remote_client;
pub mod clientdl;
pub mod config;
pub mod console;
pub mod crashes;
pub mod dashboard;
pub mod db;
pub mod diag;
pub mod docker;
@@ -30,6 +33,7 @@ pub mod repair;
pub mod schema_check;
pub mod net;
pub mod package;
pub mod platform;
pub mod ra;
pub mod allsettings;
pub mod modules;
@@ -37,8 +41,10 @@ pub mod realmlist;
pub mod realms;
pub mod registry;
pub mod release;
pub mod report;
pub mod release_schema;
pub mod update;
pub mod wine;
pub mod upnp;
pub mod signing;
pub mod srp6;
+29
View File
@@ -154,9 +154,26 @@ fn recorded<'a>(rows: &'a [LedgerRow], m: &Migration) -> Option<&'a LedgerRow> {
rows.iter().rev().find(|r| r.db == m.db && r.id == m.id)
}
/// Migrations that were published with different bytes but have the same effect, so a server that applied either
/// version accepts the other. The Wildcard table repair went out as `c1d8…` (0.261005.0, 0.261006.1) and as `9e4a…`
/// (0.261005.22, 0.261007.24); the packages carry no list of compatible versions, so the Manager knows this pair.
const SAME_EFFECT: &[(&str, &[&str])] = &[(
"manager_repair__20261005_missing_wildcard_tables",
&[
"c1d8dbf2271234283a48a39e4b4aea1106b83b70581f1e3c4aa9fff438e8e4d2",
"9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638",
],
)];
fn same_effect(id: &str, a: &str, b: &str) -> bool {
SAME_EFFECT.iter().any(|(known, hashes)| *known == id
&& hashes.iter().any(|h| h.eq_ignore_ascii_case(a)) && hashes.iter().any(|h| h.eq_ignore_ascii_case(b)))
}
fn hash_changed(row: &LedgerRow, m: &Migration) -> bool {
row.status == Status::Applied && row.sha256 != "0".repeat(64) && !row.sha256.eq_ignore_ascii_case(&m.sha256)
&& !m.compatible_sha256.iter().any(|hash| hash.eq_ignore_ascii_case(&row.sha256))
&& !same_effect(&m.id, &row.sha256, &m.sha256)
}
/// Inspect recorded history without creating a ledger or executing migrations.
@@ -275,6 +292,18 @@ mod tests {
use super::*;
use std::cell::RefCell;
#[test]
fn the_two_published_versions_of_the_wildcard_table_repair_are_interchangeable() {
let (old, new) = ("c1d8dbf2271234283a48a39e4b4aea1106b83b70581f1e3c4aa9fff438e8e4d2", "9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638");
let id = "manager_repair__20261005_missing_wildcard_tables";
let row = |id: &str, sha: &str| LedgerRow { db: "characters".into(), id: id.into(), sha256: sha.into(), status: Status::Applied, error: None, baseline: false };
let migration = |id: &str, sha: &str| Migration { compatible_sha256: vec![], id: id.into(), db: "characters".into(), sha256: sha.into(), destructive: false };
assert!(!hash_changed(&row(id, old), &migration(id, new)), "applied as c1d8, offered as 9e4a");
assert!(!hash_changed(&row(id, new), &migration(id, old)), "applied as 9e4a, offered as c1d8");
assert!(hash_changed(&row(id, &"a".repeat(64)), &migration(id, new)), "an unknown version is still a change");
assert!(hash_changed(&row("other_migration", old), &migration("other_migration", new)), "only the known pair is exempt");
}
#[derive(Default)]
struct Mem {
rows: RefCell<Vec<LedgerRow>>,
+12
View File
@@ -203,6 +203,18 @@ pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
Some(lock)
} else { None };
if on { crate::realms::guard_module(root, id)?; }
if id == "custom-races" {
if let Ok(meta_content) = fs::read_to_string(meta.join("install.json")) {
if let Ok(install_meta) = serde_json::from_str::<crate::registry::InstallMeta>(&meta_content) {
if let Some(cp) = install_meta.client_path {
let client_path = PathBuf::from(cp);
if client_path.is_dir() {
crate::custom_races::set_client_patch_enabled(&client_path, on)?;
}
}
}
}
}
set_enabled_in(&catalog(), root, meta, id, on)
}
+81
View File
@@ -19,6 +19,51 @@ pub fn lan_ip() -> Option<Ipv4Addr> {
}
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
pub struct LanAddress {
pub interface: String,
pub address: String,
pub is_default: bool,
}
/// Suitable unicast IPv4 addresses; shared carrier/Tailscale space belongs to Private mode.
pub fn is_lan_address(ip: Ipv4Addr) -> bool {
!ip.is_unspecified() && !ip.is_loopback() && !ip.is_link_local()
&& !ip.is_multicast() && !ip.is_broadcast() && ip.octets()[0] != 0
&& ip.octets()[0] < 240 && !is_cgnat_range(ip)
}
pub fn validate_lan_address(address: &str) -> Result<Ipv4Addr> {
address.parse::<Ipv4Addr>().ok().filter(|ip| is_lan_address(*ip))
.ok_or_else(|| Error::Invalid("Invalid IPv4 address for local network.".into()))
}
/// An absent/disconnected manual address is intentional: never fall back to another adapter.
pub fn resolve_lan_host(manual: Option<&str>, automatic: Option<Ipv4Addr>) -> Result<String> {
match manual {
Some(address) => validate_lan_address(address).map(|ip| ip.to_string()),
None => automatic.filter(|ip| is_lan_address(*ip)).map(|ip| ip.to_string())
.ok_or_else(|| Error::Invalid("This computer has no usable local network address.".into())),
}
}
fn lan_candidates(rows: impl IntoIterator<Item = (String, Ipv4Addr)>, automatic: Option<Ipv4Addr>) -> Vec<LanAddress> {
let mut rows: Vec<_> = rows.into_iter().filter(|(_, ip)| is_lan_address(*ip)).collect();
rows.sort_by(|a, b| a.0.cmp(&b.0).then(a.1.cmp(&b.1)));
let mut seen = std::collections::HashSet::new();
rows.into_iter().filter(|(_, ip)| seen.insert(*ip)).map(|(interface, ip)| LanAddress {
interface, address: ip.to_string(), is_default: Some(ip) == automatic,
}).collect()
}
/// Native OS enumeration (GetAdaptersAddresses on Windows, getifaddrs on Unix).
pub fn lan_addresses(automatic: Option<Ipv4Addr>) -> Result<Vec<LanAddress>> {
let interfaces = if_addrs::get_if_addrs()?;
Ok(lan_candidates(interfaces.into_iter().filter(|i| i.is_oper_up()).filter_map(|i| {
match i.ip() { IpAddr::V4(ip) => Some((i.name, ip)), _ => None }
}), automatic))
}
pub fn is_private(ip: Ipv4Addr) -> bool {
ip.is_private() || ip.is_loopback() || ip.is_link_local()
}
@@ -132,6 +177,42 @@ mod tests {
s.parse().unwrap()
}
#[test]
fn lan_validation_and_resolution_never_replace_manual_addresses() {
for good in ["192.168.1.20", "10.0.0.5", "172.16.2.4"] {
assert!(validate_lan_address(good).is_ok());
}
for bad in ["abc", "999.1.1.1", "0.0.0.0", "0.1.2.3", "127.0.0.1", "127.9.1.2", "169.254.10.20", "100.101.20.5", "224.0.0.1", "255.255.255.255", "240.0.0.1", "192.168.1.1'; DROP TABLE realmlist"] {
assert!(validate_lan_address(bad).is_err(), "{bad}");
}
let automatic = Some(ip("192.168.0.169"));
assert_eq!(resolve_lan_host(None, automatic).unwrap(), "192.168.0.169");
assert_eq!(resolve_lan_host(Some("192.168.1.50"), automatic).unwrap(), "192.168.1.50");
assert_eq!(resolve_lan_host(Some("192.168.1.50"), None).unwrap(), "192.168.1.50");
assert!(resolve_lan_host(Some("invalid"), automatic).is_err());
assert!(resolve_lan_host(None, None).is_err());
assert!(resolve_lan_host(None, Some(ip("169.254.1.2"))).is_err());
assert!(resolve_lan_host(None, Some(ip("100.100.1.2"))).is_err());
}
#[test]
fn candidates_are_filtered_deduplicated_deterministic_and_default_marked() {
let rows = vec![
("Wi-Fi", "192.168.0.25"), ("Ethernet 2", "192.168.1.50"),
("Ethernet", "192.168.0.169"), ("Duplicate", "192.168.1.50"),
("Loopback", "127.0.0.2"), ("APIPA", "169.254.1.2"),
("Tailscale", "100.101.20.5"), ("Empty", "0.0.0.0"),
("Hyper-V Virtual", "10.0.0.5"),
];
let make = |rows: Vec<(&str, &str)>| lan_candidates(rows.into_iter().map(|(name, address)| (name.into(), ip(address))), Some(ip("192.168.0.169")));
let result = make(rows.clone());
assert_eq!(result.len(), 4);
assert_eq!(result.iter().filter(|a| a.is_default).count(), 1);
assert!(result.iter().any(|a| a.interface == "Hyper-V Virtual"));
assert!(result.iter().any(|a| a.is_default && a.address == "192.168.0.169"));
assert_eq!(result, make(rows.into_iter().rev().collect()));
}
#[test]
fn address_classes() {
assert!(is_private(ip("192.168.1.5")) && is_private(ip("10.0.0.2")) && is_private(ip("172.16.4.4")) && is_private(ip("127.0.0.1")));
+6
View File
@@ -21,6 +21,12 @@ pub const DEFAULT_PART_SIZE: u64 = 1_900_000_000;
/// Archive path of the one-time database credentials shipped with a base package.
pub const BOOTSTRAP_CREDENTIALS: &str = "Settings/database.bootstrap.json";
/// Folder of a Linux (Docker) package that holds the starting databases: `<kind>.sql.zst` for `auth`, `characters`
/// and `world`, in the format of the Manager's own backups. They hold the state in which every migration of the package is
/// already applied (a world database cannot be rebuilt from the repository's SQL files: some migrations are guarded and
/// only apply to the maintainers' own database).
pub const BASELINE_DIR: &str = "Database/baseline";
/// Files that never belong in a shipped package: per-install state, logs, secrets, old binaries.
pub fn excluded(rel: &str) -> bool {
if rel.replace('\\', "/").to_lowercase().starts_with(".realms/") { return true; }
+41
View File
@@ -0,0 +1,41 @@
//! Which kind of server a new installation is on this computer. This is the one place where the host decides: a Windows
//! computer installs a repack, anything else installs a Docker server. The screens and the commands ask here and then
//! call the code of that kind, so no platform check is scattered through shared code.
use serde::Serialize;
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "kebab-case")]
pub enum Flavor {
/// The CoA Repack: Windows executables supervised by the repack's launcher.
Repack,
/// MySQL, the auth server and the world server in Docker containers.
Docker,
}
pub fn flavor() -> Flavor {
if cfg!(windows) {
Flavor::Repack
} else {
Flavor::Docker
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_host_decides_once() {
#[cfg(windows)]
assert_eq!(flavor(), Flavor::Repack);
#[cfg(not(windows))]
assert_eq!(flavor(), Flavor::Docker);
}
#[test]
fn the_screens_read_the_flavor_as_a_plain_word() {
assert_eq!(serde_json::to_string(&Flavor::Repack).unwrap(), "\"repack\"");
assert_eq!(serde_json::to_string(&Flavor::Docker).unwrap(), "\"docker\"");
}
}
+28 -3
View File
@@ -250,6 +250,19 @@ pub fn is_alive(record: &ProcessIdentity) -> bool {
identity(record.pid).map(|cur| cur.same_as(record)).unwrap_or(false)
}
/// Every running process whose image file is named one of `names` (compared without case), wherever it lives. Only for
/// diagnostics: a process found this way is not trusted to belong to any installation.
pub fn find_by_file_names(names: &[&str]) -> Vec<ProcessIdentity> {
sys::all_pids()
.into_iter()
.filter_map(identity)
.filter(|p| {
let file = p.exe.rsplit(['\\', '/']).next().unwrap_or("");
names.iter().any(|n| file.eq_ignore_ascii_case(n))
})
.collect()
}
/// Every running process whose image is exactly `exe`.
pub fn find_by_exe(exe: &Path) -> Vec<ProcessIdentity> {
let want = exe.to_string_lossy().to_lowercase().replace('/', "\\");
@@ -265,12 +278,24 @@ fn uptime_secs(p: &ProcessIdentity) -> Option<u64> {
(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 {
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.
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)
.filter(is_alive)
.filter(|r| r.exe.eq_ignore_ascii_case(&exe.to_string_lossy().replace('/', "\\")))
.or_else(|| find_by_exe(&exe).into_iter().next());
.filter(|r| expected.iter().any(|e| r.exe.eq_ignore_ascii_case(e)))
.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 (state, port_ready, conflict) = match (&proc, owner) {
@@ -306,7 +331,7 @@ pub fn observe(root: &Path, ports: &Ports) -> Observed {
Observed {
mysql: service(root, "mysql", mysql, ports.mysql, &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,
}
}
+34 -1
View File
@@ -65,10 +65,16 @@ pub fn state(root: &Path) -> Result<RealmState> {
fsx::read_json(&root.join(STATE))
}
/// The world server executable of this folder: `worldserver.exe` in a repack, `worldserver` in a Docker server.
fn world_binary(root: &Path) -> std::path::PathBuf {
let exe = root.join("Core/worldserver.exe");
if exe.exists() { exe } else { root.join("Core/worldserver") }
}
pub fn view(root: &Path) -> Result<View> {
let s = state(root)?;
// Inspect the binary itself; templates or an old log cannot prove installed support.
let supported = fs::read(root.join("Core/worldserver.exe"))?
let supported = fs::read(world_binary(root))?
.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings");
Ok(View { active: s.active, wildcard_created: s.wildcard_created, supported, recovery_pending: root.join(JOURNAL).exists(), simultaneous: s.simultaneous, secondary_world_port: s.secondary_world_port, secondary_running: crate::multiworld::is_running(root) })
}
@@ -269,6 +275,8 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
pub fn prepare_launcher(root: &Path) -> Result<()> {
// A Docker server has no launcher to adapt: the Docker backend reads the active realm itself.
if crate::docker::is_docker(root) { return Ok(()); }
let path = root.join("Scripts/manage.py");
let source = fs::read_to_string(&path)?;
let patched = patch_launcher(&source)?;
@@ -353,6 +361,31 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
mod tests {
use super::*;
#[test]
fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Core")).unwrap();
fs::create_dir_all(d.path().join("Settings")).unwrap();
fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
fs::write(d.path().join("Core/worldserver"), b"ELF...Wildcard synergy settings...").unwrap();
assert!(view(d.path()).unwrap().supported, "worldserver without .exe is read too");
fs::write(d.path().join("Core/worldserver"), b"ELF...an older build").unwrap();
assert!(!view(d.path()).unwrap().supported);
// The repack's executable still wins when both exist, so a repack is read as before.
fs::write(d.path().join("Core/worldserver.exe"), b"MZ...Wildcard synergy settings").unwrap();
assert!(view(d.path()).unwrap().supported);
}
#[test]
fn a_docker_server_has_no_launcher_to_adapt() {
let d = tempfile::tempdir().unwrap();
fs::create_dir_all(d.path().join("Settings")).unwrap();
// No Scripts/manage.py anywhere: on a repack this fails, on a Docker server there is nothing to do.
assert!(prepare_launcher(d.path()).is_err());
fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
prepare_launcher(d.path()).unwrap();
}
#[test]
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
let mut f = Files::new();
+1
View File
@@ -14,6 +14,7 @@ use crate::fsx;
pub const META_SCHEMA: u32 = 1;
pub const LAYOUT_REPACK_V1: &str = "repack-v1";
pub const LAYOUT_DOCKER_V1: &str = "docker-v1";
const META_SUBDIRS: [&str; 6] = ["manifests", "backups", "migrations", "logs", "cache", "staging"];
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
+15
View File
@@ -87,6 +87,21 @@ pub fn collect_core_sql(core: &Path) -> Result<Vec<SqlFile>> {
Ok(out)
}
/// Dump the three game databases of `server` (a repack or a Docker server, started if needed) into `out` as the starting
/// databases of a Linux package: `<kind>.sql.zst`. The databases must be in the state in which every migration of the
/// package is applied. Returns (kind, compressed bytes) per database.
pub fn export_baseline(server: &Path, out: &Path) -> Result<Vec<(String, u64)>> {
fs::create_dir_all(out)?;
crate::backup::with_database(server, |db| {
let mut done = Vec::new();
for (kind, schema) in crate::db::SCHEMAS {
let (bytes, _) = db.dump_to(schema, &out.join(format!("{kind}.sql.zst")))?;
done.push((kind.to_string(), bytes));
}
Ok(done)
})
}
/// SQL a bots module checkout ships for the characters database (its `dist/sql`).
pub fn collect_bots_sql(bots: &Path) -> Result<Vec<SqlFile>> {
let mut out = Vec::new();
+6 -1
View File
@@ -38,7 +38,12 @@ pub fn extract_base(source: &Path, fixture: &Path, trusted_key: &str) -> Result<
["mysql/", "settings/", "runtime/", "scripts/", "core/", "bugreport/"].iter().any(|prefix| path.starts_with(prefix))
}, &|_, _| {})?;
fsx::atomic_write(&fixture.join(MARKER), b"disposable release-schema fixture")?;
install::bootstrap_database(fixture)
// A Linux computer has no Windows database program: the fixture is a Docker server over the package's data directory.
if cfg!(windows) {
install::bootstrap_database(fixture)
} else {
crate::docker::fixture::prepare(fixture)
}
}
pub fn capture_release(fixture: &Path, tree: &Path, sql: &[SqlFile]) -> Result<()> {
+116
View File
@@ -0,0 +1,116 @@
//! Where a problem report goes. A report about the bots goes to the repository of the bot system in question, anything
//! else to the Manager's own. The repositories come from the module catalog, so there is one list to keep right.
use std::path::Path;
use serde::Serialize;
pub const MANAGER_REPO: &str = "Corfirean/coa-server-manager";
/// One place a report can be filed. `id` is what the page sends back; `repo` is `owner/name` on GitHub.
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
pub struct Target {
pub id: &'static str,
pub repo: String,
/// The report form asks for the Manager's labels only where we own the repository.
pub ours: bool,
}
/// `https://github.com/owner/name/tree/main/x` -> `owner/name`.
fn repo_of(url: &str) -> Option<String> {
let rest = url.strip_prefix("https://github.com/")?;
let mut parts = rest.split('/');
let (owner, name) = (parts.next()?, parts.next()?);
let ok = |s: &str| !s.is_empty() && s.chars().all(|c| c.is_ascii_alphanumeric() || "._-".contains(c));
(ok(owner) && ok(name)).then(|| format!("{owner}/{name}"))
}
fn catalog_repo(id: &str) -> Option<String> {
crate::modules::catalog().into_iter().find(|e| e.id == id).and_then(|e| repo_of(&e.repo))
}
/// The three places, in the order the page lists them. A bot system whose repository is unknown falls back to the Manager's.
pub fn targets() -> Vec<Target> {
let mut v = vec![Target { id: "manager", repo: MANAGER_REPO.into(), ours: true }];
for (id, module) in [("companions", "companions"), ("squid", "playerbots")] {
if let Some(repo) = catalog_repo(module) {
v.push(Target { id, repo: repo.clone(), ours: repo.starts_with("Corfirean/") });
}
}
v
}
pub fn target(id: &str) -> Option<Target> {
targets().into_iter().find(|t| t.id == id)
}
/// True for the "new issue" page of one of the targets: exactly that page, optionally with a query.
pub fn is_new_issue_url(url: &str) -> bool {
targets().iter().any(|t| {
let base = format!("https://github.com/{}/issues/new", t.repo);
url == base || url.starts_with(&format!("{base}?"))
})
}
/// What the report form fills in about the bot systems of this server.
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
pub struct Bots {
/// The target the form should start with: the bot system that is switched on, else the Manager.
pub suggested: &'static str,
/// The release of SQUID Playerbots, when it is the one switched on.
pub squid_version: Option<String>,
}
pub fn bots(root: &Path) -> Bots {
let list = crate::modules::list(root);
let on = |id: &str| list.iter().find(|m| m.id == id).filter(|m| m.installed && m.enabled);
let squid = on("playerbots");
Bots {
suggested: if squid.is_some() { "squid" } else if on("companions").is_some() { "companions" } else { "manager" },
squid_version: squid.and_then(|m| m.version.clone()).filter(|v| !v.is_empty()),
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_three_targets_come_from_the_catalog() {
let t = targets();
let repo = |id: &str| t.iter().find(|x| x.id == id).map(|x| x.repo.clone());
assert_eq!(repo("manager").as_deref(), Some("Corfirean/coa-server-manager"));
assert_eq!(repo("companions").as_deref(), Some("Corfirean/mod-coa-playerbots"));
assert_eq!(repo("squid").as_deref(), Some("Zyth45/mod-playerbots"));
assert!(t.iter().find(|x| x.id == "squid").is_some_and(|x| !x.ours));
}
#[test]
fn repository_names_are_read_from_module_links() {
assert_eq!(repo_of("https://github.com/Corfirean/azerothcore-wotlk-coa/tree/coa-bots/modules/x").as_deref(), Some("Corfirean/azerothcore-wotlk-coa"));
assert_eq!(repo_of("https://github.com/Zyth45/mod-playerbots").as_deref(), Some("Zyth45/mod-playerbots"));
assert_eq!(repo_of("https://example.com/a/b"), None);
assert_eq!(repo_of("https://github.com/a"), None);
}
#[test]
fn only_the_new_issue_pages_of_the_targets_are_allowed() {
assert!(is_new_issue_url("https://github.com/Zyth45/mod-playerbots/issues/new"));
assert!(is_new_issue_url("https://github.com/Corfirean/mod-coa-playerbots/issues/new?title=a&body=b"));
assert!(!is_new_issue_url("https://github.com/Zyth45/mod-playerbots/issues/newer"));
assert!(!is_new_issue_url("https://github.com/Zyth45/other/issues/new"));
assert!(!is_new_issue_url("https://evil.example/Corfirean/coa-server-manager/issues/new"));
}
#[test]
fn the_suggested_target_follows_the_bot_system_that_is_on() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
crate::layout::testkit::fake_repack(&root);
let conf = root.join("Core/configs/modules");
std::fs::write(conf.join("mod_coa_playerbots.conf"), "CoaBots.Enable = 1\n").unwrap();
assert_eq!(bots(&root).suggested, "companions");
std::fs::write(conf.join("mod_coa_playerbots.conf"), "CoaBots.Enable = 0\n").unwrap();
assert_eq!(bots(&root).suggested, "manager");
}
}
+33 -1
View File
@@ -44,6 +44,15 @@ pub struct Field {
pub default_if_missing: Option<serde_json::Value>,
pub min: 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)]
@@ -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)
|| !default_type(&field.kind, &field.default)
|| 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.insert(field.key.clone(), field);
}
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 {
match kind {
"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)),
"string" => true,
_ => 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))) }
}
#[cfg(test)]
mod tests {
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]
fn upstream_settings_preserve_types_ranges_and_distinct_defaults() {
let root = tempfile::tempdir().unwrap();
+95 -7
View File
@@ -197,8 +197,15 @@ pub struct PlanItem {
/// 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>> {
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)) {
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 recorded = meta.original_hashes.get(&f.path);
let (action, reason) = match (f.policy, &cur) {
@@ -259,10 +266,39 @@ pub struct Preview {
pub migrations: usize,
pub pending_migrations: usize,
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.
pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>) -> Result<Preview> {
preview_with(root, meta, source, trusted_key, resolutions, DatabaseAccess::Start)
}
pub fn preview_with(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>, access: DatabaseAccess) -> Result<Preview> {
refuse_for_docker(root)?;
let meta_dir = crate::registry::metadata_dir_for(root)?;
let _lock = operation_lock(&meta_dir)?;
ensure_recovered(&meta_dir)?;
@@ -277,7 +313,16 @@ pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &s
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 {
from_version: meta.core.version.clone(),
to_version: m.version.clone(),
@@ -286,6 +331,8 @@ pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &s
migrations: m.migrations.len(),
pending_migrations,
download_bytes: m.archive.as_ref().map(|a| a.parts.iter().map(|p| p.size).sum()).unwrap_or(0),
database_checked,
database_check_error,
})
}
@@ -359,6 +406,7 @@ fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) {
/// Run the whole update. On failure before the new build is validated the files are rolled back automatically;
/// a build that is applied but unhealthy is left in `NeedsDecision` so the owner chooses.
pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
refuse_for_docker(p.root)?;
let (root, meta_dir) = (p.root, p.meta_dir);
let _lock = operation_lock(meta_dir)?;
ensure_recovered(meta_dir)?;
@@ -422,7 +470,7 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
p.env.ensure_stopped()?;
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}")))?);
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)?); }
txn.ops = items
@@ -455,9 +503,13 @@ pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result<Outcome> {
Ok(r) if r.failed.is_none() => migrated = Some(r),
Ok(r) => {
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));
}
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);
}
}
}
@@ -565,7 +617,7 @@ fn restore_transaction(root: &Path, meta: &Path, before: &Path, txn: &mut Txn, e
for (rel, expected) in &txn.recovery_hashes {
let saved = match rel.as_str() {
"@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)?,
};
if fsx::sha256_file(&saved)? != *expected { return Err(Error::Invalid(format!("Recovery copy {rel} is damaged; no restoration was started."))); }
@@ -659,6 +711,7 @@ fn restore_files(root: &Path, before: &Path, txn: &mut Txn) -> Result<()> {
/// Restore the database recovery point first, then restore binaries and configuration.
pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result<Txn> {
refuse_for_docker(root)?;
let _lock = operation_lock(meta_dir)?;
let mut txn = load(meta_dir, id)?;
if matches!(txn.state, State::Committed | State::RolledBack) {
@@ -735,8 +788,13 @@ pub struct RepackEnv<'a> {
impl RepackEnv<'_> {
pub fn pending_migrations(&self, manifest: &Manifest) -> Result<usize> {
if manifest.migrations.is_empty() { return Ok(0); }
crate::backup::with_database(self.root, |db| {
Ok(self.pending_migrations_with(manifest, DatabaseAccess::Start)?.unwrap_or(0))
}
/// `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 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 }); }
@@ -746,7 +804,11 @@ impl RepackEnv<'_> {
count += crate::migrations::pending_count(&db.clone().for_realm(mode), &list)?;
}
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<()> {
if point.kind != crate::backup::Kind::Full || !["characters", "auth", "world", "configs"].iter().all(|name| point.components.iter().any(|c| c.name == *name)) {
@@ -1092,6 +1154,27 @@ mod tests {
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
}
#[test]
fn a_docker_server_is_never_given_the_repack_files() {
// Found by trying the installer: the update check of a Docker server read the Windows channel and offered its files.
let w = world(&[], false);
write(&w.root, "Settings/docker.json", br#"{"project":"t1"}"#);
let before = read(&w, "Core/worldserver.exe");
let meta = InstallMeta::new(InstallKind::New, &w.root);
let err = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap_err();
assert!(err.to_string().contains("Docker"), "{err}");
let err = run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err();
assert!(err.to_string().contains("Docker"), "{err}");
assert!(rollback(&w.root, &w.meta, "any", &Fake::ok()).is_err());
assert_eq!(read(&w, "Core/worldserver.exe"), before, "nothing was touched");
assert!(!w.root.join("Core/newfile.dll").exists());
// The same package is applied to the same folder once it is not a Docker server.
fs::remove_file(w.root.join("Settings/docker.json")).unwrap();
assert_eq!(run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap().txn.state, State::Committed);
}
#[test]
fn happy_path_replaces_creates_merges_and_records_ownership() {
let w = world(&[], false);
@@ -1131,6 +1214,11 @@ mod tests {
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());
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();
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());
+393
View File
@@ -0,0 +1,393 @@
//! Starting the game client on Linux. The client is a Windows program, so it runs under umu-launcher with a Proton build
//! (what the project's own guide uses), or under plain Wine when umu is not installed. This is the Linux counterpart of
//! starting `Ascension.exe` directly; `client::launch` hands over to it on a Linux host and Windows never comes here.
//!
//! The settings are found on their own and can all be overridden, from strongest to weakest: the environment
//! (`COA_PROTONPATH`, `COA_WINEPREFIX`), then `client-launch.json` in the Manager's folder, then what is installed.
use std::fs::{self, OpenOptions};
use std::io::Write;
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use serde::Deserialize;
use crate::error::{Error, Result};
/// Prefix used when nothing else is said: the folder umu-launcher itself suggests for a game.
const DEFAULT_PREFIX: &str = "Games/umu/coa-client";
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Runner {
/// umu-launcher runs the game with a Proton build. `proton` is `None` when umu should pick and download one itself.
Umu { program: PathBuf, proton: Option<PathBuf> },
Wine { program: PathBuf },
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Launcher {
pub runner: Runner,
pub prefix: PathBuf,
}
/// What to run, in a form that can be checked without running anything.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Plan {
pub program: PathBuf,
pub args: Vec<String>,
pub env: Vec<(String, String)>,
pub cwd: PathBuf,
}
/// `client-launch.json`: every key is optional.
#[derive(Debug, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Overrides {
pub proton_path: Option<String>,
pub prefix: Option<String>,
/// "umu" or "wine": use this one even if the other is installed.
pub runner: Option<String>,
}
/// Everything detection looks at, so it can be tested without a real computer.
pub struct Host<'a> {
pub var: &'a dyn Fn(&str) -> Option<String>,
pub which: &'a dyn Fn(&str) -> Option<PathBuf>,
/// Names of the entries of a folder (empty when it does not exist).
pub list: &'a dyn Fn(&Path) -> Vec<String>,
pub is_file: &'a dyn Fn(&Path) -> bool,
}
fn proton_folders(home: &Path) -> Vec<PathBuf> {
vec![
home.join(".local/share/Steam/compatibilitytools.d"),
home.join(".steam/root/compatibilitytools.d"),
home.join(".steam/steam/compatibilitytools.d"),
home.join(".var/app/com.valvesoftware.Steam/.local/share/Steam/compatibilitytools.d"),
PathBuf::from("/usr/share/steam/compatibilitytools.d"),
]
}
/// Numbers of a name in order, so that GE-Proton10-9 sorts before GE-Proton10-34.
fn version_key(name: &str) -> Vec<u64> {
let mut out = Vec::new();
let mut cur = String::new();
for c in name.chars().chain(std::iter::once(' ')) {
if c.is_ascii_digit() {
cur.push(c);
} else if !cur.is_empty() {
out.push(cur.parse().unwrap_or(0));
cur.clear();
}
}
out
}
/// The newest GE-Proton build installed for Steam, if any. A folder only counts when it holds the `proton` script.
fn newest_proton(host: &Host, home: &Path) -> Option<PathBuf> {
proton_folders(home)
.into_iter()
.flat_map(|dir| (host.list)(&dir).into_iter().filter(|n| n.starts_with("GE-Proton")).map(move |n| (n.clone(), dir.join(n))))
.filter(|(_, path)| (host.is_file)(&path.join("proton")))
.max_by_key(|(name, _)| version_key(name))
.map(|(_, path)| path)
}
pub fn detect_with(host: &Host, overrides: &Overrides) -> Result<Launcher> {
let home = (host.var)("HOME").map(PathBuf::from).ok_or_else(|| Error::Invalid("The home folder of this user is not known.".into()))?;
let prefix = (host.var)("COA_WINEPREFIX").or_else(|| overrides.prefix.clone()).map(PathBuf::from).unwrap_or_else(|| home.join(DEFAULT_PREFIX));
let proton = (host.var)("COA_PROTONPATH").or_else(|| overrides.proton_path.clone()).map(PathBuf::from).or_else(|| newest_proton(host, &home));
let (umu, wine) = ((host.which)("umu-run"), (host.which)("wine"));
let runner = match (overrides.runner.as_deref(), umu, wine) {
(Some("wine"), _, Some(program)) => Runner::Wine { program },
(Some("umu"), Some(program), _) | (None, Some(program), _) => Runner::Umu { program, proton },
(_, None, Some(program)) => Runner::Wine { program },
_ => {
return Err(Error::Invalid(
"To play on Linux the game client needs umu-launcher (with a Proton build such as GE-Proton) or Wine. Install one of them and press Play again.".into(),
))
}
};
Ok(Launcher { runner, prefix })
}
/// The command line that starts `exe` from the client folder.
pub fn plan(launcher: &Launcher, client: &Path, exe: &str) -> Plan {
let mut env = vec![("WINEPREFIX".to_string(), launcher.prefix.to_string_lossy().into_owned())];
// DivxTac.dll is a mixed-mode .NET assembly: loaded through wine-mono it deadlocks the client on the world loading screen
// (100%). Disabling it has the same effect as removing the file.
env.push(("WINEDLLOVERRIDES".into(), "divxtac=d".into()));
let program = match &launcher.runner {
Runner::Umu { program, proton } => {
env.push(("GAMEID".into(), "0".into()));
if let Some(p) = proton {
env.push(("PROTONPATH".into(), p.to_string_lossy().into_owned()));
}
program.clone()
}
Runner::Wine { program } => program.clone(),
};
// The client reads Data/ relative to the working directory.
Plan { program, args: vec![exe.to_string()], env, cwd: client.to_path_buf() }
}
fn system_var(k: &str) -> Option<String> {
std::env::var(k).ok().filter(|v| !v.trim().is_empty())
}
fn find_on_path(program: &str) -> Option<PathBuf> {
std::env::split_paths(&std::env::var_os("PATH")?).map(|d| d.join(program)).find(|p| p.is_file())
}
fn list_names(dir: &Path) -> Vec<String> {
fs::read_dir(dir).map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| e.file_name().into_string().ok()).collect()).unwrap_or_default()
}
fn data_home() -> Option<PathBuf> {
system_var("XDG_DATA_HOME").map(PathBuf::from).filter(|p| p.is_absolute()).or_else(|| system_var("HOME").map(|h| PathBuf::from(h).join(".local/share")))
}
fn overrides_file() -> Option<PathBuf> {
data_home().map(|d| d.join("CoAServerManager/client-launch.json"))
}
pub fn detect() -> Result<Launcher> {
let overrides: Overrides = overrides_file().and_then(|p| crate::fsx::read_json(&p).ok()).unwrap_or_default();
detect_with(&Host { var: &system_var, which: &find_on_path, list: &list_names, is_file: &|p| p.is_file() }, &overrides)
}
/// Where what the client prints goes: the Manager's own log folder.
pub fn log_path() -> Option<PathBuf> {
data_home().map(|d| d.join("CoAServerManager/logs/client.log"))
}
/// Start the client and return at once; it keeps running when the Manager closes. Returns the process id.
pub fn launch(client: &Path, exe: &str) -> Result<u32> {
let launcher = detect()?;
let plan = plan(&launcher, client, exe);
let log = match log_path() {
Some(p) => {
if let Some(dir) = p.parent() {
fs::create_dir_all(dir)?;
}
let mut f = OpenOptions::new().create(true).append(true).open(&p)?;
writeln!(f, "=== {} {:?} in {}", plan.program.display(), plan.args, plan.cwd.display())?;
for (k, v) in &plan.env {
writeln!(f, " {k}={v}")?;
}
Some(f)
}
None => None,
};
let mut cmd = Command::new(&plan.program);
cmd.args(&plan.args).current_dir(&plan.cwd).envs(plan.env.iter().map(|(k, v)| (k, v))).stdin(Stdio::null());
match log {
Some(f) => {
cmd.stderr(f.try_clone()?).stdout(f);
}
None => {
cmd.stdout(Stdio::null()).stderr(Stdio::null());
}
}
#[cfg(unix)]
{
use std::os::unix::process::CommandExt;
cmd.process_group(0); // its own group: closing the Manager does not take the game with it
}
let mut child = cmd.spawn().map_err(|e| Error::Invalid(format!("The game client could not be started ({}): {e}", plan.program.display())))?;
let pid = child.id();
std::thread::spawn(move || {
let _ = child.wait(); // reap it when the game closes
});
Ok(pid)
}
/// Is a process running this client? Under Wine its command line carries the Windows form of the path
/// (`Z:\home\you\client\Ascension.exe`), which is the only trace of it that names the folder.
pub fn command_line_runs(cmdline: &str, client: &Path, exe: &str) -> bool {
let wanted = format!("{}/{}", client.to_string_lossy().trim_end_matches('/'), exe).to_lowercase();
cmdline.replace('\0', " ").replace('\\', "/").to_lowercase().contains(&wanted)
}
/// The folder as it was given and as the system resolves it. On an immutable distribution (SteamOS, Bazzite) `/home` is a
/// link to `/var/home`: Wine writes the path it was given, the resolved one differs, and either may be what the command
/// line of the running client holds.
fn spellings(client: &Path) -> Vec<PathBuf> {
let mut all = vec![client.to_path_buf()];
if let Ok(real) = fs::canonicalize(client) {
if real != client {
all.push(real);
}
}
all
}
pub fn is_running(client: &Path, exes: &[&str]) -> bool {
let folders = spellings(client);
let Ok(rd) = fs::read_dir("/proc") else { return false };
rd.filter_map(|e| e.ok())
.filter(|e| e.file_name().to_string_lossy().bytes().all(|b| b.is_ascii_digit()))
.filter_map(|e| fs::read(e.path().join("cmdline")).ok())
.any(|raw| {
let line = String::from_utf8_lossy(&raw);
folders.iter().any(|folder| exes.iter().any(|exe| command_line_runs(&line, folder, exe)))
})
}
// Linux only: the folders are written as Linux path strings.
#[cfg(all(test, unix))]
mod tests {
use super::*;
use std::collections::{BTreeMap, BTreeSet};
#[test]
fn a_client_folder_behind_a_link_is_looked_for_under_both_names() {
// SteamOS and Bazzite: /home is a link to /var/home.
let dir = tempfile::tempdir().unwrap();
fs::create_dir_all(dir.path().join("var/home/u/client")).unwrap();
std::os::unix::fs::symlink("var/home", dir.path().join("home")).unwrap();
let given = dir.path().join("home/u/client");
let both = spellings(&given);
assert_eq!(both.len(), 2);
assert_eq!(both[0], given);
assert!(both[1].starts_with(dir.path().canonicalize().unwrap().join("var/home")));
// Wine kept the name it was given, so the line holds the first one and not the resolved one.
let line = format!("Z:\\{}\\Ascension.exe", given.to_string_lossy().replace('/', "\\"));
assert!(!command_line_runs(&line, &both[1], "Ascension.exe"));
assert!(both.iter().any(|f| command_line_runs(&line, f, "Ascension.exe")));
}
/// A computer described in a few lines: variables, programs on the path, folders with their entries, and `proton` scripts.
struct Fake {
vars: BTreeMap<&'static str, &'static str>,
programs: BTreeSet<&'static str>,
folders: BTreeMap<&'static str, Vec<&'static str>>,
}
impl Fake {
fn new() -> Fake {
Fake { vars: BTreeMap::from([("HOME", "/home/ana")]), programs: BTreeSet::new(), folders: BTreeMap::new() }
}
fn detect(&self, overrides: &Overrides) -> Result<Launcher> {
let var = |k: &str| self.vars.get(k).map(|v| v.to_string());
let which = |p: &str| self.programs.contains(p).then(|| PathBuf::from(format!("/usr/bin/{p}")));
let list = |d: &Path| self.folders.get(d.to_str().unwrap()).map(|v| v.iter().map(|s| s.to_string()).collect()).unwrap_or_default();
// every listed build has its `proton` script
let is_file = |p: &Path| p.file_name().is_some_and(|n| n == "proton");
detect_with(&Host { var: &var, which: &which, list: &list, is_file: &is_file }, overrides)
}
}
const STEAM: &str = "/home/ana/.local/share/Steam/compatibilitytools.d";
#[test]
fn umu_with_the_newest_ge_proton_is_the_default() {
let mut c = Fake::new();
c.programs.extend(["umu-run", "wine"]);
c.folders.insert(STEAM, vec!["GE-Proton9-27", "GE-Proton10-9", "GE-Proton10-34", "Proton-Experimental", "notes.txt"]);
let l = c.detect(&Overrides::default()).unwrap();
assert_eq!(l.prefix, PathBuf::from("/home/ana/Games/umu/coa-client"));
match l.runner {
Runner::Umu { proton, program } => {
assert_eq!(program, PathBuf::from("/usr/bin/umu-run"));
assert_eq!(proton, Some(PathBuf::from(format!("{STEAM}/GE-Proton10-34"))), "10-34 is newer than 10-9");
}
other => panic!("{other:?}"),
}
}
#[test]
fn without_a_proton_build_umu_is_left_to_choose_one() {
let mut c = Fake::new();
c.programs.insert("umu-run");
let Runner::Umu { proton, .. } = c.detect(&Overrides::default()).unwrap().runner else { panic!() };
assert_eq!(proton, None);
}
#[test]
fn plain_wine_is_used_when_umu_is_not_installed() {
let mut c = Fake::new();
c.programs.insert("wine");
assert!(matches!(c.detect(&Overrides::default()).unwrap().runner, Runner::Wine { .. }));
}
#[test]
fn without_umu_or_wine_the_person_is_told_what_to_install() {
let err = Fake::new().detect(&Overrides::default()).unwrap_err().to_string();
assert!(err.contains("umu-launcher") && err.contains("Wine"), "{err}");
}
#[test]
fn settings_override_what_is_installed_and_the_environment_overrides_the_file() {
let mut c = Fake::new();
c.programs.extend(["umu-run", "wine"]);
c.folders.insert(STEAM, vec!["GE-Proton10-34"]);
let file = Overrides { proton_path: Some("/opt/proton-a".into()), prefix: Some("/data/prefix-a".into()), runner: None };
let l = c.detect(&file).unwrap();
assert_eq!(l.prefix, PathBuf::from("/data/prefix-a"));
assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-a")));
c.vars.insert("COA_PROTONPATH", "/opt/proton-b");
c.vars.insert("COA_WINEPREFIX", "/data/prefix-b");
let l = c.detect(&file).unwrap();
assert_eq!(l.prefix, PathBuf::from("/data/prefix-b"));
assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-b")));
// Forcing Wine works when it is installed, and falls back to umu when it is not.
let wine = Overrides { runner: Some("wine".into()), ..Default::default() };
assert!(matches!(c.detect(&wine).unwrap().runner, Runner::Wine { .. }));
}
#[test]
fn the_command_is_the_one_of_the_projects_own_launcher_script() {
let l = Launcher { runner: Runner::Umu { program: "/usr/bin/umu-run".into(), proton: Some("/p/GE-Proton11-6".into()) }, prefix: "/home/ana/Games/umu/coa-client".into() };
let p = plan(&l, Path::new("/home/ana/CoaServer/client/ascension-live"), "Ascension.exe");
assert_eq!(p.program, PathBuf::from("/usr/bin/umu-run"));
assert_eq!(p.args, ["Ascension.exe"]);
assert_eq!(p.cwd, PathBuf::from("/home/ana/CoaServer/client/ascension-live"), "the client reads Data/ from its working directory");
let env: BTreeMap<_, _> = p.env.iter().cloned().collect();
assert_eq!(env["GAMEID"], "0");
assert_eq!(env["PROTONPATH"], "/p/GE-Proton11-6");
assert_eq!(env["WINEPREFIX"], "/home/ana/Games/umu/coa-client");
assert_eq!(env["WINEDLLOVERRIDES"], "divxtac=d", "DivxTac.dll deadlocks the world loading screen under wine-mono");
// Wine has no GAMEID / PROTONPATH.
let w = plan(&Launcher { runner: Runner::Wine { program: "/usr/bin/wine".into() }, prefix: "/pre".into() }, Path::new("/c"), "Wow.exe");
assert!(w.env.iter().all(|(k, _)| k != "GAMEID" && k != "PROTONPATH") && w.args == ["Wow.exe"]);
}
#[test]
fn a_wine_command_line_names_the_client_folder_in_windows_form() {
let client = Path::new("/home/ana/CoaServer/client/ascension-live");
assert!(command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe\0", client, "Ascension.exe"));
assert!(command_line_runs("C:\\windows\\system32\\start.exe /exec Z:\\HOME\\ANA\\coaserver\\client\\ascension-live\\ascension.exe", client, "Ascension.exe"), "case does not matter");
assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-lab\\Ascension.exe", client, "Ascension.exe"), "another client folder");
assert!(!command_line_runs("umu-run Ascension.exe", client, "Ascension.exe"), "the launcher alone does not name the folder");
assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe.ORIGINAL", Path::new("/other"), "Ascension.exe"));
}
#[test]
fn newer_versions_sort_after_older_ones() {
assert!(version_key("GE-Proton10-9") < version_key("GE-Proton10-34"));
assert!(version_key("GE-Proton9-27") < version_key("GE-Proton10-1"));
assert!(version_key("GE-Proton11-6-x86_64") < version_key("GE-Proton11-7-x86_64"));
}
#[cfg(unix)]
#[test]
fn a_real_launch_runs_the_program_in_the_client_folder_with_the_right_environment() {
use std::os::unix::fs::PermissionsExt;
let d = tempfile::tempdir().unwrap();
let client = d.path().join("client");
fs::create_dir_all(&client).unwrap();
let out = d.path().join("seen.txt");
let script = d.path().join("umu-run");
fs::write(&script, format!("#!/bin/sh\n{{ echo \"cwd=$(pwd)\"; echo \"arg=$1\"; echo \"prefix=$WINEPREFIX\"; echo \"gameid=$GAMEID\"; echo \"dll=$WINEDLLOVERRIDES\"; }} > '{}'\n", out.display())).unwrap();
fs::set_permissions(&script, fs::Permissions::from_mode(0o755)).unwrap();
let launcher = Launcher { runner: Runner::Umu { program: script, proton: None }, prefix: d.path().join("prefix") };
let p = plan(&launcher, &client, "Ascension.exe");
let mut child = Command::new(&p.program).args(&p.args).current_dir(&p.cwd).envs(p.env.iter().map(|(k, v)| (k, v))).spawn().unwrap();
assert!(child.wait().unwrap().success());
let seen = fs::read_to_string(&out).unwrap();
assert!(seen.contains(&format!("cwd={}", fs::canonicalize(&client).unwrap().display())), "{seen}");
assert!(seen.contains("arg=Ascension.exe") && seen.contains("gameid=0") && seen.contains("dll=divxtac=d") && seen.contains("prefix="), "{seen}");
}
}
+7
View File
@@ -6,6 +6,7 @@
//! coa-release extract-schema-base --package DIR --fixture NEW-coa-schema-fixture-DIR
//! coa-release schema-contract --repack FIXTURE --tree DIR --core DIR [--bots DIR] [--repairs DIR]
//! coa-release clean-base --repack DIR --core DIR --tree DIR --out DIR [--bots DIR] [--data DIR]
//! coa-release export-baseline --server DIR --out DIR (the three databases of a prepared server, for a Linux package)
//! coa-release sign --dir DIR (key: env COA_SIGNING_KEY, or ~/.coa-manager/signing/manifest-signing.key)
//! coa-release verify --dir DIR (against the public key built into this tool)
@@ -93,6 +94,12 @@ fn run() -> Result<(), String> {
coa_core::cleanbase::build(&coa_core::cleanbase::Params { repack: &repack, core: &core, bots: bots.as_deref(), tree: &tree, data: data.as_deref(), out: &out }, &|s| eprintln!("{s}")).map_err(e)?;
println!("clean base tree at {}", out.display());
}
"export-baseline" => {
let done = coa_core::release::export_baseline(&PathBuf::from(need(&a, "server")?), &PathBuf::from(need(&a, "out")?)).map_err(e)?;
for (kind, bytes) in done {
println!("{kind}.sql.zst: {:.1} MB", bytes as f64 / 1e6);
}
}
"sign" => {
let dir = PathBuf::from(need(&a, "dir")?);
require_contract_entry(&dir)?;
+69 -2
View File
@@ -374,8 +374,75 @@ hand over to `coa_core::docker`; nothing else needed to change for start, stop,
commands do on the host (password through `MYSQL_PWD`, never on a command line). Nothing else changes: accounts,
backups, the population query, migrations and the RA service account all go through `Db`, and the host needs no
MySQL client. A repack keeps using its bundled tools.
* **Not done yet**: installation and the database setup (schemas, `acore` user), updates, port conflict detection,
the firewall and exposure checks, the Wildcard realm profiles, and the client under Wine/Proton.
* **Health of the database container** is a ping over TCP, like every connection the Manager makes. On a new volume the
image first runs a temporary server that answers on its socket but takes no network connection; a socket ping reported
the container healthy about four seconds before TCP worked (measured: 10 s against 14 s).
* **Main configuration files**: a package carries only `worldserver.conf.dist` and `authserver.conf.dist` (the release
tool leaves active files out). On Windows the launcher writes them at each start; on Docker `ensure_main_configs` creates
them from the templates when they are missing, at installation and at every start, and never overwrites one.
* **Installing a new server** (`docker/install.rs`, separate from `install::install_base`, which is not touched). Same
order of events: signed manifest, space and folder checks, verified download, extraction into `<dest>.installing`,
database, then one rename. The package must hold `Core/worldserver`, `Core/authserver`, the `.dist` templates,
`_migrations/` and **`Database/baseline/{auth,characters,world}.sql.zst`**. The baseline is a dump, in the format of the
Manager's backups, of databases in which **every migration of the package is already applied**; the installer imports
it, records those migrations as applied (`baseline = 1`, a few bulk statements) and creates the `acore` account, the
realm port and the console account. It is the same arrangement as a Windows package, which ships its prepared database.
The databases are **not rebuilt from the repository's SQL**: some migrations are guards generated from the maintainers'
live database (`rev_20260903_01_live_class_baseline` refuses to run unless the table holds exactly the rows it expects),
so replaying the SQL files from the base scripts fails, in any order. `coa-release export-baseline --server DIR --out DIR`
produces the dumps from a prepared server (repack or Docker). The game data stays where the person has it
(`dataDir` in `docker.json`, mounted read-only). A failure removes the containers, the volume and the staging folder.
* **Validating a release on Linux** (`docker/fixture.rs`, used by `coa-release extract-schema-base` and `schema-contract` where
there is no Windows database program): the signed base package carries the MySQL data directory of a Windows repack, and a
MySQL 8.4 container opens it as it is (`--lower-case-table-names=1`, the repack's setting). The fixture is a Docker server
folder (`docker.json` with `mysqlData`: the database container uses that directory in place of a volume; an installation
never sets it), plus a `root` account for TCP, which the repack only has for its socket. The release SQL is then applied and the
schema contract captured by the same code as on Windows, and `export-baseline` dumps the result: that is how a Linux build
produces `Database/baseline` without anyone's live database. The migration checksums recorded in the base are those of
files checked out on Windows (CRLF line endings, `core.autocrlf`): the SQL of the core, the modules and SQUID must be
checked out the same way for the checksums to match, or every applied migration looks edited.
* **In the screens** the host is asked once per command (`coa_core::platform::flavor()`: repack on Windows, Docker
elsewhere) and the Docker half lives in `src-tauri/src/docker_install.rs`; the repack arm of each install command is the
code that was there. `install_environment` tells the install screen the kind of server, the suggested folder
(`~/CoaServer`) and why Docker cannot be used, if it cannot. On Docker the screen also asks for the game data folder and
the package, and there is no default package address until a signed Linux package is published. Packages are checked with
the embedded key; only a debug build (`tauri dev`) accepts another one, named in `COA_DEV_TRUSTED_KEY`, to try the
installer on a package signed with a throwaway key.
* **Updates are refused for a Docker server, never half done.** `update::preview`, `apply` and `rollback` refuse it: the
update packages are the repack's (executables, a bundled MySQL, a launcher) and applying one would put Windows files in a
Linux folder. Found by installing a server with the screen: the update check had read the Windows channel and offered one.
* **Realm profiles (CoA / Wildcard) work on a Docker server.** What the repack's patched launcher did at each start is done
by the Docker backend: finish an interrupted switch (`realms::before_start`), name the realms in the realm list, and give
the containers the databases of the selected realm (`acore_world_wildcard` ...). The switch itself (configuration swap,
database copy, journal) is the shared code; `prepare_launcher` has nothing to patch, and Wildcard support is read from
`Core/worldserver` as it is from `Core/worldserver.exe`.
* **The game client starts under Wine on a Linux host** (`wine.rs`; `client::launch` and `client::is_running` hand over):
umu-launcher with a Proton build when `umu-run` is installed (the newest GE-Proton found for Steam, or umu's own choice),
else plain Wine; `WINEPREFIX` defaults to `~/Games/umu/coa-client`; `WINEDLLOVERRIDES=divxtac=d` is always set, because
DivxTac.dll deadlocks the world loading screen under wine-mono. `COA_PROTONPATH`, `COA_WINEPREFIX` or
`client-launch.json` in the Manager's folder (`proton_path`, `prefix`, `runner`) override the detection. Whether the client
runs is read from `/proc` (under Wine the command line holds the Windows form of the path). Output goes to `client.log`.
* **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
A fix for one platform must not be able to break the other. The rules:
1. **Platform code lives in its own modules**: `coa_core::docker` for Linux and Docker; the repack code (`driver`, `process`,
`install`, `layout` and the bundled-tool half of `db`) for Windows. A new Linux feature is a new file there, not an edit
of a repack function.
2. **Shared modules hold platform-neutral logic only** (manifest, signing, download, extraction, migrations, backups,
configuration editing, the registry).
3. **The difference enters in as few places as possible**: the early `is_docker` return at the top of `driver::run`,
`process::observe`, `layout::scan` and `Db::from_repack`, and the platform checks of the Tauri layer. Everything past
that point belongs to one platform.
4. **No `cfg` in the middle of a shared algorithm.** Where one is unavoidable (file modes, a path comparison), it is small,
commented, and the other platform's branch is the code that was there before.
5. **Reuse by calling, not by editing**: a Linux feature that needs a helper from a Windows-side file makes it
`pub(crate)` and calls it (visibility only); it does not change what the helper does.
6. **Both platforms are tested on every pull request** (`check.yml`: Windows and Linux). Tests of one platform's behaviour
are marked for that platform, so they cannot fail on the other.
---------------------------------------------------------------------------------------------------------
+18
View File
@@ -121,6 +121,24 @@
"default_on": false,
"page": "bots"
},
{
"id": "custom-races",
"name": "Custom Races",
"description": {
"en": "Playable custom races (Esteria and additional races) with extended appearances.",
"ru": "Пользовательские расы (Esteria и дополнительные расы) с расширенной внешностью.",
"de": "Spielbare benutzerdefinierte Völker (Esteria und weitere Völker) mit erweitertem Aussehen.",
"fr": "Races personnalisées jouables (Esteria et autres) avec apparences étendues.",
"es": "Razas personalizadas jugables (Esteria y razas adicionales) con apariencias ampliadas."
},
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
"conf": "coa_custom_races.conf",
"switchable": true,
"status": "beta",
"icon": "races",
"enable_key": "CoACustomRaces.Enable",
"default_on": false
},
{
"id": "client-compat",
"name": "Client compatibility",
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "coa-server-manager",
"version": "0.6.5",
"version": "0.6.11",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "coa-server-manager",
"version": "0.6.5",
"version": "0.6.11",
"dependencies": {
"@tauri-apps/api": "^2.12.0",
"@tauri-apps/plugin-dialog": "^2.8.0",
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "coa-server-manager",
"private": true,
"version": "0.6.5",
"version": "0.6.11",
"license": "AGPL-3.0-only",
"type": "module",
"scripts": {
+1 -1
View File
@@ -770,7 +770,7 @@
"type": "bool",
"category": "gameplay",
"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,
"advanced": false,
"restartRequired": "world",
+125
View File
@@ -0,0 +1,125 @@
//! The Linux (Docker) side of the install commands. `lib.rs` asks `coa_core::platform::flavor()` once per command and
//! calls this module for a Docker install; the code for a repack install stays where it was and is not changed by what
//! happens here.
use std::path::{Path, PathBuf};
use coa_core::docker::{self, install as core_install, SystemDocker};
use coa_core::download::Cancel;
use coa_core::install::{Preflight, Source};
use coa_core::registry::Registry;
use coa_core::{Error, Result};
use serde::Serialize;
use tauri::{AppHandle, Emitter, State};
use super::{blocking, data_dir, summary, AppState, InstallRequirements, ServerSummary, UiError};
/// What the install screen needs to know about this computer before it asks anything.
#[derive(Serialize)]
pub struct Environment {
pub flavor: coa_core::platform::Flavor,
pub default_dir: String,
/// Why Docker cannot be used (not installed, not running, no permission), in Docker's own words; none when it works.
pub docker_problem: Option<String>,
}
pub fn default_dir() -> String {
default_dir_in(std::env::var("HOME").ok().as_deref())
}
fn default_dir_in(home: Option<&str>) -> String {
match home.map(|h| h.trim_end_matches('/')).filter(|h| !h.is_empty()) {
Some(h) => format!("{h}/CoaServer"),
None => "/srv/coa".into(),
}
}
pub fn docker_problem() -> Option<String> {
docker::check_docker(&SystemDocker).err().map(|e| e.to_string())
}
pub fn environment() -> Environment {
Environment { flavor: coa_core::platform::flavor(), default_dir: default_dir(), docker_problem: docker_problem() }
}
pub fn preflight(dest: &str, data: Option<String>, needed: Option<u64>, registry: &Registry) -> Preflight {
// The size comes from the signed package list when the screen already has it; it is checked again at install time.
core_install::preflight(Path::new(dest), Path::new(data.as_deref().unwrap_or("")), needed.unwrap_or(1024 * 1024 * 1024), registry)
}
/// The Linux package has no default address yet: it is published only after the maintainer has signed it.
pub fn package_source(custom: Option<String>) -> Result<Source> {
let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_PACKAGE_SOURCE").ok().filter(|s| !s.trim().is_empty()));
match pick {
Some(p) if p.to_ascii_lowercase().starts_with("http") => Ok(Source::Url(p)),
Some(p) => Ok(Source::Dir(PathBuf::from(p))),
None => Err(Error::Invalid("Choose the Linux server package (a folder or an address): none is published yet.".into())),
}
}
/// The key a Linux package must be signed with. A debug build (`tauri dev`) may name another one in `COA_DEV_TRUSTED_KEY`,
/// to try the installer on a package signed with a throwaway key; a release build always uses the embedded key.
pub fn trusted_key() -> String {
#[cfg(debug_assertions)]
if let Ok(k) = std::env::var("COA_DEV_TRUSTED_KEY") {
if !k.trim().is_empty() {
return k.trim().to_string();
}
}
coa_core::signing::EMBEDDED_PUBLIC_KEY.to_string()
}
pub async fn requirements(package: Option<String>) -> std::result::Result<InstallRequirements, UiError> {
blocking(move || {
let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package)?, &trusted_key())?;
let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
Ok(InstallRequirements { download_bytes: archive.parts.iter().map(|p| p.size).sum(), unpacked_bytes: archive.unpacked_size, version: m.version })
})
.await
}
pub async fn install(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>, data: Option<String>) -> std::result::Result<ServerSummary, UiError> {
let source = package_source(package)?;
let data_dir_path = PathBuf::from(data.filter(|d| !d.trim().is_empty()).ok_or_else(|| Error::Invalid("Choose the folder that holds the game data.".into()))?);
let cancel = Cancel::default();
*state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone());
let registry = Registry::at(data_dir().join("installs.json"));
let dest_path = PathBuf::from(dest);
let key = trusted_key();
let result = tauri::async_runtime::spawn_blocking(move || {
core_install::install(
&core_install::Params { source, dest: dest_path, data_dir: data_dir_path, trusted_key: &key, registry: &registry, cancel },
&|step| {
let _ = app.emit("install-progress", step);
},
)
})
.await;
if let Ok(mut c) = state.install_cancel.lock() {
*c = None;
}
let done = result.map_err(|e| Error::Invalid(e.to_string()))??;
Ok(summary(done.id, PathBuf::from(done.path)))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_default_folder_is_in_the_home_folder() {
assert_eq!(default_dir_in(Some("/home/ana")), "/home/ana/CoaServer");
assert_eq!(default_dir_in(Some("/home/ana/")), "/home/ana/CoaServer");
assert_eq!(default_dir_in(None), "/srv/coa");
assert_eq!(default_dir_in(Some("")), "/srv/coa");
}
#[test]
fn a_linux_package_must_be_named_there_is_no_default() {
std::env::remove_var("COA_PACKAGE_SOURCE");
assert!(package_source(None).is_err());
assert!(package_source(Some(" ".into())).is_err());
assert!(matches!(package_source(Some("/tmp/pkg".into())).unwrap(), Source::Dir(_)));
assert!(matches!(package_source(Some("https://example.org/pkg".into())).unwrap(), Source::Url(_)));
}
}
+166 -13
View File
@@ -5,11 +5,14 @@ use std::collections::HashSet;
use std::path::PathBuf;
use std::sync::Mutex;
mod docker_install;
use coa_core::backup::{self, Kind, RecoveryPoint, Trigger, VerifyReport};
use coa_core::config::{self, Scope, SettingsView};
use coa_core::download::Cancel;
use coa_core::driver::{self, DriverOutcome, Verb};
use coa_core::install::{self, Preflight, Source};
use coa_core::platform::{self, Flavor};
use coa_core::ra::Ra;
use coa_core::update::{self, Resolution};
use coa_core::error::UiError;
@@ -105,9 +108,19 @@ fn summary(id: String, path: PathBuf) -> ServerSummary {
#[tauri::command]
fn default_install_dir() -> String {
if platform::flavor() == Flavor::Docker {
return docker_install::default_dir();
}
"C:\\Games\\CoA Server".into()
}
/// What the install screen needs to know about this computer: the kind of server it installs, the suggested folder, and
/// whether Docker can be used.
#[tauri::command]
async fn install_environment() -> docker_install::Environment {
tauri::async_runtime::spawn_blocking(docker_install::environment).await.unwrap_or_else(|_| docker_install::Environment { flavor: platform::flavor(), default_dir: default_install_dir(), docker_problem: None })
}
#[tauri::command]
async fn scan_server(path: String) -> std::result::Result<ScanReport, UiError> {
tauri::async_runtime::spawn_blocking(move || layout::scan(std::path::Path::new(&path)))
@@ -353,6 +366,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]
fn list_backups(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<RecoveryPoint>, UiError> {
let root = path_of(&state, &id)?;
@@ -405,7 +463,10 @@ async fn restore_backup_database(state: State<'_, AppState>, id: String, backup_
}
#[tauri::command]
fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option<u64>) -> Preflight {
fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option<u64>, game_data: Option<String>) -> Preflight {
if platform::flavor() == Flavor::Docker {
return docker_install::preflight(&dest, game_data, needed, &state.registry);
}
// `needed` is the real size from the signed package list when the screen already has it; the real size is checked
// again at install time either way.
install::preflight(std::path::Path::new(&dest), needed.unwrap_or(6 * 1024 * 1024 * 1024), &state.registry)
@@ -423,6 +484,9 @@ struct InstallRequirements {
/// How big the server is, read from the package's signed list before anything is downloaded.
#[tauri::command]
async fn install_requirements(package: Option<String>) -> std::result::Result<InstallRequirements, UiError> {
if platform::flavor() == Flavor::Docker {
return docker_install::requirements(package).await;
}
blocking(move || {
let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package), coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?;
@@ -432,7 +496,10 @@ async fn install_requirements(package: Option<String>) -> std::result::Result<In
}
#[tauri::command]
async fn install_new(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>) -> std::result::Result<ServerSummary, UiError> {
async fn install_new(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option<String>, game_data: Option<String>) -> std::result::Result<ServerSummary, UiError> {
if platform::flavor() == Flavor::Docker {
return docker_install::install(app, state, dest, package, game_data).await;
}
let cancel = Cancel::default();
*state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone());
let source = package_source(package);
@@ -594,6 +661,50 @@ async fn module_set_enabled(state: State<'_, AppState>, id: String, module: Stri
})
.await
}
#[tauri::command]
async fn custom_races_status(state: State<'_, AppState>, id: String) -> std::result::Result<Option<coa_core::custom_races::ClientPatchStatus>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let client = linked_client(&root)?;
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 root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
let cancel = begin_client_job(&state)?;
let sid = id.clone();
let result = 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::install_client_patches(&client, &cancel, &|step, percent| {
let _ = app.emit("custom-races-progress", serde_json::json!({
"id": sid,
"step": step,
"percent": percent,
}));
})?;
let enabled = 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_toggle_client(state: State<'_, AppState>, id: String, enabled: bool) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is linked to this server.".into()))?;
coa_core::custom_races::set_client_patch_enabled(&client, enabled)
})
.await
}
#[tauri::command]
async fn module_settings(state: State<'_, AppState>, id: String, module: String) -> std::result::Result<Vec<coa_core::modules::Setting>, UiError> {
@@ -684,12 +795,14 @@ fn install_meta(root: &std::path::Path) -> Result<(PathBuf, InstallMeta)> {
}
#[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 src = update_source(source);
// The check that repeats every few minutes must not start and stop the database of a stopped server.
let access = if background.unwrap_or(false) { update::DatabaseAccess::OnlyIfRunning } else { update::DatabaseAccess::Start };
blocking(move || {
let (_, meta) = install_meta(&root)?;
update::preview(&root, &meta, &src, coa_core::signing::EMBEDDED_PUBLIC_KEY, &Default::default())
update::preview_with(&root, &meta, &src, coa_core::signing::EMBEDDED_PUBLIC_KEY, &Default::default(), access)
})
.await
}
@@ -1249,6 +1362,7 @@ async fn play(state: State<'_, AppState>, id: String) -> std::result::Result<Dri
struct FriendsStatus {
settings: coa_core::friends::Settings,
lan_ip: Option<String>,
lan_addresses: Vec<coa_core::net::LanAddress>,
exposure: Vec<coa_core::net::Exposure>,
/// The configuration lets other computers reach the login and world servers.
servers_open: bool,
@@ -1265,10 +1379,9 @@ struct FriendsStatus {
#[tauri::command]
fn open_link(url: String) -> std::result::Result<(), UiError> {
const ALLOWED: &[&str] = &["https://tailscale.com/", "https://login.tailscale.com/", "https://portforward.com/", "https://github.com/Corfirean/"];
// A prefilled "new issue" page of this project: the address must be exactly that page, and its query may carry
// `&` between the (percent-encoded) title and text.
const NEW_ISSUE: &str = "https://github.com/Corfirean/coa-server-manager/issues/new";
let issue = url == NEW_ISSUE || url.starts_with(&format!("{NEW_ISSUE}?"));
// A prefilled "new issue" page of one of the places a report can go (the Manager, Companions, SQUID Playerbots): the
// address must be exactly that page, and its query may carry `&` between the (percent-encoded) title and text.
let issue = coa_core::report::is_new_issue_url(&url);
let chars_ok = url.chars().all(|c| c.is_ascii_alphanumeric() || "/:._-?=#%".contains(c) || (issue && c == '&'));
// the GitHub page of a module that is in the bundled catalog (some are not ours)
let catalog = coa_core::modules::catalog().iter().any(|e| e.repo == url);
@@ -1286,6 +1399,16 @@ struct ReportContext {
/// "new" for a server the Manager installed, "imported" for one that was added.
install_kind: String,
server_version: Option<String>,
/// Where the form should start: the bot system that is switched on, else the Manager.
suggested_target: String,
/// The release of whichever bot system is on, for a report that goes to its repository.
bots_version: Option<String>,
}
/// The places a report can go, each with its GitHub repository.
#[tauri::command]
fn report_targets() -> Vec<coa_core::report::Target> {
coa_core::report::targets()
}
/// "Windows 11 (build 26200)" from `ver`; empty if it cannot be read.
@@ -1312,11 +1435,15 @@ async fn report_context(state: State<'_, AppState>, id: String) -> std::result::
let root = path_of(&state, &id)?;
blocking(move || {
let (_, meta) = install_meta(&root)?;
let bots = coa_core::report::bots(&root);
let companions = [meta.bots.version.clone(), meta.bots.commit.as_ref().map(|c| c.chars().take(8).collect())].into_iter().flatten().collect::<Vec<String>>().join(" · ");
Ok(ReportContext {
manager_version: coa_core::MANAGER_VERSION.to_string(),
windows: windows_version(),
install_kind: if meta.kind == coa_core::registry::InstallKind::New { "new".into() } else { "imported".into() },
server_version: meta.core.version.clone(),
suggested_target: bots.suggested.to_string(),
bots_version: if bots.suggested == "squid" { bots.squid_version } else if bots.suggested == "companions" && !companions.is_empty() { Some(companions) } else { None },
})
})
.await
@@ -1328,9 +1455,11 @@ async fn friends_status(state: State<'_, AppState>, id: String) -> std::result::
blocking(move || {
let meta = meta_dir(&root)?;
let ports = layout::read_ports(&root);
let automatic = coa_core::net::lan_ip().filter(|ip| coa_core::net::is_lan_address(*ip));
Ok(FriendsStatus {
settings: coa_core::friends::load(&meta),
lan_ip: coa_core::net::lan_ip().map(|a| a.to_string()),
lan_ip: automatic.map(|a| a.to_string()),
lan_addresses: coa_core::net::lan_addresses(automatic).unwrap_or_default(),
exposure: coa_core::net::exposure(&ports),
servers_open: coa_core::friends::bind_is_open(&root),
firewall: coa_core::firewall::status(),
@@ -1383,9 +1512,10 @@ async fn friends_enable(
id: String,
mode: coa_core::friends::Mode,
host: Option<String>,
lan_address_override: Option<String>,
use_upnp: bool,
) -> std::result::Result<FriendsResult, UiError> {
use coa_core::friends::{self, Mode, Settings};
use coa_core::friends::{self, Mode};
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
@@ -1396,7 +1526,7 @@ async fn friends_enable(
let secondary = realms.secondary_world_port.filter(|_| realms.simultaneous);
let host = match mode {
Mode::Local => "127.0.0.1".to_string(),
Mode::Lan => coa_core::net::lan_ip().ok_or_else(|| Error::Invalid("This computer has no network address.".into()))?.to_string(),
Mode::Lan => coa_core::net::resolve_lan_host(lan_address_override.as_deref(), coa_core::net::lan_ip())?,
Mode::Direct => host.filter(|h| !h.is_empty()).ok_or_else(|| Error::Invalid("Check your connection first to learn your public address.".into()))?,
Mode::Private => coa_core::net::tailscale().ip.ok_or_else(|| Error::Invalid("Tailscale is not connected. Install it, sign in, then try again.".into()))?,
};
@@ -1417,7 +1547,9 @@ async fn friends_enable(
None => note = Some("Your router does not support automatic setup; forward the two game ports by hand or use the private network.".to_string()),
}
}
friends::save(&meta, &Settings { mode, host: Some(host.clone()) })?;
let mut settings = friends::load(&meta);
settings.select_mode(mode, host.clone(), lan_address_override);
friends::save(&meta, &settings)?;
let running = coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running;
if running {
friends::apply_realm_address(&root, &host)?;
@@ -1470,11 +1602,19 @@ async fn export_diagnostics(state: State<'_, AppState>, id: String) -> std::resu
let report = coa_core::diag::run(&root, &meta);
let out = coa_core::diag::desktop_or_temp().join(format!("CoA-Diagnostics-{}.zip", coa_core::diag::stamp()));
coa_core::diag::export_package(&root, &dir, &data_dir().join("logs").join("manager.log"), &meta, &report, &out)?;
// Show the file in its folder so nobody has to look for it; failing to open the folder is not a failure.
let _ = tauri_plugin_opener::reveal_item_in_dir(&out);
Ok(out.to_string_lossy().into_owned())
})
.await
}
#[tauri::command]
async fn list_crashes(state: State<'_, AppState>, id: String, limit: Option<usize>) -> std::result::Result<Vec<coa_core::crashes::CrashItem>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::crashes::list(&root, limit.unwrap_or(10))).await
}
#[tauri::command]
async fn console_tail(
@@ -1522,6 +1662,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) })
.invoke_handler(tauri::generate_handler![
default_install_dir,
install_environment,
scan_server,
add_server,
list_servers,
@@ -1536,6 +1677,13 @@ pub fn run() {
list_config_snapshots,
restore_config_snapshot,
list_backups,
dashboard_status,
dashboard_install,
dashboard_start,
dashboard_open,
dashboard_stop,
backup_location,
set_backup_location,
create_backup,
verify_backup,
delete_backup,
@@ -1579,6 +1727,7 @@ pub fn run() {
companions_delete_all,
companions_despawn_some,
open_link,
report_targets,
companion_sizes,
add_companions,
remote_connection,
@@ -1601,9 +1750,13 @@ pub fn run() {
run_diagnostics,
verify_files,
export_diagnostics,
list_crashes,
console_tail,
console_risk,
console_command
console_command,
custom_races_status,
custom_races_install,
custom_races_toggle_client
])
.run(tauri::generate_context!())
.expect("error while running CoA Server Manager");
+2 -2
View File
@@ -1,7 +1,7 @@
{
"$schema": "https://schema.tauri.app/config/2",
"productName": "CoA Server Manager",
"version": "0.6.5",
"version": "0.6.11",
"identifier": "com.coa.servermanager",
"build": {
"beforeDevCommand": "npm run dev",
@@ -21,7 +21,7 @@
}
],
"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": {
+4 -1
View File
@@ -87,9 +87,12 @@ export {};
return (S[args.module]??[]).map(s => ({...s, value: moduleEdits[args.module]?.[s.key] ?? s.value}));
}
if(cmd==="module_save_settings") { moduleEdits[args.module] = {...moduleEdits[args.module], ...args.changes}; return Object.keys(args.changes); }
if(cmd==="report_context") return {manager_version:"0.3.1",windows:"Windows 11 (build 26200)",install_kind:"new",server_version:"0.261001.10"};
if(cmd==="report_context") return {manager_version:"0.3.1",windows:"Windows 11 (build 26200)",install_kind:"new",server_version:"0.261001.10",suggested_target:"companions",bots_version:"0.2.1 · 1a2b3c4d"};
if(cmd==="report_targets") return [{id:"manager",repo:"Corfirean/coa-server-manager",ours:true},{id:"companions",repo:"Corfirean/mod-coa-playerbots",ours:true},{id:"squid",repo:"Zyth45/mod-playerbots",ours:false}];
if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;}
if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip";
if(cmd==="list_crashes") return [];
if(cmd==="install_environment"){const docker=new URLSearchParams(location.search).get("flavor")==="docker";return docker?{flavor:"docker",default_dir:"/home/you/CoaServer",docker_problem:new URLSearchParams(location.search).has("nodocker")?"permission denied while trying to connect to the Docker daemon socket":null}:{flavor:"repack",default_dir:"C:\\Games\\CoA Server",docker_problem:null};}
if(cmd==="install_preflight") return {ok:true,problems:[],free_bytes:210*2**30};
if(cmd==="install_requirements") return {download_bytes:Math.round(5.9*2**30),unpacked_bytes:Math.round(11.4*2**30),version:"0.2.0"};
if(cmd==="list_accounts"){const w=window as any;w.__acc=w.__acc??[{id:2,name:"ALICE",access:3,online:true,last_login:"2026-10-01 12:04:11",characters:4},{id:5,name:"BOB",access:0,online:false,last_login:null,characters:0},{id:6,name:"CAROL",access:2,online:false,last_login:"2026-09-30 21:40:02",characters:2}];return w.__acc;}
+73 -7
View File
@@ -20,7 +20,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
"nav.overview": "Übersicht",
"nav.bots": "Bots",
"nav.server": "Server",
"nav.players": "Spieler",
"nav.players": "Konten",
"nav.friends": "Mit Freunden spielen",
"nav.backups": "Sicherungen",
"nav.console": "Konsole",
@@ -32,7 +32,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
"q.overview": "Läuft mein Server?",
"q.bots": "Wie sind meine Bots eingestellt?",
"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.backups": "Sind meine Daten sicher?",
"q.console": "Was macht der Server gerade?",
@@ -167,7 +167,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
"install.open": "MEINEN SERVER ÖFFNEN",
// Players
"players.title": "Spieler",
"players.title": "Konten",
"players.createTitle": "Erstelle dein Konto",
"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.",
@@ -495,7 +495,7 @@ const de: Partial<Record<keyof typeof en, string>> = {
"ustep.Updating the database": "Datenbank wird aktualisiert",
"ustep.Starting the updated server": "Aktualisierter Server wird gestartet",
"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",
// Companion sizes
@@ -702,9 +702,9 @@ const de: Partial<Record<keyof typeof en, string>> = {
"rep.expectedHint": "Beschreibe das erwartete Verhalten.",
"rep.steps": "Schritte zum Nachstellen",
"rep.attachTitle": "Logs und Screenshots",
"rep.attachText": "Erstelle eine Diagnosedatei (Einstellungen und Logs ohne Passwörter und Adressen) und ziehe sie zusammen mit Screenshots oder Videos auf die GitHub-Seite, sobald sie offen ist.",
"rep.attachText": "Ein Klick sammelt die Diagnose: Logs des Managers und des Servers, Absturzberichte, Windows-Absturzeinträge und Update-Protokolle, ohne Passwörter und Adressen. Der Ordner mit der Datei wird geöffnet; ziehe die Datei zusammen mit Screenshots oder Videos auf die GitHub-Seite.",
"rep.makeFile": "Diagnosedatei erstellen",
"rep.fileSaved": "Gespeichert unter {path}. Ziehe diese Datei in das GitHub-Issue.",
"rep.fileSaved": "Gespeichert unter {path}. Der Ordner wurde geöffnet. Ziehe diese Datei in das GitHub-Issue.",
"rep.privacy": "Bitte entferne Passwörter, Tokens, private IP-Angaben und andere sensible Daten, bevor du Logs veröffentlichst.",
"rep.open": "Bericht auf GitHub öffnen",
"rep.copy": "Text kopieren",
@@ -714,6 +714,17 @@ const de: Partial<Record<keyof typeof en, string>> = {
"rep.opened": "GitHub wurde im Browser geöffnet. Prüfe den Text, hänge Dateien an und klicke auf „Submit new issue“.",
"rep.openedLong": "Der Bericht ist für einen Link zu lang und wurde deshalb in die Zwischenablage kopiert. GitHub ist geöffnet: Füge ihn (Strg+V) in die Beschreibung ein, hänge Dateien an und klicke auf „Submit new issue“.",
"rep.copied": "In die Zwischenablage kopiert.",
"rep.targetTitle": "Worum geht es bei dem Problem?",
"rep.target.manager": "CoA Server Manager, der Server oder andere Module",
"rep.target.companions": "CoA Companions (Bots und das CoABotUI-Addon)",
"rep.target.squid": "SQUID Playerbots",
"rep.targetPublic": "Der Bericht wird öffentlich auf GitHub in {repo} veröffentlicht.",
"rep.botsVersion": "Bot-Version",
"rep.withDiag": "Diagnose für mich sammeln (empfohlen)",
"rep.collectOpen": "Diagnose sammeln und Bericht öffnen",
"rep.collecting": "Diagnose wird gesammelt…",
"overview.reportHint": "Ein Dienst wurde von selbst beendet?",
"overview.reportBtn": "Diagnose sammeln und melden",
// Realmlist switcher and modules page
"realm.profileLabel": "Realm",
@@ -751,7 +762,9 @@ const de: Partial<Record<keyof typeof en, string>> = {
"mod.noSettings": "Keine weiteren Einstellungen. Verwende den Modulschalter oben.",
"err.bot_modules_conflict.title": "Zwei Bot-Module sind aktiviert",
"err.bot_modules_conflict.message": "Deaktiviere CoA Companions oder SQUID Playerbots unter Module vor dem Serverstart.",
"mod.ahbot.setup": "GUID eines separaten Auktionscharakters eintragen, Verkäufer und Modul aktivieren. Der Charakter muss offline sein. Der CoA-Filter nutzt Beute-, Händler- und Berufstabellen; Stufengrenzen gelten zusätzlich. Erfordert einen Serverbuild mit CoA-Auktionsfilter.",
"mod.ahbot.setup": "Modul und Verkäufer aktivieren. Der Server legt beim ersten Start selbst einen Auktionscharakter an (Konto AHBOT), eine GUID ist nicht nötig. Ein Charakter bietet in den Auktionshäusern beider Fraktionen an. Der CoA-Filter nutzt Beute-, Händler- und Berufstabellen; Stufengrenzen gelten zusätzlich. Erfordert einen Serverbuild mit CoA-Auktionsfilter und automatischem Auktionscharakter.",
"mod.enchanter.add": "Verzauberer platzieren: Stellt euch an die gewünschte Stelle und gebt .npc add 601015 ein",
"mod.enchanter.remove": "Verzauberer entfernen: Ziel auf den NPC setzen und .npc delete eingeben",
"mod.ahbot.allSettings": "Alle Auktionseinstellungen",
"mod.title": "Module",
"mod.intro": "Zusatzfunktionen, die im Server eingebaut sind. Schalte die gewünschten ein oder aus, öffne ihre GitHub-Seite oder ändere ihre Einstellungen.",
@@ -814,8 +827,61 @@ const de: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Alle Einstellungen nach Name oder Beschreibung durchsuchen…",
"set.search": "Einstellungen durchsuchen…",
"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.updating": "Client wird aktualisiert",
"fr.lan.address": "Netzwerkadresse",
"fr.lan.automatic": "Automatisch",
"fr.lan.default": "Standard",
"fr.lan.custom": "Eigene Adresse…",
"fr.lan.customIpv4": "Eigene IPv4-Adresse",
"fr.lan.unavailable": "Ausgewählte Adresse nicht verfügbar",
"fr.lan.unavailableText": "Die ausgewählte Adresse ist derzeit keinem erkannten lokalen Netzwerkadapter zugewiesen. Wählen Sie eine andere Adresse oder Automatisch, oder behalten Sie diese Adresse bewusst bei.",
"fr.lan.invalid": "Ungültige IPv4-Adresse",
"unsaved.title": "Nicht gespeicherte Änderungen",
"unsaved.message": "Sie haben nicht gespeicherte Änderungen. Möchten Sie diese vor dem Verlassen der Seite speichern?",
"unsaved.saveFailed": "Änderungen konnten nicht gespeichert werden. Bitte Eingaben überprüfen.",
"crash.autoRestart": "Automatischer Neustart bei Absturz",
"crash.autoRestartDesc": "Startet den Server automatisch neu, falls er unerwartet abstürzt.",
"crash.badge": "Abstürze: {n}",
"crash.historyTitle": "Absturzverlauf des Servers",
"crash.noCrashes": "Keine Absturzberichte gefunden.",
"crash.restartNotice": "Der Server ist abgestürzt und wurde automatisch neu gestartet (Absturz #{n}).",
"crash.loopPaused": "Automatischer Neustart pausiert: Der Server ist mehrfach kurz hintereinander abgestürzt.",
"crash.details": "Absturzdetails",
"crash.viewRaw": "Vollständigen Bericht anzeigen",
"crash.hideRaw": "Vollständigen Bericht verbergen",
"crash.copyReport": "Bericht kopieren",
"crash.copied": "Kopiert!",
};
export default de;
+83 -7
View File
@@ -32,6 +32,8 @@ const en = {
"repair.result": "Restored files: {files}. Applied database updates: {sql}.",
"repair.backup": "Backup: {id}",
"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.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.",
@@ -51,7 +53,7 @@ const en = {
"nav.overview": "Overview",
"nav.bots": "Bots",
"nav.server": "Server",
"nav.players": "Players",
"nav.players": "Accounts",
"nav.friends": "Play with Friends",
"nav.backups": "Backups",
"nav.console": "Console",
@@ -63,7 +65,7 @@ const en = {
"q.overview": "Is my server running?",
"q.bots": "How are my bots configured?",
"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.backups": "Is my data safe?",
"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.localPkgHint": "(leave empty to download)",
"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.progressText": "This can take a few minutes. You can leave this window open.",
"install.step.checking": "Checking your computer",
@@ -200,7 +210,7 @@ const en = {
"install.open": "OPEN MY SERVER",
// Players
"players.title": "Players",
"players.title": "Accounts",
"players.createTitle": "Create your account",
"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.",
@@ -528,7 +538,7 @@ const en = {
"ustep.Updating the database": "Updating the database",
"ustep.Starting the updated server": "Starting the updated server",
"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",
// Companion sizes
@@ -735,9 +745,9 @@ const en = {
"rep.expectedHint": "Describe the expected behaviour.",
"rep.steps": "Steps to reproduce",
"rep.attachTitle": "Logs and screenshots",
"rep.attachText": "Create a diagnostics file (settings and logs with passwords and addresses removed) and drag it, together with any screenshot or video, into the GitHub page once it is open.",
"rep.attachText": "One click collects the diagnostics: the Manager's and the server's logs, crash reports, Windows crash records and update journals, with passwords and addresses removed. The file's folder opens; drag the file, together with any screenshot or video, into the GitHub page.",
"rep.makeFile": "Create the diagnostics file",
"rep.fileSaved": "Saved to {path}. Drag this file into the GitHub issue.",
"rep.fileSaved": "Saved to {path}. The folder was opened. Drag this file into the GitHub issue.",
"rep.privacy": "Please remove passwords, tokens, private IP information or other sensitive data before posting logs.",
"rep.open": "Open the report on GitHub",
"rep.copy": "Copy the text",
@@ -747,6 +757,17 @@ const en = {
"rep.opened": "GitHub was opened in your browser. Check the text, attach files and press Submit new issue.",
"rep.openedLong": "The report is too long for a link, so it was copied to the clipboard. GitHub is open: paste it (Ctrl+V) into the description, attach files and press Submit new issue.",
"rep.copied": "Copied to the clipboard.",
"rep.targetTitle": "What is the problem about?",
"rep.target.manager": "CoA Server Manager, the server or other modules",
"rep.target.companions": "CoA Companions (bots and the CoABotUI addon)",
"rep.target.squid": "SQUID Playerbots",
"rep.targetPublic": "The report will be public on GitHub in {repo}.",
"rep.botsVersion": "Bot release",
"rep.withDiag": "Collect the diagnostics for me (recommended)",
"rep.collectOpen": "Collect diagnostics and open the report",
"rep.collecting": "Collecting diagnostics…",
"overview.reportHint": "A service stopped on its own?",
"overview.reportBtn": "Collect diagnostics and report",
// Realmlist switcher and modules page
"realm.label": "Realm",
@@ -770,7 +791,9 @@ const en = {
"mod.ahbot.weightsHint": "Relative weights, not percentages. 0 excludes a quality; larger values make it more frequent. If all defaults are zero, enabling selects common quality. Other item filters still apply.",
"mod.ahbot.noTypes": "All types are disabled. The seller has no types to choose for new listings.",
"mod.noSettings": "There are no additional settings. Use the module switch above.",
"mod.ahbot.setup": "Enter a dedicated auction character GUID, enable the seller and the module. Keep that character offline. The CoA filter selects items from loot tables, vendors and professions; level restrictions also apply. Requires a server build with the CoA auction filter.",
"mod.ahbot.setup": "Turn on the module and the seller. The server creates its own auction character (account AHBOT) the first time it starts, so no GUID is needed. One character lists in both factions' auction houses. The CoA filter selects items from loot tables, vendors and professions; level restrictions also apply. Requires a server build with the CoA auction filter and the automatic auction character.",
"mod.enchanter.add": "Place the enchanter: stand where you want him and enter .npc add 601015",
"mod.enchanter.remove": "Remove the enchanter: target him and enter .npc delete",
"mod.ahbot.allSettings": "All settings",
"err.bot_modules_conflict.title": "Two bot modules are enabled",
"err.bot_modules_conflict.message": "Disable CoA Companions or SQUID Playerbots in Modules before starting the server.",
@@ -835,8 +858,61 @@ const en = {
"set.searchAll": "Search all settings by name or description…",
"set.search": "Search settings…",
"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.updating": "Updating the client",
"fr.lan.address": "Network address",
"fr.lan.automatic": "Automatic",
"fr.lan.default": "Default",
"fr.lan.custom": "Custom address…",
"fr.lan.customIpv4": "Custom IPv4 address",
"fr.lan.unavailable": "Selected address unavailable",
"fr.lan.unavailableText": "The selected address is not currently assigned to a detected local interface. Choose another address or switch to Automatic, or keep this address intentionally.",
"fr.lan.invalid": "Invalid IPv4 address",
"unsaved.title": "Unsaved changes",
"unsaved.message": "You have unsaved changes. Do you want to save them before leaving this page?",
"unsaved.saveFailed": "Failed to save changes. Please check fields for errors.",
"crash.autoRestart": "Auto-restart on crash",
"crash.autoRestartDesc": "Automatically restart the world server if it crashes or stops unexpectedly.",
"crash.badge": "Crashes: {n}",
"crash.historyTitle": "Server Crash History",
"crash.noCrashes": "No crash reports found.",
"crash.restartNotice": "Server crashed and was automatically restarted (Crash #{n}).",
"crash.loopPaused": "Auto-restart paused: the server crashed repeatedly in a short period.",
"crash.details": "Crash Details",
"crash.viewRaw": "View full crash report",
"crash.hideRaw": "Hide full report",
"crash.copyReport": "Copy crash report",
"crash.copied": "Copied!",
} as const;
export default en;
+73 -7
View File
@@ -20,7 +20,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
"nav.overview": "Resumen",
"nav.bots": "Bots",
"nav.server": "Servidor",
"nav.players": "Jugadores",
"nav.players": "Cuentas",
"nav.friends": "Jugar con amigos",
"nav.backups": "Copias de seguridad",
"nav.console": "Consola",
@@ -32,7 +32,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
"q.overview": "¿Está funcionando mi servidor?",
"q.bots": "¿Cómo están configurados mis bots?",
"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.backups": "¿Están seguros mis datos?",
"q.console": "¿Qué está haciendo el servidor?",
@@ -167,7 +167,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
"install.open": "ABRIR MI SERVIDOR",
// Players
"players.title": "Jugadores",
"players.title": "Cuentas",
"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.startFirst": "Inicia primero el servidor: las cuentas se crean mientras está en marcha.",
@@ -495,7 +495,7 @@ const es: Partial<Record<keyof typeof en, string>> = {
"ustep.Updating the database": "Actualizando la base de datos",
"ustep.Starting the updated server": "Iniciando el servidor actualizado",
"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",
// Companion sizes
@@ -702,9 +702,9 @@ const es: Partial<Record<keyof typeof en, string>> = {
"rep.expectedHint": "Describe el comportamiento esperado.",
"rep.steps": "Pasos para reproducirlo",
"rep.attachTitle": "Registros y capturas",
"rep.attachText": "Crea un archivo de diagnóstico (ajustes y registros sin contraseñas ni direcciones) y arrástralo, junto con capturas o vídeos, a la página de GitHub cuando se abra.",
"rep.attachText": "Un clic reúne el diagnóstico: registros del Manager y del servidor, informes de fallos, registros de fallos de Windows y diarios de actualización, sin contraseñas ni direcciones. Se abre la carpeta del archivo; arrástralo, junto con capturas o vídeos, a la página de GitHub.",
"rep.makeFile": "Crear el archivo de diagnóstico",
"rep.fileSaved": "Guardado en {path}. Arrastra este archivo al issue de GitHub.",
"rep.fileSaved": "Guardado en {path}. Se abrió la carpeta. Arrastra este archivo al issue de GitHub.",
"rep.privacy": "Elimina contraseñas, tokens, información de IP privada y otros datos sensibles antes de publicar registros.",
"rep.open": "Abrir el informe en GitHub",
"rep.copy": "Copiar el texto",
@@ -714,6 +714,17 @@ const es: Partial<Record<keyof typeof en, string>> = {
"rep.opened": "GitHub se abrió en tu navegador. Revisa el texto, adjunta archivos y pulsa «Submit new issue».",
"rep.openedLong": "El informe es demasiado largo para un enlace, así que se copió al portapapeles. GitHub está abierto: pégalo (Ctrl+V) en la descripción, adjunta archivos y pulsa «Submit new issue».",
"rep.copied": "Copiado al portapapeles.",
"rep.targetTitle": "¿Sobre qué es el problema?",
"rep.target.manager": "CoA Server Manager, el servidor u otros módulos",
"rep.target.companions": "CoA Companions (bots y el addon CoABotUI)",
"rep.target.squid": "SQUID Playerbots",
"rep.targetPublic": "El informe será público en GitHub, en {repo}.",
"rep.botsVersion": "Versión de los bots",
"rep.withDiag": "Reunir el diagnóstico por mí (recomendado)",
"rep.collectOpen": "Reunir el diagnóstico y abrir el informe",
"rep.collecting": "Reuniendo el diagnóstico…",
"overview.reportHint": "¿Un servicio se detuvo solo?",
"overview.reportBtn": "Reunir el diagnóstico y avisar",
// Realmlist switcher and modules page
"realm.profileLabel": "Reino",
@@ -751,7 +762,9 @@ const es: Partial<Record<keyof typeof en, string>> = {
"mod.noSettings": "No hay ajustes adicionales. Usa el interruptor del módulo de arriba.",
"err.bot_modules_conflict.title": "Hay dos módulos de bots activos",
"err.bot_modules_conflict.message": "Desactiva CoA Companions o SQUID Playerbots en Módulos antes de iniciar el servidor.",
"mod.ahbot.setup": "Indica el GUID de un personaje dedicado a subastas y activa vendedor y módulo. El personaje debe estar desconectado. El filtro CoA usa botín, vendedores y profesiones; los límites de nivel se aplican además. Requiere un servidor con filtro de subastas CoA.",
"mod.ahbot.setup": "Activa el módulo y el vendedor. El servidor crea por sí mismo un personaje de subastas (cuenta AHBOT) en el primer arranque, no hace falta GUID. Un solo personaje publica en las casas de subastas de ambas facciones. El filtro CoA usa botín, vendedores y profesiones; los límites de nivel se aplican además. Requiere un servidor con filtro de subastas CoA y personaje de subastas automático.",
"mod.enchanter.add": "Colocar al encantador: ponte donde quieras y escribe .npc add 601015",
"mod.enchanter.remove": "Quitar al encantador: selecciona al PNJ y escribe .npc delete",
"mod.ahbot.allSettings": "Todos los ajustes de subastas",
"mod.title": "Módulos",
"mod.intro": "Funciones adicionales integradas en el servidor. Activa o desactiva las que quieras, abre su página de GitHub o cambia sus ajustes.",
@@ -814,8 +827,61 @@ const es: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Buscar en todos los ajustes por nombre o descripción…",
"set.search": "Buscar ajustes…",
"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.updating": "Actualizando el cliente",
"fr.lan.address": "Dirección de red",
"fr.lan.automatic": "Automática",
"fr.lan.default": "Predeterminada",
"fr.lan.custom": "Dirección personalizada…",
"fr.lan.customIpv4": "Dirección IPv4 personalizada",
"fr.lan.unavailable": "Dirección seleccionada no disponible",
"fr.lan.unavailableText": "La dirección seleccionada no está asignada actualmente a ninguna interfaz local detectada. Elige otra dirección o Automática, o conserva esta dirección si así lo deseas.",
"fr.lan.invalid": "Dirección IPv4 no válida",
"unsaved.title": "Cambios sin guardar",
"unsaved.message": "¿Tienes cambios sin guardar. ¿Quieres guardarlos antes de salir de esta página?",
"unsaved.saveFailed": "Error al guardar los cambios. Revisa los campos.",
"crash.autoRestart": "Reinicio automático tras caída",
"crash.autoRestartDesc": "Reinicia automáticamente el servidor si se detiene de forma inesperada.",
"crash.badge": "Caídas: {n}",
"crash.historyTitle": "Historial de caídas del servidor",
"crash.noCrashes": "No se encontraron informes de caídas.",
"crash.restartNotice": "El servidor se cayó y se reinició automáticamente (Caída #{n}).",
"crash.loopPaused": "Reinicio automático pausado: el servidor se ha caído varias veces en poco tiempo.",
"crash.details": "Detalles de la caída",
"crash.viewRaw": "Ver informe completo",
"crash.hideRaw": "Ocultar informe completo",
"crash.copyReport": "Copiar informe",
"crash.copied": "¡Copiado!",
};
export default es;
+73 -7
View File
@@ -20,7 +20,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"nav.overview": "Vue d’ensemble",
"nav.bots": "Bots",
"nav.server": "Serveur",
"nav.players": "Joueurs",
"nav.players": "Comptes",
"nav.friends": "Jouer avec des amis",
"nav.backups": "Sauvegardes",
"nav.console": "Console",
@@ -32,7 +32,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"q.overview": "Mon serveur fonctionne-t-il ?",
"q.bots": "Comment mes bots sont-ils configurés ?",
"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.backups": "Mes données sont-elles en sécurité ?",
"q.console": "Que fait le serveur ?",
@@ -167,7 +167,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"install.open": "OUVRIR MON SERVEUR",
// Players
"players.title": "Joueurs",
"players.title": "Comptes",
"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.startFirst": "Démarrez d’abord le serveur : les comptes sont créés pendant qu’il fonctionne.",
@@ -495,7 +495,7 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"ustep.Updating the database": "Mise à jour de la base de données",
"ustep.Starting the updated server": "Démarrage du serveur mis à jour",
"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é",
// Companion sizes
@@ -702,9 +702,9 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"rep.expectedHint": "Décrivez le comportement attendu.",
"rep.steps": "Étapes pour reproduire",
"rep.attachTitle": "Journaux et captures d’écran",
"rep.attachText": "Créez un fichier de diagnostic (réglages et journaux sans mots de passe ni adresses) et glissez-le, avec vos captures ou vidéos, sur la page GitHub une fois ouverte.",
"rep.attachText": "Un clic rassemble le diagnostic : journaux du Manager et du serveur, rapports de plantage, enregistrements de plantage de Windows et journaux de mise à jour, sans mots de passe ni adresses. Le dossier du fichier s’ouvre ; glissez le fichier, avec vos captures ou vidéos, sur la page GitHub.",
"rep.makeFile": "Créer le fichier de diagnostic",
"rep.fileSaved": "Enregistré dans {path}. Glissez ce fichier dans l’issue GitHub.",
"rep.fileSaved": "Enregistré dans {path}. Le dossier a été ouvert. Glissez ce fichier dans l’issue GitHub.",
"rep.privacy": "Veuillez retirer les mots de passe, jetons, adresses IP privées et autres données sensibles avant de publier des journaux.",
"rep.open": "Ouvrir le rapport sur GitHub",
"rep.copy": "Copier le texte",
@@ -714,6 +714,17 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"rep.opened": "GitHub s’est ouvert dans votre navigateur. Vérifiez le texte, joignez les fichiers et appuyez sur « Submit new issue ».",
"rep.openedLong": "Le rapport est trop long pour un lien : il a été copié dans le presse-papiers. GitHub est ouvert : collez-le (Ctrl+V) dans la description, joignez les fichiers et appuyez sur « Submit new issue ».",
"rep.copied": "Copié dans le presse-papiers.",
"rep.targetTitle": "De quoi parle le problème ?",
"rep.target.manager": "CoA Server Manager, le serveur ou d’autres modules",
"rep.target.companions": "CoA Companions (bots et addon CoABotUI)",
"rep.target.squid": "SQUID Playerbots",
"rep.targetPublic": "Le rapport sera public sur GitHub dans {repo}.",
"rep.botsVersion": "Version des bots",
"rep.withDiag": "Rassembler le diagnostic pour moi (recommandé)",
"rep.collectOpen": "Rassembler le diagnostic et ouvrir le rapport",
"rep.collecting": "Collecte du diagnostic…",
"overview.reportHint": "Un service s’est arrêté tout seul ?",
"overview.reportBtn": "Rassembler le diagnostic et signaler",
// Realmlist switcher and modules page
"realm.profileLabel": "Royaume",
@@ -751,7 +762,9 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"mod.noSettings": "Aucun réglage supplémentaire. Utilisez l’interrupteur du module ci-dessus.",
"err.bot_modules_conflict.title": "Deux modules de bots sont activés",
"err.bot_modules_conflict.message": "Désactivez CoA Companions ou SQUID Playerbots dans Modules avant de démarrer le serveur.",
"mod.ahbot.setup": "Indiquez le GUID d’un personnage dédié aux enchères, activez le vendeur et le module. Le personnage doit être hors ligne. Le filtre CoA utilise le butin, les vendeurs et les métiers ; les limites de niveau s’ajoutent. Nécessite un serveur avec le filtre d’enchères CoA.",
"mod.ahbot.setup": "Activez le module et le vendeur. Le serveur crée lui-même un personnage d’enchères (compte AHBOT) au premier démarrage, aucun GUID n’est nécessaire. Un seul personnage met en vente dans les hôtels des ventes des deux factions. Le filtre CoA utilise le butin, les vendeurs et les métiers ; les limites de niveau s’ajoutent. Nécessite un serveur avec le filtre d’enchères CoA et le personnage d’enchères automatique.",
"mod.enchanter.add": "Placer l’enchanteur : placez-vous à l’endroit voulu et saisissez .npc add 601015",
"mod.enchanter.remove": "Retirer l’enchanteur : ciblez le PNJ et saisissez .npc delete",
"mod.ahbot.allSettings": "Tous les réglages d’enchères",
"mod.title": "Modules",
"mod.intro": "Fonctions supplémentaires intégrées au serveur. Activez ou désactivez celles que vous voulez, ouvrez leur page GitHub ou modifiez leurs réglages.",
@@ -814,8 +827,61 @@ const fr: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Rechercher dans tous les réglages par nom ou description…",
"set.search": "Rechercher un réglage…",
"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.updating": "Mise à jour du client",
"fr.lan.address": "Adresse réseau",
"fr.lan.automatic": "Automatique",
"fr.lan.default": "Par défaut",
"fr.lan.custom": "Adresse personnalisée…",
"fr.lan.customIpv4": "Adresse IPv4 personnalisée",
"fr.lan.unavailable": "Adresse sélectionnée indisponible",
"fr.lan.unavailableText": "Cette adresse n’est actuellement attribuée à aucune interface locale détectée. Choisissez une autre adresse ou le mode Automatique, ou conservez volontairement cette adresse.",
"fr.lan.invalid": "Adresse IPv4 non valide",
"unsaved.title": "Modifications non enregistrées",
"unsaved.message": "Vous avez des modifications non enregistrées. Voulez-vous les enregistrer avant de quitter cette page ?",
"unsaved.saveFailed": "Échec de l’enregistrement. Veuillez vérifier les champs.",
"crash.autoRestart": "Redémarrage automatique en cas de plantage",
"crash.autoRestartDesc": "Redémarre automatiquement le serveur s’il plante ou s’arrête de manière inattendue.",
"crash.badge": "Plantages : {n}",
"crash.historyTitle": "Historique des plantages du serveur",
"crash.noCrashes": "Aucun rapport de plantage trouvé.",
"crash.restartNotice": "Le serveur a planté et a été redémarré automatiquement (Plantage #{n}).",
"crash.loopPaused": "Redémarrage automatique suspendu : le serveur a planté plusieurs fois successivement.",
"crash.details": "Détails du plantage",
"crash.viewRaw": "Afficher le rapport complet",
"crash.hideRaw": "Masquer le rapport complet",
"crash.copyReport": "Copier le rapport",
"crash.copied": "Copié !",
};
export default fr;
+75 -7
View File
@@ -34,6 +34,8 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"repair.result": "Восстановлено файлов: {files}. Применено обновлений БД: {sql}.",
"repair.backup": "Резервная копия: {id}",
"repair.fileCount": "Изменённых или отсутствующих файлов: {n}",
"repair.fileMissing": "нет файла",
"repair.fileChanged": "изменён",
"repair.dbCount": "Проблем структуры БД/стартовых данных: {columns}. Ожидающих или неудачных SQL: {sql}.",
"repair.limited": "В старом пакете нет полного описания схемы. Проверяются только колонки сохранения персонажей и стартовые данные.",
"repair.unresolved": "Проблемы БД остались. Repair не повторяет уже применённые SQL и не добавляет колонки наугад. Экспортируйте диагностику с этим списком для исправляющего обновления сервера.",
@@ -51,7 +53,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"nav.overview": "Обзор",
"nav.bots": "Боты",
"nav.server": "Сервер",
"nav.players": "Игроки",
"nav.players": "Аккаунты",
"nav.friends": "Игра с друзьями",
"nav.backups": "Резервные копии",
"nav.console": "Консоль",
@@ -63,7 +65,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"q.overview": "Мой сервер работает?",
"q.bots": "Как настроены мои боты?",
"q.server": "Как ведёт себя мой сервер?",
"q.players": "Кто сейчас играет?",
"q.players": "Кто может войти в игру?",
"q.friends": "Как подключиться другу?",
"q.backups": "Мои данные в безопасности?",
"q.console": "Что делает сервер?",
@@ -198,7 +200,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"install.open": "ОТКРЫТЬ МОЙ СЕРВЕР",
// Players
"players.title": "Игроки",
"players.title": "Аккаунты",
"players.createTitle": "Создайте свою учётную запись",
"players.createText": "Это имя и пароль, с которыми вы входите в игру.",
"players.startFirst": "Сначала запустите сервер — учётные записи создаются, пока он работает.",
@@ -526,7 +528,7 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"ustep.Updating the database": "Обновление базы данных",
"ustep.Starting the updated server": "Запуск обновлённого сервера",
"ustep.Finishing": "Завершение",
"ustep.Undoing the update": "Откат обновления",
"ustep.Undoing the update": "Отмена обновления (восстановление баз данных может занять несколько минут)",
"ustep.Done": "Готово",
// Companion sizes
@@ -733,9 +735,9 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"rep.expectedHint": "Опишите ожидаемое поведение.",
"rep.steps": "Как воспроизвести",
"rep.attachTitle": "Логи и скриншоты",
"rep.attachText": "Создайте файл диагностики (настройки и логи без паролей и адресов) и перетащите его вместе со скриншотами или видео на страницу GitHub, когда она откроется.",
"rep.attachText": "Диагностика собирается одним нажатием: логи менеджера и сервера, отчёты о падениях, записи Windows о сбоях и журналы обновлений, без паролей и адресов. Откроется папка с файлом; перетащите его вместе со скриншотами или видео на страницу GitHub.",
"rep.makeFile": "Создать файл диагностики",
"rep.fileSaved": "Сохранено: {path}. Перетащите этот файл в issue на GitHub.",
"rep.fileSaved": "Сохранено: {path}. Папка открыта. Перетащите этот файл в issue на GitHub.",
"rep.privacy": "Перед публикацией логов удалите пароли, токены, частные IP-адреса и другие личные данные.",
"rep.open": "Открыть отчёт на GitHub",
"rep.copy": "Копировать текст",
@@ -745,6 +747,17 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"rep.opened": "GitHub открыт в браузере. Проверьте текст, прикрепите файлы и нажмите «Submit new issue».",
"rep.openedLong": "Отчёт слишком длинный для ссылки, поэтому он скопирован в буфер обмена. GitHub открыт: вставьте текст (Ctrl+V) в описание, прикрепите файлы и нажмите «Submit new issue».",
"rep.copied": "Скопировано в буфер обмена.",
"rep.targetTitle": "О чём проблема?",
"rep.target.manager": "CoA Server Manager, сервер или другие модули",
"rep.target.companions": "CoA Companions (боты и аддон CoABotUI)",
"rep.target.squid": "SQUID Playerbots",
"rep.targetPublic": "Репорт будет публичным на GitHub в {repo}.",
"rep.botsVersion": "Версия ботов",
"rep.withDiag": "Собрать диагностику за меня (рекомендуется)",
"rep.collectOpen": "Собрать диагностику и открыть репорт",
"rep.collecting": "Собираю диагностику…",
"overview.reportHint": "Служба остановилась сама?",
"overview.reportBtn": "Собрать диагностику и сообщить",
// Realmlist switcher and modules page
"realm.label": "Реалм",
@@ -768,7 +781,9 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"mod.ahbot.weightsHint": "Это относительные веса, а не проценты. 0 исключает качество; большее значение повышает частоту. Если все значения по умолчанию равны нулю, включается обычное качество. Остальные фильтры продолжают действовать.",
"mod.ahbot.noTypes": "Все типы отключены. Продавцу не из чего выбирать новые лоты.",
"mod.noSettings": "Дополнительных настроек нет. Используйте переключатель модуля выше.",
"mod.ahbot.setup": "Укажите GUID отдельного персонажа аукциониста, включите продавца и модуль. Персонаж должен быть офлайн. Фильтр CoA оставляет предметы из таблиц добычи, торговцев и профессий; ограничения уровней применяются дополнительно. Нужна сборка сервера с фильтром аукциона CoA.",
"mod.ahbot.setup": "Включите модуль и продавца. Сервер сам создаст персонажа аукциона (аккаунт AHBOT) при первом запуске, GUID вводить не нужно. Один персонаж выставляет лоты в аукционах обеих фракций. Фильтр CoA оставляет предметы из таблиц добычи, торговцев и профессий; ограничения уровней действуют дополнительно. Нужна сборка сервера с фильтром аукциона CoA и автоматическим персонажем аукциона.",
"mod.enchanter.add": "Разместить НПС зачарователя: встаньте в нужное место и введите команду .npc add 601015",
"mod.enchanter.remove": "Удалить НПС зачарователя: возьмите НПС в цель и введите команду .npc delete",
"mod.ahbot.allSettings": "Все настройки",
"err.bot_modules_conflict.title": "Включены две системы ботов",
"err.bot_modules_conflict.message": "Выключите CoA Companions или SQUID Playerbots в разделе «Модули» перед запуском сервера.",
@@ -833,8 +848,61 @@ const ru: Partial<Record<keyof typeof en, string>> = {
"set.searchAll": "Поиск по всем настройкам: название или описание…",
"set.search": "Поиск по настройкам…",
"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.updating": "Обновление клиента",
"fr.lan.address": "Сетевой адрес",
"fr.lan.automatic": "Автоматически",
"fr.lan.default": "По умолчанию",
"fr.lan.custom": "Другой адрес…",
"fr.lan.customIpv4": "Свой IPv4-адрес",
"fr.lan.unavailable": "Выбранный адрес недоступен",
"fr.lan.unavailableText": "Выбранный адрес сейчас не назначен обнаруженному сетевому интерфейсу. Выберите другой адрес, переключитесь на автоматический выбор или намеренно сохраните этот адрес.",
"fr.lan.invalid": "Некорректный IPv4-адрес",
"unsaved.title": "Несохранённые изменения",
"unsaved.message": "У вас есть несохранённые изменения. Сохранить их перед переходом на другую страницу?",
"unsaved.saveFailed": "Не удалось сохранить настройки. Проверьте правильность значений.",
"crash.autoRestart": "Автоподнятие при падении",
"crash.autoRestartDesc": "Автоматически перезапускать сервер при внезапном падении или сбое.",
"crash.badge": "Крашей: {n}",
"crash.historyTitle": "История падений сервера",
"crash.noCrashes": "Отчётов о падениях не найдено.",
"crash.restartNotice": "Сервер упал и был автоматически перезапущен (Сбой #{n}).",
"crash.loopPaused": "Автоподнятие приостановлено: сервер упал несколько раз подряд за короткое время.",
"crash.details": "Подробности сбоя",
"crash.viewRaw": "Показать полный отчёт",
"crash.hideRaw": "Скрыть полный отчёт",
"crash.copyReport": "Скопировать отчёт",
"crash.copied": "Скопировано!",
};
export default ru;
+73 -7
View File
@@ -32,7 +32,7 @@ const zh = {
"nav.overview": "概览",
"nav.bots": "机器人",
"nav.server": "服务器",
"nav.players": "玩家",
"nav.players": "账号",
"nav.friends": "好友联机",
"nav.backups": "备份",
"nav.console": "控制台",
@@ -44,7 +44,7 @@ const zh = {
"q.overview": "服务器当前是否正在运行?",
"q.bots": "机器人目前是如何配置的?",
"q.server": "服务器机制与规则是如何运行的?",
"q.players": "当前有哪些玩家在线?",
"q.players": "谁可以登录游戏?",
"q.friends": "好友如何加入我的服务器?",
"q.backups": "我的数据是否安全?",
"q.console": "服务器正在输出什么日志?",
@@ -179,7 +179,7 @@ const zh = {
"install.open": "打开我的服务器",
// Players
"players.title": "玩家",
"players.title": "账号",
"players.createTitle": "创建游戏账号",
"players.createText": "用于登录游戏的账号名称和密码。",
"players.startFirst": "请先启动服务器 —— 账号需要在服务器运行时创建。",
@@ -507,7 +507,7 @@ const zh = {
"ustep.Updating the database": "正在更新数据库结构",
"ustep.Starting the updated server": "正在启动更新后的服务器",
"ustep.Finishing": "正在收尾完成",
"ustep.Undoing the update": "正在撤销更新并回滚",
"ustep.Undoing the update": "正在撤销更新(恢复数据库可能需要几分钟)",
"ustep.Done": "已完成",
// Companion sizes
@@ -714,9 +714,9 @@ const zh = {
"rep.expectedHint": "描述你期望的正常表现。",
"rep.steps": "复现步骤",
"rep.attachTitle": "日志与截图附件",
"rep.attachText": "生成一份诊断包文件(已自动脱敏密码与私有 IP 等敏感信息),并在浏览器打开 GitHub 页面后,将其连同截图或录屏一起拖拽上传。",
"rep.attachText": "一键收集诊断信息:管理器与服务器日志、崩溃报告、Windows 崩溃记录和更新日志(已去除密码与地址)。文件所在文件夹会自动打开;请将该文件连同截图或录屏一起拖入 GitHub 页面。",
"rep.makeFile": "生成诊断包文件",
"rep.fileSaved": "已保存至 {path}。请将该文件拖入 GitHub Issue 中。",
"rep.fileSaved": "已保存至 {path}。文件夹已打开。请将该文件拖入 GitHub Issue 中。",
"rep.privacy": "上传前请注意检查并移除日志中可能包含的私有密码、Token 或其他敏感隐私信息。",
"rep.open": "在 GitHub 上打开报告",
"rep.copy": "复制报告文本",
@@ -726,6 +726,17 @@ const zh = {
"rep.opened": "已在浏览器中打开 GitHub。请检查内容、附上日志文件并点击“Submit new issue”。",
"rep.openedLong": "报告内容较长超出 URL 长度限制,已自动复制到剪贴板。请在已打开的 GitHub 页面中按 Ctrl+V 粘贴描述,附上文件后提交。",
"rep.copied": "已复制到剪贴板。",
"rep.targetTitle": "问题与什么有关?",
"rep.target.manager": "CoA Server Manager、服务器或其他模块",
"rep.target.companions": "CoA Companions(机器人与 CoABotUI 插件)",
"rep.target.squid": "SQUID Playerbots",
"rep.targetPublic": "该报告将公开发布在 GitHub 的 {repo}。",
"rep.botsVersion": "机器人版本",
"rep.withDiag": "替我收集诊断信息(推荐)",
"rep.collectOpen": "收集诊断信息并打开报告",
"rep.collecting": "正在收集诊断信息…",
"overview.reportHint": "某个服务自己停止了?",
"overview.reportBtn": "收集诊断信息并反馈",
// Realmlist switcher and modules page
"realm.label": "服务器列表",
@@ -751,7 +762,9 @@ const zh = {
"mod.noSettings": "没有其他设置,请使用上方模块开关。",
"err.bot_modules_conflict.title": "已启用两个机器人模块",
"err.bot_modules_conflict.message": "启动服务器前,请在模块中关闭CoA Companions或SQUID Playerbots。",
"mod.ahbot.setup": "填写独立拍卖角色的GUID,并启用卖家和模块。角色必须离线。CoA筛选使用掉落、商人和专业物品表,等级限制另行生效。需要包含CoA拍卖筛选的服务器版本。",
"mod.ahbot.setup": "启用模块和卖家即可。服务器首次启动时会自动创建拍卖角色(账号AHBOT),无需填写GUID。一个角色即可在双方阵营的拍卖行上架。CoA筛选使用掉落、商人和专业物品表,等级限制另行生效。需要包含CoA拍卖筛选和自动拍卖角色的服务器版本。",
"mod.enchanter.add": "放置附魔师NPC:站在想要的位置,输入 .npc add 601015",
"mod.enchanter.remove": "删除附魔师NPC:选中该NPC,输入 .npc delete",
"mod.ahbot.allSettings": "所有拍卖设置",
"mod.title": "模块管理",
"mod.intro": "服务器内置的可选扩展特性。可按需开关、访问其 GitHub 页面或调整独立参数。",
@@ -814,10 +827,63 @@ const zh = {
"set.searchAll": "按名称或描述搜索全部设置…",
"set.search": "搜索设置…",
"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.updating": "正在更新游戏客户端",
"err.docker_unavailable.title": "Docker 不可用",
"err.docker_unavailable.message": "此服务器通过 Docker 运行。请安装并启动 Docker,确保当前用户有权使用它,然后重试。",
"fr.lan.address": "网络地址",
"fr.lan.automatic": "自动",
"fr.lan.default": "默认",
"fr.lan.custom": "自定义地址…",
"fr.lan.customIpv4": "自定义 IPv4 地址",
"fr.lan.unavailable": "所选地址不可用",
"fr.lan.unavailableText": "所选地址目前未分配给检测到的本地网络接口。请选择其他地址、切换到自动,或有意保留此地址。",
"fr.lan.invalid": "无效的 IPv4 地址",
"unsaved.title": "未保存的修改",
"unsaved.message": "您有未保存的修改。是否在离开前保存?",
"unsaved.saveFailed": "保存失败,请检查填写内容。",
"crash.autoRestart": "崩溃后自动重启",
"crash.autoRestartDesc": "如果服务器意外崩溃或停止,自动重新拉起。",
"crash.badge": "崩溃次数: {n}",
"crash.historyTitle": "服务器崩溃记录",
"crash.noCrashes": "未找到崩溃日志。",
"crash.restartNotice": "服务器崩溃并已自动重新拉起(崩溃 #{n})。",
"crash.loopPaused": "自动重启已暂停:服务器在短时间内连续崩溃。",
"crash.details": "崩溃详情",
"crash.viewRaw": "查看完整日志",
"crash.hideRaw": "隐藏完整日志",
"crash.copyReport": "复制崩溃报告",
"crash.copied": "已复制!",
} as const;
export default zh;
+1 -1
View File
@@ -525,7 +525,7 @@
},
"AlwaysMaxSkillForLevel": {
"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": {
"t": "Wetter",
+1 -1
View File
@@ -525,7 +525,7 @@
},
"AlwaysMaxSkillForLevel": {
"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": {
"t": "Clima",
+1 -1
View File
@@ -525,7 +525,7 @@
},
"AlwaysMaxSkillForLevel": {
"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": {
"t": "Météo",
+1 -1
View File
@@ -525,7 +525,7 @@
},
"AlwaysMaxSkillForLevel": {
"t": "Навыки всегда на максимуме для уровня",
"d": "Навыки оружия и другие навыки всегда на максимуме для уровня персонажа, учиться не нужно."
"d": "Навыки оружия и другие навыки всегда на максимуме для уровня персонажа, учиться не нужно. Реалм Wildcard всегда включает это для себя."
},
"ActivateWeather": {
"t": "Погода",
+1 -1
View File
@@ -525,7 +525,7 @@
},
"AlwaysMaxSkillForLevel": {
"t": "武器技能自动升满",
"d": "武器及其他熟练度技能自动保持在当前角色等级上限,无需反复练习。"
"d": "武器及其他熟练度技能自动保持在当前角色等级上限,无需反复练习。 Wildcard 领域会始终为自己开启此项。"
},
"ActivateWeather": {
"t": "天气系统",
+103 -7
View File
@@ -78,6 +78,22 @@ export interface DriverOutcome {
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 {
id: string;
name: string;
@@ -217,7 +233,7 @@ export interface ModuleSetting {
value: string;
default: string | null;
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 {
@@ -234,6 +250,29 @@ export interface ReportContext {
windows: string;
install_kind: "new" | "imported";
server_version: string | null;
/** where the form starts: the bot system that is switched on, else the Manager */
suggested_target: ReportTargetId;
/** the release of the bot system that is on */
bots_version: string | null;
}
export type ReportTargetId = "manager" | "companions" | "squid";
/** A place a problem report can go: its GitHub repository as `owner/name`. */
export interface ReportTarget {
id: ReportTargetId;
repo: string;
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 {
@@ -272,6 +311,10 @@ export interface UpdatePreview {
migrations: number;
pending_migrations?: 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 {
@@ -346,11 +389,34 @@ export interface ClientDownloadCheck {
dest: string;
}
export type ClientPatchState = "not-installed" | "enabled" | "disabled" | "partially-installed";
export interface CustomRacesClientStatus {
state: ClientPatchState;
installedMpqs: number;
totalMpqs: number;
hasRootFiles: boolean;
clientPath: string | null;
}
export interface CustomRacesProgress {
id: string;
step: string;
percent: number;
}
export type FriendsMode = "local" | "lan" | "direct" | "private";
export interface LanAddress {
interface: string;
address: string;
is_default: boolean;
}
export interface FriendsStatus {
settings: { mode: FriendsMode; host: string | null };
settings: { mode: FriendsMode; host: string | null; lan_address_override: string | null };
lan_ip: string | null;
lan_addresses: LanAddress[];
exposure: { port: number; what: string; reachable_from_network: boolean; listening: boolean }[];
servers_open: boolean;
firewall: { auth: boolean; world: boolean };
@@ -381,6 +447,21 @@ export interface ConsoleLine {
level: "info" | "warn" | "error";
}
export interface CrashItem {
id: string;
timestamp_ms: number;
date_str: string;
title: string;
explanation: string;
category: "assertion" | "access_violation" | "stack_overflow" | "out_of_memory" | "database" | "network" | "exception" | "generic";
exception_code?: string | null;
location?: string | null;
function?: string | null;
condition?: string | null;
preview: string;
full_log: string;
}
export const api = {
remoteConnection: () => invoke<RemoteConnection>("remote_connection"),
remoteConnect: (host: string) => invoke<RemoteConnection>("remote_connect", { host }),
@@ -401,12 +482,21 @@ export const api = {
save: (id: string, scope: Scope, changes: Record<string, JsonValue>) => invoke<SaveReport>("save_settings", { id, scope, changes }),
presets: (scope: Scope) => invoke<PresetInfo[]>("list_presets", { scope }),
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 }),
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 }),
restoreConfigs: (id: string, backupId: string) => invoke<RecoveryPoint>("restore_backup_configs", { id, backupId }),
restoreDatabase: (id: string, backupId: string, database: string) => invoke<DbRestore>("restore_backup_database", { id, backupId, database }),
installPreflight: (dest: string, needed?: number) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null }),
installEnvironment: () => invoke<InstallEnvironment>("install_environment"),
installPreflight: (dest: string, needed?: number, gameData?: string) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null, gameData: gameData ?? null }),
installRequirements: (pkg?: string) => invoke<InstallRequirements>("install_requirements", { package: pkg ?? null }),
realmlistProfiles: (id: string) => invoke<{ profiles: RealmProfile[]; active: string | null }>("realmlist_profiles", { id }),
realmlistSave: (id: string, profileId: string | null, name: string, data: string) => invoke<RealmProfile>("realmlist_save", { id, profileId, name, data }),
@@ -419,16 +509,18 @@ export const api = {
allSettings: (id: string) => invoke<AllSetting[]>("all_settings", { id }),
allSettingsSave: (id: string, changes: Record<string, string>) => invoke<string[]>("all_settings_save", { id, changes }),
reportContext: (id: string) => invoke<ReportContext>("report_context", { id }),
reportTargets: () => invoke<ReportTarget[]>("report_targets"),
listAccounts: (id: string) => invoke<AccountInfo[]>("list_accounts", { id }),
accountSetPassword: (id: string, name: string, password: string) => invoke<void>("account_set_password", { id, name, password }),
accountSetAccess: (id: string, name: string, level: number) => invoke<void>("account_set_access", { id, name, level }),
accountRename: (id: string, name: string, newName: string, password: string) => invoke<void>("account_rename", { id, name, newName, password }),
accountDelete: (id: string, name: string) => invoke<void>("account_delete", { id, name }),
installNew: (dest: string, pkg?: string) => invoke<ServerSummary>("install_new", { dest, package: pkg ?? null }),
installNew: (dest: string, pkg?: string, gameData?: string) => invoke<ServerSummary>("install_new", { dest, package: pkg ?? null, gameData: gameData ?? null }),
cancelInstall: () => invoke<void>("cancel_install"),
createAccount: (id: string, username: string, password: string, administrator: boolean) =>
invoke<void>("create_account", { id, username, password, administrator }),
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 }),
applyUpdate: (id: string, resolutions: Record<string, "keep" | "replace">, source?: string) =>
invoke<{ txn: UpdateTxn }>("apply_update", { id, source: source ?? null, resolutions }),
@@ -453,15 +545,19 @@ export const api = {
clientSync: (id: string, keepModified: boolean) => invoke<void>("client_sync", { id, keepModified }),
clientDownload: (id: string, parent: string) => invoke<ClientInfo>("client_download", { id, parent }),
clientCancel: () => invoke<void>("client_cancel"),
customRacesStatus: (id: string) => invoke<CustomRacesClientStatus | null>("custom_races_status", { id }),
customRacesInstall: (id: string) => invoke<void>("custom_races_install", { id }),
customRacesToggleClient: (id: string, enabled: boolean) => invoke<void>("custom_races_toggle_client", { id, enabled }),
play: (id: string) => invoke<DriverOutcome>("play", { id }),
friendsStatus: (id: string) => invoke<FriendsStatus>("friends_status", { id }),
friendsCheckInternet: () => invoke<InternetCheck>("friends_check_internet"),
friendsEnable: (id: string, mode: FriendsMode, host?: string, useUpnp = false) =>
invoke<{ host: string; restart_required: boolean; note: string | null }>("friends_enable", { id, mode, host: host ?? null, useUpnp }),
friendsEnable: (id: string, mode: FriendsMode, host?: string, useUpnp = false, lanAddressOverride: string | null = null) =>
invoke<{ host: string; restart_required: boolean; note: string | null }>("friends_enable", { id, mode, host: host ?? null, useUpnp, lanAddressOverride }),
friendsPackage: (id: string) => invoke<string>("friends_package", { id }),
runDiagnostics: (id: string) => invoke<{ checks: DiagCheck[]; problems: number }>("run_diagnostics", { id }),
verifyFiles: (id: string) => invoke<{ path: string; kind: "missing" | "changed" }[]>("verify_files", { id }),
exportDiagnostics: (id: string) => invoke<string>("export_diagnostics", { id }),
listCrashes: (id: string, limit?: number) => invoke<CrashItem[]>("list_crashes", { id, limit: limit ?? null }),
consoleTail: (id: string, source: ConsoleSource, filter?: string, lines = 300) =>
invoke<ConsoleLine[]>("console_tail", { id, source, filter: filter ?? null, lines }),
consoleRisk: (command: string) => invoke<"normal" | "dangerous">("console_risk", { command }),
+32
View File
@@ -0,0 +1,32 @@
import { useState } from "react";
const key = (id: string) => `coa-auto-restart-on-crash:${id}`;
const fallback = () => false;
export function autoRestartOnCrash(id: string): boolean {
try {
const value = localStorage.getItem(key(id));
return value === null ? fallback() : value === "1";
} catch {
return fallback();
}
}
export function setAutoRestartOnCrash(id: string, on: boolean) {
try {
localStorage.setItem(key(id), on ? "1" : "0");
} catch {
/* storage unavailable */
}
}
export function useAutoRestart(id: string): [boolean, (on: boolean) => void] {
const [on, setOn] = useState(() => autoRestartOnCrash(id));
return [
on,
(next) => {
setAutoRestartOnCrash(id, next);
setOn(next);
},
];
}
+2
View File
@@ -1,3 +1,4 @@
import { startAfterUpdate } from "./updatePrefs";
import { useSyncExternalStore } from "react";
import { listen } from "@tauri-apps/api/event";
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 {
await api.clientSync(id, keepModified);
set(id, { phase: "done", step: null });
if (startAfterUpdate("client", id)) void api.play(id).catch(() => undefined);
void refresh(id);
setTimeout(() => {
if (get(id).phase === "done") set(id, { phase: "idle" });
+13 -4
View File
@@ -85,9 +85,14 @@ for (const [key, title, desc] of [
] as [string, string[], string[]][]) add(`Enchanter.${key}`, "int", title, desc, { min: 0, advanced: true });
for (let n = 1; n <= 3; n++) add(`EC.P${n}`, "string", [`NPC phrase ${n}`, `Реплика НПС ${n}`, `NPC-Satz ${n}`, `Phrase du PNJ ${n}`, `Frase del PNJ ${n}`, `NPC台词 ${n}`], ["Text spoken by the NPC. Keep the enclosing quotes.", "Текст реплики НПС. Сохраните кавычки вокруг текста.", "Gesprochener Text. Anführungszeichen beibehalten.", "Texte prononcé. Conservez les guillemets.", "Texto hablado. Conserva las comillas.", "NPC发言内容,请保留外层引号。"], { advanced: true });
add("CoACustomRaces.BotsEnable", "bool",
["Bots can be custom races", "Боты кастомных рас", "Bots benutzerdefinierter Völker", "Bots de races personnalisées", "Bots de razas personalizadas", "允许机器人为自定义种族"],
["Allow Playerbots to spawn as custom races.", "Разрешает ботам-игрокам появляться кастомными расами.", "Erlaubt Spieler-Bots, benutzerdefinierte Völker zu nutzen.", "Autorise les bots joueurs à s’incarner avec des races personnalisées.", "Permite a los bots jugadores crearse con razas personalizadas.", "允许玩家机器人扮演自定义种族。"]
);
const ah = "AuctionHouseBot.";
add(ah + "GUIDs", "string", ["Auction characters", "Персонажи аукциона", "Auktionscharaktere", "Personnages d’enchères", "Personajes de subasta", "拍卖角色"], ["Character GUIDs separated by commas, without spaces. Use dedicated offline characters, not companion bots. 0 selects nobody.", "GUID персонажей через запятую без пробелов. Используйте отдельных офлайн-персонажей, не ботов-компаньонов. 0 — никто.", "Charakter-GUIDs durch Kommas, ohne Leerzeichen. Separate Offline-Charaktere verwenden, keine Begleiter-Bots. 0 wählt niemanden.", "GUID séparés par des virgules sans espaces. Utilisez des personnages dédiés hors ligne, pas des bots compagnons. 0 ne sélectionne personne.", "GUID separados por comas sin espacios. Usa personajes dedicados desconectados, no bots acompañantes. 0 no selecciona a nadie.", "角色GUID以逗号分隔,不加空格。使用专用离线角色,勿用伙伴机器人。0不选择任何角色。"]);
add(ah + "EnableSeller", "bool", ["Post auctions", "Выставлять лоты", "Auktionen einstellen", "Publier des enchères", "Publicar subastas", "发布拍卖"], ["Let the auction characters sell items. The module switch and valid character GUIDs are also required.", "Разрешает персонажам продавать предметы. Нужны включённый модуль и действительные GUID персонажей.", "Erlaubt Verkäufe. Modulschalter und gültige Charakter-GUIDs sind ebenfalls erforderlich.", "Autorise les ventes. Le module doit être activé et les GUID valides.", "Permite vender. También requiere el módulo activado y GUID válidos.", "允许拍卖角色出售物品,还需启用模块并填写有效角色GUID。"]);
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 + "CoA.ObtainableItemsOnly", "bool", ["Only obtainable items", "Только доступные в игре предметы", "Nur erhältliche Gegenstände", "Objets accessibles uniquement", "Solo objetos obtenibles", "仅可获取物品"], ["List items from world loot, vendors and professions. Other item filters still apply.", "Выставляет предметы из добычи, торговцев и профессий. Остальные фильтры продолжают действовать.", "Listet Gegenstände aus Beute, Händlern und Berufen. Weitere Filter gelten weiterhin.", "Publie les objets de butin, vendeurs et métiers. Les autres filtres s’appliquent.", "Publica objetos de botín, vendedores y profesiones. Los demás filtros siguen activos.", "发布来自掉落、商人和专业的物品,其他筛选仍生效。"]);
add(ah + "ItemsPerCycle", "int", ["Listings per cycle", "Лотов за цикл", "Angebote pro Durchlauf", "Annonces par cycle", "Anuncios por ciclo", "每轮上架数量"], ["Maximum items posted during one auction update.", "Максимум предметов за одно обновление аукциона.", "Maximale Angebote pro Auktionsaktualisierung.", "Nombre maximal d’objets par mise à jour.", "Máximo de objetos por actualización.", "每轮拍卖更新最多上架的物品数量。"], { min: 0 });
for (const [kind, titles] of [
@@ -104,7 +109,7 @@ for (const [faction, names] of [
`${names[0]}: ${maximum ? "maximum" : "minimum"} listings`, `${names[1]}: ${maximum ? "максимум" : "минимум"} лотов`, `${names[2]}: ${maximum ? "maximale" : "minimale"} Angebote`, `${names[3]} : annonces ${maximum ? "maximales" : "minimales"}`, `${names[4]}: anuncios ${maximum ? "máximos" : "mínimos"}`, `${names[5]}:${maximum ? "最多" : "最少"}上架数量`,
], ["Target listing count for this auction house. Keep the minimum no higher than the maximum.", "Целевое число лотов этого аукциона. Минимум не должен превышать максимум.", "Zielanzahl für dieses Auktionshaus. Minimum nicht höher als Maximum einstellen.", "Nombre cible pour cet hôtel des ventes. Le minimum ne doit pas dépasser le maximum.", "Cantidad objetivo para esta casa de subastas. El mínimo no debe superar el máximo.", "此拍卖行的目标上架数量,最小值不得超过最大值。"], { min: 0 });
}
add(ah + "Buyer.Enabled", "bool", ["Buy player auctions", "Покупать лоты игроков", "Spielerauktionen kaufen", "Acheter les enchères des joueurs", "Comprar subastas de jugadores", "购买玩家拍卖"], ["Enable the auction buyer. It spends the auction characters’ money.", "Включает покупателя. Он тратит деньги персонажей аукциона.", "Aktiviert Käufe mit dem Geld der Auktionscharaktere.", "Active les achats avec l’argent des personnages d’enchères.", "Activa las compras con el dinero de los personajes de subasta.", "启用拍卖买家,会花费拍卖角色的金币。"]);
add(ah + "Buyer.Enabled", "bool", ["Buy player auctions", "Покупать лоты игроков", "Spielerauktionen kaufen", "Acheter les enchères des joueurs", "Comprar subastas de jugadores", "购买玩家拍卖"], ["The auctioneer bot buys listings.", "Бот-аукционист покупает лоты.", "Der Auktionator-Bot kauft Angebote.", "Le bot commissaire-priseur achète des annonces.", "El bot subastador compra anuncios.", "拍卖机器人会购买拍卖品。"]);
add(ah + "Buyer.BuyCandidatesPerBuyCycle", "int", ["Purchase candidates per cycle", "Кандидатов на покупку за цикл", "Kaufkandidaten pro Durchlauf", "Achats potentiels par cycle", "Candidatos de compra por ciclo", "每轮购买候选数量"], ["How many auctions the buyer considers per cycle.", "Сколько лотов покупатель рассматривает за цикл.", "Anzahl geprüfter Auktionen pro Durchlauf.", "Nombre d’enchères examinées par cycle.", "Subastas examinadas por ciclo.", "买家每轮考虑的拍卖数量。"], { min: 0 });
add(ah + "Buyer.AcceptablePriceModifier", "float", ["Buyer price multiplier", "Множитель цены покупателя", "Kaufpreisfaktor", "Multiplicateur du prix d’achat", "Multiplicador del precio de compra", "买家价格倍率"], ["1 uses the calculated price. Higher values allow more expensive purchases.", "1 — расчётная цена. Большие значения допускают более дорогие покупки.", "1 nutzt den berechneten Preis. Höhere Werte erlauben teurere Käufe.", "1 utilise le prix calculé. Une valeur supérieure autorise des achats plus chers.", "1 usa el precio calculado. Valores mayores permiten compras más caras.", "1使用计算价格,增大后允许更高价购买。"], { min: 0 });
add(ah + "MaxBuyoutPriceInCopper", "int", ["Maximum buyout (copper)", "Максимальная цена выкупа (медь)", "Maximaler Sofortkauf (Kupfer)", "Rachat maximal (cuivre)", "Compra máxima (cobre)", "最高一口价(铜币)"], ["Upper price limit. 10,000 copper = 1 gold.", "Верхний предел цены. 10 000 меди = 1 золото.", "Preisobergrenze. 10.000 Kupfer = 1 Gold.", "Prix maximal. 10 000 cuivre = 1 or.", "Precio máximo. 10 000 cobre = 1 oro.", "价格上限,10000铜币=1金币。"], { min: 0 });
@@ -175,7 +180,11 @@ for (const [category, categoryNames] of Object.entries(auctionCategories)) {
}
export function moduleField(key: string, locale: Locale, metadata?: ModuleSetting["field"]): ModuleField | 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);
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);
+13 -4
View File
@@ -1,9 +1,14 @@
import type { ReportTarget, ReportTargetId } from "./api";
/** The text of a problem report, always in English so whoever reads it on GitHub can follow it; the person's own words go in as typed. */
export interface ReportInput {
managerVersion: string;
windows: string;
installKind: "new" | "imported";
serverVersion: string | null;
/** where the report goes; a bot repository is told which Manager and bot release it came from */
target: ReportTargetId;
botsVersion: string | null;
what: string;
expected: string;
steps: string;
@@ -11,7 +16,10 @@ export interface ReportInput {
diagnostics: boolean;
}
export const NEW_ISSUE_URL = "https://github.com/Corfirean/coa-server-manager/issues/new";
/** The "new issue" page of a repository given as `owner/name`. */
export function newIssueUrl(repo: string): string {
return `https://github.com/${repo}/issues/new`;
}
const PRIVACY = "> Please remove passwords, tokens, private IP information or other sensitive data before posting logs.";
export function reportBody(r: ReportInput): string {
@@ -23,6 +31,7 @@ export function reportBody(r: ReportInput): string {
`**Windows version:** ${r.windows || "unknown"} `,
`**Fresh install or imported server:** ${r.installKind === "new" ? "Fresh install" : "Imported server"} `,
...(r.serverVersion ? [`**Server version:** ${r.serverVersion} `] : []),
...(r.target !== "manager" ? [`**Bot system:** ${r.target === "squid" ? "SQUID Playerbots" : "CoA Companions"}${r.botsVersion ? ` ${r.botsVersion}` : ""} `] : []),
"",
"**What happened?** ",
text(r.what, "Describe the problem."),
@@ -54,9 +63,9 @@ export function encodeQuery(s: string): string {
.join("");
}
/** A link that opens GitHub's "new issue" page with the title and text filled in. */
export function issueUrl(title: string, body: string): string {
return `${NEW_ISSUE_URL}?labels=bug&title=${encodeQuery(title)}&body=${encodeQuery(body)}`;
/** A link that opens GitHub's "new issue" page of `target` with the title and text filled in. The bug label is only asked for in our own repositories. */
export function issueUrl(target: Pick<ReportTarget, "repo" | "ours">, title: string, body: string): string {
return `${newIssueUrl(target.repo)}?${target.ours ? "labels=bug&" : ""}title=${encodeQuery(title)}&body=${encodeQuery(body)}`;
}
/** Links longer than this are not reliable in every browser; the full text is then copied to the clipboard instead. */
+9 -4
View File
@@ -2,6 +2,7 @@ import { useSyncExternalStore } from "react";
import { listen } from "@tauri-apps/api/event";
import { api, asUiError, type UiError, type UpdatePreview, type UpdateTxn } from "@/lib/api";
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,
@@ -34,12 +35,12 @@ function set(id: string, next: Partial<ServerUpdateState>) {
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);
if (cur.applying || cur.checking) return;
set(id, { checking: true });
try {
const p = await api.checkUpdate(id);
const p = await api.checkUpdate(id, undefined, background);
set(id, { preview: p, available: !isUpdateCurrent(p), error: null });
} catch (e) {
// 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. */
export function startServerUpdatePolling(id: string): () => void {
void checkServerUpdate(id);
const t = setInterval(() => void checkServerUpdate(id), CHECK_EVERY_MS);
void checkServerUpdate(id, true);
const t = setInterval(() => void checkServerUpdate(id, true), CHECK_EVERY_MS);
return () => clearInterval(t);
}
@@ -85,6 +86,9 @@ export async function applyServerUpdate(id: string, opts?: { choices: Record<str
const current = get(id);
if (current.applying || current.stateError || (current.result && "pending" in current.result)) 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 });
let un: (() => void) | undefined;
try {
@@ -95,6 +99,7 @@ export async function applyServerUpdate(id: string, opts?: { choices: Record<str
try {
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 } });
if (out.txn.state === "committed" && !wasRunning && !startAfterUpdate("server", id)) await api.stop(id).catch(() => undefined);
return true;
} catch (e) {
const ui = asUiError(e);
+1 -1
View File
@@ -3,5 +3,5 @@ import type { UpdatePreview } from "./api";
export function isUpdateCurrent(preview: UpdatePreview): boolean {
return preview.from_version === preview.to_version
&& 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);
}
+5
View File
@@ -0,0 +1,5 @@
export interface UnsavedChangesGuard {
isDirty: () => boolean;
save: () => Promise<boolean>;
discard: () => void;
}
+28
View File
@@ -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); }];
}
+24
View File
@@ -0,0 +1,24 @@
import { Card } from "@/components/ui/card";
import { useT } from "@/i18n";
import { useAutoRestart } from "@/lib/autoRestartPrefs";
export function AutoRestartSettings({ serverId }: { serverId: string }) {
const t = useT();
const [autoRestart, setAutoRestart] = useAutoRestart(serverId);
return (
<Card className="mt-6 p-6">
<h2 className="font-semibold">{t("crash.autoRestart")}</h2>
<label className="mt-3 flex cursor-pointer items-center gap-3">
<input
type="checkbox"
checked={autoRestart}
onChange={(e) => setAutoRestart(e.target.checked)}
className="h-4 w-4 accent-[#c9a24a]"
/>
<span className="text-sm font-medium">{t("crash.autoRestart")}</span>
</label>
<p className="mt-2 text-sm text-muted">{t("crash.autoRestartDesc")}</p>
</Card>
);
}
+21 -1
View File
@@ -1,7 +1,8 @@
import { useCallback, useEffect, useState } from "react";
import { listen } from "@tauri-apps/api/event";
import { Loader2, ShieldCheck } from "lucide-react";
import { api, asUiError, type BackupKind, type RecoveryPoint, type UiError } from "@/lib/api";
import { open } from "@tauri-apps/plugin-dialog";
import { api, asUiError, type BackupKind, type BackupLocation, type RecoveryPoint, type UiError } from "@/lib/api";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useHuman, useI18n, type Key, type Locale } from "@/i18n";
@@ -45,9 +46,11 @@ export function BackupsPage({ serverId }: { serverId: string }) {
const [notice, setNotice] = useState<string | null>(null);
const [restoring, setRestoring] = useState<RecoveryPoint | null>(null);
const [running, setRunning] = useState(false);
const [location, setLocation] = useState<BackupLocation | null>(null);
const load = useCallback(async () => {
setPoints(await api.backups(serverId));
setLocation(await api.backupLocation(serverId));
const s = await api.status(serverId);
setRunning(s.observed.world.state !== "stopped" || s.observed.auth.state !== "stopped");
}, [serverId]);
@@ -113,6 +116,23 @@ export function BackupsPage({ serverId }: { serverId: string }) {
</div>
</Card>
{location && (
<Card className="mt-4 p-5">
<p className="font-medium">{t("bk.folder")}</p>
<p className="selectable mt-1 break-all text-sm text-muted">{location.path}{location.is_default ? ` (${t("bk.folderDefault")})` : ""}</p>
<p className="mt-1 text-xs text-muted">{t("bk.folderNote")}</p>
<div className="mt-3 flex flex-wrap gap-2">
<Button size="sm" disabled={!!busy} onClick={() => void run("folder", async () => {
const dir = await open({ directory: true, multiple: false, title: t("bk.folder") });
if (typeof dir === "string") { await api.setBackupLocation(serverId, dir); return t("bk.folderChanged"); }
})}>{t("bk.folderChange")}</Button>
{!location.is_default && (
<Button size="sm" variant="ghost" disabled={!!busy} onClick={() => void run("folder", async () => { await api.setBackupLocation(serverId, null); return t("bk.folderChanged"); })}>{t("bk.folderReset")}</Button>
)}
</div>
</Card>
)}
{notice && <p className="mt-3 text-sm text-ok" role="status">{notice}</p>}
{error && (
<Card className="mt-4 border-bad/40 p-4" role="alert">
+8
View File
@@ -6,6 +6,7 @@ import { ClientDialog, type ClientDialogMode } from "@/screens/ClientDialog";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useHuman, useT } from "@/i18n";
import { useStartAfterUpdate } from "@/lib/updatePrefs";
export function ClientCard({ serverId, remote = false }: { serverId: string; remote?: boolean }) {
const t = useT();
@@ -16,6 +17,7 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
const [busy, setBusy] = useState(false);
const [status, setStatus] = useState<ClientStatus | null>(null);
const [dialog, setDialog] = useState<ClientDialogMode | null>(null);
const [playAfter, setPlayAfter] = useStartAfterUpdate("client", serverId);
const refresh = () => {
void api.clientStatus(serverId).then(setStatus).catch(() => setStatus(null));
@@ -86,6 +88,12 @@ export function ClientCard({ serverId, remote = false }: { serverId: string; rem
<dt className="text-muted">{t("client.otherAddons")}</dt>
<dd>{t("client.leftAsIs", { n: info.other_addons })}</dd>
</dl>
{!remote && (
<label className="mt-4 flex cursor-pointer items-center gap-2 text-sm">
<input type="checkbox" checked={playAfter} onChange={(e) => setPlayAfter(e.target.checked)} className="h-4 w-4 accent-[#c9a24a]" />
<span>{t("client.startAfter")}</span>
</label>
)}
<div className="mt-4 flex flex-wrap gap-2">
{!remote && !pointsLocal && (
<Button size="sm" disabled={busy} onClick={() => void run(async () => { await api.setRealmlist(serverId, "127.0.0.1"); return t("client.pointedNote"); })}>
+1 -1
View File
@@ -103,7 +103,7 @@ export function ConsolePage({ serverId }: { serverId: string }) {
</Button>
</div>
<div ref={box} className="selectable mt-3 min-h-64 flex-1 overflow-auto rounded-card border border-line bg-black/40 p-3 font-mono text-xs leading-5" role="log" aria-live="off">
<div ref={box} className="selectable relative mt-3 min-h-64 flex-1 overflow-auto rounded-card border border-line bg-black/40 p-3 font-mono text-xs leading-5" role="log" aria-live="off">
{missing ? <p className="text-muted">{missing}</p> : lines.length === 0 ? <p className="text-muted">{t("con.empty")}</p> : lines.map((l, i) => (
<div key={i} className={cn("whitespace-pre-wrap break-all", TONE[l.level])}>
{l.level !== "info" && <span className="sr-only">{l.level}: </span>}
+198
View File
@@ -0,0 +1,198 @@
import { useEffect, useState } from "react";
import { AlertTriangle, Check, ChevronDown, ChevronUp, Copy, Loader2, X } from "lucide-react";
import { api, type CrashItem } from "@/lib/api";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useT } from "@/i18n";
export function CrashHistoryModal({
serverId,
onClose,
}: {
serverId: string;
onClose: () => void;
}) {
const t = useT();
const [loading, setLoading] = useState(true);
const [crashes, setCrashes] = useState<CrashItem[]>([]);
const [expandedId, setExpandedId] = useState<string | null>(null);
const [copiedId, setCopiedId] = useState<string | null>(null);
useEffect(() => {
let alive = true;
void api
.listCrashes(serverId, 30)
.then((items) => {
if (alive) {
setCrashes(items);
setLoading(false);
}
})
.catch(() => {
if (alive) setLoading(false);
});
return () => {
alive = false;
};
}, [serverId]);
useEffect(() => {
const onKey = (e: KeyboardEvent) => {
if (e.key === "Escape") onClose();
};
window.addEventListener("keydown", onKey);
return () => window.removeEventListener("keydown", onKey);
}, [onClose]);
const copyReport = async (item: CrashItem) => {
try {
await navigator.clipboard.writeText(item.full_log);
setCopiedId(item.id);
setTimeout(() => setCopiedId(null), 2500);
} catch {
/* clipboard write failed */
}
};
const getCategoryColor = (category: CrashItem["category"]) => {
switch (category) {
case "assertion":
return "bg-amber-500/15 text-amber-400 border-amber-500/30";
case "access_violation":
case "stack_overflow":
case "out_of_memory":
return "bg-bad/15 text-bad border-bad/30";
case "network":
case "database":
return "bg-blue-500/15 text-blue-400 border-blue-500/30";
default:
return "bg-muted/15 text-muted border-line";
}
};
return (
<div
className="fixed inset-0 z-50 flex items-center justify-center bg-black/60 p-4 md:p-6"
role="presentation"
onClick={(e) => {
if (e.target === e.currentTarget) onClose();
}}
>
<Card
className="flex max-h-[85vh] w-full max-w-2xl flex-col p-6 shadow-2xl"
role="dialog"
aria-modal="true"
aria-label={t("crash.historyTitle")}
>
<div className="flex items-center justify-between border-b border-line pb-4">
<div className="flex items-center gap-2.5">
<AlertTriangle className="h-5 w-5 text-warn" aria-hidden />
<h2 className="text-lg font-semibold">{t("crash.historyTitle")}</h2>
</div>
<button
type="button"
onClick={onClose}
className="cursor-pointer text-muted transition-colors hover:text-ink"
aria-label={t("btn.close")}
>
<X className="h-5 w-5" aria-hidden />
</button>
</div>
<div className="flex-1 overflow-y-auto py-4">
{loading ? (
<div className="flex items-center justify-center py-12 text-muted">
<Loader2 className="h-6 w-6 animate-spin" aria-hidden />
</div>
) : crashes.length === 0 ? (
<div className="py-12 text-center text-muted">
<p>{t("crash.noCrashes")}</p>
</div>
) : (
<div className="space-y-4">
{crashes.map((item) => {
const isExpanded = expandedId === item.id;
const isCopied = copiedId === item.id;
return (
<div
key={item.id}
className="rounded-lg border border-line bg-card-2 p-4 text-sm transition-all"
>
<div className="flex flex-wrap items-start justify-between gap-2">
<div>
<span
className={`inline-block rounded border px-2 py-0.5 text-xs font-medium uppercase tracking-wide ${getCategoryColor(
item.category,
)}`}
>
{item.exception_code ? `${item.category} (${item.exception_code})` : item.category}
</span>
<h3 className="mt-1.5 font-semibold text-ink">{item.title}</h3>
</div>
<span className="text-xs text-muted tabular-nums">{item.date_str}</span>
</div>
<p className="mt-2 text-xs leading-relaxed text-muted">{item.explanation}</p>
<div className="mt-3 flex items-center justify-between border-t border-line/50 pt-2.5">
<button
type="button"
onClick={() => setExpandedId(isExpanded ? null : item.id)}
className="inline-flex cursor-pointer items-center gap-1.5 text-xs font-medium text-gold transition-colors hover:underline"
>
{isExpanded ? (
<>
<ChevronUp className="h-3.5 w-3.5" aria-hidden />
{t("crash.hideRaw")}
</>
) : (
<>
<ChevronDown className="h-3.5 w-3.5" aria-hidden />
{t("crash.viewRaw")}
</>
)}
</button>
<Button
variant="ghost"
size="sm"
onClick={() => void copyReport(item)}
className="h-7 gap-1.5 px-2 text-xs text-muted hover:text-ink"
>
{isCopied ? (
<>
<Check className="h-3.5 w-3.5 text-ok" aria-hidden />
<span className="text-ok">{t("crash.copied")}</span>
</>
) : (
<>
<Copy className="h-3.5 w-3.5" aria-hidden />
<span>{t("crash.copyReport")}</span>
</>
)}
</Button>
</div>
{isExpanded && (
<div className="mt-3">
<pre className="selectable max-h-56 overflow-x-auto overflow-y-auto rounded border border-line bg-black/40 p-3 font-mono text-[11px] leading-relaxed text-muted">
{item.full_log}
</pre>
</div>
)}
</div>
);
})}
</div>
)}
</div>
<div className="flex justify-end border-t border-line pt-4">
<Button variant="secondary" onClick={onClose}>
{t("btn.close")}
</Button>
</div>
</Card>
</div>
);
}
+109
View File
@@ -0,0 +1,109 @@
import { useCallback, useEffect, useState } from "react";
import { listen } from "@tauri-apps/api/event";
import { Loader2 } from "lucide-react";
import { api, asUiError, type DashboardStatus, type UiError } from "@/lib/api";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useHuman, useT } from "@/i18n";
/** SQUID's bot dashboard: installed from the release that matches the bots, started on a free port, shown here. */
export function DashboardPage({ serverId }: { serverId: string }) {
const t = useT();
const human = useHuman();
const [status, setStatus] = useState<DashboardStatus | null>(null);
const [busy, setBusy] = useState<"install" | "start" | "stop" | null>(null);
const [step, setStep] = useState<string | null>(null);
const [error, setError] = useState<UiError | null>(null);
const load = useCallback(async () => {
try { setStatus(await api.dashboardStatus(serverId)); } catch (e) { setError(asUiError(e)); }
}, [serverId]);
useEffect(() => {
void load();
const un = listen<string>("dashboard-progress", (e) => setStep(e.payload));
return () => { void un.then((f) => f()); };
}, [load]);
async function run(kind: "install" | "start" | "stop", fn: () => Promise<DashboardStatus>) {
setBusy(kind); setError(null); setStep(null);
try { setStatus(await fn()); } catch (e) { setError(asUiError(e)); await load(); }
finally { setBusy(null); setStep(null); }
}
const install = () => run("install", () => api.dashboardInstall(serverId));
return (
<div className="flex h-full max-w-6xl flex-col">
<h1 className="text-2xl font-semibold">{t("dash.title")}</h1>
<p className="mt-1 text-muted">{t("dash.intro")}</p>
{!status && !error && <p className="mt-6 text-muted">{t("overview.checking")}</p>}
{status && (
<Card className="mt-5 p-5">
{!status.installed ? (
<>
<p className="font-medium">{t("dash.notInstalled")}</p>
<p className="mt-1 text-sm text-muted">{status.squid_tag ? t("dash.willInstall", { v: status.squid_tag }) : t("dash.noSquid")}</p>
<Button className="mt-4" variant="primary" disabled={!!busy || !status.squid_tag} onClick={() => void install()}>
{busy === "install" && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{t("dash.install")}
</Button>
</>
) : (
<>
<p className="text-sm text-muted">
{t("dash.versions", { dash: status.tag ?? "?", bots: status.squid_tag ?? "?" })}
{" · "}
<span className={status.running ? "text-ok" : "text-muted"}>{status.running ? t("dash.running") : t("dash.stopped")}</span>
</p>
{!status.matches && status.squid_tag && (
<p className="mt-2 text-sm text-warn">{t("dash.mismatch", { bots: status.squid_tag })}</p>
)}
<div className="mt-4 flex flex-wrap items-center gap-2">
{status.running ? (
<>
<Button size="sm" variant="secondary" disabled={!!busy} onClick={() => void run("stop", () => api.dashboardStop(serverId))}>
{busy === "stop" && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{t("dash.stop")}
</Button>
<Button size="sm" variant="ghost" onClick={() => void api.dashboardOpen(serverId).catch((e) => setError(asUiError(e)))}>{t("dash.openBrowser")}</Button>
</>
) : (
<Button size="sm" variant="primary" disabled={!!busy} onClick={() => void run("start", () => api.dashboardStart(serverId))}>
{busy === "start" && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{t("dash.start")}
</Button>
)}
{!status.matches && status.squid_tag && (
<Button size="sm" disabled={!!busy} onClick={() => void install()}>
{busy === "install" && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{t("dash.update")}
</Button>
)}
</div>
</>
)}
{busy === "install" && <p className="mt-3 text-sm text-muted" role="status">{step ?? t("bk.working")}</p>}
</Card>
)}
{error && (
<Card className="mt-4 border-bad/40 p-4" role="alert">
<p className="selectable whitespace-pre-wrap break-words text-sm text-bad">{error.human.code === "unknown" ? error.technical : human(error.human).message}</p>
<button className="mt-1 cursor-pointer text-xs text-muted underline" onClick={() => void navigator.clipboard.writeText(error.technical)}>{t("common.copyError")}</button>
</Card>
)}
{status?.running && (
<iframe
key={status.url}
title={t("dash.title")}
src={status.url}
className="mt-4 min-h-[480px] w-full flex-1 rounded-card border border-line bg-black/30"
/>
)}
</div>
);
}
+60 -7
View File
@@ -5,6 +5,15 @@ import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useHuman, useT, type Key } from "@/i18n";
/** Convenience only; Rust validates again before applying or saving. */
function validLanIpv4(value: string): boolean {
if (!/^(0|[1-9]\d{0,2})(\.(0|[1-9]\d{0,2})){3}$/.test(value)) return false;
const octets = value.split(".").map(Number);
const [a, b] = octets;
return octets.every((n) => n <= 255) && a > 0 && a < 224 && a !== 127
&& !(a === 169 && b === 254) && !(a === 100 && b >= 64 && b <= 127);
}
function Line({ ok, children, warn }: { ok: boolean; warn?: boolean; children: React.ReactNode }) {
const t = useT();
return (
@@ -81,11 +90,28 @@ export function FriendsPage({ serverId }: { serverId: string }) {
const [note, setNote] = useState<string | null>(null);
const [copied, setCopied] = useState(false);
const [needsRestart, setNeedsRestart] = useState(false);
const [lanChoice, setLanChoice] = useState("automatic");
const [customLan, setCustomLan] = useState("");
const refresh = useCallback(() => api.friendsStatus(serverId).then(setSt).catch((e) => setError(asUiError(e))), [serverId]);
const refresh = useCallback(() => api.friendsStatus(serverId).then((status) => {
setSt(status);
}).catch((e) => setError(asUiError(e))), [serverId]);
useEffect(() => {
void refresh();
}, [refresh]);
let cancelled = false;
setSt(null);
setNet(null);
void api.friendsStatus(serverId).then((status) => {
if (cancelled) return;
const saved = status.settings.lan_address_override;
setCustomLan(saved ?? "");
setLanChoice(saved === null ? "automatic" : status.lan_addresses.some((a) => a.address === saved) ? saved : "custom");
setSt(status);
}).catch((e) => { if (!cancelled) setError(asUiError(e)); });
return () => { cancelled = true; };
}, [serverId]);
const lanOverride = lanChoice === "automatic" ? null : lanChoice === "custom" ? customLan.trim() : lanChoice;
const lanValid = lanOverride === null || validLanIpv4(lanOverride);
async function run(label: string, fn: () => Promise<string | void>) {
setBusy(label);
@@ -109,7 +135,12 @@ export function FriendsPage({ serverId }: { serverId: string }) {
const enable = (mode: FriendsMode) =>
run(`enable-${mode}`, async () => {
const r = await api.friendsEnable(serverId, mode, net?.public_ip ?? undefined, mode === "direct" && !!net?.router_found);
const r = await api.friendsEnable(
serverId, mode,
mode === "direct" ? net?.public_ip ?? undefined : undefined,
mode === "direct" && !!net?.router_found,
mode === "lan" ? lanOverride : null,
);
setNeedsRestart(r.restart_required);
return [r.restart_required ? t("fr.restartToApply") : null, r.note ? (r.note.startsWith("Your router was asked") ? t("fr.note.forwarded") : r.note.startsWith("Your router does not support") ? t("fr.note.manual") : r.note) : null].filter(Boolean).join(" ") || t("fr.ready");
});
@@ -119,6 +150,8 @@ export function FriendsPage({ serverId }: { serverId: string }) {
const cur = st.settings;
const exposed = st.exposure.filter((e) => (e.what === "database" || e.what === "server console") && e.reachable_from_network);
const connection = cur.mode === "local" ? null : `set realmlist ${cur.host}`;
const selectedLan = lanOverride ?? st.lan_ip;
const lanUnavailable = lanOverride !== null && lanValid && !st.lan_addresses.some((a) => a.address === lanOverride);
return (
<div className="max-w-3xl">
@@ -157,8 +190,28 @@ export function FriendsPage({ serverId }: { serverId: string }) {
{m.id === "lan" && (
<>
<p className="mt-2 text-sm">{t("fr.yourLan")} <b className="selectable">{st.lan_ip ?? t("fr.unknown")}</b></p>
{st.lan_ip && cur.mode !== m.id && <RealmlistLine host={st.lan_ip} />}
<label htmlFor="lan-address" className="mt-3 block text-sm">{t("fr.lan.address")}</label>
<select id="lan-address" value={lanChoice} disabled={!!busy}
className="mt-1 w-full rounded-md border border-line bg-bg px-3 py-2 text-sm outline-none focus:border-gold"
onChange={(e) => {
if (e.target.value === "custom" && lanOverride) setCustomLan(lanOverride);
setLanChoice(e.target.value);
}}>
<option value="automatic">{t("fr.lan.automatic")} — {st.lan_ip ?? t("fr.unknown")}</option>
{st.lan_addresses.map((a) => <option key={a.address} value={a.address}>{a.interface} — {a.address}{a.is_default ? ` (${t("fr.lan.default")})` : ""}</option>)}
{lanChoice !== "automatic" && lanChoice !== "custom" && !st.lan_addresses.some((a) => a.address === lanChoice) && <option value={lanChoice}>{lanChoice}</option>}
<option value="custom">{t("fr.lan.custom")}</option>
</select>
{lanChoice === "custom" && <>
<label htmlFor="lan-custom" className="mt-2 block text-sm">{t("fr.lan.customIpv4")}</label>
<input id="lan-custom" value={customLan} disabled={!!busy} spellCheck={false} inputMode="decimal"
aria-invalid={!lanValid} aria-describedby={!lanValid ? "lan-invalid" : undefined}
className="mt-1 w-full rounded-md border border-line bg-bg px-3 py-2 text-sm outline-none focus:border-gold"
onChange={(e) => setCustomLan(e.target.value)} />
</>}
{!lanValid && <p id="lan-invalid" className="mt-2 text-sm text-bad" role="alert">{t("fr.lan.invalid")}</p>}
{lanUnavailable && <p className="mt-2 text-sm text-warn" role="status"><b>{t("fr.lan.unavailable")}</b> {t("fr.lan.unavailableText")}</p>}
{selectedLan && lanValid && <RealmlistLine host={selectedLan} />}
</>
)}
@@ -221,7 +274,7 @@ export function FriendsPage({ serverId }: { serverId: string }) {
<Button
size="sm"
variant={m.id === "private" && net?.reachability === "cgnat" ? "primary" : "secondary"}
disabled={!!busy || (m.id === "direct" && !net?.public_ip) || (m.id === "private" && !st.tailscale.connected)}
disabled={!!busy || (m.id === "lan" && (!lanValid || !selectedLan)) || (m.id === "direct" && !net?.public_ip) || (m.id === "private" && !st.tailscale.connected)}
onClick={() => void enable(m.id)}
title={m.id === "direct" && !net?.public_ip ? t("fr.checkFirst") : undefined}
>
+61 -13
View File
@@ -2,7 +2,7 @@ import { useEffect, useState } from "react";
import { listen } from "@tauri-apps/api/event";
import { open } from "@tauri-apps/plugin-dialog";
import { Check, ChevronDown, ChevronRight, Loader2 } from "lucide-react";
import { api, asUiError, type InstallRequirements, type InstallStep, type Preflight, type ServerSummary, type UiError } from "@/lib/api";
import { api, asUiError, type InstallEnvironment, type InstallRequirements, type InstallStep, type Preflight, type ServerSummary, type UiError } from "@/lib/api";
import { formatBytes } from "@/lib/utils";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
@@ -33,6 +33,19 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void;
const [pkg, setPkg] = useState("");
const [installed, setInstalled] = useState<ServerSummary | null>(null);
const [showDetails, setShowDetails] = useState(false);
// What this computer installs. A repack (Windows) needs nothing more than a folder; Docker (Linux) also needs the game data
// folder and a package, and Docker itself.
const [env, setEnv] = useState<InstallEnvironment | null>(null);
const [gameData, setGameData] = useState("");
const docker = env?.flavor === "docker";
function loadEnvironment(first: boolean) {
void api.installEnvironment().then((e) => {
setEnv(e);
if (first && e.flavor === "docker") setDest(e.default_dir);
}).catch(() => setEnv(null));
}
useEffect(() => loadEnvironment(true), []);
// how big the server is, from the package's signed list (re-read when another package source is entered)
useEffect(() => {
@@ -43,9 +56,9 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void;
// room for the unpacked server plus the download that is removed afterwards
const needed = req ? req.unpacked_bytes + req.download_bytes : undefined;
useEffect(() => {
const timer = setTimeout(() => void api.installPreflight(dest, needed).then(setPre).catch(() => setPre(null)), 250);
const timer = setTimeout(() => void api.installPreflight(dest, needed, docker ? gameData.trim() : undefined).then(setPre).catch(() => setPre(null)), 250);
return () => clearTimeout(timer);
}, [dest, needed]);
}, [dest, needed, docker, gameData]);
useEffect(() => {
const un = listen<InstallStep>("install-progress", (e) => setStep(e.payload));
@@ -56,7 +69,12 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void;
async function browse() {
const picked = await open({ directory: true, multiple: false, title: t("install.dialogTitle") });
if (typeof picked === "string") setDest(picked.replace(/[\\/]+$/, "") + (picked.toLowerCase().includes("coa") ? "" : "\\CoA Server"));
if (typeof picked === "string") setDest(picked.replace(/[\\/]+$/, "") + (picked.toLowerCase().includes("coa") ? "" : docker ? "/CoaServer" : "\\CoA Server"));
}
async function browseGameData() {
const picked = await open({ directory: true, multiple: false, title: t("install.data.dialogTitle") });
if (typeof picked === "string") setGameData(picked);
}
async function browsePackage() {
@@ -69,7 +87,7 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void;
setPhase("installing");
setStep({ step: "Preparing your server", percent: 0, detail: null });
try {
const s = await api.installNew(dest, pkg.trim() || undefined);
const s = await api.installNew(dest, pkg.trim() || undefined, docker ? gameData.trim() : undefined);
setInstalled(s);
setPhase("done");
} catch (e) {
@@ -139,9 +157,34 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void;
</div>
</div>
{pre && pre.problems.length > 0 && (
{docker && (
<div>
<label htmlFor="gamedata" className="text-sm text-muted">{t("install.data.label")}</label>
<div className="mt-1 flex gap-2">
<input id="gamedata" value={gameData} onChange={(e) => setGameData(e.target.value)} className="selectable flex-1 rounded-md border border-line bg-card px-3 py-2.5 text-[15px] outline-none focus:border-gold" />
<Button onClick={browseGameData}>{t("install.browse")}</Button>
</div>
<p className="mt-1 text-xs text-muted">{t("install.data.hint")}</p>
<label htmlFor="linuxpkg" className="mt-4 block text-sm text-muted">{t("install.linuxPkg.label")}</label>
<div className="mt-1 flex gap-2">
<input id="linuxpkg" value={pkg} onChange={(e) => setPkg(e.target.value)} placeholder={t("install.linuxPkg.hint")} className="selectable flex-1 rounded-md border border-line bg-card px-3 py-2.5 text-[15px] outline-none focus:border-gold" />
<Button onClick={browsePackage}>{t("install.browse")}</Button>
</div>
</div>
)}
{docker && env?.docker_problem && (
<Card className="border-warn/40 p-4" role="alert">
{pre.problems.map((p) => (
<p className="font-medium text-warn">{t("install.docker.title")}</p>
<p className="mt-1 text-sm text-muted">{t("install.docker.text")}</p>
<pre className="mt-2 max-h-24 overflow-auto whitespace-pre-wrap rounded bg-black/40 p-2 text-xs">{env.docker_problem}</pre>
<Button className="mt-3" size="sm" onClick={() => loadEnvironment(false)}>{t("install.docker.retry")}</Button>
</Card>
)}
{pre && pre.problems.some((p) => !(docker && !gameData.trim() && p.code.startsWith("data"))) && (
<Card className="border-warn/40 p-4" role="alert">
{pre.problems.filter((p) => !(docker && !gameData.trim() && p.code.startsWith("data"))).map((p) => (
<p key={p.code} className="text-sm text-warn">{p.message}</p>
))}
</Card>
@@ -158,14 +201,19 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void;
<p className="font-medium text-bad">{error.human.code === "unknown" ? t("install.failedTitle") : human(error.human).title}</p>
<p className="mt-1 text-sm text-muted">{error.human.code === "unknown" ? error.technical : human(error.human).message}</p>
<p className="mt-1 text-sm text-muted">{t("install.nothingInstalled")}</p>
<button className="mt-2 cursor-pointer text-xs text-muted underline" onClick={() => setShowDetails((v) => !v)}>
{showDetails ? t("install.hideTech") : t("install.showTech")}
</button>
<div className="mt-2 flex items-center gap-4">
<button className="cursor-pointer text-xs text-muted underline" onClick={() => setShowDetails((v) => !v)}>
{showDetails ? t("install.hideTech") : t("install.showTech")}
</button>
<button className="cursor-pointer text-xs text-muted underline" onClick={() => void navigator.clipboard.writeText(error.technical)}>
{t("common.copyError")}
</button>
</div>
{showDetails && <pre className="mt-2 max-h-40 overflow-auto whitespace-pre-wrap rounded bg-black/40 p-2 text-xs">{error.technical}</pre>}
</Card>
)}
<div>
{!docker && <div>
<button onClick={() => setShowAdvanced((v) => !v)} aria-expanded={showAdvanced} className="flex cursor-pointer items-center gap-1 text-sm text-muted hover:text-ink">
{showAdvanced ? <ChevronDown className="h-4 w-4" aria-hidden /> : <ChevronRight className="h-4 w-4" aria-hidden />}
{t("install.advanced")}
@@ -179,10 +227,10 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void;
</div>
</div>
)}
</div>
</div>}
<div className="flex items-center gap-3">
<Button variant="primary" size="md" disabled={!pre?.ok} onClick={() => void install()}>
<Button variant="primary" size="md" disabled={!pre?.ok || (docker && (!!env?.docker_problem || !gameData.trim() || !pkg.trim()))} onClick={() => void install()}>
{t("install.button")}
</Button>
{props.canCancel && (
+164 -11
View File
@@ -1,12 +1,14 @@
import { Fragment, useCallback, useEffect, useRef, useState, type ComponentType, type ReactNode } from "react";
import { Bot, Flame, Gavel, Loader2, Plug, Puzzle, Scaling, Settings2, Snowflake, Sparkles, Swords, type LucideProps } from "lucide-react";
import { api, asUiError, type ModuleSetting, type ModuleView, type UiError } from "@/lib/api";
import { listen } from "@tauri-apps/api/event";
import { Bot, Flame, Gavel, Loader2, Plug, Puzzle, Scaling, Settings2, Snowflake, Sparkles, Swords, Users, type LucideProps } from "lucide-react";
import { api, asUiError, type CustomRacesClientStatus, type CustomRacesProgress, type ModuleSetting, type ModuleView, type UiError } from "@/lib/api";
import { cn } from "@/lib/utils";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useHuman, useI18n, useSchemaText, type Key } from "@/i18n";
import { auctionWeightKey, canonicalModuleValue, moduleEnableKey, moduleField } from "@/lib/moduleSettings";
import { AuctionTypes } from "@/screens/AuctionTypes";
import type { UnsavedChangesGuard } from "@/lib/unsavedGuard";
/** The GitHub mark (lucide dropped its brand icons). */
function GithubMark(props: { className?: string }) {
@@ -27,6 +29,7 @@ const TILES: Record<string, { icon: ComponentType<LucideProps>; from: string; to
gavel: { icon: Gavel, from: "from-yellow-500", to: "to-amber-700" },
sparkles: { icon: Sparkles, from: "from-fuchsia-500", to: "to-purple-700" },
swords: { icon: Swords, from: "from-rose-500", to: "to-red-800" },
races: { icon: Users, from: "from-cyan-500", to: "to-blue-800" },
};
const DEFAULT_TILE = { icon: Puzzle, from: "from-slate-500", to: "to-slate-700" };
@@ -78,25 +81,68 @@ function Tile({ icon, off }: { icon: string; off: boolean }) {
}
/** The server's optional modules: square cards with a switch, the module's status, a link to GitHub and its settings. */
export function ModulesPage({ serverId, onChanged }: { serverId: string; onChanged?: () => void }) {
export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId: string; onChanged?: () => void; onRegisterGuard?: (guard: UnsavedChangesGuard | null) => void }) {
const { t, locale } = useI18n();
const human = useHuman();
const [modules, setModules] = useState<ModuleView[] | null>(null);
const [open, setOpen] = useState<string | null>(null);
const [error, setError] = useState<UiError | null>(null);
const [changed, setChanged] = useState(false);
const [racesPatchStatus, setRacesPatchStatus] = useState<CustomRacesClientStatus | null>(null);
const [racesInstalling, setRacesInstalling] = useState(false);
const [racesProgress, setRacesProgress] = useState<CustomRacesProgress | null>(null);
const loadRacesStatus = useCallback(async () => {
try {
const st = await api.customRacesStatus(serverId);
setRacesPatchStatus(st);
} catch {
// ignore
}
}, [serverId]);
const [guard, setGuard] = useState<UnsavedChangesGuard | null>(null);
useEffect(() => {
onRegisterGuard?.(guard);
return () => onRegisterGuard?.(null);
}, [guard, onRegisterGuard]);
const load = useCallback(async () => {
try {
setModules((await api.modulesList(serverId)).filter((m) => !m.hidden));
await loadRacesStatus();
} catch (e) {
setError(asUiError(e));
}
}, [serverId]);
}, [serverId, loadRacesStatus]);
useEffect(() => {
void load();
}, [load]);
const un = listen<CustomRacesProgress>("custom-races-progress", (e) => {
if (e.payload.id === serverId) {
setRacesProgress(e.payload);
}
});
return () => {
void un.then((f) => f());
};
}, [load, serverId]);
async function installClientPatch() {
setRacesInstalling(true);
setError(null);
try {
await api.customRacesInstall(serverId);
await loadRacesStatus();
await load();
onChanged?.();
} catch (e) {
setError(asUiError(e));
} finally {
setRacesInstalling(false);
setRacesProgress(null);
}
}
async function toggle(m: ModuleView) {
setError(null);
@@ -104,6 +150,9 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang
await api.moduleSetEnabled(serverId, m.id, !m.enabled);
setChanged(true);
await load();
if (m.id === "custom-races") {
await loadRacesStatus();
}
onChanged?.();
} catch (e) {
setError(asUiError(e));
@@ -145,8 +194,9 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang
role="switch"
aria-checked={m.enabled}
aria-label={t("mod.switch", { name: m.name })}
disabled={m.id === "custom-races" && racesInstalling}
onClick={() => void toggle(m)}
className={cn("relative mt-1 h-6 w-11 shrink-0 cursor-pointer rounded-full transition-colors", m.enabled ? "bg-gold" : "bg-white/15")}
className={cn("relative mt-1 h-6 w-11 shrink-0 cursor-pointer rounded-full transition-colors", m.enabled ? "bg-gold" : "bg-white/15", (m.id === "custom-races" && racesInstalling) && "opacity-50 cursor-not-allowed")}
>
<span className={cn("absolute top-0.5 h-5 w-5 rounded-full bg-white transition-all", m.enabled ? "left-[22px]" : "left-0.5")} />
</button>
@@ -154,6 +204,70 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang
{m.installed && !m.switchable && m.status !== "soon" && m.compatibility !== "unsupported" && <span className="mt-1.5 shrink-0 text-xs text-muted">{t("mod.alwaysOn")}</span>}
{!m.installed && m.status !== "soon" && <span className="mt-1.5 shrink-0 text-xs text-muted">{t("mod.notHere")}</span>}
</div>
{m.id === "custom-races" && (
<div className="w-full">
{racesInstalling && racesProgress ? (
<div className="rounded-lg border border-gold/30 bg-gold/5 p-3">
<div className="flex items-center justify-between gap-3 text-xs">
<span className="flex min-w-0 items-center gap-2 font-medium text-ink">
<Loader2 className="h-3.5 w-3.5 shrink-0 animate-spin text-gold" />
<span className="truncate">{racesProgress.step}</span>
</span>
<span className="shrink-0 font-mono text-xs font-semibold text-gold">
{Math.round(racesProgress.percent * 100)}%
</span>
</div>
<div className="mt-2.5 h-2 w-full overflow-hidden rounded-full bg-white/10" role="progressbar" aria-valuenow={Math.round(racesProgress.percent * 100)} aria-valuemin={0} aria-valuemax={100}>
<div
className="h-full rounded-full bg-gold transition-all duration-300"
style={{ width: `${Math.round(racesProgress.percent * 100)}%` }}
/>
</div>
</div>
) : (
<div className="flex flex-wrap items-center justify-between gap-2 border-t border-line/40 pt-3 text-xs">
<div className="flex items-center gap-2">
{racesPatchStatus?.state === "enabled" && (
<span className="inline-flex items-center gap-1.5 rounded-full bg-ok/10 px-2.5 py-1 text-xs text-ok border border-ok/30">
<span className="h-1.5 w-1.5 rounded-full bg-ok" />
{locale === "ru" ? "Патч клиента: Включен" : "Client Patch: Active"}
</span>
)}
{racesPatchStatus?.state === "disabled" && (
<span className="inline-flex items-center gap-1.5 rounded-full bg-white/5 px-2.5 py-1 text-xs text-muted border border-white/15" title="MPQ files disabled with .disabled suffix">
<span className="h-1.5 w-1.5 rounded-full bg-muted" />
{locale === "ru" ? "Патч клиента: Отключен (.disabled)" : "Client Patch: Disabled (.disabled)"}
</span>
)}
{racesPatchStatus?.state === "not-installed" && (
<span className="inline-flex items-center gap-1.5 rounded-full bg-warn/10 px-2.5 py-1 text-xs text-warn border border-warn/30">
<span className="h-1.5 w-1.5 rounded-full bg-warn" />
{locale === "ru" ? "Патч клиента: Не установлен" : "Client Patch: Not Installed"}
</span>
)}
{racesPatchStatus?.state === "partially-installed" && (
<span className="inline-flex items-center gap-1.5 rounded-full bg-warn/10 px-2.5 py-1 text-xs text-warn border border-warn/30">
<span className="h-1.5 w-1.5 rounded-full bg-warn" />
{locale === "ru" ? `Патч клиента: ${racesPatchStatus.installedMpqs}/${racesPatchStatus.totalMpqs} MPQ` : `Client Patch: ${racesPatchStatus.installedMpqs}/${racesPatchStatus.totalMpqs} MPQ`}
</span>
)}
</div>
{(!racesPatchStatus || racesPatchStatus.state === "not-installed" || racesPatchStatus.state === "partially-installed") && (
<Button
size="sm"
variant="secondary"
className="h-7 px-3 text-xs border border-gold/40 hover:border-gold"
disabled={racesInstalling || !racesPatchStatus?.clientPath}
onClick={() => void installClientPatch()}
>
{racesInstalling && <Loader2 className="mr-1.5 h-3.5 w-3.5 animate-spin" />}
{locale === "ru" ? "Установить патч клиента" : "Install Client Patch 1.5"}
</Button>
)}
</div>
)}
</div>
)}
<div className="mt-auto flex items-center gap-2">
<button
onClick={() => void api.openLink(m.repo)}
@@ -174,7 +288,7 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang
{selected?.has_settings && !selected.page && selectedAt >= 0 && Math.floor(selectedAt / 2) === Math.floor(i / 2) && (i % 2 === 1 || i === modules.length - 1) && (
<SettingsPanel key={selected.id} className="sm:col-span-2">
<h2 className="font-semibold">{t("mod.settingsOf", { name: selected.name })}</h2>
<ModuleSettings serverId={serverId} module={selected} onSaved={() => setChanged(true)} />
<ModuleSettings serverId={serverId} module={selected} onSaved={() => setChanged(true)} onRegisterGuard={setGuard} />
</SettingsPanel>
)}
</Fragment>
@@ -184,8 +298,8 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang
);
}
function ModuleSettings({ serverId, module, onSaved }: { serverId: string; module: ModuleView; onSaved: () => void }) {
const { t, locale } = useI18n();
function ModuleSettings({ serverId, module, onSaved, onRegisterGuard }: { serverId: string; module: ModuleView; onSaved: () => void; onRegisterGuard?: (guard: UnsavedChangesGuard | null) => void }) {
const { t, tn, locale } = useI18n();
const sx = useSchemaText();
const human = useHuman();
const [advanced, setAdvanced] = useState(false);
@@ -208,7 +322,7 @@ function ModuleSettings({ serverId, module, onSaved }: { serverId: string; modul
return () => { cancelled = true; };
}, [serverId, module.id]);
async function save() {
async function save(): Promise<boolean> {
const errors: Record<string, string> = {};
for (const [key, value] of Object.entries(edits)) {
const field = moduleField(key, locale, items?.find(item => item.key === key)?.field);
@@ -222,7 +336,7 @@ function ModuleSettings({ serverId, module, onSaved }: { serverId: string; modul
}
}
setFieldErrors(errors);
if (Object.keys(errors).length) return;
if (Object.keys(errors).length) return false;
setBusy(true);
setError(null);
setNote(null);
@@ -234,14 +348,33 @@ function ModuleSettings({ serverId, module, onSaved }: { serverId: string; modul
onSaved();
setNote(t("mod.saved", { n: done.length }));
}
return true;
} catch (e) {
setError(asUiError(e));
return false;
} finally {
setBusy(false);
}
}
const dirty = Object.keys(edits).length > 0;
useEffect(() => {
if (dirty) {
onRegisterGuard?.({
isDirty: () => Object.keys(edits).length > 0,
save: () => save(),
discard: () => {
setEdits({});
setFieldErrors({});
setNote(null);
},
});
} else {
onRegisterGuard?.(null);
}
return () => onRegisterGuard?.(null);
}, [dirty, edits, onRegisterGuard]);
const edit = (key: string, value: string) => setEdits(previous => {
const next = { ...previous };
if (value === items?.find(item => item.key === key)?.value) delete next[key];
@@ -261,6 +394,12 @@ function ModuleSettings({ serverId, module, onSaved }: { serverId: string; modul
return (
<div className="mt-3 border-t border-line pt-3">
{items === null && !error && <Loader2 className="h-4 w-4 animate-spin text-muted" aria-hidden />}
{module.id === "npc-enchanter" && (
<div className="mb-4 space-y-2 text-sm text-muted">
<p>{t("mod.enchanter.add")}</p>
<p>{t("mod.enchanter.remove")}</p>
</div>
)}
{module.id === "ah-bot" && (
<div className="mb-4 space-y-2 text-sm text-muted">
<p>{t("mod.ahbot.setup")}</p>
@@ -318,6 +457,20 @@ function ModuleSettings({ serverId, module, onSaved }: { serverId: string; modul
{note && <span className="text-sm text-ok" role="status">{note}</span>}
</div>}
{error && <p className="mt-2 text-sm text-bad" role="alert">{error.human.code === "unknown" ? error.technical : human(error.human).message}</p>}
{dirty && (
<div className="fixed bottom-0 left-60 right-0 z-40 flex items-center justify-between border-t border-line bg-[#0b0c0e]/95 px-10 py-3 shadow-lg">
<span className="text-sm text-muted">{tn("set.unsaved", Object.keys(edits).length)}</span>
<div className="flex gap-2">
<Button variant="ghost" size="sm" disabled={busy} onClick={() => { setEdits({}); setFieldErrors({}); setNote(null); }}>
{t("set.discard")}
</Button>
<Button variant="primary" size="sm" disabled={busy} onClick={() => void save()}>
{busy && <Loader2 className="mr-1.5 h-3.5 w-3.5 animate-spin" aria-hidden />}
{t("acc.save")}
</Button>
</div>
</div>
)}
</div>
);
}
+225 -37
View File
@@ -1,6 +1,6 @@
import { dismissClientJob, startClientUpdate, stopClientJob, syncClient, useClientJob } from "@/lib/clientJob";
import { useCallback, useEffect, useRef, useState } from "react";
import { Loader2, X } from "lucide-react";
import { AlertTriangle, Loader2, X } from "lucide-react";
import { api, asUiError, type ClientInfo, type Human, type Performance, type Population, type ServerSummary, type ServiceStatus, type StatusView } from "@/lib/api";
import { cn, formatBytes, formatUptime } from "@/lib/utils";
import { useHuman, useT } from "@/i18n";
@@ -9,6 +9,8 @@ import { checkClient, useClientStatus } from "@/lib/clientUpdate";
import { ClientDialog, type ClientDialogMode } from "@/screens/ClientDialog";
import { RealmlistMenu } from "@/screens/RealmlistMenu";
import { RealmPicker } from "@/screens/RealmPicker";
import { CrashHistoryModal } from "@/screens/CrashHistoryModal";
import { useAutoRestart } from "@/lib/autoRestartPrefs";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
@@ -64,10 +66,23 @@ function Row({ label, s }: { label: string; s: ServiceStatus }) {
);
}
export function Overview({ server, companions = true, onForget, onOpenUpdates, onRealmChanged }: { server: ServerSummary; /** the companions module is on */ companions?: boolean; onForget: () => Promise<void>; onOpenUpdates: () => void; onRealmChanged: () => void }) {
export function Overview({ server, companions = true, onForget, onOpenUpdates, onRealmChanged, onReport }: { server: ServerSummary; /** the companions module is on */ companions?: boolean; onForget: () => Promise<void>; onOpenUpdates: () => void; onRealmChanged: () => void; /** open the problem report, which collects the diagnostics */ onReport: () => void }) {
const t = useT();
const human = useHuman();
const [status, setStatus] = useState<StatusView | null>(null);
// With both worlds started together, each realm gets its own card; the first realm owns the database and auth.
const [realms, setRealms] = useState<{ first: string; second: string } | null>(null);
const bothWorlds = !!status?.observed.secondary_world;
useEffect(() => {
if (!bothWorlds) { setRealms(null); return; }
let alive = true;
void api.realmProfiles(server.id).then((r) => {
if (!alive) return;
const name = (m: "coa" | "wildcard") => (m === "coa" ? "Conquest of Azeroth" : "Wildcard");
setRealms({ first: name(r.active), second: name(r.active === "coa" ? "wildcard" : "coa") });
}).catch(() => { if (alive) setRealms(null); });
return () => { alive = false; };
}, [bothWorlds, server.id]);
const [action, setAction] = useState<Action>(null);
const [realmBusy, setRealmBusy] = useState(false);
const [failure, setFailure] = useState<Failure | null>(null);
@@ -85,6 +100,35 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
const upd = useServerUpdate(server.id);
const needsDecision = (upd.preview?.conflicts.length ?? 0) > 0;
const [startBots, setStartBots] = useState<number | null | undefined>(undefined);
const [autoRestart, setAutoRestart] = useAutoRestart(server.id);
const autoRestartRef = useRef(autoRestart);
autoRestartRef.current = autoRestart;
const [crashCount, setCrashCount] = useState(0);
const crashCountRef = useRef(0);
const [showCrashModal, setShowCrashModal] = useState(false);
const [hasCrashHistory, setHasCrashHistory] = useState(false);
const [crashLoopPaused, setCrashLoopPaused] = useState(false);
const [crashRestartNotice, setCrashRestartNotice] = useState<string | null>(null);
const userStoppedRef = useRef(false);
const wasWorldRunningRef = useRef(false);
const actionRef = useRef<Action>(null);
const crashTimestampsRef = useRef<number[]>([]);
const pollRef = useRef<() => Promise<void>>(undefined);
useEffect(() => {
let active = true;
void api
.listCrashes(server.id, 1)
.then((items) => {
if (active && items.length > 0) setHasCrashHistory(true);
})
.catch(() => {});
return () => {
active = false;
};
}, [server.id]);
useEffect(() => {
void api
@@ -102,18 +146,87 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
if (job.phase === "done" || job.phase === "current") void api.clientInfo(server.id).then(setClient).catch(() => undefined);
}, [job.phase, server.id]);
const run = useCallback(
async (kind: Exclude<Action, null>) => {
if (kind === "stopping") {
userStoppedRef.current = true;
} else {
userStoppedRef.current = false;
setCrashLoopPaused(false);
setCrashRestartNotice(null);
}
setFailure(null);
setShowDetails(false);
setAction(kind);
actionRef.current = kind;
try {
if (kind !== "starting") {
const out = await api.stop(server.id);
if (!out.ok) throw { human: out.human, technical: out.output };
}
if (kind !== "stopping") {
setAction("starting");
actionRef.current = "starting";
const out = await api.start(server.id);
if (!out.ok) throw { human: out.human, technical: out.output };
}
} catch (e) {
const ui = asUiError(e);
setFailure({ human: ui.human ?? asUiError(String(e)).human, technical: ui.technical });
} finally {
setAction(null);
actionRef.current = null;
void pollRef.current?.();
}
},
[server.id],
);
const poll = useCallback(async () => {
try {
const s = await api.status(server.id);
if (alive.current) setStatus(s);
if (s.observed.world.state === "running") {
const isWorldRunning = s.observed.world.state === "running";
if (isWorldRunning) {
wasWorldRunningRef.current = true;
userStoppedRef.current = false;
const p = await api.population(server.id).catch(() => null);
if (alive.current) setPop(p);
} else if (alive.current) setPop(null);
} else {
if (alive.current) setPop(null);
if (
wasWorldRunningRef.current &&
!userStoppedRef.current &&
actionRef.current === null
) {
wasWorldRunningRef.current = false;
setHasCrashHistory(true);
const now = Date.now();
const recent = crashTimestampsRef.current.filter((ts) => now - ts < 180000);
recent.push(now);
crashTimestampsRef.current = recent;
crashCountRef.current += 1;
const currentCrashCount = crashCountRef.current;
setCrashCount(currentCrashCount);
if (recent.length >= 3) {
setCrashLoopPaused(true);
setCrashRestartNotice(null);
} else if (autoRestartRef.current) {
setCrashRestartNotice(t("crash.restartNotice", { n: currentCrashCount }));
void run("starting");
}
}
}
} catch {
/* transient; next poll retries */
}
}, [server.id]);
}, [server.id, t, run]);
useEffect(() => {
pollRef.current = poll;
}, [poll]);
// The tick rate comes from the server console (one short connection per reading), so it is read less often.
const worldUp = status?.observed.world.state === "running";
@@ -143,29 +256,6 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
};
}, [poll]);
async function run(kind: Exclude<Action, null>) {
setFailure(null);
setShowDetails(false);
setAction(kind);
try {
if (kind !== "starting") {
const out = await api.stop(server.id);
if (!out.ok) throw { human: out.human, technical: out.output };
}
if (kind !== "stopping") {
setAction("starting");
const out = await api.start(server.id);
if (!out.ok) throw { human: out.human, technical: out.output };
}
} catch (e) {
const ui = asUiError(e);
setFailure({ human: ui.human ?? asUiError(String(e)).human, technical: ui.technical });
} finally {
setAction(null);
void poll();
}
}
async function play() {
setFailure(null);
setShowDetails(false);
@@ -220,20 +310,68 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
<RealmPicker serverId={server.id} running={anyUp} disabled={transitioning || upd.applying} onBusy={setRealmBusy} onChanged={() => { onRealmChanged(); void poll(); }} />
<Card className="mt-6 p-7">
<div className="mb-1 text-xs font-medium uppercase tracking-[0.14em] text-muted">{t("overview.server")}</div>
<div className={cn("flex items-center gap-3 text-3xl font-semibold", tone)} role="status" aria-live="polite">
<span
aria-hidden
className={cn("h-3 w-3 rounded-full", running && !transitioning ? "bg-ok" : transitioning || anyUp ? "bg-warn" : "bg-muted/50")}
/>
{headline}
<div className="mb-1 text-xs font-medium uppercase tracking-[0.14em] text-muted">{realms ? `${realms.first} · ${t("overview.server")}` : t("overview.server")}</div>
<div className="flex flex-wrap items-center justify-between gap-3">
<div className={cn("flex items-center gap-3 text-3xl font-semibold", tone)} role="status" aria-live="polite">
<span
aria-hidden
className={cn("h-3 w-3 rounded-full", running && !transitioning ? "bg-ok" : transitioning || anyUp ? "bg-warn" : "bg-muted/50")}
/>
{headline}
</div>
{(crashCount > 0 || hasCrashHistory) && (
<button
type="button"
onClick={() => setShowCrashModal(true)}
className={cn(
"inline-flex cursor-pointer items-center gap-1.5 rounded-full px-3 py-1 text-xs font-medium transition-colors",
crashCount > 0
? "border border-bad/40 bg-bad/15 text-bad hover:bg-bad/25"
: "border border-line bg-card-2 text-muted hover:text-ink hover:border-gold/40",
)}
title={t("crash.historyTitle")}
>
<AlertTriangle className="h-3.5 w-3.5" aria-hidden />
<span>{crashCount > 0 ? t("crash.badge", { n: crashCount }) : t("crash.historyTitle")}</span>
</button>
)}
</div>
{crashRestartNotice && !crashLoopPaused && (
<div className="mt-3 flex items-center justify-between rounded-md border border-amber-500/30 bg-amber-500/10 p-3 text-xs text-amber-300">
<span>{crashRestartNotice}</span>
<button
type="button"
onClick={() => setCrashRestartNotice(null)}
className="cursor-pointer text-amber-300/70 hover:text-amber-300"
aria-label={t("btn.close")}
>
<X className="h-4 w-4" />
</button>
</div>
)}
{crashLoopPaused && (
<div className="mt-3 flex items-center justify-between rounded-md border border-bad/40 bg-bad/15 p-3 text-xs text-bad">
<span>{t("crash.loopPaused")}</span>
<button
type="button"
onClick={() => setShowCrashModal(true)}
className="cursor-pointer font-medium underline"
>
{t("crash.historyTitle")}
</button>
</div>
)}
{!transitioning && !running && anyUp && (
<p className="mt-2 text-sm text-muted">
{t("overview.reportHint")}{" "}
<button onClick={onReport} className="cursor-pointer text-gold underline hover:text-ink">{t("overview.reportBtn")}</button>
</p>
)}
<div className="mt-5 divide-y divide-line border-y border-line">
<Row label={t("overview.database")} s={mysql} />
<Row label={t("overview.auth")} s={auth} />
<Row label={t("overview.world")} s={world} />
{secondary_world && <Row label={t("realm.secondWorld")} s={secondary_world} />}
</div>
<dl className="mt-4 grid grid-cols-2 gap-4 text-sm">
@@ -295,7 +433,7 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
{t("btn.stopSmall")}
</Button>
)}
<div className="ml-auto flex items-center gap-3">
<div className="ml-auto flex max-w-full flex-wrap items-center justify-end gap-3">
{client && <RealmlistMenu serverId={server.id} />}
{client && jobBusy ? (
<div
@@ -345,6 +483,27 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
)}
</div>
</div>
<div className="mt-6 flex flex-wrap items-center justify-between gap-3 border-t border-line/60 pt-4 text-xs text-muted">
<label className="flex cursor-pointer items-center gap-2">
<input
type="checkbox"
checked={autoRestart}
onChange={(e) => setAutoRestart(e.target.checked)}
className="h-3.5 w-3.5 accent-[#c9a24a]"
/>
<span className="font-medium text-ink/80">{t("crash.autoRestart")}</span>
<span className="hidden sm:inline text-muted">— {t("crash.autoRestartDesc")}</span>
</label>
{(crashCount > 0 || hasCrashHistory) && (
<button
type="button"
onClick={() => setShowCrashModal(true)}
className="cursor-pointer text-gold hover:underline"
>
{t("crash.historyTitle")}
</button>
)}
</div>
{anyUp && !running && !transitioning && (
<p className="mt-3 text-sm text-muted">{t("overview.partial")}</p>
)}
@@ -396,6 +555,28 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
)}
</Card>
{secondary_world && (
<Card className="mt-4 p-7">
<div className="mb-1 text-xs font-medium uppercase tracking-[0.14em] text-muted">{realms ? `${realms.second} · ${t("overview.server")}` : t("realm.secondWorld")}</div>
<div
className={cn("flex items-center gap-3 text-3xl font-semibold", secondary_world.state === "running" ? "text-ok" : secondary_world.state === "starting" || transitioning ? "text-warn" : "text-muted")}
role="status"
aria-live="polite"
>
<span aria-hidden className={cn("h-3 w-3 rounded-full", secondary_world.state === "running" ? "bg-ok" : secondary_world.state === "starting" || transitioning ? "bg-warn" : "bg-muted/50")} />
{secondary_world.state === "running" ? t("status.online") : secondary_world.state === "starting" ? t("status.starting") : t("status.offline")}
</div>
<div className="mt-5 divide-y divide-line border-y border-line">
<Row label={t("overview.world")} s={secondary_world} />
</div>
<dl className="mt-4 text-sm">
<dt className="text-muted">{t("overview.uptime")}</dt>
<dd className="mt-0.5 text-lg">{secondary_world.state === "running" ? formatUptime(secondary_world.uptime_secs) : "—"}</dd>
</dl>
<p className="mt-3 text-xs text-muted">{t("realm.bothRunning")}</p>
</Card>
)}
{conflict && !anyUp && (
<Card className="mt-4 border-warn/40 p-4" role="alert">
<p className="font-medium text-warn">{t("overview.portTitle")}</p>
@@ -437,6 +618,13 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
onPlayAnyway={() => void play()}
/>
)}
{showCrashModal && (
<CrashHistoryModal
serverId={server.id}
onClose={() => setShowCrashModal(false)}
/>
)}
</div>
);
}
+4 -4
View File
@@ -34,15 +34,15 @@ export function RealmPicker({ serverId, running, disabled, onChanged, onBusy }:
<div className="flex flex-wrap items-center gap-3">
<Layers className="h-5 w-5 text-gold" aria-hidden />
<label htmlFor="realm-profile" className="font-medium">{t("realm.profileLabel")}</label>
<select id="realm-profile" value={selected} disabled={!view || disabled || busy} onChange={e => setSelected(e.target.value as RealmMode)} className="min-w-52 rounded-md border border-line bg-card-2 px-3 py-2 text-ink">
{view?.simultaneous ? <span className="text-sm text-muted">Conquest of Azeroth + Wildcard</span> : <select id="realm-profile" value={selected} disabled={!view || disabled || busy} onChange={e => setSelected(e.target.value as RealmMode)} className="min-w-52 rounded-md border border-line bg-card-2 px-3 py-2 text-ink">
<option value="coa">Conquest of Azeroth</option>
<option value="wildcard" disabled={!view?.supported && !view?.wildcard_created}>Wildcard · Darkmoon</option>
</select>
{view && (selected !== view.active || view.recovery_pending) && <Button size="sm" disabled={disabled || busy} onClick={() => void select()}>
</select>}
{view && !view.simultaneous && (selected !== view.active || view.recovery_pending) && <Button size="sm" disabled={disabled || busy} onClick={() => void select()}>
{busy && <Loader2 className="h-4 w-4 animate-spin" aria-hidden />}
{busy ? t("realm.switching") : selected === "wildcard" && !view.wildcard_created ? t("realm.create") : running ? t("realm.restart") : t("realm.select")}
</Button>}
{view && <span className="ml-auto text-xs text-muted">{t("realm.active", { name: view.active === "coa" ? "CoA" : "Wildcard" })}</span>}
{view && !view.simultaneous && <span className="ml-auto text-xs text-muted">{t("realm.active", { name: view.active === "coa" ? "CoA" : "Wildcard" })}</span>}
</div>
<p className="mt-3 text-sm text-muted">{t(view?.simultaneous ? "realm.bothRunning" : "realm.separate")}</p>
{selected === "wildcard" && <p className="mt-2 text-sm text-warn">{t("realm.modules")}</p>}
+39
View File
@@ -0,0 +1,39 @@
import { useEffect, useState } from "react";
import { api, asUiError } from "@/lib/api";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useT } from "@/i18n";
/** Takes a server out of the Manager's list. Nothing on disk is deleted, so the folder can be added again later. */
export function RemoveServerCard({ serverId, path, onForget }: { serverId: string; path: string; onForget: () => Promise<void> }) {
const t = useT();
const [running, setRunning] = useState(false);
const [error, setError] = useState<string | null>(null);
const [busy, setBusy] = useState(false);
useEffect(() => {
let active = true;
void api.status(serverId).then((s) => {
if (!active) return;
const all = [s.observed.mysql, s.observed.auth, s.observed.world, ...(s.observed.secondary_world ? [s.observed.secondary_world] : [])];
setRunning(all.some((x) => x.state === "running" || x.state === "starting" || x.state === "stopping"));
}).catch(() => { /* an unreadable status must not hide the button */ });
return () => { active = false; };
}, [serverId]);
async function remove() {
if (!window.confirm(t("remove.confirm", { path }))) return;
setBusy(true); setError(null);
try { await onForget(); }
catch (e) { setError(asUiError(e).technical); setBusy(false); }
}
return <Card className="mt-6 p-6">
<h2 className="font-semibold">{t("remove.title")}</h2>
<p className="mt-2 text-sm text-muted">{t("remove.text")}</p>
<p className="selectable mt-1 break-all text-sm text-muted">{path}</p>
<Button className="mt-4" disabled={busy || running} onClick={() => void remove()}>{t("remove.button")}</Button>
{running && <p className="mt-2 text-sm text-warn">{t("remove.stopFirst")}</p>}
{error && <p className="mt-3 text-sm text-bad" role="alert">{error}</p>}
</Card>;
}
+7 -1
View File
@@ -10,7 +10,7 @@ export function RepairCard({ serverId }: { serverId: string }) {
const job = useRepair(serverId);
const [checking, setChecking] = useState(false);
const [database, setDatabase] = useState<DatabaseCheck[] | null>(null);
const [files, setFiles] = useState<{ path: string; kind: string }[] | null>(null);
const [files, setFiles] = useState<{ path: string; kind: "missing" | "changed" | string }[] | null>(null);
const [error, setError] = useState<string | null>(null);
async function check() {
clearRepairResult(serverId);
@@ -36,6 +36,12 @@ export function RepairCard({ serverId }: { serverId: string }) {
{job.result.error && <p className="mt-2 text-bad">{job.result.error}</p>}
</div>}
{files && !job.result && <p className="mt-3 text-sm">{t("repair.fileCount", { n: files.length })}</p>}
{files && !job.result && files.length > 0 && (
<ul className="selectable mt-2 max-h-52 overflow-auto text-sm text-muted">
{files.slice(0, 200).map((f) => <li key={f.path}><span className={f.kind === "missing" ? "text-bad" : "text-warn"}>{t(f.kind === "missing" ? "repair.fileMissing" : "repair.fileChanged")}</span> {f.path}</li>)}
{files.length > 200 && <li>…</li>}
</ul>
)}
{checks?.map(c => {
const pending = c.migrations.filter(m => m.status !== "applied");
return <div key={c.realm} className="mt-4 border-t border-line pt-3 text-sm">
Loaded 100 of 104 files, more files were not shown because too many files have changed in this diff. Show more