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 crate::iq::{IqGetPayload, IqResultPayload, IqSetPayload};
8use crate::ns;
9use crate::util::error::Error;
10use crate::Element;
11use jid::Jid;
12use std::convert::TryFrom;
13
14generate_empty_element!(
15 /// The element requesting the blocklist, the result iq will contain a
16 /// [BlocklistResult].
17 BlocklistRequest,
18 "blocklist",
19 BLOCKING
20);
21
22impl IqGetPayload for BlocklistRequest {}
23
24macro_rules! generate_blocking_element {
25 ($(#[$meta:meta])* $elem:ident, $name:tt) => (
26 $(#[$meta])*
27 #[derive(Debug, Clone)]
28 pub struct $elem {
29 /// List of JIDs affected by this command.
30 pub items: Vec<Jid>,
31 }
32
33 impl TryFrom<Element> for $elem {
34 type Error = Error;
35
36 fn try_from(elem: Element) -> Result<$elem, Error> {
37 check_self!(elem, $name, BLOCKING);
38 check_no_attributes!(elem, $name);
39 let mut items = vec!();
40 for child in elem.children() {
41 check_self!(child, "item", BLOCKING);
42 check_no_unknown_attributes!(child, "item", ["jid"]);
43 check_no_children!(child, "item");
44 items.push(get_attr!(child, "jid", Required));
45 }
46 Ok($elem { items })
47 }
48 }
49
50 impl From<$elem> for Element {
51 fn from(elem: $elem) -> Element {
52 Element::builder($name, ns::BLOCKING)
53 .append_all(elem.items.into_iter().map(|jid| {
54 Element::builder("item", ns::BLOCKING)
55 .attr("jid", jid)
56 }))
57 .build()
58 }
59 }
60 );
61}
62
63generate_blocking_element!(
64 /// The element containing the current blocklist, as a reply from
65 /// [BlocklistRequest].
66 BlocklistResult,
67 "blocklist"
68);
69
70impl IqResultPayload for BlocklistResult {}
71
72// TODO: Prevent zero elements from being allowed.
73generate_blocking_element!(
74 /// A query to block one or more JIDs.
75 Block,
76 "block"
77);
78
79impl IqSetPayload for Block {}
80
81generate_blocking_element!(
82 /// A query to unblock one or more JIDs, or all of them.
83 ///
84 /// Warning: not putting any JID there means clearing out the blocklist.
85 Unblock,
86 "unblock"
87);
88
89impl IqSetPayload for Unblock {}
90
91generate_empty_element!(
92 /// The application-specific error condition when a message is blocked.
93 Blocked,
94 "blocked",
95 BLOCKING_ERRORS
96);
97
98#[cfg(test)]
99mod tests {
100 use super::*;
101 use jid::BareJid;
102
103 #[cfg(target_pointer_width = "32")]
104 #[test]
105 fn test_size() {
106 assert_size!(BlocklistRequest, 0);
107 assert_size!(BlocklistResult, 12);
108 assert_size!(Block, 12);
109 assert_size!(Unblock, 12);
110 }
111
112 #[cfg(target_pointer_width = "64")]
113 #[test]
114 fn test_size() {
115 assert_size!(BlocklistRequest, 0);
116 assert_size!(BlocklistResult, 24);
117 assert_size!(Block, 24);
118 assert_size!(Unblock, 24);
119 }
120
121 #[test]
122 fn test_simple() {
123 let elem: Element = "<blocklist xmlns='urn:xmpp:blocking'/>".parse().unwrap();
124 let request_elem = elem.clone();
125 BlocklistRequest::try_from(request_elem).unwrap();
126
127 let result_elem = elem.clone();
128 let result = BlocklistResult::try_from(result_elem).unwrap();
129 assert!(result.items.is_empty());
130
131 let elem: Element = "<block xmlns='urn:xmpp:blocking'/>".parse().unwrap();
132 let block = Block::try_from(elem).unwrap();
133 assert!(block.items.is_empty());
134
135 let elem: Element = "<unblock xmlns='urn:xmpp:blocking'/>".parse().unwrap();
136 let unblock = Unblock::try_from(elem).unwrap();
137 assert!(unblock.items.is_empty());
138 }
139
140 #[test]
141 fn test_items() {
142 let elem: Element = "<blocklist xmlns='urn:xmpp:blocking'><item jid='coucou@coucou'/><item jid='domain'/></blocklist>".parse().unwrap();
143 let two_items = vec![
144 Jid::Bare(BareJid {
145 node: Some(String::from("coucou")),
146 domain: String::from("coucou"),
147 }),
148 Jid::Bare(BareJid {
149 node: None,
150 domain: String::from("domain"),
151 }),
152 ];
153
154 let result_elem = elem.clone();
155 let result = BlocklistResult::try_from(result_elem).unwrap();
156 assert_eq!(result.items, two_items);
157
158 let elem: Element = "<block xmlns='urn:xmpp:blocking'><item jid='coucou@coucou'/><item jid='domain'/></block>".parse().unwrap();
159 let block = Block::try_from(elem).unwrap();
160 assert_eq!(block.items, two_items);
161
162 let elem: Element = "<unblock xmlns='urn:xmpp:blocking'><item jid='coucou@coucou'/><item jid='domain'/></unblock>".parse().unwrap();
163 let unblock = Unblock::try_from(elem).unwrap();
164 assert_eq!(unblock.items, two_items);
165 }
166
167 #[cfg(not(feature = "disable-validation"))]
168 #[test]
169 fn test_invalid() {
170 let elem: Element = "<blocklist xmlns='urn:xmpp:blocking' coucou=''/>"
171 .parse()
172 .unwrap();
173 let request_elem = elem.clone();
174 let error = BlocklistRequest::try_from(request_elem).unwrap_err();
175 let message = match error {
176 Error::ParseError(string) => string,
177 _ => panic!(),
178 };
179 assert_eq!(message, "Unknown attribute in blocklist element.");
180
181 let result_elem = elem.clone();
182 let error = BlocklistResult::try_from(result_elem).unwrap_err();
183 let message = match error {
184 Error::ParseError(string) => string,
185 _ => panic!(),
186 };
187 assert_eq!(message, "Unknown attribute in blocklist element.");
188
189 let elem: Element = "<block xmlns='urn:xmpp:blocking' coucou=''/>"
190 .parse()
191 .unwrap();
192 let error = Block::try_from(elem).unwrap_err();
193 let message = match error {
194 Error::ParseError(string) => string,
195 _ => panic!(),
196 };
197 assert_eq!(message, "Unknown attribute in block element.");
198
199 let elem: Element = "<unblock xmlns='urn:xmpp:blocking' coucou=''/>"
200 .parse()
201 .unwrap();
202 let error = Unblock::try_from(elem).unwrap_err();
203 let message = match error {
204 Error::ParseError(string) => string,
205 _ => panic!(),
206 };
207 assert_eq!(message, "Unknown attribute in unblock element.");
208 }
209
210 #[cfg(not(feature = "disable-validation"))]
211 #[test]
212 fn test_non_empty_blocklist_request() {
213 let elem: Element = "<blocklist xmlns='urn:xmpp:blocking'><item jid='coucou@coucou'/><item jid='domain'/></blocklist>".parse().unwrap();
214 let error = BlocklistRequest::try_from(elem).unwrap_err();
215 let message = match error {
216 Error::ParseError(string) => string,
217 _ => panic!(),
218 };
219 assert_eq!(message, "Unknown child in blocklist element.");
220 }
221}