1// Copyright (c) 2017-2021 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7use crate::data_forms::DataForm;
8use crate::forwarding::Forwarded;
9use crate::iq::{IqGetPayload, IqResultPayload, IqSetPayload};
10use crate::message::MessagePayload;
11use crate::pubsub::NodeName;
12use crate::rsm::{SetQuery, SetResult};
13
14generate_id!(
15 /// An identifier matching a result message to the query requesting it.
16 QueryId
17);
18
19generate_element!(
20 /// Starts a query to the archive.
21 Query, "query", MAM,
22 attributes: [
23 /// An optional identifier for matching forwarded messages to this
24 /// query.
25 queryid: Option<QueryId> = "queryid",
26
27 /// Must be set to Some when querying a PubSub node’s archive.
28 node: Option<NodeName> = "node"
29 ],
30 children: [
31 /// Used for filtering the results.
32 form: Option<DataForm> = ("x", DATA_FORMS) => DataForm,
33
34 /// Used for paging through results.
35 set: Option<SetQuery> = ("set", RSM) => SetQuery
36 ]
37);
38
39impl IqGetPayload for Query {}
40impl IqSetPayload for Query {}
41impl IqResultPayload for Query {}
42
43generate_element!(
44 /// The wrapper around forwarded stanzas.
45 Result_, "result", MAM,
46 attributes: [
47 /// The stanza-id under which the archive stored this stanza.
48 id: Required<String> = "id",
49
50 /// The same queryid as the one requested in the
51 /// [query](struct.Query.html).
52 queryid: Option<QueryId> = "queryid",
53 ],
54 children: [
55 /// The actual stanza being forwarded.
56 forwarded: Required<Forwarded> = ("forwarded", FORWARD) => Forwarded
57 ]
58);
59
60impl MessagePayload for Result_ {}
61
62generate_attribute!(
63 /// True when the end of a MAM query has been reached.
64 Complete,
65 "complete",
66 bool
67);
68
69generate_element!(
70 /// Notes the end of a page in a query.
71 Fin, "fin", MAM,
72 attributes: [
73 /// True when the end of a MAM query has been reached.
74 complete: Default<Complete> = "complete",
75 ],
76 children: [
77 /// Describes the current page, it should contain at least [first]
78 /// (with an [index]) and [last], and generally [count].
79 ///
80 /// [first]: ../rsm/struct.SetResult.html#structfield.first
81 /// [index]: ../rsm/struct.SetResult.html#structfield.first_index
82 /// [last]: ../rsm/struct.SetResult.html#structfield.last
83 /// [count]: ../rsm/struct.SetResult.html#structfield.count
84 set: Required<SetResult> = ("set", RSM) => SetResult
85 ]
86);
87
88impl IqResultPayload for Fin {}
89
90#[cfg(test)]
91mod tests {
92 use super::*;
93 use crate::util::error::Error;
94 use minidom::Element;
95 use std::convert::TryFrom;
96
97 #[cfg(target_pointer_width = "32")]
98 #[test]
99 fn test_size() {
100 assert_size!(QueryId, 12);
101 assert_size!(Query, 116);
102 assert_size!(Result_, 236);
103 assert_size!(Complete, 1);
104 assert_size!(Fin, 44);
105 }
106
107 #[cfg(target_pointer_width = "64")]
108 #[test]
109 fn test_size() {
110 assert_size!(QueryId, 24);
111 assert_size!(Query, 232);
112 assert_size!(Result_, 456);
113 assert_size!(Complete, 1);
114 assert_size!(Fin, 88);
115 }
116
117 #[test]
118 fn test_query() {
119 let elem: Element = "<query xmlns='urn:xmpp:mam:2'/>".parse().unwrap();
120 Query::try_from(elem).unwrap();
121 }
122
123 #[test]
124 fn test_result() {
125 #[cfg(not(feature = "component"))]
126 let elem: Element = r#"
127<result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'>
128 <forwarded xmlns='urn:xmpp:forward:0'>
129 <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
130 <message xmlns='jabber:client' from="witch@shakespeare.lit" to="macbeth@shakespeare.lit">
131 <body>Hail to thee</body>
132 </message>
133 </forwarded>
134</result>
135"#
136 .parse()
137 .unwrap();
138 #[cfg(feature = "component")]
139 let elem: Element = r#"
140<result xmlns='urn:xmpp:mam:2' queryid='f27' id='28482-98726-73623'>
141 <forwarded xmlns='urn:xmpp:forward:0'>
142 <delay xmlns='urn:xmpp:delay' stamp='2010-07-10T23:08:25Z'/>
143 <message xmlns='jabber:component:accept' from="witch@shakespeare.lit" to="macbeth@shakespeare.lit">
144 <body>Hail to thee</body>
145 </message>
146 </forwarded>
147</result>
148"#.parse().unwrap();
149 Result_::try_from(elem).unwrap();
150 }
151
152 #[test]
153 fn test_fin() {
154 let elem: Element = r#"
155<fin xmlns='urn:xmpp:mam:2'>
156 <set xmlns='http://jabber.org/protocol/rsm'>
157 <first index='0'>28482-98726-73623</first>
158 <last>09af3-cc343-b409f</last>
159 </set>
160</fin>
161"#
162 .parse()
163 .unwrap();
164 Fin::try_from(elem).unwrap();
165 }
166
167 #[test]
168 fn test_query_x() {
169 let elem: Element = r#"
170<query xmlns='urn:xmpp:mam:2'>
171 <x xmlns='jabber:x:data' type='submit'>
172 <field var='FORM_TYPE' type='hidden'>
173 <value>urn:xmpp:mam:2</value>
174 </field>
175 <field var='with'>
176 <value>juliet@capulet.lit</value>
177 </field>
178 </x>
179</query>
180"#
181 .parse()
182 .unwrap();
183 Query::try_from(elem).unwrap();
184 }
185
186 #[test]
187 fn test_query_x_set() {
188 let elem: Element = r#"
189<query xmlns='urn:xmpp:mam:2'>
190 <x xmlns='jabber:x:data' type='submit'>
191 <field var='FORM_TYPE' type='hidden'>
192 <value>urn:xmpp:mam:2</value>
193 </field>
194 <field var='start'>
195 <value>2010-08-07T00:00:00Z</value>
196 </field>
197 </x>
198 <set xmlns='http://jabber.org/protocol/rsm'>
199 <max>10</max>
200 </set>
201</query>
202"#
203 .parse()
204 .unwrap();
205 Query::try_from(elem).unwrap();
206 }
207
208 #[test]
209 fn test_invalid_child() {
210 let elem: Element = "<query xmlns='urn:xmpp:mam:2'><coucou/></query>"
211 .parse()
212 .unwrap();
213 let error = Query::try_from(elem).unwrap_err();
214 let message = match error {
215 Error::ParseError(string) => string,
216 _ => panic!(),
217 };
218 assert_eq!(message, "Unknown child in query element.");
219 }
220
221 #[test]
222 fn test_serialise_empty() {
223 let elem: Element = "<query xmlns='urn:xmpp:mam:2'/>".parse().unwrap();
224 let replace = Query {
225 queryid: None,
226 node: None,
227 form: None,
228 set: None,
229 };
230 let elem2 = replace.into();
231 assert_eq!(elem, elem2);
232 }
233
234 #[test]
235 fn test_serialize_query_with_form() {
236 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>"
237 .parse()
238 .unwrap();
239
240 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>"
241 .parse()
242 .unwrap();
243
244 let form = DataForm::try_from(elem).unwrap();
245
246 let query = Query {
247 queryid: None,
248 node: None,
249 set: None,
250 form: Some(form),
251 };
252 let serialized: Element = query.into();
253 assert_eq!(serialized, reference);
254 }
255
256 #[test]
257 fn test_serialize_result() {
258 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>"
259 .parse()
260 .unwrap();
261
262 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>"
263 .parse()
264 .unwrap();
265
266 let forwarded = Forwarded::try_from(elem).unwrap();
267
268 let result = Result_ {
269 id: String::from("28482-98726-73623"),
270 queryid: Some(QueryId(String::from("f27"))),
271 forwarded: forwarded,
272 };
273 let serialized: Element = result.into();
274 assert_eq!(serialized, reference);
275 }
276
277 #[test]
278 fn test_serialize_fin() {
279 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>"
280 .parse()
281 .unwrap();
282
283 let elem: Element = "<set xmlns='http://jabber.org/protocol/rsm'><first index='0'>28482-98726-73623</first><last>09af3-cc343-b409f</last></set>"
284 .parse()
285 .unwrap();
286
287 let set = SetResult::try_from(elem).unwrap();
288
289 let fin = Fin {
290 set: set,
291 complete: Complete::default(),
292 };
293 let serialized: Element = fin.into();
294 assert_eq!(serialized, reference);
295 }
296}