Prepare for merge: Move all xmpp-parsers files into xmpp-parsers/
Signed-off-by: Maxime “pep” Buquet <pep@bouah.net>
This commit is contained in:
Maxime “pep” Buquet
parent
8a13d7f010
commit
dc76f296de
79 changed files with 0 additions and 0 deletions
392
src/mam.rs
392
src/mam.rs
|
|
@ -1,392 +0,0 @@
|
|||
// Copyright (c) 2017 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::data_forms::DataForm;
|
||||
use crate::util::error::Error;
|
||||
use crate::forwarding::Forwarded;
|
||||
use crate::iq::{IqGetPayload, IqResultPayload, IqSetPayload};
|
||||
use crate::message::MessagePayload;
|
||||
use crate::ns;
|
||||
use crate::pubsub::NodeName;
|
||||
use crate::rsm::{SetQuery, SetResult};
|
||||
use jid::Jid;
|
||||
use minidom::{Element, Node};
|
||||
use std::convert::TryFrom;
|
||||
|
||||
generate_id!(
|
||||
/// An identifier matching a result message to the query requesting it.
|
||||
QueryId
|
||||
);
|
||||
|
||||
generate_element!(
|
||||
/// Starts a query to the archive.
|
||||
Query, "query", MAM,
|
||||
attributes: [
|
||||
/// An optional identifier for matching forwarded messages to this
|
||||
/// query.
|
||||
queryid: Option<QueryId> = "queryid",
|
||||
|
||||
/// Must be set to Some when querying a PubSub node’s archive.
|
||||
node: Option<NodeName> = "node"
|
||||
],
|
||||
children: [
|
||||
/// Used for filtering the results.
|
||||
form: Option<DataForm> = ("x", DATA_FORMS) => DataForm,
|
||||
|
||||
/// Used for paging through results.
|
||||
set: Option<SetQuery> = ("set", RSM) => SetQuery
|
||||
]
|
||||
);
|
||||
|
||||
impl IqGetPayload for Query {}
|
||||
impl IqSetPayload for Query {}
|
||||
impl IqResultPayload for Query {}
|
||||
|
||||
generate_element!(
|
||||
/// The wrapper around forwarded stanzas.
|
||||
Result_, "result", MAM,
|
||||
attributes: [
|
||||
/// The stanza-id under which the archive stored this stanza.
|
||||
id: Required<String> = "id",
|
||||
|
||||
/// The same queryid as the one requested in the
|
||||
/// [query](struct.Query.html).
|
||||
queryid: Option<QueryId> = "queryid",
|
||||
],
|
||||
children: [
|
||||
/// The actual stanza being forwarded.
|
||||
forwarded: Required<Forwarded> = ("forwarded", FORWARD) => Forwarded
|
||||
]
|
||||
);
|
||||
|
||||
impl MessagePayload for Result_ {}
|
||||
|
||||
generate_attribute!(
|
||||
/// True when the end of a MAM query has been reached.
|
||||
Complete,
|
||||
"complete",
|
||||
bool
|
||||
);
|
||||
|
||||
generate_element!(
|
||||
/// Notes the end of a page in a query.
|
||||
Fin, "fin", MAM,
|
||||
attributes: [
|
||||
/// True when the end of a MAM query has been reached.
|
||||
complete: Default<Complete> = "complete",
|
||||
],
|
||||
children: [
|
||||
/// Describes the current page, it should contain at least [first]
|
||||
/// (with an [index]) and [last], and generally [count].
|
||||
///
|
||||
/// [first]: ../rsm/struct.SetResult.html#structfield.first
|
||||
/// [index]: ../rsm/struct.SetResult.html#structfield.first_index
|
||||
/// [last]: ../rsm/struct.SetResult.html#structfield.last
|
||||
/// [count]: ../rsm/struct.SetResult.html#structfield.count
|
||||
set: Required<SetResult> = ("set", RSM) => SetResult
|
||||
]
|
||||
);
|
||||
|
||||
impl IqResultPayload for Fin {}
|
||||
|
||||
generate_attribute!(
|
||||
/// Notes the default archiving preference for the user.
|
||||
DefaultPrefs, "default", {
|
||||
/// The default is to always log messages in the archive.
|
||||
Always => "always",
|
||||
|
||||
/// The default is to never log messages in the archive.
|
||||
Never => "never",
|
||||
|
||||
/// The default is to log messages in the archive only for contacts
|
||||
/// present in the user’s [roster](../roster/index.html).
|
||||
Roster => "roster",
|
||||
}
|
||||
);
|
||||
|
||||
/// Controls the archiving preferences of the user.
|
||||
#[derive(Debug, Clone)]
|
||||
pub struct Prefs {
|
||||
/// The default preference for JIDs in neither
|
||||
/// [always](#structfield.always) or [never](#structfield.never) lists.
|
||||
pub default_: DefaultPrefs,
|
||||
|
||||
/// The set of JIDs for which to always store messages in the archive.
|
||||
pub always: Vec<Jid>,
|
||||
|
||||
/// The set of JIDs for which to never store messages in the archive.
|
||||
pub never: Vec<Jid>,
|
||||
}
|
||||
|
||||
impl IqGetPayload for Prefs {}
|
||||
impl IqSetPayload for Prefs {}
|
||||
impl IqResultPayload for Prefs {}
|
||||
|
||||
impl TryFrom<Element> for Prefs {
|
||||
type Error = Error;
|
||||
|
||||
fn try_from(elem: Element) -> Result<Prefs, Error> {
|
||||
check_self!(elem, "prefs", MAM);
|
||||
check_no_unknown_attributes!(elem, "prefs", ["default"]);
|
||||
let mut always = vec![];
|
||||
let mut never = vec![];
|
||||
for child in elem.children() {
|
||||
if child.is("always", ns::MAM) {
|
||||
for jid_elem in child.children() {
|
||||
if !jid_elem.is("jid", ns::MAM) {
|
||||
return Err(Error::ParseError("Invalid jid element in always."));
|
||||
}
|
||||
always.push(jid_elem.text().parse()?);
|
||||
}
|
||||
} else if child.is("never", ns::MAM) {
|
||||
for jid_elem in child.children() {
|
||||
if !jid_elem.is("jid", ns::MAM) {
|
||||
return Err(Error::ParseError("Invalid jid element in never."));
|
||||
}
|
||||
never.push(jid_elem.text().parse()?);
|
||||
}
|
||||
} else {
|
||||
return Err(Error::ParseError("Unknown child in prefs element."));
|
||||
}
|
||||
}
|
||||
let default_ = get_attr!(elem, "default", Required);
|
||||
Ok(Prefs {
|
||||
default_,
|
||||
always,
|
||||
never,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
fn serialise_jid_list(name: &str, jids: Vec<Jid>) -> ::std::option::IntoIter<Node> {
|
||||
if jids.is_empty() {
|
||||
None.into_iter()
|
||||
} else {
|
||||
Some(
|
||||
Element::builder(name)
|
||||
.ns(ns::MAM)
|
||||
.append_all(
|
||||
jids.into_iter()
|
||||
.map(|jid|
|
||||
Element::builder("jid")
|
||||
.ns(ns::MAM)
|
||||
.append(String::from(jid))))
|
||||
.into(),
|
||||
).into_iter()
|
||||
}
|
||||
}
|
||||
|
||||
impl From<Prefs> for Element {
|
||||
fn from(prefs: Prefs) -> Element {
|
||||
Element::builder("prefs")
|
||||
.ns(ns::MAM)
|
||||
.attr("default", prefs.default_)
|
||||
.append_all(serialise_jid_list("always", prefs.always))
|
||||
.append_all(serialise_jid_list("never", prefs.never))
|
||||
.build()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use std::str::FromStr;
|
||||
|
||||
#[cfg(target_pointer_width = "32")]
|
||||
#[test]
|
||||
fn test_size() {
|
||||
assert_size!(QueryId, 12);
|
||||
assert_size!(Query, 116);
|
||||
assert_size!(Result_, 236);
|
||||
assert_size!(Complete, 1);
|
||||
assert_size!(Fin, 44);
|
||||
assert_size!(DefaultPrefs, 1);
|
||||
assert_size!(Prefs, 28);
|
||||
}
|
||||
|
||||
#[cfg(target_pointer_width = "64")]
|
||||
#[test]
|
||||
fn test_size() {
|
||||
assert_size!(QueryId, 24);
|
||||
assert_size!(Query, 232);
|
||||
assert_size!(Result_, 456);
|
||||
assert_size!(Complete, 1);
|
||||
assert_size!(Fin, 88);
|
||||
assert_size!(DefaultPrefs, 1);
|
||||
assert_size!(Prefs, 56);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_query() {
|
||||
let elem: Element = "<query xmlns='urn:xmpp:mam:2'/>".parse().unwrap();
|
||||
Query::try_from(elem).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_result() {
|
||||
#[cfg(not(feature = "component"))]
|
||||
let elem: Element = r#"
|
||||
<result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'>
|
||||
<forwarded xmlns='urn:xmpp:forward:0'>
|
||||
<delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
|
||||
<message xmlns='jabber:client' from="witch@shakespeare.lit" to="macbeth@shakespeare.lit">
|
||||
<body>Hail to thee</body>
|
||||
</message>
|
||||
</forwarded>
|
||||
</result>
|
||||
"#
|
||||
.parse()
|
||||
.unwrap();
|
||||
#[cfg(feature = "component")]
|
||||
let elem: Element = r#"
|
||||
<result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'>
|
||||
<forwarded xmlns='urn:xmpp:forward:0'>
|
||||
<delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
|
||||
<message xmlns='jabber:component:accept' from="witch@shakespeare.lit" to="macbeth@shakespeare.lit">
|
||||
<body>Hail to thee</body>
|
||||
</message>
|
||||
</forwarded>
|
||||
</result>
|
||||
"#.parse().unwrap();
|
||||
Result_::try_from(elem).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_fin() {
|
||||
let elem: Element = r#"
|
||||
<fin xmlns='urn:xmpp:mam:2'>
|
||||
<set xmlns='http://jabber.org/protocol/rsm'>
|
||||
<first index='0'>28482-98726-73623</first>
|
||||
<last>09af3-cc343-b409f</last>
|
||||
</set>
|
||||
</fin>
|
||||
"#
|
||||
.parse()
|
||||
.unwrap();
|
||||
Fin::try_from(elem).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_query_x() {
|
||||
let elem: Element = r#"
|
||||
<query xmlns='urn:xmpp:mam:2'>
|
||||
<x xmlns='jabber:x:data' type='submit'>
|
||||
<field var='FORM_TYPE' type='hidden'>
|
||||
<value>urn:xmpp:mam:2</value>
|
||||
</field>
|
||||
<field var='with'>
|
||||
<value>juliet@capulet.lit</value>
|
||||
</field>
|
||||
</x>
|
||||
</query>
|
||||
"#
|
||||
.parse()
|
||||
.unwrap();
|
||||
Query::try_from(elem).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_query_x_set() {
|
||||
let elem: Element = r#"
|
||||
<query xmlns='urn:xmpp:mam:2'>
|
||||
<x xmlns='jabber:x:data' type='submit'>
|
||||
<field var='FORM_TYPE' type='hidden'>
|
||||
<value>urn:xmpp:mam:2</value>
|
||||
</field>
|
||||
<field var='start'>
|
||||
<value>2010-08-07T00:00:00Z</value>
|
||||
</field>
|
||||
</x>
|
||||
<set xmlns='http://jabber.org/protocol/rsm'>
|
||||
<max>10</max>
|
||||
</set>
|
||||
</query>
|
||||
"#
|
||||
.parse()
|
||||
.unwrap();
|
||||
Query::try_from(elem).unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_prefs_get() {
|
||||
let elem: Element = "<prefs xmlns='urn:xmpp:mam:2' default='always'/>"
|
||||
.parse()
|
||||
.unwrap();
|
||||
let prefs = Prefs::try_from(elem).unwrap();
|
||||
assert_eq!(prefs.always, vec!());
|
||||
assert_eq!(prefs.never, vec!());
|
||||
|
||||
let elem: Element = r#"
|
||||
<prefs xmlns='urn:xmpp:mam:2' default='roster'>
|
||||
<always/>
|
||||
<never/>
|
||||
</prefs>
|
||||
"#
|
||||
.parse()
|
||||
.unwrap();
|
||||
let prefs = Prefs::try_from(elem).unwrap();
|
||||
assert_eq!(prefs.always, vec!());
|
||||
assert_eq!(prefs.never, vec!());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_prefs_result() {
|
||||
let elem: Element = r#"
|
||||
<prefs xmlns='urn:xmpp:mam:2' default='roster'>
|
||||
<always>
|
||||
<jid>romeo@montague.lit</jid>
|
||||
</always>
|
||||
<never>
|
||||
<jid>montague@montague.lit</jid>
|
||||
</never>
|
||||
</prefs>
|
||||
"#
|
||||
.parse()
|
||||
.unwrap();
|
||||
let prefs = Prefs::try_from(elem).unwrap();
|
||||
assert_eq!(
|
||||
prefs.always,
|
||||
vec!(Jid::from_str("romeo@montague.lit").unwrap())
|
||||
);
|
||||
assert_eq!(
|
||||
prefs.never,
|
||||
vec!(Jid::from_str("montague@montague.lit").unwrap())
|
||||
);
|
||||
|
||||
let elem2 = Element::from(prefs.clone());
|
||||
println!("{:?}", elem2);
|
||||
let prefs2 = Prefs::try_from(elem2).unwrap();
|
||||
assert_eq!(prefs.default_, prefs2.default_);
|
||||
assert_eq!(prefs.always, prefs2.always);
|
||||
assert_eq!(prefs.never, prefs2.never);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_invalid_child() {
|
||||
let elem: Element = "<query xmlns='urn:xmpp:mam:2'><coucou/></query>"
|
||||
.parse()
|
||||
.unwrap();
|
||||
let error = Query::try_from(elem).unwrap_err();
|
||||
let message = match error {
|
||||
Error::ParseError(string) => string,
|
||||
_ => panic!(),
|
||||
};
|
||||
assert_eq!(message, "Unknown child in query element.");
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_serialise() {
|
||||
let elem: Element = "<query xmlns='urn:xmpp:mam:2'/>".parse().unwrap();
|
||||
let replace = Query {
|
||||
queryid: None,
|
||||
node: None,
|
||||
form: None,
|
||||
set: None,
|
||||
};
|
||||
let elem2 = replace.into();
|
||||
assert_eq!(elem, elem2);
|
||||
}
|
||||
}
|
||||
Loading…
Reference in a new issue