feat: Add support for private properties in vCard4

Author: RemiBardon

crates/prose-xmpp/src/stanza/vcard4.rs

@@ -3,6 +3,9 @@
 // Copyright: 2023, Marc Bauer <[email protected]>
 // License: Mozilla Public License v2.0 (MPL v2.0)
 
+use std::collections::HashMap;
+use std::ops::{Deref, DerefMut};
+
 use anyhow::Result;
 use minidom::{Element, ElementBuilder};
 use xmpp_parsers::iq::IqSetPayload;
@@ -24,6 +27,7 @@ pub struct VCard4 {
     pub tel: Vec<Tel>,
     pub title: Vec<Title>,
     pub url: Vec<URL>,
+    pub private_: PrivateProperties,
 }
 
 impl VCard4 {
@@ -44,6 +48,7 @@ impl VCard4 {
             && self.tel.is_empty()
             && self.title.is_empty()
             && self.url.is_empty()
+            && self.private_.is_empty()
     }
 }
 
@@ -102,6 +107,29 @@ pub struct Org {
     pub value: String,
 }
 
+#[derive(Debug, Clone, PartialEq, Default)]
+pub struct PrivateProperties(HashMap<String, String>);
+
+impl Deref for PrivateProperties {
+    type Target = HashMap<String, String>;
+
+    fn deref(&self) -> &Self::Target {
+        &self.0
+    }
+}
+
+impl DerefMut for PrivateProperties {
+    fn deref_mut(&mut self) -> &mut Self::Target {
+        &mut self.0
+    }
+}
+
+impl FromIterator<(String, String)> for PrivateProperties {
+    fn from_iter<T: IntoIterator<Item = (String, String)>>(iter: T) -> Self {
+        Self(HashMap::from_iter(iter))
+    }
+}
+
 #[derive(Debug, Clone, PartialEq)]
 pub struct Role {
     pub value: String,
@@ -161,6 +189,9 @@ impl TryFrom<Element> for VCard4 {
                 "role" => vcard.role.push(Role {
                     value: child.text_value()?,
                 }),
+                key if key.starts_with("x-") => {
+                    vcard.private_.insert(key.to_string(), child.text_value()?);
+                }
                 _ => (),
             }
         }
@@ -184,6 +215,10 @@ impl From<VCard4> for Element {
             .append_all_values(vcard.title, "title", "text", |v| v.value)
             .append_all_values(vcard.tel, "tel", "text", |v| v.value)
             .append_all_values(vcard.url, "url", "uri", |v| v.value)
+            .append_all(vcard.private_.iter().map(|(key, value)| {
+                Element::builder(key, ns::VCARD4)
+                    .append(Element::builder("text", ns::VCARD4).append(value.clone()))
+            }))
             .build()
     }
 }
@@ -459,13 +494,9 @@ mod tests {
     fn test_serialize_vcard() -> Result<()> {
         let vcard = VCard4 {
             adr: vec![Adr {
-                code: vec![],
                 country: vec!["France, French Republic".to_string()],
-                ext: vec![],
                 locality: vec!["Nantes".to_string()],
-                pobox: vec![],
-                region: vec![],
-                street: vec![],
+                ..Default::default()
             }],
             email: vec![Email {
                 value: "[email protected]".to_string(),
@@ -476,7 +507,7 @@ mod tests {
             n: vec![Name {
                 surname: Some("Saliou".to_string()),
                 given: Some("Valerian".to_string()),
-                additional: None,
+                ..Default::default()
             }],
             impp: vec![Impp {
                 value: "xmpp:[email protected]".to_string(),
@@ -489,17 +520,37 @@ mod tests {
                     value: "Another nickname".to_string(),
                 },
             ],
-            note: vec![],
-            org: vec![],
-            tel: vec![],
-            title: vec![],
-            role: vec![],
             url: vec![URL {
                 value: "https://prose.org/".to_string(),
             }],
+            ..Default::default()
         };
 
         assert_eq!(VCard4::try_from(Element::from(vcard.clone()))?, vcard);
         Ok(())
     }
+
+    /// We store workspace details in a vCard4, and need to store non-standard properties.
+    /// This test ensures private properties are parsed correctly.
+    #[test]
+    fn test_private_properties() -> Result<()> {
+        let vcard = VCard4 {
+            fn_: vec![Fn_ {
+                value: "Prose".to_string(),
+            }],
+            private_: vec![("x-accent-color", "#2d8deb")]
+                .into_iter()
+                .map(|(k, v)| (k.to_string(), v.to_string()))
+                .collect(),
+            ..Default::default()
+        };
+
+        assert_eq!(VCard4::try_from(Element::from(vcard.clone()))?, vcard);
+        // Check that values can be read
+        assert_eq!(
+            vcard.private_.get(&"x-accent-color".to_string()),
+            Some(&"#2d8deb".to_string())
+        );
+        Ok(())
+    }
 }