pinready 0.27.2

Cross-platform configurator and launcher supporting the adoption of Visual Pinball 10.8.1 — for testers and early adopters, not a replacement for a stable production setup
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
use super::*;

const ASTERISK_RED: egui::Color32 = egui::Color32::from_rgb(255, 80, 80);
const NOTICE_AMBER: egui::Color32 = egui::Color32::from_rgb(232, 168, 40);

/// Last two components of a path — a whole-disk scan walks paths far too
/// long for one line, and the tail is the part that says where we are.
fn tail_of(path: &std::path::Path) -> String {
    let mut parts: Vec<_> = path
        .components()
        .rev()
        .take(2)
        .map(|c| c.as_os_str().to_string_lossy().into_owned())
        .collect();
    parts.reverse();
    parts.join("/")
}

/// A slow sine between 0.45 and 1.0 — visibly alive, never blinking in
/// the eye-catching sense.
fn pulse_alpha(ctx: &egui::Context) -> f32 {
    let t = ctx.input(|i| i.time) as f32;
    0.72 + 0.28 * (t * 2.2).sin()
}

impl App {
    pub(super) fn render_tables_dir_page(&mut self, ui: &mut egui::Ui) {
        theme::page_header(ui, &t!("tables_heading"), Some(&t!("tables_desc")));
        theme::section(ui, &t!("tables_section_where"), None, |ui| {
            // ---- The question that decides how many paths we need ----------
            //
            // Asked before anything else: a modern collection needs one path
            // (it is both source and destination), a bulk one needs two.
            theme::field_label(ui, &t!("merge_layout_question"));
            let mut layout_changed = false;
            if ui
                .radio_value(
                    &mut self.merge_layout_modern,
                    true,
                    t!("merge_layout_modern"),
                )
                .on_hover_text(t!("merge_layout_modern_hint"))
                .changed()
            {
                layout_changed = true;
            }
            if ui
                .radio_value(
                    &mut self.merge_layout_modern,
                    false,
                    t!("merge_layout_legacy"),
                )
                .on_hover_text(t!("merge_layout_legacy_hint"))
                .changed()
            {
                layout_changed = true;
            }
            if layout_changed {
                let _ = self.db.set_config(
                    "merge_layout_modern",
                    if self.merge_layout_modern { "1" } else { "0" },
                );
            }
            ui.add_space(12.0);

            // ---- Paths, in the order the answer implies ---------------------
            if !self.merge_layout_modern {
                let mut source = std::mem::take(&mut self.merge_src_root);
                if pick_dir_row(
                    ui,
                    "🔎",
                    &t!("merge_src_root"),
                    &t!("merge_src_root_hint"),
                    &t!("merge_src_root_picker"),
                    &mut source,
                    false,
                ) {
                    let _ = self.db.set_merge_source("root", &source);
                }
                self.merge_src_root = source;
                ui.add_space(10.0);
            }

            // The tables directory is the wizard's only mandatory field here
            // (the Next button is gated on it in mod.rs), hence the asterisk.
            let dest_label = if self.merge_layout_modern {
                t!("tables_path")
            } else {
                t!("tables_path_output")
            };
            let mut dest = std::mem::take(&mut self.tables_dir);
            pick_dir_row(
                ui,
                "📂",
                &dest_label,
                &t!("tables_dir_path_hint"),
                &t!("tables_folder_picker"),
                &mut dest,
                true,
            );
            self.tables_dir = dest;

            ui.add_space(4.0);
            if self.tables_dir.is_empty() {
                ui.colored_label(ASTERISK_RED, format!("⚠ {}", t!("tables_path_required")));
            } else {
                let path = std::path::Path::new(&self.tables_dir);
                if path.is_dir() {
                    let count = std::fs::read_dir(path)
                        .map(|entries| {
                            entries
                                .filter_map(|e| e.ok())
                                .filter(|e| e.path().is_dir())
                                .count()
                        })
                        .unwrap_or(0);
                    ui.colored_label(
                        egui::Color32::from_rgb(120, 200, 120),
                        format!("✔ {}", t!("tables_valid", count = count)),
                    );
                } else {
                    ui.colored_label(ASTERISK_RED, format!("⚠ {}", t!("tables_invalid")));
                }
            }
        });

        // ---- Import: the action, now that both ends are known ----------
        theme::section(
            ui,
            &t!("merge_section_title"),
            Some(&t!("merge_section_desc")),
            |ui| {
                self.render_merge_section(ui);
            },
        );

        // ---- Maintenance: rescan / patches / catalog. Kept open because
        // these settings are scan-time and users need them visible to make
        // a deliberate choice. Placed before the layout reference, which is
        // documentation rather than something to act on.
        theme::section(ui, &t!("tables_maintenance_section"), None, |ui| {
            ui.horizontal_wrapped(|ui| {
                ui.label(
                    egui::RichText::new(t!("launcher_rebuild"))
                        .strong()
                        .color(theme::pal(ui.ctx()).error),
                );
                ui.label(t!("tables_rebuild_desc"));
            });

            ui.add_space(10.0);
            ui.horizontal(|ui| {
                if ui
                    .checkbox(&mut self.jsm174_patching, t!("tables_vbs_patch_toggle"))
                    .changed()
                    && let Err(e) = self.db.set_jsm174_patching_enabled(self.jsm174_patching)
                {
                    log::error!("Failed to persist jsm174_patching_enabled: {e}");
                }
                help_marker(ui, &t!("tables_vbs_patch_desc"));
            });

            ui.add_space(10.0);
            ui.horizontal(|ui| {
                if ui
                    .checkbox(&mut self.b2s_dmd, t!("tables_b2s_dmd_toggle"))
                    .changed()
                    && let Err(e) = self.db.set_b2s_dmd_enabled(self.b2s_dmd)
                {
                    log::error!("Failed to persist b2s_dmd_enabled: {e}");
                }
                help_marker(ui, &t!("tables_b2s_dmd_desc"));
            });

            ui.add_space(10.0);
            ui.horizontal(|ui| {
                if ui
                    .checkbox(&mut self.catalog_enrichment, t!("tables_catalog_toggle"))
                    .changed()
                    && let Err(e) = self
                        .db
                        .set_catalog_enrichment_enabled(self.catalog_enrichment)
                {
                    log::error!("Failed to persist catalog_enrichment_enabled: {e}");
                }
                help_marker(ui, &t!("tables_catalog_desc"));
            });
        });

        // ---- Reference: what the modern layout actually looks like -----
        theme::section(ui, &t!("tables_help_section"), None, |ui| {
            ui.label(t!("tables_structure"));
            ui.add_space(4.0);
            ui.code(t!("tables_structure_tree").to_string());

            ui.add_space(6.0);
            ui.colored_label(theme::pal(ui.ctx()).warning, t!("tables_formats_supported"));
            ui.colored_label(theme::pal(ui.ctx()).error, t!("tables_formats_unsupported"));

            ui.add_space(8.0);
            ui.label(t!("tables_modifiable"));
            ui.add_space(8.0);

            ui.horizontal(|ui| {
                ui.label("📖");
                ui.label(t!("tables_tips_patch_desc"));
                ui.hyperlink_to(
                    t!("tables_tips_info_here"),
                    t!("tables_tips_patch_url").to_string(),
                );
            });
            ui.add_space(4.0);
            ui.horizontal(|ui| {
                ui.label("\u{1F527}\u{FE0E}");
                ui.label(t!("tables_tips_webp_desc"));
                ui.hyperlink_to(
                    t!("tables_tips_info_here"),
                    t!("tables_tips_webp_url").to_string(),
                );
            });
        });
    }

    fn render_merge_section(&mut self, ui: &mut egui::Ui) {
        use crate::merge::{MergeEvent, MergeMode, MergeStrategy};

        // Drain any pending events from a running worker into self.merge_log.
        let mut received_done = false;
        if let Some(rx) = &self.merge_progress_rx {
            while let Ok(ev) = rx.try_recv() {
                match &ev {
                    MergeEvent::ScanProgress {
                        files,
                        dirs,
                        folder,
                    } => {
                        self.merge_scan_files = *files;
                        self.merge_scan_dirs = *dirs;
                        self.merge_busy_with = tail_of(folder);
                        continue; // a moving counter, not a log line
                    }
                    MergeEvent::ScanDone {
                        files,
                        dirs,
                        tables,
                    } => {
                        self.merge_scan_files = *files;
                        self.merge_scan_dirs = *dirs;
                        self.merge_table_total = *tables;
                        self.merge_scan_finished = true;
                    }
                    MergeEvent::TableStarted { name, index, total }
                    | MergeEvent::TableSkipped {
                        name, index, total, ..
                    } => {
                        // Skipped tables count towards the bar too, or it
                        // stalls short of the end on a collection full of
                        // duplicates.
                        self.merge_table_index = *index;
                        self.merge_table_total = *total;
                        self.merge_busy_with = name.clone();
                    }
                    // An absence is not an event, and "dry run" on every
                    // line is the mode, not news: both drowned the log
                    // in noise a hundred lines deep.
                    MergeEvent::AssetSkipped {
                        reason:
                            crate::merge::SkipReason::SourceMissing | crate::merge::SkipReason::DryRun,
                        ..
                    } => continue,
                    MergeEvent::Done(report) => {
                        if self.merge_dry_run_report.is_none() {
                            self.merge_dry_run_report = Some(report.clone());
                        }
                        received_done = true;
                    }
                    _ => {}
                }
                self.merge_log.push(ev);
            }
        }
        if received_done {
            self.merge_running = false;
            self.merge_progress_rx = None;
            self.merge_cancel = None;
        }

        // Not a collapsible section: bundling the collection is what this
        // page is for, not an optional extra.
        {
            // Where the files will land, spelled out — the whole point of
            // the question above is that these two cases differ.
            ui.horizontal_wrapped(|ui| {
                ui.label("📍");
                ui.colored_label(
                    NOTICE_AMBER,
                    match (self.merge_layout_modern, self.tables_dir.trim().is_empty()) {
                        (true, true) => t!("merge_in_place_notice").to_string(),
                        (true, false) => t!(
                            "merge_in_place_notice_path",
                            path = self.tables_dir.as_str()
                        )
                        .to_string(),
                        (false, true) => t!("merge_destination_notice").to_string(),
                        (false, false) => t!(
                            "merge_destination_notice_path",
                            path = self.tables_dir.as_str()
                        )
                        .to_string(),
                    },
                );
            });

            // Copy or move only means something when files come from
            // somewhere else.
            if !self.merge_layout_modern {
                ui.add_space(8.0);
                ui.horizontal(|ui| {
                    ui.label(egui::RichText::new(t!("merge_strategy_label")).strong());
                    help_marker(ui, &t!("merge_strategy_help"));
                });
                let mut strategy = self.merge_strategy;
                let mut strategy_changed = false;
                ui.horizontal(|ui| {
                    if ui
                        .radio_value(
                            &mut strategy,
                            MergeStrategy::Copy,
                            t!("merge_strategy_copy"),
                        )
                        .on_hover_text(t!("tables_dir_merge_strategy_copy_hint"))
                        .changed()
                    {
                        strategy_changed = true;
                    }
                    if ui
                        .radio_value(
                            &mut strategy,
                            MergeStrategy::Move,
                            t!("merge_strategy_move"),
                        )
                        .on_hover_text(t!("tables_dir_merge_strategy_move_hint"))
                        .changed()
                    {
                        strategy_changed = true;
                    }
                });
                if strategy_changed {
                    self.merge_strategy = strategy;
                    let _ = self.db.set_merge_strategy(strategy.as_db_str());
                }
            }

            ui.add_space(10.0);

            let tables_dir_set =
                !self.tables_dir.is_empty() && std::path::Path::new(&self.tables_dir).is_dir();
            let source_set = self.merge_layout_modern
                || std::path::Path::new(self.merge_src_root.trim()).is_dir();
            let ready = tables_dir_set && source_set;

            ui.horizontal(|ui| {
                let dry_btn = ui
                    .add_enabled(
                        ready && !self.merge_running,
                        egui::Button::new(t!("merge_dry_run")),
                    )
                    .on_hover_text(t!("tables_dir_merge_dry_run_hint"))
                    .on_disabled_hover_text(t!("merge_run_disabled_tooltip"));
                if dry_btn.clicked() {
                    self.start_merge_run(MergeMode::DryRun, ui.ctx());
                }

                let can_commit =
                    ready && !self.merge_running && self.merge_dry_run_report.is_some();
                let commit_btn = ui
                    .add_enabled(can_commit, egui::Button::new(t!("merge_confirm_apply")))
                    .on_hover_text(t!("tables_dir_merge_apply_hint"))
                    .on_disabled_hover_text(t!("merge_apply_disabled_tooltip"));
                if commit_btn.clicked() {
                    self.start_merge_run(MergeMode::Commit, ui.ctx());
                }

                if self.merge_running {
                    let cancel_btn = ui
                        .button(t!("merge_cancel"))
                        .on_hover_text(t!("tables_dir_merge_cancel_hint"));
                    if cancel_btn.clicked()
                        && let Some(c) = &self.merge_cancel
                    {
                        c.store(true, std::sync::atomic::Ordering::SeqCst);
                    }
                }
            });

            // ---- Two-step progress ------------------------------------
            // Step 1 has no known total (that is the point of a recursive
            // scan), so it spins; step 2 fills as tables are bundled.
            if self.merge_running || self.merge_scan_finished {
                ui.add_space(6.0);
                if !self.merge_scan_finished {
                    ui.add(
                        egui::ProgressBar::new(0.0)
                            .animate(self.merge_running)
                            .text(t!(
                                "merge_step_scan",
                                files = self.merge_scan_files,
                                dirs = self.merge_scan_dirs
                            )),
                    );
                } else {
                    let fraction = if self.merge_table_total == 0 {
                        1.0
                    } else {
                        self.merge_table_index as f32 / self.merge_table_total as f32
                    };
                    ui.add(
                        egui::ProgressBar::new(fraction)
                            .animate(self.merge_running)
                            .text(t!(
                                "merge_step_import",
                                current = self.merge_table_index,
                                total = self.merge_table_total
                            )),
                    );
                    ui.label(
                        egui::RichText::new(t!(
                            "merge_step_scan_done",
                            files = self.merge_scan_files,
                            dirs = self.merge_scan_dirs
                        ))
                        .weak(),
                    );
                }
                // Name what is being handled, breathing gently: on a hard
                // disk a single big table can hold the bar still for
                // seconds, and a still bar reads as a crash.
                if self.merge_running && !self.merge_busy_with.is_empty() {
                    let pulse = pulse_alpha(ui.ctx());
                    ui.label(
                        egui::RichText::new(&self.merge_busy_with)
                            .weak()
                            .color(ui.visuals().weak_text_color().gamma_multiply(pulse)),
                    );
                    ui.ctx().request_repaint();
                }
            }

            if let Some(report) = &self.merge_dry_run_report {
                ui.add_space(6.0);
                ui.label(t!(
                    "merge_progress",
                    tables = report.tables_processed,
                    found = report.assets_found,
                    applied = report.assets_applied,
                    skipped = report.assets_skipped
                ));
                if report.tables_skipped > 0 {
                    ui.colored_label(
                        NOTICE_AMBER,
                        t!("merge_tables_skipped", count = report.tables_skipped),
                    );
                }
                if report.tables_sample_skipped > 0 {
                    ui.colored_label(
                        NOTICE_AMBER,
                        t!(
                            "merge_samples_skipped",
                            count = report.tables_sample_skipped
                        ),
                    );
                }
            }

            if !self.merge_log.is_empty() {
                ui.add_space(6.0);
                egui::ScrollArea::vertical()
                    .max_height(220.0)
                    .auto_shrink([false, false])
                    .stick_to_bottom(true)
                    .show(ui, |ui| {
                        let start = self.merge_log.len().saturating_sub(400);
                        for ev in &self.merge_log[start..] {
                            render_merge_event(ui, ev);
                        }
                    });
            }
        }

        if self.merge_running {
            ui.ctx().request_repaint();
        }
    }

    fn start_merge_run(&mut self, mode: crate::merge::MergeMode, _ctx: &egui::Context) {
        if self.tables_dir.is_empty() {
            return;
        }
        self.merge_log.clear();
        self.merge_scan_files = 0;
        self.merge_scan_dirs = 0;
        self.merge_scan_finished = false;
        self.merge_table_index = 0;
        self.merge_table_total = 0;
        self.merge_busy_with.clear();
        if matches!(mode, crate::merge::MergeMode::DryRun) {
            self.merge_dry_run_report = None;
        }
        let output_root = std::path::PathBuf::from(&self.tables_dir);
        let scan_root = if self.merge_layout_modern {
            output_root.clone()
        } else {
            std::path::PathBuf::from(self.merge_src_root.trim())
        };
        let (rx, cancel, _handle) = crate::merge::spawn(crate::merge::MergeConfig {
            scan_root,
            output_root,
            // In place there is nothing to copy or move: tables stay put.
            strategy: if self.merge_layout_modern {
                crate::merge::MergeStrategy::Copy
            } else {
                self.merge_strategy
            },
            mode,
        });
        self.merge_progress_rx = Some(rx);
        self.merge_cancel = Some(cancel);
        self.merge_running = true;
    }
}

/// One labelled directory row: icon, label, optional mandatory marker,
/// help bubble, text field and a browse button. The picker opens where
/// the current value points — left to itself the OS dialog lands in the
/// process's working directory, which is never what the user meant.
fn pick_dir_row(
    ui: &mut egui::Ui,
    icon: &str,
    label: &str,
    hint: &str,
    picker_title: &str,
    value: &mut String,
    mandatory: bool,
) -> bool {
    ui.horizontal(|ui| {
        ui.label(icon);
        ui.label(egui::RichText::new(label).strong());
        if mandatory {
            ui.colored_label(ASTERISK_RED, "*");
        }
        help_marker(ui, hint);
    });
    let mut changed = false;
    ui.horizontal(|ui| {
        if ui.text_edit_singleline(value).changed() {
            changed = true;
        }
        if ui
            .button(t!("tables_browse"))
            .on_hover_text(t!("tables_dir_browse_hint"))
            .clicked()
        {
            let mut dialog = rfd::FileDialog::new().set_title(picker_title);
            let current = std::path::Path::new(value.trim());
            if current.is_dir() {
                dialog = dialog.set_directory(current);
            }
            if let Some(path) = dialog.pick_folder() {
                *value = path.to_string_lossy().into_owned();
                changed = true;
            }
        }
    });
    changed
}

fn render_merge_event(ui: &mut egui::Ui, ev: &crate::merge::MergeEvent) {
    use crate::merge::MergeEvent::*;
    let green = egui::Color32::from_rgb(120, 200, 120);
    let red = egui::Color32::from_rgb(220, 110, 110);
    let yellow = egui::Color32::from_rgb(220, 200, 120);
    let weak = egui::Color32::from_gray(170);
    match ev {
        ScanProgress { .. } => {}
        ScanDone {
            files,
            dirs,
            tables,
        } => {
            ui.colored_label(
                weak,
                t!(
                    "merge_log_indexed",
                    files = files,
                    dirs = dirs,
                    tables = tables
                ),
            );
        }
        TableStarted { name, index, total } => {
            ui.colored_label(weak, format!("▸ [{index}/{total}] {name}"));
        }
        TableSkipped {
            name,
            index,
            total,
            src,
            kept,
        } => {
            ui.colored_label(
                yellow,
                format!(
                    "▸ [{index}/{total}] {name} — {}",
                    t!(
                        "merge_table_duplicate",
                        src = src.display().to_string(),
                        kept = kept.display().to_string()
                    )
                ),
            );
        }
        AssetFound { kind, src, .. } => {
            ui.colored_label(green, format!("  + {} : {}", kind.label(), src.display()));
        }
        AssetApplied { kind, dst } => {
            ui.colored_label(green, format!("  ✔ {} → {}", kind.label(), dst.display()));
        }
        AssetSkipped { kind, .. } => {
            // Only "already present" survives the drain filter.
            ui.colored_label(
                yellow,
                format!(
                    "  · {} — {}",
                    kind.label(),
                    t!("merge_skip_already_present")
                ),
            );
        }
        AssetError { kind, msg } => {
            ui.colored_label(red, format!("  ! {} : {msg}", kind.label()));
        }
        TableDone { .. } => {}
        Done(report) => {
            ui.add_space(4.0);
            ui.colored_label(
                green,
                t!(
                    "merge_log_done",
                    tables = report.tables_processed,
                    found = report.assets_found,
                    applied = report.assets_applied
                ),
            );
            // The skipped/sample tallies live in the summary just above
            // the log — repeating them here read as two different results.
        }
    }
}