2021-09-29 18:08:08 +00:00
|
|
|
|
// Copyright (c) 2017-2021 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
|
2017-04-29 21:14:34 +00:00
|
|
|
|
//
|
|
|
|
|
// 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/.
|
|
|
|
|
|
2018-12-18 14:27:30 +00:00
|
|
|
|
use crate::data_forms::DataForm;
|
|
|
|
|
use crate::forwarding::Forwarded;
|
2018-12-18 14:32:05 +00:00
|
|
|
|
use crate::iq::{IqGetPayload, IqResultPayload, IqSetPayload};
|
|
|
|
|
use crate::message::MessagePayload;
|
|
|
|
|
use crate::pubsub::NodeName;
|
|
|
|
|
use crate::rsm::{SetQuery, SetResult};
|
2017-04-29 05:07:00 +00:00
|
|
|
|
|
2018-08-02 18:05:35 +00:00
|
|
|
|
generate_id!(
|
|
|
|
|
/// An identifier matching a result message to the query requesting it.
|
|
|
|
|
QueryId
|
|
|
|
|
);
|
|
|
|
|
|
2018-05-28 14:45:13 +00:00
|
|
|
|
generate_element!(
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// Starts a query to the archive.
|
2018-05-28 14:29:51 +00:00
|
|
|
|
Query, "query", MAM,
|
|
|
|
|
attributes: [
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// An optional identifier for matching forwarded messages to this
|
|
|
|
|
/// query.
|
2019-02-24 19:26:40 +00:00
|
|
|
|
queryid: Option<QueryId> = "queryid",
|
2018-08-02 18:05:51 +00:00
|
|
|
|
|
|
|
|
|
/// Must be set to Some when querying a PubSub node’s archive.
|
2019-02-24 19:26:40 +00:00
|
|
|
|
node: Option<NodeName> = "node"
|
2018-05-28 14:29:51 +00:00
|
|
|
|
],
|
|
|
|
|
children: [
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// Used for filtering the results.
|
2018-05-28 14:29:51 +00:00
|
|
|
|
form: Option<DataForm> = ("x", DATA_FORMS) => DataForm,
|
2018-08-02 18:05:51 +00:00
|
|
|
|
|
|
|
|
|
/// Used for paging through results.
|
2018-08-02 18:35:15 +00:00
|
|
|
|
set: Option<SetQuery> = ("set", RSM) => SetQuery
|
2018-05-28 14:29:51 +00:00
|
|
|
|
]
|
|
|
|
|
);
|
2017-04-29 05:07:00 +00:00
|
|
|
|
|
2018-05-16 13:08:17 +00:00
|
|
|
|
impl IqGetPayload for Query {}
|
|
|
|
|
impl IqSetPayload for Query {}
|
|
|
|
|
impl IqResultPayload for Query {}
|
|
|
|
|
|
2018-05-28 14:45:13 +00:00
|
|
|
|
generate_element!(
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// The wrapper around forwarded stanzas.
|
2018-05-15 00:06:38 +00:00
|
|
|
|
Result_, "result", MAM,
|
|
|
|
|
attributes: [
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// The stanza-id under which the archive stored this stanza.
|
2019-02-24 19:26:40 +00:00
|
|
|
|
id: Required<String> = "id",
|
2018-08-02 18:05:51 +00:00
|
|
|
|
|
|
|
|
|
/// The same queryid as the one requested in the
|
|
|
|
|
/// [query](struct.Query.html).
|
2019-02-24 19:26:40 +00:00
|
|
|
|
queryid: Option<QueryId> = "queryid",
|
2018-05-15 00:06:38 +00:00
|
|
|
|
],
|
2018-05-28 14:29:51 +00:00
|
|
|
|
children: [
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// The actual stanza being forwarded.
|
2018-05-28 14:29:51 +00:00
|
|
|
|
forwarded: Required<Forwarded> = ("forwarded", FORWARD) => Forwarded
|
|
|
|
|
]
|
2018-05-15 00:06:38 +00:00
|
|
|
|
);
|
2017-04-29 05:07:00 +00:00
|
|
|
|
|
2018-09-20 18:58:27 +00:00
|
|
|
|
impl MessagePayload for Result_ {}
|
|
|
|
|
|
2018-05-28 14:29:51 +00:00
|
|
|
|
generate_attribute!(
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// True when the end of a MAM query has been reached.
|
2018-12-18 14:32:05 +00:00
|
|
|
|
Complete,
|
|
|
|
|
"complete",
|
|
|
|
|
bool
|
2018-05-28 14:29:51 +00:00
|
|
|
|
);
|
|
|
|
|
|
2018-05-28 14:45:13 +00:00
|
|
|
|
generate_element!(
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// Notes the end of a page in a query.
|
2018-05-28 14:29:51 +00:00
|
|
|
|
Fin, "fin", MAM,
|
|
|
|
|
attributes: [
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// True when the end of a MAM query has been reached.
|
2019-02-24 19:26:40 +00:00
|
|
|
|
complete: Default<Complete> = "complete",
|
2018-05-28 14:29:51 +00:00
|
|
|
|
],
|
|
|
|
|
children: [
|
2018-08-02 18:05:51 +00:00
|
|
|
|
/// Describes the current page, it should contain at least [first]
|
|
|
|
|
/// (with an [index]) and [last], and generally [count].
|
|
|
|
|
///
|
2018-08-02 18:35:15 +00:00
|
|
|
|
/// [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
|
2018-05-28 14:29:51 +00:00
|
|
|
|
]
|
|
|
|
|
);
|
2017-04-29 05:07:00 +00:00
|
|
|
|
|
2018-05-16 13:08:17 +00:00
|
|
|
|
impl IqResultPayload for Fin {}
|
|
|
|
|
|
2017-04-29 05:07:00 +00:00
|
|
|
|
#[cfg(test)]
|
|
|
|
|
mod tests {
|
2017-05-06 20:08:44 +00:00
|
|
|
|
use super::*;
|
2021-09-29 18:08:08 +00:00
|
|
|
|
use crate::util::error::Error;
|
|
|
|
|
use minidom::Element;
|
2017-04-29 05:07:00 +00:00
|
|
|
|
|
2018-10-28 12:10:48 +00:00
|
|
|
|
#[cfg(target_pointer_width = "32")]
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_size() {
|
|
|
|
|
assert_size!(QueryId, 12);
|
|
|
|
|
assert_size!(Query, 116);
|
2023-06-20 12:14:15 +00:00
|
|
|
|
assert_size!(Result_, 176);
|
2018-10-28 12:10:48 +00:00
|
|
|
|
assert_size!(Complete, 1);
|
|
|
|
|
assert_size!(Fin, 44);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[cfg(target_pointer_width = "64")]
|
2018-10-26 12:26:16 +00:00
|
|
|
|
#[test]
|
|
|
|
|
fn test_size() {
|
|
|
|
|
assert_size!(QueryId, 24);
|
|
|
|
|
assert_size!(Query, 232);
|
2023-06-20 12:08:58 +00:00
|
|
|
|
assert_size!(Result_, 336);
|
2018-10-26 12:26:16 +00:00
|
|
|
|
assert_size!(Complete, 1);
|
|
|
|
|
assert_size!(Fin, 88);
|
|
|
|
|
}
|
|
|
|
|
|
2017-04-29 05:07:00 +00:00
|
|
|
|
#[test]
|
2017-04-29 05:41:55 +00:00
|
|
|
|
fn test_query() {
|
|
|
|
|
let elem: Element = "<query xmlns='urn:xmpp:mam:2'/>".parse().unwrap();
|
2017-05-23 22:31:33 +00:00
|
|
|
|
Query::try_from(elem).unwrap();
|
2017-04-29 05:07:00 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
2017-04-29 05:41:55 +00:00
|
|
|
|
fn test_result() {
|
2017-07-29 05:49:02 +00:00
|
|
|
|
#[cfg(not(feature = "component"))]
|
2022-03-22 22:29:25 +00:00
|
|
|
|
let elem: Element = r#"<result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'>
|
2017-04-29 05:41:55 +00:00
|
|
|
|
<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>
|
2018-12-18 14:32:05 +00:00
|
|
|
|
"#
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
2017-07-29 05:49:02 +00:00
|
|
|
|
#[cfg(feature = "component")]
|
2022-03-22 22:29:25 +00:00
|
|
|
|
let elem: Element = r#"<result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'>
|
2017-07-29 05:49:02 +00:00
|
|
|
|
<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>
|
2017-04-29 05:41:55 +00:00
|
|
|
|
"#.parse().unwrap();
|
2017-05-23 22:31:33 +00:00
|
|
|
|
Result_::try_from(elem).unwrap();
|
2017-04-29 05:41:55 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_fin() {
|
2022-03-22 22:29:25 +00:00
|
|
|
|
let elem: Element = r#"<fin xmlns='urn:xmpp:mam:2'>
|
2017-04-29 05:41:55 +00:00
|
|
|
|
<set xmlns='http://jabber.org/protocol/rsm'>
|
|
|
|
|
<first index='0'>28482-98726-73623</first>
|
|
|
|
|
<last>09af3-cc343-b409f</last>
|
|
|
|
|
</set>
|
|
|
|
|
</fin>
|
2018-12-18 14:32:05 +00:00
|
|
|
|
"#
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
2017-05-23 22:31:33 +00:00
|
|
|
|
Fin::try_from(elem).unwrap();
|
2017-04-29 05:41:55 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_query_x() {
|
2022-03-22 22:29:25 +00:00
|
|
|
|
let elem: Element = r#"<query xmlns='urn:xmpp:mam:2'>
|
2017-04-29 05:41:55 +00:00
|
|
|
|
<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>
|
2018-12-18 14:32:05 +00:00
|
|
|
|
"#
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
2017-05-23 22:31:33 +00:00
|
|
|
|
Query::try_from(elem).unwrap();
|
2017-04-29 05:07:00 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
2017-04-29 05:41:55 +00:00
|
|
|
|
fn test_query_x_set() {
|
2022-03-22 22:29:25 +00:00
|
|
|
|
let elem: Element = r#"<query xmlns='urn:xmpp:mam:2'>
|
2017-04-29 05:41:55 +00:00
|
|
|
|
<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>
|
2018-12-18 14:32:05 +00:00
|
|
|
|
"#
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
2017-05-23 22:31:33 +00:00
|
|
|
|
Query::try_from(elem).unwrap();
|
2017-04-29 05:41:55 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_invalid_child() {
|
2018-12-18 14:32:05 +00:00
|
|
|
|
let elem: Element = "<query xmlns='urn:xmpp:mam:2'><coucou/></query>"
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
2017-05-23 22:31:33 +00:00
|
|
|
|
let error = Query::try_from(elem).unwrap_err();
|
2017-04-29 05:07:00 +00:00
|
|
|
|
let message = match error {
|
|
|
|
|
Error::ParseError(string) => string,
|
|
|
|
|
_ => panic!(),
|
|
|
|
|
};
|
2017-04-29 05:41:55 +00:00
|
|
|
|
assert_eq!(message, "Unknown child in query element.");
|
2017-04-29 05:07:00 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
2019-11-22 16:31:25 +00:00
|
|
|
|
fn test_serialise_empty() {
|
2017-04-29 05:41:55 +00:00
|
|
|
|
let elem: Element = "<query xmlns='urn:xmpp:mam:2'/>".parse().unwrap();
|
2018-12-18 14:32:05 +00:00
|
|
|
|
let replace = Query {
|
|
|
|
|
queryid: None,
|
|
|
|
|
node: None,
|
|
|
|
|
form: None,
|
|
|
|
|
set: None,
|
|
|
|
|
};
|
2017-05-23 22:31:33 +00:00
|
|
|
|
let elem2 = replace.into();
|
2017-04-29 05:07:00 +00:00
|
|
|
|
assert_eq!(elem, elem2);
|
|
|
|
|
}
|
2019-11-22 16:31:25 +00:00
|
|
|
|
|
|
|
|
|
#[test]
|
2019-12-05 20:41:43 +00:00
|
|
|
|
fn test_serialize_query_with_form() {
|
2019-11-27 17:16:51 +00:00
|
|
|
|
let reference: Element = "<query xmlns='urn:xmpp:mam:2'><x xmlns='jabber:x:data' type='submit'><field xmlns='jabber:x:data' var='FORM_TYPE' type='hidden'><value xmlns='jabber:x:data'>urn:xmpp:mam:2</value></field><field xmlns='jabber:x:data' var='with'><value xmlns='jabber:x:data'>juliet@capulet.lit</value></field></x></query>"
|
2019-11-22 16:31:25 +00:00
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
|
|
|
|
|
2019-12-05 20:41:43 +00:00
|
|
|
|
let elem: Element = "<x xmlns='jabber:x:data' type='submit'><field xmlns='jabber:x:data' var='FORM_TYPE' type='hidden'><value xmlns='jabber:x:data'>urn:xmpp:mam:2</value></field><field xmlns='jabber:x:data' var='with'><value xmlns='jabber:x:data'>juliet@capulet.lit</value></field></x>"
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
|
|
let form = DataForm::try_from(elem).unwrap();
|
|
|
|
|
|
2019-12-05 21:24:25 +00:00
|
|
|
|
let query = Query {
|
2019-11-22 16:31:25 +00:00
|
|
|
|
queryid: None,
|
|
|
|
|
node: None,
|
|
|
|
|
set: None,
|
|
|
|
|
form: Some(form),
|
|
|
|
|
};
|
2019-12-05 21:24:25 +00:00
|
|
|
|
let serialized: Element = query.into();
|
2019-11-27 17:16:51 +00:00
|
|
|
|
assert_eq!(serialized, reference);
|
2019-11-22 16:31:25 +00:00
|
|
|
|
}
|
2019-11-28 17:00:40 +00:00
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_serialize_result() {
|
2019-12-05 20:41:43 +00:00
|
|
|
|
let reference: Element = "<result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'><forwarded xmlns='urn:xmpp:forward:0'><delay xmlns='urn:xmpp:delay' stamp='2002-09-10T23:08:25+00:00'/><message xmlns='jabber:client' to='juliet@capulet.example/balcony' from='romeo@montague.example/home'/></forwarded></result>"
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
|
|
let elem: Element = "<forwarded xmlns='urn:xmpp:forward:0'><delay xmlns='urn:xmpp:delay' stamp='2002-09-10T23:08:25+00:00'/><message xmlns='jabber:client' to='juliet@capulet.example/balcony' from='romeo@montague.example/home'/></forwarded>"
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
|
|
let forwarded = Forwarded::try_from(elem).unwrap();
|
|
|
|
|
|
|
|
|
|
let result = Result_ {
|
2019-12-30 05:55:32 +00:00
|
|
|
|
id: String::from("28482-98726-73623"),
|
|
|
|
|
queryid: Some(QueryId(String::from("f27"))),
|
|
|
|
|
forwarded: forwarded,
|
2019-12-05 20:41:43 +00:00
|
|
|
|
};
|
|
|
|
|
let serialized: Element = result.into();
|
|
|
|
|
assert_eq!(serialized, reference);
|
2019-11-28 17:00:40 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_serialize_fin() {
|
2019-12-05 20:41:43 +00:00
|
|
|
|
let reference: Element = "<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();
|
|
|
|
|
|
|
|
|
|
let elem: Element = "<set xmlns='http://jabber.org/protocol/rsm'><first index='0'>28482-98726-73623</first><last>09af3-cc343-b409f</last></set>"
|
|
|
|
|
.parse()
|
|
|
|
|
.unwrap();
|
|
|
|
|
|
|
|
|
|
let set = SetResult::try_from(elem).unwrap();
|
|
|
|
|
|
|
|
|
|
let fin = Fin {
|
2019-12-30 05:55:32 +00:00
|
|
|
|
set: set,
|
|
|
|
|
complete: Complete::default(),
|
2019-12-05 20:41:43 +00:00
|
|
|
|
};
|
|
|
|
|
let serialized: Element = fin.into();
|
|
|
|
|
assert_eq!(serialized, reference);
|
2019-11-28 17:00:40 +00:00
|
|
|
|
}
|
2017-04-29 05:07:00 +00:00
|
|
|
|
}
|