romm-tui 1.5.0

Terminal UI for the RomM API
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
//! Game detail and extras picker key handlers.

use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};

use anyhow::Result;
use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};

use romm_api::config::resolve_game_save_dir;
use romm_api::core::extras::has_update_or_dlc_extras;
use romm_api::error::{ApiError, RommError};

use super::super::background::types::{SaveDownloadDone, SaveUploadDone};
use super::super::{App, AppScreen};
use crate::tui::screens::game_detail::DetailTab;
use crate::tui::screens::GameDetailPrevious;

fn safe_path_segment(input: &str) -> String {
    let cleaned: String = input
        .chars()
        .map(|c| {
            if c.is_ascii_alphanumeric() || matches!(c, ' ' | '-' | '_' | '.') {
                c
            } else {
                '_'
            }
        })
        .collect();
    let trimmed = cleaned.trim().trim_matches('.').trim();
    if trimmed.is_empty() {
        "game".to_string()
    } else {
        trimmed.to_string()
    }
}

fn reserve_unique_save_path(dir: &Path, file_name: &str) -> std::io::Result<PathBuf> {
    let safe_name = safe_path_segment(file_name);
    let base = Path::new(&safe_name)
        .file_stem()
        .and_then(|s| s.to_str())
        .unwrap_or("save");
    let ext = Path::new(&safe_name).extension().and_then(|s| s.to_str());
    let mut candidate = dir.join(&safe_name);
    let mut n = 1u32;
    loop {
        match std::fs::OpenOptions::new()
            .write(true)
            .create_new(true)
            .open(&candidate)
        {
            Ok(_) => return Ok(candidate),
            Err(err) if err.kind() == std::io::ErrorKind::AlreadyExists => {}
            Err(err) => return Err(err),
        }

        let name = match ext {
            Some(ext) if !ext.is_empty() => format!("{base}-{n}.{ext}"),
            _ => format!("{base}-{n}"),
        };
        candidate = dir.join(name);
        n += 1;
    }
}

impl App {
    fn prompt_metadata_unmatch(&mut self) -> Result<bool> {
        use std::time::{Duration, Instant};
        let supported = self.metadata_edit_supported();
        let blocked = self.metadata_edit_blocked_message();
        let in_flight = match &self.screen {
            AppScreen::GameDetail(detail) => {
                self.metadata_apply_inflight_roms.contains(&detail.rom.id)
            }
            _ => false,
        };
        if let AppScreen::GameDetail(detail) = &mut self.screen {
            if in_flight {
                detail.message = Some(Self::metadata_apply_in_progress_message());
                detail.message_clear_at = Some(Instant::now() + Duration::from_secs(5));
            } else if !supported {
                detail.message = Some(blocked);
                detail.message_clear_at = Some(Instant::now() + Duration::from_secs(5));
            } else {
                detail.metadata_unmatch_confirm = true;
                detail.message = Some("Unmatch metadata? Press y to confirm, n to cancel.".into());
                detail.message_clear_at = None;
            }
        }
        Ok(false)
    }

    fn handle_metadata_unmatch_confirm_key(&mut self, key: &KeyEvent) -> Result<bool> {
        use std::time::{Duration, Instant};
        let supported = self.metadata_edit_supported();
        let blocked = self.metadata_edit_blocked_message();
        let AppScreen::GameDetail(detail) = &mut self.screen else {
            return Ok(false);
        };
        match key.code {
            KeyCode::Char('y') | KeyCode::Char('Y') => {
                if !supported {
                    detail.message = Some(blocked);
                    detail.message_clear_at = Some(Instant::now() + Duration::from_secs(5));
                    detail.metadata_unmatch_confirm = false;
                    return Ok(false);
                }
                let rom_id = detail.rom.id;
                let platform_id = detail.rom.platform_id;
                if self.metadata_apply_inflight_roms.contains(&rom_id) {
                    detail.message = Some(Self::metadata_apply_in_progress_message());
                    detail.message_clear_at = Some(Instant::now() + Duration::from_secs(5));
                    detail.metadata_unmatch_confirm = false;
                    return Ok(false);
                }
                detail.metadata_unmatch_confirm = false;
                detail.message = Some("Removing metadata match…".into());
                detail.message_clear_at = None;
                self.spawn_metadata_unmatch(rom_id, platform_id);
            }
            KeyCode::Char('n') | KeyCode::Char('N') | KeyCode::Esc => {
                detail.metadata_unmatch_confirm = false;
                detail.clear_message();
            }
            _ => {}
        }
        Ok(false)
    }

    pub(in crate::tui::app) fn handle_game_detail(&mut self, key: &KeyEvent) -> Result<bool> {
        use crate::tui::path_picker::PathPickerEvent;
        if !matches!(self.screen, AppScreen::GameDetail(_)) {
            return Ok(false);
        }

        if key.code == KeyCode::Char('m') {
            let is_identified = match &self.screen {
                AppScreen::GameDetail(d) => d.rom.is_identified,
                _ => false,
            };
            if is_identified {
                return self.prompt_metadata_unmatch();
            } else {
                self.open_metadata_match_screen();
                return Ok(false);
            }
        }

        if let AppScreen::GameDetail(detail) = &mut self.screen {
            if detail.metadata_unmatch_confirm {
                return self.handle_metadata_unmatch_confirm_key(key);
            }
        }

        let detail = match &mut self.screen {
            AppScreen::GameDetail(d) => d,
            _ => return Ok(false),
        };

        if let Some(picker) = detail.save_upload_picker.as_mut() {
            if key.code == KeyCode::Esc {
                detail.save_upload_picker = None;
                detail.clear_message();
                return Ok(false);
            }
            match picker.handle_key(key) {
                PathPickerEvent::Confirmed(path) => {
                    let rom_id = detail.rom.id;
                    detail.save_upload_picker = None;
                    detail.message = Some("Uploading save...".into());
                    detail.message_clear_at = None;
                    let client = self.client.clone();
                    let tx = self.save_upload_tx.clone();
                    tokio::spawn(async move {
                        let result = client
                            .upload_save_file(rom_id, None, &path)
                            .await
                            .map(|_| ())
                            .map_err(RommError::from);
                        let _ = tx.send(SaveUploadDone { rom_id, result });
                    });
                }
                PathPickerEvent::None => {}
            }
            return Ok(false);
        }

        // Acknowledge download completion on any key press
        // (check if there's a completed/errored download for this ROM)
        if !detail.download_completion_acknowledged {
            if let Ok(list) = detail.downloads.lock() {
                let has_completed = list.iter().any(|j| {
                    j.rom_id == detail.rom.id
                        && matches!(
                            j.status,
                            romm_api::core::download::DownloadStatus::Done
                                | romm_api::core::download::DownloadStatus::SkippedAlreadyExists
                                | romm_api::core::download::DownloadStatus::Cancelled
                                | romm_api::core::download::DownloadStatus::FinalizeFailed(_)
                                | romm_api::core::download::DownloadStatus::Error(_)
                        )
                });
                let is_still_downloading = list.iter().any(|j| {
                    j.rom_id == detail.rom.id
                        && matches!(
                            j.status,
                            romm_api::core::download::DownloadStatus::Downloading
                        )
                });
                // Only acknowledge if there's a completion and no active download
                if has_completed && !is_still_downloading {
                    detail.download_completion_acknowledged = true;
                }
            }
        }

        if key.modifiers.contains(KeyModifiers::CONTROL) {
            match key.code {
                KeyCode::Left => {
                    detail.adjust_cover_panel_width(-2);
                    self.config.tui_layout.game_detail_cover_panel_width = detail.cover_panel_width;
                    self.persist_tui_layout();
                    return Ok(false);
                }
                KeyCode::Right => {
                    detail.adjust_cover_panel_width(2);
                    self.config.tui_layout.game_detail_cover_panel_width = detail.cover_panel_width;
                    self.persist_tui_layout();
                    return Ok(false);
                }
                _ => {}
            }
        }

        let mut trigger_screenshot = false;
        match key.code {
            KeyCode::Char('1') => detail.select_tab(DetailTab::Info),
            KeyCode::Char('2') => detail.select_tab(DetailTab::Extras),
            KeyCode::Char('3') => {
                detail.select_tab(DetailTab::Saves);
                trigger_screenshot = true;
            }
            KeyCode::Char('4') => detail.select_tab(DetailTab::Achievements),
            KeyCode::Char('5') => detail.select_tab(DetailTab::Technical),
            KeyCode::Up | KeyCode::Char('k') if detail.active_tab == DetailTab::Extras => {
                detail.extras_selection_previous();
            }
            KeyCode::Down | KeyCode::Char('j') if detail.active_tab == DetailTab::Extras => {
                detail.extras_selection_next();
            }
            KeyCode::Char(' ') if detail.active_tab == DetailTab::Extras => {
                detail.extras_toggle_current();
            }
            KeyCode::Char('a') | KeyCode::Char('A') if detail.active_tab == DetailTab::Extras => {
                detail.extras_toggle_all();
            }
            KeyCode::Up | KeyCode::Char('k') if detail.active_tab == DetailTab::Saves => {
                detail.save_selection_previous();
                trigger_screenshot = true;
            }
            KeyCode::Down | KeyCode::Char('j') if detail.active_tab == DetailTab::Saves => {
                detail.save_selection_next();
                trigger_screenshot = true;
            }
            KeyCode::Up | KeyCode::Char('k') if detail.active_tab == DetailTab::Achievements => {
                detail.achievement_selection_previous();
            }
            KeyCode::Down | KeyCode::Char('j') if detail.active_tab == DetailTab::Achievements => {
                detail.achievement_selection_next();
            }
            KeyCode::Char('u') if detail.active_tab == DetailTab::Saves => {
                detail.open_save_upload_picker()
            }
            KeyCode::Char('D') if detail.active_tab == DetailTab::Saves => {
                let Some(save) = detail.selected_save().cloned() else {
                    detail.message = Some("No save selected".into());
                    detail.message_clear_at = Some(Instant::now() + Duration::from_secs(3));
                    return Ok(false);
                };
                let rom_id = detail.rom.id;
                let rom = detail.rom.clone();
                let target_dir = match resolve_game_save_dir(&self.config, &rom) {
                    Ok(path) => path,
                    Err(err) => {
                        detail.message = Some(format!(
                            "Save download blocked: {err:#}. Fix save paths in Settings."
                        ));
                        detail.message_clear_at = Some(Instant::now() + Duration::from_secs(5));
                        return Ok(false);
                    }
                };
                detail.message = Some("Downloading save...".into());
                detail.message_clear_at = None;
                let client = self.client.clone();
                let tx = self.save_download_tx.clone();
                tokio::spawn(async move {
                    let result: Result<PathBuf, RommError> = async {
                        let bytes = client.download_save_content(save.id, None, None).await?;
                        tokio::fs::create_dir_all(&target_dir)
                            .await
                            .map_err(|e| RommError::Api(ApiError::Io(e)))?;
                        let filename = if save.file_name.trim().is_empty() {
                            format!("save-{}.sav", save.id)
                        } else {
                            save.file_name.clone()
                        };
                        let target = reserve_unique_save_path(&target_dir, &filename)
                            .map_err(|e| RommError::Api(ApiError::Io(e)))?;
                        tokio::fs::write(&target, bytes)
                            .await
                            .map_err(|e| RommError::Api(ApiError::Io(e)))?;
                        Ok(target)
                    }
                    .await;
                    let _ = tx.send(SaveDownloadDone { rom_id, result });
                });
            }
            KeyCode::Enter if detail.active_tab == DetailTab::Extras => {
                if detail.extras_selected_count() == 0 {
                    detail.message = Some("Select at least one item (Space to toggle)".into());
                    detail.message_clear_at = Some(Instant::now() + Duration::from_secs(2));
                } else {
                    let rom = detail.rom.clone();
                    let items = &detail.extras_items;
                    let targets =
                        crate::tui::screens::extras_picker::build_selected_targets_from_items(
                            items,
                            &rom,
                            &self.config.roms_layout,
                            Some(self.config.download_dir.as_str()),
                        );
                    match targets {
                        Ok(targets) => {
                            match self.downloads.start_extras_download(
                                &rom,
                                targets,
                                self.client.clone(),
                                Some(self.config.download_dir.as_str()),
                            ) {
                                Ok(()) => {
                                    detail.message = Some("Extras download started".into());
                                    detail.message_clear_at =
                                        Some(Instant::now() + Duration::from_secs(3));
                                }
                                Err(e) => {
                                    detail.message = Some(format!("Extras: {e:#}"));
                                    detail.message_clear_at =
                                        Some(Instant::now() + Duration::from_secs(5));
                                }
                            }
                        }
                        Err(e) => {
                            detail.message = Some(format!("{e:#}"));
                            detail.message_clear_at = Some(Instant::now() + Duration::from_secs(4));
                        }
                    }
                }
            }
            // Only start a download once per detail view and avoid
            // stacking multiple concurrent downloads for the same ROM.
            KeyCode::Enter if !detail.has_started_download => {
                match self.downloads.start_download(
                    &detail.rom,
                    self.client.clone(),
                    &self.config.roms_layout,
                    Some(self.config.download_dir.as_str()),
                ) {
                    Ok(()) => {
                        detail.has_started_download = true;
                        if has_update_or_dlc_extras(&detail.rom, &detail.other_files) {
                            detail.message = Some(
                                "Updates/DLC available. Switch to Extras tab to download."
                                    .to_string(),
                            );
                            detail.message_clear_at = Some(Instant::now() + Duration::from_secs(5));
                        }
                    }
                    Err(err) => {
                        detail.has_started_download = false;
                        detail.message = Some(format!(
                            "Download blocked: {err}. Fix ROMs directory in settings/setup."
                        ));
                    }
                }
            }
            KeyCode::Char('o') => detail.open_cover(),
            KeyCode::Esc => {
                detail.clear_message();
                let placeholder = self.transient_screen_placeholder();
                let prev = std::mem::replace(&mut self.screen, placeholder);
                if let AppScreen::GameDetail(g) = prev {
                    self.screen = match g.previous {
                        GameDetailPrevious::Library(l) => AppScreen::LibraryBrowse(l),
                        GameDetailPrevious::Search(s) => AppScreen::Search(s),
                    };
                    if self.force_rom_reload_after_metadata
                        && matches!(self.screen, AppScreen::LibraryBrowse(_))
                    {
                        self.spawn_library_metadata_refresh();
                    }
                    self.resume_library_rom_load_if_needed("restore_partial_library");
                }
            }
            KeyCode::Char('q') => return Ok(true),
            _ => {}
        }
        if trigger_screenshot {
            self.maybe_start_save_screenshot_load();
        }
        Ok(false)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn temp_save_dir(name: &str) -> PathBuf {
        let dir = std::env::temp_dir().join(format!(
            "romm-tui-{name}-{}-{}",
            std::process::id(),
            std::time::SystemTime::now()
                .duration_since(std::time::UNIX_EPOCH)
                .unwrap()
                .as_nanos()
        ));
        std::fs::create_dir_all(&dir).unwrap();
        dir
    }

    #[test]
    fn reserve_unique_save_path_reserves_collision_candidates() {
        let dir = temp_save_dir("save-path-reservation");

        let first = reserve_unique_save_path(&dir, "same.sav").unwrap();
        let second = reserve_unique_save_path(&dir, "same.sav").unwrap();

        assert_ne!(first, second);
        assert!(first.exists());
        assert!(second.exists());

        let _ = std::fs::remove_dir_all(dir);
    }

    #[test]
    fn reserve_unique_save_path_propagates_unexpected_errors() {
        let dir = temp_save_dir("save-path-error").join("missing");

        let err = reserve_unique_save_path(&dir, "same.sav").unwrap_err();

        assert_eq!(err.kind(), std::io::ErrorKind::NotFound);
    }
}