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_no_children {
142 ($elem:ident, $name:tt) => (
143 for _ in $elem.children() {
144 return Err(Error::ParseError(concat!("Unknown child in ", $name, " element.")));
145 }
146 );
147}
148
149macro_rules! check_no_unknown_attributes {
150 ($elem:ident, $name:tt, [$($attr:tt),*]) => (
151 for (_attr, _) in $elem.attrs() {
152 $(
153 if _attr == $attr {
154 continue;
155 }
156 )*
157 return Err(Error::ParseError(concat!("Unknown attribute in ", $name, " element.")));
158 }
159 );
160}
161
162macro_rules! generate_empty_element {
163 ($elem:ident, $name:tt, $ns:expr) => (
164 // TODO: Find a better way to concatenate doc.
165 #[doc="Structure representing a "]
166 #[doc=$name]
167 #[doc=" element."]
168 #[derive(Debug, Clone)]
169 pub struct $elem;
170
171 impl TryFrom<Element> for $elem {
172 type Err = Error;
173
174 fn try_from(elem: Element) -> Result<$elem, Error> {
175 check_self!(elem, $name, $ns);
176 check_no_children!(elem, $name);
177 check_no_unknown_attributes!(elem, $name, []);
178 Ok($elem)
179 }
180 }
181
182 impl From<$elem> for Element {
183 fn from(_: $elem) -> Element {
184 Element::builder("attention")
185 .ns($ns)
186 .build()
187 }
188 }
189 );
190}
191
192macro_rules! generate_id {
193 ($elem:ident) => (
194 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
195 pub struct $elem(pub String);
196 impl FromStr for $elem {
197 type Err = Error;
198 fn from_str(s: &str) -> Result<$elem, Error> {
199 // TODO: add a way to parse that differently when needed.
200 Ok($elem(String::from(s)))
201 }
202 }
203 impl IntoAttributeValue for $elem {
204 fn into_attribute_value(self) -> Option<String> {
205 Some(self.0)
206 }
207 }
208 );
209}
210
211macro_rules! generate_elem_id {
212 ($elem:ident, $name:tt, $ns:expr) => (
213 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
214 pub struct $elem(pub String);
215 impl FromStr for $elem {
216 type Err = Error;
217 fn from_str(s: &str) -> Result<$elem, Error> {
218 // TODO: add a way to parse that differently when needed.
219 Ok($elem(String::from(s)))
220 }
221 }
222 impl From<$elem> for Element {
223 fn from(elem: $elem) -> Element {
224 Element::builder($name)
225 .ns($ns)
226 .append(elem.0)
227 .build()
228 }
229 }
230 );
231}
232
233/// Error type returned by every parser on failure.
234pub mod error;
235/// XML namespace definitions used through XMPP.
236pub mod ns;
237
238#[cfg(test)]
239/// Namespace-aware comparison for tests
240mod compare_elements;
241
242/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
243pub mod message;
244/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
245pub mod presence;
246/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
247pub mod iq;
248/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
249pub mod stanza_error;
250
251/// RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence
252pub mod roster;
253
254/// XEP-0004: Data Forms
255pub mod data_forms;
256
257/// XEP-0030: Service Discovery
258pub mod disco;
259
260/// XEP-0045: Multi-User Chat
261pub mod muc;
262
263/// XEP-0047: In-Band Bytestreams
264pub mod ibb;
265
266/// XEP-0059: Result Set Management
267pub mod rsm;
268
269/// XEP-0060: Publish-Subscribe
270pub mod pubsub;
271
272/// XEP-0077: In-Band Registration
273pub mod ibr;
274
275/// XEP-0085: Chat State Notifications
276pub mod chatstates;
277
278/// XEP-0092: Software Version
279pub mod version;
280
281/// XEP-0115: Entity Capabilities
282pub mod caps;
283
284/// XEP-0166: Jingle
285pub mod jingle;
286
287/// XEP-0184: Message Delivery Receipts
288pub mod receipts;
289
290/// XEP-0199: XMPP Ping
291pub mod ping;
292
293/// XEP-0203: Delayed Delivery
294pub mod delay;
295
296/// XEP-0221: Data Forms Media Element
297pub mod media_element;
298
299/// XEP-0224: Attention
300pub mod attention;
301
302/// XEP-0234: Jingle File Transfer
303pub mod jingle_ft;
304
305/// XEP-0260: Jingle SOCKS5 Bytestreams Transport Method
306pub mod jingle_s5b;
307
308/// XEP-0261: Jingle In-Band Bytestreams Transport Method
309pub mod jingle_ibb;
310
311/// XEP-0297: Stanza Forwarding
312pub mod forwarding;
313
314/// XEP-0300: Use of Cryptographic Hash Functions in XMPP
315pub mod hashes;
316
317/// XEP-0308: Last Message Correction
318pub mod message_correct;
319
320/// XEP-0313: Message Archive Management
321pub mod mam;
322
323/// XEP-0319: Last User Interaction in Presence
324pub mod idle;
325
326/// XEP-0353: Jingle Message Initiation
327pub mod jingle_message;
328
329/// XEP-0359: Unique and Stable Stanza IDs
330pub mod stanza_id;
331
332/// XEP-0380: Explicit Message Encryption
333pub mod eme;
334
335/// XEP-0390: Entity Capabilities 2.0
336pub mod ecaps2;