1//! A crate parsing common XMPP elements into Rust structures.
2//!
3//! Each module implements the [`TryFrom<Element>`] trait, which takes a
4//! minidom [`Element`] and returns a `Result` whose value is `Ok` if the
5//! element parsed correctly, `Err(error::Error)` otherwise.
6//!
7//! The returned structure can be manipuled as any Rust structure, with each
8//! field being public. You can also create the same structure manually, with
9//! some having `new()` and `with_*()` helper methods to create them.
10//!
11//! Once you are happy with your structure, you can serialise it back to an
12//! [`Element`], using either `From` or `Into<Element>`, which give you what
13//! you want to be sending on the wire.
14//!
15//! [`TryFrom<Element>`]: ../try_from/trait.TryFrom.html
16//! [`Element`]: ../minidom/element/struct.Element.html
17
18// Copyright (c) 2017 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
19// Copyright (c) 2017 Maxime “pep” Buquet <pep+code@bouah.net>
20//
21// This Source Code Form is subject to the terms of the Mozilla Public
22// License, v. 2.0. If a copy of the MPL was not distributed with this
23// file, You can obtain one at http://mozilla.org/MPL/2.0/.
24
25extern crate minidom;
26extern crate jid;
27extern crate base64;
28extern crate digest;
29extern crate sha_1;
30extern crate sha2;
31extern crate sha3;
32extern crate blake2;
33extern crate chrono;
34extern crate try_from;
35
36macro_rules! get_attr {
37 ($elem:ident, $attr:tt, $type:tt) => (
38 get_attr!($elem, $attr, $type, value, value.parse()?)
39 );
40 ($elem:ident, $attr:tt, optional, $value:ident, $func:expr) => (
41 match $elem.attr($attr) {
42 Some($value) => Some($func),
43 None => None,
44 }
45 );
46 ($elem:ident, $attr:tt, required, $value:ident, $func:expr) => (
47 match $elem.attr($attr) {
48 Some($value) => $func,
49 None => return Err(Error::ParseError(concat!("Required attribute '", $attr, "' missing."))),
50 }
51 );
52 ($elem:ident, $attr:tt, default, $value:ident, $func:expr) => (
53 match $elem.attr($attr) {
54 Some($value) => $func,
55 None => Default::default(),
56 }
57 );
58}
59
60macro_rules! generate_attribute {
61 ($elem:ident, $name:tt, {$($a:ident => $b:tt),+,}) => (
62 generate_attribute!($elem, $name, {$($a => $b),+});
63 );
64 ($elem:ident, $name:tt, {$($a:ident => $b:tt),+,}, Default = $default:ident) => (
65 generate_attribute!($elem, $name, {$($a => $b),+}, Default = $default);
66 );
67 ($elem:ident, $name:tt, {$($a:ident => $b:tt),+}) => (
68 #[derive(Debug, Clone, PartialEq)]
69 pub enum $elem {
70 $(
71 #[doc=$b]
72 #[doc="value for this attribute."]
73 $a
74 ),+
75 }
76 impl FromStr for $elem {
77 type Err = Error;
78 fn from_str(s: &str) -> Result<$elem, Error> {
79 Ok(match s {
80 $($b => $elem::$a),+,
81 _ => return Err(Error::ParseError(concat!("Unknown value for '", $name, "' attribute."))),
82 })
83 }
84 }
85 impl IntoAttributeValue for $elem {
86 fn into_attribute_value(self) -> Option<String> {
87 Some(String::from(match self {
88 $($elem::$a => $b),+
89 }))
90 }
91 }
92 );
93 ($elem:ident, $name:tt, {$($a:ident => $b:tt),+}, Default = $default:ident) => (
94 #[derive(Debug, Clone, PartialEq)]
95 pub enum $elem {
96 $(
97 #[doc=$b]
98 #[doc="value for this attribute."]
99 $a
100 ),+
101 }
102 impl FromStr for $elem {
103 type Err = Error;
104 fn from_str(s: &str) -> Result<$elem, Error> {
105 Ok(match s {
106 $($b => $elem::$a),+,
107 _ => return Err(Error::ParseError(concat!("Unknown value for '", $name, "' attribute."))),
108 })
109 }
110 }
111 impl IntoAttributeValue for $elem {
112 #[allow(unreachable_patterns)]
113 fn into_attribute_value(self) -> Option<String> {
114 Some(String::from(match self {
115 $elem::$default => return None,
116 $($elem::$a => $b),+
117 }))
118 }
119 }
120 impl Default for $elem {
121 fn default() -> $elem {
122 $elem::$default
123 }
124 }
125 );
126}
127
128macro_rules! check_self {
129 ($elem:ident, $name:tt, $ns:expr) => (
130 if !$elem.is($name, $ns) {
131 return Err(Error::ParseError(concat!("This is not a ", $name, " element.")));
132 }
133 );
134 ($elem:ident, $name:tt, $ns:expr, $pretty_name:tt) => (
135 if !$elem.is($name, $ns) {
136 return Err(Error::ParseError(concat!("This is not a ", $pretty_name, " element.")));
137 }
138 );
139}
140
141macro_rules! check_ns_only {
142 ($elem:ident, $name:tt, $ns:expr) => (
143 if !$elem.has_ns($ns) {
144 return Err(Error::ParseError(concat!("This is not a ", $name, " element.")));
145 }
146 );
147}
148
149macro_rules! check_no_children {
150 ($elem:ident, $name:tt) => (
151 for _ in $elem.children() {
152 return Err(Error::ParseError(concat!("Unknown child in ", $name, " element.")));
153 }
154 );
155}
156
157macro_rules! check_no_attributes {
158 ($elem:ident, $name:tt) => (
159 check_no_unknown_attributes!($elem, $name, []);
160 );
161}
162
163macro_rules! check_no_unknown_attributes {
164 ($elem:ident, $name:tt, [$($attr:tt),*]) => (
165 for (_attr, _) in $elem.attrs() {
166 $(
167 if _attr == $attr {
168 continue;
169 }
170 )*
171 return Err(Error::ParseError(concat!("Unknown attribute in ", $name, " element.")));
172 }
173 );
174}
175
176macro_rules! generate_empty_element {
177 ($elem:ident, $name:tt, $ns:expr) => (
178 // TODO: Find a better way to concatenate doc.
179 #[doc="Structure representing a "]
180 #[doc=$name]
181 #[doc=" element."]
182 #[derive(Debug, Clone)]
183 pub struct $elem;
184
185 impl TryFrom<Element> for $elem {
186 type Err = Error;
187
188 fn try_from(elem: Element) -> Result<$elem, Error> {
189 check_self!(elem, $name, $ns);
190 check_no_children!(elem, $name);
191 check_no_attributes!(elem, $name);
192 Ok($elem)
193 }
194 }
195
196 impl From<$elem> for Element {
197 fn from(_: $elem) -> Element {
198 Element::builder("attention")
199 .ns($ns)
200 .build()
201 }
202 }
203 );
204}
205
206macro_rules! generate_id {
207 ($elem:ident) => (
208 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
209 pub struct $elem(pub String);
210 impl FromStr for $elem {
211 type Err = Error;
212 fn from_str(s: &str) -> Result<$elem, Error> {
213 // TODO: add a way to parse that differently when needed.
214 Ok($elem(String::from(s)))
215 }
216 }
217 impl IntoAttributeValue for $elem {
218 fn into_attribute_value(self) -> Option<String> {
219 Some(self.0)
220 }
221 }
222 );
223}
224
225macro_rules! generate_elem_id {
226 ($elem:ident, $name:tt, $ns:expr) => (
227 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
228 pub struct $elem(pub String);
229 impl FromStr for $elem {
230 type Err = Error;
231 fn from_str(s: &str) -> Result<$elem, Error> {
232 // TODO: add a way to parse that differently when needed.
233 Ok($elem(String::from(s)))
234 }
235 }
236 impl From<$elem> for Element {
237 fn from(elem: $elem) -> Element {
238 Element::builder($name)
239 .ns($ns)
240 .append(elem.0)
241 .build()
242 }
243 }
244 );
245}
246
247/// Error type returned by every parser on failure.
248pub mod error;
249/// XML namespace definitions used through XMPP.
250pub mod ns;
251
252#[cfg(test)]
253/// Namespace-aware comparison for tests
254mod compare_elements;
255
256/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
257pub mod message;
258/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
259pub mod presence;
260/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
261pub mod iq;
262/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
263pub mod stanza_error;
264
265/// RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence
266pub mod roster;
267
268/// XEP-0004: Data Forms
269pub mod data_forms;
270
271/// XEP-0030: Service Discovery
272pub mod disco;
273
274/// XEP-0045: Multi-User Chat
275pub mod muc;
276
277/// XEP-0047: In-Band Bytestreams
278pub mod ibb;
279
280/// XEP-0059: Result Set Management
281pub mod rsm;
282
283/// XEP-0060: Publish-Subscribe
284pub mod pubsub;
285
286/// XEP-0077: In-Band Registration
287pub mod ibr;
288
289/// XEP-0085: Chat State Notifications
290pub mod chatstates;
291
292/// XEP-0092: Software Version
293pub mod version;
294
295/// XEP-0115: Entity Capabilities
296pub mod caps;
297
298/// XEP-0166: Jingle
299pub mod jingle;
300
301/// XEP-0184: Message Delivery Receipts
302pub mod receipts;
303
304/// XEP-0191: Blocking Command
305pub mod blocking;
306
307/// XEP-0199: XMPP Ping
308pub mod ping;
309
310/// XEP-0203: Delayed Delivery
311pub mod delay;
312
313/// XEP-0221: Data Forms Media Element
314pub mod media_element;
315
316/// XEP-0224: Attention
317pub mod attention;
318
319/// XEP-0234: Jingle File Transfer
320pub mod jingle_ft;
321
322/// XEP-0260: Jingle SOCKS5 Bytestreams Transport Method
323pub mod jingle_s5b;
324
325/// XEP-0261: Jingle In-Band Bytestreams Transport Method
326pub mod jingle_ibb;
327
328/// XEP-0297: Stanza Forwarding
329pub mod forwarding;
330
331/// XEP-0300: Use of Cryptographic Hash Functions in XMPP
332pub mod hashes;
333
334/// XEP-0308: Last Message Correction
335pub mod message_correct;
336
337/// XEP-0313: Message Archive Management
338pub mod mam;
339
340/// XEP-0319: Last User Interaction in Presence
341pub mod idle;
342
343/// XEP-0353: Jingle Message Initiation
344pub mod jingle_message;
345
346/// XEP-0359: Unique and Stable Stanza IDs
347pub mod stanza_id;
348
349/// XEP-0380: Explicit Message Encryption
350pub mod eme;
351
352/// XEP-0390: Entity Capabilities 2.0
353pub mod ecaps2;