diff --git a/addons/Comunidade-extras.xz b/addons/Comunidade-extras.xz index 49d5b39..c902797 100644 Binary files a/addons/Comunidade-extras.xz and b/addons/Comunidade-extras.xz differ diff --git a/addons/Comunidade.xpx.xz b/addons/Comunidade.xpx.xz index efe95fa..cf50f27 100644 Binary files a/addons/Comunidade.xpx.xz and b/addons/Comunidade.xpx.xz differ diff --git a/addons/GUIA.md b/addons/GUIA.md index 7c99e58..a9b4b8e 100644 --- a/addons/GUIA.md +++ b/addons/GUIA.md @@ -35,7 +35,7 @@ curl -L -H "Authorization: Bearer $token" -o CoreRules-Community-Addons-x86_64.A "https://ghcr.io/v2/$repo/blobs/$layer" ``` -Além de `latest`, cada versão do app tem a sua tag, como `0.7.2`. +Além de `latest`, cada versão do app tem a sua tag, como `1.0.0-rc1`. ## Instalação diff --git a/addons/README.md b/addons/README.md index 03987e1..7649613 100644 --- a/addons/README.md +++ b/addons/README.md @@ -153,9 +153,9 @@ failed. **Packaging.** The consolidated file is compressed with xz and built into the installer, `crates/cr-addons`, a Rust program with GTK 4 and -libadwaita that imports it through the same code as the app (`cr-store`), -in two passes so race and class combinations that name two new classes -come in. +libadwaita that imports it through the same code as the app's Import +(`cr-store`), so installing and importing `Comunidade.xpx` in the app leave +the same databases. **Pictures and texts.** The 668 pictures (8-bit BMP files) and 309 texts that came with the add-ons, again without Evermore's, are built into the diff --git a/addons/relatorio.md b/addons/relatorio.md index 428a88f..c0b9023 100644 --- a/addons/relatorio.md +++ b/addons/relatorio.md @@ -77,6 +77,16 @@ Ficaram algumas menções de nomes nas listas de outros addons: kits de raças d * Os bancos do usuário ficaram idênticos byte a byte aos que o antigo script de instalação gravava. * Instalar de novo não duplica personagens nem altera os registros, a não ser por 4 combinações de raças cujo nome se repete no pacote. +## Compatibilidade com o app 1.0.0-rc1 + +O pacote foi conferido de novo com o app 1.0.0-rc1, que corrigiu o travamento ao importar o `Comunidade.xpx` pela janela do app (o bug crítico dos testes da 0.9.0). + +* **Import pela janela do app:** a prévia abre e o Import traz os 36.525 itens sem travar, numa instalação limpa da Expansion. +* **Combinações raça/classe numa importação só.** Antes, uma combinação que cita duas classes novas do pacote só entrava numa segunda importação, como no original, e o Import do app mostrava 304 avisos "No race/class combinations could be added". Agora o Import fecha essas combinações na mesma vez. Sobram só os 36 avisos das raças que o pacote traz sem combinações, que são do próprio pacote. O instalador passou a importar uma vez só, e o resultado é idêntico byte a byte ao das duas passagens de antes. +* **Qilué Veladorn.** A personagem tem a classe "Sword Dancer", mas o pacote trazia a classe como "Sword Dancer " (com um espaço no fim, vinda de `sword dancer.xpx`). A ficha e o Edit Character recusavam abrir a personagem com "Sword Dancer is not a class in the databases". A classe e as suas 5 menções com espaço (2 combinações raça/classe e 3 listas de classes de kits e itens) passaram a "Sword Dancer", como já estavam nos outros 90 lugares do pacote. Nada mais mudou no pacote, o que foi conferido comparando os dois pacotes inteiros lidos pelo leitor do projeto. +* **Edição no app:** os 36.207 registros dos bancos do usuário foram abertos, passados campo a campo pelos editores da 1.0.0-rc1 e salvos, e nenhum foi recusado. Os 48 personagens abrem na ficha (texto, HTML e Markdown), são editados e salvos. +* **Instalador:** a AppImage 1.0.0-rc1 instalou o pacote numa cópia limpa em 22 segundos, com 36.525 itens, 48 personagens e 1.204 imagens, e gravou os mesmos bancos que o Import do app. + ## Imagens e textos Os addons trouxeram 685 imagens BMP e 321 textos. Sem os da Evermore, ficam 668 imagens e 309 textos, embutidos no instalador em `Comunidade-extras.xz`. @@ -84,5 +94,5 @@ Os addons trouxeram 685 imagens BMP e 321 textos. Sem os da Evermore, ficam 668 * **Para onde vai cada imagem.** Os registros guardam o caminho do Windows que a imagem tinha no computador do autor, como `C:\Program Files\AD&D Core Rules 2.0\Bitmaps\Monsters\Achaierai.BMP` ou `C:\AD&D Pics\troll.bmp`. Um caminho dentro de uma instalação do Core Rules, em qualquer drive, vira o mesmo caminho dentro da pasta de dados (`Bitmaps/Monsters/Achaierai.BMP`). Um caminho para o `Bitmaps` do CD fica em `Bitmaps`. Os outros vão para `UserBMP`, sem o drive (`UserBMP/AD&D Pics/troll.bmp`). No Wine, estes últimos também vão para o drive C:, onde o original os procura. * **Escolha da imagem.** 528 imagens são citadas pelos registros e vão para 536 lugares. Quando dois addons trazem imagens com o mesmo nome, vale a do addon de onde veio o registro. Nenhum lugar recebe duas imagens diferentes. As 4 citações a imagens do próprio CD ficam com as do CD. Todas as 668 imagens também vão para `UserBMP/`, na pasta do seu addon, que é onde o diálogo de imagens do original abre. * **Nada é sobrescrito.** Um arquivo que já existe fica como está, e o registro da instalação lista cada imagem gravada. -* **No app.** Tipos de monstro, monstros (pela imagem do seu tipo), raças e personagens mostram a imagem quando o arquivo está na pasta de dados. As imagens são lidas pelo próprio app, sem depender dos leitores de imagem do sistema. 3.800 citações apontam para imagens que nenhum addon trouxe, quase todas as do CD (`6.bmp`, `NA.bmp`), e o app não as mostra porque **Extrair dados do CD…** não copia o `Bitmaps` do CD. +* **No app.** Tipos de monstro, monstros (pela imagem do seu tipo), raças e personagens mostram a imagem quando o arquivo está na pasta de dados. As imagens são lidas pelo próprio app, sem depender dos leitores de imagem do sistema. 3.800 citações apontam para imagens que nenhum addon trouxe, quase todas as do CD (`6.bmp`, `NA.bmp`), que **Extrair dados do CD…** copia do CD desde a versão 1.0.0-rc1. * **Textos.** Os leia-me em texto, HTML, RTF, Word e PDF foram convertidos para texto simples. O botão **Detalhes dos addons…** do instalador mostra, para cada pasta de addons, os pacotes, o que cada um trouxe para a coleção e esses textos. diff --git a/crates/cr-addons/src/install.rs b/crates/cr-addons/src/install.rs index d299e36..67f36fc 100644 --- a/crates/cr-addons/src/install.rs +++ b/crates/cr-addons/src/install.rs @@ -81,8 +81,8 @@ pub struct Outcome { pub log: PathBuf, } -/// Imports `file` into `install`, then the classes again: a race/class -/// combination that names two new classes only comes in once both exist. +/// Imports `file` into `install`; a second install leaves the characters +/// out. pub fn import(install: &Installation, file: &ExportFile, stamp: &str) -> Result { let items = contents(file); let again = matches!(check(install.root()), Folder::Ready { again: true, .. }); @@ -93,15 +93,9 @@ pub fn import(install: &Installation, file: &ExportFile, stamp: &str) -> Result< }); let failed = |e: cr_store::Error| tr!("The import failed: {e}", e); let report = install.import(file, first.as_deref()).map_err(failed)?; - let classes: Vec = (0..items.len()) - .filter(|&n| items[n].category == Category::Class) - .collect(); - let second = install.import(file, Some(&classes)).map_err(failed)?; let mut log = String::new(); write_report(&mut log, &report); - log.push_str("=== second pass (classes)\n"); - write_report(&mut log, &second); let path = beside(install.root(), &format!("addons-{stamp}.log")); fs::write(&path, log) .map_err(|e| tr!("Could not write {file}: {e}", file = path.display(), e))?; @@ -203,6 +197,44 @@ mod tests { assert_eq!(characters.count(), 48); } + /// With `CORERULES_DIR` pointing at an Expansion installation without + /// records of its own, the add-ons go into a copy of its user + /// databases. + #[test] + fn one_import_brings_every_combination() { + let Some(dir) = std::env::var_os("CORERULES_DIR") else { + return; + }; + let original = Installation::open(Path::new(&dir)).unwrap(); + if original.is_core20() { + return; + } + let root = std::env::temp_dir().join(format!("cr-addons-once-{}", std::process::id())); + let _ = fs::remove_dir_all(&root); + copy_dir(&original.path("UserDbas").unwrap(), &root.join("UserDbas")).unwrap(); + std::os::unix::fs::symlink(original.path("Database").unwrap(), root.join("Database")) + .unwrap(); + let install = Installation::open(&root).unwrap(); + let file = package().unwrap(); + let report = install.import(&file, None).unwrap(); + let unresolved: Vec<_> = report + .warnings + .iter() + .filter(|w| w.starts_with("No race/class combinations could be added")) + .collect(); + assert!(unresolved.is_empty(), "{unresolved:?}"); + + // Importing the classes again, as the original needed, adds nothing. + let allowed = fs::read(root.join("UserDbas/AllowedU.dat")).unwrap(); + let items = contents(&file); + let classes: Vec = (0..items.len()) + .filter(|&n| items[n].category == Category::Class) + .collect(); + install.import(&file, Some(&classes)).unwrap(); + assert!(fs::read(root.join("UserDbas/AllowedU.dat")).unwrap() == allowed); + let _ = fs::remove_dir_all(&root); + } + #[test] fn backups_and_logs_sit_beside_the_folder() { let root = Path::new("/home/u/.local/share/corerules/data"); diff --git a/crates/cr-store/src/export.rs b/crates/cr-store/src/export.rs index cf37877..2929242 100644 --- a/crates/cr-store/src/export.rs +++ b/crates/cr-store/src/export.rs @@ -55,7 +55,7 @@ use crate::encounter::{flavor_of, replace_or_create}; use crate::exe::Image; use crate::userdb::Flavor; use crate::userdb::allowed::{self, Allowed, AllowedDb}; -use crate::userdb::classes::{ClassEntry, class_list}; +use crate::userdb::classes::{ClassEntry, class_entries, class_list}; use crate::userdb::parts::{CLASS_ABILITIES, KITS, VERSION_MARKER, VERSION_STRING}; use crate::{Error, Installation, Result}; @@ -594,6 +594,16 @@ impl<'a> Stores<'a> { Ok(self.classes.clone().expect("just set")) } + /// The standard classes and the user's as this import left them, the + /// classes it brought in included before they are saved. + fn classes_after_import(&mut self) -> Result> { + let mut objects = self + .read("Database/Class.dat", ObjectList::parse)? + .map_or(Vec::new(), |l| l.objects); + objects.extend(self.list_ref(Category::Class)?.iter().cloned()); + Ok(class_entries(&objects)) + } + /// Checks every changed file can be written, then writes them. fn save(self) -> Result<()> { let mut files: Vec<(&str, Vec)> = Vec::new(); @@ -890,6 +900,8 @@ impl Installation { // The Expansion turns what Core Rules 2.0 wrote into its own layout. let upgrade = expansion && !file.is_expansion(); let mut image = None; + let mut classes = Vec::new(); + let mut class_warnings = Vec::new(); let all = contents(file); for (n, item) in all.iter().enumerate() { if chosen.is_some_and(|c| !c.contains(&n)) { @@ -928,12 +940,26 @@ impl Installation { import_race(&mut stores, file, &object, &mut report.warnings)?; } if expansion && category == Category::Class { - import_class(&mut stores, file, &item.name, &mut report.warnings)?; + import_class(&mut stores, file, &item.name, &mut class_warnings)?; + classes.push(item.name.clone()); } } } report.imported.push(item.clone()); } + // The combinations of the classes are looked up in the classes + // there were before the import, as the original does, so those + // naming a class of the package only come in on a second round, + // with all of them known; only what still fails is reported. The + // original needed the package imported twice for this. + if !classes.is_empty() { + class_warnings.clear(); + stores.classes = Some(stores.classes_after_import()?); + for class in &classes { + import_class(&mut stores, file, class, &mut class_warnings)?; + } + } + report.warnings.append(&mut class_warnings); if file.map_maker.count > 0 { report.warnings.push(trn!( "{n} Map Maker II map was not imported", diff --git a/crates/cr-store/src/userdb/classes.rs b/crates/cr-store/src/userdb/classes.rs index b816f2d..f443b2b 100644 --- a/crates/cr-store/src/userdb/classes.rs +++ b/crates/cr-store/src/userdb/classes.rs @@ -108,8 +108,12 @@ pub fn class_group(class: &Class) -> Option { /// Every class, standard then user, sorted by name. pub fn class_list(install: &Installation) -> Result> { - let mut list: Vec = install - .list_objects("Class")? + Ok(class_entries(&install.list_objects("Class")?)) +} + +/// [`class_list`] of the class records `objects`, standard then user. +pub fn class_entries(objects: &[Object]) -> Vec { + let mut list: Vec = objects .iter() .filter_map(|o| match o { Object::Class(c) => Some(ClassEntry { @@ -122,7 +126,7 @@ pub fn class_list(install: &Installation) -> Result> { .collect(); list.sort_by_cached_key(|c| crate::collate::sort_key(&c.name)); list.dedup_by(|a, b| a.name == b.name); - Ok(list) + list } /// The class names of each group, sorted.