BlueGit

golden-age paperdoll-renderer

Files

paperdoll-renderer / src / session.rs
Code

SSH

HTTPS

Username and a token as the password.

session.rs

Bundled female: stray clip and hair removed (asset edit); female-hair equipment preset seeded into new projects; editor equipment config sets preview sex; NOTICE/README (Tim t1015u-t1021u)
timfa Grok Bot · pushed by timfa · 6 days ago
a94b061f History
session.rs 36.7 KiB Download Raw
1//! Project navigation, dirty state and equipment records.
2//!
3//! The screen starts small. A project opens on Bodies. Equipment is one
4//! step down from Body. Chosen files are copied into the project so a later
5//! save stays inside the directory.
6
7use std::fs;
8use std::path::{Path, PathBuf};
9
10use crate::equipment::Preset;
11use serde::{Deserialize, Serialize};
12
13use crate::project::{
14 create_project, portable_relative, save_project, OpenedProject, ProjectError, ProjectFile,
15 MANIFEST_NAME,
16};
17
18const MALE_GLB: &[u8] = include_bytes!("../tests/fixtures/bodies/test-body-male.glb");
19const FEMALE_GLB: &[u8] = include_bytes!("../tests/fixtures/bodies/test-body-female.glb");
20
21pub const MALE_ASSET: &str = "assets/body/test-body-male.glb";
22pub const FEMALE_ASSET: &str = "assets/body/test-body-female.glb";
23
24pub const START_WINDOW: [f32; 2] = [480.0, 280.0];
25pub const PROJECT_WINDOW: [f32; 2] = [1100.0, 720.0];
26
27#[derive(Debug, Clone, Copy, PartialEq, Eq)]
28pub enum Sex {
29 Male,
30 Female,
31}
32
33#[derive(Debug, Clone, Copy, PartialEq, Eq)]
34pub enum Screen {
35 Start,
36 Bodies,
37 Body(Sex),
38 EquipmentList,
39 Equipment(usize),
40 Preview2d,
41}
42
43#[derive(Debug, Clone, Copy, PartialEq, Eq)]
44pub enum Intent {
45 Quit,
46 PickNew,
47 PickLoad,
48}
49
50#[derive(Debug, Clone, Copy, PartialEq, Eq)]
51pub enum Choice {
52 Save,
53 Discard,
54 Cancel,
55}
56
57#[derive(Debug, Clone, PartialEq, Eq)]
58pub enum AfterChoice {
59 Stay,
60 SaveThen(Intent),
61 Go(Intent),
62}
63
64#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
65#[serde(deny_unknown_fields)]
66struct EquipmentFile {
67 name: String,
68 model: Option<String>,
69}
70
71#[derive(Debug, Clone, PartialEq)]
72pub struct EquipmentItem {
73 pub slug: String,
74 pub model: Option<String>,
75 pub legacy_path: Option<String>,
76 pub preset: Option<Preset>,
77 pub error: Option<String>,
78}
79
80#[derive(Debug, Clone, PartialEq)]
81pub struct Session {
82 pub screen: Screen,
83 pub active_body: Option<Sex>,
84 pub opened: Option<OpenedProject>,
85 pub saved_document: Option<ProjectFile>,
86 pub equipment: Vec<EquipmentItem>,
87 pub saved_equipment: Vec<EquipmentItem>,
88 pub confirm: Option<Intent>,
89 pub notice: String,
90 pub notice_ok: bool,
91}
92
93impl Session {
94 pub fn new() -> Self {
95 Self {
96 screen: Screen::Start,
97 active_body: None,
98 opened: None,
99 saved_document: None,
100 equipment: Vec::new(),
101 saved_equipment: Vec::new(),
102 confirm: None,
103 notice: "Laad een project of maak een nieuwe projectmap.".to_string(),
104 notice_ok: true,
105 }
106 }
107
108 pub fn shell_size(&self) -> [f32; 2] {
109 match self.screen {
110 Screen::Start => START_WINDOW,
111 _ => PROJECT_WINDOW,
112 }
113 }
114
115 pub fn is_dirty(&self) -> bool {
116 self.opened.as_ref().map(|opened| &opened.document) != self.saved_document.as_ref()
117 || self.equipment != self.saved_equipment
118 }
119
120 pub fn gate(&mut self, intent: Intent) -> bool {
121 if self.is_dirty() {
122 self.confirm = Some(intent);
123 false
124 } else {
125 true
126 }
127 }
128
129 pub fn resolve(&mut self, choice: Choice) -> AfterChoice {
130 let Some(intent) = self.confirm.take() else {
131 return AfterChoice::Stay;
132 };
133 match choice {
134 Choice::Cancel => {
135 self.confirm = None;
136 AfterChoice::Stay
137 }
138 Choice::Discard => AfterChoice::Go(intent),
139 Choice::Save => {
140 self.confirm = Some(intent);
141 AfterChoice::SaveThen(intent)
142 }
143 }
144 }
145
146 pub fn note_saved(&mut self) {
147 if let Some(opened) = &self.opened {
148 self.saved_document = Some(opened.document.clone());
149 }
150 self.saved_equipment = self.equipment.clone();
151 self.confirm = None;
152 }
153
154 pub fn show_bodies(&mut self) {
155 if self.opened.is_some() {
156 self.screen = Screen::Bodies;
157 }
158 }
159
160 pub fn show_body(&mut self, sex: Sex) {
161 if self.opened.is_some() {
162 self.active_body = Some(sex);
163 self.screen = Screen::Body(sex);
164 }
165 }
166
167 pub fn show_equipment_list(&mut self) {
168 if self.opened.is_some() {
169 self.screen = Screen::EquipmentList;
170 }
171 }
172
173 pub fn show_equipment(&mut self, index: usize) {
174 if index < self.equipment.len() {
175 self.screen = Screen::Equipment(index);
176 }
177 }
178
179 pub fn show_preview2d(&mut self) {
180 if self.opened.is_some() {
181 self.screen = Screen::Preview2d;
182 }
183 }
184
185 pub fn back(&mut self) {
186 self.screen = match self.screen {
187 Screen::Body(_) => Screen::Bodies,
188 Screen::EquipmentList => self.active_body.map(Screen::Body).unwrap_or(Screen::Bodies),
189 Screen::Equipment(_) => Screen::EquipmentList,
190 Screen::Preview2d => Screen::Bodies,
191 other => other,
192 };
193 }
194
195 pub fn set_name(&mut self, name: String) {
196 if let Some(opened) = &mut self.opened {
197 opened.document.name = name;
198 }
199 }
200
201 pub fn set_render(&mut self, width: u32, height: u32, fps: u32) {
202 if let Some(opened) = &mut self.opened {
203 opened.document.render.target_width = width;
204 opened.document.render.target_height = height;
205 opened.document.render.fps = fps;
206 }
207 }
208
209 pub fn body_path(&self, sex: Sex) -> Option<&str> {
210 let document = &self.opened.as_ref()?.document;
211 match sex {
212 Sex::Male => document.male_model.as_deref(),
213 Sex::Female => document.female_model.as_deref(),
214 }
215 }
216
217 pub fn set_body_path(&mut self, sex: Sex, relative: String) {
218 let Some(opened) = &mut self.opened else {
219 return;
220 };
221 let slot = match sex {
222 Sex::Male => &mut opened.document.male_model,
223 Sex::Female => &mut opened.document.female_model,
224 };
225 *slot = Some(relative);
226 }
227
228 pub fn add_equipment(&mut self) -> usize {
229 let slug = next_slug(&self.equipment);
230 self.equipment.push(EquipmentItem {
231 preset: Some(Preset::new(slug.clone())),
232 error: None,
233 slug,
234 model: None,
235 legacy_path: None,
236 });
237 let index = self.equipment.len() - 1;
238 self.screen = Screen::Equipment(index);
239 index
240 }
241
242 pub fn ensure_preset_budget(
243 &self,
244 replacement: Option<usize>,
245 candidate: &Preset,
246 ) -> Result<(), String> {
247 if replacement.is_none() && self.equipment.len() >= crate::project::MAX_PROJECT_PRESETS {
248 return Err("maximaal 64 equipmentpresets per project".into());
249 }
250 let mut budget = MAX_PROJECT_PRESET_BYTES
251 .checked_sub(candidate.encoded_len()?)
252 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
253 for (i, item) in self.equipment.iter().enumerate() {
254 if Some(i) != replacement {
255 if let Some(p) = &item.preset {
256 budget = budget
257 .checked_sub(p.encoded_len()?)
258 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
259 }
260 }
261 }
262 Ok(())
263 }
264 pub fn available_equipment_name(&self, base: &str) -> Result<String, String> {
265 if !valid_slug(base) {
266 return Err("ongeldige equipmentnaam".into());
267 }
268 let mut name = base.to_string();
269 let mut n = 2;
270 while self.equipment.iter().any(|i| i.slug == name) {
271 let suffix = format!("-{n}");
272 name = format!("{}{}", &base[..base.len().min(64 - suffix.len())], suffix);
273 n += 1;
274 }
275 Ok(name)
276 }
277
278 pub fn set_equipment_slug(&mut self, index: usize, slug: String) -> Result<(), String> {
279 let slug = slug.trim().to_string();
280 if !valid_slug(&slug) {
281 return Err(
282 "de naam gebruikt kleine letters, cijfers, '-' of '_', en is niet 'body'"
283 .to_string(),
284 );
285 }
286 if self
287 .equipment
288 .iter()
289 .enumerate()
290 .any(|(other, item)| other != index && item.slug == slug)
291 {
292 return Err("die equipmentnaam bestaat al".to_string());
293 }
294 if let Some(item) = self.equipment.get_mut(index) {
295 item.slug = slug;
296 item.legacy_path = None;
297 }
298 Ok(())
299 }
300
301 pub fn set_equipment_model(&mut self, index: usize, relative: String) {
302 if let Some(item) = self.equipment.get_mut(index) {
303 item.model = Some(relative);
304 item.legacy_path = None;
305 item.preset = None;
306 item.error = None;
307 }
308 }
309
310 pub fn delete_equipment(&mut self, index: usize) {
311 if index < self.equipment.len() {
312 self.equipment.remove(index);
313 self.screen = Screen::EquipmentList;
314 }
315 }
316
317 pub fn install_new_project(&mut self, root: &Path) -> Result<(), ProjectError> {
318 let opened = create_seeded_project(root)?;
319 self.install_opened(opened);
320 self.ok("Projectmap aangemaakt, met de testlichamen in assets/body.");
321 Ok(())
322 }
323
324 /// Create `<parent>/<name>/` (validated) and open it as a new project.
325 pub fn install_named_project(&mut self, parent: &Path, name: &str) -> Result<(), String> {
326 let dir = crate::project::new_project_dir(parent, name)?;
327 let opened = create_default_project_named(&dir, name.trim()).map_err(|e| e.to_string())?;
328 // install_loaded also reads the bundled equipment preset(s).
329 self.install_loaded(opened);
330 self.ok("Project aangemaakt, met de standaardlichamen in assets/body/male en female.");
331 Ok(())
332 }
333
334 pub fn install_loaded(&mut self, opened: OpenedProject) {
335 let root = opened
336 .manifest_path
337 .parent()
338 .map(Path::to_path_buf)
339 .unwrap_or_default();
340 let equipment = read_equipment(&root, &opened.document.equipment_presets);
341 self.equipment = equipment.clone();
342 self.saved_equipment = equipment;
343 self.saved_document = Some(opened.document.clone());
344 self.opened = Some(opened);
345 self.screen = Screen::Bodies;
346 self.active_body = None;
347 self.confirm = None;
348 self.ok("Project geopend.");
349 }
350
351 fn install_opened(&mut self, opened: OpenedProject) {
352 self.equipment.clear();
353 self.saved_equipment.clear();
354 self.saved_document = Some(opened.document.clone());
355 self.opened = Some(opened);
356 self.screen = Screen::Bodies;
357 self.active_body = None;
358 self.confirm = None;
359 }
360
361 pub fn save(&mut self) -> Result<(), ProjectError> {
362 let Some(opened) = self.opened.clone() else {
363 return Err(ProjectError::Validation(vec![
364 "er is geen project om op te slaan".to_string(),
365 ]));
366 };
367 let root = opened
368 .manifest_path
369 .parent()
370 .ok_or_else(|| ProjectError::Io {
371 path: opened.manifest_path.display().to_string(),
372 message: "het .ppd-bestand heeft geen projectmap".to_string(),
373 })?;
374 opened.document.validate_shape()?;
375 let presets = write_equipment(root, &self.equipment)
376 .map_err(|message| ProjectError::Validation(vec![message]))?;
377 let mut document = opened.document.clone();
378 document.equipment_presets = presets;
379 document.validate_shape()?;
380 let candidate = OpenedProject {
381 manifest_path: opened.manifest_path.clone(),
382 document,
383 disk_issues: Vec::new(),
384 };
385 save_project(&candidate)?;
386 for item in &mut self.equipment {
387 if let Some(preset) = &mut item.preset {
388 preset.name = item.slug.clone();
389 }
390 }
391 self.opened = Some(candidate);
392 self.note_saved();
393 self.ok("Opgeslagen.");
394 Ok(())
395 }
396
397 pub fn project_root(&self) -> Option<PathBuf> {
398 self.opened
399 .as_ref()?
400 .manifest_path
401 .parent()
402 .map(PathBuf::from)
403 }
404
405 fn ok(&mut self, message: &str) {
406 self.notice = message.to_string();
407 self.notice_ok = true;
408 }
409
410 pub fn fail(&mut self, message: impl Into<String>) {
411 self.notice = message.into();
412 self.notice_ok = false;
413 }
414}
415
416impl Default for Session {
417 fn default() -> Self {
418 Self::new()
419 }
420}
421
422pub fn create_seeded_project(root: &Path) -> Result<OpenedProject, ProjectError> {
423 create_seeded_project_named(root, "Nieuw project")
424}
425
426pub fn create_seeded_project_named(root: &Path, name: &str) -> Result<OpenedProject, ProjectError> {
427 let mut opened = create_project(root, name)?;
428 for (relative, bytes) in [
429 (MALE_ASSET, MALE_GLB),
430 (FEMALE_ASSET, FEMALE_GLB),
431 (
432 "assets/body/test-bodies-LICENSE.txt",
433 include_bytes!("../tests/fixtures/bodies/LICENSE").as_slice(),
434 ),
435 ] {
436 let path = checked_project_path(root, relative)
437 .map_err(|error| ProjectError::Validation(vec![error]))?;
438 if !path.exists() {
439 write_bytes(&path, bytes)?;
440 }
441 }
442 opened.document.male_model = Some(MALE_ASSET.to_string());
443 opened.document.female_model = Some(FEMALE_ASSET.to_string());
444 save_project(&opened)?;
445 Ok(opened)
446}
447
448/// A new project with Tim's bundled starter bodies (Tim t1009u) in
449/// `assets/body/male/` and `female/`, each with its `license.txt`, set as the
450/// male and female body.
451pub fn create_default_project_named(
452 root: &Path,
453 name: &str,
454) -> Result<OpenedProject, ProjectError> {
455 let mut opened = create_project(root, name)?;
456 for (relative, bytes) in crate::default_bodies::FILES {
457 let path = checked_project_path(root, &format!("assets/body/{relative}"))
458 .map_err(|error| ProjectError::Validation(vec![error]))?;
459 if let Some(parent) = path.parent() {
460 fs::create_dir_all(parent).map_err(|e| ProjectError::Io {
461 path: parent.display().to_string(),
462 message: e.to_string(),
463 })?;
464 }
465 if !path.exists() {
466 write_bytes(&path, bytes)?;
467 }
468 }
469 opened.document.male_model = Some(crate::default_bodies::MALE_MODEL.to_string());
470 opened.document.female_model = Some(crate::default_bodies::FEMALE_MODEL.to_string());
471 // Bundled female hair preset (t1019u), listed in the equipment presets.
472 let path = checked_project_path(root, crate::default_bodies::FEMALE_HAIR_PRESET)
473 .map_err(|error| ProjectError::Validation(vec![error]))?;
474 if !path.exists() {
475 write_bytes(&path, crate::default_bodies::FEMALE_HAIR_PPE)?;
476 }
477 opened
478 .document
479 .equipment_presets
480 .push(crate::default_bodies::FEMALE_HAIR_PRESET.to_string());
481 save_project(&opened)?;
482 Ok(opened)
483}
484
485pub fn adopt_file(root: &Path, source: &Path, folder: &str) -> Result<String, String> {
486 if !source.is_file() {
487 return Err("kies een bestand".to_string());
488 }
489 let name = source
490 .file_name()
491 .and_then(|name| name.to_str())
492 .filter(|name| {
493 !name.is_empty() && !name.contains('/') && !name.contains('\\') && !name.contains('\0')
494 })
495 .ok_or_else(|| "de bestandsnaam is niet bruikbaar".to_string())?;
496 if let (Ok(source_full), Ok(root_full)) = (source.canonicalize(), root.canonicalize()) {
497 if let Ok(inside) = source_full.strip_prefix(&root_full) {
498 let relative = inside.to_string_lossy().replace('\\', "/");
499 portable_relative(&relative)?;
500 return Ok(relative);
501 }
502 }
503 let mut relative = format!("{folder}/{name}");
504 let stem = Path::new(name).file_stem().unwrap().to_string_lossy();
505 let ext = Path::new(name)
506 .extension()
507 .map(|x| format!(".{}", x.to_string_lossy()))
508 .unwrap_or_default();
509 let mut n = 2;
510 while root.join(&relative).exists() {
511 relative = format!("{folder}/{stem}-{n}{ext}");
512 n += 1;
513 }
514 portable_relative(&relative)?;
515 let dest = checked_project_path(root, &relative)?;
516 if let Some(parent) = dest.parent() {
517 fs::create_dir_all(parent).map_err(|err| err.to_string())?;
518 }
519 fs::copy(source, &dest).map_err(|err| err.to_string())?;
520 Ok(relative)
521}
522
523fn checked_project_path(root: &Path, relative: &str) -> Result<PathBuf, String> {
524 portable_relative(relative)?;
525 let root_full = root.canonicalize().map_err(|e| e.to_string())?;
526 let path = root.join(relative);
527 let mut ancestor = path.as_path();
528 while std::fs::symlink_metadata(ancestor).is_err() {
529 ancestor = ancestor.parent().ok_or("ongeldig projectpad")?;
530 }
531 let canonical = ancestor.canonicalize().map_err(|e| e.to_string())?;
532 if !canonical.starts_with(&root_full) {
533 return Err("het bestand ligt buiten de projectmap".into());
534 }
535 Ok(path)
536}
537
538fn write_bytes(path: &Path, bytes: &[u8]) -> Result<(), ProjectError> {
539 if let Some(parent) = path.parent() {
540 fs::create_dir_all(parent).map_err(|err| io_at(path, &err.to_string()))?;
541 }
542 fs::write(path, bytes).map_err(|err| io_at(path, &err.to_string()))
543}
544
545fn io_at(path: &Path, message: &str) -> ProjectError {
546 ProjectError::Io {
547 path: path.display().to_string(),
548 message: message.to_string(),
549 }
550}
551
552pub const MAX_PROJECT_PRESET_BYTES: usize = 64 * 1024 * 1024;
553const MAX_LEGACY_PRESET_BYTES: usize = 64 * 1024;
554
555fn read_limited(path: &Path, limit: usize) -> Result<Vec<u8>, String> {
556 use std::io::Read;
557 if !path.is_file() {
558 return Err("kies een regulier bestand".into());
559 }
560 let mut bytes = Vec::new();
561 fs::File::open(path)
562 .and_then(|file| file.take((limit + 1) as u64).read_to_end(&mut bytes))
563 .map_err(|e| e.to_string())?;
564 if bytes.len() > limit {
565 return Err("presetbestand overschrijdt het bestands-/projectbudget".into());
566 }
567 Ok(bytes)
568}
569fn read_equipment(root: &Path, presets: &[String]) -> Vec<EquipmentItem> {
570 read_equipment_with_budget(root, presets, MAX_PROJECT_PRESET_BYTES)
571}
572fn read_equipment_with_budget(
573 root: &Path,
574 presets: &[String],
575 mut budget: usize,
576) -> Vec<EquipmentItem> {
577 presets
578 .iter()
579 .map(|path| {
580 let failure = |error: String| EquipmentItem {
581 preset: None,
582 error: Some(error),
583 slug: Path::new(path)
584 .file_stem()
585 .unwrap_or_default()
586 .to_string_lossy()
587 .into(),
588 model: None,
589 legacy_path: Some(path.clone()),
590 };
591 let file = match checked_project_path(root, path) {
592 Ok(path) => path,
593 Err(error) => return failure(error),
594 };
595 let binary = file.extension().and_then(|e| e.to_str()) == Some("ppe");
596 let limit = budget.min(if binary {
597 crate::equipment::MAX_FILE
598 } else {
599 MAX_LEGACY_PRESET_BYTES
600 });
601 let bytes = match read_limited(&file, limit) {
602 Ok(bytes) => bytes,
603 Err(error) => return failure(error),
604 };
605 budget -= bytes.len();
606 if binary {
607 return match Preset::decode(&bytes) {
608 Ok(preset) => EquipmentItem {
609 slug: preset.name.clone(),
610 model: preset.attachments.first().map(|a| a.label.clone()),
611 preset: Some(preset),
612 error: None,
613 legacy_path: None,
614 },
615 Err(error) => failure(error),
616 };
617 }
618 if let Ok(parsed) = serde_json::from_slice::<EquipmentFile>(&bytes) {
619 if valid_slug(&parsed.name) {
620 return EquipmentItem {
621 preset: None,
622 error: None,
623 slug: parsed.name,
624 model: parsed.model,
625 legacy_path: None,
626 };
627 }
628 }
629 failure("legacy preset; kies een OBJ- of FBX-model om te configureren".into())
630 })
631 .collect()
632}
633
634fn write_equipment(root: &Path, items: &[EquipmentItem]) -> Result<Vec<String>, String> {
635 if items.len() > crate::project::MAX_PROJECT_PRESETS {
636 return Err("maximaal 64 equipmentpresets per project".into());
637 }
638 let mut budget = MAX_PROJECT_PRESET_BYTES;
639 let mut paths = Vec::new();
640 let mut names = std::collections::BTreeSet::new();
641 // Validate every record before writing. Config files are immutable snapshots:
642 // a failed manifest save leaves its previous equipment bytes intact.
643 for item in items {
644 if !names.insert(&item.slug) {
645 return Err("dubbele equipmentnaam".into());
646 }
647 if let Some(legacy) = item.legacy_path.as_ref().filter(|_| item.model.is_none()) {
648 let path = checked_project_path(root, legacy)?;
649 let length = fs::metadata(path).map(|meta| meta.len()).unwrap_or(0);
650 budget = budget
651 .checked_sub(usize::try_from(length).map_err(|_| "preset te groot")?)
652 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
653 continue;
654 }
655 if !valid_slug(&item.slug) {
656 return Err(format!("equipment '{}' heeft geen geldige naam", item.slug));
657 }
658 if let Some(preset) = &item.preset {
659 let mut preset = preset.clone();
660 preset.name = item.slug.clone();
661 let length = preset.encode()?.len();
662 budget = budget
663 .checked_sub(length)
664 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
665 } else {
666 if let Some(model) = &item.model {
667 portable_relative(model)?;
668 }
669 let text = serde_json::to_vec_pretty(&EquipmentFile {
670 name: item.slug.clone(),
671 model: item.model.clone(),
672 })
673 .map_err(|e| e.to_string())?;
674 if text.len() > MAX_LEGACY_PRESET_BYTES {
675 return Err("legacy preset groter dan 64 KiB".into());
676 }
677 budget = budget
678 .checked_sub(text.len())
679 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
680 }
681 }
682 for item in items {
683 if let Some(preset) = &item.preset {
684 let mut preset = preset.clone();
685 preset.name = item.slug.clone();
686 let bytes = preset.encode()?;
687 let relative = format!(
688 "presets/{}-{:08x}-{}.ppe",
689 item.slug,
690 crate::equipment::checksum(&bytes),
691 bytes.len()
692 );
693 let path = checked_project_path(root, &relative)?;
694 fs::create_dir_all(path.parent().unwrap()).map_err(|e| e.to_string())?;
695 crate::equipment::write_snapshot(&path, &bytes)?;
696 paths.push(relative);
697 continue;
698 }
699 if item.model.is_none() {
700 if let Some(legacy) = &item.legacy_path {
701 paths.push(legacy.clone());
702 continue;
703 }
704 }
705 let file = EquipmentFile {
706 name: item.slug.clone(),
707 model: item.model.clone(),
708 };
709 let text = serde_json::to_string_pretty(&file).map_err(|err| err.to_string())?;
710 let mut number = 1;
711 loop {
712 let relative = format!("presets/{}-{number}.json", item.slug);
713 let path = checked_project_path(root, &relative)?;
714 if let Ok(existing) = read_limited(&path, MAX_LEGACY_PRESET_BYTES) {
715 if existing == text.as_bytes() {
716 paths.push(relative);
717 break;
718 }
719 } else if !path.exists() {
720 fs::create_dir_all(path.parent().unwrap()).map_err(|err| err.to_string())?;
721 use std::io::Write;
722 let mut out = fs::OpenOptions::new()
723 .write(true)
724 .create_new(true)
725 .open(&path)
726 .map_err(|err| err.to_string())?;
727 out.write_all(text.as_bytes())
728 .map_err(|err| err.to_string())?;
729 out.sync_all().map_err(|err| err.to_string())?;
730 paths.push(relative);
731 break;
732 }
733 number += 1;
734 }
735 }
736 Ok(paths)
737}
738
739fn next_slug(items: &[EquipmentItem]) -> String {
740 let mut number = 1u32;
741 loop {
742 let slug = if number == 1 {
743 "nieuw".to_string()
744 } else {
745 format!("nieuw-{number}")
746 };
747 if !items.iter().any(|item| item.slug == slug) {
748 return slug;
749 }
750 number += 1;
751 }
752}
753
754fn valid_slug(slug: &str) -> bool {
755 crate::equipment::valid_name(slug)
756}
757
758pub fn manifest_in(root: &Path) -> PathBuf {
759 root.join(MANIFEST_NAME)
760}
761
762#[cfg(test)]
763mod tests {
764 use super::*;
765 use std::time::{SystemTime, UNIX_EPOCH};
766
767 fn scratch() -> PathBuf {
768 let nanos = SystemTime::now()
769 .duration_since(UNIX_EPOCH)
770 .unwrap()
771 .as_nanos();
772 let path = std::env::temp_dir().join(format!("paperdoll-session-{nanos}"));
773 let _ = fs::remove_dir_all(&path);
774 path
775 }
776
777 #[test]
778 fn editing_budget_and_import_names_are_bounded_before_install() {
779 let mut session = Session::new();
780 let mut p = Preset::new("sword".into());
781 for i in 0..3 {
782 p.assets.push(crate::equipment::EmbeddedAsset {
783 path: format!("raw-{i}"),
784 bytes: vec![0; 8 * 1024 * 1024],
785 });
786 }
787 for _ in 0..2 {
788 let i = session.add_equipment();
789 session.equipment[i].preset = Some(p.clone());
790 }
791 assert!(session
792 .ensure_preset_budget(None, &p)
793 .unwrap_err()
794 .contains("64 MiB"));
795 assert!(session.ensure_preset_budget(Some(0), &p).is_ok());
796 assert_eq!(session.equipment.len(), 2);
797 let base = "a".repeat(64);
798 session.equipment[0].slug = base.clone();
799 let unique = session.available_equipment_name(&base).unwrap();
800 assert_eq!(unique.len(), 64);
801 assert_ne!(unique, base);
802 assert!(crate::equipment::valid_name(&unique));
803 }
804
805 #[test]
806 fn preset_read_budget_preserves_unloaded_references() {
807 let root = scratch();
808 fs::create_dir_all(root.join("presets")).unwrap();
809 let bytes = Preset::new("sword".into()).encode().unwrap();
810 for name in ["one", "two"] {
811 fs::write(root.join(format!("presets/{name}.ppe")), &bytes).unwrap();
812 }
813 let refs = vec!["presets/one.ppe".into(), "presets/two.ppe".into()];
814 let items = read_equipment_with_budget(&root, &refs, bytes.len());
815 assert!(items[0].preset.is_some());
816 assert!(items[1].preset.is_none());
817 assert!(items[1].error.as_ref().unwrap().contains("budget"));
818 assert_eq!(items[1].legacy_path.as_ref(), Some(&refs[1]));
819 fs::write(
820 root.join("presets/old.json"),
821 vec![b' '; MAX_LEGACY_PRESET_BYTES + 1],
822 )
823 .unwrap();
824 assert!(read_equipment(&root, &["presets/old.json".into()])[0]
825 .error
826 .is_some());
827 fs::remove_dir_all(root).unwrap();
828 }
829 #[test]
830 fn too_many_presets_do_not_write_snapshots_or_replace_manifest() {
831 let root = scratch();
832 let mut session = Session::new();
833 session.install_new_project(&root).unwrap();
834 let before = fs::read(root.join(MANIFEST_NAME)).unwrap();
835 for _ in 0..=crate::project::MAX_PROJECT_PRESETS {
836 session.add_equipment();
837 }
838 assert!(session.save().unwrap_err().to_string().contains("64"));
839 assert_eq!(fs::read(root.join(MANIFEST_NAME)).unwrap(), before);
840 assert_eq!(fs::read_dir(root.join("presets")).unwrap().count(), 0);
841 assert!(session.is_dirty());
842 fs::remove_dir_all(root).unwrap();
843 }
844
845 #[test]
846 fn named_new_project_contains_and_loads_the_default_bodies() {
847 let parent = scratch();
848 fs::create_dir_all(&parent).unwrap();
849 let mut session = Session::new();
850 session.install_named_project(&parent, "Starter").unwrap();
851 let root = parent.join("Starter");
852 for (relative, bytes) in crate::default_bodies::FILES {
853 let copied = fs::read(root.join("assets/body").join(relative)).unwrap();
854 assert!(copied == *bytes, "{relative} not byte-exact");
855 }
856 assert!(root.join("assets/body/male/license.txt").is_file());
857 assert!(root.join("assets/body/female/license.txt").is_file());
858 let document = &session.opened.as_ref().unwrap().document;
859 assert_eq!(
860 document.male_model.as_deref(),
861 Some(crate::default_bodies::MALE_MODEL)
862 );
863 assert_eq!(
864 document.female_model.as_deref(),
865 Some(crate::default_bodies::FEMALE_MODEL)
866 );
867 for model in [
868 crate::default_bodies::MALE_MODEL,
869 crate::default_bodies::FEMALE_MODEL,
870 ] {
871 let body = crate::preview::load_body_file(&root.join(model)).unwrap();
872 assert!(
873 !body.joint_names.is_empty() && !body.clips.is_empty(),
874 "{model}"
875 );
876 assert!(
877 body.surfaces.iter().any(|s| s.albedo.is_some()),
878 "{model} textures"
879 );
880 }
881 // The bundled female hair preset is listed, female-only, and at rest
882 // sits on the head of the default female (t1019u).
883 assert_eq!(
884 fs::read(root.join(crate::default_bodies::FEMALE_HAIR_PRESET)).unwrap(),
885 crate::default_bodies::FEMALE_HAIR_PPE
886 );
887 let hair = session
888 .equipment
889 .iter()
890 .find_map(|item| item.preset.as_ref().filter(|p| p.name == "female-hair"))
891 .expect("female-hair preset in the equipment list");
892 assert_eq!(hair.applies, [false, true]);
893 let female =
894 crate::preview::load_body_file(&root.join(crate::default_bodies::FEMALE_MODEL))
895 .unwrap();
896 let controls = crate::preview::PreviewControls {
897 clip_name: String::new(),
898 ..Default::default()
899 };
900 let layers = crate::equipment::layers(hair, 1, &female, &controls).unwrap();
901 assert_eq!(layers.len(), 1);
902 let (mut lo, mut hi) = (f32::MAX, f32::MIN);
903 for p in &layers[0].mesh.positions {
904 let m = &layers[0].model;
905 let y = m[1] * p[0] + m[5] * p[1] + m[9] * p[2] + m[13];
906 lo = lo.min(y);
907 hi = hi.max(y);
908 }
909 // Tim's original female with hair has rest top Y 1.621 m (the hair);
910 // the baked rigid hair must reach exactly that, the ponytail ~1.27 m.
911 assert!(
912 (hi - 1.621).abs() < 0.002 && (1.2..1.35).contains(&lo),
913 "hair Y {lo}..{hi}"
914 );
915 // The saved manifest reopens with the same bodies.
916 let reopened = crate::project::open_project(&root.join("character.ppd")).unwrap();
917 assert_eq!(
918 reopened.document.male_model.as_deref(),
919 Some(crate::default_bodies::MALE_MODEL)
920 );
921 }
922
923 #[test]
924 fn new_project_copies_both_test_bodies_and_can_be_overwritten() {
925 let root = scratch();
926 let mut session = Session::new();
927 session.install_new_project(&root).unwrap();
928 assert_eq!(session.screen, Screen::Bodies);
929 assert!(!session.is_dirty());
930 assert_eq!(fs::read(root.join(MALE_ASSET)).unwrap(), MALE_GLB);
931 assert_eq!(fs::read(root.join(FEMALE_ASSET)).unwrap(), FEMALE_GLB);
932 let outside = root
933 .parent()
934 .unwrap()
935 .join(format!("pd-src-{}", std::process::id()));
936 let _ = fs::remove_dir_all(&outside);
937 fs::create_dir_all(&outside).unwrap();
938 let source = outside.join("test-body-male.glb");
939 fs::write(&source, b"replacement-body").unwrap();
940 let relative = adopt_file(&root, &source, "assets/body").unwrap();
941 assert_ne!(relative, MALE_ASSET);
942 assert_eq!(fs::read(root.join(&relative)).unwrap(), b"replacement-body");
943 assert_eq!(fs::read(root.join(MALE_ASSET)).unwrap(), MALE_GLB);
944 let extra = outside.join("extra.glb");
945 fs::write(&extra, b"extra-body").unwrap();
946 let relative = adopt_file(&root, &extra, "assets/body").unwrap();
947 session.set_body_path(Sex::Male, relative);
948 assert!(session.is_dirty());
949 session.save().unwrap();
950 assert!(!session.is_dirty());
951 assert_eq!(
952 fs::read(root.join("assets/body/extra.glb")).unwrap(),
953 b"extra-body"
954 );
955 let _ = fs::remove_dir_all(&outside);
956 let _ = fs::remove_dir_all(&root);
957 }
958
959 #[test]
960 fn navigation_and_equipment_crud_roundtrip() {
961 let root = scratch();
962 let mut session = Session::new();
963 session.show_body(Sex::Male);
964 assert_eq!(session.screen, Screen::Start);
965 session.install_new_project(&root).unwrap();
966 session.show_body(Sex::Female);
967 assert_eq!(session.screen, Screen::Body(Sex::Female));
968 session.show_equipment_list();
969 assert_eq!(session.screen, Screen::EquipmentList);
970 let index = session.add_equipment();
971 assert_eq!(index, 0);
972 session.set_equipment_model(0, "assets/equipment/zwaard.glb".to_string());
973 session.save().unwrap();
974 let text = fs::read_to_string(root.join("presets/nieuw-1.json")).unwrap();
975 assert!(text.contains("zwaard.glb"));
976 let mut again = Session::new();
977 let opened = crate::project::open_project(&manifest_in(&root)).unwrap();
978 again.install_loaded(opened);
979 assert_eq!(
980 again.equipment[0].model.as_deref(),
981 Some("assets/equipment/zwaard.glb")
982 );
983 again.delete_equipment(0);
984 again.save().unwrap();
985 assert!(again
986 .opened
987 .as_ref()
988 .unwrap()
989 .document
990 .equipment_presets
991 .is_empty());
992 // Old immutable record stays recoverable if an earlier save is restored.
993 assert!(root.join("presets/nieuw-1.json").exists());
994 let _ = fs::remove_dir_all(&root);
995 }
996
997 #[test]
998 fn failed_save_preserves_previous_equipment_and_manifest_bytes() {
999 let root = scratch();
1000 let mut session = Session::new();
1001 session.install_new_project(&root).unwrap();
1002 session.add_equipment();
1003 session.save().unwrap();
1004 let manifest = fs::read(manifest_in(&root)).unwrap();
1005 let relative = session.opened.as_ref().unwrap().document.equipment_presets[0].clone();
1006 let preset = fs::read(root.join(&relative)).unwrap();
1007 session.equipment[0].slug = "changed".into();
1008 // Missing body fails after immutable equipment snapshots are written.
1009 session.set_body_path(Sex::Male, "assets/body/missing.glb".into());
1010 assert!(session.save().is_err());
1011 assert_eq!(fs::read(manifest_in(&root)).unwrap(), manifest);
1012 assert_eq!(fs::read(root.join(&relative)).unwrap(), preset);
1013 assert!(session.is_dirty());
1014 let _ = fs::remove_dir_all(root);
1015 }
1016
1017 #[test]
1018 fn dirty_confirm_save_discard_and_cancel_keep_bytes() {
1019 let root = scratch();
1020 let mut session = Session::new();
1021 session.install_new_project(&root).unwrap();
1022 session.set_name("Gewijzigd".to_string());
1023 assert!(session.is_dirty());
1024 assert!(!session.gate(Intent::Quit));
1025 assert_eq!(session.resolve(Choice::Cancel), AfterChoice::Stay);
1026 assert_eq!(session.opened.as_ref().unwrap().document.name, "Gewijzigd");
1027 assert!(!session.gate(Intent::PickLoad));
1028 assert_eq!(
1029 session.resolve(Choice::Discard),
1030 AfterChoice::Go(Intent::PickLoad)
1031 );
1032 assert_eq!(session.opened.as_ref().unwrap().document.name, "Gewijzigd");
1033 assert!(session.is_dirty()); // canceled file picker must not discard the old project
1034 session.set_name("Bewaard".to_string());
1035 assert!(!session.gate(Intent::PickNew));
1036 assert_eq!(
1037 session.resolve(Choice::Save),
1038 AfterChoice::SaveThen(Intent::PickNew)
1039 );
1040 session.save().unwrap();
1041 assert_eq!(session.opened.as_ref().unwrap().document.name, "Bewaard");
1042 let opened = crate::project::open_project(&manifest_in(&root)).unwrap();
1043 assert_eq!(opened.document.name, "Bewaard");
1044 let _ = fs::remove_dir_all(&root);
1045 }
1046}