diff --git a/libs/hbb_common/src/config.rs b/libs/hbb_common/src/config.rs index 4890df1c5..224709911 100644 --- a/libs/hbb_common/src/config.rs +++ b/libs/hbb_common/src/config.rs @@ -105,7 +105,7 @@ macro_rules! serde_field_string { where D: de::Deserializer<'de>, { - let s: &str = de::Deserialize::deserialize(deserializer)?; + let s: &str = de::Deserialize::deserialize(deserializer).unwrap_or_default(); Ok(if s.is_empty() { Self::$default_func() } else { @@ -119,7 +119,7 @@ macro_rules! serde_field_bool { ($struct_name: ident, $field_name: literal, $func: ident, $default: literal) => { #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)] pub struct $struct_name { - #[serde(default = $default, rename = $field_name)] + #[serde(default = $default, rename = $field_name, deserialize_with = "deserialize_bool")] pub v: bool, } impl Default for $struct_name { @@ -143,59 +143,63 @@ pub enum NetworkType { #[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq)] pub struct Config { - #[serde(default, skip_serializing_if = "String::is_empty")] + #[serde( + default, + skip_serializing_if = "String::is_empty", + deserialize_with = "deserialize_string" + )] pub id: String, // use - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] enc_id: String, // store - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] password: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] salt: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_keypair")] key_pair: KeyPair, // sk, pk - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_bool")] key_confirmed: bool, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_bool")] keys_confirmed: HashMap, } #[derive(Debug, Default, PartialEq, Serialize, Deserialize, Clone)] pub struct Socks5Server { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub proxy: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub username: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub password: String, } // more variable configs #[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq)] pub struct Config2 { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] rendezvous_server: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_i32")] nat_type: i32, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_i32")] serial: i32, #[serde(default)] socks: Option, // the other scalar value must before this - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_string")] pub options: HashMap, } #[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq)] pub struct PeerConfig { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_vec_u8")] pub password: Vec, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_size")] pub size: Size, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_size")] pub size_ft: Size, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_size")] pub size_pf: Size, #[serde( default = "PeerConfig::default_view_style", @@ -225,9 +229,9 @@ pub struct PeerConfig { pub privacy_mode: PrivacyMode, #[serde(flatten)] pub allow_swap_key: AllowSwapKey, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_vec_i32_string_i32")] pub port_forwards: Vec<(i32, String, i32)>, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_i32")] pub direct_failures: i32, #[serde(flatten)] pub disable_audio: DisableAudio, @@ -237,7 +241,7 @@ pub struct PeerConfig { pub enable_file_transfer: EnableFileTransfer, #[serde(flatten)] pub show_quality_monitor: ShowQualityMonitor, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub keyboard_mode: String, #[serde(flatten)] pub view_only: ViewOnly, @@ -246,7 +250,7 @@ pub struct PeerConfig { #[serde(default, deserialize_with = "PeerConfig::deserialize_options")] pub options: HashMap, // not use delete to represent default values // Various data for flutter ui - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_string")] pub ui_flutter: HashMap, #[serde(default)] pub info: PeerInfoSerde, @@ -256,48 +260,51 @@ pub struct PeerConfig { #[derive(Debug, PartialEq, Default, Serialize, Deserialize, Clone)] pub struct PeerInfoSerde { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub username: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub hostname: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub platform: String, } #[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq)] pub struct ConfigOidc { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_usize")] pub max_auth_count: usize, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub callback_url: String, - #[serde(default)] + #[serde( + default, + deserialize_with = "deserialize_hashmap_string_configoidcprovider" + )] pub providers: HashMap, } #[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq)] pub struct ConfigOidcProvider { // seconds. 0 means never expires - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_u32")] pub refresh_token_expires_in: u32, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub client_id: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub client_secret: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_option_string")] pub issuer: Option, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_option_string")] pub authorization_endpoint: Option, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_option_string")] pub token_endpoint: Option, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_option_string")] pub userinfo_endpoint: Option, } #[derive(Debug, Default, Serialize, Deserialize, Clone, PartialEq)] pub struct TransferSerde { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_vec_string")] pub write_jobs: Vec, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_vec_string")] pub read_jobs: Vec, } @@ -1148,18 +1155,18 @@ serde_field_bool!( #[derive(Debug, Default, Serialize, Deserialize, Clone)] pub struct LocalConfig { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] remote_id: String, // latest used one - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] kb_layout_type: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_size")] size: Size, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_vec_string")] pub fav: Vec, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_string")] options: HashMap, // Various data for flutter ui - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_string")] ui_flutter: HashMap, } @@ -1267,17 +1274,17 @@ impl LocalConfig { #[derive(Debug, Default, Serialize, Deserialize, Clone)] pub struct DiscoveryPeer { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub id: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub username: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub hostname: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_string")] pub platform: String, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_bool")] pub online: bool, - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_string")] pub ip_mac: HashMap, } @@ -1289,6 +1296,7 @@ impl DiscoveryPeer { #[derive(Debug, Default, Serialize, Deserialize, Clone)] pub struct LanPeers { + #[serde(default, deserialize_with = "deserialize_vec_discoverypeer")] pub peers: Vec, } @@ -1324,7 +1332,7 @@ impl LanPeers { #[derive(Debug, Default, Serialize, Deserialize, Clone)] pub struct HwCodecConfig { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_string")] pub options: HashMap, } @@ -1354,7 +1362,7 @@ impl HwCodecConfig { #[derive(Debug, Default, Serialize, Deserialize, Clone)] pub struct UserDefaultConfig { - #[serde(default)] + #[serde(default, deserialize_with = "deserialize_hashmap_string_string")] options: HashMap, } @@ -1451,6 +1459,34 @@ impl ConfigOidc { } } +// use default value when field type is wrong +macro_rules! deserialize_default { + ($func_name:ident, $return_type:ty) => { + fn $func_name<'de, D>(deserializer: D) -> Result<$return_type, D::Error> + where + D: de::Deserializer<'de>, + { + Ok(de::Deserialize::deserialize(deserializer).unwrap_or_default()) + } + }; +} + +deserialize_default!(deserialize_string, String); +deserialize_default!(deserialize_bool, bool); +deserialize_default!(deserialize_i32, i32); +deserialize_default!(deserialize_u32, u32); +deserialize_default!(deserialize_usize, usize); +deserialize_default!(deserialize_vec_u8, Vec); +deserialize_default!(deserialize_vec_string, Vec); +deserialize_default!(deserialize_vec_i32_string_i32, Vec<(i32, String, i32)>); +deserialize_default!(deserialize_vec_discoverypeer, Vec); +deserialize_default!(deserialize_keypair, KeyPair); +deserialize_default!(deserialize_size, Size); +deserialize_default!(deserialize_option_string, Option); +deserialize_default!(deserialize_hashmap_string_string, HashMap); +deserialize_default!(deserialize_hashmap_string_bool, HashMap); +deserialize_default!(deserialize_hashmap_string_configoidcprovider, HashMap); + #[cfg(test)] mod tests { use super::*; @@ -1464,4 +1500,38 @@ mod tests { let res = toml::to_string_pretty(&cfg); assert!(res.is_ok()); } + + #[test] + fn test_config_deserialize() { + let wrong_type_str = r#" + id = true + enc_id = [] + password = 1 + salt = "123456" + key_pair = {} + key_confirmed = "1" + keys_confirmed = 1 + "#; + let cfg = toml::from_str::(wrong_type_str); + assert_eq!( + cfg, + Ok(Config { + salt: "123456".to_string(), + ..Default::default() + }) + ); + + let wrong_field_str = r#" + hello = "world" + key_confirmed = true + "#; + let cfg = toml::from_str::(wrong_field_str); + assert_eq!( + cfg, + Ok(Config { + key_confirmed: true, + ..Default::default() + }) + ); + } }