xmppftw/xmpp-rs
Watch
1
0
Fork
You've already forked xmpp-rs
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

parsers: port Iq to use the derive macros

Browse source
This commit is contained in:
Jonas Schäfer 2025-04-30 18:07:47 +02:00 • committed by Link Mauve
commit dc8c3eac4c
8 changed files with 486 additions and 312 deletions
Download patch file Download diff file Expand all files Collapse all files

11
parsers/ChangeLog
View file

@ -85,6 +85,17 @@ XXXX-YY-ZZ RELEASER <admin@example.com>
optional `parent` attribute.
- presence::Presence has been ported to use xso (!477). It also uses the
message::Lang newtype since !561.
- iq::Iq has been ported to use xso (!572). That entails a couple
breaking changes:
- The IqType type has been removed and loosely replaced by the
IqPayload type.
- The Iq type is now an enum. Access to `from`, `to` and `id` needs
to happen via the provided accessor functions, by `match`-ing the
enum variant or by splitting the Iq into its IqHeader and IqPayload
using the `split()` method.
- The inverse is possible through the `assemble()` methods on
IqPayload, IqHeader and Iq, whichever is more convenient.
* New parsers/serialisers:
- Stream Features (RFC 6120) (!400)
- Spam Reporting (XEP-0377) (!506)

520
parsers/src/iq.rs
View file

@ -9,8 +9,7 @@ use crate::ns;
use crate::stanza_error::StanzaError;
use jid::Jid;
use minidom::Element;
use minidom::IntoAttributeValue;
use xso::error::{Error, FromElementError};
use xso::{AsXml, FromXml};
/// Should be implemented on every known payload of an `<iq type='get'/>`.
pub trait IqGetPayload: TryFrom<Element> + Into<Element> {}
@ -21,228 +20,354 @@ pub trait IqSetPayload: TryFrom<Element> + Into<Element> {}
/// Should be implemented on every known payload of an `<iq type='result'/>`.
pub trait IqResultPayload: TryFrom<Element> + Into<Element> {}
/// Represents one of the four possible iq types.
#[derive(Debug, Clone, PartialEq)]
pub enum IqType {
/// This is a request for accessing some data.
/// Metadata of an IQ stanza.
pub struct IqHeader {
/// The sender JID.
pub from: Option<Jid>,
/// The reciepient JID.
pub to: Option<Jid>,
/// The stanza's ID.
pub id: String,
}
impl IqHeader {
/// Combine a header with [`IqPayload`] to create a full [`Iq`] stanza.
pub fn assemble(self, data: IqPayload) -> Iq {
data.assemble(self)
}
}
/// Payload of an IQ stanza, by type.
pub enum IqPayload {
/// Payload of a type='get' stanza.
Get(Element),
/// This is a request for modifying some data.
/// Payload of a type='set' stanza.
Set(Element),
/// This is a result containing some data.
/// Payload of a type='result' stanza.
Result(Option<Element>),
/// A get or set request failed.
/// The error carride in a type='error' stanza.
Error(StanzaError),
}
impl IntoAttributeValue for &IqType {
fn into_attribute_value(self) -> Option<String> {
Some(
match *self {
IqType::Get(_) => "get",
IqType::Set(_) => "set",
IqType::Result(_) => "result",
IqType::Error(_) => "error",
}
.to_owned(),
)
impl IqPayload {
/// Combine the data with an [`IqHeader`] to create a full [`Iq`] stanza.
pub fn assemble(self, IqHeader { from, to, id }: IqHeader) -> Iq {
match self {
Self::Get(payload) => Iq::Get {
from,
to,
id,
payload,
},
Self::Set(payload) => Iq::Set {
from,
to,
id,
payload,
},
Self::Result(payload) => Iq::Result {
from,
to,
id,
payload,
},
Self::Error(error) => Iq::Error {
from,
to,
id,
payload: None,
error,
},
}
}
}
/// The main structure representing the `<iq/>` stanza.
#[derive(Debug, Clone, PartialEq)]
pub struct Iq {
/// The JID emitting this stanza.
pub from: Option<Jid>,
#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
#[xml(namespace = ns::DEFAULT_NS, name = "iq", attribute = "type", exhaustive)]
pub enum Iq {
/// An `<iq type='get'/>` stanza.
#[xml(value = "get")]
Get {
/// The JID emitting this stanza.
#[xml(attribute(default))]
from: Option<Jid>,
/// The recipient of this stanza.
pub to: Option<Jid>,
/// The recipient of this stanza.
#[xml(attribute(default))]
to: Option<Jid>,
/// The @id attribute of this stanza, which is required in order to match a
/// request with its result/error.
pub id: String,
/// The @id attribute of this stanza, which is required in order to match a
/// request with its result/error.
#[xml(attribute)]
id: String,
/// The payload content of this stanza.
pub payload: IqType,
/// The payload content of this stanza.
#[xml(element(n = 1))]
payload: Element,
},
/// An `<iq type='set'/>` stanza.
#[xml(value = "set")]
Set {
/// The JID emitting this stanza.
#[xml(attribute(default))]
from: Option<Jid>,
/// The recipient of this stanza.
#[xml(attribute(default))]
to: Option<Jid>,
/// The @id attribute of this stanza, which is required in order to match a
/// request with its result/error.
#[xml(attribute)]
id: String,
/// The payload content of this stanza.
#[xml(element(n = 1))]
payload: Element,
},
/// An `<iq type='result'/>` stanza.
#[xml(value = "result")]
Result {
/// The JID emitting this stanza.
#[xml(attribute(default))]
from: Option<Jid>,
/// The recipient of this stanza.
#[xml(attribute(default))]
to: Option<Jid>,
/// The @id attribute of this stanza, which is required in order to match a
/// request with its result/error.
#[xml(attribute)]
id: String,
/// The payload content of this stanza.
#[xml(element(n = 1, default))]
payload: Option<Element>,
},
/// An `<iq type='error'/>` stanza.
#[xml(value = "error")]
Error {
/// The JID emitting this stanza.
#[xml(attribute(default))]
from: Option<Jid>,
/// The recipient of this stanza.
#[xml(attribute(default))]
to: Option<Jid>,
/// The @id attribute of this stanza, which is required in order to match a
/// request with its result/error.
#[xml(attribute)]
id: String,
/// The error carried by this stanza.
#[xml(child)]
error: StanzaError,
/// The optional payload content which caused the error.
///
/// As per
/// [RFC 6120 § 8.3.1](https://datatracker.ietf.org/doc/html/rfc6120#section-8.3.1),
/// the emitter of an error stanza MAY include the original XML which
/// caused the error. However, recipients MUST NOT rely on this.
#[xml(element(n = 1, default))]
payload: Option<Element>,
},
}
impl Iq {
/// Assemble a new Iq stanza from an [`IqHeader`] and the given
/// [`IqPayload`].
pub fn assemble(header: IqHeader, data: IqPayload) -> Self {
data.assemble(header)
}
/// Creates an `<iq/>` stanza containing a get request.
pub fn from_get<S: Into<String>>(id: S, payload: impl IqGetPayload) -> Iq {
Iq {
Iq::Get {
from: None,
to: None,
id: id.into(),
payload: IqType::Get(payload.into()),
payload: payload.into(),
}
}
/// Creates an `<iq/>` stanza containing a set request.
pub fn from_set<S: Into<String>>(id: S, payload: impl IqSetPayload) -> Iq {
Iq {
Iq::Set {
from: None,
to: None,
id: id.into(),
payload: IqType::Set(payload.into()),
payload: payload.into(),
}
}
/// Creates an empty `<iq type="result"/>` stanza.
pub fn empty_result<S: Into<String>>(to: Jid, id: S) -> Iq {
Iq {
Iq::Result {
from: None,
to: Some(to),
id: id.into(),
payload: IqType::Result(None),
payload: None,
}
}
/// Creates an `<iq/>` stanza containing a result.
pub fn from_result<S: Into<String>>(id: S, payload: Option<impl IqResultPayload>) -> Iq {
Iq {
Iq::Result {
from: None,
to: None,
id: id.into(),
payload: IqType::Result(payload.map(Into::into)),
payload: payload.map(Into::into),
}
}
/// Creates an `<iq/>` stanza containing an error.
pub fn from_error<S: Into<String>>(id: S, payload: StanzaError) -> Iq {
Iq {
Iq::Error {
from: None,
to: None,
id: id.into(),
payload: IqType::Error(payload),
error: payload,
payload: None,
}
}
/// Sets the recipient of this stanza.
pub fn with_to(mut self, to: Jid) -> Iq {
self.to = Some(to);
*self.to_mut() = Some(to);
self
}
/// Sets the emitter of this stanza.
pub fn with_from(mut self, from: Jid) -> Iq {
self.from = Some(from);
*self.from_mut() = Some(from);
self
}
/// Sets the id of this stanza, in order to later match its response.
pub fn with_id(mut self, id: String) -> Iq {
self.id = id;
*self.id_mut() = id;
self
}
}
impl TryFrom<Element> for Iq {
type Error = FromElementError;
fn try_from(root: Element) -> Result<Iq, FromElementError> {
check_self!(root, "iq", DEFAULT_NS);
let from = get_attr!(root, "from", Option);
let to = get_attr!(root, "to", Option);
let id = get_attr!(root, "id", Required);
let type_: String = get_attr!(root, "type", Required);
let mut payload = None;
let mut error_payload = None;
for elem in root.children() {
if payload.is_some() {
return Err(Error::Other("Wrong number of children in iq element.").into());
}
if type_ == "error" {
if elem.is("error", ns::DEFAULT_NS) {
if error_payload.is_some() {
return Err(Error::Other("Wrong number of children in iq element.").into());
}
error_payload = Some(StanzaError::try_from(elem.clone())?);
} else if root.children().count() != 2 {
return Err(Error::Other("Wrong number of children in iq element.").into());
}
} else {
payload = Some(elem.clone());
}
/// Access the sender address.
pub fn from(&self) -> Option<&Jid> {
match self {
Self::Get { from, .. }
| Self::Set { from, .. }
| Self::Result { from, .. }
| Self::Error { from, .. } => from.as_ref(),
}
let type_ = if type_ == "get" {
if let Some(payload) = payload {
IqType::Get(payload)
} else {
return Err(Error::Other("Wrong number of children in iq element.").into());
}
} else if type_ == "set" {
if let Some(payload) = payload {
IqType::Set(payload)
} else {
return Err(Error::Other("Wrong number of children in iq element.").into());
}
} else if type_ == "result" {
if let Some(payload) = payload {
IqType::Result(Some(payload))
} else {
IqType::Result(None)
}
} else if type_ == "error" {
if let Some(payload) = error_payload {
IqType::Error(payload)
} else {
return Err(Error::Other("Wrong number of children in iq element.").into());
}
} else {
return Err(Error::Other("Unknown iq type.").into());
};
Ok(Iq {
from,
to,
id,
payload: type_,
})
}
}
impl From<Iq> for Element {
fn from(iq: Iq) -> Element {
let mut stanza = Element::builder("iq", ns::DEFAULT_NS)
.attr("from", iq.from)
.attr("to", iq.to)
.attr("id", iq.id)
.attr("type", &iq.payload)
.build();
let elem = match iq.payload {
IqType::Get(elem) | IqType::Set(elem) | IqType::Result(Some(elem)) => elem,
IqType::Error(error) => error.into(),
IqType::Result(None) => return stanza,
};
stanza.append_child(elem);
stanza
}
}
impl ::xso::FromXml for Iq {
type Builder = ::xso::minidom_compat::FromEventsViaElement<Iq>;
fn from_events(
qname: ::xso::exports::rxml::QName,
attrs: ::xso::exports::rxml::AttrMap,
_ctx: &::xso::Context<'_>,
) -> Result<Self::Builder, ::xso::error::FromEventsError> {
if qname.0 != crate::ns::DEFAULT_NS || qname.1 != "iq" {
return Err(::xso::error::FromEventsError::Mismatch { name: qname, attrs });
/// Access the sender address, mutably.
pub fn from_mut(&mut self) -> &mut Option<Jid> {
match self {
Self::Get { ref mut from, .. }
| Self::Set { ref mut from, .. }
| Self::Result { ref mut from, .. }
| Self::Error { ref mut from, .. } => from,
}
Self::Builder::new(qname, attrs)
}
}
impl ::xso::AsXml for Iq {
type ItemIter<'x> = ::xso::minidom_compat::AsItemsViaElement<'x>;
/// Access the recipient address.
pub fn to(&self) -> Option<&Jid> {
match self {
Self::Get { to, .. }
| Self::Set { to, .. }
| Self::Result { to, .. }
| Self::Error { to, .. } => to.as_ref(),
}
}
fn as_xml_iter(&self) -> Result<Self::ItemIter<'_>, ::xso::error::Error> {
::xso::minidom_compat::AsItemsViaElement::new(self.clone())
/// Access the recipient address, mutably.
pub fn to_mut(&mut self) -> &mut Option<Jid> {
match self {
Self::Get { ref mut to, .. }
| Self::Set { ref mut to, .. }
| Self::Result { ref mut to, .. }
| Self::Error { ref mut to, .. } => to,
}
}
/// Access the id.
pub fn id(&self) -> &str {
match self {
Self::Get { id, .. }
| Self::Set { id, .. }
| Self::Result { id, .. }
| Self::Error { id, .. } => id.as_str(),
}
}
/// Access the id mutably.
pub fn id_mut(&mut self) -> &mut String {
match self {
Self::Get { ref mut id, .. }
| Self::Set { ref mut id, .. }
| Self::Result { ref mut id, .. }
| Self::Error { ref mut id, .. } => id,
}
}
/// Split the IQ stanza in its metadata and data.
///
/// Note that this discards the optional original error-inducing
/// [`payload`][`Self::Error::payload`] of the
/// [`Iq::Error`][`Self::Error`] variant.
pub fn split(self) -> (IqHeader, IqPayload) {
match self {
Self::Get {
from,
to,
id,
payload,
} => (IqHeader { from, to, id }, IqPayload::Get(payload)),
Self::Set {
from,
to,
id,
payload,
} => (IqHeader { from, to, id }, IqPayload::Set(payload)),
Self::Result {
from,
to,
id,
payload,
} => (IqHeader { from, to, id }, IqPayload::Result(payload)),
Self::Error {
from,
to,
id,
error,
payload: _,
} => (IqHeader { from, to, id }, IqPayload::Error(error)),
}
}
/// Return the [`IqHeader`] of this stanza, discarding the payload.
pub fn into_header(self) -> IqHeader {
self.split().0
}
/// Return the [`IqPayload`] of this stanza, discarding the header.
///
/// Note that this also discards the optional original error-inducing
/// [`payload`][`Self::Error::payload`] of the
/// [`Iq::Error`][`Self::Error`] variant.
pub fn into_payload(self) -> IqPayload {
self.split().1
}
}
@ -251,19 +376,22 @@ mod tests {
use super::*;
use crate::disco::DiscoInfoQuery;
use crate::stanza_error::{DefinedCondition, ErrorType};
use xso::error::{Error, FromElementError};
#[cfg(target_pointer_width = "32")]
#[test]
fn test_size() {
assert_size!(IqType, 108);
assert_size!(Iq, 152);
assert_size!(IqHeader, 44);
assert_size!(IqPayload, 108);
assert_size!(Iq, 212);
}
#[cfg(target_pointer_width = "64")]
#[test]
fn test_size() {
assert_size!(IqType, 216);
assert_size!(Iq, 304);
assert_size!(IqHeader, 88);
assert_size!(IqPayload, 216);
assert_size!(Iq, 424);
}
#[test]
@ -277,20 +405,29 @@ mod tests {
FromElementError::Invalid(Error::Other(string)) => string,
_ => panic!(),
};
assert_eq!(message, "Required attribute 'id' missing.");
assert_eq!(message, "Missing discriminator attribute.");
}
#[cfg(not(feature = "component"))]
let elem: Element = "<iq xmlns='jabber:client' id='coucou'/>".parse().unwrap();
#[cfg(feature = "component")]
let elem: Element = "<iq xmlns='jabber:component:accept' id='coucou'/>"
.parse()
.unwrap();
let error = Iq::try_from(elem).unwrap_err();
let message = match error {
FromElementError::Invalid(Error::Other(string)) => string,
_ => panic!(),
};
assert_eq!(message, "Required attribute 'type' missing.");
#[test]
fn test_require_id() {
for type_ in ["get", "set", "result", "error"] {
#[cfg(not(feature = "component"))]
let elem: Element = format!("<iq xmlns='jabber:client' type='{}'/>", type_)
.parse()
.unwrap();
#[cfg(feature = "component")]
let elem: Element = format!("<iq xmlns='jabber:component:accept' type='{}'/>", type_)
.parse()
.unwrap();
let error = Iq::try_from(elem).unwrap_err();
let message = match error {
FromElementError::Invalid(Error::Other(string)) => string,
_ => panic!(),
};
// Slicing here, because the rest of the error message is specific
// about the enum variant.
assert_eq!(&message[..33], "Required attribute field 'id' on ");
}
}
#[test]
@ -309,11 +446,11 @@ mod tests {
.unwrap();
let iq = Iq::try_from(elem).unwrap();
let query: Element = "<foo xmlns='bar'/>".parse().unwrap();
assert_eq!(iq.from, None);
assert_eq!(iq.to, None);
assert_eq!(&iq.id, "foo");
assert!(match iq.payload {
IqType::Get(element) => element == query,
assert_eq!(iq.from(), None);
assert_eq!(iq.to(), None);
assert_eq!(iq.id(), "foo");
assert!(match iq {
Iq::Get { payload, .. } => payload == query,
_ => false,
});
}
@ -334,11 +471,11 @@ mod tests {
.unwrap();
let iq = Iq::try_from(elem).unwrap();
let vcard: Element = "<vCard xmlns='vcard-temp'/>".parse().unwrap();
assert_eq!(iq.from, None);
assert_eq!(iq.to, None);
assert_eq!(&iq.id, "vcard");
assert!(match iq.payload {
IqType::Set(element) => element == vcard,
assert_eq!(iq.from(), None);
assert_eq!(iq.to(), None);
assert_eq!(iq.id(), "vcard");
assert!(match iq {
Iq::Set { payload, .. } => payload == vcard,
_ => false,
});
}
@ -354,11 +491,11 @@ mod tests {
.parse()
.unwrap();
let iq = Iq::try_from(elem).unwrap();
assert_eq!(iq.from, None);
assert_eq!(iq.to, None);
assert_eq!(&iq.id, "res");
assert!(match iq.payload {
IqType::Result(None) => true,
assert_eq!(iq.from(), None);
assert_eq!(iq.to(), None);
assert_eq!(iq.id(), "res");
assert!(match iq {
Iq::Result { payload: None, .. } => true,
_ => false,
});
}
@ -381,11 +518,14 @@ mod tests {
let query: Element = "<query xmlns='http://jabber.org/protocol/disco#items'/>"
.parse()
.unwrap();
assert_eq!(iq.from, None);
assert_eq!(iq.to, None);
assert_eq!(&iq.id, "res");
assert!(match iq.payload {
IqType::Result(Some(element)) => element == query,
assert_eq!(iq.from(), None);
assert_eq!(iq.to(), None);
assert_eq!(iq.id(), "res");
assert!(match iq {
Iq::Result {
payload: Some(element),
..
} => element == query,
_ => false,
});
}
@ -411,11 +551,11 @@ mod tests {
.parse()
.unwrap();
let iq = Iq::try_from(elem).unwrap();
assert_eq!(iq.from, None);
assert_eq!(iq.to, None);
assert_eq!(iq.id, "err1");
match iq.payload {
IqType::Error(error) => {
assert_eq!(iq.from(), None);
assert_eq!(iq.to(), None);
assert_eq!(iq.id(), "err1");
match iq {
Iq::Error { error, .. } => {
assert_eq!(error.type_, ErrorType::Cancel);
assert_eq!(error.by, None);
assert_eq!(
@ -444,7 +584,7 @@ mod tests {
FromElementError::Invalid(Error::Other(string)) => string,
_ => panic!(),
};
assert_eq!(message, "Wrong number of children in iq element.");
assert_eq!(message, "Missing child field 'error' in Iq::Error element.");
}
#[test]
@ -457,11 +597,11 @@ mod tests {
let elem: Element = "<iq xmlns='jabber:component:accept' type='result' id='res'/>"
.parse()
.unwrap();
let iq2 = Iq {
let iq2 = Iq::Result {
from: None,
to: None,
id: String::from("res"),
payload: IqType::Result(None),
payload: None,
};
let elem2 = iq2.into();
assert_eq!(elem, elem2);
@ -474,8 +614,8 @@ mod tests {
#[cfg(feature = "component")]
let elem: Element = "<iq xmlns='jabber:component:accept' type='get' id='disco'><query xmlns='http://jabber.org/protocol/disco#info'/></iq>".parse().unwrap();
let iq = Iq::try_from(elem).unwrap();
let disco_info = match iq.payload {
IqType::Get(payload) => DiscoInfoQuery::try_from(payload).unwrap(),
let disco_info = match iq {
Iq::Get { payload, .. } => DiscoInfoQuery::try_from(payload).unwrap(),
_ => panic!(),
};
assert!(disco_info.node.is_none());