BlueGit

golden-age paperdoll-renderer

Files

paperdoll-renderer / src / session.rs
Code

SSH

HTTPS

Username and a token as the password.

session.rs

Bundle Tim's Sketchfab starter bodies; Nieuw project copies and selects them; THIRD_PARTY_NOTICES in repo and packages; attribution (Tim t1009u)
timfa Grok Bot · pushed by timfa · 6 days ago
24839d53 History
session.rs 34.6 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 self.install_opened(opened);
329 self.ok("Project aangemaakt, met de standaardlichamen in assets/body/male en female.");
330 Ok(())
331 }
332
333 pub fn install_loaded(&mut self, opened: OpenedProject) {
334 let root = opened
335 .manifest_path
336 .parent()
337 .map(Path::to_path_buf)
338 .unwrap_or_default();
339 let equipment = read_equipment(&root, &opened.document.equipment_presets);
340 self.equipment = equipment.clone();
341 self.saved_equipment = equipment;
342 self.saved_document = Some(opened.document.clone());
343 self.opened = Some(opened);
344 self.screen = Screen::Bodies;
345 self.active_body = None;
346 self.confirm = None;
347 self.ok("Project geopend.");
348 }
349
350 fn install_opened(&mut self, opened: OpenedProject) {
351 self.equipment.clear();
352 self.saved_equipment.clear();
353 self.saved_document = Some(opened.document.clone());
354 self.opened = Some(opened);
355 self.screen = Screen::Bodies;
356 self.active_body = None;
357 self.confirm = None;
358 }
359
360 pub fn save(&mut self) -> Result<(), ProjectError> {
361 let Some(opened) = self.opened.clone() else {
362 return Err(ProjectError::Validation(vec![
363 "er is geen project om op te slaan".to_string(),
364 ]));
365 };
366 let root = opened
367 .manifest_path
368 .parent()
369 .ok_or_else(|| ProjectError::Io {
370 path: opened.manifest_path.display().to_string(),
371 message: "het .ppd-bestand heeft geen projectmap".to_string(),
372 })?;
373 opened.document.validate_shape()?;
374 let presets = write_equipment(root, &self.equipment)
375 .map_err(|message| ProjectError::Validation(vec![message]))?;
376 let mut document = opened.document.clone();
377 document.equipment_presets = presets;
378 document.validate_shape()?;
379 let candidate = OpenedProject {
380 manifest_path: opened.manifest_path.clone(),
381 document,
382 disk_issues: Vec::new(),
383 };
384 save_project(&candidate)?;
385 for item in &mut self.equipment {
386 if let Some(preset) = &mut item.preset {
387 preset.name = item.slug.clone();
388 }
389 }
390 self.opened = Some(candidate);
391 self.note_saved();
392 self.ok("Opgeslagen.");
393 Ok(())
394 }
395
396 pub fn project_root(&self) -> Option<PathBuf> {
397 self.opened
398 .as_ref()?
399 .manifest_path
400 .parent()
401 .map(PathBuf::from)
402 }
403
404 fn ok(&mut self, message: &str) {
405 self.notice = message.to_string();
406 self.notice_ok = true;
407 }
408
409 pub fn fail(&mut self, message: impl Into<String>) {
410 self.notice = message.into();
411 self.notice_ok = false;
412 }
413}
414
415impl Default for Session {
416 fn default() -> Self {
417 Self::new()
418 }
419}
420
421pub fn create_seeded_project(root: &Path) -> Result<OpenedProject, ProjectError> {
422 create_seeded_project_named(root, "Nieuw project")
423}
424
425pub fn create_seeded_project_named(root: &Path, name: &str) -> Result<OpenedProject, ProjectError> {
426 let mut opened = create_project(root, name)?;
427 for (relative, bytes) in [
428 (MALE_ASSET, MALE_GLB),
429 (FEMALE_ASSET, FEMALE_GLB),
430 (
431 "assets/body/test-bodies-LICENSE.txt",
432 include_bytes!("../tests/fixtures/bodies/LICENSE").as_slice(),
433 ),
434 ] {
435 let path = checked_project_path(root, relative)
436 .map_err(|error| ProjectError::Validation(vec![error]))?;
437 if !path.exists() {
438 write_bytes(&path, bytes)?;
439 }
440 }
441 opened.document.male_model = Some(MALE_ASSET.to_string());
442 opened.document.female_model = Some(FEMALE_ASSET.to_string());
443 save_project(&opened)?;
444 Ok(opened)
445}
446
447/// A new project with Tim's bundled starter bodies (Tim t1009u) in
448/// `assets/body/male/` and `female/`, each with its `license.txt`, set as the
449/// male and female body.
450pub fn create_default_project_named(
451 root: &Path,
452 name: &str,
453) -> Result<OpenedProject, ProjectError> {
454 let mut opened = create_project(root, name)?;
455 for (relative, bytes) in crate::default_bodies::FILES {
456 let path = checked_project_path(root, &format!("assets/body/{relative}"))
457 .map_err(|error| ProjectError::Validation(vec![error]))?;
458 if let Some(parent) = path.parent() {
459 fs::create_dir_all(parent).map_err(|e| ProjectError::Io {
460 path: parent.display().to_string(),
461 message: e.to_string(),
462 })?;
463 }
464 if !path.exists() {
465 write_bytes(&path, bytes)?;
466 }
467 }
468 opened.document.male_model = Some(crate::default_bodies::MALE_MODEL.to_string());
469 opened.document.female_model = Some(crate::default_bodies::FEMALE_MODEL.to_string());
470 save_project(&opened)?;
471 Ok(opened)
472}
473
474pub fn adopt_file(root: &Path, source: &Path, folder: &str) -> Result<String, String> {
475 if !source.is_file() {
476 return Err("kies een bestand".to_string());
477 }
478 let name = source
479 .file_name()
480 .and_then(|name| name.to_str())
481 .filter(|name| {
482 !name.is_empty() && !name.contains('/') && !name.contains('\\') && !name.contains('\0')
483 })
484 .ok_or_else(|| "de bestandsnaam is niet bruikbaar".to_string())?;
485 if let (Ok(source_full), Ok(root_full)) = (source.canonicalize(), root.canonicalize()) {
486 if let Ok(inside) = source_full.strip_prefix(&root_full) {
487 let relative = inside.to_string_lossy().replace('\\', "/");
488 portable_relative(&relative)?;
489 return Ok(relative);
490 }
491 }
492 let mut relative = format!("{folder}/{name}");
493 let stem = Path::new(name).file_stem().unwrap().to_string_lossy();
494 let ext = Path::new(name)
495 .extension()
496 .map(|x| format!(".{}", x.to_string_lossy()))
497 .unwrap_or_default();
498 let mut n = 2;
499 while root.join(&relative).exists() {
500 relative = format!("{folder}/{stem}-{n}{ext}");
501 n += 1;
502 }
503 portable_relative(&relative)?;
504 let dest = checked_project_path(root, &relative)?;
505 if let Some(parent) = dest.parent() {
506 fs::create_dir_all(parent).map_err(|err| err.to_string())?;
507 }
508 fs::copy(source, &dest).map_err(|err| err.to_string())?;
509 Ok(relative)
510}
511
512fn checked_project_path(root: &Path, relative: &str) -> Result<PathBuf, String> {
513 portable_relative(relative)?;
514 let root_full = root.canonicalize().map_err(|e| e.to_string())?;
515 let path = root.join(relative);
516 let mut ancestor = path.as_path();
517 while std::fs::symlink_metadata(ancestor).is_err() {
518 ancestor = ancestor.parent().ok_or("ongeldig projectpad")?;
519 }
520 let canonical = ancestor.canonicalize().map_err(|e| e.to_string())?;
521 if !canonical.starts_with(&root_full) {
522 return Err("het bestand ligt buiten de projectmap".into());
523 }
524 Ok(path)
525}
526
527fn write_bytes(path: &Path, bytes: &[u8]) -> Result<(), ProjectError> {
528 if let Some(parent) = path.parent() {
529 fs::create_dir_all(parent).map_err(|err| io_at(path, &err.to_string()))?;
530 }
531 fs::write(path, bytes).map_err(|err| io_at(path, &err.to_string()))
532}
533
534fn io_at(path: &Path, message: &str) -> ProjectError {
535 ProjectError::Io {
536 path: path.display().to_string(),
537 message: message.to_string(),
538 }
539}
540
541pub const MAX_PROJECT_PRESET_BYTES: usize = 64 * 1024 * 1024;
542const MAX_LEGACY_PRESET_BYTES: usize = 64 * 1024;
543
544fn read_limited(path: &Path, limit: usize) -> Result<Vec<u8>, String> {
545 use std::io::Read;
546 if !path.is_file() {
547 return Err("kies een regulier bestand".into());
548 }
549 let mut bytes = Vec::new();
550 fs::File::open(path)
551 .and_then(|file| file.take((limit + 1) as u64).read_to_end(&mut bytes))
552 .map_err(|e| e.to_string())?;
553 if bytes.len() > limit {
554 return Err("presetbestand overschrijdt het bestands-/projectbudget".into());
555 }
556 Ok(bytes)
557}
558fn read_equipment(root: &Path, presets: &[String]) -> Vec<EquipmentItem> {
559 read_equipment_with_budget(root, presets, MAX_PROJECT_PRESET_BYTES)
560}
561fn read_equipment_with_budget(
562 root: &Path,
563 presets: &[String],
564 mut budget: usize,
565) -> Vec<EquipmentItem> {
566 presets
567 .iter()
568 .map(|path| {
569 let failure = |error: String| EquipmentItem {
570 preset: None,
571 error: Some(error),
572 slug: Path::new(path)
573 .file_stem()
574 .unwrap_or_default()
575 .to_string_lossy()
576 .into(),
577 model: None,
578 legacy_path: Some(path.clone()),
579 };
580 let file = match checked_project_path(root, path) {
581 Ok(path) => path,
582 Err(error) => return failure(error),
583 };
584 let binary = file.extension().and_then(|e| e.to_str()) == Some("ppe");
585 let limit = budget.min(if binary {
586 crate::equipment::MAX_FILE
587 } else {
588 MAX_LEGACY_PRESET_BYTES
589 });
590 let bytes = match read_limited(&file, limit) {
591 Ok(bytes) => bytes,
592 Err(error) => return failure(error),
593 };
594 budget -= bytes.len();
595 if binary {
596 return match Preset::decode(&bytes) {
597 Ok(preset) => EquipmentItem {
598 slug: preset.name.clone(),
599 model: preset.attachments.first().map(|a| a.label.clone()),
600 preset: Some(preset),
601 error: None,
602 legacy_path: None,
603 },
604 Err(error) => failure(error),
605 };
606 }
607 if let Ok(parsed) = serde_json::from_slice::<EquipmentFile>(&bytes) {
608 if valid_slug(&parsed.name) {
609 return EquipmentItem {
610 preset: None,
611 error: None,
612 slug: parsed.name,
613 model: parsed.model,
614 legacy_path: None,
615 };
616 }
617 }
618 failure("legacy preset; kies een OBJ- of FBX-model om te configureren".into())
619 })
620 .collect()
621}
622
623fn write_equipment(root: &Path, items: &[EquipmentItem]) -> Result<Vec<String>, String> {
624 if items.len() > crate::project::MAX_PROJECT_PRESETS {
625 return Err("maximaal 64 equipmentpresets per project".into());
626 }
627 let mut budget = MAX_PROJECT_PRESET_BYTES;
628 let mut paths = Vec::new();
629 let mut names = std::collections::BTreeSet::new();
630 // Validate every record before writing. Config files are immutable snapshots:
631 // a failed manifest save leaves its previous equipment bytes intact.
632 for item in items {
633 if !names.insert(&item.slug) {
634 return Err("dubbele equipmentnaam".into());
635 }
636 if let Some(legacy) = item.legacy_path.as_ref().filter(|_| item.model.is_none()) {
637 let path = checked_project_path(root, legacy)?;
638 let length = fs::metadata(path).map(|meta| meta.len()).unwrap_or(0);
639 budget = budget
640 .checked_sub(usize::try_from(length).map_err(|_| "preset te groot")?)
641 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
642 continue;
643 }
644 if !valid_slug(&item.slug) {
645 return Err(format!("equipment '{}' heeft geen geldige naam", item.slug));
646 }
647 if let Some(preset) = &item.preset {
648 let mut preset = preset.clone();
649 preset.name = item.slug.clone();
650 let length = preset.encode()?.len();
651 budget = budget
652 .checked_sub(length)
653 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
654 } else {
655 if let Some(model) = &item.model {
656 portable_relative(model)?;
657 }
658 let text = serde_json::to_vec_pretty(&EquipmentFile {
659 name: item.slug.clone(),
660 model: item.model.clone(),
661 })
662 .map_err(|e| e.to_string())?;
663 if text.len() > MAX_LEGACY_PRESET_BYTES {
664 return Err("legacy preset groter dan 64 KiB".into());
665 }
666 budget = budget
667 .checked_sub(text.len())
668 .ok_or("equipmentpresets samen groter dan 64 MiB")?;
669 }
670 }
671 for item in items {
672 if let Some(preset) = &item.preset {
673 let mut preset = preset.clone();
674 preset.name = item.slug.clone();
675 let bytes = preset.encode()?;
676 let relative = format!(
677 "presets/{}-{:08x}-{}.ppe",
678 item.slug,
679 crate::equipment::checksum(&bytes),
680 bytes.len()
681 );
682 let path = checked_project_path(root, &relative)?;
683 fs::create_dir_all(path.parent().unwrap()).map_err(|e| e.to_string())?;
684 crate::equipment::write_snapshot(&path, &bytes)?;
685 paths.push(relative);
686 continue;
687 }
688 if item.model.is_none() {
689 if let Some(legacy) = &item.legacy_path {
690 paths.push(legacy.clone());
691 continue;
692 }
693 }
694 let file = EquipmentFile {
695 name: item.slug.clone(),
696 model: item.model.clone(),
697 };
698 let text = serde_json::to_string_pretty(&file).map_err(|err| err.to_string())?;
699 let mut number = 1;
700 loop {
701 let relative = format!("presets/{}-{number}.json", item.slug);
702 let path = checked_project_path(root, &relative)?;
703 if let Ok(existing) = read_limited(&path, MAX_LEGACY_PRESET_BYTES) {
704 if existing == text.as_bytes() {
705 paths.push(relative);
706 break;
707 }
708 } else if !path.exists() {
709 fs::create_dir_all(path.parent().unwrap()).map_err(|err| err.to_string())?;
710 use std::io::Write;
711 let mut out = fs::OpenOptions::new()
712 .write(true)
713 .create_new(true)
714 .open(&path)
715 .map_err(|err| err.to_string())?;
716 out.write_all(text.as_bytes())
717 .map_err(|err| err.to_string())?;
718 out.sync_all().map_err(|err| err.to_string())?;
719 paths.push(relative);
720 break;
721 }
722 number += 1;
723 }
724 }
725 Ok(paths)
726}
727
728fn next_slug(items: &[EquipmentItem]) -> String {
729 let mut number = 1u32;
730 loop {
731 let slug = if number == 1 {
732 "nieuw".to_string()
733 } else {
734 format!("nieuw-{number}")
735 };
736 if !items.iter().any(|item| item.slug == slug) {
737 return slug;
738 }
739 number += 1;
740 }
741}
742
743fn valid_slug(slug: &str) -> bool {
744 crate::equipment::valid_name(slug)
745}
746
747pub fn manifest_in(root: &Path) -> PathBuf {
748 root.join(MANIFEST_NAME)
749}
750
751#[cfg(test)]
752mod tests {
753 use super::*;
754 use std::time::{SystemTime, UNIX_EPOCH};
755
756 fn scratch() -> PathBuf {
757 let nanos = SystemTime::now()
758 .duration_since(UNIX_EPOCH)
759 .unwrap()
760 .as_nanos();
761 let path = std::env::temp_dir().join(format!("paperdoll-session-{nanos}"));
762 let _ = fs::remove_dir_all(&path);
763 path
764 }
765
766 #[test]
767 fn editing_budget_and_import_names_are_bounded_before_install() {
768 let mut session = Session::new();
769 let mut p = Preset::new("sword".into());
770 for i in 0..3 {
771 p.assets.push(crate::equipment::EmbeddedAsset {
772 path: format!("raw-{i}"),
773 bytes: vec![0; 8 * 1024 * 1024],
774 });
775 }
776 for _ in 0..2 {
777 let i = session.add_equipment();
778 session.equipment[i].preset = Some(p.clone());
779 }
780 assert!(session
781 .ensure_preset_budget(None, &p)
782 .unwrap_err()
783 .contains("64 MiB"));
784 assert!(session.ensure_preset_budget(Some(0), &p).is_ok());
785 assert_eq!(session.equipment.len(), 2);
786 let base = "a".repeat(64);
787 session.equipment[0].slug = base.clone();
788 let unique = session.available_equipment_name(&base).unwrap();
789 assert_eq!(unique.len(), 64);
790 assert_ne!(unique, base);
791 assert!(crate::equipment::valid_name(&unique));
792 }
793
794 #[test]
795 fn preset_read_budget_preserves_unloaded_references() {
796 let root = scratch();
797 fs::create_dir_all(root.join("presets")).unwrap();
798 let bytes = Preset::new("sword".into()).encode().unwrap();
799 for name in ["one", "two"] {
800 fs::write(root.join(format!("presets/{name}.ppe")), &bytes).unwrap();
801 }
802 let refs = vec!["presets/one.ppe".into(), "presets/two.ppe".into()];
803 let items = read_equipment_with_budget(&root, &refs, bytes.len());
804 assert!(items[0].preset.is_some());
805 assert!(items[1].preset.is_none());
806 assert!(items[1].error.as_ref().unwrap().contains("budget"));
807 assert_eq!(items[1].legacy_path.as_ref(), Some(&refs[1]));
808 fs::write(
809 root.join("presets/old.json"),
810 vec![b' '; MAX_LEGACY_PRESET_BYTES + 1],
811 )
812 .unwrap();
813 assert!(read_equipment(&root, &["presets/old.json".into()])[0]
814 .error
815 .is_some());
816 fs::remove_dir_all(root).unwrap();
817 }
818 #[test]
819 fn too_many_presets_do_not_write_snapshots_or_replace_manifest() {
820 let root = scratch();
821 let mut session = Session::new();
822 session.install_new_project(&root).unwrap();
823 let before = fs::read(root.join(MANIFEST_NAME)).unwrap();
824 for _ in 0..=crate::project::MAX_PROJECT_PRESETS {
825 session.add_equipment();
826 }
827 assert!(session.save().unwrap_err().to_string().contains("64"));
828 assert_eq!(fs::read(root.join(MANIFEST_NAME)).unwrap(), before);
829 assert_eq!(fs::read_dir(root.join("presets")).unwrap().count(), 0);
830 assert!(session.is_dirty());
831 fs::remove_dir_all(root).unwrap();
832 }
833
834 #[test]
835 fn named_new_project_contains_and_loads_the_default_bodies() {
836 let parent = scratch();
837 fs::create_dir_all(&parent).unwrap();
838 let mut session = Session::new();
839 session.install_named_project(&parent, "Starter").unwrap();
840 let root = parent.join("Starter");
841 for (relative, bytes) in crate::default_bodies::FILES {
842 let copied = fs::read(root.join("assets/body").join(relative)).unwrap();
843 assert!(copied == *bytes, "{relative} not byte-exact");
844 }
845 assert!(root.join("assets/body/male/license.txt").is_file());
846 assert!(root.join("assets/body/female/license.txt").is_file());
847 let document = &session.opened.as_ref().unwrap().document;
848 assert_eq!(
849 document.male_model.as_deref(),
850 Some(crate::default_bodies::MALE_MODEL)
851 );
852 assert_eq!(
853 document.female_model.as_deref(),
854 Some(crate::default_bodies::FEMALE_MODEL)
855 );
856 for model in [
857 crate::default_bodies::MALE_MODEL,
858 crate::default_bodies::FEMALE_MODEL,
859 ] {
860 let body = crate::preview::load_body_file(&root.join(model)).unwrap();
861 assert!(
862 !body.joint_names.is_empty() && !body.clips.is_empty(),
863 "{model}"
864 );
865 assert!(
866 body.surfaces.iter().any(|s| s.albedo.is_some()),
867 "{model} textures"
868 );
869 }
870 // The saved manifest reopens with the same bodies.
871 let reopened = crate::project::open_project(&root.join("character.ppd")).unwrap();
872 assert_eq!(
873 reopened.document.male_model.as_deref(),
874 Some(crate::default_bodies::MALE_MODEL)
875 );
876 }
877
878 #[test]
879 fn new_project_copies_both_test_bodies_and_can_be_overwritten() {
880 let root = scratch();
881 let mut session = Session::new();
882 session.install_new_project(&root).unwrap();
883 assert_eq!(session.screen, Screen::Bodies);
884 assert!(!session.is_dirty());
885 assert_eq!(fs::read(root.join(MALE_ASSET)).unwrap(), MALE_GLB);
886 assert_eq!(fs::read(root.join(FEMALE_ASSET)).unwrap(), FEMALE_GLB);
887 let outside = root
888 .parent()
889 .unwrap()
890 .join(format!("pd-src-{}", std::process::id()));
891 let _ = fs::remove_dir_all(&outside);
892 fs::create_dir_all(&outside).unwrap();
893 let source = outside.join("test-body-male.glb");
894 fs::write(&source, b"replacement-body").unwrap();
895 let relative = adopt_file(&root, &source, "assets/body").unwrap();
896 assert_ne!(relative, MALE_ASSET);
897 assert_eq!(fs::read(root.join(&relative)).unwrap(), b"replacement-body");
898 assert_eq!(fs::read(root.join(MALE_ASSET)).unwrap(), MALE_GLB);
899 let extra = outside.join("extra.glb");
900 fs::write(&extra, b"extra-body").unwrap();
901 let relative = adopt_file(&root, &extra, "assets/body").unwrap();
902 session.set_body_path(Sex::Male, relative);
903 assert!(session.is_dirty());
904 session.save().unwrap();
905 assert!(!session.is_dirty());
906 assert_eq!(
907 fs::read(root.join("assets/body/extra.glb")).unwrap(),
908 b"extra-body"
909 );
910 let _ = fs::remove_dir_all(&outside);
911 let _ = fs::remove_dir_all(&root);
912 }
913
914 #[test]
915 fn navigation_and_equipment_crud_roundtrip() {
916 let root = scratch();
917 let mut session = Session::new();
918 session.show_body(Sex::Male);
919 assert_eq!(session.screen, Screen::Start);
920 session.install_new_project(&root).unwrap();
921 session.show_body(Sex::Female);
922 assert_eq!(session.screen, Screen::Body(Sex::Female));
923 session.show_equipment_list();
924 assert_eq!(session.screen, Screen::EquipmentList);
925 let index = session.add_equipment();
926 assert_eq!(index, 0);
927 session.set_equipment_model(0, "assets/equipment/zwaard.glb".to_string());
928 session.save().unwrap();
929 let text = fs::read_to_string(root.join("presets/nieuw-1.json")).unwrap();
930 assert!(text.contains("zwaard.glb"));
931 let mut again = Session::new();
932 let opened = crate::project::open_project(&manifest_in(&root)).unwrap();
933 again.install_loaded(opened);
934 assert_eq!(
935 again.equipment[0].model.as_deref(),
936 Some("assets/equipment/zwaard.glb")
937 );
938 again.delete_equipment(0);
939 again.save().unwrap();
940 assert!(again
941 .opened
942 .as_ref()
943 .unwrap()
944 .document
945 .equipment_presets
946 .is_empty());
947 // Old immutable record stays recoverable if an earlier save is restored.
948 assert!(root.join("presets/nieuw-1.json").exists());
949 let _ = fs::remove_dir_all(&root);
950 }
951
952 #[test]
953 fn failed_save_preserves_previous_equipment_and_manifest_bytes() {
954 let root = scratch();
955 let mut session = Session::new();
956 session.install_new_project(&root).unwrap();
957 session.add_equipment();
958 session.save().unwrap();
959 let manifest = fs::read(manifest_in(&root)).unwrap();
960 let relative = session.opened.as_ref().unwrap().document.equipment_presets[0].clone();
961 let preset = fs::read(root.join(&relative)).unwrap();
962 session.equipment[0].slug = "changed".into();
963 // Missing body fails after immutable equipment snapshots are written.
964 session.set_body_path(Sex::Male, "assets/body/missing.glb".into());
965 assert!(session.save().is_err());
966 assert_eq!(fs::read(manifest_in(&root)).unwrap(), manifest);
967 assert_eq!(fs::read(root.join(&relative)).unwrap(), preset);
968 assert!(session.is_dirty());
969 let _ = fs::remove_dir_all(root);
970 }
971
972 #[test]
973 fn dirty_confirm_save_discard_and_cancel_keep_bytes() {
974 let root = scratch();
975 let mut session = Session::new();
976 session.install_new_project(&root).unwrap();
977 session.set_name("Gewijzigd".to_string());
978 assert!(session.is_dirty());
979 assert!(!session.gate(Intent::Quit));
980 assert_eq!(session.resolve(Choice::Cancel), AfterChoice::Stay);
981 assert_eq!(session.opened.as_ref().unwrap().document.name, "Gewijzigd");
982 assert!(!session.gate(Intent::PickLoad));
983 assert_eq!(
984 session.resolve(Choice::Discard),
985 AfterChoice::Go(Intent::PickLoad)
986 );
987 assert_eq!(session.opened.as_ref().unwrap().document.name, "Gewijzigd");
988 assert!(session.is_dirty()); // canceled file picker must not discard the old project
989 session.set_name("Bewaard".to_string());
990 assert!(!session.gate(Intent::PickNew));
991 assert_eq!(
992 session.resolve(Choice::Save),
993 AfterChoice::SaveThen(Intent::PickNew)
994 );
995 session.save().unwrap();
996 assert_eq!(session.opened.as_ref().unwrap().document.name, "Bewaard");
997 let opened = crate::project::open_project(&manifest_in(&root)).unwrap();
998 assert_eq!(opened.document.name, "Bewaard");
999 let _ = fs::remove_dir_all(&root);
1000 }
1001}