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! generate_id {
129 ($elem:ident) => (
130 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
131 pub struct $elem(pub String);
132 impl FromStr for $elem {
133 type Err = Error;
134 fn from_str(s: &str) -> Result<$elem, Error> {
135 // TODO: add a way to parse that differently when needed.
136 Ok($elem(String::from(s)))
137 }
138 }
139 impl IntoAttributeValue for $elem {
140 fn into_attribute_value(self) -> Option<String> {
141 Some(self.0)
142 }
143 }
144 );
145}
146
147macro_rules! generate_elem_id {
148 ($elem:ident, $name:tt, $ns:expr) => (
149 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
150 pub struct $elem(pub String);
151 impl FromStr for $elem {
152 type Err = Error;
153 fn from_str(s: &str) -> Result<$elem, Error> {
154 // TODO: add a way to parse that differently when needed.
155 Ok($elem(String::from(s)))
156 }
157 }
158 impl From<$elem> for Element {
159 fn from(elem: $elem) -> Element {
160 Element::builder($name)
161 .ns($ns)
162 .append(elem.0)
163 .build()
164 }
165 }
166 );
167}
168
169/// Error type returned by every parser on failure.
170pub mod error;
171/// XML namespace definitions used through XMPP.
172pub mod ns;
173
174/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
175pub mod message;
176/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
177pub mod presence;
178/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
179pub mod iq;
180/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
181pub mod stanza_error;
182
183/// RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence
184pub mod roster;
185
186/// XEP-0004: Data Forms
187pub mod data_forms;
188
189/// XEP-0030: Service Discovery
190pub mod disco;
191
192/// XEP-0045: Multi-User Chat
193pub mod muc;
194
195/// XEP-0047: In-Band Bytestreams
196pub mod ibb;
197
198/// XEP-0059: Result Set Management
199pub mod rsm;
200
201/// XEP-0060: Publish-Subscribe
202pub mod pubsub;
203
204/// XEP-0077: In-Band Registration
205pub mod ibr;
206
207/// XEP-0085: Chat State Notifications
208pub mod chatstates;
209
210/// XEP-0115: Entity Capabilities
211pub mod caps;
212
213/// XEP-0166: Jingle
214pub mod jingle;
215
216/// XEP-0184: Message Delivery Receipts
217pub mod receipts;
218
219/// XEP-0199: XMPP Ping
220pub mod ping;
221
222/// XEP-0203: Delayed Delivery
223pub mod delay;
224
225/// XEP-0221: Data Forms Media Element
226pub mod media_element;
227
228/// XEP-0224: Attention
229pub mod attention;
230
231/// XEP-0234: Jingle File Transfer
232pub mod jingle_ft;
233
234/// XEP-0260: Jingle SOCKS5 Bytestreams Transport Method
235pub mod jingle_s5b;
236
237/// XEP-0261: Jingle In-Band Bytestreams Transport Method
238pub mod jingle_ibb;
239
240/// XEP-0297: Stanza Forwarding
241pub mod forwarding;
242
243/// XEP-0300: Use of Cryptographic Hash Functions in XMPP
244pub mod hashes;
245
246/// XEP-0308: Last Message Correction
247pub mod message_correct;
248
249/// XEP-0313: Message Archive Management
250pub mod mam;
251
252/// XEP-0319: Last User Interaction in Presence
253pub mod idle;
254
255/// XEP-0353: Jingle Message Initiation
256pub mod jingle_message;
257
258/// XEP-0359: Unique and Stable Stanza IDs
259pub mod stanza_id;
260
261/// XEP-0380: Explicit Message Encryption
262pub mod eme;
263
264/// XEP-0390: Entity Capabilities 2.0
265pub mod ecaps2;