tirith 0.4.1

Terminal security - catches homograph attacks, pipe-to-shell, ANSI injection
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
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
#[cfg(unix)]
use libc;
use std::path::{Path, PathBuf};

use crate::assets;

fn posix_single_quote(path: &str) -> String {
    format!("'{}'", path.replace('\'', "'\\''"))
}

fn powershell_single_quote(path: &str) -> String {
    format!("'{}'", path.replace('\'', "''"))
}

/// Render an exact Nushell string literal. Nushell's single-quoted strings do
/// not support embedded apostrophes or escapes, so paths are always emitted as
/// double-quoted literals with every special/control character encoded.
pub(crate) fn nushell_string_literal(value: &str) -> String {
    let mut quoted = String::with_capacity(value.len() + 2);
    quoted.push('"');
    for character in value.chars() {
        match character {
            '\\' => quoted.push_str("\\\\"),
            '"' => quoted.push_str("\\\""),
            '\n' => quoted.push_str("\\n"),
            '\r' => quoted.push_str("\\r"),
            '\t' => quoted.push_str("\\t"),
            control if control.is_control() => {
                use std::fmt::Write as _;
                write!(quoted, "\\u{{{:x}}}", control as u32)
                    .expect("writing to a String cannot fail");
            }
            ordinary => quoted.push(ordinary),
        }
    }
    quoted.push('"');
    quoted
}

/// Warn if another `tirith` binary shadows us on PATH.
fn check_path_shadow() -> Option<String> {
    let shadows = super::find_shadow_binaries();
    if shadows.is_empty() {
        return None;
    }
    let our_exe = std::env::current_exe()
        .map(|p| p.display().to_string())
        .unwrap_or_else(|_| "unknown".into());
    Some(format!(
        "tirith: WARNING: '{}' shadows this binary ({})\n\
         tirith: This may be a different package (e.g. pip-installed).\n\
         tirith: Run '{}' to inspect, and remove the conflicting binary.",
        shadows[0],
        our_exe,
        super::tirith_path_lookup_command(),
    ))
}

/// How long to suppress a repeat PATH-shadow warning. `eval "$(tirith init)"`
/// runs on every new shell, so without this the warning would print every time.
const SHADOW_WARN_INTERVAL_SECS: u64 = 24 * 60 * 60;

/// True when the shadow warning hasn't fired in the last 24h (or ever). Cheap
/// marker stat — checked BEFORE the `check_path_shadow` PATH walk.
fn shadow_warn_due() -> bool {
    let Some(marker) = tirith_core::policy::state_dir().map(|d| d.join("shadow-warned")) else {
        return true;
    };
    match std::fs::metadata(&marker).and_then(|m| m.modified()) {
        Ok(modified) => modified
            .elapsed()
            .map(|age| age.as_secs() >= SHADOW_WARN_INTERVAL_SECS)
            .unwrap_or(true),
        Err(_) => true,
    }
}

fn mark_shadow_warned() {
    if let Some(dir) = tirith_core::policy::state_dir() {
        let _ = std::fs::create_dir_all(&dir);
        let _ = std::fs::write(dir.join("shadow-warned"), b"");
    }
}

pub fn run(shell: Option<&str>, prompt_status: bool) -> i32 {
    // Throttled (once/24h) + `--quiet`-gated: a sourced `tirith init` runs on every
    // new shell. The PATH walk is skipped entirely when a warning isn't due.
    if !crate::cli::is_quiet() && shadow_warn_due() {
        if let Some(warning) = check_path_shadow() {
            eprintln!("{warning}");
            mark_shadow_warned();
        }
    }

    let shell = shell.unwrap_or_else(|| detect_shell());

    let prompt_executable = if prompt_status {
        match tirith_core::trusted_child::TrustedExecutable::current() {
            Ok(executable) => Some(executable),
            Err(error) => {
                eprintln!("tirith: cannot bind prompt status to the running executable: {error}");
                return 1;
            }
        }
    } else {
        None
    };

    let hook_dir = find_hook_dir();

    match shell {
        "zsh" => {
            if let Some(dir) = &hook_dir {
                println!(
                    "source {}",
                    posix_single_quote(&dir.join("lib/zsh-hook.zsh").display().to_string())
                );
            } else {
                eprintln!("tirith: could not locate or materialize shell hooks.");
                return 1;
            }
            if prompt_status {
                println!(
                    "{}",
                    prompt_status_snippet_for("zsh", prompt_executable.as_ref().unwrap().path())
                );
            }
            0
        }
        "bash" => {
            if let Some(dir) = &hook_dir {
                println!(
                    "source {}",
                    posix_single_quote(&dir.join("lib/bash-hook.bash").display().to_string())
                );
            } else {
                eprintln!("tirith: could not locate or materialize shell hooks.");
                return 1;
            }
            if prompt_status {
                println!(
                    "{}",
                    prompt_status_snippet_for("bash", prompt_executable.as_ref().unwrap().path())
                );
            }
            0
        }
        "fish" => {
            if let Some(dir) = &hook_dir {
                println!(
                    "source {}",
                    posix_single_quote(&dir.join("lib/fish-hook.fish").display().to_string())
                );
            } else {
                eprintln!("tirith: could not locate or materialize shell hooks.");
                return 1;
            }
            if prompt_status {
                println!(
                    "{}",
                    prompt_status_snippet_for("fish", prompt_executable.as_ref().unwrap().path())
                );
            }
            0
        }
        "powershell" | "pwsh" => {
            if let Some(dir) = &hook_dir {
                println!(
                    ". {}",
                    powershell_single_quote(
                        &dir.join("lib/powershell-hook.ps1").display().to_string()
                    )
                );
            } else {
                eprintln!("tirith: could not locate or materialize shell hooks.");
                return 1;
            }
            if prompt_status {
                println!(
                    "{}",
                    prompt_status_snippet_for(
                        "powershell",
                        prompt_executable.as_ref().unwrap().path(),
                    )
                );
            }
            0
        }
        "nushell" | "nu" => {
            if let Some(dir) = &hook_dir {
                let hook_path = dir.join("lib/nushell-hook.nu");
                if !hook_path.is_file() {
                    eprintln!(
                        "tirith: resolved nushell hook is missing or not a file: {}",
                        hook_path.display()
                    );
                    return 1;
                }
                let Some(hook_path) = hook_path.to_str() else {
                    eprintln!(
                        "tirith: resolved nushell hook path is not valid UTF-8 and cannot be emitted without changing its identity"
                    );
                    return 1;
                };
                println!("source {}", nushell_string_literal(hook_path));
            } else {
                eprintln!("tirith: could not locate or materialize shell hooks.");
                return 1;
            }
            if prompt_status {
                // Nushell can't be wired via eval; emit a manual-install pointer
                // (the shipped hook does the real wiring).
                println!(
                    "{}",
                    prompt_status_snippet_for(
                        "nushell",
                        prompt_executable.as_ref().unwrap().path(),
                    )
                );
            }
            0
        }
        _ => {
            eprintln!("tirith: unsupported shell '{shell}'");
            eprintln!("Supported: zsh, bash, fish, powershell, nushell");
            eprintln!("  try: tirith init --shell zsh");
            1
        }
    }
}

/// Render the opt-in `--prompt-status` snippet for `shell`. Each snippet is
/// guarded against double-eval (so PS1/PROMPT isn't double-wrapped) and uses
/// single quotes around the command substitution so it defers to prompt-render
/// time (the only quoting that produces a live status).
pub(crate) fn prompt_status_snippet_for(shell: &str, executable: &std::path::Path) -> String {
    let executable = executable.display().to_string();
    let posix_executable = posix_single_quote(&executable);
    let powershell_executable = powershell_single_quote(&executable);
    match shell {
        "zsh" => {
            let substitution = posix_single_quote(&format!(
                "$(TIRITH_STATUS=\"${{TIRITH_STATUS:-}}\" {posix_executable} prompt-status --short) "
            ));
            [
                "# >>> tirith prompt-status (M8 ch6) >>>".to_string(),
                "if [[ -z \"${_TIRITH_PROMPT_STATUS_LOADED:-}\" ]]; then".to_string(),
                "  _TIRITH_PROMPT_STATUS_LOADED=1".to_string(),
                "  setopt PROMPT_SUBST".to_string(),
                format!("  PROMPT={substitution}\"$PROMPT\""),
                "fi".to_string(),
                "# <<< tirith prompt-status (M8 ch6) <<<".to_string(),
            ]
            .join("\n")
        }
        "bash" => {
            let substitution = posix_single_quote(&format!(
                "$(TIRITH_STATUS=\"${{TIRITH_STATUS:-}}\" {posix_executable} prompt-status --short) "
            ));
            [
                "# >>> tirith prompt-status (M8 ch6) >>>".to_string(),
                "if [ -z \"${_TIRITH_PROMPT_STATUS_LOADED:-}\" ]; then".to_string(),
                "  _TIRITH_PROMPT_STATUS_LOADED=1".to_string(),
                format!("  PS1={substitution}\"$PS1\""),
                "fi".to_string(),
                "# <<< tirith prompt-status (M8 ch6) <<<".to_string(),
            ]
            .join("\n")
        }
        "fish" => [
            "# >>> tirith prompt-status (M8 ch6) >>>".to_string(),
            "if not set -q _TIRITH_PROMPT_STATUS_LOADED".to_string(),
            "    set -g _TIRITH_PROMPT_STATUS_LOADED 1".to_string(),
            "    functions -q fish_right_prompt; and functions -e _tirith_orig_fish_right_prompt".to_string(),
            "    if functions -q fish_right_prompt".to_string(),
            "        functions -c fish_right_prompt _tirith_orig_fish_right_prompt".to_string(),
            "    end".to_string(),
            "    function fish_right_prompt".to_string(),
            format!("        env TIRITH_STATUS=\"$TIRITH_STATUS\" {posix_executable} prompt-status --short"),
            "        if functions -q _tirith_orig_fish_right_prompt".to_string(),
            "            _tirith_orig_fish_right_prompt".to_string(),
            "        end".to_string(),
            "    end".to_string(),
            "end".to_string(),
            "# <<< tirith prompt-status (M8 ch6) <<<".to_string(),
        ]
        .join("\n"),
        "powershell" | "pwsh" => [
            "# >>> tirith prompt-status (M8 ch6) >>>".to_string(),
            "if (-not $global:_TIRITH_PROMPT_STATUS_LOADED) {".to_string(),
            "    $global:_TIRITH_PROMPT_STATUS_LOADED = $true".to_string(),
            "    if (Test-Path Function:prompt) {".to_string(),
            "        Copy-Item Function:prompt Function:_tirith_orig_prompt -Force".to_string(),
            "    }".to_string(),
            "    function global:prompt {".to_string(),
            "        $_tps = $env:TIRITH_STATUS; $env:TIRITH_STATUS = $global:TIRITH_STATUS".to_string(),
            format!("        try {{ $line = (& {powershell_executable} prompt-status --short) 2>$null }} finally {{ if ($null -eq $_tps) {{ Remove-Item Env:\\TIRITH_STATUS -ErrorAction SilentlyContinue }} else {{ $env:TIRITH_STATUS = $_tps }} }}"),
            "        if (Get-Command _tirith_orig_prompt -ErrorAction SilentlyContinue) {".to_string(),
            "            \"$line $(_tirith_orig_prompt)\"".to_string(),
            "        } else {".to_string(),
            "            \"$line PS $($executionContext.SessionState.Path.CurrentLocation)> \"".to_string(),
            "        }".to_string(),
            "    }".to_string(),
            "}".to_string(),
            "# <<< tirith prompt-status (M8 ch6) <<<".to_string(),
        ]
        .join("\n"),
        // Nushell wiring lives in config.nu and can't be spliced via `eval`;
        // print a manual-install pointer instead.
        "nushell" | "nu" => [
            "# >>> tirith prompt-status (M8 ch6) >>>",
            "# Nushell exposes no non-exported TIRITH_STATUS variable, so a live",
            "# status segment would always read `off`. nushell protection is",
            "# warn-only regardless — there is no live prompt status to wire up",
            "# here. See docs/prompt-status.md.",
            "# <<< tirith prompt-status (M8 ch6) <<<",
        ]
        .join("\n"),
        _ => String::new(),
    }
}

pub(crate) fn detect_shell() -> &'static str {
    if let Some(shell) = detect_shell_from_parent() {
        return shell;
    }

    if let Ok(shell) = std::env::var("SHELL") {
        if let Some(shell) = normalize_shell_name(&shell) {
            return shell;
        }
    }

    #[cfg(windows)]
    return "powershell";

    #[cfg(not(windows))]
    "bash"
}

fn normalize_shell_name(name: &str) -> Option<&'static str> {
    let name = name.trim();
    if name.is_empty() {
        return None;
    }
    let base = name
        .rsplit(['/', '\\'])
        .next()
        .unwrap_or(name)
        .trim_start_matches('-')
        .to_ascii_lowercase();

    if base.contains("zsh") {
        Some("zsh")
    } else if base.contains("bash") {
        Some("bash")
    } else if base.contains("fish") {
        Some("fish")
    } else if base.contains("pwsh") {
        Some("pwsh")
    } else if base.contains("powershell") {
        Some("powershell")
    } else if base == "nu" || base == "nu.exe" || base.contains("nushell") {
        Some("nushell")
    } else {
        None
    }
}

#[cfg(unix)]
fn detect_shell_from_parent() -> Option<&'static str> {
    let mut pid = unsafe { libc::getppid() };

    // Walk ancestors: the immediate parent may be a wrapper (timeout/env) or a
    // shell that exec'd into another program.
    for _ in 0..8 {
        if pid <= 1 {
            return None;
        }
        let (name, parent_pid) = read_process(pid)?;
        if let Some(shell) = normalize_shell_name(&name) {
            return Some(shell);
        }
        if parent_pid == pid {
            break;
        }
        pid = parent_pid;
    }

    None
}

#[cfg(unix)]
fn read_process(pid: libc::pid_t) -> Option<(String, libc::pid_t)> {
    use tirith_core::trusted_child::{ChildLimits, ChildOutcome, ChildSpec, TrustedExecutable};

    let program = TrustedExecutable::from_system_candidates(&[
        std::path::Path::new("/bin/ps"),
        std::path::Path::new("/usr/bin/ps"),
    ])
    .ok()?;
    let pid = pid.to_string();
    let spec = ChildSpec::new(
        ["-p", pid.as_str(), "-o", "comm=", "-o", "ppid="],
        ChildLimits::new(std::time::Duration::from_secs(1), 16 * 1024, 16 * 1024),
    );
    let ChildOutcome::Completed { status, stdout, .. } =
        tirith_core::trusted_child::run(&program, &spec)
    else {
        return None;
    };
    if !status.success() {
        return None;
    }

    let line = String::from_utf8_lossy(&stdout);
    let mut parts = line.split_whitespace();
    let name = parts.next()?.to_string();
    let ppid = parts.next()?.parse::<libc::pid_t>().ok()?;
    Some((name, ppid))
}

#[cfg(not(unix))]
fn detect_shell_from_parent() -> Option<&'static str> {
    None
}

/// Find the shell hooks directory using the following search order:
/// 1. TIRITH_SHELL_DIR env var (explicit override)
/// 2. ../share/tirith/shell relative to binary (Homebrew layout)
/// 3. /usr/share/tirith/shell (.deb layout)
/// 4. ../shell relative to binary (cargo install / dev layout)
/// 5. ../../shell relative to binary (workspace dev layout)
/// 6. Fallback: materialize embedded hooks to data dir
pub fn find_hook_dir() -> Option<PathBuf> {
    if let Ok(dir) = std::env::var("TIRITH_SHELL_DIR") {
        let p = PathBuf::from(&dir);
        if p.join("lib").exists() {
            return Some(p);
        }
    }

    if let Ok(exe) = std::env::current_exe() {
        if let Some(bin_dir) = exe.parent() {
            let brew_dir = bin_dir.join("../share/tirith/shell");
            if brew_dir.join("lib").exists() {
                return Some(brew_dir.canonicalize().unwrap_or(brew_dir));
            }

            #[cfg(unix)]
            {
                let sys_dir = PathBuf::from("/usr/share/tirith/shell");
                if sys_dir.join("lib").exists() {
                    return Some(sys_dir);
                }
            }

            let cargo_dir = bin_dir.join("../shell");
            if cargo_dir.join("lib").exists() {
                return Some(cargo_dir.canonicalize().unwrap_or(cargo_dir));
            }

            let dev_dir = bin_dir.join("../../shell");
            if dev_dir.join("lib").exists() {
                return Some(dev_dir.canonicalize().unwrap_or(dev_dir));
            }
        }
    }

    materialize_hooks()
}

/// Find the shell hooks directory without materializing (read-only variant for diagnostics).
pub fn find_hook_dir_readonly() -> Option<PathBuf> {
    if let Ok(dir) = std::env::var("TIRITH_SHELL_DIR") {
        let p = PathBuf::from(&dir);
        if p.join("lib").exists() {
            return Some(p);
        }
    }

    if let Ok(exe) = std::env::current_exe() {
        if let Some(bin_dir) = exe.parent() {
            let brew_dir = bin_dir.join("../share/tirith/shell");
            if brew_dir.join("lib").exists() {
                return Some(brew_dir.canonicalize().unwrap_or(brew_dir));
            }

            #[cfg(unix)]
            {
                let sys_dir = PathBuf::from("/usr/share/tirith/shell");
                if sys_dir.join("lib").exists() {
                    return Some(sys_dir);
                }
            }

            let cargo_dir = bin_dir.join("../shell");
            if cargo_dir.join("lib").exists() {
                return Some(cargo_dir.canonicalize().unwrap_or(cargo_dir));
            }

            let dev_dir = bin_dir.join("../../shell");
            if dev_dir.join("lib").exists() {
                return Some(dev_dir.canonicalize().unwrap_or(dev_dir));
            }
        }
    }

    // Check if hooks were previously materialized, but do not create or trust a
    // presence-only bundle. Every byte and the exact version frame must match
    // the currently embedded assets.
    if let Some(data_dir) = tirith_core::policy::data_dir() {
        let shell_dir = data_dir.join("shell");
        if materialized_hooks_match_at(&data_dir).unwrap_or(false) {
            return Some(shell_dir);
        }
    }

    None
}

/// Write embedded hook files to the user data dir, returning the shell dir.
fn materialize_hooks() -> Option<PathBuf> {
    let data_dir = tirith_core::policy::data_dir()?;
    match materialize_hooks_at(&data_dir) {
        Ok((shell_dir, wrote)) => {
            if wrote {
                eprintln!(
                    "tirith: materialized shell hooks to {}",
                    shell_dir.display()
                );
            }
            Some(shell_dir)
        }
        Err(error) => {
            eprintln!("tirith: failed to materialize shell hooks: {error}");
            None
        }
    }
}

fn expected_materialized_files<'a>(
    shell_dir: &Path,
    version: &'a [u8],
) -> Vec<(PathBuf, &'a [u8])> {
    let lib_dir = shell_dir.join("lib");
    vec![
        (shell_dir.join("tirith.sh"), assets::TIRITH_SH.as_bytes()),
        (lib_dir.join("zsh-hook.zsh"), assets::ZSH_HOOK.as_bytes()),
        (lib_dir.join("bash-hook.bash"), assets::BASH_HOOK.as_bytes()),
        (lib_dir.join("fish-hook.fish"), assets::FISH_HOOK.as_bytes()),
        (
            lib_dir.join("powershell-hook.ps1"),
            assets::POWERSHELL_HOOK.as_bytes(),
        ),
        (
            lib_dir.join("nushell-hook.nu"),
            assets::NUSHELL_HOOK.as_bytes(),
        ),
        (shell_dir.join(".hooks-version"), version),
    ]
}

fn prepared_file_matches(
    destination: &tirith_core::util::ContainedAtomicFile,
    path: &Path,
    expected: &[u8],
) -> Result<bool, String> {
    let cap = u64::try_from(expected.len())
        .unwrap_or(u64::MAX)
        .saturating_add(1);
    match destination.read_capped(cap) {
        Ok(observed) => Ok(observed == expected),
        Err(tirith_core::util::OpenRegularError::NotFound)
        | Err(tirith_core::util::OpenRegularError::TooLarge) => Ok(false),
        Err(tirith_core::util::OpenRegularError::NotRegularFile) => Err(format!(
            "refusing non-regular materialized hook destination {}",
            path.display()
        )),
        Err(tirith_core::util::OpenRegularError::Io(error)) => Err(format!(
            "could not read materialized hook {}: {error}",
            path.display()
        )),
    }
}

fn materialized_hooks_match_at(data_dir: &Path) -> Result<bool, String> {
    let shell_dir = data_dir.join("shell");
    let version = format!("{}\n", env!("CARGO_PKG_VERSION"));
    for (path, expected) in expected_materialized_files(&shell_dir, version.as_bytes()) {
        let destination =
            match tirith_core::util::ContainedAtomicFile::prepare(data_dir, &path, false) {
                Ok(destination) => destination,
                Err(error) if error.kind() == std::io::ErrorKind::NotFound => return Ok(false),
                Err(error) => {
                    return Err(format!(
                        "could not bind materialized hook {}: {error}",
                        path.display()
                    ))
                }
            };
        if !prepared_file_matches(&destination, &path, expected)? {
            return Ok(false);
        }
    }
    Ok(true)
}

/// Materialize through retained directory capabilities. All destinations are
/// prepared before the first write and each file is published atomically, but
/// the group is not transactional: a later failure can leave earlier files
/// published. Any error denotes failed materialization, successful completion
/// verifies every file, and the version is attempted last.
fn materialize_hooks_at(data_dir: &Path) -> Result<(PathBuf, bool), String> {
    let shell_dir = data_dir.join("shell");
    let version = format!("{}\n", env!("CARGO_PKG_VERSION"));
    let expected_files = expected_materialized_files(&shell_dir, version.as_bytes());
    let mut prepared = Vec::with_capacity(expected_files.len());

    for (path, expected) in expected_files {
        let destination = tirith_core::util::ContainedAtomicFile::prepare(data_dir, &path, true)
            .map_err(|error| {
                format!(
                    "could not bind materialized hook destination {}: {error}",
                    path.display()
                )
            })?;
        prepared.push((path, expected, destination));
    }

    let mut needs_write = false;
    for (path, expected, destination) in &prepared {
        if !prepared_file_matches(destination, path, expected)? {
            needs_write = true;
        }
    }
    if !needs_write {
        return Ok((shell_dir, false));
    }

    for (path, expected, destination) in &prepared {
        destination.write_atomic(expected, true).map_err(|error| {
            format!(
                "failed to write materialized hook {}: {error}",
                path.display()
            )
        })?;
    }
    for (path, expected, destination) in &prepared {
        if !prepared_file_matches(destination, path, expected)? {
            return Err(format!(
                "materialized hook did not verify after publication: {}",
                path.display()
            ));
        }
    }

    Ok((shell_dir, true))
}

#[cfg(test)]
mod tests {
    use super::{
        materialize_hooks_at, materialized_hooks_match_at, normalize_shell_name,
        nushell_string_literal, posix_single_quote, powershell_single_quote,
        prompt_status_snippet_for,
    };
    use std::path::Path;

    fn prompt_status_snippet(shell: &str) -> String {
        prompt_status_snippet_for(shell, Path::new("/opt/Tirith Bin/tirith"))
    }

    #[test]
    fn nushell_literal_quotes_apostrophe_hash_backslash_quote_and_controls() {
        assert_eq!(
            nushell_string_literal("/tmp/it's \\quoted\" #hook\n\t\u{001f}"),
            "\"/tmp/it's \\\\quoted\\\" #hook\\n\\t\\u{1f}\""
        );
    }

    #[test]
    fn normalize_shell_name_from_paths_and_login_shells() {
        assert_eq!(normalize_shell_name("/bin/bash"), Some("bash"));
        assert_eq!(normalize_shell_name("/opt/homebrew/bin/fish"), Some("fish"));
        assert_eq!(normalize_shell_name("-zsh"), Some("zsh"));
    }

    #[test]
    fn normalize_shell_name_supports_case_insensitive_names() {
        assert_eq!(normalize_shell_name("BASH"), Some("bash"));
        assert_eq!(normalize_shell_name("PwSh"), Some("pwsh"));
        assert_eq!(normalize_shell_name("PowerShell"), Some("powershell"));
    }

    #[test]
    fn normalize_shell_name_distinguishes_pwsh_and_windows_powershell() {
        // pwsh (PowerShell 7+) is a distinct label from legacy powershell 5.1;
        // the hook script is the same, only the label differs.
        assert_eq!(normalize_shell_name("/usr/local/bin/pwsh"), Some("pwsh"));
        assert_eq!(
            normalize_shell_name("C:\\Windows\\System32\\WindowsPowerShell\\v1.0\\powershell.exe"),
            Some("powershell")
        );
        // Non-PowerShell shells are unaffected by the split.
        assert_eq!(normalize_shell_name("/bin/bash"), Some("bash"));
    }

    #[test]
    fn normalize_shell_name_supports_nushell() {
        assert_eq!(normalize_shell_name("nu"), Some("nushell"));
        assert_eq!(normalize_shell_name("nu.exe"), Some("nushell"));
        assert_eq!(normalize_shell_name("nushell"), Some("nushell"));
        assert_eq!(normalize_shell_name("nushell.exe"), Some("nushell"));
        assert_eq!(normalize_shell_name("/usr/bin/nu"), Some("nushell"));
        assert_eq!(
            normalize_shell_name("C:\\Program Files\\nu.exe"),
            Some("nushell")
        );
    }

    #[test]
    fn normalize_shell_name_no_false_positive_on_gnu() {
        // "gnu" contains "nu" but is not nushell — require exact match.
        assert_eq!(normalize_shell_name("gnu"), None);
    }

    #[test]
    fn normalize_shell_name_rejects_unknown_values() {
        assert_eq!(normalize_shell_name(""), None);
        assert_eq!(normalize_shell_name("python"), None);
    }

    #[test]
    fn quote_helpers_escape_shell_metacharacters() {
        assert_eq!(
            posix_single_quote("/tmp/hook' > file"),
            "'/tmp/hook'\\'' > file'"
        );
        assert_eq!(
            powershell_single_quote("C:\\temp\\it's.ps1"),
            "'C:\\temp\\it''s.ps1'"
        );
    }

    /// Each per-shell snippet must carry the BEGIN/END markers (for external
    /// dedupe), reference `tirith prompt-status --short`, guard against double-eval,
    /// and single-quote the substitution so it defers to prompt render.
    #[test]
    fn prompt_status_snippet_zsh_is_marker_wrapped_and_deferred() {
        let s = prompt_status_snippet("zsh");
        assert!(s.contains("# >>> tirith prompt-status (M8 ch6) >>>"));
        assert!(s.contains("# <<< tirith prompt-status (M8 ch6) <<<"));
        assert!(s.contains("setopt PROMPT_SUBST"));
        assert!(s.contains("_TIRITH_PROMPT_STATUS_LOADED"));
        // Single-quoted so PROMPT re-renders each redraw, AND the non-exported
        // TIRITH_STATUS is forwarded inline so the child can actually read it
        // (a bare `tirith prompt-status` child sees a non-exported var as unset).
        assert!(s.contains("/opt/Tirith Bin/tirith"));
        assert!(!s.contains(" tirith prompt-status --short"));
    }

    #[test]
    fn prompt_status_snippet_bash_uses_ps1_with_single_quoted_subst() {
        let s = prompt_status_snippet("bash");
        assert!(s.contains("/opt/Tirith Bin/tirith"));
        assert!(!s.contains(" tirith prompt-status --short"));
        assert!(s.contains("_TIRITH_PROMPT_STATUS_LOADED"));
        assert!(s.contains("# >>> tirith prompt-status (M8 ch6) >>>"));
        assert!(s.contains("# <<< tirith prompt-status (M8 ch6) <<<"));
    }

    #[test]
    fn prompt_status_snippet_fish_wraps_right_prompt() {
        let s = prompt_status_snippet("fish");
        assert!(s.contains("function fish_right_prompt"));
        // Forwards the non-exported TIRITH_STATUS via `env` so the child sees it.
        assert!(s.contains("'/opt/Tirith Bin/tirith' prompt-status --short"));
        assert!(s.contains("_TIRITH_PROMPT_STATUS_LOADED"));
    }

    #[test]
    fn prompt_status_snippet_powershell_forwards_status_env() {
        let s = prompt_status_snippet("powershell");
        // PowerShell stores $global:TIRITH_STATUS (a PS variable, NOT $env:), which
        // a child process cannot see — forward it via $env: for the call, restored
        // in `finally` so it does not leak into the session.
        assert!(s.contains("$env:TIRITH_STATUS = $global:TIRITH_STATUS"));
        assert!(s.contains("finally"));
        assert!(s.contains("_TIRITH_PROMPT_STATUS_LOADED"));
    }

    #[test]
    fn prompt_status_snippet_powershell_wraps_prompt_function() {
        for shell in ["powershell", "pwsh"] {
            let s = prompt_status_snippet(shell);
            assert!(s.contains("function global:prompt"), "shell={shell}");
            assert!(
                s.contains("'/opt/Tirith Bin/tirith' prompt-status --short"),
                "shell={shell}"
            );
            assert!(s.contains("$global:_TIRITH_PROMPT_STATUS_LOADED"));
        }
    }

    #[test]
    fn prompt_status_snippet_quotes_an_executable_with_a_single_quote() {
        let executable = Path::new("/opt/Tirith's Bin/tirith");
        for shell in ["zsh", "bash", "fish", "powershell"] {
            let snippet = prompt_status_snippet_for(shell, executable);
            assert!(snippet.contains("Tirith"), "shell={shell}: {snippet}");
            assert!(!snippet.contains(" tirith prompt-status --short"));
        }
    }

    #[test]
    fn prompt_status_snippet_nushell_explains_no_live_status() {
        let s = prompt_status_snippet("nushell");
        // Nushell exposes no non-exported TIRITH_STATUS, so the snippet must be an
        // HONEST explanation (warn-only, no live status), NOT a prompt-status
        // command that would always render `off`.
        assert!(s.contains("warn-only"));
        assert!(s.contains("docs/prompt-status.md"));
        // Must NOT hand the user runnable prompt wiring that would render `off`.
        // (The `# >>> tirith prompt-status` MARKER legitimately names the command;
        // we guard against the old `$env.PROMPT_COMMAND` closure instead.)
        assert!(
            !s.contains("PROMPT_COMMAND"),
            "nushell snippet must not suggest a runnable prompt closure (always reads off); got: {s}"
        );
    }

    #[test]
    fn materialized_hooks_require_and_repair_exact_asset_and_version_bytes() {
        let data_dir = tempfile::tempdir().unwrap();
        let (shell_dir, wrote) = materialize_hooks_at(data_dir.path()).unwrap();
        assert!(wrote);
        assert_eq!(
            std::fs::read(shell_dir.join("tirith.sh")).unwrap(),
            crate::assets::TIRITH_SH.as_bytes()
        );
        assert_eq!(
            std::fs::read(shell_dir.join("lib/zsh-hook.zsh")).unwrap(),
            crate::assets::ZSH_HOOK.as_bytes()
        );
        assert_eq!(
            std::fs::read(shell_dir.join("lib/bash-hook.bash")).unwrap(),
            crate::assets::BASH_HOOK.as_bytes()
        );
        assert_eq!(
            std::fs::read(shell_dir.join("lib/fish-hook.fish")).unwrap(),
            crate::assets::FISH_HOOK.as_bytes()
        );
        assert_eq!(
            std::fs::read(shell_dir.join("lib/powershell-hook.ps1")).unwrap(),
            crate::assets::POWERSHELL_HOOK.as_bytes()
        );
        assert_eq!(
            std::fs::read(shell_dir.join("lib/nushell-hook.nu")).unwrap(),
            crate::assets::NUSHELL_HOOK.as_bytes()
        );
        assert_eq!(
            std::fs::read(shell_dir.join(".hooks-version")).unwrap(),
            format!("{}\n", env!("CARGO_PKG_VERSION")).as_bytes()
        );
        assert!(materialized_hooks_match_at(data_dir.path()).unwrap());

        std::fs::write(shell_dir.join("lib/zsh-hook.zsh"), b"tampered\n").unwrap();
        std::fs::write(
            shell_dir.join(".hooks-version"),
            format!("{}\n", env!("CARGO_PKG_VERSION")),
        )
        .unwrap();
        assert!(!materialized_hooks_match_at(data_dir.path()).unwrap());
        let (_, repaired) = materialize_hooks_at(data_dir.path()).unwrap();
        assert!(repaired);
        assert_eq!(
            std::fs::read(shell_dir.join("lib/zsh-hook.zsh")).unwrap(),
            crate::assets::ZSH_HOOK.as_bytes()
        );

        std::fs::write(shell_dir.join(".hooks-version"), env!("CARGO_PKG_VERSION")).unwrap();
        assert!(!materialized_hooks_match_at(data_dir.path()).unwrap());
        let (_, repaired_version) = materialize_hooks_at(data_dir.path()).unwrap();
        assert!(repaired_version);
        assert_eq!(
            std::fs::read(shell_dir.join(".hooks-version")).unwrap(),
            format!("{}\n", env!("CARGO_PKG_VERSION")).as_bytes()
        );
        let (_, rewrote_current_bundle) = materialize_hooks_at(data_dir.path()).unwrap();
        assert!(!rewrote_current_bundle);
    }

    #[cfg(unix)]
    #[test]
    fn materialized_hooks_reject_symlinked_lib_directory_without_external_write() {
        use std::os::unix::fs::symlink;

        let data_dir = tempfile::tempdir().unwrap();
        let outside = tempfile::tempdir().unwrap();
        let shell_dir = data_dir.path().join("shell");
        std::fs::create_dir(&shell_dir).unwrap();
        symlink(outside.path(), shell_dir.join("lib")).unwrap();

        let error = materialize_hooks_at(data_dir.path()).unwrap_err();
        assert!(error.contains("could not bind materialized hook destination"));
        assert!(std::fs::read_dir(outside.path()).unwrap().next().is_none());
        assert!(!shell_dir.join("tirith.sh").exists());
    }

    #[cfg(unix)]
    #[test]
    fn materialized_hooks_reject_symlinked_leaf_without_touching_target() {
        use std::os::unix::fs::symlink;

        let data_dir = tempfile::tempdir().unwrap();
        let outside = tempfile::tempdir().unwrap();
        let sentinel = outside.path().join("sentinel");
        std::fs::write(&sentinel, b"unchanged").unwrap();
        let lib_dir = data_dir.path().join("shell/lib");
        std::fs::create_dir_all(&lib_dir).unwrap();
        symlink(&sentinel, lib_dir.join("zsh-hook.zsh")).unwrap();

        let error = materialize_hooks_at(data_dir.path()).unwrap_err();
        assert!(error.contains("could not bind materialized hook destination"));
        assert_eq!(std::fs::read(&sentinel).unwrap(), b"unchanged");
        assert!(!data_dir.path().join("shell/tirith.sh").exists());
    }

    #[test]
    fn materialized_hooks_reject_non_directory_parents_and_non_regular_leaves() {
        let file_shell_root = tempfile::tempdir().unwrap();
        std::fs::write(file_shell_root.path().join("shell"), b"not a directory").unwrap();
        let shell_error = materialize_hooks_at(file_shell_root.path()).unwrap_err();
        assert!(shell_error.contains("could not bind materialized hook destination"));

        let file_lib_root = tempfile::tempdir().unwrap();
        let shell_dir = file_lib_root.path().join("shell");
        std::fs::create_dir(&shell_dir).unwrap();
        std::fs::write(shell_dir.join("lib"), b"not a directory").unwrap();
        let lib_error = materialize_hooks_at(file_lib_root.path()).unwrap_err();
        assert!(lib_error.contains("could not bind materialized hook destination"));
        assert!(!shell_dir.join("tirith.sh").exists());

        let directory_leaf_root = tempfile::tempdir().unwrap();
        let directory_leaf = directory_leaf_root.path().join("shell/lib/zsh-hook.zsh");
        std::fs::create_dir_all(&directory_leaf).unwrap();
        let leaf_error = materialize_hooks_at(directory_leaf_root.path()).unwrap_err();
        assert!(leaf_error.contains("refusing non-regular materialized hook destination"));
        assert!(!directory_leaf_root.path().join("shell/tirith.sh").exists());
    }
}