diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..3b6df58 --- /dev/null +++ b/TODO.md @@ -0,0 +1,29 @@ +# TODO + +## UI / UX +- [x] **Предупреждение о несохранённых изменениях при переходе между вкладками (Unsaved Changes Guard / Modal)**: + - Если у пользователя есть несохранённые изменения в настройках (`ModulesPage`, `SettingsPage` — сервер, боты и др.) и он переходит на другую вкладку (в боковом меню `Shell.tsx` или кнопками навигации), показывать pop-up диалог подтверждения. + - Опции в диалоге: + - **Сохранить (Save)** — сохранить внесённые изменения и перейти на выбранную страницу. + - **Сбросить (Discard)** — отменить несохранённые изменения и перейти на выбранную страницу. + - **Отмена (Cancel)** — остаться на текущей странице с сохранением введённых данных. + - *Контекст:* Предотвратит случайную потерю настроек, когда пользователь меняет параметры модуля/сервера и сразу уходит на вкладку Overview для запуска сервера (см. [Issue #45](https://github.com/Corfirean/coa-server-manager/issues/45)). + +## Сервер и стабильность +- [x] **Автоподнятие сервера при падении (Auto-restart on crash) со счётчиком и расшифровкой крашей**: + - **Настройка:** Чекбокс «Автоматически перезапускать сервер при падении» в настройках сервера / менеджера. + - **Поведение автоподнятия:** + - Перезапускать процесс сервера только если падение произошло внезапно (процесс завершился с ненулевым exit code, крашем или без команды от менеджера). + - Если пользователь нажал кнопку «Стоп» (Stop Server), сервер останавливается полностью, автоподнятие не срабатывает. + - Защита от бесконечного цикла крашей (Crash Loop Protection): если за короткий интервал (например, 2-3 минуты) сервер падает более 3-5 раз, автоподнятие временно прекращается, а в UI выводится критическое оповещение. + - **Счётчик падений в интерфейсе:** + - Рядом со статусом сервера (или в шапке/панели состояния) показывать бейдж со счётчиком крашей с момента старта (например: `Крашей: 2`). + - При клике на счётчик открывать окно / модалку со списком последних падений с точным временем. + - **Расшифровка причин краша (Crash Explanation Engine):** + - *Как парсить и определять причину:* + 1. Читать свежий текстовый файл из `Core/Crashes/_worldserver.exe_[date].txt`. + 2. Смотреть `Exception code` (например, `C0000005` — нарушение доступа к памяти/access violation, `C0000420` — сработавший assert ядра, `C00000FD` — переполнение стека, `E06D7363` — исключение C++ / std::bad_alloc). + 3. При `C0000420` парсить блок `ASSERTION FAILED` (`Location`, `Function`, `Condition`). + 4. Анализировать последние строки `Core/Logs/Server.log` и `Errors.log` на критические маркеры (потеря соединения с MySQL, нехватка RAM/OOM, ошибка бинда портов). + 5. Проверять по встроенному словарю известных сигнатур (паттерны частых крашей с понятным описанием, например: «Сбой удаления объекта из сетки карты», «Ошибка запроса к базе данных», «Нехватка оперативной памяти»). + - *Fallback:* Если сигнатура не опознана в словаре известных проблем, показывать краткую техническую выжимку (код исключения + сработавший ассерт или вершина Call Stack) и кнопку разворота полного текста крашлога / копирования. diff --git a/changelog.d/20261005-linux-install-screen-and-client.md b/changelog.d/20261005-linux-install-screen-and-client.md new file mode 100644 index 0000000..c3d1db7 --- /dev/null +++ b/changelog.d/20261005-linux-install-screen-and-client.md @@ -0,0 +1,7 @@ +--- +area: manager +type: added +audience: admins +title: Linux: install from the install screen, play with Wine or Proton (experimental) +--- +Experimental. The install screen offers Docker installs on Linux, realm profiles and the Play button work on a Docker server, and updates are not offered for it. diff --git a/changelog.d/20261008-database-error-not-misread.md b/changelog.d/20261008-database-error-not-misread.md new file mode 100644 index 0000000..e98b252 --- /dev/null +++ b/changelog.d/20261008-database-error-not-misread.md @@ -0,0 +1,7 @@ +--- +area: manager +type: fixed +audience: admins +title: A failing database update is no longer reported as "database not running" +--- +An SQL error whose message contained the number 2003, such as an out-of-range value, was shown as "The database is not running". The real error is now shown. diff --git a/changelog.d/20261010-custom-races-update.md b/changelog.d/20261010-custom-races-update.md new file mode 100644 index 0000000..0f51a5c --- /dev/null +++ b/changelog.d/20261010-custom-races-update.md @@ -0,0 +1,7 @@ +--- +area: manager +type: changed +audience: admins +title: Custom race client patches update to the latest races and appearances +--- +The module card offers an upgrade for older patches. Archive downloads are verified before installation. diff --git a/changelog.d/20261010-custom-races.md b/changelog.d/20261010-custom-races.md new file mode 100644 index 0000000..aee3bad --- /dev/null +++ b/changelog.d/20261010-custom-races.md @@ -0,0 +1,7 @@ +--- +area: manager +type: added +audience: admins +title: Custom races can be enabled and their client patches installed from Modules +--- +Install the custom race client assets from the module card, then enable the module and restart the server. diff --git a/changelog.d/20261010-unsaved-changes-and-crash-recovery.md b/changelog.d/20261010-unsaved-changes-and-crash-recovery.md new file mode 100644 index 0000000..47b8ea6 --- /dev/null +++ b/changelog.d/20261010-unsaved-changes-and-crash-recovery.md @@ -0,0 +1,7 @@ +--- +area: manager +type: added +audience: admins +title: Unsaved settings are protected and crashed servers can restart automatically +--- +The Manager asks before leaving unsaved settings. Optional automatic restart pauses after repeated crashes, and crash history explains common failures. diff --git a/crates/coa-core/src/client.rs b/crates/coa-core/src/client.rs index fd29000..ab40986 100644 --- a/crates/coa-core/src/client.rs +++ b/crates/coa-core/src/client.rs @@ -17,6 +17,9 @@ pub const ADDON_NAME: &str = "CoABotUI"; const EXECUTABLES: [&str; 3] = ["Ascension.exe", "Wow.exe", "WoW.exe"]; pub fn is_running(client: &Path) -> bool { + if crate::platform::flavor() == crate::platform::Flavor::Docker { + return crate::wine::is_running(client, &EXECUTABLES); + } EXECUTABLES.iter().any(|exe| { let path = client.join(exe); let path = dunce::canonicalize(&path).unwrap_or(path); @@ -408,6 +411,9 @@ pub fn install_addon(client: &Path, meta: &Path, source: &Path) -> Result<()> { pub fn launch(client: &Path) -> Result { let exe = find_exe(client).ok_or_else(|| Error::Invalid("The game client was not found.".into()))?; + if crate::platform::flavor() == crate::platform::Flavor::Docker { + return crate::wine::launch(client, exe); + } let child = Command::new(client.join(exe)).current_dir(client).spawn()?; Ok(child.id()) } diff --git a/crates/coa-core/src/crashes.rs b/crates/coa-core/src/crashes.rs new file mode 100644 index 0000000..2a94e73 --- /dev/null +++ b/crates/coa-core/src/crashes.rs @@ -0,0 +1,249 @@ +//! Crash log discovery and human-friendly explanation for worldserver crashes. + +use std::fs; +use std::path::{Path, PathBuf}; +use std::time::SystemTime; +use serde::{Deserialize, Serialize}; +use crate::error::Result; + +#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)] +pub struct CrashItem { + pub id: String, + pub timestamp_ms: u64, + pub date_str: String, + pub title: String, + pub explanation: String, + pub category: String, + pub exception_code: Option, + pub location: Option, + pub function: Option, + pub condition: Option, + pub preview: String, + pub full_log: String, +} + +/// Lists recent crash reports from `Core/Crashes`, sorted newest first. +pub fn list(root: &Path, limit: usize) -> Result> { + let dir = root.join("Core/Crashes"); + let mut files: Vec<(PathBuf, SystemTime)> = Vec::new(); + if let Ok(entries) = fs::read_dir(&dir) { + for entry in entries.flatten() { + let path = entry.path(); + if path.is_file() && path.extension().and_then(|e| e.to_str()) == Some("txt") { + let mtime = entry.metadata().and_then(|m| m.modified()).unwrap_or(SystemTime::UNIX_EPOCH); + files.push((path, mtime)); + } + } + } + files.sort_by_key(|(_, t)| std::cmp::Reverse(*t)); + files.truncate(limit.max(1)); + + let mut items = Vec::new(); + for (path, mtime) in files { + if let Ok(content) = fs::read_to_string(&path) { + let item = parse_crash_content(&path, mtime, &content); + items.push(item); + } + } + Ok(items) +} + +/// Parses crash report content and generates human-friendly titles and explanations. +pub fn parse_crash_content(path: &Path, mtime: SystemTime, content: &str) -> CrashItem { + let filename = path.file_name().unwrap_or_default().to_string_lossy().into_owned(); + let timestamp_ms = mtime.duration_since(SystemTime::UNIX_EPOCH).map(|d| d.as_millis() as u64).unwrap_or(0); + + let mut date_str = String::new(); + let mut exception_code = None; + let mut location = None; + let mut function = None; + let mut condition = None; + + let lines: Vec<&str> = content.lines().collect(); + + let mut in_assertion = false; + for line in &lines { + let trimmed = line.trim(); + if trimmed.starts_with("Date ") && date_str.is_empty() { + date_str = trimmed.to_string(); + } else if trimmed.starts_with("Exception code:") { + let parts: Vec<&str> = trimmed.split_whitespace().collect(); + if parts.len() >= 3 { + exception_code = Some(parts[2].to_string()); + } + } else if trimmed.contains(">> ASSERTION FAILED") { + in_assertion = true; + } else if in_assertion { + if trimmed.starts_with("# Location:") { + let loc = trimmed.trim_start_matches("# Location:").trim(); + let clean = loc.rsplit(['\\', '/']).take(2).collect::>(); + location = Some(if clean.len() == 2 { format!("{}/{}", clean[1], clean[0]) } else { loc.to_string() }); + } else if trimmed.starts_with("# Function:") { + function = Some(trimmed.trim_start_matches("# Function:").trim().to_string()); + } else if trimmed.starts_with("# Condition:") { + condition = Some(trimmed.trim_start_matches("# Condition:").trim().to_string()); + } else if trimmed.starts_with("#---") && condition.is_some() { + in_assertion = false; + } + } + } + + if date_str.is_empty() { + if let Some(pos) = filename.find("_[") { + if let Some(end) = filename[pos..].find(']') { + date_str = filename[pos + 2..pos + end].replace('_', " "); + } + } + } + + let (category, title, explanation) = explain(exception_code.as_deref(), function.as_deref(), condition.as_deref(), content); + + let preview_lines: Vec<&str> = lines.iter().take(25).copied().collect(); + let preview = preview_lines.join("\n"); + + CrashItem { + id: filename, + timestamp_ms, + date_str, + title, + explanation, + category, + exception_code, + location, + function, + condition, + preview, + full_log: content.to_string(), + } +} + +fn explain(code: Option<&str>, func: Option<&str>, cond: Option<&str>, full: &str) -> (String, String, String) { + let lower_full = full.to_lowercase(); + let lower_func = func.map(|f| f.to_lowercase()).unwrap_or_default(); + let lower_cond = cond.map(|c| c.to_lowercase()).unwrap_or_default(); + + if let Some(c) = code { + if c.eq_ignore_ascii_case("C0000420") { + if lower_func.contains("removefromgrid") || lower_cond.contains("isingrid") { + return ( + "assertion".into(), + "Сбой удаления сущности из сетки карты (Grid / Despawn)".into(), + "Сервер попытался выгрузить объект (игрока, NPC или бота), который уже не находился в сетке карты. Обычно происходит при резком разрыве соединения, телепортации или одновременном деспавне нескольких сущностей.".into(), + ); + } + if lower_func.contains("map::") || lower_func.contains("grid::") { + return ( + "assertion".into(), + "Ошибка обновления сетки игрового мира (Map Grid)".into(), + "Сбой при загрузке или обновлении клеток локации (Grid/Cell). Может быть вызван перемещением сущностей через границы чанков.".into(), + ); + } + if lower_func.contains("playerbot") || lower_func.contains("aiplayerbot") { + return ( + "assertion".into(), + "Ошибка в модуле ботов (Playerbots)".into(), + "Внутренний сбой в логике ИИ ботов (экипировка, заклинание или поиск пути).".into(), + ); + } + let cond_label = cond.unwrap_or("Assert condition failed"); + return ( + "assertion".into(), + format!("Сработала внутренняя проверка ядра ({cond_label})"), + format!("Сервер обнаружил нарушение целостности данных в функции {}. Выполнение было аварийно остановлено.", func.unwrap_or("неизвестно")), + ); + } else if c.eq_ignore_ascii_case("C0000005") { + return ( + "access_violation".into(), + "Нарушение доступа к памяти (Access Violation)".into(), + "Попытка чтения или записи по некорректному адресу памяти (разыменование null-указателя или освобождённого объекта).".into(), + ); + } else if c.eq_ignore_ascii_case("C00000FD") { + return ( + "stack_overflow".into(), + "Переполнение стека (Stack Overflow)".into(), + "Исчерпание стека вызовов, вызванное бесконечной рекурсией или слишком глубоким стеком вызовов функций.".into(), + ); + } else if c.eq_ignore_ascii_case("E06D7363") { + if lower_full.contains("bad_alloc") { + return ( + "out_of_memory".into(), + "Нехватка оперативной памяти (Out of Memory)".into(), + "Серверу не удалось выделить оперативную память (std::bad_alloc). Проверьте объем доступной RAM.".into(), + ); + } + return ( + "exception".into(), + "Необработанное исключение C++ (C++ Exception)".into(), + "Произошло критическое исключение C++, которое не было перехвачено ядром сервера.".into(), + ); + } + } + + if lower_full.contains("mysql server has gone away") || lower_full.contains("connection lost") { + return ( + "database".into(), + "Потеряна связь с базой данных (MySQL)".into(), + "Связь сервера с СУБД MySQL была прервана или служба базы данных упала.".into(), + ); + } + + if lower_full.contains("address already in use") || lower_full.contains("bind failed") { + return ( + "network".into(), + "Сетевой порт уже занят".into(), + "Порт мира, авторизации или базы данных уже занят другим приложением.".into(), + ); + } + + ( + "generic".into(), + "Непредвиденный сбой процесса сервера".into(), + "Процесс worldserver аварийно завершился. Детали и стек вызовов доступны в полном тексте отчёта.".into(), + ) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn parses_assertion_report() { + let report = r#"Revision: AzerothCore rev. df5bcdf26092 2026-10-02 22:08:42 +0500 (coa-bots branch) (Win64, RelWithDebInfo, Static) +Date 3:10:2026. Time 20:20 +//===================================================== +Exception code: C0000420 Ein Assertionsfehler ist aufgetreten. + +Assertion message: #----------------------------------------------------------------------# + +>> ASSERTION FAILED + +# Location: D:\a\coa-server-build\src\server\game\Entities\Object\Object.h:376 +# Function: GridObject::RemoveFromGrid +# Condition: IsInGrid() + +#----------------------------------------------------------------------# + +Fault address: 00007FF7ECD3645E +"#; + let item = parse_crash_content(Path::new("dummy_worldserver.exe_[3-10_20-20-51].txt"), SystemTime::UNIX_EPOCH, report); + println!("ITEM: {item:#?}"); + assert_eq!(item.exception_code.as_deref(), Some("C0000420")); + assert_eq!(item.category, "assertion"); + assert_eq!(item.condition.as_deref(), Some("IsInGrid()")); + assert_eq!(item.function.as_deref(), Some("GridObject::RemoveFromGrid")); + assert!(item.title.contains("Grid")); + assert!(item.explanation.contains("сетке карты")); + } + + #[test] + fn parses_access_violation() { + let report = r#"Date 4:10:2026. Time 12:00 +Exception code: C0000005 ACCESS_VIOLATION +Fault address: 00007FF7ECD3645E +"#; + let item = parse_crash_content(Path::new("crash.txt"), SystemTime::UNIX_EPOCH, report); + assert_eq!(item.exception_code.as_deref(), Some("C0000005")); + assert_eq!(item.category, "access_violation"); + assert!(item.title.contains("Access Violation")); + } +} diff --git a/crates/coa-core/src/custom_races.rs b/crates/coa-core/src/custom_races.rs new file mode 100644 index 0000000..c675e4d --- /dev/null +++ b/crates/coa-core/src/custom_races.rs @@ -0,0 +1,541 @@ +//! Management of client-side patches and assets for Custom Races. +//! +//! Handles detecting, enabling/disabling (via `.disabled` extension renaming), +//! and downloading/extracting client patches (Esteria and additional races) +//! into the player's WoW client directory. + +use std::fs::{self, File}; +use std::io::{self, Read, Write}; +use std::path::{Path, PathBuf}; + +use serde::{Deserialize, Serialize}; + +use crate::download::Cancel; +use crate::error::{Error, Result}; +use crate::fsx; + +pub const CLIENT_VERSION: &str = "1.5"; +pub const MANIFEST_FILENAME: &str = "custom_races_patch_manifest.txt"; +pub const ARCHIVES: &[(&str, &str)] = &[ + ( + "CoA-Custom-1.5-main-20261009-cb2a0ca4.zip", + "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-main-20261009-cb2a0ca4.zip", + ), + ( + "CoA-Custom-1.5-client-part1.zip", + "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-client-part1.zip", + ), + ( + "CoA-Custom-1.5-client-part2.zip", + "https://github.com/ilusixn/azerothcore-wotlk-coa/releases/download/coa-custom-1.5/CoA-Custom-1.5-client-part2.zip", + ), +]; + +pub const RACE_MPQS: &[&str] = &[ + "patch-T.MPQ", + "patch-ZE1.MPQ", + "patch-ZE2.MPQ", + "patch-ZE3.MPQ", + "patch-ZE5.MPQ", + "patch-ZE6.MPQ", + "patch-ZE7.MPQ", + "patch-ZE8.MPQ", + "patch-ZE9.MPQ", + "patch-ZEA.MPQ", + "patch-ZG.MPQ", + "patch-ZH.MPQ", + "patch-ZHA.MPQ", + "patch-ZHM.MPQ", + "patch-ZM.MPQ", + "patch-ZVU.MPQ", + "patch-ZES.MPQ", + "patch-ZJ.MPQ", + "patch-ZZE.MPQ", + "patch-ZZR.MPQ", +]; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)] +#[serde(rename_all = "kebab-case")] +pub enum ClientPatchState { + NotInstalled, + Enabled, + Disabled, + PartiallyInstalled, +} + +#[derive(Debug, Clone, Serialize, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct ClientPatchStatus { + pub state: ClientPatchState, + pub installed_mpqs: usize, + pub total_mpqs: usize, + pub has_root_files: bool, + pub client_path: Option, +} + +/// Inspect the client folder and determine the state of custom races patches. +pub fn client_patch_status(client_path: &Path) -> ClientPatchStatus { + let data_dir = client_path.join("Data"); + let mut enabled_count = 0; + let mut disabled_count = 0; + + for mpq in RACE_MPQS { + if data_dir.join(format!("{mpq}.disabled")).is_file() { + disabled_count += 1; + } else if data_dir.join(mpq).is_file() { + enabled_count += 1; + } + } + + let has_root = client_path.join("EsteriaAppearance.dll").is_file() + || client_path.join("dinput8.dll").is_file() + || client_path.join("dinput8.dll.disabled").is_file(); + + let total = RACE_MPQS.len(); + let current_version = fs::read_to_string(client_path.join(MANIFEST_FILENAME)).ok() + .is_some_and(|manifest| manifest.lines().any(|line| line == format!("# CoA Custom {CLIENT_VERSION}"))); + let state = if enabled_count == total && current_version && client_path.join("dinput8.dll").is_file() { + ClientPatchState::Enabled + } else if disabled_count == total && current_version && client_path.join("dinput8.dll.disabled").is_file() { + ClientPatchState::Disabled + } else if (enabled_count + disabled_count) > 0 { + ClientPatchState::PartiallyInstalled + } else { + ClientPatchState::NotInstalled + }; + + ClientPatchStatus { + state, + installed_mpqs: enabled_count + disabled_count, + total_mpqs: total, + has_root_files: has_root, + client_path: Some(client_path.to_string_lossy().into_owned()), + } +} + +/// Enable or disable client patches by renaming MPQs and `dinput8.dll` with `.disabled`. +pub fn set_client_patch_enabled(client_path: &Path, enabled: bool) -> Result<()> { + if !client_path.is_dir() { + return Err(Error::Invalid("Game client directory not found.".into())); + } + + if crate::client::is_running(client_path) { + return Err(Error::Invalid("Close the game before changing custom races patches.".into())); + } + if !client_path.join(MANIFEST_FILENAME).is_file() + && !RACE_MPQS.iter().skip(1).any(|name| client_path.join("Data").join(name).is_file() + || client_path.join("Data").join(format!("{name}.disabled")).is_file()) { + return Ok(()); + } + let mut paths: Vec = RACE_MPQS.iter().map(|name| client_path.join("Data").join(name)).collect(); + if let Ok(manifest) = fs::read_to_string(client_path.join(MANIFEST_FILENAME)) { + for line in manifest.lines() { + if let Some(name) = line.strip_prefix("MPQ:") { + if name.contains(['/', '\\']) || !name.to_ascii_lowercase().ends_with(".mpq") { + return Err(Error::Invalid("Invalid custom races patch manifest.".into())); + } + paths.push(fsx::safe_join(&client_path.join("Data"), name)?); + } + } + } + paths.sort(); + paths.dedup(); + paths.push(client_path.join("dinput8.dll")); + paths.push(client_path.join("Ascension.exe")); + for active in paths { + let disabled = active.with_extension(format!("{}.disabled", active.extension().unwrap_or_default().to_string_lossy())); + let original = active.with_extension(format!("{}.original", active.extension().unwrap_or_default().to_string_lossy())); + if enabled && disabled.is_file() { + if active.is_file() { + if !original.is_file() { + return Err(Error::Invalid(format!("Cannot replace existing {} without an original backup.", active.display()))); + } + fs::remove_file(&active)?; + } + fs::rename(&disabled, &active)?; + } else if !enabled && active.is_file() && !disabled.is_file() { + if active.file_name().is_some_and(|name| name == "Ascension.exe") && !original.is_file() { + continue; + } + fs::rename(&active, &disabled)?; + if original.is_file() { + fs::copy(&original, &active)?; + } + } + } + + tracing::info!(enabled, "custom races client patches toggled"); + Ok(()) +} + +fn verify_archive(path: &Path, filename: &str) -> Result<()> { + let expected = match filename { + "CoA-Custom-1.5-main-20261009-cb2a0ca4.zip" => "117f5d99add18191676be6648fb0f2e99019a06c18705c71454e371e7df2afd2", + "CoA-Custom-1.5-client-part1.zip" => "19eb372805b3268653914da03377d67f056e5b50d818a8a06a5f260aad03211e", + "CoA-Custom-1.5-client-part2.zip" => "122f2882da255913e01610e33c6446ded897fecbe60b6d5ee026149becf8f278", + _ => return Err(Error::Invalid("Unknown custom races archive.".into())), + }; + if fsx::sha256_file(path)? != expected { + return Err(Error::Invalid(format!("Custom races archive {filename} failed verification. Remove it and try again."))); + } + Ok(()) +} + +/// Locate an archive locally in Downloads or cache, or download it from GitHub. +fn resolve_or_download_archive( + filename: &str, + url: &str, + client: &reqwest::blocking::Client, + cancel: &Cancel, + report: &dyn Fn(&str, f32), + base_percent: f32, + percent_slice: f32, +) -> Result { + // 1. Check user Downloads folder + if let Some(userprofile) = std::env::var_os("USERPROFILE") { + let downloads = PathBuf::from(userprofile).join("Downloads"); + let candidate = downloads.join(filename); + if candidate.is_file() { + if let Ok(meta) = candidate.metadata() { + if meta.len() > 1000 { + tracing::info!(path = %candidate.display(), "using existing archive in Downloads"); + verify_archive(&candidate, filename)?; + return Ok(candidate); + } + } + } + } + + // 2. Check temp / cache directory + let cache_dir = std::env::temp_dir().join("coa-client-races"); + fs::create_dir_all(&cache_dir)?; + let target = cache_dir.join(filename); + if target.is_file() { + if let Ok(meta) = target.metadata() { + if meta.len() > 1000 { + verify_archive(&target, filename)?; + return Ok(target); + } + } + } + + // 3. Download from GitHub Releases + report(&format!("Downloading {filename}..."), base_percent); + let part_path = cache_dir.join(format!("{filename}.part")); + + let resp = client + .get(url) + .send() + .map_err(|e| Error::NetworkUnreachable(format!("Could not reach download server: {e}")))?; + + if !resp.status().is_success() { + return Err(Error::NetworkUnreachable(format!( + "Download failed with status {} for {url}", + resp.status() + ))); + } + + let total_bytes = resp.content_length().unwrap_or(0); + let mut downloaded = 0u64; + let mut src = resp; + let mut dst = File::create(&part_path)?; + + let mut buf = [0u8; 64 * 1024]; + let mut last_report = std::time::Instant::now(); + + loop { + if cancel.is_set() { + let _ = fs::remove_file(&part_path); + return Err(Error::Invalid("Operation cancelled.".into())); + } + + let n = src + .read(&mut buf) + .map_err(|e| Error::NetworkUnreachable(format!("Download interrupted: {e}")))?; + if n == 0 { + break; + } + + dst.write_all(&buf[..n])?; + downloaded += n as u64; + + if last_report.elapsed() > std::time::Duration::from_millis(200) { + let ratio = if total_bytes > 0 { + (downloaded as f32 / total_bytes as f32).clamp(0.0, 1.0) + } else { + 0.5 + }; + report( + &format!( + "Downloading {filename} ({:.1} MB)...", + downloaded as f64 / 1_048_576.0 + ), + base_percent + ratio * percent_slice, + ); + last_report = std::time::Instant::now(); + } + } + + dst.flush()?; + drop(dst); + + verify_archive(&part_path, filename)?; + fs::rename(&part_path, &target)?; + Ok(target) +} + +/// Download (if needed) and extract custom races client assets into the target WoW client. +pub fn install_client_patches( + client_path: &Path, + cancel: &Cancel, + report: &dyn Fn(&str, f32), +) -> Result<()> { + if !client_path.is_dir() { + return Err(Error::Invalid("Game client directory does not exist.".into())); + } + + if crate::client::is_running(client_path) { + return Err(Error::Invalid("Close the game before installing custom races patches.".into())); + } + let data_dir = client_path.join("Data"); + fs::create_dir_all(&data_dir)?; + + // 1. Back up original Ascension.exe and patch-T.MPQ if they exist and haven't been backed up yet + let exe = client_path.join("Ascension.exe"); + let exe_bak = client_path.join("Ascension.exe.original"); + if exe.is_file() && !exe_bak.is_file() { + report("Backing up original Ascension.exe...", 0.02); + fs::copy(&exe, &exe_bak)?; + } + + let t_mpq = data_dir.join("patch-T.MPQ"); + let t_mpq_bak = data_dir.join("patch-T.MPQ.original"); + if t_mpq.is_file() && !t_mpq_bak.is_file() { + report("Backing up original patch-T.MPQ...", 0.04); + fs::copy(&t_mpq, &t_mpq_bak)?; + } + + let dll = client_path.join("dinput8.dll"); + let dll_backup = client_path.join("dinput8.dll.original"); + if dll.is_file() && !dll_backup.is_file() { + fs::copy(&dll, &dll_backup)?; + } + + // 2. Resolve/download archives (0.05 .. 0.50) + let http = reqwest::blocking::Client::builder() + .user_agent(concat!("CoA-Server-Manager/", env!("CARGO_PKG_VERSION"))) + .timeout(std::time::Duration::from_secs(600)) + .build() + .map_err(|e| Error::Invalid(format!("Cannot prepare downloader: {e}")))?; + + let mut resolved_archives = Vec::new(); + let n_archives = ARCHIVES.len() as f32; + for (i, (fname, url)) in ARCHIVES.iter().enumerate() { + let base_pct = 0.05 + (i as f32 / n_archives) * 0.45; + let slice = 0.45 / n_archives; + let archive_path = + resolve_or_download_archive(fname, url, &http, cancel, report, base_pct, slice)?; + resolved_archives.push(archive_path); + } + + // 3. Extract archives (0.50 .. 0.95) + let mut installed_mpqs = Vec::new(); + let mut installed_roots = Vec::new(); + + for (i, arch_path) in resolved_archives.iter().enumerate() { + if cancel.is_set() { + return Err(Error::Invalid("Operation cancelled.".into())); + } + + let arch_name = arch_path + .file_name() + .map(|n| n.to_string_lossy().into_owned()) + .unwrap_or_default(); + report( + &format!("Unpacking {arch_name}..."), + 0.50 + (i as f32 / n_archives) * 0.45, + ); + + let file = File::open(arch_path)?; + let mut zip = zip::ZipArchive::new(file) + .map_err(|e| Error::Invalid(format!("Failed to open zip {arch_name}: {e}")))?; + + let num_files = zip.len(); + for file_idx in 0..num_files { + if cancel.is_set() { + return Err(Error::Invalid("Operation cancelled.".into())); + } + + let mut zfile = zip + .by_index(file_idx) + .map_err(|e| Error::Invalid(format!("Zip entry error in {arch_name}: {e}")))?; + + if zfile.is_dir() { + continue; + } + + let zname = zfile.name().to_string(); + let zname_norm = zname.replace('\\', "/"); + + if zname_norm.contains("files/client/") { + let base = Path::new(&zname_norm) + .file_name() + .map(|n| n.to_string_lossy().into_owned()) + .unwrap_or_default(); + + if base.to_ascii_lowercase().ends_with(".mpq") { + let dest = data_dir.join(&base); + let mut out = File::create(&dest)?; + io::copy(&mut zfile, &mut out)?; + let disabled = data_dir.join(format!("{base}.disabled")); + if disabled.is_file() { fs::remove_file(disabled)?; } + installed_mpqs.push(base); + } else if base.eq_ignore_ascii_case("dinput8.dll") { + let dest = client_path.join(&base); + let mut out = File::create(&dest)?; + io::copy(&mut zfile, &mut out)?; + let disabled = client_path.join(format!("{base}.disabled")); + if disabled.is_file() { fs::remove_file(disabled)?; } + installed_roots.push(base); + } + } else if zname_norm.contains("files/client_root/") { + let base = Path::new(&zname_norm) + .file_name() + .map(|n| n.to_string_lossy().into_owned()) + .unwrap_or_default(); + + if !base.is_empty() { + let dest = client_path.join(&base); + let mut out = File::create(&dest)?; + io::copy(&mut zfile, &mut out)?; + let disabled = client_path.join(format!("{base}.disabled")); + if disabled.is_file() { fs::remove_file(disabled)?; } + installed_roots.push(base); + } + } + } + } + + if !RACE_MPQS.iter().all(|name| installed_mpqs.iter().any(|installed| installed == name)) { + return Err(Error::Invalid("Custom races archives are missing required client patches.".into())); + } + + // 4. Record manifest + report("Finalizing manifest...", 0.98); + let manifest_path = client_path.join(MANIFEST_FILENAME); + installed_mpqs.sort(); + installed_mpqs.dedup(); + installed_roots.sort(); + installed_roots.dedup(); + + let mut manifest_body = format!("# CoA Custom {CLIENT_VERSION}\n# Custom Race MPQ files\n"); + for m in &installed_mpqs { + manifest_body.push_str(&format!("MPQ:{m}\n")); + } + manifest_body.push_str("# Custom Race root files\n"); + for r in &installed_roots { + manifest_body.push_str(&format!("ROOT:{r}\n")); + } + + fsx::atomic_write(&manifest_path, manifest_body.as_bytes())?; + report("Custom races client patches installed successfully!", 1.0); + tracing::info!( + mpqs = installed_mpqs.len(), + roots = installed_roots.len(), + "custom races client patch installation complete" + ); + + Ok(()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn disabling_restores_original_client_files_and_enabling_restores_custom_files() { + let temp = tempfile::tempdir().unwrap(); + let data = temp.path().join("Data"); + fs::create_dir_all(&data).unwrap(); + for path in [data.join("patch-T.MPQ"), temp.path().join("Ascension.exe"), temp.path().join("dinput8.dll")] { + fs::write(&path, b"custom").unwrap(); + let backup = path.with_extension(format!("{}.original", path.extension().unwrap().to_string_lossy())); + fs::write(&backup, b"original").unwrap(); + } + fs::write(temp.path().join(MANIFEST_FILENAME), "MPQ:patch-T.MPQ\n").unwrap(); + set_client_patch_enabled(temp.path(), false).unwrap(); + assert_eq!(fs::read(data.join("patch-T.MPQ")).unwrap(), b"original"); + assert_eq!(fs::read(temp.path().join("Ascension.exe")).unwrap(), b"original"); + set_client_patch_enabled(temp.path(), true).unwrap(); + assert_eq!(fs::read(data.join("patch-T.MPQ")).unwrap(), b"custom"); + assert_eq!(fs::read(temp.path().join("Ascension.exe")).unwrap(), b"custom"); + } + + #[test] + fn an_old_complete_installation_requires_an_update() { + let temp = tempfile::tempdir().unwrap(); + fs::create_dir_all(temp.path().join("Data")).unwrap(); + for name in RACE_MPQS { fs::write(temp.path().join("Data").join(name), b"old patch").unwrap(); } + fs::write(temp.path().join("dinput8.dll"), b"old runtime").unwrap(); + fs::write(temp.path().join(MANIFEST_FILENAME), "# CoA Custom 1.4\n").unwrap(); + assert_eq!(client_patch_status(temp.path()).state, ClientPatchState::PartiallyInstalled); + } + + #[test] + fn an_unpatched_client_is_left_untouched() { + let temp = tempfile::tempdir().unwrap(); + fs::create_dir_all(temp.path().join("Data")).unwrap(); + fs::write(temp.path().join("Data/patch-T.MPQ"), b"original").unwrap(); + set_client_patch_enabled(temp.path(), false).unwrap(); + assert_eq!(fs::read(temp.path().join("Data/patch-T.MPQ")).unwrap(), b"original"); + } + + #[test] + fn corrupt_downloads_are_rejected() { + let temp = tempfile::NamedTempFile::new().unwrap(); + fs::write(temp.path(), b"corrupt archive").unwrap(); + assert!(verify_archive(temp.path(), ARCHIVES[0].0).is_err()); + } + + #[test] + fn test_patch_status_and_toggle() { + let temp = tempfile::tempdir().unwrap(); + let client_path = temp.path(); + let data_dir = client_path.join("Data"); + fs::create_dir_all(&data_dir).unwrap(); + + // 1. Initial state: Not installed + let st = client_patch_status(client_path); + assert_eq!(st.state, ClientPatchState::NotInstalled); + + fs::write(client_path.join(MANIFEST_FILENAME), format!("# CoA Custom {CLIENT_VERSION}\n")).unwrap(); + // 2. Create MPQs and root files + for mpq in RACE_MPQS { + fs::write(data_dir.join(mpq), b"test mpq content").unwrap(); + } + fs::write(client_path.join("dinput8.dll"), b"test dll").unwrap(); + fs::write(client_path.join("EsteriaAppearance.dll"), b"test dll").unwrap(); + + let st = client_patch_status(client_path); + assert_eq!(st.state, ClientPatchState::Enabled); + assert_eq!(st.installed_mpqs, RACE_MPQS.len()); + + // 3. Disable patches + set_client_patch_enabled(client_path, false).unwrap(); + let st = client_patch_status(client_path); + assert_eq!(st.state, ClientPatchState::Disabled); + assert!(data_dir.join("patch-T.MPQ.disabled").is_file()); + assert!(!data_dir.join("patch-T.MPQ").is_file()); + assert!(client_path.join("dinput8.dll.disabled").is_file()); + assert!(!client_path.join("dinput8.dll").is_file()); + + // 4. Re-enable patches + set_client_patch_enabled(client_path, true).unwrap(); + let st = client_patch_status(client_path); + assert_eq!(st.state, ClientPatchState::Enabled); + assert!(data_dir.join("patch-T.MPQ").is_file()); + assert!(!data_dir.join("patch-T.MPQ.disabled").is_file()); + assert!(client_path.join("dinput8.dll").is_file()); + assert!(!client_path.join("dinput8.dll.disabled").is_file()); + } +} diff --git a/crates/coa-core/src/db.rs b/crates/coa-core/src/db.rs index 61af1cd..48f8466 100644 --- a/crates/coa-core/src/db.rs +++ b/crates/coa-core/src/db.rs @@ -256,19 +256,23 @@ impl Db { fn fail(&self, stderr: &[u8]) -> Error { let text = String::from_utf8_lossy(stderr); - let down = text.contains("2003") - || text.contains("Can't connect") - || text.contains("is not running") - || text.contains("No such container"); + // Only the client's own connection errors mean "not running": the number 2003 or the words can also appear inside + // the message of an ordinary SQL error (a duplicate entry, a row number) and must not hide it. + let down = text.contains("ERROR 2003") + || text.contains("ERROR 2002") + || text.contains("Can't connect to MySQL server") + || text.contains("No such container") + || text.contains("is not running"); let code = if down { ErrorCode::DatabaseNotRunning } else { ErrorCode::Unknown }; match code { - ErrorCode::DatabaseNotRunning => { - Error::Invalid("The database is not running. Start the server first.".into()) - } + ErrorCode::DatabaseNotRunning => Error::Invalid(format!( + "The database is not running. Start the server first. ({})", + text.trim().lines().last().unwrap_or("").chars().take(300).collect::() + )), _ => Error::Invalid(format!( "database command failed: {}", text.trim().lines().last().unwrap_or("") diff --git a/crates/coa-core/src/docker/lifecycle.rs b/crates/coa-core/src/docker/lifecycle.rs index acecb88..63a86ea 100644 --- a/crates/coa-core/src/docker/lifecycle.rs +++ b/crates/coa-core/src/docker/lifecycle.rs @@ -263,6 +263,10 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L return Ok(()); } + // Realm profiles (CoA / Wildcard): the database is running and healthy here (started and waited for above), which the + // realm list update below needs. Finish an interrupted switch, then make the realm list say what is selected. The repack's + // launcher did this when it started; here nothing else would. + let realm = prepare_realm(root, log)?; ensure_image(d, log)?; super::ensure_main_configs(root).map_err(|e| Failure { code: ErrorCode::ServerFilesIncomplete, @@ -289,7 +293,7 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L ports.ra, owner.as_deref(), ); - call.env = database_env(&secrets, true); + call.env = database_env(&secrets, true, realm); run_container(d, &call, &n.world, log)?; } wait_listening(d, cfg, &n.world, ports.world, WORLD_WAIT, log)?; @@ -307,7 +311,7 @@ fn start(d: &dyn Docker, root: &Path, cfg: &Config, with_game: bool, log: &mut L 0, owner.as_deref(), ); - call.env = database_env(&secrets, false); + call.env = database_env(&secrets, false, realm); run_container(d, &call, &n.auth, log)?; } wait_listening(d, cfg, &n.auth, ports.auth, AUTH_WAIT, log)?; @@ -489,19 +493,35 @@ enum GameKind { } /// Connection strings: host;port;user;password;database. They hold the password, so they travel by environment. -fn database_env(s: &Secrets, world: bool) -> Vec<(String, String)> { +fn database_env(s: &Secrets, world: bool, realm: crate::realms::Mode) -> Vec<(String, String)> { let info = |db: &str| format!("db;3306;acore;{};{db}", s.app); let mut env = vec![("AC_LOGIN_DATABASE_INFO".to_string(), info("acore_auth"))]; if world { - env.push(("AC_WORLD_DATABASE_INFO".into(), info("acore_world"))); - env.push(( - "AC_CHARACTER_DATABASE_INFO".into(), - info("acore_characters"), - )); + // The databases of the selected realm (the Wildcard realm has its own world and characters databases). + let schema = |kind: &str| realm.schema(kind).unwrap_or("acore_world"); + env.push(("AC_WORLD_DATABASE_INFO".into(), info(schema("world")))); + env.push(("AC_CHARACTER_DATABASE_INFO".into(), info(schema("characters")))); } env } +/// 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 { + let fail_with = |e: crate::error::Error| Failure { + code: ErrorCode::StartupFailed, + output: e.to_string(), + }; + crate::realms::before_start(root).map_err(fail_with)?; + let active = crate::realms::state(root).map_err(fail_with)?.active; + if root.join("Settings/realm-profile.json").exists() { + crate::realms::setup_realmlist(root).map_err(fail_with)?; + let db = crate::db::Db::from_repack(root, crate::db::Account::Admin).map_err(fail_with)?; + db.query("UPDATE acore_auth.realmlist SET name='Conquest of Azeroth' WHERE id=1; UPDATE acore_auth.realmlist SET name='Wildcard' WHERE id=2;").map_err(fail_with)?; + log.say(format!("realm {}", active.name())); + } + Ok(active) +} + fn game_args( cfg: &Config, n: &Names, @@ -572,6 +592,10 @@ fn game_args( a.extend(env("AC_UPDATES_ENABLE_DATABASES", "0")); if kind == GameKind::World { a.extend(["--volume".into(), format!("{}:{DATA}:ro", data.display())]); + let races = host.join("Data/dbc_races"); + if races.is_dir() && races != data.join("dbc_races") { + a.extend(["--volume".into(), format!("{}:{DATA}/dbc_races:ro", races.display())]); + } a.extend(env("AC_DATA_DIR", DATA)); // The remote console is only ever reachable from this computer. a.extend(["--publish".into(), format!("127.0.0.1:{ra_port}:{RA_PORT}")]); @@ -1089,6 +1113,22 @@ mod tests { .any(|a| a == "--lower-case-table-names=1" || a == "--user")); } + #[test] + fn the_containers_use_the_databases_of_the_selected_realm() { + let s = Secrets { root: "r".into(), app: "apppw".into() }; + let get = |env: &[(String, String)], k: &str| env.iter().find(|(n, _)| n == k).map(|(_, v)| v.clone()); + let coa = database_env(&s, true, crate::realms::Mode::Coa); + assert_eq!(get(&coa, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world"); + assert_eq!(get(&coa, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters"); + let wild = database_env(&s, true, crate::realms::Mode::Wildcard); + assert_eq!(get(&wild, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world_wildcard"); + assert_eq!(get(&wild, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters_wildcard"); + // Accounts are shared by both realms; the auth server never sees the others. + assert_eq!(get(&wild, "AC_LOGIN_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_auth"); + let auth = database_env(&s, false, crate::realms::Mode::Wildcard); + assert_eq!(auth.len(), 1); + } + #[test] fn the_database_is_only_healthy_once_it_takes_tcp_connections() { let (_d, root) = server("t1"); diff --git a/crates/coa-core/src/lib.rs b/crates/coa-core/src/lib.rs index 2ba9151..3c86463 100644 --- a/crates/coa-core/src/lib.rs +++ b/crates/coa-core/src/lib.rs @@ -17,6 +17,8 @@ pub mod companions; pub mod config; pub mod console; pub mod control; +pub mod crashes; +pub mod custom_races; pub mod dashboard; pub mod db; pub mod diag; @@ -38,6 +40,7 @@ pub mod multiworld; pub mod net; pub mod package; pub mod pkgsource; +pub mod platform; pub mod population; pub mod portable; pub mod process; @@ -53,12 +56,12 @@ pub mod repair; pub mod report; pub mod schema_check; pub mod signing; +pub mod squid; pub mod srp6; pub mod update; pub mod upnp; +pub mod wine; pub use error::{Error, ErrorCode, Result}; pub const MANAGER_VERSION: &str = env!("CARGO_PKG_VERSION"); - -pub mod squid; diff --git a/crates/coa-core/src/modules.rs b/crates/coa-core/src/modules.rs index f61a54a..0bfac85 100644 --- a/crates/coa-core/src/modules.rs +++ b/crates/coa-core/src/modules.rs @@ -264,6 +264,18 @@ pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> { if on { crate::realms::guard_module(root, id)?; } + if id == "custom-races" { + if let Ok(meta_content) = fs::read_to_string(meta.join("install.json")) { + if let Ok(install_meta) = serde_json::from_str::(&meta_content) { + if let Some(cp) = install_meta.client_path { + let client_path = PathBuf::from(cp); + if client_path.is_dir() { + crate::custom_races::set_client_patch_enabled(&client_path, on)?; + } + } + } + } + } set_enabled_in(&catalog(), root, meta, id, on) } diff --git a/crates/coa-core/src/platform.rs b/crates/coa-core/src/platform.rs new file mode 100644 index 0000000..d943aaa --- /dev/null +++ b/crates/coa-core/src/platform.rs @@ -0,0 +1,41 @@ +//! Which kind of server a new installation is on this computer. This is the one place where the host decides: a Windows +//! computer installs a repack, anything else installs a Docker server. The screens and the commands ask here and then +//! call the code of that kind, so no platform check is scattered through shared code. + +use serde::Serialize; + +#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)] +#[serde(rename_all = "kebab-case")] +pub enum Flavor { + /// The CoA Repack: Windows executables supervised by the repack's launcher. + Repack, + /// MySQL, the auth server and the world server in Docker containers. + Docker, +} + +pub fn flavor() -> Flavor { + if cfg!(windows) { + Flavor::Repack + } else { + Flavor::Docker + } +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn the_host_decides_once() { + #[cfg(windows)] + assert_eq!(flavor(), Flavor::Repack); + #[cfg(not(windows))] + assert_eq!(flavor(), Flavor::Docker); + } + + #[test] + fn the_screens_read_the_flavor_as_a_plain_word() { + assert_eq!(serde_json::to_string(&Flavor::Repack).unwrap(), "\"repack\""); + assert_eq!(serde_json::to_string(&Flavor::Docker).unwrap(), "\"docker\""); + } +} diff --git a/crates/coa-core/src/realms.rs b/crates/coa-core/src/realms.rs index 5f2641b..f855e4f 100644 --- a/crates/coa-core/src/realms.rs +++ b/crates/coa-core/src/realms.rs @@ -76,10 +76,16 @@ pub fn state(root: &Path) -> Result { fsx::read_json(&root.join(STATE)) } +/// The world server executable of this folder: `worldserver.exe` in a repack, `worldserver` in a Docker server. +fn world_binary(root: &Path) -> std::path::PathBuf { + let exe = root.join("Core/worldserver.exe"); + if exe.exists() { exe } else { root.join("Core/worldserver") } +} + pub fn view(root: &Path) -> Result { let s = state(root)?; // Inspect the binary itself; templates or an old log cannot prove installed support. - let supported = fs::read(root.join("Core/worldserver.exe"))? + let supported = fs::read(world_binary(root))? .windows(b"Wildcard synergy settings".len()) .any(|w| w == b"Wildcard synergy settings"); Ok(View { @@ -408,6 +414,8 @@ pub fn select(root: &Path, mode: Mode) -> Result { /// Adapt the bundled launcher's canonical schema and realm choices without changing its supervision logic. pub fn prepare_launcher(root: &Path) -> Result<()> { + // A Docker server has no launcher to adapt: the Docker backend reads the active realm itself. + if crate::docker::is_docker(root) { return Ok(()); } let path = root.join("Scripts/manage.py"); let source = fs::read_to_string(&path)?; let patched = patch_launcher(&source)?; @@ -537,6 +545,31 @@ pub fn setup_realmlist(root: &Path) -> Result<()> { mod tests { use super::*; + #[test] + fn a_docker_server_is_checked_for_wildcard_support_in_its_own_binary() { + let d = tempfile::tempdir().unwrap(); + fs::create_dir_all(d.path().join("Core")).unwrap(); + fs::create_dir_all(d.path().join("Settings")).unwrap(); + fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap(); + fs::write(d.path().join("Core/worldserver"), b"ELF...Wildcard synergy settings...").unwrap(); + assert!(view(d.path()).unwrap().supported, "worldserver without .exe is read too"); + fs::write(d.path().join("Core/worldserver"), b"ELF...an older build").unwrap(); + assert!(!view(d.path()).unwrap().supported); + // The repack's executable still wins when both exist, so a repack is read as before. + fs::write(d.path().join("Core/worldserver.exe"), b"MZ...Wildcard synergy settings").unwrap(); + assert!(view(d.path()).unwrap().supported); + } + + #[test] + fn a_docker_server_has_no_launcher_to_adapt() { + let d = tempfile::tempdir().unwrap(); + fs::create_dir_all(d.path().join("Settings")).unwrap(); + // No Scripts/manage.py anywhere: on a repack this fails, on a Docker server there is nothing to do. + assert!(prepare_launcher(d.path()).is_err()); + fs::write(d.path().join("Settings/docker.json"), br#"{"project":"t1"}"#).unwrap(); + prepare_launcher(d.path()).unwrap(); + } + #[test] fn fresh_wildcard_disables_bots_and_preserves_scaling() { let mut f = Files::new(); diff --git a/crates/coa-core/src/update.rs b/crates/coa-core/src/update.rs index 0889670..221ff16 100644 --- a/crates/coa-core/src/update.rs +++ b/crates/coa-core/src/update.rs @@ -424,6 +424,15 @@ pub enum DatabaseAccess { OnlyIfRunning, } +/// The update packages are those of the Windows repack (executables, a bundled MySQL, a launcher): applying one to a Docker +/// server would put Windows files in a Linux server folder. Updating a Docker server is separate work. +fn refuse_for_docker(root: &Path) -> Result<()> { + if crate::docker::is_docker(root) { + return Err(Error::Invalid("Updates are not available for Docker servers yet.".into())); + } + Ok(()) +} + /// Describe the update; a managed launcher may need a one-time authenticated payload check. pub fn preview( root: &Path, @@ -450,6 +459,7 @@ pub fn preview_with( resolutions: &BTreeMap, access: DatabaseAccess, ) -> Result { + refuse_for_docker(root)?; let meta_dir = crate::registry::metadata_dir_for(root)?; let _lock = operation_lock(&meta_dir)?; ensure_recovered(&meta_dir)?; @@ -609,6 +619,7 @@ fn step(report: &dyn Fn(&str, u8), name: &str, pct: u8) { /// Run the whole update. On failure before the new build is validated the files are rolled back automatically; /// a build that is applied but unhealthy is left in `NeedsDecision` so the owner chooses. pub fn apply(p: &Params, report: &dyn Fn(&str, u8)) -> Result { + refuse_for_docker(p.root)?; let (root, meta_dir) = (p.root, p.meta_dir); let _lock = operation_lock(meta_dir)?; ensure_recovered(meta_dir)?; @@ -1143,6 +1154,7 @@ fn restore_files(root: &Path, before: &Path, txn: &mut Txn) -> Result<()> { /// Restore the database recovery point first, then restore binaries and configuration. pub fn rollback(root: &Path, meta_dir: &Path, id: &str, env: &dyn Env) -> Result { + refuse_for_docker(root)?; let _lock = operation_lock(meta_dir)?; let mut txn = load(meta_dir, id)?; if matches!(txn.state, State::Committed | State::RolledBack) { @@ -1925,6 +1937,27 @@ mod tests { assert_eq!(read(&w, "Core/worldserver.exe"), b"world-v1"); } + #[test] + fn a_docker_server_is_never_given_the_repack_files() { + // Found by trying the installer: the update check of a Docker server read the Windows channel and offered its files. + let w = world(&[], false); + write(&w.root, "Settings/docker.json", br#"{"project":"t1"}"#); + let before = read(&w, "Core/worldserver.exe"); + let meta = InstallMeta::new(InstallKind::New, &w.root); + + let err = preview(&w.root, &meta, &Source::Dir(w.pkg.clone()), &w.key, &BTreeMap::new()).unwrap_err(); + assert!(err.to_string().contains("Docker"), "{err}"); + let err = run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap_err(); + assert!(err.to_string().contains("Docker"), "{err}"); + assert!(rollback(&w.root, &w.meta, "any", &Fake::ok()).is_err()); + assert_eq!(read(&w, "Core/worldserver.exe"), before, "nothing was touched"); + assert!(!w.root.join("Core/newfile.dll").exists()); + + // The same package is applied to the same folder once it is not a Docker server. + fs::remove_file(w.root.join("Settings/docker.json")).unwrap(); + assert_eq!(run(&w, &Fake::ok(), BTreeMap::new(), None).unwrap().txn.state, State::Committed); + } + #[test] fn happy_path_replaces_creates_merges_and_records_ownership() { let w = world(&[], false); diff --git a/crates/coa-core/src/wine.rs b/crates/coa-core/src/wine.rs new file mode 100644 index 0000000..3f06e67 --- /dev/null +++ b/crates/coa-core/src/wine.rs @@ -0,0 +1,393 @@ +//! Starting the game client on Linux. The client is a Windows program, so it runs under umu-launcher with a Proton build +//! (what the project's own guide uses), or under plain Wine when umu is not installed. This is the Linux counterpart of +//! starting `Ascension.exe` directly; `client::launch` hands over to it on a Linux host and Windows never comes here. +//! +//! The settings are found on their own and can all be overridden, from strongest to weakest: the environment +//! (`COA_PROTONPATH`, `COA_WINEPREFIX`), then `client-launch.json` in the Manager's folder, then what is installed. + +use std::fs::{self, OpenOptions}; +use std::io::Write; +use std::path::{Path, PathBuf}; +use std::process::{Command, Stdio}; + +use serde::Deserialize; + +use crate::error::{Error, Result}; + +/// Prefix used when nothing else is said: the folder umu-launcher itself suggests for a game. +const DEFAULT_PREFIX: &str = "Games/umu/coa-client"; + +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum Runner { + /// umu-launcher runs the game with a Proton build. `proton` is `None` when umu should pick and download one itself. + Umu { program: PathBuf, proton: Option }, + Wine { program: PathBuf }, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct Launcher { + pub runner: Runner, + pub prefix: PathBuf, +} + +/// What to run, in a form that can be checked without running anything. +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct Plan { + pub program: PathBuf, + pub args: Vec, + pub env: Vec<(String, String)>, + pub cwd: PathBuf, +} + +/// `client-launch.json`: every key is optional. +#[derive(Debug, Default, Deserialize)] +#[serde(rename_all = "camelCase")] +pub struct Overrides { + pub proton_path: Option, + pub prefix: Option, + /// "umu" or "wine": use this one even if the other is installed. + pub runner: Option, +} + +/// Everything detection looks at, so it can be tested without a real computer. +pub struct Host<'a> { + pub var: &'a dyn Fn(&str) -> Option, + pub which: &'a dyn Fn(&str) -> Option, + /// Names of the entries of a folder (empty when it does not exist). + pub list: &'a dyn Fn(&Path) -> Vec, + pub is_file: &'a dyn Fn(&Path) -> bool, +} + +fn proton_folders(home: &Path) -> Vec { + vec![ + home.join(".local/share/Steam/compatibilitytools.d"), + home.join(".steam/root/compatibilitytools.d"), + home.join(".steam/steam/compatibilitytools.d"), + home.join(".var/app/com.valvesoftware.Steam/.local/share/Steam/compatibilitytools.d"), + PathBuf::from("/usr/share/steam/compatibilitytools.d"), + ] +} + +/// Numbers of a name in order, so that GE-Proton10-9 sorts before GE-Proton10-34. +fn version_key(name: &str) -> Vec { + let mut out = Vec::new(); + let mut cur = String::new(); + for c in name.chars().chain(std::iter::once(' ')) { + if c.is_ascii_digit() { + cur.push(c); + } else if !cur.is_empty() { + out.push(cur.parse().unwrap_or(0)); + cur.clear(); + } + } + out +} + +/// The newest GE-Proton build installed for Steam, if any. A folder only counts when it holds the `proton` script. +fn newest_proton(host: &Host, home: &Path) -> Option { + proton_folders(home) + .into_iter() + .flat_map(|dir| (host.list)(&dir).into_iter().filter(|n| n.starts_with("GE-Proton")).map(move |n| (n.clone(), dir.join(n)))) + .filter(|(_, path)| (host.is_file)(&path.join("proton"))) + .max_by_key(|(name, _)| version_key(name)) + .map(|(_, path)| path) +} + +pub fn detect_with(host: &Host, overrides: &Overrides) -> Result { + let home = (host.var)("HOME").map(PathBuf::from).ok_or_else(|| Error::Invalid("The home folder of this user is not known.".into()))?; + let prefix = (host.var)("COA_WINEPREFIX").or_else(|| overrides.prefix.clone()).map(PathBuf::from).unwrap_or_else(|| home.join(DEFAULT_PREFIX)); + let proton = (host.var)("COA_PROTONPATH").or_else(|| overrides.proton_path.clone()).map(PathBuf::from).or_else(|| newest_proton(host, &home)); + let (umu, wine) = ((host.which)("umu-run"), (host.which)("wine")); + let runner = match (overrides.runner.as_deref(), umu, wine) { + (Some("wine"), _, Some(program)) => Runner::Wine { program }, + (Some("umu"), Some(program), _) | (None, Some(program), _) => Runner::Umu { program, proton }, + (_, None, Some(program)) => Runner::Wine { program }, + _ => { + return Err(Error::Invalid( + "To play on Linux the game client needs umu-launcher (with a Proton build such as GE-Proton) or Wine. Install one of them and press Play again.".into(), + )) + } + }; + Ok(Launcher { runner, prefix }) +} + +/// The command line that starts `exe` from the client folder. +pub fn plan(launcher: &Launcher, client: &Path, exe: &str) -> Plan { + let mut env = vec![("WINEPREFIX".to_string(), launcher.prefix.to_string_lossy().into_owned())]; + // DivxTac.dll is a mixed-mode .NET assembly: loaded through wine-mono it deadlocks the client on the world loading screen + // (100%). Disabling it has the same effect as removing the file. + env.push(("WINEDLLOVERRIDES".into(), "divxtac=d".into())); + let program = match &launcher.runner { + Runner::Umu { program, proton } => { + env.push(("GAMEID".into(), "0".into())); + if let Some(p) = proton { + env.push(("PROTONPATH".into(), p.to_string_lossy().into_owned())); + } + program.clone() + } + Runner::Wine { program } => program.clone(), + }; + // The client reads Data/ relative to the working directory. + Plan { program, args: vec![exe.to_string()], env, cwd: client.to_path_buf() } +} + +fn system_var(k: &str) -> Option { + std::env::var(k).ok().filter(|v| !v.trim().is_empty()) +} + +fn find_on_path(program: &str) -> Option { + std::env::split_paths(&std::env::var_os("PATH")?).map(|d| d.join(program)).find(|p| p.is_file()) +} + +fn list_names(dir: &Path) -> Vec { + fs::read_dir(dir).map(|rd| rd.filter_map(|e| e.ok()).filter_map(|e| e.file_name().into_string().ok()).collect()).unwrap_or_default() +} + +fn data_home() -> Option { + system_var("XDG_DATA_HOME").map(PathBuf::from).filter(|p| p.is_absolute()).or_else(|| system_var("HOME").map(|h| PathBuf::from(h).join(".local/share"))) +} + +fn overrides_file() -> Option { + data_home().map(|d| d.join("CoAServerManager/client-launch.json")) +} + +pub fn detect() -> Result { + let overrides: Overrides = overrides_file().and_then(|p| crate::fsx::read_json(&p).ok()).unwrap_or_default(); + detect_with(&Host { var: &system_var, which: &find_on_path, list: &list_names, is_file: &|p| p.is_file() }, &overrides) +} + +/// Where what the client prints goes: the Manager's own log folder. +pub fn log_path() -> Option { + data_home().map(|d| d.join("CoAServerManager/logs/client.log")) +} + +/// Start the client and return at once; it keeps running when the Manager closes. Returns the process id. +pub fn launch(client: &Path, exe: &str) -> Result { + let launcher = detect()?; + let plan = plan(&launcher, client, exe); + let log = match log_path() { + Some(p) => { + if let Some(dir) = p.parent() { + fs::create_dir_all(dir)?; + } + let mut f = OpenOptions::new().create(true).append(true).open(&p)?; + writeln!(f, "=== {} {:?} in {}", plan.program.display(), plan.args, plan.cwd.display())?; + for (k, v) in &plan.env { + writeln!(f, " {k}={v}")?; + } + Some(f) + } + None => None, + }; + let mut cmd = Command::new(&plan.program); + cmd.args(&plan.args).current_dir(&plan.cwd).envs(plan.env.iter().map(|(k, v)| (k, v))).stdin(Stdio::null()); + match log { + Some(f) => { + cmd.stderr(f.try_clone()?).stdout(f); + } + None => { + cmd.stdout(Stdio::null()).stderr(Stdio::null()); + } + } + #[cfg(unix)] + { + use std::os::unix::process::CommandExt; + cmd.process_group(0); // its own group: closing the Manager does not take the game with it + } + let mut child = cmd.spawn().map_err(|e| Error::Invalid(format!("The game client could not be started ({}): {e}", plan.program.display())))?; + let pid = child.id(); + std::thread::spawn(move || { + let _ = child.wait(); // reap it when the game closes + }); + Ok(pid) +} + +/// Is a process running this client? Under Wine its command line carries the Windows form of the path +/// (`Z:\home\you\client\Ascension.exe`), which is the only trace of it that names the folder. +pub fn command_line_runs(cmdline: &str, client: &Path, exe: &str) -> bool { + let wanted = format!("{}/{}", client.to_string_lossy().trim_end_matches('/'), exe).to_lowercase(); + cmdline.replace('\0', " ").replace('\\', "/").to_lowercase().contains(&wanted) +} + +/// The folder as it was given and as the system resolves it. On an immutable distribution (SteamOS, Bazzite) `/home` is a +/// link to `/var/home`: Wine writes the path it was given, the resolved one differs, and either may be what the command +/// line of the running client holds. +fn spellings(client: &Path) -> Vec { + let mut all = vec![client.to_path_buf()]; + if let Ok(real) = fs::canonicalize(client) { + if real != client { + all.push(real); + } + } + all +} + +pub fn is_running(client: &Path, exes: &[&str]) -> bool { + let folders = spellings(client); + let Ok(rd) = fs::read_dir("/proc") else { return false }; + rd.filter_map(|e| e.ok()) + .filter(|e| e.file_name().to_string_lossy().bytes().all(|b| b.is_ascii_digit())) + .filter_map(|e| fs::read(e.path().join("cmdline")).ok()) + .any(|raw| { + let line = String::from_utf8_lossy(&raw); + folders.iter().any(|folder| exes.iter().any(|exe| command_line_runs(&line, folder, exe))) + }) +} + +// Linux only: the folders are written as Linux path strings. +#[cfg(all(test, unix))] +mod tests { + use super::*; + use std::collections::{BTreeMap, BTreeSet}; + + #[test] + fn a_client_folder_behind_a_link_is_looked_for_under_both_names() { + // SteamOS and Bazzite: /home is a link to /var/home. + let dir = tempfile::tempdir().unwrap(); + fs::create_dir_all(dir.path().join("var/home/u/client")).unwrap(); + std::os::unix::fs::symlink("var/home", dir.path().join("home")).unwrap(); + let given = dir.path().join("home/u/client"); + let both = spellings(&given); + assert_eq!(both.len(), 2); + assert_eq!(both[0], given); + assert!(both[1].starts_with(dir.path().canonicalize().unwrap().join("var/home"))); + // Wine kept the name it was given, so the line holds the first one and not the resolved one. + let line = format!("Z:\\{}\\Ascension.exe", given.to_string_lossy().replace('/', "\\")); + assert!(!command_line_runs(&line, &both[1], "Ascension.exe")); + assert!(both.iter().any(|f| command_line_runs(&line, f, "Ascension.exe"))); + } + + /// A computer described in a few lines: variables, programs on the path, folders with their entries, and `proton` scripts. + struct Fake { + vars: BTreeMap<&'static str, &'static str>, + programs: BTreeSet<&'static str>, + folders: BTreeMap<&'static str, Vec<&'static str>>, + } + + impl Fake { + fn new() -> Fake { + Fake { vars: BTreeMap::from([("HOME", "/home/ana")]), programs: BTreeSet::new(), folders: BTreeMap::new() } + } + + fn detect(&self, overrides: &Overrides) -> Result { + let var = |k: &str| self.vars.get(k).map(|v| v.to_string()); + let which = |p: &str| self.programs.contains(p).then(|| PathBuf::from(format!("/usr/bin/{p}"))); + let list = |d: &Path| self.folders.get(d.to_str().unwrap()).map(|v| v.iter().map(|s| s.to_string()).collect()).unwrap_or_default(); + // every listed build has its `proton` script + let is_file = |p: &Path| p.file_name().is_some_and(|n| n == "proton"); + detect_with(&Host { var: &var, which: &which, list: &list, is_file: &is_file }, overrides) + } + } + + const STEAM: &str = "/home/ana/.local/share/Steam/compatibilitytools.d"; + + #[test] + fn umu_with_the_newest_ge_proton_is_the_default() { + let mut c = Fake::new(); + c.programs.extend(["umu-run", "wine"]); + c.folders.insert(STEAM, vec!["GE-Proton9-27", "GE-Proton10-9", "GE-Proton10-34", "Proton-Experimental", "notes.txt"]); + let l = c.detect(&Overrides::default()).unwrap(); + assert_eq!(l.prefix, PathBuf::from("/home/ana/Games/umu/coa-client")); + match l.runner { + Runner::Umu { proton, program } => { + assert_eq!(program, PathBuf::from("/usr/bin/umu-run")); + assert_eq!(proton, Some(PathBuf::from(format!("{STEAM}/GE-Proton10-34"))), "10-34 is newer than 10-9"); + } + other => panic!("{other:?}"), + } + } + + #[test] + fn without_a_proton_build_umu_is_left_to_choose_one() { + let mut c = Fake::new(); + c.programs.insert("umu-run"); + let Runner::Umu { proton, .. } = c.detect(&Overrides::default()).unwrap().runner else { panic!() }; + assert_eq!(proton, None); + } + + #[test] + fn plain_wine_is_used_when_umu_is_not_installed() { + let mut c = Fake::new(); + c.programs.insert("wine"); + assert!(matches!(c.detect(&Overrides::default()).unwrap().runner, Runner::Wine { .. })); + } + + #[test] + fn without_umu_or_wine_the_person_is_told_what_to_install() { + let err = Fake::new().detect(&Overrides::default()).unwrap_err().to_string(); + assert!(err.contains("umu-launcher") && err.contains("Wine"), "{err}"); + } + + #[test] + fn settings_override_what_is_installed_and_the_environment_overrides_the_file() { + let mut c = Fake::new(); + c.programs.extend(["umu-run", "wine"]); + c.folders.insert(STEAM, vec!["GE-Proton10-34"]); + let file = Overrides { proton_path: Some("/opt/proton-a".into()), prefix: Some("/data/prefix-a".into()), runner: None }; + let l = c.detect(&file).unwrap(); + assert_eq!(l.prefix, PathBuf::from("/data/prefix-a")); + assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-a"))); + c.vars.insert("COA_PROTONPATH", "/opt/proton-b"); + c.vars.insert("COA_WINEPREFIX", "/data/prefix-b"); + let l = c.detect(&file).unwrap(); + assert_eq!(l.prefix, PathBuf::from("/data/prefix-b")); + assert!(matches!(&l.runner, Runner::Umu { proton: Some(p), .. } if p == Path::new("/opt/proton-b"))); + // Forcing Wine works when it is installed, and falls back to umu when it is not. + let wine = Overrides { runner: Some("wine".into()), ..Default::default() }; + assert!(matches!(c.detect(&wine).unwrap().runner, Runner::Wine { .. })); + } + + #[test] + fn the_command_is_the_one_of_the_projects_own_launcher_script() { + let l = Launcher { runner: Runner::Umu { program: "/usr/bin/umu-run".into(), proton: Some("/p/GE-Proton11-6".into()) }, prefix: "/home/ana/Games/umu/coa-client".into() }; + let p = plan(&l, Path::new("/home/ana/CoaServer/client/ascension-live"), "Ascension.exe"); + assert_eq!(p.program, PathBuf::from("/usr/bin/umu-run")); + assert_eq!(p.args, ["Ascension.exe"]); + assert_eq!(p.cwd, PathBuf::from("/home/ana/CoaServer/client/ascension-live"), "the client reads Data/ from its working directory"); + let env: BTreeMap<_, _> = p.env.iter().cloned().collect(); + assert_eq!(env["GAMEID"], "0"); + assert_eq!(env["PROTONPATH"], "/p/GE-Proton11-6"); + assert_eq!(env["WINEPREFIX"], "/home/ana/Games/umu/coa-client"); + assert_eq!(env["WINEDLLOVERRIDES"], "divxtac=d", "DivxTac.dll deadlocks the world loading screen under wine-mono"); + // Wine has no GAMEID / PROTONPATH. + let w = plan(&Launcher { runner: Runner::Wine { program: "/usr/bin/wine".into() }, prefix: "/pre".into() }, Path::new("/c"), "Wow.exe"); + assert!(w.env.iter().all(|(k, _)| k != "GAMEID" && k != "PROTONPATH") && w.args == ["Wow.exe"]); + } + + #[test] + fn a_wine_command_line_names_the_client_folder_in_windows_form() { + let client = Path::new("/home/ana/CoaServer/client/ascension-live"); + assert!(command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe\0", client, "Ascension.exe")); + assert!(command_line_runs("C:\\windows\\system32\\start.exe /exec Z:\\HOME\\ANA\\coaserver\\client\\ascension-live\\ascension.exe", client, "Ascension.exe"), "case does not matter"); + assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-lab\\Ascension.exe", client, "Ascension.exe"), "another client folder"); + assert!(!command_line_runs("umu-run Ascension.exe", client, "Ascension.exe"), "the launcher alone does not name the folder"); + assert!(!command_line_runs("Z:\\home\\ana\\CoaServer\\client\\ascension-live\\Ascension.exe.ORIGINAL", Path::new("/other"), "Ascension.exe")); + } + + #[test] + fn newer_versions_sort_after_older_ones() { + assert!(version_key("GE-Proton10-9") < version_key("GE-Proton10-34")); + assert!(version_key("GE-Proton9-27") < version_key("GE-Proton10-1")); + assert!(version_key("GE-Proton11-6-x86_64") < version_key("GE-Proton11-7-x86_64")); + } + + #[cfg(unix)] + #[test] + fn a_real_launch_runs_the_program_in_the_client_folder_with_the_right_environment() { + use std::os::unix::fs::PermissionsExt; + let d = tempfile::tempdir().unwrap(); + let client = d.path().join("client"); + fs::create_dir_all(&client).unwrap(); + let out = d.path().join("seen.txt"); + let script = d.path().join("umu-run"); + fs::write(&script, format!("#!/bin/sh\n{{ echo \"cwd=$(pwd)\"; echo \"arg=$1\"; echo \"prefix=$WINEPREFIX\"; echo \"gameid=$GAMEID\"; echo \"dll=$WINEDLLOVERRIDES\"; }} > '{}'\n", out.display())).unwrap(); + fs::set_permissions(&script, fs::Permissions::from_mode(0o755)).unwrap(); + let launcher = Launcher { runner: Runner::Umu { program: script, proton: None }, prefix: d.path().join("prefix") }; + let p = plan(&launcher, &client, "Ascension.exe"); + let mut child = Command::new(&p.program).args(&p.args).current_dir(&p.cwd).envs(p.env.iter().map(|(k, v)| (k, v))).spawn().unwrap(); + assert!(child.wait().unwrap().success()); + let seen = fs::read_to_string(&out).unwrap(); + assert!(seen.contains(&format!("cwd={}", fs::canonicalize(&client).unwrap().display())), "{seen}"); + assert!(seen.contains("arg=Ascension.exe") && seen.contains("gameid=0") && seen.contains("dll=divxtac=d") && seen.contains("prefix="), "{seen}"); + } +} diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 97c48b5..1de9358 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -401,8 +401,29 @@ hand over to `coa_core::docker`; nothing else needed to change for start, stop, produces `Database/baseline` without anyone's live database. The migration checksums recorded in the base are those of files checked out on Windows (CRLF line endings, `core.autocrlf`): the SQL of the core, the modules and SQUID must be checked out the same way for the checksums to match, or every applied migration looks edited. -* **Not done yet**: wiring the installer into the screens, downloading the game data, updates, port conflict detection, - the firewall and exposure checks, the Wildcard realm profiles, and the client under Wine/Proton. +* **In the screens** the host is asked once per command (`coa_core::platform::flavor()`: repack on Windows, Docker + elsewhere) and the Docker half lives in `src-tauri/src/docker_install.rs`; the repack arm of each install command is the + code that was there. `install_environment` tells the install screen the kind of server, the suggested folder + (`~/CoaServer`) and why Docker cannot be used, if it cannot. On Docker the screen also asks for the game data folder and + the package, and there is no default package address until a signed Linux package is published. Packages are checked with + the embedded key; only a debug build (`tauri dev`) accepts another one, named in `COA_DEV_TRUSTED_KEY`, to try the + installer on a package signed with a throwaway key. +* **Updates are refused for a Docker server, never half done.** `update::preview`, `apply` and `rollback` refuse it: the + update packages are the repack's (executables, a bundled MySQL, a launcher) and applying one would put Windows files in a + Linux folder. Found by installing a server with the screen: the update check had read the Windows channel and offered one. +* **Realm profiles (CoA / Wildcard) work on a Docker server.** What the repack's patched launcher did at each start is done + by the Docker backend: finish an interrupted switch (`realms::before_start`), name the realms in the realm list, and give + the containers the databases of the selected realm (`acore_world_wildcard` ...). The switch itself (configuration swap, + database copy, journal) is the shared code; `prepare_launcher` has nothing to patch, and Wildcard support is read from + `Core/worldserver` as it is from `Core/worldserver.exe`. +* **The game client starts under Wine on a Linux host** (`wine.rs`; `client::launch` and `client::is_running` hand over): + umu-launcher with a Proton build when `umu-run` is installed (the newest GE-Proton found for Steam, or umu's own choice), + else plain Wine; `WINEPREFIX` defaults to `~/Games/umu/coa-client`; `WINEDLLOVERRIDES=divxtac=d` is always set, because + DivxTac.dll deadlocks the world loading screen under wine-mono. `COA_PROTONPATH`, `COA_WINEPREFIX` or + `client-launch.json` in the Manager's folder (`proton_path`, `prefix`, `runner`) override the detection. Whether the client + runs is read from `/proc` (under Wine the command line holds the Windows form of the path). Output goes to `client.log`. +* **Not done yet**: downloading the game data, updates, port conflict detection, the firewall and exposure checks, the + Wildcard realm profiles, and the client under Wine/Proton. ### D14. Keeping Windows and Linux apart diff --git a/docs/INFRASTRUCTURE.md b/docs/INFRASTRUCTURE.md index 5546fd0..9c623b0 100644 --- a/docs/INFRASTRUCTURE.md +++ b/docs/INFRASTRUCTURE.md @@ -6,7 +6,7 @@ This file never contains private keys, passwords, DB credentials, transfer PINs, ## Role -`coa-infra-01` (OVHcloud VPS, Ubuntu 24.04 LTS) is the shared infrastructure node for the planned services: +`coa-infra-01` (OVHcloud VPS, Ubuntu 24.04 LTS) is the shared infrastructure node for the deployed backend services: ``` Registry API Relay Coordinator PostgreSQL Caddy (ingress) monitoring @@ -43,14 +43,16 @@ Rules: - Game Relay publishes the dedicated TCP port range `40000:43999/tcp` for relayed WoW client game streams (Auth & World). - No admin dashboards or the Docker API on public interfaces. Caddy's admin API is disabled. -## Public ports +## Public surface -| Port | Proto | Service | -|---|---|---| -| 22 | tcp | SSH, key only | -| 80 | tcp | Caddy HTTP (redirects to HTTPS) | -| 443 | tcp | Caddy HTTPS / WSS | -| 40000-43999 | tcp | Game Relay WoW game traffic (Auth & World) | +The public surface of `coa-infra-01` is strictly limited to: + +| Port | Proto | Service | Access / Security | +|---|---|---|---| +| 22 | tcp | SSH | Key authentication only (Ed25519), root login disabled | +| 80 | tcp | Caddy HTTP | Redirects automatically to HTTPS (`443/tcp`) | +| 443 | tcp | Caddy HTTPS / WSS | Reverse proxy for Registry (`/registry/v2/`), Coordinator (`/coord/v1/`), Relay Host WS (`/relay/v1/host`) | +| 40000–43999 | tcp | Game Relay | Dynamic TCP port pool for client Auth & World game traffic (dumb byte forwarding) | ## Filesystem layout @@ -141,11 +143,11 @@ cd /opt/coa/coordinator && sudo docker compose up -d - Provider backup is not a substitute for application-level backups. What OVH actually includes for this plan (automatic backup, snapshot, KVM/rescue) still has to be confirmed in the Control Panel. -- Planned (not implemented yet): - 1. PostgreSQL logical backup: `pg_dump` to `/opt/coa/backups`, copied off the node. - 2. Infrastructure config backup: `/opt/coa` except `secrets/` and volumes. - 3. Secrets are backed up separately and never together with the config archive. -- Portable Characters are not backed up here: the VPS is not their source of truth. +- Automated PostgreSQL backup & restore (implemented in Phase 15, Gate 15.5 passed): + 1. Logical database backup: `/opt/coa/registry/backup-db.sh` executes `pg_dump --format=custom --blobs` into `/opt/coa/backups`, verifies minimum size (> 1024 bytes), creates `.sha256` checksum file, touches `.complete` atomic marker, and prunes dumps older than 14 days. + 2. Database restore: `/opt/coa/registry/restore-db.sh` verifies SHA-256 checksum, terminates existing database connections, and restores cleanly via `pg_restore --clean --if-exists --no-owner`. Disposable test restore verified with 100% table and schema integrity (Gate 15.5). + 3. Secrets are backed up separately in `/opt/coa/secrets` (0700 root:root) and never placed in public repositories. +- Portable Characters are not backed up here: the VPS is not their source of truth (characters are stored canonically on their respective Owners/Hosts). ## Recovery diff --git a/docs/REGISTRY_DEPLOYMENT.md b/docs/REGISTRY_DEPLOYMENT.md index 8f6e2da..44e4fc8 100644 --- a/docs/REGISTRY_DEPLOYMENT.md +++ b/docs/REGISTRY_DEPLOYMENT.md @@ -80,8 +80,7 @@ sudo sh /opt/coa/registry/src/services/coa-registry/deploy/audit-db.sh ``` Logs are structured JSON: `realm`, `endpoint`, `status`, `error` (code), `latency_ms`, and the first 8 characters of the capabilities hash. They never contain keys, -signatures, headers, request bodies or the database credentials (checked: 0 occurrences of either password in any container's log). Backups: not yet automated -(`pg_dump coa_registry` to `/opt/coa/backups`, see INFRASTRUCTURE.md); the data is discovery metadata that every Host re-announces by itself within a heartbeat or two. +signatures, headers, request bodies or the database credentials (checked: 0 occurrences of either password in any container's log). Backups: automated via `backup-db.sh` into `/opt/coa/backups` with SHA-256 verification and atomic markers (verified in Gate 15.5; see INFRASTRUCTURE.md); the data is discovery metadata that every Host re-announces by itself within a heartbeat or two. ## The Phase-10 gate diff --git a/docs/THIRD_PARTY_NOTICES.md b/docs/THIRD_PARTY_NOTICES.md index 0c2ada9..6099634 100644 --- a/docs/THIRD_PARTY_NOTICES.md +++ b/docs/THIRD_PARTY_NOTICES.md @@ -10,8 +10,7 @@ Copyright (C) 2026 CoA Project Contributors This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +the Free Software Foundation, version 3 of the License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of diff --git a/modules/catalog.json b/modules/catalog.json index e1db3bf..4a1bfd7 100644 --- a/modules/catalog.json +++ b/modules/catalog.json @@ -121,6 +121,24 @@ "default_on": false, "page": "bots" }, + { + "id": "custom-races", + "name": "Custom Races", + "description": { + "en": "Playable custom races (Esteria and additional races) with extended appearances.", + "ru": "Пользовательские расы (Esteria и дополнительные расы) с расширенной внешностью.", + "de": "Spielbare benutzerdefinierte Völker (Esteria und weitere Völker) mit erweitertem Aussehen.", + "fr": "Races personnalisées jouables (Esteria et autres) avec apparences étendues.", + "es": "Razas personalizadas jugables (Esteria y razas adicionales) con apariencias ampliadas." + }, + "repo": "https://github.com/Corfirean/azerothcore-wotlk-coa", + "conf": "coa_custom_races.conf", + "switchable": true, + "status": "beta", + "icon": "races", + "enable_key": "CoACustomRaces.Enable", + "default_on": false + }, { "id": "client-compat", "name": "Client compatibility", diff --git a/package-lock.json b/package-lock.json index 85506e5..a8f15aa 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "coa-server-manager", - "version": "0.6.7", + "version": "0.6.10", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "coa-server-manager", - "version": "0.6.7", + "version": "0.6.10", "dependencies": { "@tauri-apps/api": "^2.12.0", "@tauri-apps/plugin-dialog": "^2.8.0", diff --git a/src-tauri/src/docker_install.rs b/src-tauri/src/docker_install.rs new file mode 100644 index 0000000..1768cfc --- /dev/null +++ b/src-tauri/src/docker_install.rs @@ -0,0 +1,125 @@ +//! The Linux (Docker) side of the install commands. `lib.rs` asks `coa_core::platform::flavor()` once per command and +//! calls this module for a Docker install; the code for a repack install stays where it was and is not changed by what +//! happens here. + +use std::path::{Path, PathBuf}; + +use coa_core::docker::{self, install as core_install, SystemDocker}; +use coa_core::download::Cancel; +use coa_core::install::{Preflight, Source}; +use coa_core::registry::Registry; +use coa_core::{Error, Result}; +use serde::Serialize; +use tauri::{AppHandle, Emitter, State}; + +use super::{blocking, data_dir, summary, AppState, InstallRequirements, ServerSummary, UiError}; + +/// What the install screen needs to know about this computer before it asks anything. +#[derive(Serialize)] +pub struct Environment { + pub flavor: coa_core::platform::Flavor, + pub default_dir: String, + /// Why Docker cannot be used (not installed, not running, no permission), in Docker's own words; none when it works. + pub docker_problem: Option, +} + +pub fn default_dir() -> String { + default_dir_in(std::env::var("HOME").ok().as_deref()) +} + +fn default_dir_in(home: Option<&str>) -> String { + match home.map(|h| h.trim_end_matches('/')).filter(|h| !h.is_empty()) { + Some(h) => format!("{h}/CoaServer"), + None => "/srv/coa".into(), + } +} + +pub fn docker_problem() -> Option { + docker::check_docker(&SystemDocker).err().map(|e| e.to_string()) +} + +pub fn environment() -> Environment { + Environment { flavor: coa_core::platform::flavor(), default_dir: default_dir(), docker_problem: docker_problem() } +} + +pub fn preflight(dest: &str, data: Option, needed: Option, registry: &Registry) -> Preflight { + // The size comes from the signed package list when the screen already has it; it is checked again at install time. + core_install::preflight(Path::new(dest), Path::new(data.as_deref().unwrap_or("")), needed.unwrap_or(1024 * 1024 * 1024), registry) +} + +/// The Linux package has no default address yet: it is published only after the maintainer has signed it. +pub fn package_source(custom: Option) -> Result { + let pick = custom.filter(|s| !s.trim().is_empty()).or_else(|| std::env::var("COA_PACKAGE_SOURCE").ok().filter(|s| !s.trim().is_empty())); + match pick { + Some(p) if p.to_ascii_lowercase().starts_with("http") => Ok(Source::Url(p)), + Some(p) => Ok(Source::Dir(PathBuf::from(p))), + None => Err(Error::Invalid("Choose the Linux server package (a folder or an address): none is published yet.".into())), + } +} + +/// The key a Linux package must be signed with. A debug build (`tauri dev`) may name another one in `COA_DEV_TRUSTED_KEY`, +/// to try the installer on a package signed with a throwaway key; a release build always uses the embedded key. +pub fn trusted_key() -> String { + #[cfg(debug_assertions)] + if let Ok(k) = std::env::var("COA_DEV_TRUSTED_KEY") { + if !k.trim().is_empty() { + return k.trim().to_string(); + } + } + coa_core::signing::EMBEDDED_PUBLIC_KEY.to_string() +} + +pub async fn requirements(package: Option) -> std::result::Result { + blocking(move || { + let (m, _) = coa_core::pkgsource::fetch_manifest(&package_source(package)?, &trusted_key())?; + let archive = m.archive.ok_or_else(|| Error::InvalidManifest("no archive".into()))?; + Ok(InstallRequirements { download_bytes: archive.parts.iter().map(|p| p.size).sum(), unpacked_bytes: archive.unpacked_size, version: m.version }) + }) + .await +} + +pub async fn install(app: AppHandle, state: State<'_, AppState>, dest: String, package: Option, data: Option) -> std::result::Result { + let source = package_source(package)?; + let data_dir_path = PathBuf::from(data.filter(|d| !d.trim().is_empty()).ok_or_else(|| Error::Invalid("Choose the folder that holds the game data.".into()))?); + let cancel = Cancel::default(); + *state.install_cancel.lock().map_err(|_| Error::Invalid("state poisoned".into()))? = Some(cancel.clone()); + let registry = Registry::at(data_dir().join("installs.json")); + let dest_path = PathBuf::from(dest); + let key = trusted_key(); + let result = tauri::async_runtime::spawn_blocking(move || { + core_install::install( + &core_install::Params { source, dest: dest_path, data_dir: data_dir_path, trusted_key: &key, registry: ®istry, cancel }, + &|step| { + let _ = app.emit("install-progress", step); + }, + ) + }) + .await; + if let Ok(mut c) = state.install_cancel.lock() { + *c = None; + } + let done = result.map_err(|e| Error::Invalid(e.to_string()))??; + Ok(summary(done.id, PathBuf::from(done.path))) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn the_default_folder_is_in_the_home_folder() { + assert_eq!(default_dir_in(Some("/home/ana")), "/home/ana/CoaServer"); + assert_eq!(default_dir_in(Some("/home/ana/")), "/home/ana/CoaServer"); + assert_eq!(default_dir_in(None), "/srv/coa"); + assert_eq!(default_dir_in(Some("")), "/srv/coa"); + } + + #[test] + fn a_linux_package_must_be_named_there_is_no_default() { + std::env::remove_var("COA_PACKAGE_SOURCE"); + assert!(package_source(None).is_err()); + assert!(package_source(Some(" ".into())).is_err()); + assert!(matches!(package_source(Some("/tmp/pkg".into())).unwrap(), Source::Dir(_))); + assert!(matches!(package_source(Some("https://example.org/pkg".into())).unwrap(), Source::Url(_))); + } +} diff --git a/src-tauri/src/lib.rs b/src-tauri/src/lib.rs index 1fa6d29..330b969 100644 --- a/src-tauri/src/lib.rs +++ b/src-tauri/src/lib.rs @@ -5,10 +5,13 @@ use std::collections::HashSet; use std::path::PathBuf; use std::sync::{Arc, Mutex}; +mod docker_install; + use coa_core::backup::{self, Kind, RecoveryPoint, Trigger, VerifyReport}; use coa_core::config::{self, Scope, SettingsView}; use coa_core::download::Cancel; use coa_core::driver::{self, DriverOutcome, Verb}; +use coa_core::platform::{self, Flavor}; use coa_core::error::UiError; use coa_core::install::{self, Preflight, Source}; use coa_core::layout::{self, Classification, ScanReport}; @@ -328,9 +331,19 @@ fn summary(id: String, path: PathBuf) -> ServerSummary { #[tauri::command] fn default_install_dir() -> String { + if platform::flavor() == Flavor::Docker { + return docker_install::default_dir(); + } "C:\\Games\\CoA Server".into() } +/// What the install screen needs to know about this computer: the kind of server it installs, the suggested folder, and +/// whether Docker can be used. +#[tauri::command] +async fn install_environment() -> docker_install::Environment { + tauri::async_runtime::spawn_blocking(docker_install::environment).await.unwrap_or_else(|_| docker_install::Environment { flavor: platform::flavor(), default_dir: default_install_dir(), docker_problem: None }) +} + #[tauri::command] async fn scan_server(path: String) -> std::result::Result { tauri::async_runtime::spawn_blocking(move || layout::scan(std::path::Path::new(&path))) @@ -814,7 +827,10 @@ async fn restore_backup_database( } #[tauri::command] -fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option) -> Preflight { +fn install_preflight(state: State<'_, AppState>, dest: String, needed: Option, game_data: Option) -> Preflight { + if platform::flavor() == Flavor::Docker { + return docker_install::preflight(&dest, game_data, needed, &state.registry); + } // `needed` is the real size from the signed package list when the screen already has it; the real size is checked // again at install time either way. install::preflight( @@ -838,6 +854,9 @@ struct InstallRequirements { async fn install_requirements( package: Option, ) -> std::result::Result { + if platform::flavor() == Flavor::Docker { + return docker_install::requirements(package).await; + } blocking(move || { let (m, _) = coa_core::pkgsource::fetch_manifest( &package_source(package), @@ -861,7 +880,11 @@ async fn install_new( state: State<'_, AppState>, dest: String, package: Option, + game_data: Option, ) -> std::result::Result { + if platform::flavor() == Flavor::Docker { + return docker_install::install(app, state, dest, package, game_data).await; + } let cancel = Cancel::default(); *state .install_cancel @@ -1113,6 +1136,50 @@ async fn module_set_enabled( .await } +#[tauri::command] +async fn custom_races_status(state: State<'_, AppState>, id: String) -> std::result::Result, UiError> { + let root = path_of(&state, &id)?; + blocking(move || { + let client = linked_client(&root)?; + Ok(client.as_deref().map(coa_core::custom_races::client_patch_status)) + }) + .await +} + +#[tauri::command] +async fn custom_races_install(app: AppHandle, state: State<'_, AppState>, id: String) -> std::result::Result<(), UiError> { + let root = path_of(&state, &id)?; + let _guard = BusyGuard::acquire(&state, &id)?; + let cancel = begin_client_job(&state)?; + let sid = id.clone(); + let result = blocking(move || { + let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is linked to this server.".into()))?; + coa_core::custom_races::install_client_patches(&client, &cancel, &|step, percent| { + let _ = app.emit("custom-races-progress", serde_json::json!({ + "id": sid, + "step": step, + "percent": percent, + })); + })?; + let enabled = coa_core::modules::list(&root).iter().any(|module| module.id == "custom-races" && module.enabled); + coa_core::custom_races::set_client_patch_enabled(&client, enabled) + }) + .await; + end_client_job(&state); + result +} + +#[tauri::command] +async fn custom_races_toggle_client(state: State<'_, AppState>, id: String, enabled: bool) -> std::result::Result<(), UiError> { + let root = path_of(&state, &id)?; + let _guard = BusyGuard::acquire(&state, &id)?; + blocking(move || { + let client = linked_client(&root)?.ok_or_else(|| Error::Invalid("No game client is linked to this server.".into()))?; + coa_core::custom_races::set_client_patch_enabled(&client, enabled) + }) + .await +} + #[tauri::command] async fn module_settings( state: State<'_, AppState>, @@ -2433,6 +2500,15 @@ async fn export_diagnostics( .await } +#[tauri::command] +async fn list_crashes( + state: State<'_, AppState>, + id: String, + limit: Option, +) -> std::result::Result, UiError> { + let root = path_of(&state, &id)?; + blocking(move || coa_core::crashes::list(&root, limit.unwrap_or(10))).await +} #[tauri::command] async fn console_tail( state: State<'_, AppState>, @@ -2504,6 +2580,7 @@ pub fn run() { }) .invoke_handler(tauri::generate_handler![ default_install_dir, + install_environment, scan_server, add_server, list_servers, @@ -2591,9 +2668,13 @@ pub fn run() { run_diagnostics, verify_files, export_diagnostics, + list_crashes, console_tail, console_risk, console_command, + custom_races_status, + custom_races_install, + custom_races_toggle_client, portable_state, portable_preflight, portable_play, diff --git a/src/dev/mock.ts b/src/dev/mock.ts index cba1688..122ad26 100644 --- a/src/dev/mock.ts +++ b/src/dev/mock.ts @@ -91,6 +91,8 @@ export {}; if(cmd==="report_targets") return [{id:"manager",repo:"Corfirean/coa-server-manager",ours:true},{id:"companions",repo:"Corfirean/mod-coa-playerbots",ours:true},{id:"squid",repo:"Zyth45/mod-playerbots",ours:false}]; if(cmd==="open_link"){(window as any).__lastLink=args.url;return null;} if(cmd==="export_diagnostics") return "C:\\Users\\you\\Desktop\\CoA-Diagnostics-20261001-140000.zip"; + if(cmd==="list_crashes") return []; + if(cmd==="install_environment"){const docker=new URLSearchParams(location.search).get("flavor")==="docker";return docker?{flavor:"docker",default_dir:"/home/you/CoaServer",docker_problem:new URLSearchParams(location.search).has("nodocker")?"permission denied while trying to connect to the Docker daemon socket":null}:{flavor:"repack",default_dir:"C:\\Games\\CoA Server",docker_problem:null};} if(cmd==="install_preflight") return {ok:true,problems:[],free_bytes:210*2**30}; if(cmd==="install_requirements") return {download_bytes:Math.round(5.9*2**30),unpacked_bytes:Math.round(11.4*2**30),version:"0.2.0"}; if(cmd==="list_accounts"){const w=window as any;w.__acc=w.__acc??[{id:2,name:"ALICE",access:3,online:true,last_login:"2026-10-01 12:04:11",characters:4},{id:5,name:"BOB",access:0,online:false,last_login:null,characters:0},{id:6,name:"CAROL",access:2,online:false,last_login:"2026-09-30 21:40:02",characters:2}];return w.__acc;} diff --git a/src/i18n/locales/de.ts b/src/i18n/locales/de.ts index ac023bd..8371e8b 100644 --- a/src/i18n/locales/de.ts +++ b/src/i18n/locales/de.ts @@ -867,6 +867,21 @@ const de: Partial> = { "fr.lan.unavailable": "Ausgewählte Adresse nicht verfügbar", "fr.lan.unavailableText": "Die ausgewählte Adresse ist derzeit keinem erkannten lokalen Netzwerkadapter zugewiesen. Wählen Sie eine andere Adresse oder Automatisch, oder behalten Sie diese Adresse bewusst bei.", "fr.lan.invalid": "Ungültige IPv4-Adresse", + "unsaved.title": "Nicht gespeicherte Änderungen", + "unsaved.message": "Sie haben nicht gespeicherte Änderungen. Möchten Sie diese vor dem Verlassen der Seite speichern?", + "unsaved.saveFailed": "Änderungen konnten nicht gespeichert werden. Bitte Eingaben überprüfen.", + "crash.autoRestart": "Automatischer Neustart bei Absturz", + "crash.autoRestartDesc": "Startet den Server automatisch neu, falls er unerwartet abstürzt.", + "crash.badge": "Abstürze: {n}", + "crash.historyTitle": "Absturzverlauf des Servers", + "crash.noCrashes": "Keine Absturzberichte gefunden.", + "crash.restartNotice": "Der Server ist abgestürzt und wurde automatisch neu gestartet (Absturz #{n}).", + "crash.loopPaused": "Automatischer Neustart pausiert: Der Server ist mehrfach kurz hintereinander abgestürzt.", + "crash.details": "Absturzdetails", + "crash.viewRaw": "Vollständigen Bericht anzeigen", + "crash.hideRaw": "Vollständigen Bericht verbergen", + "crash.copyReport": "Bericht kopieren", + "crash.copied": "Kopiert!", }; export default de; diff --git a/src/i18n/locales/en.ts b/src/i18n/locales/en.ts index 7906fe5..ebfb8aa 100644 --- a/src/i18n/locales/en.ts +++ b/src/i18n/locales/en.ts @@ -192,6 +192,14 @@ const en = { "install.localPkg": "Install from a local package folder instead of downloading", "install.localPkgHint": "(leave empty to download)", "install.button": "Install", + "install.docker.title": "Docker is needed", + "install.docker.text": "On Linux the server runs in Docker. Install Docker and start it, or allow your user to use it, then check again.", + "install.docker.retry": "Check again", + "install.data.label": "Game data folder", + "install.data.hint": "The folder with the game's dbc, maps, vmaps and mmaps. It is used where it is and never changed.", + "install.data.dialogTitle": "Choose the game data folder", + "install.linuxPkg.label": "Server package", + "install.linuxPkg.hint": "A folder or an address of the Linux server package", "install.progressTitle": "Preparing your server", "install.progressText": "This can take a few minutes. You can leave this window open.", "install.step.checking": "Checking your computer", @@ -1158,6 +1166,21 @@ const en = { "access.linkUp": "Connected to the control service: players can get accounts and claim characters.", "access.linkDown": "Not connected to the control service yet.", "access.fileStore": "Secrets are kept in a protected file, not encrypted by the system, on this computer.", + "unsaved.title": "Unsaved changes", + "unsaved.message": "You have unsaved changes. Do you want to save them before leaving this page?", + "unsaved.saveFailed": "Failed to save changes. Please check fields for errors.", + "crash.autoRestart": "Auto-restart on crash", + "crash.autoRestartDesc": "Automatically restart the world server if it crashes or stops unexpectedly.", + "crash.badge": "Crashes: {n}", + "crash.historyTitle": "Server Crash History", + "crash.noCrashes": "No crash reports found.", + "crash.restartNotice": "Server crashed and was automatically restarted (Crash #{n}).", + "crash.loopPaused": "Auto-restart paused: the server crashed repeatedly in a short period.", + "crash.details": "Crash Details", + "crash.viewRaw": "View full crash report", + "crash.hideRaw": "Hide full report", + "crash.copyReport": "Copy crash report", + "crash.copied": "Copied!", } as const; export default en; diff --git a/src/i18n/locales/es.ts b/src/i18n/locales/es.ts index 15177b3..33441b3 100644 --- a/src/i18n/locales/es.ts +++ b/src/i18n/locales/es.ts @@ -867,6 +867,21 @@ const es: Partial> = { "fr.lan.unavailable": "Dirección seleccionada no disponible", "fr.lan.unavailableText": "La dirección seleccionada no está asignada actualmente a ninguna interfaz local detectada. Elige otra dirección o Automática, o conserva esta dirección si así lo deseas.", "fr.lan.invalid": "Dirección IPv4 no válida", + "unsaved.title": "Cambios sin guardar", + "unsaved.message": "¿Tienes cambios sin guardar. ¿Quieres guardarlos antes de salir de esta página?", + "unsaved.saveFailed": "Error al guardar los cambios. Revisa los campos.", + "crash.autoRestart": "Reinicio automático tras caída", + "crash.autoRestartDesc": "Reinicia automáticamente el servidor si se detiene de forma inesperada.", + "crash.badge": "Caídas: {n}", + "crash.historyTitle": "Historial de caídas del servidor", + "crash.noCrashes": "No se encontraron informes de caídas.", + "crash.restartNotice": "El servidor se cayó y se reinició automáticamente (Caída #{n}).", + "crash.loopPaused": "Reinicio automático pausado: el servidor se ha caído varias veces en poco tiempo.", + "crash.details": "Detalles de la caída", + "crash.viewRaw": "Ver informe completo", + "crash.hideRaw": "Ocultar informe completo", + "crash.copyReport": "Copiar informe", + "crash.copied": "¡Copiado!", }; export default es; diff --git a/src/i18n/locales/fr.ts b/src/i18n/locales/fr.ts index 6e37e65..4174370 100644 --- a/src/i18n/locales/fr.ts +++ b/src/i18n/locales/fr.ts @@ -867,6 +867,21 @@ const fr: Partial> = { "fr.lan.unavailable": "Adresse sélectionnée indisponible", "fr.lan.unavailableText": "Cette adresse n’est actuellement attribuée à aucune interface locale détectée. Choisissez une autre adresse ou le mode Automatique, ou conservez volontairement cette adresse.", "fr.lan.invalid": "Adresse IPv4 non valide", + "unsaved.title": "Modifications non enregistrées", + "unsaved.message": "Vous avez des modifications non enregistrées. Voulez-vous les enregistrer avant de quitter cette page ?", + "unsaved.saveFailed": "Échec de l’enregistrement. Veuillez vérifier les champs.", + "crash.autoRestart": "Redémarrage automatique en cas de plantage", + "crash.autoRestartDesc": "Redémarre automatiquement le serveur s’il plante ou s’arrête de manière inattendue.", + "crash.badge": "Plantages : {n}", + "crash.historyTitle": "Historique des plantages du serveur", + "crash.noCrashes": "Aucun rapport de plantage trouvé.", + "crash.restartNotice": "Le serveur a planté et a été redémarré automatiquement (Plantage #{n}).", + "crash.loopPaused": "Redémarrage automatique suspendu : le serveur a planté plusieurs fois successivement.", + "crash.details": "Détails du plantage", + "crash.viewRaw": "Afficher le rapport complet", + "crash.hideRaw": "Masquer le rapport complet", + "crash.copyReport": "Copier le rapport", + "crash.copied": "Copié !", }; export default fr; diff --git a/src/i18n/locales/ru.ts b/src/i18n/locales/ru.ts index 5711684..263c642 100644 --- a/src/i18n/locales/ru.ts +++ b/src/i18n/locales/ru.ts @@ -1156,6 +1156,21 @@ const ru: Partial> = { "access.linkUp": "Подключено к службе управления: игроки могут получать аккаунты и переносить персонажей.", "access.linkDown": "К службе управления пока не подключено.", "access.fileStore": "Секреты хранятся в защищённом файле без шифрования системой на этом компьютере.", + "unsaved.title": "Несохранённые изменения", + "unsaved.message": "У вас есть несохранённые изменения. Сохранить их перед переходом на другую страницу?", + "unsaved.saveFailed": "Не удалось сохранить настройки. Проверьте правильность значений.", + "crash.autoRestart": "Автоподнятие при падении", + "crash.autoRestartDesc": "Автоматически перезапускать сервер при внезапном падении или сбое.", + "crash.badge": "Крашей: {n}", + "crash.historyTitle": "История падений сервера", + "crash.noCrashes": "Отчётов о падениях не найдено.", + "crash.restartNotice": "Сервер упал и был автоматически перезапущен (Сбой #{n}).", + "crash.loopPaused": "Автоподнятие приостановлено: сервер упал несколько раз подряд за короткое время.", + "crash.details": "Подробности сбоя", + "crash.viewRaw": "Показать полный отчёт", + "crash.hideRaw": "Скрыть полный отчёт", + "crash.copyReport": "Скопировать отчёт", + "crash.copied": "Скопировано!", }; export default ru; diff --git a/src/i18n/locales/zh.ts b/src/i18n/locales/zh.ts index 72e8d16..a9e6fb3 100644 --- a/src/i18n/locales/zh.ts +++ b/src/i18n/locales/zh.ts @@ -869,6 +869,21 @@ const zh = { "fr.lan.unavailable": "所选地址不可用", "fr.lan.unavailableText": "所选地址目前未分配给检测到的本地网络接口。请选择其他地址、切换到自动,或有意保留此地址。", "fr.lan.invalid": "无效的 IPv4 地址", + "unsaved.title": "未保存的修改", + "unsaved.message": "您有未保存的修改。是否在离开前保存?", + "unsaved.saveFailed": "保存失败,请检查填写内容。", + "crash.autoRestart": "崩溃后自动重启", + "crash.autoRestartDesc": "如果服务器意外崩溃或停止,自动重新拉起。", + "crash.badge": "崩溃次数: {n}", + "crash.historyTitle": "服务器崩溃记录", + "crash.noCrashes": "未找到崩溃日志。", + "crash.restartNotice": "服务器崩溃并已自动重新拉起(崩溃 #{n})。", + "crash.loopPaused": "自动重启已暂停:服务器在短时间内连续崩溃。", + "crash.details": "崩溃详情", + "crash.viewRaw": "查看完整日志", + "crash.hideRaw": "隐藏完整日志", + "crash.copyReport": "复制崩溃报告", + "crash.copied": "已复制!", } as const; export default zh; diff --git a/src/lib/api.ts b/src/lib/api.ts index b580709..9d11c35 100644 --- a/src/lib/api.ts +++ b/src/lib/api.ts @@ -265,6 +265,16 @@ export interface ReportTarget { ours: boolean; } +/** The kind of server this computer installs: a repack (Windows) or Docker containers (Linux). */ +export type Flavor = "repack" | "docker"; + +export interface InstallEnvironment { + flavor: Flavor; + default_dir: string; + /** Why Docker cannot be used, in its own words; null when it works. */ + docker_problem: string | null; +} + export interface InstallRequirements { download_bytes: number; unpacked_bytes: number; @@ -379,6 +389,22 @@ export interface ClientDownloadCheck { dest: string; } +export type ClientPatchState = "not-installed" | "enabled" | "disabled" | "partially-installed"; + +export interface CustomRacesClientStatus { + state: ClientPatchState; + installedMpqs: number; + totalMpqs: number; + hasRootFiles: boolean; + clientPath: string | null; +} + +export interface CustomRacesProgress { + id: string; + step: string; + percent: number; +} + export type FriendsMode = "local" | "lan" | "direct" | "private"; export interface LanAddress { @@ -421,6 +447,21 @@ export interface ConsoleLine { level: "info" | "warn" | "error"; } +export interface CrashItem { + id: string; + timestamp_ms: number; + date_str: string; + title: string; + explanation: string; + category: "assertion" | "access_violation" | "stack_overflow" | "out_of_memory" | "database" | "network" | "exception" | "generic"; + exception_code?: string | null; + location?: string | null; + function?: string | null; + condition?: string | null; + preview: string; + full_log: string; +} + export const api = { remoteConnection: () => invoke("remote_connection"), remoteConnect: (host: string) => invoke("remote_connect", { host }), @@ -454,7 +495,8 @@ export const api = { deleteBackup: (id: string, backupId: string) => invoke("delete_backup", { id, backupId }), restoreConfigs: (id: string, backupId: string) => invoke("restore_backup_configs", { id, backupId }), restoreDatabase: (id: string, backupId: string, database: string) => invoke("restore_backup_database", { id, backupId, database }), - installPreflight: (dest: string, needed?: number) => invoke("install_preflight", { dest, needed: needed ?? null }), + installEnvironment: () => invoke("install_environment"), + installPreflight: (dest: string, needed?: number, gameData?: string) => invoke("install_preflight", { dest, needed: needed ?? null, gameData: gameData ?? null }), installRequirements: (pkg?: string) => invoke("install_requirements", { package: pkg ?? null }), realmlistProfiles: (id: string) => invoke<{ profiles: RealmProfile[]; active: string | null }>("realmlist_profiles", { id }), realmlistSave: (id: string, profileId: string | null, name: string, data: string) => invoke("realmlist_save", { id, profileId, name, data }), @@ -473,7 +515,7 @@ export const api = { accountSetAccess: (id: string, name: string, level: number) => invoke("account_set_access", { id, name, level }), accountRename: (id: string, name: string, newName: string, password: string) => invoke("account_rename", { id, name, newName, password }), accountDelete: (id: string, name: string) => invoke("account_delete", { id, name }), - installNew: (dest: string, pkg?: string) => invoke("install_new", { dest, package: pkg ?? null }), + installNew: (dest: string, pkg?: string, gameData?: string) => invoke("install_new", { dest, package: pkg ?? null, gameData: gameData ?? null }), cancelInstall: () => invoke("cancel_install"), createAccount: (id: string, username: string, password: string, administrator: boolean) => invoke("create_account", { id, username, password, administrator }), @@ -503,6 +545,9 @@ export const api = { clientSync: (id: string, keepModified: boolean) => invoke("client_sync", { id, keepModified }), clientDownload: (id: string, parent: string) => invoke("client_download", { id, parent }), clientCancel: () => invoke("client_cancel"), + customRacesStatus: (id: string) => invoke("custom_races_status", { id }), + customRacesInstall: (id: string) => invoke("custom_races_install", { id }), + customRacesToggleClient: (id: string, enabled: boolean) => invoke("custom_races_toggle_client", { id, enabled }), play: (id: string) => invoke("play", { id }), friendsStatus: (id: string) => invoke("friends_status", { id }), friendsCheckInternet: () => invoke("friends_check_internet"), @@ -512,6 +557,7 @@ export const api = { runDiagnostics: (id: string) => invoke<{ checks: DiagCheck[]; problems: number }>("run_diagnostics", { id }), verifyFiles: (id: string) => invoke<{ path: string; kind: "missing" | "changed" }[]>("verify_files", { id }), exportDiagnostics: (id: string) => invoke("export_diagnostics", { id }), + listCrashes: (id: string, limit?: number) => invoke("list_crashes", { id, limit: limit ?? null }), consoleTail: (id: string, source: ConsoleSource, filter?: string, lines = 300) => invoke("console_tail", { id, source, filter: filter ?? null, lines }), consoleRisk: (command: string) => invoke<"normal" | "dangerous">("console_risk", { command }), diff --git a/src/lib/autoRestartPrefs.ts b/src/lib/autoRestartPrefs.ts new file mode 100644 index 0000000..48ee8e1 --- /dev/null +++ b/src/lib/autoRestartPrefs.ts @@ -0,0 +1,32 @@ +import { useState } from "react"; + +const key = (id: string) => `coa-auto-restart-on-crash:${id}`; +const fallback = () => false; + +export function autoRestartOnCrash(id: string): boolean { + try { + const value = localStorage.getItem(key(id)); + return value === null ? fallback() : value === "1"; + } catch { + return fallback(); + } +} + +export function setAutoRestartOnCrash(id: string, on: boolean) { + try { + localStorage.setItem(key(id), on ? "1" : "0"); + } catch { + /* storage unavailable */ + } +} + +export function useAutoRestart(id: string): [boolean, (on: boolean) => void] { + const [on, setOn] = useState(() => autoRestartOnCrash(id)); + return [ + on, + (next) => { + setAutoRestartOnCrash(id, next); + setOn(next); + }, + ]; +} diff --git a/src/lib/moduleSettings.ts b/src/lib/moduleSettings.ts index 3a71d16..764645a 100644 --- a/src/lib/moduleSettings.ts +++ b/src/lib/moduleSettings.ts @@ -85,6 +85,11 @@ for (const [key, title, desc] of [ ] as [string, string[], string[]][]) add(`Enchanter.${key}`, "int", title, desc, { min: 0, advanced: true }); for (let n = 1; n <= 3; n++) add(`EC.P${n}`, "string", [`NPC phrase ${n}`, `Реплика НПС ${n}`, `NPC-Satz ${n}`, `Phrase du PNJ ${n}`, `Frase del PNJ ${n}`, `NPC台词 ${n}`], ["Text spoken by the NPC. Keep the enclosing quotes.", "Текст реплики НПС. Сохраните кавычки вокруг текста.", "Gesprochener Text. Anführungszeichen beibehalten.", "Texte prononcé. Conservez les guillemets.", "Texto hablado. Conserva las comillas.", "NPC发言内容,请保留外层引号。"], { advanced: true }); +add("CoACustomRaces.BotsEnable", "bool", + ["Bots can be custom races", "Боты кастомных рас", "Bots benutzerdefinierter Völker", "Bots de races personnalisées", "Bots de razas personalizadas", "允许机器人为自定义种族"], + ["Allow Playerbots to spawn as custom races.", "Разрешает ботам-игрокам появляться кастомными расами.", "Erlaubt Spieler-Bots, benutzerdefinierte Völker zu nutzen.", "Autorise les bots joueurs à s’incarner avec des races personnalisées.", "Permite a los bots jugadores crearse con razas personalizadas.", "允许玩家机器人扮演自定义种族。"] +); + const ah = "AuctionHouseBot."; add(ah + "GUIDs", "string", ["Auction characters", "Персонажи аукциона", "Auktionscharaktere", "Personnages d’enchères", "Personajes de subasta", "拍卖角色"], ["Leave 0 and the server creates and uses its own auction character. To use your own, enter GUIDs separated by commas, without spaces; use dedicated offline characters, not companion bots.", "Оставьте 0, и сервер сам создаст и будет использовать своего персонажа аукциона. Чтобы использовать своих, укажите GUID через запятую без пробелов; нужны отдельные офлайн-персонажи, не боты-компаньоны.", "Bei 0 legt der Server selbst einen Auktionscharakter an und nutzt ihn. Eigene Charaktere: GUIDs durch Kommas, ohne Leerzeichen; separate Offline-Charaktere verwenden, keine Begleiter-Bots.", "Laissez 0 : le serveur crée et utilise son propre personnage d’enchères. Pour les vôtres, indiquez des GUID séparés par des virgules sans espaces ; personnages dédiés hors ligne, pas des bots compagnons.", "Deja 0 y el servidor crea y usa su propio personaje de subastas. Para usar los tuyos, indica GUID separados por comas sin espacios; personajes dedicados desconectados, no bots acompañantes.", "保持0时由服务器自动创建并使用拍卖角色。要使用自己的角色,请以逗号分隔填写GUID,不加空格;使用专用离线角色,勿用伙伴机器人。"], { advanced: true }); add(ah + "EnableSeller", "bool", ["Post auctions", "Выставлять лоты", "Auktionen einstellen", "Publier des enchères", "Publicar subastas", "发布拍卖"], ["Let the auction characters sell items. The module switch is also required.", "Разрешает персонажам продавать предметы. Нужен включённый модуль.", "Erlaubt Verkäufe. Der Modulschalter muss ebenfalls aktiv sein.", "Autorise les ventes. Le module doit aussi être activé.", "Permite vender. También requiere el módulo activado.", "允许拍卖角色出售物品,还需启用模块。"]); diff --git a/src/lib/unsavedGuard.ts b/src/lib/unsavedGuard.ts new file mode 100644 index 0000000..2e0db84 --- /dev/null +++ b/src/lib/unsavedGuard.ts @@ -0,0 +1,5 @@ +export interface UnsavedChangesGuard { + isDirty: () => boolean; + save: () => Promise; + discard: () => void; +} diff --git a/src/screens/AutoRestartSettings.tsx b/src/screens/AutoRestartSettings.tsx new file mode 100644 index 0000000..78c521c --- /dev/null +++ b/src/screens/AutoRestartSettings.tsx @@ -0,0 +1,24 @@ +import { Card } from "@/components/ui/card"; +import { useT } from "@/i18n"; +import { useAutoRestart } from "@/lib/autoRestartPrefs"; + +export function AutoRestartSettings({ serverId }: { serverId: string }) { + const t = useT(); + const [autoRestart, setAutoRestart] = useAutoRestart(serverId); + + return ( + +

{t("crash.autoRestart")}

+ +

{t("crash.autoRestartDesc")}

+
+ ); +} diff --git a/src/screens/CrashHistoryModal.tsx b/src/screens/CrashHistoryModal.tsx new file mode 100644 index 0000000..b795935 --- /dev/null +++ b/src/screens/CrashHistoryModal.tsx @@ -0,0 +1,198 @@ +import { useEffect, useState } from "react"; +import { AlertTriangle, Check, ChevronDown, ChevronUp, Copy, Loader2, X } from "lucide-react"; +import { api, type CrashItem } from "@/lib/api"; +import { Button } from "@/components/ui/button"; +import { Card } from "@/components/ui/card"; +import { useT } from "@/i18n"; + +export function CrashHistoryModal({ + serverId, + onClose, +}: { + serverId: string; + onClose: () => void; +}) { + const t = useT(); + const [loading, setLoading] = useState(true); + const [crashes, setCrashes] = useState([]); + const [expandedId, setExpandedId] = useState(null); + const [copiedId, setCopiedId] = useState(null); + + useEffect(() => { + let alive = true; + void api + .listCrashes(serverId, 30) + .then((items) => { + if (alive) { + setCrashes(items); + setLoading(false); + } + }) + .catch(() => { + if (alive) setLoading(false); + }); + return () => { + alive = false; + }; + }, [serverId]); + + useEffect(() => { + const onKey = (e: KeyboardEvent) => { + if (e.key === "Escape") onClose(); + }; + window.addEventListener("keydown", onKey); + return () => window.removeEventListener("keydown", onKey); + }, [onClose]); + + const copyReport = async (item: CrashItem) => { + try { + await navigator.clipboard.writeText(item.full_log); + setCopiedId(item.id); + setTimeout(() => setCopiedId(null), 2500); + } catch { + /* clipboard write failed */ + } + }; + + const getCategoryColor = (category: CrashItem["category"]) => { + switch (category) { + case "assertion": + return "bg-amber-500/15 text-amber-400 border-amber-500/30"; + case "access_violation": + case "stack_overflow": + case "out_of_memory": + return "bg-bad/15 text-bad border-bad/30"; + case "network": + case "database": + return "bg-blue-500/15 text-blue-400 border-blue-500/30"; + default: + return "bg-muted/15 text-muted border-line"; + } + }; + + return ( +
{ + if (e.target === e.currentTarget) onClose(); + }} + > + +
+
+ +

{t("crash.historyTitle")}

+
+ +
+ +
+ {loading ? ( +
+ +
+ ) : crashes.length === 0 ? ( +
+

{t("crash.noCrashes")}

+
+ ) : ( +
+ {crashes.map((item) => { + const isExpanded = expandedId === item.id; + const isCopied = copiedId === item.id; + return ( +
+
+
+ + {item.exception_code ? `${item.category} (${item.exception_code})` : item.category} + +

{item.title}

+
+ {item.date_str} +
+ +

{item.explanation}

+ +
+ + + +
+ + {isExpanded && ( +
+
+                          {item.full_log}
+                        
+
+ )} +
+ ); + })} +
+ )} +
+ +
+ +
+
+
+ ); +} diff --git a/src/screens/InstallServer.tsx b/src/screens/InstallServer.tsx index c9f92f8..230c5c4 100644 --- a/src/screens/InstallServer.tsx +++ b/src/screens/InstallServer.tsx @@ -2,7 +2,7 @@ import { useEffect, useState } from "react"; import { listen } from "@tauri-apps/api/event"; import { open } from "@tauri-apps/plugin-dialog"; import { Check, ChevronDown, ChevronRight, Loader2 } from "lucide-react"; -import { api, asUiError, type InstallRequirements, type InstallStep, type Preflight, type ServerSummary, type UiError } from "@/lib/api"; +import { api, asUiError, type InstallEnvironment, type InstallRequirements, type InstallStep, type Preflight, type ServerSummary, type UiError } from "@/lib/api"; import { formatBytes } from "@/lib/utils"; import { Button } from "@/components/ui/button"; import { Card } from "@/components/ui/card"; @@ -33,6 +33,19 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void; const [pkg, setPkg] = useState(""); const [installed, setInstalled] = useState(null); const [showDetails, setShowDetails] = useState(false); + // What this computer installs. A repack (Windows) needs nothing more than a folder; Docker (Linux) also needs the game data + // folder and a package, and Docker itself. + const [env, setEnv] = useState(null); + const [gameData, setGameData] = useState(""); + const docker = env?.flavor === "docker"; + + function loadEnvironment(first: boolean) { + void api.installEnvironment().then((e) => { + setEnv(e); + if (first && e.flavor === "docker") setDest(e.default_dir); + }).catch(() => setEnv(null)); + } + useEffect(() => loadEnvironment(true), []); // how big the server is, from the package's signed list (re-read when another package source is entered) useEffect(() => { @@ -43,9 +56,9 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void; // room for the unpacked server plus the download that is removed afterwards const needed = req ? req.unpacked_bytes + req.download_bytes : undefined; useEffect(() => { - const timer = setTimeout(() => void api.installPreflight(dest, needed).then(setPre).catch(() => setPre(null)), 250); + const timer = setTimeout(() => void api.installPreflight(dest, needed, docker ? gameData.trim() : undefined).then(setPre).catch(() => setPre(null)), 250); return () => clearTimeout(timer); - }, [dest, needed]); + }, [dest, needed, docker, gameData]); useEffect(() => { const un = listen("install-progress", (e) => setStep(e.payload)); @@ -56,7 +69,12 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void; async function browse() { const picked = await open({ directory: true, multiple: false, title: t("install.dialogTitle") }); - if (typeof picked === "string") setDest(picked.replace(/[\\/]+$/, "") + (picked.toLowerCase().includes("coa") ? "" : "\\CoA Server")); + if (typeof picked === "string") setDest(picked.replace(/[\\/]+$/, "") + (picked.toLowerCase().includes("coa") ? "" : docker ? "/CoaServer" : "\\CoA Server")); + } + + async function browseGameData() { + const picked = await open({ directory: true, multiple: false, title: t("install.data.dialogTitle") }); + if (typeof picked === "string") setGameData(picked); } async function browsePackage() { @@ -69,7 +87,7 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void; setPhase("installing"); setStep({ step: "Preparing your server", percent: 0, detail: null }); try { - const s = await api.installNew(dest, pkg.trim() || undefined); + const s = await api.installNew(dest, pkg.trim() || undefined, docker ? gameData.trim() : undefined); setInstalled(s); setPhase("done"); } catch (e) { @@ -139,9 +157,34 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void; - {pre && pre.problems.length > 0 && ( + {docker && ( +
+ +
+ setGameData(e.target.value)} className="selectable flex-1 rounded-md border border-line bg-card px-3 py-2.5 text-[15px] outline-none focus:border-gold" /> + +
+

{t("install.data.hint")}

+ +
+ setPkg(e.target.value)} placeholder={t("install.linuxPkg.hint")} className="selectable flex-1 rounded-md border border-line bg-card px-3 py-2.5 text-[15px] outline-none focus:border-gold" /> + +
+
+ )} + + {docker && env?.docker_problem && ( - {pre.problems.map((p) => ( +

{t("install.docker.title")}

+

{t("install.docker.text")}

+
{env.docker_problem}
+ +
+ )} + + {pre && pre.problems.some((p) => !(docker && !gameData.trim() && p.code.startsWith("data"))) && ( + + {pre.problems.filter((p) => !(docker && !gameData.trim() && p.code.startsWith("data"))).map((p) => (

{p.message}

))}
@@ -170,7 +213,7 @@ export function InstallServer(props: { canCancel: boolean; onCancel: () => void; )} -
+ {!docker &&
)} - + }
- {props.canCancel && ( diff --git a/src/screens/ModulesPage.tsx b/src/screens/ModulesPage.tsx index 55a9c29..5843dbd 100644 --- a/src/screens/ModulesPage.tsx +++ b/src/screens/ModulesPage.tsx @@ -1,12 +1,14 @@ import { Fragment, useCallback, useEffect, useRef, useState, type ComponentType, type ReactNode } from "react"; -import { Bot, Flame, Gavel, Loader2, Plug, Puzzle, Scaling, Settings2, Snowflake, Sparkles, Swords, type LucideProps } from "lucide-react"; -import { api, asUiError, type ModuleSetting, type ModuleView, type UiError } from "@/lib/api"; +import { listen } from "@tauri-apps/api/event"; +import { Bot, Flame, Gavel, Loader2, Plug, Puzzle, Scaling, Settings2, Snowflake, Sparkles, Swords, Users, type LucideProps } from "lucide-react"; +import { api, asUiError, type CustomRacesClientStatus, type CustomRacesProgress, type ModuleSetting, type ModuleView, type UiError } from "@/lib/api"; import { cn } from "@/lib/utils"; import { Button } from "@/components/ui/button"; import { Card } from "@/components/ui/card"; import { useHuman, useI18n, useSchemaText, type Key } from "@/i18n"; import { auctionWeightKey, canonicalModuleValue, moduleEnableKey, moduleField } from "@/lib/moduleSettings"; import { AuctionTypes } from "@/screens/AuctionTypes"; +import type { UnsavedChangesGuard } from "@/lib/unsavedGuard"; /** The GitHub mark (lucide dropped its brand icons). */ function GithubMark(props: { className?: string }) { @@ -27,6 +29,7 @@ const TILES: Record; from: string; to gavel: { icon: Gavel, from: "from-yellow-500", to: "to-amber-700" }, sparkles: { icon: Sparkles, from: "from-fuchsia-500", to: "to-purple-700" }, swords: { icon: Swords, from: "from-rose-500", to: "to-red-800" }, + races: { icon: Users, from: "from-cyan-500", to: "to-blue-800" }, }; const DEFAULT_TILE = { icon: Puzzle, from: "from-slate-500", to: "to-slate-700" }; @@ -78,25 +81,68 @@ function Tile({ icon, off }: { icon: string; off: boolean }) { } /** The server's optional modules: square cards with a switch, the module's status, a link to GitHub and its settings. */ -export function ModulesPage({ serverId, onChanged }: { serverId: string; onChanged?: () => void }) { +export function ModulesPage({ serverId, onChanged, onRegisterGuard }: { serverId: string; onChanged?: () => void; onRegisterGuard?: (guard: UnsavedChangesGuard | null) => void }) { const { t, locale } = useI18n(); const human = useHuman(); const [modules, setModules] = useState(null); const [open, setOpen] = useState(null); const [error, setError] = useState(null); const [changed, setChanged] = useState(false); + const [racesPatchStatus, setRacesPatchStatus] = useState(null); + const [racesInstalling, setRacesInstalling] = useState(false); + const [racesProgress, setRacesProgress] = useState(null); + + const loadRacesStatus = useCallback(async () => { + try { + const st = await api.customRacesStatus(serverId); + setRacesPatchStatus(st); + } catch { + // ignore + } + }, [serverId]); + const [guard, setGuard] = useState(null); + + useEffect(() => { + onRegisterGuard?.(guard); + return () => onRegisterGuard?.(null); + }, [guard, onRegisterGuard]); const load = useCallback(async () => { try { setModules((await api.modulesList(serverId)).filter((m) => !m.hidden)); + await loadRacesStatus(); } catch (e) { setError(asUiError(e)); } - }, [serverId]); + }, [serverId, loadRacesStatus]); useEffect(() => { void load(); - }, [load]); + const un = listen("custom-races-progress", (e) => { + if (e.payload.id === serverId) { + setRacesProgress(e.payload); + } + }); + return () => { + void un.then((f) => f()); + }; + }, [load, serverId]); + + async function installClientPatch() { + setRacesInstalling(true); + setError(null); + try { + await api.customRacesInstall(serverId); + await loadRacesStatus(); + await load(); + onChanged?.(); + } catch (e) { + setError(asUiError(e)); + } finally { + setRacesInstalling(false); + setRacesProgress(null); + } + } async function toggle(m: ModuleView) { setError(null); @@ -104,6 +150,9 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang await api.moduleSetEnabled(serverId, m.id, !m.enabled); setChanged(true); await load(); + if (m.id === "custom-races") { + await loadRacesStatus(); + } onChanged?.(); } catch (e) { setError(asUiError(e)); @@ -145,8 +194,9 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang role="switch" aria-checked={m.enabled} aria-label={t("mod.switch", { name: m.name })} + disabled={m.id === "custom-races" && racesInstalling} onClick={() => void toggle(m)} - className={cn("relative mt-1 h-6 w-11 shrink-0 cursor-pointer rounded-full transition-colors", m.enabled ? "bg-gold" : "bg-white/15")} + className={cn("relative mt-1 h-6 w-11 shrink-0 cursor-pointer rounded-full transition-colors", m.enabled ? "bg-gold" : "bg-white/15", (m.id === "custom-races" && racesInstalling) && "opacity-50 cursor-not-allowed")} > @@ -154,6 +204,70 @@ export function ModulesPage({ serverId, onChanged }: { serverId: string; onChang {m.installed && !m.switchable && m.status !== "soon" && m.compatibility !== "unsupported" && {t("mod.alwaysOn")}} {!m.installed && m.status !== "soon" && {t("mod.notHere")}}
+ {m.id === "custom-races" && ( +
+ {racesInstalling && racesProgress ? ( +
+
+ + + {racesProgress.step} + + + {Math.round(racesProgress.percent * 100)}% + +
+
+
+
+
+ ) : ( +
+
+ {racesPatchStatus?.state === "enabled" && ( + + + {locale === "ru" ? "Патч клиента: Включен" : "Client Patch: Active"} + + )} + {racesPatchStatus?.state === "disabled" && ( + + + {locale === "ru" ? "Патч клиента: Отключен (.disabled)" : "Client Patch: Disabled (.disabled)"} + + )} + {racesPatchStatus?.state === "not-installed" && ( + + + {locale === "ru" ? "Патч клиента: Не установлен" : "Client Patch: Not Installed"} + + )} + {racesPatchStatus?.state === "partially-installed" && ( + + + {locale === "ru" ? `Патч клиента: ${racesPatchStatus.installedMpqs}/${racesPatchStatus.totalMpqs} MPQ` : `Client Patch: ${racesPatchStatus.installedMpqs}/${racesPatchStatus.totalMpqs} MPQ`} + + )} +
+ {(!racesPatchStatus || racesPatchStatus.state === "not-installed" || racesPatchStatus.state === "partially-installed") && ( + + )} +
+ )} +
+ )}
} {error &&

{error.human.code === "unknown" ? error.technical : human(error.human).message}

} + {dirty && ( +
+ {tn("set.unsaved", Object.keys(edits).length)} +
+ + +
+
+ )}
); } diff --git a/src/screens/Overview.tsx b/src/screens/Overview.tsx index ee3ebac..58175c7 100644 --- a/src/screens/Overview.tsx +++ b/src/screens/Overview.tsx @@ -1,6 +1,6 @@ import { dismissClientJob, startClientUpdate, stopClientJob, syncClient, useClientJob } from "@/lib/clientJob"; import { useCallback, useEffect, useRef, useState } from "react"; -import { Loader2, X } from "lucide-react"; +import { AlertTriangle, Loader2, X } from "lucide-react"; import { api, asUiError, type ClientInfo, type Human, type Performance, type Population, type ServerSummary, type ServiceStatus, type StatusView } from "@/lib/api"; import { cn, formatBytes, formatUptime } from "@/lib/utils"; import { useHuman, useT } from "@/i18n"; @@ -9,6 +9,8 @@ import { checkClient, useClientStatus } from "@/lib/clientUpdate"; import { ClientDialog, type ClientDialogMode } from "@/screens/ClientDialog"; import { RealmlistMenu } from "@/screens/RealmlistMenu"; import { RealmPicker } from "@/screens/RealmPicker"; +import { CrashHistoryModal } from "@/screens/CrashHistoryModal"; +import { useAutoRestart } from "@/lib/autoRestartPrefs"; import { Button } from "@/components/ui/button"; import { Card } from "@/components/ui/card"; @@ -98,6 +100,35 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o const upd = useServerUpdate(server.id); const needsDecision = (upd.preview?.conflicts.length ?? 0) > 0; const [startBots, setStartBots] = useState(undefined); + const [autoRestart, setAutoRestart] = useAutoRestart(server.id); + const autoRestartRef = useRef(autoRestart); + autoRestartRef.current = autoRestart; + + const [crashCount, setCrashCount] = useState(0); + const crashCountRef = useRef(0); + const [showCrashModal, setShowCrashModal] = useState(false); + const [hasCrashHistory, setHasCrashHistory] = useState(false); + const [crashLoopPaused, setCrashLoopPaused] = useState(false); + const [crashRestartNotice, setCrashRestartNotice] = useState(null); + + const userStoppedRef = useRef(false); + const wasWorldRunningRef = useRef(false); + const actionRef = useRef(null); + const crashTimestampsRef = useRef([]); + const pollRef = useRef<() => Promise>(undefined); + + useEffect(() => { + let active = true; + void api + .listCrashes(server.id, 1) + .then((items) => { + if (active && items.length > 0) setHasCrashHistory(true); + }) + .catch(() => {}); + return () => { + active = false; + }; + }, [server.id]); useEffect(() => { void api @@ -115,18 +146,87 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o if (job.phase === "done" || job.phase === "current") void api.clientInfo(server.id).then(setClient).catch(() => undefined); }, [job.phase, server.id]); + const run = useCallback( + async (kind: Exclude) => { + if (kind === "stopping") { + userStoppedRef.current = true; + } else { + userStoppedRef.current = false; + setCrashLoopPaused(false); + setCrashRestartNotice(null); + } + setFailure(null); + setShowDetails(false); + setAction(kind); + actionRef.current = kind; + try { + if (kind !== "starting") { + const out = await api.stop(server.id); + if (!out.ok) throw { human: out.human, technical: out.output }; + } + if (kind !== "stopping") { + setAction("starting"); + actionRef.current = "starting"; + const out = await api.start(server.id); + if (!out.ok) throw { human: out.human, technical: out.output }; + } + } catch (e) { + const ui = asUiError(e); + setFailure({ human: ui.human ?? asUiError(String(e)).human, technical: ui.technical }); + } finally { + setAction(null); + actionRef.current = null; + void pollRef.current?.(); + } + }, + [server.id], + ); + const poll = useCallback(async () => { try { const s = await api.status(server.id); if (alive.current) setStatus(s); - if (s.observed.world.state === "running") { + const isWorldRunning = s.observed.world.state === "running"; + if (isWorldRunning) { + wasWorldRunningRef.current = true; + userStoppedRef.current = false; const p = await api.population(server.id).catch(() => null); if (alive.current) setPop(p); - } else if (alive.current) setPop(null); + } else { + if (alive.current) setPop(null); + if ( + wasWorldRunningRef.current && + !userStoppedRef.current && + actionRef.current === null + ) { + wasWorldRunningRef.current = false; + setHasCrashHistory(true); + const now = Date.now(); + const recent = crashTimestampsRef.current.filter((ts) => now - ts < 180000); + recent.push(now); + crashTimestampsRef.current = recent; + + crashCountRef.current += 1; + const currentCrashCount = crashCountRef.current; + setCrashCount(currentCrashCount); + + if (recent.length >= 3) { + setCrashLoopPaused(true); + setCrashRestartNotice(null); + } else if (autoRestartRef.current) { + setCrashRestartNotice(t("crash.restartNotice", { n: currentCrashCount })); + void run("starting"); + } + } + } } catch { /* transient; next poll retries */ } - }, [server.id]); + }, [server.id, t, run]); + + useEffect(() => { + pollRef.current = poll; + }, [poll]); // The tick rate comes from the server console (one short connection per reading), so it is read less often. const worldUp = status?.observed.world.state === "running"; @@ -156,29 +256,6 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o }; }, [poll]); - async function run(kind: Exclude) { - setFailure(null); - setShowDetails(false); - setAction(kind); - try { - if (kind !== "starting") { - const out = await api.stop(server.id); - if (!out.ok) throw { human: out.human, technical: out.output }; - } - if (kind !== "stopping") { - setAction("starting"); - const out = await api.start(server.id); - if (!out.ok) throw { human: out.human, technical: out.output }; - } - } catch (e) { - const ui = asUiError(e); - setFailure({ human: ui.human ?? asUiError(String(e)).human, technical: ui.technical }); - } finally { - setAction(null); - void poll(); - } - } - async function play() { setFailure(null); setShowDetails(false); @@ -234,13 +311,56 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o
{realms ? `${realms.first} · ${t("overview.server")}` : t("overview.server")}
-
- - {headline} +
+
+ + {headline} +
+ {(crashCount > 0 || hasCrashHistory) && ( + + )}
+ {crashRestartNotice && !crashLoopPaused && ( +
+ {crashRestartNotice} + +
+ )} + {crashLoopPaused && ( +
+ {t("crash.loopPaused")} + +
+ )} {!transitioning && !running && anyUp && (

{t("overview.reportHint")}{" "} @@ -363,6 +483,27 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o )}

+
+ + {(crashCount > 0 || hasCrashHistory) && ( + + )} +
{anyUp && !running && !transitioning && (

{t("overview.partial")}

)} @@ -477,6 +618,13 @@ export function Overview({ server, companions = true, onForget, onOpenUpdates, o onPlayAnyway={() => void play()} /> )} + + {showCrashModal && ( + setShowCrashModal(false)} + /> + )} ); } diff --git a/src/screens/SettingsHome.tsx b/src/screens/SettingsHome.tsx index 8fb6391..8786f28 100644 --- a/src/screens/SettingsHome.tsx +++ b/src/screens/SettingsHome.tsx @@ -16,6 +16,7 @@ import { LanguagePicker } from "@/components/LanguagePicker"; import { RealmStartupSettings } from "@/screens/RealmStartupSettings"; import { RepairCard } from "@/screens/RepairCard"; import { PublishCard } from "@/screens/PublishCard"; +import { AutoRestartSettings } from "@/screens/AutoRestartSettings"; function mb(bytes: number) { return bytes >= 1 << 20 ? `${(bytes / (1 << 20)).toFixed(1)} MB` : `${Math.max(1, Math.round(bytes / 1024))} KB`; @@ -172,6 +173,7 @@ export function SettingsHome({ serverId, serverName = "", path, onForget }: { se + diff --git a/src/screens/SettingsPage.tsx b/src/screens/SettingsPage.tsx index 6d03c6e..ceb2172 100644 --- a/src/screens/SettingsPage.tsx +++ b/src/screens/SettingsPage.tsx @@ -22,6 +22,7 @@ import { Card } from "@/components/ui/card"; import { CollectionRows, RawRows, collectionsOf } from "@/screens/ExtraRows"; import { CompanionsCard } from "@/screens/CompanionsCard"; import { useHuman, useI18n, useSchemaText, useT, type Key } from "@/i18n"; +import type { UnsavedChangesGuard } from "@/lib/unsavedGuard"; type T = (k: Key, v?: Record) => string; @@ -154,7 +155,14 @@ function Row(props: { s: SettingView; value: JsonValue; error: string | null; on ); } -export function SettingsPage(props: { serverId: string; scope: Scope; botModule?: "companions" | "playerbots"; title: string; question: string }) { +export function SettingsPage(props: { + serverId: string; + scope: Scope; + botModule?: "companions" | "playerbots"; + title: string; + question: string; + onRegisterGuard?: (guard: UnsavedChangesGuard | null) => void; +}) { const { serverId, scope } = props; const { t, tn, locale } = useI18n(); const squid = scope === "bots" && props.botModule === "playerbots"; @@ -317,10 +325,10 @@ export function SettingsPage(props: { serverId: string; scope: Scope; botModule? } /** The save bar saves all three kinds of edits: the curated settings, the collection switches and the other documented ones. */ - async function saveEverything() { - if (dirtyKeys.length && !(await save(Object.fromEntries(dirtyKeys.map((k) => [k, draft[k]]))))) return; + async function saveEverything(): Promise { + if (dirtyKeys.length && !(await save(Object.fromEntries(dirtyKeys.map((k) => [k, draft[k]]))))) return false; const extra = [...Object.keys(rawEdits), ...Object.keys(colEdits)]; - if (!extra.length) return; + if (!extra.length) return true; setBusy(true); setSaveErr(null); try { @@ -337,13 +345,33 @@ export function SettingsPage(props: { serverId: string; scope: Scope; botModule? const more = extra.map((key) => ({ key, title: key, restart: "world" as const, dangerous: false })); setSaved((prev) => ({ changed: [...(prev?.changed ?? []), ...more], restart: prev?.restart ?? "world", snapshot: prev?.snapshot ?? null })); void api.status(serverId).then((st) => setRunning(st.observed.world.state === "running")); + return true; } catch (e) { setSaveErr(asUiError(e)); + return false; } finally { setBusy(false); } } + useEffect(() => { + if (pending > 0) { + props.onRegisterGuard?.({ + isDirty: () => pending > 0, + save: () => saveEverything(), + discard: () => { + setDraft({}); + setErrors({}); + setRawEdits({}); + setColEdits({}); + }, + }); + } else { + props.onRegisterGuard?.(null); + } + return () => props.onRegisterGuard?.(null); + }, [pending, props.onRegisterGuard]); + async function openPreset(id: string) { setSaved(null); if (squid) { diff --git a/src/screens/Shell.tsx b/src/screens/Shell.tsx index 900e875..4ee61ed 100644 --- a/src/screens/Shell.tsx +++ b/src/screens/Shell.tsx @@ -1,5 +1,5 @@ -import { useCallback, useEffect, useState } from "react"; -import { Archive, BarChart3, Bot, Bug, Gauge, Globe, Puzzle, Server, Settings, Swords, Terminal, Users, type LucideIcon } from "lucide-react"; +import { useCallback, useEffect, useRef, useState } from "react"; +import { Archive, BarChart3, Bot, Bug, Gauge, Globe, Loader2, Puzzle, Server, Settings, Swords, Terminal, Users, type LucideIcon } from "lucide-react"; import { api, type ServerSummary } from "@/lib/api"; import { useT, type Key } from "@/i18n"; import logo from "@/assets/logo.png"; @@ -17,8 +17,10 @@ import { ConsolePage } from "@/screens/ConsolePage"; import { PortablePage } from "@/screens/PortablePage"; import { DashboardPage } from "@/screens/DashboardPage"; import { Button } from "@/components/ui/button"; +import { Card } from "@/components/ui/card"; import { startServerUpdatePolling, useServerUpdate } from "@/lib/serverUpdate"; import { startClientPolling } from "@/lib/clientUpdate"; +import type { UnsavedChangesGuard } from "@/lib/unsavedGuard"; type Page = "overview" | "bots" | "dashboard" | "server" | "modules" | "players" | "characters" | "friends" | "backups" | "console" | "report" | "settings"; @@ -53,6 +55,22 @@ export function Shell(props: { // A module that is switched off takes its page away (the companions' "Bots" page, for one). const [botModule, setBotModule] = useState<"companions" | "playerbots">("companions"); const [hiddenPages, setHiddenPages] = useState([]); + const guardRef = useRef(null); + const registerGuard = useCallback((g: UnsavedChangesGuard | null) => { + guardRef.current = g; + }, []); + const [pendingNav, setPendingNav] = useState<(() => void) | null>(null); + const [modalSaving, setModalSaving] = useState(false); + const [modalError, setModalError] = useState(null); + + const requestNavigation = (action: () => void) => { + if (guardRef.current && guardRef.current.isDirty()) { + setPendingNav(() => action); + } else { + action(); + } + }; + const reloadModules = useCallback(() => { void api .modulesList(props.activeId) @@ -91,7 +109,7 @@ export function Shell(props: { {NAV.filter((n) => !hiddenPages.includes(n.id) && (n.id !== "dashboard" || botModule === "playerbots")).map(({ id, label, icon: Icon }) => (
  • @@ -131,15 +149,15 @@ export function Shell(props: {
    {page === "overview" ? ( - props.onForget(server.id)} onOpenUpdates={() => setPage("settings")} onRealmChanged={reloadModules} onReport={() => setPage("report")} /> + props.onForget(server.id)} onOpenUpdates={() => requestNavigation(() => setPage("settings"))} onRealmChanged={reloadModules} onReport={() => requestNavigation(() => setPage("report"))} /> ) : page === "bots" || page === "server" ? ( - + ) : page === "dashboard" ? ( ) : page === "console" ? ( ) : page === "modules" ? ( - + ) : page === "report" ? ( ) : page === "friends" ? ( @@ -156,6 +174,52 @@ export function Shell(props: { )}
    + + {pendingNav && ( +
    + +

    {t("unsaved.title")}

    +

    {t("unsaved.message")}

    + {modalError &&

    {modalError}

    } +
    + + + +
    +
    +
    + )} ); }