refactor: type escaped OS strings and fix the final audit findings

Escaped config strings (ghostty_os::osbytes) kept reaching OS
boundaries undecoded, and decoding was occasionally applied to plain
text. The root cause was that both were plain `String`s. Now:
- `EncodedOs` is a newtype (no Display/AsRef<Path>) that decodes only
  via to_os/to_path/to_bytes/to_wide; plain text enters via
  from_plain_text. OS helpers (env, home, xdg, passwd, resources dir,
  path expansion), config::Path, WorkingDirectory, theme/file_load/edit
  paths, terminal pwd, OpenUrl/Pwd actions and termio cwd use it, so the
  compiler forces decoding at every boundary. os::open takes &OsStr.
  Config output is unchanged.

Fixes all rows of docs/rewrite/notes/review-rv5-codex.md (final-Z7.md):
screen-file copy; regex/OSC 8 URLs no longer decoded (regression);
lossless Windows WTF-8/WTF-16 for args, env and CreateProcessW; Windows
resources dir/TERMINFO; color OSC request lists and X11 color lookup no
longer allocate globally (C zero-allocation test extended); macOS Mach
handler resumes all threads before KERN_FAILURE (hang regression) and
SIGABRT minidumps go through the exception thread; plus open-config,
background images, crash dir, ssh cache, exe dir/PATH, fontconfig
filenames, file links, kitty TMPDIR, .hushlogin and benchmark paths.
The typing also surfaced and fixed gtk-custom-css, bell audio, bash
HISTFILE, OSC 52 writes and the C config getters.

Test Plan:
- cargo test --workspace (3376 passed)
- just check-macos (both), just check-windows, just check-wasm
- diff <(ghostty-rs +show-config --default --docs) \
  <(ghostty +show-config --default --docs)
This commit is contained in:
ddidderr committed 2026-10-12 10:06:07 +02:00
1 parent 7a3f0b0f2c
commit f7fec6f44d
92 files changed
+2967 -992

No files matched your search

+16 -24
View File
@@ -3,7 +3,7 @@
use std::ffi::CStr;
use crate::{env::getenv_not_empty, homedir, path_join};
use crate::{env::getenv_not_empty, homedir, osbytes::EncodedOs};
#[derive(Debug, Clone, Default)]
pub struct Options<'a> {
@@ -11,10 +11,10 @@ pub struct Options<'a> {
/// when building up the directory. This is commonly the application.
pub subdir: Option<&'a str>,
/// The home directory for the user. If this is not set, we will attempt
/// The home directory for the user (encoded OS string). If this is not set, we will attempt
/// to look it up which is an expensive process. By setting this, you can
/// avoid lookups.
pub home: Option<&'a str>,
pub home: Option<&'a EncodedOs>,
}
#[derive(Debug, thiserror::Error)]
@@ -28,29 +28,25 @@ pub enum Error {
}
/// Get the XDG user config directory.
pub fn config(opts: &Options<'_>) -> Result<String, Error> {
pub fn config(opts: &Options<'_>) -> Result<EncodedOs, Error> {
dir(opts, "XDG_CONFIG_HOME", ".config")
}
/// Get the XDG cache directory.
pub fn cache(opts: &Options<'_>) -> Result<String, Error> {
pub fn cache(opts: &Options<'_>) -> Result<EncodedOs, Error> {
dir(opts, "XDG_CACHE_HOME", ".cache")
}
/// Get the XDG state directory.
pub fn state(opts: &Options<'_>) -> Result<String, Error> {
pub fn state(opts: &Options<'_>) -> Result<EncodedOs, Error> {
dir(opts, "XDG_STATE_HOME", ".local/state")
}
/// Unified helper to get XDG directories that follow a common pattern.
fn dir(opts: &Options<'_>, env: &str, default_subdir: &str) -> Result<String, Error> {
fn dir(opts: &Options<'_>, env: &str, default_subdir: &str) -> Result<EncodedOs, Error> {
// If we have a cached home dir, use that.
if let Some(home) = opts.home {
return Ok(path_join(&[
home,
default_subdir,
opts.subdir.unwrap_or(""),
]));
return Ok(home.join_plain(&[default_subdir, opts.subdir.unwrap_or("")]));
}
// First check the env var. On Windows we treat `LOCALAPPDATA` as a
@@ -61,7 +57,7 @@ fn dir(opts: &Options<'_>, env: &str, default_subdir: &str) -> Result<String, Er
if let Some(env) = env_value {
// If we have a subdir, then we join it.
if let Some(subdir) = opts.subdir {
return Ok(path_join(&[&env, subdir]));
return Ok(env.join_plain(&[subdir]));
}
return Ok(env);
@@ -69,11 +65,7 @@ fn dir(opts: &Options<'_>, env: &str, default_subdir: &str) -> Result<String, Er
// Get our home dir
if let Ok(Some(home)) = homedir::home() {
return Ok(path_join(&[
&home,
default_subdir,
opts.subdir.unwrap_or(""),
]));
return Ok(home.join_plain(&[default_subdir, opts.subdir.unwrap_or("")]));
}
Err(Error::NoHomeDir)
@@ -110,7 +102,7 @@ mod tests {
#[test]
fn cache_directory_paths() {
let mock_home = "/Users/test";
let mock_home = &EncodedOs::from_plain_text("/Users/test");
// Test base path
let p = cache(&Options {
@@ -129,7 +121,7 @@ mod tests {
assert_eq!(p, "/Users/test/.cache/ghostty");
}
type DirFn = fn(&Options<'_>) -> Result<String, Error>;
type DirFn = fn(&Options<'_>) -> Result<EncodedOs, Error>;
const CASES: [(&str, DirFn, &str); 3] = [
("XDG_CONFIG_HOME", config, ".config"),
("XDG_CACHE_HOME", cache, ".cache"),
@@ -141,9 +133,9 @@ mod tests {
let temp_home = "/tmp/ghostty-test-home";
for (name, func, default_subdir) in CASES {
temp_env::with_vars([("HOME", Some(temp_home)), (name, Some(""))], || {
let expected = path_join(&[temp_home, default_subdir]);
let expected = crate::path_join(&[temp_home, default_subdir]);
let actual = func(&Options::default()).unwrap();
assert_eq!(expected, actual);
assert_eq!(actual, expected.as_str());
});
}
}
@@ -153,13 +145,13 @@ mod tests {
let temp_home = "/tmp/ghostty-test-home";
for (name, func, default_subdir) in CASES {
temp_env::with_vars([("HOME", Some(temp_home)), (name, Some(""))], || {
let expected = path_join(&[temp_home, default_subdir, "ghostty"]);
let expected = crate::path_join(&[temp_home, default_subdir, "ghostty"]);
let actual = func(&Options {
subdir: Some("ghostty"),
..Default::default()
})
.unwrap();
assert_eq!(expected, actual);
assert_eq!(actual, expected.as_str());
});
}
}