1// Copyright (c) 2017 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 try_from::TryFrom;
8use std::str::FromStr;
9use std::collections::BTreeMap;
10
11use minidom::{Element, IntoAttributeValue};
12
13use jid::Jid;
14
15use error::Error;
16
17use ns;
18
19use stanza_error::StanzaError;
20use chatstates::ChatState;
21use receipts::{Request as ReceiptRequest, Received as ReceiptReceived};
22use delay::Delay;
23use attention::Attention;
24use message_correct::Replace;
25use eme::ExplicitMessageEncryption;
26use stanza_id::{StanzaId, OriginId};
27use mam::Result_ as MamResult;
28
29/// Lists every known payload of a `<message/>`.
30#[derive(Debug, Clone)]
31pub enum MessagePayload {
32 StanzaError(StanzaError),
33 ChatState(ChatState),
34 ReceiptRequest(ReceiptRequest),
35 ReceiptReceived(ReceiptReceived),
36 Delay(Delay),
37 Attention(Attention),
38 MessageCorrect(Replace),
39 ExplicitMessageEncryption(ExplicitMessageEncryption),
40 StanzaId(StanzaId),
41 OriginId(OriginId),
42 MamResult(MamResult),
43
44 Unknown(Element),
45}
46
47impl TryFrom<Element> for MessagePayload {
48 type Err = Error;
49
50 fn try_from(elem: Element) -> Result<MessagePayload, Error> {
51 Ok(match (elem.name().as_ref(), elem.ns().unwrap().as_ref()) {
52 ("error", ns::DEFAULT_NS) => MessagePayload::StanzaError(StanzaError::try_from(elem)?),
53
54 // XEP-0085
55 ("active", ns::CHATSTATES)
56 | ("inactive", ns::CHATSTATES)
57 | ("composing", ns::CHATSTATES)
58 | ("paused", ns::CHATSTATES)
59 | ("gone", ns::CHATSTATES) => MessagePayload::ChatState(ChatState::try_from(elem)?),
60
61 // XEP-0184
62 ("request", ns::RECEIPTS) => MessagePayload::ReceiptRequest(ReceiptRequest::try_from(elem)?),
63 ("received", ns::RECEIPTS) => MessagePayload::ReceiptReceived(ReceiptReceived::try_from(elem)?),
64
65 // XEP-0203
66 ("delay", ns::DELAY) => MessagePayload::Delay(Delay::try_from(elem)?),
67
68 // XEP-0224
69 ("attention", ns::ATTENTION) => MessagePayload::Attention(Attention::try_from(elem)?),
70
71 // XEP-0308
72 ("replace", ns::MESSAGE_CORRECT) => MessagePayload::MessageCorrect(Replace::try_from(elem)?),
73
74 // XEP-0313
75 ("result", ns::MAM) => MessagePayload::MamResult(MamResult::try_from(elem)?),
76
77 // XEP-0359
78 ("stanza-id", ns::SID) => MessagePayload::StanzaId(StanzaId::try_from(elem)?),
79 ("origin-id", ns::SID) => MessagePayload::OriginId(OriginId::try_from(elem)?),
80
81 // XEP-0380
82 ("encryption", ns::EME) => MessagePayload::ExplicitMessageEncryption(ExplicitMessageEncryption::try_from(elem)?),
83
84 _ => MessagePayload::Unknown(elem),
85 })
86 }
87}
88
89impl From<MessagePayload> for Element {
90 fn from(payload: MessagePayload) -> Element {
91 match payload {
92 MessagePayload::StanzaError(stanza_error) => stanza_error.into(),
93 MessagePayload::Attention(attention) => attention.into(),
94 MessagePayload::ChatState(chatstate) => chatstate.into(),
95 MessagePayload::ReceiptRequest(request) => request.into(),
96 MessagePayload::ReceiptReceived(received) => received.into(),
97 MessagePayload::Delay(delay) => delay.into(),
98 MessagePayload::MessageCorrect(replace) => replace.into(),
99 MessagePayload::ExplicitMessageEncryption(eme) => eme.into(),
100 MessagePayload::StanzaId(stanza_id) => stanza_id.into(),
101 MessagePayload::OriginId(origin_id) => origin_id.into(),
102 MessagePayload::MamResult(result) => result.into(),
103
104 MessagePayload::Unknown(elem) => elem,
105 }
106 }
107}
108
109generate_attribute!(MessageType, "type", {
110 Chat => "chat",
111 Error => "error",
112 Groupchat => "groupchat",
113 Headline => "headline",
114 Normal => "normal",
115}, Default = Normal);
116
117type Lang = String;
118
119generate_elem_id!(Body, "body", ns::DEFAULT_NS);
120generate_elem_id!(Subject, "subject", ns::DEFAULT_NS);
121generate_elem_id!(Thread, "thread", ns::DEFAULT_NS);
122
123/// The main structure representing the `<message/>` stanza.
124#[derive(Debug, Clone)]
125pub struct Message {
126 pub from: Option<Jid>,
127 pub to: Option<Jid>,
128 pub id: Option<String>,
129 pub type_: MessageType,
130 pub bodies: BTreeMap<Lang, Body>,
131 pub subjects: BTreeMap<Lang, Subject>,
132 pub thread: Option<Thread>,
133 pub payloads: Vec<Element>,
134}
135
136impl Message {
137 pub fn new(to: Option<Jid>) -> Message {
138 Message {
139 from: None,
140 to: to,
141 id: None,
142 type_: MessageType::Chat,
143 bodies: BTreeMap::new(),
144 subjects: BTreeMap::new(),
145 thread: None,
146 payloads: vec!(),
147 }
148 }
149}
150
151impl TryFrom<Element> for Message {
152 type Err = Error;
153
154 fn try_from(root: Element) -> Result<Message, Error> {
155 if !root.is("message", ns::DEFAULT_NS) {
156 return Err(Error::ParseError("This is not a message element."));
157 }
158 let from = get_attr!(root, "from", optional);
159 let to = get_attr!(root, "to", optional);
160 let id = get_attr!(root, "id", optional);
161 let type_ = get_attr!(root, "type", default);
162 let mut bodies = BTreeMap::new();
163 let mut subjects = BTreeMap::new();
164 let mut thread = None;
165 let mut payloads = vec!();
166 for elem in root.children() {
167 if elem.is("body", ns::DEFAULT_NS) {
168 for _ in elem.children() {
169 return Err(Error::ParseError("Unknown child in body element."));
170 }
171 let lang = get_attr!(root, "xml:lang", default);
172 let body = Body(elem.text());
173 if bodies.insert(lang, body).is_some() {
174 return Err(Error::ParseError("Body element present twice for the same xml:lang."));
175 }
176 } else if elem.is("subject", ns::DEFAULT_NS) {
177 for _ in elem.children() {
178 return Err(Error::ParseError("Unknown child in subject element."));
179 }
180 let lang = get_attr!(root, "xml:lang", default);
181 let subject = Subject(elem.text());
182 if subjects.insert(lang, subject).is_some() {
183 return Err(Error::ParseError("Subject element present twice for the same xml:lang."));
184 }
185 } else if elem.is("thread", ns::DEFAULT_NS) {
186 if thread.is_some() {
187 return Err(Error::ParseError("Thread element present twice."));
188 }
189 for _ in elem.children() {
190 return Err(Error::ParseError("Unknown child in thread element."));
191 }
192 thread = Some(Thread(elem.text()));
193 } else {
194 payloads.push(elem.clone())
195 }
196 }
197 Ok(Message {
198 from: from,
199 to: to,
200 id: id,
201 type_: type_,
202 bodies: bodies,
203 subjects: subjects,
204 thread: thread,
205 payloads: payloads,
206 })
207 }
208}
209
210impl From<Message> for Element {
211 fn from(message: Message) -> Element {
212 Element::builder("message")
213 .ns(ns::DEFAULT_NS)
214 .attr("from", message.from)
215 .attr("to", message.to)
216 .attr("id", message.id)
217 .attr("type", message.type_)
218 .append(message.subjects.into_iter()
219 .map(|(lang, subject)| {
220 let mut subject = Element::from(subject);
221 subject.set_attr("xml:lang", match lang.as_ref() {
222 "" => None,
223 lang => Some(lang),
224 });
225 subject
226 })
227 .collect::<Vec<_>>())
228 .append(message.bodies.into_iter()
229 .map(|(lang, body)| {
230 let mut body = Element::from(body);
231 body.set_attr("xml:lang", match lang.as_ref() {
232 "" => None,
233 lang => Some(lang),
234 });
235 body
236 })
237 .collect::<Vec<_>>())
238 .append(message.payloads)
239 .build()
240 }
241}
242
243#[cfg(test)]
244mod tests {
245 use super::*;
246
247 #[test]
248 fn test_simple() {
249 #[cfg(not(feature = "component"))]
250 let elem: Element = "<message xmlns='jabber:client'/>".parse().unwrap();
251 #[cfg(feature = "component")]
252 let elem: Element = "<message xmlns='jabber:component:accept'/>".parse().unwrap();
253 let message = Message::try_from(elem).unwrap();
254 assert_eq!(message.from, None);
255 assert_eq!(message.to, None);
256 assert_eq!(message.id, None);
257 assert_eq!(message.type_, MessageType::Normal);
258 assert!(message.payloads.is_empty());
259 }
260
261 #[test]
262 fn test_serialise() {
263 #[cfg(not(feature = "component"))]
264 let elem: Element = "<message xmlns='jabber:client'/>".parse().unwrap();
265 #[cfg(feature = "component")]
266 let elem: Element = "<message xmlns='jabber:component:accept'/>".parse().unwrap();
267 let mut message = Message::new(None);
268 message.type_ = MessageType::Normal;
269 let elem2 = message.into();
270 assert_eq!(elem, elem2);
271 }
272
273 #[test]
274 fn test_body() {
275 #[cfg(not(feature = "component"))]
276 let elem: Element = "<message xmlns='jabber:client' to='coucou@example.org' type='chat'><body>Hello world!</body></message>".parse().unwrap();
277 #[cfg(feature = "component")]
278 let elem: Element = "<message xmlns='jabber:component:accept' to='coucou@example.org' type='chat'><body>Hello world!</body></message>".parse().unwrap();
279 let elem1 = elem.clone();
280 let message = Message::try_from(elem).unwrap();
281 assert_eq!(message.bodies[""], Body::from_str("Hello world!").unwrap());
282
283 let elem2 = message.into();
284 assert_eq!(elem1, elem2);
285 }
286
287 #[test]
288 fn test_serialise_body() {
289 #[cfg(not(feature = "component"))]
290 let elem: Element = "<message xmlns='jabber:client' to='coucou@example.org' type='chat'><body>Hello world!</body></message>".parse().unwrap();
291 #[cfg(feature = "component")]
292 let elem: Element = "<message xmlns='jabber:component:accept' to='coucou@example.org' type='chat'><body>Hello world!</body></message>".parse().unwrap();
293 let mut message = Message::new(Some(Jid::from_str("coucou@example.org").unwrap()));
294 message.bodies.insert(String::from(""), Body::from_str("Hello world!").unwrap());
295 let elem2 = message.into();
296 assert_eq!(elem, elem2);
297 }
298
299 #[test]
300 fn test_subject() {
301 #[cfg(not(feature = "component"))]
302 let elem: Element = "<message xmlns='jabber:client' to='coucou@example.org' type='chat'><subject>Hello world!</subject></message>".parse().unwrap();
303 #[cfg(feature = "component")]
304 let elem: Element = "<message xmlns='jabber:component:accept' to='coucou@example.org' type='chat'><subject>Hello world!</subject></message>".parse().unwrap();
305 let elem1 = elem.clone();
306 let message = Message::try_from(elem).unwrap();
307 assert_eq!(message.subjects[""], Subject::from_str("Hello world!").unwrap());
308
309 let elem2 = message.into();
310 assert_eq!(elem1, elem2);
311 }
312
313 #[test]
314 fn test_attention() {
315 #[cfg(not(feature = "component"))]
316 let elem: Element = "<message xmlns='jabber:client' to='coucou@example.org' type='chat'><attention xmlns='urn:xmpp:attention:0'/></message>".parse().unwrap();
317 #[cfg(feature = "component")]
318 let elem: Element = "<message xmlns='jabber:component:accept' to='coucou@example.org' type='chat'><attention xmlns='urn:xmpp:attention:0'/></message>".parse().unwrap();
319 let elem1 = elem.clone();
320 let message = Message::try_from(elem).unwrap();
321 let elem2 = message.into();
322 assert_eq!(elem1, elem2);
323 }
324}