//! Management of client-side patches and assets for Custom Races. //! //! Handles detecting, enabling/disabling (via `.disabled` extension renaming), //! and downloading/extracting client patches (Esteria and additional races) //! into the player's WoW client directory. use std::fs::{self, File}; use std::io::{self, Read}; use std::path::{Path, PathBuf}; use serde::{Deserialize, Serialize}; use crate::download::Cancel; use crate::error::{Error, Result}; use crate::fsx; pub const CLIENT_VERSION: &str = "1.9.2"; pub const MANIFEST_FILENAME: &str = "custom_races_patch_manifest.txt"; pub const ARCHIVES: &[(&str, &str)] = &[ ("CoA-Custom-1.9.2-Client-1.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-1.zip"), ("CoA-Custom-1.9.2-Client-2.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-2.zip"), ("CoA-Custom-1.9.2-Client-3.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-3.zip"), ("CoA-Custom-1.9.2-Client-4.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-4.zip"), ("CoA-Custom-1.9.2-Client-5.zip", "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.9.2/CoA-Custom-1.9.2-Client-5.zip"), ]; pub const RACE_MPQS: &[&str] = &[ "patch-T.MPQ", "patch-ZE1.MPQ", "patch-ZE2.MPQ", "patch-ZE3.MPQ", "patch-ZE5.MPQ", "patch-ZE6.MPQ", "patch-ZE7.MPQ", "patch-ZE8.MPQ", "patch-ZE9.MPQ", "patch-ZEA.MPQ", "patch-ZG.MPQ", "patch-ZH.MPQ", "patch-ZHA.MPQ", "patch-ZHM.MPQ", "patch-ZM.MPQ", "patch-ZVU.MPQ", "patch-ZES.MPQ", "patch-ZJ.MPQ", "patch-ZZE.MPQ", "patch-ZZR.MPQ", "patch-ZZS.MPQ", "patch-ZZT.MPQ", "patch-ZZU.MPQ", "patch-ZZV.MPQ", "patch-ZZW.MPQ", "patch-ZZZ.MPQ", "patch-ZK.MPQ", "patch-ZZX.MPQ", "patch-ZZZC.MPQ", "patch-ZZZD.MPQ", "patch-ZZZA.MPQ", "patch-ZZZE.MPQ", "patch-ZZZF.MPQ", "patch-ZZZZ.MPQ", ]; pub const RACE_ADDONS: &[&str] = &[ "CoAQuestSafe/CoAQuestSafe.lua", "CoAQuestSafe/CoAQuestSafe.toc", "CoAWC2Cursor/CoAWC2Cursor.lua", "CoAWC2Cursor/CoAWC2Cursor.toc", "CoAHideArmor/CoAHideArmor.lua", "CoAHideArmor/CoAHideArmor.toc", "CoA_TalentReset/CoA_TalentReset.lua", "CoA_TalentReset/CoA_TalentReset.toc", ]; pub const EXCLUDED_BOT_RACES_RECOMMENDED: &str = "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 = "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 { let mut paths = Vec::new(); let candidates = [ root.join("Core/configs/modules/playerbots.conf"), root.join("coa-bots/Core/configs/modules/playerbots.conf"), root.join("coa-bots/core/configs/modules/playerbots.conf"), crate::multiworld::root(root).join("Core/configs/modules/playerbots.conf"), ]; for path in candidates { if path.is_file() { paths.push(path); } } if paths.is_empty() { for dist in [ root.join("Core/configs/modules/playerbots.conf.dist"), root.join("coa-bots/Core/configs/modules/playerbots.conf.dist"), ] { if dist.is_file() { let target = dist.with_extension(""); if fs::copy(&dist, &target).is_ok() { paths.push(target); break; } } } } paths } /// Checks whether playerbots are configured to allow custom races. /// Returns true if AiPlayerbot.ExcludedBotRaces exists and does not exclude general custom races. pub fn is_bot_custom_races_allowed(root: &Path) -> Option { if let Ok(bytes) = fs::read(root.join("Core/configs/modules/coa_custom_races.conf")) { if let Ok(conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) { if let Some(value) = conf.get("CoACustomRaces.BotsEnable") { return Some(matches!(value.trim().trim_matches('"'), "1" | "true")); } } } for path in playerbots_conf_paths(root) { if let Ok(bytes) = fs::read(&path) { if let Ok(conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) { if let Some(val) = conf.get("AiPlayerbot.ExcludedBotRaces") { let clean = val.trim().trim_matches(['"', '\'']); let excluded: std::collections::BTreeSet = 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)), ); } } } } None } /// Sets AiPlayerbot.ExcludedBotRaces in all discovered playerbots.conf files. pub fn sync_bot_races_config(root: &Path, allow_custom_races: bool) -> Result<()> { let excluded = if allow_custom_races { EXCLUDED_BOT_RACES_EXPERIMENTAL } else { EXCLUDED_BOT_RACES_RECOMMENDED }; for path in playerbots_conf_paths(root) { if let Ok(bytes) = fs::read(&path) { if let Ok(mut conf) = crate::config::parser::ConfFile::parse_bytes(&bytes) { if let Some(value) = conf.get("AiPlayerbot.ExcludedBotRaces") { let clean = value.trim().trim_matches(['"', '\'']); let owned = String::from_utf8_lossy(&bytes) .contains("CoA Custom: races new random bots never get") && matches!( clean, EXCLUDED_BOT_RACES_RECOMMENDED | EXCLUDED_BOT_RACES_EXPERIMENTAL ); if !owned { continue; } } conf.set( "AiPlayerbot.ExcludedBotRaces", &format!("\"{excluded}\""), &[ "CoA Custom: races new random bots never get", "Off (recommended): excludes all added races", "On (experimental): allows stable added races", ], ); fsx::atomic_write(&path, conf.to_text().as_bytes())?; } } } Ok(()) } #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] #[serde(rename_all = "kebab-case")] pub enum ClientPatchState { NotInstalled, Enabled, Disabled, PartiallyInstalled, } #[derive(Debug, Clone, Serialize, Deserialize)] #[serde(rename_all = "camelCase")] pub struct ClientPatchStatus { pub state: ClientPatchState, pub version: Option, pub installed_mpqs: usize, pub total_mpqs: usize, pub has_root_files: bool, pub client_path: Option, } #[derive(Clone, Serialize, Deserialize)] struct PatchFile { path: String, sha256: String, } fn patch_files(client: &Path) -> Result> { 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 if manifest.lines().any(|line| line == "# CoA Custom 1.6") { include_str!("custom_races_hashes_1_6.json") } else if manifest.lines().any(|line| line == "# CoA Custom 1.7") { include_str!("custom_races_hashes_1_7.json") } else if manifest.lines().any(|line| line == "# CoA Custom 1.8") { include_str!("custom_races_hashes_1_8.json") } else if manifest.lines().any(|line| line == "# CoA Custom 1.8.3") { include_str!("custom_races_hashes_1_8_3.json") } else if manifest.lines().any(|line| line == "# CoA Custom 1.9.1") { include_str!("custom_races_hashes_1_9_1.json") } else { include_str!("custom_races_hashes.json") }; let bundled: std::collections::BTreeMap = 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:") { Some(name.to_string()) } else { line.strip_prefix("ADDON:") .map(|name| format!("Interface/AddOns/{name}")) }; if let Some(path) = path { fsx::safe_join(client, &path)?; files.insert( path.clone(), bundled.get(&path).cloned().unwrap_or_default(), ); } } if files.is_empty() { files = bundled; } for line in manifest .lines() .filter_map(|line| line.strip_prefix("SHA256:")) { let (hash, path) = line .split_once(':') .ok_or_else(|| Error::Invalid("Invalid custom races checksum.".into()))?; if hash.len() != 64 || !hash.bytes().all(|b| b.is_ascii_hexdigit()) || !files.contains_key(path) { return Err(Error::Invalid("Invalid custom races checksum.".into())); } files.insert(path.into(), hash.into()); } Ok(files .into_iter() .map(|(path, sha256)| PatchFile { path, sha256 }) .collect()) } fn suffix(path: &Path, extension: &str) -> PathBuf { path.with_file_name(format!( "{}.{extension}", path.file_name().unwrap_or_default().to_string_lossy() )) } fn matches_patch(path: &Path, file: &PatchFile) -> bool { path.is_file() && fsx::sha256_file(path).is_ok_and(|hash| hash == file.sha256) } /// Only complete, verified payloads are reported as enabled or disabled. pub fn client_patch_status(client_path: &Path) -> ClientPatchStatus { let data = client_path.join("Data"); let installed_mpqs = RACE_MPQS .iter() .filter(|name| data.join(name).is_file() || suffix(&data.join(name), "disabled").is_file()) .count(); let has_root_files = client_path.join("EsteriaAppearance.dll").is_file() || client_path.join("dinput8.dll").is_file() || client_path.join("dinput8.dll.disabled").is_file(); let manifest = fs::read_to_string(client_path.join(MANIFEST_FILENAME)).unwrap_or_default(); let current = manifest .lines() .any(|line| line == format!("# CoA Custom {CLIENT_VERSION}")); let state = if !manifest.is_empty() && current && !client_path.join(".coa-races-transaction").exists() { match patch_files(client_path) { Ok(files) if files.iter().all(|f| { matches_patch(&client_path.join(&f.path), f) && !suffix(&client_path.join(&f.path), "disabled").exists() }) => { ClientPatchState::Enabled } Ok(files) if files .iter() .all(|f| matches_patch(&suffix(&client_path.join(&f.path), "disabled"), f)) => { ClientPatchState::Disabled } _ => ClientPatchState::PartiallyInstalled, } } else if !manifest.is_empty() || patch_files(client_path).is_ok_and(|files| { files .iter() .filter(|file| file.path.starts_with("Data/") && file.path != "Data/patch-T.MPQ") .any(|file| { matches_patch(&client_path.join(&file.path), file) || matches_patch(&suffix(&client_path.join(&file.path), "disabled"), file) }) }) { ClientPatchState::PartiallyInstalled } else { ClientPatchState::NotInstalled }; let version = manifest .lines() .find_map(|line| line.strip_prefix("# CoA Custom ").map(str::to_string)); ClientPatchStatus { state, version, installed_mpqs, total_mpqs: RACE_MPQS.len(), has_root_files, client_path: Some(client_path.to_string_lossy().into_owned()), } } #[derive(Serialize, Deserialize)] struct SavedFile { path: String, existed: bool, #[serde(default)] moved_to: Option, } struct PatchTransaction<'a> { root: &'a Path, entries: Vec, finished: bool, } // A shared AddOns directory can resolve onto another volume. Publish a complete, // synced copy beside the destination before deleting the source, so the journal // always retains recoverable bytes even if copying or publishing fails. fn move_patch_file(source: &Path, target: &Path) -> io::Result<()> { match fs::rename(source, target) { Ok(()) => return Ok(()), Err(error) if error.kind() == io::ErrorKind::CrossesDevices => {} Err(error) => return Err(error), } let parent = target .parent() .ok_or_else(|| io::Error::other("Patch target has no parent"))?; let temporary = tempfile::NamedTempFile::new_in(parent)?; fs::copy(source, temporary.path())?; temporary.as_file().sync_all()?; temporary.persist(target).map_err(|error| error.error)?; fs::remove_file(source) } impl<'a> PatchTransaction<'a> { fn new(root: &'a Path) -> Result { 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(), moved_to: None, }); fsx::atomic_write_json( &self.root.join(".coa-races-transaction/journal.json"), &self.entries, )?; if path.is_file() { move_patch_file( 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<()> { // Save the destination first so recovery restores the moved source before it. self.save(target)?; self.save(source)?; let index = self .entries .iter() .position(|entry| self.root.join(&entry.path) == source) .unwrap(); let relative = target .strip_prefix(self.root) .map_err(|_| Error::Invalid("Patch path escaped the client directory.".into()))? .to_string_lossy() .replace('\\', "/"); self.entries[index].moved_to = Some(relative); fsx::atomic_write_json( &self.root.join(".coa-races-transaction/journal.json"), &self.entries, )?; fs::create_dir_all(target.parent().unwrap())?; move_patch_file( &self .root .join(".coa-races-transaction") .join(index.to_string()), target, )?; Ok(()) } 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 mut entries: Vec = fsx::read_json(&directory.join("journal.json"))?; for index in (0..entries.len()).rev() { let entry = &entries[index]; let path = fsx::safe_join(root, &entry.path)?; let saved = directory.join(index.to_string()); if let Some(target) = &entry.moved_to { let target = fsx::safe_join(root, target)?; if !saved.is_file() && target.is_file() { move_patch_file(&target, &saved)?; } // Persist recovery progress before restoring the source, making retries safe. entries[index].moved_to = None; fsx::atomic_write_json(&directory.join("journal.json"), &entries)?; } let entry = &entries[index]; if saved.is_file() { if path.is_file() { fs::remove_file(&path)?; } move_patch_file(&saved, &path)?; } else if !entry.existed && path.is_file() { fs::remove_file(path)?; } } } fs::remove_dir_all(directory)?; Ok(()) } fn patch_lock(client: &Path) -> Result { 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 stage_root_asset(staging: &Path, relative: &str, reader: &mut impl Read) -> Result { let dest = fsx::safe_join(staging, relative)?; fs::create_dir_all( dest.parent() .ok_or_else(|| Error::Invalid("Invalid client asset path.".into()))?, )?; let mut output = File::create(&dest)?; io::copy(reader, &mut output)?; let disabled = PathBuf::from(format!("{}.disabled", dest.display())); if disabled.is_file() { fs::remove_file(disabled)?; } Ok(relative.to_string()) } fn archive_job(filename: &str, url: &str, cache: &Path) -> Result { let (size, sha256) = match filename { "CoA-Custom-1.9.2-Client-1.zip" => ( 1_513_021_586, "a9dd51ed2d90fb048d549602f40f5429d56e2df0df5606a38781b358fa369568", ), "CoA-Custom-1.9.2-Client-2.zip" => ( 1_198_283_005, "ab084a55509ccbcc2977a06dd0c01fa879973a1892baaacaeb3ff52f3dfc750e", ), "CoA-Custom-1.9.2-Client-3.zip" => ( 1_678_829_573, "907e267f0ee7038807e626c3c1eca5e12db6c88b747137a23c5fb52eaa1a358e", ), "CoA-Custom-1.9.2-Client-4.zip" => ( 502_385_128, "e0bd87172af989fa50a8e2b08ba4321c72b6265047482f051a1db3b80d55bcaa", ), "CoA-Custom-1.9.2-Client-5.zip" => ( 168_079_711, "73364ad1b58c6342641a848a3b20a835472834f600416606be1470386774ca78", ), _ => return Err(Error::Invalid("Unknown custom races archive.".into())), }; Ok(crate::download::Job { url: url.into(), dest: cache.join(filename), sha256: sha256.into(), size, }) } fn archive_matches(path: &Path, job: &crate::download::Job) -> bool { path.metadata() .is_ok_and(|m| m.is_file() && m.len() == job.size) && fsx::sha256_file(path).is_ok_and(|hash| hash.eq_ignore_ascii_case(&job.sha256)) } #[cfg(test)] fn verify_archive(path: &Path, filename: &str) -> Result<()> { let job = archive_job(filename, "", Path::new(""))?; if !archive_matches(path, &job) { return Err(Error::Invalid(format!( "Custom races archive {filename} failed verification." ))); } Ok(()) } /// User-owned Downloads files are read-only candidates. Only the Manager's cache is repaired. fn resolve_archive_with( transport: &dyn crate::download::Transport, job: &crate::download::Job, downloads: Option<&Path>, cancel: &Cancel, progress: &dyn Fn(crate::download::Progress), ) -> Result { if cancel.is_set() { return Err(Error::Invalid("Download cancelled.".into())); } if let Some(downloads) = downloads { let candidate = downloads.join(job.dest.file_name().unwrap_or_default()); if archive_matches(&candidate, job) { tracing::info!(path = %candidate.display(), "using verified archive in Downloads"); progress(crate::download::Progress { downloaded: job.size, total: job.size, bytes_per_sec: 0, }); return Ok(candidate); } if candidate.exists() { tracing::warn!(path = %candidate.display(), "ignoring incomplete or unverified archive in Downloads"); } } let cache = job .dest .parent() .ok_or_else(|| Error::Invalid("Missing archive cache directory.".into()))?; fs::create_dir_all(cache)?; // Different installations share this cache; never append to or replace another active download. use fs4::fs_std::FileExt; let lock = fs::OpenOptions::new() .read(true) .write(true) .create(true) .truncate(false) .open(suffix(&job.dest, "lock"))?; if !lock.try_lock_exclusive()? { return Err(Error::Invalid("Another custom races download is using this archive. Wait for it to finish, then retry.".into())); } if job.dest.is_file() { if archive_matches(&job.dest, job) { progress(crate::download::Progress { downloaded: job.size, total: job.size, bytes_per_sec: 0, }); return Ok(job.dest.clone()); } tracing::warn!(path = %job.dest.display(), "removing unverified Manager archive cache; downloading again"); fs::remove_file(&job.dest)?; } // The shared downloader resumes .part files and verifies the complete archive before promotion. // A stale/corrupt prefix may only be detectable after resume: retry once from scratch in that case. match crate::download::fetch_with(transport, job, cancel, progress) { Err(Error::HashMismatch { .. }) if !cancel.is_set() => { tracing::warn!(path = %job.dest.display(), "archive verification failed; retrying a clean download"); crate::download::fetch_with(transport, job, cancel, progress)?; } result => result?, } Ok(job.dest.clone()) } /// Locate a verified archive or resume downloading it into the Manager's cache. fn resolve_or_download_archive( filename: &str, url: &str, transport: &dyn crate::download::Transport, cancel: &Cancel, report: &dyn Fn(&str, f32), base_percent: f32, percent_slice: f32, ) -> Result { // Report before hashing existing files: otherwise checking a large archive looks like no operation. report(&format!("Checking {filename}..."), base_percent); let cache = std::env::temp_dir().join("coa-client-races"); let downloads = std::env::var_os("USERPROFILE").map(|p| PathBuf::from(p).join("Downloads")); let job = archive_job(filename, url, &cache)?; resolve_archive_with(transport, &job, downloads.as_deref(), cancel, &|p| { let ratio = p.downloaded as f32 / p.total.max(1) as f32; report( &format!( "Downloading {filename} ({:.1} MB)...", p.downloaded as f64 / 1_048_576.0 ), base_percent + ratio.clamp(0.0, 1.0) * percent_slice, ); }) } /// Download (if needed) and extract custom races client assets into the target WoW client. pub fn install_client_patches( client_path: &Path, cancel: &Cancel, report: &dyn Fn(&str, f32), ) -> Result<()> { if !client_path.is_dir() { return Err(Error::Invalid( "Game client directory does not exist.".into(), )); } if crate::client::is_running(client_path) { return Err(Error::Invalid( "Close the game before installing custom races patches.".into(), )); } let _lock = patch_lock(client_path)?; recover_patch_transaction(client_path)?; let staging = tempfile::Builder::new() .prefix(".coa-races-stage-") .tempdir_in(client_path)?; let data_dir = staging.path().join("Data"); fs::create_dir_all(&data_dir)?; // 2. Resolve/download archives (0.05 .. 0.50) let http = crate::download::HttpTransport::with_total_timeout(600)?; let mut resolved_archives = Vec::new(); let n_archives = ARCHIVES.len() as f32; for (i, (fname, url)) in ARCHIVES.iter().enumerate() { let base_pct = 0.05 + (i as f32 / n_archives) * 0.45; let slice = 0.45 / n_archives; let archive_path = resolve_or_download_archive(fname, url, &http, cancel, report, base_pct, slice)?; resolved_archives.push(archive_path); } // 3. Extract archives (0.50 .. 0.95) let mut installed_mpqs = Vec::new(); let mut installed_roots = Vec::new(); for (i, arch_path) in resolved_archives.iter().enumerate() { if cancel.is_set() { return Err(Error::Invalid("Operation cancelled.".into())); } let arch_name = arch_path .file_name() .map(|n| n.to_string_lossy().into_owned()) .unwrap_or_default(); report( &format!("Unpacking {arch_name}..."), 0.50 + (i as f32 / n_archives) * 0.45, ); let file = File::open(arch_path)?; let mut zip = zip::ZipArchive::new(file) .map_err(|e| Error::Invalid(format!("Failed to open zip {arch_name}: {e}")))?; let num_files = zip.len(); for file_idx in 0..num_files { if cancel.is_set() { return Err(Error::Invalid("Operation cancelled.".into())); } let mut zfile = zip .by_index(file_idx) .map_err(|e| Error::Invalid(format!("Zip entry error in {arch_name}: {e}")))?; if zfile.is_dir() { continue; } let zname = zfile.name().to_string(); let zname_norm = zname.replace('\\', "/"); if zname_norm.contains("files/client/") { let base = Path::new(&zname_norm) .file_name() .map(|n| n.to_string_lossy().into_owned()) .unwrap_or_default(); if base.to_ascii_lowercase().ends_with(".mpq") { let dest = data_dir.join(&base); let mut out = File::create(&dest)?; io::copy(&mut zfile, &mut out)?; let disabled = data_dir.join(format!("{base}.disabled")); if disabled.is_file() { fs::remove_file(disabled)?; } installed_mpqs.push(base); } else if base.eq_ignore_ascii_case("dinput8.dll") { let dest = staging.path().join(&base); let mut out = File::create(&dest)?; io::copy(&mut zfile, &mut out)?; let disabled = staging.path().join(format!("{base}.disabled")); if disabled.is_file() { fs::remove_file(disabled)?; } installed_roots.push(base); } } else if let Some(relative) = zname_norm.split("files/addons/").nth(1) { if !RACE_ADDONS.contains(&relative) { continue; } let relative = format!("Interface/AddOns/{relative}"); let dest = fsx::safe_join(staging.path(), &relative)?; fs::create_dir_all( dest.parent() .ok_or_else(|| Error::Invalid("Addon file has no directory.".into()))?, )?; let mut out = File::create(&dest)?; io::copy(&mut zfile, &mut out)?; installed_roots.push(relative); } else if let Some(relative) = zname_norm.split("files/client_root/").nth(1) { installed_roots.push(stage_root_asset(staging.path(), relative, &mut zfile)?); } } } if !RACE_MPQS .iter() .all(|name| installed_mpqs.iter().any(|installed| installed == name)) { return Err(Error::Invalid( "Custom races archives are missing required client patches.".into(), )); } // 4. Record manifest report("Finalizing manifest...", 0.98); let manifest_path = client_path.join(MANIFEST_FILENAME); installed_mpqs.sort(); installed_mpqs.dedup(); installed_roots.sort(); installed_roots.dedup(); let mut manifest_body = format!("# CoA Custom {CLIENT_VERSION}\n# Custom Race MPQ files\n"); for m in &installed_mpqs { manifest_body.push_str(&format!("MPQ:{m}\n")); } manifest_body.push_str("# Custom Race root files\n"); for r in &installed_roots { if let Some(relative) = r.strip_prefix("Interface/AddOns/") { manifest_body.push_str(&format!("ADDON:{relative}\n")); } else { manifest_body.push_str(&format!("ROOT:{r}\n")); } } let bundled: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes.json"))?; let mut payload = Vec::new(); for path in installed_mpqs .iter() .map(|name| format!("Data/{name}")) .chain(installed_roots.iter().cloned()) { let staged = fsx::safe_join(staging.path(), &path)?; let hash = fsx::sha256_file(&staged)?; if bundled.get(&path) != Some(&hash) { return Err(Error::Invalid(format!( "Custom races file {path} failed verification." ))); } manifest_body.push_str(&format!("SHA256:{hash}:{path}\n")); payload.push(PatchFile { path, sha256: hash }); } if cancel.is_set() { return Err(Error::Invalid("Operation cancelled.".into())); } if payload.len() != bundled.len() { return Err(Error::Invalid( "Custom races archives are missing required runtime files.".into(), )); } let previous = patch_files(client_path)?; let mut tx = PatchTransaction::new(client_path)?; for file in payload { let dest = fsx::safe_join(client_path, &file.path)?; if dest.is_file() && !previous .iter() .any(|old| old.path == file.path && matches_patch(&dest, old)) && !matches_patch(&dest, &file) { preserve_original(&mut tx, &dest)?; } tx.copy(&staging.path().join(&file.path), &dest)?; let disabled = suffix(&dest, "disabled"); if disabled.is_file() { if !previous .iter() .any(|old| old.path == file.path && matches_patch(&disabled, old)) && !matches_patch(&disabled, &file) { tx.move_file( &disabled, &suffix( &disabled, &format!("replaced-{}", uuid::Uuid::new_v4().simple()), ), )?; } else { tx.save(&disabled)?; } } } tx.save(&manifest_path)?; fsx::atomic_write(&manifest_path, manifest_body.as_bytes())?; tx.finish()?; report("Custom races client patches installed successfully!", 1.0); tracing::info!( mpqs = installed_mpqs.len(), roots = installed_roots.len(), "custom races client patch installation complete" ); Ok(()) } #[cfg(test)] mod tests { use super::*; #[cfg(windows)] fn exercise_linked_addons(shared: &Path) { let client = tempfile::tempdir().unwrap(); let root = client.path(); fs::create_dir(root.join("Interface")).unwrap(); let link = root.join("Interface/AddOns"); let output = std::process::Command::new("cmd") .args(["/C", "mklink", "/J"]) .arg(link.to_string_lossy().replace('/', "\\")) .arg(shared.to_string_lossy().replace('/', "\\")) .output() .unwrap(); assert!(output.status.success(), "{output:?}"); let name = "Interface/AddOns/CoAHideArmor/CoAHideArmor.lua"; let active = root.join(name); fs::create_dir_all(active.parent().unwrap()).unwrap(); fs::write(shared.join("unrelated.lua"), b"user addon").unwrap(); let staged = root.join("staged.lua"); fs::write(&staged, b"custom").unwrap(); let mut tx = PatchTransaction::new(root).unwrap(); tx.copy(&staged, &active).unwrap(); tx.finish().unwrap(); record_files(root, &[name]); set_client_patch_enabled(root, false).unwrap(); assert!(!active.exists()); assert_eq!(fs::read(suffix(&active, "disabled")).unwrap(), b"custom"); set_client_patch_enabled(root, true).unwrap(); assert_eq!(fs::read(&active).unwrap(), b"custom"); // Simulate process termination after a move, then recover twice. let mut tx = PatchTransaction::new(root).unwrap(); tx.move_file(&active, &suffix(&active, "disabled")).unwrap(); std::mem::forget(tx); recover_patch_transaction(root).unwrap(); recover_patch_transaction(root).unwrap(); assert_eq!(fs::read(&active).unwrap(), b"custom"); assert!(!suffix(&active, "disabled").exists()); // Replacement installation must preserve the old bytes on failure. { let mut tx = PatchTransaction::new(root).unwrap(); fs::write(&staged, b"replacement").unwrap(); tx.copy(&staged, &active).unwrap(); } assert_eq!(fs::read(&active).unwrap(), b"custom"); uninstall_client_patches(root).unwrap(); assert!(!active.exists()); assert_eq!( fs::read(shared.join("unrelated.lua")).unwrap(), b"user addon" ); assert!(fs::symlink_metadata(&link) .unwrap() .file_type() .is_symlink()); fs::remove_dir(link).unwrap(); } #[test] fn nested_root_manifest_remains_valid_and_rejects_traversal() { let temp = tempfile::tempdir().unwrap(); let relative = "Data/Retail/Assets/EquipmentFitting/60-0.bin"; fs::write( temp.path().join(MANIFEST_FILENAME), format!("# CoA Custom {CLIENT_VERSION}\nROOT:{relative}\n"), ) .unwrap(); assert_eq!(patch_files(temp.path()).unwrap()[0].path, relative); fs::write(temp.path().join(MANIFEST_FILENAME), "ROOT:../outside.bin\n").unwrap(); assert!(patch_files(temp.path()).is_err()); } #[test] fn previous_split_release_retains_its_original_hash_inventory() { let temp = tempfile::tempdir().unwrap(); fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.8.3\n").unwrap(); let old: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes_1_8_3.json")).unwrap(); let files = patch_files(temp.path()).unwrap(); assert_eq!(files.len(), old.len()); assert!(files .iter() .all(|file| old.get(&file.path) == Some(&file.sha256))); } #[test] fn previous_191_release_keeps_its_hashes_and_does_not_claim_new_addons() { let temp = tempfile::tempdir().unwrap(); fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.9.1\n").unwrap(); let old: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes_1_9_1.json")).unwrap(); let files = patch_files(temp.path()).unwrap(); assert_eq!(files.len(), old.len()); assert!(files .iter() .all(|file| old.get(&file.path) == Some(&file.sha256))); assert!(!files.iter().any(|file| file.path.contains("CoAQuestSafe"))); } #[test] fn root_assets_preserve_nested_paths_and_reject_traversal() { let temp = tempfile::tempdir().unwrap(); let relative = "Data/Retail/Assets/EquipmentFitting/60-0.bin"; let result = stage_root_asset(temp.path(), relative, &mut &b"fitting"[..]).unwrap(); assert_eq!(result, relative); assert_eq!(fs::read(temp.path().join(relative)).unwrap(), b"fitting"); assert!(!temp.path().join("60-0.bin").exists()); assert!(stage_root_asset(temp.path(), "../outside.bin", &mut &b"bad"[..]).is_err()); } #[test] #[cfg(windows)] fn shared_addons_junction_supports_install_switch_and_rollback() { let shared = tempfile::tempdir().unwrap(); exercise_linked_addons(shared.path()); } #[test] #[cfg(windows)] #[ignore = "Set COA_TEST_OTHER_VOLUME to a writable directory on another volume"] fn shared_addons_on_another_volume_supports_install_switch_and_rollback() { let base = std::env::var_os("COA_TEST_OTHER_VOLUME").expect("COA_TEST_OTHER_VOLUME"); let shared = tempfile::tempdir_in(base).unwrap(); exercise_linked_addons(shared.path()); } fn record_files(root: &Path, names: &[&str]) { let mut manifest = format!("# CoA Custom {CLIENT_VERSION}\n"); for name in names { let (kind, base) = if let Some(base) = name.strip_prefix("Interface/AddOns/") { ("ADDON", base) } else { name.strip_prefix("Data/") .map_or(("ROOT", *name), |base| ("MPQ", base)) }; manifest.push_str(&format!( "{kind}:{base}\nSHA256:{}:{name}\n", fsx::sha256_file(&root.join(name)).unwrap() )); } fs::write(root.join(MANIFEST_FILENAME), manifest).unwrap(); } #[test] #[ignore = "Requires the 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 = 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 if let Some(name) = name.split("files/addons/").nth(1) { if !RACE_ADDONS.contains(&name) { continue; } format!("Interface/AddOns/{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] #[ignore = "Requires the downloaded release archives in the normal download cache"] fn release_archives_install_toggle_and_uninstall_in_a_disposable_client() { let temp = tempfile::tempdir().unwrap(); let root = temp.path(); fs::create_dir(root.join("Data")).unwrap(); fs::write(root.join("Ascension.exe"), b"original game executable").unwrap(); fs::write(root.join("Data/patch-T.MPQ"), b"original game patch").unwrap(); fs::write(root.join("Data/patch-user.MPQ"), b"unrelated user patch").unwrap(); install_client_patches(root, &Cancel::default(), &|_, _| {}).unwrap(); let status = client_patch_status(root); assert_eq!(status.version.as_deref(), Some(CLIENT_VERSION)); assert_eq!(status.state, ClientPatchState::Enabled); assert!(root.join("Data/patch-ZZZD.MPQ").is_file()); assert!(root .join("Interface/AddOns/CoAHideArmor/CoAHideArmor.lua") .is_file()); set_client_patch_enabled(root, false).unwrap(); assert_eq!(client_patch_status(root).state, ClientPatchState::Disabled); assert_eq!( fs::read(root.join("Ascension.exe")).unwrap(), b"original game executable" ); assert_eq!( fs::read(root.join("Data/patch-T.MPQ")).unwrap(), b"original game patch" ); set_client_patch_enabled(root, true).unwrap(); assert_eq!(client_patch_status(root).state, ClientPatchState::Enabled); uninstall_client_patches(root).unwrap(); assert_eq!( client_patch_status(root).state, ClientPatchState::NotInstalled ); assert_eq!( fs::read(root.join("Ascension.exe")).unwrap(), b"original game executable" ); assert_eq!( fs::read(root.join("Data/patch-T.MPQ")).unwrap(), b"original game patch" ); assert_eq!( fs::read(root.join("Data/patch-user.MPQ")).unwrap(), b"unrelated user patch" ); assert!(!root.join("Data/patch-ZZZD.MPQ").exists()); } #[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 = serde_json::from_str(include_str!("custom_races_hashes_1_5.json")).unwrap(); let current: std::collections::BTreeMap = 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 previous_release_uses_its_own_hashes_for_upgrade_and_removal() { let temp = tempfile::tempdir().unwrap(); fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.6\n").unwrap(); let legacy: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes_1_6.json")).unwrap(); let current: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes.json")).unwrap(); let files = patch_files(temp.path()).unwrap(); assert_eq!(files.len(), legacy.len()); assert_eq!( files .iter() .find(|file| file.path == "Data/patch-T.MPQ") .unwrap() .sha256, legacy["Data/patch-T.MPQ"] ); assert_ne!(legacy["Data/patch-T.MPQ"], current["Data/patch-T.MPQ"]); assert!(!files.iter().any(|file| file.path == "Data/patch-ZZW.MPQ")); assert!(legacy.keys().all(|key| current.contains_key(key))); } #[test] fn previous_appearance_release_keeps_its_hashes_and_requests_an_update() { let temp = tempfile::tempdir().unwrap(); fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.8\n").unwrap(); let legacy: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes_1_8.json")).unwrap(); let current: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes.json")).unwrap(); let files = patch_files(temp.path()).unwrap(); assert_eq!(files.len(), legacy.len()); for file in files { assert_eq!(file.sha256, legacy[&file.path]); } assert!(legacy.keys().all(|path| current.contains_key(path))); assert!(!legacy.contains_key("Data/patch-ZZZD.MPQ")); assert!(current.contains_key("Data/patch-ZZZD.MPQ")); let status = client_patch_status(temp.path()); assert_eq!(status.version.as_deref(), Some("1.8")); assert_eq!(status.state, ClientPatchState::PartiallyInstalled); } #[test] fn previous_racial_release_keeps_its_hashes_and_addon_paths_stay_inside_client() { let temp = tempfile::tempdir().unwrap(); fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.7\n").unwrap(); let legacy: std::collections::BTreeMap = serde_json::from_str(include_str!("custom_races_hashes_1_7.json")).unwrap(); let files = patch_files(temp.path()).unwrap(); assert_eq!(files.len(), legacy.len()); assert_eq!( files .iter() .find(|file| file.path == "Data/patch-ZZW.MPQ") .unwrap() .sha256, legacy["Data/patch-ZZW.MPQ"] ); assert!(!files.iter().any(|file| file.path == "Data/patch-ZZZ.MPQ")); fs::write( temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.8\nADDON:CoAWC2Cursor/CoAWC2Cursor.lua\n", ) .unwrap(); assert_eq!( patch_files(temp.path()).unwrap()[0].path, "Interface/AddOns/CoAWC2Cursor/CoAWC2Cursor.lua" ); fs::write( temp.path().join(MANIFEST_FILENAME), "ADDON:../../../outside\n", ) .unwrap(); assert!(patch_files(temp.path()).is_err()); } #[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 interrupted_patch_moves_restore_source_and_destination() { for existing in [false, true] { let temp = tempfile::tempdir().unwrap(); let root = temp.path(); let source = root.join("patch.MPQ"); let target = root.join("patch.MPQ.disabled"); fs::write(&source, b"patch bytes").unwrap(); if existing { fs::write(&target, b"previous destination").unwrap(); } let mut tx = PatchTransaction::new(root).unwrap(); tx.move_file(&source, &target).unwrap(); assert!(!source.exists()); assert_eq!(fs::read(&target).unwrap(), b"patch bytes"); // The source is moved, not copied into both the journal and destination. assert!(!root.join(".coa-races-transaction/1").exists()); std::mem::forget(tx); recover_patch_transaction(root).unwrap(); recover_patch_transaction(root).unwrap(); assert_eq!(fs::read(&source).unwrap(), b"patch bytes"); if existing { assert_eq!(fs::read(&target).unwrap(), b"previous destination"); } else { assert!(!target.exists()); } } } #[test] fn existing_backups_and_foreign_disabled_files_are_retained() { let temp = tempfile::tempdir().unwrap(); let root = temp.path(); let file = root.join("dinput8.dll"); fs::write(&file, b"custom").unwrap(); record_files(root, &["dinput8.dll"]); fs::write(suffix(&file, "disabled"), b"third party").unwrap(); fs::write(suffix(&file, "original"), b"original").unwrap(); set_client_patch_enabled(root, false).unwrap(); assert_eq!(fs::read(&file).unwrap(), b"original"); assert!(fs::read_dir(root) .unwrap() .flatten() .any(|entry| entry.file_name().to_string_lossy().contains("replaced-"))); fs::write(&file, b"updated original").unwrap(); set_client_patch_enabled(root, true).unwrap(); assert!(fs::read_dir(root).unwrap().flatten().any(|entry| entry .file_name() .to_string_lossy() .contains("original.previous-"))); } #[test] fn uninstall_moves_corrupted_custom_only_assets_out_of_the_active_client() { let temp = tempfile::tempdir().unwrap(); let root = temp.path(); fs::create_dir_all(root.join("Data")).unwrap(); let file = root.join("Data/patch-ZE1.MPQ"); fs::write(&file, b"custom").unwrap(); record_files(root, &["Data/patch-ZE1.MPQ"]); fs::write(&file, b"corrupted custom").unwrap(); uninstall_client_patches(root).unwrap(); assert!(!file.exists()); assert!(fs::read_dir(root.join("Data")) .unwrap() .flatten() .any(|entry| entry.file_name().to_string_lossy().contains("replaced-"))); assert_eq!( client_patch_status(root).state, ClientPatchState::NotInstalled ); } #[test] fn unknown_or_corrupt_bytes_are_not_reported_as_enabled() { let temp = tempfile::tempdir().unwrap(); let root = temp.path(); fs::create_dir_all(root.join("Data")).unwrap(); for name in RACE_MPQS { fs::write(root.join("Data").join(name), b"corrupt").unwrap(); } fs::write(root.join("dinput8.dll"), b"corrupt").unwrap(); fs::write( root.join(MANIFEST_FILENAME), format!("# CoA Custom {CLIENT_VERSION}\n"), ) .unwrap(); assert_eq!( client_patch_status(root).state, ClientPatchState::PartiallyInstalled ); } #[test] fn an_old_complete_installation_requires_an_update() { let temp = tempfile::tempdir().unwrap(); fs::create_dir_all(temp.path().join("Data")).unwrap(); for name in RACE_MPQS { fs::write(temp.path().join("Data").join(name), b"old patch").unwrap(); } fs::write(temp.path().join("dinput8.dll"), b"old runtime").unwrap(); fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.4\n").unwrap(); assert_eq!( client_patch_status(temp.path()).state, ClientPatchState::PartiallyInstalled ); } #[test] fn an_unpatched_client_is_left_untouched() { let temp = tempfile::tempdir().unwrap(); fs::create_dir_all(temp.path().join("Data")).unwrap(); fs::write(temp.path().join("Data/patch-T.MPQ"), b"original").unwrap(); set_client_patch_enabled(temp.path(), false).unwrap(); assert_eq!( fs::read(temp.path().join("Data/patch-T.MPQ")).unwrap(), b"original" ); } struct ArchiveTransport { body: Vec, ranges: std::sync::Mutex>, } impl crate::download::Transport for ArchiveTransport { fn get(&self, _: &str, from: u64) -> std::result::Result { self.ranges.lock().unwrap().push(from); Ok(crate::download::Reply { status: if from == 0 { 200 } else { 206 }, content_range: (from > 0) .then(|| format!("bytes {from}-{}/{}", self.body.len() - 1, self.body.len())), body: Box::new(io::Cursor::new(self.body[from as usize..].to_vec())), }) } } fn archive_fixture(root: &Path) -> (crate::download::Job, ArchiveTransport) { use sha2::{Digest, Sha256}; let body = b"verified archive bytes for recovery tests".to_vec(); let job = crate::download::Job { url: "https://example.invalid/patch.zip".into(), dest: root.join("cache/patch.zip"), sha256: hex::encode(Sha256::digest(&body)), size: body.len() as u64, }; fs::create_dir_all(job.dest.parent().unwrap()).unwrap(); ( job, ArchiveTransport { body, ranges: Default::default(), }, ) } #[test] fn download_uses_verified_user_archive_without_network() { let temp = tempfile::tempdir().unwrap(); let (job, transport) = archive_fixture(temp.path()); let downloads = temp.path().join("Downloads"); fs::create_dir(&downloads).unwrap(); let archive = downloads.join("patch.zip"); fs::write(&archive, &transport.body).unwrap(); let path = resolve_archive_with( &transport, &job, Some(&downloads), &Cancel::default(), &|_| {}, ) .unwrap(); assert_eq!(path, archive); assert!(transport.ranges.lock().unwrap().is_empty()); assert!(!job.dest.exists()); } #[test] fn download_skips_bad_user_archive_and_repairs_bad_cache() { let temp = tempfile::tempdir().unwrap(); let (job, transport) = archive_fixture(temp.path()); let downloads = temp.path().join("Downloads"); fs::create_dir(&downloads).unwrap(); let bad = vec![b'x'; transport.body.len()]; fs::write(downloads.join("patch.zip"), &bad).unwrap(); fs::write(downloads.join("patch.zip.part"), b"user browser download").unwrap(); fs::write(&job.dest, &bad).unwrap(); let path = resolve_archive_with( &transport, &job, Some(&downloads), &Cancel::default(), &|_| {}, ) .unwrap(); assert_eq!(path, job.dest); assert_eq!(fs::read(&path).unwrap(), transport.body); assert_eq!(fs::read(downloads.join("patch.zip")).unwrap(), bad); assert_eq!( fs::read(downloads.join("patch.zip.part")).unwrap(), b"user browser download" ); assert_eq!(*transport.ranges.lock().unwrap(), vec![0]); } #[test] fn download_resumes_leftover_part_and_verifies_complete_archive() { let temp = tempfile::tempdir().unwrap(); let (job, transport) = archive_fixture(temp.path()); let part = suffix(&job.dest, "part"); fs::write(&part, &transport.body[..9]).unwrap(); resolve_archive_with(&transport, &job, None, &Cancel::default(), &|_| {}).unwrap(); assert_eq!(*transport.ranges.lock().unwrap(), vec![9]); assert_eq!(fs::read(&job.dest).unwrap(), transport.body); assert!(!part.exists()); } #[test] fn download_reuses_good_cache_even_when_user_archive_is_incomplete() { let temp = tempfile::tempdir().unwrap(); let (job, transport) = archive_fixture(temp.path()); let downloads = temp.path().join("Downloads"); fs::create_dir(&downloads).unwrap(); fs::write(downloads.join("patch.zip"), b"incomplete").unwrap(); fs::write(&job.dest, &transport.body).unwrap(); let path = resolve_archive_with( &transport, &job, Some(&downloads), &Cancel::default(), &|_| {}, ) .unwrap(); assert_eq!(path, job.dest); assert!(transport.ranges.lock().unwrap().is_empty()); assert_eq!( fs::read(downloads.join("patch.zip")).unwrap(), b"incomplete" ); } #[test] fn download_restarts_once_when_resumed_prefix_is_corrupt() { let temp = tempfile::tempdir().unwrap(); let (job, transport) = archive_fixture(temp.path()); fs::write(suffix(&job.dest, "part"), b"bad").unwrap(); resolve_archive_with(&transport, &job, None, &Cancel::default(), &|_| {}).unwrap(); assert_eq!(*transport.ranges.lock().unwrap(), vec![3, 0]); assert_eq!(fs::read(&job.dest).unwrap(), transport.body); } #[test] fn download_promotes_completed_part_without_redownloading() { let temp = tempfile::tempdir().unwrap(); let (job, transport) = archive_fixture(temp.path()); fs::write(suffix(&job.dest, "part"), &transport.body).unwrap(); resolve_archive_with(&transport, &job, None, &Cancel::default(), &|_| {}).unwrap(); assert!(transport.ranges.lock().unwrap().is_empty()); assert_eq!(fs::read(&job.dest).unwrap(), transport.body); } #[test] fn download_stops_after_one_clean_retry_if_server_bytes_are_invalid() { let temp = tempfile::tempdir().unwrap(); let (job, mut transport) = archive_fixture(temp.path()); transport.body.fill(b'x'); let result = resolve_archive_with(&transport, &job, None, &Cancel::default(), &|_| {}); assert!(matches!(result, Err(Error::HashMismatch { .. }))); assert_eq!(*transport.ranges.lock().unwrap(), vec![0, 0]); assert!(!job.dest.exists()); assert!(!suffix(&job.dest, "part").exists()); } #[test] fn download_does_not_modify_an_archive_owned_by_another_download() { use fs4::fs_std::FileExt; let temp = tempfile::tempdir().unwrap(); let (job, transport) = archive_fixture(temp.path()); let lock = fs::OpenOptions::new() .read(true) .write(true) .create(true) .truncate(false) .open(suffix(&job.dest, "lock")) .unwrap(); lock.try_lock_exclusive().unwrap(); fs::write(suffix(&job.dest, "part"), b"active download").unwrap(); assert!(resolve_archive_with(&transport, &job, None, &Cancel::default(), &|_| {}).is_err()); assert_eq!( fs::read(suffix(&job.dest, "part")).unwrap(), b"active download" ); assert!(transport.ranges.lock().unwrap().is_empty()); } #[test] fn test_patch_status_and_toggle() { let temp = tempfile::tempdir().unwrap(); let client_path = temp.path(); let data_dir = client_path.join("Data"); fs::create_dir_all(&data_dir).unwrap(); // 1. Initial state: Not installed let st = client_patch_status(client_path); assert_eq!(st.state, ClientPatchState::NotInstalled); fs::write( client_path.join(MANIFEST_FILENAME), format!("# CoA Custom {CLIENT_VERSION}\n"), ) .unwrap(); // 2. Create MPQs and root files for mpq in RACE_MPQS { fs::write(data_dir.join(mpq), b"test mpq content").unwrap(); } fs::write(client_path.join("dinput8.dll"), b"test dll").unwrap(); fs::write(client_path.join("EsteriaAppearance.dll"), b"test dll").unwrap(); let names: Vec = 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::>(), ); let st = client_patch_status(client_path); assert_eq!(st.state, ClientPatchState::Enabled); assert_eq!(st.installed_mpqs, RACE_MPQS.len()); // 3. Disable patches set_client_patch_enabled(client_path, false).unwrap(); let st = client_patch_status(client_path); assert_eq!(st.state, ClientPatchState::Disabled); assert!(data_dir.join("patch-T.MPQ.disabled").is_file()); assert!(!data_dir.join("patch-T.MPQ").is_file()); assert!(client_path.join("dinput8.dll.disabled").is_file()); assert!(!client_path.join("dinput8.dll").is_file()); // 4. Re-enable patches set_client_patch_enabled(client_path, true).unwrap(); let st = client_patch_status(client_path); assert_eq!(st.state, ClientPatchState::Enabled); assert!(data_dir.join("patch-T.MPQ").is_file()); assert!(!data_dir.join("patch-T.MPQ.disabled").is_file()); assert!(client_path.join("dinput8.dll").is_file()); assert!(!client_path.join("dinput8.dll.disabled").is_file()); } #[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.Enabled = 1\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 = 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}" ); } } #[test] fn bot_race_sync_preserves_user_and_crashing_exclusions() { let temp = tempfile::tempdir().unwrap(); let conf = temp.path().join("Core/configs/modules/playerbots.conf"); fs::create_dir_all(conf.parent().unwrap()).unwrap(); for value in ["", "1,82,97", EXCLUDED_BOT_RACES_RECOMMENDED] { let original = format!("AiPlayerbot.ExcludedBotRaces = \"{value}\"\nAiPlayerbot.CrashingBotRaces = \"72,77,97\"\n"); fs::write(&conf, &original).unwrap(); sync_bot_races_config(temp.path(), true).unwrap(); assert_eq!(fs::read_to_string(&conf).unwrap(), original); sync_bot_races_config(temp.path(), false).unwrap(); assert_eq!(fs::read_to_string(&conf).unwrap(), original); } } }