SMB support (#184)

* feat: smb client

* fix: smb connection

* fix: smbclient deps

* feat: SMB mentions to user manual

* feat: changelog

* dlib macos

* fix: removed smb support from macos :(

* fix: restored libsmbclient build

* fix: strange lint message

* fix: macos build smb

* fix: macos build smb

* fix: macos tests

* fix: macos lint

* feat: SMB windows support

* fix: windows tests

src/config/bookmarks.rs

@@ -9,7 +9,9 @@ use std::str::FromStr;
 use serde::de::Error as DeError;
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
-use crate::filetransfer::params::{AwsS3Params, GenericProtocolParams, ProtocolParams};
+use crate::filetransfer::params::{
+    AwsS3Params, GenericProtocolParams, ProtocolParams, SmbParams as TransferSmbParams,
+};
 use crate::filetransfer::{FileTransferParams, FileTransferProtocol};
 
 /// UserHosts contains all the hosts saved by the user in the data storage
@@ -40,6 +42,8 @@ pub struct Bookmark {
     pub directory: Option<PathBuf>,
     /// S3 params; optional. When used other fields are empty for sure
     pub s3: Option<S3Params>,
+    /// SMB params; optional. Extra params required for SMB protocol
+    pub smb: Option<SmbParams>,
 }
 
 /// Connection parameters for Aws s3 protocol
@@ -55,6 +59,13 @@ pub struct S3Params {
     pub new_path_style: Option<bool>,
 }
 
+/// Extra Connection parameters for SMB protocol
+#[derive(Clone, Deserialize, Serialize, Debug, PartialEq, Eq, Default)]
+pub struct SmbParams {
+    pub share: String,
+    pub workgroup: Option<String>,
+}
+
 // -- impls
 
 impl From<FileTransferParams> for Bookmark {
@@ -71,6 +82,7 @@ impl From<FileTransferParams> for Bookmark {
                 password: params.password,
                 directory,
                 s3: None,
+                smb: None,
             },
             ProtocolParams::AwsS3(params) => Self {
                 protocol,
@@ -80,6 +92,20 @@ impl From<FileTransferParams> for Bookmark {
                 password: None,
                 directory,
                 s3: Some(S3Params::from(params)),
+                smb: None,
+            },
+            ProtocolParams::Smb(params) => Self {
+                smb: Some(SmbParams::from(params.clone())),
+                protocol,
+                address: Some(params.address),
+                #[cfg(unix)]
+                port: Some(params.port),
+                #[cfg(windows)]
+                port: None,
+                username: params.username,
+                password: params.password,
+                directory,
+                s3: None,
             },
         }
     }
@@ -104,6 +130,30 @@ impl From<Bookmark> for FileTransferParams {
                     .password(bookmark.password);
                 Self::new(bookmark.protocol, ProtocolParams::Generic(params))
             }
+            #[cfg(unix)]
+            FileTransferProtocol::Smb => {
+                let params = TransferSmbParams::new(
+                    bookmark.address.unwrap_or_default(),
+                    bookmark.smb.clone().map(|x| x.share).unwrap_or_default(),
+                )
+                .port(bookmark.port.unwrap_or(445))
+                .username(bookmark.username)
+                .password(bookmark.password)
+                .workgroup(bookmark.smb.and_then(|x| x.workgroup));
+
+                Self::new(bookmark.protocol, ProtocolParams::Smb(params))
+            }
+            #[cfg(windows)]
+            FileTransferProtocol::Smb => {
+                let params = TransferSmbParams::new(
+                    bookmark.address.unwrap_or_default(),
+                    bookmark.smb.clone().map(|x| x.share).unwrap_or_default(),
+                )
+                .username(bookmark.username)
+                .password(bookmark.password);
+
+                Self::new(bookmark.protocol, ProtocolParams::Smb(params))
+            }
         }
         .entry_directory(bookmark.directory) // Set entry directory
     }
@@ -133,6 +183,26 @@ impl From<S3Params> for AwsS3Params {
     }
 }
 
+#[cfg(unix)]
+impl From<TransferSmbParams> for SmbParams {
+    fn from(params: TransferSmbParams) -> Self {
+        Self {
+            share: params.share,
+            workgroup: params.workgroup,
+        }
+    }
+}
+
+#[cfg(windows)]
+impl From<TransferSmbParams> for SmbParams {
+    fn from(params: TransferSmbParams) -> Self {
+        Self {
+            share: params.share,
+            workgroup: None,
+        }
+    }
+}
+
 fn deserialize_protocol<'de, D>(deserializer: D) -> Result<FileTransferProtocol, D::Error>
 where
     D: Deserializer<'de>,
@@ -178,6 +248,7 @@ mod tests {
             password: Some(String::from("password")),
             directory: Some(PathBuf::from("/tmp")),
             s3: None,
+            smb: None,
         };
         let recent: Bookmark = Bookmark {
             address: Some(String::from("192.168.1.2")),
@@ -187,6 +258,7 @@ mod tests {
             password: Some(String::from("password")),
             directory: Some(PathBuf::from("/home")),
             s3: None,
+            smb: None,
         };
         let mut bookmarks: HashMap<String, Bookmark> = HashMap::with_capacity(1);
         bookmarks.insert(String::from("test"), bookmark);
@@ -275,6 +347,7 @@ mod tests {
             password: Some(String::from("password")),
             directory: Some(PathBuf::from("/tmp")),
             s3: None,
+            smb: None,
         };
         let params = FileTransferParams::from(bookmark);
         assert_eq!(params.protocol, FileTransferProtocol::Sftp);
@@ -307,6 +380,7 @@ mod tests {
                 secret_access_key: Some(String::from("pluto")),
                 new_path_style: Some(true),
             }),
+            smb: None,
         };
         let params = FileTransferParams::from(bookmark);
         assert_eq!(params.protocol, FileTransferProtocol::AwsS3);
@@ -323,4 +397,64 @@ mod tests {
         assert_eq!(gparams.secret_access_key.as_deref().unwrap(), "pluto");
         assert_eq!(gparams.new_path_style, true);
     }
+
+    #[test]
+    #[cfg(unix)]
+    fn should_get_ftparams_from_smb_bookmark() {
+        let bookmark: Bookmark = Bookmark {
+            protocol: FileTransferProtocol::Smb,
+            address: Some("localhost".to_string()),
+            port: Some(445),
+            username: Some("foo".to_string()),
+            password: Some("bar".to_string()),
+            directory: Some(PathBuf::from("/tmp")),
+            s3: None,
+            smb: Some(SmbParams {
+                share: "test".to_string(),
+                workgroup: Some("testone".to_string()),
+            }),
+        };
+
+        let params = FileTransferParams::from(bookmark);
+        assert_eq!(params.protocol, FileTransferProtocol::Smb);
+        assert_eq!(
+            params.entry_directory.as_deref().unwrap(),
+            std::path::Path::new("/tmp")
+        );
+        let smb_params = params.params.smb_params().unwrap();
+        assert_eq!(smb_params.address.as_str(), "localhost");
+        assert_eq!(smb_params.port, 445);
+        assert_eq!(smb_params.share.as_str(), "test");
+        assert_eq!(smb_params.password.as_deref().unwrap(), "bar");
+        assert_eq!(smb_params.username.as_deref().unwrap(), "foo");
+        assert_eq!(smb_params.workgroup.as_deref().unwrap(), "testone");
+    }
+
+    #[test]
+    #[cfg(windows)]
+    fn should_get_ftparams_from_smb_bookmark() {
+        let bookmark: Bookmark = Bookmark {
+            protocol: FileTransferProtocol::Smb,
+            address: Some("localhost".to_string()),
+            port: Some(445),
+            username: None,
+            password: None,
+            directory: Some(PathBuf::from("/tmp")),
+            s3: None,
+            smb: Some(SmbParams {
+                share: "test".to_string(),
+                workgroup: None,
+            }),
+        };
+
+        let params = FileTransferParams::from(bookmark);
+        assert_eq!(params.protocol, FileTransferProtocol::Smb);
+        assert_eq!(
+            params.entry_directory.as_deref().unwrap(),
+            std::path::Path::new("/tmp")
+        );
+        let smb_params = params.params.smb_params().unwrap();
+        assert_eq!(smb_params.address.as_str(), "localhost");
+        assert_eq!(smb_params.share.as_str(), "test");
+    }
 }

src/config/serialization.rs

@@ -115,7 +115,7 @@ mod tests {
     use tuirealm::tui::style::Color;
 
     use super::*;
-    use crate::config::bookmarks::{Bookmark, S3Params, UserHosts};
+    use crate::config::bookmarks::{Bookmark, S3Params, SmbParams, UserHosts};
     use crate::config::params::UserConfig;
     use crate::config::themes::Theme;
     use crate::filetransfer::FileTransferProtocol;
@@ -366,7 +366,7 @@ mod tests {
         assert_eq!(host.username.as_deref().unwrap(), "root");
         assert_eq!(host.password, None);
         // Verify bookmarks
-        assert_eq!(hosts.bookmarks.len(), 4);
+        assert_eq!(hosts.bookmarks.len(), 5);
         let host: &Bookmark = hosts.bookmarks.get("raspberrypi2").unwrap();
         assert_eq!(host.address.as_deref().unwrap(), "192.168.1.31");
         assert_eq!(host.port.unwrap(), 22);
@@ -404,6 +404,20 @@ mod tests {
         assert_eq!(s3.access_key.as_deref().unwrap(), "pippo");
         assert_eq!(s3.secret_access_key.as_deref().unwrap(), "pluto");
         assert_eq!(s3.new_path_style.unwrap(), true);
+
+        // smb
+        let host = hosts.bookmarks.get("smb").unwrap();
+        assert_eq!(host.address.as_deref().unwrap(), "localhost");
+        assert_eq!(host.port.unwrap(), 445);
+        #[cfg(unix)]
+        assert_eq!(host.username.as_deref().unwrap(), "test");
+        #[cfg(unix)]
+        assert_eq!(host.password.as_deref().unwrap(), "test");
+
+        let smb = host.smb.as_ref().unwrap();
+        assert_eq!(smb.share.as_str(), "temp");
+        #[cfg(unix)]
+        assert_eq!(smb.workgroup.as_deref().unwrap(), "test");
     }
 
     #[test]
@@ -429,6 +443,7 @@ mod tests {
                 password: None,
                 directory: None,
                 s3: None,
+                smb: None,
             },
         );
         bookmarks.insert(
@@ -441,6 +456,7 @@ mod tests {
                 password: Some(String::from("password")),
                 directory: Some(PathBuf::from("/tmp")),
                 s3: None,
+                smb: None,
             },
         );
         bookmarks.insert(
@@ -461,6 +477,24 @@ mod tests {
                     secret_access_key: None,
                     new_path_style: None,
                 }),
+                smb: None,
+            },
+        );
+        let smb_params: Option<SmbParams> = Some(SmbParams {
+            share: "test".to_string(),
+            workgroup: None,
+        });
+        bookmarks.insert(
+            String::from("smb"),
+            Bookmark {
+                address: Some("localhost".to_string()),
+                port: Some(445),
+                protocol: FileTransferProtocol::Smb,
+                username: None,
+                password: None,
+                directory: None,
+                s3: None,
+                smb: smb_params,
             },
         );
         let mut recents: HashMap<String, Bookmark> = HashMap::with_capacity(1);
@@ -474,6 +508,7 @@ mod tests {
                 password: Some(String::from("aaa")),
                 directory: Some(PathBuf::from("/tmp")),
                 s3: None,
+                smb: None,
             },
         );
         let tmpfile: tempfile::NamedTempFile = tempfile::NamedTempFile::new().unwrap();
@@ -527,6 +562,17 @@ mod tests {
         secret_access_key = "pluto"
         new_path_style = true
 
+        [bookmarks.smb]
+        protocol = "SMB"
+        address = "localhost"
+        port = 445
+        username = "test"
+        password = "test"
+
+        [bookmarks.smb.smb]
+        share = "temp"
+        workgroup = "test"
+
         [recents]
         ISO20201215T094000Z = { address = "172.16.104.10", port = 22, protocol = "SCP", username = "root" }
         "#;