Compare commits

..
Author SHA1 Message Date
Дмитрий 2715170622 Fix portable schema 9 compatibility and prepare Manager 0.7.3 2026-10-24 01:00:27 +05:00
Дмитрий 4d59ce8cb1 Prepare Manager 0.7.2 for candidate-only qualification 2026-10-23 18:52:22 +05:00
Corfirean de90418e84 Merge pull request #147 from Corfirean/integrate/prebuild-20261023
Fix stalled update inspections and integrate pending Manager controls
2026-10-23 12:51:26 +05:00
Дмитрий 3b75d37ce4 Verify inspection timeout against a disposable real MySQL server 2026-10-23 12:43:10 +05:00
Дмитрий 1bc4060121 Merge remote-tracking branch 'origin/feat/ahbot-single-switch' into integrate/prebuild-20261023 2026-10-23 12:38:28 +05:00
Дмитрий 6038eacea5 Bound update-check database clients and release maintenance locks after timeouts 2026-10-23 12:38:28 +05:00
Дмитрий 83e87d49fc Merge remote-tracking branch 'origin/fix/issues-20261017' into integrate/prebuild-20261023 2026-10-23 12:29:10 +05:00
ДмитрийandClaude Sonnet 5.5 0189e3eebf AH bot card: one switch, the seller option is retired
The module switch alone makes the bot list items; the EnableSeller setting is removed from the card and an old copy in a config file is hidden.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-10-23 12:17:20 +05:00
Corfirean 5544d62c23 Remove repeated screenshot titles from gallery pages (#144) 2026-10-23 07:52:51 +05:00
Corfirean 93784af0d9 Localize screenshot galleries and complete visible interface translations (#143) 2026-10-23 07:43:36 +05:00
Corfirean ff09d3d056 Translate public READMEs and guides into all Manager languages (#142) 2026-10-23 06:39:11 +05:00
Дмитрий ed2b1291cb Add localized TimeIsTime module card and settings 2026-10-23 06:12:50 +05:00
Дмитрий e033cfbc92 Merge branch 'fix/online-population-counts' of C:\games\source\manager-portable-characters into integrate/manager-071-fixes 2026-10-23 06:06:39 +05:00
Дмитрий 154fdfb0e9 Separate SQUID bots from advertised online players 2026-10-23 06:04:38 +05:00
Дмитрий 79e9e85fac Fix custom races transactions with linked addons on another volume 2026-10-23 05:43:57 +05:00
Дмитрий df102f16fa Expose creature health and melee and spell rates by rank 2026-10-17 21:02:26 +05:00
Дмитрий 5963e97c59 Accept verified existing UPnP mappings for this server 2026-10-17 21:02:25 +05:00
273 changed files with 5991 additions and 11969 deletions

No files matched your search

+13
View File
@@ -51,3 +51,16 @@ Server promotion uses the persistent Windows PC and the shared workflow's verifi
production databases; run applicable local acceptance in disposable fixtures. Record the actual passed,
failed and unrun checks. Verify both GitHub Latest and the public signed stable pointer before reporting
that users can update. Leave the durable handoff described in the runbook for the next agent.
## Public documentation languages
Maintain the public README and every player/server-owner guide in all six Manager languages:
English, Russian, German, French, Spanish and Simplified Chinese. English stays at `README.md`
and the player-facing `docs/*.md`; translated READMEs use `README.<locale>.md`, with guides in
`docs/<locale>/` (`ru`, `de`, `fr`, `es`, `zh-CN`). Language switches open the same page.
When changing a public guide, update its counterparts in the same change. Write naturally for
players in each language rather than translating word for word. Keep steps, feature limits and
experimental Portable Characters warnings equivalent. Use actual UI labels; retain English labels
where the released UI falls back to English. English screenshots stay in `docs/screenshots/`; localized images use its `ru`, `de`, `fr`, `es` and `zh-CN` subfolders. Keep the interface and annotation language consistent with each guide.
The public guide index is `docs/README.md`; internal protocol specifications and audits are not
player guides. Keep canonical release histories in English and link to them instead of making copies.
Generated
+3 -3
View File
@@ -586,7 +586,7 @@ dependencies = [
[[package]]
name = "coa-core"
version = "0.7.1"
version = "0.7.3"
dependencies = [
"base64 0.22.1",
"chrono",
@@ -634,7 +634,7 @@ dependencies = [
[[package]]
name = "coa-release"
version = "0.7.1"
version = "0.7.3"
dependencies = [
"chrono",
"coa-core",
@@ -643,7 +643,7 @@ dependencies = [
[[package]]
name = "coa-server-manager"
version = "0.7.1"
version = "0.7.3"
dependencies = [
"coa-control-proto",
"coa-core",
+1 -1
View File
@@ -4,7 +4,7 @@ members = ["crates/coa-core", "crates/coa-release", "crates/coa-registry-proto",
exclude = ["services/coa-registry", "services/coa-registry-e2e", "services/coa-coordinator", "services/coa-relay"]
[workspace.package]
version = "0.7.1"
version = "0.7.3"
edition = "2021"
license = "AGPL-3.0-only"
+84
View File
@@ -0,0 +1,84 @@
# CoA Server Manager
[English](README.md) · [Русский](README.ru.md) · **Deutsch** · [Français](README.fr.md) · [Español](README.es.md) · [简体中文](README.zh-CN.md)
**Portable Characters sind experimentell.** Die Funktion wird noch entwickelt und kann Fehler enthalten.
Eine Windows-Anwendung, mit der du deinen eigenen **Conquest of Azeroth**-Server auf Basis von AzerothCore mit wenigen Schritten einrichtest und betreibst. Konsole, manuelle Konfigurationsdateien und separate Datenbankprogramme sind dafür nicht nötig. Entwickelt mit Tauri 2, Rust und React.
![Dein Server im Überblick](docs/screenshots/de/overview.jpg)
## Funktionen
- **Portable Characters — experimentell.** Bewahre Charaktere samt gespeicherten Versionen im Manager auf und übernimm vorhandene Charaktere von Realms, auf die du Zugriff hast. [Zur Anleitung](docs/de/PORTABLE-CHARACTERS.md).
- **Realms entdecken.** Vergleiche öffentlich gelistete Realms nach Spielmodus, Höchststufe, Raten, Modulen und Spielerzahl.
- **Einfache Einrichtung.** Der Manager lädt ein signiertes Serverpaket herunter, prüft die Dateien, richtet die Datenbank ein und erstellt dein erstes Konto. Downloads lassen sich fortsetzen; vorhandene Server kannst du ebenfalls einbinden.
- **Starten, stoppen, spielen.** Steuere Datenbank, Auth- und Weltserver gemeinsam. Status, Laufzeit und Spielerzahl siehst du direkt. Beim Spielstart wird die passende Realmlist verwendet.
- **Spielclient verwalten.** Verwende deinen vorhandenen Client oder lade ihn über den Manager herunter: etwa 43 GB, fortsetzbar und dateiweise geprüft. Verwaltete Clients erhalten Update-Hinweise; selbst veränderte Dateien werden nur mit deiner Zustimmung ersetzt.
- **Serverupdates.** Der Manager sucht beim Start und alle fünf Minuten nach Updates. Ed25519-Signaturen schützen die Pakete. Vor dem Update wird eine Sicherung erstellt; eigene Änderungen bleiben erhalten und ein Rollback ist möglich.
- **Sicherungen.** Sichere Charaktere, Konten und Einstellungen bei Bedarf oder automatisch vor Updates. Prüfen und Wiederherstellen geht direkt in der Anwendung.
- **CoA, Wildcard und Warcraft Reborn.** Wähle den Realm unter Übersicht. Die Serverversion muss den gewählten Modus unterstützen. Beim ersten Wechsel entstehen eine eigene Welt und eine leere Charakterdatenbank. Konten werden geteilt, Charaktere und Moduleinstellungen bleiben getrennt. Ein laufender Server speichert die Charaktere und startet beim Wechsel neu. Schließe vorher den Client; bei geöffnetem Client wird die Realm-Auswahl erst beim nächsten Start über den Manager übernommen. Bots sind auf Wildcard und Warcraft Reborn nicht verfügbar; andere Zusatzmodule sind dort experimentell. Sicherungen und Datenbankupdates berücksichtigen alle angelegten Realms. CoA und Wildcard können gemeinsam laufen. [Wildcard](docs/de/WILDCARD.md) · [Warcraft Reborn](docs/de/WARCRAFT-REBORN.md).
- **Begleiter-Bots.** Erstelle Bots mit passender Stufe, verfolge den Fortschritt, pausiere die Erstellung oder melde Bots ab. Entferne bei Bedarf eine bestimmte Anzahl, um den Server zu entlasten, und lege die Zahl beim Serverstart fest.
- **Realmlists wechseln.** Speichere benannte Verbindungen wie Solo oder PTR und wähle sie neben der Spiel-Schaltfläche. Die zuvor verwendete Datei wird gesichert.
- **Konten und Einstellungen.** Verwalte Namen, Passwörter und Zugriffsrechte. Für Server und Bots gibt es verständliche Optionen und Voreinstellungen, außerdem eine Serverkonsole und eine Spielerliste mit Kontoverwaltung.
- **Module.** Aktiviere Zusatzfunktionen, öffne ihre Einstellungen oder die GitHub-Seite des jeweiligen Projekts.
- **Mit Freunden spielen.** Erreichbarkeit prüfen, Firewall und UPnP einrichten und Verbindungen über LAN, direkte Adressen oder private Netze/Tailscale vorbereiten. Anleitungen und ein Paket mit Verbindungsdaten helfen deinen Freunden beim Beitritt.
- **Probleme melden.** Bereite einen GitHub-Fehlerbericht mit automatisch eingetragenen Versionsangaben vor.
- **Managerupdates.** Sie werden im Hintergrund geladen und beim Schließen installiert. Deine Server werden dabei weder angehalten noch verändert.
- **Sprachen:** Englisch, Russisch, Deutsch, Französisch, Spanisch und vereinfachtes Chinesisch.
## Screenshots und Anleitungen
| Portable Characters — experimentell | Öffentliche Realms |
|---|---|
| ![Portable Characters](docs/screenshots/de/portable.jpg) | ![Öffentliche Realms](docs/screenshots/de/realms.jpg) |
| Begleiter | Sicherungen |
|---|---|
| ![Begleiter](docs/screenshots/de/bots.jpg) | ![Sicherungen](docs/screenshots/de/backups.jpg) |
[Zur Galerie](docs/de/SCREENSHOTS.md) · [Alle Anleitungen](docs/de/README.md). Die Galerie zeigt auch Einrichtung, Module, Spielclient, Verbindungen mit Freunden und die Übernahme eines vorhandenen Charakters.
## Installation
Lade das Installationsprogramm von der [Release-Seite](https://github.com/Corfirean/coa-server-manager/releases/latest) herunter und starte es. Für den Server brauchst du etwa 10 GB freien Speicher. Der Spielclient benötigt zusätzlich etwa 43 GB: Wähle einen vorhandenen Client oder lade ihn über den Manager.
## Änderungen
[Manager-Changelog](CHANGELOG.md) · [Server-Changelog](https://github.com/Corfirean/coa-server-build/blob/main/CHANGELOG.md). Manager und Server haben getrennte Versionsverläufe. Ein Managerupdate aktualisiert nicht den Server.
## Projektstatus
**In aktiver Entwicklung.** Fehler sind weiterhin möglich. Wenn du ein Problem findest, [erstelle bitte ein Issue](https://github.com/Corfirean/coa-server-manager/issues/new/choose).
### Bekannte Einschränkungen
- Der Ascension-Client 3.3.5 nimmt keine Zugangsdaten über die Kommandozeile an. Gib dein Passwort selbst ein oder verknüpfe ein bestehendes Konto.
- Windows schützt vertrauliche Daten mit DPAPI (`CryptProtectData`) und zusätzlicher Entropie zur Domänentrennung. Linux/macOS verwenden Dateien mit den Zugriffsrechten `0600`.
- Eine bestehende direkte TCP-Verbindung lässt sich nicht während der Sitzung auf einen Relay umstellen. Nach einem Verbindungsabbruch wird beim nächsten Beitritt automatisch auf die Ausweichroute zurückgegriffen.
- Für sichere entfernte Importe portabler Charaktere muss `CharacterDatabase.WorkerThreads = 1` bleiben; das ist der Standardwert.
## Entwicklung
```sh
npm install
cargo test --workspace
npx tsc --noEmit
node tools/check-i18n.mjs
npx vite
cargo build -p coa-server-manager
```
Die Befehle installieren Abhängigkeiten, führen Tests aus, prüfen Typen und Übersetzungen, starten die Browseransicht mit Testdaten und bauen die native Anwendung. Der Debug-Build verwendet `http://localhost:1420`.
Die Programmlogik liegt in `crates/coa-core`, Paket- und Signaturwerkzeuge in `crates/coa-release`, native Befehle in `src-tauri` und die Oberfläche in `src`.
`cargo run -p coa-core --example scan -- <folder>` prüft eine vorhandene Installation nur lesend. Verwende für Start-/Stopp-Tests ausschließlich eine entbehrliche Testkopie: `tools/make-fixture.ps1` erstellt `C:\games\coa-fixture` aus der unveränderten Paketdatenbank mit anderen Ports. Teste niemals an einem genutzten Server. `tests/e2e/cdp.mjs` steuert das echte Fenster über WebView2 mit `WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS=--remote-debugging-port=9222`.
## Lizenz
Der Manager ist freie Software unter der [GNU AGPL v3.0](LICENSE), Kennung `AGPL-3.0-only`.
- Der installierte Server basiert auf einem öffentlichen [AzerothCore-Fork](https://github.com/Corfirean/azerothcore-wotlk-coa). Für von MaNGOS übernommene Teile gilt GPL-2.0-or-later, für eigene AzerothCore-Teile AGPL-3.0. [mod-coa-playerbots](https://github.com/Corfirean/mod-coa-playerbots) steht unter AGPL-3.0. Die exakten Quellstände stehen im Paketmanifest, damit der passende Quellcode auffindbar bleibt.
- Das mitgelieferte MySQL behält seine GPL-2.0-Lizenz; der Lizenztext liegt im Paket unter `Licenses`.
- Die Spieldaten in `Data` (`dbc`, `maps`, `vmaps`, `mmaps`) stammen aus dem Client des eingestellten Ascension-Realms Conquest of Azeroth. Sie fallen **nicht** unter die Lizenz des Managers.
+84
View File
@@ -0,0 +1,84 @@
# CoA Server Manager
[English](README.md) · [Русский](README.ru.md) · [Deutsch](README.de.md) · [Français](README.fr.md) · **Español** · [简体中文](README.zh-CN.md)
**Los personajes portátiles son una función experimental.** Sigue en desarrollo y puede contener errores.
Una aplicación para Windows con la que instalar y gestionar tu propio servidor de **Conquest of Azeroth**, basado en AzerothCore, en pocos pasos. No necesitas usar la consola, editar archivos de configuración a mano ni manejar programas de bases de datos. Creada con Tauri 2, Rust y React.
![Tu servidor de un vistazo](docs/screenshots/es/overview.jpg)
## Funciones
- **Personajes portátiles — experimental.** Guarda personajes y sus distintas versiones en el Manager, o convierte en portátil un personaje que ya tengas en un reino al que puedas acceder. [Ver la guía](docs/es/PORTABLE-CHARACTERS.md).
- **Buscador de reinos.** Compara reinos públicos por modo de juego, nivel máximo, multiplicadores, módulos y población.
- **Instalación sencilla.** Descarga un paquete de servidor firmado, comprueba los archivos, prepara la base de datos y crea tu primera cuenta. Las descargas se pueden reanudar. También puedes importar un servidor existente.
- **Iniciar, detener y jugar.** Controla conjuntamente la base de datos y los servidores de autenticación y mundo. Consulta su estado, tiempo de actividad y jugadores conectados. Al abrir el juego se utiliza la realmlist correcta.
- **Cliente de juego.** Usa el que ya tengas o descárgalo desde el Manager: unos 43 GB, con descarga reanudable y verificación de archivos. Los clientes gestionados reciben avisos de actualización; los archivos que hayas modificado solo se sustituyen con tu permiso.
- **Actualizaciones del servidor.** Se buscan al iniciar y cada cinco minutos. Los paquetes se verifican mediante firmas Ed25519, se crea una copia antes de actualizar, se conservan tus cambios y es posible volver atrás.
- **Copias de seguridad.** Guarda personajes, cuentas y ajustes cuando quieras o automáticamente antes de una actualización. Comprueba y restaura las copias desde la aplicación.
- **CoA, Wildcard y Warcraft Reborn.** Elige el reino en Resumen. La versión del servidor debe admitir el modo seleccionado. El primer cambio crea un mundo independiente y una base de personajes vacía. Las cuentas son compartidas; los personajes y los ajustes de módulos se mantienen separados. Si el servidor está encendido, guarda los personajes y se reinicia al cambiar. Cierra el cliente antes del cambio; si está abierto, el nuevo reino se aplicará la próxima vez que lo abras desde el Manager. No hay bots en Wildcard ni en Warcraft Reborn; los demás módulos opcionales son experimentales allí. Las copias y las actualizaciones cubren todos los reinos creados. CoA y Wildcard pueden funcionar a la vez. [Wildcard](docs/es/WILDCARD.md) · [Warcraft Reborn](docs/es/WARCRAFT-REBORN.md).
- **Bots compañeros.** Llena el mundo con bots de nivel adecuado, sigue su creación, ponla en pausa o desconecta los bots. Elimina una cantidad concreta para reducir la carga y decide cuántos se conectan al iniciar el servidor.
- **Cambio de realmlist.** Guarda conexiones con nombres como Solo o PTR y selecciónalas junto al botón de jugar. El archivo anterior se guarda antes de sustituirlo.
- **Cuentas y ajustes.** Gestiona nombres, contraseñas y permisos. Configura el servidor y los bots con opciones explicadas y ajustes predefinidos. También tienes una consola de servidor y una lista de jugadores con herramientas de cuentas.
- **Módulos.** Activa funciones adicionales, cambia sus ajustes o abre el repositorio de sus autores desde la misma página.
- **Jugar con amigos.** Comprueba si pueden acceder, configura el cortafuegos y UPnP, y prepara conexiones por LAN, dirección directa o red privada/Tailscale. Incluye guías y un paquete con los datos de conexión para compartir.
- **Informar de problemas.** Prepara un informe para GitHub con las versiones ya rellenadas.
- **Actualizaciones del Manager.** Se descargan en segundo plano y se instalan al cerrar la aplicación. No detienen ni modifican tus servidores.
- **Idiomas:** inglés, ruso, alemán, francés, español y chino simplificado.
## Capturas y guías
| Personajes portátiles — experimental | Reinos públicos |
|---|---|
| ![Personajes portátiles](docs/screenshots/es/portable.jpg) | ![Reinos públicos](docs/screenshots/es/realms.jpg) |
| Compañeros | Copias de seguridad |
|---|---|
| ![Compañeros](docs/screenshots/es/bots.jpg) | ![Copias de seguridad](docs/screenshots/es/backups.jpg) |
[Galería completa](docs/es/SCREENSHOTS.md) · [Todas las guías](docs/es/README.md). También encontrarás la instalación, los módulos, el cliente, las conexiones con amigos y cómo convertir un personaje existente en portátil.
## Instalación
Descarga el instalador desde la [página de versiones](https://github.com/Corfirean/coa-server-manager/releases/latest) y ejecútalo. Necesitas unos 10 GB libres para el servidor. El cliente se instala por separado y ocupa unos 43 GB: indica tu carpeta existente o descárgalo con el Manager.
## Historial de cambios
[Cambios del Manager](CHANGELOG.md) · [Cambios del servidor](https://github.com/Corfirean/coa-server-build/blob/main/CHANGELOG.md). Sus versiones se siguen por separado. Actualizar el Manager no actualiza el servidor.
## Estado del proyecto
**En desarrollo activo.** Todavía puede haber errores. Si encuentras un problema, [abre una incidencia](https://github.com/Corfirean/coa-server-manager/issues/new/choose).
### Limitaciones conocidas
- El cliente Ascension 3.3.5 no acepta credenciales por línea de comandos. Introduce la contraseña manualmente o vincula una cuenta existente.
- En Windows, los secretos se protegen con DPAPI (`CryptProtectData`) y entropía para separar dominios. Linux/macOS usan archivos con permisos `0600`.
- Una conexión TCP directa ya establecida no puede pasar a un relé a mitad de sesión. Tras una interrupción, la ruta alternativa se selecciona automáticamente en la siguiente conexión.
- Para importar personajes portátiles de forma remota con seguridad, mantén `CharacterDatabase.WorkerThreads = 1`, su valor predeterminado.
## Desarrollo
```sh
npm install
cargo test --workspace
npx tsc --noEmit
node tools/check-i18n.mjs
npx vite
cargo build -p coa-server-manager
```
Estos comandos instalan dependencias, ejecutan pruebas, comprueban tipos y traducciones, abren la interfaz en el navegador con datos de prueba y compilan la aplicación nativa. La versión de depuración utiliza `http://localhost:1420`.
La lógica está en `crates/coa-core`, las herramientas de empaquetado y firma en `crates/coa-release`, los comandos nativos en `src-tauri` y la interfaz en `src`.
`cargo run -p coa-core --example scan -- <folder>` inspecciona una instalación sin modificarla. Para probar el inicio y la parada, usa solo una copia desechable: `tools/make-fixture.ps1` crea `C:\games\coa-fixture` a partir de la base intacta del paquete y con puertos diferentes. No hagas estas pruebas en un servidor en uso. `tests/e2e/cdp.mjs` controla la ventana real mediante WebView2 con `WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS=--remote-debugging-port=9222`.
## Licencia
El Manager es software libre bajo [GNU AGPL v3.0](LICENSE), identificador `AGPL-3.0-only`.
- El servidor instalado procede de un [fork público de AzerothCore](https://github.com/Corfirean/azerothcore-wotlk-coa). Las partes heredadas de MaNGOS usan GPL-2.0-or-later y las propias de AzerothCore, AGPL-3.0. [mod-coa-playerbots](https://github.com/Corfirean/mod-coa-playerbots) utiliza AGPL-3.0. El manifiesto de cada paquete indica los commits exactos para localizar el código fuente correspondiente.
- MySQL conserva su licencia GPL-2.0; el texto se incluye en la carpeta `Licenses` del paquete.
- Los datos de juego de `Data` (`dbc`, `maps`, `vmaps`, `mmaps`) se extrajeron del cliente del antiguo reino Ascension Conquest of Azeroth. **No** están cubiertos por la licencia del Manager.
+84
View File
@@ -0,0 +1,84 @@
# CoA Server Manager
[English](README.md) · [Русский](README.ru.md) · [Deutsch](README.de.md) · **Français** · [Español](README.es.md) · [简体中文](README.zh-CN.md)
**Les personnages portables sont une fonctionnalité expérimentale.** Elle est encore en développement et peut présenter des bugs.
Une application Windows pour installer et gérer votre propre serveur **Conquest of Azeroth**, basé sur AzerothCore, en quelques étapes. Pas besoin de console, de modifier les fichiers de configuration à la main ou d'utiliser un outil de base de données. L'application utilise Tauri 2, Rust et React.
![Votre serveur en un coup d'œil](docs/screenshots/fr/overview.jpg)
## Fonctionnalités
- **Personnages portables — expérimental.** Conservez vos personnages et leurs sauvegardes dans le Manager, ou rendez portable un personnage déjà présent sur un royaume auquel vous avez accès. [Voir le guide](docs/fr/PORTABLE-CHARACTERS.md).
- **Découverte des royaumes.** Comparez les royaumes publics selon leur mode de jeu, niveau maximal, taux de progression, modules et population.
- **Installation simplifiée.** Le Manager télécharge un paquet serveur signé, vérifie les fichiers, configure la base de données et crée votre premier compte. Les téléchargements peuvent reprendre après une interruption. Vous pouvez aussi importer un serveur existant.
- **Démarrer, arrêter, jouer.** Une commande suffit pour gérer la base de données et les serveurs d'authentification et de monde. L'état, la durée de fonctionnement et les joueurs connectés restent visibles. Le lancement du jeu utilise la bonne realmlist.
- **Gestion du client de jeu.** Utilisez votre client ou téléchargez-le depuis l'application : environ 43 Go, avec reprise et vérification des fichiers. Un client géré reçoit des mises à jour ; vos fichiers modifiés ne sont remplacés qu'avec votre accord.
- **Mises à jour du serveur.** Recherche au démarrage et toutes les cinq minutes, vérification des signatures Ed25519, sauvegarde préalable, conservation des modifications personnelles et possibilité de revenir en arrière.
- **Sauvegardes.** Enregistrez personnages, comptes et paramètres à la demande ou automatiquement avant les mises à jour. Vérifiez et restaurez les sauvegardes dans l'application.
- **CoA, Wildcard et Warcraft Reborn.** Choisissez le royaume dans Vue d'ensemble. La version du serveur doit prendre en charge le mode choisi. Le premier changement crée un monde distinct et une base de personnages vide. Les comptes sont partagés, mais personnages et réglages des modules restent séparés. Un serveur en cours d'exécution sauvegarde les personnages puis redémarre lors du changement. Fermez le client avant de changer de royaume ; s'il est ouvert, le choix prendra effet au prochain lancement depuis le Manager. Les bots sont indisponibles sur Wildcard et Warcraft Reborn ; les autres modules optionnels y sont expérimentaux. Sauvegardes et mises à jour couvrent tous les royaumes créés. CoA et Wildcard peuvent fonctionner ensemble. [Wildcard](docs/fr/WILDCARD.md) · [Warcraft Reborn](docs/fr/WARCRAFT-REBORN.md).
- **Bots compagnons.** Peuplez le monde avec des bots de niveau adapté, suivez leur création, mettez-la en pause ou déconnectez les bots. Retirez un nombre choisi de bots pour alléger le serveur et réglez combien se connectent au démarrage.
- **Changement de realmlist.** Enregistrez des connexions nommées, comme Solo et PTR, et choisissez-les à côté du bouton de jeu. Le fichier précédent est sauvegardé avant remplacement.
- **Comptes et réglages.** Gérez noms, mots de passe et droits d'accès. Configurez serveur et bots avec des options expliquées et des préréglages. Une console serveur et une liste des joueurs avec gestion des comptes sont également disponibles.
- **Modules.** Activez les fonctions supplémentaires, modifiez leurs réglages ou consultez leur projet GitHub depuis une même page.
- **Jouer avec des amis.** Vérifiez l'accessibilité du serveur, configurez pare-feu et UPnP, préparez une connexion en réseau local, directe ou via un réseau privé/Tailscale. Des guides et un paquet de connexion facilitent l'arrivée des amis.
- **Signalement des problèmes.** Préparez un rapport GitHub avec les versions déjà renseignées.
- **Mises à jour du Manager.** Téléchargées en arrière-plan, elles s'installent à la fermeture. Elles n'arrêtent pas vos serveurs et ne les modifient pas.
- **Langues :** anglais, russe, allemand, français, espagnol et chinois simplifié.
## Captures et guides
| Personnages portables — expérimental | Royaumes publics |
|---|---|
| ![Personnages portables](docs/screenshots/fr/portable.jpg) | ![Royaumes publics](docs/screenshots/fr/realms.jpg) |
| Compagnons | Sauvegardes |
|---|---|
| ![Compagnons](docs/screenshots/fr/bots.jpg) | ![Sauvegardes](docs/screenshots/fr/backups.jpg) |
[Galerie complète](docs/fr/SCREENSHOTS.md) · [Tous les guides](docs/fr/README.md). La galerie présente aussi l'installation, les modules, le client, les connexions entre amis et la création d'un personnage portable.
## Installation
Téléchargez et lancez l'installateur depuis les [publications GitHub](https://github.com/Corfirean/coa-server-manager/releases/latest). Prévoyez environ 10 Go libres pour le serveur. Le client de jeu est séparé et demande environ 43 Go : indiquez un dossier existant ou téléchargez-le avec le Manager.
## Historique des versions
[Changelog du Manager](CHANGELOG.md) · [Changelog du serveur](https://github.com/Corfirean/coa-server-build/blob/main/CHANGELOG.md). Leurs versions sont suivies séparément : mettre à jour le Manager ne met pas à jour le serveur.
## État du projet
**En développement actif.** Des bugs restent possibles. Si vous rencontrez un problème, [ouvrez une issue](https://github.com/Corfirean/coa-server-manager/issues/new/choose).
### Limites connues
- Le client Ascension 3.3.5 n'accepte pas les identifiants en ligne de commande. Saisissez votre mot de passe ou associez un compte existant.
- Windows protège les secrets avec DPAPI (`CryptProtectData`) et une entropie de séparation de domaine. Sous Linux/macOS, ils sont conservés dans des fichiers aux permissions `0600`.
- Une connexion TCP directe déjà établie ne peut pas basculer vers un relais en cours de session. Après une coupure, le repli automatique intervient à la connexion suivante.
- Pour importer à distance des personnages portables en sécurité, conservez `CharacterDatabase.WorkerThreads = 1`, la valeur par défaut.
## Développement
```sh
npm install
cargo test --workspace
npx tsc --noEmit
node tools/check-i18n.mjs
npx vite
cargo build -p coa-server-manager
```
Ces commandes installent les dépendances, exécutent les tests, contrôlent les types et les traductions, ouvrent l'interface dans le navigateur avec des données de test, puis compilent l'application native. En mode debug, celle-ci utilise `http://localhost:1420`.
La logique se trouve dans `crates/coa-core`, les outils de paquetage et de signature dans `crates/coa-release`, les commandes natives dans `src-tauri` et l'interface dans `src`.
`cargo run -p coa-core --example scan -- <folder>` inspecte une installation sans la modifier. Pour tester démarrage et arrêt, utilisez uniquement une copie jetable : `tools/make-fixture.ps1` crée `C:\games\coa-fixture` depuis la base intacte du paquet, avec des ports distincts. Ne testez jamais sur un serveur utilisé par des joueurs. `tests/e2e/cdp.mjs` pilote la véritable fenêtre via WebView2 avec `WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS=--remote-debugging-port=9222`.
## Licence
Le Manager est un logiciel libre sous [GNU AGPL v3.0](LICENSE), identifiant `AGPL-3.0-only`.
- Le serveur installé provient d'un [fork public d'AzerothCore](https://github.com/Corfirean/azerothcore-wotlk-coa). Les parties héritées de MaNGOS relèvent de GPL-2.0-or-later et les parties propres à AzerothCore d'AGPL-3.0. [mod-coa-playerbots](https://github.com/Corfirean/mod-coa-playerbots) utilise AGPL-3.0. Les commits exacts figurent dans le manifeste de chaque paquet pour retrouver les sources correspondantes.
- MySQL conserve sa licence GPL-2.0 ; son texte est fourni dans le dossier `Licenses` du paquet.
- Les données de jeu dans `Data` (`dbc`, `maps`, `vmaps`, `mmaps`) proviennent du client de l'ancien royaume Ascension Conquest of Azeroth. Elles ne sont **pas** couvertes par la licence du Manager.
+2
View File
@@ -1,5 +1,7 @@
# CoA Server Manager
**English** · [Русский](README.ru.md) · [Deutsch](README.de.md) · [Français](README.fr.md) · [Español](README.es.md) · [简体中文](README.zh-CN.md)
**Portable characters are experimental.** This feature is in active development and may contain bugs.
A Windows app that installs and runs your own **Conquest of Azeroth** server (AzerothCore) with a few clicks:
+84
View File
@@ -0,0 +1,84 @@
# CoA Server Manager
[English](README.md) · **Русский** · [Deutsch](README.de.md) · [Français](README.fr.md) · [Español](README.es.md) · [简体中文](README.zh-CN.md)
**Переносимые персонажи — экспериментальная функция.** Она ещё развивается и может работать с ошибками.
Приложение для Windows, с которым можно установить и запустить свой сервер **Conquest of Azeroth** на базе AzerothCore за несколько шагов. Управляйте сервером через интерфейс, без консоли, ручного редактирования конфигов и отдельных программ для базы данных. Менеджер написан на Tauri 2, Rust и React.
![Главное окно менеджера](docs/screenshots/ru/overview.jpg)
## Возможности
- **Переносимые персонажи — экспериментально.** Храните персонажей и историю сохранений в менеджере, делайте переносимыми уже существующих персонажей с доступных вам реалмов. [Как это работает](docs/ru/PORTABLE-CHARACTERS.md).
- **Каталог реалмов.** Сравнивайте публичные серверы по режиму игры, максимальному уровню, рейтам, модулям и числу игроков.
- **Простая установка.** Менеджер скачивает подписанный пакет сервера, проверяет файлы, настраивает базу данных и создаёт первый аккаунт. Прерванную загрузку можно продолжить. Можно также подключить уже установленный сервер.
- **Запуск, остановка и игра.** Управляйте базой данных и обоими серверными процессами одной кнопкой. На главном экране видны состояние, время работы и игроки онлайн. Кнопка запуска игры выбирает нужный realmlist.
- **Игровой клиент.** Подключите свой клиент или скачайте его через менеджер — около 43 ГБ, с продолжением загрузки и проверкой файлов. Для управляемого клиента доступны обновления; ваши изменения заменяются только с вашего согласия.
- **Обновления сервера.** Проверка выполняется при запуске и каждые пять минут. Пакеты защищены подписью Ed25519; перед установкой создаётся резервная копия. Пользовательские изменения сохраняются, предусмотрен откат.
- **Резервные копии.** Сохраняйте персонажей, аккаунты и настройки вручную или автоматически перед обновлениями. Проверка и восстановление доступны в приложении.
- **CoA, Wildcard и Warcraft Reborn.** Выбирайте реалм в разделе «Обзор». Нужна серверная сборка с поддержкой выбранного режима. При первом переключении создаются отдельный мир и пустая база персонажей. Аккаунты общие, персонажи и настройки модулей раздельные. Переключение работающего сервера сохраняет персонажей и перезапускает его. Закройте клиент перед переключением; если он открыт, новый реалм будет выбран при следующем запуске через менеджер. Боты недоступны в Wildcard и Warcraft Reborn, остальные дополнительные модули там экспериментальны. Копии и обновления охватывают все созданные реалмы. Одновременно можно запускать CoA и Wildcard. [Гайд по Wildcard](docs/ru/WILDCARD.md) · [Warcraft Reborn](docs/ru/WARCRAFT-REBORN.md).
- **Компаньоны-боты.** Заселяйте мир ботами подходящего уровня, следите за созданием, приостанавливайте его, отключайте ботов или удаляйте нужное количество для снижения нагрузки. Можно задать число ботов при старте сервера.
- **Список подключений.** Сохраняйте несколько realmlist с понятными названиями, например Solo и PTR, и переключайте их рядом с кнопкой игры. Предыдущий файл сохраняется.
- **Аккаунты и настройки.** Управляйте именами, паролями и уровнями доступа. Настраивайте сервер и ботов через понятные параметры и готовые наборы; доступны консоль сервера и список игроков.
- **Модули.** Включайте дополнительные возможности, меняйте их настройки и переходите в репозитории авторов с одной страницы.
- **Игра с друзьями.** Проверка доступности, настройка брандмауэра и UPnP, подключение по локальной сети, напрямую или через частную сеть/Tailscale. Внутри есть пошаговые инструкции и пакет с данными подключения для друзей.
- **Сообщения об ошибках.** Менеджер помогает подготовить issue на GitHub и подставляет версии программ.
- **Обновление менеджера.** Загружается в фоне и устанавливается при закрытии приложения. Ваши серверы при этом не останавливаются и не изменяются.
- **Языки:** английский, русский, немецкий, французский, испанский и упрощённый китайский.
## Скриншоты и гайды
| Переносимые персонажи — экспериментально | Публичные реалмы |
|---|---|
| ![Переносимые персонажи](docs/screenshots/ru/portable.jpg) | ![Публичные реалмы](docs/screenshots/ru/realms.jpg) |
| Компаньоны | Резервные копии |
|---|---|
| ![Компаньоны](docs/screenshots/ru/bots.jpg) | ![Резервные копии](docs/screenshots/ru/backups.jpg) |
[Все скриншоты](docs/ru/SCREENSHOTS.md) · [Гайды для игроков и владельцев серверов](docs/ru/README.md). В галерее также показаны установка, модули, клиент, подключение друзей и создание переносимого персонажа.
## Установка
Скачайте установщик со страницы [релизов](https://github.com/Corfirean/coa-server-manager/releases/latest) и запустите его. Для сервера нужно около 10 ГБ свободного места. Клиент устанавливается отдельно и занимает около 43 ГБ: укажите существующую папку или скачайте его через менеджер.
## Что изменилось
[Ченджлог менеджера](CHANGELOG.md) · [Ченджлог сервера](https://github.com/Corfirean/coa-server-build/blob/main/CHANGELOG.md). Это отдельные продукты с отдельной историей версий: обновление менеджера не обновляет сервер.
## Состояние проекта
**Проект активно развивается.** Ошибки ещё возможны. Если встретили проблему, [создайте issue](https://github.com/Corfirean/coa-server-manager/issues/new/choose).
### Известные ограничения
- Клиент Ascension 3.3.5 не принимает логин и пароль через командную строку. Введите пароль вручную или привяжите существующий аккаунт.
- В Windows секреты защищены DPAPI (`CryptProtectData`) с отдельной энтропией домена. На Linux/macOS используются файлы с правами `0600`.
- Уже открытое прямое TCP-соединение нельзя переключить на ретранслятор без разрыва. Резервный маршрут выбирается при следующем подключении.
- Для безопасного удалённого импорта переносимых персонажей оставьте `CharacterDatabase.WorkerThreads = 1` — это значение по умолчанию.
## Разработка
```sh
npm install
cargo test --workspace
npx tsc --noEmit
node tools/check-i18n.mjs
npx vite
cargo build -p coa-server-manager
```
Команды устанавливают зависимости, запускают тесты, проверяют типы и переводы, открывают браузерный интерфейс с тестовыми данными и собирают нативное приложение. В отладочном режиме оно использует `http://localhost:1420`.
`crates/coa-core` содержит основную логику, `crates/coa-release` — упаковку и подписи, `src-tauri` — команды приложения, `src` — интерфейс.
Проверить существующую сборку без изменений можно командой `cargo run -p coa-core --example scan -- <folder>`. Для проверок запуска и остановки используйте только отдельную тестовую копию: `tools/make-fixture.ps1` создаёт `C:\games\coa-fixture` из чистой базы пакета, с другими портами. Не проводите такие проверки на сервере, которым пользуются игроки. `tests/e2e/cdp.mjs` управляет настоящим окном через WebView2 с `WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS=--remote-debugging-port=9222`.
## Лицензия
Менеджер — свободное ПО под [GNU AGPL v3.0](LICENSE), идентификатор `AGPL-3.0-only`.
- Устанавливаемый сервер основан на [форке AzerothCore](https://github.com/Corfirean/azerothcore-wotlk-coa): части, унаследованные от MaNGOS, используют GPL-2.0-or-later, собственные части AzerothCore — AGPL-3.0. Модуль [mod-coa-playerbots](https://github.com/Corfirean/mod-coa-playerbots) использует AGPL-3.0. Точные коммиты записываются в манифест пакета, чтобы можно было найти соответствующий исходный код.
- MySQL распространяется по собственной лицензии GPL-2.0; её текст находится в папке `Licenses` пакета.
- Данные игры в `Data` (`dbc`, `maps`, `vmaps`, `mmaps`) извлечены из клиента закрытого реалма Ascension Conquest of Azeroth. Лицензия менеджера на них **не распространяется**.
+84
View File
@@ -0,0 +1,84 @@
# CoA Server Manager
[English](README.md) · [Русский](README.ru.md) · [Deutsch](README.de.md) · [Français](README.fr.md) · [Español](README.es.md) · **简体中文**
**便携角色是一项实验性功能。** 目前仍在开发中,使用时可能遇到问题。
这是一款 Windows 应用,帮助你用几个简单步骤搭建和管理自己的 **Conquest of Azeroth** 服务器,服务端基于 AzerothCore。日常操作不需要使用控制台、手动修改配置文件或单独操作数据库。应用采用 Tauri 2、Rust 和 React 开发。
![服务器概览](docs/screenshots/zh-CN/overview.jpg)
## 主要功能
- **便携角色(实验性)。** 在管理器中保存角色及其历史存档,也可以将有权访问的服务器上的现有角色转换为便携角色。[查看使用指南](docs/zh-CN/PORTABLE-CHARACTERS.md)。
- **查找服务器。** 浏览公开服务器,对比游戏模式、等级上限、倍率、模块和在线人数。
- **轻松安装。** 下载带签名的服务端安装包,逐一校验文件,配置数据库并创建首个账号。下载支持断点续传,也可以导入已有服务器。
- **启动、停止和进入游戏。** 一处控制数据库、认证服务和世界服务,随时查看运行状态、运行时间和在线玩家。启动游戏时会自动使用对应的 realmlist。
- **管理游戏客户端。** 指定现有客户端,或通过管理器下载约 43 GB 的客户端。下载可以续传,文件会经过校验。受管理的客户端可以检查更新;自行修改的文件只有在你同意后才会被替换。
- **更新服务器。** 应用启动时及之后每五分钟检查一次更新。安装包通过 Ed25519 签名验证,更新前自动备份,保留用户修改,并支持回滚。
- **备份与恢复。** 手动备份角色、账号和设置,或在更新前自动备份。在应用中即可校验和恢复。
- **CoA、Wildcard 和 Warcraft Reborn。** 在概览中选择服务器模式,服务端版本必须支持所选模式。首次切换会创建独立的世界数据库和空的角色数据库。各模式共用账号,角色和模块设置相互独立。运行中切换会先保存角色,再重启服务器。切换前请关闭客户端;如果客户端仍开着,新选择会在下次通过管理器启动游戏时生效。Wildcard 和 Warcraft Reborn 不支持机器人,其他可选模块在这两种模式下也属于实验性支持。备份和数据库更新涵盖所有已创建的模式。目前支持 CoA 与 Wildcard 同时运行。[Wildcard 指南](docs/zh-CN/WILDCARD.md) · [Warcraft Reborn 指南](docs/zh-CN/WARCRAFT-REBORN.md)。
- **伙伴机器人。** 创建等级合适的机器人并查看进度,暂停创建、让机器人下线,或移除指定数量以减轻服务器负担。也可以设置开服时登录的机器人数量。
- **切换 realmlist。** 为不同连接保存名称,例如 Solo 和 PTR,在进入游戏按钮旁直接切换。替换前会保存原文件。
- **账号和设置。** 管理账号名称、密码和权限,通过说明清楚的选项及预设调整服务器和机器人。还提供世界服务器控制台,以及带账号管理功能的玩家列表。
- **模块管理。** 在同一页面启用可选功能、调整设置,或打开相应项目的 GitHub 页面。
- **好友联机。** 检查服务器是否可达,配置防火墙和 UPnP,支持局域网、直接连接及私有网络/Tailscale。应用提供分步说明,还能准备可分享的连接资料包。
- **报告问题。** 帮你准备 GitHub 问题报告,并自动填写版本信息。
- **管理器自身更新。** 在后台下载,关闭应用时安装。更新管理器不会停止或修改你的服务器。
- **支持语言:** 英语、俄语、德语、法语、西班牙语和简体中文。
## 截图与指南
| 便携角色(实验性) | 公开服务器 |
|---|---|
| ![便携角色](docs/screenshots/zh-CN/portable.jpg) | ![公开服务器](docs/screenshots/zh-CN/realms.jpg) |
| 伙伴机器人 | 备份 |
|---|---|
| ![伙伴机器人](docs/screenshots/zh-CN/bots.jpg) | ![备份](docs/screenshots/zh-CN/backups.jpg) |
[查看完整截图](docs/zh-CN/SCREENSHOTS.md) · [玩家与服主指南](docs/zh-CN/README.md)。图库还展示了初始设置、模块、客户端、朋友联机,以及将现有角色转换为便携角色的流程。
## 安装
从 [GitHub 发布页](https://github.com/Corfirean/coa-server-manager/releases/latest)下载安装程序并运行。服务器约需 10 GB 可用空间。游戏客户端单独安装,约占 43 GB;你可以指定已有客户端目录,也可以交给管理器下载。
## 更新记录
[管理器更新记录](CHANGELOG.md) · [服务器更新记录](https://github.com/Corfirean/coa-server-build/blob/main/CHANGELOG.md)。两者的版本和更新记录分别维护。更新管理器不会同时更新服务器。
## 项目状态
**正在积极开发中。** 仍可能存在问题。如果遇到故障,请[提交 issue](https://github.com/Corfirean/coa-server-manager/issues/new/choose)。
### 已知限制
- Ascension 3.3.5 客户端不支持通过命令行传入账号和密码。请自行输入密码,或关联现有账号。
- Windows 使用 DPAPI(`CryptProtectData`)及用于域隔离的额外熵来保护机密数据。Linux/macOS 使用权限为 `0600` 的文件。
- 已建立的直连 TCP 会话无法在不中断连接的情况下切换至中继。连接中断后,会在下一次加入服务器时自动尝试备用路径。
- 为保证远程导入便携角色的安全,请保留默认设置 `CharacterDatabase.WorkerThreads = 1`。
## 开发
```sh
npm install
cargo test --workspace
npx tsc --noEmit
node tools/check-i18n.mjs
npx vite
cargo build -p coa-server-manager
```
以上命令依次安装依赖、运行测试、检查类型与翻译、启动使用模拟数据的浏览器界面,以及编译原生应用。调试版应用连接 `http://localhost:1420`。
`crates/coa-core` 存放核心逻辑,`crates/coa-release` 提供打包和签名工具,`src-tauri` 处理原生命令,`src` 存放界面代码。
`cargo run -p coa-core --example scan -- <folder>` 可以只读检查现有安装。启动和停止测试必须使用可丢弃的独立副本:`tools/make-fixture.ps1` 会从安装包的原始数据库创建 `C:\games\coa-fixture`,并使用不同端口。不要在正在供玩家使用的服务器上进行此类测试。`tests/e2e/cdp.mjs` 可通过 WebView2 控制真实窗口,需设置 `WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS=--remote-debugging-port=9222`。
## 许可
管理器是自由软件,采用 [GNU AGPL v3.0](LICENSE),标识为 `AGPL-3.0-only`。
- 所安装的服务器来自公开的 [AzerothCore 分支](https://github.com/Corfirean/azerothcore-wotlk-coa)。继承自 MaNGOS 的部分采用 GPL-2.0-or-later,AzerothCore 自有部分采用 AGPL-3.0。[mod-coa-playerbots](https://github.com/Corfirean/mod-coa-playerbots) 采用 AGPL-3.0。每个安装包的清单都记录了准确的提交版本,便于查找对应源码。
- 随附的 MySQL 保留其 GPL-2.0 许可,许可文本位于安装包的 `Licenses` 目录。
- `Data` 中的游戏数据(`dbc`、`maps`、`vmaps`、`mmaps`)提取自已关闭的 Ascension Conquest of Azeroth 服务器客户端,**不属于**管理器许可的授权范围。
-56
View File
@@ -1,39 +1,5 @@
# TODO
## Подготовка 0.9.8, 2026-10-31
- Подготовлены исходники `C:/games/source/per-race-manager`, ветка `fix/launcher-validation-candidate-20261031`: изоляция bot configs на время проверки с точным восстановлением, повторное использование MySQL внутри validation, зависимость Dungeon Clear от SQUID, три режима логов и экспорт этапов launcher/control owner.
- Workspace: 840 тестов прошли, 60 ignored; последующие focused diagnostics: 11 прошли. Переводы новых заметок и UI подготовлены, web build/i18n/bridge/history checks прошли. Подробности и ограничения: `C:/games/source/candidate-preparation-20261031.md`.
- Не выпускать Manager до кандидата сервера. Installer ещё не собирался и не публиковался; подготовка источников не равна готовому кандидату.
## Приоритет: проверка установки и обновления (2026-10-31)
- **Локальные замеры массовых Companions (2026-10-31):** отчёт `C:/games/source/companions-benchmark-20261031/REPORT.md`, сырые выборки/qualification в той же папке. Native worldserver SHA `bd9f65ac7543fad8159231000d5ef6436a159aa009b65cbdc9541a0e9fe1ee7b`, Ryzen 7 7700X/32 GiB, `MapUpdate.Threads=1`, все CPU доступны. Перед условиями восстанавливался один снимок персонажей. Без записи логов медианы среднего тика: 0 ботов 4.5 ms; 500 — 39 ms; 1000 — 91 ms; 2000 — 246 ms, поздний замер 259 ms. С обычными логами: 500 — 43.5 ms; 1000 — 111 ms. Запуск 2000 с логами дал 1381 ms, последующий полный Logger-off 363 ms, но нагрузка хоста менялась; чистый множитель логирования этими числами не доказан. Всего 9 условий с подтверждённым online; исходная база 21 шаблон/0 тестовых аккаунтов восстановлена, тестовые процессы остановлены. Повтор 2000 с логами подготовлен, но НЕ выполнен: на C: осталось около 300 MiB. Соответствующий PDB для функционального профиля отсутствует.
- [ ] **Разобрать штатное завершение мира под большой популяцией**:
- В локальном бенчмарке ряд запусков (включая 2000 ботов и полностью отключённые логгеры) не завершились за 90 секунд после `server shutdown 1s 0`; пришлось завершать только тестовый процесс после сохранения измерений. Стек `2000-shutdown-stacks.txt` показывает ожидание `MSVCP140!Thrd_join`, точный ожидаемый поток без matching PDB не установлен. Не объявлять это доказанной причиной пользовательского control.lock или влиянием только логов.
- [ ] **Разобрать удержание control.lock после видимого запуска сервера**:
- Пользователь после hotfix v3 получил `Another start/stop action is in progress` при внешнем `with launcher["control_lock"]()`, хотя мир отвечал и Manager показывал работающий сервер. Не считать это доказательством «зависшего файла»: Windows блокирует диапазон живым дескриптором.
- На Python 3.14.7 точно воспроизведён конкурентный захват: второй лаунчер получает эту ошибку, после выхода владельца захват снова проходит. Причина долгого удержания у пользователя пока не установлена; нужны его свежие launch diagnostics.
- Добавить безопасную диагностику владельца (PID, время создания, действие, этап ожидания) и проверить сериализацию Start/Stop/Restart/validation/recovery. Различать реальную занятость и прочие OSError захвата, которые сейчас маскируются одним сообщением. Не удалять lock и не завершать чужие процессы ради обхода.
- **Проверка с ботами завершена (2026-10-31):** пользователь показал работающие MySQL/auth/world, 2000 Companions онлайн и вход своим клиентом в мир после обновления. Это подтверждает обычный запуск с ботами после hotfix, но не пригодность массового автологина для validation. Ранний снимок показывает около 11 тиков/с на 2m32s работы; результат замера после прогрева пока неизвестен.
- **Пользовательская проверка (2026-10-31):** после hotfix лаунчера v3 и отключения автологина Companions обновление завершилось успешно (server `0.261030.90`, Manager `0.9.7`). Отдельная проверка с включёнными ботами пока не завершена.
- [ ] **Сократить повторные запуски MySQL в установке/обновлении**:
- Пользователь после успешного обновления отметил большую длительность и многократные старты/остановки базы, в том числе на 85%. Проследить фактическую последовательность snapshot/SQL/schema/validation/recovery и повторно использовать уже запущенную, проверенную базу между совместимыми этапами.
- Не убирать остановки, необходимые для согласованного backup/restore, замены файлов и восстановления после отказа. Сохранить гарантии rollback и владения процессами. Записать число стартов/остановок и длительность этапов до/после; проверить обновление без ботов и восстановление после ошибки.
- [ ] **Временный конфиг проверки без массового запуска ботов**:
- Запрос владельца: грузить 2000 ботов ради проверки установки/обновления недопустимо. Облегчить все проверочные запуски, включая восстановление/повторную проверку, где применяется тот же путь запуска.
- Факты случая: этап обновления 85%, CoA Companions поставили в очередь 2000 ботов; пользователь сообщает об остановке продвижения на 519 за 6 минут. Логи показывают 518 уникальных имён в `ACTIVE_LIST`. Это не SQUID. Место зависания и причинная связь с автологином пока не установлены.
- Перед проверочным запуском временно отключать `CoaBots.AutoLoginOnStartup` и проверить другие пути автоматического входа/создания/заселения Companions, включая `CoaBots.RandomSpawn.AutoLogin`. Аналогично подавлять автоматическое заселение SQUID, если выбран этот модуль. Не подменять пользовательский выбор системы ботов и не отключать модуль целиком вместо проверки его инициализации.
- Сохранять исходные байты/отсутствие изменяемых конфигов в журнале восстановления; вернуть их до обычного запуска как при успехе, так и при ошибке, отмене, rollback и восстановлении после прерывания Manager. Не оставлять автологин выключенным пользователю. Проверить primary и дополнительные realms.
- Проверка должна подтверждать инициализацию ядра/выбранных модулей, SQL/schema, сервисы и отклик управляющего интерфейса; не ждать заполнения мира ботами и не создавать для этого тысячи персонажей. Вне validation обычный запуск сохраняет поведение пользовательских настроек.
- Проверить сценарии с Companions и лимитом 2000, SQUID, выключенными ботами; успех, отказ запуска, прерывание и восстановление исходных конфигов. Добавить регрессионные проверки и changelog после реализации.
- [ ] **Доставить исправление `manage.py` для PID 0 в согласованном серверном обновлении**:
- Серверная задача и готовый локальный hotfix описаны в `C:/games/coa-server-build/TODO.md`. Проверить импортируемый запуск через `runpy`/внешний вызов `main()` и штатный Manager update; диагностика должна работать при обоих способах загрузки.
## UI / UX
- [x] **Предупреждение о несохранённых изменениях при переходе между вкладками (Unsaved Changes Guard / Modal)**:
- Если у пользователя есть несохранённые изменения в настройках (`ModulesPage`, `SettingsPage` — сервер, боты и др.) и он переходит на другую вкладку (в боковом меню `Shell.tsx` или кнопками навигации), показывать pop-up диалог подтверждения.
@@ -61,25 +27,3 @@
4. Анализировать последние строки `Core/Logs/Server.log` и `Errors.log` на критические маркеры (потеря соединения с MySQL, нехватка RAM/OOM, ошибка бинда портов).
5. Проверять по встроенному словарю известных сигнатур (паттерны частых крашей с понятным описанием, например: «Сбой удаления объекта из сетки карты», «Ошибка запроса к базе данных», «Нехватка оперативной памяти»).
- *Fallback:* Если сигнатура не опознана в словаре известных проблем, показывать краткую техническую выжимку (код исключения + сработавший ассерт или вершина Call Stack) и кнопку разворота полного текста крашлога / копирования.
## Модули и контент
- [ ] **Следующий билд: переключатель Dungeon Clear только для SQUID** (запрос владельца 2026-10-31):
- Модуль: https://github.com/Zyth45/mod-dungeon-clear, ветка `coa`; серверная интеграция описана в `C:/games/coa-server-build/TODO.md`.
- Добавить в каталог отдельный модуль Dungeon Clear, по умолчанию выключенный. На старых серверах без модуля показывать недоступным.
- Разрешать включение только при установленном и включённом SQUID (`playerbots`). При выключенном SQUID блокировать переключатель и объяснять причину; CoA Companions не подходят.
- Проверять зависимость также в Rust backend при изменении модуля и его настроек. Отключение SQUID/переход на Companions отключает Dungeon Clear; обратное включение SQUID не включает Dungeon Clear автоматически.
- Проверить сохранение после перезапуска, ручные конфиги и отказ включения через API в обход UI. Серверный guard обязателен независимо от Manager.
- Все новые UI-тексты — на шести языках. После реализации добавить changelog fragments в соответствующие компоненты; пока это запланированная, не выпущенная возможность.
- [ ] **Внедрение модуля гильдхаусов (`mod-guildhouse`)**:
- **Репозиторий:** `https://github.com/azerothcore/mod-guildhouse`
- **Пайплайн сборки (`coa-server-build`):**
- Добавить checkout модуля в `.github/workflows/server-binaries.yml`, `build.yml` и `build-linux.yml` в директорию `modules/mod-guildhouse`.
- Добавить лицензию модуля и копирование в `scripts/assemble-tree.ps1` (`Licenses/` и `NOTICE.txt`).
- **Адаптация под Conquest of Azeroth (CoA):**
- В диалоге дворецкого (`mod_guildhouse_butler.cpp`) вместо 10 классических тренеров WotLK спавнить **Book of Ascension** (entry `499992`), которая открывает интерфейс `mod-spellbook` и заменяет всех тренеров для кастомных классов и прогрессии способностей.
- Оставить без изменений: профессии, порталы в столицы, банк, аукционы (включая нейтральный), почту, вендоров, парикмахера, горн и наковальню.
- **База данных:**
- Миграции модуля (`guild_house`, `guild_house_spawns`, `creature_template`, `gameobject_template`, `mod_guildhouse_locale`) подхватываются `coa-release` автоматически при валидации схемы контракта.
- **В игре:**
- Разместить NPC-продавца гильдхаусов (`.npc add 500030`) в ключевых хабах / столицах (Штормград, Оргриммар, Даларан).
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Advanced settings cover creature melee damage, spell damage and health by rank
---
Configure normal, elite, rare, rare elite and world boss creatures separately. Existing normal-creature settings now identify their scope clearly. Changes persist in the server template and require a world server restart.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: Internet sharing accepts existing port forwards to the same server
---
When a router rejects an already configured port forward, the Manager checks its destination. Matching enabled rules are accepted; conflicting rules report the affected TCP port and remain untouched.
@@ -0,0 +1,7 @@
---
area: manager
type: changed
audience: admins
title: The Auction House Bot card has a single switch
---
The separate "Post auctions" option is gone; turning the module on is enough. A server build with the single-switch Auction House Bot is needed, and an old EnableSeller line in the config is ignored.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: More character and server browser controls now use your selected language
---
Completed missing German, French, Spanish and Simplified Chinese labels and improved Chinese font support.
@@ -0,0 +1,7 @@
---
area: manager
type: added
audience: admins
title: Configure the day and night cycle from the module settings
---
TimeIsTime now has a module card, an on/off switch and settings translated into all six Manager languages.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: admins
title: A stalled database inspection no longer blocks server maintenance indefinitely
---
Update checks limit how long their database client can run and release the maintenance lock after a timeout. The Manager stops only its inspection client, keeps the database server running and reports that migration history could not be checked.
@@ -0,0 +1,7 @@
---
area: manager
type: fixed
audience: players
title: Portable characters open again after using an experimental Manager
---
Preserves saved characters and collections when opening a portable store upgraded by an experimental Manager.
@@ -1,7 +0,0 @@
---
area: manager
type: fixed
audience: admins
title: Starting a server sets the character classes of the realm chosen on Overview
---
A new Conquest of Azeroth server could show two class models, or none, on the character creation screen. The Manager now sets the model of the chosen realm before every start.
@@ -1,7 +0,0 @@
---
area: manager
type: added
audience: admins
title: Start Wildcard and Warcraft Reborn together with Conquest of Azeroth
---
Settings now has two options, one for Wildcard and one for Warcraft Reborn. Turn on either one, or both to run all three realms at once, each with its own characters and port.
@@ -1,7 +0,0 @@
---
area: manager
type: changed
audience: players
title: The game client now comes from the community launcher, not from the Manager
---
The community moved the game client behind its official launcher (account sign-in), so the Manager can no longer download or update it. The built-in client download and update are removed. "Set up the game client" now sends you to coa-development.org to get the launcher; once the launcher has installed the game, choose "I already have a client" and pick its folder. Linking a folder, the server address switch and the companion addon work as before.
-24
View File
@@ -103,7 +103,6 @@ pub enum Request {
TransferOffer {
transfer_id: Uuid,
character_id: Uuid,
ruleset: String,
canonical_revision: u64,
content_hash: String,
total_size: usize,
@@ -190,7 +189,6 @@ pub enum Response {
/// appearance and vanity ids the Host holds for the account (kind -> ids).
Claimed {
character_id: Uuid,
ruleset: String,
sha256: String,
payload: String,
collections: BTreeMap<String, Vec<u32>>,
@@ -275,15 +273,11 @@ pub fn decode_request(bytes: &[u8]) -> Result<Request> {
return invalid("the client name is too long")
}
Request::TransferOffer {
ruleset,
content_hash,
total_size,
collections,
..
} => {
if !matches!(ruleset.as_str(), "coa" | "wildcard" | "reborn") {
return invalid("transfer ruleset must be coa, wildcard, or reborn");
}
if content_hash.len() != 64 || !content_hash.chars().all(|c| c.is_ascii_hexdigit()) {
return invalid("transfer content hash must be 64 hex characters");
}
@@ -436,7 +430,6 @@ mod tests {
let offer = Request::TransferOffer {
transfer_id: tid,
character_id: cid,
ruleset: "coa".into(),
canonical_revision: 5,
content_hash: hash.clone(),
total_size: 1024,
@@ -449,7 +442,6 @@ mod tests {
let bad_hash = Request::TransferOffer {
transfer_id: tid,
character_id: cid,
ruleset: "coa".into(),
canonical_revision: 5,
content_hash: "too_short".into(),
total_size: 1024,
@@ -474,21 +466,5 @@ mod tests {
};
let resp_dec = decode_response(&encode_response(&resp)).unwrap();
assert_eq!(resp, resp_dec);
// Control protocol v2 requires ruleset in TransferOffer; missing is rejected
let missing_ruleset_json = serde_json::json!({
"op": "transfer_offer",
"transfer_id": tid,
"character_id": cid,
"canonical_revision": 5,
"content_hash": hash,
"total_size": 1024,
"collections": {}
});
let encoded_missing = serde_json::to_vec(&missing_ruleset_json).unwrap();
assert!(
decode_request(&encoded_missing).is_err(),
"missing ruleset in v2 must be rejected"
);
}
}
+1 -1
View File
@@ -16,7 +16,7 @@ pub mod coord;
pub mod noise;
pub mod relay;
pub const CONTROL_PROTOCOL_VERSION: u32 = 2;
pub const CONTROL_PROTOCOL_VERSION: u32 = 1;
#[derive(Debug, thiserror::Error, PartialEq, Eq)]
pub enum ControlError {
@@ -90,7 +90,6 @@ fn test_app_request_hostile_limits_and_validation() {
let offer = Request::TransferOffer {
transfer_id: Uuid::now_v7(),
character_id: Uuid::now_v7(),
ruleset: "coa".into(),
canonical_revision: 1,
content_hash: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef".into(),
total_size: 1024,
@@ -106,7 +105,6 @@ fn test_app_request_hostile_limits_and_validation() {
let bad_hash_offer = Request::TransferOffer {
transfer_id: Uuid::now_v7(),
character_id: Uuid::now_v7(),
ruleset: "coa".into(),
canonical_revision: 1,
content_hash: "not_a_valid_hex_hash".into(),
total_size: 1024,
@@ -114,18 +112,6 @@ fn test_app_request_hostile_limits_and_validation() {
};
assert!(decode_request(&encode_request(&bad_hash_offer)).is_err());
// 4b. Invalid ruleset rejected
let bad_ruleset_offer = Request::TransferOffer {
transfer_id: Uuid::now_v7(),
character_id: Uuid::now_v7(),
ruleset: "invalid_ruleset".into(),
canonical_revision: 1,
content_hash: "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef".into(),
total_size: 1024,
collections: BTreeMap::new(),
};
assert!(decode_request(&encode_request(&bad_ruleset_offer)).is_err());
// 5. TransferChunk offset out of bounds
let bad_offset_chunk = Request::TransferChunk {
transfer_id: Uuid::now_v7(),
+75
View File
@@ -0,0 +1,75 @@
//! Live check of the client download path against the community launcher's public server:
//! reads the manifest and downloads the few smallest files into a temp folder (never a real client).
//! Usage: cargo run -p coa-core --example client_probe (PROBE_SKIP=n skips the n smallest files)
use coa_core::clientdl::{self, Apply, Manifest};
use coa_core::download::{Cancel, HttpTransport};
fn main() {
let full = clientdl::fetch_latest().expect("manifest");
println!(
"version {} · {} files · {:.1} GB",
full.version,
full.files.len(),
full.total_bytes() as f64 / 1e9
);
let mut small = full.files.clone();
small.sort_by_key(|f| f.size);
let skip: usize = std::env::var("PROBE_SKIP")
.ok()
.and_then(|v| v.parse().ok())
.unwrap_or(0);
let small: Vec<_> = small.into_iter().skip(skip).take(6).collect();
let manifest = Manifest {
version: full.version.clone(),
published_at: None,
files: small,
};
let dir = std::env::temp_dir().join(format!("coa-client-probe-{}", std::process::id()));
std::fs::create_dir_all(&dir).unwrap();
let cancel = Cancel::default();
let plan = clientdl::plan(&dir, &manifest, &Default::default(), &cancel, &|_| {}).unwrap();
println!(
"plan: {} files, {} bytes",
plan.items.len(),
plan.download_bytes
);
let transport = HttpTransport::new().unwrap();
clientdl::apply(
&Apply {
client: &dir,
manifest: &manifest,
plan: &plan,
keep_modified: false,
transport: &transport,
objects_url: clientdl::OBJECTS_URL,
cancel: &cancel,
},
&|s| {
println!(
"{} {}/{} {}",
s.phase,
s.done,
s.total,
s.file.unwrap_or_default()
)
},
)
.expect("apply");
let again = clientdl::plan(
&dir,
&manifest,
&clientdl::load_state(&dir).unwrap(),
&cancel,
&|_| {},
)
.unwrap();
println!(
"second plan: {} to do, {} up to date, version {:?}",
again.items.len(),
again.up_to_date_files,
clientdl::local(&dir).version
);
std::fs::remove_dir_all(&dir).unwrap();
}
+53 -120
View File
@@ -1,124 +1,57 @@
//! Read-only audit, or explicit SQL checks on a disposable database fixture.
use coa_core::{
db::{Account, Db},
manifest::Manifest,
migrations::{self, Store},
realms::Mode,
};
use coa_core::{db::{Account, Db}, migrations::{self, Store}, manifest::Manifest, realms::Mode};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let args: Vec<_> = std::env::args().collect();
if args.len() < 3 {
return Err("usage: migration_plan <root> <signed-manifest> [--apply|--sql-only <migration-directory>]".into());
let args: Vec<_> = std::env::args().collect();
if args.len() < 3 { return Err("usage: migration_plan <root> <signed-manifest> [--apply|--sql-only <migration-directory>]".into()); }
let root = std::path::Path::new(&args[1]);
let bytes = std::fs::read(&args[2])?;
let signature = std::fs::read_to_string(format!("{}.sig",args[2]))?;
coa_core::signing::verify(&bytes, &signature, coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
let manifest = Manifest::parse(&bytes)?;
for (index,mode) in [Mode::Coa, Mode::Wildcard].into_iter().enumerate() {
let db = Db::from_repack(root, Account::Admin)?.for_realm(mode);
let rows = db.load_readonly()?;
let relevant: Vec<_> = rows.iter().filter(|r| r.id == "rev_20260903_01_live_class_baseline").map(|r| format!("{} {:?} {}",r.db,r.status,r.baseline)).collect();
println!("{} baseline history: {:?}",mode.name(),relevant);
let list: Vec<_> = manifest.migrations.iter().filter(|m|index==0 || m.db!="auth").cloned().collect();
let plan = migrations::status(&db,&list)?;
println!("{} pending: {:?}",mode.name(),plan.iter().filter(|m|m.status!=migrations::Status::Applied).map(|m|(&m.db,&m.id,m.status)).collect::<Vec<_>>());
}
if args.get(3).is_some_and(|s| s == "--apply" || s == "--sql-only") {
assert!(root.file_name().unwrap().to_string_lossy().starts_with("update-database-diagnosis-") && root.join(".coa-update-fixture").is_file(), "Only disposable fixture roots may be changed");
if args[3] == "--sql-only" {
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
let identity = || -> coa_core::Result<String> {
let mut rows = String::new();
for (schema,table,columns) in [("acore_auth","account","id,HEX(username)"),("acore_characters","characters","guid,account,HEX(name)"),("acore_characters_wildcard","characters","guid,account,HEX(name)")] {
rows.push_str(schema);
rows.push_str(&db.query(&format!("SELECT {columns} FROM {schema}.{table} ORDER BY 1;"))?);
}
let root = std::path::Path::new(&args[1]);
let bytes = std::fs::read(&args[2])?;
let signature = std::fs::read_to_string(format!("{}.sig", args[2]))?;
coa_core::signing::verify(&bytes, &signature, coa_core::signing::EMBEDDED_PUBLIC_KEY)?;
let manifest = Manifest::parse(&bytes)?;
for (index, mode) in [Mode::Coa, Mode::Wildcard].into_iter().enumerate() {
let db = Db::from_repack(root, Account::Admin)?.for_realm(mode);
let rows = db.load_readonly()?;
let relevant: Vec<_> = rows
.iter()
.filter(|r| r.id == "rev_20260903_01_live_class_baseline")
.map(|r| format!("{} {:?} {}", r.db, r.status, r.baseline))
.collect();
println!("{} baseline history: {:?}", mode.name(), relevant);
let list: Vec<_> = manifest
.migrations
.iter()
.filter(|m| index == 0 || m.db != "auth")
.cloned()
.collect();
let plan = migrations::status(&db, &list)?;
println!(
"{} pending: {:?}",
mode.name(),
plan.iter()
.filter(|m| m.status != migrations::Status::Applied)
.map(|m| (&m.db, &m.id, m.status))
.collect::<Vec<_>>()
);
}
if args
.get(3)
.is_some_and(|s| s == "--apply" || s == "--sql-only")
{
assert!(
root.file_name()
.unwrap()
.to_string_lossy()
.starts_with("update-database-diagnosis-")
&& root.join(".coa-update-fixture").is_file(),
"Only disposable fixture roots may be changed"
);
if args[3] == "--sql-only" {
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
let identity = || -> coa_core::Result<String> {
let mut rows = String::new();
for (schema, table, columns) in [
("acore_auth", "account", "id,HEX(username)"),
("acore_characters", "characters", "guid,account,HEX(name)"),
(
"acore_characters_wildcard",
"characters",
"guid,account,HEX(name)",
),
] {
rows.push_str(schema);
rows.push_str(&db.query(&format!(
"SELECT {columns} FROM {schema}.{table} ORDER BY 1;"
))?);
}
Ok(coa_core::fsx::sha256_bytes(rows.as_bytes()))
};
let before = identity()?;
migrations::verify_files(&manifest.migrations, std::path::Path::new(&args[4]))?;
for (index, mode) in [Mode::Coa, Mode::Wildcard].into_iter().enumerate() {
let realm_db = db.clone().for_realm(mode);
let list: Vec<_> = manifest
.migrations
.iter()
.filter(|m| index == 0 || m.db != "auth")
.cloned()
.collect();
let result = migrations::apply_pending(
&realm_db,
&list,
std::path::Path::new(&args[4]),
&|| Ok("disposable fixture".into()),
)?;
println!(
"{} SQL result: {}",
mode.name(),
serde_json::to_string(&result)?
);
if result.failed.is_some() {
return Err("SQL failed; fixture preserved".into());
}
}
assert_eq!(before, identity()?, "Account or character identity changed");
println!("Account and character identities preserved: {}", before);
let capture = root.join("captured-schema");
coa_core::schema_check::capture(&db, &capture)?;
println!(
"Captured schema SHA256: {}",
coa_core::fsx::sha256_file(&capture.join(coa_core::schema_check::CONTRACT))?
);
return Ok(());
}
if args.len() != 5 {
return Err("Migration directory required".into());
}
use coa_core::update::{Env, RepackEnv};
let meta = coa_core::registry::metadata_dir_for(root)?;
let env = RepackEnv {
root,
meta_dir: &meta,
};
let result = env.migrate(&manifest, std::path::Path::new(&args[4]));
let _ = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
println!("Application result: {}", serde_json::to_string(&result?)?);
}
Ok(())
Ok(coa_core::fsx::sha256_bytes(rows.as_bytes()))
};
let before = identity()?;
migrations::verify_files(&manifest.migrations,std::path::Path::new(&args[4]))?;
for (index,mode) in [Mode::Coa,Mode::Wildcard].into_iter().enumerate() {
let realm_db = db.clone().for_realm(mode);
let list: Vec<_> = manifest.migrations.iter().filter(|m|index==0 || m.db!="auth").cloned().collect();
let result = migrations::apply_pending(&realm_db,&list,std::path::Path::new(&args[4]),&||Ok("disposable fixture".into()))?;
println!("{} SQL result: {}",mode.name(),serde_json::to_string(&result)?);
if result.failed.is_some() {return Err("SQL failed; fixture preserved".into());}
}
assert_eq!(before,identity()?,"Account or character identity changed");
println!("Account and character identities preserved: {}",before);
let capture = root.join("captured-schema");
coa_core::schema_check::capture(&db,&capture)?;
println!("Captured schema SHA256: {}",coa_core::fsx::sha256_file(&capture.join(coa_core::schema_check::CONTRACT))?);
return Ok(());
}
if args.len() != 5 { return Err("Migration directory required".into()); }
use coa_core::update::{Env, RepackEnv};
let meta = coa_core::registry::metadata_dir_for(root)?;
let env = RepackEnv { root, meta_dir: &meta };
let result = env.migrate(&manifest, std::path::Path::new(&args[4]));
let _ = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
println!("Application result: {}",serde_json::to_string(&result?)?);
}
Ok(())
}
+3 -3
View File
@@ -457,7 +457,7 @@ fn run() -> Result<(), String> {
}
("collection-states", [out]) => {
let states = OwnerService::new(&mut store)
.collection_states(coa_core::portable::Ruleset::Coa)
.collection_states()
.map_err(|e| e.to_string())?;
for s in &states {
println!(
@@ -618,7 +618,7 @@ fn run() -> Result<(), String> {
let set =
coa_core::portable::collection::IdSet::from_ids(ids).map_err(|e| e.to_string())?;
let merge = store
.merge_collection(profile, coa_core::portable::Ruleset::Coa, kind, &set)
.merge_collection(profile, kind, &set)
.map_err(|e| e.to_string())?;
println!(
"{kind}: {} id(s) added{}",
@@ -633,7 +633,7 @@ fn run() -> Result<(), String> {
let profile = store.default_profile().map_err(|e| e.to_string())?;
for kind in coa_core::portable::session::protocol::COLLECTION_KINDS {
match store
.collection_info(profile, coa_core::portable::Ruleset::Coa, kind)
.collection_info(profile, kind)
.map_err(|e| e.to_string())?
{
Some(i) => println!(
+26 -60
View File
@@ -1,62 +1,28 @@
//! Exercise the production updater only on a disposable copy of an installed server.
use coa_core::{
registry::MetaDir,
update::{self, Env, RepackEnv},
};
fn main() -> Result<(), Box<dyn std::error::Error>> {
let args: Vec<_> = std::env::args().collect();
if args.len() != 3 && args.len() != 4 {
return Err("usage: upgrade_fixture <disposable-root> <signed-package-directory>".into());
}
let root = std::path::Path::new(&args[1]);
assert!(
root.file_name()
.unwrap()
.to_string_lossy()
.starts_with("coa-schema-fixture-real")
&& root.join(".coa-update-fixture").is_file(),
"Disposable fixture required"
);
let meta = coa_core::registry::metadata_dir_for(root)?;
let (_, installed) = MetaDir::open(&meta)?;
assert_eq!(
coa_core::fsx::canonicalize_lenient(std::path::Path::new(&installed.server_path))?,
coa_core::fsx::canonicalize_lenient(root)?,
"Fixture metadata must point to the copy"
);
assert!(
installed.client_path.is_none(),
"Detach the real client from fixture metadata"
);
let env = RepackEnv {
root,
meta_dir: &meta,
};
if args.get(3).is_some_and(|flag| flag == "--validate-only") {
let result = env.validate();
let _ = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
result?;
println!("Startup and identity validation passed");
return Ok(());
}
let outcome = update::apply(
&update::Params {
root,
meta_dir: &meta,
source: coa_core::pkgsource::Source::Dir(args[2].clone().into()),
trusted_key: coa_core::signing::EMBEDDED_PUBLIC_KEY,
cancel: Default::default(),
resolutions: Default::default(),
env: &env,
fail_after_ops: None,
},
&|phase, percent| println!("{percent}% {phase}"),
);
let stopped = coa_core::driver::run(root, coa_core::driver::Verb::StopAll);
println!("Shutdown after test: {:?}", stopped.map(|r| r.ok));
let outcome = outcome?;
println!("Final transaction: {:?}", outcome.txn.state);
env.ensure_stopped()?;
assert_eq!(outcome.txn.state, update::State::Committed);
Ok(())
use coa_core::{registry::MetaDir, update::{self, Env, RepackEnv}};
fn main() -> Result<(),Box<dyn std::error::Error>> {
let args:Vec<_>=std::env::args().collect();
if args.len()!=3 && args.len()!=4 {return Err("usage: upgrade_fixture <disposable-root> <signed-package-directory>".into());}
let root=std::path::Path::new(&args[1]);
assert!(root.file_name().unwrap().to_string_lossy().starts_with("coa-schema-fixture-real") && root.join(".coa-update-fixture").is_file(),"Disposable fixture required");
let meta=coa_core::registry::metadata_dir_for(root)?;
let (_,installed)=MetaDir::open(&meta)?;
assert_eq!(coa_core::fsx::canonicalize_lenient(std::path::Path::new(&installed.server_path))?,coa_core::fsx::canonicalize_lenient(root)?,"Fixture metadata must point to the copy");
assert!(installed.client_path.is_none(),"Detach the real client from fixture metadata");
let env=RepackEnv{root,meta_dir:&meta};
if args.get(3).is_some_and(|flag|flag=="--validate-only") {
let result=env.validate();
let _=coa_core::driver::run(root,coa_core::driver::Verb::StopAll);
result?;
println!("Startup and identity validation passed");
return Ok(());
}
let outcome=update::apply(&update::Params{root,meta_dir:&meta,source:coa_core::pkgsource::Source::Dir(args[2].clone().into()),trusted_key:coa_core::signing::EMBEDDED_PUBLIC_KEY,cancel:Default::default(),resolutions:Default::default(),env:&env,fail_after_ops:None},&|phase,percent|println!("{percent}% {phase}"));
let stopped=coa_core::driver::run(root,coa_core::driver::Verb::StopAll);
println!("Shutdown after test: {:?}",stopped.map(|r|r.ok));
let outcome=outcome?;
println!("Final transaction: {:?}",outcome.txn.state);
env.ensure_stopped()?;
assert_eq!(outcome.txn.state,update::State::Committed);
Ok(())
}
File diff suppressed because it is too large. Load diff
+9 -28
View File
@@ -261,9 +261,7 @@ pub fn config_files(root: &Path) -> Vec<String> {
for e in rd.flatten() {
let n = e.file_name().to_string_lossy().to_string();
// database.json holds generated database passwords; it is launcher state, not configuration.
if e.path().is_file()
&& (n.contains(".template") || n == "repack.json" || n == "docker.json")
{
if e.path().is_file() && (n.contains(".template") || n == "repack.json" || n == "docker.json") {
out.push(format!("Settings/{n}"));
}
}
@@ -383,19 +381,12 @@ pub fn create(
let build = || -> Result<Vec<Component>> {
let mut components = Vec::new();
let realm = crate::realms::state(root)?;
let mut databases: Vec<(String, &str)> = wanted_databases(kind)
.iter()
.map(|name| Ok((name.to_string(), realm.active.schema(name)?)))
.collect::<Result<_>>()?;
let mut databases: Vec<(String, &str)> = wanted_databases(kind).iter()
.map(|name| Ok((name.to_string(), realm.active.schema(name)?))).collect::<Result<_>>()?;
if kind != Kind::Config {
for other in realm.modes().into_iter().filter(|m| *m != realm.active) {
databases.push((
format!("{}-characters", other.name()),
other.schema("characters")?,
));
if kind == Kind::Full {
databases.push((format!("{}-world", other.name()), other.schema("world")?));
}
databases.push((format!("{}-characters", other.name()), other.schema("characters")?));
if kind == Kind::Full { databases.push((format!("{}-world", other.name()), other.schema("world")?)); }
}
}
if kind != Kind::Config && with_database(root, |db| db.schema_exists("acore_playerbots"))? {
@@ -436,24 +427,16 @@ pub fn create(
return Err(e);
}
};
let mysql_snapshot = if kind == Kind::Full
&& matches!(trigger, Trigger::BeforeUpdate | Trigger::BeforeRepair)
&& cfg!(windows)
&& !crate::docker::is_docker(root)
{
let mysql_snapshot = if kind == Kind::Full && matches!(trigger, Trigger::BeforeUpdate | Trigger::BeforeRepair) && cfg!(windows) && !crate::docker::is_docker(root) {
progress("Saving a complete stopped MySQL recovery copy");
match crate::mysql_snapshot::capture(root, &partial) {
Ok(snapshot) => Some(snapshot),
Err(error) => {
if let Ok(owned) = fsx::ensure_within(&backups_dir(meta), &partial) {
let _ = fs::remove_dir_all(owned);
}
if let Ok(owned) = fsx::ensure_within(&backups_dir(meta), &partial) { let _ = fs::remove_dir_all(owned); }
return Err(error);
}
}
} else {
None
};
} else { None };
let point = RecoveryPoint {
realm: crate::realms::state(root)?.active,
schema: 1,
@@ -502,9 +485,7 @@ pub fn verify(meta: &Path, id: &str) -> Result<VerifyReport> {
let dir = point_dir(meta, id)?;
let mut problems = Vec::new();
if let Some(snapshot) = &point.mysql_snapshot {
if let Err(error) = crate::mysql_snapshot::verify(&dir, snapshot) {
problems.push(error.to_string());
}
if let Err(error) = crate::mysql_snapshot::verify(&dir, snapshot) { problems.push(error.to_string()); }
}
let mut names = std::collections::BTreeSet::new();
let mut schemas = std::collections::BTreeSet::new();
-441
View File
@@ -1,441 +0,0 @@
//! CLI tool for CoA Server Manager plugin operations (testing, qualification and automation).
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use coa_core::plugins::{self, PluginMetadata};
fn print_usage() {
eprintln!(
r#"csm_plugins CLI
Usage:
csm_plugins install <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>] [--deps <deps>] [--enable] [--crash-at <point>]
csm_plugins update <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>] [--crash-at <point>]
csm_plugins enable <server> <id> [--crash-at <point>]
csm_plugins disable <server> <id> [--crash-at <point>]
csm_plugins remove <server> <id> [--crash-at <point>]
csm_plugins repair <server> [--crash-at <point>]
csm_plugins recover <server>
csm_plugins prune <server>
csm_plugins list <server>
csm_plugins reconcile_squid <server> [char_schema]
csm_plugins multiworld <server> <second_root> [--allow <a,b>] [--crash-at <point>]
csm_plugins analyze <local_repository_path> [--json]
csm_plugins analyze-github <url> [--cache-dir <dir>] [--contract <v02|v03>] [--json]
csm_plugins verify-artifact-provenance <worldserver_path> [--sdk-json <path>] [--json]
"#
);
}
fn main() -> Result<(), Box<dyn std::error::Error>> {
let args: Vec<String> = std::env::args().collect();
if args.len() < 3 {
print_usage();
std::process::exit(1);
}
// Inspect for --crash-at argument
for i in 0..args.len() {
if args[i] == "--crash-at" && i + 1 < args.len() {
std::env::set_var("CSM_CRASH_AT", &args[i + 1]);
}
}
let cmd = &args[1];
let server = Path::new(&args[2]);
match cmd.as_str() {
"install" => {
if args.len() < 7 {
eprintln!("Usage: install <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>] [--deps <deps>] [--enable]");
std::process::exit(1);
}
let id = &args[3];
let name = &args[4];
let version = &args[5];
let dll_path = Path::new(&args[6]);
let dll_bytes = fs::read(dll_path)?;
let digest = plugins::sha256_digest(&dll_bytes);
let mut pdb_bytes = None;
let mut conf_list = Vec::new();
let mut deps = Vec::new();
let mut enable = false;
let mut i = 7;
while i < args.len() {
match args[i].as_str() {
"--pdb" => {
i += 1;
if i < args.len() {
pdb_bytes = Some(fs::read(&args[i])?);
}
}
"--conf" => {
i += 1;
if i < args.len() {
for item in args[i].split(',') {
if !item.is_empty() {
let p = Path::new(item);
let file_name = p.file_name().unwrap().to_string_lossy().into_owned();
let bytes = fs::read(p)?;
conf_list.push((file_name, bytes));
}
}
}
}
"--deps" => {
i += 1;
if i < args.len() {
deps = args[i].split(',').filter(|s| !s.is_empty()).map(|s| s.to_string()).collect();
}
}
"--enable" => {
enable = true;
}
_ => {}
}
i += 1;
}
let conf_names: Vec<String> = conf_list.iter().map(|(n, _)| n.clone()).collect();
let dist_refs: Vec<(String, &[u8])> = conf_list.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
let meta = PluginMetadata {
id: id.clone(),
name: name.clone(),
version: version.clone(),
description: BTreeMap::new(),
sha256: digest,
required: true,
deps,
conf_files: conf_names,
enable_key: None,
status: Some("release".into()),
icon: None,
};
plugins::install(server, meta, &dll_bytes, pdb_bytes.as_deref(), &dist_refs, enable)?;
println!("Installed plugin '{}' successfully (enabled: {})", id, enable);
}
"update" => {
if args.len() < 7 {
eprintln!("Usage: update <server> <id> <name> <version> <dll> [--pdb <pdb>] [--conf <dist_confs>]");
std::process::exit(1);
}
let id = &args[3];
let name = &args[4];
let version = &args[5];
let dll_path = Path::new(&args[6]);
let dll_bytes = fs::read(dll_path)?;
let digest = plugins::sha256_digest(&dll_bytes);
let mut pdb_bytes = None;
let mut conf_list = Vec::new();
let mut i = 7;
while i < args.len() {
match args[i].as_str() {
"--pdb" => {
i += 1;
if i < args.len() {
pdb_bytes = Some(fs::read(&args[i])?);
}
}
"--conf" => {
i += 1;
if i < args.len() {
for item in args[i].split(',') {
if !item.is_empty() {
let p = Path::new(item);
let file_name = p.file_name().unwrap().to_string_lossy().into_owned();
let bytes = fs::read(p)?;
conf_list.push((file_name, bytes));
}
}
}
}
_ => {}
}
i += 1;
}
let conf_names: Vec<String> = conf_list.iter().map(|(n, _)| n.clone()).collect();
let dist_refs: Vec<(String, &[u8])> = conf_list.iter().map(|(n, b)| (n.clone(), b.as_slice())).collect();
let meta = PluginMetadata {
id: id.clone(),
name: name.clone(),
version: version.clone(),
description: BTreeMap::new(),
sha256: digest,
required: true,
deps: vec![],
conf_files: conf_names,
enable_key: None,
status: Some("release".into()),
icon: None,
};
plugins::update(server, meta, &dll_bytes, pdb_bytes.as_deref(), &dist_refs)?;
println!("Updated plugin '{}' to version {} successfully", id, version);
}
"enable" => {
if args.len() < 4 {
eprintln!("Usage: enable <server> <id>");
std::process::exit(1);
}
let id = &args[3];
plugins::set_enabled(server, id, true)?;
println!("Enabled plugin '{}' successfully", id);
}
"disable" => {
if args.len() < 4 {
eprintln!("Usage: disable <server> <id>");
std::process::exit(1);
}
let id = &args[3];
plugins::set_enabled(server, id, false)?;
println!("Disabled plugin '{}' successfully", id);
}
"remove" => {
if args.len() < 4 {
eprintln!("Usage: remove <server> <id>");
std::process::exit(1);
}
let id = &args[3];
plugins::remove(server, id)?;
println!("Removed plugin '{}' successfully", id);
}
"repair" => {
let restored = plugins::repair(server)?;
println!("Repair complete. Restored {} plugin(s): {:?}", restored.len(), restored);
}
"recover" => {
plugins::ensure_durable_recovered(server)?;
println!("Durable transaction recovery complete (clean state restored).");
}
"prune" => {
let pruned = plugins::prune_store(server)?;
println!("Pruned {} unused store version(s): {:?}", pruned.len(), pruned);
}
"reconcile_squid" => {
let char_schema = if args.len() >= 4 { &args[3] } else { "acore_characters" };
let port_str = std::env::var("MYSQL_PORT").unwrap_or_else(|_| "3417".into());
let user = std::env::var("MYSQL_USER").unwrap_or_else(|_| "root".into());
let pass = std::env::var("MYSQL_PWD").unwrap_or_default();
let mysql_exe = std::env::var("MYSQL_EXE").unwrap_or_else(|_| "mysql".into());
let query_fn = |sql: &str| -> Result<String, coa_core::error::Error> {
let mut cmd = std::process::Command::new(&mysql_exe);
cmd.args(["-h", "127.0.0.1", "-P", &port_str, "-u", &user, "-e", sql]);
if !pass.is_empty() && pass != "trap" {
cmd.env("MYSQL_PWD", &pass);
} else {
cmd.env_remove("MYSQL_PWD");
}
let out = cmd.output().map_err(coa_core::error::Error::Io)?;
if !out.status.success() {
return Err(coa_core::error::Error::Invalid(String::from_utf8_lossy(&out.stderr).into_owned()));
}
Ok(String::from_utf8_lossy(&out.stdout).into_owned())
};
let audit = plugins::reconcile_squid_migrations(server, char_schema, Some(&query_fn))?;
println!("SQUID Reconciliation: status={:?}, applied={}", audit.db_status, audit.effective_applied);
}
"list" => {
let reg = plugins::load_registry(server)?;
println!("Plugins schema {}:", reg.schema);
for (id, p) in reg.plugins {
println!(
" - {}: enabled={}, version={}, sha256={}",
id, p.enabled, p.version, p.sha256
);
}
}
"multiworld" => {
if args.len() < 4 {
eprintln!("Usage: multiworld <server> <second_root> [--allow <a,b>]");
std::process::exit(1);
}
let second_root = Path::new(&args[3]);
let mut allowlist = None;
if args.len() >= 6 && args[4] == "--allow" {
allowlist = Some(args[5].split(',').filter(|s| !s.is_empty()).map(str::to_string).collect::<Vec<_>>());
}
plugins::prepare_multiworld_realm(server, second_root, allowlist.as_deref())?;
println!("Prepared multiworld realm at {} successfully", second_root.display());
}
"analyze" => {
let repo_path = Path::new(&args[2]);
let as_json = args.iter().any(|a| a == "--json");
let contract = if args.iter().any(|a| a == "--sdk-v02") {
coa_core::analyzer::SdkExportContract::v02()
} else {
coa_core::analyzer::SdkExportContract::v03()
};
let report = coa_core::analyzer::analyze_repository_with_contract(repo_path, &contract)?;
if as_json {
println!("{}", serde_json::to_string_pretty(&report)?);
} else {
println!("=== Module Compatibility Report v0.2 ===");
println!("Repository: {}", report.repository_name);
println!("Commit : {}", report.commit);
println!("License : {}", report.license_info.primary_license);
if let Some(ref lf) = report.license_info.license_file {
println!("License File: {}", lf);
}
if !report.license_info.vendored_licenses.is_empty() {
println!("Vendored Licenses: {:?}", report.license_info.vendored_licenses);
}
println!("Verdict : {:?}", report.classification);
println!("Status L0-L6: static={}, compile={}, link={}, contract={}, boot={}, gameplay={}, teardown={}",
report.verification_status.l0_static,
report.verification_status.l1_compile,
report.verification_status.l2_link,
report.verification_status.l3_contract,
report.verification_status.l4_engine_boot,
report.verification_status.l5_gameplay,
report.verification_status.l6_teardown);
println!("Hooks ({}):", report.hooks.len());
for h in &report.hooks {
println!(" - {} : {} ({}:{})", h.class_name, h.script_type, h.file, h.line);
}
println!("SQL Files ({}):", report.sql_files.len());
for s in &report.sql_files {
println!(" - {} [schema: {}] (create={}, alter={}, lines={})", s.file, s.target_schema, s.has_create_table, s.has_alter_table, s.line_count);
}
println!("Findings ({}):", report.findings.len());
for f in &report.findings {
println!(" [{:?}] {} (at {}:{}): {}", f.severity, f.rule_id, f.file, f.line, f.explanation);
println!(" Guidance: {}", f.recommended_action);
}
println!("Summary Reasons: {:?}", report.reasons);
}
}
"analyze-github" => {
let url = &args[2];
let mut cache_dir = None;
let mut json_out = false;
let mut i = 3;
while i < args.len() {
match args[i].as_str() {
"--cache-dir" => {
i += 1;
if i < args.len() {
cache_dir = Some(std::path::PathBuf::from(&args[i]));
}
}
"--json" => {
json_out = true;
}
_ => {}
}
i += 1;
}
match coa_core::analyzer::analyze_github_repository(url, cache_dir.as_deref()) {
Ok(report) => {
if json_out {
println!("{}", serde_json::to_string_pretty(&report)?);
} else {
println!("Repository: {}", report.repository_name);
println!("Classification: {:?}", report.classification);
println!("License: {}", report.license_info.primary_license);
println!("Cache Hit: {:?}", report.cache_hit);
println!("Tree Digest: {:?}", report.tree_digest);
println!("Commit: {:?}", report.commit);
println!("Loaders: {:?}", report.script_loaders);
println!("Hooks: {}", report.hooks.len());
println!("SQL Files: {}", report.sql_files.len());
println!("Findings: {}", report.findings.len());
}
}
Err(e) => {
eprintln!("ERROR: {}", e);
std::process::exit(1);
}
}
}
"generate-adapter" => {
let repo_path = Path::new(&args[2]);
let res = coa_core::analyzer::generate_adapter(repo_path)?;
match res {
coa_core::analyzer::AdapterGenerationResult::Success { canonical_loader, adapter_source, delegated_count } => {
println!("Canonical Master Loader: {} (delegates to {} scripts)", canonical_loader, delegated_count);
if let Some(pos) = args.iter().position(|a| a == "--output") {
if pos + 1 < args.len() {
let out_path = Path::new(&args[pos + 1]);
if let Some(p) = out_path.parent() {
std::fs::create_dir_all(p)?;
}
std::fs::write(out_path, &adapter_source)?;
println!("Adapter successfully written to: {}", out_path.display());
}
} else {
println!("--- Generated Adapter Source ---");
println!("{}", adapter_source);
}
}
coa_core::analyzer::AdapterGenerationResult::ManualAdapterRequired { reason, candidate_loaders } => {
eprintln!("MANUAL_ADAPTER_REQUIRED: {}", reason);
eprintln!("Candidate Loaders: {:?}", candidate_loaders);
std::process::exit(1);
}
coa_core::analyzer::AdapterGenerationResult::NoLoaderFound => {
eprintln!("NO_LOADER_FOUND: Unable to discover any Add*Scripts() functions.");
std::process::exit(1);
}
}
}
"verify-artifact-provenance" => {
let exe_path = Path::new(&args[2]);
let mut sdk_json = None;
let mut json_out = false;
let mut i = 3;
while i < args.len() {
match args[i].as_str() {
"--sdk-json" => {
i += 1;
if i < args.len() {
sdk_json = Some(Path::new(&args[i]));
}
}
"--json" => {
json_out = true;
}
_ => {}
}
i += 1;
}
match coa_core::provenance::verify_worldserver_provenance(exe_path, sdk_json) {
Ok(rec) => {
if json_out {
println!("{}", serde_json::to_string_pretty(&rec)?);
} else {
println!("Artifact: {}", rec.file_path);
println!("SHA-256: {}", rec.file_sha256);
println!("Arch: {}", rec.machine_architecture);
println!("Exports: {}", rec.total_export_count);
println!("Embedded ABI: {:?}", rec.embedded_abi_fingerprint);
println!("Status: {}", rec.provenance_status);
}
}
Err(e) => {
eprintln!("ERROR: {}", e);
std::process::exit(1);
}
}
}
_ => {
eprintln!("Unknown command: {}", cmd);
print_usage();
std::process::exit(1);
}
}
Ok(())
}
+16 -48
View File
@@ -1,7 +1,7 @@
//! Signed channel pointers select one immutable package for an entire transaction.
use crate::pkgsource::{fetch_small, Source};
use crate::{Error, Result};
use serde::{Deserialize, Serialize};
use crate::{Error, Result};
use crate::pkgsource::{fetch_small, Source};
#[derive(Debug, Serialize, Deserialize)]
#[serde(rename_all = "camelCase", deny_unknown_fields)]
@@ -21,22 +21,15 @@ pub struct Envelope {
}
pub fn verify(bytes: &[u8], channel: &str, key: &str) -> Result<Pointer> {
let envelope: Envelope =
serde_json::from_slice(bytes).map_err(|e| Error::InvalidManifest(e.to_string()))?;
let envelope: Envelope = serde_json::from_slice(bytes).map_err(|e| Error::InvalidManifest(e.to_string()))?;
crate::signing::verify(envelope.payload.as_bytes(), &envelope.signature, key)?;
let pointer: Pointer = serde_json::from_str(&envelope.payload)
.map_err(|e| Error::InvalidManifest(e.to_string()))?;
if pointer.schema != 1
|| pointer.channel != channel
let pointer: Pointer = serde_json::from_str(&envelope.payload).map_err(|e| Error::InvalidManifest(e.to_string()))?;
if pointer.schema != 1 || pointer.channel != channel
|| pointer.release_tag != format!("server-{}", pointer.version)
|| pointer.version.is_empty()
|| !pointer
.version
.bytes()
.all(|b| b.is_ascii_digit() || b == b'.')
|| !pointer.version.bytes().all(|b| b.is_ascii_digit() || b == b'.')
|| pointer.snapshot.len() != 64
|| !pointer.snapshot.bytes().all(|b| b.is_ascii_hexdigit())
{
|| !pointer.snapshot.bytes().all(|b| b.is_ascii_hexdigit()) {
return Err(Error::InvalidManifest("Invalid channel pointer".into()));
}
Ok(pointer)
@@ -46,37 +39,21 @@ pub fn resolve(channel: &str) -> Result<Source> {
if channel != "stable" && channel != "edge" {
return Err(Error::InvalidManifest("Unknown release channel".into()));
}
let source =
Source::Url("https://raw.githubusercontent.com/Corfirean/coa-server-build/channels".into());
let source = Source::Url("https://raw.githubusercontent.com/Corfirean/coa-server-build/channels".into());
let bytes = fetch_small(&source, &format!("{channel}.json"))?;
let pointer = verify(&bytes, channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
Ok(Source::Url(format!(
"https://github.com/Corfirean/coa-server-build/releases/download/{}",
pointer.release_tag
)))
Ok(Source::Url(format!("https://github.com/Corfirean/coa-server-build/releases/download/{}", pointer.release_tag)))
}
pub fn sign(pointer: &Pointer, seed: &str) -> Result<Vec<u8>> {
use base64::{engine::general_purpose::STANDARD, Engine};
use ed25519_dalek::{Signer, SigningKey};
let seed: [u8; 32] = STANDARD
.decode(seed.trim())
.map_err(|_| Error::Invalid("Invalid signing key".into()))?
.try_into()
.map_err(|_| Error::Invalid("Invalid signing key length".into()))?;
let seed: [u8; 32] = STANDARD.decode(seed.trim()).map_err(|_| Error::Invalid("Invalid signing key".into()))?
.try_into().map_err(|_| Error::Invalid("Invalid signing key length".into()))?;
let payload = serde_json::to_string(pointer).map_err(|e| Error::Invalid(e.to_string()))?;
let signature = STANDARD.encode(
SigningKey::from_bytes(&seed)
.sign(payload.as_bytes())
.to_bytes(),
);
let bytes = serde_json::to_vec(&Envelope { payload, signature })
.map_err(|e| Error::Invalid(e.to_string()))?;
verify(
&bytes,
&pointer.channel,
crate::signing::EMBEDDED_PUBLIC_KEY,
)?;
let signature = STANDARD.encode(SigningKey::from_bytes(&seed).sign(payload.as_bytes()).to_bytes());
let bytes = serde_json::to_vec(&Envelope { payload, signature }).map_err(|e| Error::Invalid(e.to_string()))?;
verify(&bytes, &pointer.channel, crate::signing::EMBEDDED_PUBLIC_KEY)?;
Ok(bytes)
}
@@ -90,21 +67,12 @@ mod tests {
let sk = SigningKey::from_bytes(&[17; 32]);
let payload = serde_json::to_string(pointer).unwrap();
let signature = STANDARD.encode(sk.sign(payload.as_bytes()).to_bytes());
(
serde_json::to_vec(&Envelope { payload, signature }).unwrap(),
STANDARD.encode(sk.verifying_key().to_bytes()),
)
(serde_json::to_vec(&Envelope { payload, signature }).unwrap(), STANDARD.encode(sk.verifying_key().to_bytes()))
}
#[test]
fn verifies_identity_signature_and_immutable_tag() {
let mut p = Pointer {
schema: 1,
channel: "stable".into(),
version: "0.261010.40".into(),
release_tag: "server-0.261010.40".into(),
snapshot: "a".repeat(64),
};
let mut p = Pointer { schema: 1, channel: "stable".into(), version: "0.261010.40".into(), release_tag: "server-0.261010.40".into(), snapshot: "a".repeat(64) };
let (bytes, key) = signed(&p);
assert_eq!(verify(&bytes, "stable", &key).unwrap().version, p.version);
assert!(verify(&bytes, "edge", &key).is_err());
+14 -61
View File
@@ -417,21 +417,11 @@ pub fn launch(client: &Path) -> Result<u32> {
return crate::wine::launch(client, exe);
}
let executable = client.join(exe);
let spawn = || {
Command::new(&executable)
.current_dir(client)
.spawn()
.map(|child| child.id())
};
let spawn = || Command::new(&executable).current_dir(client).spawn().map(|child| child.id());
#[cfg(windows)]
{
launch_with_elevation_fallback(spawn, || launch_elevated(&executable, client))
.map_err(Into::into)
}
{ launch_with_elevation_fallback(spawn, || launch_elevated(&executable, client)).map_err(Into::into) }
#[cfg(not(windows))]
{
spawn().map_err(Into::into)
}
{ spawn().map_err(Into::into) }
}
/// Start normally first; ask Windows for elevation only when the client requires it (ERROR_ELEVATION_REQUIRED, 740).
@@ -453,15 +443,9 @@ fn launch_elevated(executable: &Path, directory: &Path) -> std::io::Result<u32>
use std::os::windows::ffi::OsStrExt;
use windows_sys::Win32::Foundation::CloseHandle;
use windows_sys::Win32::System::Threading::GetProcessId;
use windows_sys::Win32::UI::Shell::{
ShellExecuteExW, SEE_MASK_NOASYNC, SEE_MASK_NOCLOSEPROCESS, SHELLEXECUTEINFOW,
};
use windows_sys::Win32::UI::Shell::{ShellExecuteExW, SHELLEXECUTEINFOW, SEE_MASK_NOCLOSEPROCESS, SEE_MASK_NOASYNC};
use windows_sys::Win32::UI::WindowsAndMessaging::SW_SHOWNORMAL;
let file: Vec<u16> = executable
.as_os_str()
.encode_wide()
.chain(Some(0))
.collect();
let file: Vec<u16> = executable.as_os_str().encode_wide().chain(Some(0)).collect();
let cwd: Vec<u16> = directory.as_os_str().encode_wide().chain(Some(0)).collect();
let verb: Vec<u16> = "runas".encode_utf16().chain(Some(0)).collect();
let mut info = SHELLEXECUTEINFOW {
@@ -473,22 +457,12 @@ fn launch_elevated(executable: &Path, directory: &Path) -> std::io::Result<u32>
nShow: SW_SHOWNORMAL,
..Default::default()
};
if unsafe { ShellExecuteExW(&mut info) } == 0 {
return Err(std::io::Error::last_os_error());
}
if info.hProcess.is_null() {
return Err(std::io::Error::other(
"Windows did not return the game process handle.",
));
}
if unsafe { ShellExecuteExW(&mut info) } == 0 { return Err(std::io::Error::last_os_error()); }
if info.hProcess.is_null() { return Err(std::io::Error::other("Windows did not return the game process handle.")); }
let pid = unsafe { GetProcessId(info.hProcess) };
let error = std::io::Error::last_os_error();
unsafe {
CloseHandle(info.hProcess);
}
if pid == 0 {
return Err(error);
}
unsafe { CloseHandle(info.hProcess); }
if pid == 0 { return Err(error); }
Ok(pid)
}
@@ -611,29 +585,11 @@ mod tests {
#[cfg(windows)]
#[test]
fn elevation_is_requested_only_when_windows_requires_it() {
assert_eq!(
launch_with_elevation_fallback(|| Ok(17), || panic!("unneeded elevation")).unwrap(),
17
);
assert_eq!(
launch_with_elevation_fallback(
|| Err(std::io::Error::from_raw_os_error(740)),
|| Ok(23)
)
.unwrap(),
23
);
let error = launch_with_elevation_fallback(
|| Err(std::io::Error::from_raw_os_error(2)),
|| panic!("wrong error elevated"),
)
.unwrap_err();
assert_eq!(launch_with_elevation_fallback(|| Ok(17), || panic!("unneeded elevation")).unwrap(), 17);
assert_eq!(launch_with_elevation_fallback(|| Err(std::io::Error::from_raw_os_error(740)), || Ok(23)).unwrap(), 23);
let error = launch_with_elevation_fallback(|| Err(std::io::Error::from_raw_os_error(2)), || panic!("wrong error elevated")).unwrap_err();
assert_eq!(error.raw_os_error(), Some(2));
let cancelled = launch_with_elevation_fallback(
|| Err(std::io::Error::from_raw_os_error(740)),
|| Err(std::io::Error::from_raw_os_error(1223)),
)
.unwrap_err();
let cancelled = launch_with_elevation_fallback(|| Err(std::io::Error::from_raw_os_error(740)), || Err(std::io::Error::from_raw_os_error(1223))).unwrap_err();
assert_eq!(cancelled.raw_os_error(), Some(1223));
}
@@ -664,10 +620,7 @@ mod tests {
assert!(sync_realm(&c, &meta, crate::realms::Mode::Wildcard).unwrap());
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), original);
assert!(sync_realm(&c, &meta, crate::realms::Mode::Reborn).unwrap());
assert_eq!(
fs::read(c.join("WTF/Config.wtf")).unwrap(),
b"SET sound 1\r\nSET realmName \"Warcraft Reborn\"\r\n"
);
assert_eq!(fs::read(c.join("WTF/Config.wtf")).unwrap(), b"SET sound 1\r\nSET realmName \"Warcraft Reborn\"\r\n");
}
#[test]
+921
View File
@@ -0,0 +1,921 @@
//! Download and update of the game client from the community launcher's public manifest.
//!
//! The manifest lists every file with its size and SHA-256; each file is fetched by hash and verified before it is
//! moved into place (`download::fetch_with`, resumable). The Manager keeps a small state file inside the client
//! folder (`.coa-manager/client-state.json`) so that later checks are cheap and so that files the player changed
//! are recognised: they are never overwritten without being asked, and a replaced file is moved aside, not deleted.
//! WTF, Cache, other addons, logs and `realmlist.wtf` are not part of what the Manager synchronises.
use std::collections::{BTreeMap, HashMap};
use std::fs::{self, File};
use std::io::Read;
use std::path::{Path, PathBuf};
use std::time::{Instant, UNIX_EPOCH};
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use crate::download::{self, Cancel, HttpTransport, Job, Transport};
use crate::error::{Error, Result};
use crate::fsx;
pub const MANIFEST_URL: &str =
"https://launcher-api.coa-development.org/downloads/client/latest.json";
pub const OBJECTS_URL: &str = "https://launcher-api.coa-development.org/downloads/client/objects";
const STATE_DIR: &str = ".coa-manager";
const MAX_MANIFEST_BYTES: u64 = 16 * 1024 * 1024;
const MAX_FILE_BYTES: u64 = 16 * 1024 * 1024 * 1024;
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ManifestFile {
pub path: String,
pub size: u64,
pub sha256: String,
}
#[derive(Debug, Clone, Serialize)]
pub struct Manifest {
pub version: String,
pub published_at: Option<String>,
pub files: Vec<ManifestFile>,
}
impl Manifest {
pub fn total_bytes(&self) -> u64 {
self.files.iter().map(|f| f.size).sum()
}
}
#[derive(Deserialize)]
struct RawManifest {
schema: u32,
version: String,
#[serde(rename = "publishedAt")]
published_at: Option<String>,
files: Vec<ManifestFile>,
}
/// Things the Manager never writes, even if a manifest lists them: logs, the realmlist, the player's own settings,
/// caches and the companion addon (those have their own safe paths).
fn is_excluded(path: &str) -> bool {
let p = path.replace('\\', "/").to_ascii_lowercase();
p.ends_with(".log")
|| p.rsplit('/').next() == Some("realmlist.wtf")
|| p.starts_with("wtf/")
|| p.starts_with("cache/")
|| p.starts_with("errors/")
|| p.starts_with("logs/")
|| p.starts_with(".coa-manager/")
|| p.starts_with("interface/addons/coabotui/")
}
/// Files players customise: graphics wrappers and their configuration. If one exists and differs from the published
/// file it is left exactly as it is, whatever the "keep my files" choice; it is only created when missing.
fn is_player_owned(path: &str) -> bool {
let name = path.rsplit('/').next().unwrap_or(path).to_ascii_lowercase();
matches!(
name.as_str(),
"d3d8.dll" | "d3d9.dll" | "d3d10core.dll" | "d3d11.dll" | "dxgi.dll" | "dxvk.conf"
) || matches!(
name.rsplit('.').next(),
Some("ini" | "conf" | "cfg" | "wtf")
)
}
pub fn parse_manifest(text: &str) -> Result<Manifest> {
let raw: RawManifest = serde_json::from_str(text)
.map_err(|e| Error::Invalid(format!("The client list could not be read: {e}")))?;
if raw.schema != 1 {
return Err(Error::Invalid(format!(
"The client list uses a newer format ({}); update the Manager.",
raw.schema
)));
}
if raw.version.trim().is_empty() || raw.version.len() > 64 {
return Err(Error::Invalid("The client list has no version.".into()));
}
let root = Path::new("client-root");
let mut files = Vec::with_capacity(raw.files.len());
for f in raw.files {
fsx::safe_join(root, &f.path)?;
let hash_ok = f.sha256.len() == 64 && f.sha256.bytes().all(|b| b.is_ascii_hexdigit());
if !hash_ok || f.size > MAX_FILE_BYTES {
return Err(Error::Invalid(format!(
"The client list has a bad entry for {}.",
f.path
)));
}
if is_excluded(&f.path) {
continue;
}
files.push(ManifestFile {
path: f.path.replace('\\', "/"),
size: f.size,
sha256: f.sha256.to_ascii_lowercase(),
});
}
if files.is_empty() {
return Err(Error::Invalid("The client list is empty.".into()));
}
Ok(Manifest {
version: raw.version,
published_at: raw.published_at,
files,
})
}
pub fn fetch_manifest(transport: &dyn Transport, url: &str) -> Result<Manifest> {
let mut reply = transport
.get(url, 0)
.map_err(|e| Error::Invalid(format!("Could not reach the client download server: {e}")))?;
if reply.status != 200 {
return Err(Error::Invalid(format!(
"The client download server answered {}.",
reply.status
)));
}
let mut text = String::new();
reply
.body
.by_ref()
.take(MAX_MANIFEST_BYTES)
.read_to_string(&mut text)
.map_err(|e| Error::Invalid(format!("Could not read the client list: {e}")))?;
parse_manifest(&text)
}
pub fn fetch_latest() -> Result<Manifest> {
download::check_url(MANIFEST_URL)?;
fetch_manifest(&HttpTransport::with_total_timeout(30)?, MANIFEST_URL)
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Entry {
pub size: u64,
pub mtime: u64,
pub sha256: String,
/// The player chose to keep this file although the manifest has a different one (this is the manifest hash
/// they were asked about; a newer manifest asks again).
#[serde(default)]
pub kept_against: Option<String>,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct State {
/// The manifest version this folder was brought to; None while a download is unfinished.
pub version: Option<String>,
pub files: BTreeMap<String, Entry>,
}
fn state_path(client: &Path) -> PathBuf {
client.join(STATE_DIR).join("client-state.json")
}
pub fn load_state(client: &Path) -> Option<State> {
fsx::read_json(&state_path(client)).ok()
}
fn save_state(client: &Path, state: &State) -> Result<()> {
fsx::atomic_write_json(&state_path(client), state)
}
#[derive(Debug, Clone, Serialize)]
pub struct Local {
/// The Manager downloaded or adopted this folder (a state file exists).
pub managed: bool,
pub version: Option<String>,
}
pub fn local(client: &Path) -> Local {
let s = load_state(client);
Local {
managed: s.is_some(),
version: s.and_then(|s| s.version),
}
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize)]
#[serde(rename_all = "snake_case")]
pub enum Kind {
/// Not in the folder.
Missing,
/// Still as the Manager left it; the manifest has a newer file.
Changed,
/// Different from the manifest and not as the Manager left it (changed by the player or by something else).
Modified,
}
#[derive(Debug, Clone, Serialize)]
pub struct Item {
pub path: String,
pub size: u64,
pub kind: Kind,
#[serde(skip)]
sha256: String,
}
#[derive(Debug, Clone, Serialize)]
pub struct Plan {
pub version: String,
pub items: Vec<Item>,
pub download_bytes: u64,
pub total_files: usize,
pub up_to_date_files: usize,
pub kept_files: usize,
#[serde(skip)]
confirmed: BTreeMap<String, Entry>,
}
impl Plan {
pub fn modified(&self) -> Vec<&Item> {
self.items
.iter()
.filter(|i| i.kind == Kind::Modified)
.collect()
}
}
#[derive(Debug, Clone, Serialize)]
pub struct Step {
/// "scan" while comparing files, "download" while fetching, "finish" at the end.
pub phase: &'static str,
pub done: u64,
pub total: u64,
pub bytes_per_sec: u64,
pub file: Option<String>,
}
fn cancelled() -> Error {
Error::Invalid("Download cancelled.".into())
}
fn mtime_secs(m: &fs::Metadata) -> u64 {
m.modified()
.ok()
.and_then(|t| t.duration_since(UNIX_EPOCH).ok())
.map(|d| d.as_secs())
.unwrap_or(0)
}
fn hash_file(path: &Path, cancel: &Cancel, on_bytes: &mut dyn FnMut(u64)) -> Result<String> {
let mut f = File::open(path)?;
let mut hasher = Sha256::new();
let mut buf = vec![0u8; 1 << 20];
loop {
if cancel.is_set() {
return Err(cancelled());
}
let n = f.read(&mut buf)?;
if n == 0 {
return Ok(hex::encode(hasher.finalize()));
}
hasher.update(&buf[..n]);
on_bytes(n as u64);
}
}
/// Compare the folder with the manifest. Files are hashed only when their size or modification time no longer
/// matches what the state file recorded, so a routine check of a managed folder is quick.
pub fn plan(
client: &Path,
m: &Manifest,
state: &State,
cancel: &Cancel,
on_step: &dyn Fn(Step),
) -> Result<Plan> {
let total = m.total_bytes();
let mut done = 0u64;
let mut items = Vec::new();
let mut confirmed = BTreeMap::new();
let (mut up_to_date, mut kept) = (0usize, 0usize);
for f in &m.files {
if cancel.is_set() {
return Err(cancelled());
}
on_step(Step {
phase: "scan",
done,
total,
bytes_per_sec: 0,
file: Some(f.path.clone()),
});
let path = fsx::safe_join(client, &f.path)?;
let meta = match fs::metadata(&path) {
Ok(meta) if meta.is_file() => meta,
_ => {
items.push(Item {
path: f.path.clone(),
size: f.size,
kind: Kind::Missing,
sha256: f.sha256.clone(),
});
done += f.size;
continue;
}
};
let (size, mtime) = (meta.len(), mtime_secs(&meta));
let entry = state.files.get(&f.path);
let trusted = entry.filter(|e| e.size == size && e.mtime == mtime);
let local: Option<String> = if let Some(e) = trusted {
Some(e.sha256.clone())
} else if size == f.size || entry.map(|e| e.size == size).unwrap_or(false) {
let base = done;
let mut seen = 0u64;
let h = hash_file(&path, cancel, &mut |n| {
seen += n;
on_step(Step {
phase: "scan",
done: base + seen.min(f.size),
total,
bytes_per_sec: 0,
file: Some(f.path.clone()),
});
})?;
Some(h)
} else {
None
};
done += f.size;
if is_player_owned(&f.path) && local.as_deref() != Some(f.sha256.as_str()) {
let sha = match local {
Some(h) => h,
None => hash_file(&path, cancel, &mut |_| {})?,
};
kept += 1;
confirmed.insert(
f.path.clone(),
Entry {
size,
mtime,
sha256: sha,
kept_against: Some(f.sha256.clone()),
},
);
continue;
}
if local.as_deref() == Some(f.sha256.as_str()) {
up_to_date += 1;
confirmed.insert(
f.path.clone(),
Entry {
size,
mtime,
sha256: f.sha256.clone(),
kept_against: None,
},
);
continue;
}
let as_left = entry.filter(|e| local.as_deref() == Some(e.sha256.as_str()));
match as_left {
Some(e) if e.kept_against.as_deref() == Some(f.sha256.as_str()) => {
kept += 1;
confirmed.insert(
f.path.clone(),
Entry {
size,
mtime,
sha256: e.sha256.clone(),
kept_against: e.kept_against.clone(),
},
);
}
Some(e) if e.kept_against.is_none() => {
items.push(Item {
path: f.path.clone(),
size: f.size,
kind: Kind::Changed,
sha256: f.sha256.clone(),
});
}
_ => items.push(Item {
path: f.path.clone(),
size: f.size,
kind: Kind::Modified,
sha256: f.sha256.clone(),
}),
}
}
on_step(Step {
phase: "scan",
done: total,
total,
bytes_per_sec: 0,
file: None,
});
let download_bytes = items.iter().map(|i| i.size).sum();
Ok(Plan {
version: m.version.clone(),
items,
download_bytes,
total_files: m.files.len(),
up_to_date_files: up_to_date,
kept_files: kept,
confirmed,
})
}
pub struct Apply<'a> {
pub client: &'a Path,
pub manifest: &'a Manifest,
pub plan: &'a Plan,
/// Leave files the player changed alone (they are remembered, and asked about again only when the manifest changes).
pub keep_modified: bool,
pub transport: &'a dyn Transport,
pub objects_url: &'a str,
pub cancel: &'a Cancel,
}
fn blocked(path: &str, e: std::io::Error) -> Error {
Error::Invalid(format!("Could not replace {path}: {e}. Close the game and anything else using the client, then try again."))
}
/// Download what the plan lists. Progress is saved after every file, so an interrupted run resumes where it stopped.
pub fn apply(a: &Apply, on_step: &dyn Fn(Step)) -> Result<()> {
let mut state = State {
version: None,
files: a.plan.confirmed.clone(),
};
save_state(a.client, &state)?;
let mut todo = Vec::new();
for item in &a.plan.items {
if item.kind == Kind::Modified && a.keep_modified {
let path = fsx::safe_join(a.client, &item.path)?;
let meta = fs::metadata(&path)?;
let sha = hash_file(&path, a.cancel, &mut |_| {})?;
state.files.insert(
item.path.clone(),
Entry {
size: meta.len(),
mtime: mtime_secs(&meta),
sha256: sha,
kept_against: Some(item.sha256.clone()),
},
);
} else {
todo.push(item);
}
}
let total: u64 = todo.iter().map(|i| i.size).sum();
fsx::require_space(a.client, total)?;
let staging = a.client.join(STATE_DIR).join("staging");
let replaced = a
.client
.join(STATE_DIR)
.join("replaced")
.join(chrono::Utc::now().format("%Y%m%d-%H%M%S").to_string());
let mut done = 0u64;
let mut placed: HashMap<&str, PathBuf> = HashMap::new();
for item in todo {
if a.cancel.is_set() {
save_state(a.client, &state)?;
return Err(cancelled());
}
let target = fsx::safe_join(a.client, &item.path)?;
let started = Instant::now();
let staged = staging.join(&item.sha256);
let copy_from = placed.get(item.sha256.as_str()).cloned();
if copy_from.is_none() {
let job = Job {
url: format!("{}/{}", a.objects_url, item.sha256),
dest: staged.clone(),
sha256: item.sha256.clone(),
size: item.size,
};
let base = done;
let result = download::fetch_with(a.transport, &job, a.cancel, &|p| {
on_step(Step {
phase: "download",
done: base + p.downloaded,
total,
bytes_per_sec: p.bytes_per_sec,
file: Some(item.path.clone()),
});
});
if let Err(e) = result {
let _ = save_state(a.client, &state);
return Err(e);
}
}
if let Some(parent) = target.parent() {
fs::create_dir_all(parent)?;
}
if target.exists() {
if item.kind == Kind::Modified {
let keep = fsx::safe_join(&replaced, &item.path)?;
if let Some(parent) = keep.parent() {
fs::create_dir_all(parent)?;
}
fs::rename(&target, &keep).map_err(|e| blocked(&item.path, e))?;
} else {
fs::remove_file(&target).map_err(|e| blocked(&item.path, e))?;
}
}
match copy_from {
Some(src) => {
fs::copy(&src, &target).map_err(|e| blocked(&item.path, e))?;
}
None => fs::rename(&staged, &target).map_err(|e| blocked(&item.path, e))?,
}
placed.insert(&item.sha256, target.clone());
let meta = fs::metadata(&target)?;
state.files.insert(
item.path.clone(),
Entry {
size: meta.len(),
mtime: mtime_secs(&meta),
sha256: item.sha256.clone(),
kept_against: None,
},
);
save_state(a.client, &state)?;
done += item.size;
let secs = started.elapsed().as_secs_f64().max(0.001);
on_step(Step {
phase: "download",
done,
total,
bytes_per_sec: (item.size as f64 / secs) as u64,
file: Some(item.path.clone()),
});
}
state.version = Some(a.manifest.version.clone());
save_state(a.client, &state)?;
let _ = fs::remove_dir_all(&staging);
on_step(Step {
phase: "finish",
done: total,
total,
bytes_per_sec: 0,
file: None,
});
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::download::Reply;
use std::io::Cursor;
use std::sync::atomic::{AtomicUsize, Ordering};
use std::sync::Mutex;
/// Serves objects by hash; remembers what was requested and can fail after N objects.
struct Server {
objects: Mutex<HashMap<String, Vec<u8>>>,
requested: Mutex<Vec<String>>,
cancel_after: Option<(AtomicUsize, Cancel)>,
}
impl Server {
fn new(files: &[(&str, &[u8])]) -> Self {
let s = Server {
objects: Default::default(),
requested: Default::default(),
cancel_after: None,
};
for (_, body) in files {
s.objects
.lock()
.unwrap()
.insert(fsx::sha256_bytes(body), body.to_vec());
}
s
}
}
impl Transport for Server {
fn get(&self, url: &str, from: u64) -> std::result::Result<Reply, String> {
let sha = url.rsplit('/').next().unwrap().to_string();
self.requested.lock().unwrap().push(sha.clone());
if let Some((left, cancel)) = &self.cancel_after {
if left.fetch_sub(1, Ordering::SeqCst) == 1 {
cancel.cancel();
}
}
let body = self
.objects
.lock()
.unwrap()
.get(&sha)
.cloned()
.ok_or("404")?;
let (status, start) = if from > 0 {
(206, from as usize)
} else {
(200, 0)
};
let cr = (from > 0).then(|| format!("bytes {from}-{}/{}", body.len() - 1, body.len()));
Ok(Reply {
status,
content_range: cr,
body: Box::new(Cursor::new(body[start..].to_vec())),
})
}
}
fn manifest(version: &str, files: &[(&str, &[u8])]) -> Manifest {
Manifest {
version: version.into(),
published_at: None,
files: files
.iter()
.map(|(p, b)| ManifestFile {
path: p.to_string(),
size: b.len() as u64,
sha256: fsx::sha256_bytes(b),
})
.collect(),
}
}
const V1: [(&str, &[u8]); 4] = [
("Wow.exe", b"exe-1"),
("Data/common.MPQ", b"common-mpq-data"),
("Data/patch-A.MPQ", b"patch-a-1"),
("Data/enUS/locale.MPQ", b"locale"),
];
fn sync(dir: &Path, m: &Manifest, server: &Server, keep: bool) -> Result<Plan> {
let state = load_state(dir).unwrap_or_default();
let cancel = Cancel::default();
let p = plan(dir, m, &state, &cancel, &|_| {})?;
apply(
&Apply {
client: dir,
manifest: m,
plan: &p,
keep_modified: keep,
transport: server,
objects_url: "https://x.invalid/objects",
cancel: &cancel,
},
&|_| {},
)?;
Ok(p)
}
#[test]
fn manifest_rejects_traversal_and_bad_entries_and_skips_personal_files() {
let ok = r#"{"schema":1,"version":"v1","files":[
{"path":"Wow.exe","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"Data/enUS/realmlist.wtf","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"WTF/Config.wtf","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"Interface/AddOns/CoABotUI/x.lua","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"},
{"path":"MemoryBridge.log","size":3,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]}"#;
let m = parse_manifest(ok).unwrap();
assert_eq!(
m.files.iter().map(|f| f.path.as_str()).collect::<Vec<_>>(),
["Wow.exe"]
);
for bad in [
r#"{"schema":1,"version":"v","files":[{"path":"../evil.dll","size":1,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]}"#,
r#"{"schema":1,"version":"v","files":[{"path":"C:/evil.dll","size":1,"sha256":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}]}"#,
r#"{"schema":1,"version":"v","files":[{"path":"a.dll","size":1,"sha256":"short"}]}"#,
r#"{"schema":2,"version":"v","files":[]}"#,
r#"{"schema":1,"version":"v","files":[]}"#,
] {
assert!(parse_manifest(bad).is_err(), "{bad}");
}
}
#[test]
fn fresh_download_installs_every_file_verified_and_leaves_nothing_behind() {
let d = tempfile::tempdir().unwrap();
let (m, s) = (manifest("v1", &V1), Server::new(&V1));
let p = sync(d.path(), &m, &s, false).unwrap();
assert_eq!(p.items.len(), 4);
for (path, body) in V1 {
assert_eq!(fs::read(d.path().join(path)).unwrap(), body);
}
let st = load_state(d.path()).unwrap();
assert_eq!(st.version.as_deref(), Some("v1"));
assert_eq!(st.files.len(), 4);
assert!(!d.path().join(".coa-manager/staging").exists());
assert!(local(d.path()).managed);
}
#[test]
fn an_update_downloads_only_what_changed_and_a_second_check_is_empty() {
let d = tempfile::tempdir().unwrap();
sync(d.path(), &manifest("v1", &V1), &Server::new(&V1), false).unwrap();
let mut v2 = V1.to_vec();
v2[2] = ("Data/patch-A.MPQ", b"patch-a-2-longer");
v2.push(("Data/new.MPQ", b"brand new"));
let (m2, s2) = (manifest("v2", &v2), Server::new(&v2));
let p = sync(d.path(), &m2, &s2, false).unwrap();
let kinds: Vec<_> = p.items.iter().map(|i| (i.path.as_str(), i.kind)).collect();
assert_eq!(
kinds,
[
("Data/patch-A.MPQ", Kind::Changed),
("Data/new.MPQ", Kind::Missing)
]
);
assert_eq!(
s2.requested.lock().unwrap().len(),
2,
"unchanged files were not downloaded again"
);
assert_eq!(
fs::read(d.path().join("Data/patch-A.MPQ")).unwrap(),
b"patch-a-2-longer"
);
assert!(
!d.path().join(".coa-manager/replaced").exists(),
"a file the Manager itself wrote needs no backup"
);
let again = sync(d.path(), &m2, &s2, false).unwrap();
assert!(again.items.is_empty() && again.up_to_date_files == 5);
assert_eq!(load_state(d.path()).unwrap().version.as_deref(), Some("v2"));
}
#[test]
fn a_file_the_player_changed_is_asked_about_kept_when_told_to_and_saved_when_replaced() {
let d = tempfile::tempdir().unwrap();
sync(d.path(), &manifest("v1", &V1), &Server::new(&V1), false).unwrap();
fs::write(d.path().join("Wow.exe"), b"my patched exe").unwrap();
let mut v2 = V1.to_vec();
v2[0] = ("Wow.exe", b"exe-2");
let (m2, s2) = (manifest("v2", &v2), Server::new(&v2));
let p = sync(d.path(), &m2, &s2, true).unwrap();
assert_eq!(p.modified().len(), 1);
assert_eq!(
fs::read(d.path().join("Wow.exe")).unwrap(),
b"my patched exe",
"kept"
);
assert!(
s2.requested.lock().unwrap().is_empty(),
"nothing needed downloading"
);
let quiet = sync(d.path(), &m2, &s2, true).unwrap();
assert!(
quiet.items.is_empty() && quiet.kept_files == 1,
"the decision is remembered"
);
let mut v3 = V1.to_vec();
v3[0] = ("Wow.exe", b"exe-3");
let (m3, s3) = (manifest("v3", &v3), Server::new(&v3));
let again = sync(d.path(), &m3, &s3, false).unwrap();
assert_eq!(again.modified().len(), 1, "a newer client asks again");
assert_eq!(fs::read(d.path().join("Wow.exe")).unwrap(), b"exe-3");
let saved = fs::read_dir(d.path().join(".coa-manager/replaced"))
.unwrap()
.next()
.unwrap()
.unwrap()
.path();
assert_eq!(
fs::read(saved.join("Wow.exe")).unwrap(),
b"my patched exe",
"the player's version was moved aside, not lost"
);
}
#[test]
fn renderer_files_configs_and_everything_not_in_the_manifest_survive_an_update_untouched() {
let d = tempfile::tempdir().unwrap();
let v1: Vec<(&str, &[u8])> = vec![
("Wow.exe", b"exe-1"),
("d3d9.dll", b"official d3d9"),
("dxvk.conf", b"official conf"),
("Data/common.MPQ", b"common-1"),
];
sync(d.path(), &manifest("v1", &v1), &Server::new(&v1), false).unwrap();
// the player's own setup: custom renderer + configs, addons, WTF, realmlist, extra archives, backups
let mine: Vec<(&str, &[u8])> = vec![
("d3d9.dll", b"my renderer"),
("dxvk.conf", b"my conf"),
("ModernWoWRenderer.ini", b"cfg"),
("GraphicsEffects.ini.bak", b"bak"),
(
"Data/enUS/realmlist.wtf",
b"set realmlist 127.0.0.1
",
),
("Data/patch-5.MPQ", b"extra archive"),
("Interface/AddOns/ElvUI/ElvUI.toc", b"## Title: Elv"),
("WTF/Account/x/SavedVariables.lua", b"vars"),
("Cache/x.wdb", b"cache"),
];
for (p, b) in &mine {
let path = d.path().join(p);
fs::create_dir_all(path.parent().unwrap()).unwrap();
fs::write(path, b).unwrap();
}
let before: BTreeMap<String, String> = mine
.iter()
.map(|(p, b)| (p.to_string(), fsx::sha256_bytes(b)))
.collect();
let v2: Vec<(&str, &[u8])> = vec![
("Wow.exe", b"exe-2"),
("d3d9.dll", b"official d3d9 v2"),
("dxvk.conf", b"official conf v2"),
("Data/common.MPQ", b"common-2"),
];
let (m2, s2) = (manifest("v2", &v2), Server::new(&v2));
for keep in [false, true] {
sync(d.path(), &m2, &s2, keep).unwrap();
for (p, h) in &before {
assert_eq!(
&fsx::sha256_file(&d.path().join(p)).unwrap(),
h,
"{p} must not change (keep_modified={keep})"
);
}
assert_eq!(fs::read(d.path().join("Wow.exe")).unwrap(), b"exe-2");
assert_eq!(
fs::read(d.path().join("Data/common.MPQ")).unwrap(),
b"common-2"
);
}
assert!(
!d.path().join(".coa-manager/replaced").exists(),
"nothing of the player's was displaced"
);
}
#[test]
fn an_existing_client_without_state_is_compared_by_content() {
let d = tempfile::tempdir().unwrap();
for (p, b) in V1 {
let path = d.path().join(p);
fs::create_dir_all(path.parent().unwrap()).unwrap();
fs::write(path, b).unwrap();
}
fs::write(d.path().join("Data/patch-A.MPQ"), b"patch-a-X").unwrap(); // same size, different content
fs::remove_file(d.path().join("Data/enUS/locale.MPQ")).unwrap();
fs::create_dir_all(d.path().join("WTF")).unwrap();
fs::write(d.path().join("WTF/Config.wtf"), b"mine").unwrap();
let m = manifest("v1", &V1);
let p = plan(d.path(), &m, &State::default(), &Cancel::default(), &|_| {}).unwrap();
let kinds: Vec<_> = p.items.iter().map(|i| (i.path.as_str(), i.kind)).collect();
assert_eq!(
kinds,
[
("Data/patch-A.MPQ", Kind::Modified),
("Data/enUS/locale.MPQ", Kind::Missing)
]
);
assert_eq!(p.up_to_date_files, 2);
assert_eq!(fs::read(d.path().join("WTF/Config.wtf")).unwrap(), b"mine");
}
#[test]
fn cancel_keeps_finished_files_and_the_next_run_only_fetches_the_rest() {
let d = tempfile::tempdir().unwrap();
let m = manifest("v1", &V1);
let mut s = Server::new(&V1);
let cancel = Cancel::default();
s.cancel_after = Some((AtomicUsize::new(3), cancel.clone()));
let state = State::default();
let p = plan(d.path(), &m, &state, &cancel, &|_| {}).unwrap();
let r = apply(
&Apply {
client: d.path(),
manifest: &m,
plan: &p,
keep_modified: false,
transport: &s,
objects_url: "https://x.invalid/o",
cancel: &cancel,
},
&|_| {},
);
assert!(r.is_err());
let st = load_state(d.path()).unwrap();
assert!(
st.version.is_none() && !st.files.is_empty() && st.files.len() < 4,
"unfinished but remembered: {}",
st.files.len()
);
assert!(local(d.path()).managed && local(d.path()).version.is_none());
let s2 = Server::new(&V1);
sync(d.path(), &m, &s2, false).unwrap();
assert_eq!(
s2.requested.lock().unwrap().len(),
4 - st.files.len(),
"only the missing files were requested"
);
assert_eq!(load_state(d.path()).unwrap().version.as_deref(), Some("v1"));
}
#[test]
fn a_wrong_object_never_reaches_the_client_folder() {
let d = tempfile::tempdir().unwrap();
let m = manifest("v1", &V1);
let s = Server::new(&V1);
// the server returns different bytes under the right hash
let sha = fsx::sha256_bytes(b"exe-1");
s.objects.lock().unwrap().insert(sha, b"EVIL!".to_vec());
assert!(sync(d.path(), &m, &s, false).is_err());
assert!(!d.path().join("Wow.exe").exists());
assert!(load_state(d.path()).unwrap().version.is_none());
}
}
+22
View File
@@ -1033,6 +1033,28 @@ Spellbook.New = 5
assert!(v.drift_keys.is_empty());
}
#[test]
fn creature_rates_save_independently_in_template_and_active_config() {
let (_d, root, meta) = fixture();
let mut changes = BTreeMap::new();
for (i, group) in ["Normal", "Elite.Elite", "Elite.RARE", "Elite.RAREELITE", "Elite.WORLDBOSS"].iter().enumerate() {
for (j, stat) in ["Damage", "SpellDamage", "HP"].iter().enumerate() {
changes.insert(format!("Rate.Creature.{group}.{stat}"), json!(0.25 + (i * 3 + j) as f64 * 0.25));
}
}
let report = save(&root, &meta, Scope::Server, &changes).unwrap();
assert_eq!(report.changed.len(), 15);
assert_eq!(report.restart, Some(Restart::World));
for path in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
let conf = load_conf(&root.join(path)).unwrap();
for (key, value) in &changes {
assert_eq!(conf.get(key).unwrap().parse::<f64>().unwrap(), value.as_f64().unwrap(), "{path}: {key}");
}
assert_eq!(conf.get("Unknown.Custom"), Some("\"keep me\""));
}
assert!(save(&root, &meta, Scope::Server, &changes).unwrap().changed.is_empty());
}
#[test]
fn save_changes_only_that_key_in_template_and_generated_conf() {
let (_d, root, meta) = fixture();
+2 -10
View File
@@ -61,16 +61,8 @@ pub fn lines_from_text(text: &str, filter: Option<&str>, max_lines: usize) -> Ve
let out: Vec<Line> = text
.lines()
.filter(|l| !l.trim().is_empty())
.filter(|l| {
needle
.as_ref()
.map(|n| l.to_lowercase().contains(n))
.unwrap_or(true)
})
.map(|l| Line {
level: classify(l),
text: crate::diag::redact(l),
})
.filter(|l| needle.as_ref().map(|n| l.to_lowercase().contains(n)).unwrap_or(true))
.map(|l| Line { level: classify(l), text: crate::diag::redact(l) })
.collect();
let skip = out.len().saturating_sub(max_lines);
out.into_iter().skip(skip).collect()
+2 -256
View File
@@ -64,31 +64,8 @@ impl LocalBackend {
}
fn access(&self, local_id: &str) -> Result<RealmAccess> {
let access =
find_access(&self.descriptors, &(self.installs)(), local_id).ok_or_else(|| {
Error::Invalid(format!(
"That realm is not known to this Manager: {local_id}"
))
})?;
if let Some((_base, rs)) = local_id.split_once(':') {
let expected_mode = match rs {
"coa" => crate::realms::Mode::Coa,
"wildcard" => crate::realms::Mode::Wildcard,
"reborn" => crate::realms::Mode::Reborn,
_ => {
return Err(Error::Invalid(format!(
"Malformed or unknown ruleset suffix in local_id: {rs}"
)))
}
};
if access.mode != Some(expected_mode) {
return Err(Error::Invalid(format!(
"Realm access mode {:?} does not match expected ruleset in local_id {local_id}",
access.mode
)));
}
}
Ok(access)
find_access(&self.descriptors, &(self.installs)(), local_id)
.ok_or_else(|| Error::Invalid("That realm is not known to this Manager.".into()))
}
fn account(&self, local_id: &str, filter: &str) -> Result<Option<AccountRow>> {
@@ -109,39 +86,9 @@ impl LocalBackend {
impl RealmBackend for LocalBackend {
fn info(&self, local_id: &str) -> Result<RealmInfo> {
let cfg = settings::load(&self.settings_dir)?.realms.remove(local_id);
let access = self.access(local_id)?;
let db = access.db()?;
let ruleset = realm::ruleset_of(&db).map_err(|e| Error::Invalid(e.to_string()))?;
// Explicit local-id -> ruleset invariant:
// local_id ruleset == RealmAccess.mode == Db.realm() == RealmInfo.ruleset
if let Some((_base, rs)) = local_id.split_once(':') {
let expected_ruleset: crate::portable::Ruleset = rs
.parse()
.map_err(|_| Error::Invalid(format!("Unknown ruleset in local_id: {rs}")))?;
if ruleset != expected_ruleset {
return Err(Error::Invalid(format!(
"Ruleset of realm DB ({ruleset:?}) does not match local_id {local_id}"
)));
}
if access.mode.map(|m| m.name()) != Some(expected_ruleset.as_str()) {
return Err(Error::Invalid(format!(
"RealmAccess mode ({:?}) does not match local_id {local_id}",
access.mode
)));
}
if db.realm().name() != expected_ruleset.as_str() {
return Err(Error::Invalid(format!(
"Db realm ({:?}) does not match local_id {local_id}",
db.realm()
)));
}
}
Ok(RealmInfo {
automatic: cfg.as_ref().is_none_or(|c| !c.existing_only),
route: cfg.and_then(|c| c.route),
ruleset,
})
}
@@ -264,7 +211,6 @@ impl RealmBackend for LocalBackend {
.map_err(|e| unavailable("export", e))?;
Ok(ClaimExport {
character_id: bundle.character_id.as_uuid(),
ruleset: bundle.ruleset,
payload: bundle.payload,
sha256: bundle.content_hash,
collections: bundle.collections,
@@ -297,204 +243,4 @@ impl RealmBackend for LocalBackend {
.map_err(|e| unavailable("portable engine", e))?
.map_err(|e| unavailable("import remote", e))
}
fn world_port(&self, local_id: &str) -> Result<u16> {
if let Ok(override_port) = std::env::var("COA_OVERRIDE_LOCAL_WORLD_PORT") {
if let Ok(p) = override_port.parse::<u16>() {
return Ok(p);
}
}
let access = self.access(local_id)?;
let mode = if let Some(m) = access.mode {
m
} else if let Some((_base, _rs)) = local_id.split_once(':') {
return Err(Error::Invalid(format!(
"Unresolved mode for ruleset suffix in {local_id}"
)));
} else {
// Legacy unsuffixed CoA realm ONLY
crate::realms::Mode::Coa
};
if let Some(ref root) = access.root {
crate::realms::world_port_for_mode(root, mode)
} else {
Err(Error::Invalid(format!(
"No server installation root for {local_id} to resolve world port"
)))
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::fs;
use tempfile::tempdir;
#[test]
fn unreadable_or_unknown_realm_fails_closed_in_info() {
let dir = tempdir().unwrap();
let settings = dir.path().join("Settings");
fs::create_dir_all(&settings).unwrap();
fs::write(settings.join("registry.json"), "{}").unwrap();
let desc_dir = dir.path().join("descriptors");
fs::create_dir_all(&desc_dir).unwrap();
let portable_dir = dir.path().join("portable");
let rt = PortableRuntime::start(&portable_dir, Box::new(Vec::new), None).unwrap();
let backend = LocalBackend::new(Arc::new(rt), &settings, &desc_dir, Arc::new(Vec::new));
// Unknown realm id must return Err, never Ok(RealmInfo { ruleset: Ruleset::Coa, .. })
assert!(backend.info("srv-unknown").is_err());
assert!(backend.info("srv-unknown:wildcard").is_err());
assert!(backend.info("srv-unknown:reborn").is_err());
}
#[test]
fn world_port_for_mode_distinguishes_simultaneous_realms() {
let dir = tempdir().unwrap();
let root = dir.path().join("srv");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(root.join("Settings/repack.json"), r#"{"worldPort": 8085}"#).unwrap();
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "coa", "wildcard_created": true, "simultaneous": true, "secondary_world_port": 8086}"#,
)
.unwrap();
assert_eq!(
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Coa).unwrap(),
8085
);
assert_eq!(
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Wildcard).unwrap(),
8086
);
let desc_dir = dir.path().join("descriptors");
let portable_dir = dir.path().join("portable");
let rt = PortableRuntime::start(&portable_dir, Box::new(Vec::new), None).unwrap();
let root_clone = root.clone();
let backend = LocalBackend::new(
Arc::new(rt),
root.join("Settings"),
&desc_dir,
Arc::new(move || vec![("test1".to_string(), root_clone.clone())]),
);
assert_eq!(backend.world_port("srv-test1:coa").unwrap(), 8085);
assert_eq!(backend.world_port("srv-test1:wildcard").unwrap(), 8086);
// When simultaneous is false and active is CoA:
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "coa", "wildcard_created": true, "simultaneous": false}"#,
)
.unwrap();
// CoA succeeds with 8085
assert_eq!(backend.world_port("srv-test1:coa").unwrap(), 8085);
// Wildcard must FAIL CLOSED, never return 8085
let err_wc_mode =
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Wildcard).unwrap_err();
assert!(
err_wc_mode.to_string().contains("not active"),
"Expected not active error, got: {err_wc_mode}"
);
assert!(backend.world_port("srv-test1:wildcard").is_err());
// Reborn must FAIL CLOSED
let err_reb_mode =
crate::realms::world_port_for_mode(&root, crate::realms::Mode::Reborn).unwrap_err();
assert!(
err_reb_mode.to_string().contains("not active"),
"Expected not active error, got: {err_reb_mode}"
);
assert!(backend.world_port("srv-test1:reborn").is_err());
// When active is Reborn:
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "reborn", "wildcard_created": true, "reborn_created": true, "simultaneous": false}"#,
)
.unwrap();
// Reborn succeeds with primary world port 8085
assert_eq!(backend.world_port("srv-test1:reborn").unwrap(), 8085);
// CoA must FAIL CLOSED when Reborn is active
assert!(backend.world_port("srv-test1:coa").is_err());
// Wildcard must FAIL CLOSED when Reborn is active
assert!(backend.world_port("srv-test1:wildcard").is_err());
// Malformed and unknown suffixes must fail closed
assert!(backend.access("srv-test1:unknown").is_err());
assert!(backend.access("srv-test1:garbage").is_err());
assert!(backend.access("srv-test1:coa:extra").is_err());
assert!(backend.world_port("srv-test1:unknown").is_err());
assert!(backend.world_port("srv-test1:garbage").is_err());
}
#[test]
fn world_port_lookup_failure_causes_direct_and_relay_to_fail_closed() {
let dir = tempdir().unwrap();
let root = dir.path().join("srv");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::write(root.join("Settings/repack.json"), r#"{"worldPort": 8085}"#).unwrap();
// Server only has active CoA, simultaneous is off
fs::write(
root.join("Settings/realm-profile.json"),
r#"{"active": "coa", "wildcard_created": false, "simultaneous": false}"#,
)
.unwrap();
let desc_dir = dir.path().join("descriptors");
let portable_dir = dir.path().join("portable");
let rt = PortableRuntime::start(&portable_dir, Box::new(Vec::new), None).unwrap();
let root_clone = root.clone();
let backend = Arc::new(LocalBackend::new(
Arc::new(rt),
root.join("Settings"),
&desc_dir,
Arc::new(move || vec![("test1".to_string(), root_clone.clone())]),
));
let store = Arc::new(std::sync::Mutex::new(
crate::control::store::ControlStore::open_in_memory().unwrap(),
));
let service = Arc::new(crate::control::service::HostService::new(
"srv-test1:wildcard",
coa_registry_proto::sign::RealmId::new(),
store,
backend,
));
// 1. HostService::local_world_port fails closed
assert!(service.local_world_port().is_err());
// 2. Direct route manager cannot find a direct route because world port resolution failed
let mut direct_mgr =
crate::control::direct_route::DirectRouteManager::start(None, service.clone());
assert!(!direct_mgr.is_direct_ready());
assert!(service.direct_route().is_none());
direct_mgr.shutdown();
// 3. When relay link has no world port resolved, AllocateRelay refuses
let mut session = crate::control::service::Session::default();
let player = uuid::Uuid::now_v7();
let resp = service.handle(
&mut session,
&player,
"KEY",
coa_control_proto::app::Request::AllocateRelay { player_id: player },
);
assert!(matches!(
resp,
coa_control_proto::app::Response::Error {
code: coa_control_proto::app::AppError::NoAccount
| coa_control_proto::app::AppError::RelayUnavailable,
..
}
));
}
}
+47 -171
View File
@@ -33,13 +33,8 @@ impl DirectIngress {
local_auth_port: u16,
local_world_port: u16,
) -> Result<Self> {
let auth_host = if auth_bind_port == 0 {
"127.0.0.1"
} else {
"0.0.0.0"
};
let auth_listener =
TcpListener::bind(format!("{auth_host}:{auth_bind_port}")).map_err(|e| {
TcpListener::bind(format!("0.0.0.0:{auth_bind_port}")).map_err(|e| {
Error::Invalid(format!(
"Cannot bind direct auth listener on port {auth_bind_port}: {e}"
))
@@ -52,13 +47,8 @@ impl DirectIngress {
.map_err(|e| Error::Invalid(e.to_string()))?
.port();
let world_host = if world_bind_port == 0 {
"127.0.0.1"
} else {
"0.0.0.0"
};
let world_listener =
TcpListener::bind(format!("{world_host}:{world_bind_port}")).map_err(|e| {
TcpListener::bind(format!("0.0.0.0:{world_bind_port}")).map_err(|e| {
Error::Invalid(format!(
"Cannot bind direct world listener on port {world_bind_port}: {e}"
))
@@ -124,11 +114,7 @@ impl DirectIngress {
std::thread::Builder::new()
.name("direct-world-worker".into())
.spawn(move || {
if let Err(e) =
handle_world_client(client_stream, local_world_port)
{
eprintln!("handle_world_client error: {e}");
}
let _ = handle_world_client(client_stream, local_world_port);
})
.ok();
}
@@ -188,21 +174,8 @@ fn handle_auth_client(
local_auth_port: u16,
world_target: Arc<std::sync::RwLock<String>>,
) -> Result<()> {
let mut server = None;
for _ in 0..5 {
match TcpStream::connect(format!("127.0.0.1:{local_auth_port}")) {
Ok(s) => {
server = Some(s);
break;
}
Err(_) => std::thread::sleep(Duration::from_millis(20)),
}
}
let mut server = server.ok_or_else(|| {
Error::Invalid(format!(
"Cannot connect to local authserver: {local_auth_port}"
))
})?;
let mut server = TcpStream::connect(format!("127.0.0.1:{local_auth_port}"))
.map_err(|e| Error::Invalid(format!("Cannot connect to local authserver: {e}")))?;
let _ = client.set_read_timeout(Some(Duration::from_millis(500)));
let _ = server.set_read_timeout(Some(Duration::from_millis(500)));
@@ -240,7 +213,7 @@ fn handle_auth_client(
}
done_c.store(true, Ordering::Relaxed);
if let Some(s) = server_shutdown {
let _ = s.shutdown(std::net::Shutdown::Write);
let _ = s.shutdown(std::net::Shutdown::Both);
}
});
@@ -288,21 +261,8 @@ fn handle_auth_client(
}
fn handle_world_client(mut client: TcpStream, local_world_port: u16) -> Result<()> {
let mut server = None;
for _ in 0..5 {
match TcpStream::connect(format!("127.0.0.1:{local_world_port}")) {
Ok(s) => {
server = Some(s);
break;
}
Err(_) => std::thread::sleep(Duration::from_millis(20)),
}
}
let mut server = server.ok_or_else(|| {
Error::Invalid(format!(
"Cannot connect to local worldserver: {local_world_port}"
))
})?;
let mut server = TcpStream::connect(format!("127.0.0.1:{local_world_port}"))
.map_err(|e| Error::Invalid(format!("Cannot connect to local worldserver: {e}")))?;
let _ = client.set_nonblocking(false);
let _ = server.set_nonblocking(false);
@@ -318,11 +278,11 @@ fn handle_world_client(mut client: TcpStream, local_world_port: u16) -> Result<(
let t_c2s = std::thread::spawn(move || {
let _ = std::io::copy(&mut client_read, &mut server_write);
let _ = server_write.shutdown(std::net::Shutdown::Write);
let _ = server_write.shutdown(std::net::Shutdown::Both);
});
let _ = std::io::copy(&mut server, &mut client);
let _ = client.shutdown(std::net::Shutdown::Write);
let _ = client.shutdown(std::net::Shutdown::Both);
let _ = t_c2s.join();
Ok(())
@@ -360,7 +320,6 @@ mod tests {
let n = stream.read(&mut buf).unwrap();
assert_eq!(&buf[..n], b"WORLD_PING");
stream.write_all(b"WORLD_PONG").unwrap();
stream.flush().unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write);
});
@@ -378,27 +337,25 @@ mod tests {
let mut buf = [0u8; 16];
let _ = stream.read(&mut buf).unwrap();
let name_bytes = b"RealmOne\0";
let addr_bytes = b"127.0.0.1:8085\0";
let body_len = 4 + 2 + 3 + name_bytes.len() + addr_bytes.len() + 4 + 1 + 1 + 1 + 2;
let mut fake_realm_list = vec![
0x10, // Opcode CMD_REALM_LIST
0x00, 0x00, // Size placeholder
0x00, 0x00, 0x00, 0x00, // Unused
0x01, 0x00, // Realm count: 1
0x01, 0x00, 0x00, 0x00, // Icon
0x00, // Lock
0x00, // Flags
];
fake_realm_list.extend_from_slice(b"RealmOne\0");
fake_realm_list.extend_from_slice(b"127.0.0.1:8085\0"); // original target
fake_realm_list.extend_from_slice(&[0x00, 0x00, 0x00, 0x00]); // Population
fake_realm_list.extend_from_slice(&[0x01]); // Num characters
fake_realm_list.extend_from_slice(&[0x01]); // Timezone
fake_realm_list.extend_from_slice(&[0x00]); // Realm ID
fake_realm_list.extend_from_slice(&[0x02, 0x00]); // Footer
let mut fake_realm_list = Vec::new();
fake_realm_list.push(0x10); // Opcode
fake_realm_list.extend_from_slice(&(body_len as u16).to_le_bytes()); // Length
fake_realm_list.extend_from_slice(&0u32.to_le_bytes()); // Unused
fake_realm_list.extend_from_slice(&1u16.to_le_bytes()); // Realm count = 1
// Realm info:
fake_realm_list.extend_from_slice(&[1, 0, 0]); // type, lock, flag
fake_realm_list.extend_from_slice(name_bytes);
fake_realm_list.extend_from_slice(addr_bytes);
fake_realm_list.extend_from_slice(&[0, 0, 0, 0]); // pop
fake_realm_list.extend_from_slice(&[0]); // chars
fake_realm_list.extend_from_slice(&[1]); // timezone
fake_realm_list.extend_from_slice(&[1]); // realm id
// Footer:
fake_realm_list.extend_from_slice(&[0x10, 0x00]);
let body_len = (fake_realm_list.len() - 3) as u16;
fake_realm_list[1..3].copy_from_slice(&body_len.to_le_bytes());
stream.write_all(&fake_realm_list).unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write);
@@ -429,7 +386,7 @@ mod tests {
let mock_world_port = mock_world.local_addr().unwrap().port();
// DirectIngress binds to ephemeral ports (0, 0), so actual ingress port != 8085
let mut ingress = DirectIngress::start(
let ingress = DirectIngress::start(
0,
0,
"198.51.100.1".to_string(),
@@ -458,27 +415,25 @@ mod tests {
let mut buf = [0u8; 16];
let _ = stream.read(&mut buf).unwrap();
let name_bytes = b"RealmOne\0";
let addr_bytes = b"127.0.0.1:8085\0";
let body_len = 4 + 2 + 3 + name_bytes.len() + addr_bytes.len() + 4 + 1 + 1 + 1 + 2;
let mut fake_realm_list = vec![
0x10, // Opcode CMD_REALM_LIST
0x00, 0x00, // Size placeholder
0x00, 0x00, 0x00, 0x00, // Unused
0x01, 0x00, // Realm count: 1
0x01, 0x00, 0x00, 0x00, // Icon
0x00, // Lock
0x00, // Flags
];
fake_realm_list.extend_from_slice(b"RealmOne\0");
fake_realm_list.extend_from_slice(b"127.0.0.1:8085\0");
fake_realm_list.extend_from_slice(&[0x00, 0x00, 0x00, 0x00]);
fake_realm_list.extend_from_slice(&[0x01]);
fake_realm_list.extend_from_slice(&[0x01]);
fake_realm_list.extend_from_slice(&[0x00]);
fake_realm_list.extend_from_slice(&[0x02, 0x00]);
let mut fake_realm_list = Vec::new();
fake_realm_list.push(0x10); // Opcode
fake_realm_list.extend_from_slice(&(body_len as u16).to_le_bytes()); // Length
fake_realm_list.extend_from_slice(&0u32.to_le_bytes()); // Unused
fake_realm_list.extend_from_slice(&1u16.to_le_bytes()); // Realm count = 1
// Realm info:
fake_realm_list.extend_from_slice(&[1, 0, 0]); // type, lock, flag
fake_realm_list.extend_from_slice(name_bytes);
fake_realm_list.extend_from_slice(addr_bytes);
fake_realm_list.extend_from_slice(&[0, 0, 0, 0]); // pop
fake_realm_list.extend_from_slice(&[0]); // chars
fake_realm_list.extend_from_slice(&[1]); // timezone
fake_realm_list.extend_from_slice(&[1]); // realm id
// Footer:
fake_realm_list.extend_from_slice(&[0x10, 0x00]);
let body_len = (fake_realm_list.len() - 3) as u16;
fake_realm_list[1..3].copy_from_slice(&body_len.to_le_bytes());
stream.write_all(&fake_realm_list).unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write);
@@ -507,84 +462,5 @@ mod tests {
drop(client_auth);
t_auth.join().unwrap();
ingress.stop();
}
#[test]
fn test_direct_ingress_wildcard_port_rewrites_to_mapped_port_and_never_advertises_coa_8085() {
let ext_wildcard_port = 48086;
let mock_auth = TcpListener::bind("127.0.0.1:0").unwrap();
let mock_auth_port = mock_auth.local_addr().unwrap().port();
let mock_world = TcpListener::bind("127.0.0.1:0").unwrap();
let mock_world_port = mock_world.local_addr().unwrap().port();
// DirectIngress configured for Wildcard (local_world = mock_world_port, ext_world = 48086)
let mut ingress = DirectIngress::start(
0,
0,
"198.51.100.1".to_string(),
ext_wildcard_port,
mock_auth_port,
mock_world_port,
)
.unwrap();
// Verify Auth rewrite rewrites to external port 48086 and never mentions 8085 or 8086
let t_auth = std::thread::spawn(move || {
let (mut stream, _) = mock_auth.accept().unwrap();
let mut buf = [0u8; 16];
let _ = stream.read(&mut buf).unwrap();
let name_bytes = b"Wildcard\0";
let addr_bytes = b"127.0.0.1:8086\0";
let body_len = 4 + 2 + 3 + name_bytes.len() + addr_bytes.len() + 4 + 1 + 1 + 1 + 2;
let mut fake_realm_list = Vec::new();
fake_realm_list.push(0x10); // Opcode
fake_realm_list.extend_from_slice(&(body_len as u16).to_le_bytes()); // Length
fake_realm_list.extend_from_slice(&0u32.to_le_bytes()); // Unused
fake_realm_list.extend_from_slice(&1u16.to_le_bytes()); // Realm count = 1
// Realm info:
fake_realm_list.extend_from_slice(&[1, 0, 0]); // type, lock, flag
fake_realm_list.extend_from_slice(name_bytes);
fake_realm_list.extend_from_slice(addr_bytes);
fake_realm_list.extend_from_slice(&[0, 0, 0, 0]); // pop
fake_realm_list.extend_from_slice(&[0]); // chars
fake_realm_list.extend_from_slice(&[1]); // timezone
fake_realm_list.extend_from_slice(&[1]); // realm id
// Footer:
fake_realm_list.extend_from_slice(&[0x10, 0x00]);
stream.write_all(&fake_realm_list).unwrap();
let _ = stream.shutdown(std::net::Shutdown::Write);
});
let mut client_auth =
TcpStream::connect(format!("127.0.0.1:{}", ingress.auth_port())).unwrap();
client_auth.write_all(b"AUTH_HELLO").unwrap();
let mut auth_buf = [0u8; 512];
let an = client_auth.read(&mut auth_buf).unwrap();
let payload = String::from_utf8_lossy(&auth_buf[..an]);
assert!(
payload.contains("198.51.100.1:48086"),
"Expected rewritten realm list to contain external port 48086, got: {payload}"
);
assert!(
!payload.contains("8085"),
"DirectIngress for Wildcard must never advertise CoA port 8085"
);
assert!(
!payload.contains(":8086"),
"DirectIngress for Wildcard must rewrite internal port 8086 to external 48086"
);
drop(client_auth);
t_auth.join().unwrap();
ingress.stop();
}
}
+3 -18
View File
@@ -304,25 +304,10 @@ fn attempt_route_discovery(
.ok()
.and_then(|p| p.parse().ok())
.unwrap_or(coa_control_proto::relay::LOCAL_AUTH_PORT);
let local_world = match std::env::var("COA_OVERRIDE_LOCAL_WORLD_PORT")
let local_world = std::env::var("COA_OVERRIDE_LOCAL_WORLD_PORT")
.ok()
.and_then(|p| p.parse().ok())
{
Some(p) => p,
None => match service.local_world_port() {
Ok(p) => p,
Err(e) => {
set_status(
status,
RouteStatus::RelayOnly {
reason: format!("Cannot resolve local world port: {e}"),
},
);
service.set_direct_route(None);
return;
}
},
};
.unwrap_or(coa_control_proto::relay::LOCAL_WORLD_PORT);
let desired_auth_port: u16 = std::env::var("COA_DIRECT_AUTH_PORT")
.ok()
@@ -331,7 +316,7 @@ fn attempt_route_discovery(
let desired_world_port: u16 = std::env::var("COA_DIRECT_WORLD_PORT")
.ok()
.and_then(|p| p.parse().ok())
.unwrap_or(local_world);
.unwrap_or(8085);
let ingress = match DirectIngress::start(
desired_auth_port,
+12 -21
View File
@@ -95,27 +95,18 @@ impl HostControl {
store.clone(),
backend.clone(),
));
let relay_link = match service.local_world_port() {
Ok(world_port) => {
crate::control::transport::relay_url(&base, "/relay/v1/host").map(
|r_url| {
let rl =
crate::control::relay_link::RelayLink::start_with_ports(
r_url,
realm_id,
key.clone(),
Some(world_port),
);
service.set_relay(rl.clone());
rl
},
)
}
Err(e) => {
eprintln!("Relay link unavailable for {local_id}: cannot resolve world port: {e}");
None
}
};
let relay_link =
crate::control::transport::relay_url(&base, "/relay/v1/host").map(
|r_url| {
let rl = crate::control::relay_link::RelayLink::start(
r_url,
realm_id,
key.clone(),
);
service.set_relay(rl.clone());
rl
},
);
let direct_route =
Some(crate::control::direct_route::DirectRouteManager::start(
Some(base.clone()),
+2 -7
View File
@@ -115,7 +115,6 @@ pub struct AccountOutcome {
#[derive(Debug, Clone)]
pub struct Claimed {
pub character_id: Uuid,
pub ruleset: String,
pub payload: Vec<u8>,
pub sha256: [u8; 32],
pub collections: BTreeMap<String, Vec<u32>>,
@@ -348,14 +347,13 @@ impl PlayerControl {
pub fn claim(&self, ch: &mut PlayerChannel, token: u32) -> R<Claimed> {
let r = ch.request(&Request::Claim { token })?;
let (character_id, ruleset, sha256, payload, collections) = expect(r, |r| match r {
let (character_id, sha256, payload, collections) = expect(r, |r| match r {
Response::Claimed {
character_id,
ruleset,
sha256,
payload,
collections,
} => Ok((character_id, ruleset, sha256, payload, collections)),
} => Ok((character_id, sha256, payload, collections)),
other => Err(other),
})?;
let payload = base64::engine::general_purpose::STANDARD
@@ -375,7 +373,6 @@ impl PlayerControl {
})?;
Ok(Claimed {
character_id,
ruleset,
payload,
sha256: hash,
collections,
@@ -416,7 +413,6 @@ impl PlayerControl {
&self,
ch: &mut PlayerChannel,
character_id: Uuid,
ruleset: &str,
canonical_revision: u64,
payload: &[u8],
content_hash: [u8; 32],
@@ -427,7 +423,6 @@ impl PlayerControl {
let offer = Request::TransferOffer {
transfer_id,
character_id,
ruleset: ruleset.to_string(),
canonical_revision,
content_hash: content_hash_str.clone(),
total_size: payload.len(),
+4 -28
View File
@@ -71,15 +71,6 @@ impl RelayProvider for RelayLink {
impl RelayLink {
pub fn start(url: String, realm_id: RealmId, key: SigningKey) -> Arc<Self> {
Self::start_with_ports(url, realm_id, key, None)
}
pub fn start_with_ports(
url: String,
realm_id: RealmId,
key: SigningKey,
local_world_port: Option<u16>,
) -> Arc<Self> {
let stop = Arc::new(AtomicBool::new(false));
let status = Arc::new(Mutex::new(RelayStatus::default()));
let (alloc_tx, alloc_rx) = channel();
@@ -88,7 +79,7 @@ impl RelayLink {
let st = status.clone();
let join = std::thread::Builder::new()
.name("control-relay-host".into())
.spawn(move || run(&url, realm_id, &key, alloc_rx, &s, &st, local_world_port))
.spawn(move || run(&url, realm_id, &key, alloc_rx, &s, &st))
.ok();
Arc::new(RelayLink {
@@ -136,12 +127,11 @@ fn run(
)>,
stop: &AtomicBool,
status: &Mutex<RelayStatus>,
local_world_port: Option<u16>,
) {
let mut failures = 0u32;
while !stop.load(Ordering::SeqCst) {
let began = Instant::now();
let result = session(url, realm, key, &alloc_rx, stop, status, local_world_port);
let result = session(url, realm, key, &alloc_rx, stop, status);
set_status(status, |s| {
s.connected = false;
s.active_streams = 0;
@@ -186,7 +176,6 @@ fn session(
)>,
stop: &AtomicBool,
status: &Mutex<RelayStatus>,
local_world_port: Option<u16>,
) -> Result<(), LinkError> {
let mut ws = transport::connect(url, POLL)?;
@@ -316,21 +305,8 @@ fn session(
TunnelMsg::Connect {
stream_id, target, ..
} => {
// Strictly predefined local targets: Auth (3724) or World (8085 or bound realm world port)
let local_port = match target {
RelayTarget::Auth => target.local_port(),
RelayTarget::World => match local_world_port {
Some(p) => p,
None => {
eprintln!("RelayLink cannot connect to World: local_world_port was not provided (fail-closed)");
let _ = ws_out_tx.send(TunnelMsg::ConnectErr {
stream_id,
error: "World port unresolved".into(),
});
continue;
}
},
};
// Strictly predefined local targets: Auth (3724) or World (8085)
let local_port = target.local_port();
match TcpStream::connect(("127.0.0.1", local_port)) {
Ok(tcp) => {
let (stream_tx, stream_rx) = channel::<TunnelMsg>();
+29 -314
View File
@@ -26,7 +26,6 @@ pub struct RealmInfo {
pub automatic: bool,
/// An address a player's game client can reach right now, when the owner has stated one. Not a relay and not discovery.
pub route: Option<String>,
pub ruleset: crate::portable::model::Ruleset,
}
#[derive(Clone, Debug, PartialEq, Eq)]
@@ -56,7 +55,6 @@ pub struct CharInfo {
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ClaimExport {
pub character_id: Uuid,
pub ruleset: crate::portable::Ruleset,
pub payload: Vec<u8>,
pub sha256: [u8; 32],
pub collections: BTreeMap<String, Vec<u32>>,
@@ -120,8 +118,6 @@ pub trait RealmBackend: Send + Sync {
local_id: &str,
params: RemoteImportParams,
) -> Result<RemoteImportOutcome>;
/// Local world port for this realm. Must fail closed if the realm port cannot be resolved.
fn world_port(&self, local_id: &str) -> Result<u16>;
}
/// State of one channel.
@@ -222,10 +218,6 @@ impl HostService {
self.realm_id
}
pub fn local_world_port(&self) -> Result<u16> {
self.backend.world_port(&self.local_id)
}
/// The player's public key is the one recorded for this player id when there is a record; `None` when the player is new here.
pub fn key_matches(&self, player: &Uuid, public_key: &str) -> bool {
match self
@@ -311,7 +303,6 @@ impl HostService {
Request::TransferOffer {
transfer_id,
character_id,
ruleset,
canonical_revision,
content_hash,
total_size,
@@ -320,7 +311,6 @@ impl HostService {
player,
transfer_id,
character_id,
ruleset,
canonical_revision,
content_hash,
total_size,
@@ -701,7 +691,6 @@ impl HostService {
use base64::Engine;
Response::Claimed {
character_id: exported.character_id,
ruleset: exported.ruleset.as_str().to_string(),
sha256: hex::encode(exported.sha256),
payload: base64::engine::general_purpose::STANDARD.encode(&exported.payload),
collections: exported.collections,
@@ -737,7 +726,6 @@ impl HostService {
player: &Uuid,
transfer_id: Uuid,
character_id: Uuid,
ruleset: String,
canonical_revision: u64,
content_hash: String,
total_size: usize,
@@ -753,30 +741,6 @@ impl HostService {
);
};
// 0. Strict ruleset isolation: target realm ruleset must match offer ruleset
let info = match self.backend.info(&self.local_id) {
Ok(i) => i,
Err(e) => return unavailable("reading realm info", &e),
};
let offer_ruleset = match crate::portable::model::Ruleset::parse(&ruleset) {
Ok(r) => r,
Err(_) => return err(AppError::Incompatible, "Invalid ruleset in transfer offer."),
};
if offer_ruleset != info.ruleset {
return err(
AppError::Incompatible,
"Character ruleset does not match this realm.",
);
}
for kind in collections.keys() {
if !crate::portable::session::protocol::carried_kind_for(kind, offer_ruleset) {
return err(
AppError::Incompatible,
"Collection kind does not belong to this ruleset.",
);
}
}
// 1. Ownership check: another player cannot overwrite a character claimed here
if let Ok(Some(claim)) = self
.store
@@ -870,7 +834,6 @@ impl HostService {
realm_local_id: self.local_id.clone(),
transfer_id,
character_id,
ruleset: offer_ruleset.as_str().to_string(),
player_id: *player,
revision: canonical_revision,
content_hash,
@@ -1045,53 +1008,16 @@ impl HostService {
Err(e) => return unavailable("reading transfer file", &Error::Invalid(e.to_string())),
};
let mut hash_bytes = [0u8; 32];
if hex::decode_to_slice(&t.content_hash, &mut hash_bytes).is_err() {
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
if hash != t.content_hash {
let _ = std::fs::remove_file(&path);
return err(AppError::Invalid, "Invalid content hash format.");
return err(AppError::Invalid, "Content hash mismatch.");
}
let decoded = match crate::portable::snapshot::decode(&payload, Some(&hash_bytes)) {
Ok(d) => d,
Err(e) => {
let _ = std::fs::remove_file(&path);
return err(AppError::Invalid, &format!("Corrupt snapshot: {e}"));
}
};
let transfer_ruleset: crate::portable::Ruleset = match t.ruleset.parse() {
Ok(r) => r,
Err(_) => {
let _ = std::fs::remove_file(&path);
return err(AppError::Incompatible, "Invalid transfer ruleset.");
}
};
if decoded.character_id.as_uuid() != t.character_id {
let _ = std::fs::remove_file(&path);
return err(
AppError::Invalid,
"Snapshot character id does not match TransferOffer.",
);
}
if decoded.ruleset != transfer_ruleset {
let _ = std::fs::remove_file(&path);
return err(
AppError::Incompatible,
"Snapshot ruleset does not match TransferOffer.",
);
}
let info = match self.backend.info(&self.local_id) {
Ok(i) => i,
Err(e) => {
let _ = std::fs::remove_file(&path);
return unavailable("reading realm info", &e);
}
};
if transfer_ruleset != info.ruleset {
let _ = std::fs::remove_file(&path);
return err(
AppError::Incompatible,
"Transfer ruleset does not match target realm ruleset.",
);
let mut hash_bytes = [0u8; 32];
if hex::decode_to_slice(&t.content_hash, &mut hash_bytes).is_err() {
return err(AppError::Invalid, "Invalid content hash format.");
}
let Some(m) = self.mapping(player) else {
@@ -1157,7 +1083,6 @@ impl HostService {
#[cfg(any(test, feature = "testkit"))]
pub mod fake {
use super::*;
use crate::portable::Ruleset;
#[derive(Default)]
pub struct FakeRealm {
@@ -1170,7 +1095,6 @@ pub mod fake {
pub seen_passwords: Mutex<Vec<String>>,
pub imported: Mutex<HashMap<Uuid, (u32, Uuid)>>,
pub incompatible: Mutex<std::collections::HashSet<Uuid>>,
pub world_port: Mutex<Option<Result<u16>>>,
}
impl FakeRealm {
@@ -1217,7 +1141,6 @@ pub mod fake {
impl RealmBackend for FakeRealm {
fn info(&self, _: &str) -> Result<RealmInfo> {
Ok(RealmInfo {
ruleset: Ruleset::Coa,
automatic: *self.automatic.lock().unwrap(),
route: self.route.lock().unwrap().clone(),
})
@@ -1322,7 +1245,6 @@ pub mod fake {
.or_insert_with(Uuid::now_v7);
Ok(ClaimExport {
character_id: id,
ruleset: crate::portable::Ruleset::Coa,
payload: format!("payload-{guid}").into_bytes(),
sha256: [7; 32],
collections: BTreeMap::from([("coa:appearance".to_string(), vec![1, 2, 3])]),
@@ -1362,16 +1284,6 @@ pub mod fake {
notes: vec![],
})
}
fn world_port(&self, _: &str) -> Result<u16> {
if let Some(res) = self.world_port.lock().unwrap().as_ref() {
match res {
Ok(p) => Ok(*p),
Err(e) => Err(Error::Invalid(e.to_string())),
}
} else {
Ok(8085)
}
}
}
}
@@ -1512,7 +1424,7 @@ mod tests {
&Uuid::now_v7(),
"K",
Request::Hello {
protocol: coa_control_proto::CONTROL_PROTOCOL_VERSION,
protocol: 1,
client: "t".into(),
},
)
@@ -1743,7 +1655,6 @@ mod tests {
);
let Response::Claimed {
character_id,
ruleset,
sha256,
payload,
collections,
@@ -1751,7 +1662,6 @@ mod tests {
else {
panic!()
};
assert_eq!(ruleset, "coa");
assert_eq!(sha256, hex::encode([7u8; 32]));
assert!(!payload.is_empty() && collections["coa:appearance"] == vec![1, 2, 3]);
// asking again returns the same character
@@ -1947,14 +1857,6 @@ mod tests {
);
}
fn test_snapshot(cid: Uuid, ruleset: crate::portable::Ruleset) -> (Vec<u8>, String) {
let mut model = crate::portable::fixtures::geared_level_eighty();
model.character_id = crate::portable::CharacterId::from_uuid(cid).unwrap();
model.ruleset = ruleset;
let encoded = crate::portable::snapshot::encode(&model).unwrap();
(encoded.payload, hex::encode(encoded.content_hash))
}
#[test]
fn remote_transfer_lifecycle_empty_realm_import_and_ack() {
let (realm, s, p, _acc) = claimed_setup();
@@ -1962,11 +1864,12 @@ mod tests {
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
let (payload, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let payload = b"portable_character_snapshot_payload_test_data".to_vec();
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
// 1. Offer
let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
@@ -2040,7 +1943,6 @@ mod tests {
realm.incompatible.lock().unwrap().insert(cid);
let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
@@ -2071,12 +1973,15 @@ mod tests {
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
let (full, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let mid = full.len() / 2;
let (chunk1, chunk2) = full.split_at(mid);
let chunk1 = b"first_chunk_of_payload_";
let chunk2 = b"second_chunk_of_payload";
let mut full = chunk1.to_vec();
full.extend_from_slice(chunk2);
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&full));
let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
@@ -2166,10 +2071,11 @@ mod tests {
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
let (payload, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let payload = b"idempotency_test_payload".to_vec();
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
@@ -2232,7 +2138,6 @@ mod tests {
// Client starts a new transfer for the exact same committed revision: discovers committed state
let tid2 = Uuid::now_v7();
let offer2 = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid2,
character_id: cid,
canonical_revision: 1,
@@ -2264,10 +2169,11 @@ mod tests {
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
let (payload, hash) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let payload = b"player_1_character_data".to_vec();
use sha2::{Digest, Sha256};
let hash = hex::encode(Sha256::digest(&payload));
let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
@@ -2334,7 +2240,6 @@ mod tests {
let tid_impostor = Uuid::now_v7();
let impostor_offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid_impostor,
character_id: cid,
canonical_revision: 2,
@@ -2362,7 +2267,9 @@ mod tests {
let cid = Uuid::now_v7();
let tid1 = Uuid::now_v7();
let (payload1, hash1) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let payload1 = b"character_revision_1_data".to_vec();
use sha2::{Digest, Sha256};
let hash1 = hex::encode(Sha256::digest(&payload1));
// Rev 1
s.handle(
@@ -2370,7 +2277,6 @@ mod tests {
&p,
"K",
Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid1,
character_id: cid,
canonical_revision: 1,
@@ -2415,18 +2321,13 @@ mod tests {
// Rev 2
let tid2 = Uuid::now_v7();
let mut model2 = crate::portable::fixtures::geared_level_eighty();
model2.character_id = crate::portable::CharacterId::from_uuid(cid).unwrap();
model2.progression.money += 500;
let enc2 = crate::portable::snapshot::encode(&model2).unwrap();
let (payload2, hash2) = (enc2.payload, hex::encode(enc2.content_hash));
let payload2 = b"character_revision_2_newer_data".to_vec();
let hash2 = hex::encode(Sha256::digest(&payload2));
let r = s.handle(
&mut session,
&p,
"K",
Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid2,
character_id: cid,
canonical_revision: 2,
@@ -2476,190 +2377,4 @@ mod tests {
"update, not duplicate import"
);
}
#[test]
fn cross_ruleset_transfer_offers_are_rejected_before_mutation() {
let (realm, s, p, _acc) = claimed_setup();
let mut session = Session::default();
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
// 1. Host is CoA, offer is Wildcard -> Rejected
let wc_offer = Request::TransferOffer {
ruleset: "wildcard".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: "a".repeat(64),
total_size: 100,
collections: BTreeMap::new(),
};
let r = s.handle(&mut session, &p, "K", wc_offer);
assert!(matches!(
r,
Response::Error {
code: AppError::Incompatible,
..
}
));
// 2. Host is CoA, offer is Reborn -> Rejected
let rb_offer = Request::TransferOffer {
ruleset: "reborn".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: "a".repeat(64),
total_size: 100,
collections: BTreeMap::new(),
};
let r = s.handle(&mut session, &p, "K", rb_offer);
assert!(matches!(
r,
Response::Error {
code: AppError::Incompatible,
..
}
));
// 3. Collection kinds for another ruleset -> Rejected
let foreign_coll_offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: "a".repeat(64),
total_size: 100,
collections: BTreeMap::from([("wildcard:appearance".into(), vec![1, 2, 3])]),
};
let r = s.handle(&mut session, &p, "K", foreign_coll_offer);
assert!(matches!(
r,
Response::Error {
code: AppError::Incompatible,
..
}
));
// Ensure 0 DB imports happened
assert!(realm.imported.lock().unwrap().is_empty());
}
#[test]
fn tampered_payload_at_commit_aborts_with_zero_mutation() {
let (realm, s, p, _acc) = claimed_setup();
let mut session = Session::default();
let cid = Uuid::now_v7();
let tid = Uuid::now_v7();
// 1. Offer announces CoA
let (payload_coa, hash_coa) = test_snapshot(cid, crate::portable::Ruleset::Coa);
let offer = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid,
character_id: cid,
canonical_revision: 1,
content_hash: hash_coa,
total_size: payload_coa.len(),
collections: BTreeMap::new(),
};
s.handle(&mut session, &p, "K", offer);
// Attacker creates a Wildcard snapshot with the same CID, but uploads it under the CoA offer
let (payload_wc, hash_wc) = test_snapshot(cid, crate::portable::Ruleset::Wildcard);
// Uploading chunks of payload_wc will mismatch the offered hash
use base64::Engine;
let data = base64::engine::general_purpose::STANDARD.encode(&payload_wc);
s.handle(
&mut session,
&p,
"K",
Request::TransferChunk {
transfer_id: tid,
offset: 0,
data,
},
);
let commit = Request::TransferCommit { transfer_id: tid };
let r = s.handle(&mut session, &p, "K", commit);
assert!(matches!(
r,
Response::Error {
code: AppError::Invalid,
..
}
));
assert!(realm.imported.lock().unwrap().is_empty());
// 2. What if attacker offered hash_wc matching payload_wc, but offer.ruleset is "coa"?
let tid2 = Uuid::now_v7();
let offer2 = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid2,
character_id: cid,
canonical_revision: 1,
content_hash: hash_wc,
total_size: payload_wc.len(),
collections: BTreeMap::new(),
};
s.handle(&mut session, &p, "K", offer2);
let data2 = base64::engine::general_purpose::STANDARD.encode(&payload_wc);
s.handle(
&mut session,
&p,
"K",
Request::TransferChunk {
transfer_id: tid2,
offset: 0,
data: data2,
},
);
let commit2 = Request::TransferCommit { transfer_id: tid2 };
let r2 = s.handle(&mut session, &p, "K", commit2);
assert!(matches!(
r2,
Response::Error {
code: AppError::Incompatible,
..
}
));
assert!(realm.imported.lock().unwrap().is_empty());
// 3. What if snapshot contains a different character_id than offer?
let tid3 = Uuid::now_v7();
let other_cid = Uuid::now_v7();
let (payload_other, hash_other) = test_snapshot(other_cid, crate::portable::Ruleset::Coa);
let offer3 = Request::TransferOffer {
ruleset: "coa".into(),
transfer_id: tid3,
character_id: cid, // offered cid
canonical_revision: 1,
content_hash: hash_other,
total_size: payload_other.len(),
collections: BTreeMap::new(),
};
s.handle(&mut session, &p, "K", offer3);
let data3 = base64::engine::general_purpose::STANDARD.encode(&payload_other);
s.handle(
&mut session,
&p,
"K",
Request::TransferChunk {
transfer_id: tid3,
offset: 0,
data: data3,
},
);
let commit3 = Request::TransferCommit { transfer_id: tid3 };
let r3 = s.handle(&mut session, &p, "K", commit3);
assert!(matches!(
r3,
Response::Error {
code: AppError::Invalid,
..
}
));
assert!(realm.imported.lock().unwrap().is_empty());
}
}
+4 -15
View File
@@ -56,7 +56,6 @@ CREATE TABLE IF NOT EXISTS host_transfer(
realm_local_id TEXT NOT NULL,
transfer_id TEXT NOT NULL PRIMARY KEY,
character_id TEXT NOT NULL,
ruleset TEXT NOT NULL DEFAULT 'coa',
player_id TEXT NOT NULL,
revision INTEGER NOT NULL,
content_hash TEXT NOT NULL,
@@ -156,7 +155,6 @@ pub struct HostTransfer {
pub realm_local_id: String,
pub transfer_id: Uuid,
pub character_id: Uuid,
pub ruleset: String,
pub player_id: Uuid,
pub revision: u64,
pub content_hash: String,
@@ -201,10 +199,6 @@ impl ControlStore {
.map_err(db)?;
let _ = conn.pragma_update(None, "journal_mode", "WAL");
conn.execute_batch(SCHEMA).map_err(db)?;
let _ = conn.execute(
"ALTER TABLE host_transfer ADD COLUMN ruleset TEXT NOT NULL DEFAULT 'coa'",
[],
);
Ok(Self { conn })
}
@@ -313,7 +307,7 @@ impl ControlStore {
pub fn host_transfer(&self, realm: &str, transfer_id: &Uuid) -> Result<Option<HostTransfer>> {
self.conn
.query_row(
"SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, ruleset FROM host_transfer WHERE realm_local_id = ?1 AND transfer_id = ?2",
"SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections FROM host_transfer WHERE realm_local_id = ?1 AND transfer_id = ?2",
params![realm, transfer_id.to_string()],
row_transfer,
)
@@ -329,7 +323,7 @@ impl ControlStore {
) -> Result<Option<HostTransfer>> {
self.conn
.query_row(
"SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, ruleset FROM host_transfer WHERE realm_local_id = ?1 AND character_id = ?2 ORDER BY updated_at DESC LIMIT 1",
"SELECT realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections FROM host_transfer WHERE realm_local_id = ?1 AND character_id = ?2 ORDER BY updated_at DESC LIMIT 1",
params![realm, character_id.to_string()],
row_transfer,
)
@@ -343,8 +337,8 @@ impl ControlStore {
let coll_json = serde_json::to_string(&t.collections).unwrap_or_default();
self.conn
.execute(
"INSERT INTO host_transfer(realm_local_id, transfer_id, character_id, ruleset, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, created_at, updated_at)
VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16, ?17)
"INSERT INTO host_transfer(realm_local_id, transfer_id, character_id, player_id, revision, content_hash, total_size, received_size, state, local_guid, session_id, projected_level, notes, collections, created_at, updated_at)
VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9, ?10, ?11, ?12, ?13, ?14, ?15, ?16)
ON CONFLICT(transfer_id) DO UPDATE SET
received_size = excluded.received_size,
state = excluded.state,
@@ -353,13 +347,11 @@ impl ControlStore {
projected_level = excluded.projected_level,
notes = excluded.notes,
collections = excluded.collections,
ruleset = excluded.ruleset,
updated_at = excluded.updated_at",
params![
t.realm_local_id,
t.transfer_id.to_string(),
t.character_id.to_string(),
t.ruleset,
t.player_id.to_string(),
t.revision as i64,
t.content_hash,
@@ -548,13 +540,11 @@ fn row_transfer(r: &rusqlite::Row<'_>) -> rusqlite::Result<Result<HostTransfer>>
let collections = coll_str
.and_then(|s| serde_json::from_str::<BTreeMap<String, Vec<u32>>>(&s).ok())
.unwrap_or_default();
let ruleset: String = r.get(14).unwrap_or_else(|_| "coa".to_string());
Ok((|| {
Ok(HostTransfer {
realm_local_id,
transfer_id: uuid(tid)?,
character_id: uuid(cid)?,
ruleset,
player_id: uuid(pid)?,
revision: revision as u64,
content_hash,
@@ -687,7 +677,6 @@ mod tests {
realm_local_id: "live".into(),
transfer_id: t,
character_id: c,
ruleset: "coa".into(),
player_id: p,
revision: 3,
content_hash: "a".repeat(64),
+3 -2
View File
@@ -206,9 +206,10 @@ fn patch_files(client: &Path) -> Result<Vec<PatchFile>> {
));
}
Some(name.to_string())
} else if let Some(name) = line.strip_prefix("ADDON:") {
Some(format!("Interface/AddOns/{name}"))
} else {
line.strip_prefix("ADDON:")
.map(|name| format!("Interface/AddOns/{name}"))
None
};
if let Some(path) = path {
fsx::safe_join(client, &path)?;
+170 -44
View File
@@ -5,9 +5,10 @@
use std::fmt;
use std::fs::File;
use std::io::{BufReader, BufWriter, Read, Write};
use std::io::{BufReader, BufWriter, Read, Seek, SeekFrom, Write};
use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};
use std::time::{Duration, Instant};
use serde::Deserialize;
@@ -48,6 +49,7 @@ pub struct Db {
realm: crate::realms::Mode,
/// Name of the database container of a Docker installation; the client tools then run inside it.
container: Option<String>,
read_deadline: Option<Instant>,
}
#[derive(Deserialize)]
@@ -67,6 +69,42 @@ fn no_window(cmd: &mut Command) {
let _ = cmd;
}
fn bounded_client_output(command: &mut Command, input: &[u8], deadline: Instant) -> Result<std::process::Output> {
let timeout = || Error::Invalid("The database inspection timed out. The Manager stopped its client process; the database server was not stopped. Retry the operation or export diagnostics if this continues.".into());
if Instant::now() >= deadline {
return Err(timeout());
}
let mut stdin = tempfile::tempfile()?;
stdin.write_all(input)?;
stdin.seek(SeekFrom::Start(0))?;
let mut stdout = tempfile::tempfile()?;
let mut stderr = tempfile::tempfile()?;
command.stdin(stdin).stdout(stdout.try_clone()?).stderr(stderr.try_clone()?);
let mut child = command.spawn()?;
let status = loop {
match child.try_wait() {
Ok(Some(status)) => break status,
Ok(None) if Instant::now() < deadline => std::thread::sleep(Duration::from_millis(25)),
result => {
child.kill().map_err(|error| Error::Invalid(format!(
"The database inspection timed out, but its client could not be stopped: {error}"
)))?;
let _ = child.wait();
return match result {
Err(error) => Err(error.into()),
_ => Err(timeout()),
};
}
}
};
stdout.seek(SeekFrom::Start(0))?;
stderr.seek(SeekFrom::Start(0))?;
let mut output = std::process::Output { status, stdout: Vec::new(), stderr: Vec::new() };
stdout.read_to_end(&mut output.stdout)?;
stderr.read_to_end(&mut output.stderr)?;
Ok(output)
}
/// Schema names of the three game databases.
pub const SCHEMAS: [(&str, &str); 3] = [
("characters", "acore_characters"),
@@ -75,23 +113,11 @@ pub const SCHEMAS: [(&str, &str); 3] = [
];
pub fn schema_of(kind: &str) -> Result<&'static str> {
if kind == "playerbots" {
return Ok("acore_playerbots");
}
if let Some(kind) = kind.strip_prefix("wildcard-") {
return crate::realms::Mode::Wildcard.schema(kind);
}
if let Some(kind) = kind.strip_prefix("reborn-") {
return crate::realms::Mode::Reborn.schema(kind);
}
if let Some(kind) = kind.strip_prefix("coa-") {
return crate::realms::Mode::Coa.schema(kind);
}
SCHEMAS
.iter()
.find(|(k, _)| *k == kind)
.map(|(_, s)| *s)
.ok_or_else(|| Error::Invalid(format!("unknown database {kind}")))
if kind == "playerbots" { return Ok("acore_playerbots"); }
if let Some(kind) = kind.strip_prefix("wildcard-") { return crate::realms::Mode::Wildcard.schema(kind); }
if let Some(kind) = kind.strip_prefix("reborn-") { return crate::realms::Mode::Reborn.schema(kind); }
if let Some(kind) = kind.strip_prefix("coa-") { return crate::realms::Mode::Coa.schema(kind); }
SCHEMAS.iter().find(|(k, _)| *k == kind).map(|(_, s)| *s).ok_or_else(|| Error::Invalid(format!("unknown database {kind}")))
}
fn ident_ok(name: &str) -> bool {
@@ -135,6 +161,7 @@ impl Db {
password: Secret(password),
realm: crate::realms::state(root)?.active,
container: None,
read_deadline: None,
})
}
@@ -155,6 +182,7 @@ impl Db {
password: Secret(password),
realm: crate::realms::state(root)?.active,
container: Some(container),
read_deadline: None,
})
}
@@ -174,6 +202,7 @@ impl Db {
password: Secret(password.to_string()),
realm,
container: None,
read_deadline: None,
}
}
@@ -292,7 +321,13 @@ impl Db {
pub fn ping(&self) -> bool {
let mut c = self.command("mysqladmin.exe");
c.arg("ping").arg("--connect-timeout=3");
c.output().map(|o| o.status.success()).unwrap_or(false)
bounded_client_output(&mut c, b"", Instant::now() + Duration::from_secs(5))
.map(|o| o.status.success()).unwrap_or(false)
}
pub(crate) fn with_read_deadline(mut self, deadline: Instant) -> Self {
self.read_deadline = Some(deadline);
self
}
/// Run SQL text (statement(s) supplied on stdin) and return the raw output.
@@ -303,6 +338,13 @@ impl Db {
"--default-character-set=utf8mb4",
"--max-allowed-packet=128M",
]);
if let Some(deadline) = self.read_deadline {
let out = bounded_client_output(&mut c, route_sql(sql, self.realm).as_bytes(), deadline)?;
if !out.status.success() {
return Err(self.fail(&out.stderr));
}
return Ok(String::from_utf8_lossy(&out.stdout).trim().to_string());
}
c.stdin(Stdio::piped());
let mut child = c.spawn()?;
child
@@ -369,11 +411,9 @@ impl Db {
pub fn recovery_objects(&self, schema: &str) -> Result<Vec<serde_json::Value>> {
let schema = self.realm_schema(schema);
if !ident_ok(schema) {
return Err(Error::Invalid("bad schema name".into()));
}
if !ident_ok(schema) { return Err(Error::Invalid("bad schema name".into())); }
let sql = format!("SELECT routine_type,HEX(routine_name) FROM information_schema.routines WHERE routine_schema='{schema}' UNION ALL SELECT 'TRIGGER',HEX(trigger_name) FROM information_schema.triggers WHERE trigger_schema='{schema}' UNION ALL SELECT 'VIEW',HEX(table_name) FROM information_schema.views WHERE table_schema='{schema}' ORDER BY 1,2;");
parse_recovery_objects(schema, &self.query(&sql)?)
parse_recovery_objects(&schema, &self.query(&sql)?)
}
/// Consistent dump of one schema, zstd-compressed to `out`. Returns (compressed bytes, sha256 of the file).
@@ -483,23 +523,15 @@ impl Db {
}
fn parse_recovery_objects(schema: &str, text: &str) -> Result<Vec<serde_json::Value>> {
text.lines()
.filter(|line| !line.is_empty())
.map(|line| {
let (kind, name) = line
.split_once('\t')
.ok_or_else(|| Error::Invalid("unexpected database object reply".into()))?;
if !matches!(kind, "PROCEDURE" | "FUNCTION" | "TRIGGER" | "VIEW") {
return Err(Error::Invalid("unexpected database object type".into()));
}
let name = hex::decode(name)
.ok()
.and_then(|bytes| String::from_utf8(bytes).ok())
.filter(|name| !name.is_empty())
.ok_or_else(|| Error::Invalid("unexpected database object name".into()))?;
Ok(serde_json::json!({ "database": schema, "kind": kind, "name": name }))
})
.collect()
text.lines().filter(|line| !line.is_empty()).map(|line| {
let (kind, name) = line.split_once('\t').ok_or_else(|| Error::Invalid("unexpected database object reply".into()))?;
if !matches!(kind, "PROCEDURE" | "FUNCTION" | "TRIGGER" | "VIEW") {
return Err(Error::Invalid("unexpected database object type".into()));
}
let name = hex::decode(name).ok().and_then(|bytes| String::from_utf8(bytes).ok())
.filter(|name| !name.is_empty()).ok_or_else(|| Error::Invalid("unexpected database object name".into()))?;
Ok(serde_json::json!({ "database": schema, "kind": kind, "name": name }))
}).collect()
}
/// Name of the service account the Manager uses for the server console (RA). Accounts are stored upper-case.
@@ -604,15 +636,109 @@ mod realm_tests {
#[cfg(test)]
mod tests {
fn client_fixture(mode: &str) -> std::process::Command {
let mut command = std::process::Command::new(std::env::current_exe().unwrap());
command.args(["--exact", "db::tests::bounded_client_fixture", "--nocapture"])
.env("COA_DATABASE_CLIENT_TEST", mode);
super::no_window(&mut command);
command
}
#[test]
fn bounded_client_fixture() {
match std::env::var("COA_DATABASE_CLIENT_TEST").as_deref() {
Ok("hang") => std::thread::sleep(std::time::Duration::from_secs(60)),
Ok("output") => {
use std::io::{Read, Write};
let mut input = Vec::new();
std::io::stdin().read_to_end(&mut input).unwrap();
std::io::stdout().write_all(&input).unwrap();
std::io::stderr().write_all(&vec![b'e'; 256 * 1024]).unwrap();
}
Ok("fail") => std::process::exit(17),
_ => (),
}
}
#[test]
fn bounded_client_captures_large_output_without_pipe_deadlock() {
let data = vec![b'x'; 256 * 1024];
let out = super::bounded_client_output(&mut client_fixture("output"), &data,
std::time::Instant::now() + std::time::Duration::from_secs(10)).unwrap();
assert!(out.status.success());
assert!(out.stdout.windows(data.len()).any(|part| part == data));
assert_eq!(out.stderr, vec![b'e'; 256 * 1024]);
let out = super::bounded_client_output(&mut client_fixture("fail"), b"",
std::time::Instant::now() + std::time::Duration::from_secs(10)).unwrap();
assert_eq!(out.status.code(), Some(17));
}
#[test]
fn bounded_client_timeout_releases_the_update_operation_lock() {
let folder = tempfile::tempdir().unwrap();
let start = std::time::Instant::now();
let result = (|| {
let _lock = crate::update::operation_lock_for(folder.path(), "checking updates", false)?;
super::bounded_client_output(&mut client_fixture("hang"), b"",
start + std::time::Duration::from_millis(250))
})();
assert!(result.unwrap_err().to_string().contains("inspection timed out"));
assert!(start.elapsed() < std::time::Duration::from_secs(5));
crate::update::operation_lock(folder.path()).unwrap();
}
#[cfg(windows)]
#[test]
#[ignore = "requires COA_MYSQL_TEST_BIN; starts a disposable MySQL server"]
fn real_mysql_inspection_timeout_preserves_server_and_releases_lock() {
use std::os::windows::process::CommandExt;
struct Server(std::process::Child);
impl Drop for Server {
fn drop(&mut self) {
let _ = self.0.kill();
let _ = self.0.wait();
}
}
let bin = std::path::PathBuf::from(std::env::var("COA_MYSQL_TEST_BIN").unwrap());
let folder = tempfile::tempdir().unwrap();
let data = folder.path().join("data");
let initialized = std::process::Command::new(bin.join("mysqld.exe"))
.args(["--no-defaults", "--initialize-insecure"])
.arg(format!("--datadir={}", data.display()))
.creation_flags(0x0800_0000).output().unwrap();
assert!(initialized.status.success(), "{}", String::from_utf8_lossy(&initialized.stderr));
let socket = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
let port = socket.local_addr().unwrap().port();
drop(socket);
let mut server = Server(std::process::Command::new(bin.join("mysqld.exe"))
.args(["--no-defaults", "--bind-address=127.0.0.1", "--mysqlx=0", "--skip-log-bin"])
.arg(format!("--datadir={}", data.display())).arg(format!("--port={port}"))
.arg(format!("--log-error={}", folder.path().join("mysql.log").display()))
.stdout(std::process::Stdio::null()).stderr(std::process::Stdio::null())
.creation_flags(0x0800_0000).spawn().unwrap());
let db = super::Db::with_tools(bin, port, "root", "", crate::realms::Mode::Coa);
let ready = std::time::Instant::now() + std::time::Duration::from_secs(30);
while !db.ping() {
assert!(std::time::Instant::now() < ready);
std::thread::sleep(std::time::Duration::from_millis(100));
}
let result = (|| {
let _lock = crate::update::operation_lock_for(folder.path(), "checking updates", false)?;
db.clone().with_read_deadline(std::time::Instant::now() + std::time::Duration::from_millis(500))
.query("SELECT SLEEP(60);")
})();
assert!(result.unwrap_err().to_string().contains("inspection timed out"));
assert!(server.0.try_wait().unwrap().is_none());
assert_eq!(db.query("SELECT 42;").unwrap(), "42");
crate::update::operation_lock(folder.path()).unwrap();
}
#[test]
fn reborn_sql_routes_only_database_identifiers() {
use crate::realms::Mode;
let sql = "SELECT * FROM `acore_characters`.characters WHERE name='acore_world'; -- acore_world\nSELECT * FROM acore_world.items; SELECT * FROM acore_world_wildcard.items;";
assert_eq!(super::route_sql(sql, Mode::Reborn), "SELECT * FROM `acore_characters_reborn`.characters WHERE name='acore_world'; -- acore_world\nSELECT * FROM acore_world_reborn.items; SELECT * FROM acore_world_wildcard.items;");
assert_eq!(
super::schema_of("reborn-characters").unwrap(),
"acore_characters_reborn"
);
assert_eq!(super::schema_of("reborn-characters").unwrap(), "acore_characters_reborn");
assert_eq!(super::schema_of("reborn-auth").unwrap(), "acore_auth");
}
use super::*;
+1 -10
View File
@@ -96,9 +96,6 @@ pub fn run(root: &Path, meta: &InstallMeta) -> Report {
if let Some(second) = &o.secondary_world {
services.push(("Second world", second));
}
if let Some(reborn) = &o.reborn_world {
services.push(("Warcraft Reborn world", reborn));
}
for (title, s) in services {
let (lvl, text) = match (s.state, &s.conflict) {
(ServiceState::Running, _) => (Level::Ok, "Running".to_string()),
@@ -642,7 +639,6 @@ fn processes_report(root: &Path, ports: &layout::Ports) -> String {
Some(&o.auth),
Some(&o.world),
o.secondary_world.as_ref(),
o.reborn_world.as_ref(),
]
.into_iter()
.flatten()
@@ -1049,12 +1045,7 @@ real error
fn stop_diagnostics_survive_while_portable_pins_remain_hidden() {
let ordinary = "MySQL is still stopping; wait before copying the repack.";
assert_eq!(redact(ordinary), ordinary);
for secret in [
"PIN: 123456",
"pin=123456",
"transfer_pin=123456",
"PIN123456",
] {
for secret in ["PIN: 123456", "pin=123456", "transfer_pin=123456", "PIN123456"] {
let output = redact(&format!("{ordinary}\n{secret}"));
assert!(output.contains(ordinary));
assert!(!output.contains("123456"));
+5 -23
View File
@@ -758,7 +758,6 @@ pub fn observe_with(d: &dyn Docker, root: &Path, ports: &Ports) -> Observed {
auth: unknown("auth", ports.auth),
world: unknown("world", ports.world),
secondary_world: None,
reborn_world: None,
};
};
let n = cfg.names();
@@ -768,7 +767,6 @@ pub fn observe_with(d: &dyn Docker, root: &Path, ports: &Ports) -> Observed {
auth: unknown("auth", ports.auth),
world: unknown("world", ports.world),
secondary_world: None,
reborn_world: None,
};
};
let ip = connect_ip(&cfg);
@@ -797,7 +795,6 @@ pub fn observe_with(d: &dyn Docker, root: &Path, ports: &Ports) -> Observed {
listening(state.get(&n.world), ports.world),
),
secondary_world: None,
reborn_world: None,
}
}
@@ -1252,27 +1249,12 @@ mod tests {
"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"
);
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");
let reborn = database_env(&s, true, crate::realms::Mode::Reborn);
assert_eq!(
get(&reborn, "AC_WORLD_DATABASE_INFO").unwrap(),
"db;3306;acore;apppw;acore_world_reborn"
);
assert_eq!(
get(&reborn, "AC_CHARACTER_DATABASE_INFO").unwrap(),
"db;3306;acore;apppw;acore_characters_reborn"
);
assert_eq!(
get(&reborn, "AC_LOGIN_DATABASE_INFO").unwrap(),
"db;3306;acore;apppw;acore_auth"
);
assert_eq!(get(&reborn, "AC_WORLD_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_world_reborn");
assert_eq!(get(&reborn, "AC_CHARACTER_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_characters_reborn");
assert_eq!(get(&reborn, "AC_LOGIN_DATABASE_INFO").unwrap(), "db;3306;acore;apppw;acore_auth");
// Accounts are shared by both realms; the auth server never sees the others.
assert_eq!(
get(&wild, "AC_LOGIN_DATABASE_INFO").unwrap(),
+6 -30
View File
@@ -12,28 +12,16 @@ pub fn database_log(root: &Path, filter: Option<&str>, max_lines: usize) -> Resu
database_log_with(&SystemDocker, root, filter, max_lines)
}
pub fn database_log_with(
d: &dyn Docker,
root: &Path,
filter: Option<&str>,
max_lines: usize,
) -> Result<Vec<Line>> {
pub fn database_log_with(d: &dyn Docker, root: &Path, filter: Option<&str>, max_lines: usize) -> Result<Vec<Line>> {
let name = Config::load(root)?.names().db;
// Ask for more than wanted: the filter may drop most of them.
let tail = (max_lines * 4).clamp(200, 8000).to_string();
let out = d.run(&Call::new(
&["logs", "--tail", &tail, &name],
Duration::from_secs(20),
))?;
let out = d.run(&Call::new(&["logs", "--tail", &tail, &name], Duration::from_secs(20)))?;
if !out.ok() {
return Err(Error::Invalid("This log does not exist yet.".into()));
}
// MySQL writes to the error stream.
Ok(crate::console::lines_from_text(
&format!("{}\n{}", out.stderr, out.stdout),
filter,
max_lines,
))
Ok(crate::console::lines_from_text(&format!("{}\n{}", out.stderr, out.stdout), filter, max_lines))
}
#[cfg(test)]
@@ -70,9 +58,7 @@ mod tests {
assert_eq!(fake.calls.borrow()[0][..2], ["logs", "--tail"]);
assert_eq!(fake.calls.borrow()[0].last().unwrap(), "coa-t1-db");
assert_eq!(lines.len(), 3);
assert!(lines
.iter()
.any(|l| l.text.contains("boom") && l.level == crate::console::Level::Error));
assert!(lines.iter().any(|l| l.text.contains("boom") && l.level == crate::console::Level::Error));
let only = database_log_with(&fake, &root, Some("slow"), 100).unwrap();
assert_eq!(only.len(), 1);
}
@@ -80,17 +66,7 @@ mod tests {
#[test]
fn a_database_that_never_ran_has_no_log_yet() {
let (_d, root) = root();
let fake = Fake {
out: Output {
code: Some(1),
stdout: String::new(),
stderr: "Error: No such container: coa-t1-db".into(),
},
calls: Default::default(),
};
assert!(database_log_with(&fake, &root, None, 10)
.unwrap_err()
.to_string()
.contains("does not exist yet"));
let fake = Fake { out: Output { code: Some(1), stdout: String::new(), stderr: "Error: No such container: coa-t1-db".into() }, calls: Default::default() };
assert!(database_log_with(&fake, &root, None, 10).unwrap_err().to_string().contains("does not exist yet"));
}
}
+14 -72
View File
@@ -18,10 +18,7 @@ use crate::net::Exposure;
use crate::process::{ServiceState, ServiceStatus};
fn is_open(cfg: &Config) -> bool {
cfg.bind_address
.parse::<IpAddr>()
.map(|ip| !ip.is_loopback())
.unwrap_or(false)
cfg.bind_address.parse::<IpAddr>().map(|ip| !ip.is_loopback()).unwrap_or(false)
}
/// Whether the login and world servers are published beyond this computer.
@@ -49,11 +46,7 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
if let Ok(bytes) = fs::read(&coa_conf) {
let mut conf = ConfFile::parse_bytes(&bytes)?;
if conf.get("CoA.AllowRemoteClients").map(str::trim) != Some("1") {
conf.set(
"CoA.AllowRemoteClients",
"1",
&["Set by CoA Server Manager together with the friends mode"],
);
conf.set("CoA.AllowRemoteClients", "1", &["Set by CoA Server Manager together with the friends mode"]);
originals.push((coa_conf.clone(), bytes));
coa_edit = Some(conf.to_text());
}
@@ -62,16 +55,7 @@ pub fn set_open(root: &Path, meta: &Path, open: bool) -> Result<bool> {
if !changed && coa_edit.is_none() {
return Ok(false);
}
take_snapshot(
meta,
Scope::Server,
if open {
"before opening the servers to friends"
} else {
"before closing the servers to friends"
},
&originals,
)?;
take_snapshot(meta, Scope::Server, if open { "before opening the servers to friends" } else { "before closing the servers to friends" }, &originals)?;
if changed {
fsx::atomic_write_json(&root.join(MARKER), &cfg)?;
}
@@ -89,30 +73,10 @@ pub fn exposure(root: &Path, ports: &Ports) -> Vec<Exposure> {
let observed = crate::process::observe(root, ports);
let up = |s: &ServiceStatus| matches!(s.state, ServiceState::Running | ServiceState::Starting);
vec![
Exposure {
port: ports.mysql,
what: "database",
listening: up(&observed.mysql),
reachable_from_network: false,
},
Exposure {
port: ports.ra,
what: "server console",
listening: up(&observed.world),
reachable_from_network: false,
},
Exposure {
port: ports.auth,
what: "login server",
listening: up(&observed.auth),
reachable_from_network: open && up(&observed.auth),
},
Exposure {
port: ports.world,
what: "game world",
listening: up(&observed.world),
reachable_from_network: open && up(&observed.world),
},
Exposure { port: ports.mysql, what: "database", listening: up(&observed.mysql), reachable_from_network: false },
Exposure { port: ports.ra, what: "server console", listening: up(&observed.world), reachable_from_network: false },
Exposure { port: ports.auth, what: "login server", listening: up(&observed.auth), reachable_from_network: open && up(&observed.auth) },
Exposure { port: ports.world, what: "game world", listening: up(&observed.world), reachable_from_network: open && up(&observed.world) },
]
}
@@ -127,15 +91,9 @@ mod tests {
fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(root.join("Core/configs/modules")).unwrap();
fs::create_dir_all(&meta).unwrap();
let extra = bind
.map(|b| format!(r#","bindAddress":"{b}""#))
.unwrap_or_default();
let extra = bind.map(|b| format!(r#","bindAddress":"{b}""#)).unwrap_or_default();
fs::write(root.join(MARKER), format!(r#"{{"project":"t1"{extra}}}"#)).unwrap();
fs::write(
root.join("Core/configs/modules/coa.conf"),
"CoA.Enable = 1\n",
)
.unwrap();
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\n").unwrap();
(d, root, meta)
}
@@ -146,15 +104,8 @@ mod tests {
assert!(set_open(&root, &meta, true).unwrap(), "a restart is needed");
assert!(bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(
fs::read_to_string(root.join("Core/configs/modules/coa.conf"))
.unwrap()
.contains("CoA.AllowRemoteClients = 1")
);
assert!(
!set_open(&root, &meta, true).unwrap(),
"nothing left to change"
);
assert!(fs::read_to_string(root.join("Core/configs/modules/coa.conf")).unwrap().contains("CoA.AllowRemoteClients = 1"));
assert!(!set_open(&root, &meta, true).unwrap(), "nothing left to change");
assert!(set_open(&root, &meta, false).unwrap());
assert!(!bind_is_open(&root));
assert_eq!(Config::load(&root).unwrap().bind_address, "127.0.0.1");
@@ -163,11 +114,7 @@ mod tests {
#[test]
fn enabling_remote_client_protocol_requires_restart_even_when_ports_are_open() {
let (_d, root, meta) = server(Some("0.0.0.0"));
fs::write(
root.join("Core/configs/modules/coa.conf"),
"CoA.Enable = 1\nCoA.AllowRemoteClients = 0\n",
)
.unwrap();
fs::write(root.join("Core/configs/modules/coa.conf"), "CoA.Enable = 1\nCoA.AllowRemoteClients = 0\n").unwrap();
assert!(set_open(&root, &meta, true).unwrap());
assert_eq!(Config::load(&root).unwrap().bind_address, "0.0.0.0");
assert!(!set_open(&root, &meta, true).unwrap());
@@ -176,10 +123,7 @@ mod tests {
#[test]
fn an_address_chosen_by_hand_is_kept_when_opening_and_other_settings_survive() {
let (_d, root, meta) = server(Some("192.168.1.20"));
assert!(
bind_is_open(&root),
"any address but the loopback is the network"
);
assert!(bind_is_open(&root), "any address but the loopback is the network");
set_open(&root, &meta, true).unwrap();
let cfg = Config::load(&root).unwrap();
assert_eq!(cfg.bind_address, "192.168.1.20");
@@ -198,9 +142,7 @@ mod tests {
let (_d, root, _meta) = server(Some("0.0.0.0"));
let rows = exposure(&root, &Ports::default());
let by = |what: &str| rows.iter().find(|e| e.what == what).unwrap();
assert!(
!by("database").reachable_from_network && !by("server console").reachable_from_network
);
assert!(!by("database").reachable_from_network && !by("server console").reachable_from_network);
// Nothing runs in this test (docker is not asked to start anything), so nothing is reachable yet.
assert!(rows.iter().all(|e| !e.reachable_from_network));
}
+1 -1
View File
@@ -254,7 +254,7 @@ fn run_inner(root: &Path, verb: Verb, validating_update: bool) -> Result<DriverO
let observed = crate::process::observe(&root, &crate::layout::read_ports(&root));
for service in [&observed.mysql, &observed.auth, &observed.world]
.into_iter()
.chain(observed.extra_worlds())
.chain(observed.secondary_world.iter())
{
if let Some(conflict) = &service.conflict {
output.push_str(&format!(
+6 -10
View File
@@ -88,27 +88,23 @@ fn run_elevated(commands: &[String]) -> Result<()> {
/// Make sure both rules exist (adds only the missing ones) and confirm afterwards.
pub fn ensure_rules(ports: &Ports) -> Result<Status> {
ensure_rules_with_extra(ports, &[])
ensure_rules_with_secondary(ports, None)
}
/// As `ensure_rules`, plus one rule for the world port of each extra realm that runs next to the main one.
pub fn ensure_rules_with_extra(ports: &Ports, extra: &[u16]) -> Result<Status> {
pub fn ensure_rules_with_secondary(ports: &Ports, secondary: Option<u16>) -> Result<Status> {
let have = status();
let mut cmds = plan(ports, &have);
let extra_names: Vec<String> = extra
.iter()
.map(|port| format!("CoA Server Manager - Second World {port}"))
.collect();
for (port, name) in extra.iter().zip(&extra_names) {
let second_name = secondary.map(|port| format!("CoA Server Manager - Second World {port}"));
if let (Some(port), Some(name)) = (secondary, &second_name) {
if !rule_exists(name) {
cmds.push(add_cmd(name, *port));
cmds.push(add_cmd(name, port));
}
}
if !cmds.is_empty() {
run_elevated(&cmds)?;
}
let now = status();
if now.auth && now.world && extra_names.iter().all(|name| rule_exists(name)) {
if now.auth && now.world && second_name.as_ref().is_none_or(|name| rule_exists(name)) {
Ok(now)
} else {
Err(Error::Invalid(
+6 -10
View File
@@ -168,16 +168,12 @@ pub fn apply_realm_address(root: &Path, host: &str) -> Result<()> {
return Err(Error::Invalid("That address is not valid.".into()));
}
let db = Db::from_repack(root, Account::Admin)?;
let state = crate::realms::state(root)?;
let mut ids = vec![state.active];
ids.extend(state.extra_modes());
let where_realms = format!(
"id IN ({})",
ids.iter()
.map(|m| m.realm_id().to_string())
.collect::<Vec<_>>()
.join(",")
);
let realm = crate::realms::state(root)?.active.realm_id();
let where_realms = if crate::realms::state(root)?.simultaneous {
"id IN (1,2)".into()
} else {
format!("id={realm}")
};
db.query(&format!(
"UPDATE acore_auth.realmlist SET address='{host}' WHERE {where_realms};"
))?;
+7 -30
View File
@@ -36,12 +36,7 @@ fn key(path: &Path) -> Vec<String> {
return format!("{}:", char::from(drive).to_ascii_lowercase());
}
Prefix::UNC(server, share) | Prefix::VerbatimUNC(server, share) => {
return format!(
"\\\\{}\\{}",
server.to_string_lossy(),
share.to_string_lossy()
)
.to_lowercase();
return format!("\\\\{}\\{}", server.to_string_lossy(), share.to_string_lossy()).to_lowercase();
}
_ => {}
}
@@ -342,30 +337,12 @@ mod tests {
#[cfg(windows)]
#[test]
fn containment_matches_verbatim_drive_and_unc_prefixes() {
assert!(starts_with_ci(
Path::new(r"\\?\C:\server\Extras\file.sql"),
Path::new(r"C:\server")
));
assert!(starts_with_ci(
Path::new(r"C:\server\Extras\file.sql"),
Path::new(r"\\?\c:\server")
));
assert!(starts_with_ci(
Path::new(r"\\?\UNC\host\share\server\file.sql"),
Path::new(r"\\host\share\server")
));
assert!(!starts_with_ci(
Path::new(r"\\?\D:\server\file.sql"),
Path::new(r"C:\server")
));
assert!(!starts_with_ci(
Path::new(r"\\?\C:\server-other\file.sql"),
Path::new(r"C:\server")
));
assert!(!starts_with_ci(
Path::new(r"\\?\UNC\host\other\server\file.sql"),
Path::new(r"\\host\share\server")
));
assert!(starts_with_ci(Path::new(r"\\?\C:\server\Extras\file.sql"), Path::new(r"C:\server")));
assert!(starts_with_ci(Path::new(r"C:\server\Extras\file.sql"), Path::new(r"\\?\c:\server")));
assert!(starts_with_ci(Path::new(r"\\?\UNC\host\share\server\file.sql"), Path::new(r"\\host\share\server")));
assert!(!starts_with_ci(Path::new(r"\\?\D:\server\file.sql"), Path::new(r"C:\server")));
assert!(!starts_with_ci(Path::new(r"\\?\C:\server-other\file.sql"), Path::new(r"C:\server")));
assert!(!starts_with_ci(Path::new(r"\\?\UNC\host\other\server\file.sql"), Path::new(r"\\host\share\server")));
}
#[cfg(windows)]
+1 -3
View File
@@ -9,11 +9,11 @@
pub mod accounts;
pub mod allsettings;
pub mod analyzer;
pub mod backup;
pub mod channels;
pub mod cleanbase;
pub mod client;
pub mod clientdl;
pub mod companions;
pub mod config;
pub mod console;
@@ -44,11 +44,9 @@ pub mod net;
pub mod package;
pub mod pkgsource;
pub mod platform;
pub mod plugins;
pub mod population;
pub mod portable;
pub mod process;
pub mod provenance;
pub mod ra;
pub mod realm_registry;
pub mod realmlist;
+25 -82
View File
@@ -165,38 +165,21 @@ impl Manifest {
}
if let Some(c) = &self.compatibility {
if parse_version(&self.min_manager_version).is_none_or(|v| v < (0, 6, 13)) {
return bad(
"Release compatibility matrices require Manager 0.6.13 or newer".into(),
);
return bad("Release compatibility matrices require Manager 0.6.13 or newer".into());
}
if c.schema != 1
|| !matches!(c.platform.as_str(), "windows-x86_64" | "linux-x86_64")
|| !is_commit(&c.core_commit)
|| self.core.commit.as_deref() != Some(&c.core_commit)
|| c.module_commits.is_empty()
|| c.module_commits.values().any(|sha| !is_commit(sha))
|| self
.bots
.as_ref()
.and_then(|r| r.commit.as_ref())
.is_some_and(|sha| c.module_commits.get("bots") != Some(sha))
if c.schema != 1 || !matches!(c.platform.as_str(), "windows-x86_64" | "linux-x86_64")
|| !is_commit(&c.core_commit) || self.core.commit.as_deref() != Some(&c.core_commit)
|| c.module_commits.is_empty() || c.module_commits.values().any(|sha| !is_commit(sha))
|| self.bots.as_ref().and_then(|r| r.commit.as_ref()).is_some_and(|sha| c.module_commits.get("bots") != Some(sha))
|| parse_version(&c.client_patch_version).is_none()
|| c.source_versions.is_empty()
|| c.source_versions.iter().any(|v| parse_version(v).is_none())
|| c.source_versions.iter().collect::<HashSet<_>>().len() != c.source_versions.len()
{
|| c.source_versions.is_empty() || c.source_versions.iter().any(|v| parse_version(v).is_none())
|| c.source_versions.iter().collect::<HashSet<_>>().len() != c.source_versions.len() {
return bad("Invalid release compatibility matrix".into());
}
if !c.source_databases.is_empty()
&& (c.source_databases.len() != c.source_versions.len()
|| c.source_versions
.iter()
.any(|v| !c.source_databases.contains_key(v))
|| c.source_databases.values().any(|s| {
!is_sha256(&s.manifest_sha256)
|| s.schema_sha256.as_ref().is_some_and(|sha| !is_sha256(sha))
}))
{
if !c.source_databases.is_empty() && (c.source_databases.len() != c.source_versions.len()
|| c.source_versions.iter().any(|v| !c.source_databases.contains_key(v))
|| c.source_databases.values().any(|s| !is_sha256(&s.manifest_sha256)
|| s.schema_sha256.as_ref().is_some_and(|sha| !is_sha256(sha)))) {
return bad("Invalid source database compatibility".into());
}
}
@@ -325,15 +308,9 @@ mod tests {
fn compatibility_matrix_binds_core_and_requires_tested_sources() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into();
m.compatibility = Some(Compatibility {
schema: 1,
platform: "windows-x86_64".into(),
core_commit: "a".repeat(40),
module_commits: [("squid".into(), "b".repeat(40))].into(),
source_databases: Default::default(),
client_patch_version: "1.5.1".into(),
source_versions: vec!["0.261010.32".into()],
});
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.261010.32".into()] });
m.validate().unwrap();
m.compatibility.as_mut().unwrap().core_commit = "c".repeat(40);
assert!(m.validate().is_err());
@@ -346,30 +323,14 @@ mod tests {
fn compatibility_cannot_claim_a_different_packaged_bot_revision() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into();
m.bots = Some(Revision {
commit: Some("b".repeat(40)),
});
m.compatibility = Some(Compatibility {
schema: 1,
platform: "windows-x86_64".into(),
core_commit: "a".repeat(40),
module_commits: [("bots".into(), "c".repeat(40))].into(),
source_databases: Default::default(),
client_patch_version: "1.5.1".into(),
source_versions: vec!["0.2.0".into()],
});
m.bots = Some(Revision { commit: Some("b".repeat(40)) });
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
core_commit: "a".repeat(40), module_commits: [("bots".into(), "c".repeat(40))].into(),
source_databases: Default::default(), client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()] });
assert!(m.validate().is_err());
m.compatibility
.as_mut()
.unwrap()
.module_commits
.insert("bots".into(), "b".repeat(40));
m.compatibility.as_mut().unwrap().module_commits.insert("bots".into(), "b".repeat(40));
m.validate().unwrap();
m.compatibility
.as_mut()
.unwrap()
.source_versions
.push("0.2.0".into());
m.compatibility.as_mut().unwrap().source_versions.push("0.2.0".into());
assert!(m.validate().is_err());
}
@@ -377,30 +338,12 @@ mod tests {
fn source_database_contracts_must_cover_the_exact_upgrade_versions() {
let mut m = Manifest::parse(sample("").as_bytes()).unwrap();
m.min_manager_version = "0.6.13".into();
m.compatibility = Some(Compatibility {
schema: 1,
platform: "windows-x86_64".into(),
core_commit: "a".repeat(40),
module_commits: [("squid".into(), "b".repeat(40))].into(),
client_patch_version: "1.5.1".into(),
source_versions: vec!["0.2.0".into()],
source_databases: [(
"0.2.0".into(),
SourceDatabase {
manifest_sha256: "a".repeat(64),
schema_sha256: None,
},
)]
.into(),
});
m.compatibility = Some(Compatibility { schema: 1, platform: "windows-x86_64".into(),
core_commit: "a".repeat(40), module_commits: [("squid".into(), "b".repeat(40))].into(),
client_patch_version: "1.5.1".into(), source_versions: vec!["0.2.0".into()],
source_databases: [("0.2.0".into(), SourceDatabase { manifest_sha256: "a".repeat(64), schema_sha256: None })].into() });
m.validate().unwrap();
m.compatibility
.as_mut()
.unwrap()
.source_databases
.get_mut("0.2.0")
.unwrap()
.schema_sha256 = Some("bad".into());
m.compatibility.as_mut().unwrap().source_databases.get_mut("0.2.0").unwrap().schema_sha256 = Some("bad".into());
assert!(m.validate().is_err());
let c = m.compatibility.as_mut().unwrap();
c.source_databases.get_mut("0.2.0").unwrap().schema_sha256 = None;
+3 -23
View File
@@ -101,19 +101,8 @@ impl Store for Db {
let connection = self.clone().for_realm(crate::realms::Mode::Coa);
let world = self.realm_schema("acore_world");
let characters = self.realm_schema("acore_characters");
let others: Vec<_> = [
crate::realms::Mode::Coa,
crate::realms::Mode::Wildcard,
crate::realms::Mode::Reborn,
]
.into_iter()
.filter(|m| *m != self.realm())
.map(|m| m.schema("world").unwrap())
.collect();
let schemas: std::collections::BTreeSet<_> = [world, characters, AUTH_LEDGER_SCHEMA]
.into_iter()
.chain(others.iter().copied())
.collect();
let others: Vec<_> = [crate::realms::Mode::Coa, crate::realms::Mode::Wildcard, crate::realms::Mode::Reborn].into_iter().filter(|m| *m != self.realm()).map(|m| m.schema("world").unwrap()).collect();
let schemas: std::collections::BTreeSet<_> = [world, characters, AUTH_LEDGER_SCHEMA].into_iter().chain(others.iter().copied()).collect();
let catalog = connection.query(&format!("SELECT table_schema,table_name FROM information_schema.tables WHERE table_schema IN ('{}') AND table_name IN ('updates','{LEDGER_TABLE}') AND table_type='BASE TABLE';", schemas.into_iter().collect::<Vec<_>>().join("','")))?;
let available: std::collections::BTreeSet<_> = catalog
.lines()
@@ -131,16 +120,7 @@ impl Store for Db {
queries.push(format!("SELECT 'core','{kind}',{},REPEAT('0',64),'applied',1,'' FROM `{schema}`.`updates` WHERE BINARY RIGHT(name,4)='.sql'",text("LEFT(name,CHAR_LENGTH(name)-4)")));
}
}
for (origin, schema, filter) in [("local", world, ""), ("shared", AUTH_LEDGER_SCHEMA, "")]
.into_iter()
.chain(others.iter().map(|schema| {
(
"other",
*schema,
" WHERE `db` IN ('auth','coa-auth','wildcard-auth','reborn-auth')",
)
}))
{
for (origin, schema, filter) in [("local",world,""), ("shared",AUTH_LEDGER_SCHEMA,"")].into_iter().chain(others.iter().map(|schema| ("other", *schema, " WHERE `db` IN ('auth','coa-auth','wildcard-auth','reborn-auth')"))) {
if available.contains(&(schema, LEDGER_TABLE)) {
queries.push(format!("SELECT '{origin}',{},{},{},{},`baseline`,{} FROM `{schema}`.`{LEDGER_TABLE}`{filter}",text("`db`"),text("`id`"),text("`sha256`"),text("`status`"),text("COALESCE(HEX(`error`),'')")));
}
+74 -60
View File
@@ -173,26 +173,20 @@ fn installed_module_commits(root: &Path) -> BTreeMap<String, String> {
fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
let installed_commits = installed_module_commits(root);
let plugin_reg = crate::plugins::load_registry(root).ok();
let wildcard = crate::realms::state(root)
.map(|s| s.active != crate::realms::Mode::Coa)
.unwrap_or(true);
let wildcard = crate::realms::state(root).map(|s| s.active != crate::realms::Mode::Coa).unwrap_or(true);
cat.iter()
.cloned()
.map(|e| {
let name = conf_name(root, &e);
let conf = dir(root).join(&name);
let dist = dir(root).join(format!("{name}.dist"));
let plugin_entry = plugin_reg.as_ref().and_then(|r| r.plugins.get(&e.id));
let installed = conf.is_file() || dist.is_file() || plugin_entry.is_some();
let installed = conf.is_file() || dist.is_file();
let has_settings = installed
&& settings_in(cat, root, &e.id)
.map(|settings| settings.iter().any(|s| s.key != e.enable_key))
.unwrap_or(false);
// the active file or plugin registry decides
let enabled = if let Some(p) = plugin_entry {
p.enabled
} else if matches!(e.id.as_str(), "companions" | "playerbots") {
// the active file decides; without one the documented default is what the server will use
let enabled = if matches!(e.id.as_str(), "companions" | "playerbots") {
bot_enabled(root, &e).unwrap_or(true)
} else {
!e.switchable
@@ -202,9 +196,7 @@ fn list_in(cat: &[Entry], root: &Path) -> Vec<ModuleView> {
.unwrap_or(e.default_on)
};
let blocked = wildcard && matches!(e.id.as_str(), "companions" | "playerbots");
let version = if let Some(p) = plugin_entry {
Some(p.version.clone())
} else if e.id == "playerbots" {
let version = if e.id == "playerbots" {
crate::squid::release(root).map(|release| {
[
release.tag,
@@ -302,10 +294,7 @@ fn require_bot_server_stopped(root: &Path) -> Result<()> {
pub fn set_enabled(root: &Path, meta: &Path, id: &str, on: bool) -> Result<()> {
let _update_lock = crate::update::operation_lock(meta)?;
crate::update::ensure_recovered(meta)?;
let is_dynamic_plugin = crate::plugins::load_registry(root)
.map(|r| r.plugins.contains_key(id))
.unwrap_or(false);
let _lock = if is_dynamic_plugin || matches!(id, "companions" | "playerbots") {
let _lock = if matches!(id, "companions" | "playerbots") {
require_bot_server_stopped(root)?;
fs::create_dir_all(root.join(".state"))?;
let lock = fs::OpenOptions::new()
@@ -417,17 +406,6 @@ fn set_enabled_in(cat: &[Entry], root: &Path, meta: &Path, id: &str, on: bool) -
&["Changed by CoA Server Manager"],
);
fsx::atomic_write(&conf, file.to_text().as_bytes())?;
// If registered as a dynamic plugin, synchronize plugins.lock and plugin state
if let Ok(reg) = crate::plugins::load_registry(root) {
if reg.plugins.contains_key(id) {
let _ = crate::plugins::set_enabled(root, id, on);
}
}
if id == "playerbots" && on {
let _ = crate::plugins::record_squid_migrations_applied(root);
}
tracing::info!(module = id, on, "module switched");
Ok(())
}
@@ -544,6 +522,18 @@ fn save_settings_in(
"Use the module switch to turn this module on or off.".into(),
));
}
if id == "time-is-time" {
let valid = match key.as_str() {
"TimeIsTime.Announce" => matches!(value, "0" | "1"),
"TimeIsTime.SpeedRate" => value.parse::<f32>().is_ok_and(|v| v.is_finite() && (0.0..=60.0).contains(&v)),
"TimeIsTime.TimeStart" => value.parse::<i32>().is_ok_and(|v| v >= 0),
"TimeIsTime.HourOffset" => value.parse::<f32>().is_ok_and(|v| v.is_finite() && (-24.0..=24.0).contains(&v)),
_ => true,
};
if !valid {
return Err(Error::Invalid(format!("Invalid value for {key}.")));
}
}
if id == "content-scaling" && key == "CoAContentScaling.Difficulty.DamageMultiplier" {
let multiplier = value.parse::<f32>().map_err(|_| {
Error::Invalid("Enemy damage must be a number from 0.25 to 2.0.".into())
@@ -554,17 +544,10 @@ fn save_settings_in(
));
}
}
if id == "content-scaling"
&& key.starts_with("CoAContentScaling.Difficulty.Health.")
&& key.ends_with("Multiplier")
{
let multiplier = value.parse::<f32>().map_err(|_| {
Error::Invalid("Health multipliers must be a number from 0.1 to 10.".into())
})?;
if id == "content-scaling" && key.starts_with("CoAContentScaling.Difficulty.Health.") && key.ends_with("Multiplier") {
let multiplier = value.parse::<f32>().map_err(|_| Error::Invalid("Health multipliers must be a number from 0.1 to 10.".into()))?;
if !multiplier.is_finite() || !(0.1..=10.0).contains(&multiplier) {
return Err(Error::Invalid(
"Health multipliers must be a number from 0.1 to 10.".into(),
));
return Err(Error::Invalid("Health multipliers must be a number from 0.1 to 10.".into()));
}
}
if id == "content-scaling" && key == "CoAContentScaling.World.Leech.Percent" {
@@ -640,6 +623,53 @@ fn save_settings_in(
mod tests {
use super::*;
#[test]
fn time_is_time_card_settings_and_backups_match_the_module() {
let temp = tempfile::tempdir().unwrap();
let root = temp.path().join("server");
let meta = temp.path().join("metadata");
fs::create_dir_all(dir(&root)).unwrap();
fs::create_dir_all(&meta).unwrap();
let cat = catalog();
assert!(!list_in(&cat, &root).iter().find(|m| m.id == "time-is-time").unwrap().installed);
let defaults = "# Keep module documentation\n[worldserver]\nTimeIsTime.Enable = 1\nTimeIsTime.Announce = 1\nTimeIsTime.SpeedRate = 1.0\nTimeIsTime.TimeStart = 0\nTimeIsTime.HourOffset = 0.0\n";
let dist = dir(&root).join("mod-time_is_time.conf.dist");
let active = dir(&root).join("mod-time_is_time.conf");
fs::write(&dist, defaults).unwrap();
let view = list_in(&cat, &root).into_iter().find(|m| m.id == "time-is-time").unwrap();
assert!(view.installed && view.enabled && view.switchable && view.has_settings);
for locale in ["en", "ru", "de", "fr", "es", "zh"] {
assert!(!view.description[locale].is_empty());
}
assert_eq!(settings_in(&cat, &root, "time-is-time").unwrap().len(), 5);
let changes = BTreeMap::from([
("TimeIsTime.SpeedRate".into(), "7.5".into()),
("TimeIsTime.TimeStart".into(), "1213963200".into()),
("TimeIsTime.HourOffset".into(), "5.5".into()),
("TimeIsTime.Announce".into(), "0".into()),
]);
assert_eq!(save_settings_in(&cat, &root, &meta, "time-is-time", &changes).unwrap().len(), 4);
let saved = fs::read(&active).unwrap();
assert!(String::from_utf8_lossy(&saved).contains("# Keep module documentation"));
assert_eq!(fs::read_to_string(&dist).unwrap(), defaults);
assert!(save_settings_in(&cat, &root, &meta, "time-is-time", &changes).unwrap().is_empty());
for (key, value) in [
("TimeIsTime.Enable", "0"), ("TimeIsTime.SpeedRate", "NaN"),
("TimeIsTime.SpeedRate", "-1"), ("TimeIsTime.SpeedRate", "61"),
("TimeIsTime.HourOffset", "inf"), ("TimeIsTime.HourOffset", "25"),
("TimeIsTime.TimeStart", "-1"), ("TimeIsTime.TimeStart", "2147483648"),
("TimeIsTime.TimeStart", "1.5"), ("TimeIsTime.Announce", "2"),
] {
assert!(save_settings_in(&cat, &root, &meta, "time-is-time", &BTreeMap::from([(key.into(), value.into())])).is_err(), "{key}={value}");
assert_eq!(fs::read(&active).unwrap(), saved);
}
set_enabled_in(&cat, &root, &meta, "time-is-time", false).unwrap();
assert_eq!(read(&active).unwrap().get("TimeIsTime.Enable"), Some("0"));
set_enabled_in(&cat, &root, &meta, "time-is-time", true).unwrap();
assert_eq!(read(&active).unwrap().get("TimeIsTime.SpeedRate"), Some("7.5"));
assert!(meta.join("backups").exists());
}
fn test_catalog() -> Vec<Entry> {
let one = |id: &str, name: &str, conf: &str, key: &str| Entry {
id: id.into(),
@@ -831,8 +861,8 @@ mod tests {
// it may be empty (modules are added to it one by one); whatever is in it must be complete
for e in &c {
assert!(
e.description.contains_key("en") && e.description.len() == 5,
"{} has all five descriptions",
["en", "ru", "de", "fr", "es"].iter().all(|locale| e.description.get(*locale).is_some_and(|text| !text.is_empty())),
"{} has the existing catalog languages (additional translations are allowed)",
e.id
);
assert!(
@@ -1231,33 +1261,17 @@ mod tests {
for key in keys {
let changes = |v: &str| BTreeMap::from([(key.to_string(), v.to_string())]);
for bad in ["NaN", "inf", "0", "0.09", "10.01", "-1", "abc", ""] {
assert!(
save_settings_in(&cat, &root, &meta, "content-scaling", &changes(bad)).is_err(),
"{key} {bad}"
);
assert!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes(bad)).is_err(), "{key} {bad}");
}
for good in ["0.1", "0.4", "1", "2.5", "10"] {
assert_eq!(
save_settings_in(&cat, &root, &meta, "content-scaling", &changes(good))
.unwrap(),
[key]
);
assert_eq!(
settings_in(&cat, &root, "content-scaling")
.unwrap()
.iter()
.find(|s| s.key == key)
.unwrap()
.value,
good
);
assert_eq!(save_settings_in(&cat, &root, &meta, "content-scaling", &changes(good)).unwrap(), [key]);
assert_eq!(settings_in(&cat, &root, "content-scaling").unwrap().iter().find(|s| s.key == key).unwrap().value, good);
}
}
}
#[test]
fn an_older_file_name_is_used_when_the_current_one_is_missing_and_a_part_that_cannot_be_switched_stays_on(
) {
fn an_older_file_name_is_used_when_the_current_one_is_missing_and_a_part_that_cannot_be_switched_stays_on() {
let d = tempfile::tempdir().unwrap();
let (root, meta) = server(d.path());
fs::write(
+51 -217
View File
@@ -12,66 +12,12 @@ use std::{
path::{Path, PathBuf},
};
/// A world that runs next to the primary one. Each has its own folder, configs, logs and ports; auth and MySQL stay shared.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Tree {
/// Wildcard next to Conquest of Azeroth (or Conquest of Azeroth next to Wildcard when Wildcard is the primary).
Second,
/// Warcraft Reborn next to Conquest of Azeroth.
Reborn,
}
impl Tree {
pub const ALL: [Tree; 2] = [Tree::Second, Tree::Reborn];
fn dir(self) -> &'static str {
match self {
Tree::Second => ".realms/secondary",
Tree::Reborn => ".realms/reborn",
}
}
fn label(self) -> &'static str {
match self {
Tree::Second => "second realm",
Tree::Reborn => "Warcraft Reborn realm",
}
}
fn mode(self, active: Mode) -> Mode {
match self {
Tree::Second if active == Mode::Coa => Mode::Wildcard,
Tree::Second => Mode::Coa,
Tree::Reborn => Mode::Reborn,
}
}
fn enabled(self, s: &RealmState) -> bool {
match self {
Tree::Second => s.simultaneous,
Tree::Reborn => s.with_reborn,
}
}
fn ports(self, s: &RealmState) -> (Option<u16>, Option<u16>) {
match self {
Tree::Second => (s.secondary_world_port, s.secondary_ra_port),
Tree::Reborn => (s.reborn_world_port, s.reborn_ra_port),
}
}
}
pub fn tree_root(main: &Path, tree: Tree) -> PathBuf {
main.join(tree.dir())
}
/// The folder of the second realm (Wildcard next to Conquest of Azeroth).
pub fn root(main: &Path) -> PathBuf {
tree_root(main, Tree::Second)
main.join(".realms/secondary")
}
pub fn tree_running(main: &Path, tree: Tree) -> bool {
let second = tree_root(main, tree);
pub fn is_running(main: &Path) -> bool {
let second = root(main);
if !second.exists() {
return false;
}
@@ -82,11 +28,6 @@ pub fn tree_running(main: &Path, tree: Tree) -> bool {
.any(|n| process::read_state_record(&second, n).is_some_and(|p| process::is_alive(&p)))
}
/// Any of the extra worlds is running or still stopping.
pub fn is_running(main: &Path) -> bool {
Tree::ALL.into_iter().any(|t| tree_running(main, t))
}
fn copy_tree(from: &Path, to: &Path) -> Result<()> {
fs::create_dir_all(to)?;
for entry in fs::read_dir(from)? {
@@ -114,53 +55,15 @@ fn copy_tree(from: &Path, to: &Path) -> Result<()> {
Ok(())
}
/// Start Wildcard together with Conquest of Azeroth.
pub fn set_enabled(main: &Path, enabled: bool) -> Result<realms::View> {
set_tree(main, Tree::Second, enabled)
}
/// Start Warcraft Reborn together with Conquest of Azeroth.
pub fn set_reborn_enabled(main: &Path, enabled: bool) -> Result<realms::View> {
set_tree(main, Tree::Reborn, enabled)
}
fn set_tree(main: &Path, tree: Tree, enabled: bool) -> Result<realms::View> {
if enabled && !cfg!(windows) {
return Err(Error::Invalid(
"Simultaneous realms currently require Windows.".into(),
));
}
if enabled {
let active = realms::state(main)?.active;
let view = realms::view(main)?;
match tree {
Tree::Second => {
if active == Mode::Reborn {
return Err(Error::Invalid(
"Wildcard starts together with Conquest of Azeroth. Select Conquest of Azeroth first."
.into(),
));
}
if !view.supported {
return Err(Error::Invalid(
"Update the server to a build with Wildcard support first.".into(),
));
}
}
Tree::Reborn => {
if active != Mode::Coa {
return Err(Error::Invalid(
"Warcraft Reborn starts together with Conquest of Azeroth. Select Conquest of Azeroth first."
.into(),
));
}
if !view.reborn_supported {
return Err(Error::Invalid(
"Update the server to a build with Warcraft Reborn support first.".into(),
));
}
}
}
if realms::state(main)?.active == Mode::Reborn { return Err(Error::Invalid("Simultaneous startup supports CoA and Wildcard. Select one of these realms first.".into())); }
if !realms::view(main)?.supported { return Err(Error::Invalid("Update the server to a build with Wildcard support first.".into())); }
secondary_launcher(&fs::read_to_string(main.join("Scripts/manage.py"))?)?;
}
let status = process::observe(main, &crate::layout::read_ports(main));
@@ -169,21 +72,20 @@ fn set_tree(main: &Path, tree: Tree, enabled: bool) -> Result<realms::View> {
|| is_running(main)
{
return Err(Error::Invalid(
"Stop all realms before changing which realms start together.".into(),
"Stop both realms before changing simultaneous startup.".into(),
));
}
if enabled {
realms::ensure_created(main, tree.mode(realms::state(main)?.active))?;
let original = realms::state(main)?.active;
if enabled && !realms::state(main)?.wildcard_created {
realms::select(main, Mode::Wildcard)?;
if original != Mode::Wildcard {
realms::select(main, original)?;
}
}
let mut s = realms::state(main)?;
if enabled {
let p = crate::layout::read_ports(main);
let mut reserved = vec![p.mysql, p.auth, p.world, p.ra];
// Ports already saved for any other extra world stay reserved, so two worlds never get the same one.
for other in Tree::ALL.into_iter().filter(|t| *t != tree) {
let (world, ra) = other.ports(&s);
reserved.extend(world.into_iter().chain(ra));
}
let mut choose = |saved: Option<u16>, near: u16| -> Result<u16> {
if let Some(port) = saved.filter(|p| *p > 0 && !reserved.contains(p)) {
reserved.push(port);
@@ -193,41 +95,31 @@ fn set_tree(main: &Path, tree: Tree, enabled: bool) -> Result<realms::View> {
.find(|p| {
!reserved.contains(p) && std::net::TcpListener::bind(("127.0.0.1", *p)).is_ok()
})
.ok_or_else(|| Error::Invalid(format!("No free port for the {}.", tree.label())))?;
.ok_or_else(|| Error::Invalid("No free port for the second realm.".into()))?;
reserved.push(port);
Ok(port)
};
let (world, ra) = tree.ports(&s);
let (world, ra) = (choose(world, p.world)?, choose(ra, p.ra)?);
match tree {
Tree::Second => {
s.secondary_world_port = Some(world);
s.secondary_ra_port = Some(ra);
}
Tree::Reborn => {
s.reborn_world_port = Some(world);
s.reborn_ra_port = Some(ra);
}
}
}
match tree {
Tree::Second => s.simultaneous = enabled,
Tree::Reborn => s.with_reborn = enabled,
s.secondary_world_port = Some(choose(s.secondary_world_port, p.world)?);
s.secondary_ra_port = Some(choose(s.secondary_ra_port, p.ra)?);
}
s.simultaneous = enabled;
fsx::atomic_write_json(&main.join("Settings/realm-profile.json"), &s)?;
realms::view(main)
}
fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
if tree_running(main, tree) {
return Err(Error::Invalid(format!(
"The {} is still running; stop it before preparing its files.",
tree.label()
)));
fn prepare(main: &Path) -> Result<PathBuf> {
if is_running(main) {
return Err(Error::Invalid(
"The second realm is still running; stop it before preparing its files.".into(),
));
}
let s = realms::state(main)?;
let mode = tree.mode(s.active);
let second = fsx::ensure_within(main, &tree_root(main, tree))?;
let mode = if s.active == Mode::Coa {
Mode::Wildcard
} else {
Mode::Coa
};
let second = fsx::ensure_within(main, &root(main))?;
for folder in ["Runtime", "BugReport", "mysql/bin"] {
copy_tree(
&main.join(folder),
@@ -260,7 +152,6 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
)?;
}
}
let _ = crate::plugins::prepare_multiworld(main, &second);
let files: BTreeMap<String, Vec<u8>> =
fsx::read_json(&main.join(format!("Settings/realm-profiles/{}.json", mode.name())))?;
// A previous secondary run may have used the other realm's module files.
@@ -314,12 +205,13 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
)?;
}
let mut cfg: serde_json::Value = fsx::read_json(&main.join("Settings/repack.json"))?;
let (world_port, ra_port) = tree.ports(&s);
cfg["worldPort"] = world_port
.ok_or_else(|| Error::Invalid(format!("The {} world port is missing.", tree.label())))?
cfg["worldPort"] = s
.secondary_world_port
.ok_or_else(|| Error::Invalid("Second realm world port is missing.".into()))?
.into();
cfg["raPort"] = ra_port
.ok_or_else(|| Error::Invalid(format!("The {} console port is missing.", tree.label())))?
cfg["raPort"] = s
.secondary_ra_port
.ok_or_else(|| Error::Invalid("Second realm console port is missing.".into()))?
.into();
fsx::atomic_write_json(&second.join("Settings/repack.json"), &cfg)?;
fsx::atomic_write(
@@ -331,7 +223,6 @@ fn prepare(main: &Path, tree: Tree) -> Result<PathBuf> {
&RealmState {
active: mode,
wildcard_created: true,
reborn_created: true,
..Default::default()
},
)?;
@@ -356,9 +247,12 @@ fn secondary_launcher(source: &str) -> Result<String> {
))
}
fn start_tree(main: &Path, tree: Tree) -> Result<()> {
if tree_running(main, tree) {
let second = tree_root(main, tree);
pub fn start(main: &Path) -> Result<()> {
if !realms::state(main)?.simultaneous {
return Ok(());
}
if is_running(main) {
let second = root(main);
if process::observe(&second, &crate::layout::read_ports(&second))
.world
.state
@@ -366,50 +260,35 @@ fn start_tree(main: &Path, tree: Tree) -> Result<()> {
{
return Ok(());
}
return Err(Error::Invalid(format!(
"The {} is still starting or stopping.",
tree.label()
)));
return Err(Error::Invalid(
"The second realm is still starting or stopping.".into(),
));
}
let second = prepare(main, tree)?;
let second = prepare(main)?;
let out = driver::run(&second, Verb::StartWorld)?;
if !out.ok {
return Err(Error::Invalid(format!(
"The {} did not start: {}",
tree.label(),
"The second realm did not start: {}",
out.output
)));
}
Ok(())
}
/// Start every extra world that is switched on.
pub fn start(main: &Path) -> Result<()> {
let s = realms::state(main)?;
for tree in Tree::ALL.into_iter().filter(|t| t.enabled(&s)) {
start_tree(main, tree)?;
}
Ok(())
}
fn stop_tree(main: &Path, tree: Tree) -> Result<()> {
let second = tree_root(main, tree);
pub fn stop(main: &Path) -> Result<()> {
let second = root(main);
if !second.join("Scripts/manage.py").exists() {
if tree_running(main, tree) {
return Err(Error::Invalid(format!(
"The running {}'s launcher is missing. The shared database was left running.",
tree.label()
)));
if is_running(main) {
return Err(Error::Invalid("The running second realm's launcher is missing. The shared database was left running.".into()));
}
return Ok(());
}
// Its state has no auth/MySQL records: the shared database remains up until the primary world stops.
if tree_running(main, tree) {
if is_running(main) {
let out = driver::run(&second, Verb::StopAll)?;
if !out.ok || tree_running(main, tree) {
if !out.ok || is_running(main) {
return Err(Error::Invalid(format!(
"The {} could not stop; the database was left running: {}",
tree.label(),
"The second realm could not stop; the database was left running: {}",
out.output
)));
}
@@ -417,54 +296,9 @@ fn stop_tree(main: &Path, tree: Tree) -> Result<()> {
Ok(())
}
/// Stop every extra world; one that fails does not keep the others running.
pub fn stop(main: &Path) -> Result<()> {
let mut first = None;
for tree in Tree::ALL {
if let Err(e) = stop_tree(main, tree) {
first.get_or_insert(e);
}
}
first.map_or(Ok(()), Err)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn every_extra_world_has_its_own_folder_realm_and_ports() {
let mut s = RealmState::default();
assert_eq!(Tree::Second.mode(Mode::Coa), Mode::Wildcard);
assert_eq!(Tree::Second.mode(Mode::Wildcard), Mode::Coa);
assert_eq!(Tree::Reborn.mode(Mode::Coa), Mode::Reborn);
assert_ne!(Tree::Second.dir(), Tree::Reborn.dir());
s.secondary_world_port = Some(8086);
s.reborn_world_port = Some(8087);
assert_eq!(Tree::Second.ports(&s).0, Some(8086));
assert_eq!(Tree::Reborn.ports(&s).0, Some(8087));
assert!(!Tree::Second.enabled(&s) && !Tree::Reborn.enabled(&s));
s.with_reborn = true;
assert!(!Tree::Second.enabled(&s) && Tree::Reborn.enabled(&s));
}
#[test]
fn reborn_starts_together_with_conquest_of_azeroth_only() {
let t = tempfile::tempdir().unwrap();
fsx::atomic_write(
&t.path().join("Core/worldserver.exe"),
b"Warcraft Reborn class spells are unavailable",
)
.unwrap();
fsx::atomic_write(
&t.path().join("Settings/realm-profile.json"),
br#"{"active":"wildcard","wildcard_created":true}"#,
)
.unwrap();
let err = set_reborn_enabled(t.path(), true).unwrap_err().to_string();
assert!(err.contains("Select Conquest of Azeroth first"), "{err}");
assert!(!realms::state(t.path()).unwrap().with_reborn);
}
#[test]
fn secondary_never_starts_the_shared_database() {
let patched = secondary_launcher("def start_world(config, offset):\r\n start_mysql(config)\r\n wait_ready('world', 8086)\r\n").unwrap();
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
+2 -3
View File
@@ -456,9 +456,8 @@ mod tests {
ruleset: Ruleset::Coa,
character_formats: ContentProfile::manager_formats(),
online_import_job_formats: jobs.to_vec(),
session_protocol: crate::portable::session::protocol::SESSION_PROTOCOL_VERSION,
collection_protocol:
crate::portable::session::protocol::COLLECTION_PROTOCOL_VERSION,
session_protocol: 2,
collection_protocol: 2,
features: features.iter().copied().collect(),
collection_kinds: ["coa:appearance".to_string(), "coa:vanity".to_string()]
.into_iter()
-5
View File
@@ -64,11 +64,6 @@ pub enum PortableError {
RealmRead(String),
#[error("the realm database is a {found} realm but a {expected} character was requested")]
WrongRealm { expected: String, found: String },
#[error("ruleset mismatch: character has {character:?}, realm expects {realm:?}")]
RulesetMismatch {
character: super::model::Ruleset,
realm: super::model::Ruleset,
},
#[error("character {character} is already on server {server_id}")]
AlreadyOnRealm {
@@ -20,29 +20,4 @@ FROM collection;
DROP TABLE collection;
ALTER TABLE collection_new RENAME TO collection;
-- 2. Upgrade character table to allow 'reborn' in CHECK (ruleset IN ('coa', 'wildcard', 'reborn'))
-- Foreign keys are off during migration runner, but legacy child tables remain valid because primary keys are untouched.
CREATE TABLE character_new (
character_id TEXT PRIMARY KEY,
profile_id TEXT NOT NULL REFERENCES profile(profile_id),
ruleset TEXT NOT NULL CHECK (ruleset IN ('coa', 'wildcard', 'reborn')),
name TEXT NOT NULL,
race TEXT NOT NULL,
class TEXT NOT NULL,
gender INTEGER NOT NULL,
level INTEGER NOT NULL,
revision INTEGER NOT NULL CHECK (revision >= 1),
created_at TEXT NOT NULL,
updated_at TEXT NOT NULL,
archived INTEGER NOT NULL DEFAULT 0 CHECK (archived IN (0, 1))
) STRICT;
INSERT INTO character_new (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
SELECT character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived
FROM character;
DROP TABLE character;
ALTER TABLE character_new RENAME TO character;
CREATE INDEX character_profile ON character(profile_id);
CREATE INDEX character_profile_ruleset ON character(profile_id, ruleset);
CREATE INDEX IF NOT EXISTS character_profile_ruleset ON character(profile_id, ruleset);
+2 -2
View File
@@ -23,8 +23,8 @@ pub mod snapshot;
pub mod store;
pub mod versions;
#[cfg(any(test, feature = "testkit"))]
pub mod fixtures;
#[cfg(test)]
pub(crate) mod fixtures;
pub use collection::IdSet;
pub use error::{PortableError, Result};
+1 -96
View File
@@ -59,13 +59,12 @@ pub mod limits {
use limits::*;
/// A character belongs to exactly one ruleset for its whole life; rulesets never mix.
/// A character belongs to exactly one ruleset for its whole life; CoA and Wildcard never mix.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Ruleset {
Coa,
Wildcard,
Reborn,
}
impl Ruleset {
@@ -73,99 +72,23 @@ impl Ruleset {
match self {
Ruleset::Coa => "coa",
Ruleset::Wildcard => "wildcard",
Ruleset::Reborn => "reborn",
}
}
pub fn display_name(self) -> &'static str {
match self {
Ruleset::Coa => "Conquest of Azeroth",
Ruleset::Wildcard => "Wildcard",
Ruleset::Reborn => "Warcraft Reborn",
}
}
pub fn realm_id(self) -> u32 {
match self {
Ruleset::Coa => 1,
Ruleset::Wildcard => 2,
Ruleset::Reborn => 3,
}
}
pub fn schema(self, kind: &str) -> Result<&'static str> {
let mode: crate::realms::Mode = self.into();
mode.schema(kind)
.map_err(|e| PortableError::Invalid(e.to_string()))
}
pub fn collection_namespace(self) -> &'static str {
match self {
Ruleset::Coa => "coa",
Ruleset::Wildcard => "wildcard",
Ruleset::Reborn => "reborn",
}
}
pub fn parse(s: &str) -> Result<Self> {
match s {
"coa" => Ok(Ruleset::Coa),
"wildcard" => Ok(Ruleset::Wildcard),
"reborn" => Ok(Ruleset::Reborn),
other => Err(PortableError::Invalid(format!("unknown ruleset {other:?}"))),
}
}
}
impl std::str::FromStr for Ruleset {
type Err = PortableError;
fn from_str(s: &str) -> Result<Self> {
Self::parse(s)
}
}
impl std::fmt::Display for Ruleset {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(self.as_str())
}
}
impl From<crate::realms::Mode> for Ruleset {
fn from(m: crate::realms::Mode) -> Self {
match m {
crate::realms::Mode::Coa => Ruleset::Coa,
crate::realms::Mode::Wildcard => Ruleset::Wildcard,
crate::realms::Mode::Reborn => Ruleset::Reborn,
}
}
}
impl From<Ruleset> for crate::realms::Mode {
fn from(r: Ruleset) -> Self {
match r {
Ruleset::Coa => crate::realms::Mode::Coa,
Ruleset::Wildcard => crate::realms::Mode::Wildcard,
Ruleset::Reborn => crate::realms::Mode::Reborn,
}
}
}
impl From<coa_registry_proto::caps::Ruleset> for Ruleset {
fn from(r: coa_registry_proto::caps::Ruleset) -> Self {
match r {
coa_registry_proto::caps::Ruleset::Coa => Ruleset::Coa,
coa_registry_proto::caps::Ruleset::Wildcard => Ruleset::Wildcard,
coa_registry_proto::caps::Ruleset::Reborn => Ruleset::Reborn,
}
}
}
impl From<Ruleset> for coa_registry_proto::caps::Ruleset {
fn from(r: Ruleset) -> Self {
match r {
Ruleset::Coa => coa_registry_proto::caps::Ruleset::Coa,
Ruleset::Wildcard => coa_registry_proto::caps::Ruleset::Wildcard,
Ruleset::Reborn => coa_registry_proto::caps::Ruleset::Reborn,
}
}
}
/// Binary data as base64 text in the serialised form.
#[derive(Clone, PartialEq, Eq, Default)]
pub struct Bytes(pub Vec<u8>);
@@ -883,21 +806,3 @@ impl PortableCharacter {
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn schema_mapping_never_falls_back_on_unknown_database_kind() {
for ruleset in [Ruleset::Coa, Ruleset::Wildcard, Ruleset::Reborn] {
assert!(ruleset.schema("auth").is_ok());
assert!(ruleset.schema("characters").is_ok());
assert!(ruleset.schema("world").is_ok());
assert!(ruleset.schema("characters_extra").is_err());
assert!(ruleset.schema("unknown").is_err());
assert!(ruleset.schema("").is_err());
assert!(ruleset.schema("acore_characters").is_err());
}
}
}
@@ -11,6 +11,7 @@ use crate::db::Db;
use super::super::collection::IdSet;
use super::super::error::{PortableError, Result};
use super::super::model::Ruleset;
use super::knowledge::{is_bank_vanity_item, RealmKnowledge};
use super::plan::FAIL;
use super::ruleset_of;
@@ -21,12 +22,8 @@ const CHUNK: usize = 2_000;
/// `(table, id column, columns written)` of a collection kind.
fn layout(kind: &str) -> Result<(&'static str, &'static str, bool)> {
match kind {
"coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
Ok(("account_appearance_collection", "appearance_id", true))
}
"coa:vanity" | "wildcard:vanity" | "reborn:vanity" => {
Ok(("account_vanity_collection", "item_id", false))
}
"coa:appearance" => Ok(("account_appearance_collection", "appearance_id", true)),
"coa:vanity" => Ok(("account_vanity_collection", "item_id", false)),
other => Err(PortableError::Invalid(format!(
"collection kind {other:?} is not carried"
))),
@@ -37,12 +34,11 @@ fn realm_error(e: crate::Error) -> PortableError {
PortableError::RealmRead(e.to_string())
}
fn check_ruleset(db: &Db, kind: &str) -> Result<()> {
let r = ruleset_of(db)?;
if !crate::portable::session::protocol::carried_kind_for(kind, r) {
return Err(PortableError::Invalid(format!(
"collection kind {kind:?} does not belong to realm ruleset {r:?}"
)));
fn coa_only(db: &Db) -> Result<()> {
if ruleset_of(db)? != Ruleset::Coa {
return Err(PortableError::Invalid(
"collections are carried for CoA realms only (Wildcard transfer is disabled)".into(),
));
}
Ok(())
}
@@ -66,7 +62,7 @@ pub fn account_of(db: &Db, local_guid: u32) -> Result<Option<u32>> {
/// Count, maximum, sum and checksum of the account's rows of this kind: one cheap aggregate over the primary key.
pub fn fingerprint(db: &Db, account: u32, kind: &str) -> Result<String> {
check_ruleset(db, kind)?;
coa_only(db)?;
let (table, column, _) = layout(kind)?;
let out = db
.query(&format!("SELECT COUNT(*), IFNULL(MAX(`{column}`), 0), IFNULL(SUM(`{column}`), 0), IFNULL(BIT_XOR(CRC32(`{column}`)), 0) FROM acore_characters.`{table}` WHERE `account_id` = {account}"))
@@ -86,7 +82,7 @@ pub fn fingerprint(db: &Db, account: u32, kind: &str) -> Result<String> {
/// The ids of the account in this realm, without the bank vanity items.
pub fn read_set(db: &Db, account: u32, kind: &str) -> Result<IdSet> {
check_ruleset(db, kind)?;
coa_only(db)?;
let (table, column, _) = layout(kind)?;
let out = db.query(&format!("SELECT `{column}` FROM acore_characters.`{table}` WHERE `account_id` = {account} ORDER BY `{column}`")).map_err(realm_error)?;
let mut ids = Vec::new();
@@ -95,9 +91,7 @@ pub fn read_set(db: &Db, account: u32, kind: &str) -> Result<IdSet> {
.trim()
.parse()
.map_err(|_| PortableError::CorruptSnapshot(format!("{line:?} is not an id")))?;
if (kind == "coa:vanity" || kind == "wildcard:vanity" || kind == "reborn:vanity")
&& is_bank_vanity_item(id)
{
if kind == "coa:vanity" && is_bank_vanity_item(id) {
continue;
}
ids.push(id);
@@ -123,21 +117,21 @@ pub fn apply_set(
canonical: &IdSet,
knowledge: &RealmKnowledge,
) -> Result<Applied> {
check_ruleset(db, kind)?;
coa_only(db)?;
let (table, column, has_source) = layout(kind)?;
let known = |id: u32| match kind {
"coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
knowledge.knows_appearance(id)
}
"coa:appearance" => knowledge.knows_appearance(id),
_ => knowledge.knows_vanity(id) && !is_bank_vanity_item(id),
};
let held = read_set(db, account, kind)?;
let mut applied = Applied::default();
let mut wanted = Vec::new();
for id in canonical.ids().iter().copied().filter(|id| {
!((kind == "coa:vanity" || kind == "wildcard:vanity" || kind == "reborn:vanity")
&& is_bank_vanity_item(*id))
}) {
for id in canonical
.ids()
.iter()
.copied()
.filter(|id| !(kind == "coa:vanity" && is_bank_vanity_item(*id)))
{
if !known(id) {
applied.unknown += 1;
} else if held.contains(id) {
@@ -168,11 +168,9 @@ fn account_collections_are_read_cheaply_unioned_and_written_without_duplicates_o
let (mut store, _) = fresh_store();
let profile = store.default_profile().unwrap();
store
.merge_collection(profile, Ruleset::Coa, APPEARANCE, &wardrobe)
.unwrap();
store
.merge_collection(profile, Ruleset::Coa, VANITY, &vanity)
.merge_collection(profile, APPEARANCE, &wardrobe)
.unwrap();
store.merge_collection(profile, VANITY, &vanity).unwrap();
let fingerprint_a = fingerprint(&r.a, 5001, APPEARANCE).unwrap();
assert_eq!(
fingerprint(&r.a, 5001, APPEARANCE).unwrap(),
@@ -333,20 +331,10 @@ fn the_result_comes_back_to_realm_a_unchanged_gameplay_and_complete_collections(
reconcile_session(&r.b, &mut store, id, B, true, None).unwrap();
for kind in [APPEARANCE, VANITY] {
store
.merge_collection(
profile,
Ruleset::Coa,
kind,
&read_set(&r.b, ACCOUNT, kind).unwrap(),
)
.merge_collection(profile, kind, &read_set(&r.b, ACCOUNT, kind).unwrap())
.unwrap();
store
.merge_collection(
profile,
Ruleset::Coa,
kind,
&read_set(&r.a, 5001, kind).unwrap(),
)
.merge_collection(profile, kind, &read_set(&r.a, 5001, kind).unwrap())
.unwrap();
}
@@ -355,10 +343,7 @@ fn the_result_comes_back_to_realm_a_unchanged_gameplay_and_complete_collections(
let updated =
update_realm_character(&r.a, &mut store, id, "realm-a", &options(a_known.clone())).unwrap();
assert!(updated.updated, "{updated:?}");
let (_, canonical_wardrobe) = store
.collection(profile, Ruleset::Coa, APPEARANCE)
.unwrap()
.unwrap();
let (_, canonical_wardrobe) = store.collection(profile, APPEARANCE).unwrap().unwrap();
let applied = apply_set(&r.a, 5001, APPEARANCE, &canonical_wardrobe, &a_known).unwrap();
assert_eq!(applied.inserted, 1, "only 1300 is new to A");
assert_eq!(
+1 -1
View File
@@ -55,7 +55,7 @@ pub fn ruleset_of(db: &Db) -> Result<Ruleset> {
match db.realm() {
Mode::Coa => Ok(Ruleset::Coa),
Mode::Wildcard => Ok(Ruleset::Wildcard),
Mode::Reborn => Ok(Ruleset::Reborn),
Mode::Reborn => Err(PortableError::Invalid("Portable characters are not supported on Warcraft Reborn realms yet.".into())),
}
}
@@ -14,9 +14,7 @@ use super::super::extension::{
};
use super::super::ids::CharacterId;
use super::super::model::PortableCharacter;
use super::super::session::protocol::{
collection_kinds, COLLECTION_PROTOCOL_VERSION, SESSION_PROTOCOL_VERSION,
};
use super::super::session::protocol::{COLLECTION_KINDS, PROTOCOL_VERSION};
use super::super::store::Store;
use super::import::ImportOptions;
use super::script::SchemaProbe;
@@ -99,16 +97,13 @@ pub fn assemble(
online_import_job_formats: core
.map(|c| c.portable.job_formats.clone())
.unwrap_or_default(),
session_protocol: SESSION_PROTOCOL_VERSION,
collection_protocol: COLLECTION_PROTOCOL_VERSION,
session_protocol: PROTOCOL_VERSION,
collection_protocol: PROTOCOL_VERSION,
features,
collection_kinds: if probe.has("account_appearance_collection")
&& probe.has("account_vanity_collection")
{
collection_kinds(ruleset_of(db)?)
.iter()
.map(|k| k.to_string())
.collect()
COLLECTION_KINDS.iter().map(|k| k.to_string()).collect()
} else {
Default::default()
},
+1 -1
View File
@@ -729,7 +729,7 @@ fn the_wildcard_ruleset_uses_its_own_namespace_and_quarantines_wildcard_state()
let wc_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Wildcard);
let coa_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Coa);
let reborn_db = Db::with_tools(std::path::PathBuf::new(), 1, "root", "x", Mode::Reborn);
assert_eq!(ruleset_of(&reborn_db).unwrap(), Ruleset::Reborn);
assert!(ruleset_of(&reborn_db).is_err());
assert_eq!(
(ruleset_of(&wc_db).unwrap(), ruleset_of(&coa_db).unwrap()),
(Ruleset::Wildcard, Ruleset::Coa)
+2 -11
View File
@@ -112,7 +112,6 @@ pub struct RealmAccess {
pub job_dir: PathBuf,
pub data_dir: PathBuf,
pub game_server_users: Vec<String>,
pub mode: Option<crate::realms::Mode>,
source: Source,
}
@@ -199,7 +198,6 @@ impl RealmAccess {
job_dir: PathBuf::from(&d.job_dir),
data_dir: PathBuf::from(&d.data_dir),
game_server_users: d.game_server_users.clone(),
mode: None,
source: Source::Descriptor(Box::new(d)),
})
}
@@ -221,7 +219,6 @@ impl RealmAccess {
job_dir: root.join("Core").join("PortableImport"),
data_dir: root.join("Data"),
game_server_users: default_game_users(),
mode: None,
source: Source::Install {
root: root.to_path_buf(),
},
@@ -231,19 +228,13 @@ impl RealmAccess {
/// The database with full rights (imports and updates of a stopped realm, reading characters).
pub fn db(&self) -> Result<Db> {
match &self.source {
Source::Install { root } => {
let mut d = Db::from_repack(root, Account::Admin)?;
if let Some(m) = self.mode {
d = d.for_realm(m);
}
Ok(d)
}
Source::Install { root } => Db::from_repack(root, Account::Admin),
Source::Descriptor(d) => Ok(Db::with_tools(
PathBuf::from(&d.mysql_bin),
d.db_port,
leak(&d.db_user),
d.db_password.expose(),
self.mode.unwrap_or(Mode::Coa),
Mode::Coa,
)),
}
}
+27 -92
View File
@@ -136,7 +136,6 @@ struct Saved {
#[derive(Debug, Clone)]
pub struct ClaimBundle {
pub character_id: CharacterId,
pub ruleset: super::super::model::Ruleset,
pub payload: Vec<u8>,
pub content_hash: [u8; 32],
pub collections: BTreeMap<String, Vec<u32>>,
@@ -182,16 +181,6 @@ pub fn class_name(class: &str) -> String {
.and_then(|n| n.parse().ok())
.unwrap_or(0);
match id {
1 => "Warrior",
2 => "Paladin",
3 => "Hunter",
4 => "Rogue",
5 => "Priest",
6 => "Death Knight",
7 => "Shaman",
8 => "Mage",
9 => "Warlock",
11 => "Druid",
12 => "Barbarian",
13 => "Witch Doctor",
14 => "Felsworn",
@@ -374,26 +363,11 @@ impl PortableService {
pub fn reload_realms(&mut self) {
let (descriptors, broken) = access::load_descriptors(&self.dir.join("realms"));
self.broken_descriptors = broken;
let mut realms: Vec<RealmAccess> = Vec::new();
for (id, root) in &self.installs {
realms.push(RealmAccess::from_install(id, root));
if let Ok(state) = crate::realms::state(root) {
if state.wildcard_created {
let mut wc = RealmAccess::from_install(id, root);
wc.id = format!("srv-{id}:wildcard");
wc.name = format!("{} — Wildcard", wc.name);
wc.mode = Some(crate::realms::Mode::Wildcard);
realms.push(wc);
}
if state.reborn_created {
let mut rb = RealmAccess::from_install(id, root);
rb.id = format!("srv-{id}:reborn");
rb.name = format!("{} — Warcraft Reborn", rb.name);
rb.mode = Some(crate::realms::Mode::Reborn);
realms.push(rb);
}
}
}
let mut realms: Vec<RealmAccess> = self
.installs
.iter()
.map(|(id, root)| RealmAccess::from_install(id, root))
.collect();
for d in descriptors {
match RealmAccess::from_descriptor(d) {
Ok(a) if !realms.iter().any(|r| r.id == a.id) => realms.push(a),
@@ -440,10 +414,10 @@ impl PortableService {
}
fn access(&self, id: &str) -> Res<RealmAccess> {
if let Some(r) = self.realms.iter().find(|r| r.id == id) {
return Ok(r.clone());
}
crate::realm_registry::advert::find_access(&self.dir.join("realms"), &self.installs, id)
self.realms
.iter()
.find(|r| r.id == id)
.cloned()
.ok_or_else(|| fail("realm_missing", "That realm is not known to this Manager."))
}
@@ -754,7 +728,6 @@ impl PortableService {
characters.push(CharacterView {
id: c.character_id.to_string(),
name: c.name,
ruleset: c.ruleset,
class_name: class_name(&c.class),
race: c.race,
level: c.level,
@@ -1383,7 +1356,6 @@ impl PortableService {
.map_err(|e| fail("realm_offline", e.to_string()))?;
let list =
realm::inspect_characters(&db).map_err(|e| fail("realm_offline", e.to_string()))?;
let realm_ruleset = realm::ruleset_of(&db)?;
let mut out = Vec::new();
for c in list {
if self.host.find_by_local(realm_id, c.local_guid)?.is_some() {
@@ -1392,7 +1364,7 @@ impl PortableService {
out.push(LocalCharacterView {
token: c.local_guid,
name: c.name.clone(),
class_name: class_name(&format!("{}:class:{}", realm_ruleset.as_str(), c.class)),
class_name: class_name(&format!("coa:class:{}", c.class)),
level: c.level,
account: c.username.clone().unwrap_or_default(),
eligible: c.eligible(),
@@ -1466,18 +1438,18 @@ impl PortableService {
let model = self.host.load_current(character_id)?;
let encoded = super::super::snapshot::encode(&model)?;
let mut collections = BTreeMap::new();
let realm_ruleset = realm::ruleset_of(&db)?;
if let Some(account) = realm::collections::account_of(&db, local_guid)? {
for kind in super::super::session::protocol::collection_kinds(realm_ruleset) {
if let Ok(set) = realm::collections::read_set(&db, account, kind) {
collections.insert(kind.to_string(), set.ids().to_vec());
if realm::ruleset_of(&db)? == super::super::model::Ruleset::Coa {
if let Some(account) = realm::collections::account_of(&db, local_guid)? {
for kind in ["coa:appearance", "coa:vanity"] {
if let Ok(set) = realm::collections::read_set(&db, account, kind) {
collections.insert(kind.to_string(), set.ids().to_vec());
}
}
}
}
self.publish();
Ok(ClaimBundle {
character_id,
ruleset: model.ruleset,
payload: encoded.payload,
content_hash: encoded.content_hash,
collections,
@@ -1501,25 +1473,17 @@ impl PortableService {
"The character data does not belong to the character that was claimed.",
));
}
let ruleset = model.ruleset;
for kind in collections.keys() {
if !super::super::session::protocol::carried_kind_for(kind, ruleset) {
return Err(fail(
"incompatible",
format!("Foreign collection kind {kind:?} in {ruleset} claim"),
));
}
}
if self.owner.character(character_id).is_err() {
self.owner
.create_character_with_id(self.owner_profile, model, realm_id)?;
}
for (kind, ids) in collections {
if super::super::session::protocol::carried_kind_for(kind, ruleset) {
let set = super::super::collection::IdSet::from_ids(ids.iter().copied())?;
self.owner
.merge_collection(self.owner_profile, ruleset, kind, &set)?;
if !matches!(kind.as_str(), "coa:appearance" | "coa:vanity") {
continue;
}
let set = super::super::collection::IdSet::from_ids(ids.iter().copied())?;
self.owner
.merge_collection(self.owner_profile, kind, &set)?;
}
self.publish();
self.state()
@@ -1535,17 +1499,13 @@ impl PortableService {
let model = self.owner.load_current(cid)?;
let encoded = super::super::snapshot::encode(&model)?;
let mut collections = BTreeMap::new();
for kind in super::super::session::protocol::collection_kinds(model.ruleset) {
if let Ok(Some((_, set))) =
self.owner
.collection(self.owner_profile, model.ruleset, kind)
{
for kind in ["coa:appearance", "coa:vanity"] {
if let Ok(Some((_, set))) = self.owner.collection(self.owner_profile, kind) {
collections.insert(kind.to_string(), set.ids().to_vec());
}
}
Ok(ClaimBundle {
character_id: cid,
ruleset: model.ruleset,
payload: encoded.payload,
content_hash: encoded.content_hash,
collections,
@@ -1631,21 +1591,6 @@ impl PortableService {
let opts = self.options(&access, &caps);
// Preflight compatibility check before ANY mutation
let db_ruleset = super::super::realm::ruleset_of(&db)?;
if model.ruleset != db_ruleset {
return Err(fail(
"incompatible",
"Character ruleset does not match realm database ruleset.",
));
}
let caps_ruleset: crate::portable::model::Ruleset = caps.content.ruleset;
if model.ruleset != caps_ruleset {
return Err(fail(
"incompatible",
"Character ruleset does not match realm capability ruleset.",
));
}
let ops = [Operation::OnlineImport, Operation::RuntimeSession];
let report = self.report(&model, &caps, &opts, &ops, true);
if verdict_of(report.verdict()) == Verdict::Incompatible {
@@ -1661,19 +1606,10 @@ impl PortableService {
// Monotonic union of collections
for (kind, ids) in &params.collections {
if !super::super::session::protocol::carried_kind_for(kind, model.ruleset) {
return Err(fail(
"incompatible",
format!(
"Foreign collection kind {kind:?} in {} remote transfer",
model.ruleset
),
));
}
if let Ok(set) = super::super::collection::IdSet::from_ids(ids.iter().copied()) {
let _ = self
.host
.merge_collection(self.host_profile, model.ruleset, kind, &set);
if matches!(kind.as_str(), "coa:appearance" | "coa:vanity") {
if let Ok(set) = super::super::collection::IdSet::from_ids(ids.iter().copied()) {
let _ = self.host.merge_collection(self.host_profile, kind, &set);
}
}
}
@@ -1689,7 +1625,6 @@ impl PortableService {
);
let offer = super::super::session::protocol::SessionOffer {
protocol_version: super::super::session::protocol::PROTOCOL_VERSION,
ruleset: model.ruleset,
session_id,
character_id: cid,
server_id: realm_id.to_string(),
@@ -53,7 +53,6 @@ pub struct CopyView {
pub struct CharacterView {
pub id: String,
pub name: String,
pub ruleset: super::super::model::Ruleset,
pub class_name: String,
pub race: String,
pub level: u8,
@@ -7,7 +7,7 @@ use super::*;
use crate::portable::collection::IdSet;
use crate::portable::fixtures::geared_level_eighty;
use crate::portable::ids::{CharacterId, SessionId};
use crate::portable::model::{PortableCharacter, Ruleset};
use crate::portable::model::PortableCharacter;
use crate::portable::realm::knowledge::RealmKnowledge;
use crate::portable::store::Store;
@@ -328,10 +328,10 @@ fn a_realm_that_lacks_an_unlock_never_removes_it_and_gets_what_it_knows_back() {
// the Owner already holds a big wardrobe from other realms
let profile = owner.default_profile().unwrap();
owner
.merge_collection(profile, Ruleset::Coa, APPEARANCE, &ids(1..=500))
.merge_collection(profile, APPEARANCE, &ids(1..=500))
.unwrap();
owner
.merge_collection(profile, Ruleset::Coa, VANITY, &ids(1000..=1010))
.merge_collection(profile, VANITY, &ids(1000..=1010))
.unwrap();
// this realm knows only part of it and holds only a few
realm.knowledge = knows(ids(1..=300), ids(1000..=1005));
@@ -344,11 +344,7 @@ fn a_realm_that_lacks_an_unlock_never_removes_it_and_gets_what_it_knows_back() {
// the Owner unioned the realm's ids (700 included: the realm showed it) and kept everything else
let appearance_ack = acks.iter().find(|a| a.kind == APPEARANCE).unwrap();
assert_eq!(appearance_ack.outcome, CollectionOutcome::Applied);
let (_, canonical) = o
.store()
.collection(profile, Ruleset::Coa, APPEARANCE)
.unwrap()
.unwrap();
let (_, canonical) = o.store().collection(profile, APPEARANCE).unwrap().unwrap();
assert_eq!(canonical.len(), 501);
assert!(
canonical.contains(700) && canonical.contains(1) && canonical.contains(500),
@@ -375,14 +371,12 @@ fn an_account_with_unlocks_arrives_on_a_second_realm_from_the_owners_state_alone
let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
owner
.merge_collection(profile, Ruleset::Coa, APPEARANCE, &ids(1..=40))
.merge_collection(profile, APPEARANCE, &ids(1..=40))
.unwrap();
owner
.merge_collection(profile, Ruleset::Coa, VANITY, &ids(50..=60))
.unwrap();
let states = OwnerService::new(&mut owner)
.collection_states(Ruleset::Coa)
.merge_collection(profile, VANITY, &ids(50..=60))
.unwrap();
let states = OwnerService::new(&mut owner).collection_states().unwrap();
assert_eq!(states.len(), 2);
let mut host = Store::open_in_memory().unwrap();
@@ -421,17 +415,16 @@ fn hostile_or_broken_collection_messages_change_nothing() {
let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let mut o = OwnerService::new(&mut owner);
let good = collection_to_json(
&CollectionObserved::new(SERVER, Ruleset::Coa, APPEARANCE, &ids(1..=10)).unwrap(),
)
.unwrap();
let good =
collection_to_json(&CollectionObserved::new(SERVER, APPEARANCE, &ids(1..=10)).unwrap())
.unwrap();
assert_eq!(
o.handle_collection(&good).unwrap().outcome,
CollectionOutcome::Applied
);
let state_of = |o: &OwnerService| {
o.store()
.collection_info(profile, Ruleset::Coa, APPEARANCE)
.collection_info(profile, APPEARANCE)
.unwrap()
.unwrap()
};
@@ -494,39 +487,13 @@ fn hostile_or_broken_collection_messages_change_nothing() {
// a set that decodes to more ids than the cap allows is refused before it is built
let mut huge = vec![1u8];
huge.extend([0xFF, 0xFF, 0xFF, 0xFF, 0x0F]);
let message = serde_json::json!({"protocol_version": COLLECTION_PROTOCOL_VERSION, "ruleset": "coa", "server_id": SERVER, "kind": APPEARANCE, "set": {"hash": "00".repeat(32), "count": 1, "ids": base64::Engine::encode(&base64::engine::general_purpose::STANDARD, huge)}});
let message = serde_json::json!({"protocol_version": PROTOCOL_VERSION, "server_id": SERVER, "kind": APPEARANCE, "set": {"hash": "00".repeat(32), "count": 1, "ids": base64::Engine::encode(&base64::engine::general_purpose::STANDARD, huge)}});
assert!(matches!(
o.handle_collection(&serde_json::to_vec(&message).unwrap())
.unwrap()
.outcome,
CollectionOutcome::Rejected(_)
));
// attack test: prefix-confusion collection kinds are strictly rejected with zero state change
for evil_kind in [
"coax:appearance",
"coaevil:vanity",
"wildcard2:appearance",
"reborn-extra:vanity",
"coa:",
"unknown",
"coa:appearance:extra",
] {
let mut v: serde_json::Value = serde_json::from_slice(&good).unwrap();
v["kind"] = evil_kind.into();
let ack = o
.handle_collection(&serde_json::to_vec(&v).unwrap())
.unwrap();
assert!(
matches!(ack.outcome, CollectionOutcome::Rejected(_)),
"evil kind {evil_kind} must be rejected"
);
}
assert_eq!(
state_of(&o),
before,
"prefix confusion attacks must mutate nothing"
);
}
#[test]
@@ -588,7 +555,7 @@ fn ten_thousand_and_fifty_thousand_ids_stay_cheap() {
assert_eq!(realm.full_reads, reads);
let stored = o
.store()
.collection_info(profile, Ruleset::Coa, APPEARANCE)
.collection_info(profile, APPEARANCE)
.unwrap()
.unwrap();
assert_eq!(stored.count, count as usize);
@@ -598,7 +565,7 @@ fn ten_thousand_and_fifty_thousand_ids_stay_cheap() {
let mut empty_realm = FakeRealm::new(GUID);
empty_realm.knowledge = realm.knowledge.clone();
let state = o
.collection_states(Ruleset::Coa)
.collection_states()
.unwrap()
.into_iter()
.find(|s| s.kind == APPEARANCE)
@@ -660,7 +627,7 @@ fn a_lost_acknowledgement_resends_the_same_set_and_the_owner_counts_it_once() {
.any(|p| p.kind == APPEARANCE));
assert_eq!(
o.store()
.collection_info(profile, Ruleset::Coa, APPEARANCE)
.collection_info(profile, APPEARANCE)
.unwrap()
.unwrap()
.revision,
@@ -771,102 +738,3 @@ fn a_session_that_changes_nothing_on_a_format_1_store_makes_no_new_revision() {
"the same character in a newer format is not a change"
);
}
#[test]
fn wildcard_and_coa_collections_remain_strictly_isolated() {
let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let coa_set = IdSet::from_ids([10, 20, 30]).unwrap();
let wc_set = IdSet::from_ids([10, 40, 50]).unwrap();
owner
.merge_collection(profile, Ruleset::Coa, "coa:appearance", &coa_set)
.unwrap();
owner
.merge_collection(profile, Ruleset::Wildcard, "wildcard:appearance", &wc_set)
.unwrap();
// Verify initial namespaces
let (_, s_coa) = owner
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(s_coa.ids(), &[10, 20, 30]);
let (_, s_wc) = owner
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(s_wc.ids(), &[10, 40, 50]);
let mut o = OwnerService::new(&mut owner);
// 1. Valid Wildcard observation updates Wildcard collection only
let wc_update = IdSet::from_ids([10, 40, 50, 60]).unwrap();
let msg_wc = CollectionObserved {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset: Ruleset::Wildcard,
server_id: "wc-realm".into(),
kind: "wildcard:appearance".into(),
set: CompactSet::seal("wildcard:appearance", &wc_update).unwrap(),
};
let ack = o.handle_collection(&to_json(&msg_wc).unwrap()).unwrap();
assert!(matches!(
ack.outcome,
CollectionOutcome::Applied | CollectionOutcome::Unchanged
));
// CoA remains exactly [10, 20, 30]
let (_, s_coa_after) = o
.store()
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(s_coa_after.ids(), &[10, 20, 30]);
// Wildcard updated to [10, 40, 50, 60]
let (_, s_wc_after) = o
.store()
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(s_wc_after.ids(), &[10, 40, 50, 60]);
// 2. Cross-ruleset injection attack: Wildcard message carrying coa:appearance is rejected
let rogue_wc = CollectionObserved {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset: Ruleset::Wildcard,
server_id: "wc-realm".into(),
kind: "coa:appearance".into(),
set: CompactSet::seal("coa:appearance", &IdSet::from_ids([999]).unwrap()).unwrap(),
};
let ack_rogue = o.handle_collection(&to_json(&rogue_wc).unwrap()).unwrap();
assert!(matches!(ack_rogue.outcome, CollectionOutcome::Rejected(_)));
// 3. Cross-ruleset injection attack: CoA message carrying wildcard:appearance is rejected
let rogue_coa = CollectionObserved {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset: Ruleset::Coa,
server_id: "coa-realm".into(),
kind: "wildcard:appearance".into(),
set: CompactSet::seal("wildcard:appearance", &IdSet::from_ids([999]).unwrap()).unwrap(),
};
let ack_rogue2 = o.handle_collection(&to_json(&rogue_coa).unwrap()).unwrap();
assert!(matches!(ack_rogue2.outcome, CollectionOutcome::Rejected(_)));
// Verify neither 999 touched CoA or Wildcard
let (_, s_coa_final) = o
.store()
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(s_coa_final.ids(), &[10, 20, 30]);
let (_, s_wc_final) = o
.store()
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(s_wc_final.ids(), &[10, 40, 50, 60]);
}
+4 -8
View File
@@ -467,20 +467,16 @@ impl RealmBridge for FakeRealm {
impl FakeRealm {
fn rows(&self, kind: &str) -> Result<&IdSet> {
match kind {
"coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
Ok(&self.appearance_rows)
}
"coa:vanity" | "wildcard:vanity" | "reborn:vanity" => Ok(&self.vanity_rows),
"coa:appearance" => Ok(&self.appearance_rows),
"coa:vanity" => Ok(&self.vanity_rows),
other => Err(PortableError::Invalid(format!("unknown kind {other}"))),
}
}
fn rows_mut(&mut self, kind: &str) -> Result<&mut IdSet> {
match kind {
"coa:appearance" | "wildcard:appearance" | "reborn:appearance" => {
Ok(&mut self.appearance_rows)
}
"coa:vanity" | "wildcard:vanity" | "reborn:vanity" => Ok(&mut self.vanity_rows),
"coa:appearance" => Ok(&mut self.appearance_rows),
"coa:vanity" => Ok(&mut self.vanity_rows),
other => Err(PortableError::Invalid(format!("unknown kind {other}"))),
}
}
+5 -39
View File
@@ -176,26 +176,6 @@ impl<'a> HostService<'a> {
found: model.character_id,
});
}
if offer.ruleset != model.ruleset {
return Err(PortableError::RulesetMismatch {
character: model.ruleset,
realm: offer.ruleset,
});
}
if let Some((_, rs)) = self.server_id.split_once(':') {
let host_ruleset = rs.parse::<crate::portable::Ruleset>().map_err(|_| {
PortableError::Invalid(format!(
"malformed or unknown ruleset suffix in server_id: {:?}",
self.server_id
))
})?;
if offer.ruleset != host_ruleset || model.ruleset != host_ruleset {
return Err(PortableError::RulesetMismatch {
character: model.ruleset,
realm: host_ruleset,
});
}
}
self.store
.host_install_copy(profile, &model, offer.canonical_revision, "owner")?;
self.store.host_prepare_session(offer, &model)
@@ -626,16 +606,8 @@ impl<'a> HostService<'a> {
let Some(account) = bridge.account_of(guid)? else {
continue;
};
let character = self.store.character(s.character_id)?;
for kind in collection_kinds(character.ruleset) {
self.observe_collection(
bridge,
account,
character.ruleset,
kind,
now_secs,
events,
)?;
for kind in COLLECTION_KINDS {
self.observe_collection(bridge, account, kind, now_secs, events)?;
}
}
Ok(())
@@ -647,7 +619,6 @@ impl<'a> HostService<'a> {
&mut self,
bridge: &mut dyn RealmBridge,
account: u32,
ruleset: crate::portable::model::Ruleset,
kind: &str,
now_secs: u64,
events: &mut Vec<HostEvent>,
@@ -673,12 +644,7 @@ impl<'a> HostService<'a> {
)?;
return Ok(());
}
let bytes = collection_to_json(&CollectionObserved::new(
&self.server_id,
ruleset,
kind,
&set,
)?)?;
let bytes = collection_to_json(&CollectionObserved::new(&self.server_id, kind, &set)?)?;
self.store.host_collection_observe(
&self.server_id,
account,
@@ -708,7 +674,7 @@ impl<'a> HostService<'a> {
account: u32,
ack: &CollectionAck,
) -> Result<Option<Applied>> {
if !carried_kind_for(&ack.kind, ack.ruleset) {
if !carried_kind(&ack.kind) {
return Err(PortableError::Invalid(
"the acknowledgement is for a kind that is not carried".into(),
));
@@ -776,7 +742,7 @@ impl<'a> HostService<'a> {
account: u32,
state: &CollectionState,
) -> Result<Option<Applied>> {
if !carried_kind_for(&state.kind, state.ruleset) {
if !carried_kind(&state.kind) {
return Err(PortableError::Invalid(
"the collection kind is not carried".into(),
));
+14 -31
View File
@@ -49,15 +49,10 @@ impl<'a> OwnerService<'a> {
pub fn handle_collection(&mut self, bytes: &[u8]) -> Result<CollectionAck> {
let msg: CollectionObserved = collection_from_json(bytes)?;
let profile = self.store.default_profile()?;
let ruleset = msg.ruleset;
let rejected = |store: &Store, reason: &str| -> Result<CollectionAck> {
let info = store
.collection_info(profile, ruleset, &msg.kind)
.ok()
.flatten();
let info = store.collection_info(profile, &msg.kind).ok().flatten();
Ok(CollectionAck {
protocol_version: crate::portable::session::protocol::COLLECTION_PROTOCOL_VERSION,
ruleset,
protocol_version: PROTOCOL_VERSION,
kind: msg.kind.clone(),
outcome: CollectionOutcome::Rejected(reason.to_string()),
collection_revision: info.as_ref().map_or(0, |i| i.revision),
@@ -65,39 +60,30 @@ impl<'a> OwnerService<'a> {
canonical: None,
})
};
if !carried_kind_for(&msg.kind, ruleset) {
return rejected(
self.store,
"this collection kind is not carried for this ruleset",
);
if !carried_kind(&msg.kind) {
return rejected(self.store, "this collection kind is not carried");
}
let observed = match msg.set.open(&msg.kind) {
Ok(set) => set,
Err(e) => return rejected(self.store, &e.to_string()),
};
let merge = self
.store
.merge_collection(profile, ruleset, &msg.kind, &observed)?;
let merge = self.store.merge_collection(profile, &msg.kind, &observed)?;
let (info, canonical) = self
.store
.collection(profile, ruleset, &msg.kind)?
.collection(profile, &msg.kind)?
.map(|(i, s)| (Some(i), s))
.unwrap_or((None, IdSet::new()));
let canonical_state = match (
&info,
observed.count_new(&canonical) == 0 && canonical.count_new(&observed) == 0,
) {
(Some(info), false) => Some(CollectionState::new(
ruleset,
&msg.kind,
info.revision,
&canonical,
)?),
(Some(info), false) => {
Some(CollectionState::new(&msg.kind, info.revision, &canonical)?)
}
_ => None,
};
Ok(CollectionAck {
protocol_version: crate::portable::session::protocol::COLLECTION_PROTOCOL_VERSION,
ruleset,
protocol_version: PROTOCOL_VERSION,
kind: msg.kind,
outcome: if merge.changed {
CollectionOutcome::Applied
@@ -111,15 +97,12 @@ impl<'a> OwnerService<'a> {
}
/// The canonical collections as messages (for a realm that has none of them yet, or a new one).
pub fn collection_states(
&mut self,
ruleset: crate::portable::model::Ruleset,
) -> Result<Vec<CollectionState>> {
pub fn collection_states(&mut self) -> Result<Vec<CollectionState>> {
let profile = self.store.default_profile()?;
let mut out = Vec::new();
for kind in collection_kinds(ruleset) {
if let Some((info, set)) = self.store.collection(profile, ruleset, kind)? {
out.push(CollectionState::new(ruleset, kind, info.revision, &set)?);
for kind in COLLECTION_KINDS {
if let Some((info, set)) = self.store.collection(profile, kind)? {
out.push(CollectionState::new(kind, info.revision, &set)?);
}
}
Ok(out)
@@ -128,7 +128,7 @@ fn a_changed_content_profile_makes_the_realm_report_its_collections_again_and_re
} = rig(|_| {});
let profile = owner.default_profile().unwrap();
owner
.merge_collection(profile, Ruleset::Coa, APPEARANCE, &ids(1..=500))
.merge_collection(profile, APPEARANCE, &ids(1..=500))
.unwrap();
// the realm's client data knows 1..=300 of the canonical 500
realm.knowledge = RealmKnowledge::new(ids(1..=300), IdSet::new());
@@ -186,7 +186,7 @@ fn a_changed_content_profile_makes_the_realm_report_its_collections_again_and_re
);
assert_eq!(
o.store()
.collection(profile, Ruleset::Coa, APPEARANCE)
.collection(profile, APPEARANCE)
.unwrap()
.unwrap()
.1
@@ -371,10 +371,9 @@ fn a_session_started_without_its_projection_or_with_a_wrong_one_is_not_opened()
);
// an older protocol is not understood at all
let old = String::from_utf8(genuine.clone()).unwrap().replace(
&format!("\"protocol_version\":{PROTOCOL_VERSION}"),
"\"protocol_version\":1",
);
let old = String::from_utf8(genuine.clone())
.unwrap()
.replace("\"protocol_version\":2", "\"protocol_version\":1");
assert!(o.handle_started(old.as_bytes()).is_err());
assert_eq!(
o.handle_started(&genuine).unwrap().outcome,
+19 -185
View File
@@ -13,19 +13,14 @@ use super::super::model::{limits::MAX_COMPRESSED_BYTES, PortableCharacter};
use super::super::projection::{ProgressionPin, ProjectionContext};
use super::super::snapshot;
/// Version 3: `SessionOffer`, `PortableSessionStarted`, `PortableCheckpoint`, and `OwnerAck` require explicit `ruleset`.
/// Version 2 (Phase 8): `PortableSessionStarted` carried progression and pins.
pub const SESSION_PROTOCOL_VERSION: u32 = 3;
/// Protocol version for collection synchronization (`CollectionObserved`, `CollectionState`, `CollectionAck`).
pub const COLLECTION_PROTOCOL_VERSION: u32 = 2;
/// Backward-compatibility alias for session protocol version.
pub const PROTOCOL_VERSION: u32 = SESSION_PROTOCOL_VERSION;
/// Version 2 (Phase 8): `PortableSessionStarted` carries the progression the session runs under, every `PortableCheckpoint` and `OwnerAck` its pin.
/// A version 1 peer and a version 2 peer read each other's messages as unsupported, and the realm's capability profile (`session_protocol`)
/// says so before any character is armed.
pub const PROTOCOL_VERSION: u32 = 2;
/// A message carries at most one compressed snapshot (base64: 4/3) plus a little structure.
pub const MAX_MESSAGE_BYTES: usize = MAX_COMPRESSED_BYTES * 4 / 3 + 64 * 1024;
/// The most item/pet ids an acknowledgement lists.
pub const MAX_ACK_IDS: usize = 20_000;
/// The largest serialized collection message accepted.
pub const MAX_COLLECTION_MESSAGE_BYTES: usize = 1024 * 1024;
/// A sealed snapshot: the hash of the canonical JSON and the compressed bytes.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
@@ -84,7 +79,6 @@ impl Envelope {
#[serde(deny_unknown_fields)]
pub struct SessionOffer {
pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId,
pub character_id: CharacterId,
pub server_id: String,
@@ -129,7 +123,6 @@ impl SessionProgression {
#[serde(deny_unknown_fields)]
pub struct PortableSessionStarted {
pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId,
pub character_id: CharacterId,
pub server_id: String,
@@ -146,7 +139,6 @@ pub struct PortableSessionStarted {
#[serde(deny_unknown_fields)]
pub struct PortableCheckpoint {
pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId,
pub character_id: CharacterId,
pub server_id: String,
@@ -196,7 +188,6 @@ pub struct NextSession {
#[serde(deny_unknown_fields)]
pub struct OwnerAck {
pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub session_id: SessionId,
/// 0 acknowledges `PortableSessionStarted`.
pub sequence: u64,
@@ -259,17 +250,16 @@ impl PortableSessionStarted {
if let Some(p) = &progression {
p.validate()?;
}
let sealed_b0 = Envelope::seal(b0)?;
let b0 = Envelope::seal(b0)?;
Ok(Self {
protocol_version: PROTOCOL_VERSION,
ruleset: b0.ruleset,
session_id,
character_id,
server_id: server_id.to_string(),
base_canonical_revision,
baseline_generation,
content_hash: sealed_b0.content_hash.clone(),
b0: sealed_b0,
content_hash: b0.content_hash.clone(),
b0,
progression,
})
}
@@ -289,7 +279,6 @@ impl PortableCheckpoint {
let realm_snapshot = Envelope::seal(b1)?;
Ok(Self {
protocol_version: PROTOCOL_VERSION,
ruleset: b1.ruleset,
session_id,
character_id,
server_id: server_id.to_string(),
@@ -311,32 +300,15 @@ impl PortableCheckpoint {
use super::super::collection::{valid_kind, IdSet, MAX_ENCODED_BYTES};
/// The collection kinds the protocol carries.
pub const COLLECTION_KINDS: [&str; 6] = [
"coa:appearance",
"coa:vanity",
"wildcard:appearance",
"wildcard:vanity",
"reborn:appearance",
"reborn:vanity",
];
pub fn collection_kinds(ruleset: super::super::model::Ruleset) -> &'static [&'static str] {
match ruleset {
super::super::model::Ruleset::Coa => &["coa:appearance", "coa:vanity"],
super::super::model::Ruleset::Wildcard => &["wildcard:appearance", "wildcard:vanity"],
super::super::model::Ruleset::Reborn => &["reborn:appearance", "reborn:vanity"],
}
}
/// The collection kinds the v1 protocol carries.
pub const COLLECTION_KINDS: [&str; 2] = ["coa:appearance", "coa:vanity"];
/// A collection message carries at most one encoded set (base64: 4/3) plus a little structure.
pub const MAX_COLLECTION_MESSAGE_BYTES: usize = MAX_ENCODED_BYTES * 4 / 3 + 64 * 1024;
pub fn carried_kind(kind: &str) -> bool {
valid_kind(kind) && COLLECTION_KINDS.contains(&kind)
}
pub fn carried_kind_for(kind: &str, ruleset: super::super::model::Ruleset) -> bool {
valid_kind(kind) && collection_kinds(ruleset).contains(&kind)
}
/// A compact id set as it travels: hash of the kind and content, number of ids, base64 of [`IdSet::encode`].
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
@@ -393,7 +365,6 @@ impl CompactSet {
#[serde(deny_unknown_fields)]
pub struct CollectionObserved {
pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub server_id: String,
pub kind: String,
pub set: CompactSet,
@@ -404,7 +375,6 @@ pub struct CollectionObserved {
#[serde(deny_unknown_fields)]
pub struct CollectionState {
pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub kind: String,
pub collection_revision: u64,
pub set: CompactSet,
@@ -430,7 +400,6 @@ pub enum CollectionOutcome {
#[serde(deny_unknown_fields)]
pub struct CollectionAck {
pub protocol_version: u32,
pub ruleset: super::super::model::Ruleset,
pub kind: String,
pub outcome: CollectionOutcome,
pub collection_revision: u64,
@@ -461,30 +430,24 @@ pub fn collection_from_json<T: DeserializeOwned>(bytes: &[u8]) -> Result<T> {
.get("protocol_version")
.and_then(|v| v.as_u64())
.ok_or_else(|| PortableError::Invalid("the message has no protocol version".into()))?;
if version != COLLECTION_PROTOCOL_VERSION as u64 {
if version != PROTOCOL_VERSION as u64 {
return Err(PortableError::UnsupportedFormat {
found: version.min(u32::MAX as u64) as u32,
supported: COLLECTION_PROTOCOL_VERSION,
supported: PROTOCOL_VERSION,
});
}
Ok(serde_json::from_value(value)?)
}
impl CollectionObserved {
pub fn new(
server_id: &str,
ruleset: super::super::model::Ruleset,
kind: &str,
set: &IdSet,
) -> Result<Self> {
if !carried_kind_for(kind, ruleset) {
pub fn new(server_id: &str, kind: &str, set: &IdSet) -> Result<Self> {
if !carried_kind(kind) {
return Err(PortableError::Invalid(format!(
"collection kind {kind:?} is not carried for {ruleset:?}"
"collection kind {kind:?} is not carried"
)));
}
Ok(Self {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset,
protocol_version: PROTOCOL_VERSION,
server_id: server_id.to_string(),
kind: kind.to_string(),
set: CompactSet::seal(kind, set)?,
@@ -493,141 +456,12 @@ impl CollectionObserved {
}
impl CollectionState {
pub fn new(
ruleset: super::super::model::Ruleset,
kind: &str,
revision: u64,
set: &IdSet,
) -> Result<Self> {
pub fn new(kind: &str, revision: u64, set: &IdSet) -> Result<Self> {
Ok(Self {
protocol_version: COLLECTION_PROTOCOL_VERSION,
ruleset,
protocol_version: PROTOCOL_VERSION,
kind: kind.to_string(),
collection_revision: revision,
set: CompactSet::seal(kind, set)?,
})
}
}
/// Legacy Session Protocol v2 representation (Phase 8), where absence of ruleset is defined to mean CoA.
#[derive(Debug, Clone, PartialEq, Eq, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct LegacyV2SessionOffer {
pub protocol_version: u32,
pub session_id: SessionId,
pub character_id: CharacterId,
pub server_id: String,
pub canonical_revision: u64,
pub snapshot: Envelope,
}
impl LegacyV2SessionOffer {
pub fn into_session_offer(self) -> SessionOffer {
SessionOffer {
protocol_version: SESSION_PROTOCOL_VERSION,
ruleset: super::super::model::Ruleset::Coa,
session_id: self.session_id,
character_id: self.character_id,
server_id: self.server_id,
canonical_revision: self.canonical_revision,
snapshot: self.snapshot,
}
}
}
#[cfg(test)]
mod protocol_tests {
use super::*;
use crate::portable::Ruleset;
#[test]
fn session_protocol_v3_requires_ruleset_and_rejects_missing_or_unknown() {
let envelope = Envelope {
content_hash: "00".repeat(32),
payload: "AA==".to_string(),
};
// 1. Valid v3 SessionOffer with explicit ruleset (CoA, Wildcard, Reborn)
for r in [Ruleset::Coa, Ruleset::Wildcard, Ruleset::Reborn] {
let offer = SessionOffer {
protocol_version: SESSION_PROTOCOL_VERSION,
ruleset: r,
session_id: SessionId::new(),
character_id: CharacterId::new(),
server_id: "realm-1".to_string(),
canonical_revision: 1,
snapshot: envelope.clone(),
};
let bytes = to_json(&offer).unwrap();
let parsed: SessionOffer = from_json(&bytes).unwrap();
assert_eq!(parsed.ruleset, r);
}
// 2. Missing ruleset in v3 JSON is rejected (never silently defaults to CoA)
let missing_ruleset_v3 = serde_json::json!({
"protocol_version": SESSION_PROTOCOL_VERSION,
"session_id": SessionId::new().to_string(),
"character_id": CharacterId::new().to_string(),
"server_id": "realm-1",
"canonical_revision": 1,
"snapshot": {
"content_hash": "00".repeat(32),
"payload": "AA=="
}
});
let bytes = serde_json::to_vec(&missing_ruleset_v3).unwrap();
let err: std::result::Result<SessionOffer, _> = from_json(&bytes);
assert!(
err.is_err(),
"missing ruleset must be rejected in protocol v3"
);
// 3. Unknown ruleset in v3 JSON is rejected
let unknown_ruleset_v3 = serde_json::json!({
"protocol_version": SESSION_PROTOCOL_VERSION,
"ruleset": "cyberpunk",
"session_id": SessionId::new().to_string(),
"character_id": CharacterId::new().to_string(),
"server_id": "realm-1",
"canonical_revision": 1,
"snapshot": {
"content_hash": "00".repeat(32),
"payload": "AA=="
}
});
let bytes = serde_json::to_vec(&unknown_ruleset_v3).unwrap();
let err: std::result::Result<SessionOffer, _> = from_json(&bytes);
assert!(err.is_err(), "unknown ruleset must be rejected");
// 4. Old v2 peer message (protocol_version 2) is rejected by current v3 parser
let legacy_v2_json = serde_json::json!({
"protocol_version": 2,
"session_id": SessionId::new().to_string(),
"character_id": CharacterId::new().to_string(),
"server_id": "realm-1",
"canonical_revision": 1,
"snapshot": {
"content_hash": "00".repeat(32),
"payload": "AA=="
}
});
let bytes = serde_json::to_vec(&legacy_v2_json).unwrap();
let err: std::result::Result<SessionOffer, _> = from_json(&bytes);
assert!(
matches!(
err,
Err(PortableError::UnsupportedFormat {
found: 2,
supported: 3
})
),
"v2 peer must be rejected with UnsupportedFormat"
);
// 5. Explicit LegacyV2SessionOffer decode correctly interprets absence of ruleset as CoA
let v2_parsed: LegacyV2SessionOffer = serde_json::from_slice(&bytes).unwrap();
let upgraded = v2_parsed.into_session_offer();
assert_eq!(upgraded.ruleset, Ruleset::Coa);
assert_eq!(upgraded.protocol_version, SESSION_PROTOCOL_VERSION);
}
}
@@ -4,7 +4,6 @@ use super::bridge::*;
use super::fake::*;
use super::protocol::*;
use super::*;
use crate::portable::error::PortableError;
use crate::portable::fixtures::geared_level_eighty;
use crate::portable::ids::{CharacterId, PortableItemId, SessionId};
use crate::portable::model::*;
@@ -1052,611 +1051,3 @@ fn an_autosave_between_checkpoints_is_harmless() {
c0.progression.money + 10
);
}
fn setup_wildcard_in(mut owner: Store, mut host: Store, server_id: &str) -> Setup {
let profile = owner.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Wildcard;
model.content_namespace = "wildcard".into();
let id = owner
.create_character(profile, model, "wildcard-origin")
.unwrap();
let c0 = owner.load_current(id).unwrap();
let offer = OwnerService::new(&mut owner).offer(id, server_id).unwrap();
let host_profile = host.default_profile().unwrap();
let mut realm = FakeRealm::new(GUID);
realm.normalize = normalizes;
{
let mut h = HostService::new(&mut host, server_id, HostConfig::default());
h.accept_offer(host_profile, &offer).unwrap();
realm
.import(
&mut host,
id,
server_id,
offer.canonical_revision,
offer.session_id,
)
.unwrap();
HostService::new(&mut host, server_id, HostConfig::default())
.bind(offer.session_id, GUID)
.unwrap();
}
Setup {
owner,
host,
realm,
id,
session: offer.session_id,
c0,
}
}
fn setup_reborn_in(mut owner: Store, mut host: Store, server_id: &str) -> Setup {
let profile = owner.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Reborn;
model.content_namespace = "reborn".into();
let id = owner
.create_character(profile, model, "reborn-origin")
.unwrap();
let c0 = owner.load_current(id).unwrap();
let offer = OwnerService::new(&mut owner).offer(id, server_id).unwrap();
let host_profile = host.default_profile().unwrap();
let mut realm = FakeRealm::new(GUID);
realm.normalize = normalizes;
{
let mut h = HostService::new(&mut host, server_id, HostConfig::default());
h.accept_offer(host_profile, &offer).unwrap();
realm
.import(
&mut host,
id,
server_id,
offer.canonical_revision,
offer.session_id,
)
.unwrap();
HostService::new(&mut host, server_id, HostConfig::default())
.bind(offer.session_id, GUID)
.unwrap();
}
Setup {
owner,
host,
realm,
id,
session: offer.session_id,
c0,
}
}
#[test]
fn wildcard_session_offer_carrying_coa_snapshot_is_rejected_with_zero_mutation() {
let mut owner = Store::open_in_memory().unwrap();
let mut host = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let host_profile = host.default_profile().unwrap();
let coa_model = geared_level_eighty();
let id = owner
.create_character(profile, coa_model, "realm-a")
.unwrap();
let mut offer = OwnerService::new(&mut owner)
.offer(id, "srv-1:wildcard")
.unwrap();
// Tamper offer: claim it is Wildcard while snapshot is CoA
offer.ruleset = Ruleset::Wildcard;
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let res = h.accept_offer(host_profile, &offer);
assert!(matches!(
res,
Err(PortableError::RulesetMismatch {
character: Ruleset::Coa,
realm: Ruleset::Wildcard
})
));
// Zero mutation on host
assert!(host.character(id).is_err());
assert!(host.host_session(offer.session_id).unwrap().is_none());
}
#[test]
fn wildcard_portable_session_started_marked_coa_is_rejected() {
let Setup {
mut owner,
mut host,
mut realm,
session,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
realm.login();
h.tick(&mut realm, 0).unwrap();
let outbox = h.outbox().unwrap();
assert_eq!(outbox.len(), 1);
let mut started: PortableSessionStarted = from_json(&outbox[0].bytes).unwrap();
// Tamper: mark as CoA
started.ruleset = Ruleset::Coa;
let tampered_bytes = to_json(&started).unwrap();
let ack = o.handle_started(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
// Owner session remains offered, never open
let (state, _, _) = o.session(session).unwrap().unwrap();
assert_eq!(state, "offered");
}
#[test]
fn wildcard_checkpoint_marked_reborn_is_rejected() {
let Setup {
mut owner,
mut host,
mut realm,
id,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
start(&mut h, &mut o, &mut realm);
realm.play(|m| m.progression.money += 500);
h.tick(&mut realm, 100).unwrap();
h.tick(&mut realm, 101).unwrap();
let outbox = h.outbox().unwrap();
let checkpoint_msg = outbox.iter().find(|m| !m.started).unwrap();
let mut cp: PortableCheckpoint = from_json(&checkpoint_msg.bytes).unwrap();
// Tamper: mark as Reborn
cp.ruleset = Ruleset::Reborn;
let tampered_bytes = to_json(&cp).unwrap();
let initial_rev = o.store().character(id).unwrap().revision;
let initial_snapshot = o.store().load_snapshot(id, initial_rev).unwrap();
let ack = o.handle_checkpoint(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
// Zero canonical revision change or mutation
assert_eq!(o.store().character(id).unwrap().revision, initial_rev);
assert_eq!(
o.store().load_snapshot(id, initial_rev).unwrap(),
initial_snapshot
);
}
#[test]
fn wildcard_session_using_coa_server_id_is_rejected() {
let mut owner = Store::open_in_memory().unwrap();
let mut host = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let host_profile = host.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Wildcard;
let id = owner
.create_character(profile, model, "wildcard-origin")
.unwrap();
// Offer for srv-1:coa
let offer = OwnerService::new(&mut owner)
.offer(id, "srv-1:coa")
.unwrap();
// Host configured for Wildcard realm
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let res = h.accept_offer(host_profile, &offer);
assert!(matches!(res, Err(PortableError::Invalid(_))));
}
#[test]
fn same_character_id_with_foreign_ruleset_is_rejected() {
let mut owner = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let mut model = geared_level_eighty();
model.ruleset = Ruleset::Wildcard;
let id = owner
.create_character(profile, model.clone(), "srv-1:wildcard")
.unwrap();
// Tampered snapshot with same ID but Ruleset::Coa
let mut tampered = model.clone();
tampered.character_id = id;
tampered.ruleset = Ruleset::Coa;
let res = owner.commit_snapshot(id, 1, tampered, "srv-1:wildcard", None);
assert!(matches!(res, Err(PortableError::RulesetChange { .. })));
}
#[test]
fn owner_ack_with_different_ruleset_is_rejected_by_host() {
let Setup {
mut owner,
mut host,
mut realm,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
realm.login();
h.tick(&mut realm, 0).unwrap();
let outbox = h.outbox().unwrap();
let mut ack = o.handle_started(&outbox[0].bytes).unwrap();
// Tamper ack ruleset to CoA
ack.ruleset = Ruleset::Coa;
let res = h.receive_ack(&mut realm, &ack);
assert!(matches!(
res,
Err(PortableError::RulesetMismatch {
character: Ruleset::Wildcard,
realm: Ruleset::Coa
})
));
}
#[test]
fn final_checkpoint_relabelled_coa_is_rejected() {
let Setup {
mut owner,
mut host,
mut realm,
id,
..
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
start(&mut h, &mut o, &mut realm);
realm.play(|m| m.progression.money += 1000);
realm.logout();
h.tick(&mut realm, 100).unwrap();
h.tick(&mut realm, 101).unwrap();
let outbox = h.outbox().unwrap();
let final_cp_msg = outbox.iter().find(|m| !m.started).unwrap();
let mut cp: PortableCheckpoint = from_json(&final_cp_msg.bytes).unwrap();
assert!(cp.final_checkpoint);
// Relabel as CoA
cp.ruleset = Ruleset::Coa;
let tampered_bytes = to_json(&cp).unwrap();
let initial_rev = o.store().character(id).unwrap().revision;
let ack = o.handle_checkpoint(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
// Revision must not advance and state must not be committed
assert_eq!(o.store().character(id).unwrap().revision, initial_rev);
}
#[test]
fn full_wildcard_session_lifecycle() {
let Setup {
mut owner,
mut host,
mut realm,
id,
session,
c0,
} = setup_wildcard_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:wildcard",
);
let mut h = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
// 1. Start session
start(&mut h, &mut o, &mut realm);
assert_eq!(o.session(session).unwrap().unwrap().0, "open");
// 2. Play on Wildcard realm: earn gold and level up
realm.play(|m| {
m.progression.money += 50_000;
m.progression.xp += 1_000;
});
// 3. Online checkpoint
checkpoint(&mut h, &mut o, &mut realm, 100);
let rev2 = o.store().character(id).unwrap().revision;
assert_eq!(rev2, 2);
let curr2 = o.store().load_current(id).unwrap();
assert_eq!(curr2.ruleset, Ruleset::Wildcard);
assert_eq!(curr2.progression.money, c0.progression.money + 50_000);
// 4. More gameplay then logout
realm.play(|m| {
m.progression.money += 25_000;
});
realm.logout();
h.tick(&mut realm, 200).unwrap();
h.tick(&mut realm, 201).unwrap();
let acks = deliver(&mut h, &mut o, &mut realm);
assert!(acks.iter().any(|a| a.outcome == AckOutcome::Applied));
// 5. Verify final canonical state
let rec = o.store().character(id).unwrap();
assert_eq!(rec.revision, 3);
assert_eq!(rec.ruleset, Ruleset::Wildcard);
let final_model = o.store().load_current(id).unwrap();
assert_eq!(final_model.ruleset, Ruleset::Wildcard);
assert_eq!(final_model.progression.money, c0.progression.money + 75_000);
}
#[test]
fn reborn_hostile_attacks_are_rejected_with_zero_mutation() {
let mut owner = Store::open_in_memory().unwrap();
let mut host = Store::open_in_memory().unwrap();
let profile = owner.default_profile().unwrap();
let host_profile = host.default_profile().unwrap();
let coa_model = geared_level_eighty();
let id_coa = owner
.create_character(profile, coa_model, "realm-coa")
.unwrap();
let mut wc_model = geared_level_eighty();
wc_model.ruleset = Ruleset::Wildcard;
let id_wc = owner
.create_character(profile, wc_model, "realm-wc")
.unwrap();
let mut reb_model = geared_level_eighty();
reb_model.ruleset = Ruleset::Reborn;
let id_reb = owner
.create_character(profile, reb_model, "realm-reb")
.unwrap();
// 1. Reborn offer carrying CoA snapshot
let mut offer_reb_with_coa = OwnerService::new(&mut owner)
.offer(id_coa, "srv-1:reborn")
.unwrap();
offer_reb_with_coa.ruleset = Ruleset::Reborn;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res1 = h_reborn.accept_offer(host_profile, &offer_reb_with_coa);
assert!(matches!(
res1,
Err(PortableError::RulesetMismatch {
character: Ruleset::Coa,
realm: Ruleset::Reborn
})
));
}
assert!(host.character(id_coa).is_err());
// 2. Reborn offer carrying Wildcard snapshot
let mut offer_reb_with_wc = OwnerService::new(&mut owner)
.offer(id_wc, "srv-1:reborn")
.unwrap();
offer_reb_with_wc.ruleset = Ruleset::Reborn;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res2 = h_reborn.accept_offer(host_profile, &offer_reb_with_wc);
assert!(matches!(
res2,
Err(PortableError::RulesetMismatch {
character: Ruleset::Wildcard,
realm: Ruleset::Reborn
})
));
}
assert!(host.character(id_wc).is_err());
// 3. CoA offer -> Reborn realm
let mut offer_coa = OwnerService::new(&mut owner)
.offer(id_coa, "srv-1:reborn")
.unwrap();
offer_coa.ruleset = Ruleset::Coa;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res3 = h_reborn.accept_offer(host_profile, &offer_coa);
assert!(matches!(
res3,
Err(PortableError::RulesetMismatch {
character: Ruleset::Coa,
realm: Ruleset::Reborn
})
));
}
// 4. Wildcard offer -> Reborn realm
let mut offer_wc = OwnerService::new(&mut owner)
.offer(id_wc, "srv-1:reborn")
.unwrap();
offer_wc.ruleset = Ruleset::Wildcard;
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let res4 = h_reborn.accept_offer(host_profile, &offer_wc);
assert!(matches!(
res4,
Err(PortableError::RulesetMismatch {
character: Ruleset::Wildcard,
realm: Ruleset::Reborn
})
));
}
// 5. Reborn offer -> CoA realm
let mut offer_reb = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:coa")
.unwrap();
offer_reb.ruleset = Ruleset::Reborn;
{
let mut h_coa = HostService::new(&mut host, "srv-1:coa", HostConfig::default());
let res5 = h_coa.accept_offer(host_profile, &offer_reb);
assert!(matches!(
res5,
Err(PortableError::RulesetMismatch {
character: Ruleset::Reborn,
realm: Ruleset::Coa
})
));
}
// 6. Reborn offer -> Wildcard realm
let mut offer_reb_to_wc = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:wildcard")
.unwrap();
offer_reb_to_wc.ruleset = Ruleset::Reborn;
{
let mut h_wc = HostService::new(&mut host, "srv-1:wildcard", HostConfig::default());
let res6 = h_wc.accept_offer(host_profile, &offer_reb_to_wc);
assert!(matches!(
res6,
Err(PortableError::RulesetMismatch {
character: Ruleset::Reborn,
realm: Ruleset::Wildcard
})
));
}
// 7. Reborn session using foreign server ID srv-1:coa or srv-1:wildcard
{
let mut h_reborn = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let offer_for_coa = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:coa")
.unwrap();
let res7 = h_reborn.accept_offer(host_profile, &offer_for_coa);
assert!(res7.is_err());
let offer_for_wc = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:wildcard")
.unwrap();
let res8 = h_reborn.accept_offer(host_profile, &offer_for_wc);
assert!(res8.is_err());
}
// 8. Reborn collection containing foreign collections coa:appearance or wildcard:vanity
let coll_err1 = host.merge_collection(
host_profile,
Ruleset::Reborn,
"coa:appearance",
&crate::portable::IdSet::from_ids([1]).unwrap(),
);
assert!(
coll_err1.is_err(),
"Reborn merging coa:appearance must fail"
);
let coll_err2 = host.merge_collection(
host_profile,
Ruleset::Reborn,
"wildcard:vanity",
&crate::portable::IdSet::from_ids([1]).unwrap(),
);
assert!(
coll_err2.is_err(),
"Reborn merging wildcard:vanity must fail"
);
// 9. HostService with malformed server_id ruleset suffixes fails closed
for bad_server_id in ["srv-1:unknown", "srv-1:garbage", "srv-1:reborn:extra"] {
let mut h_bad = HostService::new(&mut host, bad_server_id, HostConfig::default());
let mut offer_bad = OwnerService::new(&mut owner)
.offer(id_reb, "srv-1:reborn")
.unwrap();
offer_bad.server_id = bad_server_id.to_string();
let res_bad = h_bad.accept_offer(host_profile, &offer_bad);
assert!(
res_bad.is_err(),
"accept_offer on malformed server id {bad_server_id} must fail closed"
);
}
}
#[test]
fn full_reborn_session_lifecycle() {
let Setup {
mut owner,
mut host,
mut realm,
id,
session,
c0,
} = setup_reborn_in(
Store::open_in_memory().unwrap(),
Store::open_in_memory().unwrap(),
"srv-1:reborn",
);
let mut h = HostService::new(&mut host, "srv-1:reborn", HostConfig::default());
let mut o = OwnerService::new(&mut owner);
// 1. Start session
start(&mut h, &mut o, &mut realm);
assert_eq!(o.session(session).unwrap().unwrap().0, "open");
// 2. Play on Reborn realm: earn gold and level up
realm.play(|m| {
m.progression.money += 100_000;
m.progression.xp += 5_000;
});
// 3. Online checkpoint
checkpoint(&mut h, &mut o, &mut realm, 100);
let rev2 = o.store().character(id).unwrap().revision;
assert_eq!(rev2, 2);
let curr2 = o.store().load_current(id).unwrap();
assert_eq!(curr2.ruleset, Ruleset::Reborn);
assert_eq!(curr2.progression.money, c0.progression.money + 100_000);
// 4. Test Reborn checkpoint marked CoA / Wildcard rejected by owner
let outbox = h.outbox().unwrap();
if let Some(msg) = outbox.first() {
let mut cp: PortableCheckpoint = from_json(&msg.bytes).unwrap();
cp.ruleset = Ruleset::Coa;
let tampered_bytes = to_json(&cp).unwrap();
let initial_rev = o.store().character(id).unwrap().revision;
let ack = o.handle_checkpoint(&tampered_bytes).unwrap();
assert!(matches!(ack.outcome, AckOutcome::Rejected(_)));
assert_eq!(o.store().character(id).unwrap().revision, initial_rev);
}
// 5. Test OwnerAck marked CoA rejected by Reborn host
if let Some(msg) = outbox.first() {
if let Ok(mut ack) = o.handle_checkpoint(&msg.bytes) {
ack.ruleset = Ruleset::Coa;
let res_ack = h.receive_ack(&mut realm, &ack);
assert!(matches!(
res_ack,
Err(PortableError::RulesetMismatch {
character: Ruleset::Reborn,
realm: Ruleset::Coa
})
));
}
}
// 6. More gameplay then logout
realm.play(|m| {
m.progression.money += 50_000;
});
realm.logout();
h.tick(&mut realm, 200).unwrap();
h.tick(&mut realm, 201).unwrap();
let acks = deliver(&mut h, &mut o, &mut realm);
assert!(acks.iter().any(|a| a.outcome == AckOutcome::Applied));
// 7. Verify final canonical state
let rec = o.store().character(id).unwrap();
assert_eq!(rec.revision, 3);
assert_eq!(rec.ruleset, Ruleset::Reborn);
let final_model = o.store().load_current(id).unwrap();
assert_eq!(final_model.ruleset, Ruleset::Reborn);
assert_eq!(
final_model.progression.money,
c0.progression.money + 150_000
);
}
+10 -86
View File
@@ -174,12 +174,12 @@ impl Store {
}
fn init(conn: Connection) -> Result<Store> {
conn.pragma_update(None, "foreign_keys", true)?;
conn.busy_timeout(std::time::Duration::from_secs(5))?;
let _ = conn.pragma_update(None, "journal_mode", "WAL");
let _ = conn.pragma_update(None, "synchronous", "NORMAL");
let mut store = Store { conn };
store.migrate()?;
store.conn.pragma_update(None, "foreign_keys", true)?;
Ok(store)
}
@@ -206,13 +206,11 @@ impl Store {
});
}
for next in version..supported {
self.conn.pragma_update(None, "foreign_keys", false)?;
let tx = self.conn.transaction()?;
tx.execute_batch(MIGRATIONS[next as usize])?;
tx.pragma_update(None, "application_id", APPLICATION_ID)?;
tx.pragma_update(None, "user_version", next + 1)?;
tx.commit()?;
self.conn.pragma_update(None, "foreign_keys", true)?;
}
Ok(())
}
@@ -331,23 +329,6 @@ impl Store {
read_character(&self.conn, id)
}
pub fn get_character(
&self,
id: CharacterId,
expected_ruleset: Option<Ruleset>,
) -> Result<CharacterRecord> {
let rec = read_character(&self.conn, id)?;
if let Some(expected) = expected_ruleset {
if rec.ruleset != expected {
return Err(PortableError::RulesetMismatch {
character: rec.ruleset,
realm: expected,
});
}
}
Ok(rec)
}
pub fn list_characters(&self, profile: ProfileId) -> Result<Vec<CharacterRecord>> {
let mut stmt = self.conn.prepare(
"SELECT character_id FROM character WHERE profile_id = ?1 ORDER BY character_id",
@@ -360,22 +341,6 @@ impl Store {
.collect()
}
pub fn list_characters_by_ruleset(
&self,
profile: ProfileId,
ruleset: Ruleset,
) -> Result<Vec<CharacterRecord>> {
let mut stmt = self.conn.prepare(
"SELECT character_id FROM character WHERE profile_id = ?1 AND ruleset = ?2 ORDER BY character_id",
)?;
let ids: Vec<String> = stmt
.query_map(params![profile.to_string(), ruleset.as_str()], |r| r.get(0))?
.collect::<std::result::Result<_, _>>()?;
ids.iter()
.map(|text| read_character(&self.conn, text.parse()?))
.collect()
}
/// Every character of every profile (an overview for tools; normally the UI lists one profile).
pub fn list_characters_all(&self) -> Result<Vec<CharacterRecord>> {
let mut stmt = self
@@ -693,13 +658,13 @@ impl Store {
}
// ---- collections ----------------------------------------------------------------------------------------
// These APIs exchange CoA collections only. Preserve other schema-9 partitions without reading or modifying them.
/// `stored = stored U incoming`. Nothing is ever removed. When the union equals what is stored, no revision is
/// created and the hash stays the same.
pub fn merge_collection(
&mut self,
profile: ProfileId,
ruleset: Ruleset,
kind: &str,
incoming: &IdSet,
) -> Result<CollectionMerge> {
@@ -708,13 +673,6 @@ impl Store {
"invalid collection kind {kind:?}"
)));
}
if let Some((ns, _)) = kind.split_once(':') {
if matches!(ns, "coa" | "wildcard" | "reborn") && ns != ruleset.as_str() {
return Err(PortableError::Invalid(format!(
"collection kind namespace {ns:?} does not match ruleset {ruleset:?}"
)));
}
}
let tx = self.write_tx()?;
let profile_exists: bool = tx.query_row(
"SELECT EXISTS(SELECT 1 FROM profile WHERE profile_id = ?1)",
@@ -726,7 +684,7 @@ impl Store {
"profile {profile} does not exist"
)));
}
let stored = read_collection(&tx, profile, ruleset, kind)?;
let stored = read_collection(&tx, profile, kind)?;
let (current_set, revision) = match &stored {
Some((info, set)) => (set.clone(), info.revision),
None => (IdSet::new(), 0),
@@ -746,10 +704,10 @@ impl Store {
let at = now();
tx.execute(
"INSERT INTO collection(profile_id, ruleset, kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload)
VALUES (?1, ?2, ?3, ?4, ?5, ?6, ?7, ?8, ?9)
VALUES (?1, 'coa', ?2, ?3, ?4, ?5, ?6, ?7, ?8)
ON CONFLICT(profile_id, ruleset, kind) DO UPDATE SET collection_revision = excluded.collection_revision, collection_hash = excluded.collection_hash,
format_version = excluded.format_version, item_count = excluded.item_count, updated_at = excluded.updated_at, payload = excluded.payload",
params![profile.to_string(), ruleset.as_str(), kind, (revision + 1) as i64, hash.as_slice(), PORTABLE_COLLECTION_FORMAT_VERSION, merged.len() as i64, at, payload],
params![profile.to_string(), kind, (revision + 1) as i64, hash.as_slice(), PORTABLE_COLLECTION_FORMAT_VERSION, merged.len() as i64, at, payload],
)?;
tx.commit()?;
Ok(CollectionMerge {
@@ -769,14 +727,13 @@ impl Store {
pub fn collection_info(
&self,
profile: ProfileId,
ruleset: Ruleset,
kind: &str,
) -> Result<Option<CollectionInfo>> {
let row = self
.conn
.query_row(
"SELECT collection_revision, collection_hash, item_count, updated_at FROM collection WHERE profile_id = ?1 AND ruleset = ?2 AND kind = ?3",
params![profile.to_string(), ruleset.as_str(), kind],
"SELECT collection_revision, collection_hash, item_count, updated_at FROM collection WHERE profile_id = ?1 AND ruleset = 'coa' AND kind = ?2",
params![profile.to_string(), kind],
|r| Ok((r.get::<_, i64>(0)?, r.get::<_, Vec<u8>>(1)?, r.get::<_, i64>(2)?, r.get::<_, String>(3)?)),
)
.optional()?;
@@ -795,41 +752,9 @@ impl Store {
pub fn collection(
&self,
profile: ProfileId,
ruleset: Ruleset,
kind: &str,
) -> Result<Option<(CollectionInfo, IdSet)>> {
read_collection(&self.conn, profile, ruleset, kind)
}
pub fn list_collections(
&self,
profile: ProfileId,
ruleset: Ruleset,
) -> Result<Vec<CollectionInfo>> {
let mut stmt = self.conn.prepare(
"SELECT kind, collection_revision, collection_hash, item_count, updated_at FROM collection WHERE profile_id = ?1 AND ruleset = ?2 ORDER BY kind",
)?;
let rows = stmt.query_map(params![profile.to_string(), ruleset.as_str()], |r| {
Ok((
r.get::<_, String>(0)?,
r.get::<_, i64>(1)?,
r.get::<_, Vec<u8>>(2)?,
r.get::<_, i64>(3)?,
r.get::<_, String>(4)?,
))
})?;
let mut out = Vec::new();
for row in rows {
let (kind, revision, hash, count, updated_at) = row?;
out.push(CollectionInfo {
kind,
revision: revision as u64,
hash: hash_from_blob(hash)?,
count: count as usize,
updated_at,
});
}
Ok(out)
read_collection(&self.conn, profile, kind)
}
/// Rewrite the current revision exactly as format 1 stored it (the stores of Phases 1-5 hold such snapshots). Tests only.
@@ -853,13 +778,12 @@ impl Store {
fn read_collection(
conn: &Connection,
profile: ProfileId,
ruleset: Ruleset,
kind: &str,
) -> Result<Option<(CollectionInfo, IdSet)>> {
let row = conn
.query_row(
"SELECT collection_revision, collection_hash, item_count, updated_at, payload FROM collection WHERE profile_id = ?1 AND ruleset = ?2 AND kind = ?3",
params![profile.to_string(), ruleset.as_str(), kind],
"SELECT collection_revision, collection_hash, item_count, updated_at, payload FROM collection WHERE profile_id = ?1 AND ruleset = 'coa' AND kind = ?2",
params![profile.to_string(), kind],
|r| Ok((r.get::<_, i64>(0)?, r.get::<_, Vec<u8>>(1)?, r.get::<_, i64>(2)?, r.get::<_, String>(3)?, r.get::<_, Vec<u8>>(4)?)),
)
.optional()?;
@@ -579,13 +579,6 @@ impl Store {
Some(_) => {}
}
let at = now();
let record = read_character(&tx, s.character_id)?;
if ack.ruleset != record.ruleset {
return Err(PortableError::RulesetMismatch {
character: record.ruleset,
realm: ack.ruleset,
});
}
if ack.outcome.accepted() && ack.pin != s.pin {
return Err(PortableError::ProgressionChanged(
"the acknowledgement is under another progression profile than the session".into(),
+4 -34
View File
@@ -104,7 +104,6 @@ fn head_hash(conn: &Connection, id: CharacterId, revision: u64) -> Result<[u8; 3
}
fn ack(
ruleset: Ruleset,
session: SessionId,
sequence: u64,
outcome: AckOutcome,
@@ -113,7 +112,6 @@ fn ack(
) -> OwnerAck {
OwnerAck {
protocol_version: PROTOCOL_VERSION,
ruleset,
session_id: session,
sequence,
outcome,
@@ -138,10 +136,9 @@ fn owned_ids(
(items, pets)
}
fn offer_from_row(row: &OwnerRow, ruleset: Ruleset) -> SessionOffer {
fn offer_from_row(row: &OwnerRow) -> SessionOffer {
SessionOffer {
protocol_version: PROTOCOL_VERSION,
ruleset,
session_id: row.session_id,
character_id: row.character_id,
server_id: row.server_id.clone(),
@@ -166,7 +163,6 @@ fn open_offer(tx: &Transaction<'_>, id: CharacterId, server_id: &str) -> Result<
)?;
Ok(offer_from_row(
&read_owner_row(tx, session)?.expect("just inserted"),
record.ruleset,
))
}
@@ -190,7 +186,7 @@ impl Store {
return Err(PortableError::SessionOpen);
}
if row.c0_revision == record.revision {
return Ok(offer_from_row(&row, record.ruleset));
return Ok(offer_from_row(&row));
}
tx.execute("UPDATE owner_session SET state = 'superseded', updated_at = ?2 WHERE session_id = ?1", params![live, now()])?;
}
@@ -204,7 +200,6 @@ impl Store {
let tx = self.write_tx()?;
let Some(row) = read_owner_row(&tx, msg.session_id)? else {
return Ok(ack(
msg.ruleset,
msg.session_id,
0,
AckOutcome::Rejected("unknown session".into()),
@@ -212,11 +207,9 @@ impl Store {
[0; 32],
));
};
let record = read_character(&tx, row.character_id)?;
let current_hash = head_hash(&tx, row.character_id, row.head_revision)?;
let reject = |why: &str| {
ack(
record.ruleset,
msg.session_id,
0,
AckOutcome::Rejected(why.into()),
@@ -224,9 +217,6 @@ impl Store {
current_hash,
)
};
if msg.ruleset != record.ruleset {
return Ok(reject("the message ruleset does not match the character"));
}
if msg.character_id != row.character_id || msg.server_id != row.server_id {
return Ok(reject("the message does not belong to this session"));
}
@@ -247,7 +237,6 @@ impl Store {
&& row.progression == msg.progression
{
let mut a = ack(
record.ruleset,
msg.session_id,
0,
AckOutcome::Duplicate,
@@ -264,7 +253,6 @@ impl Store {
"offered" => {}
_ => {
return Ok(ack(
record.ruleset,
msg.session_id,
0,
AckOutcome::StaleSession,
@@ -311,7 +299,6 @@ impl Store {
)?;
tx.commit()?;
let mut a = ack(
record.ruleset,
msg.session_id,
0,
AckOutcome::Applied,
@@ -328,7 +315,6 @@ impl Store {
let tx = self.write_tx()?;
let Some(row) = read_owner_row(&tx, msg.session_id)? else {
return Ok(ack(
msg.ruleset,
msg.session_id,
msg.sequence,
AckOutcome::Rejected("unknown session".into()),
@@ -338,23 +324,10 @@ impl Store {
};
let record = read_character(&tx, row.character_id)?;
let seen_hash = head_hash(&tx, row.character_id, record.revision)?;
let outcome = |o: AckOutcome| {
ack(
record.ruleset,
msg.session_id,
msg.sequence,
o,
record.revision,
seen_hash,
)
};
let outcome =
|o: AckOutcome| ack(msg.session_id, msg.sequence, o, record.revision, seen_hash);
let reject = |why: &str| outcome(AckOutcome::Rejected(why.into()));
if msg.ruleset != record.ruleset {
return Ok(reject(
"the checkpoint ruleset does not match the character",
));
}
if msg.character_id != row.character_id || msg.server_id != row.server_id {
return Ok(reject("the message does not belong to this session"));
}
@@ -381,7 +354,6 @@ impl Store {
}
let revision = revision as u64;
let mut a = ack(
record.ruleset,
msg.session_id,
msg.sequence,
AckOutcome::Duplicate,
@@ -418,7 +390,6 @@ impl Store {
tx.execute("UPDATE owner_session SET state = 'superseded', updated_at = ?2 WHERE session_id = ?1", params![msg.session_id.to_string(), now()])?;
tx.commit()?;
return Ok(ack(
record.ruleset,
msg.session_id,
msg.sequence,
AckOutcome::StaleSession,
@@ -486,7 +457,6 @@ impl Store {
};
let mut a = ack(
record.ruleset,
msg.session_id,
msg.sequence,
AckOutcome::Applied,
+109 -558
View File
@@ -7,6 +7,101 @@ fn fresh() -> (Store, ProfileId) {
(store, profile)
}
#[test]
fn schema_nine_upgrade_preserves_characters_and_isolates_collections() {
let dir = tempfile::tempdir().unwrap();
let conn = Connection::open(Store::path_of(dir.path())).unwrap();
for sql in &MIGRATIONS[..8] {
conn.execute_batch(sql).unwrap();
}
conn.pragma_update(None, "application_id", APPLICATION_ID)
.unwrap();
conn.pragma_update(None, "user_version", 8).unwrap();
let mut old = Store { conn };
let profile = old.default_profile().unwrap();
let id = created(&mut old, profile);
old.bind_server(id, "realm-a", 42, 1, MappingState::Synced)
.unwrap();
let before = old.load_current(id).unwrap();
let set = IdSet::from_ids([10, 20]).unwrap();
let kind = "coa:wardrobe";
old.conn
.execute(
"INSERT INTO collection VALUES (?1, ?2, 7, ?3, ?4, 2, 'before', ?5)",
params![
profile.to_string(),
kind,
set.hash(kind).as_slice(),
PORTABLE_COLLECTION_FORMAT_VERSION,
set.encode()
],
)
.unwrap();
drop(old);
let mut store = Store::open(dir.path()).unwrap();
assert_eq!(store.schema_version().unwrap(), 9);
assert_eq!(store.load_current(id).unwrap(), before);
assert_eq!(store.server_mappings(id).unwrap()[0].local_guid, 42);
assert_eq!(store.collection(profile, kind).unwrap().unwrap().1, set);
assert_eq!(
store
.collection_info(profile, kind)
.unwrap()
.unwrap()
.revision,
7
);
// An experimental Manager may already have populated another partition.
store.conn.execute(
"INSERT INTO collection SELECT profile_id, 'reborn', kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload FROM collection WHERE ruleset = 'coa'",
[],
).unwrap();
store
.merge_collection(profile, kind, &IdSet::from_ids([30]).unwrap())
.unwrap();
assert_eq!(
store.collection(profile, kind).unwrap().unwrap().1,
IdSet::from_ids([10, 20, 30]).unwrap()
);
let foreign: (i64, Vec<u8>) = store
.conn
.query_row(
"SELECT collection_revision, payload FROM collection WHERE ruleset = 'reborn'",
[],
|r| Ok((r.get(0)?, r.get(1)?)),
)
.unwrap();
assert_eq!(foreign, (7, set.encode()));
drop(store);
assert_eq!(
Store::open(dir.path()).unwrap().load_current(id).unwrap(),
before
);
}
#[test]
#[ignore = "Requires a disposable SQLite backup in COA_PORTABLE_SCHEMA9_FIXTURE"]
fn schema_nine_existing_store_and_runtime_smoke() {
let root = std::path::PathBuf::from(
std::env::var_os("COA_PORTABLE_SCHEMA9_FIXTURE").expect("fixture path"),
);
for role in ["owner", "host"] {
let store = Store::open(&root.join(role)).unwrap();
assert_eq!(store.schema_version().unwrap(), 9);
let records = store.list_characters_all().unwrap();
assert!(!records.is_empty());
for record in records {
store.load_current(record.character_id).unwrap();
store.list_revisions(record.character_id).unwrap();
}
}
let runtime =
crate::portable::service::PortableRuntime::start(&root, Box::new(Vec::new), None).unwrap();
runtime.call(|_| ()).unwrap();
runtime.shutdown();
}
fn created(store: &mut Store, profile: ProfileId) -> CharacterId {
store
.create_character(profile, fixtures::geared_level_eighty(), "realm-a")
@@ -918,22 +1013,16 @@ fn schema_1_item_mappings_survive_the_migration_as_unverified() {
fn collection_union_never_removes_and_unchanged_means_no_revision() {
let (mut store, profile) = fresh();
let kind = "coa:wardrobe";
let ruleset = Ruleset::Coa;
assert!(store.collection(profile, ruleset, kind).unwrap().is_none());
assert!(store.collection(profile, kind).unwrap().is_none());
// nothing stored, nothing incoming: nothing is created
let empty = store
.merge_collection(profile, ruleset, kind, &IdSet::new())
.merge_collection(profile, kind, &IdSet::new())
.unwrap();
assert!(!empty.changed && empty.info.is_none());
let first = store
.merge_collection(
profile,
ruleset,
kind,
&IdSet::from_ids([10, 20, 30]).unwrap(),
)
.merge_collection(profile, kind, &IdSet::from_ids([10, 20, 30]).unwrap())
.unwrap();
assert!(first.changed);
assert_eq!(first.added, 3);
@@ -942,7 +1031,7 @@ fn collection_union_never_removes_and_unchanged_means_no_revision() {
// another realm returns a subset: nothing is lost, nothing changes
let subset = store
.merge_collection(profile, ruleset, kind, &IdSet::from_ids([20]).unwrap())
.merge_collection(profile, kind, &IdSet::from_ids([20]).unwrap())
.unwrap();
assert!(!subset.changed);
assert_eq!(
@@ -951,23 +1040,13 @@ fn collection_union_never_removes_and_unchanged_means_no_revision() {
"same revision, same hash"
);
let same = store
.merge_collection(
profile,
ruleset,
kind,
&IdSet::from_ids([10, 20, 30]).unwrap(),
)
.merge_collection(profile, kind, &IdSet::from_ids([10, 20, 30]).unwrap())
.unwrap();
assert!(!same.changed);
// a realm with new unlocks (and without the old ones) only adds
let more = store
.merge_collection(
profile,
ruleset,
kind,
&IdSet::from_ids([30, 40, 5]).unwrap(),
)
.merge_collection(profile, kind, &IdSet::from_ids([30, 40, 5]).unwrap())
.unwrap();
assert!(more.changed);
assert_eq!(more.added, 2);
@@ -975,25 +1054,22 @@ fn collection_union_never_removes_and_unchanged_means_no_revision() {
assert_eq!((info2.revision, info2.count), (2, 5));
assert_ne!(info2.hash, info1.hash);
let (info, set) = store.collection(profile, ruleset, kind).unwrap().unwrap();
let (info, set) = store.collection(profile, kind).unwrap().unwrap();
assert_eq!(set.ids(), &[5, 10, 20, 30, 40]);
assert_eq!(info, info2);
assert_eq!(
store
.collection_info(profile, ruleset, kind)
.unwrap()
.unwrap(),
store.collection_info(profile, kind).unwrap().unwrap(),
info2
);
// kinds are separate collections
assert!(store
.collection_info(profile, ruleset, "coa:vanity")
.collection_info(profile, "coa:vanity")
.unwrap()
.is_none());
assert!(
store
.merge_collection(profile, ruleset, "wardrobe", &IdSet::new())
.merge_collection(profile, "wardrobe", &IdSet::new())
.is_err(),
"kinds must be namespaced"
);
@@ -1009,9 +1085,7 @@ fn collections_hold_tens_of_thousands_of_ids_compactly() {
] {
let ids: Vec<u32> = (0..count).map(|n| n * 7 + (n % 5)).collect();
let set = IdSet::from_ids(ids).unwrap();
let merge = store
.merge_collection(profile, Ruleset::Coa, kind, &set)
.unwrap();
let merge = store.merge_collection(profile, kind, &set).unwrap();
assert_eq!(merge.added, count as usize);
let stored_bytes: i64 = store
.conn
@@ -1025,10 +1099,7 @@ fn collections_hold_tens_of_thousands_of_ids_compactly() {
stored_bytes < count as i64 * 2 + 16,
"{kind}: {count} ids took {stored_bytes} bytes"
);
let (_, back) = store
.collection(profile, Ruleset::Coa, kind)
.unwrap()
.unwrap();
let (_, back) = store.collection(profile, kind).unwrap().unwrap();
assert_eq!(back, set);
}
}
@@ -1037,12 +1108,7 @@ fn collections_hold_tens_of_thousands_of_ids_compactly() {
fn a_tampered_collection_is_detected() {
let (mut store, profile) = fresh();
store
.merge_collection(
profile,
Ruleset::Coa,
"coa:vanity",
&IdSet::from_ids([1, 2, 3]).unwrap(),
)
.merge_collection(profile, "coa:vanity", &IdSet::from_ids([1, 2, 3]).unwrap())
.unwrap();
let forged = IdSet::from_ids([1, 2, 3, 4]).unwrap().encode();
store
@@ -1050,7 +1116,7 @@ fn a_tampered_collection_is_detected() {
.execute("UPDATE collection SET payload = ?1", [forged])
.unwrap();
assert!(matches!(
store.collection(profile, Ruleset::Coa, "coa:vanity"),
store.collection(profile, "coa:vanity"),
Err(PortableError::CorruptSnapshot(_))
));
}
@@ -1968,518 +2034,3 @@ fn a_store_that_holds_format_1_snapshots_reads_them_and_compares_them_by_what_th
);
assert_eq!(owner.load_current(id).unwrap(), other);
}
#[test]
fn released_v0_7_x_database_upgrades_transactionally_through_migration_009_and_accepts_reborn() {
let dir = tempfile::tempdir().unwrap();
let file = Store::path_of(dir.path());
let profile = ProfileId::new();
let char_coa = CharacterId::new();
let char_wc = CharacterId::new();
let item_coa = PortableItemId::new();
let now = "2026-10-22T12:00:00Z";
// Build realistic pre-multiruleset v0.7.x database (migrations 0..8)
{
let conn = Connection::open(&file).unwrap();
conn.pragma_update(None, "foreign_keys", true).unwrap();
for m in &MIGRATIONS[..8] {
conn.execute_batch(m).unwrap();
}
conn.pragma_update(None, "application_id", APPLICATION_ID)
.unwrap();
conn.pragma_update(None, "user_version", 8).unwrap();
// 1. Profile
conn.execute(
"INSERT INTO profile (profile_id, created_at, format_version) VALUES (?1, ?2, 1)",
params![profile.to_string(), now],
)
.unwrap();
// 2. Characters (CoA and Wildcard allowed in pre-009 schema)
conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'coa', 'Varian', 'coa:race:1', 'coa:class:1', 0, 80, 1, ?3, ?3, 0)",
params![char_coa.to_string(), profile.to_string(), now],
).unwrap();
conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'wildcard', 'RogueMage', 'coa:race:1', 'coa:class:4', 1, 60, 2, ?3, ?3, 0)",
params![char_wc.to_string(), profile.to_string(), now],
).unwrap();
// Verify pre-009 CHECK constraint rejects 'reborn'
let err = conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'Paladin', 'coa:race:1', 'coa:class:2', 0, 70, 1, ?3, ?3, 0)",
params![CharacterId::new().to_string(), profile.to_string(), now],
);
assert!(err.is_err(), "pre-009 schema must reject reborn");
// 3. Snapshots and revisions
conn.execute(
"INSERT INTO snapshot (character_id, revision, snapshot_format_version, created_at, source_server_id, content_hash, uncompressed_size, payload, note)
VALUES (?1, 1, 2, ?2, 'realm-a', ?3, 4, X'01020304', 'genesis')",
params![char_coa.to_string(), now, [0x42u8; 32]],
).unwrap();
// 4. Mappings and server bindings
conn.execute(
"INSERT INTO character_server_mapping (character_id, server_id, local_guid, last_revision, state, updated_at)
VALUES (?1, 'realm-a', 101, 1, 'active', ?2)",
params![char_coa.to_string(), now],
).unwrap();
conn.execute(
"INSERT INTO item_mapping (character_id, server_id, portable_item_id, local_item_guid, entry, identity, state, created_revision, confirmed_revision, created_at, updated_at)
VALUES (?1, 'realm-a', ?2, 202, 'item_entry', 'ident', 'active', 1, 1, ?3, ?3)",
params![char_coa.to_string(), item_coa.to_string(), now],
).unwrap();
// 5. Baseline session (realm_baseline)
conn.execute(
"INSERT INTO realm_baseline (character_id, server_id, c0_revision, head_revision, state, c0_hash, c0_payload, b0_hash, b0_payload, created_at, updated_at)
VALUES (?1, 'realm-a', 1, 1, 'open', ?2, X'AA', ?2, X'BB', ?3, ?3)",
params![char_coa.to_string(), [0x42u8; 32], now],
).unwrap();
// 6. Pre-009 Collection (single profile_id, kind PK)
conn.execute(
"INSERT INTO collection (profile_id, kind, collection_revision, collection_hash, format_version, item_count, updated_at, payload)
VALUES (?1, 'coa:appearance', 1, ?2, 1, 0, ?3, X'00')",
params![profile.to_string(), [0x42u8; 32], now],
).unwrap();
}
// Upgrade through Store::open_file (applies migration 009)
let store = Store::open_file(&file).unwrap();
assert_eq!(store.schema_version().unwrap(), 9);
// Verify all original rows and fields survived byte-for-byte and constraint-wise
let coa_rec = store.character(char_coa).unwrap();
assert_eq!(coa_rec.ruleset, Ruleset::Coa);
assert_eq!(coa_rec.name, "Varian");
assert_eq!(coa_rec.revision, 1);
assert_eq!(coa_rec.level, 80);
assert_eq!(coa_rec.created_at, now);
let wc_rec = store.character(char_wc).unwrap();
assert_eq!(wc_rec.ruleset, Ruleset::Wildcard);
assert_eq!(wc_rec.name, "RogueMage");
assert_eq!(wc_rec.revision, 2);
// Verify child tables survived without cascading drop
let server_maps = store.server_mappings(char_coa).unwrap();
assert_eq!(server_maps.len(), 1);
assert_eq!(server_maps[0].local_guid, 101);
let item_maps = store.item_mappings(char_coa, "realm-a").unwrap();
assert_eq!(item_maps.len(), 1);
assert_eq!(item_maps[0].portable_item_id, item_coa);
assert_eq!(item_maps[0].local_item_guid, 202);
// Verify collection migrated to composite key (profile_id, ruleset, kind)
let coll_info = store
.collection_info(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_info.revision, 1);
// Verify insertion of Reborn character succeeds now on migrated DB
let char_rb = CharacterId::new();
let rb_rec = store.conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'Mograine', 'coa:race:1', 'coa:class:2', 0, 70, 1, ?3, ?3, 0)",
params![char_rb.to_string(), profile.to_string(), now],
);
assert!(
rb_rec.is_ok(),
"migrated database must accept reborn ruleset"
);
let loaded_rb = store.character(char_rb).unwrap();
assert_eq!(loaded_rb.ruleset, Ruleset::Reborn);
assert_eq!(loaded_rb.name, "Mograine");
// Verify invalid ruleset is still rejected by CHECK constraint
let err = store.conn.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'invalid_ruleset', 'Bad', 'coa:race:1', 'coa:class:1', 0, 1, 1, ?3, ?3, 0)",
params![CharacterId::new().to_string(), profile.to_string(), now],
);
assert!(
err.is_err(),
"migrated database must reject invalid ruleset"
);
}
#[test]
fn mapping_isolation_between_coa_and_wildcard_on_same_installation() {
let mut store = Store::open_in_memory().unwrap();
let profile = store.default_profile().unwrap();
let mut model_coa = fixtures::geared_level_eighty();
model_coa.ruleset = Ruleset::Coa;
let char_coa = store
.create_character(profile, model_coa, "srv-1:coa")
.unwrap();
let mut model_wc = fixtures::geared_level_eighty();
model_wc.ruleset = Ruleset::Wildcard;
let char_wc = store
.create_character(profile, model_wc, "srv-1:wildcard")
.unwrap();
// 1. Both share local_guid = 100 on their respective server_id
store
.bind_server(char_coa, "srv-1:coa", 100, 1, MappingState::Active)
.unwrap();
store
.bind_server(char_wc, "srv-1:wildcard", 100, 1, MappingState::Active)
.unwrap();
// 2. Both share local_item_guid = 500 on their respective server_id
let item_coa = PortableItemId::new();
let item_wc = PortableItemId::new();
store
.reconcile_item_mappings(
char_coa,
"srv-1:coa",
1,
&[obs(item_coa, 500, 10, "entry1")],
)
.unwrap();
store
.reconcile_item_mappings(
char_wc,
"srv-1:wildcard",
1,
&[obs(item_wc, 500, 20, "entry2")],
)
.unwrap();
// Verify lookup isolation
assert_eq!(
store.find_by_local("srv-1:coa", 100).unwrap(),
Some(char_coa)
);
assert_eq!(
store.find_by_local("srv-1:wildcard", 100).unwrap(),
Some(char_wc)
);
let maps_coa = store.item_mappings(char_coa, "srv-1:coa").unwrap();
assert_eq!(maps_coa.len(), 1);
assert_eq!(maps_coa[0].portable_item_id, item_coa);
assert_eq!(maps_coa[0].local_item_guid, 500);
let maps_wc = store.item_mappings(char_wc, "srv-1:wildcard").unwrap();
assert_eq!(maps_wc.len(), 1);
assert_eq!(maps_wc[0].portable_item_id, item_wc);
assert_eq!(maps_wc[0].local_item_guid, 500);
}
#[test]
fn three_space_isolation_fixture_proves_wildcard_activity_leaves_coa_and_reborn_untouched() {
let mut store = Store::open_in_memory().unwrap();
let profile = store.default_profile().unwrap();
// Character A: CoA
let mut model_a = fixtures::geared_level_eighty();
model_a.identity.name = "Hero".into();
model_a.ruleset = Ruleset::Coa;
let char_a = store
.create_character(profile, model_a, "srv-1:coa")
.unwrap();
// Character B: Wildcard
let mut model_b = fixtures::geared_level_eighty();
model_b.identity.name = "Hero".into();
model_b.ruleset = Ruleset::Wildcard;
let char_b = store
.create_character(profile, model_b, "srv-1:wildcard")
.unwrap();
// Character C: Reborn
let mut model_c = fixtures::geared_level_eighty();
model_c.identity.name = "Hero".into();
model_c.ruleset = Ruleset::Reborn;
let char_c = store
.create_character(profile, model_c, "srv-1:reborn")
.unwrap();
// Initial identical mappings (local_guid = 100, item_guid = 200)
store
.bind_server(char_a, "srv-1:coa", 100, 1, MappingState::Active)
.unwrap();
store
.bind_server(char_b, "srv-1:wildcard", 100, 1, MappingState::Active)
.unwrap();
store
.bind_server(char_c, "srv-1:reborn", 100, 1, MappingState::Active)
.unwrap();
let item_a = PortableItemId::new();
let item_b = PortableItemId::new();
let item_c = PortableItemId::new();
store
.reconcile_item_mappings(char_a, "srv-1:coa", 1, &[obs(item_a, 200, 10, "e1")])
.unwrap();
store
.reconcile_item_mappings(char_b, "srv-1:wildcard", 1, &[obs(item_b, 200, 10, "e2")])
.unwrap();
store
.reconcile_item_mappings(char_c, "srv-1:reborn", 1, &[obs(item_c, 200, 10, "e3")])
.unwrap();
// Initial collections
store
.merge_collection(
profile,
Ruleset::Coa,
"coa:appearance",
&IdSet::from_ids([1, 2, 3]).unwrap(),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Wildcard,
"wildcard:appearance",
&IdSet::from_ids([1, 2, 4]).unwrap(),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Reborn,
"reborn:appearance",
&IdSet::from_ids([1, 2, 5]).unwrap(),
)
.unwrap();
// Record baseline hashes and revisions
let hash_a_before = store.load_snapshot(char_a, 1).unwrap();
let hash_c_before = store.load_snapshot(char_c, 1).unwrap();
// ---- MUTATE WILDCARD B ONLY ----
let mut model_b_mut = store.load_current(char_b).unwrap();
model_b_mut.progression.money += 100_000;
model_b_mut.progression.level = 80;
store
.commit_snapshot(
char_b,
1,
model_b_mut,
"srv-1:wildcard",
Some("wildcard gameplay"),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Wildcard,
"wildcard:appearance",
&IdSet::from_ids([1, 2, 4, 999]).unwrap(),
)
.unwrap();
let new_item_b = PortableItemId::new();
store
.reconcile_item_mappings(
char_b,
"srv-1:wildcard",
2,
&[
obs(item_b, 200, 10, "e2"),
obs(new_item_b, 201, 10, "e2_new"),
],
)
.unwrap();
// ---- ASSERT WILDCARD B ADVANCED ----
let rec_b = store.character(char_b).unwrap();
assert_eq!(rec_b.revision, 2);
let (_, coll_b) = store
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_b.ids(), &[1, 2, 4, 999]);
assert_eq!(
store.item_mappings(char_b, "srv-1:wildcard").unwrap().len(),
2
);
// ---- ASSERT COA A IS 100% UNTOUCHED ----
let rec_a = store.character(char_a).unwrap();
assert_eq!(rec_a.revision, 1);
let hash_a_after = store.load_snapshot(char_a, 1).unwrap();
assert_eq!(hash_a_before, hash_a_after);
let (_, coll_a) = store
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_a.ids(), &[1, 2, 3]);
let items_a = store.item_mappings(char_a, "srv-1:coa").unwrap();
assert_eq!(items_a.len(), 1);
assert_eq!(items_a[0].portable_item_id, item_a);
assert_eq!(items_a[0].local_item_guid, 200);
// ---- ASSERT REBORN C IS 100% UNTOUCHED ----
let rec_c = store.character(char_c).unwrap();
assert_eq!(rec_c.revision, 1);
let hash_c_after = store.load_snapshot(char_c, 1).unwrap();
assert_eq!(hash_c_before, hash_c_after);
let (_, coll_c) = store
.collection(profile, Ruleset::Reborn, "reborn:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_c.ids(), &[1, 2, 5]);
let items_c = store.item_mappings(char_c, "srv-1:reborn").unwrap();
assert_eq!(items_c.len(), 1);
assert_eq!(items_c[0].portable_item_id, item_c);
assert_eq!(items_c[0].local_item_guid, 200);
// ---- MUTATE REBORN C ONLY ----
let mut model_c_mut = store.load_current(char_c).unwrap();
model_c_mut.progression.money += 300_000;
model_c_mut.progression.level = 80;
store
.commit_snapshot(
char_c,
1,
model_c_mut,
"srv-1:reborn",
Some("reborn gameplay progression"),
)
.unwrap();
store
.merge_collection(
profile,
Ruleset::Reborn,
"reborn:appearance",
&IdSet::from_ids([1, 2, 5, 8888]).unwrap(),
)
.unwrap();
let new_item_c = PortableItemId::new();
store
.reconcile_item_mappings(
char_c,
"srv-1:reborn",
2,
&[
obs(item_c, 200, 10, "e3"),
obs(new_item_c, 202, 10, "e3_new"),
],
)
.unwrap();
// ---- ASSERT REBORN C ADVANCED TO REV 2 ----
let rec_c2 = store.character(char_c).unwrap();
assert_eq!(rec_c2.revision, 2);
let (_, coll_c2) = store
.collection(profile, Ruleset::Reborn, "reborn:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_c2.ids(), &[1, 2, 5, 8888]);
assert_eq!(
store.item_mappings(char_c, "srv-1:reborn").unwrap().len(),
2
);
// ---- ASSERT COA A REMAINS 100% UNTOUCHED (STILL REV 1) ----
let rec_a2 = store.character(char_a).unwrap();
assert_eq!(rec_a2.revision, 1);
assert_eq!(store.load_snapshot(char_a, 1).unwrap(), hash_a_before);
let (_, coll_a2) = store
.collection(profile, Ruleset::Coa, "coa:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_a2.ids(), &[1, 2, 3]);
assert_eq!(store.item_mappings(char_a, "srv-1:coa").unwrap().len(), 1);
// ---- ASSERT WILDCARD B REMAINS 100% UNTOUCHED (STILL REV 2) ----
let rec_b2 = store.character(char_b).unwrap();
assert_eq!(rec_b2.revision, 2);
let (_, coll_b2) = store
.collection(profile, Ruleset::Wildcard, "wildcard:appearance")
.unwrap()
.unwrap();
assert_eq!(coll_b2.ids(), &[1, 2, 4, 999]);
assert_eq!(
store.item_mappings(char_b, "srv-1:wildcard").unwrap().len(),
2
);
}
#[test]
fn reborn_store_corruption_fails_closed() {
let mut store = Store::open_in_memory().unwrap();
let profile = store.default_profile().unwrap();
// 1. summary = reborn + snapshot = coa
let mut model_coa = fixtures::geared_level_eighty();
model_coa.ruleset = Ruleset::Coa;
let enc_coa = crate::portable::snapshot::encode(&model_coa).unwrap();
// Insert corrupt summary with reborn ruleset but pointing to coa snapshot
let id_1 = CharacterId::new();
let at = "2026-10-22T12:00:00Z";
store
.conn
.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'HeroReborn', 'coa:race:1', 'coa:class:1', 0, 80, 1, ?3, ?3, 0)",
rusqlite::params![id_1.to_string(), profile.to_string(), at],
)
.unwrap();
store
.conn
.execute(
"INSERT INTO snapshot (character_id, revision, snapshot_format_version, created_at, source_server_id, content_hash, uncompressed_size, payload, note)
VALUES (?1, 1, 2, ?2, 'srv-1:reborn', ?3, ?4, ?5, 'corrupted snapshot test')",
rusqlite::params![id_1.to_string(), at, enc_coa.content_hash.as_slice(), enc_coa.payload.len() as i64, enc_coa.payload],
)
.unwrap();
// Loading current snapshot must FAIL CLOSED with ruleset mismatch error
let res1 = store.load_current(id_1);
assert!(
res1.is_err(),
"Loading reborn summary with CoA snapshot must fail closed"
);
// 2. summary = reborn + snapshot = wildcard
let mut model_wc = fixtures::geared_level_eighty();
model_wc.ruleset = Ruleset::Wildcard;
let enc_wc = crate::portable::snapshot::encode(&model_wc).unwrap();
let id_2 = CharacterId::new();
store
.conn
.execute(
"INSERT INTO character (character_id, profile_id, ruleset, name, race, class, gender, level, revision, created_at, updated_at, archived)
VALUES (?1, ?2, 'reborn', 'HeroReborn2', 'coa:race:1', 'coa:class:1', 0, 80, 1, ?3, ?3, 0)",
rusqlite::params![id_2.to_string(), profile.to_string(), at],
)
.unwrap();
store
.conn
.execute(
"INSERT INTO snapshot (character_id, revision, snapshot_format_version, created_at, source_server_id, content_hash, uncompressed_size, payload, note)
VALUES (?1, 1, 2, ?2, 'srv-1:reborn', ?3, ?4, ?5, 'corrupted snapshot test 2')",
rusqlite::params![id_2.to_string(), at, enc_wc.content_hash.as_slice(), enc_wc.payload.len() as i64, enc_wc.payload],
)
.unwrap();
let res2 = store.load_current(id_2);
assert!(
res2.is_err(),
"Loading reborn summary with Wildcard snapshot must fail closed"
);
}
+13 -34
View File
@@ -64,16 +64,6 @@ pub struct Observed {
pub auth: ServiceStatus,
pub world: ServiceStatus,
pub secondary_world: Option<ServiceStatus>,
/// The Warcraft Reborn world that starts together with Conquest of Azeroth.
#[serde(default)]
pub reborn_world: Option<ServiceStatus>,
}
impl Observed {
/// The worlds that run next to the primary one.
pub fn extra_worlds(&self) -> impl Iterator<Item = &ServiceStatus> {
self.secondary_world.iter().chain(self.reborn_world.iter())
}
}
pub fn read_state_record(root: &Path, name: &str) -> Option<ProcessIdentity> {
@@ -402,30 +392,20 @@ pub fn observe(root: &Path, ports: &Ports) -> Observed {
}
let listen = listeners();
let (world, auth, mysql) = crate::layout::executables(root);
use crate::multiworld::Tree;
let realm_state = crate::realms::state(root).ok();
let extra_world = |tree: Tree, name: &'static str, enabled: bool| {
let folder = crate::multiworld::tree_root(root, tree);
(enabled || crate::multiworld::tree_running(root, tree)).then(|| {
service(
&folder,
name,
folder.join("Core/worldserver.exe"),
crate::layout::read_ports(&folder).world,
&listen,
)
})
let secondary = crate::multiworld::root(root);
let secondary_world = if crate::realms::state(root).is_ok_and(|s| s.simultaneous)
|| crate::multiworld::is_running(root)
{
Some(service(
&secondary,
"world-secondary",
secondary.join("Core/worldserver.exe"),
crate::layout::read_ports(&secondary).world,
&listen,
))
} else {
None
};
let secondary_world = extra_world(
Tree::Second,
"world-secondary",
realm_state.as_ref().is_some_and(|s| s.simultaneous),
);
let reborn_world = extra_world(
Tree::Reborn,
"world-reborn",
realm_state.as_ref().is_some_and(|s| s.with_reborn),
);
Observed {
mysql: service(root, "mysql", mysql, ports.mysql, &listen),
auth: service(root, "auth", auth, ports.auth, &listen),
@@ -438,7 +418,6 @@ pub fn observe(root: &Path, ports: &Ports) -> Observed {
&listen,
),
secondary_world,
reborn_world,
}
}
-292
View File
@@ -1,292 +0,0 @@
use std::collections::BTreeMap;
use std::fs;
use std::path::Path;
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use crate::error::{Error, Result};
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct PeExportEntry {
pub ordinal: u32,
pub rva: String,
pub decorated_name: String,
pub demangled_signature: Option<String>,
pub is_forwarder: bool,
pub forwarder_target: Option<String>,
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ArtifactProvenanceRecord {
pub file_path: String,
pub file_size: u64,
pub file_sha256: String,
pub machine_architecture: String,
pub is_dll: bool,
pub total_export_count: usize,
pub total_name_count: usize,
pub embedded_abi_fingerprint: Option<String>,
pub sdk_manifest_fingerprint: Option<String>,
pub sdk_manifest_match: bool,
pub category_a_signatures: Vec<String>,
pub category_a_count: usize,
pub compiler_environment: BTreeMap<String, String>,
pub provenance_status: String, // "PROVENANCE_VERIFIED" or "CONFLICT_DETECTED"
pub notes: Vec<String>,
}
/// Helper function to translate RVA to file offset given PE section headers
fn rva_to_offset(rva: u32, sections: &[(u32, u32, u32, u32)]) -> Option<usize> {
for &(sec_va, sec_vsize, sec_raw_ptr, sec_raw_size) in sections {
let size = sec_vsize.max(sec_raw_size);
if rva >= sec_va && rva < sec_va + size {
return Some((sec_raw_ptr + (rva - sec_va)) as usize);
}
}
None
}
/// Parse PE headers and extract all exported symbols and metadata directly from binary bytes
pub fn parse_pe_exports(bytes: &[u8]) -> Result<(String, bool, Vec<PeExportEntry>, Option<String>)> {
if bytes.len() < 64 {
return Err(Error::Invalid("File too small to be a PE image".into()));
}
// DOS Header
if bytes[0] != b'M' || bytes[1] != b'Z' {
return Err(Error::Invalid("Invalid DOS signature (expected MZ)".into()));
}
let e_lfanew = u32::from_le_bytes(bytes[0x3C..0x40].try_into().unwrap()) as usize;
if e_lfanew + 24 > bytes.len() {
return Err(Error::Invalid("Truncated NT header offset".into()));
}
// PE Signature
if &bytes[e_lfanew..e_lfanew + 4] != b"PE\0\0" {
return Err(Error::Invalid("Invalid PE signature".into()));
}
let file_header_offset = e_lfanew + 4;
let machine = u16::from_le_bytes(bytes[file_header_offset..file_header_offset + 2].try_into().unwrap());
let num_sections = u16::from_le_bytes(bytes[file_header_offset + 2..file_header_offset + 4].try_into().unwrap()) as usize;
let size_of_opt_header = u16::from_le_bytes(bytes[file_header_offset + 16..file_header_offset + 18].try_into().unwrap()) as usize;
let characteristics = u16::from_le_bytes(bytes[file_header_offset + 18..file_header_offset + 20].try_into().unwrap());
let arch = match machine {
0x8664 => "AMD64 (x86_64)",
0x014C => "i386 (x86)",
0xAA64 => "ARM64",
_ => "UNKNOWN",
}.to_string();
let is_dll = (characteristics & 0x2000) != 0;
let opt_header_offset = file_header_offset + 20;
if opt_header_offset + size_of_opt_header > bytes.len() {
return Err(Error::Invalid("Truncated Optional Header".into()));
}
let magic = u16::from_le_bytes(bytes[opt_header_offset..opt_header_offset + 2].try_into().unwrap());
let is_pe32_plus = magic == 0x020B;
let data_dirs_offset = if is_pe32_plus {
opt_header_offset + 112
} else {
opt_header_offset + 96
};
let export_dir_va = u32::from_le_bytes(bytes[data_dirs_offset..data_dirs_offset + 4].try_into().unwrap());
let export_dir_size = u32::from_le_bytes(bytes[data_dirs_offset + 4..data_dirs_offset + 8].try_into().unwrap());
// Section headers
let section_table_offset = opt_header_offset + size_of_opt_header;
let mut sections = Vec::new();
for i in 0..num_sections {
let sec_offset = section_table_offset + i * 40;
if sec_offset + 40 > bytes.len() {
break;
}
let sec_vsize = u32::from_le_bytes(bytes[sec_offset + 8..sec_offset + 12].try_into().unwrap());
let sec_va = u32::from_le_bytes(bytes[sec_offset + 12..sec_offset + 16].try_into().unwrap());
let sec_raw_size = u32::from_le_bytes(bytes[sec_offset + 16..sec_offset + 20].try_into().unwrap());
let sec_raw_ptr = u32::from_le_bytes(bytes[sec_offset + 20..sec_offset + 24].try_into().unwrap());
sections.push((sec_va, sec_vsize, sec_raw_ptr, sec_raw_size));
}
// Extract embedded ABI fingerprint from binary bytes
let mut embedded_abi = None;
let known_fingerprints = [
"2f82013def4698d3f75fa24e5f70ffa504a7782d366b5edb78c7adc3c1ee0883",
"e6c51ed94f3d74c48a45c7ec4efd7c7fb5777d99b6923434890532b011f222a0",
];
for &fp in &known_fingerprints {
if bytes.windows(64).any(|w| w == fp.as_bytes()) {
embedded_abi = Some(fp.to_string());
break;
}
}
// Parse Export Table
let mut export_entries = Vec::new();
if export_dir_va != 0 && export_dir_size != 0 {
if let Some(export_offset) = rva_to_offset(export_dir_va, &sections) {
if export_offset + 40 <= bytes.len() {
let ordinal_base = u32::from_le_bytes(bytes[export_offset + 16..export_offset + 20].try_into().unwrap());
let num_functions = u32::from_le_bytes(bytes[export_offset + 20..export_offset + 24].try_into().unwrap()) as usize;
let num_names = u32::from_le_bytes(bytes[export_offset + 24..export_offset + 28].try_into().unwrap()) as usize;
let addr_functions_rva = u32::from_le_bytes(bytes[export_offset + 28..export_offset + 32].try_into().unwrap());
let addr_names_rva = u32::from_le_bytes(bytes[export_offset + 32..export_offset + 36].try_into().unwrap());
let addr_ordinals_rva = u32::from_le_bytes(bytes[export_offset + 36..export_offset + 40].try_into().unwrap());
let names_offset_opt = rva_to_offset(addr_names_rva, &sections);
let ordinals_offset_opt = rva_to_offset(addr_ordinals_rva, &sections);
let functions_offset_opt = rva_to_offset(addr_functions_rva, &sections);
if let (Some(names_off), Some(ords_off), Some(funcs_off)) = (names_offset_opt, ordinals_offset_opt, functions_offset_opt) {
for i in 0..num_names {
if names_off + (i + 1) * 4 > bytes.len() || ords_off + (i + 1) * 2 > bytes.len() {
break;
}
let name_rva = u32::from_le_bytes(bytes[names_off + i * 4..names_off + (i + 1) * 4].try_into().unwrap());
let ordinal_bias = u16::from_le_bytes(bytes[ords_off + i * 2..ords_off + (i + 1) * 2].try_into().unwrap()) as usize;
let ordinal = ordinal_base + ordinal_bias as u32;
let mut func_rva = 0;
if ordinal_bias < num_functions && funcs_off + (ordinal_bias + 1) * 4 <= bytes.len() {
func_rva = u32::from_le_bytes(bytes[funcs_off + ordinal_bias * 4..funcs_off + (ordinal_bias + 1) * 4].try_into().unwrap());
}
// Read string from name_rva
let name_str = if let Some(n_off) = rva_to_offset(name_rva, &sections) {
let mut end = n_off;
while end < bytes.len() && bytes[end] != 0 {
end += 1;
}
String::from_utf8_lossy(&bytes[n_off..end]).to_string()
} else {
format!("UNKNOWN_RVA_{:08X}", name_rva)
};
let is_forwarder = func_rva >= export_dir_va && func_rva < export_dir_va + export_dir_size;
let forwarder_target = if is_forwarder {
if let Some(f_off) = rva_to_offset(func_rva, &sections) {
let mut end = f_off;
while end < bytes.len() && bytes[end] != 0 {
end += 1;
}
Some(String::from_utf8_lossy(&bytes[f_off..end]).to_string())
} else {
None
}
} else {
None
};
export_entries.push(PeExportEntry {
ordinal,
rva: format!("0x{:08X}", func_rva),
decorated_name: name_str,
demangled_signature: None,
is_forwarder,
forwarder_target,
});
}
}
}
}
}
Ok((arch, is_dll, export_entries, embedded_abi))
}
/// Verify artifact provenance for a given worldserver.exe binary path against expected SDK metadata
pub fn verify_worldserver_provenance(
exe_path: &Path,
sdk_json_path: Option<&Path>,
) -> Result<ArtifactProvenanceRecord> {
if !exe_path.exists() {
return Err(Error::Invalid(format!("Executable path does not exist: {}", exe_path.display())));
}
let bytes = fs::read(exe_path)?;
let mut hasher = Sha256::new();
hasher.update(&bytes);
let file_sha256 = hex::encode(hasher.finalize()).to_lowercase();
let file_size = bytes.len() as u64;
let (arch, is_dll, exports, embedded_abi) = parse_pe_exports(&bytes)?;
let mut sdk_manifest_fingerprint = None;
if let Some(sdk_path) = sdk_json_path {
if sdk_path.exists() {
if let Ok(content) = fs::read_to_string(sdk_path) {
if let Ok(parsed) = serde_json::from_str::<serde_json::Value>(&content) {
if let Some(fp) = parsed.get("abi_fingerprint").and_then(|v| v.as_str()) {
sdk_manifest_fingerprint = Some(fp.to_string());
}
}
}
}
}
let sdk_match = match (&embedded_abi, &sdk_manifest_fingerprint) {
(Some(a), Some(b)) => a == b,
(Some(_), None) => true,
_ => false,
};
let category_a_patterns = [
"SendServerMessage@WorldSessionMgr",
"AddGossipItemFor",
"SendGossipMenuFor",
"CloseGossipMenuFor",
"ClearGossipMenuFor",
"SendMailTo@MailDraft",
];
let mut category_a_sigs = Vec::new();
for exp in &exports {
for &pat in &category_a_patterns {
if exp.decorated_name.contains(pat) {
category_a_sigs.push(exp.decorated_name.clone());
break;
}
}
}
let mut notes = Vec::new();
if !sdk_match {
notes.push("CONFLICT: Embedded ABI fingerprint does not match provided sdk.json".into());
} else {
notes.push("Embedded ABI fingerprint strictly matches host binary expectation".into());
}
let status = if sdk_match && !exports.is_empty() {
"PROVENANCE_VERIFIED".to_string()
} else {
"CONFLICT_DETECTED".to_string()
};
let mut compiler_env = BTreeMap::new();
compiler_env.insert("toolchain".into(), "MSVC 19.51.36247 (Visual Studio 2026 Preview/Insiders x64)".into());
compiler_env.insert("target".into(), "x86_64-pc-windows-msvc".into());
compiler_env.insert("crt".into(), "MultiThreadedDLL (/MD)".into());
Ok(ArtifactProvenanceRecord {
file_path: exe_path.to_string_lossy().into_owned(),
file_size,
file_sha256,
machine_architecture: arch,
is_dll,
total_export_count: exports.len(),
total_name_count: exports.len(),
embedded_abi_fingerprint: embedded_abi,
sdk_manifest_fingerprint,
sdk_manifest_match: sdk_match,
category_a_count: category_a_sigs.len(),
category_a_signatures: category_a_sigs,
compiler_environment: compiler_env,
provenance_status: status,
notes,
})
}
-25
View File
@@ -249,17 +249,6 @@ impl Ra {
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Log in up to `count` existing offline bots without creating new characters.
pub fn login_offline_bots(&mut self, count: u32) -> Result<String> {
if !(1..=5000).contains(&count) {
return Err(Error::Invalid(
"Choose between 1 and 5000 companions.".into(),
));
}
let out = self.command(&format!("botcmd loginall {count}"))?;
Ok(out.lines().last().unwrap_or("").to_string())
}
/// Set a new password for an existing account.
pub fn set_account_password(&mut self, name: &str, password: &str) -> Result<()> {
validate_account(name, password)?;
@@ -558,20 +547,6 @@ AC>";
assert_eq!(h.join().unwrap()[2], "botcmd spawnleveled 50");
}
#[test]
fn login_offline_bots_sends_count() {
let _lock = serial();
let (port, h) = fake_ra("BotMgr: queued 500 offline bot(s) for login.");
let mut ra = Ra::connect_to(port, "u", "p").unwrap();
assert_eq!(
ra.login_offline_bots(500).unwrap(),
"BotMgr: queued 500 offline bot(s) for login."
);
assert!(ra.login_offline_bots(0).is_err() && ra.login_offline_bots(6000).is_err());
drop(ra);
assert_eq!(h.join().unwrap()[2], "botcmd loginall 500");
}
#[test]
fn duplicate_account_and_input_validation() {
let _lock = serial();
+5 -48
View File
@@ -122,66 +122,23 @@ pub fn modules_of(root: &Path) -> Vec<ModuleEntry> {
out
}
/// The realm a local id names: an installed server (`srv-<install id>`, `srv-<install id>:<ruleset>` or the bare install id) or a prepared descriptor.
/// The realm a local id names: an installed server (`srv-<install id>` or the bare install id) or a prepared descriptor.
pub fn find_access(
descriptors: &Path,
installs: &[(String, PathBuf)],
local_id: &str,
) -> Option<RealmAccess> {
let (base_id, explicit_mode) = if let Some((base, rs)) = local_id.split_once(':') {
let m = match rs {
"coa" => crate::realms::Mode::Coa,
"wildcard" => crate::realms::Mode::Wildcard,
"reborn" => crate::realms::Mode::Reborn,
_ => return None,
};
(base, Some(m))
} else {
(local_id, None)
};
if let Some((id, root)) = installs
.iter()
.find(|(id, _)| format!("srv-{id}") == base_id || id == base_id)
.find(|(id, _)| format!("srv-{id}") == local_id || id == local_id)
{
let mut access = RealmAccess::from_install(id, root);
if let Some(m) = explicit_mode {
if let Ok(st) = crate::realms::state(root) {
let supported = match m {
crate::realms::Mode::Coa => {
st.active == crate::realms::Mode::Coa || st.simultaneous
}
crate::realms::Mode::Wildcard => {
st.active == crate::realms::Mode::Wildcard
|| (st.simultaneous && st.wildcard_created)
}
crate::realms::Mode::Reborn => {
st.active == crate::realms::Mode::Reborn
|| (st.with_reborn && st.reborn_created)
}
};
if !supported {
return None;
}
}
access.id = format!("srv-{id}:{}", m.name());
access.name = format!("{} — {}", access.name, m.label());
access.mode = Some(m);
}
return Some(access);
return Some(RealmAccess::from_install(id, root));
}
let (found, _) = load_descriptors(descriptors);
found
.into_iter()
.find(|d| d.id == local_id || d.id == base_id)
.and_then(|d| {
let mut access = RealmAccess::from_descriptor(d).ok()?;
if let Some(m) = explicit_mode {
access.id = format!("{}:{}", access.id, m.name());
access.name = format!("{} — {}", access.name, m.label());
access.mode = Some(m);
}
Some(access)
})
.find(|d| d.id == local_id)
.and_then(|d| RealmAccess::from_descriptor(d).ok())
}
struct Cached {
+64 -534
View File
@@ -23,26 +23,10 @@ pub enum Mode {
impl Mode {
pub fn name(self) -> &'static str {
match self {
Self::Coa => "coa",
Self::Wildcard => "wildcard",
Self::Reborn => "reborn",
}
}
pub fn realm_id(self) -> u32 {
match self {
Self::Coa => 1,
Self::Wildcard => 2,
Self::Reborn => 3,
}
}
pub fn label(self) -> &'static str {
match self {
Self::Coa => "Conquest of Azeroth",
Self::Wildcard => "Wildcard",
Self::Reborn => "Warcraft Reborn",
}
match self { Self::Coa => "coa", Self::Wildcard => "wildcard", Self::Reborn => "reborn" }
}
pub fn realm_id(self) -> u32 { match self { Self::Coa => 1, Self::Wildcard => 2, Self::Reborn => 3 } }
pub fn label(self) -> &'static str { match self { Self::Coa => "Conquest of Azeroth", Self::Wildcard => "Wildcard", Self::Reborn => "Warcraft Reborn" } }
pub fn schema(self, kind: &str) -> Result<&'static str> {
match (self, kind) {
(_, "auth") => Ok("acore_auth"),
@@ -63,53 +47,19 @@ pub struct RealmState {
pub wildcard_created: bool,
#[serde(default)]
pub reborn_created: bool,
/// Wildcard starts together with Conquest of Azeroth (the second of the two when Wildcard is the primary realm).
#[serde(default)]
pub simultaneous: bool,
#[serde(default)]
pub secondary_world_port: Option<u16>,
#[serde(default)]
pub secondary_ra_port: Option<u16>,
/// Warcraft Reborn starts together with Conquest of Azeroth, which is then the primary realm.
#[serde(default)]
pub with_reborn: bool,
#[serde(default)]
pub reborn_world_port: Option<u16>,
#[serde(default)]
pub reborn_ra_port: Option<u16>,
}
impl RealmState {
/// Realms that run as a world of their own next to the primary one.
pub fn extra_modes(&self) -> Vec<Mode> {
let mut modes = Vec::new();
if self.simultaneous {
modes.push(if self.active == Mode::Coa {
Mode::Wildcard
} else {
Mode::Coa
});
}
if self.with_reborn {
modes.push(Mode::Reborn);
}
modes
}
pub fn created(&self, mode: Mode) -> bool {
match mode {
Mode::Coa => true,
Mode::Wildcard => self.wildcard_created,
Mode::Reborn => self.reborn_created,
}
}
pub fn created(&self, mode: Mode) -> bool { match mode { Mode::Coa => true, Mode::Wildcard => self.wildcard_created, Mode::Reborn => self.reborn_created } }
pub fn modes(&self) -> Vec<Mode> {
let mut modes = vec![self.active];
modes.extend(
[Mode::Coa, Mode::Wildcard, Mode::Reborn]
.into_iter()
.filter(|m| *m != self.active && self.created(*m)),
);
modes.extend([Mode::Coa, Mode::Wildcard, Mode::Reborn].into_iter().filter(|m| *m != self.active && self.created(*m)));
modes
}
}
@@ -125,9 +75,6 @@ pub struct View {
pub simultaneous: bool,
pub secondary_world_port: Option<u16>,
pub secondary_running: bool,
pub with_reborn: bool,
pub reborn_world_port: Option<u16>,
pub reborn_running: bool,
}
pub fn state(root: &Path) -> Result<RealmState> {
@@ -151,26 +98,9 @@ pub fn view(root: &Path) -> Result<View> {
let s = state(root)?;
// Inspect the binary itself; templates or an old log cannot prove installed support.
let binary = fs::read(world_binary(root))?;
let reborn_supported = binary
.windows(b"Warcraft Reborn class spells are unavailable".len())
.any(|w| w == b"Warcraft Reborn class spells are unavailable");
let supported = binary
.windows(b"Wildcard synergy settings".len())
.any(|w| w == b"Wildcard synergy settings");
Ok(View {
active: s.active,
wildcard_created: s.wildcard_created,
reborn_created: s.reborn_created,
reborn_supported,
supported,
recovery_pending: root.join(JOURNAL).exists(),
simultaneous: s.simultaneous,
secondary_world_port: s.secondary_world_port,
secondary_running: crate::multiworld::tree_running(root, crate::multiworld::Tree::Second),
with_reborn: s.with_reborn,
reborn_world_port: s.reborn_world_port,
reborn_running: crate::multiworld::tree_running(root, crate::multiworld::Tree::Reborn),
})
let reborn_supported = binary.windows(b"Warcraft Reborn class spells are unavailable".len()).any(|w| w == b"Warcraft Reborn class spells are unavailable");
let supported = binary.windows(b"Wildcard synergy settings".len()).any(|w| w == b"Wildcard synergy settings");
Ok(View { active: s.active, wildcard_created: s.wildcard_created, reborn_created: s.reborn_created, reborn_supported, supported, recovery_pending: root.join(JOURNAL).exists(), simultaneous: s.simultaneous, secondary_world_port: s.secondary_world_port, secondary_running: crate::multiworld::is_running(root) })
}
pub fn guard_module(root: &Path, id: &str) -> Result<()> {
@@ -293,53 +223,24 @@ fn wildcard_configs(mut files: Files) -> Result<Files> {
value,
)?;
}
set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
set(&mut files, "Core/configs/modules/playerbots.conf", "AiPlayerbot.Enabled", "0")?;
Ok(files)
}
fn reborn_configs(mut files: Files) -> Result<Files> {
for (key, value) in [
("CoA.ClassModel", "\"wcr\""),
("CoA.GameModeMask", "0"),
("CoA.MapClass10ToWarrior", "0"),
("CoA.RealmType", "\"live\""),
("CoA.ClassModel", "\"wcr\""), ("CoA.GameModeMask", "0"),
("CoA.MapClass10ToWarrior", "0"), ("CoA.RealmType", "\"live\""),
("CoA.ClientBooleanConfigs", "\"\""),
] {
set(&mut files, "Core/configs/modules/coa.conf", key, value)?;
}
set(
&mut files,
"Core/configs/modules/mod-coa-challenges.conf",
"CoAChallenges.GameModes.Realm",
"\"\"",
)?;
for path in [
"Settings/worldserver.conf.template",
"Core/configs/worldserver.conf",
] {
if files.contains_key(path) {
set(&mut files, path, "RealmID", "3")?;
}
] { set(&mut files, "Core/configs/modules/coa.conf", key, value)?; }
set(&mut files, "Core/configs/modules/mod-coa-challenges.conf", "CoAChallenges.GameModes.Realm", "\"\"")?;
for path in ["Settings/worldserver.conf.template", "Core/configs/worldserver.conf"] {
if files.contains_key(path) { set(&mut files, path, "RealmID", "3")?; }
}
for (key, value) in [("CoaBots.Enable", "0"), ("CoaBots.AutoLoginOnStartup", "0")] {
set(
&mut files,
"Core/configs/modules/mod_coa_playerbots.conf",
key,
value,
)?;
set(&mut files, "Core/configs/modules/mod_coa_playerbots.conf", key, value)?;
}
set(
&mut files,
"Core/configs/modules/playerbots.conf",
"AiPlayerbot.Enabled",
"0",
)?;
set(&mut files, "Core/configs/modules/playerbots.conf", "AiPlayerbot.Enabled", "0")?;
Ok(files)
}
@@ -377,15 +278,8 @@ pub fn recover(root: &Path) -> Result<()> {
fn create_databases(root: &Path, mode: Mode) -> Result<()> {
crate::backup::with_database(root, |_| {
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
if db.query(&format!(
"SELECT COUNT(*) FROM acore_auth.realmlist WHERE id={};",
mode.realm_id()
))? != "0"
{
return Err(Error::Invalid(format!(
"Realm ID {} is already in use. Its settings were left intact.",
mode.realm_id()
)));
if db.query(&format!("SELECT COUNT(*) FROM acore_auth.realmlist WHERE id={};", mode.realm_id()))? != "0" {
return Err(Error::Invalid(format!("Realm ID {} is already in use. Its settings were left intact.", mode.realm_id())));
}
for kind in ["world", "characters"] {
let source = Mode::Coa.schema(kind)?;
@@ -400,10 +294,7 @@ fn create_databases(root: &Path, mode: Mode) -> Result<()> {
));
}
}
for (kind, tables) in crate::schema_check::WILDCARD_TABLES
.iter()
.filter(|_| mode == Mode::Wildcard)
{
for (kind, tables) in crate::schema_check::WILDCARD_TABLES.iter().filter(|_| mode == Mode::Wildcard) {
let schema = crate::db::schema_of(kind)?;
let present = db.tables(schema)?;
let missing: Vec<_> = tables
@@ -477,58 +368,6 @@ fn create_databases(root: &Path, mode: Mode) -> Result<()> {
})
}
/// Create the saved settings and the databases of a realm that was never set up. `before` is the current
/// configuration, the base of a new realm while Conquest of Azeroth is the active one.
fn create_realm(root: &Path, s: &mut RealmState, mode: Mode, before: &Files) -> Result<()> {
if s.created(mode) {
return Ok(());
}
let base = if s.active == Mode::Coa {
before.clone()
} else {
fsx::read_json(&snapshot(root, Mode::Coa))?
};
let files = match mode {
Mode::Wildcard => wildcard_configs(base)?,
Mode::Reborn => reborn_configs(base)?,
Mode::Coa => unreachable!(),
};
fsx::atomic_write_json(&snapshot(root, mode), &files)?;
create_databases(root, mode)?;
match mode {
Mode::Wildcard => s.wildcard_created = true,
Mode::Reborn => s.reborn_created = true,
Mode::Coa => {}
}
fsx::atomic_write_json(&root.join(STATE), s)?;
Ok(())
}
/// Set a realm up without making it the active one, so it can start next to the active realm.
pub fn ensure_created(root: &Path, mode: Mode) -> Result<()> {
let meta = crate::registry::metadata_dir_for(root)?;
let _update_lock = crate::update::operation_lock(&meta)?;
crate::update::ensure_recovered(&meta)?;
require_world_stopped(root)?;
recover(root)?;
let mut s = state(root)?;
let supported = view(root)?;
if mode == Mode::Wildcard && !supported.supported {
return Err(Error::Invalid(
"Update the server to a build with Wildcard support first.".into(),
));
}
if mode == Mode::Reborn && !supported.reborn_supported {
return Err(Error::Invalid(
"Update the server to a build with Warcraft Reborn support first.".into(),
));
}
// Verify launcher support before creating databases, as selecting a realm does.
prepare_launcher(root)?;
let before = configs(root)?;
create_realm(root, &mut s, mode, &before)
}
pub fn select(root: &Path, mode: Mode) -> Result<View> {
let meta = crate::registry::metadata_dir_for(root)?;
let _update_lock = crate::update::operation_lock(&meta)?;
@@ -545,20 +384,23 @@ pub fn select(root: &Path, mode: Mode) -> Result<View> {
));
}
if mode == Mode::Reborn && !view(root)?.reborn_supported {
return Err(Error::Invalid(
"Update the server to a build with Warcraft Reborn support first.".into(),
));
return Err(Error::Invalid("Update the server to a build with Warcraft Reborn support first.".into()));
}
if (s.simultaneous || s.with_reborn) && mode != s.active {
return Err(Error::Invalid(
"Disable the realms that start together before switching realms.".into(),
));
if s.simultaneous && mode != s.active {
return Err(Error::Invalid("Disable simultaneous startup before switching realms.".into()));
}
// Verify launcher support before creating databases or changing the selected realm.
prepare_launcher(root)?;
let before = configs(root)?;
fsx::atomic_write_json(&snapshot(root, s.active), &before)?;
create_realm(root, &mut s, mode, &before)?;
if !s.created(mode) {
let base = if s.active == Mode::Coa { before.clone() } else { fsx::read_json(&snapshot(root, Mode::Coa))? };
let files = match mode { Mode::Wildcard => wildcard_configs(base)?, Mode::Reborn => reborn_configs(base)?, Mode::Coa => unreachable!() };
fsx::atomic_write_json(&snapshot(root, mode), &files)?;
create_databases(root, mode)?;
match mode { Mode::Wildcard => s.wildcard_created = true, Mode::Reborn => s.reborn_created = true, Mode::Coa => {} }
fsx::atomic_write_json(&root.join(STATE), &s)?;
}
let target: Files = fsx::read_json(&snapshot(root, mode))?;
// The launcher and batch files share this lock; recheck after the potentially long database copy.
fs::create_dir_all(root.join(".state"))?;
@@ -639,16 +481,9 @@ const LAUNCHER_REALM_REPLACEMENTS: &[(&str, &str)] = &[
const LAUNCHER_REALM_INSERT: &str = "# coa-manager-realm-profiles-v1\ndef coa_realm():\n path = ROOT / 'Settings/realm-profile.json'\n return json.loads(path.read_text(encoding='utf-8')).get('active', 'coa') if path.exists() else 'coa'\n\ndef coa_realm_id():\n return 2 if coa_realm() == 'wildcard' else 1\n\ndef coa_realm_name():\n return 'Wildcard' if coa_realm() == 'wildcard' else 'Conquest of Azeroth'\n\n";
fn launcher_insert() -> String {
LAUNCHER_REALM_INSERT
.replace("profiles-v1", "profiles-v2")
.replace(
"return 2 if",
"return 3 if coa_realm() == 'reborn' else 2 if",
)
.replace(
"return 'Wildcard' if",
"return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if",
)
LAUNCHER_REALM_INSERT.replace("profiles-v1", "profiles-v2")
.replace("return 2 if", "return 3 if coa_realm() == 'reborn' else 2 if")
.replace("return 'Wildcard' if", "return 'Warcraft Reborn' if coa_realm() == 'reborn' else 'Wildcard' if")
}
fn launcher_replacements() -> Vec<(&'static str, String)> {
@@ -658,31 +493,19 @@ fn launcher_replacements() -> Vec<(&'static str, String)> {
}
pub(crate) fn patch_launcher(source: &str) -> Result<String> {
if source.contains("# coa-manager-realm-profiles-v2") {
return Ok(source.into());
}
if source.contains("# coa-manager-realm-profiles-v2") { return Ok(source.into()); }
if source.contains("# coa-manager-realm-profiles-v1") {
let original = unpatch_launcher(source)
.ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?;
let original = unpatch_launcher(source).ok_or_else(|| Error::Invalid("Unrecognised realm launcher patch.".into()))?;
return patch_launcher(&original);
}
let mut out = source.to_string();
for (from, to) in launcher_replacements() {
if !out.contains(from) {
return Err(Error::Invalid(
"This launcher does not support realm profiles. Update the server package first."
.into(),
));
}
if !out.contains(from) { return Err(Error::Invalid("This launcher does not support realm profiles. Update the server package first.".into())); }
out = out.replace(from, &to);
}
// Insert before the entry point so ROOT, json and functions are all defined when called.
let marker = "if __name__ == \"__main__\":";
if !out.contains(marker) {
return Err(Error::Invalid(
"Unrecognised server launcher entry point.".into(),
));
}
if !out.contains(marker) { return Err(Error::Invalid("Unrecognised server launcher entry point.".into())); }
Ok(out.replace(marker, &format!("{}{marker}", launcher_insert())))
}
@@ -691,119 +514,35 @@ pub(crate) fn unpatch_launcher(source: &str) -> Option<String> {
let (insert, replacements) = if source.contains(&launcher_insert()) {
(launcher_insert(), launcher_replacements())
} else if source.contains(LAUNCHER_REALM_INSERT) {
(
LAUNCHER_REALM_INSERT.into(),
LAUNCHER_REALM_REPLACEMENTS
.iter()
.map(|(a, b)| (*a, b.to_string()))
.collect(),
)
} else {
return None;
};
(LAUNCHER_REALM_INSERT.into(), LAUNCHER_REALM_REPLACEMENTS.iter().map(|(a,b)| (*a, b.to_string())).collect())
} else { return None; };
let mut original = source.replacen(&insert, "", 1);
for (from, to) in &replacements {
original = original.replace(to, from);
}
for (from, to) in &replacements { original = original.replace(to, from); }
let mut check = original.clone();
for (from, to) in &replacements {
check = check.replace(from, to);
}
check = check.replace(
"if __name__ == \"__main__\":",
&format!("{insert}if __name__ == \"__main__\":"),
);
for (from, to) in &replacements { check = check.replace(from, to); }
check = check.replace("if __name__ == \"__main__\":", &format!("{insert}if __name__ == \"__main__\":"));
(check == source).then_some(original)
}
/// The character-creation model the world server advertises for a realm. Every realm has its own database and its own
/// entry on Overview, so it advertises exactly one model: a list such as `"coa wcr"` would let players create
/// Warcraft Reborn characters in the Conquest of Azeroth realm.
fn class_model_for(mode: Mode) -> &'static str {
match mode {
Mode::Coa => "coa",
Mode::Wildcard => "hero",
Mode::Reborn => "wcr",
}
}
/// The client builds its character-creation screen from `CoA.ClassModel`, so a realm whose setting lacks its own
/// model would show the wrong screen (a Conquest of Azeroth realm set to `"hero"` has no classes). The realm chosen in
/// the Manager wins: any other setting is replaced by the realm's own model.
/// A missing key means the server default, `"coa"`; a missing file is left to the server.
fn align_class_model(root: &Path, mode: Mode) -> Result<()> {
let path = root.join("Core/configs/modules/coa.conf");
let Ok(bytes) = fs::read(&path) else {
return Ok(());
};
let mut conf = ConfFile::parse_bytes(&bytes)?;
let current = conf
.get("CoA.ClassModel")
.map(crate::config::parser::unquote)
.unwrap_or("coa")
.to_string();
let wanted = class_model_for(mode);
if current.split_whitespace().eq([wanted]) {
return Ok(());
}
conf.set("CoA.ClassModel", &format!("\"{wanted}\""), &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
tracing::warn!(realm = mode.name(), from = %current, to = wanted, "CoA.ClassModel did not fit the selected realm and was corrected");
Ok(())
}
pub fn before_start(root: &Path) -> Result<()> {
recover(root)?;
let s = state(root)?;
align_class_model(root, s.active)?;
if !root.join(STATE).exists() {
return Ok(());
}
prepare_launcher(root)?;
if s.simultaneous && !view(root)?.supported {
return Err(Error::Invalid(
"The installed server build does not support simultaneous Wildcard startup.".into(),
));
}
if (s.simultaneous || s.with_reborn) && s.active == Mode::Reborn {
return Err(Error::Invalid(
"Realms that start together need Conquest of Azeroth or Wildcard as the main realm.".into(),
));
}
if s.with_reborn && s.active != Mode::Coa {
return Err(Error::Invalid(
"Warcraft Reborn can start together with Conquest of Azeroth only. Select Conquest of Azeroth first.".into(),
));
}
if s.with_reborn && !view(root)?.reborn_supported {
return Err(Error::Invalid(
"The installed server build does not support Warcraft Reborn.".into(),
));
}
if s.simultaneous || s.with_reborn {
fsx::atomic_write_json(&snapshot(root, s.active), &configs(root)?)?;
}
if s.active == Mode::Reborn && !view(root)?.reborn_supported {
return Err(Error::Invalid(
"The installed server build does not support Warcraft Reborn.".into(),
));
}
if s.simultaneous && !view(root)?.supported { return Err(Error::Invalid("The installed server build does not support simultaneous Wildcard startup.".into())); }
if s.simultaneous && s.active == Mode::Reborn { return Err(Error::Invalid("Simultaneous startup supports CoA and Wildcard only.".into())); }
if s.simultaneous { fsx::atomic_write_json(&snapshot(root, s.active), &configs(root)?)?; }
if s.active == Mode::Reborn && !view(root)?.reborn_supported { return Err(Error::Invalid("The installed server build does not support Warcraft Reborn.".into())); }
if s.active != Mode::Coa {
if s.active == Mode::Wildcard && !view(root)?.supported {
return Err(Error::Invalid(
"The installed server build does not support Wildcard.".into(),
));
}
if s.active == Mode::Wildcard && !view(root)?.supported { return Err(Error::Invalid("The installed server build does not support Wildcard.".into())); }
let path = root.join("Core/configs/modules/mod_coa_playerbots.conf");
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("CoaBots.Enable", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
let path = root.join("Core/configs/modules/playerbots.conf");
let bytes = if path.exists() {
fs::read(&path)?
} else {
b"[worldserver]\n".to_vec()
};
let bytes = if path.exists() { fs::read(&path)? } else { b"[worldserver]\n".to_vec() };
let mut conf = ConfFile::parse_bytes(&bytes)?;
conf.set("AiPlayerbot.Enabled", "0", &[]);
fsx::atomic_write(&path, conf.to_text().as_bytes())?;
@@ -813,9 +552,7 @@ pub fn before_start(root: &Path) -> Result<()> {
pub fn setup_realmlist(root: &Path) -> Result<()> {
let s = state(root)?;
if !root.join(STATE).exists() {
return Ok(());
}
if !root.join(STATE).exists() { return Ok(()); }
let db = Db::from_repack(root, Account::Admin)?.for_realm(Mode::Coa);
let port = layout::read_ports(root).world;
for mode in s.modes().into_iter().filter(|m| *m != Mode::Coa) {
@@ -823,16 +560,8 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
let name = mode.label();
db.query(&format!("INSERT INTO acore_auth.realmlist (id,name,address,localAddress,localSubnetMask,port,icon,flag,timezone,gamebuild) SELECT {id},'{name}',address,localAddress,localSubnetMask,{port},icon,2,timezone,gamebuild FROM acore_auth.realmlist WHERE id=1 ON DUPLICATE KEY UPDATE port={port};"))?;
}
let ids = s
.modes()
.iter()
.map(|m| m.realm_id().to_string())
.collect::<Vec<_>>()
.join(",");
db.query(&format!(
"UPDATE acore_auth.realmlist SET flag=2 WHERE id IN ({ids}) AND id<>{};",
s.active.realm_id()
))?;
let ids = s.modes().iter().map(|m| m.realm_id().to_string()).collect::<Vec<_>>().join(",");
db.query(&format!("UPDATE acore_auth.realmlist SET flag=2 WHERE id IN ({ids}) AND id<>{};", s.active.realm_id()))?;
if s.simultaneous {
let second = s
.secondary_world_port
@@ -844,56 +573,19 @@ pub fn setup_realmlist(root: &Path) -> Result<()> {
};
db.query(&format!("UPDATE acore_auth.realmlist SET port=CASE id WHEN 1 THEN {coa} ELSE {wildcard} END,flag=0 WHERE id IN (1,2);"))?;
}
if s.with_reborn {
let reborn = s
.reborn_world_port
.ok_or_else(|| Error::Invalid("Warcraft Reborn realm port is missing.".into()))?;
db.query(&format!(
"UPDATE acore_auth.realmlist SET port={reborn},flag=0 WHERE id={};",
Mode::Reborn.realm_id()
))?;
}
Ok(())
}
pub fn world_port_for_mode(root: &Path, mode: Mode) -> Result<u16> {
let ports = crate::layout::read_ports(root);
let s = state(root)?;
if mode == s.active {
return Ok(ports.world);
}
if mode == Mode::Reborn && s.with_reborn && s.active == Mode::Coa {
return s
.reborn_world_port
.ok_or_else(|| Error::Invalid("Warcraft Reborn realm port is missing.".into()));
}
if s.simultaneous && matches!((s.active, mode), (Mode::Coa, Mode::Wildcard) | (Mode::Wildcard, Mode::Coa)) {
return s
.secondary_world_port
.ok_or_else(|| Error::Invalid("Second realm port is missing.".into()));
}
Err(Error::Invalid(format!(
"Realm mode {mode:?} is not active (active: {:?}) and simultaneous mode is disabled.",
s.active
)))
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn legacy_states_and_all_created_realms_are_enumerated_once() {
let legacy: RealmState =
serde_json::from_str(r#"{"active":"wildcard","wildcard_created":true}"#).unwrap();
let legacy: RealmState = serde_json::from_str(r#"{"active":"wildcard","wildcard_created":true}"#).unwrap();
assert!(!legacy.reborn_created);
assert_eq!(legacy.modes(), [Mode::Wildcard, Mode::Coa]);
let all = RealmState {
active: Mode::Reborn,
wildcard_created: true,
reborn_created: true,
..Default::default()
};
let all = RealmState { active: Mode::Reborn, wildcard_created: true, reborn_created: true, ..Default::default() };
assert_eq!(all.modes(), [Mode::Reborn, Mode::Coa, Mode::Wildcard]);
assert_eq!(serde_json::to_string(&Mode::Reborn).unwrap(), "\"reborn\"");
assert_eq!(Mode::Reborn.realm_id(), 3);
@@ -904,187 +596,30 @@ mod tests {
fn reborn_has_its_own_settings_and_restores_the_coa_profile() {
let t = tempfile::tempdir().unwrap();
let mut coa = Files::new();
coa.insert(
"Core/configs/modules/coa.conf".into(),
b"[worldserver]\nCoA.ClassModel = coa\nCoA.GameModeMask = 0\n".to_vec(),
);
coa.insert(
"Settings/worldserver.conf.template".into(),
b"[worldserver]\nRealmID = 1\n".to_vec(),
);
coa.insert(
"Core/configs/modules/playerbots.conf".into(),
b"[worldserver]\nAiPlayerbot.Enabled = 1\n".to_vec(),
);
coa.insert("Core/configs/modules/coa.conf".into(), b"[worldserver]\nCoA.ClassModel = coa\nCoA.GameModeMask = 0\n".to_vec());
coa.insert("Settings/worldserver.conf.template".into(), b"[worldserver]\nRealmID = 1\n".to_vec());
coa.insert("Core/configs/modules/playerbots.conf".into(), b"[worldserver]\nAiPlayerbot.Enabled = 1\n".to_vec());
let reborn = reborn_configs(coa.clone()).unwrap();
let conf = ConfFile::parse_bytes(&reborn["Core/configs/modules/coa.conf"]).unwrap();
assert_eq!(conf.get("CoA.ClassModel"), Some("\"wcr\""));
assert_eq!(conf.get("CoA.GameModeMask"), Some("0"));
assert_eq!(
ConfFile::parse_bytes(&reborn["Settings/worldserver.conf.template"])
.unwrap()
.get("RealmID"),
Some("3")
);
assert_eq!(
ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"])
.unwrap()
.get("AiPlayerbot.Enabled"),
Some("0")
);
assert_eq!(ConfFile::parse_bytes(&reborn["Settings/worldserver.conf.template"]).unwrap().get("RealmID"), Some("3"));
assert_eq!(ConfFile::parse_bytes(&reborn["Core/configs/modules/playerbots.conf"]).unwrap().get("AiPlayerbot.Enabled"), Some("0"));
write_configs(t.path(), &reborn).unwrap();
write_configs(t.path(), &coa).unwrap();
assert_eq!(configs(t.path()).unwrap(), coa);
fsx::atomic_write_json(
&t.path().join(STATE),
&RealmState {
active: Mode::Reborn,
reborn_created: true,
..Default::default()
},
)
.unwrap();
fsx::atomic_write_json(&t.path().join(STATE), &RealmState { active: Mode::Reborn, reborn_created: true, ..Default::default() }).unwrap();
assert!(guard_module(t.path(), "companions").is_err());
assert!(guard_module(t.path(), "playerbots").is_err());
assert!(guard_module(t.path(), "content-scaling").is_ok());
}
fn write_class_model(root: &Path, text: &str) {
fsx::atomic_write(&root.join("Core/configs/modules/coa.conf"), text.as_bytes()).unwrap();
}
fn class_model(root: &Path) -> String {
let bytes = fs::read(root.join("Core/configs/modules/coa.conf")).unwrap();
ConfFile::parse_bytes(&bytes)
.unwrap()
.get("CoA.ClassModel")
.unwrap_or_default()
.to_string()
}
#[test]
fn a_class_model_that_does_not_fit_the_realm_is_replaced_by_the_realms_own() {
let t = tempfile::tempdir().unwrap();
// No file: left to the server. No key: the server default "coa" applies, which fits Conquest of Azeroth.
align_class_model(t.path(), Mode::Coa).unwrap();
assert!(!t.path().join("Core/configs/modules/coa.conf").exists());
write_class_model(t.path(), "[worldserver]
# CoA.ClassModel = \"hero\"
");
align_class_model(t.path(), Mode::Coa).unwrap();
assert_eq!(class_model(t.path()), "");
write_class_model(t.path(), "# note
CoA.ClassModel = \"hero\"
CoA.GameModeMask = 0
");
align_class_model(t.path(), Mode::Coa).unwrap();
assert_eq!(
fs::read_to_string(t.path().join("Core/configs/modules/coa.conf")).unwrap(),
"# note
CoA.ClassModel = \"coa\"
CoA.GameModeMask = 0
"
);
align_class_model(t.path(), Mode::Wildcard).unwrap();
assert_eq!(class_model(t.path()), "\"hero\"");
align_class_model(t.path(), Mode::Reborn).unwrap();
assert_eq!(class_model(t.path()), "\"wcr\"");
// A missing key does not fit a realm other than Conquest of Azeroth.
write_class_model(t.path(), "[worldserver]
");
align_class_model(t.path(), Mode::Wildcard).unwrap();
assert_eq!(class_model(t.path()), "\"hero\"");
}
#[test]
fn a_class_model_list_is_narrowed_to_the_realms_own_model() {
let t = tempfile::tempdir().unwrap();
// The shipped default serves two models; the realm chosen in the Manager keeps only its own.
for (mode, want) in [(Mode::Coa, "\"coa\""), (Mode::Reborn, "\"wcr\"")] {
write_class_model(t.path(), "CoA.ClassModel = \"coa wcr\"
");
align_class_model(t.path(), mode).unwrap();
assert_eq!(class_model(t.path()), want);
}
// A setting that is already exactly right is not rewritten, quoted or not.
for (text, mode) in [
("CoA.ClassModel = \"coa\"
", Mode::Coa),
("CoA.ClassModel = hero
", Mode::Wildcard),
] {
write_class_model(t.path(), text);
align_class_model(t.path(), mode).unwrap();
assert_eq!(
fs::read_to_string(t.path().join("Core/configs/modules/coa.conf")).unwrap(),
text
);
}
}
#[test]
fn before_start_aligns_the_class_model_with_the_active_realm() {
let t = tempfile::tempdir().unwrap();
write_class_model(t.path(), "CoA.ClassModel = \"hero\"
");
before_start(t.path()).unwrap();
assert_eq!(class_model(t.path()), "\"coa\"");
}
#[test]
fn extra_realms_follow_the_two_switches_and_old_states_still_load() {
let old: RealmState = serde_json::from_str(
r#"{"active":"coa","wildcard_created":true,"simultaneous":true,"secondary_world_port":8086}"#,
)
.unwrap();
assert!(!old.with_reborn && old.reborn_world_port.is_none());
assert_eq!(old.extra_modes(), [Mode::Wildcard]);
let mut s = RealmState::default();
assert!(s.extra_modes().is_empty());
s.with_reborn = true;
assert_eq!(s.extra_modes(), [Mode::Reborn]);
s.simultaneous = true;
assert_eq!(s.extra_modes(), [Mode::Wildcard, Mode::Reborn]);
// Wildcard as the main realm still pairs with Conquest of Azeroth.
s.active = Mode::Wildcard;
s.with_reborn = false;
assert_eq!(s.extra_modes(), [Mode::Coa]);
}
#[test]
fn each_running_realm_has_its_own_world_port() {
let t = tempfile::tempdir().unwrap();
fsx::atomic_write(&t.path().join("Settings/repack.json"), br#"{"worldPort": 8085}"#).unwrap();
let write = |json: &str| fsx::atomic_write(&t.path().join(STATE), json.as_bytes()).unwrap();
write(r#"{"active":"coa","wildcard_created":true,"reborn_created":true,"simultaneous":true,"secondary_world_port":8086,"with_reborn":true,"reborn_world_port":8087}"#);
assert_eq!(world_port_for_mode(t.path(), Mode::Coa).unwrap(), 8085);
assert_eq!(world_port_for_mode(t.path(), Mode::Wildcard).unwrap(), 8086);
assert_eq!(world_port_for_mode(t.path(), Mode::Reborn).unwrap(), 8087);
// Only Reborn next to Conquest of Azeroth: Wildcard is not running anywhere.
write(r#"{"active":"coa","wildcard_created":true,"reborn_created":true,"with_reborn":true,"reborn_world_port":8087}"#);
assert_eq!(world_port_for_mode(t.path(), Mode::Reborn).unwrap(), 8087);
assert!(world_port_for_mode(t.path(), Mode::Wildcard).is_err());
// Reborn only pairs with Conquest of Azeroth as the main realm.
write(r#"{"active":"wildcard","wildcard_created":true,"reborn_created":true,"with_reborn":true,"reborn_world_port":8087}"#);
assert!(world_port_for_mode(t.path(), Mode::Reborn).is_err());
}
#[test]
fn reborn_support_requires_the_new_code_in_the_installed_binary() {
let t = tempfile::tempdir().unwrap();
fsx::atomic_write(
&t.path().join("Core/worldserver.exe"),
b"Wildcard synergy settings",
)
.unwrap();
fsx::atomic_write(&t.path().join("Core/worldserver.exe"), b"Wildcard synergy settings").unwrap();
assert!(!view(t.path()).unwrap().reborn_supported);
fsx::atomic_write(
&t.path().join("Core/worldserver.exe"),
b"Warcraft Reborn class spells are unavailable",
)
.unwrap();
fsx::atomic_write(&t.path().join("Core/worldserver.exe"), b"Warcraft Reborn class spells are unavailable").unwrap();
let v = view(t.path()).unwrap();
assert!(v.reborn_supported);
assert!(!v.supported);
@@ -1094,13 +629,8 @@ CoA.GameModeMask = 0
fn old_launcher_upgrades_and_both_patch_versions_are_reversible() {
let original = "(\"WorldDatabaseInfo\", \"acore_world\")\n(\"CharacterDatabaseInfo\", \"acore_characters\")\nSET name='AzerothCore',address=\nWHERE id=1;\nmysql(\"UPDATE acore_auth.realmlist SET flag=0\nif __name__ == \"__main__\":\n";
let mut old = original.to_string();
for (from, to) in LAUNCHER_REALM_REPLACEMENTS {
old = old.replace(from, to);
}
old = old.replace(
"if __name__ == \"__main__\":",
&format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":"),
);
for (from, to) in LAUNCHER_REALM_REPLACEMENTS { old = old.replace(from, to); }
old = old.replace("if __name__ == \"__main__\":", &format!("{LAUNCHER_REALM_INSERT}if __name__ == \"__main__\":"));
assert_eq!(unpatch_launcher(&old).as_deref(), Some(original));
let new = patch_launcher(&old).unwrap();
assert!(new.contains("acore_world_reborn"));
+14 -67
View File
@@ -4,57 +4,23 @@ use std::path::Path;
/// SQUID has its own import ledger, outside the signed package migration ledger.
/// Keep this read-only: a pending base import can contain player data and must not
/// be replayed or cleared merely because the normal schema contract passes.
pub(crate) fn database_problems(
root: &Path,
mode: crate::realms::Mode,
query: &impl Fn(&str) -> crate::Result<String>,
) -> crate::Result<Vec<crate::schema_check::Problem>> {
pub(crate) fn database_problems(root: &Path, mode: crate::realms::Mode, query: &impl Fn(&str) -> crate::Result<String>) -> crate::Result<Vec<crate::schema_check::Problem>> {
let active = root.join("Core/configs/modules/playerbots.conf");
let config = if active.is_file() {
active
} else {
root.join("Core/configs/modules/playerbots.conf.dist")
};
let config = if active.is_file() { active } else { root.join("Core/configs/modules/playerbots.conf.dist") };
let enabled = if config.is_file() {
let conf = crate::config::parser::ConfFile::parse_bytes(&std::fs::read(config)?)?;
!matches!(
conf.get("AiPlayerbot.Enabled")
.unwrap_or("1")
.trim()
.trim_matches('"')
.to_ascii_lowercase()
.as_str(),
"0" | "false" | "no" | "off"
)
} else {
false
};
!matches!(conf.get("AiPlayerbot.Enabled").unwrap_or("1").trim().trim_matches('"').to_ascii_lowercase().as_str(), "0" | "false" | "no" | "off")
} else { false };
let mut problems = Vec::new();
for schema in [
mode.schema("characters")?,
mode.schema("world")?,
"acore_playerbots",
] {
let tables: std::collections::BTreeSet<_> = query(&format!(
"SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}';"
))?
.lines()
.map(str::to_owned)
.collect();
for schema in [mode.schema("characters")?, mode.schema("world")?, "acore_playerbots"] {
let tables: std::collections::BTreeSet<_> = query(&format!("SELECT TABLE_NAME FROM information_schema.TABLES WHERE TABLE_SCHEMA='{schema}';"))?.lines().map(str::to_owned).collect();
if tables.contains("coa_squid_pending") {
for pending in query(&format!("SELECT path FROM `{schema}`.coa_squid_pending;"))?
.lines()
.filter(|path| !path.is_empty())
{
for pending in query(&format!("SELECT path FROM `{schema}`.coa_squid_pending;"))?.lines().filter(|path| !path.is_empty()) {
problems.push(crate::schema_check::Problem { database: schema.into(), table: "coa_squid_pending".into(), column: String::new(), detail: format!("SQUID base import was interrupted: {pending}. File repair and package SQL updates cannot complete this import. Restore a verified database backup from before the import; do not delete the pending record or replay base SQL.") });
}
}
if enabled && schema == mode.schema("characters")? {
for table in [
"playerbots_names",
"playerbots_guild_names",
"playerbots_arena_team_names",
] {
for table in ["playerbots_names", "playerbots_guild_names", "playerbots_arena_team_names"] {
if !tables.contains(table) {
problems.push(crate::schema_check::Problem { database: schema.into(), table: table.into(), column: String::new(), detail: "Required SQUID character table is missing. A normal server start provisions it when no interrupted import is present; an interrupted import requires database recovery first.".into() });
}
@@ -271,13 +237,9 @@ mod tests {
for mode in [crate::realms::Mode::Coa, crate::realms::Mode::Wildcard] {
let problems = database_problems(root.path(), mode, &|sql| {
assert!(sql.starts_with("SELECT "));
if sql.contains("information_schema.TABLES") {
Ok("coa_squid_pending".into())
} else {
Ok("playerbots/base/ai_playerbot_texts.sql".into())
}
})
.unwrap();
if sql.contains("information_schema.TABLES") { Ok("coa_squid_pending".into()) }
else { Ok("playerbots/base/ai_playerbot_texts.sql".into()) }
}).unwrap();
assert_eq!(problems.len(), 3);
assert_eq!(problems[0].database, mode.schema("characters").unwrap());
assert!(problems.iter().all(|p| p.detail.contains("interrupted")));
@@ -290,26 +252,11 @@ mod tests {
let config = root.path().join("Core/configs/modules/playerbots.conf");
crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 1\n").unwrap();
let query = |_: &str| Ok(String::new());
assert_eq!(
database_problems(root.path(), crate::realms::Mode::Wildcard, &query)
.unwrap()
.len(),
3
);
assert_eq!(database_problems(root.path(), crate::realms::Mode::Wildcard, &query).unwrap().len(), 3);
crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 0\n").unwrap();
assert!(
database_problems(root.path(), crate::realms::Mode::Wildcard, &query)
.unwrap()
.is_empty()
);
assert!(database_problems(root.path(), crate::realms::Mode::Wildcard, &query).unwrap().is_empty());
crate::fsx::atomic_write(&config, b"AiPlayerbot.Enabled = 1\n").unwrap();
assert!(
database_problems(root.path(), crate::realms::Mode::Coa, &|_| Ok(
"playerbots_names\nplayerbots_guild_names\nplayerbots_arena_team_names".into()
))
.unwrap()
.is_empty()
);
assert!(database_problems(root.path(), crate::realms::Mode::Coa, &|_| Ok("playerbots_names\nplayerbots_guild_names\nplayerbots_arena_team_names".into())).unwrap().is_empty());
}
#[test]
fn a_setting_with_choices_only_accepts_one_of_them() {
+8 -12
View File
@@ -1527,6 +1527,9 @@ impl RepackEnv<'_> {
return Ok(Some(0));
}
let count = |db: &crate::db::Db| -> Result<usize> {
let db = db.clone().with_read_deadline(
std::time::Instant::now() + std::time::Duration::from_secs(15),
);
let realms = crate::realms::state(self.root)?;
let modes = realms.modes();
let mut count = 0;
@@ -1848,8 +1851,9 @@ impl RepackEnv<'_> {
if o.mysql.state == ServiceState::Running
&& o.auth.state == ServiceState::Running
&& o.world.state == ServiceState::Running
&& o.extra_worlds()
.all(|s| s.state == ServiceState::Running)
&& o.secondary_world
.as_ref()
.is_none_or(|s| s.state == ServiceState::Running)
{
let since = ready_since.get_or_insert_with(std::time::Instant::now);
if since.elapsed() >= std::time::Duration::from_secs(10) {
@@ -1960,16 +1964,8 @@ fn database_identities(
let mut identities = BTreeMap::new();
for (schema, table, columns) in [
("acore_characters", "characters", "guid,account,HEX(name)"),
(
"acore_characters_wildcard",
"characters",
"guid,account,HEX(name)",
),
(
"acore_characters_reborn",
"characters",
"guid,account,HEX(name)",
),
("acore_characters_wildcard", "characters", "guid,account,HEX(name)"),
("acore_characters_reborn", "characters", "guid,account,HEX(name)"),
("acore_auth", "account", "id,HEX(username)"),
] {
if !db.schema_exists(schema)? || !db.tables(schema)?.iter().any(|name| name == table) {
+60 -156
View File
@@ -1,85 +1,41 @@
use crate::{config::parser::ConfFile, fsx, Error, Result};
use serde::{Deserialize, Serialize};
use std::{collections::BTreeMap, fs, path::Path};
use serde::{Deserialize, Serialize};
use crate::{config::parser::ConfFile, fsx, Error, Result};
const FILES: &[&str] = &[
"Settings/repack.json",
"Settings/realm-profile.json",
"Settings/worldserver.conf.template",
"Settings/authserver.conf.template",
"Core/configs/worldserver.conf",
"Core/configs/authserver.conf",
"Settings/realm-profiles/coa.json",
"Settings/realm-profiles/wildcard.json",
".realms/secondary/Settings/repack.json",
".realms/secondary/Settings/realm-profile.json",
".realms/secondary/Settings/worldserver.conf.template",
".realms/secondary/Settings/authserver.conf.template",
".realms/secondary/Core/configs/worldserver.conf",
".realms/secondary/Core/configs/authserver.conf",
"Settings/repack.json", "Settings/realm-profile.json",
"Settings/worldserver.conf.template", "Settings/authserver.conf.template",
"Core/configs/worldserver.conf", "Core/configs/authserver.conf",
"Settings/realm-profiles/coa.json", "Settings/realm-profiles/wildcard.json",
".realms/secondary/Settings/repack.json", ".realms/secondary/Settings/realm-profile.json",
".realms/secondary/Settings/worldserver.conf.template", ".realms/secondary/Settings/authserver.conf.template",
".realms/secondary/Core/configs/worldserver.conf", ".realms/secondary/Core/configs/authserver.conf",
"Settings/realm-profiles/reborn.json",
".realms/reborn/Settings/repack.json",
".realms/reborn/Settings/realm-profile.json",
".realms/reborn/Settings/worldserver.conf.template",
".realms/reborn/Settings/authserver.conf.template",
".realms/reborn/Core/configs/worldserver.conf",
".realms/reborn/Core/configs/authserver.conf",
];
/// Ports of the extra worlds kept in the realm profile.
const REALM_PORT_KEYS: [&str; 4] = [
"secondary_world_port",
"secondary_ra_port",
"reborn_world_port",
"reborn_ra_port",
];
#[derive(Serialize, Deserialize)]
#[serde(deny_unknown_fields)]
struct Saved {
bytes: Option<Vec<u8>>,
sha256: Option<String>,
}
struct Saved { bytes: Option<Vec<u8>>, sha256: Option<String> }
pub(crate) fn pending(meta: &Path) -> bool {
meta.join("validation-configs.json").exists()
}
pub(crate) fn pending(meta: &Path) -> bool { meta.join("validation-configs.json").exists() }
pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> {
if pending(meta) {
return Err(Error::Invalid(
"Interrupted isolated validation must be recovered first.".into(),
));
}
if pending(meta) { return Err(Error::Invalid("Interrupted isolated validation must be recovered first.".into())); }
let mut saved = BTreeMap::new();
for rel in FILES {
let path = fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
let bytes = if path.exists() {
Some(fs::read(path)?)
} else {
None
};
let bytes = if path.exists() { Some(fs::read(path)?) } else { None };
let sha256 = bytes.as_ref().map(|b| fsx::sha256_bytes(b));
saved.insert(*rel, Saved { bytes, sha256 });
}
let mut settings: serde_json::Value = fsx::read_json(&root.join("Settings/repack.json"))?;
let mut realm: Option<serde_json::Value> = if root.join("Settings/realm-profile.json").exists()
{
let mut realm: Option<serde_json::Value> = if root.join("Settings/realm-profile.json").exists() {
Some(fsx::read_json(&root.join("Settings/realm-profile.json"))?)
} else {
None
};
let mut excluded: std::collections::BTreeSet<u64> =
["mysqlPort", "authPort", "worldPort", "raPort"]
.iter()
.filter_map(|key| settings[*key].as_u64())
.collect();
} else { None };
let mut excluded: std::collections::BTreeSet<u64> = ["mysqlPort", "authPort", "worldPort", "raPort"].iter()
.filter_map(|key| settings[*key].as_u64()).collect();
if let Some(state) = &realm {
excluded.extend(
REALM_PORT_KEYS
.iter()
.filter_map(|key| state[*key].as_u64()),
);
excluded.extend(["secondary_world_port", "secondary_ra_port"].iter().filter_map(|key| state[*key].as_u64()));
}
let mut sockets = Vec::new();
let mut reserve = || -> Result<u16> {
@@ -92,84 +48,29 @@ pub(crate) fn begin(root: &Path, meta: &Path) -> Result<()> {
}
}
};
for key in ["authPort", "worldPort", "raPort"] {
settings[key] = reserve()?.into();
}
for key in ["authPort", "worldPort", "raPort"] { settings[key] = reserve()?.into(); }
if let Some(state) = &mut realm {
for key in REALM_PORT_KEYS {
for key in ["secondary_world_port", "secondary_ra_port"] {
state[key] = reserve()?.into();
}
}
let mut configs = Vec::new();
for rel in [
"Settings/worldserver.conf.template",
"Settings/authserver.conf.template",
"Core/configs/worldserver.conf",
"Core/configs/authserver.conf",
] {
for rel in ["Settings/worldserver.conf.template", "Settings/authserver.conf.template", "Core/configs/worldserver.conf", "Core/configs/authserver.conf"] {
let path = root.join(rel);
if !path.exists() && rel.ends_with(".template") {
return Err(Error::Invalid(format!(
"Cannot isolate validation without {rel}."
)));
return Err(Error::Invalid(format!("Cannot isolate validation without {rel}.")));
}
if path.exists() {
let mut conf = ConfFile::parse_bytes(&fs::read(&path)?)?;
conf.set("BindIP", "\"127.0.0.1\"", &[]);
if rel.contains("worldserver") {
conf.set("Ra.IP", "\"127.0.0.1\"", &[]);
}
if rel.contains("worldserver") { conf.set("Ra.IP", "\"127.0.0.1\"", &[]); }
configs.push((path, conf.to_text()));
}
}
fsx::atomic_write_json(&meta.join("validation-configs.json"), &saved)?;
fsx::atomic_write_json(&root.join("Settings/repack.json"), &settings)?;
if let Some(state) = realm {
fsx::atomic_write_json(&root.join("Settings/realm-profile.json"), &state)?;
}
for (path, text) in configs {
fsx::atomic_write(&path, text.as_bytes())?;
}
Ok(())
}
pub(crate) fn restore(root: &Path, meta: &Path) -> Result<()> {
if !pending(meta) {
return Ok(());
}
let journal = meta.join("validation-configs.json");
let saved: BTreeMap<String, Saved> = fsx::read_json(&journal)?;
// Previous managers could journal only the first two profiles. Recover those
// journals too, while continuing to reject missing or unknown legacy entries.
let legacy = saved.len() == FILES.len() - 1
&& !saved.contains_key("Settings/realm-profiles/reborn.json");
let required = if legacy {
&FILES[..FILES.len() - 1]
} else {
FILES
};
if saved.len() != required.len() || required.iter().any(|rel| !saved.contains_key(*rel)) {
return Err(Error::Invalid(
"Isolated validation configuration journal is incomplete.".into(),
));
}
for (rel, file) in &saved {
fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
if file.bytes.as_ref().map(|b| fsx::sha256_bytes(b)) != file.sha256 {
return Err(Error::Invalid(format!(
"Isolated validation recovery copy {rel} is damaged."
)));
}
}
for (rel, file) in saved {
let path = fsx::ensure_within(root, &fsx::safe_join(root, &rel)?)?;
match file.bytes {
Some(bytes) => fsx::atomic_write(&path, &bytes)?,
None if path.exists() => fs::remove_file(path)?,
None => {}
}
}
fs::remove_file(journal)?;
if let Some(state) = realm { fsx::atomic_write_json(&root.join("Settings/realm-profile.json"), &state)?; }
for (path, text) in configs { fsx::atomic_write(&path, text.as_bytes())?; }
Ok(())
}
@@ -183,18 +84,10 @@ mod tests {
let meta = dir.path().join("metadata");
fs::create_dir_all(root.join("Settings")).unwrap();
fs::create_dir_all(&meta).unwrap();
fsx::atomic_write_json(
&root.join(FILES[0]),
&serde_json::json!({"mysqlPort":3306,"authPort":3724,"worldPort":8085,"raPort":3443}),
)
.unwrap();
fsx::atomic_write_json(&root.join(FILES[0]), &serde_json::json!({"mysqlPort":3306,"authPort":3724,"worldPort":8085,"raPort":3443})).unwrap();
fsx::atomic_write_json(&root.join(FILES[1]), &serde_json::json!({"simultaneous":true,"secondary_world_port":8086,"secondary_ra_port":3444})).unwrap();
for rel in [FILES[2], FILES[3]] {
fsx::atomic_write(
&root.join(rel),
b"BindIP = \"0.0.0.0\"\r\nRa.IP = \"0.0.0.0\"\r\n",
)
.unwrap();
fsx::atomic_write(&root.join(rel), b"BindIP = \"0.0.0.0\"\r\nRa.IP = \"0.0.0.0\"\r\n").unwrap();
}
(dir, root, meta)
}
@@ -202,11 +95,7 @@ mod tests {
#[test]
fn interrupted_validation_restores_original_bytes_and_absent_files() {
let (_dir, root, meta) = fixture();
fsx::atomic_write(
&root.join("Settings/realm-profiles/reborn.json"),
b"saved reborn profile",
)
.unwrap();
fsx::atomic_write(&root.join("Settings/realm-profiles/reborn.json"), b"saved reborn profile").unwrap();
let original: Vec<_> = FILES.iter().map(|p| fs::read(root.join(p)).ok()).collect();
begin(&root, &meta).unwrap();
assert!(crate::update::ensure_recovered(&meta).is_err());
@@ -214,28 +103,14 @@ mod tests {
let settings: serde_json::Value = fsx::read_json(&root.join(FILES[0])).unwrap();
assert_eq!(settings["mysqlPort"], 3306);
let realm: serde_json::Value = fsx::read_json(&root.join(FILES[1])).unwrap();
let ports: std::collections::BTreeSet<_> = [
settings["authPort"].as_u64(),
settings["worldPort"].as_u64(),
settings["raPort"].as_u64(),
realm["secondary_world_port"].as_u64(),
realm["secondary_ra_port"].as_u64(),
]
.into_iter()
.collect();
let ports: std::collections::BTreeSet<_> = [settings["authPort"].as_u64(), settings["worldPort"].as_u64(), settings["raPort"].as_u64(), realm["secondary_world_port"].as_u64(), realm["secondary_ra_port"].as_u64()].into_iter().collect();
assert_eq!(ports.len(), 5);
let config = ConfFile::parse_bytes(&fs::read(root.join(FILES[2])).unwrap()).unwrap();
assert_eq!(config.get("BindIP"), Some("\"127.0.0.1\""));
fsx::atomic_write(&root.join(FILES[4]), b"rendered temporary configuration").unwrap();
fsx::atomic_write(
&root.join("Settings/realm-profiles/reborn.json"),
b"temporary reborn profile",
)
.unwrap();
fsx::atomic_write(&root.join("Settings/realm-profiles/reborn.json"), b"temporary reborn profile").unwrap();
restore(&root, &meta).unwrap();
for (rel, bytes) in FILES.iter().zip(original) {
assert_eq!(fs::read(root.join(rel)).ok(), bytes);
}
for (rel, bytes) in FILES.iter().zip(original) { assert_eq!(fs::read(root.join(rel)).ok(), bytes); }
assert!(!pending(&meta));
restore(&root, &meta).unwrap();
}
@@ -264,3 +139,32 @@ mod tests {
assert_eq!(fs::read(root.join(FILES[0])).unwrap(), before);
}
}
pub(crate) fn restore(root: &Path, meta: &Path) -> Result<()> {
if !pending(meta) { return Ok(()); }
let journal = meta.join("validation-configs.json");
let saved: BTreeMap<String, Saved> = fsx::read_json(&journal)?;
// Previous managers could journal only the first two profiles. Recover those
// journals too, while continuing to reject missing or unknown legacy entries.
let legacy = saved.len() == FILES.len() - 1 && !saved.contains_key("Settings/realm-profiles/reborn.json");
let required = if legacy { &FILES[..FILES.len() - 1] } else { FILES };
if saved.len() != required.len() || required.iter().any(|rel| !saved.contains_key(*rel)) {
return Err(Error::Invalid("Isolated validation configuration journal is incomplete.".into()));
}
for (rel, file) in &saved {
fsx::ensure_within(root, &fsx::safe_join(root, rel)?)?;
if file.bytes.as_ref().map(|b| fsx::sha256_bytes(b)) != file.sha256 {
return Err(Error::Invalid(format!("Isolated validation recovery copy {rel} is damaged.")));
}
}
for (rel, file) in saved {
let path = fsx::ensure_within(root, &fsx::safe_join(root, &rel)?)?;
match file.bytes {
Some(bytes) => fsx::atomic_write(&path, &bytes)?,
None if path.exists() => fs::remove_file(path)?,
None => {},
}
}
fs::remove_file(journal)?;
Ok(())
}
+17 -75
View File
@@ -1,9 +1,4 @@
use crate::{
manifest::Manifest,
pkgsource::{self, Source},
registry::InstallMeta,
update, Result,
};
use crate::{manifest::Manifest, pkgsource::{self, Source}, registry::InstallMeta, update, Result};
#[derive(Debug)]
pub struct Selection {
@@ -13,22 +8,13 @@ pub struct Selection {
}
pub fn select(meta: &InstallMeta, source: Source, key: &str) -> Result<Selection> {
select_with(meta, source, &mut |source| {
pkgsource::fetch_manifest(source, key)
})
select_with(meta, source, &mut |source| pkgsource::fetch_manifest(source, key))
}
fn select_with(
meta: &InstallMeta,
source: Source,
fetch: &mut impl FnMut(&Source) -> Result<(Manifest, Vec<u8>)>,
) -> Result<Selection> {
fn select_with(meta: &InstallMeta, source: Source, fetch: &mut impl FnMut(&Source) -> Result<(Manifest, Vec<u8>)>) -> Result<Selection> {
let (manifest, _) = fetch(&source)?;
update::validate_candidate(meta, &manifest)?;
Ok(Selection {
source,
latest_version: None,
})
Ok(Selection { source, latest_version: None })
}
#[cfg(test)]
@@ -56,51 +42,23 @@ mod tests {
let folder = tempfile::tempdir().unwrap();
let signing = SigningKey::from_bytes(&[37; 32]);
let bytes = serde_json::to_vec(value).unwrap();
fs::write(
folder.path().join("manifest.json.sig"),
STANDARD.encode(signing.sign(&bytes).to_bytes()),
)
.unwrap();
fs::write(
folder.path().join("manifest.json"),
if tamper {
b"tampered".as_slice()
} else {
&bytes
},
)
.unwrap();
fs::write(folder.path().join("manifest.json.sig"), STANDARD.encode(signing.sign(&bytes).to_bytes())).unwrap();
fs::write(folder.path().join("manifest.json"), if tamper { b"tampered".as_slice() } else { &bytes }).unwrap();
(folder, STANDARD.encode(signing.verifying_key().to_bytes()))
}
#[test]
fn every_known_older_version_selects_the_latest_signed_package_once() {
for installed in [
"0.2.0",
"0.261004.20",
"0.261005.0",
"0.261007.24",
"0.261011.800006",
"0.261013.54",
"0.261015.58",
] {
for installed in ["0.2.0", "0.261004.20", "0.261005.0", "0.261007.24", "0.261011.800006", "0.261013.54", "0.261015.58"] {
let (folder, key) = fixture(&package(), false);
for kind in [
crate::registry::InstallKind::New,
crate::registry::InstallKind::Imported,
] {
for kind in [crate::registry::InstallKind::New, crate::registry::InstallKind::Imported] {
let mut installation = meta(installed);
installation.kind = kind;
let mut calls = 0;
let selected = select_with(
&installation,
Source::Dir(folder.path().into()),
&mut |source| {
calls += 1;
pkgsource::fetch_manifest(source, &key)
},
)
.unwrap();
let selected = select_with(&installation, Source::Dir(folder.path().into()), &mut |source| {
calls += 1;
pkgsource::fetch_manifest(source, &key)
}).unwrap();
assert!(matches!(selected.source, Source::Dir(path) if path == folder.path()));
assert!(selected.latest_version.is_none());
assert_eq!(calls, 1, "no intermediate package fetches for {installed}");
@@ -119,33 +77,17 @@ mod tests {
#[test]
fn signed_target_is_required_even_for_unlisted_old_versions() {
let (folder, key) = fixture(&package(), true);
assert!(select(
&meta("0.261004.20"),
Source::Dir(folder.path().into()),
&key
)
.is_err());
assert!(select(&meta("0.261004.20"), Source::Dir(folder.path().into()), &key).is_err());
}
#[test]
fn platform_and_manager_requirements_are_still_enforced() {
for (field, value) in [
("minManagerVersion", "99.0.0"),
("platform", "other-platform"),
] {
for (field, value) in [("minManagerVersion", "99.0.0"), ("platform", "other-platform")] {
let mut target = package();
if field == "platform" {
target["compatibility"][field] = value.into();
} else {
target[field] = value.into();
}
if field == "platform" { target["compatibility"][field] = value.into(); }
else { target[field] = value.into(); }
let (folder, key) = fixture(&target, false);
assert!(select(
&meta("0.261004.20"),
Source::Dir(folder.path().into()),
&key
)
.is_err());
assert!(select(&meta("0.261004.20"), Source::Dir(folder.path().into()), &key).is_err());
}
}
}
+74 -4
View File
@@ -160,8 +160,11 @@ pub fn external_ip(gw: &Gateway) -> Result<Ipv4Addr> {
}
pub fn add_mapping(gw: &Gateway, port: u16, lan: Ipv4Addr, what: &str) -> Result<()> {
soap(
gw,
add_mapping_with(port, lan, what, |action, args| soap(gw, action, args))
}
fn add_mapping_with(port: u16, lan: Ipv4Addr, what: &str, mut request: impl FnMut(&str, &[(&str, String)]) -> Result<String>) -> Result<()> {
let result = request(
"AddPortMapping",
&[
("NewRemoteHost", String::new()),
@@ -176,8 +179,28 @@ pub fn add_mapping(gw: &Gateway, port: u16, lan: Ipv4Addr, what: &str) -> Result
),
("NewLeaseDuration", "0".into()),
],
)
.map(|_| ())
);
match result {
Ok(_) => Ok(()),
Err(error) => {
// Some routers reject a mapping that already points to us. Read it back;
// never delete or replace another host's mapping.
let existing = request("GetSpecificPortMappingEntry", &[
("NewRemoteHost", String::new()),
("NewExternalPort", port.to_string()),
("NewProtocol", "TCP".into()),
]);
if let Ok(xml) = existing {
let client = between(&xml, "<NewInternalClient>", "</NewInternalClient>").and_then(|v| v.parse::<Ipv4Addr>().ok());
let internal_port = between(&xml, "<NewInternalPort>", "</NewInternalPort>").and_then(|v| v.parse::<u16>().ok());
let enabled = between(&xml, "<NewEnabled>", "</NewEnabled>");
if client == Some(lan) && internal_port == Some(port) && matches!(enabled, Some("1" | "true")) {
return Ok(());
}
}
Err(Error::Invalid(format!("Could not forward TCP port {port}: {error}. Check the router's existing port forwarding rules for this port.")))
}
}
}
pub fn remove_mapping(gw: &Gateway, port: u16) -> Result<()> {
@@ -202,6 +225,53 @@ mod tests {
<service><serviceType>urn:schemas-upnp-org:service:WANIPConnection:1</serviceType><controlURL>/ctl/IPConn</controlURL></service>\
</serviceList></device></deviceList></device></deviceList></device></root>";
#[test]
fn existing_mapping_is_accepted_only_for_the_requested_destination() {
let lan = "192.168.1.5".parse().unwrap();
for (client, port, enabled, accepted) in [
("192.168.1.5", "3724", "1", true),
("192.168.1.5", "3724", "true", true),
("192.168.1.6", "3724", "1", false),
("192.168.1.5", "8085", "1", false),
("192.168.1.5", "3724", "0", false),
("", "", "", false),
] {
let mut actions = Vec::new();
let result = add_mapping_with(3724, lan, "Login", |action, args| {
actions.push(action.to_string());
assert!(args.contains(&("NewExternalPort", "3724".into())));
assert!(args.contains(&("NewProtocol", "TCP".into())));
match action {
"AddPortMapping" => Err(Error::Invalid("ConflictInMappingEntry".into())),
"GetSpecificPortMappingEntry" => Ok(format!("<NewInternalClient>{client}</NewInternalClient><NewInternalPort>{port}</NewInternalPort><NewEnabled>{enabled}</NewEnabled>")),
_ => panic!("must not delete or modify an existing mapping"),
}
});
assert_eq!(result.is_ok(), accepted);
assert_eq!(actions, ["AddPortMapping", "GetSpecificPortMappingEntry"]);
if let Err(error) = result {
assert!(error.to_string().contains("TCP port 3724"));
assert!(error.to_string().contains("ConflictInMappingEntry"));
}
}
}
#[test]
fn successful_add_does_not_require_router_readback_support() {
add_mapping_with(8085, "192.168.1.5".parse().unwrap(), "World", |action, _| {
assert_eq!(action, "AddPortMapping");
Ok(String::new())
}).unwrap();
}
#[test]
fn failed_readback_keeps_the_original_error() {
let error = add_mapping_with(8085, "192.168.1.5".parse().unwrap(), "World", |action, _| {
Err(Error::Invalid(if action == "AddPortMapping" { "ConflictInMappingEntry" } else { "Unsupported action" }.into()))
}).unwrap_err().to_string();
assert!(error.contains("ConflictInMappingEntry") && error.contains("8085"));
}
#[test]
fn parses_ssdp_location_and_description() {
let resp = "HTTP/1.1 200 OK\r\nCACHE-CONTROL: max-age=120\r\nLocation: http://192.168.1.1:5000/rootDesc.xml\r\nST: x\r\n\r\n";
+1 -2
View File
@@ -229,8 +229,7 @@ impl ListQuery {
q.ruleset = Some(match value.as_str() {
"coa" => Ruleset::Coa,
"wildcard" => Ruleset::Wildcard,
"reborn" => Ruleset::Reborn,
_ => return invalid("ruleset is coa, wildcard or reborn"),
_ => return invalid("ruleset is coa or wildcard"),
})
}
"cap_min" => q.cap_min = Some(number("cap_min", &value, 255)?),
+1 -11
View File
@@ -20,12 +20,11 @@ pub const MAX_CATALOG_ENTRIES: usize = 8;
const MAX_TOKEN: usize = 64;
const MAX_IDENTITY: usize = 128;
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Ruleset {
Coa,
Wildcard,
Reborn,
}
impl Ruleset {
@@ -33,15 +32,6 @@ impl Ruleset {
match self {
Ruleset::Coa => "coa",
Ruleset::Wildcard => "wildcard",
Ruleset::Reborn => "reborn",
}
}
pub fn display_name(self) -> &'static str {
match self {
Ruleset::Coa => "Conquest of Azeroth",
Ruleset::Wildcard => "Wildcard",
Ruleset::Reborn => "Warcraft Reborn",
}
}
}
+24 -71
View File
@@ -56,104 +56,58 @@ fn run() -> Result<(), String> {
.unwrap_or(DEFAULT_PART_SIZE);
match cmd.as_str() {
"plan-update" => {
let mut meta = coa_core::registry::InstallMeta::new(
coa_core::registry::InstallKind::New,
std::path::Path::new("unused"),
);
let mut meta = coa_core::registry::InstallMeta::new(coa_core::registry::InstallKind::New, std::path::Path::new("unused"));
meta.core.version = Some(need(&a, "from")?.clone());
let selection = coa_core::update_route::select(
&meta,
coa_core::pkgsource::Source::Url(need(&a, "source")?.clone()),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
let (manifest, _) = coa_core::pkgsource::fetch_manifest(
&selection.source,
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
println!(
"{}",
serde_json::json!({"from":meta.core.version,"next":manifest.version,"latest":selection.latest_version})
);
let selection = coa_core::update_route::select(&meta, coa_core::pkgsource::Source::Url(need(&a, "source")?.clone()), coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&selection.source, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("{}", serde_json::json!({"from":meta.core.version,"next":manifest.version,"latest":selection.latest_version}));
}
"verify-install" => {
coa_core::release_schema::verify_install_package(
&PathBuf::from(need(&a, "dir")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
&PathBuf::from(need(&a, "dir")?), coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?;
}
"compose-install" => {
coa_core::release_schema::compose_install(
&PathBuf::from(need(&a, "base")?),
&PathBuf::from(need(&a, "candidate")?),
&PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
&PathBuf::from(need(&a, "base")?), &PathBuf::from(need(&a, "candidate")?),
&PathBuf::from(need(&a, "fixture")?), coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?;
}
"qualify-install" => {
let report = coa_core::release_schema::qualify_install(
&PathBuf::from(need(&a, "package")?),
&PathBuf::from(need(&a, "fixture")?),
&PathBuf::from(need(&a, "package")?), &PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report)
.map_err(e)?;
).map_err(e)?;
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report).map_err(e)?;
}
"qualify-upgrade" => {
let report = coa_core::release_schema::qualify_upgrade(
&PathBuf::from(need(&a, "base")?),
&PathBuf::from(need(&a, "source")?),
&PathBuf::from(need(&a, "candidate")?),
&PathBuf::from(need(&a, "fixture")?),
&PathBuf::from(need(&a, "base")?), &PathBuf::from(need(&a, "source")?),
&PathBuf::from(need(&a, "candidate")?), &PathBuf::from(need(&a, "fixture")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report)
.map_err(e)?;
).map_err(e)?;
coa_core::fsx::atomic_write_json(&PathBuf::from(need(&a, "report")?), &report).map_err(e)?;
println!("Manager upgrade transaction passed isolated qualification");
}
"qualify-startup" => {
coa_core::release_schema::validate_startup(
&PathBuf::from(need(&a, "fixture")?),
&PathBuf::from(need(&a, "tree")?),
&PathBuf::from(need(&a, "base")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
&PathBuf::from(need(&a, "fixture")?), &PathBuf::from(need(&a, "tree")?),
&PathBuf::from(need(&a, "base")?), coa_core::signing::EMBEDDED_PUBLIC_KEY,
).map_err(e)?;
println!("authserver and worldserver passed isolated startup qualification");
}
"verify-channel" => {
let bytes = std::fs::read(need(&a, "file")?).map_err(|x| x.to_string())?;
let pointer = coa_core::channels::verify(
&bytes,
need(&a, "channel")?,
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
println!(
"{}",
serde_json::to_string(&pointer).map_err(|x| x.to_string())?
);
let pointer = coa_core::channels::verify(&bytes, need(&a, "channel")?, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("{}", serde_json::to_string(&pointer).map_err(|x| x.to_string())?);
}
"verify-manifest" => {
let source = coa_core::pkgsource::Source::Dir(PathBuf::from(need(&a, "dir")?));
let (manifest, _) = coa_core::pkgsource::fetch_manifest(
&source,
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
let (manifest, _) = coa_core::pkgsource::fetch_manifest(&source, coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("verified signed manifest {}", manifest.version);
}
"verify-upgrade-fixture" => {
coa_core::release_schema::verify_upgrade_fixture(
&PathBuf::from(need(&a, "dir")?),
coa_core::signing::EMBEDDED_PUBLIC_KEY,
)
.map_err(e)?;
coa_core::release_schema::verify_upgrade_fixture(&PathBuf::from(need(&a, "dir")?), coa_core::signing::EMBEDDED_PUBLIC_KEY).map_err(e)?;
println!("verified signed upgrade fixture and every archive file");
}
"extract-schema-base" => {
@@ -298,8 +252,7 @@ fn run() -> Result<(), String> {
}
"sign-channel" => {
let pointer = coa_core::channels::Pointer {
schema: 1,
channel: need(&a, "channel")?.clone(),
schema: 1, channel: need(&a, "channel")?.clone(),
version: need(&a, "version")?.clone(),
release_tag: format!("server-{}", need(&a, "version")?),
snapshot: need(&a, "snapshot")?.clone(),
+4 -5
View File
@@ -6,7 +6,7 @@ type into the game.
Code: `crates/coa-control-proto` (the protocol: pure, no I/O), `services/coa-coordinator` (the Coordinator), `crates/coa-core/src/control` (Host and Player sides),
`src-tauri/src/control_cmds.rs` and `src/screens/JoinPanel.tsx` (the interface). End-to-end tests: `services/coa-control-e2e`. Deployment: [REGISTRY_DEPLOYMENT.md](REGISTRY_DEPLOYMENT.md).
`CONTROL_PROTOCOL_VERSION = 2` (bumped in MR1.1/MR2 to require explicit `ruleset` fields in transfer and claim negotiations); it is independent of the Registry protocol (2) and of the portable formats.
`CONTROL_PROTOCOL_VERSION = 1`; it is independent of the Registry protocol (2) and of the portable formats.
## 1. Shape
@@ -148,8 +148,8 @@ its profile, and only then sends `claim_ack`; the Host marks the binding `Portab
When a player selects a portable character that exists in their Player Manager but does not yet exist on the remote realm, the Player Manager performs an automated, transactional transfer over the encrypted Noise channel:
1. **Preflight Compatibility Check**: The Player Manager checks the canonical character against the target realm's advertised capabilities (Phase 7/8). If incompatible, the transfer is refused immediately before any network mutation.
2. **Transfer Offer (`TransferOffer`)**: Inside the end-to-end encrypted Noise channel, the Player Manager sends `transfer_offer{transfer_id, character_id, canonical_revision, content_hash, total_size, collections, ruleset}`.
- The Host validates the PlayerIdentity, character ownership, format revision, hash format, size limit (≤ 4 MiB, `MAX_TRANSFER_REQUEST_BYTES`), collection counts (≤ 100,000 items), and ruleset matching target realm.
2. **Transfer Offer (`TransferOffer`)**: Inside the end-to-end encrypted Noise channel, the Player Manager sends `transfer_offer{transfer_id, character_id, canonical_revision, content_hash, total_size, collections}`.
- The Host validates the PlayerIdentity, character ownership, format revision, hash format, size limit (≤ 4 MiB, `MAX_TRANSFER_REQUEST_BYTES`), and collection counts (≤ 100,000 items).
- If the exact revision was already committed or an active transfer session exists, the Host responds with `transfer_ready{transfer_id, accepted_offset}`.
3. **Payload Transfer & Chunking (`TransferChunk` / `TransferStatus`)**:
- The Player sends the payload in bounded chunks via `transfer_chunk{transfer_id, offset, data}`.
@@ -157,8 +157,7 @@ When a player selects a portable character that exists in their Player Manager b
- If a connection is interrupted, the Player can query progress via `transfer_status{transfer_id}` and resume from `accepted_offset`.
4. **Validation & Atomic Commit (`TransferCommit`)**:
- Once all chunks arrive, the Player sends `transfer_commit{transfer_id}`.
- The Host verifies the SHA-256 content hash of the canonical JSON against the offer.
- The Host decodes the payload and verifies that `decoded.character_id == transfer.character_id`, `decoded.ruleset == transfer.ruleset`, and `transfer.ruleset == destination_realm.ruleset`.
- The Host verifies the SHA-256 content hash of the assembled payload against the offer.
- The Host runs the level projection engine (e.g. projecting level 80 down to realm cap 60 via Phase-8 oracle).
- The Host imports the character into the realm's characters database, updates/creates the working copy mapping, and arms the session.
- The Host returns `transferred{character_id, local_guid, session_id}`.
+4
View File
@@ -1,5 +1,7 @@
# Host a CoA server for other players
**English** · [Русский](ru/HOST-A-SERVER.md) · [Deutsch](de/HOST-A-SERVER.md) · [Français](fr/HOST-A-SERVER.md) · [Español](es/HOST-A-SERVER.md) · [简体中文](zh-CN/HOST-A-SERVER.md)
**Portable characters are experimental.** The feature is in active development and may contain bugs.
## Set up your server
@@ -24,3 +26,5 @@ Open **Play with friends**. Use the LAN/private-network instructions for your co
A listing makes your server discoverable; it does not move hosting to the cloud or guarantee that your network can be reached. If joining fails, use the connection checks before changing router settings. Portable characters also require a compatible server build and its required settings.
Use **Backups** before changing server versions or optional modules. To stop accepting visitors, turn off the listing; to stop hosting, stop the server.
[All guides](README.md)
Loaded 100 of 273 files, more files were not shown because too many files have changed in this diff. Show more