shell_env.rs

  1use std::path::Path;
  2
  3use anyhow::{Context as _, Result};
  4use collections::HashMap;
  5
  6use crate::shell::ShellKind;
  7
  8pub fn print_env() {
  9    let env_vars: HashMap<String, String> = std::env::vars().collect();
 10    let json = serde_json::to_string_pretty(&env_vars).unwrap_or_else(|err| {
 11        eprintln!("Error serializing environment variables: {}", err);
 12        std::process::exit(1);
 13    });
 14    println!("{}", json);
 15}
 16
 17/// Capture all environment variables from the login shell in the given directory.
 18pub async fn capture(
 19    shell_path: impl AsRef<Path>,
 20    args: &[String],
 21    directory: impl AsRef<Path>,
 22) -> Result<collections::HashMap<String, String>> {
 23    #[cfg(windows)]
 24    return capture_windows(shell_path.as_ref(), args, directory.as_ref()).await;
 25    #[cfg(unix)]
 26    return capture_unix(shell_path.as_ref(), args, directory.as_ref()).await;
 27}
 28
 29#[cfg(unix)]
 30async fn capture_unix(
 31    shell_path: &Path,
 32    args: &[String],
 33    directory: &Path,
 34) -> Result<collections::HashMap<String, String>> {
 35    use std::os::unix::process::CommandExt;
 36
 37    let shell_kind = ShellKind::new(shell_path, false);
 38    let zed_path = super::get_shell_safe_zed_path(shell_kind)?;
 39
 40    let mut command_string = String::new();
 41    let mut command = std::process::Command::new(shell_path);
 42    command.args(args);
 43    // In some shells, file descriptors greater than 2 cannot be used in interactive mode,
 44    // so file descriptor 0 (stdin) is used instead. This impacts zsh, old bash; perhaps others.
 45    // See: https://github.com/zed-industries/zed/pull/32136#issuecomment-2999645482
 46    const FD_STDIN: std::os::fd::RawFd = 0;
 47    const FD_STDOUT: std::os::fd::RawFd = 1;
 48    const FD_STDERR: std::os::fd::RawFd = 2;
 49
 50    let (fd_num, redir) = match shell_kind {
 51        ShellKind::Rc => (FD_STDIN, format!(">[1={}]", FD_STDIN)), // `[1=0]`
 52        ShellKind::Nushell | ShellKind::Tcsh => (FD_STDOUT, "".to_string()),
 53        // xonsh doesn't support redirecting to stdin, and control sequences are printed to
 54        // stdout on startup
 55        ShellKind::Xonsh => (FD_STDERR, "o>e".to_string()),
 56        _ => (FD_STDIN, format!(">&{}", FD_STDIN)), // `>&0`
 57    };
 58
 59    match shell_kind {
 60        ShellKind::Csh | ShellKind::Tcsh => {
 61            // For csh/tcsh, login shell requires passing `-` as 0th argument (instead of `-l`)
 62            command.arg0("-");
 63        }
 64        ShellKind::Fish => {
 65            // in fish, asdf, direnv attach to the `fish_prompt` event
 66            command_string.push_str("emit fish_prompt;");
 67            command.arg("-l");
 68        }
 69        _ => {
 70            command.arg("-l");
 71        }
 72    }
 73    // cd into the directory, triggering directory specific side-effects (asdf, direnv, etc)
 74    command_string.push_str(&format!("cd '{}';", directory.display()));
 75    if let Some(prefix) = shell_kind.command_prefix() {
 76        command_string.push(prefix);
 77    }
 78    command_string.push_str(&format!("{} --printenv {}", zed_path, redir));
 79    command.args(["-i", "-c", &command_string]);
 80
 81    super::set_pre_exec_to_start_new_session(&mut command);
 82
 83    let (env_output, process_output) = spawn_and_read_fd(command, fd_num).await?;
 84    let env_output = String::from_utf8_lossy(&env_output);
 85
 86    anyhow::ensure!(
 87        process_output.status.success(),
 88        "login shell exited with {}. stdout: {:?}, stderr: {:?}",
 89        process_output.status,
 90        String::from_utf8_lossy(&process_output.stdout),
 91        String::from_utf8_lossy(&process_output.stderr),
 92    );
 93
 94    // Parse the JSON output from zed --printenv
 95    let env_map: collections::HashMap<String, String> = serde_json::from_str(&env_output)
 96        .with_context(|| "Failed to deserialize environment variables from json: {env_output}")?;
 97    Ok(env_map)
 98}
 99
100#[cfg(unix)]
101async fn spawn_and_read_fd(
102    mut command: std::process::Command,
103    child_fd: std::os::fd::RawFd,
104) -> anyhow::Result<(Vec<u8>, std::process::Output)> {
105    use command_fds::{CommandFdExt, FdMapping};
106    use std::{io::Read, process::Stdio};
107
108    let (mut reader, writer) = std::io::pipe()?;
109
110    command.fd_mappings(vec![FdMapping {
111        parent_fd: writer.into(),
112        child_fd,
113    }])?;
114
115    let process = smol::process::Command::from(command)
116        .stdin(Stdio::null())
117        .stdout(Stdio::piped())
118        .stderr(Stdio::piped())
119        .spawn()?;
120
121    let mut buffer = Vec::new();
122    reader.read_to_end(&mut buffer)?;
123
124    Ok((buffer, process.output().await?))
125}
126
127#[cfg(windows)]
128async fn capture_windows(
129    shell_path: &Path,
130    _args: &[String],
131    directory: &Path,
132) -> Result<collections::HashMap<String, String>> {
133    use std::process::Stdio;
134
135    let zed_path =
136        std::env::current_exe().context("Failed to determine current zed executable path.")?;
137
138    let shell_kind = ShellKind::new(shell_path, true);
139    if let ShellKind::Posix
140    | ShellKind::Csh
141    | ShellKind::Tcsh
142    | ShellKind::Rc
143    | ShellKind::Fish
144    | ShellKind::Xonsh = shell_kind
145    {
146        return Err(anyhow::anyhow!("unsupported shell kind"));
147    }
148    let mut cmd = crate::command::new_smol_command(shell_path);
149    let cmd = match shell_kind {
150        ShellKind::Posix
151        | ShellKind::Csh
152        | ShellKind::Tcsh
153        | ShellKind::Rc
154        | ShellKind::Fish
155        | ShellKind::Xonsh => {
156            unreachable!()
157        }
158        ShellKind::PowerShell => cmd.args([
159            "-NonInteractive",
160            "-NoProfile",
161            "-Command",
162            &format!(
163                "Set-Location '{}'; & '{}' --printenv",
164                directory.display(),
165                zed_path.display()
166            ),
167        ]),
168        ShellKind::Elvish => cmd.args([
169            "-c",
170            &format!(
171                "cd '{}'; {} --printenv",
172                directory.display(),
173                zed_path.display()
174            ),
175        ]),
176        ShellKind::Nushell => cmd.args([
177            "-c",
178            &format!(
179                "cd '{}'; {}'{}' --printenv",
180                directory.display(),
181                shell_kind
182                    .command_prefix()
183                    .map(|prefix| prefix.to_string())
184                    .unwrap_or_default(),
185                zed_path.display()
186            ),
187        ]),
188        ShellKind::Cmd => cmd.args([
189            "/c",
190            "cd",
191            &directory.display().to_string(),
192            "&&",
193            &zed_path.display().to_string(),
194            "--printenv",
195        ]),
196    }
197    .stdin(Stdio::null())
198    .stdout(Stdio::piped())
199    .stderr(Stdio::piped());
200    let output = cmd
201        .output()
202        .await
203        .with_context(|| format!("command {cmd:?}"))?;
204    anyhow::ensure!(
205        output.status.success(),
206        "Command {cmd:?} failed with {}. stdout: {:?}, stderr: {:?}",
207        output.status,
208        String::from_utf8_lossy(&output.stdout),
209        String::from_utf8_lossy(&output.stderr),
210    );
211    let env_output = String::from_utf8_lossy(&output.stdout);
212
213    // Parse the JSON output from zed --printenv
214    serde_json::from_str(&env_output)
215        .with_context(|| "Failed to deserialize environment variables from json: {env_output}")
216}