use std::collections::BTreeSet; use std::{path::PathBuf, sync::Arc, time::Duration}; use anyhow::{Context as _, Result, anyhow}; use auto_update::AutoUpdater; use editor::Editor; use extension_host::ExtensionStore; use futures::channel::oneshot; use gpui::{ Animation, AnimationExt, AnyWindowHandle, App, AsyncApp, DismissEvent, Entity, EventEmitter, Focusable, FontFeatures, ParentElement as _, PromptLevel, Render, SemanticVersion, SharedString, Task, TextStyleRefinement, Transformation, WeakEntity, percentage, }; use language::CursorShape; use markdown::{Markdown, MarkdownElement, MarkdownStyle}; use release_channel::ReleaseChannel; use remote::ssh_session::{ConnectionIdentifier, SshPortForwardOption}; use remote::{SshConnectionOptions, SshPlatform, SshRemoteClient}; use schemars::JsonSchema; use serde::{Deserialize, Serialize}; use settings::{Settings, SettingsSources}; use theme::ThemeSettings; use ui::{ ActiveTheme, Color, Context, Icon, IconName, IconSize, InteractiveElement, IntoElement, Label, LabelCommon, Styled, Window, prelude::*, }; use workspace::{AppState, ModalView, Workspace}; #[derive(Deserialize)] pub struct SshSettings { pub ssh_connections: Option>, } impl SshSettings { pub fn ssh_connections(&self) -> impl Iterator + use<> { self.ssh_connections.clone().into_iter().flatten() } pub fn connection_options_for( &self, host: String, port: Option, username: Option, ) -> SshConnectionOptions { for conn in self.ssh_connections() { if conn.host == host && conn.username == username && conn.port == port { return SshConnectionOptions { nickname: conn.nickname, upload_binary_over_ssh: conn.upload_binary_over_ssh.unwrap_or_default(), args: Some(conn.args), host, port, username, port_forwards: conn.port_forwards, password: None, }; } } SshConnectionOptions { host, port, username, ..Default::default() } } } #[derive(Clone, Default, Serialize, Deserialize, PartialEq, JsonSchema)] pub struct SshConnection { pub host: SharedString, #[serde(skip_serializing_if = "Option::is_none")] pub username: Option, #[serde(skip_serializing_if = "Option::is_none")] pub port: Option, #[serde(skip_serializing_if = "Vec::is_empty")] #[serde(default)] pub args: Vec, #[serde(default)] pub projects: BTreeSet, /// Name to use for this server in UI. #[serde(skip_serializing_if = "Option::is_none")] pub nickname: Option, // By default Zed will download the binary to the host directly. // If this is set to true, Zed will download the binary to your local machine, // and then upload it over the SSH connection. Useful if your SSH server has // limited outbound internet access. #[serde(skip_serializing_if = "Option::is_none")] pub upload_binary_over_ssh: Option, #[serde(skip_serializing_if = "Option::is_none")] pub port_forwards: Option>, } impl From for SshConnectionOptions { fn from(val: SshConnection) -> Self { SshConnectionOptions { host: val.host.into(), username: val.username, port: val.port, password: None, args: Some(val.args), nickname: val.nickname, upload_binary_over_ssh: val.upload_binary_over_ssh.unwrap_or_default(), port_forwards: val.port_forwards, } } } #[derive(Clone, Default, Serialize, PartialEq, Eq, PartialOrd, Ord, Deserialize, JsonSchema)] pub struct SshProject { pub paths: Vec, } #[derive(Clone, Default, Serialize, Deserialize, JsonSchema)] pub struct RemoteSettingsContent { pub ssh_connections: Option>, } impl Settings for SshSettings { const KEY: Option<&'static str> = None; type FileContent = RemoteSettingsContent; fn load(sources: SettingsSources, _: &mut App) -> Result { sources.json_merge() } fn import_from_vscode(_vscode: &settings::VsCodeSettings, _current: &mut Self::FileContent) {} } pub struct SshPrompt { connection_string: SharedString, nickname: Option, status_message: Option, prompt: Option<(Entity, oneshot::Sender)>, cancellation: Option>, editor: Entity, } impl Drop for SshPrompt { fn drop(&mut self) { if let Some(cancel) = self.cancellation.take() { cancel.send(()).ok(); } } } pub struct SshConnectionModal { pub(crate) prompt: Entity, paths: Vec, finished: bool, } impl SshPrompt { pub(crate) fn new( connection_options: &SshConnectionOptions, window: &mut Window, cx: &mut Context, ) -> Self { let connection_string = connection_options.connection_string().into(); let nickname = connection_options.nickname.clone().map(|s| s.into()); Self { connection_string, nickname, editor: cx.new(|cx| Editor::single_line(window, cx)), status_message: None, cancellation: None, prompt: None, } } pub fn set_cancellation_tx(&mut self, tx: oneshot::Sender<()>) { self.cancellation = Some(tx); } pub fn set_prompt( &mut self, prompt: String, tx: oneshot::Sender, window: &mut Window, cx: &mut Context, ) { let theme = ThemeSettings::get_global(cx); let refinement = TextStyleRefinement { font_family: Some(theme.buffer_font.family.clone()), font_features: Some(FontFeatures::disable_ligatures()), font_size: Some(theme.buffer_font_size(cx).into()), color: Some(cx.theme().colors().editor_foreground), background_color: Some(gpui::transparent_black()), ..Default::default() }; self.editor.update(cx, |editor, cx| { if prompt.contains("yes/no") { editor.set_masked(false, cx); } else { editor.set_masked(true, cx); } editor.set_text_style_refinement(refinement); editor.set_cursor_shape(CursorShape::Block, cx); }); let markdown = cx.new(|cx| Markdown::new_text(prompt.into(), cx)); self.prompt = Some((markdown, tx)); self.status_message.take(); window.focus(&self.editor.focus_handle(cx)); cx.notify(); } pub fn set_status(&mut self, status: Option, cx: &mut Context) { self.status_message = status.map(|s| s.into()); cx.notify(); } pub fn confirm(&mut self, window: &mut Window, cx: &mut Context) { if let Some((_, tx)) = self.prompt.take() { self.status_message = Some("Connecting".into()); self.editor.update(cx, |editor, cx| { tx.send(editor.text(cx)).ok(); editor.clear(window, cx); }); } } } impl Render for SshPrompt { fn render(&mut self, window: &mut Window, cx: &mut Context) -> impl IntoElement { let theme = ThemeSettings::get_global(cx); let mut text_style = window.text_style(); let refinement = TextStyleRefinement { font_family: Some(theme.buffer_font.family.clone()), font_features: Some(FontFeatures::disable_ligatures()), font_size: Some(theme.buffer_font_size(cx).into()), color: Some(cx.theme().colors().editor_foreground), background_color: Some(gpui::transparent_black()), ..Default::default() }; text_style.refine(&refinement); let markdown_style = MarkdownStyle { base_text_style: text_style, selection_background_color: cx.theme().players().local().selection, ..Default::default() }; v_flex() .key_context("PasswordPrompt") .py_2() .px_3() .size_full() .text_buffer(cx) .when_some(self.status_message.clone(), |el, status_message| { el.child( h_flex() .gap_1() .child( Icon::new(IconName::ArrowCircle) .size(IconSize::Medium) .with_animation( "arrow-circle", Animation::new(Duration::from_secs(2)).repeat(), |icon, delta| { icon.transform(Transformation::rotate(percentage(delta))) }, ), ) .child( div() .text_ellipsis() .overflow_x_hidden() .child(format!("{}…", status_message)), ), ) }) .when_some(self.prompt.as_ref(), |el, prompt| { el.child( div() .size_full() .overflow_hidden() .child(MarkdownElement::new(prompt.0.clone(), markdown_style)) .child(self.editor.clone()), ) }) } } impl SshConnectionModal { pub(crate) fn new( connection_options: &SshConnectionOptions, paths: Vec, window: &mut Window, cx: &mut Context, ) -> Self { Self { prompt: cx.new(|cx| SshPrompt::new(connection_options, window, cx)), finished: false, paths, } } fn confirm(&mut self, _: &menu::Confirm, window: &mut Window, cx: &mut Context) { self.prompt .update(cx, |prompt, cx| prompt.confirm(window, cx)) } pub fn finished(&mut self, cx: &mut Context) { self.finished = true; cx.emit(DismissEvent); } fn dismiss(&mut self, _: &menu::Cancel, _: &mut Window, cx: &mut Context) { if let Some(tx) = self .prompt .update(cx, |prompt, _cx| prompt.cancellation.take()) { tx.send(()).ok(); } self.finished(cx); } } pub(crate) struct SshConnectionHeader { pub(crate) connection_string: SharedString, pub(crate) paths: Vec, pub(crate) nickname: Option, } impl RenderOnce for SshConnectionHeader { fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement { let theme = cx.theme(); let mut header_color = theme.colors().text; header_color.fade_out(0.96); let (main_label, meta_label) = if let Some(nickname) = self.nickname { (nickname, Some(format!("({})", self.connection_string))) } else { (self.connection_string, None) }; h_flex() .px(DynamicSpacing::Base12.rems(cx)) .pt(DynamicSpacing::Base08.rems(cx)) .pb(DynamicSpacing::Base04.rems(cx)) .rounded_t_sm() .w_full() .gap_1p5() .child(Icon::new(IconName::Server).size(IconSize::XSmall)) .child( h_flex() .gap_1() .overflow_x_hidden() .child( div() .max_w_96() .overflow_x_hidden() .text_ellipsis() .child(Headline::new(main_label).size(HeadlineSize::XSmall)), ) .children( meta_label.map(|label| { Label::new(label).color(Color::Muted).size(LabelSize::Small) }), ) .child(div().overflow_x_hidden().text_ellipsis().children( self.paths.into_iter().map(|path| { Label::new(path.to_string_lossy().to_string()) .size(LabelSize::Small) .color(Color::Muted) }), )), ) } } impl Render for SshConnectionModal { fn render(&mut self, window: &mut Window, cx: &mut Context) -> impl ui::IntoElement { let nickname = self.prompt.read(cx).nickname.clone(); let connection_string = self.prompt.read(cx).connection_string.clone(); let theme = cx.theme().clone(); let body_color = theme.colors().editor_background; v_flex() .elevation_3(cx) .w(rems(34.)) .border_1() .border_color(theme.colors().border) .key_context("SshConnectionModal") .track_focus(&self.focus_handle(cx)) .on_action(cx.listener(Self::dismiss)) .on_action(cx.listener(Self::confirm)) .child( SshConnectionHeader { paths: self.paths.clone(), connection_string, nickname, } .render(window, cx), ) .child( div() .w_full() .rounded_b_lg() .bg(body_color) .border_t_1() .border_color(theme.colors().border_variant) .child(self.prompt.clone()), ) } } impl Focusable for SshConnectionModal { fn focus_handle(&self, cx: &gpui::App) -> gpui::FocusHandle { self.prompt.read(cx).editor.focus_handle(cx) } } impl EventEmitter for SshConnectionModal {} impl ModalView for SshConnectionModal { fn on_before_dismiss( &mut self, _window: &mut Window, _: &mut Context, ) -> workspace::DismissDecision { return workspace::DismissDecision::Dismiss(self.finished); } fn fade_out_background(&self) -> bool { true } } #[derive(Clone)] pub struct SshClientDelegate { window: AnyWindowHandle, ui: WeakEntity, known_password: Option, } impl remote::SshClientDelegate for SshClientDelegate { fn ask_password(&self, prompt: String, tx: oneshot::Sender, cx: &mut AsyncApp) { let mut known_password = self.known_password.clone(); if let Some(password) = known_password.take() { tx.send(password).ok(); } else { self.window .update(cx, |_, window, cx| { self.ui.update(cx, |modal, cx| { modal.set_prompt(prompt, tx, window, cx); }) }) .ok(); } } fn set_status(&self, status: Option<&str>, cx: &mut AsyncApp) { self.update_status(status, cx) } fn download_server_binary_locally( &self, platform: SshPlatform, release_channel: ReleaseChannel, version: Option, cx: &mut AsyncApp, ) -> Task> { cx.spawn(async move |cx| { let binary_path = AutoUpdater::download_remote_server_release( platform.os, platform.arch, release_channel, version, cx, ) .await .map_err(|e| { anyhow!( "Failed to download remote server binary (version: {}, os: {}, arch: {}): {}", version .map(|v| format!("{}", v)) .unwrap_or("unknown".to_string()), platform.os, platform.arch, e ) })?; Ok(binary_path) }) } fn get_download_params( &self, platform: SshPlatform, release_channel: ReleaseChannel, version: Option, cx: &mut AsyncApp, ) -> Task>> { cx.spawn(async move |cx| { AutoUpdater::get_remote_server_release_url( platform.os, platform.arch, release_channel, version, cx, ) .await }) } } impl SshClientDelegate { fn update_status(&self, status: Option<&str>, cx: &mut AsyncApp) { self.window .update(cx, |_, _, cx| { self.ui.update(cx, |modal, cx| { modal.set_status(status.map(|s| s.to_string()), cx); }) }) .ok(); } } pub fn is_connecting_over_ssh(workspace: &Workspace, cx: &App) -> bool { workspace.active_modal::(cx).is_some() } pub fn connect_over_ssh( unique_identifier: ConnectionIdentifier, connection_options: SshConnectionOptions, ui: Entity, window: &mut Window, cx: &mut App, ) -> Task>>> { let window = window.window_handle(); let known_password = connection_options.password.clone(); let (tx, rx) = oneshot::channel(); ui.update(cx, |ui, _cx| ui.set_cancellation_tx(tx)); remote::SshRemoteClient::new( unique_identifier, connection_options, rx, Arc::new(SshClientDelegate { window, ui: ui.downgrade(), known_password, }), cx, ) } pub async fn open_ssh_project( connection_options: SshConnectionOptions, paths: Vec, app_state: Arc, open_options: workspace::OpenOptions, cx: &mut AsyncApp, ) -> Result<()> { let window = if let Some(window) = open_options.replace_window { window } else { let workspace_position = cx .update(|cx| { workspace::ssh_workspace_position_from_db( connection_options.host.clone(), connection_options.port, connection_options.username.clone(), &paths, cx, ) })? .await .context("fetching ssh workspace position from db")?; let mut options = cx.update(|cx| (app_state.build_window_options)(workspace_position.display, cx))?; options.window_bounds = workspace_position.window_bounds; cx.open_window(options, |window, cx| { let project = project::Project::local( app_state.client.clone(), app_state.node_runtime.clone(), app_state.user_store.clone(), app_state.languages.clone(), app_state.fs.clone(), None, cx, ); cx.new(|cx| { let mut workspace = Workspace::new(None, project, app_state.clone(), window, cx); workspace.centered_layout = workspace_position.centered_layout; workspace }) })? }; loop { let (cancel_tx, cancel_rx) = oneshot::channel(); let delegate = window.update(cx, { let connection_options = connection_options.clone(); let paths = paths.clone(); move |workspace, window, cx| { window.activate_window(); workspace.toggle_modal(window, cx, |window, cx| { SshConnectionModal::new(&connection_options, paths, window, cx) }); let ui = workspace .active_modal::(cx)? .read(cx) .prompt .clone(); ui.update(cx, |ui, _cx| { ui.set_cancellation_tx(cancel_tx); }); Some(Arc::new(SshClientDelegate { window: window.window_handle(), ui: ui.downgrade(), known_password: connection_options.password.clone(), })) } })?; let Some(delegate) = delegate else { break }; let did_open_ssh_project = cx .update(|cx| { workspace::open_ssh_project_with_new_connection( window, connection_options.clone(), cancel_rx, delegate.clone(), app_state.clone(), paths.clone(), cx, ) })? .await; window .update(cx, |workspace, _, cx| { if let Some(ui) = workspace.active_modal::(cx) { ui.update(cx, |modal, cx| modal.finished(cx)) } }) .ok(); if let Err(e) = did_open_ssh_project { log::error!("Failed to open project: {e:?}"); let response = window .update(cx, |_, window, cx| { window.prompt( PromptLevel::Critical, "Failed to connect over SSH", Some(&e.to_string()), &["Retry", "Ok"], cx, ) })? .await; if response == Ok(0) { continue; } } window .update(cx, |workspace, _, cx| { if let Some(client) = workspace.project().read(cx).ssh_client().clone() { ExtensionStore::global(cx) .update(cx, |store, cx| store.register_ssh_client(client, cx)); } }) .ok(); break; } // Already showed the error to the user Ok(()) }