wez/wezterm
1
1
Fork 0
mirror of https://github.com/wez/wezterm.git synced 2024-12-23 13:21:38 +03:00
Code Issues Projects Releases Wiki Activity

ssh: introduce separate Dir and DirWrap types

Browse Source
This commit is contained in:
Wez Furlong 2021-10-18 23:35:45 -07:00
parent 9d44cc1720
commit e3f5174dcc
9 changed files with 204 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
wezterm-ssh/src/dirwrap.rs Normal file
View File

@ -0,0 +1,26 @@
use crate::sftp::types::Metadata;
use crate::sftp::{SftpChannelError, SftpChannelResult};
use camino::Utf8PathBuf;
use std::convert::TryFrom;
pub(crate) enum DirWrap {
Ssh2(ssh2::File),
}
impl DirWrap {
pub fn read_dir(&mut self) -> SftpChannelResult<(Utf8PathBuf, Metadata)> {
match self {
Self::Ssh2(file) => {
file.readdir()
.map_err(SftpChannelError::from)
.and_then(|(path, stat)| match Utf8PathBuf::try_from(path) {
Ok(path) => Ok((path, Metadata::from(stat))),
Err(x) => Err(SftpChannelError::from(std::io::Error::new(
std::io::ErrorKind::InvalidData,
x,
))),
})
}
}
}
}

21
wezterm-ssh/src/filewrap.rs
View File

@ -1,6 +1,5 @@
use crate::sftp::{Metadata, SftpChannelError, SftpChannelResult};
use camino::Utf8PathBuf;
use std::convert::TryFrom;
use crate::sftp::types::Metadata;
use crate::sftp::{SftpChannelError, SftpChannelResult};
pub(crate) enum FileWrap {
Ssh2(ssh2::File),
@ -36,22 +35,6 @@ impl FileWrap {
}
}
pub fn read_dir(&mut self) -> SftpChannelResult<(Utf8PathBuf, Metadata)> {
match self {
Self::Ssh2(file) => {
file.readdir()
.map_err(SftpChannelError::from)
.and_then(|(path, stat)| match Utf8PathBuf::try_from(path) {
Ok(path) => Ok((path, Metadata::from(stat))),
Err(x) => Err(SftpChannelError::from(std::io::Error::new(
std::io::ErrorKind::InvalidData,
x,
))),
})
}
}
}
pub fn fsync(&mut self) -> SftpChannelResult<()> {
match self {
Self::Ssh2(file) => file.fsync().map_err(SftpChannelError::from),

3
wezterm-ssh/src/lib.rs
View File

@ -1,6 +1,7 @@
mod auth;
mod channelwrap;
mod config;
mod dirwrap;
mod filewrap;
mod host;
mod pty;
@ -15,6 +16,8 @@ pub use config::*;
pub use host::*;
pub use pty::*;
pub use session::*;
pub use sftp::error::*;
pub use sftp::types::*;
pub use sftp::*;
// NOTE: Re-exported as is exposed in a public API of this crate

1
wezterm-ssh/src/session.rs
View File

@ -97,6 +97,7 @@ impl Session {
rx_req,
channels: HashMap::new(),
files: HashMap::new(),
dirs: HashMap::new(),
next_channel_id: 1,
next_file_id: 1,
sender_read,

130
wezterm-ssh/src/sessioninner.rs
View File

@ -1,11 +1,19 @@
use crate::channelwrap::ChannelWrap;
use crate::config::ConfigMap;
use crate::dirwrap::DirWrap;
use crate::filewrap::FileWrap;
use crate::pty::*;
use crate::session::{Exec, ExecResult, SessionEvent, SessionRequest, SignalChannel};
use crate::sessionwrap::SessionWrap;
use crate::sftp::dir::{CloseDir, Dir, DirId, DirRequest, ReadDirHandle};
use crate::sftp::file::{
CloseFile, File, FileId, FileRequest, FlushFile, FsyncFile, MetadataFile, ReadFile,
SetMetadataFile, WriteFile,
};
use crate::sftp::{
self, File, FileId, FileRequest, SftpChannelError, SftpChannelResult, SftpRequest,
Canonicalize, CreateDir, GetMetadata, OpenDir, OpenWithMode, ReadDir, ReadLink, RemoveDir,
RemoveFile, Rename, SetMetadata, SftpChannelError, SftpChannelResult, SftpRequest, Symlink,
SymlinkMetadata,
};
use crate::sftpwrap::SftpWrap;
use anyhow::{anyhow, Context};
@ -41,6 +49,7 @@ pub(crate) struct SessionInner {
pub rx_req: Receiver<SessionRequest>,
pub channels: HashMap<ChannelId, ChannelInfo>,
pub files: HashMap<FileId, FileWrap>,
pub dirs: HashMap<DirId, DirWrap>,
pub next_channel_id: ChannelId,
pub next_file_id: FileId,
pub sender_read: FileDescriptor,
@ -443,6 +452,12 @@ impl SessionInner {
}
Ok(true)
}
SessionRequest::Sftp(SftpRequest::Dir(DirRequest::Close(msg))) => {
if let Err(err) = self.close_dir(sess, &msg) {
log::error!("{:?} -> error: {:#}", msg, err);
}
Ok(true)
}
SessionRequest::Sftp(SftpRequest::File(FileRequest::Flush(msg))) => {
if let Err(err) = self.flush_file(sess, &msg) {
log::error!("{:?} -> error: {:#}", msg, err);
@ -461,8 +476,8 @@ impl SessionInner {
}
Ok(true)
}
SessionRequest::Sftp(SftpRequest::File(FileRequest::ReadDir(msg))) => {
if let Err(err) = self.read_dir_file(sess, &msg) {
SessionRequest::Sftp(SftpRequest::Dir(DirRequest::ReadDir(msg))) => {
if let Err(err) = self.read_dir_handle(sess, &msg) {
log::error!("{:?} -> error: {:#}", msg, err);
}
Ok(true)
@ -634,7 +649,7 @@ impl SessionInner {
pub fn open_with_mode(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::OpenWithMode,
msg: &OpenWithMode,
) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
@ -642,7 +657,11 @@ impl SessionInner {
match result {
Ok(ssh_file) => {
let (file_id, file) = self.make_file();
let file_id = self.next_file_id;
self.next_file_id += 1;
let file = File::new(file_id);
msg.reply.try_send(Ok(file))?;
self.files.insert(file_id, ssh_file);
}
@ -653,16 +672,20 @@ impl SessionInner {
}
/// Helper to open a directory for reading its contents.
pub fn open_dir(&mut self, sess: &mut SessionWrap, msg: &sftp::OpenDir) -> anyhow::Result<()> {
pub fn open_dir(&mut self, sess: &mut SessionWrap, msg: &OpenDir) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
.and_then(|sftp| sftp.open_dir(&msg.filename));
match result {
Ok(ssh_file) => {
let (file_id, file) = self.make_file();
msg.reply.try_send(Ok(file))?;
self.files.insert(file_id, ssh_file);
let dir_id = self.next_file_id;
self.next_file_id += 1;
let dir = Dir::new(dir_id);
msg.reply.try_send(Ok(dir))?;
self.dirs.insert(dir_id, ssh_file);
}
Err(x) => msg.reply.try_send(Err(x))?,
}
@ -670,17 +693,9 @@ impl SessionInner {
Ok(())
}
fn make_file(&mut self) -> (FileId, File) {
let file_id = self.next_file_id;
self.next_file_id += 1;
let file = File::new(file_id);
(file_id, file)
}
/// Writes to a loaded file.
fn write_file(&mut self, _sess: &mut SessionWrap, msg: &sftp::WriteFile) -> anyhow::Result<()> {
let sftp::WriteFile {
fn write_file(&mut self, _sess: &mut SessionWrap, msg: &WriteFile) -> anyhow::Result<()> {
let WriteFile {
file_id,
data,
reply,
@ -698,8 +713,8 @@ impl SessionInner {
}
/// Reads from a loaded file.
fn read_file(&mut self, _sess: &mut SessionWrap, msg: &sftp::ReadFile) -> anyhow::Result<()> {
let sftp::ReadFile {
fn read_file(&mut self, _sess: &mut SessionWrap, msg: &ReadFile) -> anyhow::Result<()> {
let ReadFile {
file_id,
max_bytes,
reply,
@ -720,8 +735,15 @@ impl SessionInner {
Ok(())
}
fn close_dir(&mut self, _sess: &mut SessionWrap, msg: &CloseDir) -> anyhow::Result<()> {
self.dirs.remove(&msg.dir_id);
msg.reply.try_send(Ok(()))?;
Ok(())
}
/// Closes a file and removes it from the internal memory.
fn close_file(&mut self, _sess: &mut SessionWrap, msg: &sftp::CloseFile) -> anyhow::Result<()> {
fn close_file(&mut self, _sess: &mut SessionWrap, msg: &CloseFile) -> anyhow::Result<()> {
self.files.remove(&msg.file_id);
msg.reply.try_send(Ok(()))?;
@ -729,7 +751,7 @@ impl SessionInner {
}
/// Flushes a file.
fn flush_file(&mut self, _sess: &mut SessionWrap, msg: &sftp::FlushFile) -> anyhow::Result<()> {
fn flush_file(&mut self, _sess: &mut SessionWrap, msg: &FlushFile) -> anyhow::Result<()> {
if let Some(file) = self.files.get_mut(&msg.file_id) {
let result = file.writer().flush().map_err(SftpChannelError::from);
msg.reply.try_send(result)?;
@ -742,9 +764,9 @@ impl SessionInner {
fn set_metadata_file(
&mut self,
_sess: &mut SessionWrap,
msg: &sftp::SetMetadataFile,
msg: &SetMetadataFile,
) -> anyhow::Result<()> {
let sftp::SetMetadataFile {
let SetMetadataFile {
file_id,
metadata,
reply,
@ -759,11 +781,7 @@ impl SessionInner {
}
/// Gets file stat.
fn metadata_file(
&mut self,
_sess: &mut SessionWrap,
msg: &sftp::MetadataFile,
) -> anyhow::Result<()> {
fn metadata_file(&mut self, _sess: &mut SessionWrap, msg: &MetadataFile) -> anyhow::Result<()> {
if let Some(file) = self.files.get_mut(&msg.file_id) {
let result = file.metadata();
msg.reply.try_send(result)?;
@ -773,13 +791,13 @@ impl SessionInner {
}
/// Performs readdir for file.
fn read_dir_file(
fn read_dir_handle(
&mut self,
_sess: &mut SessionWrap,
msg: &sftp::ReadDirFile,
msg: &ReadDirHandle,
) -> anyhow::Result<()> {
if let Some(file) = self.files.get_mut(&msg.file_id) {
let result = file.read_dir();
if let Some(dir) = self.dirs.get_mut(&msg.dir_id) {
let result = dir.read_dir();
msg.reply.try_send(result)?;
}
@ -790,7 +808,7 @@ impl SessionInner {
fn fsync_file(
&mut self,
_sess: &mut SessionWrap,
fsync_file: &sftp::FsyncFile,
fsync_file: &FsyncFile,
) -> anyhow::Result<()> {
if let Some(file) = self.files.get_mut(&fsync_file.file_id) {
let result = file.fsync();
@ -801,7 +819,7 @@ impl SessionInner {
}
/// Convenience function to read the files in a directory.
pub fn read_dir(&mut self, sess: &mut SessionWrap, msg: &sftp::ReadDir) -> anyhow::Result<()> {
pub fn read_dir(&mut self, sess: &mut SessionWrap, msg: &ReadDir) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
.and_then(|sftp| sftp.read_dir(&msg.filename));
@ -811,11 +829,7 @@ impl SessionInner {
}
/// Create a directory on the remote filesystem.
pub fn create_dir(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::CreateDir,
) -> anyhow::Result<()> {
pub fn create_dir(&mut self, sess: &mut SessionWrap, msg: &CreateDir) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
.and_then(|sftp| sftp.create_dir(&msg.filename, msg.mode));
@ -825,11 +839,7 @@ impl SessionInner {
}
/// Remove a directory from the remote filesystem.
pub fn remove_dir(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::RemoveDir,
) -> anyhow::Result<()> {
pub fn remove_dir(&mut self, sess: &mut SessionWrap, msg: &RemoveDir) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
.and_then(|sftp| sftp.remove_dir(&msg.filename));
@ -839,11 +849,7 @@ impl SessionInner {
}
/// Get the metadata for a file, performed by stat(2).
pub fn metadata(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::GetMetadata,
) -> anyhow::Result<()> {
pub fn metadata(&mut self, sess: &mut SessionWrap, msg: &GetMetadata) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
.and_then(|sftp| sftp.metadata(&msg.filename));
@ -856,7 +862,7 @@ impl SessionInner {
pub fn symlink_metadata(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::SymlinkMetadata,
msg: &SymlinkMetadata,
) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
@ -870,7 +876,7 @@ impl SessionInner {
pub fn set_metadata(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::SetMetadata,
msg: &SetMetadata,
) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
@ -881,7 +887,7 @@ impl SessionInner {
}
/// Create symlink at `target` pointing at `path`.
pub fn symlink(&mut self, sess: &mut SessionWrap, msg: &sftp::Symlink) -> anyhow::Result<()> {
pub fn symlink(&mut self, sess: &mut SessionWrap, msg: &Symlink) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
.and_then(|sftp| sftp.symlink(&msg.path, &msg.target));
@ -891,11 +897,7 @@ impl SessionInner {
}
/// Read a symlink at `path`.
pub fn read_link(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::ReadLink,
) -> anyhow::Result<()> {
pub fn read_link(&mut self, sess: &mut SessionWrap, msg: &ReadLink) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
.and_then(|sftp| sftp.read_link(&msg.path));
@ -908,7 +910,7 @@ impl SessionInner {
pub fn canonicalize(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::Canonicalize,
msg: &Canonicalize,
) -> anyhow::Result<()> {
let result = self
.init_sftp(sess)
@ -919,7 +921,7 @@ impl SessionInner {
}
/// Rename the filesystem object on the remote filesystem.
pub fn rename(&mut self, sess: &mut SessionWrap, msg: &sftp::Rename) -> anyhow::Result<()> {
pub fn rename(&mut self, sess: &mut SessionWrap, msg: &Rename) -> anyhow::Result<()> {
let result = self.init_sftp(sess).and_then(|sftp| {
sftp.rename(&msg.src, &msg.dst, msg.opts)
.map_err(SftpChannelError::from)
@ -930,11 +932,7 @@ impl SessionInner {
}
/// Remove a file on the remote filesystem.
pub fn remove_file(
&mut self,
sess: &mut SessionWrap,
msg: &sftp::RemoveFile,
) -> anyhow::Result<()> {
pub fn remove_file(&mut self, sess: &mut SessionWrap, msg: &RemoveFile) -> anyhow::Result<()> {
let result = self.init_sftp(sess).and_then(|sftp| sftp.unlink(&msg.file));
msg.reply.try_send(result)?;

88
wezterm-ssh/src/sftp/dir.rs Normal file
View File

@ -0,0 +1,88 @@
use super::{Metadata, SessionRequest, SessionSender, SftpChannelResult, SftpRequest};
use camino::Utf8PathBuf;
use smol::channel::{bounded, Sender};
use std::fmt;
pub(crate) type DirId = usize;
/// A file handle to an SFTP connection.
pub struct Dir {
pub(crate) dir_id: DirId,
tx: Option<SessionSender>,
}
impl fmt::Debug for Dir {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Dir").field("dir_id", &self.dir_id).finish()
}
}
#[derive(Debug)]
pub(crate) struct CloseDir {
pub dir_id: DirId,
pub reply: Sender<SftpChannelResult<()>>,
}
#[derive(Debug)]
pub(crate) struct ReadDirHandle {
pub dir_id: DirId,
pub reply: Sender<SftpChannelResult<(Utf8PathBuf, Metadata)>>,
}
#[derive(Debug)]
pub(crate) enum DirRequest {
Close(CloseDir),
ReadDir(ReadDirHandle),
}
impl Drop for Dir {
/// Attempts to close the file that exists in the dedicated ssh2 thread
fn drop(&mut self) {
if let Some(tx) = self.tx.take() {
let (reply, _) = bounded(1);
let _ = tx.try_send(SessionRequest::Sftp(SftpRequest::Dir(DirRequest::Close(
CloseDir {
dir_id: self.dir_id,
reply,
},
))));
}
}
}
impl Dir {
pub(crate) fn new(dir_id: DirId) -> Self {
Self { dir_id, tx: None }
}
pub(crate) fn initialize_sender(&mut self, sender: SessionSender) {
self.tx.replace(sender);
}
/// Reads a block of data from a handle and returns file entry information for the next entry,
/// if any.
///
/// Note that this provides raw access to the readdir function from libssh2. This will return
/// an error when there are no more files to read, and files such as . and .. will be included
/// in the return values.
///
/// Also note that the return paths will not be absolute paths, they are the filenames of the
/// files in this directory.
///
/// See [`ssh2::Dir::readdir`] for more information.
pub async fn read_dir(&self) -> anyhow::Result<(Utf8PathBuf, Metadata)> {
let (reply, rx) = bounded(1);
self.tx
.as_ref()
.unwrap()
.send(SessionRequest::Sftp(SftpRequest::Dir(DirRequest::ReadDir(
ReadDirHandle {
dir_id: self.dir_id,
reply,
},
))))
.await?;
let result = rx.recv().await??;
Ok(result)
}
}

40
wezterm-ssh/src/sftp/file.rs
View File

@ -1,9 +1,11 @@
use super::{Metadata, SessionRequest, SessionSender, SftpChannelResult, SftpRequest};
use camino::Utf8PathBuf;
use smol::channel::{bounded, Sender};
use smol::future::FutureExt;
use std::fmt;
use std::future::Future;
use std::io;
use std::pin::Pin;
use std::task::{Context, Poll};
use std::{fmt, future::Future, io, pin::Pin};
pub(crate) type FileId = usize;
@ -30,7 +32,6 @@ pub(crate) enum FileRequest {
Flush(FlushFile),
SetMetadata(SetMetadataFile),
Metadata(MetadataFile),
ReadDir(ReadDirFile),
Fsync(FsyncFile),
}
@ -73,12 +74,6 @@ pub(crate) struct MetadataFile {
pub reply: Sender<SftpChannelResult<Metadata>>,
}
#[derive(Debug)]
pub(crate) struct ReadDirFile {
pub file_id: FileId,
pub reply: Sender<SftpChannelResult<(Utf8PathBuf, Metadata)>>,
}
#[derive(Debug)]
pub(crate) struct FsyncFile {
pub file_id: FileId,
@ -160,33 +155,6 @@ impl File {
Ok(result)
}
/// Reads a block of data from a handle and returns file entry information for the next entry,
/// if any.
///
/// Note that this provides raw access to the readdir function from libssh2. This will return
/// an error when there are no more files to read, and files such as . and .. will be included
/// in the return values.
///
/// Also note that the return paths will not be absolute paths, they are the filenames of the
/// files in this directory.
///
/// See [`ssh2::File::readdir`] for more information.
pub async fn read_dir(&self) -> anyhow::Result<(Utf8PathBuf, Metadata)> {
let (reply, rx) = bounded(1);
self.tx
.as_ref()
.unwrap()
.send(SessionRequest::Sftp(SftpRequest::File(
FileRequest::ReadDir(ReadDirFile {
file_id: self.file_id,
reply,
}),
)))
.await?;
let result = rx.recv().await??;
Ok(result)
}
/// This function causes the remote server to synchronize the file data and metadata to disk
/// (like fsync(2)).
///

27
wezterm-ssh/src/sftp/mod.rs
View File

@ -1,24 +1,18 @@
use super::{SessionRequest, SessionSender};
use crate::sftp::dir::{Dir, DirRequest};
use crate::sftp::file::{File, FileRequest};
use crate::sftp::types::{Metadata, OpenFileType, OpenOptions, RenameOptions, WriteMode};
use camino::Utf8PathBuf;
use error::SftpError;
use smol::channel::{bounded, RecvError, Sender};
use std::convert::TryInto;
use std::io;
use thiserror::Error;
mod error;
pub use error::{SftpError, SftpResult};
mod file;
pub use file::File;
pub(crate) use file::{
CloseFile, FileId, FileRequest, FlushFile, FsyncFile, MetadataFile, ReadDirFile, ReadFile,
SetMetadataFile, WriteFile,
};
mod types;
pub use types::{
FilePermissions, FileType, Metadata, OpenFileType, OpenOptions, RenameOptions, WriteMode,
};
pub(crate) mod dir;
pub(crate) mod error;
pub(crate) mod file;
pub(crate) mod types;
fn into_invalid_data<E>(err: E) -> io::Error
where
@ -122,7 +116,7 @@ impl Sftp {
}
/// Helper to open a directory for reading its contents.
pub async fn open_dir<T, E>(&self, filename: T) -> SftpChannelResult<File>
pub async fn open_dir<T, E>(&self, filename: T) -> SftpChannelResult<Dir>
where
T: TryInto<Utf8PathBuf, Error = E>,
E: Into<Box<dyn std::error::Error + Send + Sync>>,
@ -371,6 +365,7 @@ pub(crate) enum SftpRequest {
/// Specialized type for file-based operations
File(FileRequest),
Dir(DirRequest),
}
#[derive(Debug)]
@ -395,7 +390,7 @@ pub(crate) struct Create {
#[derive(Debug)]
pub(crate) struct OpenDir {
pub filename: Utf8PathBuf,
pub reply: Sender<SftpChannelResult<File>>,
pub reply: Sender<SftpChannelResult<Dir>>,
}
#[derive(Debug)]

9
wezterm-ssh/src/sftpwrap.rs
View File

@ -1,5 +1,7 @@
use crate::dirwrap::DirWrap;
use crate::filewrap::FileWrap;
use crate::sftp::{Metadata, OpenOptions, RenameOptions, SftpChannelError, SftpChannelResult};
use crate::sftp::types::{Metadata, OpenOptions, RenameOptions};
use crate::sftp::{SftpChannelError, SftpChannelResult};
use camino::{Utf8Path, Utf8PathBuf};
use std::convert::TryFrom;
@ -126,13 +128,12 @@ impl SftpWrap {
}
}
// FIXME: need a DirWrap
pub fn open_dir(&self, filename: &Utf8Path) -> SftpChannelResult<FileWrap> {
pub fn open_dir(&self, filename: &Utf8Path) -> SftpChannelResult<DirWrap> {
match self {
Self::Ssh2(sftp) => sftp
.opendir(filename.as_std_path())
.map_err(SftpChannelError::from)
.map(FileWrap::Ssh2),
.map(DirWrap::Ssh2),
}
}