Compare commits

...
58 Commits
Author SHA1 Message Date
Дмитрий 162bfd1e04 Release Manager 0.6.0 with Chinese localization, realm sync and Linux preview 2026-10-03 22:50:01 +05:00
Дмитрий 85963b0bf0 Merge branch 'review/pr11' into release/0.6.0 2026-10-03 22:45:53 +05:00
Дмитрий 79d293e120 Merge branch 'review/pr5' into release/0.6.0
# Conflicts:
#	src-tauri/src/lib.rs
2026-10-03 22:45:53 +05:00
Дмитрий 46ba3fa3dc Merge branch 'review/pr9' into release/0.6.0 2026-10-03 22:45:37 +05:00
Дмитрий beb3b03010 Merge branch 'review/pr4' into release/0.6.0 2026-10-03 22:45:37 +05:00
Fabien F. 3da9628b79 feat: Docker runtime backend for Linux (start, stop, status)
A server folder with Settings/docker.json is a Docker installation: MySQL, the
auth server and the world server run in containers controlled through the
docker command line. Every other folder is a repack and goes through the
unchanged Windows code. driver::run, process::observe and layout::scan check
for the marker first and hand over to coa_core::docker.

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

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

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

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

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

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

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

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

cargo test --workspace on Linux: 157 passed, 0 failed.
2026-10-02 18:40:07 +02:00
CorfireanandClaude Sonnet 5.5 53aa117ec2 fix(update): say 'up to date' when the version and files are unchanged instead of offering an update
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 21:32:43 +05:00
CorfireanandClaude Sonnet 5.5 cc5363b385 Release 0.4.0: modules page, one settings panel, collections, account delete, bot economy switches
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 20:41:25 +05:00
CorfireanandClaude Sonnet 5.5 209dbe37ac feat(ui): module settings open under their card's row; Other settings tab
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 17:07:39 +05:00
CorfireanandClaude Sonnet 5.5 89be57b4e4 feat(ui): one search, tabs and save bar on the Server page; no module legend
The collection switches and every other documented setting become tabs of the same
panel, are searched together with the curated settings and are saved by the same bar.
The Modules page drops the status legend; Playerbots is named SQUID's Playerbots.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 16:33:00 +05:00
CorfireanandClaude Sonnet 5.5 1f54fbf909 feat(modules): NPC Enchanter is a switchable early module
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 15:39:06 +05:00
ДмитрийandClaude Sonnet 5.5 31c08934ad Modules page: places held for Auction House Bot, NPC Enchanter and Playerbots with a Soon badge; module GitHub links from the catalog are allowed to open
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 15:07:25 +05:00
ДмитрийandClaude Sonnet 5.5 3b4cea7530 The companions are recognised by their .dist default file when no active config exists yet; the Bots settings page creates the active file from it
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 12:10:27 +05:00
ДмитрийandClaude Sonnet 5.5 b091061cc5 Appearances and collections card on the Server page; the compatibility part is no longer a card on the Modules page
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 11:36:42 +05:00
ДмитрийandClaude Sonnet 5.5 726b089f42 Modules page: square icon cards with status (early/beta/release), switch, GitHub and settings; companions, scaling, TBC and WotLK packs and client compatibility in the catalog; a module switched off hides its page. Accounts: delete an account with confirmation.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 11:26:09 +05:00
ДмитрийandClaude Sonnet 5.5 14173d7d7e Server settings: Achievement.RealmFirstBlockBots (bots cannot take Realm First achievements)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 06:21:51 +05:00
ДмитрийandClaude Sonnet 5.5 05397c4505 Import: when the chosen folder is the Core folder or an outer folder, offer the server's main folder; say clearly when it is a standalone AzerothCore server
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-02 05:31:28 +05:00
ДмитрийandClaude Sonnet 5.5 9444434734 Settings: full searchable list of every documented world-server setting (575), edited in place with a snapshot before each save
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 22:54:36 +05:00
ДмитрийandClaude Sonnet 5.5 8f2b585641 Server settings: 20 more curated settings (drop rates by quality, talents, repair cost, auction cut, instances, professions, cross-faction, weather) in five languages
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 22:50:06 +05:00
ДмитрийandClaude Sonnet 5.5 3281750104 Diagnostics: fold repeated config warnings, list config/log files, include the CoA switches
A server whose module configs lack a key logs the same warning on every tick, which filled the 512 KB log tails of a
bug report and hid the actual failure. Read 8 MB back, fold the repeats, then keep the last part.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 20:29:30 +05:00
ДмитрийandClaude Sonnet 5.5 d01e401f3c Layout fixes (fluid main card, password field), no emoji in reports, empty modules page; Release 0.3.1
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 16:30:12 +05:00
ДмитрийandClaude Sonnet 5.5 81aacdf5bb Realmlist switcher next to PLAY, and a Modules page
- Named realmlists (e.g. Solo, PTR): a drop-down by the PLAY button switches the game client by writing the chosen text into every
  locale's realmlist.wtf (the replaced file is saved first); add / edit / remove with a name and the realmlist text (or just an
  address). First use offers 'Solo' (127.0.0.1) and, if the client held another realmlist, 'Previous'.
- Modules page: bundled catalog (modules/catalog.json) of the optional modules built into the server; switch each on or off (its
  Enable setting), open its page on GitHub, edit its configuration with the module's own documentation. Nine modules to start with.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 16:10:45 +05:00
ДмитрийandClaude Sonnet 5.5 a79c26ed49 Report a problem: a tab that prepares a prefilled GitHub bug report
Form (summary, what happened, expected, steps) plus the Manager version, Windows version, install kind and server version filled in
automatically, a redacted diagnostics file to attach, and a button that opens GitHub's new-issue page with the standard template
(the full text goes to the clipboard when it is too long for a link). Nothing is sent from the Manager and no token is needed.
open_link accepts only this project's new-issue page for that.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 15:56:53 +05:00
ДмитрийandClaude Sonnet 5.5 a4c1080575 Tester suggestions: account management, install size and download volume, password show button, addon explanation
- Players page: list of the server's accounts with password change, access level (player/moderator/GM/administrator) and
  rename (a rename also sets a new password because the login verifier depends on the name; refused while logged in).
  Companion and console accounts are never listed.
- Install screen: size of the server from the signed package list (unpacked, download, peak) and the drive check uses it.
- Install progress shows downloaded / total volume and speed.
- Own show/hide button on password fields (the browser's one disappeared after leaving the field).
- Settings: one sentence on what the companion addon does.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 15:13:11 +05:00
ДмитрийandClaude Sonnet 5.5 2c0bb2bac3 Settings: a running server update survives leaving the tab
The update's busy flag, progress and result were local to the Settings card, so switching tabs and coming back showed 'Update now'
again while the update was still running (and the server rightly answered 'another action is still in progress'). They now live in the
shared server-update store: the card re-attaches to the running update with its progress, and shows how it ended.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 14:05:56 +05:00
ДмитрийandClaude Sonnet 5.5 645ffd8999 New servers and updated ones run the world on several threads: MapUpdate.Threads setting, one-time performance defaults, debug loggers lowered
- Server settings page gains 'CPU cores for the world' (MapUpdate.Threads), translated in all languages.
- On the first start of an installed server (not imports) the Manager sets it to half the logical processors (2..8) unless
  the owner already raised it, and lowers Logger.network / Logger.entities.player from debug to info; once per server.
- tools/sample_stacks.py: sampling profiler for a running worldserver (dbghelp + PDB), used to find what the world thread spends time on.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 13:14:41 +05:00
ДмитрийandClaude Sonnet 5.5 c8f6d61b98 Release 0.3.0
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 07:59:59 +05:00
ДмитрийandClaude Sonnet 5.5 2317d46bda Client updates never overwrite renderer wrappers or config files; test that nothing outside the manifest changes
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 07:56:40 +05:00
ДмитрийandClaude Sonnet 5.5 f1f2818525 Client setup dialog: drop the extra explanations, keep only the size
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 07:54:00 +05:00
ДмитрийandClaude Sonnet 5.5 615b3e938d Game client: download and update through the Manager
PLAY turns into UPDATE CLIENT when a tracked client is outdated; with no client linked
it offers choosing an existing folder or downloading from the community launcher servers
(resumable, hash-verified, free-space checked, progress and stop). Files the player changed
are kept on request or moved aside, never silently replaced. Existing clients can be adopted
from Settings. Fresh downloads get a realmlist for each installed locale.

Fixes zero-length files in the downloader (found by the live probe).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 07:52:58 +05:00
ДмитрийandClaude Sonnet 5.5 7d447b490f README: feature overview and screenshots
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 07:41:22 +05:00
ДмитрийandClaude Sonnet 5.5 0c376fdaf8 Main screen: server update check at start and every 5 minutes, UPDATE button instead of START when an update exists, progress, navigation dot; notes on client download
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 06:40:22 +05:00
ДмитрийandClaude Sonnet 5.5 0940e9cf28 v0.2.0: first batch release (companions control, progress, offline bots, tick rate, sharing guides, logo, translations, scroll bars, new base/update pipeline verified end to end)
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-01 05:44:34 +05:00
ДмитрийandClaude Sonnet 5.5 ab0bdbe3e9 clean-base: quiet network logger and a CoA logger in the shipped world template
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 23:51:10 +05:00
ДмитрийandClaude Sonnet 5.5 313d3e1c08 App logo (icon set, welcome screen, sidebar, page icon); despawn N bots to ease the load
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 23:41:20 +05:00
ДмитрийandClaude Sonnet 5.5 8686990a30 Companions: stop creating, take all offline, delete all (with a recovery point); bot module gets spawncancel and despawnall
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 23:28:58 +05:00
ДмитрийandClaude Sonnet 5.5 dd066f2094 Companions: progress bar while the server creates them (n of N added); offline creation shows a busy bar
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 23:24:27 +05:00
ДмитрийandClaude Sonnet 5.5 5bbe5adff1 UI: dark slim scroll bars
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 23:16:11 +05:00
ДмитрийandClaude Sonnet 5.5 79846186ea Bots at start on the Bots page and the main card; adding companions raises the start limit; large batches are created offline with equipment when the server is stopped
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 23:10:22 +05:00
ДмитрийandClaude Sonnet 5.5 f7d29b09ef v0.1.6: companion templates, world speed, sharing guides, links, settings tabs fix; retry of the failed 0.1.5 build
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 23:00:49 +05:00
ДмитрийandClaude Sonnet 5.5 efacd4946e Companions: clear error when no template characters exist; requests made while stopped are created after the next start
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 22:54:21 +05:00
ДмитрийandClaude Sonnet 5.5 b4b1260099 Overview: world speed (ticks per second) from the server's own timing report
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 22:53:16 +05:00
ДмитрийandClaude Sonnet 5.5 b03bc6de28 v0.1.5: CoA.AllowRemoteClients = 1 by default for Manager-installed servers; translations of settings, diagnostics and more
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 22:25:33 +05:00
ДмитрийandClaude Sonnet 5.5 38b5b86be1 Translations: settings schema overlays (ru/de/fr/es), diagnostics, update steps, companion sizes, friends notes; dev mock for settings pages; docs/TRANSLATIONS.md
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 21:32:15 +05:00
ДмитрийandClaude Sonnet 5.5 a4b9ae81c7 clean-base: re-run the race/class starts migration whose effect is missing in the maintainer's database
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 20:49:01 +05:00
ДмитрийandClaude Sonnet 5.5 fb25ffa04b Module confs get newly documented keys from their .dist; sharing also allows remote CoA clients
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-09-30 20:28:42 +05:00
155 changed files with 15655 additions and 269 deletions

No files matched your search

+14
View File
@@ -0,0 +1,14 @@
name: changelog
# Checks the changelog.d/ fragment files with the shared rules (https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md).
on:
push:
paths: ['changelog.d/**']
pull_request:
paths: ['changelog.d/**']
permissions:
contents: read
jobs:
check:
uses: Corfirean/coa-server-build/.github/workflows/changelog-check.yml@main
+28
View File
@@ -0,0 +1,28 @@
name: check
on:
push:
branches: [master, 'release/**']
pull_request:
workflow_dispatch:
permissions:
contents: read
jobs:
test:
strategy:
fail-fast: false
matrix:
os: [windows-latest, ubuntu-latest]
runs-on: ${{ matrix.os }}
timeout-minutes: 40
steps:
- uses: actions/checkout@v7
- uses: actions/setup-node@v4
with:
node-version: 22
- name: Linux build dependencies
if: runner.os == 'Linux'
run: sudo apt-get update && sudo apt-get install -y libwebkit2gtk-4.1-dev build-essential libxdo-dev libssl-dev librsvg2-dev libayatana-appindicator3-dev
- run: npm ci
- run: node tools/check-i18n.mjs
- run: npm run build
- run: cargo test --workspace --locked
+31
View File
@@ -0,0 +1,31 @@
# AGENTS.md
<!-- changelog:start (managed by coa-server-build/changelog/changelog.py sync-instructions) -->
## Changelog (shared by all CoA repositories)
Every CoA project (server fork, bots, Content Scaling, Manager, renderer) feeds **one** changelog that is posted to the
community. When you finish a change that a **player** or a **server owner** would notice (a new feature, a changed
behaviour, a fix for something people ran into, a removed feature, a known issue), add **one small file to
`changelog.d/` in the same commit**. Do not add one for internal work (refactors, tests, CI, documentation).
File name: `YYYYMMDD-short-slug.md` (today's date). Content:
```
---
area: bots # server | bots | scaling | modules | manager | addon | client | renderer
type: fixed # added | changed | fixed | removed | known-issue
audience: players # players | admins (admins = people who run a server or use the Manager)
title: Bots no longer take Realm First achievements
---
Optional: one short paragraph in plain English for the reader (at most 300 characters).
```
- English only. The title says what changed **for the reader**, not how (at most 90 characters, starts with a capital,
no full stop). No code names, file names or commit language in the title.
- One file per change. Never edit or delete files that are already released; never write version numbers (the release
step adds them).
- Check your file: `python changelog.py check --dir changelog.d` (download the script from
https://raw.githubusercontent.com/Corfirean/coa-server-build/main/changelog/changelog.py ), or create it with
`python changelog.py new --area bots --type fixed --audience players --title "..."`.
- Full guide with examples: https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md
<!-- changelog:end -->
+17
View File
@@ -0,0 +1,17 @@
# CoA Server Manager changelog
## 0.6.0 — 2026-10-03
- Added Simplified Chinese for the interface and all server and bot settings.
- The closed game client now follows the selected CoA or Wildcard realm. Play checks the saved realm before launching; existing settings are preserved and backed up.
- Fixed GitHub reports opening Windows Explorer instead of the default browser. Long reports use the clipboard fallback.
- Fixed configuration snapshots created in the same millisecond overwriting each other during restore.
- Added experimental Linux startup: persistent state uses the XDG data folder, Tailscale detection supports Linux, and a Wayland rendering workaround respects existing user settings.
- Added experimental start, stop and status controls for manually prepared Docker servers, with private database networking and a remote console bound to localhost.
- Linux extraction restores executable permissions for ELF binaries and scripts, and paths retain case-sensitive filesystem semantics.
### Availability
This release ships the Windows installer and signed updater assets. Linux support is a development preview, not a one-click installation flow. Docker installation/database setup, SQL operations and backups, updates, Wildcard realm profiles, and Wine/Proton client launching remain unfinished. Servers must be prepared manually and use Linux binaries built with the packaged configuration layout.
Server shutdown and starting-zone scaling issues require separate server releases and are not fixed by updating the Manager alone.
+1
View File
@@ -0,0 +1 @@
@AGENTS.md
Generated
+448 -3
View File
@@ -56,6 +56,137 @@ dependencies = [
"derive_arbitrary", "derive_arbitrary",
] ]
[[package]]
name = "async-broadcast"
version = "0.7.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "435a87a52755b8f27fcf321ac4f04b2802e337c8c4872923137471ec39c37532"
dependencies = [
"event-listener",
"event-listener-strategy",
"futures-core",
"pin-project-lite",
]
[[package]]
name = "async-channel"
version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "924ed96dd52d1b75e9c1a3e6275715fd320f5f9439fb5a4a11fa51f4221158d2"
dependencies = [
"concurrent-queue",
"event-listener-strategy",
"futures-core",
"pin-project-lite",
]
[[package]]
name = "async-executor"
version = "1.14.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c96bf972d85afc50bf5ab8fe2d54d1586b4e0b46c97c50a0c9e71e2f7bcd812a"
dependencies = [
"async-task",
"concurrent-queue",
"fastrand",
"futures-lite",
"pin-project-lite",
"slab",
]
[[package]]
name = "async-io"
version = "2.6.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "456b8a8feb6f42d237746d4b3e9a178494627745c3c56c6ea55d92ba50d026fc"
dependencies = [
"autocfg",
"cfg-if",
"concurrent-queue",
"futures-io",
"futures-lite",
"parking",
"polling",
"rustix",
"slab",
"windows-sys 0.61.2",
]
[[package]]
name = "async-lock"
version = "3.4.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "290f7f2596bd5b78a9fec8088ccd89180d7f9f55b94b0576823bbbdc72ee8311"
dependencies = [
"event-listener",
"event-listener-strategy",
"pin-project-lite",
]
[[package]]
name = "async-process"
version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fc50921ec0055cdd8a16de48773bfeec5c972598674347252c0399676be7da75"
dependencies = [
"async-channel",
"async-io",
"async-lock",
"async-signal",
"async-task",
"blocking",
"cfg-if",
"event-listener",
"futures-lite",
"rustix",
]
[[package]]
name = "async-recursion"
version = "1.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3b43422f69d8ff38f95f1b2bb76517c91589a924d1559a0e935d7c8ce0274c11"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.119",
]
[[package]]
name = "async-signal"
version = "0.2.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "52b5aaafa020cf5053a01f2a60e8ff5dccf550f0f77ec54a4e47285ac2bab485"
dependencies = [
"async-io",
"async-lock",
"atomic-waker",
"cfg-if",
"futures-core",
"futures-io",
"rustix",
"signal-hook-registry",
"slab",
"windows-sys 0.61.2",
]
[[package]]
name = "async-task"
version = "4.7.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8b75356056920673b02621b35afd0f7dda9306d03c79a30f5c56c44cf256e3de"
[[package]]
name = "async-trait"
version = "0.1.92"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "82f6aeea286b8eb4dd3431a1be1b59d290ace00f5bfd8e2a159bc2a05e2c1667"
dependencies = [
"proc-macro2",
"quote",
"syn 3.0.6",
]
[[package]] [[package]]
name = "atk" name = "atk"
version = "0.18.2" version = "0.18.2"
@@ -163,6 +294,19 @@ dependencies = [
"objc2", "objc2",
] ]
[[package]]
name = "blocking"
version = "1.7.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a70e4329df6cb94385eed412ec92375c3cdd8a6e502493d1229b6414e4036dfa"
dependencies = [
"async-channel",
"async-task",
"futures-io",
"futures-lite",
"piper",
]
[[package]] [[package]]
name = "brotli" name = "brotli"
version = "9.0.0" version = "9.0.0"
@@ -347,7 +491,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-core" name = "coa-core"
version = "0.1.4" version = "0.6.0"
dependencies = [ dependencies = [
"base64 0.22.1", "base64 0.22.1",
"chrono", "chrono",
@@ -375,7 +519,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-release" name = "coa-release"
version = "0.1.4" version = "0.6.0"
dependencies = [ dependencies = [
"chrono", "chrono",
"coa-core", "coa-core",
@@ -384,7 +528,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-server-manager" name = "coa-server-manager"
version = "0.1.4" version = "0.6.0"
dependencies = [ dependencies = [
"coa-core", "coa-core",
"serde", "serde",
@@ -392,6 +536,7 @@ dependencies = [
"tauri", "tauri",
"tauri-build", "tauri-build",
"tauri-plugin-dialog", "tauri-plugin-dialog",
"tauri-plugin-opener",
"tauri-plugin-process", "tauri-plugin-process",
"tauri-plugin-updater", "tauri-plugin-updater",
"tracing", "tracing",
@@ -407,6 +552,15 @@ dependencies = [
"memchr", "memchr",
] ]
[[package]]
name = "concurrent-queue"
version = "2.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4ca0197aee26d1ae37445ee532fefce43251d24cc7c166799f4d46817f1d3973"
dependencies = [
"crossbeam-utils",
]
[[package]] [[package]]
name = "const-oid" name = "const-oid"
version = "0.9.6" version = "0.9.6"
@@ -872,6 +1026,33 @@ version = "1.2.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4ef6b89e5b37196644d8796de5268852ff179b44e96276cf4290264843743bb7" checksum = "4ef6b89e5b37196644d8796de5268852ff179b44e96276cf4290264843743bb7"
[[package]]
name = "endi"
version = "1.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "66b7e2430c6dff6a955451e2cfc438f09cea1965a9d6f87f7e3b90decc014099"
[[package]]
name = "enumflags2"
version = "0.7.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1027f7680c853e056ebcec683615fb6fbbc07dbaa13b4d5d9442b146ded4ecef"
dependencies = [
"enumflags2_derive",
"serde",
]
[[package]]
name = "enumflags2_derive"
version = "0.7.12"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "67c78a4d8fdf9953a5c9d458f9efe940fd97a0cab0941c075a813ac594733827"
dependencies = [
"proc-macro2",
"quote",
"syn 2.0.119",
]
[[package]] [[package]]
name = "equivalent" name = "equivalent"
version = "1.0.2" version = "1.0.2"
@@ -899,6 +1080,26 @@ dependencies = [
"windows-sys 0.61.2", "windows-sys 0.61.2",
] ]
[[package]]
name = "event-listener"
version = "5.4.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5a23add41df1562121a9393cb065eab5146a1242410f23a644851e90cfd669d2"
dependencies = [
"parking",
"pin-project-lite",
]
[[package]]
name = "event-listener-strategy"
version = "0.5.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8be9f3dfaaffdae2972880079a491a1a8bb7cbed0b8dd7a347f668b4150a3b93"
dependencies = [
"event-listener",
"pin-project-lite",
]
[[package]] [[package]]
name = "fastrand" name = "fastrand"
version = "2.5.0" version = "2.5.0"
@@ -1063,6 +1264,19 @@ version = "0.3.34"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed" checksum = "53c0fa8157de1303bfffdaa1cc2a673bfffb60102f76b0ef4441659124373fed"
[[package]]
name = "futures-lite"
version = "2.6.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f78e10609fe0e0b3f4157ffab1876319b5b0db102a2c60dc4626306dc46b44ad"
dependencies = [
"fastrand",
"futures-core",
"futures-io",
"parking",
"pin-project-lite",
]
[[package]] [[package]]
name = "futures-macro" name = "futures-macro"
version = "0.3.34" version = "0.3.34"
@@ -1417,6 +1631,12 @@ version = "0.5.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
[[package]]
name = "hermit-abi"
version = "0.5.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e17592d60ebacc7d5e169f4663c5f84f9161cc90328abcfe8456f41e4dfcb284"
[[package]] [[package]]
name = "hex" name = "hex"
version = "0.4.3" version = "0.4.3"
@@ -1731,6 +1951,25 @@ version = "2.12.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0" checksum = "791930b43c0d5973160d90a8f3894509f2b273430f5c5c73b668636d0287c5c0"
[[package]]
name = "is-docker"
version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "928bae27f42bc99b60d9ac7334e3a21d10ad8f1835a4e12ec3ec0464765ed1b3"
dependencies = [
"once_cell",
]
[[package]]
name = "is-wsl"
version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "173609498df190136aa7dea1a91db051746d339e18476eed5ca40521f02d7aa5"
dependencies = [
"is-docker",
"once_cell",
]
[[package]] [[package]]
name = "itoa" name = "itoa"
version = "1.0.18" version = "1.0.18"
@@ -2446,6 +2685,17 @@ version = "1.21.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50" checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
[[package]]
name = "open"
version = "5.4.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "aa576c76302b7b808eecc68061e67336c47833ef9d22caa74dda10fa9675eebc"
dependencies = [
"dunce",
"is-wsl",
"libc",
]
[[package]] [[package]]
name = "openssl" name = "openssl"
version = "0.10.81" version = "0.10.81"
@@ -2495,6 +2745,16 @@ version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d"
[[package]]
name = "ordered-stream"
version = "0.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9aa2b01e1d916879f73a53d01d1d6cee68adbb31d6d9177a8cfce093cced1d50"
dependencies = [
"futures-core",
"pin-project-lite",
]
[[package]] [[package]]
name = "osakit" name = "osakit"
version = "0.3.1" version = "0.3.1"
@@ -2534,6 +2794,12 @@ dependencies = [
"system-deps", "system-deps",
] ]
[[package]]
name = "parking"
version = "2.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f38d5652c16fde515bb1ecef450ab0f6a219d619a7274976324d5e377f7dceba"
[[package]] [[package]]
name = "parking_lot" name = "parking_lot"
version = "0.12.5" version = "0.12.5"
@@ -2622,6 +2888,17 @@ version = "0.2.17"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd" checksum = "a89322df9ebe1c1578d689c92318e070967d1042b512afbe49518723f4e6d5cd"
[[package]]
name = "piper"
version = "0.2.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c835479a4443ded371d6c535cbfd8d31ad92c5d23ae9770a61bc155e4992a3c1"
dependencies = [
"atomic-waker",
"fastrand",
"futures-io",
]
[[package]] [[package]]
name = "pkcs8" name = "pkcs8"
version = "0.10.2" version = "0.10.2"
@@ -2677,6 +2954,20 @@ dependencies = [
"miniz_oxide 0.8.9", "miniz_oxide 0.8.9",
] ]
[[package]]
name = "polling"
version = "3.11.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5d0e4f59085d47d8241c88ead0f274e8a0cb551f3625263c05eb8dd897c34218"
dependencies = [
"cfg-if",
"concurrent-queue",
"hermit-abi",
"pin-project-lite",
"rustix",
"windows-sys 0.61.2",
]
[[package]] [[package]]
name = "portable-atomic" name = "portable-atomic"
version = "1.15.0" version = "1.15.0"
@@ -3451,6 +3742,16 @@ version = "2.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba" checksum = "f8fadd59c855ef2080decdef8ff161eb6661b86933c9d82e5ba29dc602a55aba"
[[package]]
name = "signal-hook-registry"
version = "1.4.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c4db69cba1110affc0e9f7bcd48bbf87b3f4fc7c61fc9155afd4c469eb3d6c1b"
dependencies = [
"errno",
"libc",
]
[[package]] [[package]]
name = "signature" name = "signature"
version = "2.2.0" version = "2.2.0"
@@ -3946,6 +4247,28 @@ dependencies = [
"url", "url",
] ]
[[package]]
name = "tauri-plugin-opener"
version = "2.7.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d39404b2572927e0d3ed30a7ca226037f7508d22e79c96ee6ef0d42b6a4b3345"
dependencies = [
"dunce",
"glob",
"objc2-app-kit",
"objc2-foundation",
"open",
"schemars 0.8.22",
"serde",
"serde_json",
"tauri",
"tauri-plugin",
"thiserror 2.0.21",
"url",
"windows",
"zbus",
]
[[package]] [[package]]
name = "tauri-plugin-process" name = "tauri-plugin-process"
version = "2.4.0" version = "2.4.0"
@@ -4476,6 +4799,17 @@ version = "1.20.1"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20" checksum = "b6f5e870be6c3b371b77fe0ee0bafb859fa4964b4404c27de1d380043c4dda20"
[[package]]
name = "uds_windows"
version = "1.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f2f6fb2847f6742cd76af783a2a2c49e9375d0a111c7bef6f71cd9e738c72d6e"
dependencies = [
"memoffset",
"tempfile",
"windows-sys 0.61.2",
]
[[package]] [[package]]
name = "unicode-ident" name = "unicode-ident"
version = "1.0.26" version = "1.0.26"
@@ -5343,6 +5677,76 @@ dependencies = [
"synstructure", "synstructure",
] ]
[[package]]
name = "zbus"
version = "5.19.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5db4be7c075cb421e4b7ee645541604239bd243ba7c357511f4ff3a74b555907"
dependencies = [
"async-broadcast",
"async-executor",
"async-io",
"async-lock",
"async-process",
"async-recursion",
"async-task",
"async-trait",
"blocking",
"enumflags2",
"event-listener",
"futures-core",
"futures-lite",
"hex",
"libc",
"ordered-stream",
"rustix",
"serde",
"serde_repr",
"tracing",
"uds_windows",
"uuid",
"windows-sys 0.61.2",
"winnow 1.0.4",
"zbus_macros",
"zbus_names",
"zvariant",
]
[[package]]
name = "zbus_macros"
version = "5.19.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2990635d09ade6df1868f72f8cac69a876a90981e8bd3c40b1be413f8dc88f40"
dependencies = [
"proc-macro-crate 3.5.0",
"proc-macro2",
"quote",
"syn 3.0.6",
"zbus_names",
"zvariant",
"zvariant_utils",
]
[[package]]
name = "zbus_names"
version = "4.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d8bf88b4a3ff53e883001e0e0115b297a9d53c31b9c1edd2bfdd853e3428624e"
dependencies = [
"serde",
"winnow 1.0.4",
"zvariant",
]
[[package]]
name = "zcheapstr"
version = "1.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d1afec51604565183aeb5c54c20aeab286120d4e4460f7f76e3e8bb8c0d99473"
dependencies = [
"serde",
]
[[package]] [[package]]
name = "zerofrom" name = "zerofrom"
version = "0.1.8" version = "0.1.8"
@@ -5483,3 +5887,44 @@ dependencies = [
"cc", "cc",
"pkg-config", "pkg-config",
] ]
[[package]]
name = "zvariant"
version = "5.15.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c1d34c27cc6cdd1f458427519dd6b8612f7b7e3f7b9a0b2355d041dda9869147"
dependencies = [
"endi",
"enumflags2",
"serde",
"winnow 1.0.4",
"zcheapstr",
"zvariant_derive",
"zvariant_utils",
]
[[package]]
name = "zvariant_derive"
version = "5.15.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "864155e69b4352db0c7f374917bf45d1e0c8d17659c8b3dbf9795f3673f8c497"
dependencies = [
"proc-macro-crate 3.5.0",
"proc-macro2",
"quote",
"syn 3.0.6",
"zvariant_utils",
]
[[package]]
name = "zvariant_utils"
version = "4.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bad0294361a320b694a328460dc73add56c306150f5cb6bfafc44446120008a3"
dependencies = [
"proc-macro2",
"quote",
"serde",
"syn 3.0.6",
"winnow 1.0.4",
]
+1 -1
View File
@@ -3,7 +3,7 @@ resolver = "2"
members = ["crates/coa-core", "crates/coa-release", "src-tauri"] members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
[workspace.package] [workspace.package]
version = "0.1.4" version = "0.6.0"
edition = "2021" edition = "2021"
license = "AGPL-3.0-only" license = "AGPL-3.0-only"
+1
View File
@@ -0,0 +1 @@
@AGENTS.md
+66 -18
View File
@@ -1,32 +1,80 @@
# CoA Server Manager # CoA Server Manager
Windows desktop manager for local Conquest of Azeroth (AzerothCore) servers. Tauri 2 + Rust + React. A Windows app that installs and runs your own **Conquest of Azeroth** server (AzerothCore) with a few clicks:
Design and audit: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md). no console, no config files, no database tools. Tauri 2 + Rust + React.
![Overview](docs/screenshots/play.png)
## What it does
* **One-click install.** Downloads a signed, verified server package (resumable, checked file by file), sets up the
database and creates your first account. Or import a server you already have.
* **Start / Stop / PLAY.** One button for the whole server (database, auth, world) with live status, uptime and
players online. PLAY starts the game client with the right realmlist.
* **Game client.** Use the client you already have, or let the Manager download it (about 43 GB, resumable, every file
verified). A client the Manager looks after is checked for updates like the server: PLAY turns into **UPDATE CLIENT**,
and files you changed yourself are never replaced unless you say so.
* **Safe updates.** The Manager checks for a new server version on start and every five minutes; the main button turns
into **UPDATE**. Updates are authenticated (Ed25519), back up first, keep files you changed and can be rolled back.
* **Backups.** Characters, accounts and settings on demand, automatically before every update; verify and restore
from the app.
* **CoA / Wildcard realms.** Choose the active realm on Overview. A server build with Wildcard support is required;
the first switch copies world data and creates an empty character database. Accounts are shared, characters and
module settings are separate, and only one world runs. Switching a running server saves characters and restarts it.
The closed client's saved realm follows this selection and is checked again before PLAY. If the client is open,
the change is applied on the next launch through the Manager.
CoA companions are unavailable on Wildcard; other optional modules are experimental. Backups include both realms,
and database updates apply to both.
See [realm profiles and validation](docs/WILDCARD.md).
* **Companions (bots).** Fill the world with level-appropriate bots, see progress, stop spawning, take them offline,
despawn N to relieve the server, and choose how many log in at server start.
* **Realmlist switcher.** Keep named realmlists (for example *Solo* and *PTR*) and switch the game client between them from a
drop-down next to PLAY; the file that was replaced is saved first.
* **Accounts.** See everyone who can log in, change passwords and access levels, rename an account.
* **Modules.** A page for the server's optional modules (switch on/off, GitHub, settings); it fills up as modules are added.
* **Report a problem.** A form that prepares a ready bug report for GitHub with your versions filled in.
* **Settings without files.** Bots and Server pages with plain-language options and presets, a console to the world
server, player list with account tools.
* **Play with friends.** Checks whether your server is reachable, opens firewall rules, finds your router (UPnP),
supports LAN, direct and private-network (Tailscale) play, with step-by-step guides and a package to send to friends.
* **Updates to the Manager itself** download in the background and install when you close it. Your servers are never
stopped or changed by a Manager update.
* **Languages:** English, Russian, German, French, Spanish.
| Install | Ready |
|---------|-------|
| ![Installing](docs/screenshots/install.png) | ![Ready](docs/screenshots/ready.png) |
| Overview | Server updates |
|----------|----------------|
| ![Overview](docs/screenshots/overview.png) | ![Updates](docs/screenshots/updates.png) |
![Backups](docs/screenshots/backups.png)
## Install
Download the installer from the [Releases](https://github.com/Corfirean/coa-server-manager/releases) page
and run it. You need about 10 GB of free disk space for the server. The game client (about 43 GB) is separate: point the
Manager at the one you have, or let it download one for you.
## Status ## Status
| Phase | State |
|-------|-------| Phases 0–10 of the plan in [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) are done: foundation, import, start/stop,
| 0 Audit + architecture | done | config engine, backups, clean install from signed packages, updates, companions, client launch, friends, polish.
| 1 Foundation (fsx, registry, manifest, logging, error catalogue) | done | Remaining work (translation review by native speakers, optional extras) is listed in section 9 of that document. Translation notes: [docs/TRANSLATIONS.md](docs/TRANSLATIONS.md).
| 2 Read-only import, process observation, Start/Stop via repack launcher, health diagnosis | done |
| 3 Config engine + Bots/Server settings UI + presets + snapshots | done |
| 4 Recovery points, DB dump/restore (staging + atomic swap), Backups UI | done |
| 5 Clean install: signed split packages, resumable verified download, staging + atomic commit, DB credential rotation, RA account creation | done |
| 6 Updates: tracked SQL migrations, update transaction (journal, conflicts, rollback), Settings > Server updates | done |
| 7 Companions: real population, hardware-aware sizes, RA spawn (install/update of the module rides on the update flow) | done |
| 8 Client: read-only detection, backed-up realmlist, isolated addon install, START & PLAY | done |
| Backlog: interface languages EN/RU/DE/FR/ES (see docs/ARCHITECTURE.md section 9) | planned |
| 9 Friends: exposure check, firewall rules, UPnP discovery, LAN/direct/private modes, friend package | done |
| 10 Polish: diagnostics, file verification, redacted diagnostic export | done; self-update installer, accessibility audit, i18n pending |
| `coa-server-build` repo: nightly build, edge/stable releases, fork sync | created; needs the COA_SIGNING_KEY / FORK_PUSH_TOKEN secrets |
## Develop ## Develop
``` ```
npm install npm install
cargo test --workspace # core logic (scan, fsx, manifest, process, driver, health) cargo test --workspace # core logic (scan, fsx, manifest, process, driver, health, updates, ...)
npx tsc --noEmit # type check
node tools/check-i18n.mjs # translation keys and placeholders
npx vite # UI in a browser uses a mock IPC (src/dev/mock.ts) npx vite # UI in a browser uses a mock IPC (src/dev/mock.ts)
cargo build -p coa-server-manager # native app (debug build loads http://localhost:1420) cargo build -p coa-server-manager # native app (debug build loads http://localhost:1420)
``` ```
Layout: `crates/coa-core` (logic), `crates/coa-release` (package tools: pack, sign, verify), `src-tauri`
(command layer), `src` (UI).
Live checks against a real repack: `cargo run -p coa-core --example scan -- <folder>` (read-only). Live checks against a real repack: `cargo run -p coa-core --example scan -- <folder>` (read-only).
Start/stop testing must use a disposable copy: `tools/make-fixture.ps1` builds `C:\games\coa-fixture` Start/stop testing must use a disposable copy: `tools/make-fixture.ps1` builds `C:\games\coa-fixture`
on offset ports from the pristine packaged database. Never run start/stop against a server in use. on offset ports from the pristine packaged database. Never run start/stop against a server in use.
@@ -0,0 +1,6 @@
---
area: manager
type: added
audience: admins
title: Collections tab with transmog, vanity, riding and companion switches
---
@@ -0,0 +1,6 @@
---
area: manager
type: fixed
audience: admins
title: Companion bots are recognised from their default config file
---
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Delete an account from the Players page
---
You type the account name to confirm; online and system accounts are refused.
@@ -0,0 +1,6 @@
---
area: manager
type: changed
audience: admins
title: Importing a server suggests the right folder when you pick the wrong one
---
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Modules page with cards, status badges and per-module settings
---
Switch the companion bots and NPC Enchanter on and off; a module's settings open under its card.
@@ -0,0 +1,6 @@
---
area: manager
type: changed
audience: admins
title: Report a problem collects more and ignores repeated config warnings
---
@@ -0,0 +1,6 @@
---
area: manager
type: changed
audience: admins
title: Server settings in one panel with search, tabs and a single Save bar
---
@@ -0,0 +1,6 @@
---
area: manager
type: fixed
audience: admins
title: The update check says you are up to date instead of offering the same version
---
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: The game client follows the realm selected in the Manager
---
Switching realms updates the closed client's saved realm automatically. Play checks it again before launch, preventing login attempts to the previous realm. If the client is running, the update waits until the next launch.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Configuration snapshots no longer overwrite each other
---
Snapshots created close together keep separate copies, so restoring a configuration reliably restores the selected snapshot.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Imported servers get the module config files they lack
---
They are created at start and after an update; existing files are never changed.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Experimental Linux startup and Docker server controls
---
The Manager can start on Linux and control manually prepared Docker servers. One-click installation, updates, backups and Wine or Proton client launch are not available yet.
@@ -0,0 +1,6 @@
---
area: manager
type: fixed
audience: admins
title: Modules marked Soon stay greyed out
---
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Problem reports open in the default browser
---
GitHub reports open in the default browser instead of Windows Explorer. Long reports use the clipboard fallback.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Simplified Chinese is available in the Manager
---
The interface and server and bot settings are now available in Simplified Chinese. Choose Simplified Chinese in the language selector.
@@ -0,0 +1,6 @@
---
area: manager
type: fixed
audience: admins
title: The Bots page is hidden when the module is not on the server
---
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: Updating the game client shows a progress bar on its button
---
No window covers the app while the client updates.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Switch between CoA and Wildcard while keeping separate characters and module settings
---
Run one world at a time with shared accounts. Wildcard keeps its own progress; CoA companions are unavailable there, and other modules show experimental compatibility. Backups and server updates cover both realms.
+7
View File
@@ -0,0 +1,7 @@
# changelog.d
One small Markdown file per change that a player or a server owner would notice. They are collected from every CoA
repository when a release is made. The rules and the file format are in `AGENTS.md` (section "Changelog") and, in full,
in https://github.com/Corfirean/coa-server-build/blob/main/changelog/GUIDE.md
This README is ignored by the collector.
@@ -0,0 +1,127 @@
-- Companion template characters: one level 80 character per CoA class (12-32), used by the bot module as the
-- source its bots are copied from. Generated from a maintainer database; guids and the owning account are
-- variables (@G is added to every guid, @ACC is the owner account, which must not be account 1 or a bot host).
-- Idempotent: rows that already exist are kept.
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+112,@ACC,'TcBarbarian',2,12,0,80,0,0,0,0,0,0,0,0,2,0,16226,16258,13.2,1,0,0,3.14159,'4194304 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,374,374,1789536550,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,8175,0,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 357876 0 0 0 2000002 0 0 0 2000000 0 2000001 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999013 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+113,@ACC,'TcWitchDoc',8,13,0,80,0,0,0,0,0,0,0,0,2,0,16226,16258,13.2,1,0,0,3.14159,'4194304 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,267,267,1789443324,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,3791,6796,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','2000014 0 0 0 0 0 0 0 2000013 0 0 0 2000011 0 484330 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999003 0 9999009 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+114,@ACC,'TcFelsworn',10,14,0,80,0,0,0,0,0,0,0,0,2,32,16234,16258,13.6675,1,0,0,3.14159,'0 0 131072 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,400,400,1789561795,1,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,7749,0,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 2000009 0 0 0 0 0 2000007 0 2000008 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+115,@ACC,'TcWitchHunt',1,15,0,80,0,0,0,0,0,0,0,0,2,0,16226,16258,13.2,1,0,0,3.14159,'2 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,238,238,1789439472,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,10000,4878,526,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','2000017 0 0 0 0 0 0 0 2000016 0 0 0 2000018 0 2000015 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999011 0 9999014 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+116,@ACC,'TcStormbr',6,16,0,80,0,0,0,0,0,0,0,0,2,32,16226,16258,13.2,1,0,0,0,'2097152 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,199,199,1789436314,1,0,0,0,0,0,0,0,0,0,0,0,139,0,'',0,0,0,0,0,0,0,0,0,0,0,8482,4681,660,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','501973 0 0 0 0 0 0 0 2000021 0 0 0 2000019 0 2000020 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999003 0 0 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+117,@ACC,'TcXoroth',2,17,0,80,0,0,0,0,0,0,0,0,2,32,16210,16258,16.3796,1,0,0,3.14159,'4194304 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,220,220,1789561746,1,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,9450,0,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000024 0 0 0 2000022 0 2000023 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999014 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+118,@ACC,'TcGuardian',1,18,0,80,0,0,0,0,0,0,0,0,2,16,16226,16258,13.2,1,0,0,-3.00499,'2 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,457,457,1789465163,0,0,0,0,0,0,0,0,0,0,0,0,876,1789453570,'',0,0,0,0,0,0,0,0,0,0,0,1,0,0,0,0,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 244613 0 2000027 0 0 0 2000025 0 2000026 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999015 0 9999014 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+119,@ACC,'TcTemplar',1,19,0,80,0,0,0,0,0,0,0,0,2,0,16233,16258,14.0852,1,0,0,-2.93445,'2 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,543,543,1789561768,0,0,0,0,0,0,0,0,0,0,0,0,876,1789453179,'',0,0,0,0,0,0,0,0,0,0,0,8554,0,1000,0,19,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 2446130 0 2000030 0 0 0 2000028 0 2117000 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 0 0 9999014 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+120,@ACC,'TcBloodmage',5,20,0,80,0,0,0,0,0,0,0,0,2,32,16226,16258,13.2,1,0,0,0,'1024 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,276,276,1789436248,1,0,0,0,0,0,0,0,0,0,0,0,139,0,'',0,0,0,0,0,0,0,0,0,0,0,413,0,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000033 0 0 0 2000031 0 494334 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+121,@ACC,'TcRanger',4,21,0,80,0,0,0,0,0,0,0,0,2,0,16226,16258,13.2,1,0,0,4.37863,'100663296 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,314,314,1789465922,0,0,0,0,0,0,0,0,0,0,0,0,876,1789434887,'',0,0,0,0,0,0,0,0,0,0,0,4349,0,0,30,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000040 0 0 0 2000038 0 2000039 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999008 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+122,@ACC,'TcChrono',7,22,0,80,0,0,0,0,0,0,0,0,2,0,16226,16258,13.2,1,0,0,3.14159,'32 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,154,154,1789537290,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,7453,4851,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000046 0 0 0 494335 0 2000045 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 0 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+123,@ACC,'TcNecro',5,23,0,80,0,0,0,0,0,0,0,0,2,0,16235,16258,13.7211,1,0,0,3.14159,'1024 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,141,141,1789561691,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,7118,6036,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000053 0 0 0 2000051 0 2000052 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+124,@ACC,'TcPyromancer',1,24,0,80,0,0,0,0,0,0,0,0,2,0,16231,16258,13.7211,1,0,0,3.14159,'2 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,485,485,1789561719,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,7395,5481,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000056 0 0 0 2000054 0 2000055 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+125,@ACC,'TcCultist',10,25,0,80,0,0,0,0,0,0,0,0,2,0,16235,16262,13.2,1,0,0,3.14159,'0 0 131072 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,374,374,1789561732,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,8261,4332,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000059 0 0 0 2000057 0 484331 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+126,@ACC,'TcStarcaller',4,26,0,80,0,0,0,0,0,0,0,0,2,0,16226,16258,13.2,1,0,0,3.14159,'100663296 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,233,233,1789536668,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,8296,5461,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000062 0 0 0 2000060 0 2000061 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999014 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+127,@ACC,'TcSunCleric',1,27,0,80,0,0,0,0,0,0,0,0,2,0,16210,16258,16.3796,1,0,0,5.76404,'2 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,1100,1100,1789564571,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,7523,6165,900,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000065 0 0 0 2000063 0 2000064 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999011 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+128,@ACC,'TcTinker',7,28,0,80,0,0,0,0,0,0,0,0,2,0,16235,16262,13.2,1,0,0,3.14159,'32 0 0 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,301,301,1789561705,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,8463,5522,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','2000047 0 0 0 0 0 0 0 2000043 0 0 0 2000041 0 2000042 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999003 0 9999014 655032320 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+129,@ACC,'TcVenomancer',8,29,0,80,0,0,0,0,0,0,0,0,2,0,16220,16258,13.2307,1,0,0,3.14159,'4194304 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,274,274,1789561782,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,8076,6021,0,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000068 0 0 0 967757 0 2000067 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999009 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+130,@ACC,'TcReaper',5,30,0,80,0,0,0,0,0,0,0,0,2,0,16226,16258,13.2,1,0,0,0,'1024 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,128,128,1789465178,0,0,0,0,0,0,0,0,0,0,0,0,876,0,'',0,0,0,0,0,0,0,0,0,0,0,8230,0,1000,0,100,0,0,100,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 2001095 0 2000071 0 0 0 2000069 0 2000070 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 0 9999011 0 9999008 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+131,@ACC,'TcPrimalist',6,31,0,80,0,0,0,0,0,0,0,0,2,32,16226,16258,13.2,1,0,0,0,'2097152 0 0 4 0 0 1048576 0 0 0 0 0 0 0 ',0,1,227,227,1789437186,1,0,0,0,0,0,0,0,0,0,0,0,139,0,'',0,0,0,0,0,0,0,0,0,0,0,9536,3431,980,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 0 0 2000074 0 0 0 2000072 0 2000073 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `characters` (`guid`, `account`, `name`, `race`, `class`, `gender`, `level`, `xp`, `money`, `skin`, `face`, `hairStyle`, `hairColor`, `facialStyle`, `bankSlots`, `restState`, `playerFlags`, `position_x`, `position_y`, `position_z`, `map`, `instance_id`, `instance_mode_mask`, `orientation`, `taximask`, `online`, `cinematic`, `totaltime`, `leveltime`, `logout_time`, `is_logout_resting`, `rest_bonus`, `resettalents_cost`, `resettalents_time`, `trans_x`, `trans_y`, `trans_z`, `trans_o`, `transguid`, `extra_flags`, `stable_slots`, `at_login`, `zone`, `death_expire_time`, `taxi_path`, `arenaPoints`, `totalHonorPoints`, `todayHonorPoints`, `yesterdayHonorPoints`, `totalKills`, `todayKills`, `yesterdayKills`, `chosenTitle`, `knownCurrencies`, `watchedFaction`, `drunk`, `health`, `power1`, `power2`, `power3`, `power4`, `power5`, `power6`, `power7`, `latency`, `talentGroupsCount`, `activeTalentGroup`, `exploredZones`, `equipmentCache`, `ammoId`, `knownTitles`, `actionBars`, `grantableLevels`, `order`, `creation_date`, `deleteInfos_Account`, `deleteInfos_Name`, `deleteDate`, `innTriggerId`, `extraBonusTalentCount`) VALUES (@G+132,@ACC,'TcRunemaster',11,32,0,80,0,0,0,0,0,0,0,0,2,32,16226,16258,13.2,1,0,0,0,'0 0 536870912 8 0 0 1048576 0 0 0 0 0 0 0 ',0,1,327,327,1789437523,1,0,0,0,0,0,0,0,0,0,0,0,139,0,'',0,0,0,0,0,0,0,0,0,0,0,8174,1,1000,0,100,0,0,1000,0,1,0,'0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 8 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 ','0 0 0 0 0 0 511017 0 2000080 0 0 0 2000078 0 2000079 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 9999001 65929216 9999009 0 9999007 0 0 0 0 0 0 0 0 0 0 0 ',0,'0 0 0 0 0 0 ',0,0,NULL,'2026-09-13 08:33:38',NULL,NULL,NULL,0,0);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+112,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+113,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+114,1,876,16234,16258,13.6675);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+115,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+116,1,139,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+117,1,876,16210,16258,16.3796);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+118,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+119,1,876,16233,16258,14.0852);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+120,1,139,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+121,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+122,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+123,1,876,16235,16258,13.7211);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+124,1,876,16231,16258,13.7211);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+125,1,876,16235,16262,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+126,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+127,1,876,16210,16258,16.3796);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+128,1,876,16235,16262,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+129,1,876,16220,16258,13.2307);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+130,1,876,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+131,1,139,16226,16258,13.2);
INSERT IGNORE INTO `character_homebind` (`guid`, `mapId`, `zoneId`, `posX`, `posY`, `posZ`) VALUES (@G+132,1,139,16226,16258,13.2);
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+112,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+112,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+112,'core.spell_charge.500919','2 0 0 6000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+112,'core.spell_charge.804138','3 0 0 8000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+113,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+113,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+114,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+114,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+114,'core.spell_charge.500028','3 0 0 10000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+114,'core.spell_charge.561216','2 0 0 90000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+115,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+115,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+115,'core.spell_charge.802006','2 0 0 25000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+115,'core.spell_charge.803333','2 0 0 15000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+116,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+116,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+116,'core.spell_charge.705669','3 0 0 15000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+116,'core.spell_charge.804036','3 0 0 10000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+117,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+117,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+117,'core.spell_charge.805555','2 0 0 8000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+117,'core.spell_charge.807247','2 0 0 60000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+118,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+118,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+118,'core.spell_charge.800316','1 1789452964 866 6000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+119,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+119,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+119,'core.spell_charge.801165','3 0 0 35000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+120,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+120,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+120,'core.spell_charge.804197','2 0 0 6000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+121,'core.ascension_active_spec','28 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+121,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+122,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+122,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+122,'core.spell_charge.706969','3 0 0 15000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+123,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+123,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+124,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+124,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+125,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+125,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+125,'core.spell_charge.500720','3 0 0 6000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+125,'core.spell_charge.500721','3 0 0 30000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+125,'core.spell_charge.804711','2 0 0 60000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+126,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+126,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+126,'core.spell_charge.520590','2 0 0 18000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+127,'core.ascension_active_spec','46 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+127,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+127,'core.spell_charge.560095','2 0 0 25000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.500241','3 0 0 30000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.500600','3 0 0 10000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.504527','2 0 0 8000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.560750','3 0 0 15000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.560754','3 0 0 15000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.801799','3 0 0 15000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.801801','3 0 0 15000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+128,'core.spell_charge.805306','3 0 0 20000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+129,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+129,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+129,'core.spell_charge.504342','2 0 0 12000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+129,'core.spell_charge.504706','2 0 0 25000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+129,'core.spell_charge.805931','3 0 0 20000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+130,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+130,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+130,'core.spell_charge.573425','3 0 0 30000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+130,'core.spell_charge.803990','2 0 0 60000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+130,'core.spell_charge.803997','2 0 0 40000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+131,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+131,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+131,'core.spell_charge.503630','2 0 0 20000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+131,'core.spell_charge.706342','2 0 0 10000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+131,'core.spell_charge.803974','2 0 0 8000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+132,'core.ascension_active_spec','0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+132,'core.ascension_starter','1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+132,'core.runemaster.echoes','2 0 0 0 0 0 0 0 0 0 0 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+132,'core.spell_charge.707141','0 1789437518 37 6000 1 ');
INSERT IGNORE INTO `character_settings` (`guid`, `source`, `data`) VALUES (@G+132,'core.spell_charge.712389','2 0 0 45000 1 ');
+31
View File
@@ -0,0 +1,31 @@
//! Live check of the client download path against the community launcher's public server:
//! reads the manifest and downloads the few smallest files into a temp folder (never a real client).
//! Usage: cargo run -p coa-core --example client_probe (PROBE_SKIP=n skips the n smallest files)
use coa_core::clientdl::{self, Apply, Manifest};
use coa_core::download::{Cancel, HttpTransport};
fn main() {
let full = clientdl::fetch_latest().expect("manifest");
println!("version {} · {} files · {:.1} GB", full.version, full.files.len(), full.total_bytes() as f64 / 1e9);
let mut small = full.files.clone();
small.sort_by_key(|f| f.size);
let skip: usize = std::env::var("PROBE_SKIP").ok().and_then(|v| v.parse().ok()).unwrap_or(0);
let small: Vec<_> = small.into_iter().skip(skip).take(6).collect();
let manifest = Manifest { version: full.version.clone(), published_at: None, files: small };
let dir = std::env::temp_dir().join(format!("coa-client-probe-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let cancel = Cancel::default();
let plan = clientdl::plan(&dir, &manifest, &Default::default(), &cancel, &|_| {}).unwrap();
println!("plan: {} files, {} bytes", plan.items.len(), plan.download_bytes);
let transport = HttpTransport::new().unwrap();
clientdl::apply(
&Apply { client: &dir, manifest: &manifest, plan: &plan, keep_modified: false, transport: &transport, objects_url: clientdl::OBJECTS_URL, cancel: &cancel },
&|s| println!("{} {}/{} {}", s.phase, s.done, s.total, s.file.unwrap_or_default()),
)
.expect("apply");
let again = clientdl::plan(&dir, &manifest, &clientdl::load_state(&dir).unwrap(), &cancel, &|_| {}).unwrap();
println!("second plan: {} to do, {} up to date, version {:?}", again.items.len(), again.up_to_date_files, clientdl::local(&dir).version);
std::fs::remove_dir_all(&dir).unwrap();
}
@@ -0,0 +1,19 @@
//! Adds the template characters to a scratch install and creates companions offline. usage: companions_e2e <install folder> <count>
//! The folder name must contain "installtest" and its database must already be running (Scripts/manage.py start-mysql).
use coa_core::db::{Account, Db};
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = std::path::PathBuf::from(&a[0]);
assert!(a[0].to_lowercase().contains("installtest"), "refusing to touch a server that is not a disposable test install");
let count: u32 = a[1].parse().unwrap();
let db = Db::from_repack(&root, Account::Admin).expect("db");
println!("templates before: {}", coa_core::companions::template_count(&db).unwrap());
println!("added: {}", coa_core::companions::ensure_templates(&db).unwrap());
println!("templates after: {}", coa_core::companions::template_count(&db).unwrap());
let t = std::time::Instant::now();
match coa_core::companions::offline_create(&root, &root.join("companions-e2e.log"), count) {
Ok(tail) => println!("offline create ok in {:?}:\n{tail}", t.elapsed()),
Err(e) => println!("offline create FAILED: {e}"),
}
}
+92
View File
@@ -0,0 +1,92 @@
//! Native smoke checks for the disposable fixture created by tools/make-fixture.ps1.
//! Never point these probes at an owned server.
use std::path::Path;
use coa_core::db::{Account, Db};
use coa_core::driver::{self, Verb};
use coa_core::realms::{self, Mode};
use coa_core::{Error, Result};
fn main() -> Result<()> {
let args: Vec<String> = std::env::args().collect();
let root = Path::new("C:/games/coa-wildcard-fixture");
let action = args.get(1).map(String::as_str).unwrap_or("view");
match action {
"select" => {
let mode = if args.get(2).map(String::as_str) == Some("wildcard") { Mode::Wildcard } else { Mode::Coa };
println!("{}", serde_json::to_string(&realms::select(root, mode)?)?);
}
"start" | "stop" => {
let out = driver::run(root, if action == "start" { Verb::StartAll } else { Verb::StopAll })?;
println!("{}", serde_json::to_string(&out)?);
if !out.ok { return Err(Error::Invalid("Fixture operation failed".into())); }
}
"probe" => {
let db = Db::from_repack(root, Account::Admin)?;
let s = realms::state(root)?;
println!("{}", db.query("SELECT * FROM acore_characters.manager_profile_probe;")?);
println!("active={} chars={} world={}", s.active.name(), s.active.schema("characters")?, s.active.schema("world")?);
}
"mark" => {
Db::from_repack(root, Account::Admin)?.query("INSERT INTO acore_characters.manager_profile_probe VALUES (22);")?;
}
"backup" => {
use coa_core::backup::{self, Kind, Trigger};
let meta = root.join("fixture-manager");
let point = backup::create(root, &meta, Kind::Full, Trigger::Manual, Some("realm isolation check".into()), &|step| println!("{step}"))?;
assert_eq!(point.realm, Mode::Wildcard);
for name in ["characters", "world", "auth", "coa-characters", "coa-world", "configs"] {
assert!(point.components.iter().any(|c| c.name == name), "Missing {name}");
}
assert!(backup::verify(&meta, &point.id)?.ok);
println!("Verified both realm backups: {}", point.id);
}
"database-checks" => {
use coa_core::backup::{self, Kind, Trigger};
use coa_core::manifest::{Manifest, Migration};
use coa_core::update::{Env, RepackEnv};
let meta = root.join("fixture-manager");
let env = RepackEnv { root, meta_dir: &meta };
env.ensure_stopped()?;
let staged = root.join("fixture-migrations");
let mut manifest: Manifest = serde_json::from_value(serde_json::json!({
"schema": 1, "kind": "update", "version": "0.5.0", "core": {"commit": null},
"builtAt": "fixture", "minManagerVersion": "0.5.0"
}))?;
for kind in ["characters", "world", "auth"] {
let sql = format!("CREATE TABLE acore_{kind}.manager_migration_probe (value INT); INSERT INTO acore_{kind}.manager_migration_probe VALUES (42);");
let path = staged.join(format!("{kind}/manager_realm_fixture.sql"));
std::fs::create_dir_all(path.parent().unwrap())?;
std::fs::write(&path, sql)?;
manifest.migrations.push(Migration { id: "manager_realm_fixture".into(), db: kind.into(), sha256: coa_core::fsx::sha256_file(&path)?, destructive: false });
}
let result = env.migrate(&manifest, &staged)?;
assert!(result.failed.is_none());
backup::with_database(root, |db| {
for mode in [Mode::Coa, Mode::Wildcard] {
let realm = db.clone().for_realm(mode);
for kind in ["characters", "world", "auth"] {
assert_eq!(realm.query(&format!("SELECT COUNT(*) FROM acore_{kind}.manager_migration_probe;"))?, "1");
}
}
Ok(())
})?;
assert!(env.migrate(&manifest, &staged)?.applied.is_empty());
let point = backup::create(root, &meta, Kind::Quick, Trigger::Manual, None, &|_| {})?;
backup::with_database(root, |db| {
db.query("INSERT INTO acore_characters.manager_profile_probe VALUES (22);")?;
Ok(())
})?;
backup::restore_database(root, &meta, &point.id, "characters")?;
backup::with_database(root, |db| {
assert_eq!(db.query("SELECT COUNT(*) FROM acore_characters.manager_profile_probe;")?, "0");
assert_eq!(db.clone().for_realm(Mode::Coa).query("SELECT value FROM acore_characters.manager_profile_probe;")?, "11");
Ok(())
})?;
println!("Both realms migrated once; shared auth migrated once; Wildcard restore left CoA intact.");
}
"view" => println!("{}", serde_json::to_string(&realms::view(root)?)?),
_ => return Err(Error::Invalid("Unknown fixture action".into())),
}
Ok(())
}
+25
View File
@@ -0,0 +1,25 @@
//! Check and apply a real published update on a DISPOSABLE install. usage: update_url <install folder> <update url>
//! The folder name must contain "installtest"; ports must already point away from any running server.
use coa_core::download::Cancel;
use coa_core::pkgsource::Source;
use coa_core::registry::{metadata_dir_for, MetaDir};
use coa_core::update::{apply, preview, Params, RepackEnv};
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
let root = std::path::PathBuf::from(&a[0]);
assert!(a[0].to_lowercase().contains("installtest"), "refusing: not a disposable test install");
let dir = metadata_dir_for(&root).unwrap();
let (_, meta) = MetaDir::open(&dir).unwrap();
let src = Source::Url(a[1].clone());
let p = preview(&root, &meta, &src, coa_core::signing::EMBEDDED_PUBLIC_KEY, &Default::default()).unwrap_or_else(|e| panic!("preview failed: {e:?}"));
println!("preview: {} -> {} | download {} bytes | {} files change | {} migrations | conflicts {:?}", p.from_version.clone().unwrap_or_default(), p.to_version, p.download_bytes, p.items.iter().filter(|i| format!("{:?}", i.action) != "Skip").count(), p.migrations, p.conflicts);
let env = RepackEnv { root: &root, meta_dir: &dir };
let t = std::time::Instant::now();
let out = apply(
&Params { root: &root, meta_dir: &dir, source: src, trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY, cancel: Cancel::default(), resolutions: Default::default(), env: &env, fail_after_ops: None },
&|s, pct| eprintln!(" {pct:>3}% {s}"),
)
.unwrap_or_else(|e| panic!("apply failed: {e:?}"));
println!("apply finished in {:?}: state {:?}, to {:?}", t.elapsed(), out.txn.state, out.txn.to_version);
}
+146
View File
@@ -0,0 +1,146 @@
//! The accounts of the people who play on this server: listed from the login database, changed through the world
//! console (password, access level) or - for a rename - by changing the stored name and then letting the console set
//! a new password, because the login verifier is computed from the name and would no longer match.
//! The accounts the Manager and the companions use themselves are never listed.
use std::path::Path;
use serde::Serialize;
use crate::db::{Account, Db};
use crate::error::{Error, Result};
use crate::ra::{validate_account, Ra};
#[derive(Debug, Clone, Serialize, PartialEq, Eq)]
pub struct AccountInfo {
pub id: u32,
pub name: String,
/// 0 player, 1 moderator, 2 game master, 3 administrator.
pub access: u8,
pub online: bool,
pub last_login: Option<String>,
pub characters: u32,
}
const LIST_SQL: &str = "SELECT a.id, a.username, \
IFNULL((SELECT MAX(aa.gmlevel) FROM acore_auth.account_access aa WHERE aa.id = a.id), 0), \
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;";
/// Rows of tab-separated columns as the `mysql` client prints them.
pub fn parse_list(out: &str) -> Vec<AccountInfo> {
out.lines()
.filter_map(|line| {
let c: Vec<&str> = line.split('\t').collect();
if c.len() < 6 {
return None;
}
Some(AccountInfo {
id: c[0].trim().parse().ok()?,
name: c[1].trim().to_string(),
access: c[2].trim().parse().unwrap_or(0),
online: c[3].trim() != "0",
last_login: Some(c[4].trim().to_string()).filter(|s| !s.is_empty() && s != "NULL"),
characters: c[5].trim().parse().unwrap_or(0),
})
})
.collect()
}
pub fn list(root: &Path) -> Result<Vec<AccountInfo>> {
let db = Db::from_repack(root, Account::Admin)?;
Ok(parse_list(&db.query(LIST_SQL)?))
}
fn upper(name: &str) -> Result<String> {
validate_account(name, "placeholder")?;
Ok(name.to_ascii_uppercase())
}
/// Give the account a new name. Needs the world console (the new password is what makes the login work again) and an
/// account that is not logged in. The old name is put back if anything goes wrong.
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 old == new {
return Err(Error::Invalid("That is already the name of this account.".into()));
}
let db = Db::from_repack(root, Account::Admin)?;
let taken = db.query(&format!("SELECT COUNT(*) FROM acore_auth.account WHERE username = '{new}';"))?;
if taken.trim() != "0" {
return Err(Error::Invalid("That account name is already taken.".into()));
}
let changed = db.query(&format!("UPDATE acore_auth.account SET username = '{new}' WHERE username = '{old}' AND online = 0; SELECT ROW_COUNT();"))?;
if changed.trim() != "1" {
return Err(Error::Invalid("The account was not renamed: it does not exist or is logged in right now.".into()));
}
if let Err(e) = ra.set_account_password(&new, password) {
let _ = db.query(&format!("UPDATE acore_auth.account SET username = '{old}' WHERE username = '{new}';"));
return Err(e);
}
tracing::info!(%old, %new, "account renamed");
Ok(())
}
/// Accounts the Manager and the companions use themselves; they can never be deleted from here.
fn is_reserved(upper_name: &str) -> bool {
upper_name == "COAMANAGER" || upper_name.starts_with("COABOT")
}
/// Delete an account and, with it, all of its characters. Needs the world console. Refuses the Manager's and the
/// 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()));
}
let db = Db::from_repack(root, Account::Admin)?;
match db.query(&format!("SELECT online FROM acore_auth.account WHERE username = '{name}';"))?.trim() {
"" => return Err(Error::Invalid("That account does not exist.".into())),
"0" => {}
_ => return Err(Error::Invalid("The account is logged in right now; log it out first.".into())),
}
ra.delete_account(&name)?;
if db.query(&format!("SELECT COUNT(*) FROM acore_auth.account WHERE username = '{name}';"))?.trim() != "0" {
return Err(Error::Invalid("The account was not deleted.".into()));
}
tracing::info!(%name, "account deleted");
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn rows_from_the_client_become_accounts() {
let out = "2\tALICE\t3\t0\t2026-09-30 21:04:11\t4\n5\tBOB\t0\t1\t\t0\n7\tBROKEN\n";
let a = parse_list(out);
assert_eq!(a.len(), 2, "a short row is skipped");
assert_eq!(a[0], AccountInfo { id: 2, name: "ALICE".into(), access: 3, online: false, last_login: Some("2026-09-30 21:04:11".into()), characters: 4 });
assert!(a[1].online && a[1].last_login.is_none() && a[1].access == 0);
}
#[test]
fn the_internal_accounts_are_filtered_out_by_the_query() {
assert!(LIST_SQL.contains("COABOTHOST%") && LIST_SQL.contains("COAMANAGER"));
}
#[test]
fn the_managers_and_the_companions_accounts_are_never_deletable() {
for n in ["COAMANAGER", "COABOTHOST1", "COABOT12", "COABOTS"] {
assert!(is_reserved(n), "{n}");
}
for n in ["ALICE", "MYCOABOT", "BOT1"] {
assert!(!is_reserved(n), "{n}");
}
}
#[test]
fn names_are_validated_and_stored_in_capitals() {
assert_eq!(upper("Alice1").unwrap(), "ALICE1");
assert!(upper("a").is_err() && upper("x; DROP TABLE account").is_err() && upper("bad name").is_err());
}
}
+239
View File
@@ -0,0 +1,239 @@
//! Every setting of the world server's configuration, for people who want more than the curated list: the documented
//! settings come from `worldserver.conf.dist` (the file that ships with the server and explains each one), the current
//! values from the configuration the next start will use. Anything that holds a password, a port, an address, a folder or
//! the database connection is left out; the Manager owns those.
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use serde::Serialize;
use crate::config::parser::ConfFile;
use crate::config::{take_snapshot, targets, Scope};
use crate::error::{Error, Result};
use crate::fsx;
#[derive(Debug, Serialize, PartialEq, Eq)]
pub struct Item {
pub key: String,
/// What the server uses now (the documented default when the file does not mention the setting).
pub value: String,
pub default: String,
pub doc: String,
/// The file sets it to something other than the documented default.
pub changed: bool,
}
/// Settings the Manager (or the launcher) owns.
fn hidden(key: &str) -> bool {
let k = key.to_ascii_lowercase();
k.contains("password")
|| k.contains("databaseinfo")
|| k.ends_with("port")
|| k.starts_with("ra.")
|| k.starts_with("logger.")
|| k.starts_with("appender.")
|| k.starts_with("updates.")
|| k.starts_with("logindatabase.")
|| k.starts_with("worlddatabase.")
|| k.starts_with("characterdatabase.")
|| ["bindip", "realmid", "datadir", "logsdir", "tempdir", "sourcedirectory", "mysqlexecutable", "cmakecommand", "builddirectory", "pidfile", "vmapdir", "mmapdir"].contains(&k.as_str())
}
fn doc_of(block: &[String]) -> String {
let mut parts: Vec<String> = Vec::new();
for l in block {
let body = l.trim_start_matches('#').trim();
if body.is_empty() {
continue;
}
// the lines that only name the settings the block describes
let named = l.starts_with("# ") && !l.starts_with("# ") && body.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'));
if named {
continue;
}
parts.push(body.split_whitespace().collect::<Vec<_>>().join(" "));
}
let mut doc = parts.join(" ");
if doc.chars().count() > 900 {
doc = doc.chars().take(900).collect::<String>() + "…";
}
doc
}
/// The documented settings of a `.dist` file: (key, default, description), in file order.
fn parse_dist(text: &str) -> Vec<(String, String, String)> {
let mut out = Vec::new();
let mut block: Vec<String> = Vec::new();
let mut in_comment = false;
let mut doc = String::new();
for line in text.lines() {
let t = line.trim();
if t.starts_with('#') {
if !in_comment {
block.clear();
in_comment = true;
}
block.push(line.trim_end().to_string());
continue;
}
if in_comment {
doc = doc_of(&block);
in_comment = false;
}
if t.is_empty() || t.starts_with('[') {
continue;
}
if let Some((k, v)) = t.split_once('=') {
let k = k.trim();
if !k.is_empty() && k.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-')) {
out.push((k.to_string(), v.trim().to_string(), doc.clone()));
}
}
}
out
}
fn dist_path(root: &Path) -> std::path::PathBuf {
root.join("Core/configs/worldserver.conf.dist")
}
pub fn list(root: &Path) -> Result<Vec<Item>> {
let dist = fs::read_to_string(dist_path(root)).map_err(|_| Error::Invalid("The documented settings file (worldserver.conf.dist) was not found on this server.".into()))?;
let t = targets(root, Scope::Server)?;
let active = ConfFile::parse_bytes(&fs::read(&t.read)?)?;
Ok(parse_dist(&dist)
.into_iter()
.filter(|(k, _, _)| !hidden(k))
.map(|(key, default, doc)| {
let value = active.get(&key).map(|v| v.trim().to_string()).unwrap_or_else(|| default.clone());
let changed = value != default;
Item { key, value, default, doc, changed }
})
.collect())
}
/// Change settings that exist in the documented file. A value is one line of at most 500 characters. Returns the keys
/// that actually changed; the previous files are snapshotted first (and can be restored from Settings).
pub fn save(root: &Path, meta: &Path, changes: &BTreeMap<String, String>) -> Result<Vec<String>> {
let known: BTreeMap<String, String> = parse_dist(&fs::read_to_string(dist_path(root)).map_err(|_| Error::Invalid("worldserver.conf.dist was not found on this server.".into()))?)
.into_iter()
.map(|(k, d, _)| (k, d))
.collect();
let t = targets(root, Scope::Server)?;
let mut originals: Vec<(std::path::PathBuf, Vec<u8>)> = Vec::new();
let mut confs: Vec<ConfFile> = Vec::new();
for p in &t.writes {
let bytes = fs::read(p)?;
confs.push(ConfFile::parse_bytes(&bytes)?);
originals.push((p.clone(), bytes));
}
let mut changed = Vec::new();
for (key, value) in changes {
let value = value.trim();
if hidden(key) || !known.contains_key(key) {
return Err(Error::Invalid(format!("{key} is not a setting that can be changed here.")));
}
if value.is_empty() || value.len() > 500 || value.chars().any(char::is_control) {
return Err(Error::Invalid(format!("The value of {key} must be one line of text.")));
}
let same = confs.iter().all(|c| match c.get(key) {
Some(v) => v.trim() == value,
None => known[key] == value,
});
if !same {
changed.push((key.clone(), value.to_string()));
}
}
if changed.is_empty() {
return Ok(Vec::new());
}
for c in &mut confs {
for (k, v) in &changed {
c.set(k, v, &["Added by CoA Server Manager"]);
}
}
let texts: Vec<String> = confs.iter().map(ConfFile::to_text).collect();
for text in &texts {
let reread = ConfFile::parse(text);
for (k, v) in &changed {
if reread.get(k).map(str::trim) != Some(v.as_str()) {
return Err(Error::Invalid(format!("internal check failed for {k}")));
}
}
}
take_snapshot(meta, Scope::Server, &format!("before changing {} setting(s) in the full list", changed.len()), &originals)?;
let mut written = 0;
for (i, (path, _)) in originals.iter().enumerate() {
if let Err(e) = fsx::atomic_write(path, texts[i].as_bytes()) {
for (p, bytes) in originals.iter().take(written) {
let _ = fsx::atomic_write(p, bytes);
}
return Err(e);
}
written += 1;
}
Ok(changed.into_iter().map(|(k, _)| k).collect())
}
#[cfg(test)]
mod tests {
use super::*;
const DIST: &str = "[worldserver]\r\n\r\n###################\r\n# SECTION\r\n###################\r\n\r\n#\r\n# Rate.Drop.Item.Epic\r\n# Rate.Drop.Item.Rare\r\n# Description: Drop rates by quality.\r\n# Default: 1\r\n#\r\n\r\nRate.Drop.Item.Rare = 1\r\nRate.Drop.Item.Epic = 1\r\n\r\n#\r\n# LoginDatabaseInfo\r\n# Description: secret\r\n#\r\n\r\nLoginDatabaseInfo = \"127.0.0.1;3306;a;b;c\"\r\n\r\n#\r\n# Instance.ResetTimeHour\r\n# Description: Hour of the reset.\r\n# Important: Use 0-23.\r\n# Default: 4\r\n#\r\n\r\nInstance.ResetTimeHour = 4\r\n";
fn server(d: &Path) -> (std::path::PathBuf, std::path::PathBuf) {
let (root, meta) = (d.join("srv"), d.join("meta"));
fs::create_dir_all(root.join("Core/configs")).unwrap();
fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(&meta).unwrap();
fs::write(root.join("Core/configs/worldserver.conf.dist"), DIST).unwrap();
let conf = "[worldserver]\r\nRate.Drop.Item.Epic = 3\r\nLoginDatabaseInfo = \"x\"\r\n";
fs::write(root.join("Settings/worldserver.conf.template"), conf).unwrap();
fs::write(root.join("Core/configs/worldserver.conf"), conf).unwrap();
(root, meta)
}
#[test]
fn the_documentation_of_a_block_is_shared_by_its_settings_and_secrets_are_left_out() {
let d = tempfile::tempdir().unwrap();
let (root, _) = server(d.path());
let items = list(&root).unwrap();
let keys: Vec<&str> = items.iter().map(|i| i.key.as_str()).collect();
assert_eq!(keys, ["Rate.Drop.Item.Rare", "Rate.Drop.Item.Epic", "Instance.ResetTimeHour"], "the database connection is hidden");
assert_eq!(items[0].doc, "Description: Drop rates by quality. Default: 1");
assert_eq!(items[0].doc, items[1].doc);
assert_eq!(items[2].doc, "Description: Hour of the reset. Important: Use 0-23. Default: 4");
assert!(!items[0].changed && items[0].value == "1", "absent from the file: documented default");
assert!(items[1].changed && items[1].value == "3");
}
#[test]
fn only_documented_visible_settings_with_one_line_values_can_be_saved_and_both_files_change() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
let ok = BTreeMap::from([("Instance.ResetTimeHour".to_string(), "6".to_string())]);
assert_eq!(save(&root, &meta, &ok).unwrap(), ["Instance.ResetTimeHour"]);
for f in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
let t = fs::read_to_string(root.join(f)).unwrap();
assert!(t.contains("Instance.ResetTimeHour = 6") && t.contains("Rate.Drop.Item.Epic = 3"), "{f}: {t}");
}
assert!(save(&root, &meta, &ok).unwrap().is_empty(), "same value: nothing to do");
let same_as_default = BTreeMap::from([("Rate.Drop.Item.Rare".to_string(), "1".to_string())]);
assert!(save(&root, &meta, &same_as_default).unwrap().is_empty(), "the default is already in effect");
for bad in [("LoginDatabaseInfo", "\"evil\""), ("Nope.Key", "1"), ("Rate.Drop.Item.Rare", ""), ("Rate.Drop.Item.Rare", "1\n2")] {
assert!(save(&root, &meta, &BTreeMap::from([(bad.0.to_string(), bad.1.to_string())])).is_err(), "{bad:?}");
}
}
#[test]
fn what_belongs_to_the_manager_is_hidden() {
for k in ["LoginDatabaseInfo", "WorldServerPort", "BindIP", "Ra.Enable", "Ra.Password", "Logger.root", "Appender.Console", "DataDir", "Updates.EnableDatabases", "LoginDatabase.WorkerThreads", "InstanceServerPort"] {
assert!(hidden(k), "{k}");
}
for k in ["Rate.XP.Kill", "PlayerLimit", "SupportEnabled", "Instance.ResetTimeHour", "Warden.Enabled", "CharacterCreating.Disabled"] {
assert!(!hidden(k), "{k}");
}
}
}
+24 -4
View File
@@ -63,6 +63,8 @@ pub struct RecoveryPoint {
pub created_at: String, pub created_at: String,
pub manager_version: String, pub manager_version: String,
pub components: Vec<Component>, pub components: Vec<Component>,
#[serde(default)]
pub realm: crate::realms::Mode,
} }
fn backups_dir(meta: &Path) -> PathBuf { fn backups_dir(meta: &Path) -> PathBuf {
@@ -127,6 +129,8 @@ pub fn config_files(root: &Path) -> Vec<String> {
if root.join("RELEASE.json").is_file() { if root.join("RELEASE.json").is_file() {
out.push("RELEASE.json".into()); out.push("RELEASE.json".into());
} }
walk(root, &root.join("Settings/realm-profiles"), &mut out);
if root.join("Settings/realm-profile.json").is_file() { out.push("Settings/realm-profile.json".into()); }
out.sort(); out.sort();
out out
} }
@@ -191,16 +195,24 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
let build = || -> Result<Vec<Component>> { let build = || -> Result<Vec<Component>> {
let mut components = Vec::new(); let mut components = Vec::new();
for name in wanted_databases(kind) { let realm = crate::realms::state(root)?;
let schema = db::schema_of(name)?; let mut databases: Vec<(String, &str)> = wanted_databases(kind).iter()
.map(|name| Ok((name.to_string(), realm.active.schema(name)?))).collect::<Result<_>>()?;
if realm.wildcard_created && kind != Kind::Config {
let other = if realm.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa };
databases.push((format!("{}-characters", other.name()), other.schema("characters")?));
if kind == Kind::Full { databases.push((format!("{}-world", other.name()), other.schema("world")?)); }
}
for (name, schema) in databases {
progress(&format!("Backing up {name} database")); progress(&format!("Backing up {name} database"));
let component = with_database(root, |db| { let component = with_database(root, |db| {
let db = db.clone().for_realm(crate::realms::Mode::Coa);
let size = db.schema_bytes(schema)?; let size = db.schema_bytes(schema)?;
fsx::require_space(&partial, size / 2 + 32 * 1024 * 1024)?; fsx::require_space(&partial, size / 2 + 32 * 1024 * 1024)?;
let tables = db.tables(schema)?.len(); let tables = db.tables(schema)?.len();
let file = format!("{name}.sql.zst"); let file = format!("{name}.sql.zst");
let (bytes, sha) = db.dump_to(schema, &partial.join(&file))?; let (bytes, sha) = db.dump_to(schema, &partial.join(&file))?;
Ok(Component { name: (*name).into(), path: file, bytes, sha256: Some(sha), tables: Some(tables), files: None }) Ok(Component { name, path: file, bytes, sha256: Some(sha), tables: Some(tables), files: None })
})?; })?;
components.push(component); components.push(component);
} }
@@ -219,6 +231,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
} }
}; };
let point = RecoveryPoint { let point = RecoveryPoint {
realm: crate::realms::state(root)?.active,
schema: 1, schema: 1,
id: id.clone(), id: id.clone(),
kind, kind,
@@ -289,6 +302,9 @@ pub fn delete(meta: &Path, id: &str) -> Result<()> {
/// Put configuration files back. Files the backup does not contain are left alone. A safety point is taken first. /// Put configuration files back. Files the backup does not contain are left alone. A safety point is taken first.
pub fn restore_configs(root: &Path, meta: &Path, id: &str) -> Result<RecoveryPoint> { pub fn restore_configs(root: &Path, meta: &Path, id: &str) -> Result<RecoveryPoint> {
let point = get(meta, id)?; let point = get(meta, id)?;
if point.realm != crate::realms::state(root)?.active {
return Err(Error::Invalid("Select the realm this backup belongs to before restoring it.".into()));
}
let comp = point.components.iter().find(|c| c.name == "configs").ok_or_else(|| Error::Invalid("this backup has no configuration".into()))?; let comp = point.components.iter().find(|c| c.name == "configs").ok_or_else(|| Error::Invalid("this backup has no configuration".into()))?;
if !verify(meta, id)?.ok { if !verify(meta, id)?.ok {
return Err(Error::Invalid("This backup is damaged and cannot be restored.".into())); return Err(Error::Invalid("This backup is damaged and cannot be restored.".into()));
@@ -314,6 +330,9 @@ pub struct DbRestore {
/// import into a staging schema, sanity-check it, then swap tables atomically and keep the old schema. /// import into a staging schema, sanity-check it, then swap tables atomically and keep the old schema.
pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Result<DbRestore> { pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Result<DbRestore> {
let point = get(meta, id)?; let point = get(meta, id)?;
if point.realm != crate::realms::state(root)?.active {
return Err(Error::Invalid("Select the realm this backup belongs to before restoring it.".into()));
}
let comp = point.components.iter().find(|c| c.name == name && c.sha256.is_some()).ok_or_else(|| Error::Invalid(format!("this backup has no {name} database")))?; let comp = point.components.iter().find(|c| c.name == name && c.sha256.is_some()).ok_or_else(|| Error::Invalid(format!("this backup has no {name} database")))?;
if !verify(meta, id)?.ok { if !verify(meta, id)?.ok {
return Err(Error::Invalid("This backup is damaged and cannot be restored.".into())); return Err(Error::Invalid("This backup is damaged and cannot be restored.".into()));
@@ -322,7 +341,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
if now.world.state != ServiceState::Stopped || now.auth.state != ServiceState::Stopped { if now.world.state != ServiceState::Stopped || now.auth.state != ServiceState::Stopped {
return Err(Error::Invalid("Stop the server before restoring a database.".into())); return Err(Error::Invalid("Stop the server before restoring a database.".into()));
} }
let live = db::schema_of(name)?; let live = if name.contains('-') { db::schema_of(name)? } else { point.realm.schema(name)? };
let expected_tables = comp.tables.unwrap_or(0); let expected_tables = comp.tables.unwrap_or(0);
let dump = point_dir(meta, id)?.join(&comp.path); let dump = point_dir(meta, id)?.join(&comp.path);
let stamp = chrono::Utc::now().format("%Y%m%d%H%M%S").to_string(); let stamp = chrono::Utc::now().format("%Y%m%d%H%M%S").to_string();
@@ -331,6 +350,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
let safety = create(root, meta, Kind::Database, Trigger::BeforeRestore, Some(format!("before restoring {name} from {id}")), &|_| {})?; let safety = create(root, meta, Kind::Database, Trigger::BeforeRestore, Some(format!("before restoring {name} from {id}")), &|_| {})?;
with_database(root, |db| { with_database(root, |db| {
let db = db.clone().for_realm(crate::realms::Mode::Coa);
let staging = format!("{live}_restore_{stamp}"); let staging = format!("{live}_restore_{stamp}");
let old = format!("{live}_before_restore_{stamp}"); let old = format!("{live}_before_restore_{stamp}");
if db.schema_exists(&staging)? || db.schema_exists(&old)? { if db.schema_exists(&staging)? || db.schema_exists(&old)? {
+58 -4
View File
@@ -86,9 +86,41 @@ pub fn restore_quiet_logging(settings: &Path) -> Result<()> {
fs::remove_file(&original)?; fs::remove_file(&original)?;
} }
} }
let world = settings.join("worldserver.conf.template");
if world.is_file() {
let bytes = fs::read(&world)?;
let patched = quiet_world_logging(&String::from_utf8_lossy(&bytes));
if patched.as_bytes() != bytes.as_slice() {
fs::write(&world, patched)?;
}
}
Ok(()) Ok(())
} }
/// The network logger at debug level writes a line for every packet the world sends (hundreds of thousands per hour
/// with creatures fighting); keep it to errors. CoA's own logger defaults to errors only unless `Logger.coa` exists.
pub fn quiet_world_logging(text: &str) -> String {
let nl = if text.contains("\r\n") { "\r\n" } else { "\n" };
let mut out: Vec<String> = Vec::new();
let has_coa = text.lines().any(|l| l.trim_start().starts_with("Logger.coa="));
for line in text.lines() {
let l = line.trim();
if l.starts_with("Logger.network=") {
out.push("Logger.network=2,Server".to_string());
} else {
out.push(line.to_string());
}
if l.starts_with("Logger.root=") && !has_coa {
out.push("Logger.coa=4,Console Server".to_string());
}
}
let mut s = out.join(nl);
if text.ends_with('\n') {
s.push_str(nl);
}
s
}
pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> { pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
if p.out.exists() { if p.out.exists() {
return Err(Error::Invalid(format!("{} already exists; choose a new folder.", p.out.display()))); return Err(Error::Invalid(format!("{} already exists; choose a new folder.", p.out.display())));
@@ -157,6 +189,9 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
fs::create_dir_all(dst.parent().unwrap())?; fs::create_dir_all(dst.parent().unwrap())?;
fs::copy(&f.abs, dst)?; fs::copy(&f.abs, dst)?;
} }
// The maintainer's database records `rev_20260906_03_any_race_class.sql` as applied although its 86 race/class starts
// are absent (the client patch offers those pairs, so creating such a character failed). The file is idempotent.
let any_race_class = sql.iter().find(|f| f.id.contains("any_race_class")).map(|f| f.abs.clone());
let base_chars: Vec<PathBuf> = { let base_chars: Vec<PathBuf> = {
let mut v: Vec<PathBuf> = fs::read_dir(p.core.join("data/sql/base/db_characters")) let mut v: Vec<PathBuf> = fs::read_dir(p.core.join("data/sql/base/db_characters"))
.map_err(|_| Error::Invalid("data/sql/base/db_characters was not found in the core checkout.".into()))? .map_err(|_| Error::Invalid("data/sql/base/db_characters was not found in the core checkout.".into()))?
@@ -200,11 +235,21 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
if both.trim() == "2" { if both.trim() == "2" {
db.query("INSERT IGNORE INTO acore_world.item_template_coa SELECT * FROM acore_world.item_template_ascension_compat; DROP TABLE acore_world.item_template_ascension_compat;")?; db.query("INSERT IGNORE INTO acore_world.item_template_coa SELECT * FROM acore_world.item_template_ascension_compat; DROP TABLE acore_world.item_template_ascension_compat;")?;
} }
// 3c. re-run the race/class starts when their effect is missing
if let Some(file) = &any_race_class {
if db.query("SELECT COUNT(*) FROM acore_world.playercreateinfo WHERE race=7 AND class=27;")?.trim() == "0" {
db.run_sql_file("acore_world", file)?;
}
}
// 3d. the companion template characters (the bot module copies every bot from one of them)
crate::companions::seed_fresh(db)?;
// 4. prove it is clean // 4. prove it is clean
let accounts = db.query("SELECT COUNT(*) FROM acore_auth.account;")?; let accounts = db.query("SELECT COUNT(*) FROM acore_auth.account;")?;
let chars = db.query("SELECT COUNT(*) FROM acore_characters.characters;")?; // nothing but the template characters may exist
if accounts != "0" || chars != "0" { let chars = db.query(&format!("SELECT COUNT(*) FROM acore_characters.characters WHERE account<>{};", crate::companions::TEMPLATE_ACCOUNT))?;
return Err(Error::Invalid(format!("The database is not clean ({accounts} accounts, {chars} characters)."))); let templates = crate::companions::template_count(db)?;
if accounts != "0" || chars != "0" || templates != 21 {
return Err(Error::Invalid(format!("The database is not clean ({accounts} accounts, {chars} player characters, {templates} templates).")));
} }
Ok(()) Ok(())
})?; })?;
@@ -255,11 +300,20 @@ mod tests {
fs::write(d.path().join("worldserver.conf.template.original"), "Logger.root=2,Console Server").unwrap(); fs::write(d.path().join("worldserver.conf.template.original"), "Logger.root=2,Console Server").unwrap();
fs::write(d.path().join("authserver.conf.template"), "unchanged").unwrap(); fs::write(d.path().join("authserver.conf.template"), "unchanged").unwrap();
restore_quiet_logging(d.path()).unwrap(); restore_quiet_logging(d.path()).unwrap();
assert_eq!(fs::read_to_string(d.path().join("worldserver.conf.template")).unwrap(), "Logger.root=2,Console Server"); let restored = fs::read_to_string(d.path().join("worldserver.conf.template")).unwrap();
assert!(restored.starts_with("Logger.root=2,Console Server") && !restored.contains("Logger.root=6"), "{restored}");
assert!(!d.path().join("worldserver.conf.template.original").exists()); assert!(!d.path().join("worldserver.conf.template.original").exists());
assert_eq!(fs::read_to_string(d.path().join("authserver.conf.template")).unwrap(), "unchanged"); assert_eq!(fs::read_to_string(d.path().join("authserver.conf.template")).unwrap(), "unchanged");
} }
#[test]
fn the_world_template_gets_a_quiet_network_logger_and_a_coa_logger() {
let input = "Logger.root=2,Console Server\r\nLogger.network=5,Server\r\nOther = 1\r\n";
let out = quiet_world_logging(input);
assert_eq!(out, "Logger.root=2,Console Server\r\nLogger.coa=4,Console Server\r\nLogger.network=2,Server\r\nOther = 1\r\n");
assert_eq!(quiet_world_logging(&out), out, "idempotent");
}
#[test] #[test]
fn refuses_to_overwrite_an_existing_output_folder() { fn refuses_to_overwrite_an_existing_output_folder() {
let d = tempfile::tempdir().unwrap(); let d = tempfile::tempdir().unwrap();
+173 -2
View File
@@ -1,6 +1,7 @@
//! The game client is a separate object: detected read-only, and touched only in two narrow ways - //! The game client is a separate object: detected read-only, with targeted updates to
//! `realmlist.wtf` (backed up first) and the `Interface/AddOns/CoABotUI` folder (backed up when it differs). //! `realmlist.wtf` (backed up first) and the `Interface/AddOns/CoABotUI` folder (backed up when it differs).
//! WTF, Cache, other addons and the executable are never modified. //! The selected realm in WTF/Config.wtf is synchronized while the client is closed.
//! Cache, other addons and the executable are never modified.
use std::collections::BTreeMap; use std::collections::BTreeMap;
use std::fs; use std::fs;
@@ -15,6 +16,67 @@ use crate::fsx;
pub const ADDON_NAME: &str = "CoABotUI"; pub const ADDON_NAME: &str = "CoABotUI";
const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"]; const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"];
pub fn is_running(client: &Path) -> bool {
EXECUTABLES.iter().any(|exe| {
let path = client.join(exe);
let path = dunce::canonicalize(&path).unwrap_or(path);
!crate::process::find_by_exe(&path).is_empty()
})
}
fn realm_config(old: &[u8], realm: &str) -> Vec<u8> {
let eol: &[u8] = if old.windows(2).any(|w| w == b"\r\n") { b"\r\n" } else { b"\n" };
let mut out = Vec::new();
let mut replaced = false;
for line in old.split_inclusive(|b| *b == b'\n') {
let body = line.strip_prefix(b"\xef\xbb\xbf").unwrap_or(line);
let mut words = body.split(|b| b.is_ascii_whitespace()).filter(|w| !w.is_empty());
let matches = words.next().is_some_and(|w| w.eq_ignore_ascii_case(b"SET"))
&& words.next().is_some_and(|w| w.eq_ignore_ascii_case(b"realmName"));
if matches {
if line.starts_with(b"\xef\xbb\xbf") { out.extend_from_slice(b"\xef\xbb\xbf"); }
out.extend_from_slice(format!("SET realmName \"{realm}\"").as_bytes());
if line.ends_with(b"\r\n") { out.extend_from_slice(b"\r\n"); }
else if line.ends_with(b"\n") { out.push(b'\n'); }
replaced = true;
} else {
out.extend_from_slice(line);
}
}
if !replaced {
if !out.is_empty() && !out.ends_with(b"\n") { out.extend_from_slice(eol); }
out.extend_from_slice(format!("SET realmName \"{realm}\"").as_bytes());
out.extend_from_slice(eol);
}
out
}
pub fn sync_realm(client: &Path, meta: &Path, mode: crate::realms::Mode) -> Result<bool> {
sync_realm_when_closed(client, meta, mode, is_running(client))
}
fn sync_realm_when_closed(client: &Path, meta: &Path, mode: crate::realms::Mode, running: bool) -> Result<bool> {
if running { return Ok(false); }
let file = client.join("WTF/Config.wtf");
let old = match fs::read(&file) {
Ok(bytes) => bytes,
Err(e) if e.kind() == std::io::ErrorKind::NotFound => Vec::new(),
Err(e) => return Err(e.into()),
};
let realm = match mode {
crate::realms::Mode::Coa => "Conquest of Azeroth",
crate::realms::Mode::Wildcard => "Wildcard",
};
let new = realm_config(&old, realm);
if new == old { return Ok(true); }
if file.exists() {
let saved = backup_dir(meta).join(format!("config-realm-{}.wtf", uuid::Uuid::new_v4()));
fsx::atomic_write(&saved, &old)?;
}
fsx::atomic_write(&file, &new)?;
Ok(true)
}
#[derive(Debug, Clone, Serialize)] #[derive(Debug, Clone, Serialize)]
pub struct Realmlist { pub struct Realmlist {
pub path: String, pub path: String,
@@ -122,12 +184,40 @@ fn host_ok(h: &str) -> bool {
!h.is_empty() && h.len() <= 253 && h.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '-' | ':')) && !h.starts_with('-') !h.is_empty() && h.len() <= 253 && h.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '-' | ':')) && !h.starts_with('-')
} }
/// Locales a client has game data for (`Data/<locale>/locale-<locale>.MPQ`), e.g. `enUS`.
fn installed_locales(client: &Path) -> Vec<String> {
let mut v: Vec<String> = fs::read_dir(client.join("Data"))
.map(|rd| {
rd.flatten()
.filter(|e| e.path().is_dir())
.filter_map(|e| e.file_name().into_string().ok())
.filter(|n| n.len() == 4 && n[..2].bytes().all(|b| b.is_ascii_lowercase()) && n[2..].bytes().all(|b| b.is_ascii_uppercase()))
.filter(|n| client.join("Data").join(n).join(format!("locale-{n}.MPQ")).is_file())
.collect()
})
.unwrap_or_default();
v.sort();
v
}
/// Point every locale's realmlist at `host`. Each changed file is copied to the backup folder first. /// Point every locale's realmlist at `host`. Each changed file is copied to the backup folder first.
/// A freshly downloaded client has no realmlist yet; one is created for each installed locale.
pub fn set_realmlist(client: &Path, meta: &Path, host: &str) -> Result<Vec<String>> { pub fn set_realmlist(client: &Path, meta: &Path, host: &str) -> Result<Vec<String>> {
if !host_ok(host) { if !host_ok(host) {
return Err(Error::Invalid("That address is not valid.".into())); return Err(Error::Invalid("That address is not valid.".into()));
} }
let mut changed = Vec::new(); let mut changed = Vec::new();
if realmlist_files(client).is_empty() {
for loc in installed_locales(client) {
let file = client.join("Data").join(&loc).join("realmlist.wtf");
fsx::atomic_write(&file, format!("set realmlist {host}
").as_bytes())?;
changed.push(file.to_string_lossy().into_owned());
}
if !changed.is_empty() {
return Ok(changed);
}
}
let stamp = chrono::Utc::now().format("%Y%m%d-%H%M%S").to_string(); let stamp = chrono::Utc::now().format("%Y%m%d-%H%M%S").to_string();
for file in realmlist_files(client) { for file in realmlist_files(client) {
let old = fs::read(&file)?; let old = fs::read(&file)?;
@@ -161,6 +251,32 @@ pub fn set_realmlist(client: &Path, meta: &Path, host: &str) -> Result<Vec<Strin
Ok(changed) Ok(changed)
} }
/// Replace the text of every locale's realmlist with `content` (a named realmlist chosen by the player). Each changed file
/// is saved to the backup folder first; files that already hold the same lines are left alone. A client without one gets a
/// file for each installed locale. Returns the files that changed.
pub fn write_realmlist(client: &Path, meta: &Path, content: &str) -> Result<Vec<String>> {
let compact = |t: &str| t.lines().map(|l| l.trim().to_ascii_lowercase()).filter(|l| !l.is_empty()).collect::<Vec<_>>().join("\n");
let mut files = realmlist_files(client);
if files.is_empty() {
files = installed_locales(client).into_iter().map(|loc| client.join("Data").join(loc).join("realmlist.wtf")).collect();
}
let stamp = chrono::Utc::now().format("%Y%m%d-%H%M%S").to_string();
let mut changed = Vec::new();
for file in files {
let old = fs::read(&file).ok();
if let Some(old) = &old {
if compact(&String::from_utf8_lossy(old)) == compact(content) {
continue;
}
let locale = file.parent().and_then(|p| p.file_name()).map(|n| n.to_string_lossy().into_owned()).unwrap_or_default();
fsx::atomic_write(&backup_dir(meta).join(format!("realmlist-{locale}-{stamp}.wtf")), old)?;
}
fsx::atomic_write(&file, content.as_bytes())?;
changed.push(file.to_string_lossy().into_owned());
}
Ok(changed)
}
/// Copy the addon into the client. If a different version is there, that one folder is backed up first; /// Copy the addon into the client. If a different version is there, that one folder is backed up first;
/// files in it that the package does not contain are left alone. /// files in it that the package does not contain are left alone.
pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> { pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> {
@@ -199,6 +315,45 @@ pub fn launch(client: &Path) -> Result<u32> {
mod tests { mod tests {
use super::*; use super::*;
#[test]
fn realm_selection_preserves_other_settings_bytes_and_line_endings() {
let old = b"\xef\xbb\xbfSET realmName \"Wildcard\"\r\nSET accountName \"\xff\"\r\nset REALMNAME \"old\"\r\nSET realmList \"127.0.0.1\"";
let expected = b"\xef\xbb\xbfSET realmName \"Conquest of Azeroth\"\r\nSET accountName \"\xff\"\r\nSET realmName \"Conquest of Azeroth\"\r\nSET realmList \"127.0.0.1\"";
assert_eq!(realm_config(old, "Conquest of Azeroth"), expected);
assert_eq!(realm_config(b"SET sound 1", "Wildcard"), b"SET sound 1\nSET realmName \"Wildcard\"\n");
}
#[test]
fn realm_sync_backs_up_config_and_is_idempotent() {
let d = tempfile::tempdir().unwrap();
let c = fake_client(d.path());
let meta = d.path().join("meta");
let original = b"SET sound 1\r\nSET realmName \"Wildcard\"\r\n";
fs::write(c.join("WTF/Config.wtf"), original).unwrap();
assert!(sync_realm(&c, &meta, crate::realms::Mode::Coa).unwrap());
let backups: Vec<_> = fs::read_dir(backup_dir(&meta)).unwrap().flatten().collect();
assert_eq!(backups.len(), 1);
assert_eq!(fs::read(backups[0].path()).unwrap(), original);
assert!(sync_realm(&c, &meta, crate::realms::Mode::Coa).unwrap());
assert_eq!(fs::read_dir(backup_dir(&meta)).unwrap().count(), 1);
assert!(sync_realm(&c, &meta, crate::realms::Mode::Wildcard).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
}
#[test]
fn running_client_defers_realm_update_until_closed() {
let d = tempfile::tempdir().unwrap();
let c = fake_client(d.path());
let meta = d.path().join("meta");
let original = b"SET realmName \"Wildcard\"\n";
fs::write(c.join("WTF/Config.wtf"), original).unwrap();
assert!(!sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, true).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
assert!(!backup_dir(&meta).exists());
assert!(sync_realm_when_closed(&c, &meta, crate::realms::Mode::Coa, false).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), b"SET realmName \"Conquest of Azeroth\"\n");
}
fn fake_client(d: &Path) -> PathBuf { fn fake_client(d: &Path) -> PathBuf {
let c = d.join("wow"); let c = d.join("wow");
fs::create_dir_all(c.join("Data/enUS")).unwrap(); fs::create_dir_all(c.join("Data/enUS")).unwrap();
@@ -261,6 +416,22 @@ mod tests {
assert!(set_realmlist(&c, &meta, "bad host; rm -rf").is_err()); assert!(set_realmlist(&c, &meta, "bad host; rm -rf").is_err());
} }
#[test]
fn a_fresh_client_gets_a_realmlist_for_each_installed_locale() {
let d = tempfile::tempdir().unwrap();
let c = d.path().join("fresh");
fs::create_dir_all(c.join("Data/enUS")).unwrap();
fs::create_dir_all(c.join("Data/Content")).unwrap();
fs::write(c.join("Data/enUS/locale-enUS.MPQ"), b"x").unwrap();
fs::write(c.join("Ascension.exe"), b"exe").unwrap();
let changed = set_realmlist(&c, &d.path().join("meta"), "127.0.0.1").unwrap();
assert_eq!(changed.len(), 1);
assert_eq!(fs::read_to_string(c.join("Data/enUS/realmlist.wtf")).unwrap(), "set realmlist 127.0.0.1
");
assert!(!c.join("Data/Content/realmlist.wtf").exists());
assert_eq!(detect(&c, None).unwrap().realmlists[0].host.as_deref(), Some("127.0.0.1"));
}
#[test] #[test]
fn addon_install_touches_only_its_own_folder_and_backs_up_a_different_version() { fn addon_install_touches_only_its_own_folder_and_backs_up_a_different_version() {
let d = tempfile::tempdir().unwrap(); let d = tempfile::tempdir().unwrap();
+630
View File
@@ -0,0 +1,630 @@
//! Download and update of the game client from the community launcher's public manifest.
//!
//! The manifest lists every file with its size and SHA-256; each file is fetched by hash and verified before it is
//! moved into place (`download::fetch_with`, resumable). The Manager keeps a small state file inside the client
//! folder (`.coa-manager/client-state.json`) so that later checks are cheap and so that files the player changed
//! are recognised: they are never overwritten without being asked, and a replaced file is moved aside, not deleted.
//! WTF, Cache, other addons, logs and `realmlist.wtf` are not part of what the Manager synchronises.
use std::collections::{BTreeMap, HashMap};
use std::fs::{self, File};
use std::io::Read;
use std::path::{Path, PathBuf};
use std::time::{Instant, UNIX_EPOCH};
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use crate::download::{self, Cancel, HttpTransport, Job, Transport};
use crate::error::{Error, Result};
use crate::fsx;
pub const MANIFEST_URL: &str = "https://launcher-api.coa-development.org/downloads/client/latest.json";
pub const OBJECTS_URL: &str = "https://launcher-api.coa-development.org/downloads/client/objects";
const STATE_DIR: &str = ".coa-manager";
const MAX_MANIFEST_BYTES: u64 = 16 * 1024 * 1024;
const MAX_FILE_BYTES: u64 = 16 * 1024 * 1024 * 1024;
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ManifestFile {
pub path: String,
pub size: u64,
pub sha256: String,
}
#[derive(Debug, Clone, Serialize)]
pub struct Manifest {
pub version: String,
pub published_at: Option<String>,
pub files: Vec<ManifestFile>,
}
impl Manifest {
pub fn total_bytes(&self) -> u64 {
self.files.iter().map(|f| f.size).sum()
}
}
#[derive(Deserialize)]
struct RawManifest {
schema: u32,
version: String,
#[serde(rename = "publishedAt")]
published_at: Option<String>,
files: Vec<ManifestFile>,
}
/// Things the Manager never writes, even if a manifest lists them: logs, the realmlist, the player's own settings,
/// caches and the companion addon (those have their own safe paths).
fn is_excluded(path: &str) -> bool {
let p = path.replace('\\', "/").to_ascii_lowercase();
p.ends_with(".log")
|| p.rsplit('/').next() == Some("realmlist.wtf")
|| p.starts_with("wtf/")
|| p.starts_with("cache/")
|| p.starts_with("errors/")
|| p.starts_with("logs/")
|| p.starts_with(".coa-manager/")
|| p.starts_with("interface/addons/coabotui/")
}
/// Files players customise: graphics wrappers and their configuration. If one exists and differs from the published
/// file it is left exactly as it is, whatever the "keep my files" choice; it is only created when missing.
fn is_player_owned(path: &str) -> bool {
let name = path.rsplit('/').next().unwrap_or(path).to_ascii_lowercase();
matches!(name.as_str(), "d3d8.dll" | "d3d9.dll" | "d3d10core.dll" | "d3d11.dll" | "dxgi.dll" | "dxvk.conf")
|| matches!(name.rsplit('.').next(), Some("ini" | "conf" | "cfg" | "wtf"))
}
pub fn parse_manifest(text: &str) -> Result<Manifest> {
let raw: RawManifest = serde_json::from_str(text).map_err(|e| Error::Invalid(format!("The client list could not be read: {e}")))?;
if raw.schema != 1 {
return Err(Error::Invalid(format!("The client list uses a newer format ({}); update the Manager.", raw.schema)));
}
if raw.version.trim().is_empty() || raw.version.len() > 64 {
return Err(Error::Invalid("The client list has no version.".into()));
}
let root = Path::new("client-root");
let mut files = Vec::with_capacity(raw.files.len());
for f in raw.files {
fsx::safe_join(root, &f.path)?;
let hash_ok = f.sha256.len() == 64 && f.sha256.bytes().all(|b| b.is_ascii_hexdigit());
if !hash_ok || f.size > MAX_FILE_BYTES {
return Err(Error::Invalid(format!("The client list has a bad entry for {}.", f.path)));
}
if is_excluded(&f.path) {
continue;
}
files.push(ManifestFile { path: f.path.replace('\\', "/"), size: f.size, sha256: f.sha256.to_ascii_lowercase() });
}
if files.is_empty() {
return Err(Error::Invalid("The client list is empty.".into()));
}
Ok(Manifest { version: raw.version, published_at: raw.published_at, files })
}
pub fn fetch_manifest(transport: &dyn Transport, url: &str) -> Result<Manifest> {
let mut reply = transport.get(url, 0).map_err(|e| Error::Invalid(format!("Could not reach the client download server: {e}")))?;
if reply.status != 200 {
return Err(Error::Invalid(format!("The client download server answered {}.", reply.status)));
}
let mut text = String::new();
reply.body.by_ref().take(MAX_MANIFEST_BYTES).read_to_string(&mut text).map_err(|e| Error::Invalid(format!("Could not read the client list: {e}")))?;
parse_manifest(&text)
}
pub fn fetch_latest() -> Result<Manifest> {
download::check_url(MANIFEST_URL)?;
fetch_manifest(&HttpTransport::with_total_timeout(30)?, MANIFEST_URL)
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Entry {
pub size: u64,
pub mtime: u64,
pub sha256: String,
/// The player chose to keep this file although the manifest has a different one (this is the manifest hash
/// they were asked about; a newer manifest asks again).
#[serde(default)]
pub kept_against: Option<String>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct State {
/// The manifest version this folder was brought to; None while a download is unfinished.
pub version: Option<String>,
pub files: BTreeMap<String, Entry>,
}
fn state_path(client: &Path) -> PathBuf {
client.join(STATE_DIR).join("client-state.json")
}
pub fn load_state(client: &Path) -> Option<State> {
fsx::read_json(&state_path(client)).ok()
}
fn save_state(client: &Path, state: &State) -> Result<()> {
fsx::atomic_write_json(&state_path(client), state)
}
#[derive(Debug, Clone, Serialize)]
pub struct Local {
/// The Manager downloaded or adopted this folder (a state file exists).
pub managed: bool,
pub version: Option<String>,
}
pub fn local(client: &Path) -> Local {
let s = load_state(client);
Local { managed: s.is_some(), version: s.and_then(|s| s.version) }
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Kind {
/// Not in the folder.
Missing,
/// Still as the Manager left it; the manifest has a newer file.
Changed,
/// Different from the manifest and not as the Manager left it (changed by the player or by something else).
Modified,
}
#[derive(Debug, Clone, Serialize)]
pub struct Item {
pub path: String,
pub size: u64,
pub kind: Kind,
#[serde(skip)]
sha256: String,
}
#[derive(Debug, Clone, Serialize)]
pub struct Plan {
pub version: String,
pub items: Vec<Item>,
pub download_bytes: u64,
pub total_files: usize,
pub up_to_date_files: usize,
pub kept_files: usize,
#[serde(skip)]
confirmed: BTreeMap<String, Entry>,
}
impl Plan {
pub fn modified(&self) -> Vec<&Item> {
self.items.iter().filter(|i| i.kind == Kind::Modified).collect()
}
}
#[derive(Debug, Clone, Serialize)]
pub struct Step {
/// "scan" while comparing files, "download" while fetching, "finish" at the end.
pub phase: &'static str,
pub done: u64,
pub total: u64,
pub bytes_per_sec: u64,
pub file: Option<String>,
}
fn cancelled() -> Error {
Error::Invalid("Download cancelled.".into())
}
fn mtime_secs(m: &fs::Metadata) -> u64 {
m.modified().ok().and_then(|t| t.duration_since(UNIX_EPOCH).ok()).map(|d| d.as_secs()).unwrap_or(0)
}
fn hash_file(path: &Path, cancel: &Cancel, on_bytes: &mut dyn FnMut(u64)) -> Result<String> {
let mut f = File::open(path)?;
let mut hasher = Sha256::new();
let mut buf = vec![0u8; 1 << 20];
loop {
if cancel.is_set() {
return Err(cancelled());
}
let n = f.read(&mut buf)?;
if n == 0 {
return Ok(hex::encode(hasher.finalize()));
}
hasher.update(&buf[..n]);
on_bytes(n as u64);
}
}
/// Compare the folder with the manifest. Files are hashed only when their size or modification time no longer
/// matches what the state file recorded, so a routine check of a managed folder is quick.
pub fn plan(client: &Path, m: &Manifest, state: &State, cancel: &Cancel, on_step: &dyn Fn(Step)) -> Result<Plan> {
let total = m.total_bytes();
let mut done = 0u64;
let mut items = Vec::new();
let mut confirmed = BTreeMap::new();
let (mut up_to_date, mut kept) = (0usize, 0usize);
for f in &m.files {
if cancel.is_set() {
return Err(cancelled());
}
on_step(Step { phase: "scan", done, total, bytes_per_sec: 0, file: Some(f.path.clone()) });
let path = fsx::safe_join(client, &f.path)?;
let meta = match fs::metadata(&path) {
Ok(meta) if meta.is_file() => meta,
_ => {
items.push(Item { path: f.path.clone(), size: f.size, kind: Kind::Missing, sha256: f.sha256.clone() });
done += f.size;
continue;
}
};
let (size, mtime) = (meta.len(), mtime_secs(&meta));
let entry = state.files.get(&f.path);
let trusted = entry.filter(|e| e.size == size && e.mtime == mtime);
let local: Option<String> = if let Some(e) = trusted {
Some(e.sha256.clone())
} else if size == f.size || entry.map(|e| e.size == size).unwrap_or(false) {
let base = done;
let mut seen = 0u64;
let h = hash_file(&path, cancel, &mut |n| {
seen += n;
on_step(Step { phase: "scan", done: base + seen.min(f.size), total, bytes_per_sec: 0, file: Some(f.path.clone()) });
})?;
Some(h)
} else {
None
};
done += f.size;
if is_player_owned(&f.path) && local.as_deref() != Some(f.sha256.as_str()) {
let sha = match local {
Some(h) => h,
None => hash_file(&path, cancel, &mut |_| {})?,
};
kept += 1;
confirmed.insert(f.path.clone(), Entry { size, mtime, sha256: sha, kept_against: Some(f.sha256.clone()) });
continue;
}
if local.as_deref() == Some(f.sha256.as_str()) {
up_to_date += 1;
confirmed.insert(f.path.clone(), Entry { size, mtime, sha256: f.sha256.clone(), kept_against: None });
continue;
}
let as_left = entry.filter(|e| local.as_deref() == Some(e.sha256.as_str()));
match as_left {
Some(e) if e.kept_against.as_deref() == Some(f.sha256.as_str()) => {
kept += 1;
confirmed.insert(f.path.clone(), Entry { size, mtime, sha256: e.sha256.clone(), kept_against: e.kept_against.clone() });
}
Some(e) if e.kept_against.is_none() => {
items.push(Item { path: f.path.clone(), size: f.size, kind: Kind::Changed, sha256: f.sha256.clone() });
}
_ => items.push(Item { path: f.path.clone(), size: f.size, kind: Kind::Modified, sha256: f.sha256.clone() }),
}
}
on_step(Step { phase: "scan", done: total, total, bytes_per_sec: 0, file: None });
let download_bytes = items.iter().map(|i| i.size).sum();
Ok(Plan { version: m.version.clone(), items, download_bytes, total_files: m.files.len(), up_to_date_files: up_to_date, kept_files: kept, confirmed })
}
pub struct Apply<'a> {
pub client: &'a Path,
pub manifest: &'a Manifest,
pub plan: &'a Plan,
/// Leave files the player changed alone (they are remembered, and asked about again only when the manifest changes).
pub keep_modified: bool,
pub transport: &'a dyn Transport,
pub objects_url: &'a str,
pub cancel: &'a Cancel,
}
fn blocked(path: &str, e: std::io::Error) -> Error {
Error::Invalid(format!("Could not replace {path}: {e}. Close the game and anything else using the client, then try again."))
}
/// Download what the plan lists. Progress is saved after every file, so an interrupted run resumes where it stopped.
pub fn apply(a: &Apply, on_step: &dyn Fn(Step)) -> Result<()> {
let mut state = State { version: None, files: a.plan.confirmed.clone() };
save_state(a.client, &state)?;
let mut todo = Vec::new();
for item in &a.plan.items {
if item.kind == Kind::Modified && a.keep_modified {
let path = fsx::safe_join(a.client, &item.path)?;
let meta = fs::metadata(&path)?;
let sha = hash_file(&path, a.cancel, &mut |_| {})?;
state.files.insert(item.path.clone(), Entry { size: meta.len(), mtime: mtime_secs(&meta), sha256: sha, kept_against: Some(item.sha256.clone()) });
} else {
todo.push(item);
}
}
let total: u64 = todo.iter().map(|i| i.size).sum();
fsx::require_space(a.client, total)?;
let staging = a.client.join(STATE_DIR).join("staging");
let replaced = a.client.join(STATE_DIR).join("replaced").join(chrono::Utc::now().format("%Y%m%d-%H%M%S").to_string());
let mut done = 0u64;
let mut placed: HashMap<&str, PathBuf> = HashMap::new();
for item in todo {
if a.cancel.is_set() {
save_state(a.client, &state)?;
return Err(cancelled());
}
let target = fsx::safe_join(a.client, &item.path)?;
let started = Instant::now();
let staged = staging.join(&item.sha256);
let copy_from = placed.get(item.sha256.as_str()).cloned();
if copy_from.is_none() {
let job = Job { url: format!("{}/{}", a.objects_url, item.sha256), dest: staged.clone(), sha256: item.sha256.clone(), size: item.size };
let base = done;
let result = download::fetch_with(a.transport, &job, a.cancel, &|p| {
on_step(Step { phase: "download", done: base + p.downloaded, total, bytes_per_sec: p.bytes_per_sec, file: Some(item.path.clone()) });
});
if let Err(e) = result {
let _ = save_state(a.client, &state);
return Err(e);
}
}
if let Some(parent) = target.parent() {
fs::create_dir_all(parent)?;
}
if target.exists() {
if item.kind == Kind::Modified {
let keep = fsx::safe_join(&replaced, &item.path)?;
if let Some(parent) = keep.parent() {
fs::create_dir_all(parent)?;
}
fs::rename(&target, &keep).map_err(|e| blocked(&item.path, e))?;
} else {
fs::remove_file(&target).map_err(|e| blocked(&item.path, e))?;
}
}
match copy_from {
Some(src) => {
fs::copy(&src, &target).map_err(|e| blocked(&item.path, e))?;
}
None => fs::rename(&staged, &target).map_err(|e| blocked(&item.path, e))?,
}
placed.insert(&item.sha256, target.clone());
let meta = fs::metadata(&target)?;
state.files.insert(item.path.clone(), Entry { size: meta.len(), mtime: mtime_secs(&meta), sha256: item.sha256.clone(), kept_against: None });
save_state(a.client, &state)?;
done += item.size;
let secs = started.elapsed().as_secs_f64().max(0.001);
on_step(Step { phase: "download", done, total, bytes_per_sec: (item.size as f64 / secs) as u64, file: Some(item.path.clone()) });
}
state.version = Some(a.manifest.version.clone());
save_state(a.client, &state)?;
let _ = fs::remove_dir_all(&staging);
on_step(Step { phase: "finish", done: total, total, bytes_per_sec: 0, file: None });
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::download::Reply;
use std::io::Cursor;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Mutex;
/// Serves objects by hash; remembers what was requested and can fail after N objects.
struct Server {
objects: Mutex<HashMap<String, Vec<u8>>>,
requested: Mutex<Vec<String>>,
cancel_after: Option<(AtomicUsize, Cancel)>,
}
impl Server {
fn new(files: &[(&str, &[u8])]) -> Self {
let s = Server { objects: Default::default(), requested: Default::default(), cancel_after: None };
for (_, body) in files {
s.objects.lock().unwrap().insert(fsx::sha256_bytes(body), body.to_vec());
}
s
}
}
impl Transport for Server {
fn get(&self, url: &str, from: u64) -> std::result::Result<Reply, String> {
let sha = url.rsplit('/').next().unwrap().to_string();
self.requested.lock().unwrap().push(sha.clone());
if let Some((left, cancel)) = &self.cancel_after {
if left.fetch_sub(1, Ordering::SeqCst) == 1 {
cancel.cancel();
}
}
let body = self.objects.lock().unwrap().get(&sha).cloned().ok_or("404")?;
let (status, start) = if from > 0 { (206, from as usize) } else { (200, 0) };
let cr = (from > 0).then(|| format!("bytes {from}-{}/{}", body.len() - 1, body.len()));
Ok(Reply { status, content_range: cr, body: Box::new(Cursor::new(body[start..].to_vec())) })
}
}
fn manifest(version: &str, files: &[(&str, &[u8])]) -> Manifest {
Manifest {
version: version.into(),
published_at: None,
files: files.iter().map(|(p, b)| ManifestFile { path: p.to_string(), size: b.len() as u64, sha256: fsx::sha256_bytes(b) }).collect(),
}
}
const V1: [(&str, &[u8]); 4] = [("Wow.exe", b"exe-1"), ("Data/common.MPQ", b"common-mpq-data"), ("Data/patch-A.MPQ", b"patch-a-1"), ("Data/enUS/locale.MPQ", b"locale")];
fn sync(dir: &Path, m: &Manifest, server: &Server, keep: bool) -> Result<Plan> {
let state = load_state(dir).unwrap_or_default();
let cancel = Cancel::default();
let p = plan(dir, m, &state, &cancel, &|_| {})?;
apply(&Apply { client: dir, manifest: m, plan: &p, keep_modified: keep, transport: server, objects_url: "https://x.invalid/objects", cancel: &cancel }, &|_| {})?;
Ok(p)
}
#[test]
fn manifest_rejects_traversal_and_bad_entries_and_skips_personal_files() {
let ok = r#"{"schema":1,"version":"v1","files":[
{"path":"Wow.exe","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"Data/enUS/realmlist.wtf","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"WTF/Config.wtf","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"Interface/AddOns/CoABotUI/x.lua","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"MemoryBridge.log","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]}"#;
let m = parse_manifest(ok).unwrap();
assert_eq!(m.files.iter().map(|f| f.path.as_str()).collect::<Vec<_>>(), ["Wow.exe"]);
for bad in [
r#"{"schema":1,"version":"v","files":[{"path":"../evil.dll","size":1,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]}"#,
r#"{"schema":1,"version":"v","files":[{"path":"C:/evil.dll","size":1,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]}"#,
r#"{"schema":1,"version":"v","files":[{"path":"a.dll","size":1,"sha256":"short"}]}"#,
r#"{"schema":2,"version":"v","files":[]}"#,
r#"{"schema":1,"version":"v","files":[]}"#,
] {
assert!(parse_manifest(bad).is_err(), "{bad}");
}
}
#[test]
fn fresh_download_installs_every_file_verified_and_leaves_nothing_behind() {
let d = tempfile::tempdir().unwrap();
let (m, s) = (manifest("v1", &V1), Server::new(&V1));
let p = sync(d.path(), &m, &s, false).unwrap();
assert_eq!(p.items.len(), 4);
for (path, body) in V1 {
assert_eq!(fs::read(d.path().join(path)).unwrap(), body);
}
let st = load_state(d.path()).unwrap();
assert_eq!(st.version.as_deref(), Some("v1"));
assert_eq!(st.files.len(), 4);
assert!(!d.path().join(".coa-manager/staging").exists());
assert!(local(d.path()).managed);
}
#[test]
fn an_update_downloads_only_what_changed_and_a_second_check_is_empty() {
let d = tempfile::tempdir().unwrap();
sync(d.path(), &manifest("v1", &V1), &Server::new(&V1), false).unwrap();
let mut v2 = V1.to_vec();
v2[2] = ("Data/patch-A.MPQ", b"patch-a-2-longer");
v2.push(("Data/new.MPQ", b"brand new"));
let (m2, s2) = (manifest("v2", &v2), Server::new(&v2));
let p = sync(d.path(), &m2, &s2, false).unwrap();
let kinds: Vec<_> = p.items.iter().map(|i| (i.path.as_str(), i.kind)).collect();
assert_eq!(kinds, [("Data/patch-A.MPQ", Kind::Changed), ("Data/new.MPQ", Kind::Missing)]);
assert_eq!(s2.requested.lock().unwrap().len(), 2, "unchanged files were not downloaded again");
assert_eq!(fs::read(d.path().join("Data/patch-A.MPQ")).unwrap(), b"patch-a-2-longer");
assert!(!d.path().join(".coa-manager/replaced").exists(), "a file the Manager itself wrote needs no backup");
let again = sync(d.path(), &m2, &s2, false).unwrap();
assert!(again.items.is_empty() && again.up_to_date_files == 5);
assert_eq!(load_state(d.path()).unwrap().version.as_deref(), Some("v2"));
}
#[test]
fn a_file_the_player_changed_is_asked_about_kept_when_told_to_and_saved_when_replaced() {
let d = tempfile::tempdir().unwrap();
sync(d.path(), &manifest("v1", &V1), &Server::new(&V1), false).unwrap();
fs::write(d.path().join("Wow.exe"), b"my patched exe").unwrap();
let mut v2 = V1.to_vec();
v2[0] = ("Wow.exe", b"exe-2");
let (m2, s2) = (manifest("v2", &v2), Server::new(&v2));
let p = sync(d.path(), &m2, &s2, true).unwrap();
assert_eq!(p.modified().len(), 1);
assert_eq!(fs::read(d.path().join("Wow.exe")).unwrap(), b"my patched exe", "kept");
assert!(s2.requested.lock().unwrap().is_empty(), "nothing needed downloading");
let quiet = sync(d.path(), &m2, &s2, true).unwrap();
assert!(quiet.items.is_empty() && quiet.kept_files == 1, "the decision is remembered");
let mut v3 = V1.to_vec();
v3[0] = ("Wow.exe", b"exe-3");
let (m3, s3) = (manifest("v3", &v3), Server::new(&v3));
let again = sync(d.path(), &m3, &s3, false).unwrap();
assert_eq!(again.modified().len(), 1, "a newer client asks again");
assert_eq!(fs::read(d.path().join("Wow.exe")).unwrap(), b"exe-3");
let saved = fs::read_dir(d.path().join(".coa-manager/replaced")).unwrap().next().unwrap().unwrap().path();
assert_eq!(fs::read(saved.join("Wow.exe")).unwrap(), b"my patched exe", "the player's version was moved aside, not lost");
}
#[test]
fn renderer_files_configs_and_everything_not_in_the_manifest_survive_an_update_untouched() {
let d = tempfile::tempdir().unwrap();
let v1: Vec<(&str, &[u8])> = vec![("Wow.exe", b"exe-1"), ("d3d9.dll", b"official d3d9"), ("dxvk.conf", b"official conf"), ("Data/common.MPQ", b"common-1")];
sync(d.path(), &manifest("v1", &v1), &Server::new(&v1), false).unwrap();
// the player's own setup: custom renderer + configs, addons, WTF, realmlist, extra archives, backups
let mine: Vec<(&str, &[u8])> = vec![
("d3d9.dll", b"my renderer"),
("dxvk.conf", b"my conf"),
("ModernWoWRenderer.ini", b"cfg"),
("GraphicsEffects.ini.bak", b"bak"),
("Data/enUS/realmlist.wtf", b"set realmlist 127.0.0.1
"),
("Data/patch-5.MPQ", b"extra archive"),
("Interface/AddOns/ElvUI/ElvUI.toc", b"## Title: Elv"),
("WTF/Account/x/SavedVariables.lua", b"vars"),
("Cache/x.wdb", b"cache"),
];
for (p, b) in &mine {
let path = d.path().join(p);
fs::create_dir_all(path.parent().unwrap()).unwrap();
fs::write(path, b).unwrap();
}
let before: BTreeMap<String, String> = mine.iter().map(|(p, b)| (p.to_string(), fsx::sha256_bytes(b))).collect();
let v2: Vec<(&str, &[u8])> = vec![("Wow.exe", b"exe-2"), ("d3d9.dll", b"official d3d9 v2"), ("dxvk.conf", b"official conf v2"), ("Data/common.MPQ", b"common-2")];
let (m2, s2) = (manifest("v2", &v2), Server::new(&v2));
for keep in [false, true] {
sync(d.path(), &m2, &s2, keep).unwrap();
for (p, h) in &before {
assert_eq!(&fsx::sha256_file(&d.path().join(p)).unwrap(), h, "{p} must not change (keep_modified={keep})");
}
assert_eq!(fs::read(d.path().join("Wow.exe")).unwrap(), b"exe-2");
assert_eq!(fs::read(d.path().join("Data/common.MPQ")).unwrap(), b"common-2");
}
assert!(!d.path().join(".coa-manager/replaced").exists(), "nothing of the player's was displaced");
}
#[test]
fn an_existing_client_without_state_is_compared_by_content() {
let d = tempfile::tempdir().unwrap();
for (p, b) in V1 {
let path = d.path().join(p);
fs::create_dir_all(path.parent().unwrap()).unwrap();
fs::write(path, b).unwrap();
}
fs::write(d.path().join("Data/patch-A.MPQ"), b"patch-a-X").unwrap(); // same size, different content
fs::remove_file(d.path().join("Data/enUS/locale.MPQ")).unwrap();
fs::create_dir_all(d.path().join("WTF")).unwrap();
fs::write(d.path().join("WTF/Config.wtf"), b"mine").unwrap();
let m = manifest("v1", &V1);
let p = plan(d.path(), &m, &State::default(), &Cancel::default(), &|_| {}).unwrap();
let kinds: Vec<_> = p.items.iter().map(|i| (i.path.as_str(), i.kind)).collect();
assert_eq!(kinds, [("Data/patch-A.MPQ", Kind::Modified), ("Data/enUS/locale.MPQ", Kind::Missing)]);
assert_eq!(p.up_to_date_files, 2);
assert_eq!(fs::read(d.path().join("WTF/Config.wtf")).unwrap(), b"mine");
}
#[test]
fn cancel_keeps_finished_files_and_the_next_run_only_fetches_the_rest() {
let d = tempfile::tempdir().unwrap();
let m = manifest("v1", &V1);
let mut s = Server::new(&V1);
let cancel = Cancel::default();
s.cancel_after = Some((AtomicUsize::new(3), cancel.clone()));
let state = State::default();
let p = plan(d.path(), &m, &state, &cancel, &|_| {}).unwrap();
let r = apply(&Apply { client: d.path(), manifest: &m, plan: &p, keep_modified: false, transport: &s, objects_url: "https://x.invalid/o", cancel: &cancel }, &|_| {});
assert!(r.is_err());
let st = load_state(d.path()).unwrap();
assert!(st.version.is_none() && !st.files.is_empty() && st.files.len() < 4, "unfinished but remembered: {}", st.files.len());
assert!(local(d.path()).managed && local(d.path()).version.is_none());
let s2 = Server::new(&V1);
sync(d.path(), &m, &s2, false).unwrap();
assert_eq!(s2.requested.lock().unwrap().len(), 4 - st.files.len(), "only the missing files were requested");
assert_eq!(load_state(d.path()).unwrap().version.as_deref(), Some("v1"));
}
#[test]
fn a_wrong_object_never_reaches_the_client_folder() {
let d = tempfile::tempdir().unwrap();
let m = manifest("v1", &V1);
let s = Server::new(&V1);
// the server returns different bytes under the right hash
let sha = fsx::sha256_bytes(b"exe-1");
s.objects.lock().unwrap().insert(sha, b"EVIL!".to_vec());
assert!(sync(d.path(), &m, &s, false).is_err());
assert!(!d.path().join("Wow.exe").exists());
assert!(load_state(d.path()).unwrap().version.is_none());
}
}
+118
View File
@@ -0,0 +1,118 @@
//! Companion (bot) support data. The bot module creates each bot by copying a level 80 "template" character of the
//! same class, so a server with no such characters can not create any bot. A freshly installed server ships with a
//! small set (one per CoA class); older or imported servers can have it added on request.
use std::fs;
use std::path::Path;
use crate::db::Db;
use crate::error::Result;
/// Owner of the template characters. Not account 1 (the bot module skips it) and not a bot-host account; no such
/// account exists in the login database, so nobody can ever log in to these characters.
pub const TEMPLATE_ACCOUNT: u32 = 900_000;
const SQL: &str = include_str!("../data/companion-templates.sql");
/// The seed script with its two variables set: `base_guid` is added to every character guid.
pub fn seed_sql(base_guid: &str) -> String {
format!("SET @G = {base_guid}; SET @ACC = {TEMPLATE_ACCOUNT};\n{SQL}")
}
/// Number of characters the bot module could use as templates (level 80, a CoA class, not account 1).
pub fn template_count(db: &Db) -> Result<u32> {
let n = db.query("SELECT COUNT(*) FROM acore_characters.characters WHERE account<>1 AND level>=80 AND class BETWEEN 12 AND 32;")?;
Ok(n.trim().parse().unwrap_or(0))
}
fn run_seed(db: &Db, base_guid: &str) -> Result<()> {
let file = std::env::temp_dir().join(format!("coa-companion-templates-{}.sql", std::process::id()));
fs::write(&file, seed_sql(base_guid))?;
let r = db.run_sql_file("acore_characters", &file);
let _ = fs::remove_file(&file);
r
}
/// Fresh databases (release tooling): the original guids.
pub fn seed_fresh(db: &Db) -> Result<()> {
run_seed(db, "0")
}
/// An existing server without templates: add them far above the highest guid in use, so a running world can never
/// hand a new character one of their guids. Returns whether anything was added.
pub fn ensure_templates(db: &Db) -> Result<bool> {
if template_count(db)? > 0 {
return Ok(false);
}
run_seed(db, "(SELECT IFNULL(MAX(guid),0) FROM acore_characters.characters) + 100000")?;
Ok(true)
}
/// The bot module's offline factory ships with the server package; it creates fully equipped bots straight in the
/// database while the world server is stopped (fast and safe for large batches).
pub const OFFLINE_FACTORY: &str = "Extras/CoABotTools/offline_bot_factory.py";
/// Batches at least this large are created offline when the server happens to be stopped.
pub const OFFLINE_MIN: u32 = 100;
pub fn offline_factory(root: &Path) -> Option<std::path::PathBuf> {
let p = root.join(OFFLINE_FACTORY);
(p.is_file() && root.join("Runtime/python/python.exe").is_file() && root.join("mysql/bin/mysql.exe").is_file() && root.join("mysql/admin-client.ini").is_file()).then_some(p)
}
/// Run the offline factory for `count` leveled bots. The database must be running and the world/auth servers stopped.
/// Returns the tail of its report. Credentials are passed as a file path only, never on the command line.
pub fn offline_create(root: &Path, log: &Path, count: u32) -> Result<String> {
use std::process::{Command, Stdio};
let script = offline_factory(root).ok_or_else(|| crate::error::Error::Invalid("The offline bot factory is not part of this server.".into()))?;
if let Some(dir) = log.parent() {
fs::create_dir_all(dir)?;
}
let out = fs::File::create(log)?;
let err = out.try_clone()?;
let mut child = Command::new(root.join("Runtime/python/python.exe"))
.arg(&script)
.args(["--count", &count.to_string(), "--leveled", "--mysql-exe"])
.arg(root.join("mysql/bin/mysql.exe"))
.arg("--defaults-file")
.arg(root.join("mysql/admin-client.ini"))
.current_dir(root)
.stdin(Stdio::null())
.stdout(Stdio::from(out))
.stderr(Stdio::from(err))
.spawn()?;
let started = std::time::Instant::now();
let status = loop {
if let Some(s) = child.try_wait()? {
break s;
}
if started.elapsed() > std::time::Duration::from_secs(45 * 60) {
let _ = child.kill();
return Err(crate::error::Error::Invalid("Creating the companions took too long and was stopped.".into()));
}
std::thread::sleep(std::time::Duration::from_millis(500));
};
let text = fs::read_to_string(log).unwrap_or_default();
let tail: Vec<&str> = text.lines().rev().take(6).collect::<Vec<_>>().into_iter().rev().collect();
if status.success() {
Ok(tail.join("\n"))
} else {
Err(crate::error::Error::Invalid(format!("The bot factory reported an error: {}", tail.join(" | "))))
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn the_seed_has_one_template_per_class_and_uses_only_variables_for_ids() {
let s = seed_sql("0");
assert!(s.starts_with("SET @G = 0; SET @ACC = 900000;"));
let chars = s.matches("INSERT IGNORE INTO `characters`").count();
assert_eq!(chars, 21);
assert_eq!(s.matches("VALUES (@G+").count(), s.matches("INSERT IGNORE").count(), "every row takes its guid from @G");
assert!(s.contains("@ACC"));
assert!(!s.contains("INSERT INTO "), "rows that exist are kept");
}
}
+201 -13
View File
@@ -67,7 +67,12 @@ pub fn targets(root: &Path, scope: Scope) -> Result<Targets> {
Scope::Bots => { Scope::Bots => {
let conf = root.join("Core/configs/modules/mod_coa_playerbots.conf"); let conf = root.join("Core/configs/modules/mod_coa_playerbots.conf");
if !conf.is_file() { if !conf.is_file() {
return Err(Error::Invalid("CoA Companions (bots) are not installed on this server.".into())); // The server ships the documented defaults as `.dist` and uses them until an active file exists: make it.
let dist = root.join("Core/configs/modules/mod_coa_playerbots.conf.dist");
if !dist.is_file() {
return Err(Error::Invalid("CoA Companions (bots) are not installed on this server.".into()));
}
fsx::atomic_write(&conf, &fs::read(&dist)?)?;
} }
Ok(Targets { read: conf.clone(), writes: vec![conf], generated: None }) Ok(Targets { read: conf.clone(), writes: vec![conf], generated: None })
} }
@@ -122,8 +127,21 @@ pub struct SettingsView {
/// Modules read `Core/configs/modules/<name>.conf`, but packages ship only the documented `<name>.conf.dist` (the active /// Modules read `Core/configs/modules/<name>.conf`, but packages ship only the documented `<name>.conf.dist` (the active
/// files are the server owner's). Create every missing active file from its `.dist`, so a fresh server runs with the /// files are the server owner's). Create every missing active file from its `.dist`, so a fresh server runs with the
/// documented defaults (for example `CoA.Enable = 1`, without which the Ascension client is dropped after login). /// documented defaults (for example `CoA.Enable = 1`, without which the Ascension client is dropped after login).
/// Existing files are never touched. Files the launcher writes itself are skipped. Returns the created file names. /// An existing file only receives keys its `.dist` gained since (added with their documentation, values never changed),
/// so a server updated to a build with a new setting gets that setting's documented default. Files the launcher writes
/// itself are skipped. Returns what was created (`name.conf`) or extended (`name.conf (+n keys)`).
pub fn materialize_module_configs(root: &Path) -> Result<Vec<String>> { pub fn materialize_module_configs(root: &Path) -> Result<Vec<String>> {
materialize(root, true)
}
/// Only the missing active files, created from their `.dist`; a file that exists is not touched at all. This is what a
/// server the Manager imported (not installed) gets: without its file a module logs a "missing property" line for every
/// setting it reads, and some modules read them on every world tick.
pub fn create_missing_module_configs(root: &Path) -> Result<Vec<String>> {
materialize(root, false)
}
fn materialize(root: &Path, extend_existing: bool) -> Result<Vec<String>> {
let dir = root.join("Core").join("configs").join("modules"); let dir = root.join("Core").join("configs").join("modules");
let mut created = Vec::new(); let mut created = Vec::new();
let Ok(entries) = fs::read_dir(&dir) else { return Ok(created) }; let Ok(entries) = fs::read_dir(&dir) else { return Ok(created) };
@@ -136,7 +154,28 @@ pub fn materialize_module_configs(root: &Path) -> Result<Vec<String>> {
let active = dir.join(format!("{stem}.conf")); let active = dir.join(format!("{stem}.conf"));
if !active.exists() { if !active.exists() {
fs::copy(e.path(), &active)?; fs::copy(e.path(), &active)?;
if stem == "coa" {
// This product serves the CoA client only, and the servers listen on this computer unless the owner
// shares them; without this key the server drops CoA clients that connect from another address
// (friends over a private network) right after login.
if let Ok(bytes) = fs::read(&active) {
if let Ok(mut conf) = parser::ConfFile::parse_bytes(&bytes) {
conf.set("CoA.AllowRemoteClients", "1", &["Set by CoA Server Manager: this server is built for CoA clients"]);
fsx::atomic_write(&active, conf.to_text().as_bytes())?;
}
}
}
created.push(format!("{stem}.conf")); created.push(format!("{stem}.conf"));
} else if !extend_existing {
continue;
} else if let (Ok(have), Ok(dist)) = (fs::read(&active), fs::read(e.path())) {
if let (Ok(mut conf), Ok(dist)) = (parser::ConfFile::parse_bytes(&have), parser::ConfFile::parse_bytes(&dist)) {
let plan = merge::apply(&mut conf, &dist);
if !plan.added.is_empty() {
fsx::atomic_write(&active, conf.to_text().as_bytes())?;
created.push(format!("{stem}.conf (+{} keys)", plan.added.len()));
}
}
} }
} }
created.sort(); created.sort();
@@ -302,9 +341,23 @@ pub struct SnapshotInfo {
} }
pub(crate) fn take_snapshot(meta_dir: &Path, scope: Scope, reason: &str, files: &[(PathBuf, Vec<u8>)]) -> Result<String> { pub(crate) fn take_snapshot(meta_dir: &Path, scope: Scope, reason: &str, files: &[(PathBuf, Vec<u8>)]) -> Result<String> {
let id = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S%3f"), scope.name()); let root = snapshot_root(meta_dir);
let dir = snapshot_root(meta_dir).join(&id); fs::create_dir_all(&root)?;
fs::create_dir_all(&dir)?; // The id is a timestamp to the millisecond. Two snapshots of the same scope can land in the same one (a restore
// snapshots the current state just before reading the snapshot it restores), and reusing the folder would overwrite
// the files about to be restored. Take a fresh folder, with a numeric suffix when the name is already used.
let base = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S%3f"), scope.name());
let (id, dir) = (1u32..)
.map(|n| if n == 1 { base.clone() } else { format!("{base}-{n}") })
.find_map(|id| {
let dir = root.join(&id);
match fs::create_dir(&dir) {
Ok(()) => Some(Ok((id, dir))),
Err(e) if e.kind() == std::io::ErrorKind::AlreadyExists => None,
Err(e) => Some(Err(e)),
}
})
.expect("the suffix range is unbounded")?;
let mut entries = Vec::new(); let mut entries = Vec::new();
for (i, (path, bytes)) in files.iter().enumerate() { for (i, (path, bytes)) in files.iter().enumerate() {
let stored = format!("{i}_{}", path.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default()); let stored = format!("{i}_{}", path.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default());
@@ -334,8 +387,70 @@ pub fn list_snapshots(meta_dir: &Path) -> Vec<SnapshotInfo> {
out out
} }
/// How many threads the world should use to update maps on this computer: half the logical processors, between 2 and 8.
/// Maps (continents, dungeons, battlegrounds) are updated in parallel, one thread per map, so more threads than the
/// number of maps in use bring nothing.
pub fn recommended_map_threads() -> u32 {
let cores = std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(4);
(cores / 2).clamp(2, 8)
}
const PERFORMANCE_MARKER: &str = "performance-defaults-v1.done";
/// Once per server: switch the world to updating maps on several threads (`MapUpdate.Threads`), which the stock
/// configuration leaves at 1. A value the owner already raised is respected, and because this runs a single time
/// (a marker file in the Manager's folder for the server) a later choice to go back to 1 is never overridden.
/// Returns the new thread count when something was written.
pub fn ensure_performance_defaults(root: &Path, meta_dir: &Path) -> Result<Option<u32>> {
let marker = meta_dir.join(PERFORMANCE_MARKER);
if marker.exists() {
return Ok(None);
}
let view = load(root, Scope::Server)?;
let current = view.settings.iter().find(|s| s.meta.key == "MapUpdate.Threads");
let already = current.map(|s| s.present && s.value.as_i64().unwrap_or(1) > 1).unwrap_or(false);
let threads = recommended_map_threads();
let written = if already {
None
} else {
let changes = BTreeMap::from([("MapUpdate.Threads".to_string(), Value::from(threads))]);
save(root, meta_dir, Scope::Server, &changes)?;
Some(threads)
};
let quieted = quiet_debug_loggers(root)?;
fsx::atomic_write(&marker, b"MapUpdate.Threads and logging levels set by the Manager\n")?;
tracing::info!(?written, ?quieted, "performance defaults applied");
Ok(written)
}
/// Loggers some configurations leave at debug level: `network` writes a line for every packet sent and
/// `entities.player` one for every item check. With companions that is thousands of lines a second, each a disk write.
/// They are put back to info level (the next level up); anything else in the file is untouched.
fn quiet_debug_loggers(root: &Path) -> Result<Vec<String>> {
let mut changed = Vec::new();
for path in targets(root, Scope::Server)?.writes {
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
let mut touched = false;
for key in ["Logger.network", "Logger.entities.player"] {
let Some(value) = conf.get(key).map(|v| v.trim().to_string()) else { continue };
if let Some(rest) = value.strip_prefix("5,") {
conf.set(key, &format!("4,{rest}"), &["Lowered from debug by CoA Server Manager: it wrote a line for every packet and item check"]);
touched = true;
if !changed.contains(&key.to_string()) {
changed.push(key.to_string());
}
}
}
if touched {
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
}
}
Ok(changed)
}
/// Apply validated `changes`. Nothing is written unless every change is valid; previous contents are snapshotted first. /// Apply validated `changes`. Nothing is written unless every change is valid; previous contents are snapshotted first.
pub fn save(root: &Path, meta_dir: &Path, scope: Scope, changes: &BTreeMap<String, Value>) -> Result<SaveReport> { pub fn save(root: &Path, meta_dir: &Path, scope: Scope, changes: &BTreeMap<String, Value>) -> Result<SaveReport> {
if scope == Scope::Bots { crate::realms::guard_module(root, "companions")?; }
let raws = validate(root, scope, changes)?; let raws = validate(root, scope, changes)?;
let schema = scope.schema(); let schema = scope.schema();
let t = targets(root, scope)?; let t = targets(root, scope)?;
@@ -487,6 +602,38 @@ mod tests {
pairs.iter().map(|(k, v)| (k.to_string(), v.clone())).collect() pairs.iter().map(|(k, v)| (k.to_string(), v.clone())).collect()
} }
#[test]
fn the_world_gets_several_map_threads_once_and_an_owner_choice_is_never_overridden() {
let (_d, root, meta) = fixture();
let wanted = recommended_map_threads();
assert!((2..=8).contains(&wanted));
for p in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
let mut t = fs::read_to_string(root.join(p)).unwrap();
t.push_str("Logger.network=5,Server\r\nLogger.entities.player=5,Server\r\nLogger.module=4,Console Server\r\n");
fs::write(root.join(p), t).unwrap();
}
assert_eq!(ensure_performance_defaults(&root, &meta).unwrap(), Some(wanted));
for p in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
let t = fs::read_to_string(root.join(p)).unwrap();
assert!(t.contains(&format!("MapUpdate.Threads = {wanted}")), "{p}: {t}");
assert!(t.contains("Unknown.Custom = \"keep me\""), "other settings untouched");
assert!(t.contains("Logger.network=4,Server") && t.contains("Logger.entities.player=4,Server"), "{p}: {t}");
assert!(t.contains("Logger.module=4,Console Server"), "info level loggers are left alone");
}
// the owner goes back to one thread: it stays that way
save(&root, &meta, Scope::Server, &set(&[("MapUpdate.Threads", json!(1))])).unwrap();
assert_eq!(ensure_performance_defaults(&root, &meta).unwrap(), None);
assert!(fs::read_to_string(root.join("Core/configs/worldserver.conf")).unwrap().contains("MapUpdate.Threads = 1"));
}
#[test]
fn an_already_raised_value_is_respected_on_the_first_run() {
let (_d, root, meta) = fixture();
save(&root, &meta, Scope::Server, &set(&[("MapUpdate.Threads", json!(6))])).unwrap();
assert_eq!(ensure_performance_defaults(&root, &meta).unwrap(), None);
assert!(fs::read_to_string(root.join("Core/configs/worldserver.conf")).unwrap().contains("MapUpdate.Threads = 6"));
}
#[test] #[test]
fn missing_module_configs_are_created_from_their_dist_and_existing_ones_are_kept() { fn missing_module_configs_are_created_from_their_dist_and_existing_ones_are_kept() {
let (_d, root, _m) = fixture(); let (_d, root, _m) = fixture();
@@ -495,20 +642,40 @@ mod tests {
fs::write(m.join("coa.conf.dist"), "CoA.Enable = 1 fs::write(m.join("coa.conf.dist"), "CoA.Enable = 1
").unwrap(); ").unwrap();
fs::write(m.join("spellbook.conf.dist"), "Spellbook.Enable = 1 fs::write(m.join("spellbook.conf.dist"), "Spellbook.Enable = 1
Spellbook.New = 5
").unwrap(); ").unwrap();
fs::write(m.join("spellbook.conf"), "Spellbook.Enable = 0 fs::write(m.join("spellbook.conf"), "Spellbook.Enable = 0
").unwrap(); ").unwrap();
fs::write(m.join("coa_bugreport.conf.dist"), "x = 1 fs::write(m.join("coa_bugreport.conf.dist"), "x = 1
").unwrap(); ").unwrap();
assert_eq!(materialize_module_configs(&root).unwrap(), vec!["coa.conf".to_string()]); assert_eq!(materialize_module_configs(&root).unwrap(), vec!["coa.conf".to_string(), "spellbook.conf (+1 keys)".to_string()]);
assert_eq!(fs::read_to_string(m.join("coa.conf")).unwrap(), "CoA.Enable = 1 let coa = fs::read_to_string(m.join("coa.conf")).unwrap();
"); assert!(coa.contains("CoA.Enable = 1") && coa.contains("CoA.AllowRemoteClients = 1"), "{coa}");
assert_eq!(fs::read_to_string(m.join("spellbook.conf")).unwrap(), "Spellbook.Enable = 0 let sb = fs::read_to_string(m.join("spellbook.conf")).unwrap();
"); assert!(sb.contains("Spellbook.Enable = 0"), "existing values are never changed: {sb}");
assert!(sb.contains("Spellbook.New = 5"), "new documented key was added: {sb}");
assert!(!m.join("coa_bugreport.conf").exists()); assert!(!m.join("coa_bugreport.conf").exists());
assert!(materialize_module_configs(&root).unwrap().is_empty()); assert!(materialize_module_configs(&root).unwrap().is_empty());
} }
#[test]
fn an_imported_server_only_gets_the_files_it_lacks() {
let (_d, root, _m) = fixture();
let m = root.join("Core/configs/modules");
fs::create_dir_all(&m).unwrap();
fs::write(m.join("dynamicxp.conf.dist"), "Dynamic.XP.Reminder.Interval = 40
").unwrap();
fs::write(m.join("spellbook.conf.dist"), "Spellbook.Enable = 1
Spellbook.New = 5
").unwrap();
fs::write(m.join("spellbook.conf"), "Spellbook.Enable = 0
").unwrap();
assert_eq!(create_missing_module_configs(&root).unwrap(), vec!["dynamicxp.conf".to_string()]);
assert!(fs::read_to_string(m.join("dynamicxp.conf")).unwrap().contains("Dynamic.XP.Reminder.Interval = 40"));
assert_eq!(fs::read_to_string(m.join("spellbook.conf")).unwrap(), "Spellbook.Enable = 0
", "an existing file stays byte for byte");
}
#[test] #[test]
fn schemas_and_presets_are_self_consistent() { fn schemas_and_presets_are_self_consistent() {
for scope in [Scope::Bots, Scope::Server] { for scope in [Scope::Bots, Scope::Server] {
@@ -595,6 +762,21 @@ mod tests {
assert!(restore_snapshot(&meta, "../evil").is_err()); assert!(restore_snapshot(&meta, "../evil").is_err());
} }
#[test]
fn snapshots_taken_in_the_same_millisecond_keep_their_own_files() {
let dir = tempfile::tempdir().unwrap();
let mut ids = std::collections::HashSet::new();
for i in 0..40 {
let path = dir.path().join("worldserver.conf");
let id = take_snapshot(dir.path(), Scope::Server, "test", &[(path, format!("version {i}").into_bytes())]).unwrap();
assert!(ids.insert(id.clone()), "snapshot id {id} was handed out twice");
}
for info in list_snapshots(dir.path()) {
assert_eq!(info.files.len(), 1);
}
assert_eq!(list_snapshots(dir.path()).len(), 40.min(KEEP_SNAPSHOTS));
}
#[test] #[test]
fn a_repeated_key_with_the_same_effective_value_is_not_drift() { fn a_repeated_key_with_the_same_effective_value_is_not_drift() {
let (_d, root, _m) = fixture(); let (_d, root, _m) = fixture();
@@ -637,9 +819,15 @@ Logger.x=6,Console Server
} }
#[test] #[test]
fn bots_scope_requires_the_module_config() { fn bots_scope_requires_the_module_config_or_its_default_file() {
let (_d, root, _m) = fixture(); let (_d, root, _m) = fixture();
fs::remove_file(root.join("Core/configs/modules/mod_coa_playerbots.conf")).unwrap(); let modules = root.join("Core/configs/modules");
assert!(load(&root, Scope::Bots).is_err()); let conf = modules.join("mod_coa_playerbots.conf");
let text = fs::read(&conf).unwrap();
fs::remove_file(&conf).unwrap();
assert!(load(&root, Scope::Bots).is_err(), "neither file: not installed");
fs::write(modules.join("mod_coa_playerbots.conf.dist"), &text).unwrap();
assert!(load(&root, Scope::Bots).is_ok(), "only the default file: it is made");
assert!(conf.is_file());
} }
} }
+103 -2
View File
@@ -44,6 +44,7 @@ pub struct Db {
port: u16, port: u16,
user: &'static str, user: &'static str,
password: Secret, password: Secret,
realm: crate::realms::Mode,
} }
#[derive(Deserialize)] #[derive(Deserialize)]
@@ -67,6 +68,8 @@ fn no_window(cmd: &mut Command) {
pub const SCHEMAS: [(&str, &str); 3] = [("characters", "acore_characters"), ("auth", "acore_auth"), ("world", "acore_world")]; pub const SCHEMAS: [(&str, &str); 3] = [("characters", "acore_characters"), ("auth", "acore_auth"), ("world", "acore_world")];
pub fn schema_of(kind: &str) -> Result<&'static str> { pub fn schema_of(kind: &str) -> Result<&'static str> {
if let Some(kind) = kind.strip_prefix("wildcard-") { return crate::realms::Mode::Wildcard.schema(kind); }
if let Some(kind) = kind.strip_prefix("coa-") { return crate::realms::Mode::Coa.schema(kind); }
SCHEMAS.iter().find(|(k, _)| *k == kind).map(|(_, s)| *s).ok_or_else(|| Error::Invalid(format!("unknown database {kind}"))) SCHEMAS.iter().find(|(k, _)| *k == kind).map(|(_, s)| *s).ok_or_else(|| Error::Invalid(format!("unknown database {kind}")))
} }
@@ -74,6 +77,13 @@ fn ident_ok(name: &str) -> bool {
!name.is_empty() && name.len() <= 64 && name.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') !name.is_empty() && name.len() <= 64 && name.chars().all(|c| c.is_ascii_alphanumeric() || c == '_')
} }
/// (root password, application password) from `Settings/database.json`.
pub(crate) fn credentials(root: &Path) -> Result<(String, String)> {
let c: Credentials = fsx::read_json(&root.join("Settings/database.json"))
.map_err(|_| Error::Invalid("The database settings of this server could not be read.".into()))?;
Ok((c.root_password, c.app_password))
}
impl Db { impl Db {
pub fn from_repack(root: &Path, account: Account) -> Result<Db> { pub fn from_repack(root: &Path, account: Account) -> Result<Db> {
let creds: Credentials = fsx::read_json(&root.join("Settings/database.json")) let creds: Credentials = fsx::read_json(&root.join("Settings/database.json"))
@@ -87,7 +97,38 @@ impl Db {
Account::Admin => ("root", creds.root_password), Account::Admin => ("root", creds.root_password),
Account::App => ("acore", creds.app_password), Account::App => ("acore", creds.app_password),
}; };
Ok(Db { bin, port: ports.mysql, user, password: Secret(password) }) Ok(Db { bin, port: ports.mysql, user, password: Secret(password), realm: crate::realms::state(root)?.active })
}
pub fn for_realm(mut self, realm: crate::realms::Mode) -> Self { self.realm = realm; self }
pub fn realm_schema<'a>(&self, name: &'a str) -> &'a str {
if self.realm == crate::realms::Mode::Wildcard {
match name {
"acore_world" => "acore_world_wildcard",
"acore_characters" => "acore_characters_wildcard",
_ => name,
}
} else { name }
}
pub fn clone_structure(&self, source: &str, dest: &str, cache: &Path) -> Result<()> {
if !ident_ok(source) || !ident_ok(dest) { return Err(Error::Invalid("Invalid schema name.".into())); }
let path = cache.join("characters-structure.sql");
self.dump_structure_to(source, &path)?;
self.run_sql_file(dest, &path)?;
std::fs::remove_file(path)?;
Ok(())
}
pub fn dump_structure_to(&self, source: &str, path: &Path) -> Result<()> {
if !ident_ok(source) { return Err(Error::Invalid("Invalid schema name.".into())); }
let mut c = self.command("mysqldump.exe");
c.args(["--no-data", "--no-tablespaces", "--skip-comments", "--default-character-set=utf8mb4", source]);
c.stdout(Stdio::from(File::create(&path)?));
let out = c.output()?;
if !out.status.success() { return Err(self.fail(&out.stderr)); }
Ok(())
} }
fn command(&self, tool: &str) -> Command { fn command(&self, tool: &str) -> Command {
@@ -123,9 +164,10 @@ impl Db {
pub fn query(&self, sql: &str) -> Result<String> { pub fn query(&self, sql: &str) -> Result<String> {
let mut c = self.command("mysql.exe"); let mut c = self.command("mysql.exe");
c.args(["--batch", "--skip-column-names", "--connect-timeout=5"]); c.args(["--batch", "--skip-column-names", "--connect-timeout=5"]);
c.args(["--default-character-set=utf8mb4", "--max-allowed-packet=128M"]);
c.stdin(Stdio::piped()); c.stdin(Stdio::piped());
let mut child = c.spawn()?; let mut child = c.spawn()?;
child.stdin.take().expect("piped").write_all(sql.as_bytes())?; child.stdin.take().expect("piped").write_all(route_sql(sql, self.realm).as_bytes())?;
let out = child.wait_with_output()?; let out = child.wait_with_output()?;
if !out.status.success() { if !out.status.success() {
return Err(self.fail(&out.stderr)); return Err(self.fail(&out.stderr));
@@ -134,6 +176,7 @@ impl Db {
} }
pub fn schema_exists(&self, name: &str) -> Result<bool> { pub fn schema_exists(&self, name: &str) -> Result<bool> {
let name = self.realm_schema(name);
if !ident_ok(name) { if !ident_ok(name) {
return Err(Error::Invalid("bad schema name".into())); return Err(Error::Invalid("bad schema name".into()));
} }
@@ -141,6 +184,7 @@ impl Db {
} }
pub fn tables(&self, schema: &str) -> Result<Vec<String>> { pub fn tables(&self, schema: &str) -> Result<Vec<String>> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) { if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into())); return Err(Error::Invalid("bad schema name".into()));
} }
@@ -150,6 +194,7 @@ impl Db {
/// Bytes of data + index the schema occupies (used to estimate backup size). /// Bytes of data + index the schema occupies (used to estimate backup size).
pub fn schema_bytes(&self, schema: &str) -> Result<u64> { pub fn schema_bytes(&self, schema: &str) -> Result<u64> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) { if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into())); return Err(Error::Invalid("bad schema name".into()));
} }
@@ -159,6 +204,7 @@ impl Db {
/// Stored routines / triggers / views make a table-level swap unsafe; count them. /// Stored routines / triggers / views make a table-level swap unsafe; count them.
pub fn extra_objects(&self, schema: &str) -> Result<u64> { pub fn extra_objects(&self, schema: &str) -> Result<u64> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) { if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into())); return Err(Error::Invalid("bad schema name".into()));
} }
@@ -170,6 +216,7 @@ impl Db {
/// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file). /// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file).
pub fn dump_to(&self, schema: &str, out: &Path) -> Result<(u64, String)> { pub fn dump_to(&self, schema: &str, out: &Path) -> Result<(u64, String)> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) { if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into())); return Err(Error::Invalid("bad schema name".into()));
} }
@@ -203,9 +250,15 @@ impl Db {
/// Run a plain SQL file against `schema`; the first error aborts and is returned. /// Run a plain SQL file against `schema`; the first error aborts and is returned.
pub fn run_sql_file(&self, schema: &str, file: &Path) -> Result<()> { pub fn run_sql_file(&self, schema: &str, file: &Path) -> Result<()> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) { if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into())); return Err(Error::Invalid("bad schema name".into()));
} }
if self.realm == crate::realms::Mode::Wildcard {
let sql = std::fs::read_to_string(file)?;
self.query(&format!("SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci; USE `{schema}`;\n{sql}"))?;
return Ok(());
}
let mut c = self.command("mysql.exe"); let mut c = self.command("mysql.exe");
c.args(["--default-character-set=utf8mb4", "--init-command=SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci", "--max-allowed-packet=128M"]); c.args(["--default-character-set=utf8mb4", "--init-command=SET NAMES utf8mb4 COLLATE utf8mb4_unicode_ci", "--max-allowed-packet=128M"]);
c.arg(schema); c.arg(schema);
@@ -219,6 +272,7 @@ impl Db {
/// Import a dump produced by `dump_to` into `schema` (which must already exist and be empty). /// Import a dump produced by `dump_to` into `schema` (which must already exist and be empty).
pub fn import_from(&self, schema: &str, dump: &Path) -> Result<()> { pub fn import_from(&self, schema: &str, dump: &Path) -> Result<()> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) { if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into())); return Err(Error::Invalid("bad schema name".into()));
} }
@@ -278,3 +332,50 @@ pub fn write_console_credentials(root: &Path, password: &str) -> Result<()> {
pub fn valid_identifier(name: &str) -> bool { pub fn valid_identifier(name: &str) -> bool {
ident_ok(name) ident_ok(name)
} }
// Route only SQL identifiers. User names, values, comments and longer identifiers remain untouched.
fn route_sql(sql: &str, realm: crate::realms::Mode) -> String {
if realm == crate::realms::Mode::Coa { return sql.into(); }
let bytes = sql.as_bytes();
let mut out = String::new();
let mut i = 0;
while i < bytes.len() {
let start = i;
if matches!(bytes[i], b'\'' | b'"') {
let quote = bytes[i]; i += 1;
while i < bytes.len() {
if bytes[i] == b'\\' { i = (i + 2).min(bytes.len()); }
else if bytes[i] == quote {
i += 1;
if i < bytes.len() && bytes[i] == quote { i += 1; } else { break; }
} else { i += 1; }
}
out.push_str(&sql[start..i]);
} else if bytes[i] == b'#' || sql[i..].starts_with("--") || sql[i..].starts_with("/*") {
if sql[i..].starts_with("/*") {
i = sql[i + 2..].find("*/").map(|p| i + p + 4).unwrap_or(bytes.len());
} else { i = sql[i..].find('\n').map(|p| i + p).unwrap_or(bytes.len()); }
out.push_str(&sql[start..i]);
} else if bytes[i].is_ascii_alphanumeric() || bytes[i] == b'_' {
while i < bytes.len() && (bytes[i].is_ascii_alphanumeric() || bytes[i] == b'_') { i += 1; }
out.push_str(match &sql[start..i] {
"acore_world" => "acore_world_wildcard",
"acore_characters" => "acore_characters_wildcard",
other => other,
});
} else {
let c = sql[i..].chars().next().unwrap(); out.push(c); i += c.len_utf8();
}
}
out
}
#[cfg(test)]
mod realm_tests {
use super::*;
#[test]
fn routes_schema_identifiers_without_rewriting_account_values() {
let sql = "SELECT * FROM `acore_characters`.characters WHERE name='acore_world' AND x=\"acore_characters\"; -- acore_world\nSELECT * FROM acore_world.items;";
assert_eq!(route_sql(sql, crate::realms::Mode::Wildcard), "SELECT * FROM `acore_characters_wildcard`.characters WHERE name='acore_world' AND x=\"acore_characters\"; -- acore_world\nSELECT * FROM acore_world_wildcard.items;");
}
}
+66 -2
View File
@@ -143,6 +143,31 @@ fn tail(path: &Path, max: u64) -> Vec<u8> {
b b
} }
/// Keep the first line of each repeated "Missing property X" warning and report how often it came.
pub fn squash_repeated_config_warnings(text: &str) -> String {
let mut counts: Vec<(String, usize)> = Vec::new();
let mut out: Vec<&str> = Vec::new();
for line in text.lines() {
let key = line.strip_prefix("> Config: Missing property ").and_then(|r| r.split_whitespace().next());
match key {
Some(k) => match counts.iter_mut().find(|(n, _)| n == k) {
Some((_, c)) => *c += 1,
None => {
counts.push((k.to_string(), 1));
out.push(line);
}
},
None => out.push(line),
}
}
let mut s = out.join("\n");
for (k, c) in counts.iter().filter(|(_, c)| *c > 1) {
s.push_str(&format!("
[Manager: \"Missing property {k}\" was logged {c} times in this excerpt]"));
}
s
}
/// Remove things that must never leave the machine from log text. /// Remove things that must never leave the machine from log text.
pub fn redact(text: &str) -> String { pub fn redact(text: &str) -> String {
let mut out = Vec::new(); let mut out = Vec::new();
@@ -177,9 +202,33 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
}); });
add("summary.json", serde_json::to_string_pretty(&summary)?.as_bytes())?; 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"))] { for (name, path) in [("manager.log", manager_log.to_path_buf()), ("manager-install.log", meta_dir.join("logs/manager.log")), ("Server.log.tail", root.join("Core/Logs/Server.log")), ("Errors.log.tail", root.join("Core/Logs/Errors.log")), ("Auth.log.tail", root.join("Core/Logs/Auth.log")), ("world-console.log.tail", root.join("Core/Logs/world-console.log")), ("mysql-error.log.tail", root.join("mysql/logs/mysql-error.log"))] {
let bytes = tail(&path, 512 * 1024); // 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);
if !bytes.is_empty() { if !bytes.is_empty() {
add(name, redact(&String::from_utf8_lossy(&bytes)).as_bytes())?; 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())?;
}
}
// 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();
for dir in ["Core/configs", "Core/configs/modules", "Core/Logs"] {
if let Ok(rd) = fs::read_dir(root.join(dir)) {
let mut names: Vec<String> = rd.flatten().filter(|e| e.path().is_file()).map(|e| format!("{dir}/{} ({} bytes)", e.file_name().to_string_lossy(), e.metadata().map(|m| m.len()).unwrap_or(0))).collect();
names.sort();
present.push_str(&names.join("\n"));
present.push('\n');
}
}
add("files.txt", present.as_bytes())?;
if let Ok(b) = fs::read(root.join("Core/configs/modules/coa.conf")) {
if let Ok(c) = ConfFile::parse_bytes(&b) {
let wanted = ["CoA.Enable", "CoA.AllowRemoteClients", "CoA.MapClass10ToWarrior"];
let lines: Vec<String> = c.entries().filter(|(k, _)| wanted.contains(k)).map(|(k, v)| format!("{k} = {v}")).collect();
add("coa.conf.txt", lines.join("\n").as_bytes())?;
} }
} }
// Which settings exist, never their values. // Which settings exist, never their values.
@@ -210,6 +259,21 @@ mod tests {
use super::*; use super::*;
use crate::registry::{InstallKind, InstallMeta}; use crate::registry::{InstallKind, InstallMeta};
#[test]
fn repeated_config_warnings_are_folded() {
let t = "start
> Config: Missing property A.B in config file x or module config, add y
> Config: Missing property A.B in config file x
real error
> Config: Missing property C.D in config file x
> Config: Missing property A.B in config file x";
let out = squash_repeated_config_warnings(t);
assert_eq!(out.matches("Missing property A.B in config file").count(), 1);
assert!(out.contains("real error") && out.contains("C.D"));
assert!(out.contains("\"Missing property A.B\" was logged 3 times"));
assert!(!out.contains("C.D\" was logged"));
}
#[test] #[test]
fn redaction_removes_lines_that_could_carry_secrets() { fn redaction_removes_lines_that_could_carry_secrets() {
let t = redact("normal line\nLoginDatabaseInfo = \"127.0.0.1;3307;acore;PASS;db\"\nRa.Password=abc\nother"); let t = redact("normal line\nLoginDatabaseInfo = \"127.0.0.1;3307;acore;PASS;db\"\nRa.Password=abc\nother");
@@ -0,0 +1,7 @@
# Runtime image of the CoA server. It holds only the shared libraries the server binaries need (checked with ldd on
# Ubuntu 26.04: libmysqlclient24, ICU 78, ncurses 6 and readline 8); the binaries themselves are mounted from the
# server folder, so an update replaces files and does not rebuild this image.
FROM ubuntu:26.04
RUN apt-get update \
&& apt-get install -y --no-install-recommends libmysqlclient24 libicu78 libncurses6 libreadline8t64 \
&& rm -rf /var/lib/apt/lists/*
+151
View File
@@ -0,0 +1,151 @@
//! The one place that runs the `docker` command line. Everything else talks to the `Docker` trait, so the logic can
//! be tested without Docker. Only the `docker` client is needed on the computer (no `docker compose`).
use std::io::{Read, Write};
use std::net::{SocketAddr, TcpStream};
use std::process::{Command, Stdio};
use std::time::{Duration, Instant};
use crate::error::{Error, Result};
#[derive(Debug, Clone, Default)]
pub struct Output {
/// None when the command timed out.
pub code: Option<i32>,
pub stdout: String,
pub stderr: String,
}
impl Output {
pub fn ok(&self) -> bool {
self.code == Some(0)
}
/// stdout and stderr, trimmed, for the technical details shown to the user.
pub fn text(&self) -> String {
format!("{}\n{}", self.stdout.trim(), self.stderr.trim()).trim().to_string()
}
}
/// What to run. `env` is where secrets go: a container option `-e NAME` (without a value) copies it from the
/// environment of the docker client, so a password never appears on a command line.
pub struct Call<'a> {
pub args: Vec<String>,
pub env: Vec<(String, String)>,
pub stdin: Option<&'a [u8]>,
pub timeout: Duration,
}
impl<'a> Call<'a> {
pub fn new(args: &[&str], timeout: Duration) -> Call<'a> {
Call { args: args.iter().map(|a| a.to_string()).collect(), env: Vec::new(), stdin: None, timeout }
}
}
pub trait Docker {
/// Err only when `docker` cannot be started at all (not installed).
fn run(&self, call: &Call) -> Result<Output>;
/// Is a server really listening on this address? Docker's own proxy accepts connections on a published port even
/// when nothing listens inside the container, and closes them at once; so a connection that stays open (or gets
/// data, as the world server's greeting) is the proof, a connect alone is not.
fn port_open(&self, addr: SocketAddr) -> bool {
let Ok(mut s) = TcpStream::connect_timeout(&addr, Duration::from_millis(400)) else { return false };
let _ = s.set_read_timeout(Some(Duration::from_millis(300)));
match s.read(&mut [0u8; 1]) {
Ok(0) => false,
Ok(_) => true,
Err(e) => matches!(e.kind(), std::io::ErrorKind::WouldBlock | std::io::ErrorKind::TimedOut),
}
}
fn pause(&self, d: Duration) {
std::thread::sleep(d);
}
}
pub struct SystemDocker;
impl Docker for SystemDocker {
fn run(&self, call: &Call) -> Result<Output> {
let mut cmd = Command::new("docker");
cmd.args(&call.args).envs(call.env.iter().map(|(k, v)| (k, v))).stdout(Stdio::piped()).stderr(Stdio::piped());
cmd.stdin(if call.stdin.is_some() { Stdio::piped() } else { Stdio::null() });
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
cmd.creation_flags(0x0800_0000); // CREATE_NO_WINDOW
}
let mut child = cmd.spawn().map_err(|e| Error::Invalid(format!("docker could not be started: {e}")))?;
if let (Some(data), Some(mut stdin)) = (call.stdin, child.stdin.take()) {
// Closing stdin at the end of this block tells docker the input is complete.
let _ = stdin.write_all(data);
}
let mut out = child.stdout.take().expect("piped");
let mut err = child.stderr.take().expect("piped");
let out_t = std::thread::spawn(move || {
let mut s = String::new();
let _ = out.read_to_string(&mut s);
s
});
let err_t = std::thread::spawn(move || {
let mut s = String::new();
let _ = err.read_to_string(&mut s);
s
});
let deadline = Instant::now() + call.timeout;
let code = loop {
if let Some(st) = child.try_wait()? {
break st.code();
}
if Instant::now() > deadline {
// Only the docker client is stopped; the containers it started keep running.
let _ = child.kill();
let _ = child.wait();
break None;
}
std::thread::sleep(Duration::from_millis(50));
};
Ok(Output { code, stdout: out_t.join().unwrap_or_default(), stderr: err_t.join().unwrap_or_default() })
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::net::TcpListener;
#[test]
fn a_published_port_with_nothing_behind_it_does_not_count_as_open() {
let sys = SystemDocker;
// Closed port.
let closed = TcpListener::bind("127.0.0.1:0").unwrap();
let closed_addr = closed.local_addr().unwrap();
drop(closed);
assert!(!sys.port_open(closed_addr));
// Like docker-proxy without a backend: accepts, then closes at once.
let proxy = TcpListener::bind("127.0.0.1:0").unwrap();
let proxy_addr = proxy.local_addr().unwrap();
let t = std::thread::spawn(move || drop(proxy.accept().unwrap()));
assert!(!sys.port_open(proxy_addr));
t.join().unwrap();
// A server that waits for the client (auth server) and one that greets first (world server).
let quiet = TcpListener::bind("127.0.0.1:0").unwrap();
let quiet_addr = quiet.local_addr().unwrap();
let t = std::thread::spawn(move || {
let (_s, _) = quiet.accept().unwrap();
std::thread::sleep(Duration::from_millis(700));
});
assert!(sys.port_open(quiet_addr));
t.join().unwrap();
let greeter = TcpListener::bind("127.0.0.1:0").unwrap();
let greeter_addr = greeter.local_addr().unwrap();
let t = std::thread::spawn(move || {
let (mut s, _) = greeter.accept().unwrap();
s.write_all(b"hello").unwrap();
std::thread::sleep(Duration::from_millis(400));
});
assert!(sys.port_open(greeter_addr));
t.join().unwrap();
}
}
+903
View File
@@ -0,0 +1,903 @@
//! Start, stop and observe the three containers of a Docker installation.
//!
//! Start order matters: the database must be healthy before the game servers, and the world server must be listening
//! before the auth server, because the auth server refuses to run while no realm is online.
use std::collections::HashMap;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use std::path::Path;
use std::time::Duration;
use serde_json::Value;
use super::cli::{Call, Docker, SystemDocker};
use super::{runtime_image, Config, Names, RUNTIME_DOCKERFILE};
use crate::driver::{DriverOutcome, Verb};
use crate::error::{ErrorCode, Result};
use crate::layout::{read_ports, Ports};
use crate::process::{Observed, ServiceState, ServiceStatus};
/// Where the server folder and the game data appear inside the containers.
const CORE: &str = "/srv/core";
const DATA: &str = "/srv/data";
/// Fixed ports inside the containers; the host side comes from `Settings/repack.json`.
const AUTH_PORT: u16 = 3724;
const WORLD_PORT: u16 = 8085;
const RA_PORT: u16 = 3443;
const QUICK: Duration = Duration::from_secs(20);
const POLL: Duration = Duration::from_secs(1);
const DB_WAIT: u32 = 120;
const WORLD_WAIT: u32 = 300;
const AUTH_WAIT: u32 = 60;
struct Failure {
code: ErrorCode,
output: String,
}
type Step<T> = std::result::Result<T, Failure>;
#[derive(Default)]
struct Log(Vec<String>);
impl Log {
fn say(&mut self, line: impl Into<String>) {
self.0.push(line.into());
}
}
fn fail<T>(code: ErrorCode, output: impl Into<String>) -> Step<T> {
Err(Failure { code, output: output.into() })
}
pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
run_with(&SystemDocker, root, verb)
}
pub fn run_with(d: &dyn Docker, root: &Path, verb: Verb) -> Result<DriverOutcome> {
let cfg = Config::load(root)?;
let mut log = Log::default();
let result = match verb {
Verb::StartAll => start(d, root, &cfg, true, &mut log),
Verb::StartMysql => start(d, root, &cfg, false, &mut log),
Verb::StopAll => stop(d, &cfg, &mut log),
};
Ok(match result {
Ok(()) => DriverOutcome { ok: true, exit_code: Some(0), code: None, human: None, output: log.0.join("\n") },
Err(f) => {
log.say(f.output);
DriverOutcome { ok: false, exit_code: None, code: Some(f.code), human: Some(f.code.human()), output: log.0.join("\n") }
}
})
}
// ---------------------------------------------------------------------------------------------------- docker calls
/// Run docker; only "docker cannot be started" is an error here, a non-zero exit is returned for the caller to judge.
fn docker(d: &dyn Docker, args: &[&str], timeout: Duration) -> Step<super::cli::Output> {
d.run(&Call::new(args, timeout)).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))
}
fn preflight(d: &dyn Docker, log: &mut Log) -> Step<()> {
let o = docker(d, &["version", "--format", "{{.Server.Version}}"], QUICK)?;
if !o.ok() {
// Typical causes: the service is stopped, or the user is not allowed to talk to it.
return fail(ErrorCode::DockerUnavailable, o.text());
}
log.say(format!("docker {}", o.stdout.trim()));
Ok(())
}
#[derive(Debug, Clone, PartialEq)]
pub(crate) struct Container {
pub status: String,
pub exit_code: i64,
pub oom_killed: bool,
pub pid: Option<u32>,
pub started_at: Option<String>,
/// "healthy", "unhealthy" or "starting" when the container has a health check.
pub health: Option<String>,
}
impl Container {
fn running(&self) -> bool {
self.status == "running"
}
}
/// State of the named containers that exist (the others are simply absent from the result).
fn inspect(d: &dyn Docker, names: &[&str]) -> Step<HashMap<String, Container>> {
let mut args = vec!["inspect"];
args.extend_from_slice(names);
let o = docker(d, &args, QUICK)?;
// docker prints what it found and complains about the rest with a non-zero exit code.
let found = parse_inspect(&o.stdout);
if !o.ok() && found.is_empty() && !o.stderr.contains("No such object") && !o.stderr.contains("no such object") {
return fail(ErrorCode::DockerUnavailable, o.text());
}
Ok(found)
}
pub(crate) fn parse_inspect(json: &str) -> HashMap<String, Container> {
let Ok(Value::Array(items)) = serde_json::from_str::<Value>(json) else { return HashMap::new() };
items
.iter()
.filter_map(|v| {
let name = v["Name"].as_str()?.trim_start_matches('/').to_string();
let s = &v["State"];
Some((
name,
Container {
status: s["Status"].as_str()?.to_string(),
exit_code: s["ExitCode"].as_i64().unwrap_or(0),
oom_killed: s["OOMKilled"].as_bool().unwrap_or(false),
pid: s["Pid"].as_u64().filter(|p| *p > 0).map(|p| p as u32),
started_at: s["StartedAt"].as_str().map(str::to_string),
health: s["Health"]["Status"].as_str().map(str::to_string),
},
))
})
.collect()
}
fn strip_ansi(s: &str) -> String {
let mut out = String::with_capacity(s.len());
let mut chars = s.chars().peekable();
while let Some(c) = chars.next() {
if c == '\u{1b}' && chars.peek() == Some(&'[') {
for n in chars.by_ref() {
if n.is_ascii_alphabetic() {
break;
}
}
} else {
out.push(c);
}
}
out
}
/// Last lines a container wrote, as the technical details of a failure, and the cause they point to.
fn why_stopped(d: &dyn Docker, name: &str) -> (ErrorCode, String) {
let text = d.run(&Call::new(&["logs", "--tail", "60", name], QUICK)).map(|o| strip_ansi(&o.text())).unwrap_or_default();
(crate::health::diagnose(&text).unwrap_or(ErrorCode::StartupFailed), format!("--- last lines of {name}\n{text}"))
}
// ------------------------------------------------------------------------------------------------------------ start
struct Secrets {
root: String,
app: String,
}
fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut Log) -> Step<()> {
preflight(d, log)?;
let n = cfg.names();
let secrets = crate::db::credentials(root).map(|(root, app)| Secrets { root, app }).or_else(|e| fail(ErrorCode::ServerFilesIncomplete, e.to_string()))?;
let ports = read_ports(root);
let state = inspect(d, &[&n.db, &n.world, &n.auth])?;
if !docker(d, &["network", "inspect", &n.network], QUICK)?.ok() {
let o = docker(d, &["network", "create", &n.network], QUICK)?;
if !o.ok() {
return fail(ErrorCode::StartupFailed, o.text());
}
log.say(format!("created network {}", n.network));
}
if !state.get(&n.db).is_some_and(Container::running) {
remove(d, &n.db);
let mut call = Call::new(&[], Duration::from_secs(120));
call.args = db_args(cfg, &n);
call.env = vec![("MYSQL_ROOT_PASSWORD".into(), secrets.root.clone())];
let o = d.run(&call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
if !o.ok() {
return fail(ErrorCode::StartupFailed, o.text());
}
log.say(format!("started {}", n.db));
}
wait_database(d, &n, log)?;
if !with_game {
return Ok(());
}
ensure_image(d, log)?;
std::fs::create_dir_all(root.join("Core/Logs")).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, output: e.to_string() })?;
let owner = owner_of(root);
let host = std::fs::canonicalize(root).unwrap_or_else(|_| root.to_path_buf());
let host = crate::fsx::canonicalize_lenient(&host).unwrap_or(host);
if !state.get(&n.world).is_some_and(Container::running) {
remove(d, &n.world);
let mut call = Call::new(&[], Duration::from_secs(60));
call.args = game_args(cfg, &n, GameKind::World, &host, ports.world, ports.ra, owner.as_deref());
call.env = database_env(&secrets, true);
run_container(d, &call, &n.world, log)?;
}
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
if !state.get(&n.auth).is_some_and(Container::running) {
remove(d, &n.auth);
let mut call = Call::new(&[], Duration::from_secs(60));
call.args = game_args(cfg, &n, GameKind::Auth, &host, ports.auth, 0, owner.as_deref());
call.env = database_env(&secrets, false);
run_container(d, &call, &n.auth, log)?;
}
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
Ok(())
}
fn remove(d: &dyn Docker, name: &str) {
// A stopped container of the same name is replaced, so its settings always match the files on disk.
let _ = d.run(&Call::new(&["rm", "-f", name], QUICK));
}
fn run_container(d: &dyn Docker, call: &Call, name: &str, log: &mut Log) -> Step<()> {
let o = d.run(call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
if !o.ok() {
let text = o.text();
let code = if text.contains("port is already allocated") || text.contains("address already in use") { ErrorCode::PortInUse } else { ErrorCode::StartupFailed };
return fail(code, text);
}
log.say(format!("started {name}"));
Ok(())
}
fn ensure_image(d: &dyn Docker, log: &mut Log) -> Step<()> {
let image = runtime_image();
if docker(d, &["image", "inspect", &image], QUICK)?.ok() {
return Ok(());
}
log.say(format!("building {image} (first start only)"));
let mut call = Call::new(&["build", "--tag", &image, "-"], Duration::from_secs(900));
call.stdin = Some(RUNTIME_DOCKERFILE.as_bytes());
let o = d.run(&call).or_else(|e| fail(ErrorCode::DockerUnavailable, e.to_string()))?;
if !o.ok() {
return fail(ErrorCode::StartupFailed, o.text());
}
Ok(())
}
fn wait_database(d: &dyn Docker, n: &Names, log: &mut Log) -> Step<()> {
for _ in 0..DB_WAIT {
let state = inspect(d, &[&n.db])?;
match state.get(&n.db) {
Some(c) if c.running() && c.health.as_deref() == Some("healthy") => {
log.say("database is ready");
return Ok(());
}
Some(c) if !c.running() => {
let (code, text) = why_stopped(d, &n.db);
return fail(if code == ErrorCode::StartupFailed { ErrorCode::DatabaseNotRunning } else { code }, text);
}
None => return fail(ErrorCode::DatabaseNotRunning, "the database container does not exist"),
_ => d.pause(POLL),
}
}
fail(ErrorCode::DatabaseNotRunning, "the database did not become ready in time")
}
/// Wait until the container accepts connections on its published port; give up when it stops or on timeout.
fn wait_listening(d: &dyn Docker, cfg: &Config, name: &str, port: u16, seconds: u32, log: &mut Log) -> Step<()> {
let addr = SocketAddr::new(connect_ip(cfg), port);
for _ in 0..seconds {
let state = inspect(d, &[name])?;
match state.get(name) {
Some(c) if c.running() => {
if d.port_open(addr) {
log.say(format!("{name} is listening on port {port}"));
return Ok(());
}
d.pause(POLL);
}
_ => {
let (code, text) = why_stopped(d, name);
return fail(code, text);
}
}
}
let (code, text) = why_stopped(d, name);
fail(code, format!("{name} was not listening on port {port} after {seconds} seconds\n{text}"))
}
/// Address to test a published port on from this computer.
fn connect_ip(cfg: &Config) -> IpAddr {
match cfg.bind_address.parse::<IpAddr>() {
Ok(ip) if !ip.is_unspecified() => ip,
_ => IpAddr::V4(Ipv4Addr::LOCALHOST),
}
}
// ------------------------------------------------------------------------------------------------- argument lists
fn db_args(cfg: &Config, n: &Names) -> Vec<String> {
let mut a: Vec<String> = ["run", "--detach", "--name"].iter().map(|s| s.to_string()).collect();
a.push(n.db.clone());
a.extend(["--network".into(), n.network.clone(), "--network-alias".into(), "db".into()]);
a.extend(["--label".into(), format!("coa.project={}", cfg.project)]);
a.extend(["--volume".into(), format!("{}:/var/lib/mysql", n.volume)]);
// The password comes from the environment of the docker client, not from this command line.
a.extend(["--env".into(), "MYSQL_ROOT_PASSWORD".into()]);
// "mysqladmin ping" succeeds as soon as the server answers, with or without a login.
a.extend(["--health-cmd".into(), "mysqladmin ping --silent".into()]);
a.extend(["--health-interval".into(), "5s".into(), "--health-timeout".into(), "5s".into(), "--health-retries".into(), "40".into()]);
a.extend(["--stop-timeout".into(), "60".into()]);
a.push(cfg.mysql_image.clone());
a
}
#[derive(Clone, Copy, PartialEq)]
enum GameKind {
World,
Auth,
}
/// Connection strings: host;port;user;password;database. They hold the password, so they travel by environment.
fn database_env(s: &Secrets, world: bool) -> Vec<(String, String)> {
let info = |db: &str| format!("db;3306;acore;{};{db}", s.app);
let mut env = vec![("AC_LOGIN_DATABASE_INFO".to_string(), info("acore_auth"))];
if world {
env.push(("AC_WORLD_DATABASE_INFO".into(), info("acore_world")));
env.push(("AC_CHARACTER_DATABASE_INFO".into(), info("acore_characters")));
}
env
}
fn game_args(cfg: &Config, n: &Names, kind: GameKind, host: &Path, port: u16, ra_port: u16, owner: Option<&str>) -> Vec<String> {
let (name, alias, binary, conf, inner_port) = match kind {
GameKind::World => (&n.world, "world", "./worldserver", "configs/worldserver.conf", WORLD_PORT),
GameKind::Auth => (&n.auth, "auth", "./authserver", "configs/authserver.conf", AUTH_PORT),
};
let mut a: Vec<String> = vec!["run".into(), "--detach".into(), "--name".into(), name.clone()];
a.extend(["--network".into(), n.network.clone(), "--network-alias".into(), alias.into()]);
a.extend(["--label".into(), format!("coa.project={}", cfg.project)]);
if let Some(o) = owner {
// The server writes logs and configuration into the folder: do it as the person who owns it.
a.extend(["--user".into(), o.into()]);
}
a.extend(["--workdir".into(), CORE.into()]);
a.extend(["--volume".into(), format!("{}:{CORE}", host.join("Core").display())]);
a.extend(["--publish".into(), format!("{}:{port}:{inner_port}", cfg.bind_address)]);
// Settings that must not depend on the configuration files: where things are inside the container, and listening
// on every interface of the container (the published address decides who can connect).
let env = |k: &str, v: &str| ["--env".to_string(), format!("{k}={v}")];
a.extend(env("AC_BIND_IP", "0.0.0.0"));
a.extend(env(if kind == GameKind::World { "AC_WORLD_SERVER_PORT" } else { "AC_REALM_SERVER_PORT" }, &inner_port.to_string()));
a.extend(env("AC_LOGS_DIR", &format!("{CORE}/Logs")));
// The Manager applies database updates itself. The server's own updater would need a `mysql` client program inside
// the container and stops the server when it cannot find one.
a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0"));
if kind == GameKind::World {
a.extend(["--volume".into(), format!("{}:{DATA}:ro", host.join("Data").display())]);
a.extend(env("AC_DATA_DIR", DATA));
// The remote console is only ever reachable from this computer.
a.extend(["--publish".into(), format!("127.0.0.1:{ra_port}:{RA_PORT}")]);
a.extend(env("AC_RA_ENABLE", "1"));
a.extend(env("AC_RA_IP", "0.0.0.0"));
a.extend(env("AC_RA_PORT", &RA_PORT.to_string()));
// Saving every character can take a while.
a.extend(["--stop-timeout".into(), "180".into()]);
a.extend(["--env".into(), "AC_WORLD_DATABASE_INFO".into(), "--env".into(), "AC_CHARACTER_DATABASE_INFO".into()]);
} else {
a.extend(["--restart".into(), "on-failure:3".into(), "--stop-timeout".into(), "30".into()]);
}
a.extend(["--env".into(), "AC_LOGIN_DATABASE_INFO".into()]);
a.push(runtime_image());
a.extend([binary.to_string(), "-c".into(), conf.into()]);
a
}
#[cfg(unix)]
fn owner_of(root: &Path) -> Option<String> {
use std::os::unix::fs::MetadataExt;
let m = std::fs::metadata(root).ok()?;
Some(format!("{}:{}", m.uid(), m.gid()))
}
#[cfg(not(unix))]
fn owner_of(_root: &Path) -> Option<String> {
None
}
// ------------------------------------------------------------------------------------------------------------- stop
fn stop(d: &dyn Docker, cfg: &Config, log: &mut Log) -> Step<()> {
preflight(d, log)?;
let n = cfg.names();
let state = inspect(d, &[&n.db, &n.world, &n.auth])?;
// Game servers first, the database last. The world server gets time to save every character.
for (name, seconds) in [(&n.world, 180u64), (&n.auth, 30), (&n.db, 60)] {
if state.get(name).is_some_and(Container::running) {
let t = seconds.to_string();
let o = docker(d, &["stop", "--time", &t, name], Duration::from_secs(seconds + 30))?;
if !o.ok() {
return fail(ErrorCode::StartupFailed, o.text());
}
log.say(format!("stopped {name}"));
}
}
Ok(())
}
// ---------------------------------------------------------------------------------------------------------- observe
pub fn observe(root: &Path, ports: &Ports) -> Observed {
observe_with(&SystemDocker, root, ports)
}
pub fn observe_with(d: &dyn Docker, root: &Path, ports: &Ports) -> Observed {
let unknown = |name: &'static str, port: u16| ServiceStatus { name, state: ServiceState::Unknown, pid: None, port, port_ready: false, conflict: None, uptime_secs: None };
let Ok(cfg) = Config::load(root) else {
return Observed { mysql: unknown("mysql", ports.mysql), auth: unknown("auth", ports.auth), world: unknown("world", ports.world) };
};
let n = cfg.names();
let Ok(state) = inspect(d, &[&n.db, &n.world, &n.auth]) else {
return Observed { mysql: unknown("mysql", ports.mysql), auth: unknown("auth", ports.auth), world: unknown("world", ports.world) };
};
let ip = connect_ip(&cfg);
let listening = |c: Option<&Container>, port: u16| c.is_some_and(Container::running) && d.port_open(SocketAddr::new(ip, port));
Observed {
mysql: status("mysql", state.get(&n.db), ports.mysql, state.get(&n.db).is_some_and(|c| c.health.as_deref() == Some("healthy"))),
auth: status("auth", state.get(&n.auth), ports.auth, listening(state.get(&n.auth), ports.auth)),
world: status("world", state.get(&n.world), ports.world, listening(state.get(&n.world), ports.world)),
}
}
fn status(name: &'static str, c: Option<&Container>, port: u16, ready: bool) -> ServiceStatus {
let Some(c) = c else {
return ServiceStatus { name, state: ServiceState::Stopped, pid: None, port, port_ready: false, conflict: None, uptime_secs: None };
};
let state = match c.status.as_str() {
"running" if ready => ServiceState::Running,
"running" | "created" | "restarting" => ServiceState::Starting,
// Stopped by `docker stop` (SIGTERM, then SIGKILL after the grace period) is a normal stop; anything else is a crash.
"exited" if c.exit_code == 0 || ((c.exit_code == 137 || c.exit_code == 143) && !c.oom_killed) => ServiceState::Stopped,
"exited" => ServiceState::Crashed,
_ => ServiceState::Unknown,
};
let running = c.running();
ServiceStatus {
name,
state,
pid: if running { c.pid } else { None },
port,
port_ready: running && ready,
conflict: None,
uptime_secs: if running { c.started_at.as_deref().and_then(uptime_since) } else { None },
}
}
fn uptime_since(started: &str) -> Option<u64> {
let t = chrono::DateTime::parse_from_rfc3339(started).ok()?;
u64::try_from((chrono::Utc::now() - t.with_timezone(&chrono::Utc)).num_seconds()).ok()
}
#[cfg(test)]
mod tests {
use super::*;
use crate::docker::cli::Output;
use std::cell::RefCell;
use std::collections::{BTreeMap, HashSet};
use std::fs;
const ROOT_PW: &str = "rootpw-ZZ1";
const APP_PW: &str = "apppw-QQ2";
/// A tiny in-memory Docker: containers, one network, one image. It answers the few commands the backend uses.
struct Sim {
calls: RefCell<Vec<Call2>>,
running: RefCell<HashSet<String>>,
exited: RefCell<BTreeMap<String, (i64, bool)>>,
network: RefCell<bool>,
image: RefCell<bool>,
logs: RefCell<String>,
unavailable: bool,
daemon_error: Option<String>,
/// `docker run` of this container fails with this message.
run_error: Option<(String, String)>,
/// A container that stops right after it was created, with this exit code.
dies: Option<(String, i64)>,
port_open: bool,
}
#[derive(Clone)]
struct Call2 {
args: Vec<String>,
env: Vec<(String, String)>,
stdin: bool,
}
impl Sim {
fn new() -> Sim {
Sim {
calls: Default::default(),
running: Default::default(),
exited: Default::default(),
network: RefCell::new(false),
image: RefCell::new(false),
logs: Default::default(),
unavailable: false,
daemon_error: None,
run_error: None,
dies: None,
port_open: true,
}
}
fn verbs(&self) -> Vec<String> {
self.calls.borrow().iter().map(|c| c.args.iter().take(2).cloned().collect::<Vec<_>>().join(" ")).collect()
}
fn calls_of(&self, verb: &str) -> Vec<Call2> {
self.calls.borrow().iter().filter(|c| c.args[0] == verb).cloned().collect()
}
fn inspect_json(&self, names: &[String]) -> (String, bool) {
let mut items = Vec::new();
let mut missing = false;
for n in names {
if self.running.borrow().contains(n) {
let health = if n.ends_with("-db") { r#","Health":{"Status":"healthy"}"# } else { "" };
items.push(format!(
r#"{{"Name":"/{n}","State":{{"Status":"running","Running":true,"ExitCode":0,"OOMKilled":false,"Pid":4242,"StartedAt":"2026-10-02T12:27:26.892949316Z"{health}}}}}"#
));
} else if let Some((code, oom)) = self.exited.borrow().get(n) {
items.push(format!(
r#"{{"Name":"/{n}","State":{{"Status":"exited","Running":false,"ExitCode":{code},"OOMKilled":{oom},"Pid":0,"StartedAt":"2026-10-02T12:27:26.892949316Z"}}}}"#
));
} else {
missing = true;
}
}
(format!("[{}]", items.join(",")), missing)
}
}
fn out(code: i32, stdout: &str, stderr: &str) -> Output {
Output { code: Some(code), stdout: stdout.into(), stderr: stderr.into() }
}
impl Docker for Sim {
fn run(&self, call: &Call) -> Result<Output> {
self.calls.borrow_mut().push(Call2 { args: call.args.clone(), env: call.env.clone(), stdin: call.stdin.is_some() });
if self.unavailable {
return Err(crate::error::Error::Invalid("docker could not be started: No such file or directory".into()));
}
let a: Vec<&str> = call.args.iter().map(String::as_str).collect();
Ok(match a.as_slice() {
["version", ..] => match &self.daemon_error {
Some(e) => out(1, "", e),
None => out(0, "27.3.1\n", ""),
},
["network", "inspect", ..] => if *self.network.borrow() { out(0, "[]", "") } else { out(1, "[]", "Error: No such network") },
["network", "create", ..] => {
*self.network.borrow_mut() = true;
out(0, "id\n", "")
}
["image", "inspect", ..] => if *self.image.borrow() { out(0, "[]", "") } else { out(1, "[]", "Error: No such image") },
["build", ..] => {
*self.image.borrow_mut() = true;
out(0, "built", "")
}
["inspect", names @ ..] => {
let names: Vec<String> = names.iter().map(|s| s.to_string()).collect();
let (json, missing) = self.inspect_json(&names);
if missing { out(1, &json, "Error: No such object: x") } else { out(0, &json, "") }
}
["rm", "-f", name] => {
self.running.borrow_mut().remove(*name);
self.exited.borrow_mut().remove(*name);
out(0, "", "")
}
["run", ..] => {
let name = call.args[call.args.iter().position(|x| x == "--name").unwrap() + 1].clone();
if let Some((n, e)) = &self.run_error {
if *n == name {
return Ok(out(125, "", e));
}
}
match &self.dies {
Some((n, code)) if *n == name => {
self.exited.borrow_mut().insert(name, (*code, false));
}
_ => {
self.running.borrow_mut().insert(name);
}
}
out(0, "containerid\n", "")
}
["stop", "--time", _, name] => {
self.running.borrow_mut().remove(*name);
self.exited.borrow_mut().insert(name.to_string(), (0, false));
out(0, "", "")
}
["logs", ..] => out(0, &self.logs.borrow(), ""),
other => panic!("unexpected docker call: {other:?}"),
})
}
fn port_open(&self, _addr: SocketAddr) -> bool {
self.port_open
}
fn pause(&self, _d: Duration) {}
}
fn server(project: &str) -> (tempfile::TempDir, std::path::PathBuf) {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(root.join("Settings/docker.json"), format!(r#"{{"project":"{project}"}}"#)).unwrap();
fs::write(root.join("Settings/database.json"), format!(r#"{{"rootPassword":"{ROOT_PW}","appPassword":"{APP_PW}"}}"#)).unwrap();
(d, root)
}
fn start_all(sim: &Sim, root: &Path) -> DriverOutcome {
run_with(sim, root, Verb::StartAll).unwrap()
}
#[test]
fn a_first_start_creates_the_network_the_image_and_the_containers_in_order() {
let (_d, root) = server("t1");
let sim = Sim::new();
let o = start_all(&sim, &root);
assert!(o.ok, "{}", o.output);
let verbs = sim.verbs();
let at = |needle: &str| verbs.iter().position(|v| v.starts_with(needle)).unwrap_or_else(|| panic!("{needle} not called: {verbs:?}"));
assert!(at("version") < at("network create"));
assert!(at("network create") < at("run --detach"), "database comes first");
let runs: Vec<String> = sim.calls_of("run").iter().map(|c| c.args[c.args.iter().position(|x| x == "--name").unwrap() + 1].clone()).collect();
assert_eq!(runs, ["coa-t1-db", "coa-t1-world", "coa-t1-auth"], "database, then world, then auth");
assert!(at("build") < verbs.iter().rposition(|v| v.starts_with("run")).unwrap(), "the runtime image exists before the game servers");
assert!(sim.calls_of("build")[0].stdin, "the Dockerfile travels on stdin");
}
#[test]
fn passwords_travel_by_environment_and_never_on_a_command_line() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
for c in sim.calls.borrow().iter() {
for arg in &c.args {
assert!(!arg.contains(ROOT_PW) && !arg.contains(APP_PW), "secret on a command line: {arg}");
}
}
let runs = sim.calls_of("run");
assert!(runs[0].env.contains(&("MYSQL_ROOT_PASSWORD".into(), ROOT_PW.into())));
assert!(runs[1].env.iter().any(|(k, v)| k == "AC_LOGIN_DATABASE_INFO" && v == &format!("db;3306;acore;{APP_PW};acore_auth")));
assert!(runs[1].env.iter().any(|(k, _)| k == "AC_CHARACTER_DATABASE_INFO"));
assert!(runs[2].env.iter().any(|(k, _)| k == "AC_LOGIN_DATABASE_INFO"));
assert!(!runs[2].env.iter().any(|(k, _)| k == "AC_WORLD_DATABASE_INFO"), "auth does not need the world database");
assert!(runs[1].args.windows(2).any(|w| w == ["--env", "AC_WORLD_DATABASE_INFO"]), "name only, the value is in the environment");
}
#[test]
fn the_world_container_is_wired_like_the_repack_layout() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
let world = &sim.calls_of("run")[1].args;
let has = |s: &str| world.iter().any(|a| a == s);
assert!(has("127.0.0.1:8085:8085"), "game port on this computer only by default");
assert!(has("127.0.0.1:3443:3443"), "the remote console is never exposed beyond this computer");
assert!(has("AC_BIND_IP=0.0.0.0") && has("AC_RA_ENABLE=1") && has("AC_RA_IP=0.0.0.0"));
assert!(has("AC_UPDATES_ENABLE_DATABASES=0"), "the server's own database updater needs a mysql client the image does not have");
assert!(sim.calls_of("run")[2].args.iter().any(|a| a == "AC_UPDATES_ENABLE_DATABASES=0"));
assert!(has("AC_DATA_DIR=/srv/data") && has("AC_LOGS_DIR=/srv/core/Logs"));
assert!(world.iter().any(|a| a.ends_with(":/srv/data:ro")), "game data is read-only");
assert!(world.iter().any(|a| a.ends_with(":/srv/core") && a.contains("Core")));
assert!(world.windows(2).any(|w| w == ["--workdir", "/srv/core"]));
assert!(world.windows(2).any(|w| w == ["--stop-timeout", "180"]));
let n = world.len();
assert_eq!(&world[n - 3..], ["./worldserver", "-c", "configs/worldserver.conf"]);
assert!(world[n - 4].starts_with("coa-runtime:"));
assert!(root.join("Core/Logs").is_dir(), "created by the Manager so it belongs to the user");
}
#[test]
fn the_published_address_follows_the_setting() {
let (_d, root) = server("t1");
fs::write(root.join("Settings/docker.json"), r#"{"project":"t1","bindAddress":"0.0.0.0"}"#).unwrap();
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
let runs = sim.calls_of("run");
assert!(runs[1].args.iter().any(|a| a == "0.0.0.0:8085:8085"));
assert!(runs[1].args.iter().any(|a| a == "127.0.0.1:3443:3443"), "the console stays private");
assert!(runs[2].args.iter().any(|a| a == "0.0.0.0:3724:3724"));
}
#[test]
fn custom_host_ports_keep_the_container_listeners_on_the_mapped_ports() {
let (_d, root) = server("ports");
let cfg = Config::load(&root).unwrap();
let n = cfg.names();
let world = game_args(&cfg, &n, GameKind::World, &root, 18085, 13443, None);
let auth = game_args(&cfg, &n, GameKind::Auth, &root, 13724, 0, None);
assert!(world.iter().any(|a| a == "127.0.0.1:18085:8085"));
assert!(world.iter().any(|a| a == "127.0.0.1:13443:3443"));
assert!(world.iter().any(|a| a == "AC_WORLD_SERVER_PORT=8085"));
assert!(world.iter().any(|a| a == "AC_RA_PORT=3443"));
assert!(auth.iter().any(|a| a == "127.0.0.1:13724:3724"));
assert!(auth.iter().any(|a| a == "AC_REALM_SERVER_PORT=3724"));
}
#[test]
fn a_second_start_leaves_running_containers_alone() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
let before = sim.calls_of("run").len();
assert!(start_all(&sim, &root).ok);
assert_eq!(sim.calls_of("run").len(), before, "nothing was recreated");
}
#[test]
fn start_database_only_does_not_touch_the_game_servers() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(run_with(&sim, &root, Verb::StartMysql).unwrap().ok);
assert_eq!(sim.calls_of("run").len(), 1);
assert!(sim.calls_of("build").is_empty());
}
#[test]
fn stop_goes_world_then_auth_then_database_with_time_to_save() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
sim.calls.borrow_mut().clear();
let o = run_with(&sim, &root, Verb::StopAll).unwrap();
assert!(o.ok, "{}", o.output);
let stops: Vec<(String, String)> = sim.calls_of("stop").iter().map(|c| (c.args[3].clone(), c.args[2].clone())).collect();
assert_eq!(stops, [("coa-t1-world".into(), "180".into()), ("coa-t1-auth".into(), "30".into()), ("coa-t1-db".into(), "60".into())]);
assert!(sim.running.borrow().is_empty());
// Stopping what is already stopped is fine.
sim.calls.borrow_mut().clear();
assert!(run_with(&sim, &root, Verb::StopAll).unwrap().ok);
assert!(sim.calls_of("stop").is_empty());
}
#[test]
fn docker_not_installed_is_reported_as_unavailable() {
let (_d, root) = server("t1");
let mut sim = Sim::new();
sim.unavailable = true;
let o = start_all(&sim, &root);
assert!(!o.ok);
assert_eq!(o.code, Some(ErrorCode::DockerUnavailable));
assert!(o.output.contains("could not be started"));
}
#[test]
fn a_refused_connection_to_the_docker_service_shows_docker_own_words() {
let (_d, root) = server("t1");
let mut sim = Sim::new();
sim.daemon_error = Some("permission denied while trying to connect to the Docker daemon socket".into());
let o = start_all(&sim, &root);
assert_eq!(o.code, Some(ErrorCode::DockerUnavailable));
assert!(o.output.contains("permission denied"), "{}", o.output);
assert!(sim.calls_of("run").is_empty(), "nothing is started when docker is not usable");
}
#[test]
fn a_world_server_that_stops_while_starting_reports_the_cause_found_in_its_log() {
let (_d, root) = server("t1");
let mut sim = Sim::new();
sim.dies = Some(("coa-t1-world".into(), 1));
*sim.logs.borrow_mut() = "\u{1b}[31mCould not connect to MySQL database at db: Can't connect to MySQL server on 'db:3306' (111)\u{1b}[0m".into();
let o = start_all(&sim, &root);
assert!(!o.ok);
assert_eq!(o.code, Some(ErrorCode::DatabaseNotRunning));
assert!(o.output.contains("Can't connect to MySQL server"), "{}", o.output);
assert!(!o.output.contains('\u{1b}'), "colour codes are removed");
assert!(sim.calls_of("run").len() == 2, "auth is not started after a failed world");
}
#[test]
fn a_port_that_is_taken_is_reported_as_such() {
let (_d, root) = server("t1");
let mut sim = Sim::new();
sim.run_error = Some(("coa-t1-world".into(), "Bind for 127.0.0.1:8085 failed: port is already allocated".into()));
let o = start_all(&sim, &root);
assert_eq!(o.code, Some(ErrorCode::PortInUse));
}
#[test]
fn a_server_that_never_listens_times_out_with_its_log() {
let (_d, root) = server("t1");
let mut sim = Sim::new();
sim.port_open = false;
*sim.logs.borrow_mut() = "still loading".into();
let o = start_all(&sim, &root);
assert!(!o.ok);
assert!(o.output.contains("was not listening on port 8085") && o.output.contains("still loading"), "{}", o.output);
}
#[test]
fn invalid_settings_are_refused_before_anything_runs() {
for (project, bind, image) in [("Bad Name", "127.0.0.1", "mysql:8.4"), ("", "127.0.0.1", "mysql:8.4"), ("ok", "not-an-ip", "mysql:8.4"), ("ok", "127.0.0.1", "mysql:8.4; rm -rf /"), ("-lead", "127.0.0.1", "mysql:8.4")] {
let (_d, root) = server("t1");
fs::write(root.join("Settings/docker.json"), format!(r#"{{"project":"{project}","bindAddress":"{bind}","mysqlImage":"{image}"}}"#)).unwrap();
let sim = Sim::new();
assert!(run_with(&sim, &root, Verb::StartAll).is_err(), "{project} / {bind} / {image}");
assert!(sim.calls.borrow().is_empty());
}
}
#[test]
fn inspect_output_is_read_like_docker_prints_it() {
// Shape taken from `docker inspect` on a stopped database container and a world server.
let json = r#"[{"Id":"abc","Name":"/coa-t1-db","State":{"Status":"running","Running":true,"Paused":false,"Restarting":false,"OOMKilled":false,"Dead":false,"Pid":2402,"ExitCode":0,"Error":"","StartedAt":"2026-10-02T12:27:26.892949316Z","FinishedAt":"0001-01-01T00:00:00Z","Health":{"Status":"healthy","FailingStreak":0,"Log":[]}}},
{"Name":"/coa-t1-world","State":{"Status":"exited","Running":false,"OOMKilled":false,"Pid":0,"ExitCode":137,"StartedAt":"2026-10-02T12:40:06.76552263Z"}}]"#;
let m = parse_inspect(json);
assert_eq!(m["coa-t1-db"].pid, Some(2402));
assert_eq!(m["coa-t1-db"].health.as_deref(), Some("healthy"));
assert_eq!(m["coa-t1-world"].exit_code, 137);
assert_eq!(m["coa-t1-world"].pid, None);
assert!(parse_inspect("[]").is_empty() && parse_inspect("").is_empty() && parse_inspect("nonsense").is_empty());
}
#[test]
fn observation_maps_container_states_to_service_states() {
let ports = Ports::default();
let (_d, root) = server("t1");
// Nothing created yet.
let sim = Sim::new();
let o = observe_with(&sim, &root, &ports);
assert!([o.mysql.state, o.auth.state, o.world.state].iter().all(|s| *s == ServiceState::Stopped));
// Everything up.
assert!(start_all(&sim, &root).ok);
let o = observe_with(&sim, &root, &ports);
assert_eq!((o.mysql.state, o.auth.state, o.world.state), (ServiceState::Running, ServiceState::Running, ServiceState::Running));
assert!(o.world.port_ready && o.world.pid == Some(4242) && o.world.uptime_secs.is_some());
assert_eq!(o.world.port, ports.world);
// Running but not listening yet.
let mut slow = Sim::new();
slow.port_open = false;
slow.running.borrow_mut().insert("coa-t1-world".into());
let o = observe_with(&slow, &root, &ports);
assert_eq!(o.world.state, ServiceState::Starting);
assert!(!o.world.port_ready);
// Stopped cleanly, killed after the grace period, crashed, killed for lack of memory.
let mut sim = Sim::new();
for (name, code, oom) in [("coa-t1-db", 0, false), ("coa-t1-auth", 137, false), ("coa-t1-world", 1, false)] {
sim.exited.borrow_mut().insert(name.into(), (code, oom));
}
let o = observe_with(&sim, &root, &ports);
assert_eq!((o.mysql.state, o.auth.state, o.world.state), (ServiceState::Stopped, ServiceState::Stopped, ServiceState::Crashed));
sim.exited.borrow_mut().insert("coa-t1-auth".into(), (137, true));
assert_eq!(observe_with(&sim, &root, &ports).auth.state, ServiceState::Crashed);
sim.unavailable = true;
assert_eq!(observe_with(&sim, &root, &ports).world.state, ServiceState::Unknown, "docker unreachable: unknown, not stopped");
}
#[test]
fn the_runtime_image_is_named_after_its_dockerfile() {
let name = runtime_image();
assert!(name.starts_with("coa-runtime:") && name.len() == "coa-runtime:".len() + 12, "{name}");
assert!(RUNTIME_DOCKERFILE.contains("libmysqlclient24") && RUNTIME_DOCKERFILE.contains("libreadline8t64"));
}
#[test]
fn a_docker_folder_is_scanned_without_the_repack_files() {
let (_d, root) = server("t1");
assert!(crate::docker::is_docker(&root));
for f in ["Core/worldserver", "Core/authserver", "Core/configs/worldserver.conf", "Core/configs/authserver.conf", "Data/dbc/x", "Data/maps/x"] {
let p = root.join(f);
fs::create_dir_all(p.parent().unwrap()).unwrap();
fs::write(p, "x").unwrap();
}
let r = crate::layout::scan(&root).unwrap();
assert_eq!(r.classification, crate::layout::Classification::Healthy);
assert!(r.worldserver.is_some() && r.authserver.is_some() && !r.modifies_files);
fs::remove_file(root.join("Core/authserver")).unwrap();
assert_eq!(crate::layout::scan(&root).unwrap().classification, crate::layout::Classification::Partial);
fs::remove_file(root.join("Settings/docker.json")).unwrap();
assert!(!crate::docker::is_docker(&root), "without the marker it is scanned as a repack");
}
}
+159
View File
@@ -0,0 +1,159 @@
//! Docker backend. The three services (MySQL, authserver, worldserver) run in containers that the Manager creates
//! and controls through the `docker` command line; the server folder keeps the same shape as a repack where it
//! matters (`Core/configs`, `Core/Logs`, `Settings/*.json`, `Data/`) so configuration, logs and the RA console work
//! unchanged. This is the only runtime available on Linux. The Windows repack path is not touched: an
//! installation is a Docker one only when `Settings/docker.json` exists.
//!
//! ```text
//! <server>/
//! Core/worldserver, authserver mounted at /srv/core (working directory of both containers)
//! Core/configs/ Core/Logs/ read and written by the Manager as usual
//! Data/ mounted read-only at /srv/data
//! Settings/docker.json marks the installation and names its containers
//! Settings/repack.json ports and RA login (same file as a repack)
//! Settings/database.json database passwords (same file as a repack)
//! ```
mod cli;
mod lifecycle;
pub use cli::{Call, Docker, Output, SystemDocker};
pub use lifecycle::{observe, observe_with, run, run_with};
use std::net::IpAddr;
use std::path::Path;
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
use crate::fsx;
use crate::layout::{self, Classification, ScanReport};
/// Present in a Docker installation, absent from a repack.
pub const MARKER: &str = "Settings/docker.json";
const MYSQL_IMAGE: &str = "mysql:8.4";
const RUNTIME_DOCKERFILE: &str = include_str!("Dockerfile.runtime");
pub fn is_docker(root: &Path) -> bool {
root.join(MARKER).is_file()
}
fn loopback() -> String {
"127.0.0.1".into()
}
fn mysql_image() -> String {
MYSQL_IMAGE.into()
}
/// `Settings/docker.json`.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Config {
/// Short unique name of this installation; part of every container, network and volume name.
pub project: String,
/// Host address the game ports are published on: `127.0.0.1` (this computer only) or `0.0.0.0` / a LAN address.
#[serde(default = "loopback")]
pub bind_address: String,
#[serde(default = "mysql_image")]
pub mysql_image: String,
}
pub(crate) struct Names {
pub network: String,
pub volume: String,
pub db: String,
pub world: String,
pub auth: String,
}
impl Config {
pub fn load(root: &Path) -> Result<Config> {
let cfg: Config = fsx::read_json(&root.join(MARKER)).map_err(|_| Error::Invalid("The Docker settings of this server could not be read.".into()))?;
cfg.validate()?;
Ok(cfg)
}
fn validate(&self) -> Result<()> {
let name_ok = !self.project.is_empty()
&& self.project.len() <= 32
&& self.project.starts_with(|c: char| c.is_ascii_lowercase() || c.is_ascii_digit())
&& self.project.chars().all(|c| c.is_ascii_lowercase() || c.is_ascii_digit() || c == '-');
if !name_ok {
return Err(Error::Invalid("The Docker project name must be 1-32 characters: lower-case letters, digits and dashes.".into()));
}
if self.bind_address.parse::<IpAddr>().is_err() {
return Err(Error::Invalid(format!("{} is not an IP address.", self.bind_address)));
}
let image_ok = !self.mysql_image.is_empty() && self.mysql_image.chars().all(|c| c.is_ascii_alphanumeric() || "._/:@-".contains(c));
if !image_ok {
return Err(Error::Invalid("The database image name is not valid.".into()));
}
Ok(())
}
pub(crate) fn names(&self) -> Names {
let p = &self.project;
Names { network: format!("coa-{p}"), volume: format!("coa-{p}-db"), db: format!("coa-{p}-db"), world: format!("coa-{p}-world"), auth: format!("coa-{p}-auth") }
}
}
/// Name of the runtime image: it follows the content of its Dockerfile, so changing the libraries builds a new image.
pub(crate) fn runtime_image() -> String {
format!("coa-runtime:{}", &fsx::sha256_bytes(RUNTIME_DOCKERFILE.as_bytes())[..12])
}
/// Read-only description of a Docker installation, shaped like the scan of a repack so the screens that list what a
/// server holds work for both.
pub(crate) fn scan(root: &Path) -> Result<ScanReport> {
let cfg = Config::load(root);
let world = layout::hash_exe(&root.join("Core/worldserver"), None, "worldserver");
let auth = layout::hash_exe(&root.join("Core/authserver"), None, "authserver");
let modules_dir = root.join("Core/configs/modules");
let mut module_configs: Vec<String> = std::fs::read_dir(&modules_dir)
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| e.file_name().into_string().ok()).filter(|n| n.ends_with(".conf")).collect())
.unwrap_or_default();
module_configs.sort();
let bot_active = modules_dir.join("mod_coa_playerbots.conf");
let bot_conf = if bot_active.is_file() { bot_active } else { modules_dir.join("mod_coa_playerbots.conf.dist") };
let bot_config_keys = layout::count_bot_keys(&bot_conf);
let has_data = layout::exists(root, "Data/dbc") && layout::exists(root, "Data/maps");
let has_confs = layout::exists(root, "Core/configs/worldserver.conf") && layout::exists(root, "Core/configs/authserver.conf");
let items = vec![
layout::item("worldserver", "World server", world.is_some(), None),
layout::item("authserver", "Auth server", auth.is_some(), None),
layout::item("worldserver_conf", "World server configuration", layout::exists(root, "Core/configs/worldserver.conf"), None),
layout::item("authserver_conf", "Auth server configuration", layout::exists(root, "Core/configs/authserver.conf"), None),
layout::item("modules_conf", "Module configuration", modules_dir.is_dir(), Some(format!("{} files", module_configs.len()))),
layout::item("game_data", "Game data (maps, DBC)", has_data, None),
layout::item("database_runtime", "Database runtime", cfg.is_ok(), cfg.as_ref().ok().map(|c| c.mysql_image.clone())),
layout::item("launcher", "Docker settings", cfg.is_ok(), cfg.as_ref().ok().map(|c| c.project.clone())),
layout::item("companions", "CoA Companions (bots)", bot_conf.is_file(), (bot_config_keys > 0).then(|| format!("{bot_config_keys} settings"))),
];
let mut notes = Vec::new();
if let Err(e) = &cfg {
notes.push(e.to_string());
}
let healthy = cfg.is_ok() && world.is_some() && auth.is_some() && has_data && has_confs;
Ok(ScanReport {
path: root.to_string_lossy().into_owned(),
classification: if healthy { Classification::Healthy } else { Classification::Partial },
items,
worldserver: world,
authserver: auth,
release: None,
banner_revision: layout::banner_revision_in_log(&root.join("Core/Logs/Server.log")),
module_configs,
bot_config_keys,
ports: layout::read_ports(root),
database_schemas: Vec::new(),
client: ["Client", "client"].iter().find_map(|d| layout::detect_client(&root.join(d))),
notes,
suggested_path: None,
hint: None,
modifies_files: false,
})
}
+26 -1
View File
@@ -35,7 +35,7 @@ impl Cancel {
pub fn cancel(&self) { pub fn cancel(&self) {
self.0.store(true, Ordering::SeqCst); self.0.store(true, Ordering::SeqCst);
} }
fn is_set(&self) -> bool { pub fn is_set(&self) -> bool {
self.0.load(Ordering::SeqCst) self.0.load(Ordering::SeqCst)
} }
} }
@@ -70,6 +70,17 @@ pub trait Transport {
pub struct HttpTransport(reqwest::blocking::Client); pub struct HttpTransport(reqwest::blocking::Client);
impl HttpTransport { impl HttpTransport {
/// For small documents (manifests): gives up when the server stalls instead of waiting forever.
pub fn with_total_timeout(secs: u64) -> Result<Self> {
reqwest::blocking::Client::builder()
.connect_timeout(Duration::from_secs(15))
.timeout(Duration::from_secs(secs))
.redirect(reqwest::redirect::Policy::limited(5))
.build()
.map(HttpTransport)
.map_err(|e| Error::Invalid(e.to_string()))
}
pub fn new() -> Result<Self> { pub fn new() -> Result<Self> {
reqwest::blocking::Client::builder() reqwest::blocking::Client::builder()
.connect_timeout(Duration::from_secs(15)) .connect_timeout(Duration::from_secs(15))
@@ -130,6 +141,10 @@ fn attempt(client: &dyn Transport, job: &Job, part: &Path, cancel: &Cancel, on_p
have = 0; have = 0;
} }
if have == job.size { if have == job.size {
if !part.exists() {
// an empty file: nothing to request
File::create(part)?;
}
return finish(job, part, hasher); return finish(job, part, hasher);
} }
@@ -378,6 +393,16 @@ mod tests {
assert!(part_path(&j.dest).exists(), "partial data is kept for the next try"); assert!(part_path(&j.dest).exists(), "partial data is kept for the next try");
} }
#[test]
fn an_empty_file_needs_no_request_and_is_still_created() {
let dir = tempfile::tempdir().unwrap();
let j = job(dir.path(), b"");
let m = Mock::new(Vec::new(), 0, true);
fetch_with(&m, &j, &Cancel::default(), &|_| {}).unwrap();
assert_eq!(fs::read(&j.dest).unwrap(), Vec::<u8>::new());
assert_eq!(m.calls.load(Ordering::SeqCst), 0);
}
#[test] #[test]
fn only_https_or_loopback_http_is_allowed() { fn only_https_or_loopback_http_is_allowed() {
assert!(check_url("https://github.com/x").is_ok()); assert!(check_url("https://github.com/x").is_ok());
+14
View File
@@ -80,6 +80,20 @@ fn launcher(root: &Path) -> Result<(PathBuf, PathBuf)> {
/// Run a launcher verb to completion (blocking; call from a worker thread). /// Run a launcher verb to completion (blocking; call from a worker thread).
pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> { pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
let root = fsx::canonicalize_lenient(root)?; let root = fsx::canonicalize_lenient(root)?;
if crate::docker::is_docker(&root) {
return crate::docker::run(&root, verb);
}
if verb == Verb::StartAll {
crate::realms::before_start(&root)?;
if root.join("Settings/realm-profile.json").exists() {
let db = crate::db::Db::from_repack(&root, crate::db::Account::Admin)?;
if !db.ping() {
let out = run(&root, Verb::StartMysql)?;
if !out.ok { return Ok(out); }
}
crate::realms::setup_realmlist(&root)?;
}
}
let (python, script) = launcher(&root)?; let (python, script) = launcher(&root)?;
let mut cmd = Command::new(&python); let mut cmd = Command::new(&python);
cmd.arg("-B").arg(&script).arg(verb.arg()).current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped()); cmd.arg("-B").arg(&script).arg(verb.arg()).current_dir(&root).stdin(Stdio::null()).stdout(Stdio::piped()).stderr(Stdio::piped());
+24
View File
@@ -24,6 +24,10 @@ pub enum Error {
PackageNotPublished(String), PackageNotPublished(String),
#[error("download server unreachable: {0}")] #[error("download server unreachable: {0}")]
NetworkUnreachable(String), NetworkUnreachable(String),
#[error("the bot module found no level 80 template characters")]
CompanionTemplatesMissing,
#[error("this server's bot module does not have that command yet")]
CompanionCommandUnsupported,
#[error("invalid values: {}", .0.iter().map(|f| format!("{}: {}", f.key, f.message)).collect::<Vec<_>>().join("; "))] #[error("invalid values: {}", .0.iter().map(|f| format!("{}: {}", f.key, f.message)).collect::<Vec<_>>().join("; "))]
Validation(Vec<FieldError>), Validation(Vec<FieldError>),
} }
@@ -48,10 +52,13 @@ pub enum ErrorCode {
DiskFull, DiskFull,
OperationInProgress, OperationInProgress,
StartupFailed, StartupFailed,
DockerUnavailable,
HashMismatch, HashMismatch,
PathRejected, PathRejected,
PackageNotPublished, PackageNotPublished,
NetworkUnreachable, NetworkUnreachable,
CompanionTemplatesMissing,
CompanionCommandUnsupported,
Unknown, Unknown,
} }
@@ -122,6 +129,11 @@ impl ErrorCode {
"A service stopped while starting. Check the details for the cause.", "A service stopped while starting. Check the details for the cause.",
&[FixAutomatically, ShowDetails], &[FixAutomatically, ShowDetails],
), ),
ErrorCode::DockerUnavailable => (
"Docker is not available",
"This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
&[Retry, ShowDetails],
),
ErrorCode::HashMismatch => ( ErrorCode::HashMismatch => (
"A downloaded file is damaged", "A downloaded file is damaged",
"The file did not match its checksum and was not used.", "The file did not match its checksum and was not used.",
@@ -142,6 +154,16 @@ impl ErrorCode {
"Check your internet connection and try again.", "Check your internet connection and try again.",
&[Retry, ShowDetails], &[Retry, ShowDetails],
), ),
ErrorCode::CompanionTemplatesMissing => (
"Companions have nothing to be copied from yet",
"New companions are copied from level 80 characters of each class. Create one level 80 character per class on any account except the console account, then try again.",
&[ShowDetails],
),
ErrorCode::CompanionCommandUnsupported => (
"This server version can not do that yet",
"The bot module of this server build has no such command. Update the server, or restart it to stop what is running.",
&[ShowDetails],
),
ErrorCode::Unknown => ("Something went wrong", "See the technical details.", &[ShowDetails]), ErrorCode::Unknown => ("Something went wrong", "See the technical details.", &[ShowDetails]),
}; };
Human { code: self, title, message, actions } Human { code: self, title, message, actions }
@@ -157,6 +179,8 @@ impl Error {
Error::Validation(_) => ErrorCode::InvalidConfigValue, Error::Validation(_) => ErrorCode::InvalidConfigValue,
Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished, Error::PackageNotPublished(_) => ErrorCode::PackageNotPublished,
Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable, Error::NetworkUnreachable(_) => ErrorCode::NetworkUnreachable,
Error::CompanionTemplatesMissing => ErrorCode::CompanionTemplatesMissing,
Error::CompanionCommandUnsupported => ErrorCode::CompanionCommandUnsupported,
_ => ErrorCode::Unknown, _ => ErrorCode::Unknown,
} }
} }
+29 -1
View File
@@ -89,6 +89,18 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
originals.push((p.clone(), bytes)); originals.push((p.clone(), bytes));
edits.push((p, conf.to_text())); edits.push((p, conf.to_text()));
} }
// Friends connect from other addresses, and the server only applies the CoA client protocol (extension packets,
// header mode) to loopback unless remote clients are allowed - so sharing must switch that on as well.
let coa_conf = root.join("Core/configs/modules/coa.conf");
if let Ok(bytes) = fs::read(&coa_conf) {
let mut conf = ConfFile::parse_bytes(&bytes)?;
// Opening turns it on; closing leaves it alone (it only matters while the servers listen beyond this computer).
if open && conf.get("CoA.AllowRemoteClients").map(str::trim) != Some("1") {
conf.set("CoA.AllowRemoteClients", "1", &["Set by CoA Server Manager together with the friends mode"]);
originals.push((coa_conf.clone(), bytes));
edits.push((coa_conf, conf.to_text()));
}
}
if edits.is_empty() { if edits.is_empty() {
return Ok(false); return Ok(false);
} }
@@ -105,7 +117,8 @@ pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
return Err(Error::Invalid("That address is not valid.".into())); return Err(Error::Invalid("That address is not valid.".into()));
} }
let db = Db::from_repack(root, Account::Admin)?; let db = Db::from_repack(root, Account::Admin)?;
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}', localAddress='{host}' WHERE id=1;"))?; let realm = crate::realms::state(root)?.active.realm_id();
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}', localAddress='{host}' WHERE id={realm};"))?;
Ok(()) Ok(())
} }
@@ -200,6 +213,21 @@ mod tests {
assert!(fs::read_to_string(root.join("Core/configs/worldserver.conf")).unwrap().contains("BindIP = \"127.0.0.1\"")); assert!(fs::read_to_string(root.join("Core/configs/worldserver.conf")).unwrap().contains("BindIP = \"127.0.0.1\""));
} }
#[test]
fn sharing_also_allows_remote_coa_clients_and_closing_leaves_it() {
let (_d, root, meta) = setup();
let coa = root.join("Core/configs/modules/coa.conf");
fs::create_dir_all(coa.parent().unwrap()).unwrap();
fs::write(&coa, "CoA.Enable = 1
CoA.AllowRemoteClients = 0
").unwrap();
assert!(set_open(&root, &meta, true).unwrap());
assert!(fs::read_to_string(&coa).unwrap().contains("CoA.AllowRemoteClients = 1"));
assert!(fs::read_to_string(&coa).unwrap().contains("CoA.Enable = 1"));
assert!(set_open(&root, &meta, false).unwrap());
assert!(fs::read_to_string(&coa).unwrap().contains("CoA.AllowRemoteClients = 1"), "closing only changes BindIP");
}
#[test] #[test]
fn a_shared_server_gets_its_bind_address_back_before_start_and_a_local_one_is_left_alone() { fn a_shared_server_gets_its_bind_address_back_before_start_and_a_local_one_is_left_alone() {
let (_d, root, meta) = setup(); let (_d, root, meta) = setup();
+5 -2
View File
@@ -27,11 +27,14 @@ pub fn normalize_lexical(path: &Path) -> PathBuf {
fn key(path: &Path) -> Vec<String> { fn key(path: &Path) -> Vec<String> {
path.components() path.components()
.map(|c| c.as_os_str().to_string_lossy().to_lowercase()) .map(|c| {
let c = c.as_os_str().to_string_lossy();
if cfg!(windows) { c.to_lowercase() } else { c.into_owned() }
})
.collect() .collect()
} }
/// Case-insensitive component-wise prefix test (Windows semantics). /// Component-wise prefix test: case-insensitive on Windows, exact elsewhere (`/srv/CoA` and `/srv/coa` are two folders).
pub fn starts_with_ci(path: &Path, prefix: &Path) -> bool { pub fn starts_with_ci(path: &Path, prefix: &Path) -> bool {
let (p, q) = (key(path), key(prefix)); let (p, q) = (key(path), key(prefix));
p.len() >= q.len() && p[..q.len()] == q[..] p.len() >= q.len() && p[..q.len()] == q[..]
+93 -5
View File
@@ -101,19 +101,24 @@ pub struct ScanReport {
pub database_schemas: Vec<String>, pub database_schemas: Vec<String>,
pub client: Option<ClientInfo>, pub client: Option<ClientInfo>,
pub notes: Vec<String>, pub notes: Vec<String>,
/// When the chosen folder is not a server but a repack's main folder is right next to it (its parent, or a folder
/// inside it): the folder the person most likely meant.
pub suggested_path: Option<String>,
/// "not-repack": a server was found but it is not laid out like the CoA Repack the Manager works with.
pub hint: Option<&'static str>,
/// Always false: a scan never modifies anything. /// Always false: a scan never modifies anything.
pub modifies_files: bool, pub modifies_files: bool,
} }
fn exists(root: &Path, rel: &str) -> bool { pub(crate) fn exists(root: &Path, rel: &str) -> bool {
root.join(rel).exists() root.join(rel).exists()
} }
fn item(key: &'static str, label: &'static str, present: bool, detail: Option<String>) -> Item { pub(crate) fn item(key: &'static str, label: &'static str, present: bool, detail: Option<String>) -> Item {
Item { key, label, status: if present { Status::Found } else { Status::Missing }, detail } Item { key, label, status: if present { Status::Found } else { Status::Missing }, detail }
} }
fn hash_exe(path: &Path, release: Option<&ReleaseJson>, name: &str) -> Option<ExeInfo> { pub(crate) fn hash_exe(path: &Path, release: Option<&ReleaseJson>, name: &str) -> Option<ExeInfo> {
let meta = fs::metadata(path).ok()?; let meta = fs::metadata(path).ok()?;
if !meta.is_file() { if !meta.is_file() {
return None; return None;
@@ -187,7 +192,7 @@ pub fn detect_client(dir: &Path) -> Option<ClientInfo> {
None None
} }
fn count_bot_keys(conf: &Path) -> usize { pub(crate) fn count_bot_keys(conf: &Path) -> usize {
fs::read_to_string(conf) fs::read_to_string(conf)
.map(|t| t.lines().filter(|l| l.trim_start().starts_with("CoaBots.")).count()) .map(|t| t.lines().filter(|l| l.trim_start().starts_with("CoaBots.")).count())
.unwrap_or(0) .unwrap_or(0)
@@ -199,6 +204,9 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
return Err(crate::error::Error::Invalid(format!("{} is not a folder", root.display()))); return Err(crate::error::Error::Invalid(format!("{} is not a folder", root.display())));
} }
let root = fsx::canonicalize_lenient(root)?; let root = fsx::canonicalize_lenient(root)?;
if crate::docker::is_docker(&root) {
return crate::docker::scan(&root);
}
let mut notes = Vec::new(); let mut notes = Vec::new();
let release: Option<ReleaseJson> = fsx::read_json(&root.join("RELEASE.json")).ok(); let release: Option<ReleaseJson> = fsx::read_json(&root.join("RELEASE.json")).ok();
@@ -224,7 +232,10 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
.collect(); .collect();
database_schemas.sort(); database_schemas.sort();
let bot_conf = modules_dir.join("mod_coa_playerbots.conf"); // A fresh repack ships `mod_coa_playerbots.conf.dist` and only writes the active file when someone changes it.
let bot_active = modules_dir.join("mod_coa_playerbots.conf");
let bot_dist = modules_dir.join("mod_coa_playerbots.conf.dist");
let bot_conf = if bot_active.is_file() { bot_active } else { bot_dist };
let bot_config_keys = count_bot_keys(&bot_conf); let bot_config_keys = count_bot_keys(&bot_conf);
let banner_revision = banner_revision_in_log(&root.join("Core/Logs/Server.log")); let banner_revision = banner_revision_in_log(&root.join("Core/Logs/Server.log"));
@@ -294,6 +305,16 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
notes.push("This looks like a game client folder, not a server folder.".into()); notes.push("This looks like a game client folder, not a server folder.".into());
} }
let (suggested_path, hint) = if classification == Classification::Incompatible && !looks_like_client {
match find_repack_nearby(&root) {
Some(p) => (Some(p.to_string_lossy().into_owned()), None),
None if root.join("worldserver.exe").is_file() || has_exes => (None, Some("not-repack")),
None => (None, None),
}
} else {
(None, None)
};
Ok(ScanReport { Ok(ScanReport {
path: root.to_string_lossy().into_owned(), path: root.to_string_lossy().into_owned(),
classification, classification,
@@ -308,10 +329,34 @@ pub fn scan(root: &Path) -> Result<ScanReport> {
database_schemas, database_schemas,
client, client,
notes, notes,
suggested_path,
hint,
modifies_files: false, modifies_files: false,
}) })
} }
fn is_repack_root(p: &Path) -> bool {
p.join("Core/worldserver.exe").is_file() && p.join("Scripts/manage.py").is_file()
}
/// People often pick the `Core` folder (it holds worldserver.exe) or the folder an archive was unpacked into, with the real
/// server one level inside. Look at the parent, then at the folders inside (two levels), for the repack's main folder.
fn find_repack_nearby(root: &Path) -> Option<PathBuf> {
if let Some(parent) = root.parent() {
if is_repack_root(parent) {
return Some(parent.to_path_buf());
}
}
let subdirs = |dir: &Path| -> Vec<PathBuf> {
fs::read_dir(dir).map(|rd| rd.flatten().map(|e| e.path()).filter(|p| p.is_dir()).take(200).collect()).unwrap_or_default()
};
let first = subdirs(root);
if let Some(p) = first.iter().find(|p| is_repack_root(p)) {
return Some(p.clone());
}
first.iter().flat_map(|d| subdirs(d)).find(|p| is_repack_root(p))
}
/// Paths of the executables used by an installation, if present. /// Paths of the executables used by an installation, if present.
pub fn executables(root: &Path) -> (PathBuf, PathBuf, PathBuf) { pub fn executables(root: &Path) -> (PathBuf, PathBuf, PathBuf) {
(root.join("Core/worldserver.exe"), root.join("Core/authserver.exe"), root.join("mysql/bin/mysqld.exe")) (root.join("Core/worldserver.exe"), root.join("Core/authserver.exe"), root.join("mysql/bin/mysqld.exe"))
@@ -405,6 +450,49 @@ mod tests {
assert_eq!(scan(&root).unwrap().classification, Classification::UnknownCustom); assert_eq!(scan(&root).unwrap().classification, Classification::UnknownCustom);
} }
#[test]
fn the_core_folder_or_an_outer_folder_points_at_the_real_server_folder() {
let dir = tempfile::tempdir().unwrap();
let repack = dir.path().join("CoA-Repack");
testkit::fake_repack(&repack);
let core = scan(&repack.join("Core")).unwrap();
assert_eq!(core.classification, Classification::Incompatible);
assert!(Path::new(core.suggested_path.as_deref().unwrap()).ends_with("CoA-Repack"));
let outer = tempfile::tempdir().unwrap();
testkit::fake_repack(&outer.path().join("unpacked").join("CoA-Repack"));
let r = scan(outer.path()).unwrap();
assert_eq!(r.classification, Classification::Incompatible);
assert!(Path::new(r.suggested_path.as_deref().unwrap()).ends_with("CoA-Repack"), "found two levels down");
let healthy = scan(&repack).unwrap();
assert!(healthy.suggested_path.is_none() && healthy.hint.is_none());
}
#[test]
fn a_plain_azerothcore_folder_is_told_apart_from_a_wrong_folder() {
let dir = tempfile::tempdir().unwrap();
let plain = dir.path().join("acore");
fs::create_dir_all(&plain).unwrap();
fs::write(plain.join("worldserver.exe"), b"w").unwrap();
let r = scan(&plain).unwrap();
assert_eq!(r.classification, Classification::Incompatible);
assert!(r.suggested_path.is_none());
assert_eq!(r.hint, Some("not-repack"));
}
#[test]
fn the_companions_are_found_by_their_documented_default_file_when_no_active_one_exists() {
let dir = tempfile::tempdir().unwrap();
let root = dir.path().join("repack");
testkit::fake_repack(&root);
let modules = root.join("Core/configs/modules");
fs::rename(modules.join("mod_coa_playerbots.conf"), modules.join("mod_coa_playerbots.conf.dist")).unwrap();
let r = scan(&root).unwrap();
assert!(r.items.iter().any(|i| i.key == "companions" && i.status == Status::Found), "found through the .dist");
assert_eq!(r.bot_config_keys, 2);
}
#[test] #[test]
fn missing_folder_is_an_error_not_a_verdict() { fn missing_folder_is_an_error_not_a_verdict() {
assert!(scan(Path::new("C:/definitely/not/here")).is_err()); assert!(scan(Path::new("C:/definitely/not/here")).is_err());
+8
View File
@@ -1,10 +1,14 @@
pub mod accounts;
pub mod backup; pub mod backup;
pub mod cleanbase; pub mod cleanbase;
pub mod companions;
pub mod client; pub mod client;
pub mod clientdl;
pub mod config; pub mod config;
pub mod console; pub mod console;
pub mod db; pub mod db;
pub mod diag; pub mod diag;
pub mod docker;
pub mod download; pub mod download;
pub mod driver; pub mod driver;
pub mod error; pub mod error;
@@ -23,6 +27,10 @@ pub mod migrations;
pub mod net; pub mod net;
pub mod package; pub mod package;
pub mod ra; pub mod ra;
pub mod allsettings;
pub mod modules;
pub mod realmlist;
pub mod realms;
pub mod registry; pub mod registry;
pub mod release; pub mod release;
pub mod update; pub mod update;
+411
View File
@@ -0,0 +1,411 @@
//! Optional server modules. They are compiled into the server; what the owner decides is whether each one is on and how it is
//! configured, which lives in `Core/configs/modules/<module>.conf` (the documented defaults are in the `.dist` beside it).
//! The list of known modules is a bundled catalog, so a module is added to the Manager by adding a few lines to it.
use std::collections::BTreeMap;
use std::fs;
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use crate::config::parser::ConfFile;
use crate::error::{Error, Result};
use crate::fsx;
static CATALOG: &str = include_str!("../../../modules/catalog.json");
#[derive(Debug, Clone, Deserialize)]
pub struct Entry {
pub id: String,
pub name: String,
/// language code -> text; "en" is always there.
pub description: BTreeMap<String, String>,
pub repo: String,
/// File in `Core/configs/modules` that holds this module's settings.
pub conf: String,
/// The name an older server build gave that file (used when `conf` is not there).
#[serde(default)]
pub alt_conf: Option<String>,
/// The setting that switches the whole module on or off (1 / 0). Empty for a part that cannot be switched off.
#[serde(default)]
pub enable_key: String,
/// Can be turned on and off here. A part the game client needs to talk to the server is only configured.
#[serde(default = "yes")]
pub switchable: bool,
/// What the module is when its setting is not in the file: a server from before the setting existed runs it.
#[serde(default = "yes")]
pub default_on: bool,
/// How far along it is: `early` (experimental, may change or break), `beta` (works, still being tested) or
/// `release` (stable); `soon` is a place held for a module that is planned but not part of any build yet.
#[serde(default = "release")]
pub status: String,
/// Which icon the page draws (a name the page knows).
#[serde(default)]
pub icon: String,
/// A page of the Manager that only makes sense while the module is on (it is hidden while it is off).
#[serde(default)]
pub page: Option<String>,
/// Not shown on the Modules page; its settings are offered elsewhere (a server setting card).
#[serde(default)]
pub hidden: bool,
}
fn yes() -> bool {
true
}
fn release() -> String {
"release".into()
}
#[derive(Deserialize)]
struct Catalog {
modules: Vec<Entry>,
}
pub fn catalog() -> Vec<Entry> {
serde_json::from_str::<Catalog>(CATALOG).map(|c| c.modules).unwrap_or_default()
}
fn entry_in(cat: &[Entry], id: &str) -> Result<Entry> {
cat.iter().find(|e| e.id == id).cloned().ok_or_else(|| Error::Invalid("That module is not known to the Manager.".into()))
}
fn dir(root: &Path) -> PathBuf {
root.join("Core/configs/modules")
}
fn read(path: &Path) -> Option<ConfFile> {
fs::read(path).ok().and_then(|b| ConfFile::parse_bytes(&b).ok())
}
fn truthy(v: &str) -> bool {
matches!(v.trim().trim_matches('"').to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on")
}
#[derive(Debug, Serialize)]
pub struct ModuleView {
pub id: String,
pub name: String,
pub description: BTreeMap<String, String>,
pub repo: String,
/// The module's configuration is present on this server (otherwise it is not part of this server build).
pub installed: bool,
pub enabled: bool,
pub switchable: bool,
pub status: String,
pub icon: String,
pub page: Option<String>,
pub hidden: bool,
pub compatibility: String,
}
pub fn list(root: &Path) -> Vec<ModuleView> {
list_in(&catalog(), root)
}
/// The configuration file name this server uses for the module: the current one, or the name an older build gave it.
fn conf_name(root: &Path, e: &Entry) -> String {
let there = |n: &str| dir(root).join(n).is_file() || dir(root).join(format!("{n}.dist")).is_file();
if there(&e.conf) {
return e.conf.clone();
}
match &e.alt_conf {
Some(alt) if there(alt) => alt.clone(),
_ => e.conf.clone(),
}
}
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let wildcard = crate::realms::state(root).map(|s| s.active == crate::realms::Mode::Wildcard).unwrap_or(true);
cat.iter()
.cloned()
.map(|e| {
let name = conf_name(root, &e);
let conf = dir(root).join(&name);
let dist = dir(root).join(format!("{name}.dist"));
let installed = conf.is_file() || dist.is_file();
// the active file decides; without one the documented default is what the server will use
let enabled = !e.switchable
|| read(&conf).or_else(|| read(&dist)).and_then(|c| c.get(&e.enable_key).map(truthy)).unwrap_or(e.default_on);
let blocked = wildcard && matches!(e.id.as_str(), "companions" | "playerbots");
ModuleView {
compatibility: if blocked { "unsupported" } else if wildcard && e.id != "client-compat" { "experimental" } else { "compatible" }.into(),
id: e.id,
name: e.name,
description: e.description,
repo: e.repo,
installed,
enabled: enabled && !blocked,
switchable: e.switchable && !blocked,
status: e.status,
icon: e.icon,
page: e.page,
hidden: e.hidden,
}
})
.collect()
}
/// The active file, created from its `.dist` when it does not exist yet.
fn active_file(root: &Path, e: &Entry) -> Result<PathBuf> {
let name = conf_name(root, e);
let conf = dir(root).join(&name);
if !conf.is_file() {
let dist = dir(root).join(format!("{name}.dist"));
if !dist.is_file() {
return Err(Error::Invalid("This module is not part of this server.".into()));
}
fsx::atomic_write(&conf, &fs::read(&dist)?)?;
}
Ok(conf)
}
fn backup(meta: &Path, conf: &Path) -> Result<()> {
let name = conf.file_name().map(|n| n.to_string_lossy().into_owned()).unwrap_or_default();
let to = meta.join("backups").join("modules").join(format!("{name}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S")));
fsx::atomic_write(&to, &fs::read(conf)?)
}
pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
if on { crate::realms::guard_module(root, id)?; }
set_enabled_in(&catalog(), root, meta, id, on)
}
fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
let e = entry_in(cat, id)?;
if !e.switchable || e.enable_key.is_empty() {
return Err(Error::Invalid("This part cannot be switched off.".into()));
}
let conf = active_file(root, &e)?;
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
if file.get(&e.enable_key).map(truthy).unwrap_or(e.default_on) == on && file.get(&e.enable_key).is_some() {
return Ok(());
}
backup(meta, &conf)?;
file.set(&e.enable_key, if on { "1" } else { "0" }, &["Changed by CoA Server Manager"]);
fsx::atomic_write(&conf, file.to_text().as_bytes())?;
tracing::info!(module = id, on, "module switched");
Ok(())
}
#[derive(Debug, Serialize, PartialEq, Eq)]
pub struct Setting {
pub key: String,
pub value: String,
pub default: Option<String>,
/// The documentation the module ships above the setting.
pub doc: String,
}
/// Every active setting of the module with its current value, its documented default and its description.
pub fn settings(root: &Path, id: &str) -> Result<Vec<Setting>> {
settings_in(&catalog(), root, id)
}
fn settings_in(cat: &[Entry], root: &Path, id: &str) -> Result<Vec<Setting>> {
let e = entry_in(cat, id)?;
let name = conf_name(root, &e);
let conf = dir(root).join(&name);
let dist = read(&dir(root).join(format!("{name}.dist")));
let active = read(&conf).or_else(|| dist.clone()).ok_or_else(|| Error::Invalid("This module is not part of this server.".into()))?;
Ok(active
.entries()
.map(|(k, v)| Setting {
key: k.to_string(),
value: v.to_string(),
default: dist.as_ref().and_then(|d| d.get(k)).map(str::to_string),
doc: dist.as_ref().map(|d| d.doc_for(k)).filter(|d| !d.is_empty()).unwrap_or_else(|| active.doc_for(k)).join(" "),
})
.collect())
}
/// Change values of settings the module already has. A value is one line of at most 500 characters.
pub fn save_settings(root: &Path, meta: &Path, id: &str, changes: &BTreeMap<String, String>) -> Result<Vec<String>> {
crate::realms::guard_module(root, id)?;
save_settings_in(&catalog(), root, meta, id, changes)
}
fn save_settings_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, changes: &BTreeMap<String, String>) -> Result<Vec<String>> {
let e = entry_in(cat, id)?;
let conf = active_file(root, &e)?;
let mut file = ConfFile::parse_bytes(&fs::read(&conf)?)?;
let mut changed = Vec::new();
for (key, value) in changes {
let value = value.trim();
if file.get(key).is_none() {
return Err(Error::Invalid(format!("{key} is not a setting of this module.")));
}
if value.is_empty() || value.len() > 500 || value.chars().any(char::is_control) {
return Err(Error::Invalid(format!("The value of {key} must be one line of text.")));
}
if file.get(key).map(str::trim) != Some(value) {
changed.push((key.clone(), value.to_string()));
}
}
if changed.is_empty() {
return Ok(Vec::new());
}
backup(meta, &conf)?;
for (k, v) in &changed {
file.set(k, v, &[]);
}
fsx::atomic_write(&conf, file.to_text().as_bytes())?;
Ok(changed.into_iter().map(|(k, _)| k).collect())
}
#[cfg(test)]
mod tests {
use super::*;
fn test_catalog() -> Vec<Entry> {
let one = |id: &str, name: &str, conf: &str, key: &str| Entry {
id: id.into(),
name: name.into(),
description: ["en", "ru", "de", "fr", "es"].iter().map(|l| (l.to_string(), format!("{name} ({l})"))).collect(),
repo: format!("https://github.com/Corfirean/example/{id}"),
conf: conf.into(),
alt_conf: None,
enable_key: key.into(),
switchable: true,
default_on: true,
status: "beta".into(),
icon: String::new(),
page: None,
hidden: false,
};
vec![one("war-games", "War Games", "war_games.conf", "WarGames.Enable"), one("spellbook", "Spellbook", "spellbook.conf", "Spellbook.Enable")]
}
fn server(d: &Path) -> (PathBuf, PathBuf) {
let (root, meta) = (d.join("srv"), d.join("meta"));
let m = dir(&root);
fs::create_dir_all(&m).unwrap();
fs::create_dir_all(&meta).unwrap();
fs::write(m.join("war_games.conf.dist"), "# Turns War Games on.\r\n# Second line.\r\nWarGames.Enable = 1\r\n\r\n# How long a challenge stays open.\r\nWarGames.ChallengeSeconds = 60\r\n").unwrap();
(root, meta)
}
#[test]
fn the_bundled_catalog_is_valid() {
let c = catalog();
// it may be empty (modules are added to it one by one); whatever is in it must be complete
for e in &c {
assert!(e.description.contains_key("en") && e.description.len() == 5, "{} has all five descriptions", e.id);
assert!(e.repo.starts_with("https://github.com/") && e.conf.ends_with(".conf"), "{}", e.id);
assert!(!e.switchable || e.enable_key.ends_with(".Enable"), "{} needs the setting that switches it", e.id);
assert!(["soon", "early", "beta", "release"].contains(&e.status.as_str()), "{} has an unknown status", e.id);
assert!(e.status != "soon" || !e.switchable, "{} is only announced, so it cannot be switched", e.id);
}
let mut ids: Vec<_> = c.iter().map(|e| e.id.as_str()).collect();
ids.sort();
ids.dedup();
assert_eq!(ids.len(), c.len(), "ids are unique");
}
#[test]
fn a_module_is_listed_as_installed_with_its_documented_default_until_a_file_exists() {
let d = tempfile::tempdir().unwrap();
let (root, _) = server(d.path());
let wg = list_in(&test_catalog(), &root).into_iter().find(|m| m.id == "war-games").unwrap();
assert!(wg.installed && wg.enabled, "the .dist says 1");
assert!(!list_in(&test_catalog(), &root).into_iter().find(|m| m.id == "spellbook").unwrap().installed, "no configuration of that module on this server");
}
#[test]
fn the_content_scaling_switch_persists_the_master_flag_and_preserves_other_settings() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
let e = entry_in(&catalog(), "content-scaling").unwrap();
assert_eq!(e.enable_key, "CoAContentScaling.Enable");
let defaults = "CoAContentScaling.Enable = 1\nCoAContentScaling.ScaleItems = 1\nCoAContentScaling.GroupScaling.Enable = 1\n";
fs::write(dir(&root).join(format!("{}.dist", e.conf)), defaults).unwrap();
set_enabled(&root, &meta, &e.id, false).unwrap();
let active = read(&dir(&root).join(&e.conf)).unwrap();
assert_eq!(active.get("CoAContentScaling.Enable"), Some("0"));
assert_eq!(active.get("CoAContentScaling.ScaleItems"), Some("1"));
assert_eq!(active.get("CoAContentScaling.GroupScaling.Enable"), Some("1"));
assert!(!list(&root).into_iter().find(|m| m.id == e.id).unwrap().enabled);
set_enabled(&root, &meta, &e.id, true).unwrap();
assert_eq!(read(&dir(&root).join(&e.conf)).unwrap().get("CoAContentScaling.Enable"), Some("1"));
assert!(list(&root).into_iter().find(|m| m.id == e.id).unwrap().enabled);
}
#[test]
fn switching_a_module_creates_its_file_saves_the_old_one_and_changes_only_that_line() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
set_enabled_in(&test_catalog(), &root, &meta, "war-games", false).unwrap();
let conf = fs::read_to_string(dir(&root).join("war_games.conf")).unwrap();
assert!(conf.contains("WarGames.Enable = 0") && conf.contains("WarGames.ChallengeSeconds = 60"), "{conf}");
assert!(!list_in(&test_catalog(), &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled);
set_enabled_in(&test_catalog(), &root, &meta, "war-games", false).unwrap();
assert_eq!(fs::read_dir(meta.join("backups/modules")).unwrap().count(), 1, "no change, no backup");
set_enabled_in(&test_catalog(), &root, &meta, "war-games", true).unwrap();
assert!(fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("WarGames.Enable = 1"));
assert!(set_enabled_in(&test_catalog(), &root, &meta, "spellbook", true).is_err(), "not part of this server");
assert!(set_enabled_in(&test_catalog(), &root, &meta, "nonsense", true).is_err());
}
#[test]
fn settings_show_the_documentation_and_only_known_keys_with_one_line_values_can_be_saved() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
let s = settings_in(&test_catalog(), &root, "war-games").unwrap();
assert_eq!(s.len(), 2);
assert_eq!(s[1], Setting { key: "WarGames.ChallengeSeconds".into(), value: "60".into(), default: Some("60".into()), doc: "How long a challenge stays open.".into() });
assert_eq!(s[0].doc, "Turns War Games on. Second line.");
let ok = BTreeMap::from([("WarGames.ChallengeSeconds".to_string(), "90".to_string())]);
assert_eq!(save_settings_in(&test_catalog(), &root, &meta, "war-games", &ok).unwrap(), ["WarGames.ChallengeSeconds"]);
assert!(settings_in(&test_catalog(), &root, "war-games").unwrap()[1].value == "90");
assert!(save_settings_in(&test_catalog(), &root, &meta, "war-games", &ok).unwrap().is_empty(), "same value: nothing to do");
for bad in [("Other.Key", "1"), ("WarGames.ChallengeSeconds", ""), ("WarGames.ChallengeSeconds", "1\nInjected = 1")] {
let c = BTreeMap::from([(bad.0.to_string(), bad.1.to_string())]);
assert!(save_settings_in(&test_catalog(), &root, &meta, "war-games", &c).is_err(), "{bad:?}");
}
assert!(!fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("Injected"));
}
#[test]
fn an_older_file_name_is_used_when_the_current_one_is_missing_and_a_part_that_cannot_be_switched_stays_on() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
fs::write(dir(&root).join("old_name.conf"), "CoA.Enable = 0\r\nCoA.UnlockAllVanity = 1\r\n").unwrap();
let compat = Entry {
id: "compat".into(),
name: "Compat".into(),
description: ["en", "ru", "de", "fr", "es"].iter().map(|l| (l.to_string(), "x".to_string())).collect(),
repo: "https://github.com/Corfirean/x".into(),
conf: "coa.conf".into(),
alt_conf: Some("old_name.conf".into()),
enable_key: String::new(),
switchable: false,
default_on: true,
status: "release".into(),
icon: String::new(),
page: None,
hidden: false,
};
let cat = vec![compat];
let v = list_in(&cat, &root).remove(0);
assert!(v.installed && v.enabled && !v.switchable, "found under the old name, never reported as off");
assert_eq!(settings_in(&cat, &root, "compat").unwrap().len(), 2);
let change = BTreeMap::from([("CoA.UnlockAllVanity".to_string(), "0".to_string())]);
assert_eq!(save_settings_in(&cat, &root, &meta, "compat", &change).unwrap(), ["CoA.UnlockAllVanity"]);
assert!(fs::read_to_string(dir(&root).join("old_name.conf")).unwrap().contains("CoA.UnlockAllVanity = 0"));
assert!(set_enabled_in(&cat, &root, &meta, "compat", false).is_err(), "cannot be switched off");
}
#[test]
fn a_module_whose_setting_is_not_in_the_file_counts_as_on_and_can_be_switched_off() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
fs::write(dir(&root).join("war_games.conf"), "WarGames.ChallengeSeconds = 60\r\n").unwrap();
let cat = test_catalog();
assert!(list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled, "a missing key means the default (on)");
set_enabled_in(&cat, &root, &meta, "war-games", false).unwrap();
assert!(fs::read_to_string(dir(&root).join("war_games.conf")).unwrap().contains("WarGames.Enable = 0"));
assert!(!list_in(&cat, &root).into_iter().find(|m| m.id == "war-games").unwrap().enabled);
}
}
+6
View File
@@ -88,10 +88,16 @@ pub struct Tailscale {
pub connected: bool, pub connected: bool,
} }
#[cfg(windows)]
fn tailscale_exe() -> Option<PathBuf> { fn tailscale_exe() -> Option<PathBuf> {
["C:/Program Files/Tailscale/tailscale.exe", "C:/Program Files (x86)/Tailscale/tailscale.exe"].iter().map(PathBuf::from).find(|p| p.is_file()) ["C:/Program Files/Tailscale/tailscale.exe", "C:/Program Files (x86)/Tailscale/tailscale.exe"].iter().map(PathBuf::from).find(|p| p.is_file())
} }
#[cfg(not(windows))]
fn tailscale_exe() -> Option<PathBuf> {
["/usr/bin/tailscale", "/usr/local/bin/tailscale", "/usr/sbin/tailscale"].iter().map(PathBuf::from).find(|p| p.is_file())
}
pub fn parse_tailscale_ip(out: &str) -> Option<String> { pub fn parse_tailscale_ip(out: &str) -> Option<String> {
out.lines().map(str::trim).find(|l| l.parse::<Ipv4Addr>().map(is_cgnat_range).unwrap_or(false)).map(str::to_string) out.lines().map(str::trim).find(|l| l.parse::<Ipv4Addr>().map(is_cgnat_range).unwrap_or(false)).map(str::to_string)
} }
+36
View File
@@ -298,11 +298,15 @@ pub fn extract(parts_dir: &Path, manifest: &Manifest, dest: &Path, progress: &dy
let mut hasher = Sha256::new(); let mut hasher = Sha256::new();
let mut buf = vec![0u8; 1 << 20]; let mut buf = vec![0u8; 1 << 20];
let mut size = 0u64; let mut size = 0u64;
let mut head = Vec::with_capacity(4);
loop { loop {
let n = entry.read(&mut buf)?; let n = entry.read(&mut buf)?;
if n == 0 { if n == 0 {
break; break;
} }
if head.len() < 4 {
head.extend_from_slice(&buf[..n.min(4 - head.len())]);
}
size += n as u64; size += n as u64;
if size > want.size { if size > want.size {
return Err(Error::HashMismatch { path: rel, expected: format!("{} bytes", want.size), actual: "more".into() }); return Err(Error::HashMismatch { path: rel, expected: format!("{} bytes", want.size), actual: "more".into() });
@@ -315,6 +319,13 @@ pub fn extract(parts_dir: &Path, manifest: &Manifest, dest: &Path, progress: &dy
if size != want.size || !actual.eq_ignore_ascii_case(&want.sha256) { if size != want.size || !actual.eq_ignore_ascii_case(&want.sha256) {
return Err(Error::HashMismatch { path: rel, expected: want.sha256.clone(), actual }); return Err(Error::HashMismatch { path: rel, expected: want.sha256.clone(), actual });
} }
// The archive does not carry per-file modes, so a Linux binary or script would be extracted unusable.
// Recognise them by content (ELF header or `#!`); Windows has no execute bit and ignores this.
#[cfg(unix)]
if head.starts_with(b"\x7fELF") || head.starts_with(b"#!") {
use std::os::unix::fs::PermissionsExt;
fs::set_permissions(&target, fs::Permissions::from_mode(0o755))?;
}
done += size; done += size;
progress(done, archive.unpacked_size); progress(done, archive.unpacked_size);
} }
@@ -373,6 +384,31 @@ mod tests {
(d, src) (d, src)
} }
#[cfg(unix)]
#[test]
fn extract_makes_binaries_and_scripts_executable_and_nothing_else() {
use std::os::unix::fs::PermissionsExt;
let d = tempfile::tempdir().unwrap();
let src = d.path().join("src");
for (p, c) in [
("Core/worldserver", &b"\x7fELF\x02\x01\x01 binary"[..]),
("Scripts/tool.sh", &b"#!/bin/sh\necho hi\n"[..]),
("Core/configs/worldserver.conf.dist", &b"Setting = 1\n"[..]),
] {
let f = src.join(p);
fs::create_dir_all(f.parent().unwrap()).unwrap();
fs::write(f, c).unwrap();
}
let out = d.path().join("out");
let m = build(&src, &out, &opts(64 * 1024), &|_| {}).unwrap();
let dest = d.path().join("dest");
extract(&out, &m, &dest, &|_, _| {}).unwrap();
let mode = |p: &str| fs::metadata(dest.join(p)).unwrap().permissions().mode() & 0o111;
assert_ne!(mode("Core/worldserver"), 0, "ELF binary must be executable");
assert_ne!(mode("Scripts/tool.sh"), 0, "script with a shebang must be executable");
assert_eq!(mode("Core/configs/worldserver.conf.dist"), 0, "plain files stay non-executable");
}
#[test] #[test]
fn build_split_extract_roundtrip_excludes_noise_and_secrets() { fn build_split_extract_roundtrip_excludes_noise_and_secrets() {
let (d, src) = source(); let (d, src) = source();
+32 -4
View File
@@ -53,20 +53,48 @@ pub fn fetch_manifest(source: &Source, trusted_key: &str) -> Result<(Manifest, V
/// Make every archive part available in a verified folder: a local source is used in place, a remote one is /// Make every archive part available in a verified folder: a local source is used in place, a remote one is
/// downloaded (resumable) into `download_dir`. `report(fraction 0..1, speed_text)`. /// downloaded (resumable) into `download_dir`. `report(fraction 0..1, speed_text)`.
/// 1536 -> "1.5 KB", 6.3e9 -> "5.9 GB" (binary units, as drive sizes are shown).
pub fn human_bytes(n: u64) -> String {
let units = ["B", "KB", "MB", "GB", "TB"];
let mut v = n as f64;
let mut i = 0;
while v >= 1024.0 && i < units.len() - 1 {
v /= 1024.0;
i += 1;
}
if i == 0 || v >= 100.0 { format!("{} {}", v.round() as u64, units[i]) } else { format!("{v:.1} {}", units[i]) }
}
pub fn fetch_parts(source: &Source, manifest: &Manifest, download_dir: &Path, cancel: &Cancel, report: &dyn Fn(f64, Option<String>)) -> Result<PathBuf> { pub fn fetch_parts(source: &Source, manifest: &Manifest, download_dir: &Path, cancel: &Cancel, report: &dyn Fn(f64, Option<String>)) -> Result<PathBuf> {
let archive = manifest.archive.as_ref().ok_or_else(|| Error::InvalidManifest("manifest has no archive".into()))?; let archive = manifest.archive.as_ref().ok_or_else(|| Error::InvalidManifest("manifest has no archive".into()))?;
match source { match source {
Source::Dir(d) => Ok(d.clone()), Source::Dir(d) => Ok(d.clone()),
Source::Url(base) => { Source::Url(base) => {
let total = archive.parts.len(); let all: u64 = archive.parts.iter().map(|p| p.size).sum::<u64>().max(1);
for (i, part) in archive.parts.iter().enumerate() { let mut before = 0u64;
for part in archive.parts.iter() {
let job = Job { url: format!("{}/{}", base.trim_end_matches('/'), part.name), dest: download_dir.join(&part.name), sha256: part.sha256.clone(), size: part.size }; let job = Job { url: format!("{}/{}", base.trim_end_matches('/'), part.name), dest: download_dir.join(&part.name), sha256: part.sha256.clone(), size: part.size };
download::fetch(&job, cancel, &|p: Progress| { download::fetch(&job, cancel, &|p: Progress| {
let frac = (i as f64 + p.downloaded as f64 / p.total.max(1) as f64) / total as f64; let done = before + p.downloaded.min(part.size);
report(frac, Some(format!("{:.1} MB/s", p.bytes_per_sec as f64 / 1e6))); // language-neutral so the screen can show it as it is: "3.1 GB / 5.9 GB · 40.6 MB/s"
report(done as f64 / all as f64, Some(format!("{} / {} \u{b7} {:.1} MB/s", human_bytes(done), human_bytes(all), p.bytes_per_sec as f64 / 1e6)));
})?; })?;
before += part.size;
} }
Ok(download_dir.to_path_buf()) Ok(download_dir.to_path_buf())
} }
} }
} }
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn sizes_are_shown_in_binary_units() {
assert_eq!(human_bytes(0), "0 B");
assert_eq!(human_bytes(1536), "1.5 KB");
assert_eq!(human_bytes(6 * (1 << 30)), "6.0 GB");
assert_eq!(human_bytes(150 * (1 << 20)), "150 MB");
}
}
+3
View File
@@ -293,6 +293,9 @@ fn service(root: &Path, name: &'static str, exe: PathBuf, port: u16, listen: &[(
/// Snapshot the three services of an installation without touching anything. /// Snapshot the three services of an installation without touching anything.
pub fn observe(root: &Path, ports: &Ports) -> Observed { pub fn observe(root: &Path, ports: &Ports) -> Observed {
if crate::docker::is_docker(root) {
return crate::docker::observe(root, ports);
}
let listen = listeners(); let listen = listeners();
let (world, auth, mysql) = crate::layout::executables(root); let (world, auth, mysql) = crate::layout::executables(root);
Observed { Observed {
+173 -1
View File
@@ -6,7 +6,7 @@ use std::net::{SocketAddr, TcpStream};
use std::path::Path; use std::path::Path;
use std::time::Duration; use std::time::Duration;
use serde::Deserialize; use serde::{Deserialize, Serialize};
use crate::error::{Error, Result}; use crate::error::{Error, Result};
use crate::fsx; use crate::fsx;
@@ -91,15 +91,77 @@ impl Ra {
} }
} }
/// World update timing from the server's own `server info` report (mean/median/percentiles of the last 500 updates).
pub fn performance(&mut self) -> Result<Option<Performance>> {
let out = self.command("server info")?;
Ok(parse_server_info(&out))
}
fn bot_command(&mut self, cmd: &str) -> Result<String> {
let out = self.command(cmd)?;
if is_unsupported_command(&out) {
return Err(Error::CompanionCommandUnsupported);
}
Ok(out)
}
/// Drop every bot still waiting to be created. Returns how many were waiting.
pub fn cancel_spawning(&mut self) -> Result<u32> {
Ok(first_number(&self.bot_command("botcmd spawncancel")?))
}
/// Log every bot out without deleting anything. Returns how many were online.
pub fn despawn_all(&mut self) -> Result<u32> {
Ok(first_number(&self.bot_command("botcmd despawnall")?))
}
/// Log one bot out (the character stays saved). False when that bot was not online.
pub fn despawn_bot(&mut self, guid: u64) -> Result<bool> {
Ok(self.bot_command(&format!("botcmd despawn {guid}"))?.to_lowercase().contains("despawned"))
}
/// Log every bot out and delete every bot character for good (the caller saves a recovery point first).
pub fn purge_all(&mut self) -> Result<String> {
let out = self.bot_command("botcmd purgeall")?;
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Ask the bot module to create `count` leveling bots (throttled by the module itself). Only a number is sent. /// Ask the bot module to create `count` leveling bots (throttled by the module itself). Only a number is sent.
pub fn spawn_bots(&mut self, count: u32) -> Result<String> { pub fn spawn_bots(&mut self, count: u32) -> Result<String> {
if !(1..=2000).contains(&count) { if !(1..=2000).contains(&count) {
return Err(Error::Invalid("Choose between 1 and 2000 companions.".into())); return Err(Error::Invalid("Choose between 1 and 2000 companions.".into()));
} }
let out = self.command(&format!("botcmd spawnleveled {count}"))?; let out = self.command(&format!("botcmd spawnleveled {count}"))?;
if out.to_lowercase().contains("no usable template characters") {
return Err(Error::CompanionTemplatesMissing);
}
Ok(out.lines().last().unwrap_or("").to_string()) Ok(out.lines().last().unwrap_or("").to_string())
} }
/// Set a new password for an existing account.
pub fn set_account_password(&mut self, name: &str, password: &str) -> Result<()> {
validate_account(name, password)?;
let out = self.command(&format!("account set password {name} {password} {password}"))?;
account_reply(&out, "The password was not changed")
}
/// Access level of an account on all realms: 0 player, 1 moderator, 2 game master, 3 administrator.
pub fn set_account_access(&mut self, name: &str, level: u8) -> Result<()> {
validate_account(name, "placeholder")?;
if level > 3 {
return Err(Error::Invalid("The access level must be 0 to 3.".into()));
}
let out = self.command(&format!("account set gmlevel {name} {level} -1"))?;
account_reply(&out, "The access level was not changed")
}
/// Delete an account together with its characters (the console's `account delete`).
pub fn delete_account(&mut self, name: &str) -> Result<()> {
validate_account(name, "placeholder")?;
let out = self.command(&format!("account delete {name}"))?;
account_reply(&out, "The account was not deleted")
}
/// Give `name` administrator rights on all realms (GM level 3). /// Give `name` administrator rights on all realms (GM level 3).
pub fn make_administrator(&mut self, name: &str) -> Result<()> { pub fn make_administrator(&mut self, name: &str) -> Result<()> {
validate_account(name, "placeholder")?; validate_account(name, "placeholder")?;
@@ -112,6 +174,61 @@ impl Ra {
} }
} }
/// The console reports a failed account command in words; anything else (including silence) counts as done.
fn account_reply(out: &str, what: &str) -> Result<()> {
let l = out.to_lowercase();
let failed = ["does not exist", "not exist", "not found", "do not match", "don't match", "usage", "unknown", "incorrect", "error"];
if failed.iter().any(|m| l.contains(m)) {
return Err(Error::Invalid(format!("{what}: {}", out.lines().last().unwrap_or("").trim())));
}
Ok(())
}
/// The console answers an unknown sub-command with the list of the ones it knows.
fn is_unsupported_command(out: &str) -> bool {
let l = out.to_lowercase();
l.contains("possible subcommands") || l.contains("### usage") || l.contains("no such command") || l.contains("unknown command")
}
fn first_number(text: &str) -> u32 {
text.split(|c: char| !c.is_ascii_digit()).find(|t| !t.is_empty()).and_then(|t| t.parse().ok()).unwrap_or(0)
}
/// How fast the world loop is running, read from `server info`.
#[derive(Debug, Clone, Serialize, PartialEq)]
pub struct Performance {
pub mean_ms: u32,
pub median_ms: u32,
pub p95_ms: u32,
pub p99_ms: u32,
pub max_ms: u32,
/// World updates per second implied by the mean update time.
pub ticks_per_sec: f32,
}
fn ms(text: &str) -> Option<u32> {
text.trim().trim_end_matches("ms").trim().parse().ok()
}
pub fn parse_server_info(text: &str) -> Option<Performance> {
let (mut mean, mut median, mut pct) = (None, None, None);
for line in text.lines() {
let line = line.trim().trim_start_matches('|').trim_start_matches('-').trim();
if let Some(v) = line.strip_prefix("Mean:") {
mean = ms(v);
} else if let Some(v) = line.strip_prefix("Median:") {
median = ms(v);
} else if let Some(v) = line.strip_prefix("Percentiles (95, 99, max):") {
let p: Vec<Option<u32>> = v.split(',').map(ms).collect();
if p.len() == 3 {
pct = Some((p[0]?, p[1]?, p[2]?));
}
}
}
let (mean_ms, median_ms, (p95_ms, p99_ms, max_ms)) = (mean?, median?, pct?);
Some(Performance { mean_ms, median_ms, p95_ms, p99_ms, max_ms, ticks_per_sec: 1000.0 / mean_ms.max(1) as f32 })
}
/// Account names are letters/digits (3-17); passwords are 6-16 printable characters without spaces or quotes. /// Account names are letters/digits (3-17); passwords are 6-16 printable characters without spaces or quotes.
pub fn validate_account(name: &str, password: &str) -> Result<()> { pub fn validate_account(name: &str, password: &str) -> Result<()> {
let bad = |m: &str| Err(Error::Invalid(m.into())); let bad = |m: &str| Err(Error::Invalid(m.into()));
@@ -169,6 +286,31 @@ mod tests {
(port, h) (port, h)
} }
#[test]
fn an_unknown_bot_subcommand_is_recognised_and_numbers_are_read_from_replies() {
assert!(is_unsupported_command("### USAGE: .botcmd ...
Possible subcommands:
|- botcmd despawn"));
assert!(!is_unsupported_command("BotMgr: cancelled 35 queued bot spawn(s)."));
assert_eq!(first_number("BotMgr: cancelled 35 queued bot spawn(s)."), 35);
assert_eq!(first_number("nothing"), 0);
}
#[test]
fn server_info_timing_is_parsed_and_unrelated_text_is_ignored() {
let text = "AzerothCore rev. x
Connected players: 0. Characters in world: 0.
Update time diff: 1ms. Last 500 diffs summary:
|- Mean: 14ms
|- Median: 15ms
|- Percentiles (95, 99, max): 24ms, 30ms, 61ms
AC>";
let p = parse_server_info(text).unwrap();
assert_eq!((p.mean_ms, p.median_ms, p.p95_ms, p.p99_ms, p.max_ms), (14, 15, 24, 30, 61));
assert!((p.ticks_per_sec - 71.4).abs() < 0.2);
assert!(parse_server_info("Connected players: 0.").is_none());
}
#[test] #[test]
fn creates_an_account_over_ra_with_the_expected_commands() { fn creates_an_account_over_ra_with_the_expected_commands() {
let _lock = serial(); let _lock = serial();
@@ -179,6 +321,36 @@ mod tests {
assert_eq!(h.join().unwrap(), ["local", "secretra", "account create Player1 hunter22"]); assert_eq!(h.join().unwrap(), ["local", "secretra", "account create Player1 hunter22"]);
} }
#[test]
fn changes_a_password_with_the_expected_command() {
let _lock = serial();
let (port, h) = fake_ra("The password was changed");
let mut ra = Ra::connect_to(port, "u", "p").unwrap();
ra.set_account_password("Player1", "newpass9").unwrap();
drop(ra);
assert_eq!(h.join().unwrap()[2], "account set password Player1 newpass9 newpass9");
}
#[test]
fn changes_an_access_level_with_the_expected_command() {
let _lock = serial();
let (port, h) = fake_ra("You have changed security level of Player1 to 2.");
let mut ra = Ra::connect_to(port, "u", "p").unwrap();
ra.set_account_access("Player1", 2).unwrap();
assert!(ra.set_account_access("Player1", 4).is_err(), "only 0 to 3");
drop(ra);
assert_eq!(h.join().unwrap()[2], "account set gmlevel Player1 2 -1");
}
#[test]
fn a_failed_account_command_is_reported_and_bad_names_never_reach_the_console() {
let _lock = serial();
let (port, _h) = fake_ra("Account not found.");
let mut ra = Ra::connect_to(port, "u", "p").unwrap();
assert!(ra.set_account_password("x", "newpass9").is_err(), "the name is validated before anything is sent");
assert!(ra.set_account_password("Nobody", "newpass9").unwrap_err().to_string().contains("not found"));
}
#[test] #[test]
fn spawn_bots_sends_only_a_bounded_number() { fn spawn_bots_sends_only_a_bounded_number() {
let _lock = serial(); let _lock = serial();
+235
View File
@@ -0,0 +1,235 @@
//! Named realmlists for the game client ("Solo" for your own server, "PTR" for the shared one, ...). Choosing one writes its
//! text into the client's `Data/<locale>/realmlist.wtf` files; the file that was there is saved first. The profiles live
//! in the Manager's folder for the server, never in the client.
use std::fs;
use std::path::Path;
use serde::{Deserialize, Serialize};
use crate::client;
use crate::error::{Error, Result};
use crate::fsx;
const FILE: &str = "realmlists.json";
const MAX_PROFILES: usize = 24;
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
pub struct Profile {
pub id: String,
pub name: String,
/// The text of `realmlist.wtf` (normalised: `set <name> <value>` lines).
pub data: String,
}
#[derive(Debug, Default, Serialize, Deserialize)]
struct Store {
profiles: Vec<Profile>,
}
#[derive(Debug, Serialize)]
pub struct View {
pub profiles: Vec<Profile>,
/// The profile whose text every realmlist file of the client currently holds.
pub active: Option<String>,
}
fn compact(text: &str) -> String {
text.lines().map(|l| l.trim().to_ascii_lowercase()).filter(|l| !l.is_empty()).collect::<Vec<_>>().join("\n")
}
/// Accept either the whole file text or just an address ("play.example.com", "192.168.0.5:3724"), and make sure that
/// what is written into the client is nothing but `set <name> <value>` lines.
pub fn normalize(data: &str) -> Result<String> {
let bad = |m: &str| Err(Error::Invalid(m.into()));
let text = data.trim();
if text.is_empty() {
return bad("Enter the realmlist text or an address.");
}
if text.len() > 2000 {
return bad("That text is too long for a realmlist.");
}
let lines: Vec<String> = if !text.contains(char::is_whitespace) {
vec![format!("set realmlist {text}")]
} else {
text.lines().map(|l| l.trim().to_string()).filter(|l| !l.is_empty()).collect()
};
for line in &lines {
let mut parts = line.splitn(3, char::is_whitespace);
let (set, key, value) = (parts.next().unwrap_or(""), parts.next().unwrap_or(""), parts.next().unwrap_or("").trim());
if !set.eq_ignore_ascii_case("set") || key.is_empty() || value.is_empty() || !key.chars().all(|c| c.is_ascii_alphanumeric() || c == '_') {
return bad("Each line must look like: set realmlist 127.0.0.1");
}
if !value.chars().all(|c| c.is_ascii_graphic() || c == ' ') {
return bad("The realmlist may only use plain letters, digits and punctuation.");
}
if key.eq_ignore_ascii_case("realmlist") && !value.trim_matches('"').chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '-' | ':' | '_')) {
return bad("That address is not valid.");
}
}
Ok(lines.join("\r\n") + "\r\n")
}
fn slug(name: &str) -> String {
let s: String = name.to_ascii_lowercase().chars().map(|c| if c.is_ascii_alphanumeric() { c } else { '-' }).collect();
let s = s.trim_matches('-').to_string();
if s.is_empty() { "realm".into() } else { s }
}
fn load(meta: &Path, client_dir: Option<&Path>) -> Store {
let mut store: Store = fsx::read_json(&meta.join(FILE)).unwrap_or_default();
if store.profiles.is_empty() {
// First use: "Solo" for this computer, and what the client held before so that it can be switched back to.
store.profiles.push(Profile { id: "solo".into(), name: "Solo".into(), data: "set realmlist 127.0.0.1\r\n".into() });
if let Some(files) = client_dir.map(client::realmlist_files) {
if let Some(text) = files.iter().find_map(|f| fs::read_to_string(f).ok()) {
if let Ok(data) = normalize(&text) {
if compact(&data) != compact(&store.profiles[0].data) {
store.profiles.push(Profile { id: "previous".into(), name: "Previous".into(), data });
}
}
}
}
let _ = fsx::atomic_write_json(&meta.join(FILE), &store);
}
store
}
fn save_store(meta: &Path, store: &Store) -> Result<()> {
fsx::atomic_write_json(&meta.join(FILE), store)
}
pub fn view(meta: &Path, client_dir: Option<&Path>) -> View {
let store = load(meta, client_dir);
let active = client_dir.and_then(|c| {
let files = client::realmlist_files(c);
let texts: Vec<String> = files.iter().filter_map(|f| fs::read_to_string(f).ok()).map(|t| compact(&t)).collect();
let first = texts.first()?;
if texts.iter().any(|t| t != first) {
return None;
}
store.profiles.iter().find(|p| compact(&p.data) == *first).map(|p| p.id.clone())
});
View { profiles: store.profiles, active }
}
/// Add a profile (`id` None) or change one. Names are 1-32 characters and unique regardless of capitals.
pub fn save_profile(meta: &Path, client_dir: Option<&Path>, id: Option<&str>, name: &str, data: &str) -> Result<Profile> {
let name = name.trim();
if name.is_empty() || name.chars().count() > 32 || name.chars().any(char::is_control) {
return Err(Error::Invalid("The name must be 1 to 32 characters.".into()));
}
let data = normalize(data)?;
let mut store = load(meta, client_dir);
if store.profiles.iter().any(|p| p.name.eq_ignore_ascii_case(name) && Some(p.id.as_str()) != id) {
return Err(Error::Invalid("A realmlist with that name already exists.".into()));
}
let profile = match id {
Some(id) => {
let p = store.profiles.iter_mut().find(|p| p.id == id).ok_or_else(|| Error::Invalid("That realmlist does not exist.".into()))?;
p.name = name.to_string();
p.data = data;
p.clone()
}
None => {
if store.profiles.len() >= MAX_PROFILES {
return Err(Error::Invalid("There are too many realmlists; remove one first.".into()));
}
let mut new_id = slug(name);
while store.profiles.iter().any(|p| p.id == new_id) {
new_id.push('-');
}
let p = Profile { id: new_id, name: name.to_string(), data };
store.profiles.push(p.clone());
p
}
};
save_store(meta, &store)?;
Ok(profile)
}
pub fn delete_profile(meta: &Path, client_dir: Option<&Path>, id: &str) -> Result<()> {
let mut store = load(meta, client_dir);
if store.profiles.len() <= 1 {
return Err(Error::Invalid("The last realmlist cannot be removed.".into()));
}
store.profiles.retain(|p| p.id != id);
save_store(meta, &store)
}
/// Write the profile into the client; returns the files that changed (each was saved to the backup folder first).
pub fn activate(meta: &Path, client_dir: &Path, id: &str) -> Result<Vec<String>> {
let store = load(meta, Some(client_dir));
let profile = store.profiles.iter().find(|p| p.id == id).ok_or_else(|| Error::Invalid("That realmlist does not exist.".into()))?;
client::write_realmlist(client_dir, meta, &profile.data)
}
#[cfg(test)]
mod tests {
use super::*;
fn fake_client(d: &Path, host: &str) -> std::path::PathBuf {
let c = d.join("wow");
for loc in ["enUS", "ruRU"] {
fs::create_dir_all(c.join("Data").join(loc)).unwrap();
fs::write(c.join("Data").join(loc).join("realmlist.wtf"), format!("set realmlist {host}\r\nset patchlist x.example\r\n")).unwrap();
}
fs::write(c.join("Ascension.exe"), b"exe").unwrap();
c
}
#[test]
fn an_address_or_whole_lines_are_accepted_and_anything_else_is_not() {
assert_eq!(normalize("play.example.com").unwrap(), "set realmlist play.example.com\r\n");
assert_eq!(normalize("SET realmlist 192.168.0.5:3724\nset patchlist x.example\n").unwrap(), "SET realmlist 192.168.0.5:3724\r\nset patchlist x.example\r\n");
for bad in ["", " ", "rm -rf /", "set realmlist bad host;calc", "set realmlist", "x\ny", "set realmlist a\"b", &"a".repeat(2100)] {
assert!(normalize(bad).is_err(), "{bad:?}");
}
}
#[test]
fn the_first_use_offers_solo_and_what_the_client_had_and_the_active_one_is_recognised() {
let d = tempfile::tempdir().unwrap();
let (c, meta) = (fake_client(d.path(), "ptr.example.org"), d.path().join("meta"));
fs::create_dir_all(&meta).unwrap();
let v = view(&meta, Some(&c));
assert_eq!(v.profiles.iter().map(|p| p.name.as_str()).collect::<Vec<_>>(), ["Solo", "Previous"]);
assert_eq!(v.active.as_deref(), Some("previous"), "the files hold exactly what was captured");
assert!(activate(&meta, &c, "previous").unwrap().is_empty(), "already what the files hold");
assert_eq!(fs::read_to_string(c.join("Data/enUS/realmlist.wtf")).unwrap(), "set realmlist ptr.example.org\r\nset patchlist x.example\r\n");
}
#[test]
fn switching_writes_every_locale_saves_the_old_file_and_changes_nothing_else() {
let d = tempfile::tempdir().unwrap();
let (c, meta) = (fake_client(d.path(), "ptr.example.org"), d.path().join("meta"));
fs::create_dir_all(&meta).unwrap();
fs::write(c.join("WTF.txt"), b"mine").unwrap();
let ptr = save_profile(&meta, Some(&c), None, "PTR", "ptr.example.org").unwrap();
let changed = activate(&meta, &c, "solo").unwrap();
assert_eq!(changed.len(), 2);
for loc in ["enUS", "ruRU"] {
assert_eq!(fs::read_to_string(c.join("Data").join(loc).join("realmlist.wtf")).unwrap(), "set realmlist 127.0.0.1\r\n");
}
assert_eq!(view(&meta, Some(&c)).active.as_deref(), Some("solo"));
assert_eq!(fs::read_dir(meta.join("backups/client")).unwrap().count(), 2, "each replaced file was saved");
activate(&meta, &c, &ptr.id).unwrap();
assert_eq!(view(&meta, Some(&c)).active.as_deref(), Some(ptr.id.as_str()));
assert_eq!(fs::read(c.join("WTF.txt")).unwrap(), b"mine");
}
#[test]
fn names_are_unique_profiles_can_be_edited_and_the_last_one_stays() {
let d = tempfile::tempdir().unwrap();
let meta = d.path().join("meta");
fs::create_dir_all(&meta).unwrap();
let a = save_profile(&meta, None, None, "PTR", "ptr.example.org").unwrap();
assert!(save_profile(&meta, None, None, "ptr", "other.example.org").is_err(), "names are unique regardless of capitals");
let edited = save_profile(&meta, None, Some(&a.id), "PTR 2", "ptr2.example.org").unwrap();
assert_eq!((edited.id.as_str(), edited.data.as_str()), (a.id.as_str(), "set realmlist ptr2.example.org\r\n"));
assert!(save_profile(&meta, None, None, "", "x.example.org").is_err());
delete_profile(&meta, None, &a.id).unwrap();
assert!(delete_profile(&meta, None, "solo").is_err(), "one profile must remain");
assert_eq!(view(&meta, None).profiles.len(), 1);
}
}
+371
View File
@@ -0,0 +1,371 @@
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use serde::{Deserialize, Serialize};
use crate::config::parser::ConfFile;
use crate::db::{Account, Db};
use crate::error::{Error, Result};
use crate::{fsx, layout, process};
const STATE: &str = "Settings/realm-profile.json";
const JOURNAL: &str = "Settings/realm-switch.json";
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Mode {
#[default]
Coa,
Wildcard,
}
impl Mode {
pub fn name(self) -> &'static str {
match self { Self::Coa => "coa", Self::Wildcard => "wildcard" }
}
pub fn realm_id(self) -> u32 { if self == Self::Coa { 1 } else { 2 } }
pub fn schema(self, kind: &str) -> Result<&'static str> {
match (self, kind) {
(_, "auth") => Ok("acore_auth"),
(Self::Coa, "characters") => Ok("acore_characters"),
(Self::Coa, "world") => Ok("acore_world"),
(Self::Wildcard, "characters") => Ok("acore_characters_wildcard"),
(Self::Wildcard, "world") => Ok("acore_world_wildcard"),
_ => Err(Error::Invalid("Unknown realm database.".into())),
}
}
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RealmState {
pub active: Mode,
pub wildcard_created: bool,
}
#[derive(Debug, Serialize)]
pub struct View {
pub active: Mode,
pub wildcard_created: bool,
pub supported: bool,
pub recovery_pending: bool,
}
pub fn state(root: &Path) -> Result<RealmState> {
if !root.join(STATE).exists() { return Ok(RealmState::default()); }
fsx::read_json(&root.join(STATE))
}
pub fn view(root: &Path) -> Result<View> {
let s = state(root)?;
// Inspect the binary itself; templates or an old log cannot prove installed support.
let supported = fs::read(root.join("Core/worldserver.exe"))?
.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings");
Ok(View { active: s.active, wildcard_created: s.wildcard_created, supported, recovery_pending: root.join(JOURNAL).exists() })
}
pub fn guard_module(root: &Path, id: &str) -> Result<()> {
if state(root)?.active == Mode::Wildcard && matches!(id, "companions" | "playerbots") {
return Err(Error::Invalid("CoA companion class mechanics have not been validated for Wildcard. This module is unavailable on this realm.".into()));
}
Ok(())
}
type Files = BTreeMap<String, Vec<u8>>;
fn configs(root: &Path) -> Result<Files> {
let mut files = Files::new();
for rel in crate::backup::config_files(root) {
if rel.starts_with("Core/configs/") && rel.ends_with(".conf")
|| rel.starts_with("Settings/") && rel.ends_with(".template") {
files.insert(rel.clone(), fs::read(fsx::safe_join(root, &rel)?)?);
}
}
Ok(files)
}
fn snapshot(root: &Path, mode: Mode) -> std::path::PathBuf {
root.join(format!("Settings/realm-profiles/{}.json", mode.name()))
}
fn write_configs(root: &Path, files: &Files) -> Result<()> {
for rel in configs(root)?.keys() {
if !files.contains_key(rel) { fs::remove_file(fsx::safe_join(root, rel)?)?; }
}
for (rel, bytes) in files {
if !(rel.starts_with("Core/configs/") && rel.ends_with(".conf")
|| rel.starts_with("Settings/") && rel.ends_with(".template")) {
return Err(Error::Invalid("Invalid realm configuration path.".into()));
}
fsx::atomic_write(&fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?, bytes)?;
}
Ok(())
}
fn set(files: &mut Files, path: &str, key: &str, value: &str) -> Result<()> {
let mut conf = ConfFile::parse_bytes(files.entry(path.into()).or_insert_with(|| b"[worldserver]\n".to_vec()))?;
conf.set(key, value, &[]);
files.insert(path.into(), conf.to_text().into_bytes());
Ok(())
}
fn wildcard_configs(mut files: Files) -> Result<Files> {
for (key, value) in [
("CoA.ClassModel", "\"hero\""), ("CoA.GameModeMask", "64"),
("CoA.MapClass10ToWarrior", "0"), ("CoA.RealmType", "\"live seasonal\""),
("CoA.ClientBooleanConfigs", "\"CONFIG_LEGACY_CHARACTER_ADVANCEMENT_ENABLED=0\""),
] { set(&mut files, "Core/configs/modules/coa.conf", key, value)?; }
set(&mut files, "Core/configs/modules/mod-coa-challenges.conf", "CoAChallenges.GameModes.Realm", "WildCard")?;
set(&mut files, "Core/configs/modules/mod-coa-challenges.conf", "CoAChallenges.GameModes.Enable", "1")?;
for (key, value) in [("ChancePercent", "65"), ("LinkWeight", "3"), ("RelatedWeight", "2"), ("SpecTagWeight", "2"), ("SchoolTagWeight", "1"), ("TooltipWeight", "3"), ("TalentsNeedTarget", "1"), ("LogRolls", "1")] {
set(&mut files, "Core/configs/modules/wildcard.conf", &format!("Wildcard.Synergy.{key}"), value)?;
}
for path in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
if files.contains_key(path) {
for (key, value) in [("RealmID", "2"), ("AlwaysMaxSkillForLevel", "1"), ("PlayerStart.CustomSpells", "1")] {
set(&mut files, path, key, value)?;
}
}
}
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", key, value)?;
}
Ok(files)
}
#[derive(Serialize, Deserialize)]
struct Journal { before: RealmState, files: Files }
fn require_world_stopped(root: &Path) -> Result<()> {
let observed = process::observe(root, &layout::read_ports(root));
if observed.world.state != process::ServiceState::Stopped || observed.auth.state != process::ServiceState::Stopped {
return Err(Error::Invalid("Stop the server before switching realms. Your characters will be saved.".into()));
}
Ok(())
}
pub fn recover(root: &Path) -> Result<()> {
if !root.join(JOURNAL).exists() { return Ok(()); }
require_world_stopped(root)?;
let journal: Journal = fsx::read_json(&root.join(JOURNAL))?;
write_configs(root, &journal.files)?;
fsx::atomic_write_json(&root.join(STATE), &journal.before)?;
fs::remove_file(root.join(JOURNAL))?;
Ok(())
}
fn create_databases(root: &Path) -> Result<()> {
crate::backup::with_database(root, |_| {
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
if db.query("SELECT COUNT(*) FROM acore_auth.realmlist WHERE id=2;")? != "0" {
return Err(Error::Invalid("Realm ID 2 is already in use. Its settings were left intact.".into()));
}
for kind in ["world", "characters"] {
let source = Mode::Coa.schema(kind)?;
let dest = Mode::Wildcard.schema(kind)?;
if db.schema_exists(dest)? {
return Err(Error::Invalid(format!("Database {dest} already exists. It was left intact; inspect it before creating a realm.")));
}
if db.extra_objects(source)? != 0 {
return Err(Error::Invalid("Realm creation does not support databases with routines, triggers or views.".into()));
}
}
for (schema, tables) in [
("acore_world", &["ascension_wildcard_boss_marks", "ascension_wildcard_tooltip_links"][..]),
("acore_characters", &["coa_wildcard_skill_card", "coa_wildcard_skill_card_pending", "coa_wildcard_skill_card_account", "coa_wildcard_skill_card_purchase", "coa_wildcard_specialization_cache"][..]),
] {
let present = db.tables(schema)?;
if tables.iter().any(|table| !present.iter().any(|p| p == table)) {
return Err(Error::Invalid("Wildcard database migrations are missing. Update the server database before creating this realm.".into()));
}
}
let cache = root.join("Settings/realm-profiles/staging");
fs::create_dir_all(&cache)?;
fsx::require_space(&cache, db.schema_bytes("acore_world")?.saturating_mul(2) + 512 * 1024 * 1024)?;
let dump = cache.join("world.sql.zst");
db.dump_to("acore_world", &dump)?;
let stage_world = format!("coa_realm_world_{}", uuid::Uuid::new_v4().simple());
let stage_chars = format!("coa_realm_chars_{}", uuid::Uuid::new_v4().simple());
db.query(&format!("CREATE DATABASE `{stage_world}` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; CREATE DATABASE `{stage_chars}` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"))?;
db.import_from(&stage_world, &dump)?;
db.clone_structure("acore_characters", &stage_chars, &cache)?;
for table in ["active_arena_season", "addons", "updates", "updates_include", "warden_action"] {
db.query(&format!("INSERT INTO `{stage_chars}`.`{table}` SELECT * FROM acore_characters.`{table}`;"))?;
}
// The newly empty realm inherits schema migration history, never the owner's characters or cards.
if db.tables("acore_world")?.iter().any(|t| t == "coa_manager_migrations") {
db.query(&format!("CREATE TABLE IF NOT EXISTS `{stage_world}`.coa_manager_migrations LIKE acore_world.coa_manager_migrations;"))?;
}
db.query("CREATE DATABASE acore_world_wildcard CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; CREATE DATABASE acore_characters_wildcard CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;")?;
let mut renames = Vec::new();
for (stage, dest) in [(&stage_world, "acore_world_wildcard"), (&stage_chars, "acore_characters_wildcard")] {
for table in db.tables(stage)? {
if !crate::db::valid_identifier(&table) { return Err(Error::Invalid("Unsupported table name.".into())); }
renames.push(format!("`{stage}`.`{table}` TO `{dest}`.`{table}`"));
}
}
db.query(&format!("RENAME TABLE {};", renames.join(", ")))?;
for host in db.query("SELECT host FROM mysql.user WHERE user='acore';")?.lines() {
let host = hex::encode(host.as_bytes());
// Host names are trusted database data, but still quote them through a hex SQL literal.
db.query(&format!("SET @host=CONVERT(UNHEX('{host}') USING utf8mb4); SET @grant=CONCAT('GRANT ALL ON acore_world_wildcard.* TO ', QUOTE('acore'), '@', QUOTE(@host)); PREPARE realm_grant FROM @grant; EXECUTE realm_grant; DEALLOCATE PREPARE realm_grant; SET @grant=CONCAT('GRANT ALL ON acore_characters_wildcard.* TO ', QUOTE('acore'), '@', QUOTE(@host)); PREPARE realm_grant FROM @grant; EXECUTE realm_grant; DEALLOCATE PREPARE realm_grant;"))?;
}
db.query(&format!("DROP DATABASE `{stage_world}`; DROP DATABASE `{stage_chars}`;"))?;
fs::remove_file(&dump)?;
Ok(())
})
}
pub fn select(root: &Path, mode: Mode) -> Result<View> {
require_world_stopped(root)?;
recover(root)?;
let mut s = state(root)?;
if mode == s.active { return view(root); }
if mode == Mode::Wildcard && !view(root)?.supported {
return Err(Error::Invalid("Update the server to a build with Wildcard support first.".into()));
}
// Verify launcher support before creating databases or changing the selected realm.
prepare_launcher(root)?;
let before = configs(root)?;
fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
if mode == Mode::Wildcard && !s.wildcard_created {
fsx::atomic_write_json(&snapshot(root, mode), &wildcard_configs(before.clone())?)?;
create_databases(root)?;
s.wildcard_created = true;
fsx::atomic_write_json(&root.join(STATE), &s)?;
}
let target: Files = fsx::read_json(&snapshot(root, mode))?;
// The launcher and batch files share this lock; recheck after the potentially long database copy.
fs::create_dir_all(root.join(".state"))?;
let lock = fs::OpenOptions::new().read(true).write(true).create(true).truncate(false).open(root.join(".state/control.lock"))?;
fs4::fs_std::FileExt::try_lock_exclusive(&lock).map_err(|_| Error::Invalid("Another start/stop action is in progress.".into()))?;
require_world_stopped(root)?;
let original = state(root)?;
fsx::atomic_write_json(&root.join(JOURNAL), &Journal { before: original, files: before })?;
let result = (|| {
write_configs(root, &target)?;
s.active = mode;
fsx::atomic_write_json(&root.join(STATE), &s)?;
Ok(())
})();
if let Err(e) = result { drop(lock); recover(root)?; return Err(e); }
fs::remove_file(root.join(JOURNAL))?;
view(root)
}
/// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic.
pub fn prepare_launcher(root: &Path) -> Result<()> {
let path = root.join("Scripts/manage.py");
let source = fs::read_to_string(&path)?;
let patched = patch_launcher(&source)?;
if patched != source { fsx::atomic_write(&path, patched.as_bytes())?; }
Ok(())
}
fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v1") { return Ok(source.into()); }
let replacements = [
("(\"WorldDatabaseInfo\", \"acore_world\")", "(\"WorldDatabaseInfo\", \"acore_world_wildcard\" if coa_realm() == 'wildcard' else \"acore_world\")"),
("(\"CharacterDatabaseInfo\", \"acore_characters\")", "(\"CharacterDatabaseInfo\", \"acore_characters_wildcard\" if coa_realm() == 'wildcard' else \"acore_characters\")"),
("SET name='AzerothCore',address=", "SET name='{coa_realm_name()}',address="),
("WHERE id=1;", "WHERE id={coa_realm_id()};"),
("mysql(\"UPDATE acore_auth.realmlist SET flag=0", "mysql(f\"UPDATE acore_auth.realmlist SET flag=0"),
];
let mut out = source.to_string();
for (from, to) in replacements {
if !out.contains(from) { return Err(Error::Invalid("This launcher does not support realm profiles. Update the server package first.".into())); }
out = out.replace(from, to);
}
let insert = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
// Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) { return Err(Error::Invalid("Unrecognised server launcher entry point.".into())); }
Ok(out.replace(marker, &format!("{insert}{marker}")))
}
pub fn before_start(root: &Path) -> Result<()> {
recover(root)?;
let s = state(root)?;
if !root.join(STATE).exists() { return Ok(()); }
prepare_launcher(root)?;
if s.active == Mode::Wildcard {
if !view(root)?.supported { return Err(Error::Invalid("The installed server build does not support Wildcard.".into())); }
let path = root.join("Core/configs/modules/mod_coa_playerbots.conf");
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("CoaBots.Enable", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
}
Ok(())
}
pub fn setup_realmlist(root: &Path) -> Result<()> {
let s = state(root)?;
if !root.join(STATE).exists() || !s.wildcard_created { return Ok(()); }
let db = Db::from_repack(root, Account::Admin)?;
let port = layout::read_ports(root).world;
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT 2,'Wildcard',address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port}; UPDATE acore_auth.realmlist SET flag=2 WHERE id IN (1,2) AND id<>{};", s.active.realm_id()))?;
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn fresh_wildcard_disables_bots_and_preserves_scaling() {
let mut f = Files::new();
f.insert("Core/configs/modules/mod-coa-content-scaling.conf".into(), b"[worldserver]\nCoAContentScaling.Enable = 1\n".to_vec());
f.insert("Settings/worldserver.conf.template".into(), b"[worldserver]\nRealmID = 1\n".to_vec());
let w = wildcard_configs(f.clone()).unwrap();
assert_eq!(w["Core/configs/modules/mod-coa-content-scaling.conf"], f["Core/configs/modules/mod-coa-content-scaling.conf"]);
let c = ConfFile::parse_bytes(&w["Core/configs/modules/mod_coa_playerbots.conf"]).unwrap();
assert_eq!(c.get("CoaBots.Enable"), Some("0"));
assert_eq!(ConfFile::parse_bytes(&w["Settings/worldserver.conf.template"]).unwrap().get("RealmID"), Some("2"));
}
#[test]
fn corrupt_state_is_not_silently_treated_as_coa() {
let t = tempfile::tempdir().unwrap();
fs::create_dir(t.path().join("Settings")).unwrap();
fs::write(t.path().join(STATE), "broken").unwrap();
assert!(state(t.path()).is_err());
}
#[test]
fn recovery_restores_original_settings() {
let t = tempfile::tempdir().unwrap();
let mut files = Files::new();
files.insert("Core/configs/modules/coa.conf".into(), b"CoA.ClassModel = coa\n".to_vec());
fsx::atomic_write_json(&t.path().join(JOURNAL), &Journal { before: RealmState::default(), files }).unwrap();
recover(t.path()).unwrap();
assert_eq!(state(t.path()).unwrap().active, Mode::Coa);
assert_eq!(fs::read_to_string(t.path().join("Core/configs/modules/coa.conf")).unwrap(), "CoA.ClassModel = coa\n");
assert!(!t.path().join(JOURNAL).exists());
}
#[test]
fn reverting_to_coa_removes_wildcard_only_config_files() {
let t = tempfile::tempdir().unwrap();
let mut coa = Files::new();
coa.insert("Core/configs/modules/coa.conf".into(), b"[worldserver]\nCoA.ClassModel = coa\n".to_vec());
let wildcard = wildcard_configs(coa.clone()).unwrap();
write_configs(t.path(), &wildcard).unwrap();
write_configs(t.path(), &coa).unwrap();
assert!(!t.path().join("Core/configs/modules/mod-coa-challenges.conf").exists());
assert_eq!(configs(t.path()).unwrap(), coa);
}
#[test]
fn wildcard_blocks_bot_settings_and_enable_calls() {
let t = tempfile::tempdir().unwrap();
fsx::atomic_write_json(&t.path().join(STATE), &RealmState { active: Mode::Wildcard, wildcard_created: true }).unwrap();
assert!(crate::modules::set_enabled(t.path(), t.path(), "companions", true).is_err());
assert!(crate::config::save(t.path(), t.path(), crate::config::Scope::Bots, &BTreeMap::new()).is_err());
assert!(guard_module(t.path(), "content-scaling").is_ok());
}
#[test]
fn unknown_launcher_is_refused_without_partial_patching() {
assert!(patch_launcher("print('custom launcher')").is_err());
}
}
+2 -1
View File
@@ -267,6 +267,7 @@ mod tests {
fn drive_root_and_missing_folder_are_rejected() { fn drive_root_and_missing_folder_are_rejected() {
let meta = InstallMeta::new(InstallKind::New, Path::new("C:/nope")); let meta = InstallMeta::new(InstallKind::New, Path::new("C:/nope"));
assert!(MetaDir::create(Path::new("C:/definitely/missing/folder"), &meta).is_err()); assert!(MetaDir::create(Path::new("C:/definitely/missing/folder"), &meta).is_err());
assert!(metadata_dir_for(Path::new("C:/")).is_err()); let root = if cfg!(windows) { "C:/" } else { "/" };
assert!(metadata_dir_for(Path::new(root)).is_err());
} }
} }
+29 -3
View File
@@ -476,14 +476,40 @@ impl Env for RepackEnv<'_> {
fn migrate(&self, manifest: &Manifest, staged: &Path) -> Result<ApplyReport> { fn migrate(&self, manifest: &Manifest, staged: &Path) -> Result<ApplyReport> {
let (root, meta) = (self.root, self.meta_dir); let (root, meta) = (self.root, self.meta_dir);
crate::backup::with_database(root, |db| { crate::backup::with_database(root, |db| {
crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| { let realms = crate::realms::state(root)?;
Ok(crate::backup::create(root, meta, crate::backup::Kind::Database, crate::backup::Trigger::BeforeMigration, None, &|_| {})?.id) let mut result = crate::migrations::apply_pending(db, &manifest.migrations, staged, &|| {
}) Ok(crate::backup::create(root, meta, crate::backup::Kind::Full, crate::backup::Trigger::BeforeMigration, None, &|_| {})?.id)
})?;
if realms.wildcard_created && result.failed.is_none() {
let other = if realms.active == crate::realms::Mode::Coa { crate::realms::Mode::Wildcard } else { crate::realms::Mode::Coa };
let other_db = db.clone().for_realm(other);
let shared_snapshot = result.snapshot.clone();
let migrations: Vec<_> = manifest.migrations.iter().filter(|m| m.db != "auth").cloned().collect();
let extra = crate::migrations::apply_pending(&other_db, &migrations, staged, &|| {
if let Some(id) = &shared_snapshot { return Ok(id.clone()); }
Ok(crate::backup::create(root, meta, crate::backup::Kind::Full, crate::backup::Trigger::BeforeMigration, None, &|_| {})?.id)
})?;
result.applied.extend(extra.applied);
result.failed = extra.failed;
if result.snapshot.is_none() { result.snapshot = extra.snapshot; }
}
Ok(result)
}) })
} }
fn validate(&self) -> Result<()> { fn validate(&self) -> Result<()> {
use crate::process::{observe, ServiceState}; use crate::process::{observe, ServiceState};
// The check start is the first start of the new build: give the module configs the settings the update added
// (as a normal start does), or the server logs a "missing property" line for every one of them.
match crate::registry::MetaDir::open(self.meta_dir) {
Ok((_, meta)) if meta.kind == crate::registry::InstallKind::New => {
let _ = crate::config::materialize_module_configs(self.root);
}
// An imported server gets the files it lacks (nothing it has is changed).
_ => {
let _ = crate::config::create_missing_module_configs(self.root);
}
}
let started = crate::driver::run(self.root, crate::driver::Verb::StartAll)?; let started = crate::driver::run(self.root, crate::driver::Verb::StartAll)?;
let ports = crate::layout::read_ports(self.root); let ports = crate::layout::read_ports(self.root);
let healthy = started.ok && { let healthy = started.ok && {
+60 -6
View File
@@ -277,9 +277,10 @@ Advanced override, snapshot first.
### D9. Client integration ### D9. Client integration
The client is a separate object. Manager only: detect (`Wow.exe`/`Ascension.exe` + `Data\`), read/write The client is a separate object. By default the Manager only detects it (`Wow.exe`/`Ascension.exe` + `Data\`), reads/writes
`realmlist.wtf` after backing it up, and copy `Interface\AddOns\CoABotUI` (backing that one directory up only if `realmlist.wtf` after backing it up, and copies `Interface\AddOns\CoABotUI` (backing that one directory up only if
its files differ from the manifest). No touching of `WTF`, `Cache`, other AddOns, or the exe. its files differ from the manifest). No touching of `WTF`, `Cache`, other AddOns, or the exe. Downloading or updating
a client is opt-in and described in section 9 (game client download); an existing client is never changed without asking.
*Reference machine note:* `C:\games\Ascension` is a heavily modified Ascension client (custom `d3d9.dll`, *Reference machine note:* `C:\games\Ascension` is a heavily modified Ascension client (custom `d3d9.dll`,
renderer files, many `.bak`s) — client detection must be strictly read-only + additive. renderer files, many `.bak`s) — client detection must be strictly read-only + additive.
@@ -336,6 +337,37 @@ Base package (≈3.2 GB; Data 3.8 GB + mysql data) is split into ≤ 1.9 GB part
with a parts manifest. Reproducibility: pinned runner image label, recorded compiler/vcpkg versions, source SHAs, with a parts manifest. Reproducibility: pinned runner image label, recorded compiler/vcpkg versions, source SHAs,
build timestamp written into RELEASE.json. build timestamp written into RELEASE.json.
### D13. Linux: the servers run in Docker (experimental)
Linux has no repack launcher and no Win32 process API, and the host should need nothing but Docker. A server folder
that contains `Settings/docker.json` is a **Docker installation**; every other folder is a repack, handled by the
code above without any change. `driver::run`, `process::observe` and `layout::scan` check for the marker first and
hand over to `coa_core::docker`; nothing else needed to change for start, stop, status and the server list.
* **Containers** (`docker/lifecycle.rs`): `coa-<project>-db` (official `mysql:8.4`, data in a named volume, not
published on the host), `-world` and `-auth` (a small runtime image holding only the shared libraries; the
binaries are mounted from `Core/`, so an update replaces files and never rebuilds an image). The image tag is a
hash of its Dockerfile.
* **Why the `docker` command line and not `docker compose`**: the compose plugin is missing from some distributions'
Docker packages, and the plan is to ask for as little as possible on the host. The command line is wrapped by a
`Docker` trait (`docker/cli.rs`), so the logic is tested with an in-memory fake.
* **Same folder shape as a repack where it matters**: `Core/configs`, `Core/Logs`, `Settings/repack.json`
(ports, RA login), `Settings/database.json` and `Data/`. Configuration editing, log tailing and the RA console
therefore work as they do on Windows. The container runs as the owner of the folder and starts in `Core/`.
* **Settings forced by environment** (the core reads `AC_<KEY>` before the `.conf`): `AC_BIND_IP=0.0.0.0` (the
published address, `bindAddress`, decides who can connect), `AC_DATA_DIR`, `AC_LOGS_DIR`, `AC_RA_ENABLE`,
`AC_RA_IP`, and `AC_UPDATES_ENABLE_DATABASES=0`: the server's own database updater needs a `mysql` client program and
stops the server without one; the Manager applies database updates itself (section 1.4). The remote console is published
on `127.0.0.1` only.
* **Secrets** go to `docker` by environment (`--env NAME` without a value), never on a command line.
* **Order**: database healthy, then world listening, then auth. The auth server exits when no realm is online.
Readiness is a connection that stays open: Docker's proxy accepts connections on a published port before the server
inside listens, so a plain connect proves nothing.
* **Configuration path in the binaries**: Linux builds must use `-DCONF_DIR=configs` (see `coa-server-build`),
otherwise the core looks for module configs in a path baked in at build time.
* **Not done yet**: installation and the database setup (schemas, `acore` user), backups and database access through the
container, updates, port conflict detection, the firewall and exposure checks, and the client under Wine/Proton.
--------------------------------------------------------------------------------------------------------- ---------------------------------------------------------------------------------------------------------
## 3. Flows ## 3. Flows
@@ -484,9 +516,11 @@ The reference install classifies as **Healthy (customised)**: repack shape, bina
translations are reviewed by native speakers before release, with an English fallback for missing keys and a CI check translations are reviewed by native speakers before release, with an English fallback for missing keys and a CI check
that every locale has every key. Do this before the first public release so strings are not retro-fitted. that every locale has every key. Do this before the first public release so strings are not retro-fitted.
**Status (2026-09-30):** catalogue + picker + all screens translated (en/ru/de/fr/es drafts, `tools/check-i18n.mjs` checks **Status (2026-09-30, updated):** catalogue + picker + every screen translated (en/ru/de/fr/es drafts); settings-schema titles,
keys/placeholders). Still English: settings-schema titles/descriptions/presets, companion size names, diagnostics check descriptions, categories, presets, options and units are translated through overlays in `src/i18n/schema/`; diagnostics
texts and update step names coming from the backend (need `schemas/i18n/<locale>.json` overlays and code-keyed backend strings). checks, update steps, companion sizes and friends notes are recognised and translated in the UI. `tools/check-i18n.mjs`
verifies keys, placeholders and overlay coverage. Still English: free-form backend technical messages. Native-speaker
review is still needed (see `docs/TRANSLATIONS.md`).
* **Language choice on the very first screen** (requested 2026-09-30): the welcome screen must offer the language picker * **Language choice on the very first screen** (requested 2026-09-30): the welcome screen must offer the language picker
right away (before any other text is read), preselected from the OS language; the choice is persisted and shared with right away (before any other text is read), preselected from the OS language; the choice is persisted and shared with
@@ -515,3 +549,23 @@ The reference install classifies as **Healthy (customised)**: repack shape, bina
hour, world thread stalled); (2) no active `coa.conf` (`CoA.Enable = 1`) because packages contain only `*.conf.dist`. hour, world thread stalled); (2) no active `coa.conf` (`CoA.Enable = 1`) because packages contain only `*.conf.dist`.
Fixed: `clean-base` restores quiet templates, `assemble-tree` ships `coa.conf.dist`, and the Manager creates missing Fixed: `clean-base` restores quiet templates, `assemble-tree` ships `coa.conf.dist`, and the Manager creates missing
module `.conf` files from their `.dist` on install and before each start of a Manager-installed server. module `.conf` files from their `.dist` on install and before each start of a Manager-installed server.
* **Game client download and update through the Manager** (built 2026-10-01, `coa-core::clientdl`). The community PTR launcher
("Conquest of AzerothCore" Electron app) reads its client from
`https://launcher-api.coa-development.org/downloads/client/latest.json` (`{schema, version, publishedAt, files:[{path,size,sha256}]}`;
~200 files, 43 GiB: `Ascension.exe`, DLLs and ~40 big `Data/*.MPQ`) and fetches each file as the content-addressed object
`.../downloads/client/objects/<sha256>`. The Manager uses the same endpoints with its own resumable, hash-verified downloader:
* **State** lives in the client folder (`.coa-manager/client-state.json`: manifest version, per file size/mtime/sha256). A
routine check (every 5 minutes, like the server) is one small manifest request compared with the recorded version; no game file is read.
* **Plan, then apply** (like server updates): files are compared by size and mtime against the state, and hashed only when those
no longer match. Each file is `Missing`, `Changed` (still as the Manager left it) or `Modified` (the player changed it, e.g. a
custom `d3d9.dll` or a patched exe). Modified files are kept on request (and remembered: asked again only when the published file
changes) or replaced after being moved to `.coa-manager/replaced/<time>/`. Objects are staged in `.coa-manager/staging/<sha>` and
moved into place only after the hash matches; state is saved after every file, so cancel, crash or reboot resume where they stopped.
* **Never touched:** `WTF`, `Cache`, `Errors`, `Logs`, `*.log`, `realmlist.wtf`, `Interface/AddOns/CoABotUI` (those have their own paths).
* **UI:** PLAY becomes **UPDATE CLIENT** when a tracked client is outdated (with "Play without updating"); with no client linked it
becomes **Set up game client** (choose an existing folder, or download into `<chosen folder>/CoA Client` with a free-space check).
An existing client that is not tracked can be adopted from Settings > Game client ("Keep this client up to date").
A fresh download gets `realmlist.wtf` for each installed locale (the manifest has none) and the companion addon.
* **Open points:** ask the launcher maintainers before putting heavy load on their API; DBCs live inside the MPQ patch archives
(extracting them would need an MPQ reader), so the server's `Data\dbc` still comes from our `base` package for now.
+36
View File
@@ -0,0 +1,36 @@
# Translations
The Manager interface exists in English (source), Russian, German, French and Spanish. Everything except English is a
**draft written by an AI assistant and needs review by a native speaker** before it is treated as final.
## Where the texts are
| What | File | Notes |
|---|---|---|
| Interface texts | `src/i18n/locales/<lang>.ts` | flat `"key": "text"` lists; `en.ts` is the source of truth, other languages fall back to it |
| Setting titles, descriptions, categories, presets, units, option labels | `src/i18n/schema/<lang>.json` | generated once from `schemas/*.json`; edit the JSON directly |
| Backend error messages | keys `err.<code>.title` / `err.<code>.message` in the locale files | codes come from `crates/coa-core/src/error.rs` |
`{name}` placeholders must stay exactly as they are. Plural forms use the suffixes `_one`, `_few`, `_many`, `_other`
(the browser picks the right one for the language).
## Checking your work
```
node tools/check-i18n.mjs # unknown keys, changed placeholders, coverage, schema overlays complete
npx tsc --noEmit # types
npx vite # UI with mock data in a browser; pick the language on the welcome screen
```
## Adding a language
1. Copy `src/i18n/locales/en.ts` to `<lang>.ts` (keep the keys), translate, and register it in `src/i18n/index.tsx`
(`Locale`, `LOCALES`, `DICTS`).
2. Copy `src/i18n/schema/ru.json` to `<lang>.json`, translate the values, and register it in `SCHEMA`.
3. Run the check above.
## Known gaps
* Free-form technical messages produced deep inside the backend (`Error::Invalid("...")`) stay in English; they are
shown as "technical details".
* Texts inside the game itself (client, server data) are not part of the Manager.
+42
View File
@@ -0,0 +1,42 @@
# Realm profiles
Overview offers CoA and Wildcard. The installed worldserver must contain Wildcard support and the database must
already have its Wildcard migrations. The Manager refuses an unsupported binary, an occupied realm ID 2 or an
existing destination database rather than overwrite them.
The first switch copies the CoA world into `acore_world_wildcard` and creates `acore_characters_wildcard` from
the character schema and neutral server seed tables. Existing characters, card collections and progress are not
copied. Accounts remain in shared `acore_auth`. Realm IDs 1 and 2 share the world port; only the selected world
runs, and the inactive realm is listed offline. A switch while running stops the server gracefully and restarts it.
Configuration profiles are saved under `Settings/realm-profiles`. An interrupted switch can restore its previous
configuration from the journal. CoA companion bots cannot be enabled on Wildcard. Content Scaling and the other
optional modules retain their settings but show experimental compatibility; class mechanics need separate gameplay
validation. Switching back restores the CoA module settings.
Quick/database backups include both character databases and shared auth. Full backups also include both worlds.
Recovery points identify their active realm; select that realm before restoring them. Server migrations apply to
both realms, with auth applied once. The server updater can replace its launcher: the Manager reapplies the realm
adapter before the next start.
![Wildcard overview](screenshots/wildcard-demo/overview.jpg)
![Module compatibility](screenshots/wildcard-demo/modules.jpg)
## Validation for v0.5.0
- `cargo test --workspace`: 178 core tests passed; command layer and examples compiled.
- `npm run build`, translation key checks and changelog validation passed.
- Native disposable fixture on offset ports: fresh Wildcard creation and startup, CoA startup after switching back,
separate probe values and restored CoA configuration. A second fresh creation verified the arena-season seed fix.
- Full backup verified both worlds, both character databases, shared auth and configurations.
- Native migration probe applied once to each realm and once to auth; repeating it did nothing.
- Restoring Wildcard characters removed a fixture-only change and preserved the CoA probe value.
- Core gameplay wrapper: `VERIFY ALL: PASSED`, gameplay stage only, real clock. First login (7 assertions),
level rolls/reroll (31), skill card rolls (13), stat path (12). The level-roll and skill-card scenarios passed on isolated
reruns after failing in the shared batch; the wrapper records two batch-sensitive cases.
- Browser demo verified active profile, hidden Bots navigation and module compatibility labels. Screenshots show
mock IPC; native checks above exercised the actual backend and server.
The gameplay harness required fixture-only synchronization of already applied migration history by verified SQL
hashes and its normal Windows module config path. Owned server files and databases were not modified.
Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

+1
View File
@@ -4,6 +4,7 @@
<meta charset="UTF-8" /> <meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>CoA Server Manager</title> <title>CoA Server Manager</title>
<link rel="icon" type="image/png" href="/src/assets/logo.png" />
</head> </head>
<body> <body>
<div id="root"></div> <div id="root"></div>
+138
View File
@@ -0,0 +1,138 @@
{
"schema": 1,
"modules": [
{
"id": "companions",
"name": "CoA Companions",
"description": {
"en": "Companion bots for groups, dungeons and your guild.",
"ru": "Боты-компаньоны для групп, подземелий и гильдии.",
"de": "Begleiter-Bots für Gruppen, Dungeons und deine Gilde.",
"fr": "Des bots compagnons pour les groupes, les donjons et votre guilde.",
"es": "Bots acompañantes para grupos, mazmorras y tu hermandad."
},
"repo": "https://github.com/Corfirean/mod-coa-playerbots",
"conf": "mod_coa_playerbots.conf",
"enable_key": "CoaBots.Enable",
"status": "beta",
"icon": "bot",
"page": "bots"
},
{
"id": "content-scaling",
"name": "Content Scaling",
"description": {
"en": "Scales dungeons and raids to your group, with solo modes.",
"ru": "Подстраивает подземелья и рейды под вашу группу, есть соло-режимы.",
"de": "Passt Dungeons und Schlachtzüge an deine Gruppe an, mit Solo-Modi.",
"fr": "Adapte donjons et raids à votre groupe, avec des modes solo.",
"es": "Adapta mazmorras y bandas a tu grupo, con modos en solitario."
},
"repo": "https://github.com/Corfirean/mod-coa-content-scaling",
"conf": "mod-coa-content-scaling.conf",
"enable_key": "CoAContentScaling.Enable",
"status": "early",
"icon": "scaling"
},
{
"id": "tbc-content",
"name": "TBC Content",
"description": {
"en": "Outland dungeons and raids, scaled to your level range.",
"ru": "Подземелья и рейды Запределья, подогнанные под ваши уровни.",
"de": "Dungeons und Schlachtzüge der Scherbenwelt, an deine Stufen angepasst.",
"fr": "Donjons et raids de l'Outreterre, adaptés à vos niveaux.",
"es": "Mazmorras y bandas de Terrallende, adaptadas a tus niveles."
},
"repo": "https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-tbc-content",
"conf": "mod-coa-tbc-content.conf",
"enable_key": "CoATBC.Enable",
"status": "early",
"icon": "tbc"
},
{
"id": "wotlk-content",
"name": "WotLK Content",
"description": {
"en": "Northrend dungeons and raids, scaled to your level range.",
"ru": "Подземелья и рейды Нордскола, подогнанные под ваши уровни.",
"de": "Dungeons und Schlachtzüge Nordends, an deine Stufen angepasst.",
"fr": "Donjons et raids du Norfendre, adaptés à vos niveaux.",
"es": "Mazmorras y bandas de Rasganorte, adaptadas a tus niveles."
},
"repo": "https://github.com/Corfirean/mod-coa-content-scaling/tree/main/content-packs/mod-coa-wotlk-content",
"conf": "mod-coa-wotlk-content.conf",
"enable_key": "CoAWotLK.Enable",
"status": "early",
"icon": "wotlk"
},
{
"id": "ah-bot",
"name": "Auction House Bot",
"description": {
"en": "Fills the auction house with realistic, adjustable listings.",
"ru": "Наполняет аукцион реалистичными настраиваемыми лотами.",
"de": "Füllt das Auktionshaus mit realistischen, einstellbaren Angeboten.",
"fr": "Remplit l'hôtel des ventes d'annonces réalistes et réglables.",
"es": "Llena la casa de subastas con ofertas realistas y ajustables."
},
"repo": "https://github.com/NathanHandley/mod-ah-bot-plus",
"conf": "mod_ahbot.conf",
"switchable": false,
"status": "soon",
"icon": "gavel"
},
{
"id": "npc-enchanter",
"name": "NPC Enchanter",
"description": {
"en": "An NPC that enchants your gear for you.",
"ru": "НПС, который зачаровывает ваше снаряжение.",
"de": "Ein NPC, der deine Ausrüstung für dich verzaubert.",
"fr": "Un PNJ qui enchante votre équipement pour vous.",
"es": "Un PNJ que encanta tu equipo por ti."
},
"repo": "https://github.com/azerothcore/mod-npc-enchanter",
"conf": "npc_enchanter.conf",
"switchable": true,
"status": "early",
"icon": "sparkles",
"enable_key": "Enchanter.Enable",
"default_on": true
},
{
"id": "playerbots",
"name": "SQUID's Playerbots",
"description": {
"en": "An alternative bot system with random bots and full AI.",
"ru": "Альтернативная система ботов со случайными ботами и полным ИИ.",
"de": "Ein alternatives Bot-System mit Zufalls-Bots und voller KI.",
"fr": "Un système de bots alternatif avec bots aléatoires et IA complète.",
"es": "Un sistema de bots alternativo con bots aleatorios e IA completa."
},
"repo": "https://github.com/Zyth45/mod-playerbots",
"conf": "playerbots.conf",
"switchable": false,
"status": "soon",
"icon": "swords"
},
{
"id": "client-compat",
"name": "Client compatibility",
"description": {
"en": "Client-server link and appearance unlocks.",
"ru": "Связь клиента с сервером и разблокировка внешних видов.",
"de": "Verbindung Client–Server und Aussehen-Freischaltungen.",
"fr": "Lien client-serveur et déblocage des apparences.",
"es": "Enlace cliente-servidor y desbloqueo de apariencias."
},
"repo": "https://github.com/Corfirean/azerothcore-wotlk-coa",
"conf": "coa.conf",
"alt_conf": "mod_ascension_compat.conf",
"switchable": false,
"status": "release",
"icon": "plug",
"hidden": true
}
]
}
+2 -2
View File
@@ -1,12 +1,12 @@
{ {
"name": "coa-server-manager", "name": "coa-server-manager",
"version": "0.1.0", "version": "0.6.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "coa-server-manager", "name": "coa-server-manager",
"version": "0.1.0", "version": "0.6.0",
"dependencies": { "dependencies": {
"@tauri-apps/api": "^2.12.0", "@tauri-apps/api": "^2.12.0",
"@tauri-apps/plugin-dialog": "^2.8.0", "@tauri-apps/plugin-dialog": "^2.8.0",
+1 -1
View File
@@ -1,7 +1,7 @@
{ {
"name": "coa-server-manager", "name": "coa-server-manager",
"private": true, "private": true,
"version": "0.1.4", "version": "0.6.0",
"license": "AGPL-3.0-only", "license": "AGPL-3.0-only",
"type": "module", "type": "module",
"scripts": { "scripts": {
+280
View File
@@ -489,6 +489,19 @@
"max": 1000, "max": 1000,
"unit": "ms" "unit": "ms"
}, },
{
"key": "MapUpdate.Threads",
"type": "int",
"category": "performance",
"title": "CPU cores for the world",
"description": "How many processor cores the world uses to update maps. Companions spread over several maps run much faster with more than one. Takes effect when the world server restarts.",
"default": 4,
"advanced": false,
"restartRequired": "world",
"dangerous": false,
"min": 1,
"max": 16
},
{ {
"key": "MinWorldUpdateTime", "key": "MinWorldUpdateTime",
"type": "int", "type": "int",
@@ -563,6 +576,273 @@
"dangerous": true, "dangerous": true,
"min": 0, "min": 0,
"max": 7 "max": 7
},
{
"key": "Rate.Drop.Item.Uncommon",
"type": "float",
"category": "rates",
"title": "Uncommon item drop rate",
"description": "Multiplier for how often uncommon (green) items drop.",
"default": 1,
"advanced": false,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 20,
"unit": "x"
},
{
"key": "Rate.Drop.Item.Rare",
"type": "float",
"category": "rates",
"title": "Rare item drop rate",
"description": "Multiplier for how often rare (blue) items drop.",
"default": 1,
"advanced": false,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 20,
"unit": "x"
},
{
"key": "Rate.Drop.Item.Epic",
"type": "float",
"category": "rates",
"title": "Epic item drop rate",
"description": "Multiplier for how often epic (purple) items drop.",
"default": 1,
"advanced": false,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 20,
"unit": "x"
},
{
"key": "Rate.Drop.Item.Legendary",
"type": "float",
"category": "rates",
"title": "Legendary item drop rate",
"description": "Multiplier for how often legendary (orange) items drop.",
"default": 1,
"advanced": false,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 20,
"unit": "x"
},
{
"key": "Rate.Talent",
"type": "float",
"category": "rates",
"title": "Talent points",
"description": "Multiplier for the talent points a character earns per level.",
"default": 1,
"advanced": true,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 10,
"unit": "x"
},
{
"key": "Rate.Skill.Discovery",
"type": "float",
"category": "rates",
"title": "Recipe discovery chance",
"description": "Multiplier for the chance to discover a new recipe while crafting.",
"default": 1,
"advanced": true,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 20,
"unit": "x"
},
{
"key": "Rate.RepairCost",
"type": "float",
"category": "rates",
"title": "Repair cost",
"description": "Multiplier for what repairing equipment costs. 0 makes repairs free.",
"default": 1,
"advanced": false,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 10,
"unit": "x"
},
{
"key": "Rate.Auction.Cut",
"type": "float",
"category": "rates",
"title": "Auction house cut",
"description": "Multiplier for the share of a sale the auction house keeps. 0 means no cut.",
"default": 1,
"advanced": true,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 10,
"unit": "x"
},
{
"key": "Rate.ArenaPoints",
"type": "float",
"category": "rates",
"title": "Arena points gain",
"description": "Multiplier for arena points earned.",
"default": 1,
"advanced": true,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 20,
"unit": "x"
},
{
"key": "Rate.XP.Pet",
"type": "float",
"category": "rates",
"title": "Pet experience",
"description": "Multiplier for the experience hunters' pets gain.",
"default": 1,
"advanced": true,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 20,
"unit": "x"
},
{
"key": "Instance.IgnoreLevel",
"type": "bool",
"category": "gameplay",
"title": "Ignore dungeon level requirements",
"description": "Characters of any level can enter dungeons and raids.",
"default": false,
"advanced": false,
"restartRequired": "world",
"dangerous": false
},
{
"key": "Instance.IgnoreRaid",
"type": "bool",
"category": "gameplay",
"title": "Enter raids without a raid group",
"description": "Players can enter raid instances without being in a raid group.",
"default": false,
"advanced": false,
"restartRequired": "world",
"dangerous": false
},
{
"key": "Instance.ResetTimeHour",
"type": "int",
"category": "gameplay",
"title": "Dungeon reset hour",
"description": "Hour of the day (0-23) when dungeon and raid lockouts reset.",
"default": 4,
"advanced": true,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 23
},
{
"key": "MaxPrimaryTradeSkill",
"type": "int",
"category": "gameplay",
"title": "Primary professions per character",
"description": "How many primary professions (such as Blacksmithing or Herbalism) a character may learn.",
"default": 2,
"advanced": false,
"restartRequired": "world",
"dangerous": false,
"min": 0,
"max": 11
},
{
"key": "AlwaysMaxSkillForLevel",
"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.",
"default": false,
"advanced": false,
"restartRequired": "world",
"dangerous": false
},
{
"key": "ActivateWeather",
"type": "bool",
"category": "gameplay",
"title": "Weather",
"description": "Turns rain, snow and storms on or off.",
"default": true,
"advanced": false,
"restartRequired": "world",
"dangerous": false
},
{
"key": "Group.Raid.LevelRestriction",
"type": "int",
"category": "gameplay",
"title": "Minimum level to invite to a raid",
"description": "Characters below this level cannot be invited to a raid group.",
"default": 10,
"advanced": true,
"restartRequired": "world",
"dangerous": false,
"min": 1,
"max": 80
},
{
"key": "AllowTwoSide.Interaction.Group",
"type": "bool",
"category": "accounts",
"title": "Cross-faction groups",
"description": "Alliance and Horde players can form groups together.",
"default": false,
"advanced": false,
"restartRequired": "world",
"dangerous": false
},
{
"key": "AllowTwoSide.Interaction.Guild",
"type": "bool",
"category": "accounts",
"title": "Cross-faction guilds",
"description": "Alliance and Horde players can join the same guild.",
"default": false,
"advanced": false,
"restartRequired": "world",
"dangerous": false
},
{
"key": "AllowTwoSide.Interaction.Auction",
"type": "bool",
"category": "accounts",
"title": "Shared auction house",
"description": "Alliance and Horde players can use the same auction house.",
"default": false,
"advanced": false,
"restartRequired": "world",
"dangerous": false
},
{
"key": "Achievement.RealmFirstBlockBots",
"type": "bool",
"category": "gameplay",
"title": "Bots cannot take 'Realm First!'",
"description": "Companions (bots) cannot earn 'Realm First!' achievements, so they never take a server first away from real players. Needs a server build from 2026-10-02 or later.",
"default": true,
"advanced": false,
"restartRequired": "world",
"dangerous": false
} }
] ]
} }
+1
View File
@@ -16,6 +16,7 @@ tauri = { version = "2", features = [] }
tauri-plugin-dialog = "2" tauri-plugin-dialog = "2"
tauri-plugin-updater = "2" tauri-plugin-updater = "2"
tauri-plugin-process = "2" tauri-plugin-process = "2"
tauri-plugin-opener = "2"
serde = { version = "1", features = ["derive"] } serde = { version = "1", features = ["derive"] }
serde_json = "1" serde_json = "1"
coa-core = { path = "../crates/coa-core" } coa-core = { path = "../crates/coa-core" }
Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.3 KiB

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 141 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.2 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 5.3 KiB

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.1 KiB

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 7.5 KiB

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 171 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.3 KiB

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.1 KiB

After

Width:  |  Height:  |  Size: 5.8 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.5 KiB

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.4 KiB

After

Width:  |  Height:  |  Size: 7.3 KiB

Binary file not shown.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 167 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.2 KiB

After

Width:  |  Height:  |  Size: 499 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 1.7 MiB

+680 -10
View File
@@ -28,6 +28,8 @@ struct AppState {
busy: Mutex<HashSet<String>>, busy: Mutex<HashSet<String>>,
/// Cancel handle of the installation currently running, if any. /// Cancel handle of the installation currently running, if any.
install_cancel: Mutex<Option<Cancel>>, install_cancel: Mutex<Option<Cancel>>,
/// Cancel handle of the game-client check or download currently running, if any.
client_cancel: Mutex<Option<Cancel>>,
} }
/// Where official server packages are published (created by the release pipeline, Phase 6). /// Where official server packages are published (created by the release pipeline, Phase 6).
@@ -68,11 +70,24 @@ struct StatusView {
path_exists: bool, path_exists: bool,
} }
/// Where the Manager keeps its own state (server list, logs). `%LOCALAPPDATA%` on Windows, the XDG data folder elsewhere.
fn data_dir() -> PathBuf { fn data_dir() -> PathBuf {
#[cfg(windows)]
let base = std::env::var_os("LOCALAPPDATA").map(PathBuf::from).unwrap_or_else(std::env::temp_dir); let base = std::env::var_os("LOCALAPPDATA").map(PathBuf::from).unwrap_or_else(std::env::temp_dir);
#[cfg(not(windows))]
let base = unix_data_home(std::env::var_os("XDG_DATA_HOME"), std::env::var_os("HOME"));
base.join("CoAServerManager") base.join("CoAServerManager")
} }
/// `$XDG_DATA_HOME` when it is an absolute path (the spec says to ignore relative ones), else `~/.local/share`.
#[cfg(not(windows))]
fn unix_data_home(xdg: Option<std::ffi::OsString>, home: Option<std::ffi::OsString>) -> PathBuf {
xdg.map(PathBuf::from)
.filter(|p| p.is_absolute())
.or_else(|| home.map(|h| PathBuf::from(h).join(".local/share")))
.unwrap_or_else(std::env::temp_dir)
}
fn path_of(state: &AppState, id: &str) -> Result<PathBuf> { fn path_of(state: &AppState, id: &str) -> Result<PathBuf> {
state state
.registry .registry
@@ -187,23 +202,49 @@ async fn run_verb(state: &AppState, id: String, verb: Verb) -> std::result::Resu
#[tauri::command] #[tauri::command]
async fn start_server(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> { async fn start_server(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> {
let _guard = BusyGuard::acquire(&state, &id)?;
// Servers installed before module configs were created automatically get them now (missing files only). Imported // Servers installed before module configs were created automatically get them now (missing files only). Imported
// servers are never written to by the Manager outside the launcher's own start-up. // servers only get the module files they lack (see below); nothing they have is changed.
if let Ok(root) = path_of(&state, &id) { if let Ok(root) = path_of(&state, &id) {
let _ = tauri::async_runtime::spawn_blocking(move || { let _ = tauri::async_runtime::spawn_blocking(move || {
let (_, meta) = install_meta(&root)?; let (_, meta) = install_meta(&root)?;
if meta.kind == coa_core::registry::InstallKind::New { if meta.kind == coa_core::registry::InstallKind::New {
coa_core::config::materialize_module_configs(&root)?; coa_core::config::materialize_module_configs(&root)?;
} else {
// Imported: only the module files that are missing (a module without its file logs every setting it reads).
let _ = coa_core::config::create_missing_module_configs(&root);
} }
let dir = meta_dir(&root)?; let dir = meta_dir(&root)?;
coa_core::friends::ensure_bind(&root, &dir)?; coa_core::friends::ensure_bind(&root, &dir)?;
if meta.kind == coa_core::registry::InstallKind::New {
coa_core::config::ensure_performance_defaults(&root, &dir)?;
}
Ok::<(), Error>(()) Ok::<(), Error>(())
}) })
.await; .await;
} }
let out = run_verb(&state, id.clone(), Verb::StartAll).await?; let root = path_of(&state, &id)?;
let out = blocking(move || driver::run(&root, Verb::StartAll)).await?;
if out.ok { if out.ok {
if let Ok(root) = path_of(&state, &id) { if let Ok(root) = path_of(&state, &id) {
// Companions requested while the server was stopped are created now (once; a failure is only logged).
let r = root.clone();
let _ = tauri::async_runtime::spawn_blocking(move || -> Result<()> {
if coa_core::realms::guard_module(&r, "companions").is_err() { return Ok(()); }
let pending = meta_dir(&r)?.join("companions.pending.json");
if let Ok(v) = coa_core::fsx::read_json::<serde_json::Value>(&pending) {
let _ = std::fs::remove_file(&pending);
let n = v["count"].as_u64().unwrap_or(0) as u32;
if n > 0 {
let made = coa_core::db::Db::from_repack(&r, coa_core::db::Account::Admin).and_then(|db| coa_core::companions::ensure_templates(&db));
if let Err(e) = made.and_then(|_| Ra::connect(&r)).and_then(|mut ra| ra.spawn_bots(n)) {
tracing::warn!("pending companions were not created: {e}");
}
}
}
Ok(())
})
.await;
let _ = tauri::async_runtime::spawn_blocking(move || meta_dir(&root).and_then(|m| coa_core::friends::reapply(&root, &m))).await; let _ = tauri::async_runtime::spawn_blocking(move || meta_dir(&root).and_then(|m| coa_core::friends::reapply(&root, &m))).await;
} }
} }
@@ -253,6 +294,7 @@ async fn save_settings(
changes: BTreeMap<String, Value>, changes: BTreeMap<String, Value>,
) -> std::result::Result<config::SaveReport, UiError> { ) -> std::result::Result<config::SaveReport, UiError> {
let root = path_of(&state, &id)?; let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || { blocking(move || {
let meta = meta_dir(&root)?; let meta = meta_dir(&root)?;
config::save(&root, &meta, scope, &changes) config::save(&root, &meta, scope, &changes)
@@ -363,9 +405,30 @@ async fn restore_backup_database(state: State<'_, AppState>, id: String, backup_
} }
#[tauri::command] #[tauri::command]
fn install_preflight(state: State<'_, AppState>, dest: String) -> Preflight { fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option<u64>) -> Preflight {
// The real size is checked again once the signed manifest is known; assume a typical install here. // `needed` is the real size from the signed package list when the screen already has it; the real size is checked
install::preflight(std::path::Path::new(&dest), 6 * 1024 * 1024 * 1024, &state.registry) // again at install time either way.
install::preflight(std::path::Path::new(&dest), needed.unwrap_or(6 * 1024 * 1024 * 1024), &state.registry)
}
#[derive(Serialize)]
struct InstallRequirements {
/// What is downloaded.
download_bytes: u64,
/// What the unpacked server takes on the drive (the downloaded parts are removed afterwards).
unpacked_bytes: u64,
version: String,
}
/// 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> {
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()))?;
Ok(InstallRequirements { download_bytes: archive.parts.iter().map(|p| p.size).sum(), unpacked_bytes: archive.unpacked_size, version: m.version })
})
.await
} }
#[tauri::command] #[tauri::command]
@@ -416,6 +479,178 @@ async fn create_account(state: State<'_, AppState>, id: String, username: String
.await .await
} }
#[tauri::command]
async fn realmlist_profiles(state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::realmlist::View, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
Ok(coa_core::realmlist::view(&dir, linked_client(&root)?.as_deref()))
})
.await
}
#[tauri::command]
async fn realmlist_save(state: State<'_, AppState>, id: String, profile_id: Option<String>, name: String, data: String) -> std::result::Result<coa_core::realmlist::Profile, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
coa_core::realmlist::save_profile(&dir, linked_client(&root)?.as_deref(), profile_id.as_deref(), &name, &data)
})
.await
}
#[tauri::command]
async fn realmlist_delete(state: State<'_, AppState>, id: String, profile_id: String) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
coa_core::realmlist::delete_profile(&dir, linked_client(&root)?.as_deref(), &profile_id)
})
.await
}
/// Write the chosen realmlist into the linked game client.
#[tauri::command]
async fn realmlist_activate(state: State<'_, AppState>, id: String, profile_id: String) -> std::result::Result<Vec<String>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is set up for this server yet.".into()))?;
let changed = coa_core::realmlist::activate(&dir, &client, &profile_id)?;
tracing::info!(profile = %profile_id, files = changed.len(), "realmlist switched");
Ok(changed)
})
.await
}
#[tauri::command]
async fn modules_list(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<coa_core::modules::ModuleView>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || Ok(coa_core::modules::list(&root))).await
}
#[tauri::command]
async fn realm_profiles(state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::realms::View, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::realms::view(&root)).await
}
#[tauri::command]
async fn realm_select(state: State<'_, AppState>, id: String, mode: coa_core::realms::Mode, restart: bool) -> std::result::Result<coa_core::realms::View, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
let result = blocking(move || {
if restart {
let out = driver::run(&root, Verb::StopAll)?;
if !out.ok { return Err(Error::Invalid(out.output)); }
}
let view = coa_core::realms::select(&root, mode)?;
let (dir, meta) = install_meta(&root)?;
if let Some(client) = meta.client_path {
coa_core::client::sync_realm(std::path::Path::new(&client), &dir, view.active)?;
}
if restart {
let out = driver::run(&root, Verb::StartAll)?;
if !out.ok { return Err(Error::Invalid(format!("Realm selected, but startup failed: {}", out.output))); }
}
Ok(view)
}).await;
result
}
#[tauri::command]
async fn module_set_enabled(state: State<'_, AppState>, id: String, module: String, enabled: bool) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
coa_core::modules::set_enabled(&root, &dir, &module, enabled)
})
.await
}
#[tauri::command]
async fn module_settings(state: State<'_, AppState>, id: String, module: String) -> std::result::Result<Vec<coa_core::modules::Setting>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::modules::settings(&root, &module)).await
}
#[tauri::command]
async fn module_save_settings(state: State<'_, AppState>, id: String, module: String, changes: BTreeMap<String, String>) -> std::result::Result<Vec<String>, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
coa_core::modules::save_settings(&root, &dir, &module, &changes)
})
.await
}
#[tauri::command]
async fn all_settings(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<coa_core::allsettings::Item>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::allsettings::list(&root)).await
}
#[tauri::command]
async fn all_settings_save(state: State<'_, AppState>, id: String, changes: BTreeMap<String, String>) -> std::result::Result<Vec<String>, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let (dir, _) = install_meta(&root)?;
coa_core::allsettings::save(&root, &dir, &changes)
})
.await
}
#[tauri::command]
async fn list_accounts(state: State<'_, AppState>, id: String) -> std::result::Result<Vec<coa_core::accounts::AccountInfo>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || coa_core::accounts::list(&root)).await
}
#[tauri::command]
async fn account_set_password(state: State<'_, AppState>, id: String, name: String, password: String) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
Ra::connect(&root)?.set_account_password(&name, &password)?;
tracing::info!(%name, "account password changed");
Ok(())
})
.await
}
#[tauri::command]
async fn account_set_access(state: State<'_, AppState>, id: String, name: String, level: u8) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
Ra::connect(&root)?.set_account_access(&name, level)?;
tracing::info!(%name, level, "account access level changed");
Ok(())
})
.await
}
#[tauri::command]
async fn account_rename(state: State<'_, AppState>, id: String, name: String, new_name: String, password: String) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let mut ra = Ra::connect(&root)?;
coa_core::accounts::rename(&root, &mut ra, &name, &new_name, &password)
})
.await
}
#[tauri::command]
async fn account_delete(state: State<'_, AppState>, id: String, name: String) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let mut ra = Ra::connect(&root)?;
coa_core::accounts::delete(&root, &mut ra, &name)
})
.await
}
fn install_meta(root: &std::path::Path) -> Result<(PathBuf, InstallMeta)> { fn install_meta(root: &std::path::Path) -> Result<(PathBuf, InstallMeta)> {
let dir = meta_dir(root)?; let dir = meta_dir(root)?;
let (_, meta) = MetaDir::open(&dir)?; let (_, meta) = MetaDir::open(&dir)?;
@@ -497,6 +732,92 @@ async fn get_population(state: State<'_, AppState>, id: String) -> std::result::
.unwrap_or(None)) .unwrap_or(None))
} }
#[derive(Serialize)]
struct CompanionAction {
/// Bots affected (cancelled from the queue, or logged out).
count: u32,
}
#[tauri::command]
async fn companions_stop_spawning(state: State<'_, AppState>, id: String) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
blocking(move || Ok(CompanionAction { count: Ra::connect(&root)?.cancel_spawning()? })).await
}
#[tauri::command]
async fn companions_take_offline(state: State<'_, AppState>, id: String) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let mut ra = Ra::connect(&root)?;
// Anything still waiting to be created must not come back right after.
let _ = ra.cancel_spawning();
Ok(CompanionAction { count: ra.despawn_all()? })
})
.await
}
/// Log `count` randomly chosen online companions out to lower the load. Uses the per-bot command that every server
/// build has, so it works on older builds too.
#[tauri::command]
async fn companions_despawn_some(state: State<'_, AppState>, id: String, count: u32) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
if !(1..=5000).contains(&count) {
return Err(Error::Invalid("Choose a number between 1 and 5000.".into()));
}
let prefix = coa_core::population::bot_account_prefix(&root).to_uppercase();
let db = coa_core::db::Db::from_repack(&root, coa_core::db::Account::App)?;
let rows = db.query(&format!(
"SELECT c.guid FROM acore_characters.characters c JOIN acore_auth.account a ON a.id=c.account WHERE c.online=1 AND UPPER(a.username) LIKE '{prefix}%' ORDER BY RAND() LIMIT {count};"
))?;
let guids: Vec<u64> = rows.lines().filter_map(|l| l.trim().parse().ok()).collect();
let mut ra = Ra::connect(&root)?;
let mut done = 0;
for g in guids {
if ra.despawn_bot(g).unwrap_or(false) {
done += 1;
}
}
Ok(CompanionAction { count: done })
})
.await
}
/// Delete every companion for good. A recovery point of the characters and accounts is saved first.
#[tauri::command]
async fn companions_delete_all(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<CompanionAction, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
let meta = meta_dir(&root)?;
backup::create(&root, &meta, Kind::Quick, Trigger::BeforeDangerousChange, Some("before deleting all companions".into()), &|step| {
let _ = app.emit("backup-progress", step);
})?;
let before = coa_core::population::query(&root).map(|p| p.bots_total).unwrap_or(0);
let mut ra = Ra::connect(&root)?;
let _ = ra.cancel_spawning();
ra.purge_all()?;
Ok(CompanionAction { count: before })
})
.await
}
#[tauri::command]
async fn get_performance(state: State<'_, AppState>, id: String) -> std::result::Result<Option<coa_core::ra::Performance>, UiError> {
let root = path_of(&state, &id)?;
Ok(tauri::async_runtime::spawn_blocking(move || {
let o = coa_core::process::observe(&root, &layout::read_ports(&root));
if o.world.state != coa_core::process::ServiceState::Running {
return None;
}
Ra::connect(&root).and_then(|mut r| r.performance()).ok().flatten()
})
.await
.unwrap_or(None))
}
#[derive(Serialize)] #[derive(Serialize)]
struct CompanionSizes { struct CompanionSizes {
hardware: coa_core::population::Hardware, hardware: coa_core::population::Hardware,
@@ -513,6 +834,10 @@ fn companion_sizes() -> CompanionSizes {
#[derive(Serialize)] #[derive(Serialize)]
struct CompanionsResult { struct CompanionsResult {
spawned: Option<String>, spawned: Option<String>,
/// Created offline with their equipment (server was stopped and the batch was large).
created: Option<u32>,
/// Companions that existed before this request (for a progress bar while the server creates the new ones).
baseline: Option<u32>,
} }
/// Turn on automatic bot login for `count` bots and, if the server is running, ask it to create them. /// Turn on automatic bot login for `count` bots and, if the server is running, ask it to create them.
@@ -527,16 +852,53 @@ async fn add_companions(state: State<'_, AppState>, id: String, count: u32) -> s
let meta = meta_dir(&root)?; let meta = meta_dir(&root)?;
let mut changes = BTreeMap::new(); let mut changes = BTreeMap::new();
changes.insert("CoaBots.AutoLoginOnStartup".to_string(), Value::Bool(true)); changes.insert("CoaBots.AutoLoginOnStartup".to_string(), Value::Bool(true));
changes.insert("CoaBots.AutoLogin.MaxCount".to_string(), Value::from(count)); // Every companion, old and new, should come back at the next start, so the start-up limit only ever grows here.
let existing_max = config::load(&root, Scope::Bots)
.ok()
.and_then(|v| v.settings.iter().find(|s| s.meta.key == "CoaBots.AutoLogin.MaxCount").and_then(|s| s.value.as_u64()))
.unwrap_or(0) as u32;
let already = coa_core::population::query(&root).map(|p| p.bots_total).unwrap_or(0);
changes.insert("CoaBots.AutoLogin.MaxCount".to_string(), Value::from(existing_max.max(already + count).min(5000)));
config::save(&root, &meta, Scope::Bots, &changes)?; config::save(&root, &meta, Scope::Bots, &changes)?;
let o = coa_core::process::observe(&root, &layout::read_ports(&root)); let o = coa_core::process::observe(&root, &layout::read_ports(&root));
// Large batches while the server is stopped: create them in the database right now, fully equipped.
if o.world.state == coa_core::process::ServiceState::Stopped
&& o.auth.state == coa_core::process::ServiceState::Stopped
&& count >= coa_core::companions::OFFLINE_MIN
&& coa_core::companions::offline_factory(&root).is_some()
{
let started_db = o.mysql.state != coa_core::process::ServiceState::Running;
if started_db {
let out = driver::run(&root, Verb::StartMysql)?;
if !out.ok {
return Err(Error::Invalid("The database could not be started.".into()));
}
}
let made = (|| -> Result<()> {
coa_core::companions::ensure_templates(&coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin)?)?;
coa_core::companions::offline_create(&root, &meta.join("logs").join("companions-offline.log"), count)?;
Ok(())
})();
if started_db {
let _ = driver::run(&root, Verb::StopAll);
}
made?;
tracing::info!(count, "companions created offline");
return Ok(CompanionsResult { spawned: None, created: Some(count), baseline: None });
}
let mut baseline = None;
let spawned = if o.world.state == coa_core::process::ServiceState::Running { let spawned = if o.world.state == coa_core::process::ServiceState::Running {
// Older servers have no template characters to copy bots from: add them first.
coa_core::companions::ensure_templates(&coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin)?)?;
baseline = coa_core::population::query(&root).ok().map(|p| p.bots_total);
Some(Ra::connect(&root)?.spawn_bots(count)?) Some(Ra::connect(&root)?.spawn_bots(count)?)
} else { } else {
// The server is stopped: creating bots needs it running, so remember the request and do it after the next start.
coa_core::fsx::atomic_write_json(&meta.join("companions.pending.json"), &serde_json::json!({ "count": count }))?;
None None
}; };
tracing::info!(count, spawned = spawned.is_some(), "companions requested"); tracing::info!(count, spawned = spawned.is_some(), "companions requested");
Ok(CompanionsResult { spawned }) Ok(CompanionsResult { spawned, created: None, baseline })
}) })
.await .await
} }
@@ -582,23 +944,207 @@ fn client_install_addon(state: State<'_, AppState>, id: String) -> std::result::
Ok(coa_core::client::install_addon(&client.unwrap(), &dir, &source)?) Ok(coa_core::client::install_addon(&client.unwrap(), &dir, &source)?)
} }
#[derive(Serialize)]
struct ClientStatus {
/// A usable client folder is linked to this server.
linked: bool,
/// The Manager keeps this folder up to date (it downloaded it or was asked to adopt it).
managed: bool,
installed_version: Option<String>,
latest_version: Option<String>,
latest_bytes: Option<u64>,
/// A managed client is older than the published one (or its download never finished).
update_available: bool,
}
fn linked_client(root: &std::path::Path) -> Result<Option<PathBuf>> {
let (_, meta) = install_meta(root)?;
Ok(meta.client_path.map(PathBuf::from).filter(|p| coa_core::client::detect(p, None).is_some()))
}
/// Cheap: one small manifest request and the local state file; no game file is read.
#[tauri::command]
async fn client_status(state: State<'_, AppState>, id: String) -> std::result::Result<ClientStatus, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let client = linked_client(&root)?;
let latest = coa_core::clientdl::fetch_latest().ok();
let local = client.as_deref().map(coa_core::clientdl::local);
let managed = local.as_ref().map(|l| l.managed).unwrap_or(false);
let installed = local.and_then(|l| l.version);
let update_available = managed && latest.as_ref().map(|l| installed.as_deref() != Some(l.version.as_str())).unwrap_or(false);
Ok(ClientStatus {
linked: client.is_some(),
managed,
installed_version: installed,
latest_bytes: latest.as_ref().map(|l| l.total_bytes()),
latest_version: latest.map(|l| l.version),
update_available,
})
})
.await
}
#[derive(Serialize)]
struct ClientDownloadCheck {
needed_bytes: u64,
free_bytes: u64,
version: String,
/// Where the client would go.
dest: String,
}
const CLIENT_FOLDER: &str = "CoA Client";
#[tauri::command]
async fn client_download_check(parent: String) -> std::result::Result<ClientDownloadCheck, UiError> {
blocking(move || {
let latest = coa_core::clientdl::fetch_latest()?;
let dest = PathBuf::from(&parent).join(CLIENT_FOLDER);
Ok(ClientDownloadCheck {
needed_bytes: latest.total_bytes(),
free_bytes: coa_core::fsx::free_space(std::path::Path::new(&parent))?,
version: latest.version,
dest: dest.to_string_lossy().into_owned(),
})
})
.await
}
/// Compare the linked client with the published one. Hashes files only where the recorded state cannot vouch for them.
#[tauri::command]
async fn client_plan(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<coa_core::clientdl::Plan, UiError> {
let root = path_of(&state, &id)?;
let cancel = begin_client_job(&state)?;
let result = blocking(move || {
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is set up for this server yet.".into()))?;
let manifest = coa_core::clientdl::fetch_latest()?;
let current = coa_core::clientdl::load_state(&client).unwrap_or_default();
coa_core::clientdl::plan(&client, &manifest, &current, &cancel, &|s| {
let _ = app.emit("client-progress", s);
})
})
.await;
end_client_job(&state);
result
}
/// Bring the linked client to the published version. `keep_modified` leaves files the player changed alone.
#[tauri::command]
async fn client_sync(app: AppHandle, state: State<'_, AppState>, id: String, keep_modified: bool) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
let cancel = begin_client_job(&state)?;
let result = blocking(move || {
let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is set up for this server yet.".into()))?;
run_client_sync(&app, &client, keep_modified, &cancel)
})
.await;
end_client_job(&state);
result
}
fn run_client_sync(app: &AppHandle, client: &std::path::Path, keep_modified: bool, cancel: &Cancel) -> Result<()> {
let emit = |s: coa_core::clientdl::Step| {
let _ = app.emit("client-progress", s);
};
let manifest = coa_core::clientdl::fetch_latest()?;
let current = coa_core::clientdl::load_state(client).unwrap_or_default();
let plan = coa_core::clientdl::plan(client, &manifest, &current, cancel, &emit)?;
coa_core::download::check_url(coa_core::clientdl::OBJECTS_URL)?;
let transport = coa_core::download::HttpTransport::new()?;
coa_core::clientdl::apply(
&coa_core::clientdl::Apply { client, manifest: &manifest, plan: &plan, keep_modified, transport: &transport, objects_url: coa_core::clientdl::OBJECTS_URL, cancel },
&emit,
)?;
tracing::info!(version = %manifest.version, downloaded = plan.items.len(), "client brought up to date");
Ok(())
}
/// Download the whole client into `<parent>/CoA Client`, then link it to this server.
#[tauri::command]
async fn client_download(app: AppHandle, state: State<'_, AppState>, id: String, parent: String) -> std::result::Result<coa_core::client::ClientInfo, UiError> {
let root = path_of(&state, &id)?;
let cancel = begin_client_job(&state)?;
let result = blocking(move || {
let (dir, mut meta) = install_meta(&root)?;
let parent = PathBuf::from(&parent);
if !parent.is_dir() {
return Err(Error::Invalid("Choose an existing folder to put the game client in.".into()));
}
let dest = parent.join(CLIENT_FOLDER);
let resuming = coa_core::clientdl::load_state(&dest).is_some();
let non_empty = std::fs::read_dir(&dest).map(|mut r| r.next().is_some()).unwrap_or(false);
if non_empty && !resuming {
return Err(Error::Invalid(format!("{} already exists and is not an unfinished download. Choose another folder.", dest.display())));
}
std::fs::create_dir_all(&dest)?;
run_client_sync(&app, &dest, false, &cancel)?;
let source = coa_core::client::addon_source(&root);
let info = coa_core::client::detect(&dest, source.as_deref()).ok_or_else(|| Error::Invalid("The downloaded client looks incomplete.".into()))?;
meta.client_path = Some(info.path.clone());
coa_core::fsx::atomic_write_json(&dir.join("install.json"), &meta)?;
// a fresh client has no realmlist; this server is on this computer
coa_core::client::set_realmlist(&dest, &dir, "127.0.0.1")?;
if let Some(src) = source {
coa_core::client::install_addon(&dest, &dir, &src)?;
}
Ok(coa_core::client::detect(&dest, coa_core::client::addon_source(&root).as_deref()).unwrap_or(info))
})
.await;
end_client_job(&state);
result
}
#[tauri::command]
fn client_cancel(state: State<'_, AppState>) {
if let Ok(c) = state.client_cancel.lock() {
if let Some(c) = c.as_ref() {
c.cancel();
}
}
}
fn begin_client_job(state: &AppState) -> std::result::Result<Cancel, UiError> {
let mut slot = state.client_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))?;
if slot.is_some() {
return Err(Error::Invalid("The game client is already being checked or downloaded.".into()).into());
}
let cancel = Cancel::default();
*slot = Some(cancel.clone());
Ok(cancel)
}
fn end_client_job(state: &AppState) {
if let Ok(mut c) = state.client_cancel.lock() {
*c = None;
}
}
/// Start the server if needed, wait until it is ready, then launch the game client. /// Start the server if needed, wait until it is ready, then launch the game client.
#[tauri::command] #[tauri::command]
async fn play(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> { async fn play(state: State<'_, AppState>, id: String) -> std::result::Result<DriverOutcome, UiError> {
let root = path_of(&state, &id)?; let root = path_of(&state, &id)?;
let (_, _, client) = client_of(&root)?; let (dir, _, client) = client_of(&root)?;
let client = client.unwrap(); let client = client.unwrap();
if coa_core::client::is_running(&client) {
return Err(Error::Invalid("Close the game client before pressing Play so its selected realm can be updated.".into()).into());
}
let ready = { let ready = {
let o = coa_core::process::observe(&root, &layout::read_ports(&root)); let o = coa_core::process::observe(&root, &layout::read_ports(&root));
[&o.mysql, &o.auth, &o.world].iter().all(|s| s.state == coa_core::process::ServiceState::Running) [&o.mysql, &o.auth, &o.world].iter().all(|s| s.state == coa_core::process::ServiceState::Running)
}; };
if !ready { if !ready {
let out = run_verb(&state, id, Verb::StartAll).await?; let out = run_verb(&state, id.clone(), Verb::StartAll).await?;
if !out.ok { if !out.ok {
return Ok(out); return Ok(out);
} }
} }
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || { blocking(move || {
let mode = coa_core::realms::state(&root)?.active;
if !coa_core::client::sync_realm(&client, &dir, mode)? {
return Err(Error::Invalid("Close the game client before pressing Play so its selected realm can be updated.".into()));
}
coa_core::client::launch(&client)?; coa_core::client::launch(&client)?;
Ok(DriverOutcome { ok: true, exit_code: None, code: None, human: None, output: String::new() }) Ok(DriverOutcome { ok: true, exit_code: None, code: None, human: None, output: String::new() })
}) })
@@ -615,6 +1161,70 @@ struct FriendsStatus {
firewall: coa_core::firewall::Status, firewall: coa_core::firewall::Status,
tailscale: coa_core::net::Tailscale, tailscale: coa_core::net::Tailscale,
server_running: bool, server_running: bool,
auth_port: u16,
world_port: u16,
}
/// Open one of a few known help pages in the default browser. Anything else is refused, so a page can never ask the
/// Manager to launch an arbitrary address.
#[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}?"));
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);
if !(issue || catalog || ALLOWED.iter().any(|p| url.starts_with(p))) || !chars_ok || url.len() > 12_000 {
return Err(Error::Invalid("That link is not allowed.".into()).into());
}
tauri_plugin_opener::open_url(&url, None::<&str>).map_err(|e| Error::Invalid(e.to_string()))?;
Ok(())
}
#[derive(Serialize)]
struct ReportContext {
manager_version: String,
windows: String,
/// "new" for a server the Manager installed, "imported" for one that was added.
install_kind: String,
server_version: Option<String>,
}
/// "Windows 11 (build 26200)" from `ver`; empty if it cannot be read.
fn windows_version() -> String {
let mut cmd = std::process::Command::new("cmd.exe");
cmd.args(["/C", "ver"]);
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
cmd.creation_flags(0x0800_0000);
}
let out = cmd.output().map(|o| String::from_utf8_lossy(&o.stdout).into_owned()).unwrap_or_default();
let build: Option<u32> = out.split("Version").nth(1).and_then(|v| v.trim().trim_end_matches(']').split('.').nth(2)).and_then(|b| b.trim().parse().ok());
match build {
Some(b) if b >= 22000 => format!("Windows 11 (build {b})"),
Some(b) => format!("Windows 10 (build {b})"),
None => String::new(),
}
}
/// What the problem report fills in on its own. Nothing here identifies the person or the machine.
#[tauri::command]
async fn report_context(state: State<'_, AppState>, id: String) -> std::result::Result<ReportContext, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
let (_, meta) = install_meta(&root)?;
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(),
})
})
.await
} }
#[tauri::command] #[tauri::command]
@@ -631,6 +1241,8 @@ async fn friends_status(state: State<'_, AppState>, id: String) -> std::result::
firewall: coa_core::firewall::status(), firewall: coa_core::firewall::status(),
tailscale: coa_core::net::tailscale(), tailscale: coa_core::net::tailscale(),
server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running, server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running,
auth_port: ports.auth,
world_port: ports.world,
}) })
}) })
.await .await
@@ -808,7 +1420,7 @@ pub fn run() {
.plugin(tauri_plugin_dialog::init()) .plugin(tauri_plugin_dialog::init())
.plugin(tauri_plugin_updater::Builder::new().build()) .plugin(tauri_plugin_updater::Builder::new().build())
.plugin(tauri_plugin_process::init()) .plugin(tauri_plugin_process::init())
.manage(AppState { registry: Registry::at(dir.join("installs.json")), busy: Mutex::new(HashSet::new()), install_cancel: Mutex::new(None) }) .manage(AppState { registry: Registry::at(dir.join("installs.json")), busy: Mutex::new(HashSet::new()), install_cancel: Mutex::new(None), client_cancel: Mutex::new(None) })
.invoke_handler(tauri::generate_handler![ .invoke_handler(tauri::generate_handler![
default_install_dir, default_install_dir,
scan_server, scan_server,
@@ -831,6 +1443,25 @@ pub fn run() {
restore_backup_configs, restore_backup_configs,
restore_backup_database, restore_backup_database,
install_preflight, install_preflight,
install_requirements,
report_context,
list_accounts,
realmlist_profiles,
realmlist_save,
realmlist_delete,
realmlist_activate,
modules_list,
realm_profiles,
realm_select,
module_set_enabled,
module_settings,
module_save_settings,
all_settings,
all_settings_save,
account_set_password,
account_set_access,
account_rename,
account_delete,
install_new, install_new,
cancel_install, cancel_install,
create_account, create_account,
@@ -839,12 +1470,24 @@ pub fn run() {
apply_update, apply_update,
rollback_update, rollback_update,
get_population, get_population,
get_performance,
companions_stop_spawning,
companions_take_offline,
companions_delete_all,
companions_despawn_some,
open_link,
companion_sizes, companion_sizes,
add_companions, add_companions,
client_info, client_info,
set_client, set_client,
client_realmlist, client_realmlist,
client_install_addon, client_install_addon,
client_status,
client_download_check,
client_plan,
client_sync,
client_download,
client_cancel,
play, play,
friends_status, friends_status,
friends_check_internet, friends_check_internet,
@@ -860,3 +1503,30 @@ pub fn run() {
.run(tauri::generate_context!()) .run(tauri::generate_context!())
.expect("error while running CoA Server Manager"); .expect("error while running CoA Server Manager");
} }
#[cfg(all(test, not(windows)))]
mod tests {
use super::unix_data_home;
use std::ffi::OsString;
use std::path::PathBuf;
fn os(s: &str) -> Option<OsString> {
Some(s.into())
}
#[test]
fn data_home_prefers_an_absolute_xdg_folder() {
assert_eq!(unix_data_home(os("/data/xdg"), os("/home/u")), PathBuf::from("/data/xdg"));
}
#[test]
fn data_home_ignores_a_relative_xdg_folder_and_falls_back_to_home() {
assert_eq!(unix_data_home(os("relative/dir"), os("/home/u")), PathBuf::from("/home/u/.local/share"));
assert_eq!(unix_data_home(None, os("/home/u")), PathBuf::from("/home/u/.local/share"));
}
#[test]
fn data_home_without_any_variable_uses_the_temp_folder() {
assert_eq!(unix_data_home(None, None), std::env::temp_dir());
}
}
Loaded 100 of 155 files, more files were not shown because too many files have changed in this diff. Show more