Compare commits

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

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

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

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

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

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

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

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

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

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

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-08 06:56:03 +05:00
Corfirean fac6ce469a Merge pull request #35 from Corfirean/release/0.6.6
Release Manager 0.6.6 (version bump)
2026-10-07 10:35:07 +05:00
ДмитрийandClaude Sonnet 5.5 f22cedd963 Release Manager 0.6.6
Version bump only. Collects: one-click diagnostics and report routing, LAN
address selector, Auction House Bot card without a GUID, experimental Linux
Docker installer, and the fixes already on master since 0.6.5.

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

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

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

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

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

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

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-06 13:35:32 +05:00
Corfirean 3f700ee8f4 Merge pull request #28 from Corfirean/codex/release-065-coordinated
Release 0.6.5: reliable update guards and coordinated SQUID integration
2026-10-06 11:19:07 +05:00
Дмитрий 277ebba847 Restore the original realm before disposable SQUID recovery 2026-10-06 10:46:04 +05:00
Дмитрий 9a0b815937 Cover initial SQUID import and bot creation in startup budget 2026-10-06 10:42:08 +05:00
Дмитрий 78b84e11c2 Add disposable SQUID provisioning and repeated-start acceptance 2026-10-06 10:20:18 +05:00
Дмитрий 6aea9011f9 Allow first SQUID startup to complete large database imports 2026-10-06 10:12:13 +05:00
Дмитрий 171d9a2bf8 Add coordinated release packaging and disposable update acceptance 2026-10-06 10:08:54 +05:00
Дмитрий 0d6d8a0db8 Harden server update history, recovery guards and repeated checks 2026-10-06 07:01:13 +05:00
Дмитрий 3940506987 fix: update legacy Manager-patched realm launchers 2026-10-06 07:01:13 +05:00
Дмитрий 654b7cddd3 Keep SQUID settings usable with unknown metadata and preserve translations 2026-10-05 18:09:36 +05:00
Дмитрий f8301d7394 Read SQUID release settings and protect imported repack binaries 2026-10-05 16:56:46 +05:00
Corfirean cd3a963f70 Merge pull request #21 from Corfirean/codex/fix-update-startup
Release Manager 0.6.4: fix server startup and resume failed validation
2026-10-05 14:07:36 +05:00
Дмитрий 6c771fae20 feat: allow launching installed server and client without updates 2026-10-05 14:01:37 +05:00
Дмитрий cfe0889a4f Fix embedded launcher startup and retry applied updates safely 2026-10-05 13:53:32 +05:00
Fabien F. f25a1d425d docs: changelog entry for the Linux installer 2026-10-05 10:10:53 +02:00
Fabien F. b5e4a38d7d feat: install a new server as a Docker installation (Linux)
docker::install is the Linux counterpart of install::install_base and shares none
of its code (the Windows installer and its folder checks are untouched). Same
order of events: signed manifest, folder / space / game data checks, verified
download, extraction into <dest>.installing, database, one rename. Docker must be
usable; a failure removes the containers, the volume and the staging folder.

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

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

Tested: 12 new tests (folder rules, settings, package checks, bulk ledger SQL,
failure cleanup with an in-memory docker), and real runs of the whole chain
through examples/docker_install: baseline dumps exported from a prepared
server, package signed with a throwaway key, installed in 171 s, started by the
Manager (database healthy, world ready in 8 s, auth up), console reached with the
account the installer created, 1630 migrations recorded as applied.
2026-10-05 10:03:09 +02:00
Corfirean 07ec22798f Merge pull request #19 from Corfirean/codex/release-all-pending
Release client-only connections and scaling controls in Manager 0.6.3
2026-10-05 03:26:16 +05:00
Дмитрий 5d865fcaea Prepare Manager 0.6.3 with remote clients and scaling settings 2026-10-05 03:15:05 +05:00
Дмитрий a67d51804b Expose partial LFG and open-world leech module settings 2026-10-05 03:09:02 +05:00
Дмитрий 7c096a4844 Merge remote-tracking branch 'origin/codex/client-only-mode' into codex/release-all-pending 2026-10-05 03:09:02 +05:00
Corfirean b90b377fc3 Merge pull request #17 from Corfirean/codex/reliable-server-updates
Recover failed updates and validate release database schemas
2026-10-05 02:38:57 +05:00
Дмитрий a02130f587 Prepare Manager 0.6.2 release 2026-10-05 02:31:56 +05:00
Дмитрий f4e36f21eb Merge remote-tracking branch 'origin/master' into codex/reliable-server-updates 2026-10-05 02:31:00 +05:00
Дмитрий 65c9945626 Validate release databases and require full schema contracts 2026-10-05 01:56:36 +05:00
Corfirean f13398bbd7 Merge pull request #13 from lostmind84/feat/linux-b2-container-db
feat: database access through the container for Docker installations
2026-10-05 01:45:07 +05:00
Дмитрий f05f94ba01 Document standalone client connections 2026-10-05 01:24:01 +05:00
Дмитрий c39a7a0ac7 Let players download and update clients without a local server 2026-10-05 01:23:31 +05:00
Дмитрий e8367354ef Record update stages and migration results for support diagnosis 2026-10-05 00:14:15 +05:00
Дмитрий 461fa035d0 Validate race-class starts and protect existing character visibility 2026-10-04 23:58:51 +05:00
Дмитрий 3edc600f97 Recover database and file updates together after failures 2026-10-04 23:55:15 +05:00
Дмитрий c3d87e1ff2 Keep bot settings release note within changelog limit 2026-10-04 20:40:54 +05:00
Дмитрий d2496603e7 Configure both bot systems exclusively in the shared Bots tab 2026-10-04 20:40:36 +05:00
Дмитрий 2eea0e117c Add translated module settings and exclusive SQUID Playerbots controls 2026-10-04 20:26:39 +05:00
Дмитрий 2e3fb24e1a Run release socket tests without parallel timing contention 2026-10-04 15:43:50 +05:00
Дмитрий 146b1c50b9 Release Manager 0.6.1 and preserve Docker lifecycle compatibility 2026-10-04 15:43:29 +05:00
Дмитрий c02c635463 Fix settings input, client launch, server repair and simultaneous realms 2026-10-04 15:40:06 +05:00
Fabien F. 58b5ddeb07 feat: database access through the container for Docker installations
Db runs mysql, mysqldump and mysqladmin inside the database container with
docker exec -i when the server folder is a Docker installation, connecting over
TCP on the container's loopback like the repack's commands do on the host. The
password still travels only in MYSQL_PWD. Every caller keeps using Db unchanged
(accounts, backups, population, migrations, the RA service account), and the
host needs no MySQL client. The repack path is untouched: one line before its
tools are looked up. A stopped container or a missing one is reported as a
database that is not running.

Tested: 4 new tests (commands built for the container, no password on a command
line, repack unchanged, error classification), and a real run against the
Docker folder: SQL queries, a quick backup (156 characters tables), restore with
the previous database kept, a damaged backup refused, the RA service account
created by SQL, the world server console reached through its published
loopback port, an account created through it and listed by the Manager.
2026-10-03 21:21:26 +02:00
Дмитрий 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
215 changed files with 19945 additions and 522 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
+1 -1
View File
@@ -21,7 +21,7 @@ jobs:
node-version: 22 node-version: 22
- run: npm ci - run: npm ci
- name: Tests - name: Tests
run: cargo test --workspace run: cargo test --workspace -- --test-threads=1
- name: Build, sign and publish - name: Build, sign and publish
uses: tauri-apps/tauri-action@v0 uses: tauri-apps/tauri-action@v0
env: env:
+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 -->
+25
View File
@@ -0,0 +1,25 @@
# CoA Server Manager changelog
## 0.6.1 — 2026-10-04
- PLAY launches only the client with the selected realmlist; starting the local server remains a separate action.
- Server multipliers accept decimals typed with a dot or comma. Talent and rested experience descriptions now explain their actual behavior.
- Added database and file checks, and Repair with backups and signed package verification. Unresolved schema damage is reported instead of guessed repairs.
- Fixed character database rebuilds retaining migration history that could skip required SQL. Applied migration hash changes are now rejected.
- Added optional simultaneous CoA and Wildcard worlds on Windows, with separate processes, ports and status indicators.
## 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
+459 -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.2.0" version = "0.6.7"
dependencies = [ dependencies = [
"base64 0.22.1", "base64 0.22.1",
"chrono", "chrono",
@@ -355,6 +499,7 @@ dependencies = [
"ed25519-dalek", "ed25519-dalek",
"fs4", "fs4",
"hex", "hex",
"if-addrs",
"num-bigint", "num-bigint",
"rand_core", "rand_core",
"reqwest 0.12.28", "reqwest 0.12.28",
@@ -375,7 +520,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-release" name = "coa-release"
version = "0.2.0" version = "0.6.7"
dependencies = [ dependencies = [
"chrono", "chrono",
"coa-core", "coa-core",
@@ -384,7 +529,7 @@ dependencies = [
[[package]] [[package]]
name = "coa-server-manager" name = "coa-server-manager"
version = "0.2.0" version = "0.6.7"
dependencies = [ dependencies = [
"coa-core", "coa-core",
"serde", "serde",
@@ -392,6 +537,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 +553,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 +1027,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 +1081,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 +1265,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 +1632,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"
@@ -1693,6 +1914,16 @@ dependencies = [
"icu_properties", "icu_properties",
] ]
[[package]]
name = "if-addrs"
version = "0.15.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "c0a05c691e1fae256cf7013d99dad472dc52d5543322761f83ec8d47eab40d2b"
dependencies = [
"libc",
"windows-sys 0.61.2",
]
[[package]] [[package]]
name = "indexmap" name = "indexmap"
version = "1.9.3" version = "1.9.3"
@@ -1731,6 +1962,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 +2696,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 +2756,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 +2805,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 +2899,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 +2965,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 +3753,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 +4258,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 +4810,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 +5688,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 +5898,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.2.0" version = "0.6.7"
edition = "2021" edition = "2021"
license = "AGPL-3.0-only" license = "AGPL-3.0-only"
+1
View File
@@ -0,0 +1 @@
@AGENTS.md
+104
View File
@@ -0,0 +1,104 @@
# Urgent update hotfix
Deadline: 2026-10-06. This checkout starts at the exact v0.6.4 tag, commit
6c771fa, and excludes the ongoing isolated-trial/recovery redesign.
The client accepts checksum compatibility only from a verified signed manifest and only
for an Applied migration. It never updates the historical checksum, reruns historical
SQL, or excuses a Running/Failed ledger row. A server package must explicitly list the
verified published variants and append corrections under new migration IDs.
Current local evidence: the locked workspace tests passed, including 252 core tests
run serially. Six frontend logic tests and the frontend production build passed.
The hotfix runtime was tested against the exact signed candidate manifest on the marked
CoA/Wildcard fixture. Both published repair checksums were accepted independently in
both worlds, with zero migration executions, unchanged historical checksums, and unchanged
account, character and inventory counts. The original ledger rows were restored after
the test, and all fixture processes were stopped. A real Running or Failed repair row in
either world was rejected before staging or creating a transaction, with unchanged world
executable and installation metadata. Tests use independent hotfix metadata so experimental
transaction formats are not confused with the 0.6.4 upgrade path. Windows journal writes also use flushed
atomic replacement with long-path support. Changelog validation passed.
Additional guards implemented:
- Read migration history without creating its ledger before downloading or replacing files.
- Reject missing journals, invalid identities, paths, hashes and inconsistent operations.
Durable completed-cleanup markers distinguish interrupted pruning from a lost journal.
- Preserve all backups while an update is unfinished or its journal is damaged.
- Verify saved-file hashes and the complete database/configuration recovery point before
stopping services or changing files/databases. New snapshots include configuration hashes;
update journals bind their backup metadata to a hash.
- Surface state-reading errors in Settings and disable applying until the disk state is
successfully read. Checking again refreshes that state.
- Verify every extracted SQL artifact before taking the update snapshot or replacing
server files; missing files, invalid IDs, duplicate migrations and checksum disagreements
reject the update early. SQL application repeats the integrity check immediately before use.
- Count unapplied migrations in the active and secondary realms, counting shared auth once.
Matching versions and files do not hide remaining database work. Preview reads history
under the installation lock; a stopped database is temporarily started for inspection
and stopped again when no game services are running.
- Reread the disk state after every update/recovery attempt, including failed attempts and
background updates. Unfinished or unreadable state blocks another application in the UI.
- Acquire the installation lock before checking and deleting a backup.
Latest real-runtime test used the independently copied, doubly marked fixture
`C:\games\coa-schema-fixture-chaos-20261005-v1` and signed candidate `0.261005.24`, manifest SHA-256
`1284b1273815209c9621b6d173a2211bae316f33462ccbe8b578e53b8d26fb5b`.
All 1748 SQL artifacts passed verification after authenticated archive extraction.
Removing one repair record separately in CoA and Wildcard increased the pending count
by exactly one; restoring its original record restored the original count. No migrations
were executed, player counts were preserved and fixture services were stopped afterward.
The source checkout remains uncommitted; these results are not an installer acceptance report.
Additional acceptance on 2026-10-06: a new independent installation/database copy at
`C:\games\coa-schema-fixture-chaos-064-transition-20261006` received the authenticated
published `0.261005.22` program files, original CRLF repair checksum, and a deliberately
missing Wildcard table in both realms. The production hotfix update pipeline committed
signed candidate `0.261005.24`, repaired both realms, passed schema checks and actual
bundled-Python server startup, and preserved the selected account, character, item and
inventory fields byte-for-byte. The fixture was stopped afterward. The harness explicitly
instruments the launcher to prevent relay submissions and bind to localhost; this is not
proof of packaged UI behavior or operating-system network containment.
Local installer `C:\games\source\manager-065-local-installer-20261006\CoA Server Manager_0.6.5_x64-setup.exe`
has SHA-256 `520ee0391d923b92da0a20591e30006c048cdb60156275d7a829918bf1b77491`.
Its updater signature and the published 0.6.4 installer's signature passed independent
verification with the configured updater public key. Both executables extracted from
their exact NSIS packages started, created responsive windows, and were stopped using
an independent application/WebView profile. No installer was executed over a user's
installation, and no UI update operation was exercised.
Legacy limitation: old 0.6.4 transaction copies and configuration snapshots without recorded
hashes can be checked for presence and declared database hashes, but their original file
contents cannot be authenticated retroactively. Missing copies block restoration. This
hotfix does not claim that old unchecksummed copies received full integrity verification.
Remaining release requirements: reproduce the existing-user failures through the published
0.6.4 interface, verify legacy unfinished transaction handling on real-runtime fixtures,
and execute the exact installer over 0.6.4 in an isolated Windows environment with UI
state/settings/server-list verification. Windows native UI automation is unavailable in
this session. Packaged startup and signature checks do not satisfy that installer gate.
No public release has been made.
The user subsequently exercised the packaged UI: candidate 0.261005.24 committed and
both CoA and Wildcard were shown running. Repeat-check/restart acceptance is still pending.
The screenshots exposed an older published package being offered after the local candidate
was installed. Follow-up changes reject older packages before preview/database inspection
and application and clear a cached offer after a failed recheck. All 253 core tests and
seven frontend tests passed. The earlier installer hash above does not include this follow-up;
a separately recorded revision is required. Native UI control was subsequently initialized
through the deferred node_repl tool, then the user stopped automation with Escape and
performed the UI check manually.
Another user repeat-check exposed the already installed launcher being offered again.
The preview now verifies canonical launcher bytes against the current signed package,
caches those bytes by SHA-256, and compares only recognized Manager transformations.
The actual disposable fixture's repeat preview passed with all 104 files skipped and
zero pending SQL. User edits, recorded custom content, and a package with different
launcher bytes are not mistaken for that integration. All 254 core tests passed;
the strengthened regression test and seven frontend tests also passed. The first
preview of a managed launcher may download/extract its authenticated package to build
the optional canonical cache. Earlier installer revisions do not include this fix.
Do not recommend deleting an installation or replacing its player databases.
+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.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Choose which item types the auction bot sells
---
Switch 15 item categories on or off and adjust listing frequency by quality. Labels and descriptions are translated into all six languages. Changes affect new listings; existing auctions remain.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server multipliers now accept decimals typed with a dot or comma
---
Talent settings now explain that the multiplier does not affect CoA talents. The rested experience setting now correctly describes bonus accumulation.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Play launches only the game client without starting your local server
---
Use the left button to start the server and PLAY to launch the client with your selected realmlist, including connections to other servers.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: Module settings now offer translated controls and an enemy damage slider
---
Configure scaling, auctions and enchantments with translated controls. Module switches no longer appear twice. Modules without settings hide their settings button; short lists need no search. New server builds support dungeon and raid damage from 25% to 200%.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Failed server updates restore databases and files together
---
Updates save a full backup and recover databases and files together. Interrupted SQL is not replayed. Checks cover Wildcard tables and every supported race/class pair, including existing characters. Unfinished updates block startup until recovered.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Check database structure and repair server files with a safety backup
---
Settings can check both realm databases and restore official files plus pending SQL. Installation and updates check character-save columns. Clean packages no longer keep old character migration records when rebuilding their database.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Configure partial dungeon parties and open-world life steal in module settings
---
Choose whether Dungeon Finder enters with the current party and enable open-world life steal with a healing percentage from 0 to 100. Available on server builds that support these options.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Start CoA and Wildcard together from Settings
---
Both worlds can run on separate ports with their own characters, settings and logs, sharing accounts. Stop saves both worlds before shutting down the shared database.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Configure SQUID Playerbots and prevent conflicting bot systems
---
The Bots tab shows translated settings for the active bot system. Bot module cards keep enable switches without duplicate settings. Enable one bot system at a time; the Manager checks manual config changes before starting the server. Recovery points also include the SQUID database when installed.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: Download and update the game client without installing a server
---
Choose to host a server or connect to someone else's. Players joining a friend can download, update and launch the client, save the host's address and use the Manager without installing a local server.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Imported SquidBots servers warn before replacing their original binary
---
Imports explain that the original launcher and updater check the server binary hash. Updating that binary requires an explicit choice to keep or replace it.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: players
title: Start your installed server or client without downloading an available update
---
Choose to update later and keep playing with your installed version. Interrupted server updates still require recovery before startup.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Install a server from a package on Linux, running in Docker (experimental)
---
Experimental. The Manager creates the database, imports the packaged baseline and starts the server in Docker containers. It needs a Linux server package and your own game data folder.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Finish a server update that was blocked by a startup failure
---
The Manager repairs the launcher import path and lets you retry startup for an already applied update. Successful validation finishes the update without replaying SQL or restoring old databases. Failure details are preserved and rollback remains available.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: SquidBots settings follow the options shipped by the module
---
New settings use the module's descriptions, groups, defaults and value limits while retaining existing translations. Unknown formats or invalid fields use built-in controls so the settings page remains available.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: SquidBots shows its bundled release and includes it in problem reports
---
The Bots and Modules pages and problem reports include the release identifiers. Imported repacks use their recorded bot revision; empty tags are hidden. The settings file's source commit is not presented as the build revision.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates accept verified published migration variants without rerunning them
---
Signed updates can recognise known published checksums without changing your migration history. Interrupted or failed SQL still requires recovery before retrying.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates replace older launchers adapted by the Manager for Wildcard
---
Updates recognize the Manager’s own realm and import adjustments even when older metadata still records the original launcher. New server binaries receive their matching launcher; genuine custom edits still require your decision.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server packages must include a complete database schema check
---
Release tools generate the expected database structure on an isolated copy of the signed base, verify all archive files and refuse packages without the schema check. Corrective SQL can restore missing Wildcard tables without replaying old updates.
@@ -0,0 +1,8 @@
---
area: manager
type: changed
audience: admins
title: The Auction House Bot card no longer asks for a character GUID
---
Turning the module and the seller on is enough: a server build with the automatic auction character creates its own account and character. The GUID field moved to the advanced settings.
The buyer option hint no longer says it spends the auction character's gold.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Choose and remember the local network address friends use to connect
---
Select an adapter or custom IPv4 address when sharing on LAN. Your choice survives restarts and mode changes; unavailable addresses show a warning instead of silently switching adapters.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: The NPC Enchanter card explains how to place and remove the NPC
---
The card now shows the two commands: `.npc add 601015` where you stand, and `.npc delete` on the targeted NPC.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Older server packages cannot replace a newer installation
---
Update checks stop offering stale packages after an update. To undo an update, use its recovery point instead of applying an older server package.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Checking again no longer offers an already installed launcher update
---
The Manager recognizes its own launcher integration while still detecting user edits and changes in newer signed packages.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Large SQUID database imports have more time to finish on first startup
---
The Manager allows up to 45 minutes when SQUID Playerbots is enabled, covering its initial database import and bot creation. Ordinary server startup and shutdown keep their existing deadlines.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Update history conflicts are detected before server files change
---
Damaged update records block changes and remain visible. Recovery checks saved copies before restoring, and unfinished updates protect backups from deletion and cleanup.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Pending database updates remain visible when the server version matches
---
SQL files are checked before replacing server files. Update and recovery attempts refresh their saved status, including errors. Backup deletion cannot race with an update.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Diagnostic files with database checks stay readable after secrets are removed
---
Removing a line that mentioned a secret could break the JSON files in a diagnostic package. Secret values are now replaced instead, so the files stay valid.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: One button collects all diagnostics, including crashes and Windows crash records
---
Report a problem collects logs, crash reports and small dumps, Windows crash records, update journals and the running server programs in one file, then shows its folder. Crashes without a server crash report are no longer missing.
+7
View File
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Problem reports go to the right project
---
Choose what the problem is about: Manager and other modules, CoA Companions, or SQUID Playerbots. The report opens in that project's GitHub page with the versions filled in. The bot system that is switched on is preselected.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Choose where backups are stored, for example on another drive
---
Backups can now live in any folder outside the server folder. Existing backups stay listed. A backups folder that you moved and linked from the old place also works again for updates.
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: Bot settings with a fixed list of values show a drop-down
---
SQUID bots 1.9 describes the chat language as a list of languages. The Manager shows it as a drop-down with names instead of a bare number.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: The bot dashboard loads completely and can be opened in the browser
---
The dashboard no longer fails on large pages, starts again after a crash left its history files empty, and its Open in the browser button works. With both realms started together the realm drop-down is hidden.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Accounts of the SQUID bots are hidden from the Accounts list
---
The RNDBOT accounts that hold the random bots no longer fill the Accounts tab, and they cannot be renamed or deleted from there.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: A Dashboard tab shows what the SQUID bots are doing
---
With SQUID Playerbots on, the Dashboard tab downloads the dashboard release that matches your bots, starts it on this computer and shows it inside the Manager.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: A stopped server stays stopped after an update, unless you ask it to start
---
Updating no longer leaves a server running that was stopped before. Settings has a switch to start it afterwards, and the client card has one to open the game after a client update.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Checking for updates no longer fails with "Something went wrong" after a crash
---
A crash or power loss could leave a damaged status file that made every database start fail. The Manager now removes such files itself, still compares the files when the database is unavailable, and shows the real reason.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates no longer stop with "has a different checksum" on the Wildcard repair
---
Servers that applied one of the two published versions of the Wildcard table repair can now update to the other. Nothing in the database changes.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: A world server started from the coa-bots folder is recognised
---
The Manager no longer reports a port conflict when the world server runs from the coa-bots folder inside the server folder, and a failed update now says that undoing it can take several minutes.
+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.
+3 -2
View File
@@ -24,14 +24,15 @@ num-bigint = "0.4"
zip = { version = "2", default-features = false, features = ["deflate"] } zip = { version = "2", default-features = false, features = ["deflate"] }
sha1 = "0.10" sha1 = "0.10"
tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "std"] } tracing-subscriber = { version = "0.3", default-features = false, features = ["fmt", "std"] }
tempfile = "3"
if-addrs = "0.15"
[dev-dependencies] [dev-dependencies]
tempfile = "3"
rand_core = { version = "0.6", features = ["getrandom"] } rand_core = { version = "0.6", features = ["getrandom"] }
ed25519-dalek = { version = "2", features = ["rand_core"] } ed25519-dalek = { version = "2", features = ["rand_core"] }
[target.'cfg(windows)'.dependencies] [target.'cfg(windows)'.dependencies]
windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_System_Threading", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock"] } windows-sys = { version = "0.60", features = ["Win32_Foundation", "Win32_Storage_FileSystem", "Win32_System_Threading", "Win32_System_SystemInformation", "Win32_System_Diagnostics_ToolHelp", "Win32_NetworkManagement_IpHelper", "Win32_Networking_WinSock"] }
[features] [features]
testkit = [] testkit = []
+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,38 @@
use std::{fs, path::PathBuf};
use coa_core::{manifest::{Kind, Manifest}, package::{self, BuildOptions}, pkgsource::{self, Source}, release, signing, Result};
fn main() -> Result<()> {
let args: Vec<String> = std::env::args().skip(1).collect();
let source = Source::Dir(args[1].clone().into());
let (previous, _) = pkgsource::fetch_manifest(&source, signing::EMBEDDED_PUBLIC_KEY)?;
let tree = PathBuf::from(&args[2]);
if args[0] == "extract" {
assert!(!tree.exists(), "Use a new release tree");
package::extract(&PathBuf::from(&args[1]), &previous, &tree, &|_, _| {})?;
println!("Verified and extracted {}: {} historical migrations", previous.version, previous.migrations.len());
return Ok(());
}
assert_eq!(args[0], "pack");
let out = PathBuf::from(&args[3]);
assert!(!out.exists(), "Release addresses must be immutable");
for migration in &previous.migrations {
let entry = previous.files.iter().find(|file| file.path.starts_with("_migrations/") && file.sha256 == migration.sha256).expect("Historical SQL entry");
assert_eq!(coa_core::fsx::sha256_file(&tree.join(&entry.path))?, entry.sha256, "Historical SQL changed: {}", migration.id);
}
let mut manifest = package::build(&tree, &out, &BuildOptions {
kind: Kind::Update, version: args[4].clone(), core_commit: Some(args[5].clone()),
bots_commit: previous.bots.and_then(|revision| revision.commit),
built_at: chrono::Utc::now().to_rfc3339(), part_size: package::DEFAULT_PART_SIZE,
migrations: previous.migrations.clone(),
}, &|line| println!("{line}"))?;
manifest.min_manager_version = "0.6.5".into();
manifest.validate()?;
coa_core::fsx::atomic_write(&out.join("manifest.json"), &serde_json::to_vec_pretty(&manifest)?)?;
let key_path = PathBuf::from(std::env::var("USERPROFILE").unwrap()).join(".coa-manager/signing/manifest-signing.key");
release::sign_manifest(&out, &fs::read_to_string(key_path)?)?;
coa_core::release_schema::verify_package(&out, signing::EMBEDDED_PUBLIC_KEY)?;
let reread: Manifest = serde_json::from_slice(&fs::read(out.join("manifest.json"))?)?;
assert_eq!(serde_json::to_value(reread.migrations)?, serde_json::to_value(previous.migrations)?);
println!("PASS: signed {}; all historical migration bytes, checksums, aliases and order preserved", manifest.version);
Ok(())
}
@@ -0,0 +1,70 @@
use std::path::{Path, PathBuf};
use coa_core::{backup, driver, fsx, Result};
fn set(root: &Path, filename: &str, values: &[(&str, &str)]) -> Result<()> {
let path = root.join("Core/configs/modules").join(filename);
let mut config = coa_core::config::parser::ConfFile::parse_bytes(&std::fs::read(&path)?)?;
for (key, value) in values { config.set(key, value, &[]); }
fsx::atomic_write(&path, config.to_text().as_bytes())
}
fn ledgers(root: &Path) -> Result<Vec<String>> {
backup::with_database(root, |db| ["acore_playerbots", "acore_world", "acore_characters"].into_iter()
.map(|schema| db.query(&format!("SELECT path,sha256 FROM `{schema}`.coa_squid_migrations ORDER BY path;"))).collect())
}
fn exercise(root: &Path) -> Result<()> {
let meta = coa_core::registry::metadata_dir_for(root)?;
let point = backup::create(root, &meta, backup::Kind::Full, backup::Trigger::Manual, Some("Disposable SQUID acceptance".into()), &|stage| println!("{stage}"))?;
assert!(backup::verify(&meta, &point.id)?.ok);
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| -> Result<()> {
backup::with_database(root, |db| db.query("DROP DATABASE IF EXISTS acore_playerbots;").map(|_| ()))?;
assert!(driver::run(root, driver::Verb::StartAll)?.ok, "Disabled SQUID must start without its database");
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
coa_core::multiworld::set_enabled(root, false)?;
coa_core::realms::select(root, coa_core::realms::Mode::Coa)?;
set(root, "mod_coa_playerbots.conf", &[("CoaBots.Enable", "0")])?;
set(root, "playerbots.conf", &[("AiPlayerbot.Enabled", "1"), ("AiPlayerbot.RandomBotAutologin", "0"), ("AiPlayerbot.MinRandomBots", "0"), ("AiPlayerbot.MaxRandomBots", "0"), ("AiPlayerbot.RandomBotGuildCount", "0"), ("AiPlayerbot.RandomBotAccountCount", "0")])?;
let started = driver::run(root, driver::Verb::StartAll)?;
assert!(started.ok, "Fresh SQUID startup: {}", coa_core::diag::redact(&started.output));
let before = ledgers(root)?;
assert!(!before[0].is_empty(), "Fresh SQUID history missing");
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
let started = driver::run(root, driver::Verb::StartAll)?;
assert!(started.ok, "Repeated SQUID startup: {}", coa_core::diag::redact(&started.output));
assert_eq!(ledgers(root)?, before, "SQUID replay changed its migration history");
println!("PASS: SQUID-disabled dual startup without its database; fresh enabled SQUID import and startup; repeated startup preserves all three histories");
Ok(())
}));
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
restore(root, &meta, &point)?;
result.map_err(|_| coa_core::Error::Invalid("SQUID acceptance failed; disposable databases and configurations restored".into()))?
}
fn restore(root: &Path, meta: &Path, point: &backup::RecoveryPoint) -> Result<()> {
assert!(backup::verify(meta, &point.id)?.ok);
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
coa_core::realms::select(root, point.realm)?;
for component in point.components.iter().filter(|component| component.name != "configs") {
backup::restore_database(root, meta, &point.id, &component.name)?;
}
backup::restore_configs(root, meta, &point.id)?;
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
println!("PASS: disposable SQUID acceptance databases and original realm configurations restored");
Ok(())
}
fn main() -> Result<()> {
let root = PathBuf::from(std::env::args().nth(1).unwrap());
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
assert_eq!(std::fs::read(root.join(".transition-fixture"))?, b"disposable published-064 transition fixture");
assert!(!root.join("Data").symlink_metadata()?.file_type().is_symlink());
assert!(driver::run(&root, driver::Verb::StopAll)?.ok);
if let Some(id) = std::env::args().nth(2) {
let meta = coa_core::registry::metadata_dir_for(&root)?;
return restore(&root, &meta, &backup::get(&meta, &id)?);
}
let result = exercise(&root);
assert!(driver::run(&root, driver::Verb::StopAll)?.ok);
result
}
@@ -0,0 +1,54 @@
use std::{collections::BTreeMap, path::PathBuf};
use coa_core::{backup, driver, registry::MetaDir, update::{self, RepackEnv}, Result};
fn players(db: &coa_core::db::Db) -> Result<String> {
db.query("SELECT CONCAT(id,':',username,':',HEX(salt),':',HEX(verifier)) FROM acore_auth.account WHERE id=900001; SELECT CONCAT(guid,':',account,':',name,':',level,':',money) FROM acore_characters.characters WHERE guid=900001; SELECT CONCAT(guid,':',itemEntry,':',owner_guid,':',enchantments) FROM acore_characters.item_instance WHERE guid=900001; SELECT CONCAT(guid,':',bag,':',slot,':',item) FROM acore_characters.character_inventory WHERE guid=900001;")
}
fn exercise(root: &std::path::Path, package: &str) -> Result<()> {
let meta_dir = coa_core::registry::metadata_dir_for(root)?;
let (_, meta) = MetaDir::open(&meta_dir)?;
let expected = backup::with_database(root, |db| [coa_core::realms::Mode::Coa, coa_core::realms::Mode::Wildcard].into_iter().map(|mode| players(&db.clone().for_realm(mode))).collect::<Result<Vec<_>>>())?;
assert!(driver::run(root, driver::Verb::StopAll)?.ok);
let source = coa_core::pkgsource::Source::Dir(package.into());
let preview = update::preview(root, &meta, &source, coa_core::signing::EMBEDDED_PUBLIC_KEY, &BTreeMap::new())?;
assert_eq!(preview.pending_migrations, 0, "Historical SQL must not replay");
assert!(!preview.items.iter().any(|item| item.action == update::Action::Conflict), "Unresolved candidate files: {:?}", preview.items);
let environment = RepackEnv { root, meta_dir: &meta_dir };
let outcome = update::apply(&update::Params {
root, meta_dir: &meta_dir, source, trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY,
resolutions: BTreeMap::new(), cancel: Default::default(), env: &environment, fail_after_ops: None,
}, &|stage, progress| println!("{progress}% {stage}"))?;
assert_eq!(outcome.txn.state, update::State::Committed, "{:?}", outcome.txn);
backup::with_database(root, |db| {
for (index, mode) in [coa_core::realms::Mode::Coa, coa_core::realms::Mode::Wildcard].into_iter().enumerate() {
let realm = db.clone().for_realm(mode);
assert_eq!(players(&realm)?, expected[index], "Player data changed in {mode:?}");
let problems = coa_core::schema_check::check(&realm, root)?;
assert!(problems.is_empty(), "{problems:?}");
}
Ok(())
})?;
let release = coa_core::squid::release(root).expect("SQUID release metadata");
println!("SQUID metadata: {release:?}");
assert_eq!(coa_core::squid::fields(root)?.len(), 40);
let (_, installed) = MetaDir::open(&meta_dir)?;
let repeated = update::preview(root, &installed, &coa_core::pkgsource::Source::Dir(package.into()), coa_core::signing::EMBEDDED_PUBLIC_KEY, &BTreeMap::new())?;
assert_eq!(repeated.pending_migrations, 0);
assert!(repeated.items.iter().all(|item| item.action == update::Action::Skip), "{:?}", repeated.items);
println!("PASS: coordinated update committed, both realms started, player fields preserved, historical SQL skipped, repeated preview clean");
Ok(())
}
fn main() -> Result<()> {
let args: Vec<String> = std::env::args().skip(1).collect();
let root = PathBuf::from(&args[0]);
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
assert_eq!(std::fs::read(root.join(".transition-fixture"))?, b"disposable published-064 transition fixture");
assert_eq!(std::fs::read(root.join(".release-schema-fixture"))?, b"disposable release-schema fixture");
assert!(!root.join("Data").symlink_metadata()?.file_type().is_symlink());
assert!(driver::run(&root, driver::Verb::StopAll)?.ok);
let outcome = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| exercise(&root, &args[1])));
assert!(driver::run(&root, driver::Verb::StopAll)?.ok, "Fixture shutdown failed");
outcome.map_err(|_| coa_core::Error::Invalid("Disposable coordinated acceptance failed; stopped services and retained recovery copies".into()))?
}
@@ -0,0 +1,21 @@
//! Install a new Docker server from a package folder, for a manual end-to-end check on Linux (needs docker).
//! usage: docker_install <package folder> <destination> <game data folder> <public key (base64)>
//! The key is the one the package was signed with (the production key is only used by the Manager itself).
use coa_core::docker::install::{install, Params};
use coa_core::download::Cancel;
use coa_core::install::Source;
use coa_core::registry::Registry;
use std::path::PathBuf;
fn main() {
let a: Vec<String> = std::env::args().skip(1).collect();
assert!(a.len() == 4, "usage: docker_install <package folder> <destination> <game data folder> <public key>");
let registry = Registry::at(std::env::temp_dir().join("coa-docker-install/installs.json"));
let t = std::time::Instant::now();
let done = install(
&Params { source: Source::Dir(PathBuf::from(&a[0])), dest: PathBuf::from(&a[1]), data_dir: PathBuf::from(&a[2]), trusted_key: &a[3], registry: &registry, cancel: Cancel::default() },
&|s| eprintln!(" {:>3}% {} {}", s.percent, s.step, s.detail.unwrap_or_default()),
)
.unwrap_or_else(|e| panic!("install failed: {e}"));
println!("installed {} at {} in {:?}", done.version, done.path, t.elapsed());
}
@@ -0,0 +1,93 @@
//! Verify published checksum compatibility on a disposable real database, without running SQL migrations.
use std::{path::{Path, PathBuf}, sync::atomic::{AtomicUsize, Ordering}};
use coa_core::{backup, db::Db, migrations::{self, LedgerRow, Status, Store}, pkgsource::{self, Source}, Result};
struct Observed<'a> { db: &'a Db, executions: AtomicUsize }
impl Store for Observed<'_> {
fn load(&self) -> Result<Vec<LedgerRow>> { self.db.load() }
fn put(&self, row: &LedgerRow) -> Result<()> { self.db.put(row) }
fn run_file(&self, _: &str, _: &Path) -> Result<()> {
self.executions.fetch_add(1, Ordering::SeqCst);
panic!("Historical SQL must never be replayed");
}
}
fn main() -> Result<()> {
let args: Vec<_> = std::env::args().skip(1).collect();
let root = PathBuf::from(&args[0]);
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-"));
assert_eq!(std::fs::read(root.join(".coa-chaos-fixture"))?, b"disposable update chaos fixture");
assert_eq!(std::fs::read(root.join(".release-schema-fixture"))?, b"disposable release-schema fixture");
let source = Source::Dir(PathBuf::from(&args[1]));
let package = pkgsource::fetch_manifest(&source, coa_core::signing::EMBEDDED_PUBLIC_KEY)?.0;
let staging = tempfile::tempdir()?;
let parts = pkgsource::fetch_parts(&source, &package, &staging.path().join("download"), &Default::default(), &|_, _| {})?;
coa_core::package::extract(&parts, &package, &staging.path().join("tree"), &|_, _| {})?;
migrations::verify_files(&package.migrations, &staging.path().join("tree/_migrations"))?;
println!("PASS: all {} signed-package SQL artifacts verified before any database mutation", package.migrations.len());
let migration = package.migrations.iter().find(|m| m.id == "manager_repair__20261005_missing_wildcard_tables").unwrap();
let hashes = ["c1d8dbf2271234283a48a39e4b4aea1106b83b70581f1e3c4aa9fff438e8e4d2", "9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638"];
for hash in hashes { assert!(migration.sha256 == hash || migration.compatible_sha256.iter().any(|h| h == hash)); }
let fixture_meta = coa_core::registry::metadata_dir_for(&root)?;
let test_meta = tempfile::tempdir()?;
coa_core::fsx::atomic_write(&test_meta.path().join("install.json"), &std::fs::read(fixture_meta.join("install.json"))?)?;
coa_core::registry::MetaDir::open(test_meta.path())?;
std::fs::create_dir_all(test_meta.path().join("updates"))?;
let result = backup::with_database(&root, |db| {
let mut modes = vec![coa_core::realms::Mode::Coa];
if coa_core::realms::state(&root)?.wildcard_created { modes.push(coa_core::realms::Mode::Wildcard); }
for mode in modes {
let db = db.clone().for_realm(mode);
let saved = db.load()?.into_iter().find(|row| row.id == migration.id && row.db == migration.db).expect("Published repair must already be applied");
assert_eq!(saved.status, Status::Applied);
let counts = db.query("SELECT CONCAT((SELECT COUNT(*) FROM acore_characters.characters),':',(SELECT COUNT(*) FROM acore_characters.item_instance),':',(SELECT COUNT(*) FROM acore_auth.account));")?;
let check = || -> Result<()> {
for hash in hashes {
db.put(&LedgerRow { sha256: hash.into(), ..saved.clone() })?;
let observed = Observed { db: &db, executions: AtomicUsize::new(0) };
migrations::preflight(&db, std::slice::from_ref(migration))?;
let report = migrations::apply_pending(&observed, std::slice::from_ref(migration), &root.join(".unused-hotfix-sql"), &|| panic!("Already applied SQL needs no snapshot"))?;
assert!(report.applied.is_empty());
assert_eq!(observed.executions.load(Ordering::SeqCst), 0);
assert_eq!(db.load()?.into_iter().find(|r| r.id == migration.id && r.db == migration.db).unwrap().sha256, hash);
}
let meta = test_meta.path();
let file_hash = coa_core::fsx::sha256_file(&root.join("Core/worldserver.exe"))?;
let install_hash = coa_core::fsx::sha256_file(&meta.join("install.json"))?;
let transaction_count = std::fs::read_dir(meta.join("updates"))?.count();
for status in [Status::Running, Status::Failed] {
db.put(&LedgerRow { status, ..saved.clone() })?;
let env = coa_core::update::RepackEnv { root: &root, meta_dir: meta };
let rejected = coa_core::update::apply(&coa_core::update::Params {
root: &root, meta_dir: meta, source: Source::Dir(PathBuf::from(&args[1])),
trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY, cancel: Default::default(),
resolutions: Default::default(), env: &env, fail_after_ops: None,
}, &|_, _| {});
let message = rejected.unwrap_err().to_string();
assert!(message.contains("partially applied"), "Unexpected rejection: {message}");
assert_eq!(std::fs::read_dir(meta.join("updates"))?.count(), transaction_count);
assert_eq!(coa_core::fsx::sha256_file(&root.join("Core/worldserver.exe"))?, file_hash);
assert_eq!(coa_core::fsx::sha256_file(&meta.join("install.json"))?, install_hash);
}
db.put(&saved)?;
let env = coa_core::update::RepackEnv { root: &root, meta_dir: meta };
let pending_before = env.pending_migrations(&package)?;
db.query("DELETE FROM acore_world.coa_manager_migrations WHERE db='characters' AND id='manager_repair__20261005_missing_wildcard_tables';")?;
assert_eq!(env.pending_migrations(&package)?, pending_before + 1,
"Missing history in either realm must remain visible even with identical server files");
db.put(&saved)?;
assert_eq!(env.pending_migrations(&package)?, pending_before);
Ok(())
};
let result = std::panic::catch_unwind(std::panic::AssertUnwindSafe(check));
db.put(&saved)?;
result.map_err(|_| coa_core::Error::Invalid("History regression assertion failed; the injected ledger row was restored.".into()))??;
assert_eq!(db.query("SELECT CONCAT((SELECT COUNT(*) FROM acore_characters.characters),':',(SELECT COUNT(*) FROM acore_characters.item_instance),':',(SELECT COUNT(*) FROM acore_auth.account));")?, counts);
println!("PASS: {} published checksums; Running/Failed rejected before staging; missing migration counted; zero SQL replays; history and player counts preserved", mode.name());
}
Ok(())
});
assert!(coa_core::driver::run(&root, coa_core::driver::Verb::StopAll)?.ok);
result?;
Ok(())
}
@@ -0,0 +1,16 @@
//! Read-only update preview against the marked disposable acceptance fixture.
use std::{collections::BTreeMap,path::PathBuf};
fn main()->coa_core::Result<()> {
let args:Vec<_>=std::env::args().skip(1).collect();
let root=PathBuf::from(&args[0]);
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
assert_eq!(std::fs::read(root.join(".transition-fixture"))?,b"disposable published-064 transition fixture");
let meta_dir=coa_core::registry::metadata_dir_for(&root)?;
let (_,meta)=coa_core::registry::MetaDir::open(&meta_dir)?;
let preview=coa_core::update::preview(&root,&meta,&coa_core::pkgsource::Source::Dir(args[1].clone().into()),coa_core::signing::EMBEDDED_PUBLIC_KEY,&BTreeMap::new())?;
assert_eq!(preview.from_version.as_deref(),Some(preview.to_version.as_str()));
assert_eq!(preview.pending_migrations,0);
assert!(preview.items.iter().all(|item|item.action==coa_core::update::Action::Skip),"{:?}",preview.items.iter().filter(|item|item.action!=coa_core::update::Action::Skip).collect::<Vec<_>>());
println!("PASS: real fixture repeated preview: {} files unchanged, zero pending SQL, no update offered",preview.items.len());
Ok(())
}
@@ -0,0 +1,165 @@
//! Real signed-package transition on an independent, explicitly marked disposable copy.
//! The Env wrapper instruments only launcher isolation; migration/backup/update code is production code.
use std::{collections::BTreeMap, path::{Path, PathBuf}};
use coa_core::{backup, driver, fsx, migrations, pkgsource::{self, Source}, registry::{InstallMeta, MetaDir}, update::{self, Env, RepackEnv}, Result};
struct Offline<'a>(RepackEnv<'a>);
impl Env for Offline<'_> {
fn ensure_stopped(&self) -> Result<()> { self.0.ensure_stopped() }
fn preflight(&self, m: &coa_core::manifest::Manifest) -> Result<()> { self.0.preflight(m) }
fn verify_snapshot(&self, id: &str) -> Result<()> { self.0.verify_snapshot(id) }
fn snapshot(&self) -> Result<String> { self.0.snapshot() }
fn restore_snapshot(&self, id: &str) -> Result<()> { self.0.restore_snapshot(id) }
fn migrate(&self, m: &coa_core::manifest::Manifest, p: &Path) -> Result<migrations::ApplyReport> { self.0.migrate(m,p) }
fn validate(&self) -> Result<()> {
let path=self.0.root.join("Scripts/manage.py");
let source=std::fs::read_to_string(&path)?.replace("\r\n", "\n");
// Explicit test instrumentation prevents relay transmissions and binds services locally.
let guarded=source.replace("def spawn(name, command, cwd, log):\n", "def spawn(name, command, cwd, log):\n for filename in ('worldserver.conf', 'authserver.conf'):\n path = ROOT / 'Core/configs' / filename\n if path.exists():\n text = path.read_text(encoding='utf-8-sig')\n for key, value in (('BindIP', '\"127.0.0.1\"'), ('Ra.IP', '\"127.0.0.1\"'), ('SOAP.Enabled', '0')):\n text = re.sub(r'(?m)^\\s*' + re.escape(key) + r'\\s*=.*$', '', text)\n text += '\\n' + key + ' = ' + value + '\\n'\n path.write_text(text, encoding='utf-8')\n").replace("def relay_worker():\n", "def relay_worker():\n save_process('relay-ready', os.getpid())\n while not (STATE / 'stop-relay').exists():\n time.sleep(0.5)\n return\n");
assert_ne!(source,guarded,"Fixture launcher isolation failed");
fsx::atomic_write(&path,guarded.as_bytes())?;
self.0.validate()
}
}
fn players(db: &coa_core::db::Db) -> Result<String> {
db.query("SELECT CONCAT(id,':',username,':',HEX(salt),':',HEX(verifier)) FROM acore_auth.account WHERE id=900001; SELECT CONCAT(guid,':',account,':',name,':',level,':',money) FROM acore_characters.characters WHERE guid=900001; SELECT CONCAT(guid,':',itemEntry,':',owner_guid,':',enchantments) FROM acore_characters.item_instance WHERE guid=900001; SELECT CONCAT(guid,':',bag,':',slot,':',item) FROM acore_characters.character_inventory WHERE guid=900001;")
}
fn main() -> Result<()> {
let args:Vec<_>=std::env::args().skip(1).collect();
let root=PathBuf::from(&args[0]);
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-chaos-064-transition-"));
assert_eq!(std::fs::read(root.join(".transition-fixture"))?,b"disposable published-064 transition fixture");
if args.get(3).is_some_and(|mode| mode=="legacy-recovery") {
return run_fixture(&root,||legacy_recovery(&root));
}
assert!(!root.join(".transition-started").exists(),"Use a new independent fixture");
fsx::atomic_write(&root.join(".transition-started"),b"started")?;
let meta=coa_core::registry::metadata_dir_for(&root)?;
assert!(!meta.exists(),"Do not reuse experimental or user metadata");
run_fixture(&root,||exercise(&root,&meta,&args[1],&args[2]))
}
fn run_fixture(root:&Path,operation:impl FnOnce()->Result<()>)->Result<()> {
let result=std::panic::catch_unwind(std::panic::AssertUnwindSafe(operation));
assert!(driver::run(root,driver::Verb::StopAll)?.ok,"Fixture shutdown failed");
result.map_err(|_|coa_core::Error::Invalid("Disposable acceptance assertion failed; services were stopped and recovery copies retained.".into()))?
}
fn legacy_recovery(root:&Path)->Result<()> {
let meta=coa_core::registry::metadata_dir_for(root)?;
assert!(driver::run(root,driver::Verb::StopAll)?.ok);
let expected=backup::with_database(root,|db| [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard].into_iter().map(|mode|players(&db.clone().for_realm(mode))).collect::<Result<Vec<_>>>())?;
assert!(driver::run(root,driver::Verb::StopAll)?.ok);
let dirs=std::fs::read_dir(meta.join("updates"))?.collect::<std::io::Result<Vec<_>>>()?;
assert_eq!(dirs.len(),1,"Requires exactly the preceding successful disposable transition");
let txn_dir=dirs[0].path();
let journal=txn_dir.join("txn.json");
let mut legacy:serde_json::Value=fsx::read_json(&journal)?;
assert_eq!(legacy["state"],"committed");
let point=legacy["recovery_point"].as_str().unwrap().to_string();
let point_path=meta.join("backups").join(&point).join("backup.json");
let mut point_json:serde_json::Value=fsx::read_json(&point_path)?;
point_json["manager_version"]="0.6.4".into();
for component in point_json["components"].as_array_mut().unwrap() { component.as_object_mut().unwrap().remove("file_sha256"); }
fsx::atomic_write_json(&point_path,&point_json)?;
legacy.as_object_mut().unwrap().remove("recovery_hashes");
legacy.as_object_mut().unwrap().remove("databases_started");
legacy["state"]="applied".into();
fsx::atomic_write_json(&journal,&legacy)?;
assert!(update::ensure_recovered(&meta).is_err(),"Legacy unfinished update must block startup");
let id=legacy["id"].as_str().unwrap();
let env=RepackEnv {root,meta_dir:&meta};
println!("Recovering legacy-format transaction and recovery point on disposable installation");
assert_eq!(update::rollback(root,&meta,id,&env)?.state,update::State::RolledBack);
for op in legacy["ops"].as_array().unwrap() {
let relative=op["path"].as_str().unwrap();
if op["had_previous"]==true {
assert_eq!(fsx::sha256_file(&fsx::safe_join(root,relative)?)?,fsx::sha256_file(&fsx::safe_join(&txn_dir.join("before"),relative)?)?,"Legacy file restoration mismatch: {relative}");
} else { assert!(!fsx::safe_join(root,relative)?.exists()); }
}
assert_eq!(std::fs::read(meta.join("install.json"))?,std::fs::read(txn_dir.join("before/manager-install.json"))?);
backup::with_database(root,|db| {
for (index,mode) in [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard].into_iter().enumerate() {
let db=db.clone().for_realm(mode);
assert_eq!(players(&db)?,expected[index]);
assert_eq!(db.query("SELECT COUNT(*) FROM acore_world.coa_manager_migrations WHERE id IN ('manager_repair__20261005_reconcile_wildcard_tables','manager_repair__20261005_reconcile_missing_class_starts');")?,"0");
assert_eq!(db.query("SELECT sha256 FROM acore_world.coa_manager_migrations WHERE id='manager_repair__20261005_missing_wildcard_tables';")?,"9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638");
}
Ok(())
})?;
assert!(driver::run(root,driver::Verb::StopAll)?.ok);
assert!(update::pending_checked(&meta)?.is_none());
assert!(update::rollback(root,&meta,id,&env).is_err(),"Completed recovery must not run again");
println!("PASS: legacy journal blocked startup; old files, metadata, migration histories and player fields restored; completed recovery rejects replay. Original baseline had a missing table, so healthy startup is not claimed after rollback.");
Ok(())
}
fn exercise(root:&Path,meta:&Path,baseline:&str,candidate:&str)->Result<()> {
let mut install:InstallMeta=fsx::read_json(&PathBuf::from("C:/games/coa-schema-fixture-chaos-20261005-v1.manager/install.json"))?;
install.server_path=root.to_string_lossy().into_owned();
install.id=uuid::Uuid::new_v4().to_string();
install.manager_version="0.6.4".into();
MetaDir::create(root,&install)?;
// Private ports, and no inherited PID records or paths to the source database.
let mut cfg:serde_json::Value=fsx::read_json(&root.join("Settings/repack.json"))?;
let mut listeners=Vec::new();
for key in ["mysqlPort","authPort","worldPort","raPort"] {
let listener=std::net::TcpListener::bind("127.0.0.1:0")?;
cfg[key]=listener.local_addr()?.port().into(); listeners.push(listener);
}
fsx::atomic_write_json(&root.join("Settings/repack.json"),&cfg)?;
let mut profile:serde_json::Value=fsx::read_json(&root.join("Settings/realm-profile.json"))?;
for key in ["secondary_world_port","secondary_ra_port"] {
let listener=std::net::TcpListener::bind("127.0.0.1:0")?;
profile[key]=listener.local_addr()?.port().into(); listeners.push(listener);
}
fsx::atomic_write_json(&root.join("Settings/realm-profile.json"),&profile)?;
drop(listeners);
let state=root.join(".state");
if state.exists() { std::fs::remove_dir_all(&state)?; }
let secondary_state=root.join(".realms/secondary/.state");
if secondary_state.exists() { std::fs::remove_dir_all(&secondary_state)?; }
let source=Source::Dir(baseline.into());
let (manifest,_)=pkgsource::fetch_manifest(&source,coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
let temp=tempfile::tempdir()?;
let parts=pkgsource::fetch_parts(&source,&manifest,&temp.path().join("download"),&Default::default(),&|_,_|{})?;
let tree=temp.path().join("tree");
coa_core::package::extract(&parts,&manifest,&tree,&|_,_|{})?;
for file in &manifest.files {
if file.path.starts_with("_migrations/") {continue;}
fsx::atomic_write(&fsx::safe_join(root,&file.path)?,&std::fs::read(fsx::safe_join(&tree,&file.path)?)?)?;
install.original_hashes.insert(file.path.clone(),file.sha256.clone());
}
install.core.version=Some(manifest.version);
fsx::atomic_write_json(&meta.join("install.json"),&install)?;
// Both worlds must remain local, including generated secondary configuration.
for relative in ["Settings/worldserver.conf.template","Settings/authserver.conf.template"] {
let p=root.join(relative);
let mut conf=coa_core::config::parser::ConfFile::parse_bytes(&std::fs::read(&p)?)?;
conf.set("BindIP","\"127.0.0.1\"",&[]); conf.set("Ra.IP","\"127.0.0.1\"",&[]); conf.set("SOAP.Enabled","0",&[]);
fsx::atomic_write(&p,conf.to_text().as_bytes())?;
}
let expected=backup::with_database(root,|db| {
let mut saved=Vec::new();
for mode in [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard] {
let db=db.clone().for_realm(mode);
saved.push(players(&db)?);
db.query("DROP TABLE IF EXISTS acore_characters.coa_wildcard_skill_card; DELETE FROM acore_world.coa_manager_migrations WHERE id IN ('manager_repair__20261005_reconcile_wildcard_tables','manager_repair__20261005_reconcile_missing_class_starts'); UPDATE acore_world.coa_manager_migrations SET sha256='9e4a36245c3f83255415c122c01f08ceb3e3b83898d3d427ac4e2fbcf61e9638' WHERE id='manager_repair__20261005_missing_wildcard_tables' AND status='applied';")?;
}
Ok(saved)
})?;
let source=Source::Dir(candidate.into());
let candidate_manifest=pkgsource::fetch_manifest(&source,coa_core::signing::EMBEDDED_PUBLIC_KEY)?.0;
let choices:BTreeMap<_,_>=update::plan(root,&install,&candidate_manifest,&BTreeMap::new(),None)?.into_iter().filter(|p|p.action==update::Action::Conflict).map(|p|(p.path,update::Resolution::Replace)).collect();
let env=Offline(RepackEnv{root,meta_dir:meta});
let outcome=update::apply(&update::Params {root,meta_dir:meta,source,trusted_key:coa_core::signing::EMBEDDED_PUBLIC_KEY,cancel:Default::default(),resolutions:choices,env:&env,fail_after_ops:None},&|stage,pct|println!("{pct}% {stage}"))?;
assert_eq!(outcome.txn.state,update::State::Committed,"{:?}",outcome.txn.message);
backup::with_database(root,|db| {
for (index,mode) in [coa_core::realms::Mode::Coa,coa_core::realms::Mode::Wildcard].into_iter().enumerate() {
let db=db.clone().for_realm(mode);
assert_eq!(players(&db)?,expected[index],"Player data changed in {}",mode.name());
assert!(coa_core::schema_check::check(&db,root)?.is_empty());
assert_eq!(migrations::pending_count(&db,&candidate_manifest.migrations)?,0);
}
Ok(())
})?;
println!("PASS: signed historical package to candidate; missing Wildcard table repaired in both realms; player fields and inventory preserved; schema and startup verified. Launcher isolation was test instrumentation, not packaged UI acceptance.");
Ok(())
}
+1 -1
View File
@@ -29,7 +29,7 @@ fn main() {
let dst = staging.join(db).join(format!("{id}.sql")); let dst = staging.join(db).join(format!("{id}.sql"));
std::fs::create_dir_all(dst.parent().unwrap()).unwrap(); std::fs::create_dir_all(dst.parent().unwrap()).unwrap();
std::fs::write(&dst, &bytes).unwrap(); std::fs::write(&dst, &bytes).unwrap();
list.push(Migration { id, db: db.into(), sha256: fsx::sha256_bytes(&bytes), destructive: false }); list.push(Migration { compatible_sha256: vec![], id, db: db.into(), sha256: fsx::sha256_bytes(&bytes), destructive: false });
}; };
for (kind, dirs) in [("auth", ["db_auth", "pending_db_auth"]), ("characters", ["db_characters", "pending_db_characters"]), ("world", ["db_world", "pending_db_world"])] { for (kind, dirs) in [("auth", ["db_auth", "pending_db_auth"]), ("characters", ["db_characters", "pending_db_characters"]), ("world", ["db_world", "pending_db_world"])] {
for d in dirs { for d in dirs {
@@ -0,0 +1,43 @@
//! Probe only a disposable fixture: enable both worlds, verify isolation, gracefully stop both.
use coa_core::{Error, Result, driver::{self, Verb}, realms::{self, Mode}, multiworld, process::{self, ServiceState}};
use std::path::PathBuf;
fn main() -> Result<()> {
let root = PathBuf::from(std::env::args().nth(1).ok_or_else(|| Error::Invalid("fixture path required".into()))?);
if !root.file_name().is_some_and(|n| n.to_string_lossy().contains("fixture")) { return Err(Error::Invalid("Refusing a non-fixture server.".into())); }
let action = std::env::args().nth(2).unwrap_or_else(|| "smoke".into());
if action == "stop" { driver::run(&root, Verb::StopAll)?; return Ok(()); }
driver::run(&root, Verb::StopAll)?;
if action == "wildcard" { realms::select(&root, Mode::Wildcard)?; }
multiworld::set_enabled(&root, true)?;
let result = (|| {
let out = driver::run(&root, Verb::StartAll)?;
if !out.ok { return Err(Error::Invalid(out.output)); }
let first = process::observe(&root, &coa_core::layout::read_ports(&root));
let second_root = multiworld::root(&root);
let second = process::observe(&second_root, &coa_core::layout::read_ports(&second_root));
assert_eq!(first.world.state, ServiceState::Running);
assert_eq!(second.world.state, ServiceState::Running);
assert_ne!(first.world.pid, second.world.pid);
assert_ne!(first.world.port, second.world.port);
assert!(second.mysql.pid.is_none() && second.auth.pid.is_none());
let db = coa_core::db::Db::from_repack(&root, coa_core::db::Account::Admin)?;
let realms = db.query("SELECT id,port,flag FROM acore_auth.realmlist WHERE id IN (1,2) ORDER BY id;")?;
println!("Two distinct world PIDs; shared auth/MySQL; realm rows:\n{realms}");
for mode in [Mode::Coa, Mode::Wildcard] {
let problems = coa_core::schema_check::check(&db.clone().for_realm(mode), &root)?;
println!("{}: {} database problems", mode.name(), problems.len());
for p in problems.iter().take(5) { println!("{}.{}.{}: {}", p.database, p.table, p.column, p.detail); }
}
assert!(multiworld::set_enabled(&root, false).is_err());
assert!(realms::select(&root, Mode::Wildcard).is_err());
Ok(())
})();
let stopped = driver::run(&root, Verb::StopAll)?;
if !stopped.ok { return Err(Error::Invalid(stopped.output)); }
assert!(!multiworld::is_running(&root));
assert_eq!(process::observe(&root, &coa_core::layout::read_ports(&root)).mysql.state, ServiceState::Stopped);
result?;
println!("Both worlds shut down before the shared database.");
Ok(())
}
+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 { compatible_sha256: vec![], 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(())
}
+62
View File
@@ -0,0 +1,62 @@
//! Signed-package repair smoke test. Only a disposable fixture may be used.
use std::path::PathBuf;
use base64::{engine::general_purpose::STANDARD, Engine};
use ed25519_dalek::{Signer, SigningKey};
use coa_core::{Result, Error, fsx, package::{self, BuildOptions}, manifest::{Kind, Migration}, registry::{InstallKind, InstallMeta, MetaDir, metadata_dir_for}, pkgsource::Source, realms::Mode};
fn main() -> Result<()> {
let root = PathBuf::from(std::env::args().nth(1).ok_or_else(|| Error::Invalid("fixture path required".into()))?);
if !root.file_name().is_some_and(|n| n.to_string_lossy().contains("fixture")) { return Err(Error::Invalid("Refusing a non-fixture server.".into())); }
let work = tempfile::tempdir()?;
let base_tree = work.path().join("base-tree");
let update_tree = work.path().join("update-tree");
let base_pkg = work.path().join("base-pkg");
let update_pkg = work.path().join("update-pkg");
let probe = "Core/reference/repair-e2e.txt";
fsx::atomic_write(&base_tree.join(probe), b"base")?;
fsx::atomic_write(&update_tree.join(probe), b"correct official file")?;
let sql = "CREATE TABLE IF NOT EXISTS acore_world.manager_repair_probe (id INT PRIMARY KEY); INSERT IGNORE INTO acore_world.manager_repair_probe VALUES (42);";
let id = "20261004_repair_e2e";
fsx::atomic_write(&update_tree.join(format!("_migrations/world/{id}.sql")), sql.as_bytes())?;
let options = |kind, version: &str, migrations| BuildOptions { kind, version: version.into(), core_commit: None, built_at: "fixture".into(), part_size: 1 << 20, bots_commit: None, migrations };
let base = package::build(&base_tree, &base_pkg, &options(Kind::Base, "1.0.0", vec![]), &|_| {})?;
let update = package::build(&update_tree, &update_pkg, &options(Kind::Update, "1.0.1", vec![Migration { compatible_sha256: vec![], id: id.into(), db: "world".into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false }]), &|_| {})?;
// A test-only trust key, unrelated to production signing material.
let key = SigningKey::from_bytes(&[23; 32]);
let public = STANDARD.encode(key.verifying_key().as_bytes());
for pkg in [&base_pkg, &update_pkg] {
fsx::atomic_write(&pkg.join("manifest.json.sig"), STANDARD.encode(key.sign(&std::fs::read(pkg.join("manifest.json"))?).to_bytes()).as_bytes())?;
}
let dir = metadata_dir_for(&root)?;
let mut meta = InstallMeta::new(InstallKind::New, &root);
meta.core.version = Some(update.version.clone());
MetaDir::create(&root, &meta)?;
fsx::atomic_write_json(&dir.join("manifests/base.json"), &base)?;
fsx::atomic_write_json(&dir.join("manifests/update-1.0.1.json"), &update)?;
fsx::atomic_write(&root.join(probe), b"corrupted")?;
let settings = std::fs::read(root.join("Settings/repack.json"))?;
let counts = coa_core::backup::with_database(&root, |db| db.query("SELECT COUNT(*) FROM acore_auth.account; SELECT COUNT(*) FROM acore_characters.characters; SELECT COUNT(*) FROM acore_characters_wildcard.characters;"))?;
let report = coa_core::repair::run(&root, &dir, &Source::Dir(base_pkg), &Source::Dir(update_pkg), &public, &|s,p| println!("{p}% {s}"))?;
assert_eq!(std::fs::read(root.join(probe))?, b"correct official file");
assert!(report.error.is_none(), "{:?}", report.error);
assert_eq!(report.applied.len(), 2, "Migration must run in both worlds");
assert!(report.database.iter().all(|d| d.problems.is_empty() && d.migrations.iter().all(|m| m.status == coa_core::migrations::Status::Applied)));
assert_eq!(std::fs::read(root.join("Settings/repack.json"))?, settings);
assert!(coa_core::backup::verify(&dir, &report.backup)?.ok);
coa_core::backup::with_database(&root, |db| {
assert_eq!(db.query("SELECT COUNT(*) FROM acore_auth.account; SELECT COUNT(*) FROM acore_characters.characters; SELECT COUNT(*) FROM acore_characters_wildcard.characters;")?, counts);
for mode in [Mode::Coa, Mode::Wildcard] {
assert_eq!(db.clone().for_realm(mode).query("SELECT id FROM acore_world.manager_repair_probe;")?, "42");
}
// Corrupt only the second realm, proving that checks read its actual schema.
let wildcard = db.clone().for_realm(Mode::Wildcard);
wildcard.query("ALTER TABLE acore_characters.character_action DROP COLUMN type;")?;
let problems = coa_core::schema_check::check(&wildcard, &root)?;
assert!(problems.iter().any(|p| p.table == "character_action" && p.column == "type"));
assert!(coa_core::schema_check::check(&db.clone().for_realm(Mode::Coa), &root)?.is_empty());
wildcard.query("ALTER TABLE acore_characters.character_action ADD COLUMN type TINYINT UNSIGNED NOT NULL DEFAULT 0;")?;
Ok(())
})?;
println!("Repair verified: signed file restored, both realms migrated, backup valid, accounts/characters/settings preserved, missing column isolated to its realm.");
Ok(())
}
+26
View File
@@ -0,0 +1,26 @@
//! Check full schema contracts and blocking custom columns, only against a disposable fixture.
use coa_core::{Result, Error, backup, schema_check, realms::Mode};
use std::path::PathBuf;
fn main() -> Result<()> {
let root = PathBuf::from(std::env::args().nth(1).ok_or_else(|| Error::Invalid("fixture path required".into()))?);
if !root.file_name().is_some_and(|n| n.to_string_lossy().contains("fixture")) { return Err(Error::Invalid("Refusing a non-fixture server.".into())); }
backup::with_database(&root, |db| {
let coa = db.clone().for_realm(Mode::Coa);
let wildcard = db.clone().for_realm(Mode::Wildcard);
assert!(schema_check::check(&coa, &root)?.is_empty());
assert!(schema_check::check(&wildcard, &root)?.is_empty());
let reference = tempfile::tempdir()?;
schema_check::capture(&coa, reference.path())?;
assert!(schema_check::check(&coa, reference.path())?.is_empty());
wildcard.query("ALTER TABLE acore_characters.character_action ADD COLUMN manager_required INT NOT NULL;")?;
let result = (|| {
assert!(schema_check::check(&wildcard, &root)?.iter().any(|p| p.table == "character_action" && p.column == "manager_required"));
assert!(schema_check::check(&coa, &root)?.is_empty());
Ok(())
})();
wildcard.query("ALTER TABLE acore_characters.character_action DROP COLUMN manager_required;")?;
result
})?;
println!("Full schema contract and a blocking NOT NULL column verified; second-realm corruption does not affect CoA checks.");
Ok(())
}
+1 -1
View File
@@ -33,7 +33,7 @@ fn main() {
let sql = "CREATE TABLE IF NOT EXISTS coa_manager_update_test (id INT PRIMARY KEY); INSERT IGNORE INTO coa_manager_update_test VALUES (1);"; let sql = "CREATE TABLE IF NOT EXISTS coa_manager_update_test (id INT PRIMARY KEY); INSERT IGNORE INTO coa_manager_update_test VALUES (1);";
put(&src, "_migrations/world/2026_09_30_00_update_e2e.sql", sql); put(&src, "_migrations/world/2026_09_30_00_update_e2e.sql", sql);
let mut m = build(&src, &pkg, &BuildOptions { kind: Kind::Update, version: "0.2.0".into(), core_commit: None, built_at: chrono::Utc::now().to_rfc3339(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap(); let mut m = build(&src, &pkg, &BuildOptions { kind: Kind::Update, version: "0.2.0".into(), core_commit: None, built_at: chrono::Utc::now().to_rfc3339(), part_size: 1 << 20, bots_commit: None, migrations: vec![] }, &|_| {}).unwrap();
m.migrations.push(Migration { id: "2026_09_30_00_update_e2e".into(), db: "world".into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false }); m.migrations.push(Migration { compatible_sha256: vec![], id: "2026_09_30_00_update_e2e".into(), db: "world".into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false });
std::fs::write(pkg.join("manifest.json"), serde_json::to_vec_pretty(&m).unwrap()).unwrap(); std::fs::write(pkg.join("manifest.json"), serde_json::to_vec_pretty(&m).unwrap()).unwrap();
let key = format!("{}/.coa-manager/signing/manifest-signing.key", std::env::var("USERPROFILE").unwrap()); let key = format!("{}/.coa-manager/signing/manifest-signing.key", std::env::var("USERPROFILE").unwrap());
let seed: [u8; 32] = STANDARD.decode(std::fs::read_to_string(key).unwrap().trim()).unwrap().try_into().unwrap(); let seed: [u8; 32] = STANDARD.decode(std::fs::read_to_string(key).unwrap().trim()).unwrap().try_into().unwrap();
@@ -0,0 +1,73 @@
//! Failure injection on a NEW disposable fixture created by tools/make-fixture.ps1.
//! Uses real MySQL dumps, SQL execution, signed packages and update rollback.
use std::{collections::BTreeMap, path::{Path, PathBuf}};
use coa_core::{backup, db::{Account, Db}, download::Cancel, driver::{self, Verb}, fsx,
manifest::{Kind, Migration}, package::{self, BuildOptions}, pkgsource::Source,
registry::{InstallKind, InstallMeta, MetaDir},
update::{self, Env, RepackEnv}, Error, Result};
use base64::Engine;
use ed25519_dalek::{Signer, SigningKey};
fn main() -> Result<()> {
let arg = std::env::args().nth(1).expect("usage: update_recovery_e2e <new fixture>");
let root = PathBuf::from(arg);
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-update-recovery-fixture-"));
assert!(!root.join("recovery-e2e-started").exists(), "Use a new fixture; never reuse an owned server");
fsx::atomic_write(&root.join("recovery-e2e-started"), b"disposable fixture")?;
let result = exercise(&root);
let stopped = driver::run(&root, Verb::StopAll)?;
assert!(stopped.ok);
result
}
fn exercise(root: &Path) -> Result<()> {
let meta = coa_core::registry::metadata_dir_for(root)?;
let mut installed = InstallMeta::new(InstallKind::New, root);
installed.core.version = Some("1.0.0".into());
MetaDir::create(root, &installed)?;
backup::with_database(root, |db| {
db.query("CREATE TABLE acore_characters.manager_recovery_probe (id INT); INSERT INTO acore_characters.manager_recovery_probe VALUES (42); CREATE TABLE acore_world.manager_recovery_probe (id INT); INSERT INTO acore_world.manager_recovery_probe VALUES (43);")?;
Ok(())
})?;
let source = root.join("fixture-update-source");
fsx::atomic_write(&source.join("Core/recovery-probe.txt"), b"updated")?;
let mut migrations = Vec::new();
for (db, id, sql) in [
("characters", "probe_chars", "UPDATE manager_recovery_probe SET id=999;"),
("world", "probe_world", "DROP TABLE manager_recovery_probe; THIS IS INTENTIONALLY INVALID SQL;"),
] {
fsx::atomic_write(&source.join(format!("_migrations/{db}/{id}.sql")), sql.as_bytes())?;
migrations.push(Migration { compatible_sha256: vec![], db: db.into(), id: id.into(), sha256: fsx::sha256_bytes(sql.as_bytes()), destructive: false });
}
let pkg = root.join("fixture-package");
let manifest = package::build(&source, &pkg, &BuildOptions {
kind: Kind::Update, version: "2.0.0".into(), core_commit: None, bots_commit: None,
built_at: "fixture".into(), part_size: 1 << 20, migrations,
}, &|_| {})?;
let key = SigningKey::generate(&mut rand_core::OsRng);
let signature = base64::engine::general_purpose::STANDARD.encode(key.sign(&std::fs::read(pkg.join("manifest.json"))?).to_bytes());
fsx::atomic_write(&pkg.join("manifest.json.sig"), signature.as_bytes())?;
let trusted = base64::engine::general_purpose::STANDARD.encode(key.verifying_key().to_bytes());
let env = RepackEnv { root, meta_dir: &meta };
let error = update::apply(&update::Params {
root, meta_dir: &meta, source: Source::Dir(pkg), trusted_key: &trusted,
cancel: Cancel::default(), resolutions: BTreeMap::new(), env: &env, fail_after_ops: None,
}, &|step, pct| println!("{pct}% {step}" )).unwrap_err();
assert!(error.to_string().contains("probe_world"), "{error}");
assert!(error.to_string().contains("were restored"), "{error}");
assert!(!root.join("Core/recovery-probe.txt").exists());
assert!(update::unfinished(&meta).is_none());
assert_eq!(MetaDir::open(&meta)?.1.core.version.as_deref(), Some("1.0.0"));
backup::with_database(root, |db| {
assert_eq!(db.query("SELECT id FROM acore_characters.manager_recovery_probe;")?, "42");
assert_eq!(db.query("SELECT id FROM acore_world.manager_recovery_probe;")?, "43");
assert!(!coa_core::migrations::status(db, &manifest.migrations)?.iter().any(|m| m.status == coa_core::migrations::Status::Applied));
Ok(())
})?;
// A recovery point can be reused if the process died midway through restoring multiple schemas.
let point = backup::list(&meta).into_iter().find(|p| p.trigger == backup::Trigger::BeforeUpdate).ok_or_else(|| Error::Invalid("missing backup".into()))?;
env.restore_snapshot(&point.id)?;
assert_eq!(Db::from_repack(root, Account::Admin)?.realm(), coa_core::realms::Mode::Coa);
println!("PASS: failed SQL restored world, characters, ledger, files and version; repeated recovery succeeded");
Ok(())
}
@@ -0,0 +1,19 @@
use coa_core::update::{Env, RepackEnv};
use std::path::PathBuf;
fn main() {
let root = PathBuf::from(std::env::args().nth(1).expect("disposable fixture path"));
assert_eq!(std::fs::read(root.join(".release-schema-fixture")).unwrap(), b"disposable release-schema fixture");
let meta = coa_core::registry::metadata_dir_for(&root).unwrap();
let env = RepackEnv { root: &root, meta_dir: &meta };
let result = env.validate();
let _ = coa_core::driver::run(&root, coa_core::driver::Verb::StopAll);
if let Err(error) = result {
eprintln!("{}", error);
for log in ["Core/Logs/auth-console.log", "Core/Logs/world-console.log", "Core/Logs/supervisor.log"] {
eprintln!("{log}:\n{}", coa_core::diag::redact(&coa_core::health::tail(&root.join(log), 8192)));
}
std::process::exit(1);
}
println!("Published server startup validation passed on the disposable fixture");
}
@@ -0,0 +1,58 @@
//! Reproduce applied migration history with five missing tables on a disposable MySQL fixture.
use std::path::PathBuf;
use coa_core::{backup, fsx, manifest::Migration, migrations::{self, LedgerRow, Status, Store}, release_schema, schema_check, Error, Result};
fn main() -> Result<()> {
let mut args = std::env::args().skip(1);
let root = PathBuf::from(args.next().ok_or_else(|| Error::Invalid("fixture path required".into()))?);
let old_sql = PathBuf::from(args.next().ok_or_else(|| Error::Invalid("core SQL directory required".into()))?);
let repairs = PathBuf::from(args.next().ok_or_else(|| Error::Invalid("repair SQL directory required".into()))?);
if !root.file_name().is_some_and(|n| n.to_string_lossy().starts_with("coa-update-recovery-fixture-"))
|| !root.join("recovery-e2e-started").exists() {
return Err(Error::Invalid("Refusing a non-disposable recovery fixture.".into()));
}
let tree = tempfile::tempdir()?;
backup::with_database(&root, |db| {
let db = db.clone().for_realm(coa_core::realms::Mode::Coa);
let characters = db.query("SELECT COUNT(*) FROM acore_characters.characters;")?;
db.load()?;
// Record exactly the old file hashes, as in the user's all-applied report.
let mut migrations = Vec::new();
for name in ["rev_20260929_92_coa_wildcard_skill_cards", "rev_20260929_93_coa_wildcard_skill_card_duplicates", "rev_20260929_94_coa_wildcard_specialization_cache"] {
let path = old_sql.join(format!("{name}.sql"));
let hash = fsx::sha256_file(&path)?;
db.put(&LedgerRow { db: "characters".into(), id: name.into(), sha256: hash.clone(), status: Status::Applied, error: None, baseline: false })?;
migrations.push(Migration { compatible_sha256: vec![], db: "characters".into(), id: name.into(), sha256: hash, destructive: false });
}
for (_, tables) in schema_check::WILDCARD_TABLES.iter().filter(|(kind,_)| *kind == "characters") {
for table in *tables { db.query(&format!("DROP TABLE IF EXISTS acore_characters.`{table}`;"))?; }
}
assert!(migrations::status(&db, &migrations)?.iter().all(|m| m.status == Status::Applied));
assert!(!db.tables("acore_characters")?.iter().any(|t| t == "coa_wildcard_skill_card"));
let empty_core = tempfile::tempdir()?;
let files = release_schema::collect(empty_core.path(), None, Some(&repairs))?;
assert_eq!(files.len(), 1);
let repair = &files[0];
migrations.push(Migration { compatible_sha256: vec![], db: repair.db.clone(), id: repair.id.clone(), sha256: repair.sha256.clone(), destructive: false });
let staged = tree.path().join("sql/characters");
fsx::atomic_write(&staged.join(format!("{}.sql", repair.id)), &std::fs::read(&repair.abs)?)?;
let report = migrations::apply_pending(&db, &migrations, &tree.path().join("sql"), &|| Ok("disposable fixture".into()))?;
assert!(report.failed.is_none());
assert_eq!(report.applied, [repair.id.clone()]);
assert_eq!(db.query("SELECT COUNT(*) FROM acore_characters.characters;")?, characters);
db.query("INSERT INTO acore_characters.coa_wildcard_skill_card VALUES (77,123,456);")?;
db.run_sql_file("acore_characters", &repair.abs)?;
assert_eq!(db.query("SELECT progress FROM acore_characters.coa_wildcard_skill_card WHERE account=77 AND card=123;")?, "456");
assert!(migrations::apply_pending(&db, &migrations, &tree.path().join("sql"), &|| Ok("disposable fixture".into()))?.applied.is_empty());
schema_check::capture(&db, tree.path())?;
db.query("DROP TABLE acore_characters.coa_wildcard_skill_card_purchase;")?;
assert!(schema_check::check(&db, tree.path())?.iter().any(|p| p.table == "coa_wildcard_skill_card_purchase" && p.detail == "Missing table"));
db.run_sql_file("acore_characters", &repair.abs)?;
db.query("ALTER TABLE acore_characters.coa_wildcard_skill_card DROP COLUMN progress;")?;
assert!(schema_check::check(&db, tree.path())?.iter().any(|p| p.table == "coa_wildcard_skill_card" && p.column == "progress"));
db.query("ALTER TABLE acore_characters.coa_wildcard_skill_card ADD COLUMN progress INT UNSIGNED NOT NULL DEFAULT 0;")?;
Ok(())
})?;
println!("Applied history with all five tables missing repaired; characters and existing card rows preserved; full contract detects missing tables and columns.");
Ok(())
}
+172
View File
@@ -0,0 +1,172 @@
//! 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' AND a.username NOT LIKE '{SQUID}%' ORDER BY a.id;";
/// The accounts of SQUID's random bots share a name prefix (`AiPlayerbot.RandomBotAccountPrefix`, default `rndbot`).
/// They belong to the bot system like the companions' accounts and are never listed or touched here.
pub fn squid_bot_prefix(root: &Path) -> String {
std::fs::read(root.join("Core/configs/modules/playerbots.conf"))
.ok()
.and_then(|bytes| crate::config::parser::ConfFile::parse_bytes(&bytes).ok())
.and_then(|conf| conf.get("AiPlayerbot.RandomBotAccountPrefix").map(|v| crate::config::parser::unquote(v).to_string()))
.filter(|prefix| !prefix.is_empty() && prefix.len() <= 32 && prefix.chars().all(|c| c.is_ascii_alphanumeric()))
.unwrap_or_else(|| "rndbot".into())
}
/// Rows of tab-separated columns as the `mysql` client prints them.
pub fn parse_list(out: &str) -> Vec<AccountInfo> {
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.replace("{SQUID}", &squid_bot_prefix(root).to_ascii_uppercase()))?))
}
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 is_reserved(&old) || old.starts_with(&squid_bot_prefix(root).to_ascii_uppercase()) {
return Err(Error::Invalid("This account belongs to the Manager or the bots and cannot be renamed.".into()));
}
if old == new {
return Err(Error::Invalid("That is already the name of this account.".into()));
}
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) || name.starts_with(&squid_bot_prefix(root).to_ascii_uppercase()) {
return Err(Error::Invalid("This account belongs to the Manager or the bots and cannot be deleted.".into()));
}
let db = Db::from_repack(root, Account::Admin)?;
match db.query(&format!("SELECT online FROM acore_auth.account WHERE username = '{name}';"))?.trim() {
"" => 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") && LIST_SQL.contains("{SQUID}%"));
}
#[test]
fn the_squid_bot_prefix_comes_from_the_bot_settings_and_defaults_to_rndbot() {
let root = tempfile::tempdir().unwrap();
assert_eq!(squid_bot_prefix(root.path()), "rndbot");
let conf = root.path().join("Core/configs/modules/playerbots.conf");
std::fs::create_dir_all(conf.parent().unwrap()).unwrap();
std::fs::write(&conf, "AiPlayerbot.RandomBotAccountPrefix = \"MyBots\"\n").unwrap();
assert_eq!(squid_bot_prefix(root.path()), "MyBots");
std::fs::write(&conf, "AiPlayerbot.RandomBotAccountPrefix = \"x' OR 1=1 --\"\n").unwrap();
assert_eq!(squid_bot_prefix(root.path()), "rndbot", "an unsafe prefix is ignored");
}
#[test]
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}");
}
}
}
+227 -22
View File
@@ -51,6 +51,8 @@ pub struct Component {
pub sha256: Option<String>, pub sha256: Option<String>,
pub tables: Option<usize>, pub tables: Option<usize>,
pub files: Option<Vec<String>>, pub files: Option<Vec<String>>,
#[serde(default)]
pub file_sha256: std::collections::BTreeMap<String, String>,
} }
#[derive(Debug, Clone, Serialize, Deserialize)] #[derive(Debug, Clone, Serialize, Deserialize)]
@@ -63,12 +65,86 @@ 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 { const LOCATION_FILE: &str = "backup-location.json";
#[derive(Serialize, Deserialize)]
struct StoredLocation {
path: String,
}
fn default_dir(meta: &Path) -> PathBuf {
meta.join("backups") meta.join("backups")
} }
/// The folder the owner chose for backups (for example on another drive), if any.
fn custom_dir(meta: &Path) -> Option<PathBuf> {
let stored: StoredLocation = fsx::read_json(&meta.join(LOCATION_FILE)).ok()?;
let path = PathBuf::from(stored.path.trim());
path.is_absolute().then_some(path)
}
/// Where new backups go.
fn backups_dir(meta: &Path) -> PathBuf {
custom_dir(meta).unwrap_or_else(|| default_dir(meta))
}
/// Every folder that may hold backups: the chosen one first, then the default one, so backups made before the
/// folder was changed stay visible and restorable.
fn backup_roots(meta: &Path) -> Vec<PathBuf> {
let mut roots: Vec<PathBuf> = custom_dir(meta).into_iter().collect();
let default = default_dir(meta);
if !roots.contains(&default) { roots.push(default); }
roots
}
#[derive(Debug, Serialize)]
pub struct BackupLocation {
pub path: String,
pub default_path: String,
pub is_default: bool,
}
pub fn location(meta: &Path) -> BackupLocation {
let default = default_dir(meta);
let current = backups_dir(meta);
BackupLocation { is_default: current == default, path: current.to_string_lossy().into_owned(), default_path: default.to_string_lossy().into_owned() }
}
/// Choose where new backups are stored (`None` = the default folder next to the server). Existing backups stay where
/// they are and remain listed.
pub fn set_location(root: &Path, meta: &Path, path: Option<&str>) -> Result<BackupLocation> {
let _lock = crate::update::operation_lock(meta)?;
crate::update::ensure_recovered(meta)?;
match path.map(str::trim).filter(|p| !p.is_empty()) {
None => {
let file = meta.join(LOCATION_FILE);
if file.exists() { fs::remove_file(file)?; }
}
Some(chosen) => {
let dir = PathBuf::from(chosen);
if !dir.is_absolute() { return Err(Error::Invalid("Choose a full folder path, for example D:\\CoA backups.".into())); }
if fsx::ensure_within(root, &dir).is_ok() {
return Err(Error::Invalid("Backups cannot be stored inside the server folder: they would be part of what is being backed up.".into()));
}
fs::create_dir_all(&dir).map_err(|e| Error::Invalid(format!("The folder cannot be created: {e}")))?;
let probe = dir.join(format!(".coa-write-test-{}", uuid::Uuid::new_v4().simple()));
fs::write(&probe, b"x").map_err(|e| Error::Invalid(format!("The folder is not writable: {e}")))?;
let _ = fs::remove_file(&probe);
fsx::atomic_write_json(&meta.join(LOCATION_FILE), &StoredLocation { path: dir.to_string_lossy().into_owned() })?;
}
}
Ok(location(meta))
}
/// The `backup.json` of a recovery point, wherever its folder is.
pub(crate) fn point_json(meta: &Path, id: &str) -> Result<PathBuf> {
Ok(point_dir(meta, id)?.join("backup.json"))
}
fn id_ok(id: &str) -> bool { fn id_ok(id: &str) -> bool {
!id.is_empty() && id.len() < 100 && id.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')) && !id.contains("..") !id.is_empty() && id.len() < 100 && id.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.')) && !id.contains("..")
} }
@@ -77,19 +153,34 @@ fn point_dir(meta: &Path, id: &str) -> Result<PathBuf> {
if !id_ok(id) { if !id_ok(id) {
return Err(Error::PathRejected(format!("bad backup id {id:?}"))); return Err(Error::PathRejected(format!("bad backup id {id:?}")));
} }
if let Some(found) = backup_roots(meta).into_iter().map(|root| root.join(id)).find(|dir| dir.is_dir()) {
return Ok(found);
}
Ok(backups_dir(meta).join(id)) Ok(backups_dir(meta).join(id))
} }
pub fn list(meta: &Path) -> Vec<RecoveryPoint> { pub fn list(meta: &Path) -> Vec<RecoveryPoint> {
let mut out: Vec<RecoveryPoint> = fs::read_dir(backups_dir(meta)) let mut out: Vec<RecoveryPoint> = Vec::new();
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| fsx::read_json(&e.path().join("backup.json")).ok()).collect()) for root in backup_roots(meta) {
.unwrap_or_default(); let found: Vec<RecoveryPoint> = fs::read_dir(&root)
.map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| fsx::read_json(&e.path().join("backup.json")).ok()).collect())
.unwrap_or_default();
for point in found {
if !out.iter().any(|p| p.id == point.id) { out.push(point); }
}
}
out.sort_by(|a, b| b.id.cmp(&a.id)); out.sort_by(|a, b| b.id.cmp(&a.id));
out out
} }
pub fn get(meta: &Path, id: &str) -> Result<RecoveryPoint> { pub fn get(meta: &Path, id: &str) -> Result<RecoveryPoint> {
fsx::read_json(&point_dir(meta, id)?.join("backup.json")).map_err(|_| Error::Invalid(format!("backup {id} was not found"))) let dir = point_dir(meta, id)?;
// The folder holding the backups may itself be a junction or symlink to another drive (the owner moved it there);
// what must hold is that the recovery point stays inside that folder.
let holder = dir.parent().ok_or_else(|| Error::PathRejected(format!("bad backup folder for {id}")))?;
let point: RecoveryPoint = fsx::read_json(&fsx::ensure_within(holder, &dir.join("backup.json"))?).map_err(|_| Error::Invalid(format!("backup {id} was not found or its metadata is damaged")))?;
if point.id != id || point.schema != 1 { return Err(Error::Invalid(format!("Backup {id} has inconsistent identity or an unsupported schema."))); }
Ok(point)
} }
/// Files that make up "configuration": everything a user or the Manager may have changed, minus secrets. /// Files that make up "configuration": everything a user or the Manager may have changed, minus secrets.
@@ -127,6 +218,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
} }
@@ -135,13 +228,16 @@ fn copy_configs(root: &Path, dir: &Path) -> Result<Component> {
let files = config_files(root); let files = config_files(root);
let target = dir.join("files"); let target = dir.join("files");
let mut bytes = 0; let mut bytes = 0;
let mut file_sha256 = std::collections::BTreeMap::new();
for rel in &files { for rel in &files {
let src = fsx::safe_join(root, rel)?; let src = fsx::safe_join(root, rel)?;
let dst = fsx::safe_join(&target, rel)?; let dst = fsx::safe_join(&target, rel)?;
fs::create_dir_all(dst.parent().unwrap())?; let content = fs::read(&src)?;
bytes += fs::copy(&src, &dst)?; fsx::atomic_write(&dst, &content)?;
bytes += content.len() as u64;
file_sha256.insert(rel.clone(), fsx::sha256_bytes(&content));
} }
Ok(Component { name: "configs".into(), path: "files".into(), bytes, sha256: None, tables: None, files: Some(files) }) Ok(Component { name: "configs".into(), path: "files".into(), bytes, sha256: None, tables: None, files: Some(files), file_sha256 })
} }
/// Make sure the database is up for `f`. If we had to start it (and nothing else is running), stop it again. /// Make sure the database is up for `f`. If we had to start it (and nothing else is running), stop it again.
@@ -152,19 +248,28 @@ pub fn with_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result
if !mysql_was_up { if !mysql_was_up {
let out = driver::run(root, Verb::StartMysql)?; let out = driver::run(root, Verb::StartMysql)?;
if !out.ok { if !out.ok {
return Err(Error::Invalid(out.human.map(|h| h.title.to_string()).unwrap_or_else(|| "The database could not be started.".into()))); // Keep the launcher's own last lines: the title alone ("Something went wrong") hides the cause.
return Err(Error::Invalid(format!("The database could not be started. {}", driver::startup_failure(root, &out))));
} }
} }
let result = f(&db); let result = f(&db);
if !mysql_was_up { if !mysql_was_up {
let now = process::observe(root, &read_ports(root)); let now = process::observe(root, &read_ports(root));
if now.world.state == ServiceState::Stopped && now.auth.state == ServiceState::Stopped { if now.world.state == ServiceState::Stopped && now.auth.state == ServiceState::Stopped && !crate::multiworld::is_running(root) {
let _ = driver::run(root, Verb::StopAll); let _ = driver::run(root, Verb::StopAll);
} }
} }
result result
} }
/// Run `f` only if the database is already up; `None` (and nothing started) otherwise.
pub fn with_running_database<T>(root: &Path, f: impl FnOnce(&Db) -> Result<T>) -> Result<Option<T>> {
let db = Db::from_repack(root, Account::Admin)?;
let observed = process::observe(root, &read_ports(root));
if observed.mysql.state != ServiceState::Running || !db.ping() { return Ok(None); }
f(&db).map(Some)
}
fn wanted_databases(kind: Kind) -> &'static [&'static str] { fn wanted_databases(kind: Kind) -> &'static [&'static str] {
match kind { match kind {
Kind::Quick | Kind::Database => &["characters", "auth"], Kind::Quick | Kind::Database => &["characters", "auth"],
@@ -175,7 +280,7 @@ fn wanted_databases(kind: Kind) -> &'static [&'static str] {
/// Create a recovery point. The server may be running: dumps are consistent snapshots (`--single-transaction`). /// Create a recovery point. The server may be running: dumps are consistent snapshots (`--single-transaction`).
pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Option<String>, progress: &dyn Fn(&str)) -> Result<RecoveryPoint> { pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Option<String>, progress: &dyn Fn(&str)) -> Result<RecoveryPoint> {
let id = format!("{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), match trigger { let id = format!("{}-{}-{}", chrono::Utc::now().format("%Y%m%d-%H%M%S"), match trigger {
Trigger::Manual => "manual", Trigger::Manual => "manual",
Trigger::Automatic => "auto", Trigger::Automatic => "auto",
Trigger::BeforeUpdate => "before-update", Trigger::BeforeUpdate => "before-update",
@@ -184,23 +289,34 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
Trigger::BeforeBots => "before-bots", Trigger::BeforeBots => "before-bots",
Trigger::BeforeRepair => "before-repair", Trigger::BeforeRepair => "before-repair",
Trigger::BeforeDangerousChange => "before-change", Trigger::BeforeDangerousChange => "before-change",
}); }, uuid::Uuid::new_v4().simple());
let final_dir = point_dir(meta, &id)?; let final_dir = point_dir(meta, &id)?;
let partial = backups_dir(meta).join(format!("{id}.partial")); let partial = backups_dir(meta).join(format!("{id}.partial"));
fs::create_dir_all(&partial)?; fs::create_dir_all(&partial)?;
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")?)); }
}
if kind != Kind::Config && with_database(root, |db| db.schema_exists("acore_playerbots"))? {
databases.push(("playerbots".into(), "acore_playerbots"));
}
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, file_sha256: Default::default() })
})?; })?;
components.push(component); components.push(component);
} }
@@ -219,6 +335,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,
@@ -239,6 +356,7 @@ pub fn create(root: &Path, meta: &Path, kind: Kind, trigger: Trigger, label: Opt
/// Keep the newest `keep` automatic recovery points; manual and safety ones are never pruned. /// Keep the newest `keep` automatic recovery points; manual and safety ones are never pruned.
pub fn prune_automatic(meta: &Path, keep: usize) { pub fn prune_automatic(meta: &Path, keep: usize) {
if crate::update::ensure_recovered(meta).is_err() { return; }
let autos: Vec<_> = list(meta).into_iter().filter(|p| p.trigger == Trigger::Automatic).collect(); let autos: Vec<_> = list(meta).into_iter().filter(|p| p.trigger == Trigger::Automatic).collect();
for p in autos.into_iter().skip(keep) { for p in autos.into_iter().skip(keep) {
if let Ok(dir) = point_dir(meta, &p.id) { if let Ok(dir) = point_dir(meta, &p.id) {
@@ -257,8 +375,21 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
let point = get(meta, id)?; let point = get(meta, id)?;
let dir = point_dir(meta, id)?; let dir = point_dir(meta, id)?;
let mut problems = Vec::new(); let mut problems = Vec::new();
let mut names = std::collections::BTreeSet::new();
let mut schemas = std::collections::BTreeSet::new();
for c in &point.components { for c in &point.components {
let path = dir.join(&c.path); if !names.insert(&c.name) { problems.push(format!("{} appears more than once", c.name)); }
let path = fsx::ensure_within(&dir, &fsx::safe_join(&dir, &c.path)?)?;
if c.name != "configs" && (c.sha256.is_none() || c.tables.is_none()) { problems.push(format!("{} lacks database integrity metadata", c.name)); }
if c.name == "configs" {
if c.sha256.is_some() || c.files.is_none() { problems.push("configuration integrity metadata is inconsistent".into()); }
} else {
let schema = if c.name.contains('-') || c.name == "playerbots" { db::schema_of(&c.name) } else { point.realm.schema(&c.name) };
match schema {
Ok(schema) if schemas.insert(schema) => {}
_ => problems.push(format!("{} has an unknown or duplicate database target", c.name)),
}
}
match (&c.sha256, &c.files) { match (&c.sha256, &c.files) {
(Some(sha), _) => match fsx::sha256_file(&path) { (Some(sha), _) => match fsx::sha256_file(&path) {
Ok(actual) if actual.eq_ignore_ascii_case(sha) => {} Ok(actual) if actual.eq_ignore_ascii_case(sha) => {}
@@ -267,12 +398,16 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
}, },
(None, Some(files)) => { (None, Some(files)) => {
for f in files { for f in files {
if !c.file_sha256.is_empty() && !c.file_sha256.contains_key(f) { problems.push(format!("configuration file {f} lacks its checksum")); }
if !fsx::safe_join(&path, f).map(|p| p.is_file()).unwrap_or(false) { if !fsx::safe_join(&path, f).map(|p| p.is_file()).unwrap_or(false) {
problems.push(format!("configuration file {f} is missing")); problems.push(format!("configuration file {f} is missing"));
} else if let Some(expected) = c.file_sha256.get(f) {
let file = fsx::ensure_within(&dir, &fsx::safe_join(&path, f)?)?;
if fsx::sha256_file(&file)?.as_str() != expected { problems.push(format!("configuration file {f} is damaged")); }
} }
} }
} }
_ => {} _ => problems.push(format!("{} lacks an integrity inventory", c.name)),
} }
} }
Ok(VerifyReport { ok: problems.is_empty(), problems }) Ok(VerifyReport { ok: problems.is_empty(), problems })
@@ -280,6 +415,11 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
/// Delete one recovery point (its own folder only). /// Delete one recovery point (its own folder only).
pub fn delete(meta: &Path, id: &str) -> Result<()> { pub fn delete(meta: &Path, id: &str) -> Result<()> {
let _lock = crate::update::operation_lock(meta)?;
crate::update::ensure_recovered(meta)?;
if crate::update::unfinished(meta).is_some_and(|t| t.recovery_point.as_deref() == Some(id)) {
return Err(Error::Invalid("This recovery point is required by an unfinished update and cannot be deleted.".into()));
}
let dir = point_dir(meta, id)?; let dir = point_dir(meta, id)?;
get(meta, id)?; // must be a real recovery point get(meta, id)?; // must be a real recovery point
fs::remove_dir_all(dir)?; fs::remove_dir_all(dir)?;
@@ -289,6 +429,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,23 +457,27 @@ 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()));
} }
let now = process::observe(root, &read_ports(root)); let now = process::observe(root, &read_ports(root));
if now.world.state != ServiceState::Stopped || now.auth.state != ServiceState::Stopped { if now.world.state != ServiceState::Stopped || now.auth.state != ServiceState::Stopped || crate::multiworld::is_running(root) {
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('-') || name == "playerbots" { 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 = uuid::Uuid::new_v4().simple().to_string()[..16].to_string();
// 1. Safety copy of the current state, so even a wrong restore is reversible. // 1. Safety copy of the current state, so even a wrong restore is reversible.
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)? {
@@ -341,7 +488,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
db.import_from(&staging, &dump)?; db.import_from(&staging, &dump)?;
// 3. Sanity checks. // 3. Sanity checks.
let staged = db.tables(&staging)?; let staged = db.tables(&staging)?;
if staged.is_empty() || (expected_tables > 0 && staged.len() != expected_tables) { if comp.tables.is_some_and(|expected| staged.len() != expected) || (comp.tables.is_none() && staged.is_empty()) {
return Err(Error::Invalid(format!("The restored copy looks incomplete ({} of {expected_tables} tables); nothing was changed.", staged.len()))); return Err(Error::Invalid(format!("The restored copy looks incomplete ({} of {expected_tables} tables); nothing was changed.", staged.len())));
} }
if db.extra_objects(&staging)? > 0 || db.extra_objects(live)? > 0 { if db.extra_objects(&staging)? > 0 || db.extra_objects(live)? > 0 {
@@ -357,7 +504,7 @@ pub fn restore_database(root: &Path, meta: &Path, id: &str, name: &str) -> Resul
for t in &staged { for t in &staged {
renames.push(format!("`{staging}`.`{t}` TO `{live}`.`{t}`")); renames.push(format!("`{staging}`.`{t}` TO `{live}`.`{t}`"));
} }
db.query(&format!("RENAME TABLE {};", renames.join(", ")))?; if !renames.is_empty() { db.query(&format!("RENAME TABLE {};", renames.join(", ")))?; }
Ok(DbRestore { previous_schema: old, safety_backup: safety.id.clone(), tables_restored: staged.len() }) Ok(DbRestore { previous_schema: old, safety_backup: safety.id.clone(), tables_restored: staged.len() })
}) })
} }
@@ -379,6 +526,36 @@ mod tests {
(dir, root, meta) (dir, root, meta)
} }
#[test]
fn backup_deletion_obeys_the_installation_lock() {
let (_d, root, meta) = setup();
let point = create(&root, &meta, Kind::Config, Trigger::Manual, None, &|_| {}).unwrap();
let lock = crate::update::operation_lock(&meta).unwrap();
assert!(delete(&meta, &point.id).is_err());
assert!(get(&meta, &point.id).is_ok());
drop(lock);
delete(&meta, &point.id).unwrap();
assert!(get(&meta, &point.id).is_err());
}
#[test]
fn damaged_configuration_is_detected_before_restore_and_copies_are_retained() {
let (_d, root, meta) = setup();
let point = create(&root, &meta, Kind::Config, Trigger::Automatic, None, &|_| {}).unwrap();
let file = point_dir(&meta, &point.id).unwrap().join("files/Core/configs/worldserver.conf");
fs::write(&file, b"corrupted").unwrap();
assert!(!verify(&meta, &point.id).unwrap().ok);
let original = fs::read(root.join("Core/configs/worldserver.conf")).unwrap();
assert!(restore_configs(&root, &meta, &point.id).is_err());
assert_eq!(fs::read(root.join("Core/configs/worldserver.conf")).unwrap(), original);
assert_eq!(list(&meta).len(), 1);
fs::create_dir_all(meta.join("updates/broken")).unwrap();
fs::write(meta.join("updates/broken/txn.json"), b"{damaged").unwrap();
assert!(delete(&meta, &point.id).is_err());
prune_automatic(&meta, 0);
assert!(file.exists());
}
#[test] #[test]
fn config_backup_excludes_secrets_and_clutter_and_restores_byte_exact() { fn config_backup_excludes_secrets_and_clutter_and_restores_byte_exact() {
let (_d, root, meta) = setup(); let (_d, root, meta) = setup();
@@ -407,6 +584,34 @@ mod tests {
assert!(list(&meta).len() >= 2); assert!(list(&meta).len() >= 2);
} }
#[test]
fn backups_can_live_in_a_chosen_folder_and_old_ones_stay_visible() {
let (d, root, meta) = setup();
let before = create(&root, &meta, Kind::Config, Trigger::Manual, Some("default folder".into()), &|_| {}).unwrap();
assert!(location(&meta).is_default);
// inside the server folder is refused, a relative path is refused
assert!(set_location(&root, &meta, Some(root.join("backups").to_str().unwrap())).is_err());
assert!(set_location(&root, &meta, Some("backups")).is_err());
let elsewhere = d.path().join("other drive").join("CoA backups");
let loc = set_location(&root, &meta, Some(elsewhere.to_str().unwrap())).unwrap();
assert!(!loc.is_default && elsewhere.is_dir());
let after = create(&root, &meta, Kind::Config, Trigger::Manual, Some("chosen folder".into()), &|_| {}).unwrap();
assert!(elsewhere.join(&after.id).join("backup.json").is_file(), "new backups go to the chosen folder");
assert!(!default_dir(&meta).join(&after.id).exists());
let ids: Vec<_> = list(&meta).into_iter().map(|p| p.id).collect();
assert!(ids.contains(&before.id) && ids.contains(&after.id), "the old backup is still listed");
assert!(verify(&meta, &before.id).unwrap().ok && verify(&meta, &after.id).unwrap().ok);
assert_eq!(point_json(&meta, &after.id).unwrap(), elsewhere.join(&after.id).join("backup.json"));
restore_configs(&root, &meta, &after.id).unwrap();
delete(&meta, &after.id).unwrap();
assert!(!elsewhere.join(&after.id).exists());
assert!(set_location(&root, &meta, None).unwrap().is_default);
assert!(list(&meta).iter().any(|p| p.id == before.id));
}
#[test] #[test]
fn verify_detects_tampering_and_restore_refuses_damaged_backup() { fn verify_detects_tampering_and_restore_refuses_damaged_backup() {
let (_d, root, meta) = setup(); let (_d, root, meta) = setup();
@@ -0,0 +1,170 @@
{
"character_inventory": [
"guid",
"bag",
"slot",
"item"
],
"characters": [
"guid",
"account",
"name",
"race",
"class",
"gender",
"level",
"xp",
"money",
"skin",
"face",
"hairStyle",
"hairColor",
"facialStyle",
"bankSlots",
"restState",
"playerFlags",
"map",
"instance_id",
"instance_mode_mask",
"position_x",
"position_y",
"position_z",
"orientation",
"trans_x",
"trans_y",
"trans_z",
"trans_o",
"transguid",
"taximask",
"cinematic",
"totaltime",
"leveltime",
"rest_bonus",
"logout_time",
"is_logout_resting",
"resettalents_cost",
"resettalents_time",
"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",
"innTriggerId",
"extraBonusTalentCount"
],
"character_spell": [
"guid",
"spell",
"specMask"
],
"character_skills": [
"guid",
"skill",
"value",
"max"
],
"character_homebind": [
"guid",
"mapId",
"zoneId",
"posX",
"posY",
"posZ"
],
"character_reputation": [
"guid",
"faction",
"standing",
"flags"
],
"character_action": [
"guid",
"spec",
"button",
"action",
"type"
],
"character_talent": [
"guid",
"spell",
"specMask"
],
"item_instance": [
"itemEntry",
"owner_guid",
"creatorGuid",
"giftCreatorGuid",
"count",
"duration",
"charges",
"flags",
"enchantments",
"randomPropertyId",
"durability",
"playedTime",
"text",
"guid"
],
"character_stats": [
"guid",
"maxhealth",
"maxpower1",
"maxpower2",
"maxpower3",
"maxpower4",
"maxpower5",
"maxpower6",
"maxpower7",
"strength",
"agility",
"stamina",
"intellect",
"spirit",
"armor",
"resHoly",
"resFire",
"resNature",
"resFrost",
"resShadow",
"resArcane",
"blockPct",
"dodgePct",
"parryPct",
"critPct",
"rangedCritPct",
"spellCritPct",
"attackPower",
"rangedAttackPower",
"spellPower",
"resilience"
]
}
+12 -3
View File
@@ -181,7 +181,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
if let Some(b) = p.bots { if let Some(b) = p.bots {
sql.extend(collect_bots_sql(b)?); sql.extend(collect_bots_sql(b)?);
} }
let migrations: Vec<_> = sql.iter().map(|f| crate::manifest::Migration { id: f.id.clone(), db: f.db.clone(), sha256: f.sha256.clone(), destructive: false }).collect(); let migrations: Vec<_> = sql.iter().map(|f| crate::manifest::Migration { compatible_sha256: vec![], id: f.id.clone(), db: f.db.clone(), sha256: f.sha256.clone(), destructive: false }).collect();
let staging = std::env::temp_dir().join("coa-cleanbase-sql"); let staging = std::env::temp_dir().join("coa-cleanbase-sql");
let _ = fs::remove_dir_all(&staging); let _ = fs::remove_dir_all(&staging);
for f in &sql { for f in &sql {
@@ -218,12 +218,17 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
db.query(&sql)?; db.query(&sql)?;
// 2. characters: a brand-new schema from the core's base scripts // 2. characters: a brand-new schema from the core's base scripts
db.query("DROP DATABASE IF EXISTS `acore_characters`; CREATE DATABASE `acore_characters` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;")?; db.query("DROP DATABASE IF EXISTS `acore_characters`; CREATE DATABASE `acore_characters` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;")?;
// The ledger lives in world, so dropping characters does not clear its migration history.
// Never carry that history into a freshly rebuilt character database.
if db.tables("acore_world")?.iter().any(|t| t == "coa_manager_migrations") {
db.query("DELETE FROM acore_world.coa_manager_migrations WHERE `db`='characters';")?;
}
for f in &base_chars { for f in &base_chars {
db.run_sql_file("acore_characters", f)?; db.run_sql_file("acore_characters", f)?;
} }
// 3. every migration up to the core commit (already-recorded ones are skipped) // 3. every migration up to the core commit (already-recorded ones are skipped)
let before = status(db, &migrations)?; let before = status(db, &migrations)?;
let pending: Vec<_> = migrations.iter().zip(&before).filter(|(_, i)| i.status == Status::Pending).map(|(m, _)| m.clone()).collect(); let pending: Vec<_> = migrations.iter().zip(&before).filter(|(_, i)| i.status != Status::Applied).map(|(m, _)| m.clone()).collect();
say(&format!("Applying {} database updates", pending.len())); say(&format!("Applying {} database updates", pending.len()));
let report = apply_pending(db, &pending, &staging, &|| Ok("(scratch database)".into()))?; let report = apply_pending(db, &pending, &staging, &|| Ok("(scratch database)".into()))?;
if let Some((id, why)) = report.failed { if let Some((id, why)) = report.failed {
@@ -251,6 +256,10 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
if accounts != "0" || chars != "0" || templates != 21 { if accounts != "0" || chars != "0" || templates != 21 {
return Err(Error::Invalid(format!("The database is not clean ({accounts} accounts, {chars} player characters, {templates} templates)."))); return Err(Error::Invalid(format!("The database is not clean ({accounts} accounts, {chars} player characters, {templates} templates).")));
} }
if let Some(p) = crate::schema_check::check(db, p.tree)?.first() {
return Err(Error::Invalid(format!("The rebuilt base database is incomplete: {}.{}.{}: {}", p.database, p.table, p.column, p.detail)));
}
crate::schema_check::capture(db, out)?;
Ok(()) Ok(())
})?; })?;
@@ -270,7 +279,7 @@ pub fn build(p: &Params, say: &dyn Fn(&str)) -> Result<()> {
fsx::atomic_write_json(&repack_json, &shipped)?; fsx::atomic_write_json(&repack_json, &shipped)?;
say("Adding the release files"); say("Adding the release files");
copy_dir(p.tree, p.out, &|_| false, p.tree)?; copy_dir(p.tree, p.out, &|rel| rel == crate::schema_check::CONTRACT, p.tree)?;
if let Some(data) = p.data { if let Some(data) = p.data {
say("Copying game data"); say("Copying game data");
fs::create_dir_all(p.out.join("Data"))?; fs::create_dir_all(p.out.join("Data"))?;
+174 -3
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,
@@ -118,16 +180,44 @@ fn backup_dir(meta: &Path) -> PathBuf {
meta.join("backups").join("client") meta.join("backups").join("client")
} }
fn host_ok(h: &str) -> bool { pub 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());
}
}
+172 -7
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 })
} }
@@ -126,6 +131,17 @@ pub struct SettingsView {
/// so a server updated to a build with a new setting gets that setting's documented default. Files the launcher writes /// 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)`). /// 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) };
@@ -150,6 +166,8 @@ pub fn materialize_module_configs(root: &Path) -> Result<Vec<String>> {
} }
} }
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())) { } 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)) { if let (Ok(mut conf), Ok(dist)) = (parser::ConfFile::parse_bytes(&have), parser::ConfFile::parse_bytes(&dist)) {
let plan = merge::apply(&mut conf, &dist); let plan = merge::apply(&mut conf, &dist);
@@ -323,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());
@@ -355,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)?;
@@ -508,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();
@@ -532,6 +658,24 @@ Spellbook.New = 5
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] {
@@ -618,6 +762,21 @@ Spellbook.New = 5
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();
@@ -660,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());
} }
} }
+382
View File
@@ -0,0 +1,382 @@
//! SQUID's bot dashboard (<https://github.com/Zyth45/squidbots-dashboard>): a small web page, written in Python with
//! no dependencies, that shows where the bots are and what they do. It is kept in `Extras/SquidDashboard` of the server
//! folder and always comes from the release that matches the installed SQUID bots (same major and minor version), so the
//! page and the bots agree on what the database and the logs contain.
//!
//! The dashboard finds the repack by itself (`Settings/database.json` and `Settings/repack.json` two folders up), so the
//! Manager only has to download it and start it on a free port. Only the process the Manager started and recorded is ever
//! stopped, identified by PID and creation time.
use std::io::Read;
use std::path::{Path, PathBuf};
use serde::{Deserialize, Serialize};
use crate::error::{Error, Result};
use crate::fsx;
use crate::process::{self, ProcessIdentity};
const REPO: &str = "Zyth45/squidbots-dashboard";
const DIR: &str = "Extras/SquidDashboard";
const MARKER: &str = ".manager-dashboard.json";
const PROCESS: &str = ".manager-dashboard-process.json";
const FIRST_PORT: u16 = 8088;
const MAX_ARCHIVE: u64 = 60 * 1024 * 1024;
const MAX_UNPACKED: u64 = 150 * 1024 * 1024;
#[derive(Debug, Clone, Serialize, Deserialize)]
struct Marker {
/// The dashboard release that is installed.
tag: String,
/// The SQUID release it was chosen for.
squid_tag: String,
port: u16,
}
#[derive(Debug, Serialize)]
pub struct Status {
pub installed: bool,
/// Dashboard release installed.
pub tag: Option<String>,
/// SQUID bots release found in the server.
pub squid_tag: Option<String>,
/// The installed dashboard belongs to the installed bots' release series.
pub matches: bool,
pub running: bool,
pub port: u16,
pub url: String,
}
fn dir(root: &Path) -> PathBuf {
root.join(DIR)
}
fn read_marker(root: &Path) -> Option<Marker> {
fsx::read_json(&dir(root).join(MARKER)).ok()
}
/// `v1.9.1` -> `[1, 9, 1]`.
fn parse_tag(tag: &str) -> Option<Vec<u32>> {
let parts: Vec<u32> = tag.trim().trim_start_matches('v').split('.').map(|p| p.parse().ok()).collect::<Option<_>>()?;
(parts.len() >= 2).then_some(parts)
}
/// Same major and minor version.
fn same_series(a: &str, b: &str) -> bool {
matches!((parse_tag(a), parse_tag(b)), (Some(a), Some(b)) if a[..2] == b[..2])
}
/// The newest dashboard release of the bots' series (`v1.9` serves bots `v1.9` and `v1.9.1`).
fn pick_tag(squid_tag: &str, available: &[String]) -> Option<String> {
available.iter()
.filter(|tag| same_series(tag, squid_tag))
.max_by_key(|tag| parse_tag(tag).unwrap_or_default())
.cloned()
}
fn safe_tag(tag: &str) -> bool {
!tag.is_empty() && tag.len() <= 40 && tag.chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '.' | '_' | '-'))
}
fn squid_tag(root: &Path) -> Option<String> {
crate::squid::release(root).and_then(|r| r.tag).filter(|t| safe_tag(t))
}
fn record_alive(root: &Path) -> Option<ProcessIdentity> {
let record: ProcessIdentity = fsx::read_json(&dir(root).join(PROCESS)).ok()?;
let inside = Path::new(&record.exe).starts_with(root);
(inside && process::is_alive(&record)).then_some(record)
}
pub fn status(root: &Path) -> Status {
let marker = read_marker(root);
let installed = dir(root).join("squidbots.py").is_file() && marker.is_some();
let squid = squid_tag(root);
let port = marker.as_ref().map(|m| m.port).unwrap_or(FIRST_PORT);
let running = installed && record_alive(root).is_some_and(|r| process::listeners().iter().any(|(p, pid)| *p == port && *pid == r.pid));
Status {
installed,
matches: matches!((&marker, &squid), (Some(m), Some(s)) if same_series(&m.tag, s)),
tag: marker.map(|m| m.tag),
squid_tag: squid,
running,
port,
url: format!("http://127.0.0.1:{port}"),
}
}
fn http() -> Result<reqwest::blocking::Client> {
reqwest::blocking::Client::builder()
.user_agent(concat!("CoA-Server-Manager/", env!("CARGO_PKG_VERSION")))
.timeout(std::time::Duration::from_secs(120))
.build()
.map_err(|e| Error::Invalid(format!("Cannot prepare the download: {e}")))
}
fn download_error(e: impl std::fmt::Display) -> Error {
Error::NetworkUnreachable(e.to_string())
}
fn available_tags(client: &reqwest::blocking::Client) -> Result<Vec<String>> {
#[derive(Deserialize)]
struct Tag { name: String }
let response = client.get(format!("https://api.github.com/repos/{REPO}/tags?per_page=100")).send().map_err(download_error)?;
if !response.status().is_success() { return Err(download_error(format!("GitHub answered {}", response.status()))); }
let tags: Vec<Tag> = serde_json::from_str(&response.text().map_err(download_error)?).map_err(download_error)?;
Ok(tags.into_iter().map(|t| t.name).filter(|t| safe_tag(t)).collect())
}
/// Download the dashboard release that matches the installed bots and unpack it. A running dashboard is stopped first;
/// maps the owner extracted and other files of theirs are left alone.
pub fn install(root: &Path, report: &dyn Fn(&str)) -> Result<Status> {
let squid = squid_tag(root).ok_or_else(|| Error::Invalid("The version of the SQUID bots could not be read, so the matching dashboard cannot be chosen.".into()))?;
report("Looking for the matching dashboard");
let client = http()?;
let tag = pick_tag(&squid, &available_tags(&client)?)
.ok_or_else(|| Error::Invalid(format!("There is no dashboard release for SQUID bots {squid} yet.")))?;
report("Downloading the dashboard");
let response = client.get(format!("https://codeload.github.com/{REPO}/zip/refs/tags/{tag}")).send().map_err(download_error)?;
if !response.status().is_success() { return Err(download_error(format!("GitHub answered {}", response.status()))); }
let mut bytes = Vec::new();
response.take(MAX_ARCHIVE + 1).read_to_end(&mut bytes).map_err(download_error)?;
if bytes.len() as u64 > MAX_ARCHIVE { return Err(Error::Invalid("The dashboard download is larger than expected and was rejected.".into())); }
stop(root)?;
report("Unpacking the dashboard");
let target = dir(root);
std::fs::create_dir_all(&target)?;
let mut archive = zip::ZipArchive::new(std::io::Cursor::new(bytes)).map_err(|e| Error::Invalid(format!("The dashboard download is damaged: {e}")))?;
let mut total = 0u64;
let mut wrote_main = false;
for index in 0..archive.len() {
let mut file = archive.by_index(index).map_err(|e| Error::Invalid(format!("The dashboard download is damaged: {e}")))?;
if file.is_dir() { continue; }
// GitHub wraps everything in one folder named after the repository and release.
let Some(relative) = file.name().split_once('/').map(|(_, rest)| rest.to_string()) else { continue; };
if relative.is_empty() || relative.starts_with(".github/") || relative.starts_with("docs/") { continue; }
total += file.size();
if total > MAX_UNPACKED { return Err(Error::Invalid("The dashboard download unpacks to more than expected and was rejected.".into())); }
let destination = fsx::safe_join(&target, &relative)?;
let mut content = Vec::with_capacity(file.size() as usize);
file.read_to_end(&mut content)?;
fsx::atomic_write(&destination, &content)?;
wrote_main |= relative == "squidbots.py";
}
if !wrote_main { return Err(Error::Invalid("The dashboard download did not contain the dashboard.".into())); }
let port = read_marker(root).map(|m| m.port).unwrap_or(FIRST_PORT);
fsx::atomic_write_json(&target.join(MARKER), &Marker { tag, squid_tag: squid, port })?;
Ok(status(root))
}
fn free_port(preferred: u16) -> Result<u16> {
let used: Vec<u16> = process::listeners().into_iter().map(|(port, _)| port).collect();
std::iter::once(preferred).chain(FIRST_PORT..FIRST_PORT + 40).find(|p| !used.contains(p))
.ok_or_else(|| Error::Invalid("No free port was found for the dashboard.".into()))
}
/// A crash or power loss while the dashboard saves its history can leave a file of the right length that holds only
/// zero bytes, and the dashboard then fails to start on it. Those files carry nothing, and the dashboard recreates them,
/// so they are removed. The files that come with the release are never touched here (reinstalling restores them).
fn discard_damaged_data(folder: &Path) -> Vec<String> {
const SHIPPED: &[&str] = &["worldmap.json", "dashboard.example.json"];
let mut removed = Vec::new();
let Ok(entries) = std::fs::read_dir(folder) else { return removed; };
for entry in entries.flatten() {
let name = entry.file_name().to_string_lossy().into_owned();
let path = entry.path();
if !name.ends_with(".json") || name.starts_with('.') || SHIPPED.contains(&name.as_str()) || !path.is_file() { continue; }
let Ok(bytes) = std::fs::read(&path) else { continue; };
if !bytes.is_empty() && bytes.iter().all(|b| *b == 0) && std::fs::remove_file(&path).is_ok() {
tracing::warn!(file = %path.display(), "dashboard: removed a data file damaged by an interrupted write");
removed.push(name);
}
}
removed
}
/// The dashboard reads `coa-level-builds.json` (class and specialization names) from its own folder; the CoA Bots repack
/// ships it, the GitHub release does not. The server's own reference file has the same content and shape.
fn ensure_builds_file(root: &Path) {
let target = dir(root).join("coa-level-builds.json");
if target.is_file() { return; }
let reference = root.join("Core/reference/ascensionsidekick-level-builds.json");
let content = std::fs::read(&reference).ok().filter(|bytes| serde_json::from_slice::<serde_json::Value>(bytes).is_ok_and(|v| v.is_object()));
let _ = fsx::atomic_write(&target, content.as_deref().unwrap_or(b"{}"));
}
/// Python's HTTP server closes each connection with `shutdown(SHUT_WR)` straight after the answer. On Windows that can
/// throw away what is still queued: any answer above about 64 KB (the dashboard's statistics are 400 KB) arrives cut
/// off, and the page fails to load. This small launcher waits for the client to finish reading and close instead, queues
/// more waiting connections than Python's five, and then runs the dashboard unchanged.
const LAUNCHER: &str = r#"import runpy, socketserver, sys, http.server
http.server.ThreadingHTTPServer.request_queue_size = 256
def shutdown_request(self, request):
try:
request.settimeout(5)
while request.recv(4096):
pass
except OSError:
pass
self.close_request(request)
socketserver.TCPServer.shutdown_request = shutdown_request
script = sys.argv[1]
sys.argv = [script]
runpy.run_path(script, run_name="__main__")
"#;
/// Start the dashboard with the repack's own Python. Returns when it answers on its port.
pub fn start(root: &Path) -> Result<Status> {
let current = status(root);
if !current.installed { return Err(Error::Invalid("The dashboard is not installed.".into())); }
if current.running { return Ok(current); }
let python = root.join("Runtime/python/python.exe");
if !python.is_file() { return Err(Error::Invalid("This server has no bundled Python, so the dashboard cannot run.".into())); }
let folder = dir(root);
let mut marker = read_marker(root).ok_or_else(|| Error::Invalid("The dashboard installation is incomplete.".into()))?;
marker.port = free_port(marker.port)?;
fsx::atomic_write_json(&folder.join(MARKER), &marker)?;
let log_path = folder.join("dashboard.log");
let log = std::fs::File::create(&log_path)?;
let mut command = std::process::Command::new(&python);
ensure_builds_file(root);
discard_damaged_data(&folder);
let script = folder.join("squidbots.py");
let launcher = folder.join("manager_launch.py");
fsx::atomic_write(&launcher, LAUNCHER.as_bytes())?;
command.arg("-B").arg(&launcher).arg(&script).current_dir(&folder).env("COA_DASHBOARD_PORT", marker.port.to_string())
.stdin(std::process::Stdio::null()).stdout(log.try_clone()?).stderr(log);
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
command.creation_flags(0x0800_0000); // CREATE_NO_WINDOW
}
let mut child = command.spawn()?;
let identity = process::identity(child.id()).ok_or_else(|| Error::Invalid("The dashboard exited at once.".into()))?;
fsx::atomic_write_json(&folder.join(PROCESS), &identity)?;
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(20);
loop {
if process::listeners().iter().any(|(port, pid)| *port == marker.port && *pid == identity.pid) { return Ok(status(root)); }
if let Ok(Some(_)) = child.try_wait() {
let _ = std::fs::remove_file(folder.join(PROCESS));
let tail = std::fs::read_to_string(&log_path).unwrap_or_default();
let lines: Vec<&str> = tail.lines().rev().take(8).collect();
return Err(Error::Invalid(format!("The dashboard stopped right after starting. {}", lines.into_iter().rev().collect::<Vec<_>>().join("\n"))));
}
if std::time::Instant::now() > deadline {
let _ = stop(root);
return Err(Error::Invalid("The dashboard did not start in time. See Extras/SquidDashboard/dashboard.log.".into()));
}
std::thread::sleep(std::time::Duration::from_millis(300));
}
}
/// Stop the dashboard this Manager started (by recorded PID and creation time, never by name).
pub fn stop(root: &Path) -> Result<()> {
let record_file = dir(root).join(PROCESS);
if let Some(record) = record_alive(root) {
let mut command = std::process::Command::new("taskkill");
command.args(["/PID", &record.pid.to_string(), "/T", "/F"]).stdout(std::process::Stdio::null()).stderr(std::process::Stdio::null());
#[cfg(windows)]
{
use std::os::windows::process::CommandExt;
command.creation_flags(0x0800_0000);
}
let _ = command.status();
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(10);
while process::is_alive(&record) && std::time::Instant::now() < deadline {
std::thread::sleep(std::time::Duration::from_millis(200));
}
if process::is_alive(&record) { return Err(Error::Invalid("The dashboard could not be stopped.".into())); }
}
let _ = std::fs::remove_file(record_file);
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
fn tags(list: &[&str]) -> Vec<String> { list.iter().map(|s| s.to_string()).collect() }
#[test]
fn the_dashboard_follows_the_bots_release_series() {
let available = tags(&["v1.8", "v1.9", "v1.9.2", "v2.0"]);
assert_eq!(pick_tag("v1.9", &available).as_deref(), Some("v1.9.2"), "the newest of the same series");
assert_eq!(pick_tag("v1.9.1", &tags(&["v1.8", "v1.9"])).as_deref(), Some("v1.9"), "bots 1.9.1 use dashboard 1.9");
assert_eq!(pick_tag("v1.8.1", &available).as_deref(), Some("v1.8"));
assert_eq!(pick_tag("v1.10", &available), None, "a later series has none yet");
assert_eq!(pick_tag("main", &available), None);
assert!(same_series("v1.9", "v1.9.1") && !same_series("v1.9", "v1.8.9"));
}
#[test]
fn zero_filled_history_files_are_removed_but_shipped_and_valid_files_stay() {
let folder = tempfile::tempdir().unwrap();
std::fs::write(folder.path().join("history.json"), vec![0u8; 358]).unwrap();
std::fs::write(folder.path().join("levels.json"), vec![0u8; 100]).unwrap();
std::fs::write(folder.path().join("xp-history.json"), "[1, 2]").unwrap();
std::fs::write(folder.path().join("worldmap.json"), vec![0u8; 50]).unwrap();
std::fs::write(folder.path().join("empty.json"), "").unwrap();
let mut removed = discard_damaged_data(folder.path());
removed.sort();
assert_eq!(removed, ["history.json", "levels.json"]);
assert!(folder.path().join("xp-history.json").exists() && folder.path().join("worldmap.json").exists() && folder.path().join("empty.json").exists());
}
#[test]
fn tags_are_checked_before_they_reach_a_url() {
assert!(safe_tag("v1.9.1") && !safe_tag("v1.9/../x") && !safe_tag("") && !safe_tag("a b"));
}
/// Needs the network: `cargo test -p coa-core dashboard -- --ignored`.
#[test]
#[ignore]
fn the_matching_release_is_downloaded_and_unpacked() {
let root = tempfile::tempdir().unwrap();
let settings = root.path().join("Core/configs/modules/playerbots.conf.settings.json");
fsx::atomic_write(&settings, br#"{"format":1,"tag":"v1.9.1","settings":[]}"#).unwrap();
let installed = install(root.path(), &|step| println!("{step}")).unwrap();
assert!(installed.installed && installed.matches);
assert_eq!(installed.tag.as_deref(), Some("v1.9"));
assert!(root.path().join("Extras/SquidDashboard/squidbots.py").is_file());
assert!(!installed.running);
}
/// Needs a real server folder (`COA_TEST_ROOT`) whose bots are installed and whose database runs:
/// `COA_TEST_ROOT=... cargo test -p coa-core dashboard -- --ignored --nocapture`.
#[test]
#[ignore]
fn the_started_dashboard_delivers_its_large_statistics() {
let root = PathBuf::from(std::env::var("COA_TEST_ROOT").expect("COA_TEST_ROOT"));
let started = start(&root).unwrap();
assert!(started.running, "{started:?}");
let client = reqwest::blocking::Client::builder().timeout(std::time::Duration::from_secs(90)).build().unwrap();
let body = client.get(format!("{}/api/stats", started.url)).send().unwrap().bytes().unwrap();
println!("stats: {} bytes: {}", body.len(), String::from_utf8_lossy(&body[..body.len().min(300)]));
let live = client.get(format!("{}/api/live", started.url)).send().unwrap().bytes().unwrap();
stop(&root).unwrap();
assert!(!status(&root).running);
if String::from_utf8_lossy(&body).starts_with("{\"error\"") {
println!("the database of this server is not running, so the large answer could not be checked");
} else {
assert!(body.len() > 100_000, "the statistics must arrive whole, got {} bytes", body.len());
}
assert!(!live.is_empty());
}
#[test]
fn a_folder_without_the_dashboard_is_not_installed_or_running() {
let root = tempfile::tempdir().unwrap();
let s = status(root.path());
assert!(!s.installed && !s.running && !s.matches);
assert!(start(root.path()).is_err());
assert!(stop(root.path()).is_ok());
}
}
+219 -5
View File
@@ -1,4 +1,5 @@
//! Database access through the MySQL client tools bundled with the repack (`mysql`, `mysqldump`, `mysqladmin`). //! Database access through the MySQL client tools bundled with the repack (`mysql`, `mysqldump`, `mysqladmin`), or,
//! for a Docker installation, the same tools run inside the database container with `docker exec`.
//! //!
//! Passwords travel only in the child's environment (`MYSQL_PWD`), never on a command line or in a log. //! Passwords travel only in the child's environment (`MYSQL_PWD`), never on a command line or in a log.
@@ -44,6 +45,9 @@ pub struct Db {
port: u16, port: u16,
user: &'static str, user: &'static str,
password: Secret, password: Secret,
realm: crate::realms::Mode,
/// Name of the database container of a Docker installation; the client tools then run inside it.
container: Option<String>,
} }
#[derive(Deserialize)] #[derive(Deserialize)]
@@ -67,6 +71,9 @@ 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 kind == "playerbots" { return Ok("acore_playerbots"); }
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,11 +81,21 @@ 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"))
.map_err(|_| Error::Invalid("The database settings of this server could not be read.".into()))?; .map_err(|_| Error::Invalid("The database settings of this server could not be read.".into()))?;
let ports: Ports = read_ports(root); let ports: Ports = read_ports(root);
if crate::docker::is_docker(root) {
return Db::in_container(root, creds, account);
}
let bin = root.join("mysql/bin"); let bin = root.join("mysql/bin");
if !bin.join("mysqldump.exe").is_file() || !bin.join("mysql.exe").is_file() { if !bin.join("mysqldump.exe").is_file() || !bin.join("mysql.exe").is_file() {
return Err(Error::Invalid("The bundled database tools are missing.".into())); return Err(Error::Invalid("The bundled database tools are missing.".into()));
@@ -87,11 +104,64 @@ 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, container: None })
}
/// The database of a Docker installation: the client tools of the database image, run with `docker exec`. The
/// database is not published on the host, so nothing about this depends on a port or on tools installed here.
fn in_container(root: &Path, creds: Credentials, account: Account) -> Result<Db> {
let container = crate::docker::Config::load(root)?.database_container();
let (user, password) = match account {
Account::Admin => ("root", creds.root_password),
Account::App => ("acore", creds.app_password),
};
// Inside the container the server listens on its standard port; the commands below connect to it over TCP on
// the container's own loopback, exactly like the commands of a repack do on the host.
Ok(Db { bin: PathBuf::new(), port: 3306, user, password: Secret(password), realm: crate::realms::state(root)?.active, container: Some(container) })
}
pub fn for_realm(mut self, realm: crate::realms::Mode) -> Self { self.realm = realm; self }
pub fn realm(&self) -> crate::realms::Mode { self.realm }
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 {
let mut c = Command::new(self.bin.join(tool)); let mut c = match &self.container {
None => Command::new(self.bin.join(tool)),
Some(name) => {
// `-e MYSQL_PWD` without a value takes it from this process's environment: never on a command line.
let mut c = Command::new("docker");
c.args(["exec", "-i", "-e", "MYSQL_PWD", name, tool.trim_end_matches(".exe")]);
c
}
};
c.env("MYSQL_PWD", self.password.expose()) c.env("MYSQL_PWD", self.password.expose())
.arg("--protocol=tcp") .arg("--protocol=tcp")
.arg("--host=127.0.0.1") .arg("--host=127.0.0.1")
@@ -106,7 +176,8 @@ impl Db {
fn fail(&self, stderr: &[u8]) -> Error { fn fail(&self, stderr: &[u8]) -> Error {
let text = String::from_utf8_lossy(stderr); let text = String::from_utf8_lossy(stderr);
let code = if text.contains("2003") || text.contains("Can't connect") { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown }; let down = text.contains("2003") || text.contains("Can't connect") || text.contains("is not running") || text.contains("No such container");
let code = if down { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown };
match code { match code {
ErrorCode::DatabaseNotRunning => Error::Invalid("The database is not running. Start the server first.".into()), ErrorCode::DatabaseNotRunning => Error::Invalid("The database is not running. Start the server first.".into()),
_ => Error::Invalid(format!("database command failed: {}", text.trim().lines().last().unwrap_or(""))), _ => Error::Invalid(format!("database command failed: {}", text.trim().lines().last().unwrap_or(""))),
@@ -123,9 +194,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 +206,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 +214,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 +224,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 +234,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 +246,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 +280,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 +302,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 +362,133 @@ 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;");
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::ffi::OsStr;
const ROOT_PW: &str = "rootpw-ZZ1";
const APP_PW: &str = "apppw-QQ2";
fn folder(docker: bool) -> (tempfile::TempDir, PathBuf) {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
std::fs::create_dir_all(root.join("Settings")).unwrap();
std::fs::write(root.join("Settings/database.json"), format!(r#"{{"rootPassword":"{ROOT_PW}","appPassword":"{APP_PW}"}}"#)).unwrap();
if docker {
std::fs::write(root.join("Settings/docker.json"), r#"{"project":"t1"}"#).unwrap();
}
(d, root)
}
fn args(c: &Command) -> Vec<String> {
c.get_args().map(|a| a.to_string_lossy().into_owned()).collect()
}
fn env_of(c: &Command, key: &str) -> Option<String> {
c.get_envs().find(|(k, _)| *k == OsStr::new(key)).and_then(|(_, v)| v.map(|v| v.to_string_lossy().into_owned()))
}
#[test]
fn a_docker_installation_runs_the_client_tools_inside_the_database_container() {
let (_d, root) = folder(true);
let db = Db::from_repack(&root, Account::Admin).unwrap();
for (tool, program) in [("mysql.exe", "mysql"), ("mysqldump.exe", "mysqldump"), ("mysqladmin.exe", "mysqladmin")] {
let c = db.command(tool);
assert_eq!(c.get_program(), "docker");
let a = args(&c);
assert_eq!(&a[..6], ["exec", "-i", "-e", "MYSQL_PWD", "coa-t1-db", program]);
assert!(a.contains(&"--protocol=tcp".to_string()) && a.contains(&"--host=127.0.0.1".to_string()) && a.contains(&"--port=3306".to_string()));
assert!(a.contains(&"--user=root".to_string()));
assert!(a.iter().all(|x| !x.contains(ROOT_PW)), "the password must not be on the command line");
assert_eq!(env_of(&c, "MYSQL_PWD").as_deref(), Some(ROOT_PW));
}
let app = Db::from_repack(&root, Account::App).unwrap().command("mysql.exe");
assert!(args(&app).contains(&"--user=acore".to_string()));
assert_eq!(env_of(&app, "MYSQL_PWD").as_deref(), Some(APP_PW));
}
#[test]
fn a_repack_still_uses_its_bundled_tools_on_the_host() {
let (_d, root) = folder(false);
std::fs::create_dir_all(root.join("mysql/bin")).unwrap();
for f in ["mysql.exe", "mysqldump.exe"] {
std::fs::write(root.join("mysql/bin").join(f), b"x").unwrap();
}
std::fs::write(root.join("Settings/repack.json"), r#"{"mysqlPort":3999}"#).unwrap();
let c = Db::from_repack(&root, Account::Admin).unwrap().command("mysql.exe");
assert_eq!(c.get_program(), root.join("mysql/bin").join("mysql.exe").as_os_str());
let a = args(&c);
assert!(!a.contains(&"exec".to_string()));
assert!(a.contains(&"--port=3999".to_string()) && a.contains(&"--host=127.0.0.1".to_string()));
assert_eq!(env_of(&c, "MYSQL_PWD").as_deref(), Some(ROOT_PW));
}
#[test]
fn a_docker_installation_does_not_need_tools_in_the_server_folder() {
let (_d, root) = folder(true);
assert!(!root.join("mysql").exists());
assert!(Db::from_repack(&root, Account::Admin).is_ok());
// ...but a broken Docker settings file is reported, not ignored.
std::fs::write(root.join("Settings/docker.json"), r#"{"project":"Bad Name"}"#).unwrap();
assert!(Db::from_repack(&root, Account::Admin).is_err());
}
#[test]
fn a_stopped_database_container_is_reported_as_a_database_that_is_not_running() {
let (_d, root) = folder(true);
let db = Db::from_repack(&root, Account::Admin).unwrap();
for text in ["Error response from daemon: container abc is not running", "Error response from daemon: No such container: coa-t1-db", "ERROR 2003 (HY000): Can't connect to MySQL server"] {
assert!(db.fail(text.as_bytes()).to_string().contains("not running"), "{text}");
}
assert!(db.fail(b"ERROR 1045 (28000): Access denied for user 'root'").to_string().contains("Access denied"));
}
}
+338 -7
View File
@@ -64,7 +64,9 @@ pub fn run(root: &Path, meta: &InstallMeta) -> Report {
let ports = layout::read_ports(root); let ports = layout::read_ports(root);
let o = process::observe(root, &ports); let o = process::observe(root, &ports);
for (title, s) in [("Database", &o.mysql), ("Login server", &o.auth), ("World server", &o.world)] { let mut services = vec![("Database", &o.mysql), ("Login server", &o.auth), ("World server", &o.world)];
if let Some(second) = &o.secondary_world { services.push(("Second world", second)); }
for (title, s) in services {
let (lvl, text) = match (s.state, &s.conflict) { let (lvl, text) = match (s.state, &s.conflict) {
(ServiceState::Running, _) => (Level::Ok, "Running".to_string()), (ServiceState::Running, _) => (Level::Ok, "Running".to_string()),
(_, Some(conf)) => (Level::Fail, format!("Port {} is used by another program (process {}).", conf.port, conf.pid)), (_, Some(conf)) => (Level::Fail, format!("Port {} is used by another program (process {}).", conf.port, conf.pid)),
@@ -124,6 +126,8 @@ pub struct FileProblem {
pub fn verify_managed(root: &Path, meta: &InstallMeta) -> Vec<FileProblem> { pub fn verify_managed(root: &Path, meta: &InstallMeta) -> Vec<FileProblem> {
let mut out = Vec::new(); let mut out = Vec::new();
for (rel, want) in &meta.original_hashes { for (rel, want) in &meta.original_hashes {
let lower = rel.replace('\\', "/").to_lowercase();
if lower.starts_with("mysql/data/") || lower.starts_with("settings/") || lower.starts_with("core/configs/") && !lower.ends_with(".dist") { continue; }
let Ok(p) = fsx::safe_join(root, rel) else { continue }; let Ok(p) = fsx::safe_join(root, rel) else { continue };
match fsx::sha256_file(&p) { match fsx::sha256_file(&p) {
Err(_) => out.push(FileProblem { path: rel.clone(), kind: "missing" }), Err(_) => out.push(FileProblem { path: rel.clone(), kind: "missing" }),
@@ -143,19 +147,183 @@ 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
}
const SENSITIVE: [&str; 7] = ["password", "passwd", "secret", "token", "apikey", "api_key", "databaseinfo"];
/// 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();
for line in text.lines() { for line in text.lines() {
let l = line.to_lowercase(); let l = line.to_lowercase();
let sensitive = ["password", "passwd", "secret", "token", "apikey", "api_key", "databaseinfo"].iter().any(|k| l.contains(k)); let sensitive = SENSITIVE.iter().any(|k| l.contains(k));
out.push(if sensitive { "[line removed: may contain a secret]".to_string() } else { line.to_string() }); out.push(if sensitive { "[line removed: may contain a secret]".to_string() } else { line.to_string() });
} }
out.join("\n") out.join("\n")
} }
/// The same for JSON: values under a sensitive key and strings that look like `password=...` are replaced, and the
/// result stays valid JSON (removing a whole line would break the file for whoever reads it). Text that is not JSON
/// falls back to the line rule.
pub fn redact_json(text: &str) -> String {
fn scrub(v: &mut serde_json::Value) {
use serde_json::Value;
match v {
Value::Object(map) => {
for (key, value) in map.iter_mut() {
let k = key.to_lowercase();
if SENSITIVE.iter().any(|s| k.contains(s)) && !value.is_object() && !value.is_array() {
*value = Value::String("[redacted]".into());
} else {
scrub(value);
}
}
}
Value::Array(items) => items.iter_mut().for_each(scrub),
Value::String(s) => {
let l = s.to_lowercase();
if ["password=", "passwd=", "secret=", "token=", "apikey=", "api_key=", "password:"].iter().any(|k| l.contains(k)) {
*s = "[redacted]".into();
}
}
_ => {}
}
}
match serde_json::from_str::<serde_json::Value>(text) {
Ok(mut v) => {
scrub(&mut v);
serde_json::to_string_pretty(&v).unwrap_or_else(|_| redact(text))
}
Err(_) => redact(text),
}
}
/// Keep the events of a `wevtutil ... /f:text` listing that mention one of `needles` (compared without case), in the
/// order listed, at most `max` of them.
pub fn filter_event_blocks(listing: &str, needles: &[&str], max: usize) -> String {
let mut blocks: Vec<Vec<&str>> = Vec::new();
for line in listing.lines() {
if line.starts_with("Event[") || blocks.is_empty() {
blocks.push(Vec::new());
}
if let Some(b) = blocks.last_mut() { b.push(line); }
}
blocks
.into_iter()
.map(|b| b.join("\n"))
.filter(|b| { let l = b.to_lowercase(); needles.iter().any(|n| l.contains(n)) })
.take(max)
.collect::<Vec<_>>()
.join("\n\n")
}
/// Drop the lines of an event listing that name the person or the computer.
pub fn drop_identity_lines(listing: &str) -> String {
listing
.lines()
.filter(|l| { let t = l.trim_start(); !(t.starts_with("User:") || t.starts_with("User Name:") || t.starts_with("Computer:")) })
.collect::<Vec<_>>()
.join("\n")
}
/// `wevtutil /uni:true` writes UTF-16 with a byte order mark; anything else is read as UTF-8 (lossy).
fn decode_console_output(bytes: &[u8]) -> String {
if bytes.starts_with(&[0xFF, 0xFE]) {
let units: Vec<u16> = bytes[2..].chunks_exact(2).map(|c| u16::from_le_bytes([c[0], c[1]])).collect();
String::from_utf16_lossy(&units)
} else {
String::from_utf8_lossy(bytes).into_owned()
}
}
/// Crashes and hangs Windows recorded for the server programs in the last two weeks. This is the only trace of a crash
/// that ends the process without the server's own crash report (a stack buffer overrun, for example). The lines that
/// name the user and the computer are left out.
#[cfg(windows)]
fn windows_events() -> String {
use std::os::windows::process::CommandExt;
let query = "*[System[(Provider[@Name='Application Error' or @Name='Windows Error Reporting' or @Name='Application Hang']) and TimeCreated[timediff(@SystemTime) <= 1209600000]]]";
let out = std::process::Command::new("wevtutil")
.args(["qe", "Application", &format!("/q:{query}"), "/c:300", "/rd:true", "/f:text", "/uni:true"])
.creation_flags(0x0800_0000)
.output();
match out {
Ok(o) if o.status.success() => {
let text = filter_event_blocks(&decode_console_output(&o.stdout), &["worldserver", "authserver", "mysqld", "coa server manager", "coa-server-manager"], 40);
if text.is_empty() { "No crash or hang of the server programs was recorded by Windows in the last 14 days.".into() } else { drop_identity_lines(&text) }
}
Ok(o) => format!("Windows event log could not be read: {}", decode_console_output(&o.stderr).trim()),
Err(e) => format!("Windows event log could not be read: {e}"),
}
}
#[cfg(not(windows))]
fn windows_events() -> String {
String::new()
}
/// Newest files of a folder with the given extension (compared without case): path, size, modified time.
fn newest_files(dir: &Path, ext: &str, limit: usize) -> Vec<(PathBuf, u64, std::time::SystemTime)> {
let Ok(rd) = fs::read_dir(dir) else { return Vec::new() };
let mut v: Vec<_> = rd
.flatten()
.filter(|e| e.path().extension().is_some_and(|x| x.eq_ignore_ascii_case(ext)))
.filter_map(|e| { let m = e.metadata().ok()?; m.is_file().then(|| (e.path(), m.len(), m.modified().unwrap_or(std::time::UNIX_EPOCH))) })
.collect();
v.sort_by(|a, b| b.2.cmp(&a.2));
v.truncate(limit);
v
}
/// Which server programs run right now and from where, next to what the Manager made of it. A program started from a
/// folder or a copy the Manager does not know shows up here even when the Manager reports "port in use".
fn processes_report(root: &Path, ports: &layout::Ports) -> String {
let here = root.to_string_lossy().to_lowercase().replace('/', "\\");
let listen = process::listeners_detailed();
let mut out = String::from("Server programs running now (any folder):\n");
let found = process::find_by_file_names(&["worldserver.exe", "authserver.exe", "mysqld.exe"]);
if found.is_empty() { out.push_str(" none\n"); }
for p in found {
let ports_of: Vec<String> = listen.iter().filter(|l| l.pid == p.pid).map(|l| l.port.to_string()).collect();
let inside = p.exe.to_lowercase().replace('/', "\\").starts_with(&here);
out.push_str(&format!(" pid {} {} | listening on: {} | {}\n", p.pid, p.exe, if ports_of.is_empty() { "-".into() } else { ports_of.join(", ") }, if inside { "inside this server folder" } else { "OUTSIDE this server folder" }));
}
let o = process::observe(root, ports);
out.push_str("\nThe Manager's view:\n");
for s in [Some(&o.mysql), Some(&o.auth), Some(&o.world), o.secondary_world.as_ref()].into_iter().flatten() {
out.push_str(&format!(" {:<16} {:?} port {} {}{}\n", s.name, s.state, s.port, s.pid.map(|p| format!("pid {p}")).unwrap_or_default(), s.conflict.as_ref().map(|c| format!(" | port held by pid {} {}", c.pid, c.exe.clone().unwrap_or_default())).unwrap_or_default()));
}
out
}
/// Zip with what a maintainer needs to debug a problem, with secrets removed. Returns the number of files inside. /// Zip with what a maintainer needs to debug a problem, with secrets removed. Returns the number of files inside.
/// One call collects everything: the Manager's and the server's logs, crash reports and small crash dumps, Windows'
/// own record of crashes, the update journals, the running server programs and the settings the client depends on.
pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &InstallMeta, report: &Report, out_zip: &Path) -> Result<usize> { pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &InstallMeta, report: &Report, out_zip: &Path) -> Result<usize> {
const DUMP_FILE_MAX: u64 = 30 * 1024 * 1024;
let file = fs::File::create(out_zip)?; let file = fs::File::create(out_zip)?;
let mut zip = zip::ZipWriter::new(file); let mut zip = zip::ZipWriter::new(file);
let opts = zip::write::SimpleFileOptions::default().compression_method(zip::CompressionMethod::Deflated); let opts = zip::write::SimpleFileOptions::default().compression_method(zip::CompressionMethod::Deflated);
@@ -166,20 +334,100 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
n += 1; n += 1;
Ok(()) Ok(())
}; };
let ports = layout::read_ports(root);
let summary = serde_json::json!({ let summary = serde_json::json!({
"manager": crate::MANAGER_VERSION, "manager": crate::MANAGER_VERSION,
"exported_utc": chrono::Utc::now().to_rfc3339(),
"core": meta.core, "core": meta.core,
"bots": meta.bots, "bots": meta.bots,
"squid_bots": crate::squid::release(root),
"kind": meta.kind, "kind": meta.kind,
"layout": meta.layout, "layout": meta.layout,
"checks": report.checks, "checks": report.checks,
"wow_client_set": meta.client_path.is_some(), "wow_client_set": meta.client_path.is_some(),
}); });
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"))] {
let bytes = tail(&path, 512 * 1024); // Logs. The newest update logs of the repack's own updater are added under their own names.
let mut logs: Vec<(String, PathBuf)> = vec![
("manager.log".into(), manager_log.to_path_buf()),
("manager-install.log".into(), meta_dir.join("logs/manager.log")),
("Server.log.tail".into(), root.join("Core/Logs/Server.log")),
("Errors.log.tail".into(), root.join("Core/Logs/Errors.log")),
("Auth.log.tail".into(), root.join("Core/Logs/Auth.log")),
("world-console.log.tail".into(), root.join("Core/Logs/world-console.log")),
("CoaBots.log.tail".into(), root.join("Core/Logs/CoaBots.log")),
("Playerbots.log.tail".into(), root.join("Core/Logs/Playerbots.log")),
("supervisor.log.tail".into(), root.join("Core/Logs/supervisor.log")),
("mysql-error.log.tail".into(), root.join("mysql/logs/mysql-error.log")),
];
let updater_logs = newest_files(&root.join("Core/Logs"), "log", usize::MAX).into_iter().filter(|(p, _, _)| p.file_name().is_some_and(|f| f.to_string_lossy().to_lowercase().starts_with("update-")));
for (p, _, _) in updater_logs.take(2) {
logs.push((format!("{}.tail", p.file_name().unwrap_or_default().to_string_lossy()), p));
}
for (name, path) in logs {
// A module that reads a missing setting on every tick fills a log with one warning, thousands of times; read far
// enough back to see past that, fold the repeats, then keep the last part.
let bytes = tail(&path, 8 * 1024 * 1024);
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())?;
}
}
// Crash reports of the server (text, and the small dumps next to them), and what Windows recorded for the programs.
let crashes = root.join("Core/Crashes");
let mut listing = String::new();
for (p, len, _) in newest_files(&crashes, "txt", 10) {
let name = p.file_name().unwrap_or_default().to_string_lossy().into_owned();
listing.push_str(&format!("{name} ({len} bytes)\n"));
let text = String::from_utf8_lossy(&tail(&p, 1024 * 1024)).into_owned();
add(&format!("crashes/{name}"), redact(&text).as_bytes())?;
}
for (p, len, _) in newest_files(&crashes, "dmp", 3) {
let name = p.file_name().unwrap_or_default().to_string_lossy().into_owned();
if len > DUMP_FILE_MAX {
listing.push_str(&format!("{name} ({len} bytes) not included: larger than {} MB\n", DUMP_FILE_MAX >> 20));
} else if let Ok(bytes) = fs::read(&p) {
listing.push_str(&format!("{name} ({len} bytes) included\n"));
add(&format!("crashes/{name}"), &bytes)?;
}
}
add("crashes.txt", if listing.is_empty() { "No crash reports in Core/Crashes.".to_string() } else { listing }.as_bytes())?;
let events = windows_events();
if !events.is_empty() { add("windows-events.txt", events.as_bytes())?; }
add("processes.txt", processes_report(root, &ports).as_bytes())?;
// The newest update journals: the state of each update and the reason it failed.
let mut journals: Vec<_> = fs::read_dir(meta_dir.join("updates")).into_iter().flatten().flatten()
.filter(|e| e.file_type().is_ok_and(|t| t.is_dir()) && e.file_name().to_string_lossy().chars().all(|c| c.is_ascii_alphanumeric() || matches!(c, '-' | '_')))
.collect();
journals.sort_by_key(|e| std::cmp::Reverse(e.file_name()));
for e in journals.into_iter().take(5) {
if let Ok(text) = fs::read_to_string(e.path().join("txn.json")) {
add(&format!("updates/{}-txn.json", e.file_name().to_string_lossy()), redact_json(&text).as_bytes())?;
}
}
// Which files the server's own configuration folders hold, and the two CoA switches that decide whether the game
// client can talk to the world server at all.
let mut present = String::new();
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.
@@ -190,7 +438,10 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
} }
} }
if let Ok(b) = fs::read(root.join("RELEASE.json")) { if let Ok(b) = fs::read(root.join("RELEASE.json")) {
add("RELEASE.json", redact(&String::from_utf8_lossy(&b)).as_bytes())?; add("RELEASE.json", redact_json(&String::from_utf8_lossy(&b)).as_bytes())?;
}
if let Ok(b) = fs::read(meta_dir.join("logs/database-checks.json")) {
add("database-checks.json", redact_json(&String::from_utf8_lossy(&b)).as_bytes())?;
} }
zip.finish().map_err(|e| Error::Invalid(e.to_string()))?; zip.finish().map_err(|e| Error::Invalid(e.to_string()))?;
Ok(n) Ok(n)
@@ -210,6 +461,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");
@@ -217,6 +483,68 @@ mod tests {
assert!(!t.contains("PASS") && !t.contains("abc")); assert!(!t.contains("PASS") && !t.contains("abc"));
} }
#[test]
fn json_redaction_keeps_the_file_valid_and_hides_the_secrets() {
let t = redact_json(r#"{"id":"rev_20261006_token_cache","password":"hunter2","nested":{"apiKey":"k","note":"login with password=abc"},"list":[{"secret":1},"ok"]}"#);
let v: serde_json::Value = serde_json::from_str(&t).expect("still JSON");
assert_eq!(v["id"], "rev_20261006_token_cache", "an id that merely contains a word is kept");
assert_eq!(v["password"], "[redacted]");
assert_eq!(v["nested"]["apiKey"], "[redacted]");
assert_eq!(v["nested"]["note"], "[redacted]");
assert_eq!(v["list"][0]["secret"], "[redacted]");
assert_eq!(v["list"][1], "ok");
assert!(!t.contains("hunter2") && !t.contains("abc"));
assert!(redact_json("not json\nPassword=1").contains("[line removed"), "text falls back to the line rule");
}
#[test]
fn windows_events_are_filtered_to_the_server_programs() {
let listing = "Event[0]:\n Provider Name: Application Error\n Description: Faulting application name: worldserver.exe, version: 0.0.0.0\n\nEvent[1]:\n Provider Name: Application Error\n Description: Faulting application name: notepad.exe\n\nEvent[2]:\n Description: Faulting application name: MYSQLD.EXE\n";
let out = filter_event_blocks(listing, &["worldserver", "mysqld"], 10);
assert!(out.contains("worldserver.exe") && out.contains("MYSQLD.EXE") && !out.contains("notepad"));
assert_eq!(filter_event_blocks(listing, &["worldserver", "mysqld"], 1).matches("Event[").count(), 1);
}
#[test]
fn event_text_loses_the_user_and_computer_lines_and_reads_utf16() {
let out = drop_identity_lines("Event[0]\n Source: Application Error\n User: S-1-5-21-1\n User Name: PC\\Dion\n Computer: PC\n Description: worldserver.exe");
assert!(out.contains("Source") && out.contains("worldserver.exe"));
assert!(!out.contains("S-1-5") && !out.contains("Dion") && !out.contains("Computer"));
let mut bytes = vec![0xFF, 0xFE];
for u in "Сбой worldserver".encode_utf16() { bytes.extend_from_slice(&u.to_le_bytes()); }
assert_eq!(decode_console_output(&bytes), "Сбой worldserver");
assert_eq!(decode_console_output(b"plain"), "plain");
}
#[test]
fn the_package_carries_crash_reports_update_journals_and_the_process_view() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
layout::testkit::fake_repack(&root);
fs::create_dir_all(root.join("Core/Crashes")).unwrap();
fs::write(root.join("Core/Crashes/567e_worldserver.exe_[4-10_21-25-31].txt"), "Exception code: C0000005\nRCX:0\n").unwrap();
fs::write(root.join("Core/Crashes/567e_worldserver.exe_[4-10_21-25-31].dmp"), b"MDMP-small").unwrap();
fs::write(root.join("Core/Logs/CoaBots.log"), "bot line\n").unwrap();
fs::write(root.join("Core/Logs/update-1.8-20261005.log"), "updater line\n").unwrap();
let meta_dir = d.path().join("srv.manager");
fs::create_dir_all(meta_dir.join("updates/20261006-082021-0_261006_1-abc")).unwrap();
fs::write(meta_dir.join("updates/20261006-082021-0_261006_1-abc/txn.json"), r#"{"state":"rolled-back","message":"Database update 2026_02_24_00 failed: duplicate column"}"#).unwrap();
fs::create_dir_all(meta_dir.join("updates/not a journal!")).unwrap();
let meta = InstallMeta::new(InstallKind::Imported, &root);
let report = run(&root, &meta);
let zip_path = d.path().join("diag.zip");
export_package(&root, &meta_dir, &d.path().join("none.log"), &meta, &report, &zip_path).unwrap();
let mut z = zip::ZipArchive::new(fs::File::open(&zip_path).unwrap()).unwrap();
let names: Vec<String> = (0..z.len()).map(|i| z.by_index(i).unwrap().name().to_string()).collect();
for want in ["crashes.txt", "processes.txt", "CoaBots.log.tail", "update-1.8-20261005.log.tail", "updates/20261006-082021-0_261006_1-abc-txn.json", "crashes/567e_worldserver.exe_[4-10_21-25-31].txt", "crashes/567e_worldserver.exe_[4-10_21-25-31].dmp"] {
assert!(names.iter().any(|n| n == want), "{want} is in the package: {names:?}");
}
assert!(!names.iter().any(|n| n.contains("not a journal")));
let mut listing = String::new();
z.by_name("crashes.txt").unwrap().read_to_string(&mut listing).unwrap();
assert!(listing.contains("included"));
}
#[test] #[test]
fn verify_reports_missing_and_changed_managed_files_only() { fn verify_reports_missing_and_changed_managed_files_only() {
let d = tempfile::tempdir().unwrap(); let d = tempfile::tempdir().unwrap();
@@ -252,6 +580,8 @@ mod tests {
let d = tempfile::tempdir().unwrap(); let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv"); let root = d.path().join("srv");
layout::testkit::fake_repack(&root); layout::testkit::fake_repack(&root);
fs::create_dir_all(root.join("Extras/SquidPlayerbots")).unwrap();
fs::write(root.join("Extras/SquidPlayerbots/release.json"), r#"{"tag":"v1.8","commit":"48c4786a","password":"upstream-secret"}"#).unwrap();
fs::write(root.join("Core/Logs/Errors.log"), "boom\nDatabase password=hunter2 rejected\n").unwrap(); fs::write(root.join("Core/Logs/Errors.log"), "boom\nDatabase password=hunter2 rejected\n").unwrap();
fs::write(root.join("Core/configs/worldserver.conf"), "LoginDatabaseInfo = \"127.0.0.1;3307;acore;SECRETPW;auth\"\nRate.XP.Kill = 1\n").unwrap(); fs::write(root.join("Core/configs/worldserver.conf"), "LoginDatabaseInfo = \"127.0.0.1;3307;acore;SECRETPW;auth\"\nRate.XP.Kill = 1\n").unwrap();
let meta_dir = d.path().join("srv.manager"); let meta_dir = d.path().join("srv.manager");
@@ -269,6 +599,7 @@ mod tests {
all.push_str(&s); all.push_str(&s);
} }
assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included"); assert!(all.contains("boom") && all.contains("Rate.XP.Kill"), "keys and ordinary log lines are included");
assert!(!all.contains("hunter2") && !all.contains("SECRETPW")); assert!(all.contains("v1.8") && all.contains("48c4786a"));
assert!(!all.contains("hunter2") && !all.contains("SECRETPW") && !all.contains("upstream-secret"));
} }
} }
@@ -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();
}
}
Loaded 100 of 215 files, more files were not shown because too many files have changed in this diff. Show more