From 35fccafc0909618f020b86fc3188d6a77d03f0d9 Mon Sep 17 00:00:00 2001
From: Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
Date: Fri, 25 Jan 2019 02:57:37 +0100
Subject: [PATCH] avatar: Add a new XEP-0084 parser.

---
 src/avatar.rs | 121 ++++++++++++++++++++++++++++++++++++++++++++++++++
 src/lib.rs    |   3 ++
 src/ns.rs     |   5 +++
 3 files changed, 129 insertions(+)
 create mode 100644 src/avatar.rs

diff --git a/src/avatar.rs b/src/avatar.rs
new file mode 100644
index 0000000..07f0bde
--- /dev/null
+++ b/src/avatar.rs
@@ -0,0 +1,121 @@
+// Copyright (c) 2019 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
+//
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+use crate::hashes::Sha1HexAttribute;
+use crate::util::helpers::Base64;
+
+generate_element!(
+    /// Communicates information about an avatar.
+    Metadata, "metadata", AVATAR_METADATA,
+    children: [
+        /// List of information elements describing this avatar.
+        infos: Vec<Info> = ("info", AVATAR_METADATA) => Info
+    ]
+);
+
+generate_element!(
+    /// Communicates avatar metadata.
+    Info, "info", AVATAR_METADATA,
+    attributes: [
+        /// The size of the image data in bytes.
+        bytes: u16 = "bytes" => required,
+
+        /// The width of the image in pixels.
+        width: Option<u8> = "width" => optional,
+
+        /// The height of the image in pixels.
+        height: Option<u8> = "height" => optional,
+
+        /// The SHA-1 hash of the image data for the specified content-type.
+        id: Sha1HexAttribute = "id" => required,
+
+        /// The IANA-registered content type of the image data.
+        type_: String = "type" => required,
+
+        /// The http: or https: URL at which the image data file is hosted.
+        url: Option<String> = "url" => optional,
+    ]
+);
+
+generate_element!(
+    /// The actual avatar data.
+    Data, "data", AVATAR_DATA,
+    text: (
+        /// Vector of bytes representing the avatar’s image.
+        data: Base64<Vec<u8>>
+    )
+);
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+    use crate::hashes::Algo;
+    use crate::util::error::Error;
+    use minidom::Element;
+    use try_from::TryFrom;
+
+    #[cfg(target_pointer_width = "32")]
+    #[test]
+    fn test_size() {
+        assert_size!(Metadata, 12);
+        assert_size!(Info, 60);
+        assert_size!(Data, 12);
+    }
+
+    #[cfg(target_pointer_width = "64")]
+    #[test]
+    fn test_size() {
+        assert_size!(Metadata, 24);
+        assert_size!(Info, 112);
+        assert_size!(Data, 24);
+    }
+
+    #[test]
+    fn test_simple() {
+        let elem: Element = "<metadata xmlns='urn:xmpp:avatar:metadata'>
+                                 <info bytes='12345' width='64' height='64'
+                                       id='111f4b3c50d7b0df729d299bc6f8e9ef9066971f'
+                                       type='image/png'/>
+                             </metadata>"
+            .parse()
+            .unwrap();
+        let metadata = Metadata::try_from(elem).unwrap();
+        assert_eq!(metadata.infos.len(), 1);
+        let info = &metadata.infos[0];
+        assert_eq!(info.bytes, 12345);
+        assert_eq!(info.width, Some(64));
+        assert_eq!(info.height, Some(64));
+        assert_eq!(info.id.algo, Algo::Sha_1);
+        assert_eq!(info.type_, "image/png");
+        assert_eq!(info.url, None);
+        assert_eq!(
+            info.id.hash,
+            [
+                17, 31, 75, 60, 80, 215, 176, 223, 114, 157, 41, 155, 198, 248, 233, 239, 144, 102,
+                151, 31
+            ]
+        );
+
+        let elem: Element = "<data xmlns='urn:xmpp:avatar:data'>AAAA</data>"
+            .parse()
+            .unwrap();
+        let data = Data::try_from(elem).unwrap();
+        assert_eq!(data.data, b"\0\0\0");
+    }
+
+    #[test]
+    fn test_invalid() {
+        let elem: Element = "<data xmlns='urn:xmpp:avatar:data' id='coucou'>"
+            .parse()
+            .unwrap();
+        let error = Data::try_from(elem).unwrap_err();
+        let message = match error {
+            Error::ParseError(string) => string,
+            _ => panic!(),
+        };
+        assert_eq!(message, "Unknown attribute in data element.")
+    }
+}
diff --git a/src/lib.rs b/src/lib.rs
index aea3e73..765c9a1 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -83,6 +83,9 @@ pub mod ibr;
 /// XEP-0082: XMPP Date and Time Profiles
 pub mod date;
 
+/// XEP-0084: User Avatar
+pub mod avatar;
+
 /// XEP-0085: Chat State Notifications
 pub mod chatstates;
 
diff --git a/src/ns.rs b/src/ns.rs
index 658428f..7aa4768 100644
--- a/src/ns.rs
+++ b/src/ns.rs
@@ -56,6 +56,11 @@ pub const PUBSUB_OWNER: &str = "http://jabber.org/protocol/pubsub#owner";
 /// XEP-0077: In-Band Registration
 pub const REGISTER: &str = "jabber:iq:register";
 
+/// XEP-0084: User Avatar
+pub const AVATAR_DATA: &str = "urn:xmpp:avatar:data";
+/// XEP-0084: User Avatar
+pub const AVATAR_METADATA: &str = "urn:xmpp:avatar:metadata";
+
 /// XEP-0085: Chat State Notifications
 pub const CHATSTATES: &str = "http://jabber.org/protocol/chatstates";