// Copyright (c) 2024 Emmanuel Gil Peyrot // // 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 xso::{AsXml, FromXml}; use crate::mam; use crate::ns; use minidom::Element; use xso::error::{Error, FromElementError}; /// Represents the `` element, as sent by the server in SASL 2 to advertise which features /// can be enabled during the binding step. #[derive(FromXml, AsXml, Debug, Clone, PartialEq)] #[xml(namespace = ns::BIND2, name = "bind")] pub struct BindFeature { /// The features that can be enabled by the client. #[xml(extract(name = "inline", fields(extract(n = .., name = "feature", fields(attribute(name = "var", type_ = String))))))] pub inline_features: Vec, } /// Represents a `` element, as sent by the client inline in the `` SASL 2 /// element, to perform the binding at the same time as the authentication. #[derive(Debug, Clone, PartialEq)] pub struct BindQuery { /// Short text string that typically identifies the software the user is using, mostly useful /// for diagnostic purposes for users, operators and developers. This tag may be visible to /// other entities on the XMPP network. pub tag: Option, /// Features that the client requests to be automatically enabled for its new session. pub payloads: Vec, } impl TryFrom for BindQuery { type Error = FromElementError; fn try_from(root: Element) -> Result { check_self!(root, "bind", BIND2); check_no_attributes!(root, "bind"); let mut tag = None; let mut payloads = Vec::new(); for child in root.children() { if child.is("tag", ns::BIND2) { if tag.is_some() { return Err( Error::Other("Bind must not have more than one tag element.").into(), ); } check_no_attributes!(child, "tag"); check_no_children!(child, "tag"); tag = Some(child.text()); } else { payloads.push(child.clone()); } } Ok(BindQuery { tag, payloads }) } } impl From for Element { fn from(bind: BindQuery) -> Element { Element::builder("bind", ns::BIND2) .append_all( bind.tag .map(|tag| Element::builder("tag", ns::BIND2).append(tag)), ) .append_all(bind.payloads) .build() } } /// Represents a `` element, which tells the client its resource is bound, alongside other /// requests. #[derive(Debug, Clone, PartialEq)] pub struct Bound { /// Indicates which messages got missed by this particular device, start is the oldest message /// and end is the newest, before this connection. pub mam_metadata: Option, /// Additional payloads which happened during the binding process. pub payloads: Vec, } impl TryFrom for Bound { type Error = FromElementError; fn try_from(root: Element) -> Result { check_self!(root, "bound", BIND2); check_no_attributes!(root, "bound"); let mut mam_metadata = None; let mut payloads = Vec::new(); for child in root.children() { if child.is("metadata", ns::MAM) { if mam_metadata.is_some() { return Err( Error::Other("Bind must not have more than one metadata element.").into(), ); } mam_metadata = Some(mam::MetadataResponse::try_from(child.clone())?); } else { payloads.push(child.clone()); } } Ok(Bound { mam_metadata, payloads, }) } } impl From for Element { fn from(bound: Bound) -> Element { Element::builder("bound", ns::BIND2) .append_all(bound.mam_metadata) .build() } } #[cfg(test)] mod tests { use super::*; #[cfg(target_pointer_width = "32")] #[test] fn test_size() { assert_size!(BindFeature, 12); assert_size!(BindQuery, 24); assert_size!(Bound, 68); } #[cfg(target_pointer_width = "64")] #[test] fn test_size() { assert_size!(BindFeature, 24); assert_size!(BindQuery, 48); assert_size!(Bound, 104); } #[test] fn test_simple() { // Example 1 let elem: Element = "" .parse() .unwrap(); let bind = BindFeature::try_from(elem.clone()).unwrap(); assert_eq!(bind.inline_features.len(), 3); assert_eq!(bind.inline_features[0], "urn:xmpp:carbons:2"); assert_eq!(bind.inline_features[1], "urn:xmpp:csi:0"); assert_eq!(bind.inline_features[2], "urn:xmpp:sm:3"); let elem2 = bind.into(); assert_eq!(elem, elem2); // Example 2 let elem: Element = "AwesomeXMPP" .parse() .unwrap(); let bind = BindQuery::try_from(elem).unwrap(); assert_eq!(bind.tag.unwrap(), "AwesomeXMPP"); assert_eq!(bind.payloads.len(), 0); // Example 3 let elem: Element = "AwesomeXMPP".parse().unwrap(); let bind = BindQuery::try_from(elem).unwrap(); assert_eq!(bind.tag.unwrap(), "AwesomeXMPP"); assert_eq!(bind.payloads.len(), 3); // Example 4 let elem: Element = "".parse().unwrap(); let bound = Bound::try_from(elem).unwrap(); assert!(bound.mam_metadata.is_some()); assert_eq!(bound.payloads.len(), 0); } }