Compare commits

..
Author SHA1 Message Date
Дмитрий 6a955bd670 Release CoA Server Manager 0.6.16 2026-10-13 17:12:18 +05:00
Corfirean d5f441de0c Merge pull request #93 from Corfirean/fix/long-rehearsal-paths-84
Fix long Windows SQL paths in update rehearsals
2026-10-13 07:24:38 +05:00
Дмитрий 4efc02e768 fix(paths): recognize long Windows rehearsal paths inside server 2026-10-13 07:18:03 +05:00
Corfirean be9641254a Merge pull request #92 from Corfirean/feat/client-races-1.6
feat(client): update custom races to verified 1.6 payloads
2026-10-13 07:14:35 +05:00
Дмитрий c18daac228 docs(changelog): record supported experimental bot race preset 2026-10-13 07:02:07 +05:00
Дмитрий 89c62abf80 fix(bots): align experimental race exclusions with upstream 1.6 2026-10-13 07:01:15 +05:00
Дмитрий a6471d79d0 feat(client): update verified custom race payloads to 1.6 2026-10-13 06:52:12 +05:00
Corfirean fd0eaafda2 Merge pull request #70 from lostmind84/feat/linux-b4-parity
feat: Docker server parity on Linux (realm online, game data folder, settings, sharing)
2026-10-13 06:50:56 +05:00
Corfirean fb1cc38773 Merge pull request #73 from LarsSeverson/fix/local-host-friends-mode
fix(friends): preserve local realm address
2026-10-13 06:42:46 +05:00
Corfirean 7a950f234b Merge pull request #91 from Corfirean/fix/export-maintenance-diagnostics
fix(diagnostics): log refused starts and export maintenance ownership
2026-10-13 06:42:42 +05:00
Corfirean 2f1df13b7a Merge pull request #90 from Corfirean/fix/operation-lock-contention
fix(startup): wait for update checks and identify active maintenance
2026-10-13 06:42:38 +05:00
Corfirean be705329c1 Merge pull request #89 from Corfirean/fix/show-installed-module-versions
feat(modules): display installed server revisions and client patch version
2026-10-13 06:42:34 +05:00
Corfirean 7e70409ca0 Merge pull request #88 from Corfirean/fix/client-patch-preservation
fix(client): preserve and repair custom race patch files safely
2026-10-13 06:42:08 +05:00
Corfirean 9e6a650d13 Merge pull request #87 from Corfirean/fix/startup-failure-service-logs
fix(diagnostics): show service errors behind failed update rehearsal
2026-10-13 06:42:04 +05:00
Corfirean 0398a5a6f9 Merge pull request #86 from Corfirean/fix/stock-bot-race-exclusions
fix(bots): keep the standard-races preset free of custom race IDs
2026-10-13 06:42:00 +05:00
Corfirean dd23e81dd4 Merge pull request #85 from Corfirean/fix/recheck-installed-release
fix(updates): allow checking the already installed release
2026-10-13 06:41:56 +05:00
Дмитрий ca2a555d7c fix(docker): request restart when remote client protocol changes 2026-10-13 06:41:16 +05:00
Дмитрий 8269a53db7 fix(diagnostics): record refused starts and export maintenance ownership 2026-10-13 06:26:46 +05:00
Дмитрий b97f86fc00 feat(modules): show installed revisions and client patch versions 2026-10-13 06:21:05 +05:00
Дмитрий 1a71f18def fix(client): create missing patch directories before publishing 2026-10-13 06:20:23 +05:00
Дмитрий 358f9f4f2b fix(bots): exclude every nonstandard race in the stock preset 2026-10-13 06:17:52 +05:00
Дмитрий 0c0d2db368 fix(startup): wait for checks and report operation lock owners 2026-10-13 06:17:17 +05:00
Дмитрий 7d7bc530ec fix(client): preserve originals and verify race patch lifecycle 2026-10-13 06:14:32 +05:00
Дмитрий acd04fae2f fix(diagnostics): include service errors after launcher readiness 2026-10-13 06:10:56 +05:00
Дмитрий 106a532092 fix(updates): accept rechecking the installed target release 2026-10-13 05:59:38 +05:00
LarsSeverson 51ef88101e fix(friends): preserve local realm address 2026-10-11 11:35:24 -05:00
Fabien F. 4d8ca00e46 test: a Docker config built by a test has no database data directory 2026-10-11 08:57:43 +02:00
Fabien F. 36bfc6d31e docs: changelog entry for Docker server parity 2026-10-11 08:57:43 +02:00
Fabien F. 3fb4ee39c6 fix: the realm is not shown offline after a start on Docker
The auth server marks every realm offline when it starts, after the world server
cleared its own flag. Mark the active realm online once the auth server listens.
2026-10-11 08:57:43 +02:00
Fabien F. 0250b61c62 feat: a wrong game data folder is diagnosed, and it can be changed from Settings
The world refusing to start with the standard Data set (no CoA DBC) is now
reported as GameDataMismatch. A Settings card shows the folder in use and
changes it while the server is stopped, using the install checks.
2026-10-11 08:57:43 +02:00
Fabien F. dfd8a50975 fix: sharing with friends and the other screens work on a Docker server
Second part of the audit of every screen for a Docker server. What it found, and
what now happens:

- Play with friends. "Servers open" read the BindIP of the configuration files, which
  the containers force to 0.0.0.0, so it was green on a fresh server while who can
  connect is decided by the address the ports are published on (bindAddress in
  docker.json). Opening and closing now edit bindAddress (and set
  CoA.AllowRemoteClients), the open state is read from it, and enabling a mode no
  longer fails on netsh / PowerShell after it already rewrote the files. There is no
  firewall row on Linux (Docker publishes the ports itself); the Windows reply is
  unchanged.
- The "private services" check (Friends and Diagnostics) could never fail on Linux: it
  reads the Windows listener table. For a Docker server it is computed from how the
  ports are published: the database never, the console only on 127.0.0.1, the game
  servers on bindAddress.
- Console, Database tab: read a mysql log file that does not exist; it shows
  `docker logs` of the database container.
- The Overview showed a service that had stopped by itself as "Stopped"; it now says
  "Stopped unexpectedly".
- Settings: a Docker server that was added but never started had no
  worldserver.conf and the page failed; it is created from its template. A talent
  file path outside the Core folder is refused (the container cannot see it).
- Backups of configuration now include docker.json; verifying the files of an
  imported Docker server looked for worldserver.exe and reported it missing.
- Linux locations: the friend package and the diagnostics go to the desktop folder
  (from the user directories file) instead of /tmp, the problem report names the
  distribution, and the size advice for companions reads /proc/meminfo instead of
  assuming 8 GB.

Every Windows branch is the code that was there; the dispatch is the early return on
docker::is_docker (or the host flavor for the firewall).
2026-10-11 08:57:38 +02:00
Fabien F. 90c308615b fix: settings the Docker backend fixes are not offered, and the world restarts itself
Found by auditing every screen for a Docker server.

- Server settings: Ra.Enable, Ra.IP and Updates.EnableDatabases were on the page and
  written to worldserver.conf, but the containers get AC_RA_ENABLE, AC_RA_IP and
  AC_UPDATES_ENABLE_DATABASES, and the core reads those before the file: the change
  was accepted and had no effect, and the page showed the file's value while the
  container ran another. A Docker server no longer offers them (nor "restore
  recommended defaults" for them), and a change forced through is refused with the
  reason. The list is docker::FORCED_KEYS, and a test compares it to the variables
  the containers really get, so adding one without the other fails.
- `server restart` (and idlerestart) make the core exit with code 2 and expect a
  supervisor to start it again; the Docker world had none and showed "crashed". It now
  gets `--restart on-failure:3`, applied once the server is up (so a start that fails
  stays failed instead of looping); a stop or `server shutdown` (code 0) is never
  restarted.
2026-10-11 08:57:38 +02:00
48 changed files with 1522 additions and 177 deletions

No files matched your search

Generated
+3 -3
View File
@@ -491,7 +491,7 @@ dependencies = [
[[package]]
name = "coa-core"
version = "0.6.15"
version = "0.6.16"
dependencies = [
"base64 0.22.1",
"chrono",
@@ -520,7 +520,7 @@ dependencies = [
[[package]]
name = "coa-release"
version = "0.6.15"
version = "0.6.16"
dependencies = [
"chrono",
"coa-core",
@@ -529,7 +529,7 @@ dependencies = [
[[package]]
name = "coa-server-manager"
version = "0.6.15"
version = "0.6.16"
dependencies = [
"coa-core",
"serde",
+1 -1
View File
@@ -3,7 +3,7 @@ resolver = "2"
members = ["crates/coa-core", "crates/coa-release", "src-tauri"]
[workspace.package]
version = "0.6.15"
version = "0.6.16"
edition = "2021"
license = "AGPL-3.0-only"
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Linux Docker servers follow Settings, sharing and backups (experimental)
---
Experimental. Settings the Docker backend fixes are hidden, friends sharing and logs work, the game data folder can be changed, and the realm no longer shows offline after a start.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Local hosts can connect while sharing a server online
---
The Manager no longer replaces the realm's local address with its public address when Friends mode is enabled.
@@ -0,0 +1,7 @@
---
area: client
type: changed
audience: admins
title: Custom race client installation follows the current upstream release
---
The installer verifies the current race archives and includes the two additional MPQs. Legacy patch hashes remain available so upgrading never mistakes the old custom executable for an original launcher file.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Docker friend mode requests a restart when remote client support changes
---
Enabling remote CoA clients now requests a world restart even when the game ports were already open. Repeating the same unchanged setting does not request another restart.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Module cards show installed server revisions and the client race patch version
---
Module revisions come from the currently installed release metadata. The race card shows the client patch version separately; missing version metadata is reported honestly instead of showing a download version as installed.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Server updates accept long Windows paths inside the private test server
---
Long SQL file paths no longer fail the folder safety check during update rehearsals. Files outside the server folder remain blocked.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Diagnostics record blocked startup requests and maintenance owner information
---
A start refused before the launcher runs is now logged with its reason. Exported diagnostics include the last recorded maintenance owner, while clearly distinguishing old metadata from a currently held operating-system lock.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Client race patches can be repaired and removed while preserving original files
---
Every overwritten client file gets an original backup. Switching preserves newer launcher files; checksums detect missing or replaced assets. Repair and removal are always available, with rollback if a file operation fails.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Checking an already installed server update no longer reports incompatibility
---
The installed release can be checked again even when its compatibility list only names earlier releases. Platform checks and protection against downgrades still apply.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Failed server startup shows service errors even when the launcher reported ready
---
Update rehearsal and startup failures include recent world, authentication and database error lines. Missing tables and late startup failures are visible directly in the error details, with secrets redacted.
+7
View File
@@ -0,0 +1,7 @@
---
area: bots
type: fixed
audience: admins
title: Disabling custom races for SQUID bots now excludes all nonstandard races
---
The standard-races preset keeps only the ten original playable races. High elves, worgen and other custom race IDs are excluded, and the displayed setting reads complete race IDs rather than matching number substrings.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Starting the server waits for update checks and identifies ongoing maintenance
---
Downloading an update manifest no longer blocks startup. A start waits up to 30 seconds for a check to finish; other active maintenance still blocks it safely and shows its operation, process and start time.
@@ -0,0 +1,7 @@
---
area: bots
type: changed
audience: admins
title: The experimental SQUID race preset follows the current race release
---
Custom-race bots now use the upstream supported-race preset, excluding Test Race, Skyborne and Darkfallen. The standard-races preset continues to exclude all custom races.
+1 -1
View File
@@ -212,7 +212,7 @@ pub fn config_files(root: &Path) -> Vec<String> {
for e in rd.flatten() {
let n = e.file_name().to_string_lossy().to_string();
// database.json holds generated database passwords; it is launcher state, not configuration.
if e.path().is_file() && (n.contains(".template") || n == "repack.json") {
if e.path().is_file() && (n.contains(".template") || n == "repack.json" || n == "docker.json") {
out.push(format!("Settings/{n}"));
}
}
+35
View File
@@ -206,6 +206,10 @@ pub fn drift(root: &Path) -> Result<Vec<String>> {
}
pub fn load(root: &Path, scope: Scope) -> Result<SettingsView> {
// A Docker server that was added but never started has no active world configuration yet; create it from its template.
if scope == Scope::Server && crate::docker::is_docker(root) {
let _ = crate::docker::ensure_main_configs(root);
}
let schema = scope.schema();
let t = targets(root, scope)?;
let conf = load_conf(&t.read)?;
@@ -213,9 +217,12 @@ pub fn load(root: &Path, scope: Scope) -> Result<SettingsView> {
let known: BTreeSet<&str> = schema.settings.iter().map(|s| s.key.as_str()).collect();
let unknown_keys = conf.entries().filter(|(k, _)| !known.contains(k)).count();
// On a Docker server some settings are fixed by the backend (environment beats the file): not offered.
let docker = scope == Scope::Server && crate::docker::is_docker(root);
let settings = schema
.settings
.iter()
.filter(|s| !(docker && crate::docker::managed_setting(&s.key)))
.map(|s| {
let raw = conf.get(&s.key);
let (value, problem) = match raw {
@@ -286,11 +293,19 @@ pub fn validate(root: &Path, scope: Scope, changes: &BTreeMap<String, Value>) ->
let schema = scope.schema();
let mut errors = Vec::new();
let mut raws = BTreeMap::new();
let docker = scope == Scope::Server && crate::docker::is_docker(root);
for (key, value) in changes {
match schema.get(key) {
None => errors.push(FieldError { key: key.clone(), message: "is not a setting the Manager can change".into() }),
Some(_) if docker && crate::docker::managed_setting(key) => {
errors.push(FieldError { key: key.clone(), message: "is set by the Docker backend; changing it in the file would have no effect".into() })
}
Some(s) => match s.to_raw(value) {
Ok(raw) => {
if let Some(problem) = crate::docker::setting_problem(key, &raw).filter(|_| crate::docker::is_docker(root)) {
errors.push(FieldError { key: key.clone(), message: problem.into() });
continue;
}
raws.insert(key.clone(), raw);
}
Err(m) => errors.push(FieldError { key: key.clone(), message: m }),
@@ -736,6 +751,26 @@ Spellbook.New = 5
assert!(list_snapshots(&meta).is_empty(), "no snapshot for a rejected save");
}
#[test]
fn a_docker_server_is_not_offered_the_settings_its_backend_fixes() {
let (_d, root, meta) = fixture();
let keys = |root: &Path| load(root, Scope::Server).unwrap().settings.into_iter().map(|s| s.meta.key).collect::<Vec<_>>();
for k in ["Ra.Enable", "Ra.IP", "Updates.EnableDatabases", "PlayerLimit"] {
assert!(keys(&root).iter().any(|x| x == k), "a repack offers {k}");
}
fs::write(root.join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap();
let docker = keys(&root);
for k in ["Ra.Enable", "Ra.IP", "Updates.EnableDatabases"] {
assert!(!docker.iter().any(|x| x == k), "a Docker server does not offer {k}: the containers' environment beats the file");
}
assert!(docker.iter().any(|x| x == "PlayerLimit"), "everything else is still offered");
// Forcing a change through is refused and says why, instead of being saved and ignored.
let err = save(&root, &meta, Scope::Server, &set(&[("Ra.Enable", json!(0))])).unwrap_err().to_string();
assert!(err.contains("Docker backend"), "{err}");
assert!(!fs::read_to_string(root.join("Core/configs/worldserver.conf")).unwrap().contains("Ra.Enable = 0"));
save(&root, &meta, Scope::Server, &set(&[("PlayerLimit", json!(77))])).unwrap();
}
#[test]
fn missing_key_is_appended_and_noop_saves_do_nothing() {
let (_d, root, meta) = fixture();
+13
View File
@@ -51,6 +51,19 @@ fn classify(l: &str) -> Level {
}
}
/// The last `max_lines` lines of some text (after filtering), classified and redacted like the lines of a log file.
pub fn lines_from_text(text: &str, filter: Option<&str>, max_lines: usize) -> Vec<Line> {
let needle = filter.map(str::to_lowercase).filter(|n| !n.is_empty());
let out: Vec<Line> = text
.lines()
.filter(|l| !l.trim().is_empty())
.filter(|l| needle.as_ref().map(|n| l.to_lowercase().contains(n)).unwrap_or(true))
.map(|l| Line { level: classify(l), text: crate::diag::redact(l) })
.collect();
let skip = out.len().saturating_sub(max_lines);
out.into_iter().skip(skip).collect()
}
/// The last `max_lines` lines (after filtering) from the last ~512 KB of a log. Works on multi-gigabyte files.
pub fn tail(path: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
const WINDOW: u64 = 512 * 1024;
+415 -141
View File
@@ -14,20 +14,20 @@ use crate::download::Cancel;
use crate::error::{Error, Result};
use crate::fsx;
pub const CLIENT_VERSION: &str = "1.5";
pub const CLIENT_VERSION: &str = "1.6";
pub const MANIFEST_FILENAME: &str = "custom_races_patch_manifest.txt";
pub const ARCHIVES: &[(&str, &str)] = &[
(
"CoA-Custom-1.5-main-20261009-cb2a0ca4.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-main-20261009-cb2a0ca4.zip",
"CoA-Custom-1.6-main-20261012-4dd3a4ec.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.6/CoA-Custom-1.6-main-20261012-4dd3a4ec.zip",
),
(
"CoA-Custom-1.5-client-part1.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-client-part1.zip",
"CoA-Custom-1.6-client-part1.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.6/CoA-Custom-1.6-client-part1.zip",
),
(
"CoA-Custom-1.5-client-part2.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-client-part2.zip",
"CoA-Custom-1.6-client-part2.zip",
"https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.6/CoA-Custom-1.6-client-part2.zip",
),
];
@@ -52,13 +52,15 @@ pub const RACE_MPQS: &[&str] = &[
"patch-ZJ.MPQ",
"patch-ZZE.MPQ",
"patch-ZZR.MPQ",
"patch-ZZS.MPQ",
"patch-ZZT.MPQ",
];
pub const EXCLUDED_BOT_RACES_RECOMMENDED: &str =
"19,27,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128";
"9,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,103,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,128";
pub const EXCLUDED_BOT_RACES_EXPERIMENTAL: &str =
"16,19,27,32,50,52,53,65,66,67,68,69,70,71,72,74,77,80,81";
"65,72,77,80,81";
/// Finds all active playerbots.conf files on this server (root, coa-bots folder, and secondary realm).
pub fn playerbots_conf_paths(root: &Path) -> Vec<PathBuf> {
@@ -99,7 +101,8 @@ pub fn is_bot_custom_races_allowed(root: &Path) -> Option<bool> {
if let Ok(conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) {
if let Some(val) = conf.get("AiPlayerbot.ExcludedBotRaces") {
let clean = val.trim().trim_matches(['"', '\'']);
return Some(!clean.contains("33") && !clean.contains("128"));
let excluded: std::collections::BTreeSet<u32> = clean.split(',').filter_map(|race| race.trim().parse().ok()).collect();
return Some((1..=128).filter(|race| ![1, 2, 3, 4, 5, 6, 7, 8, 10, 11].contains(race)).any(|race| !excluded.contains(&race)));
}
}
}
@@ -146,112 +149,224 @@ pub enum ClientPatchState {
#[serde(rename_all = "camelCase")]
pub struct ClientPatchStatus {
pub state: ClientPatchState,
pub version: Option<String>,
pub installed_mpqs: usize,
pub total_mpqs: usize,
pub has_root_files: bool,
pub client_path: Option<String>,
}
/// Inspect the client folder and determine the state of custom races patches.
pub fn client_patch_status(client_path: &Path) -> ClientPatchStatus {
let data_dir = client_path.join("Data");
let mut enabled_count = 0;
let mut disabled_count = 0;
for mpq in RACE_MPQS {
if data_dir.join(format!("{mpq}.disabled")).is_file() {
disabled_count += 1;
} else if data_dir.join(mpq).is_file() {
enabled_count += 1;
}
}
let has_root = client_path.join("EsteriaAppearance.dll").is_file()
|| client_path.join("dinput8.dll").is_file()
|| client_path.join("dinput8.dll.disabled").is_file();
let total = RACE_MPQS.len();
let current_version = fs::read_to_string(client_path.join(MANIFEST_FILENAME)).ok()
.is_some_and(|manifest| manifest.lines().any(|line| line == format!("# CoA Custom {CLIENT_VERSION}")));
let state = if enabled_count == total && current_version && client_path.join("dinput8.dll").is_file() {
ClientPatchState::Enabled
} else if disabled_count == total && current_version && client_path.join("dinput8.dll.disabled").is_file() {
ClientPatchState::Disabled
} else if (enabled_count + disabled_count) > 0 {
ClientPatchState::PartiallyInstalled
} else {
ClientPatchState::NotInstalled
};
ClientPatchStatus {
state,
installed_mpqs: enabled_count + disabled_count,
total_mpqs: total,
has_root_files: has_root,
client_path: Some(client_path.to_string_lossy().into_owned()),
}
#[derive(Clone, Serialize, Deserialize)]
struct PatchFile {
path: String,
sha256: String,
}
/// Enable or disable client patches by renaming MPQs and `dinput8.dll` with `.disabled`.
pub fn set_client_patch_enabled(client_path: &Path, enabled: bool) -> Result<()> {
if !client_path.is_dir() {
return Err(Error::Invalid("Game client directory not found.".into()));
}
if crate::client::is_running(client_path) {
return Err(Error::Invalid("Close the game before changing custom races patches.".into()));
}
if !client_path.join(MANIFEST_FILENAME).is_file()
&& !RACE_MPQS.iter().skip(1).any(|name| client_path.join("Data").join(name).is_file()
|| client_path.join("Data").join(format!("{name}.disabled")).is_file()) {
return Ok(());
}
let mut paths: Vec<PathBuf> = RACE_MPQS.iter().map(|name| client_path.join("Data").join(name)).collect();
if let Ok(manifest) = fs::read_to_string(client_path.join(MANIFEST_FILENAME)) {
for line in manifest.lines() {
if let Some(name) = line.strip_prefix("MPQ:") {
if name.contains(['/', '\\']) || !name.to_ascii_lowercase().ends_with(".mpq") {
return Err(Error::Invalid("Invalid custom races patch manifest.".into()));
}
paths.push(fsx::safe_join(&client_path.join("Data"), name)?);
}
fn patch_files(client: &Path) -> Result<Vec<PatchFile>> {
let manifest = fs::read_to_string(client.join(MANIFEST_FILENAME)).unwrap_or_default();
let hashes = if manifest.lines().any(|line| line == "# CoA Custom 1.5") { include_str!("custom_races_hashes_1_5.json") } else { include_str!("custom_races_hashes.json") };
let bundled: std::collections::BTreeMap<String, String> = serde_json::from_str(hashes)?;
let mut files = std::collections::BTreeMap::new();
for line in manifest.lines() {
let path = if let Some(name) = line.strip_prefix("MPQ:") {
if name.contains(['/', '\\']) { return Err(Error::Invalid("Invalid custom races patch manifest.".into())); }
Some(format!("Data/{name}"))
} else if let Some(name) = line.strip_prefix("ROOT:") {
if name.contains(['/', '\\']) { return Err(Error::Invalid("Invalid custom races patch manifest.".into())); }
Some(name.to_string())
} else { None };
if let Some(path) = path {
fsx::safe_join(client, &path)?;
files.insert(path.clone(), bundled.get(&path).cloned().unwrap_or_default());
}
}
paths.sort();
paths.dedup();
paths.push(client_path.join("dinput8.dll"));
paths.push(client_path.join("Ascension.exe"));
for active in paths {
let disabled = active.with_extension(format!("{}.disabled", active.extension().unwrap_or_default().to_string_lossy()));
let original = active.with_extension(format!("{}.original", active.extension().unwrap_or_default().to_string_lossy()));
if enabled && disabled.is_file() {
if active.is_file() {
if !original.is_file() {
return Err(Error::Invalid(format!("Cannot replace existing {} without an original backup.", active.display())));
}
fs::remove_file(&active)?;
}
fs::rename(&disabled, &active)?;
} else if !enabled && active.is_file() && !disabled.is_file() {
if active.file_name().is_some_and(|name| name == "Ascension.exe") && !original.is_file() {
continue;
}
fs::rename(&active, &disabled)?;
if original.is_file() {
fs::copy(&original, &active)?;
}
if files.is_empty() { files = bundled; }
for line in manifest.lines().filter_map(|line| line.strip_prefix("SHA256:")) {
let (hash, path) = line.split_once(':').ok_or_else(|| Error::Invalid("Invalid custom races checksum.".into()))?;
if hash.len() != 64 || !hash.bytes().all(|b| b.is_ascii_hexdigit()) || !files.contains_key(path) {
return Err(Error::Invalid("Invalid custom races checksum.".into()));
}
files.insert(path.into(), hash.into());
}
Ok(files.into_iter().map(|(path, sha256)| PatchFile { path, sha256 }).collect())
}
fn suffix(path: &Path, extension: &str) -> PathBuf {
path.with_file_name(format!("{}.{extension}", path.file_name().unwrap_or_default().to_string_lossy()))
}
fn matches_patch(path: &Path, file: &PatchFile) -> bool {
path.is_file() && fsx::sha256_file(path).is_ok_and(|hash| hash == file.sha256)
}
/// Only complete, verified payloads are reported as enabled or disabled.
pub fn client_patch_status(client_path: &Path) -> ClientPatchStatus {
let data = client_path.join("Data");
let installed_mpqs = RACE_MPQS.iter().filter(|name| data.join(name).is_file() || suffix(&data.join(name), "disabled").is_file()).count();
let has_root_files = client_path.join("EsteriaAppearance.dll").is_file() || client_path.join("dinput8.dll").is_file() || client_path.join("dinput8.dll.disabled").is_file();
let manifest = fs::read_to_string(client_path.join(MANIFEST_FILENAME)).unwrap_or_default();
let current = manifest.lines().any(|line| line == format!("# CoA Custom {CLIENT_VERSION}"));
let state = if !manifest.is_empty() && current && !client_path.join(".coa-races-transaction").exists() {
match patch_files(client_path) {
Ok(files) if files.iter().all(|f| matches_patch(&client_path.join(&f.path), f) && !suffix(&client_path.join(&f.path), "disabled").exists()) => ClientPatchState::Enabled,
Ok(files) if files.iter().all(|f| matches_patch(&suffix(&client_path.join(&f.path), "disabled"), f)) => ClientPatchState::Disabled,
_ => ClientPatchState::PartiallyInstalled,
}
} else if !manifest.is_empty() || patch_files(client_path).is_ok_and(|files| files.iter().filter(|file| file.path.starts_with("Data/") && file.path != "Data/patch-T.MPQ").any(|file| matches_patch(&client_path.join(&file.path), file) || matches_patch(&suffix(&client_path.join(&file.path), "disabled"), file))) {
ClientPatchState::PartiallyInstalled
} else { ClientPatchState::NotInstalled };
let version = manifest.lines().find_map(|line| line.strip_prefix("# CoA Custom ").map(str::to_string));
ClientPatchStatus { state, version, installed_mpqs, total_mpqs: RACE_MPQS.len(), has_root_files,
client_path: Some(client_path.to_string_lossy().into_owned()) }
}
#[derive(Serialize, Deserialize)]
struct SavedFile { path: String, existed: bool }
struct PatchTransaction<'a> { root: &'a Path, entries: Vec<SavedFile>, finished: bool }
impl<'a> PatchTransaction<'a> {
fn new(root: &'a Path) -> Result<Self> {
recover_patch_transaction(root)?;
fs::create_dir(root.join(".coa-races-transaction"))?;
Ok(Self { root, entries: Vec::new(), finished: false })
}
fn save(&mut self, path: &Path) -> Result<()> {
let relative = path.strip_prefix(self.root).map_err(|_| Error::Invalid("Patch path escaped the client directory.".into()))?.to_string_lossy().replace('\\', "/");
fsx::safe_join(self.root, &relative)?;
if self.entries.iter().any(|entry| entry.path == relative) { return Ok(()); }
let index = self.entries.len();
self.entries.push(SavedFile { path: relative, existed: path.is_file() });
fsx::atomic_write_json(&self.root.join(".coa-races-transaction/journal.json"), &self.entries)?;
if path.is_file() { fs::rename(path, self.root.join(".coa-races-transaction").join(index.to_string()))?; }
Ok(())
}
fn copy(&mut self, source: &Path, target: &Path) -> Result<()> {
self.save(target)?;
fs::create_dir_all(target.parent().ok_or_else(|| Error::Invalid("Patch file has no parent directory.".into()))?)?;
fs::copy(source, target)?;
Ok(())
}
fn move_file(&mut self, source: &Path, target: &Path) -> Result<()> {
self.save(source)?;
let index = self.entries.iter().position(|entry| self.root.join(&entry.path) == source).unwrap();
// Copy from the journal so rollback retains the previous bytes.
let saved = self.root.join(".coa-races-transaction").join(index.to_string());
self.copy(&saved, target)
}
fn finish(mut self) -> Result<()> {
fsx::atomic_write(&self.root.join(".coa-races-transaction/committed"), b"committed")?;
self.finished = true;
fs::remove_dir_all(self.root.join(".coa-races-transaction"))?;
Ok(())
}
}
impl Drop for PatchTransaction<'_> {
fn drop(&mut self) { if !self.finished { let _ = recover_patch_transaction(self.root); } }
}
fn recover_patch_transaction(root: &Path) -> Result<()> {
let directory = root.join(".coa-races-transaction");
if !directory.is_dir() { return Ok(()); }
if !directory.join("committed").exists() && directory.join("journal.json").exists() {
let entries: Vec<SavedFile> = fsx::read_json(&directory.join("journal.json"))?;
for (index, entry) in entries.iter().enumerate().rev() {
let path = fsx::safe_join(root, &entry.path)?;
let saved = directory.join(index.to_string());
if saved.is_file() {
if path.is_file() { fs::remove_file(&path)?; }
fs::rename(saved, path)?;
} else if !entry.existed && path.is_file() { fs::remove_file(path)?; }
}
}
tracing::info!(enabled, "custom races client patches toggled");
fs::remove_dir_all(directory)?;
Ok(())
}
fn patch_lock(client: &Path) -> Result<File> {
use fs4::fs_std::FileExt;
let lock = fs::OpenOptions::new().read(true).write(true).create(true).truncate(false).open(client.join(".coa-races.lock"))?;
if !lock.try_lock_exclusive()? { return Err(Error::Invalid("Another custom races operation is using this client.".into())); }
Ok(lock)
}
fn preserve_original(tx: &mut PatchTransaction<'_>, active: &Path) -> Result<()> {
let original = suffix(active, "original");
if original.is_file() && fsx::sha256_file(active)? == fsx::sha256_file(&original)? { return Ok(()); }
if original.is_file() {
let previous = suffix(active, &format!("original.previous-{}", uuid::Uuid::new_v4().simple()));
tx.copy(&original, &previous)?;
}
tx.copy(active, &original)
}
/// Preserve launcher replacements, and switch every file owned by the package.
pub fn set_client_patch_enabled(client: &Path, enabled: bool) -> Result<()> {
if !client.is_dir() { return Err(Error::Invalid("Game client directory not found.".into())); }
if crate::client::is_running(client) { return Err(Error::Invalid("Close the game before changing custom races patches.".into())); }
let _lock = patch_lock(client)?;
recover_patch_transaction(client)?;
if !client.join(MANIFEST_FILENAME).is_file() { return Ok(()); }
let files = patch_files(client)?;
if enabled {
for file in &files {
let active = client.join(&file.path);
if !matches_patch(&active, file) && !matches_patch(&suffix(&active, "disabled"), file) {
return Err(Error::Invalid(format!("Custom races file {} was replaced or is missing. Repair the client patch before enabling it.", file.path)));
}
}
}
let mut tx = PatchTransaction::new(client)?;
for file in files {
let active = client.join(&file.path);
let disabled = suffix(&active, "disabled");
let original = suffix(&active, "original");
if enabled {
if active.is_file() && !matches_patch(&active, &file) { preserve_original(&mut tx, &active)?; }
if matches_patch(&disabled, &file) { tx.move_file(&disabled, &active)?; }
} else if matches_patch(&active, &file) {
if disabled.is_file() && !matches_patch(&disabled, &file) {
tx.move_file(&disabled, &suffix(&disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?;
}
tx.move_file(&active, &disabled)?;
if original.is_file() { tx.copy(&original, &active)?; }
} else if active.is_file() {
preserve_original(&mut tx, &active)?;
}
}
tx.finish()
}
pub fn uninstall_client_patches(client: &Path) -> Result<()> {
if crate::client::is_running(client) { return Err(Error::Invalid("Close the game before removing custom races patches.".into())); }
let _lock = patch_lock(client)?;
recover_patch_transaction(client)?;
if !client.join(MANIFEST_FILENAME).is_file() { return Ok(()); }
let mut tx = PatchTransaction::new(client)?;
for file in patch_files(client)? {
let active = client.join(&file.path);
if matches_patch(&active, &file) {
tx.save(&active)?;
let original = suffix(&active, "original");
if original.is_file() { tx.copy(&original, &active)?; }
}
let disabled = suffix(&active, "disabled");
if active.is_file() && !matches_patch(&active, &file) && !suffix(&active, "original").is_file() {
tx.move_file(&active, &suffix(&active, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?;
}
if disabled.is_file() {
if !matches_patch(&disabled, &file) { tx.move_file(&disabled, &suffix(&disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?; }
else { tx.save(&disabled)?; }
}
}
tx.save(&client.join(MANIFEST_FILENAME))?;
tx.finish()
}
fn verify_archive(path: &Path, filename: &str) -> Result<()> {
let expected = match filename {
"CoA-Custom-1.5-main-20261009-cb2a0ca4.zip" => "117f5d99add18191676be6648fb0f2e99019a06c18705c71454e371e7df2afd2",
"CoA-Custom-1.5-client-part1.zip" => "19eb372805b3268653914da03377d67f056e5b50d818a8a06a5f260aad03211e",
"CoA-Custom-1.5-client-part2.zip" => "122f2882da255913e01610e33c6446ded897fecbe60b6d5ee026149becf8f278",
"CoA-Custom-1.6-main-20261012-4dd3a4ec.zip" => "dfe802ea70047c129ac2e0aaa557bab3110e3cc6926d36403b8c880a0e310ee4",
"CoA-Custom-1.6-client-part1.zip" => "1dbf1901ad5be61eba66973609df90712ffc78ef9e9b2c8549a5f3e36332bf12",
"CoA-Custom-1.6-client-part2.zip" => "689f7f946b4180fe977dabedc7cfe642e3e7f27431600c64c4dd5b7960b1bc66",
_ => return Err(Error::Invalid("Unknown custom races archive.".into())),
};
if fsx::sha256_file(path)? != expected {
@@ -376,30 +491,12 @@ pub fn install_client_patches(
if crate::client::is_running(client_path) {
return Err(Error::Invalid("Close the game before installing custom races patches.".into()));
}
let data_dir = client_path.join("Data");
let _lock = patch_lock(client_path)?;
recover_patch_transaction(client_path)?;
let staging = tempfile::Builder::new().prefix(".coa-races-stage-").tempdir_in(client_path)?;
let data_dir = staging.path().join("Data");
fs::create_dir_all(&data_dir)?;
// 1. Back up original Ascension.exe and patch-T.MPQ if they exist and haven't been backed up yet
let exe = client_path.join("Ascension.exe");
let exe_bak = client_path.join("Ascension.exe.original");
if exe.is_file() && !exe_bak.is_file() {
report("Backing up original Ascension.exe...", 0.02);
fs::copy(&exe, &exe_bak)?;
}
let t_mpq = data_dir.join("patch-T.MPQ");
let t_mpq_bak = data_dir.join("patch-T.MPQ.original");
if t_mpq.is_file() && !t_mpq_bak.is_file() {
report("Backing up original patch-T.MPQ...", 0.04);
fs::copy(&t_mpq, &t_mpq_bak)?;
}
let dll = client_path.join("dinput8.dll");
let dll_backup = client_path.join("dinput8.dll.original");
if dll.is_file() && !dll_backup.is_file() {
fs::copy(&dll, &dll_backup)?;
}
// 2. Resolve/download archives (0.05 .. 0.50)
let http = reqwest::blocking::Client::builder()
.user_agent(concat!("CoA-Server-Manager/", env!("CARGO_PKG_VERSION")))
@@ -470,10 +567,10 @@ pub fn install_client_patches(
if disabled.is_file() { fs::remove_file(disabled)?; }
installed_mpqs.push(base);
} else if base.eq_ignore_ascii_case("dinput8.dll") {
let dest = client_path.join(&base);
let dest = staging.path().join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = client_path.join(format!("{base}.disabled"));
let disabled = staging.path().join(format!("{base}.disabled"));
if disabled.is_file() { fs::remove_file(disabled)?; }
installed_roots.push(base);
}
@@ -484,10 +581,10 @@ pub fn install_client_patches(
.unwrap_or_default();
if !base.is_empty() {
let dest = client_path.join(&base);
let dest = staging.path().join(&base);
let mut out = File::create(&dest)?;
io::copy(&mut zfile, &mut out)?;
let disabled = client_path.join(format!("{base}.disabled"));
let disabled = staging.path().join(format!("{base}.disabled"));
if disabled.is_file() { fs::remove_file(disabled)?; }
installed_roots.push(base);
}
@@ -516,7 +613,35 @@ pub fn install_client_patches(
manifest_body.push_str(&format!("ROOT:{r}\n"));
}
let bundled: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json"))?;
let mut payload = Vec::new();
for path in installed_mpqs.iter().map(|name| format!("Data/{name}")).chain(installed_roots.iter().cloned()) {
let staged = fsx::safe_join(staging.path(), &path)?;
let hash = fsx::sha256_file(&staged)?;
if bundled.get(&path) != Some(&hash) { return Err(Error::Invalid(format!("Custom races file {path} failed verification."))); }
manifest_body.push_str(&format!("SHA256:{hash}:{path}\n"));
payload.push(PatchFile { path, sha256: hash });
}
if cancel.is_set() { return Err(Error::Invalid("Operation cancelled.".into())); }
if payload.len() != bundled.len() { return Err(Error::Invalid("Custom races archives are missing required runtime files.".into())); }
let previous = patch_files(client_path)?;
let mut tx = PatchTransaction::new(client_path)?;
for file in payload {
let dest = fsx::safe_join(client_path, &file.path)?;
if dest.is_file() && !previous.iter().any(|old| old.path == file.path && matches_patch(&dest, old)) && !matches_patch(&dest, &file) {
preserve_original(&mut tx, &dest)?;
}
tx.copy(&staging.path().join(&file.path), &dest)?;
let disabled = suffix(&dest, "disabled");
if disabled.is_file() {
if !previous.iter().any(|old| old.path == file.path && matches_patch(&disabled, old)) && !matches_patch(&disabled, &file) {
tx.move_file(&disabled, &suffix(&disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple())))?;
} else { tx.save(&disabled)?; }
}
}
tx.save(&manifest_path)?;
fsx::atomic_write(&manifest_path, manifest_body.as_bytes())?;
tx.finish()?;
report("Custom races client patches installed successfully!", 1.0);
tracing::info!(
mpqs = installed_mpqs.len(),
@@ -531,23 +656,153 @@ pub fn install_client_patches(
mod tests {
use super::*;
#[test]
fn disabling_restores_original_client_files_and_enabling_restores_custom_files() {
let temp = tempfile::tempdir().unwrap();
let data = temp.path().join("Data");
fs::create_dir_all(&data).unwrap();
for path in [data.join("patch-T.MPQ"), temp.path().join("Ascension.exe"), temp.path().join("dinput8.dll")] {
fs::write(&path, b"custom").unwrap();
let backup = path.with_extension(format!("{}.original", path.extension().unwrap().to_string_lossy()));
fs::write(&backup, b"original").unwrap();
fn record_files(root: &Path, names: &[&str]) {
let mut manifest = format!("# CoA Custom {CLIENT_VERSION}\n");
for name in names {
let (kind, base) = name.strip_prefix("Data/").map_or(("ROOT", *name), |base| ("MPQ", base));
manifest.push_str(&format!("{kind}:{base}\nSHA256:{}:{name}\n", fsx::sha256_file(&root.join(name)).unwrap()));
}
fs::write(temp.path().join(MANIFEST_FILENAME), "MPQ:patch-T.MPQ\n").unwrap();
set_client_patch_enabled(temp.path(), false).unwrap();
assert_eq!(fs::read(data.join("patch-T.MPQ")).unwrap(), b"original");
assert_eq!(fs::read(temp.path().join("Ascension.exe")).unwrap(), b"original");
set_client_patch_enabled(temp.path(), true).unwrap();
assert_eq!(fs::read(data.join("patch-T.MPQ")).unwrap(), b"custom");
assert_eq!(fs::read(temp.path().join("Ascension.exe")).unwrap(), b"custom");
fs::write(root.join(MANIFEST_FILENAME), manifest).unwrap();
}
#[test]
#[ignore = "Requires the three downloaded release archives"]
fn bundled_hashes_match_verified_release_archives() {
use sha2::{Digest, Sha256};
let folder = PathBuf::from(std::env::var_os("COA_RACES_ARCHIVE_DIR").expect("COA_RACES_ARCHIVE_DIR"));
let expected: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json")).unwrap();
let mut actual = std::collections::BTreeMap::new();
for (name, _) in ARCHIVES {
let path = folder.join(name);
verify_archive(&path, name).unwrap();
let mut archive = zip::ZipArchive::new(File::open(path).unwrap()).unwrap();
for index in 0..archive.len() {
let mut entry = archive.by_index(index).unwrap();
let name = entry.name().replace('\\', "/");
if entry.is_dir() { continue; }
let relative = if let Some(name) = name.split("files/client_root/").nth(1) { name.to_string() }
else if let Some(name) = name.split("files/client/").nth(1) { if name == "dinput8.dll" { name.to_string() } else { format!("Data/{name}") } }
else { continue };
let mut hash = Sha256::new();
let mut buffer = vec![0; 1024 * 1024];
loop { let read = entry.read(&mut buffer).unwrap(); if read == 0 { break; } hash.update(&buffer[..read]); }
actual.insert(relative, hex::encode(hash.finalize()));
}
}
assert_eq!(actual, expected);
}
#[test]
fn legacy_installation_uses_its_own_hashes_when_preserving_originals() {
let temp = tempfile::tempdir().unwrap();
fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.5\n").unwrap();
let legacy: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes_1_5.json")).unwrap();
let current: std::collections::BTreeMap<String, String> = serde_json::from_str(include_str!("custom_races_hashes.json")).unwrap();
let files = patch_files(temp.path()).unwrap();
assert_eq!(files.iter().find(|file| file.path == "Ascension.exe").unwrap().sha256, legacy["Ascension.exe"]);
assert_eq!(files.len(), legacy.len());
assert!(current.len() > legacy.len());
assert!(!files.iter().any(|file| file.path == "Data/patch-ZZS.MPQ"));
}
#[test]
fn another_patch_operation_cannot_enter_the_same_client() {
let temp = tempfile::tempdir().unwrap();
let first = patch_lock(temp.path()).unwrap();
assert!(patch_lock(temp.path()).is_err());
drop(first);
patch_lock(temp.path()).unwrap();
}
#[test]
fn switching_preserves_launcher_updates_for_every_owned_file() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
fs::create_dir_all(root.join("Data")).unwrap();
let names = ["Data/patch-T.MPQ", "Data/patch-ZE1.MPQ", "Ascension.exe", "dinput8.dll", "EsteriaAppearance.dll"];
for name in names { fs::write(root.join(name), b"custom").unwrap(); fs::write(suffix(&root.join(name), "original"), b"old official").unwrap(); }
record_files(root, &names);
set_client_patch_enabled(root, false).unwrap();
for name in names { assert_eq!(fs::read(root.join(name)).unwrap(), b"old official"); fs::write(root.join(name), b"new official").unwrap(); }
set_client_patch_enabled(root, true).unwrap();
for name in names { assert_eq!(fs::read(root.join(name)).unwrap(), b"custom"); assert_eq!(fs::read(suffix(&root.join(name), "original")).unwrap(), b"new official"); }
// An official launcher can also replace a currently enabled file.
fs::write(root.join("Ascension.exe"), b"newest official").unwrap();
assert_eq!(client_patch_status(root).state, ClientPatchState::PartiallyInstalled);
set_client_patch_enabled(root, false).unwrap();
assert_eq!(fs::read(root.join("Ascension.exe")).unwrap(), b"newest official");
assert!(set_client_patch_enabled(root, true).unwrap_err().to_string().contains("Repair"));
uninstall_client_patches(root).unwrap();
assert_eq!(fs::read(root.join("Ascension.exe")).unwrap(), b"newest official");
assert_eq!(client_patch_status(root).state, ClientPatchState::NotInstalled);
}
#[test]
fn failed_and_interrupted_transactions_restore_previous_bytes() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let file = root.join("Ascension.exe");
fs::write(&file, b"previous").unwrap();
{
let mut tx = PatchTransaction::new(root).unwrap();
tx.save(&file).unwrap();
fs::write(&file, b"replacement").unwrap();
let staged = root.join("staged.dll");
fs::write(&staged, b"new").unwrap();
tx.copy(&staged, &root.join("Data/new.dll")).unwrap();
assert_eq!(fs::read(root.join("Data/new.dll")).unwrap(), b"new");
}
assert_eq!(fs::read(&file).unwrap(), b"previous");
assert!(!root.join("Data/new.dll").exists());
let mut tx = PatchTransaction::new(root).unwrap();
tx.save(&file).unwrap();
fs::write(&file, b"interrupted").unwrap();
std::mem::forget(tx);
recover_patch_transaction(root).unwrap();
assert_eq!(fs::read(&file).unwrap(), b"previous");
}
#[test]
fn existing_backups_and_foreign_disabled_files_are_retained() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
let file = root.join("dinput8.dll");
fs::write(&file, b"custom").unwrap();
record_files(root, &["dinput8.dll"]);
fs::write(suffix(&file, "disabled"), b"third party").unwrap();
fs::write(suffix(&file, "original"), b"original").unwrap();
set_client_patch_enabled(root, false).unwrap();
assert_eq!(fs::read(&file).unwrap(), b"original");
assert!(fs::read_dir(root).unwrap().flatten().any(|entry| entry.file_name().to_string_lossy().contains("replaced-")));
fs::write(&file, b"updated original").unwrap();
set_client_patch_enabled(root, true).unwrap();
assert!(fs::read_dir(root).unwrap().flatten().any(|entry| entry.file_name().to_string_lossy().contains("original.previous-")));
}
#[test]
fn uninstall_moves_corrupted_custom_only_assets_out_of_the_active_client() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
fs::create_dir_all(root.join("Data")).unwrap();
let file = root.join("Data/patch-ZE1.MPQ");
fs::write(&file, b"custom").unwrap();
record_files(root, &["Data/patch-ZE1.MPQ"]);
fs::write(&file, b"corrupted custom").unwrap();
uninstall_client_patches(root).unwrap();
assert!(!file.exists());
assert!(fs::read_dir(root.join("Data")).unwrap().flatten().any(|entry| entry.file_name().to_string_lossy().contains("replaced-")));
assert_eq!(client_patch_status(root).state, ClientPatchState::NotInstalled);
}
#[test]
fn unknown_or_corrupt_bytes_are_not_reported_as_enabled() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path();
fs::create_dir_all(root.join("Data")).unwrap();
for name in RACE_MPQS { fs::write(root.join("Data").join(name), b"corrupt").unwrap(); }
fs::write(root.join("dinput8.dll"), b"corrupt").unwrap();
fs::write(root.join(MANIFEST_FILENAME), format!("# CoA Custom {CLIENT_VERSION}\n")).unwrap();
assert_eq!(client_patch_status(root).state, ClientPatchState::PartiallyInstalled);
}
#[test]
@@ -595,6 +850,8 @@ mod tests {
fs::write(client_path.join("dinput8.dll"), b"test dll").unwrap();
fs::write(client_path.join("EsteriaAppearance.dll"), b"test dll").unwrap();
let names: Vec<String> = RACE_MPQS.iter().map(|name| format!("Data/{name}")).chain(["dinput8.dll".into(), "EsteriaAppearance.dll".into()]).collect();
record_files(client_path, &names.iter().map(String::as_str).collect::<Vec<_>>());
let st = client_patch_status(client_path);
assert_eq!(st.state, ClientPatchState::Enabled);
assert_eq!(st.installed_mpqs, RACE_MPQS.len());
@@ -617,4 +874,21 @@ mod tests {
assert!(client_path.join("dinput8.dll").is_file());
assert!(!client_path.join("dinput8.dll.disabled").is_file());
}
#[test]
fn disabling_bot_custom_races_excludes_every_nonstandard_race() {
let temp = tempfile::tempdir().unwrap();
let conf = temp.path().join("Core/configs/modules/playerbots.conf");
fs::create_dir_all(conf.parent().unwrap()).unwrap();
fs::write(&conf, "AiPlayerbot.ExcludedBotRaces = \"\"\n").unwrap();
sync_bot_races_config(temp.path(), false).unwrap();
assert_eq!(is_bot_custom_races_allowed(temp.path()), Some(false));
let parsed = crate::config::parser::ConfFile::parse_bytes(&fs::read(conf).unwrap()).unwrap();
let value = parsed.get("AiPlayerbot.ExcludedBotRaces").unwrap().trim_matches('"');
let excluded: Vec<u32> = value.split(',').map(|race| race.parse().unwrap()).collect();
for race in 1..=128 {
assert_eq!(excluded.contains(&race), ![1, 2, 3, 4, 5, 6, 7, 8, 10, 11].contains(&race), "race {race}");
}
}
}
@@ -0,0 +1,52 @@
{
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"EsteriaAppearance.bin": "b3fb7c69b7600c39f888ea1925701be5667097dcb02bb6ddd830e5489306bb50",
"EsteriaAppearance.dll": "392c5a2a25f9a69d705bdf841bb899aab768d4a3ee62734d576286c7198710d8",
"EsteriaAppearanceGeometry.bin": "c95c53ca19c53c3434e12b99c1966f9c015ec3944c46dff7784d5e4ffc472d5d",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
"EsteriaSaberonCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaThinHuman.bin": "75794d192ea0c228b3da7bf7d0bdff1119f79d3f9bfef6650cd5e1a2b5d106eb",
"EsteriaThinHumanTextures.bin": "02aeb4c05893d06125b8b58fdb7c2a56fe3d66a7d094706a44b43cb503d1731e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"dinput8.dll": "f8de78606c241fb3911dce22faf68f5b9f9885b142b183c1e2c09ddc8f7e380c",
"Data/patch-T.MPQ": "9403e0680c74754eb0cb063718119aa6ace3616f7cecf488c8faf46f22505ae5",
"Data/patch-ZE5.MPQ": "476b5a1fcf69f64fdb281e3b445362b936d016066ccd12f897acfcf200d6c0cf",
"Data/patch-ZE6.MPQ": "762592c9ed950b4a7b6c7d85d45050b30fa3f35d53e348ee1e1516fdbb7e5484",
"Data/patch-ZE7.MPQ": "de54b0189d242763d2872223419a259b6b8a4b380c24b50a2ef9c6fa44466248",
"Data/patch-ZE8.MPQ": "1bc5691fb84a84f3e7a0a70baaa9192a97b4ec5906ee37c85838ffe08adef934",
"Data/patch-ZE9.MPQ": "d49c94463e9548e76378ce2c0454d8f204f0745c8c0de32b6dce7f0b0fd67c4a",
"Data/patch-ZES.MPQ": "a2d9348f917f745c7aa25b2eed96efa312f7b2d2f62cb86a4f2eaabc2dfa895f",
"Data/patch-ZG.MPQ": "48979e1fda775f8deb47bffa48e0a468595d4c71286fee518f51dc5801c5ca39",
"Data/patch-ZH.MPQ": "5e1d2fe287053abba703d7af381e10096c6525ba477ffed3971c2fc4f93e919c",
"Data/patch-ZHM.MPQ": "317d3ae00f0bd674b358af07544976acb7804aa6d8b19d1788ad96030e8c9bf0",
"Data/patch-ZJ.MPQ": "f821e99add86ef68d108c5ec466328c97677d3ed52f7944e200f3fe38c13b4de",
"Data/patch-ZM.MPQ": "424ab1978986e854551633983a94bd15beba6328aabea8c02f98eaa32f6f0b61",
"Data/patch-ZVU.MPQ": "c679b85a2e97344395756b54d2cf6abefe4e80e74944cb55b6e573ad17b7d020",
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
"Data/patch-ZE3.MPQ": "b587202c21b6f580682b601b7c2e905fbfa766276e74733db55c1bddbffb7f87",
"Data/patch-ZEA.MPQ": "78fd10ec5262ae2417eba9700d2172553bbc1e5cfb0b597aada8f1753ca46d9d",
"Data/patch-ZHA.MPQ": "0fc6ebeafe1d14192dc64bafc90bde3c49230df1297f98bf65900a3bcf953617",
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Data/patch-ZZS.MPQ": "533fd69d5784d83e872a5a28d27301dc9ab5d0cb925f8b2116926854e4a0a5b8",
"Data/patch-ZZT.MPQ": "aef3bbe4951333d62fb55224484724fbaa9c35773a19944ffb9935e250cfb59c"
}
@@ -0,0 +1,50 @@
{
"Data/patch-ZE1.MPQ": "69d79dbbea54ec0312c37770debc79c7bc9ce2e21eedef99c03cd8d911955283",
"Data/patch-ZE2.MPQ": "1a41cae77ad730e9cf69e8d63fd12ae3a579418bb550d351fff469573a97ac3c",
"Data/patch-ZE3.MPQ": "b587202c21b6f580682b601b7c2e905fbfa766276e74733db55c1bddbffb7f87",
"Data/patch-ZEA.MPQ": "78fd10ec5262ae2417eba9700d2172553bbc1e5cfb0b597aada8f1753ca46d9d",
"Data/patch-ZHA.MPQ": "0fc6ebeafe1d14192dc64bafc90bde3c49230df1297f98bf65900a3bcf953617",
"Data/patch-ZZE.MPQ": "4b1e289e12c82644cb78f50170e6b5fd53918eb2de834f9e0cebddd81873a8bb",
"Data/patch-ZZR.MPQ": "5a7575e592dc0c8a6913e0d946bbe06fa0ca2e4d817ef1f8548d3d13142bcbd3",
"Ascension.exe": "e2c347019d554a59639e5978fd68e50e906973ab313c6573cc56ca82e8e3c547",
"EsteriaAppearance.bin": "b3fb7c69b7600c39f888ea1925701be5667097dcb02bb6ddd830e5489306bb50",
"EsteriaAppearance.dll": "392c5a2a25f9a69d705bdf841bb899aab768d4a3ee62734d576286c7198710d8",
"EsteriaAppearanceGeometry.bin": "c95c53ca19c53c3434e12b99c1966f9c015ec3944c46dff7784d5e4ffc472d5d",
"EsteriaAppearanceMaterials.bin": "f72f027f54a55c05aa0f76b457b97b484fe0e1aedc0e068cc0e0ca53e1878cba",
"EsteriaCosmeticWings.bin": "57352c28459d073a29b3014d33b70f3b3756afa37fa9583ef6b30d503422ac3f",
"EsteriaEarthen.bin": "8a0db93ba2d5c756b44ed84f2f7bc7c15eef13be6a7d87baf1383c6c0c624e02",
"EsteriaGnoll.bin": "cfacc8e681bb8e54a4f01ee9c12a91bf0bd23a23527bb548d4dc21ec1b33eea2",
"EsteriaGnollTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaHaranir.bin": "59f31d00e372fd2646e1cf0d9d3d5d671b31edd60ff7b862f8d1ce7e53ba1f2f",
"EsteriaHaranirTextures.bin": "99948ca570be2d376f0c67e3b8088739b6fa9f9d2c73985e19f68df77689a229",
"EsteriaHighmountain.bin": "e83349252ad2687ac23fcfc5623db7401cf32e5faf47a5a7be20c2f94b014938",
"EsteriaNaga.bin": "e87547cff5d09500c294f8b06935d134cdd0bbb962e294a72de09404505bd8b3",
"EsteriaNagaTextures.bin": "57ec560f99c1d48ac1e8f6a797c156513b99e7d349e3071afe405f812d159ae3",
"EsteriaSaberon.bin": "7735c9325c807c5125760d87f323d6b7d4162fb542c1d8b5f435ea2d6b9a4daa",
"EsteriaSaberonCoverage.bin": "9cdc227f08329e1245d2b864a996e7a772c96ecdbe5d81925f4d60cdbe4fa11e",
"EsteriaSaberonTextures.bin": "1ba9133a75dad291d98a068b2dcde01f31a897a1764cd7f3e2c316c288a8f605",
"EsteriaSethrak.bin": "bd14857a8c11fdf8027128763293701586b2102f9a6539d33a727014789fd606",
"EsteriaSethrakTextures.bin": "d2b2cf58087a391f00198008fe871edd400ddf28d54a3a05674df74c5198528a",
"EsteriaThinHuman.bin": "75794d192ea0c228b3da7bf7d0bdff1119f79d3f9bfef6650cd5e1a2b5d106eb",
"EsteriaThinHumanTextures.bin": "02aeb4c05893d06125b8b58fdb7c2a56fe3d66a7d094706a44b43cb503d1731e",
"EsteriaTuskarr.bin": "ecbe7ef490ba67eca029a57639192db61238522618491549766fe38529914387",
"EsteriaTuskarrTextures.bin": "e2116c2c83adea079126fd5da765d20da24f044d4f161c4124e4368cb3d6bc71",
"EsteriaVrykul.bin": "39e2b7b4c67997dbbd34bae840bd606a59290f7f2fc82565a0ba00090335415c",
"EsteriaVrykulTextures.bin": "46098750a0e235724c6e9cc8d9d4e26550aa47bef95fd5f0f82efe5e945bf296",
"EsteriaVulpera.bin": "c5434993b9af4a17d881965e4735cd2ac379e39c7142aac9844adff9528562d4",
"EsteriaVulperaTextures.bin": "1ab844e74684aced2b069f1b91cd563aade45e05bd5e23f866a6c0c301cb098e",
"dinput8.dll": "f8de78606c241fb3911dce22faf68f5b9f9885b142b183c1e2c09ddc8f7e380c",
"Data/patch-T.MPQ": "9403e0680c74754eb0cb063718119aa6ace3616f7cecf488c8faf46f22505ae5",
"Data/patch-ZE5.MPQ": "476b5a1fcf69f64fdb281e3b445362b936d016066ccd12f897acfcf200d6c0cf",
"Data/patch-ZE6.MPQ": "762592c9ed950b4a7b6c7d85d45050b30fa3f35d53e348ee1e1516fdbb7e5484",
"Data/patch-ZE7.MPQ": "de54b0189d242763d2872223419a259b6b8a4b380c24b50a2ef9c6fa44466248",
"Data/patch-ZE8.MPQ": "1bc5691fb84a84f3e7a0a70baaa9192a97b4ec5906ee37c85838ffe08adef934",
"Data/patch-ZE9.MPQ": "d49c94463e9548e76378ce2c0454d8f204f0745c8c0de32b6dce7f0b0fd67c4a",
"Data/patch-ZES.MPQ": "a2d9348f917f745c7aa25b2eed96efa312f7b2d2f62cb86a4f2eaabc2dfa895f",
"Data/patch-ZG.MPQ": "48979e1fda775f8deb47bffa48e0a468595d4c71286fee518f51dc5801c5ca39",
"Data/patch-ZH.MPQ": "5e1d2fe287053abba703d7af381e10096c6525ba477ffed3971c2fc4f93e919c",
"Data/patch-ZHM.MPQ": "317d3ae00f0bd674b358af07544976acb7804aa6d8b19d1788ad96030e8c9bf0",
"Data/patch-ZJ.MPQ": "f821e99add86ef68d108c5ec466328c97677d3ed52f7944e200f3fe38c13b4de",
"Data/patch-ZM.MPQ": "424ab1978986e854551633983a94bd15beba6328aabea8c02f98eaa32f6f0b61",
"Data/patch-ZVU.MPQ": "c679b85a2e97344395756b54d2cf6abefe4e80e74944cb55b6e573ad17b7d020"
}
+54 -1
View File
@@ -109,7 +109,8 @@ pub fn run(root: &Path, meta: &InstallMeta) -> Report {
c.push(if crate::client::detect(Path::new(path), None).is_some() { check("client", "Game client", Level::Ok, path.clone()) } else { check("client", "Game client", Level::Warn, "The saved game folder was not found; choose it again in Settings.") });
}
let exposed: Vec<&str> = crate::net::exposure(&ports).iter().filter(|e| (e.what == "database" || e.what == "server console") && e.reachable_from_network).map(|e| e.what).collect();
let exposure = if crate::docker::is_docker(root) { crate::docker::exposure(root, &ports) } else { crate::net::exposure(&ports) };
let exposed: Vec<&str> = exposure.iter().filter(|e| (e.what == "database" || e.what == "server console") && e.reachable_from_network).map(|e| e.what).collect();
c.push(if exposed.is_empty() { check("exposure", "Private services", Level::Ok, "Database and server console are not reachable from the network.") } else { check("exposure", "Private services", Level::Fail, format!("Reachable from the network: {}.", exposed.join(", "))) });
let problems = c.iter().filter(|x| x.level != Level::Ok).count();
@@ -347,6 +348,15 @@ pub fn export_package(root: &Path, meta_dir: &Path, manager_log: &Path, meta: &I
"wow_client_set": meta.client_path.is_some(),
});
add("summary.json", serde_json::to_string_pretty(&summary)?.as_bytes())?;
let owner = fs::read_to_string(meta_dir.join("update-lock-owner.json")).ok()
.and_then(|text| serde_json::from_str::<serde_json::Value>(&redact_json(&text)).ok());
let maintenance = serde_json::json!({
"lockFilePresent": meta_dir.join("update.lock").is_file(),
"lastRecordedOwner": owner,
"note": "The lock file and owner record may remain after completion. Their presence does not establish whether the OS lock is currently held."
});
add("maintenance.json", serde_json::to_string_pretty(&maintenance)?.as_bytes())?;
// Logs. The newest update logs of the repack's own updater are added under their own names.
let mut logs: Vec<(String, PathBuf)> = vec![
@@ -464,16 +474,53 @@ pub fn stamp() -> String {
chrono::Local::now().format("%Y%m%d-%H%M%S").to_string()
}
#[cfg(windows)]
pub fn desktop_or_temp() -> PathBuf {
let d = std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop");
if d.is_dir() { d } else { std::env::temp_dir() }
}
/// Where a file meant for the person goes on Linux: the desktop folder they have (the XDG user directories file names it), else
/// `~/Desktop`, else `~/Downloads`, else the temporary folder.
#[cfg(not(windows))]
pub fn desktop_or_temp() -> PathBuf {
let Some(home) = std::env::var_os("HOME").map(PathBuf::from) else { return std::env::temp_dir() };
let dirs = std::fs::read_to_string(home.join(".config/user-dirs.dirs")).ok();
pick_desktop(&home, dirs.as_deref(), &|p| p.is_dir())
}
#[cfg(not(windows))]
fn pick_desktop(home: &Path, user_dirs: Option<&str>, exists: &dyn Fn(&Path) -> bool) -> PathBuf {
let named = user_dirs.and_then(|t| {
t.lines().find_map(|l| {
let v = l.trim().strip_prefix("XDG_DESKTOP_DIR=")?.trim_matches('"');
Some(PathBuf::from(v.replace("$HOME", &home.to_string_lossy())))
})
});
// A user without a desktop sets XDG_DESKTOP_DIR to the home folder itself: that is not a place to drop files into.
[named, Some(home.join("Desktop")), Some(home.join("Downloads"))].into_iter().flatten().filter(|p| p != home).find(|p| exists(p)).unwrap_or_else(std::env::temp_dir)
}
#[cfg(test)]
mod tests {
use super::*;
use crate::registry::{InstallKind, InstallMeta};
#[cfg(not(windows))]
#[test]
fn the_desktop_folder_on_linux_follows_the_users_own_directories() {
let home = Path::new("/home/ana");
let only = |wanted: &'static [&'static str]| move |p: &Path| wanted.contains(&p.to_str().unwrap());
let dirs = "# comment\nXDG_DOWNLOAD_DIR=\"$HOME/Downloads\"\nXDG_DESKTOP_DIR=\"$HOME/Bureau\"\n";
assert_eq!(pick_desktop(home, Some(dirs), &only(&["/home/ana/Bureau", "/home/ana/Desktop"])), PathBuf::from("/home/ana/Bureau"));
assert_eq!(pick_desktop(home, None, &only(&["/home/ana/Desktop"])), PathBuf::from("/home/ana/Desktop"));
assert_eq!(pick_desktop(home, Some(dirs), &only(&["/home/ana/Downloads"])), PathBuf::from("/home/ana/Downloads"));
assert_eq!(pick_desktop(home, None, &only(&[])), std::env::temp_dir());
// No desktop: the user directories file names the home folder itself.
let none = "XDG_DESKTOP_DIR=\"$HOME/\"\n";
assert_eq!(pick_desktop(home, Some(none), &only(&["/home/ana", "/home/ana/Downloads"])), PathBuf::from("/home/ana/Downloads"));
}
#[test]
fn repeated_config_warnings_are_folded() {
let t = "start
@@ -599,6 +646,8 @@ real error
fs::write(root.join("Core/configs/worldserver.conf"), "LoginDatabaseInfo = \"127.0.0.1;3307;acore;SECRETPW;auth\"\nRate.XP.Kill = 1\n").unwrap();
let meta_dir = d.path().join("srv.manager");
fs::create_dir_all(&meta_dir).unwrap();
fs::write(meta_dir.join("update.lock"), b"").unwrap();
fs::write(meta_dir.join("update-lock-owner.json"), r#"{"operation":"checking updates","pid":1234,"started":"2026-10-13T01:00:00Z","token":"owner-secret"}"#).unwrap();
fs::create_dir_all(meta_dir.join("diagnostics")).unwrap();
fs::write(meta_dir.join("diagnostics/schema-validation-CoA-test.json"), r#"{"problems":[{"table":"creature_display_preset","column":"display_id","detail":"default mismatch"}],"password":"schema-secret"}"#).unwrap();
fs::write(meta_dir.join("diagnostics/database-recovery-test.json"), r#"{"objects":[{"database":"acore_characters","kind":"TRIGGER","name":"user_character_trigger"}],"password":"recovery-secret"}"#).unwrap();
@@ -620,6 +669,10 @@ real error
assert!(!all.contains("schema-secret"));
assert!(all.contains("user_character_trigger") && all.contains("acore_characters"));
assert!(!all.contains("recovery-secret"));
assert!(all.contains("checking updates") && all.contains("1234"));
assert!(all.contains("lockFilePresent") && all.contains("does not establish"));
assert!(!all.contains("owner-secret"));
assert_eq!(fs::read(meta_dir.join("update.lock")).unwrap(), b"");
assert!(!all.contains("hunter2") && !all.contains("SECRETPW") && !all.contains("upstream-secret"));
}
}
+1 -1
View File
@@ -112,7 +112,7 @@ pub fn preflight(dest: &Path, data_dir: &Path, needed_bytes: u64, registry: &Reg
Preflight { ok: problems.is_empty(), problems, free_bytes }
}
fn data_problems(data_dir: &Path) -> Vec<crate::install::Problem> {
pub(crate) fn data_problems(data_dir: &Path) -> Vec<crate::install::Problem> {
let s = data_dir.to_string_lossy();
if !data_dir.is_absolute() || s.contains(':') {
return vec![problem("data_path", "Choose the game data folder with its full path, without a colon in it.")];
+57
View File
@@ -242,6 +242,10 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
run_container(d, &call, &n.world, log)?;
}
wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?;
// The core leaves with code 2 for `server restart` and expects a supervisor to start it again (the repack has one). Docker
// does that for any non-zero exit, but only once the server has come up: a start that fails must stay failed, not loop.
// A stop by `docker stop` or `server shutdown` (code 0) is never restarted.
let _ = docker(d, &["update", "--restart", "on-failure:3", &n.world], QUICK);
if !state.get(&n.auth).is_some_and(Container::running) {
remove(d, &n.auth);
@@ -251,9 +255,26 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L
run_container(d, &call, &n.auth, log)?;
}
wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?;
mark_realm_online(d, &n, &secrets, realm, log);
Ok(())
}
/// The auth server marks every realm offline when it starts, and the world server (already up, see the order above) only
/// puts itself back after its next uptime update, ten minutes later by default: until then the client shows "Realm is
/// Offline". The world is known to be listening here, so say so for the realm it serves. The other realm of a Wildcard
/// install keeps the offline flag it is given on purpose (`realms::setup_realmlist`).
fn mark_realm_online(d: &dyn Docker, n: &Names, secrets: &Secrets, realm: crate::realms::Mode, log: &mut Log) {
let sql = format!("UPDATE acore_auth.realmlist SET flag = flag & ~2 WHERE id = {};", realm.realm_id());
let mut call = Call::new(&["exec", "-i", "-e", "MYSQL_PWD", &n.db, "mysql", "--user=root", "--protocol=tcp", "--host=127.0.0.1"], QUICK);
call.env = vec![("MYSQL_PWD".into(), secrets.root.clone())];
call.stdin = Some(sql.as_bytes());
match d.run(&call) {
Ok(o) if o.ok() => {}
Ok(o) => log.say(format!("the realm could not be marked online: {}", o.text().trim())),
Err(e) => log.say(format!("the realm could not be marked online: {e}")),
}
}
fn remove(d: &dyn Docker, name: &str) {
// A stopped container of the same name is replaced, so its settings always match the files on disk.
let _ = d.run(&Call::new(&["rm", "-f", name], QUICK));
@@ -388,6 +409,21 @@ fn database_env(s: &Secrets, world: bool, realm: crate::realms::Mode) -> Vec<(St
env
}
/// Every setting variable (`AC_...`) the containers get, for the check that the screens know which settings are fixed.
#[cfg(test)]
pub(crate) fn forced_variables() -> Vec<String> {
let cfg = Config { project: "t".into(), bind_address: "127.0.0.1".into(), mysql_image: "mysql:8.4".into(), data_dir: None, mysql_data: None };
let n = cfg.names();
let mut found = Vec::new();
for kind in [GameKind::World, GameKind::Auth] {
let args = game_args(&cfg, &n, kind, Path::new("/s"), Path::new("/d"), 1, 2, None);
found.extend(args.iter().filter_map(|a| a.strip_prefix("AC_").map(|rest| format!("AC_{}", rest.split('=').next().unwrap()))));
}
found.sort();
found.dedup();
found
}
/// Realm profiles are only in play once a profile has been chosen on this server (`Settings/realm-profile.json`).
fn prepare_realm(root: &Path, log: &mut Log) -> Step<crate::realms::Mode> {
let fail_with = |e: crate::error::Error| Failure { code: ErrorCode::StartupFailed, output: e.to_string() };
@@ -670,6 +706,8 @@ mod tests {
}
out(0, "containerid\n", "")
}
["update", "--restart", _, _] => out(0, "", ""),
["exec", ..] => out(0, "", ""),
["stop", "--time", _, name] => {
self.running.borrow_mut().remove(*name);
self.exited.borrow_mut().insert(name.to_string(), (0, false));
@@ -712,6 +750,10 @@ mod tests {
assert!(at("network create") < at("run --detach"), "database comes first");
let runs: Vec<String> = sim.calls_of("run").iter().map(|c| c.args[c.args.iter().position(|x| x == "--name").unwrap() + 1].clone()).collect();
assert_eq!(runs, ["coa-t1-db", "coa-t1-world", "coa-t1-auth"], "database, then world, then auth");
let exec = sim.calls_of("exec");
assert_eq!(exec.len(), 1, "the realm is marked online once the auth server is up");
assert!(exec[0].stdin && exec[0].env == [("MYSQL_PWD".to_string(), ROOT_PW.to_string())]);
assert!(!exec[0].args.iter().any(|a| a.contains(ROOT_PW)), "the password is not on the command line");
assert!(at("build") < verbs.iter().rposition(|v| v.starts_with("run")).unwrap(), "the runtime image exists before the game servers");
assert!(sim.calls_of("build")[0].stdin, "the Dockerfile travels on stdin");
}
@@ -757,6 +799,21 @@ mod tests {
assert!(!plain.iter().any(|a| a == "--lower-case-table-names=1" || a == "--user"));
}
#[test]
fn the_world_server_is_started_again_when_it_restarts_itself_but_only_once_it_is_up() {
let (_d, root) = server("t1");
let sim = Sim::new();
assert!(start_all(&sim, &root).ok);
let world_run = sim.calls_of("run").into_iter().find(|c| c.args.iter().any(|a| a == "coa-t1-world")).unwrap();
assert!(!world_run.args.iter().any(|a| a == "--restart"), "no restart while it is still starting");
let updates = sim.calls_of("update");
assert_eq!(updates.len(), 1);
assert_eq!(updates[0].args, ["update", "--restart", "on-failure:3", "coa-t1-world"]);
let verbs = sim.verbs();
let pos = |p: &str| verbs.iter().position(|v| v.starts_with(p)).unwrap();
assert!(pos("run --detach") < pos("update"), "after the container exists and listens");
}
#[test]
fn the_containers_use_the_databases_of_the_selected_realm() {
let s = Secrets { root: "r".into(), app: "apppw".into() };
+72
View File
@@ -0,0 +1,72 @@
//! The database of a Docker server has no log file in the server folder: MySQL writes to its container's output.
use super::cli::{Call, Docker, SystemDocker};
use super::Config;
use crate::console::Line;
use crate::error::{Error, Result};
use std::path::Path;
use std::time::Duration;
/// The last lines MySQL wrote (what `docker logs` returns), filtered and classified like the lines of a log file.
pub fn database_log(root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
database_log_with(&SystemDocker, root, filter, max_lines)
}
pub fn database_log_with(d: &dyn Docker, root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
let name = Config::load(root)?.names().db;
// Ask for more than wanted: the filter may drop most of them.
let tail = (max_lines * 4).clamp(200, 8000).to_string();
let out = d.run(&Call::new(&["logs", "--tail", &tail, &name], Duration::from_secs(20)))?;
if !out.ok() {
return Err(Error::Invalid("This log does not exist yet.".into()));
}
// MySQL writes to the error stream.
Ok(crate::console::lines_from_text(&format!("{}\n{}", out.stderr, out.stdout), filter, max_lines))
}
#[cfg(test)]
mod tests {
use super::*;
use crate::docker::cli::Output;
use std::cell::RefCell;
struct Fake {
out: Output,
calls: RefCell<Vec<Vec<String>>>,
}
impl Docker for Fake {
fn run(&self, call: &Call) -> Result<Output> {
self.calls.borrow_mut().push(call.args.clone());
Ok(self.out.clone())
}
}
fn root() -> (tempfile::TempDir, std::path::PathBuf) {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
std::fs::create_dir_all(root.join("Settings")).unwrap();
std::fs::write(root.join("Settings/docker.json"), r#"{"project":"t1"}"#).unwrap();
(d, root)
}
#[test]
fn the_database_log_is_what_the_container_printed() {
let (_d, root) = root();
let fake = Fake { out: Output { code: Some(0), stdout: "2026-10-04T10:00:00Z [System] ready\n".into(), stderr: "2026-10-04T10:00:01Z [ERROR] [MY-010] boom\n2026-10-04T10:00:02Z [Warning] slow\n".into() }, calls: Default::default() };
let lines = database_log_with(&fake, &root, None, 100).unwrap();
assert_eq!(fake.calls.borrow()[0][..2], ["logs", "--tail"]);
assert_eq!(fake.calls.borrow()[0].last().unwrap(), "coa-t1-db");
assert_eq!(lines.len(), 3);
assert!(lines.iter().any(|l| l.text.contains("boom") && l.level == crate::console::Level::Error));
let only = database_log_with(&fake, &root, Some("slow"), 100).unwrap();
assert_eq!(only.len(), 1);
}
#[test]
fn a_database_that_never_ran_has_no_log_yet() {
let (_d, root) = root();
let fake = Fake { out: Output { code: Some(1), stdout: String::new(), stderr: "Error: No such container: coa-t1-db".into() }, calls: Default::default() };
assert!(database_log_with(&fake, &root, None, 10).unwrap_err().to_string().contains("does not exist yet"));
}
}
+141
View File
@@ -18,9 +18,12 @@ mod cli;
pub mod fixture;
pub mod install;
mod lifecycle;
pub mod logs;
pub mod sharing;
pub use cli::{Call, Docker, Output, SystemDocker};
pub use lifecycle::{check_docker, observe, observe_with, run, run_with};
pub use sharing::{bind_is_open, exposure, set_open};
pub(crate) use lifecycle::destroy;
use std::net::IpAddr;
@@ -140,6 +143,84 @@ pub fn ensure_main_configs(root: &Path) -> Result<Vec<String>> {
Ok(created)
}
/// Settings the Docker backend gives the containers as environment variables. The core reads `AC_<KEY>` before the
/// configuration file, so a value written to the file for one of these keys is silently ignored. They are what makes the
/// containers work (where things are inside them, listening on every interface, the console, no built-in database
/// updater, the databases); the owner has no use for them and the screens do not offer them.
pub(crate) const FORCED_KEYS: [&str; 12] = [
"BindIP",
"WorldServerPort",
"RealmServerPort",
"LogsDir",
"DataDir",
"Updates.EnableDatabases",
"Ra.Enable",
"Ra.IP",
"Ra.Port",
"LoginDatabaseInfo",
"WorldDatabaseInfo",
"CharacterDatabaseInfo",
];
/// Is this setting fixed by the Docker backend (see `FORCED_KEYS`)?
pub fn managed_setting(key: &str) -> bool {
FORCED_KEYS.iter().any(|k| k.eq_ignore_ascii_case(key))
}
/// The environment variable the core reads for a setting: `AC_` and the key in upper snake case, a `_` between a lower-case
/// letter and a capital, and at letter / digit boundaries (the core's `IniKeyToEnvVarKey`).
#[cfg(test)]
pub(crate) fn env_name(key: &str) -> String {
let chars: Vec<char> = key.chars().collect();
let mut out = String::from("AC_");
for (i, &c) in chars.iter().enumerate() {
if matches!(c, ' ' | '.' | '-') {
out.push('_');
continue;
}
out.push(c.to_ascii_uppercase());
if let Some(&next) = chars.get(i + 1) {
let split = (!c.is_ascii_uppercase() && next.is_ascii_uppercase()) || (!c.is_ascii_digit() && next.is_ascii_digit()) || (c.is_ascii_digit() && !next.is_ascii_digit() && !matches!(next, ' ' | '.' | '-'));
if split {
out.push('_');
}
}
}
out
}
/// The folder mounted as the game data of this Docker server.
pub fn game_data_dir(root: &Path) -> Result<std::path::PathBuf> {
Ok(Config::load(root)?.data_path(root))
}
/// Point a Docker server at another game data folder (used in place, read-only). The containers are recreated at the next
/// start, so the servers must be stopped: a running one keeps the folder it has.
pub fn set_game_data(root: &Path, path: &Path) -> Result<()> {
let problems = install::data_problems(path);
if !problems.is_empty() {
return Err(Error::Invalid(problems.iter().map(|p| p.message.clone()).collect::<Vec<_>>().join(" ")));
}
let observed = crate::process::observe(root, &crate::layout::read_ports(root));
let busy = |s: &crate::process::ServiceStatus| matches!(s.state, crate::process::ServiceState::Running | crate::process::ServiceState::Starting | crate::process::ServiceState::Stopping);
if busy(&observed.world) || busy(&observed.auth) {
return Err(Error::Invalid("Stop the server before changing the game data folder.".into()));
}
let mut cfg = Config::load(root)?;
cfg.data_dir = Some(path.to_string_lossy().into_owned());
cfg.validate()?;
fsx::atomic_write_json(&root.join(MARKER), &cfg)
}
/// A reason a value cannot work on a Docker server, for settings that name a path: the server runs in a container that sees only
/// its own `Core` folder (as `/srv/core`, its working directory), so a path elsewhere on this computer does not exist for it.
pub fn setting_problem(key: &str, raw: &str) -> Option<&'static str> {
let raw = raw.trim().trim_matches('"');
let outside = Path::new(raw).is_absolute() && !raw.starts_with("/srv/core/");
(key.eq_ignore_ascii_case("CoaBots.TalentBuildsPath") && !raw.is_empty() && outside)
.then_some("must be a path inside the server's Core folder (for example reference/ascensionsidekick-level-builds.json), because the server runs in a container that cannot see other folders")
}
/// Name of the runtime image: it follows the content of its Dockerfile, so changing the libraries builds a new image.
pub(crate) fn runtime_image() -> String {
format!("coa-runtime:{}", &fsx::sha256_bytes(RUNTIME_DOCKERFILE.as_bytes())[..12])
@@ -206,6 +287,66 @@ mod tests {
use super::*;
use std::fs;
#[cfg(unix)]
#[test]
fn the_game_data_folder_can_be_changed_when_the_servers_are_stopped() {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
std::fs::create_dir_all(root.join("Settings")).unwrap();
std::fs::write(root.join(MARKER), r#"{"project":"t1","dataDir":"/old/data"}"#).unwrap();
let good = d.path().join("data");
std::fs::create_dir_all(good.join("dbc")).unwrap();
std::fs::create_dir_all(good.join("maps")).unwrap();
assert_eq!(game_data_dir(&root).unwrap(), std::path::PathBuf::from("/old/data"));
set_game_data(&root, &good).unwrap();
assert_eq!(game_data_dir(&root).unwrap(), good);
assert_eq!(Config::load(&root).unwrap().project, "t1", "the other settings are kept");
// A folder that does not look like game data is refused and nothing changes.
let empty = d.path().join("empty");
std::fs::create_dir_all(&empty).unwrap();
assert!(set_game_data(&root, &empty).is_err());
assert_eq!(game_data_dir(&root).unwrap(), good);
assert!(set_game_data(&root, std::path::Path::new("relative/dir")).is_err());
}
#[cfg(unix)]
#[test]
fn a_path_outside_the_core_folder_is_refused_for_a_docker_server() {
let key = "CoaBots.TalentBuildsPath";
assert!(setting_problem(key, "reference/builds.json").is_none());
assert!(setting_problem(key, "").is_none());
assert!(setting_problem(key, "\"/srv/core/reference/builds.json\"").is_none());
assert!(setting_problem(key, "/home/ana/builds.json").is_some());
assert!(setting_problem("Rate.XP.Kill", "/home/ana/x").is_none(), "only settings that name a path");
}
#[test]
fn setting_names_become_the_variables_the_core_reads() {
for (key, var) in [
("BindIP", "AC_BIND_IP"),
("Ra.Enable", "AC_RA_ENABLE"),
("Ra.IP", "AC_RA_IP"),
("Updates.EnableDatabases", "AC_UPDATES_ENABLE_DATABASES"),
("WorldServerPort", "AC_WORLD_SERVER_PORT"),
("LoginDatabaseInfo", "AC_LOGIN_DATABASE_INFO"),
("DataDir", "AC_DATA_DIR"),
("Dynamic.XP.Reminder.Interval", "AC_DYNAMIC_XP_REMINDER_INTERVAL"),
("EtherealBazaar.Enable", "AC_ETHEREAL_BAZAAR_ENABLE"),
] {
assert_eq!(env_name(key), var, "{key}");
}
}
#[test]
fn the_settings_called_managed_are_exactly_the_variables_the_containers_get() {
// If a variable is added to the containers without being listed here (or the other way round), a screen would
// offer a setting that does nothing, or hide one that works.
let given: std::collections::BTreeSet<String> = lifecycle::forced_variables().into_iter().collect();
let listed: std::collections::BTreeSet<String> = FORCED_KEYS.iter().map(|k| env_name(k)).collect();
assert_eq!(given, listed);
assert!(managed_setting("ra.enable") && managed_setting("Updates.EnableDatabases") && !managed_setting("PlayerLimit"));
}
#[test]
fn the_main_configs_are_created_from_their_templates_and_never_overwritten() {
let d = tempfile::tempdir().unwrap();
+149
View File
@@ -0,0 +1,149 @@
//! Sharing a Docker server with friends. Who can reach the game is decided by the address the container ports are
//! published on (`bindAddress` in `Settings/docker.json`): `127.0.0.1` is this computer only, anything else is the network.
//! The `BindIP` of the configuration files is forced to `0.0.0.0` inside the containers and changes nothing, so the
//! repack's way of opening the servers (editing `BindIP`) is replaced here. The database is never published and the server
//! console is only ever published on the loopback address.
use std::fs;
use std::net::IpAddr;
use std::path::{Path, PathBuf};
use super::{Config, MARKER};
use crate::config::parser::ConfFile;
use crate::config::{take_snapshot, Scope};
use crate::error::Result;
use crate::fsx;
use crate::layout::Ports;
use crate::net::Exposure;
use crate::process::{ServiceState, ServiceStatus};
fn is_open(cfg: &Config) -> bool {
cfg.bind_address.parse::<IpAddr>().map(|ip| !ip.is_loopback()).unwrap_or(false)
}
/// Whether the login and world servers are published beyond this computer.
pub fn bind_is_open(root: &Path) -> bool {
Config::load(root).map(|c| is_open(&c)).unwrap_or(false)
}
/// Publish the login and world servers beyond this computer (`0.0.0.0`) or only on it (`127.0.0.1`). An address the owner chose
/// by hand (for example one network card) is kept when opening. Returns true if anything changed, which needs a restart of
/// the containers. The old files are snapshotted.
pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
let mut cfg = Config::load(root)?;
let mut originals: Vec<(PathBuf, Vec<u8>)> = Vec::new();
let mut changed = false;
if is_open(&cfg) != open {
originals.push((root.join(MARKER), fs::read(root.join(MARKER))?));
cfg.bind_address = if open { "0.0.0.0" } else { "127.0.0.1" }.into();
changed = true;
}
// Friends connect from other addresses, and the server only applies the CoA client protocol to loopback unless remote clients
// are allowed; opening switches that on (closing leaves it, it only matters while the servers listen beyond this computer).
let coa_conf = root.join("Core/configs/modules/coa.conf");
let mut coa_edit = None;
if open {
if let Ok(bytes) = fs::read(&coa_conf) {
let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("CoA.AllowRemoteClients").map(str::trim) != Some("1") {
conf.set("CoA.AllowRemoteClients", "1", &["Set by CoA Server Manager together with the friends mode"]);
originals.push((coa_conf.clone(), bytes));
coa_edit = Some(conf.to_text());
}
}
}
if !changed && coa_edit.is_none() {
return Ok(false);
}
take_snapshot(meta, Scope::Server, if open { "before opening the servers to friends" } else { "before closing the servers to friends" }, &originals)?;
if changed {
fsx::atomic_write_json(&root.join(MARKER), &cfg)?;
}
let remote_changed = coa_edit.is_some();
if let Some(text) = coa_edit {
fsx::atomic_write(&coa_conf, text.as_bytes())?;
}
Ok(changed || remote_changed)
}
/// What each service can be reached from, computed from how the containers publish their ports: the database is never published,
/// the console only on the loopback address, the game servers on `bindAddress`.
pub fn exposure(root: &Path, ports: &Ports) -> Vec<Exposure> {
let open = bind_is_open(root);
let observed = crate::process::observe(root, ports);
let up = |s: &ServiceStatus| matches!(s.state, ServiceState::Running | ServiceState::Starting);
vec![
Exposure { port: ports.mysql, what: "database", listening: up(&observed.mysql), reachable_from_network: false },
Exposure { port: ports.ra, what: "server console", listening: up(&observed.world), reachable_from_network: false },
Exposure { port: ports.auth, what: "login server", listening: up(&observed.auth), reachable_from_network: open && up(&observed.auth) },
Exposure { port: ports.world, what: "game world", listening: up(&observed.world), reachable_from_network: open && up(&observed.world) },
]
}
#[cfg(test)]
mod tests {
use super::*;
fn server(bind: Option<&str>) -> (tempfile::TempDir, PathBuf, PathBuf) {
let d = tempfile::tempdir().unwrap();
let root = d.path().join("srv");
let meta = d.path().join("srv.manager");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(root.join("Core/configs/modules")).unwrap();
fs::create_dir_all(&meta).unwrap();
let extra = bind.map(|b| format!(r#","bindAddress":"{b}""#)).unwrap_or_default();
fs::write(root.join(MARKER), format!(r#"{{"project":"t1"{extra}}}"#)).unwrap();
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\n").unwrap();
(d, root, meta)
}
#[test]
fn opening_and_closing_changes_the_published_address_and_allows_remote_clients() {
let (_d, root, meta) = server(None);
assert!(!bind_is_open(&root));
assert!(set_open(&root, &meta, true).unwrap(), "a restart is needed");
assert!(bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap().contains("CoA.AllowRemoteClients = 1"));
assert!(!set_open(&root, &meta, true).unwrap(), "nothing left to change");
assert!(set_open(&root, &meta, false).unwrap());
assert!(!bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "127.0.0.1");
}
#[test]
fn enabling_remote_client_protocol_requires_restart_even_when_ports_are_open() {
let (_d, root, meta) = server(Some("0.0.0.0"));
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\nCoA.AllowRemoteClients = 0\n").unwrap();
assert!(set_open(&root, &meta, true).unwrap());
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(!set_open(&root, &meta, true).unwrap());
}
#[test]
fn an_address_chosen_by_hand_is_kept_when_opening_and_other_settings_survive() {
let (_d, root, meta) = server(Some("192.168.1.20"));
assert!(bind_is_open(&root), "any address but the loopback is the network");
set_open(&root, &meta, true).unwrap();
let cfg = Config::load(&root).unwrap();
assert_eq!(cfg.bind_address, "192.168.1.20");
assert_eq!(cfg.project, "t1");
}
#[test]
fn the_old_settings_are_snapshotted_before_a_change() {
let (_d, root, meta) = server(None);
set_open(&root, &meta, true).unwrap();
assert_eq!(crate::config::list_snapshots(&meta).len(), 1);
}
#[test]
fn the_database_and_the_console_are_never_reported_reachable() {
let (_d, root, _meta) = server(Some("0.0.0.0"));
let rows = exposure(&root, &Ports::default());
let by = |what: &str| rows.iter().find(|e| e.what == what).unwrap();
assert!(!by("database").reachable_from_network && !by("server console").reachable_from_network);
// Nothing runs in this test (docker is not asked to start anything), so nothing is reachable yet.
assert!(rows.iter().all(|e| !e.reachable_from_network));
}
}
+57 -4
View File
@@ -90,7 +90,12 @@ fn launcher(root: &Path) -> Result<(PathBuf, PathBuf)> {
/// Run a launcher verb to completion (blocking; call from a worker thread).
pub fn run(root: &Path, verb: Verb) -> Result<DriverOutcome> {
run_inner(root, verb, false)
tracing::info!(?verb, root = %root.display(), "driver: launcher requested");
let result = run_inner(root, verb, false);
if let Err(error) = &result {
tracing::warn!(?verb, root = %root.display(), %error, "driver: launcher request failed before completion");
}
result
}
pub(crate) fn validate_update(root: &Path) -> Result<DriverOutcome> {
@@ -100,7 +105,7 @@ pub(crate) fn validate_update(root: &Path) -> Result<DriverOutcome> {
fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverOutcome> {
let root = fsx::canonicalize_lenient(root)?;
let _update_lock = if !validating_update && matches!(verb, Verb::StartAll | Verb::StartWorld) {
Some(crate::update::operation_lock(&crate::registry::metadata_dir_for(&root)?)?)
Some(crate::update::operation_lock_for(&crate::registry::metadata_dir_for(&root)?, "starting server", true)?)
} else { None };
if !validating_update && matches!(verb, Verb::StartAll | Verb::StartWorld) {
crate::update::ensure_recovered(&crate::registry::metadata_dir_for(&root)?)?;
@@ -279,14 +284,50 @@ pub(crate) fn startup_failure(root: &Path, started: &DriverOutcome) -> String {
let title = code.map(|c| c.human().title).unwrap_or("The server did not become ready");
let output = crate::diag::redact(&started.output);
let lines: Vec<_> = output.lines().rev().take(12).collect();
if lines.is_empty() { title.into() }
else { format!("{title}\n{}", lines.into_iter().rev().collect::<Vec<_>>().join("\n")) }
let mut reason = if lines.is_empty() { title.into() }
else { format!("{title}\n{}", lines.into_iter().rev().collect::<Vec<_>>().join("\n")) };
for relative in ["Core/Logs/world-console.log", "Core/Logs/auth-console.log", "mysql/logs/mysql-error.log"] {
let tail = crate::health::tail(&root.join(relative), 64 * 1024);
let failures: Vec<_> = tail.lines().filter(|line| {
let lower = line.to_ascii_lowercase();
crate::health::diagnose(line).is_some() || lower.contains("fatal") || lower.contains("error") || lower.contains("aborting")
}).rev().take(8).collect();
if !failures.is_empty() {
reason.push_str(&format!("\n{relative}:\n{}", crate::diag::redact(&failures.into_iter().rev().collect::<Vec<_>>().join("\n"))));
}
}
reason
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn a_blocked_start_is_logged_before_any_launcher_is_spawned() {
use std::io::Write;
use std::sync::{Arc, Mutex};
struct Capture(Arc<Mutex<Vec<u8>>>);
impl Write for Capture {
fn write(&mut self, bytes: &[u8]) -> std::io::Result<usize> { self.0.lock().unwrap().extend_from_slice(bytes); Ok(bytes.len()) }
fn flush(&mut self) -> std::io::Result<()> { Ok(()) }
}
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
std::fs::create_dir(&root).unwrap();
let metadata = crate::registry::metadata_dir_for(&root).unwrap();
let _maintenance = crate::update::operation_lock(&metadata).unwrap();
let buffer = Arc::new(Mutex::new(Vec::new()));
let writer = Arc::clone(&buffer);
let subscriber = tracing_subscriber::fmt().without_time().with_ansi(false).with_writer(move || Capture(Arc::clone(&writer))).finish();
let error = tracing::subscriber::with_default(subscriber, || run(&root, Verb::StartAll)).unwrap_err();
assert!(error.to_string().contains("in progress"));
let text = String::from_utf8(buffer.lock().unwrap().clone()).unwrap();
assert!(text.contains("launcher requested") && text.contains("StartAll"));
assert!(text.contains("launcher request failed before completion") && text.contains("in progress"));
assert!(!text.contains("starting launcher verb"));
}
#[test]
fn background_start_disables_cli_in_template_and_rendered_config() {
let folder = tempfile::tempdir().unwrap();
@@ -381,6 +422,18 @@ mod tests {
assert!(run(dir.path(), Verb::StartAll).is_err());
}
#[test]
fn startup_failure_reports_late_world_errors_after_launcher_ready() {
let dir = tempfile::tempdir().unwrap();
std::fs::create_dir_all(dir.path().join("Core/Logs")).unwrap();
std::fs::write(dir.path().join("Core/Logs/world-console.log"), "ERROR [1146] Table 'acore_characters.playerbots_names' doesn't exist\nFATAL Could not prepare statements\n").unwrap();
let started = DriverOutcome { ok: true, code: None, exit_code: Some(0), human: None, output: "Worldserver and automatic bug reporting are ready.".into() };
let reason = startup_failure(dir.path(), &started);
assert!(reason.contains("playerbots_names"));
assert!(reason.contains("Core/Logs/world-console.log"));
assert!(reason.contains("Could not prepare statements"));
}
#[test]
fn startup_failure_keeps_the_launcher_reason_without_secrets() {
let dir = tempfile::tempdir().unwrap();
+6
View File
@@ -55,6 +55,7 @@ pub enum ErrorCode {
OperationInProgress,
StartupFailed,
DockerUnavailable,
GameDataMismatch,
HashMismatch,
PathRejected,
PackageNotPublished,
@@ -138,6 +139,11 @@ impl ErrorCode {
"This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
&[Retry, ShowDetails],
),
ErrorCode::GameDataMismatch => (
"The game data folder is not the CoA set",
"The server stopped because the DBC files in the game data folder are not the ones of the Conquest of Azeroth client. Choose the folder that holds the CoA data (Settings > Game data folder), then start again.",
&[ShowDetails],
),
ErrorCode::HashMismatch => (
"A downloaded file is damaged",
"The file did not match its checksum and was not used.",
+9 -2
View File
@@ -80,6 +80,9 @@ fn bind_targets(root: &Path) -> Vec<PathBuf> {
/// Whether the configuration currently lets other computers reach the login and world servers.
pub fn bind_is_open(root: &Path) -> bool {
if crate::docker::is_docker(root) {
return crate::docker::bind_is_open(root);
}
let files = bind_targets(root);
!files.is_empty()
&& files
@@ -90,6 +93,9 @@ pub fn bind_is_open(root: &Path) -> bool {
/// Open (`0.0.0.0`) or close (`127.0.0.1`) the login and world servers to other computers. The database and the server
/// console are never touched. Returns true if anything changed (a restart is then needed). The old files are snapshotted.
pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
if crate::docker::is_docker(root) {
return crate::docker::set_open(root, meta, open);
}
let want = if open { "\"0.0.0.0\"" } else { "\"127.0.0.1\"" };
let mut originals = Vec::new();
let mut edits = Vec::new();
@@ -125,7 +131,8 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
Ok(true)
}
/// Make the realm list advertise `host` (the launcher resets it to 127.0.0.1 at every start, so this runs after each start).
/// Make the realm list advertise `host` to remote clients (the launcher resets it to 127.0.0.1 at every start, so this
/// runs after each start).
pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
if !host_ok(host) {
return Err(Error::Invalid("That address is not valid.".into()));
@@ -133,7 +140,7 @@ pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
let db = Db::from_repack(root, Account::Admin)?;
let realm = crate::realms::state(root)?.active.realm_id();
let where_realms = if crate::realms::state(root)?.simultaneous { "id IN (1,2)".into() } else { format!("id={realm}") };
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}', localAddress='{host}' WHERE {where_realms};"))?;
db.query(&format!("UPDATE acore_auth.realmlist SET address='{host}' WHERE {where_realms};"))?;
Ok(())
}
+42
View File
@@ -28,6 +28,19 @@ pub fn normalize_lexical(path: &Path) -> PathBuf {
fn key(path: &Path) -> Vec<String> {
path.components()
.map(|c| {
#[cfg(windows)]
if let Component::Prefix(prefix) = c {
use std::path::Prefix;
match prefix.kind() {
Prefix::Disk(drive) | Prefix::VerbatimDisk(drive) => {
return format!("{}:", char::from(drive).to_ascii_lowercase());
}
Prefix::UNC(server, share) | Prefix::VerbatimUNC(server, share) => {
return format!("\\\\{}\\{}", server.to_string_lossy(), share.to_string_lossy()).to_lowercase();
}
_ => {}
}
}
let c = c.as_os_str().to_string_lossy();
if cfg!(windows) { c.to_lowercase() } else { c.into_owned() }
})
@@ -262,6 +275,35 @@ mod tests {
}
}
#[cfg(windows)]
#[test]
fn containment_matches_verbatim_drive_and_unc_prefixes() {
assert!(starts_with_ci(Path::new(r"\\?\C:\server\Extras\file.sql"), Path::new(r"C:\server")));
assert!(starts_with_ci(Path::new(r"C:\server\Extras\file.sql"), Path::new(r"\\?\c:\server")));
assert!(starts_with_ci(Path::new(r"\\?\UNC\host\share\server\file.sql"), Path::new(r"\\host\share\server")));
assert!(!starts_with_ci(Path::new(r"\\?\D:\server\file.sql"), Path::new(r"C:\server")));
assert!(!starts_with_ci(Path::new(r"\\?\C:\server-other\file.sql"), Path::new(r"C:\server")));
assert!(!starts_with_ci(Path::new(r"\\?\UNC\host\other\server\file.sql"), Path::new(r"\\host\share\server")));
}
#[cfg(windows)]
#[test]
fn ensure_within_accepts_long_rehearsal_sql_path() {
let dir = tempfile::tempdir().unwrap();
let root = dir.path().join("server");
fs::create_dir_all(&root).unwrap();
let mut candidate = root.clone();
for _ in 0..5 {
candidate.push("long-private-rehearsal-directory-name-20261013");
}
fs::create_dir_all(&candidate).unwrap();
candidate.push("2026_06_13_00_ai_playerbot_missing_group_buff_reagent.sql");
fs::write(&candidate, b"SELECT 1;").unwrap();
assert!(candidate.as_os_str().len() > 260);
assert!(ensure_within(&root, &candidate).is_ok());
assert!(ensure_within(&root, &std::fs::canonicalize(candidate).unwrap()).is_ok());
}
#[test]
fn ensure_within_blocks_junction_escape() {
if !cfg!(windows) {
+9
View File
@@ -25,6 +25,8 @@ pub fn diagnose(text: &str) -> Option<ErrorCode> {
Some(ErrorCode::DatabaseNotRunning)
} else if l.contains("address already in use") || l.contains("could not bind") || l.contains("only one usage of each socket") {
Some(ErrorCode::PortInUse)
} else if l.contains("does not hold the coa client dbc set") || l.contains("_outdated_ dbc data") {
Some(ErrorCode::GameDataMismatch)
} else if l.contains("config::loadfile") && l.contains("failed open file") && l.contains("worldserver.conf") {
Some(ErrorCode::ServerFilesIncomplete)
} else {
@@ -57,6 +59,13 @@ pub fn diagnose_installation(root: &Path) -> Option<ErrorCode> {
mod tests {
use super::*;
#[test]
fn a_game_data_folder_without_the_coa_dbc_set_is_named_as_such() {
let log = "Using DataDir /srv/data/\nSpellAffect.dbc not found in /srv/data/dbc/\nDataDir does not hold the CoA client DBC set. Install it with apps/coa-dbc/client_dbc.py.";
assert_eq!(diagnose(log), Some(ErrorCode::GameDataMismatch));
assert_eq!(diagnose("You have _outdated_ DBC data. Please extract correct versions from current using client."), Some(ErrorCode::GameDataMismatch));
}
#[test]
fn recognises_missing_migrations() {
let log = "ERROR [sql.sql] [1146] Table 'acore_world.coa_boss' doesn't exist\nFATAL [sql.sql] Your database structure is not up to date.";
+37
View File
@@ -119,7 +119,26 @@ fn conf_name(root: &Path, e: &Entry) -> String {
}
}
fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
let Ok(directory) = crate::registry::metadata_dir_for(root) else { return Default::default() };
let Ok((_, meta)) = crate::registry::MetaDir::open(&directory) else { return Default::default() };
let Some(version) = meta.core.version else { return Default::default() };
let candidates = [directory.join("manifests").join(format!("update-{version}.json")), directory.join("manifests/base.json")];
for path in candidates {
let Ok(manifest) = crate::fsx::read_json::<serde_json::Value>(&path) else { continue };
if manifest.get("version").and_then(|value| value.as_str()) != Some(&version) { continue; }
if let Some(commits) = manifest.get("compatibility").and_then(|value| value.get("moduleCommits")).and_then(|value| value.as_object()) {
return commits.iter().filter_map(|(name, commit)| {
let commit = commit.as_str()?;
(commit.len() == 40 && commit.bytes().all(|byte| byte.is_ascii_hexdigit())).then(|| (name.clone(), commit.chars().take(8).collect()))
}).collect();
}
}
Default::default()
}
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let installed_commits = installed_module_commits(root);
let wildcard = crate::realms::state(root).map(|s| s.active == crate::realms::Mode::Wildcard).unwrap_or(true);
cat.iter()
.cloned()
@@ -141,6 +160,8 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let version = if e.id == "playerbots" { crate::squid::release(root).map(|release| {
[release.tag, release.commit.map(|commit| commit.chars().take(8).collect())].into_iter().flatten().collect::<Vec<_>>().join(" · ")
}) } else { None };
let key = match e.id.as_str() { "companions" => "bots", "playerbots" => "squid", "content-scaling" => "scaling", "custom-races" => "races", id => id };
let version = if installed { version.or_else(|| installed_commits.get(key).cloned()) } else { None };
ModuleView {
version,
compatibility: if blocked { "unsupported" } else if wildcard && e.id != "client-compat" { "experimental" } else { "compatible" }.into(),
@@ -425,6 +446,22 @@ mod tests {
(root, meta)
}
#[test]
fn module_revisions_come_from_the_installed_release_only() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
fs::create_dir_all(&root).unwrap();
let mut meta = crate::registry::InstallMeta::new(crate::registry::InstallKind::Imported, &root);
meta.core.version = Some("2.0.0".into());
let directory = crate::registry::MetaDir::create(&root, &meta).unwrap();
let value = serde_json::json!({"version": "2.0.0", "compatibility": {"moduleCommits": {"races": "a".repeat(40), "bots": "b".repeat(40)}}});
fsx::atomic_write_json(&directory.root.join("manifests/update-2.0.0.json"), &value).unwrap();
assert_eq!(installed_module_commits(&root).get("races").map(String::as_str), Some("aaaaaaaa"));
let stale = serde_json::json!({"version": "1.0.0", "compatibility": {"moduleCommits": {"races": "c".repeat(40)}}});
fsx::atomic_write_json(&directory.root.join("manifests/update-2.0.0.json"), &stale).unwrap();
assert!(installed_module_commits(&root).is_empty());
}
#[test]
fn squid_missing_keys_use_code_defaults_and_saves_enforce_json_ranges() {
let d = tempfile::tempdir().unwrap();
+19 -1
View File
@@ -71,7 +71,15 @@ pub fn hardware() -> Hardware {
#[cfg(not(windows))]
pub fn hardware() -> Hardware {
Hardware { cores: std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(2), ram_gb: 8.0, free_ram_gb: 4.0 }
let (total, free) = std::fs::read_to_string("/proc/meminfo").ok().and_then(|t| parse_meminfo(&t)).unwrap_or((8.0, 4.0));
Hardware { cores: std::thread::available_parallelism().map(|n| n.get() as u32).unwrap_or(2), ram_gb: total, free_ram_gb: free }
}
/// (total, available) memory in GB from the text of `/proc/meminfo`.
#[cfg(not(windows))]
fn parse_meminfo(text: &str) -> Option<(f64, f64)> {
let kb = |key: &str| -> Option<f64> { text.lines().find_map(|l| l.strip_prefix(key)?.trim().strip_suffix("kB")?.trim().parse::<f64>().ok()) };
Some((kb("MemTotal:")? / (1u64 << 20) as f64, kb("MemAvailable:")? / (1u64 << 20) as f64))
}
#[derive(Debug, Clone, Serialize)]
@@ -105,6 +113,16 @@ pub fn sizes(h: &Hardware) -> Vec<SizeOption> {
mod tests {
use super::*;
#[cfg(not(windows))]
#[test]
fn memory_is_read_from_proc_meminfo() {
let t = "MemTotal: 65536000 kB\nMemFree: 1000000 kB\nMemAvailable: 16777216 kB\nBuffers: 1 kB\n";
let (total, free) = parse_meminfo(t).unwrap();
assert!((total - 62.5).abs() < 0.01 && (free - 16.0).abs() < 0.01, "{total} {free}");
assert!(parse_meminfo("nothing useful").is_none());
assert!(hardware().ram_gb > 0.0);
}
#[test]
fn parses_counts_and_never_goes_negative() {
let p = parse_counts("12\t9\t400").unwrap();
+46 -5
View File
@@ -308,9 +308,12 @@ pub fn preview(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &s
pub fn preview_with(root: &Path, meta: &InstallMeta, source: &Source, trusted_key: &str, resolutions: &BTreeMap<String, Resolution>, access: DatabaseAccess) -> Result<Preview> {
refuse_for_docker(root)?;
let meta_dir = crate::registry::metadata_dir_for(root)?;
let _lock = operation_lock(&meta_dir)?;
ensure_recovered(&meta_dir)?;
let observed_version = MetaDir::open(&meta_dir)?.1.core.version;
let (m, _) = fetch_manifest(source, trusted_key)?;
let _lock = operation_lock_for(&meta_dir, "checking updates", false)?;
ensure_recovered(&meta_dir)?;
let (_, current_meta) = MetaDir::open(&meta_dir)?;
let meta = if current_meta.core.version != observed_version { &current_meta } else { meta };
check_manifest(&m)?;
reject_downgrade(meta, &m)?;
let mut items = plan(root, meta, &m, resolutions, None)?;
@@ -373,7 +376,7 @@ fn reject_downgrade(meta: &InstallMeta, manifest: &Manifest) -> Result<()> {
if c.platform != platform {
return Err(Error::Invalid(format!("This package targets {} rather than {platform}.", c.platform)));
}
if meta.core.version.as_ref().is_none_or(|version| !c.source_versions.contains(version)) {
if meta.core.version.as_ref().is_none_or(|version| version != &manifest.version && !c.source_versions.contains(version)) {
return Err(Error::Invalid("This server version is outside the release's tested compatibility matrix.".into()));
}
}
@@ -780,11 +783,26 @@ pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result
}
pub(crate) fn operation_lock(meta_dir: &Path) -> Result<fs::File> {
operation_lock_for(meta_dir, "server maintenance", false)
}
pub(crate) fn operation_lock_for(meta_dir: &Path, operation: &str, wait_for_check: bool) -> Result<fs::File> {
fs::create_dir_all(meta_dir)?;
let lock = fs::OpenOptions::new().read(true).write(true).create(true).truncate(false).open(meta_dir.join("update.lock"))?;
if !fs4::fs_std::FileExt::try_lock_exclusive(&lock)? {
return Err(Error::Invalid("Another update, repair or recovery is in progress.".into()));
let deadline = std::time::Instant::now() + std::time::Duration::from_secs(30);
loop {
if fs4::fs_std::FileExt::try_lock_exclusive(&lock)? { break; }
let owner = fsx::read_json::<serde_json::Value>(&meta_dir.join("update-lock-owner.json")).ok();
let checking = owner.as_ref().and_then(|owner| owner.get("operation")).and_then(|value| value.as_str()) == Some("checking updates");
if wait_for_check && checking && std::time::Instant::now() < deadline {
std::thread::sleep(std::time::Duration::from_millis(100));
continue;
}
let details = owner.as_ref().and_then(|owner| Some(format!(" Operation: {}; Manager process: {}; started: {}.", owner.get("operation")?.as_str()?, owner.get("pid")?.as_u64()?, owner.get("started")?.as_str()?))).unwrap_or_default();
return Err(Error::Invalid(format!("Another update, repair or recovery is in progress.{details} Wait for that operation to finish, then retry.")));
}
let record = serde_json::json!({"operation": operation, "pid": std::process::id(), "started": chrono::Utc::now().to_rfc3339()});
fsx::atomic_write_json(&meta_dir.join("update-lock-owner.json"), &record)?;
Ok(lock)
}
@@ -1358,6 +1376,25 @@ mod tests {
w
}
#[test]
fn startup_waits_for_an_update_check_but_not_for_active_maintenance() {
let temp = tempfile::tempdir().unwrap();
let checker = operation_lock_for(temp.path(), "checking updates", false).unwrap();
let root = temp.path().to_path_buf();
let release = std::thread::spawn(move || {
std::thread::sleep(std::time::Duration::from_millis(150));
drop(checker);
});
let start = operation_lock_for(&root, "starting server", true).unwrap();
release.join().unwrap();
let error = operation_lock(&root).unwrap_err().to_string();
assert!(error.contains("starting server"));
assert!(error.contains(&std::process::id().to_string()));
drop(start);
// Stale owner metadata is harmless once the OS lock is released.
operation_lock(&root).unwrap();
}
#[test]
fn legacy_manager_realm_launcher_is_replaced_during_update() {
let w = legacy_launcher_world(false);
@@ -1656,9 +1693,13 @@ mod tests {
validate_candidate(&meta, &manifest).unwrap();
manifest.compatibility.as_mut().unwrap().source_versions = vec!["0.9.0".into()];
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("compatibility matrix"));
let mut already_updated = meta.clone();
already_updated.core.version = Some(manifest.version.clone());
validate_candidate(&already_updated, &manifest).unwrap();
manifest.compatibility.as_mut().unwrap().source_versions = vec!["1.0.0".into()];
manifest.compatibility.as_mut().unwrap().platform = if cfg!(windows) { "linux-x86_64" } else { "windows-x86_64" }.into();
assert!(validate_candidate(&meta, &manifest).unwrap_err().to_string().contains("targets"));
assert!(validate_candidate(&already_updated, &manifest).unwrap_err().to_string().contains("targets"));
assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1");
assert!(unfinished(&w.meta).is_none());
}
+12
View File
@@ -422,6 +422,18 @@ hand over to `coa_core::docker`; nothing else needed to change for start, stop,
DivxTac.dll deadlocks the world loading screen under wine-mono. `COA_PROTONPATH`, `COA_WINEPREFIX` or
`client-launch.json` in the Manager's folder (`proton_path`, `prefix`, `runner`) override the detection. Whether the client
runs is read from `/proc` (under Wine the command line holds the Windows form of the path). Output goes to `client.log`.
* **Sharing with friends** (`docker/sharing.rs`): who can reach the game is decided by the address the container ports are
published on, `bindAddress` in `docker.json`; the `BindIP` of the configuration files is forced to `0.0.0.0` inside the
containers and changes nothing. Opening and closing therefore edit `bindAddress` (and set `CoA.AllowRemoteClients`), "servers
open" and the exposure check are computed from it (the database is never published, the console only on `127.0.0.1`), and
there is no firewall row on Linux. Settings the backend fixes (`docker::FORCED_KEYS`) are not offered; a test keeps that list
equal to the variables the containers get. A world that restarts itself (exit code 2) is restarted by Docker once it has come
up. The database console shows `docker logs`, and the file-based screens read Linux locations (the desktop folder from the
user directories file, memory from `/proc/meminfo`, the distribution name for the problem report).
* **Game data folder** (`docker::game_data_dir` / `set_game_data`, Settings card): `dataDir` in `docker.json` can be changed
after the install, only while the world and auth are stopped, and only to a folder that passes the install checks. A world
that stops with "does not hold the CoA client dbc set" is reported as `GameDataMismatch` (wrong data set: the standard one,
not Conquest of Azeroth's) instead of a bare failure.
* **Not done yet**: downloading the game data, updates, port conflict detection, the firewall and exposure checks, the
Wildcard realm profiles, and the client under Wine/Proton.
+2 -2
View File
@@ -1,12 +1,12 @@
{
"name": "coa-server-manager",
"version": "0.6.15",
"version": "0.6.16",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "coa-server-manager",
"version": "0.6.15",
"version": "0.6.16",
"dependencies": {
"@tauri-apps/api": "^2.12.0",
"@tauri-apps/plugin-dialog": "^2.8.0",
+1 -1
View File
@@ -1,7 +1,7 @@
{
"name": "coa-server-manager",
"private": true,
"version": "0.6.15",
"version": "0.6.16",
"license": "AGPL-3.0-only",
"type": "module",
"scripts": {
+59 -6
View File
@@ -110,6 +110,31 @@ fn summary(id: String, path: PathBuf) -> ServerSummary {
ServerSummary { id, name, path: path.to_string_lossy().into_owned() }
}
/// The game data folder of a Docker server; none for a repack, whose data is inside its own folder.
#[tauri::command]
fn game_data_folder(state: State<'_, AppState>, id: String) -> std::result::Result<Option<String>, UiError> {
let root = path_of(&state, &id)?;
if !coa_core::docker::is_docker(&root) {
return Ok(None);
}
Ok(Some(coa_core::docker::game_data_dir(&root)?.to_string_lossy().into_owned()))
}
/// Point a Docker server at another game data folder. The servers must be stopped.
#[tauri::command]
async fn set_game_data_folder(state: State<'_, AppState>, id: String, path: String) -> std::result::Result<String, UiError> {
let root = path_of(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || {
if !coa_core::docker::is_docker(&root) {
return Err(Error::Invalid("The game data of this server is inside its folder.".into()));
}
coa_core::docker::set_game_data(&root, std::path::Path::new(&path))?;
Ok(path)
})
.await
}
#[tauri::command]
fn default_install_dir() -> String {
if platform::flavor() == Flavor::Docker {
@@ -156,7 +181,9 @@ async fn add_server(state: State<'_, AppState>, path: String) -> std::result::Re
meta.core.version = report.banner_revision.clone();
meta.database.port = Some(report.ports.mysql);
meta.database.schemas = report.database_schemas.clone();
for (rel, exe) in [("Core/worldserver.exe", &report.worldserver), ("Core/authserver.exe", &report.authserver)] {
// The executables are `worldserver.exe` in a repack and `worldserver` in a Docker server; the file check reads these names.
let exe_names = if coa_core::docker::is_docker(std::path::Path::new(&report.path)) { ("Core/worldserver", "Core/authserver") } else { ("Core/worldserver.exe", "Core/authserver.exe") };
for (rel, exe) in [(exe_names.0, &report.worldserver), (exe_names.1, &report.authserver)] {
if let Some(e) = exe {
meta.original_hashes.insert(rel.into(), e.sha256.clone());
}
@@ -699,6 +726,13 @@ async fn custom_races_install(app: AppHandle, state: State<'_, AppState>, id: St
result
}
#[tauri::command]
async fn custom_races_uninstall(state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> {
let ctx = client_context(&state, &id)?;
let _guard = BusyGuard::acquire(&state, &id)?;
blocking(move || coa_core::custom_races::uninstall_client_patches(&ctx.require()?)).await
}
#[tauri::command]
async fn custom_races_toggle_client(state: State<'_, AppState>, id: String, enabled: bool) -> std::result::Result<(), UiError> {
let root = path_of(&state, &id)?;
@@ -1374,7 +1408,7 @@ struct FriendsStatus {
exposure: Vec<coa_core::net::Exposure>,
/// The configuration lets other computers reach the login and world servers.
servers_open: bool,
firewall: coa_core::firewall::Status,
firewall: Option<coa_core::firewall::Status>,
tailscale: coa_core::net::Tailscale,
server_running: bool,
auth_port: u16,
@@ -1419,7 +1453,18 @@ fn report_targets() -> Vec<coa_core::report::Target> {
coa_core::report::targets()
}
/// The distribution on Linux ("Linux (Arch Linux)"), from `/etc/os-release`; empty if it cannot be read.
#[cfg(not(windows))]
fn windows_version() -> String {
std::fs::read_to_string("/etc/os-release")
.ok()
.and_then(|t| t.lines().find_map(|l| l.strip_prefix("PRETTY_NAME=").map(|v| v.trim_matches('"').to_string())))
.map(|name| format!("Linux ({name})"))
.unwrap_or_default()
}
/// "Windows 11 (build 26200)" from `ver`; empty if it cannot be read.
#[cfg(windows)]
fn windows_version() -> String {
let mut cmd = std::process::Command::new("cmd.exe");
cmd.args(["/C", "ver"]);
@@ -1468,9 +1513,10 @@ async fn friends_status(state: State<'_, AppState>, id: String) -> std::result::
settings: coa_core::friends::load(&meta),
lan_ip: automatic.map(|a| a.to_string()),
lan_addresses: coa_core::net::lan_addresses(automatic).unwrap_or_default(),
exposure: coa_core::net::exposure(&ports),
exposure: if coa_core::docker::is_docker(&root) { coa_core::docker::exposure(&root, &ports) } else { coa_core::net::exposure(&ports) },
servers_open: coa_core::friends::bind_is_open(&root),
firewall: coa_core::firewall::status(),
// The Windows firewall exists only on Windows; on Linux Docker publishes the ports itself.
firewall: (platform::flavor() == Flavor::Repack).then(coa_core::firewall::status),
tailscale: coa_core::net::tailscale(),
server_running: coa_core::process::observe(&root, &ports).world.state == coa_core::process::ServiceState::Running,
auth_port: ports.auth,
@@ -1540,7 +1586,7 @@ async fn friends_enable(
};
let open = mode != Mode::Local;
let changed = friends::set_open(&root, &meta, open)?;
if open {
if open && platform::flavor() == Flavor::Repack {
coa_core::firewall::ensure_rules_with_secondary(&ports, secondary)?;
}
if mode == Mode::Direct && use_upnp {
@@ -1573,7 +1619,7 @@ async fn friends_package(state: State<'_, AppState>, id: String) -> std::result:
blocking(move || {
let meta = meta_dir(&root)?;
let host = coa_core::friends::load(&meta).host.ok_or_else(|| Error::Invalid("Choose how friends connect first.".into()))?;
let desktop = std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop");
let desktop = if platform::flavor() == Flavor::Docker { coa_core::diag::desktop_or_temp() } else { std::env::var_os("USERPROFILE").map(PathBuf::from).unwrap_or_else(std::env::temp_dir).join("Desktop") };
let out = if desktop.is_dir() { desktop } else { std::env::temp_dir() }.join("CoA-Friend-Setup.zip");
coa_core::friends::make_friend_package(&root, &host, true, &out)?;
Ok(out.to_string_lossy().into_owned())
@@ -1634,6 +1680,10 @@ async fn console_tail(
) -> std::result::Result<Vec<coa_core::console::Line>, UiError> {
let root = path_of(&state, &id)?;
blocking(move || {
// A Docker server's database writes to its container's output, not to a file.
if coa_core::docker::is_docker(&root) && matches!(source, coa_core::console::Source::Database) {
return coa_core::docker::logs::database_log(&root, filter.as_deref(), lines.unwrap_or(300).min(2000));
}
let path = coa_core::console::log_path(&root, &data_dir().join("logs").join("manager.log"), source);
coa_core::console::tail(&path, filter.as_deref(), lines.unwrap_or(300).min(2000))
})
@@ -1670,6 +1720,8 @@ pub fn run() {
.manage(AppState { registry: Registry::at(dir.join("installs.json")), busy: Mutex::new(HashSet::new()), install_cancel: Mutex::new(None), client_cancel: Mutex::new(None) })
.invoke_handler(tauri::generate_handler![
default_install_dir,
game_data_folder,
set_game_data_folder,
install_environment,
scan_server,
add_server,
@@ -1764,6 +1816,7 @@ pub fn run() {
console_command,
custom_races_status,
custom_races_install,
custom_races_uninstall,
custom_races_toggle_client
])
.run(tauri::generate_context!())
+1 -1
View File
@@ -1,7 +1,7 @@
{
"$schema": "https://schema.tauri.app/config/2",
"productName": "CoA Server Manager",
"version": "0.6.15",
"version": "0.6.16",
"identifier": "com.coa.servermanager",
"build": {
"beforeDevCommand": "npm run dev",
+2
View File
@@ -92,6 +92,8 @@ export {};
if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;}
if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip";
if(cmd==="list_crashes") return [];
if(cmd==="game_data_folder") return new URLSearchParams(location.search).get("flavor")==="docker"?"/srv/coa/server-data":null;
if(cmd==="set_game_data_folder") return args.path;
if(cmd==="install_environment"){const docker=new URLSearchParams(location.search).get("flavor")==="docker";return docker?{flavor:"docker",default_dir:"/home/you/CoaServer",docker_problem:new URLSearchParams(location.search).has("nodocker")?"permission denied while trying to connect to the Docker daemon socket":null}:{flavor:"repack",default_dir:"C:\\Games\\CoA Server",docker_problem:null};}
if(cmd==="install_preflight") return {ok:true,problems:[],free_bytes:210*2**30};
if(cmd==="install_requirements") return {download_bytes:Math.round(5.9*2**30),unpacked_bytes:Math.round(11.4*2**30),version:"0.2.0"};
+8
View File
@@ -101,6 +101,7 @@ const en = {
"status.attention": "Needs attention",
"status.running": "Running",
"status.stopped": "Stopped",
"status.crashed": "Stopped unexpectedly",
"btn.start": "START SERVER",
"btn.stop": "STOP SERVER",
@@ -143,6 +144,8 @@ const en = {
"err.operation_in_progress.message": "The server is busy starting or stopping. Wait a moment and try again.",
"err.startup_failed.title": "Server could not start",
"err.startup_failed.message": "A service stopped while starting. Check the details for the cause.",
"err.game_data_mismatch.title": "The game data folder is not the CoA set",
"err.game_data_mismatch.message": "The server stopped because the DBC files in the game data folder are not the ones of the Conquest of Azeroth client. Choose the folder that holds the CoA data (Settings > Game data folder), then start again.",
"err.docker_unavailable.title": "Docker is not available",
"err.docker_unavailable.message": "This server runs in Docker. Install Docker, start it, and make sure your user account may use it, then try again.",
"err.hash_mismatch.title": "A downloaded file is damaged",
@@ -190,6 +193,11 @@ const en = {
"install.localPkg": "Install from a local package folder instead of downloading",
"install.localPkgHint": "(leave empty to download)",
"install.button": "Install",
"gamedata.title": "Game data folder",
"gamedata.text": "The folder with the game's dbc, maps, vmaps and mmaps that this server reads. It is used where it is and never changed. It must be the Conquest of Azeroth set, not the standard one. Stop the server before changing it.",
"gamedata.change": "Change…",
"gamedata.dialog": "Choose the game data folder",
"gamedata.saved": "Saved. It is used the next time the server starts.",
"install.docker.title": "Docker is needed",
"install.docker.text": "On Linux the server runs in Docker. Install Docker and start it, or allow your user to use it, then check again.",
"install.docker.retry": "Check again",
+7 -1
View File
@@ -393,6 +393,7 @@ export interface ClientDownloadCheck {
export type ClientPatchState = "not-installed" | "enabled" | "disabled" | "partially-installed";
export interface CustomRacesClientStatus {
version: string | null;
state: ClientPatchState;
installedMpqs: number;
totalMpqs: number;
@@ -420,7 +421,8 @@ export interface FriendsStatus {
lan_addresses: LanAddress[];
exposure: { port: number; what: string; reachable_from_network: boolean; listening: boolean }[];
servers_open: boolean;
firewall: { auth: boolean; world: boolean };
/** null where there is no Windows firewall to ask about (Linux). */
firewall: { auth: boolean; world: boolean } | null;
tailscale: { installed: boolean; ip: string | null; connected: boolean };
server_running: boolean;
auth_port: number;
@@ -497,6 +499,9 @@ export const api = {
restoreConfigs: (id: string, backupId: string) => invoke<RecoveryPoint>("restore_backup_configs", { id, backupId }),
restoreDatabase: (id: string, backupId: string, database: string) => invoke<DbRestore>("restore_backup_database", { id, backupId, database }),
installEnvironment: () => invoke<InstallEnvironment>("install_environment"),
/** The game data folder of a Docker server; null for a repack. */
gameDataFolder: (id: string) => invoke<string | null>("game_data_folder", { id }),
setGameDataFolder: (id: string, path: string) => invoke<string>("set_game_data_folder", { id, path }),
installPreflight: (dest: string, needed?: number, gameData?: string) => invoke<Preflight>("install_preflight", { dest, needed: needed ?? null, gameData: gameData ?? null }),
installRequirements: (pkg?: string) => invoke<InstallRequirements>("install_requirements", { package: pkg ?? null }),
realmlistProfiles: (id: string) => invoke<{ profiles: RealmProfile[]; active: string | null }>("realmlist_profiles", { id }),
@@ -547,6 +552,7 @@ export const api = {
clientDownload: (id: string, parent: string) => invoke<ClientInfo>("client_download", { id, parent }),
clientCancel: () => invoke<void>("client_cancel"),
customRacesStatus: (id: string) => invoke<CustomRacesClientStatus | null>("custom_races_status", { id }),
customRacesUninstall: (id: string) => invoke<void>("custom_races_uninstall", { id }),
customRacesInstall: (id: string) => invoke<void>("custom_races_install", { id }),
customRacesToggleClient: (id: string, enabled: boolean) => invoke<void>("custom_races_toggle_client", { id, enabled }),
play: (id: string) => invoke<DriverOutcome>("play", { id }),
+1 -1
View File
@@ -170,7 +170,7 @@ export function FriendsPage({ serverId }: { serverId: string }) {
<ul className="mt-2 divide-y divide-line">
<Line ok={st.server_running}>{t("fr.st.running")}</Line>
<Line ok={st.servers_open}>{t("fr.st.open")}</Line>
<Line ok={st.firewall.auth && st.firewall.world}>{t("fr.st.firewall")}</Line>
{st.firewall && <Line ok={st.firewall.auth && st.firewall.world}>{t("fr.st.firewall")}</Line>}
<Line ok={st.exposure.filter((e) => e.what === "database" || e.what === "server console").every((e) => !e.reachable_from_network)}>
{t("fr.st.private")}
</Line>
+44
View File
@@ -0,0 +1,44 @@
import { useEffect, useState } from "react";
import { open } from "@tauri-apps/plugin-dialog";
import { api, asUiError } from "@/lib/api";
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { useT } from "@/i18n";
/** Where a Docker server reads the game data from. Not shown for a repack, which keeps its data in its own folder. */
export function GameDataCard({ serverId }: { serverId: string }) {
const t = useT();
const [folder, setFolder] = useState<string | null>(null);
const [message, setMessage] = useState<{ ok: boolean; text: string } | null>(null);
useEffect(() => {
let alive = true;
void api.gameDataFolder(serverId).then((f) => alive && setFolder(f)).catch(() => alive && setFolder(null));
return () => { alive = false; };
}, [serverId]);
if (folder === null) return null;
async function change() {
const picked = await open({ directory: true, multiple: false, title: t("gamedata.dialog"), defaultPath: folder ?? undefined });
if (typeof picked !== "string") return;
try {
setFolder(await api.setGameDataFolder(serverId, picked));
setMessage({ ok: true, text: t("gamedata.saved") });
} catch (e) {
setMessage({ ok: false, text: asUiError(e).technical });
}
}
return (
<Card className="mt-6 p-6">
<h2 className="font-semibold">{t("gamedata.title")}</h2>
<p className="mt-1 text-sm text-muted">{t("gamedata.text")}</p>
<div className="mt-3 flex items-center gap-3">
<code className="selectable min-w-0 flex-1 truncate rounded-md border border-line bg-card px-3 py-2 text-sm" title={folder}>{folder}</code>
<Button onClick={() => void change()}>{t("gamedata.change")}</Button>
</div>
{message && <p className={message.ok ? "mt-2 text-sm text-ok" : "mt-2 text-sm text-bad"} role="status">{message.text}</p>}
</Card>
);
}
+18 -2
View File
@@ -144,6 +144,17 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
}
}
async function uninstallClientPatch() {
setRacesInstalling(true);
setError(null);
try {
await api.customRacesUninstall(serverId);
await load();
onChanged?.();
} catch (e) { setError(asUiError(e)); }
finally { setRacesInstalling(false); }
}
async function toggle(m: ModuleView) {
setError(null);
try {
@@ -205,7 +216,9 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
{!m.installed && m.status !== "soon" && <span className="mt-1.5 shrink-0 text-xs text-muted">{t("mod.notHere")}</span>}
</div>
{m.id === "custom-races" && (
<div className="w-full">
<p className="text-xs text-muted">{locale === "ru" ? "Установленная версия патча клиента: " : "Installed client patch version: "}{racesPatchStatus?.version ?? (locale === "ru" ? "не записана" : "not recorded")}</p>
{racesInstalling && racesProgress ? (
<div className="rounded-lg border border-gold/30 bg-gold/5 p-3">
<div className="flex items-center justify-between gap-3 text-xs">
@@ -252,7 +265,8 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
</span>
)}
</div>
{(!racesPatchStatus || racesPatchStatus.state === "not-installed" || racesPatchStatus.state === "partially-installed") && (
{racesPatchStatus?.state === "partially-installed" && <p className="text-xs text-warn">{locale === "ru" ? "Файлы отсутствуют или изменены. Восстановите патч клиента." : "Files are missing or changed. Repair the client patch."}</p>}
{(
<Button
size="sm"
variant="secondary"
@@ -261,9 +275,11 @@ export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId
onClick={() => void installClientPatch()}
>
{racesInstalling && <Loader2 className="mr-1.5 h-3.5 w-3.5 animate-spin" />}
{locale === "ru" ? "Установить патч клиента" : "Install Client Patch 1.5"}
{racesPatchStatus?.state === "not-installed" ? (locale === "ru" ? "Установить патч клиента" : "Install Client Patch") : (locale === "ru" ? "Восстановить патч клиента" : "Repair Client Patch")}
</Button>
)}
{racesPatchStatus && racesPatchStatus.state !== "not-installed" && <Button size="sm" variant="ghost" disabled={racesInstalling} onClick={() => void uninstallClientPatch()}>{locale === "ru" ? "Удалить патч клиента" : "Uninstall Client Patch"}</Button>}
<p className="text-xs text-muted">{locale === "ru" ? (m.enabled ? "После установки патч будет включён." : "После установки патч останется отключённым: модуль сервера выключен или отсутствует.") : (m.enabled ? "The patch will be enabled after installation." : "The patch will stay disabled after installation: the server module is off or missing.")}</p>
</div>
)}
</div>
+4 -3
View File
@@ -46,21 +46,22 @@ function Row({ label, s }: { label: string; s: ServiceStatus }) {
const t = useT();
const running = s.state === "running";
const starting = s.state === "starting";
const crashed = s.state === "crashed";
return (
<div className="flex items-center justify-between py-2.5">
<span>{label}</span>
<span
className={cn("flex items-center gap-2 text-sm", running ? "text-ok" : starting ? "text-warn" : "text-muted")}
className={cn("flex items-center gap-2 text-sm", running ? "text-ok" : starting || crashed ? "text-warn" : "text-muted")}
role="status"
>
<span
aria-hidden
className={cn(
"h-2 w-2 rounded-full",
running ? "bg-ok" : starting ? "animate-[pulse-dot_1.2s_ease-in-out_infinite] bg-warn" : "bg-muted/50",
running ? "bg-ok" : starting ? "animate-[pulse-dot_1.2s_ease-in-out_infinite] bg-warn" : crashed ? "bg-warn" : "bg-muted/50",
)}
/>
{running ? t("status.running") : starting ? t("status.starting") : t("status.stopped")}
{running ? t("status.running") : starting ? t("status.starting") : crashed ? t("status.crashed") : t("status.stopped")}
</span>
</div>
);
+3
View File
@@ -7,6 +7,7 @@ import { api, asUiError, type UiError, type UpdatePreview, type UpdateTxn } from
import { Button } from "@/components/ui/button";
import { Card } from "@/components/ui/card";
import { ClientCard } from "@/screens/ClientCard";
import { GameDataCard } from "@/screens/GameDataCard";
import { DiagnosticsCard } from "@/screens/DiagnosticsCard";
import { AboutCard } from "@/screens/AboutCard";
import { RemoveServerCard } from "@/screens/RemoveServerCard";
@@ -174,6 +175,8 @@ export function SettingsHome({ serverId, path, onForget }: { serverId: string; p
<RealmStartupSettings serverId={serverId} />
<AutoRestartSettings serverId={serverId} />
<GameDataCard serverId={serverId} />
<DiagnosticsCard serverId={serverId} />
<RepairCard key={serverId} serverId={serverId} />