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::util::error::Error;
8use crate::media_element::MediaElement;
9use crate::ns;
10use minidom::Element;
11use std::convert::TryFrom;
12
13generate_element!(
14 /// Represents one of the possible values for a list- field.
15 Option_, "option", DATA_FORMS,
16 attributes: [
17 /// The optional label to be displayed to the user for this option.
18 label: Option<String> = "label"
19 ],
20 children: [
21 /// The value returned to the server when selecting this option.
22 value: Required<String> = ("value", DATA_FORMS) => String
23 ]
24);
25
26generate_attribute!(
27 /// The type of a [field](struct.Field.html) element.
28 FieldType, "type", {
29 /// This field can only take the values "0" or "false" for a false
30 /// value, and "1" or "true" for a true value.
31 Boolean => "boolean",
32
33 /// This field describes data, it must not be sent back to the
34 /// requester.
35 Fixed => "fixed",
36
37 /// This field is hidden, it should not be displayed to the user but
38 /// should be sent back to the requester.
39 Hidden => "hidden",
40
41 /// This field accepts one or more [JIDs](../../jid/struct.Jid.html).
42 /// A client may want to let the user autocomplete them based on their
43 /// contacts list for instance.
44 JidMulti => "jid-multi",
45
46 /// This field accepts one [JID](../../jid/struct.Jid.html). A client
47 /// may want to let the user autocomplete it based on their contacts
48 /// list for instance.
49 JidSingle => "jid-single",
50
51 /// This field accepts one or more values from the list provided as
52 /// [options](struct.Option_.html).
53 ListMulti => "list-multi",
54
55 /// This field accepts one value from the list provided as
56 /// [options](struct.Option_.html).
57 ListSingle => "list-single",
58
59 /// This field accepts one or more free form text lines.
60 TextMulti => "text-multi",
61
62 /// This field accepts one free form password, a client should hide it
63 /// in its user interface.
64 TextPrivate => "text-private",
65
66 /// This field accepts one free form text line.
67 TextSingle => "text-single",
68 }, Default = TextSingle
69);
70
71/// Represents a field in a [data form](struct.DataForm.html).
72#[derive(Debug, Clone)]
73pub struct Field {
74 /// The unique identifier for this field, in the form.
75 pub var: String,
76
77 /// The type of this field.
78 pub type_: FieldType,
79
80 /// The label to be possibly displayed to the user for this field.
81 pub label: Option<String>,
82
83 /// The form will be rejected if this field isn’t present.
84 pub required: bool,
85
86 /// A list of allowed values.
87 pub options: Vec<Option_>,
88
89 /// The values provided for this field.
90 pub values: Vec<String>,
91
92 /// A list of media related to this field.
93 pub media: Vec<MediaElement>,
94}
95
96impl Field {
97 fn is_list(&self) -> bool {
98 self.type_ == FieldType::ListSingle || self.type_ == FieldType::ListMulti
99 }
100}
101
102impl TryFrom<Element> for Field {
103 type Error = Error;
104
105 fn try_from(elem: Element) -> Result<Field, Error> {
106 check_self!(elem, "field", DATA_FORMS);
107 check_no_unknown_attributes!(elem, "field", ["label", "type", "var"]);
108 let mut field = Field {
109 var: get_attr!(elem, "var", Required),
110 type_: get_attr!(elem, "type", Default),
111 label: get_attr!(elem, "label", Option),
112 required: false,
113 options: vec![],
114 values: vec![],
115 media: vec![],
116 };
117 for element in elem.children() {
118 if element.is("value", ns::DATA_FORMS) {
119 check_no_children!(element, "value");
120 check_no_attributes!(element, "value");
121 field.values.push(element.text());
122 } else if element.is("required", ns::DATA_FORMS) {
123 if field.required {
124 return Err(Error::ParseError("More than one required element."));
125 }
126 check_no_children!(element, "required");
127 check_no_attributes!(element, "required");
128 field.required = true;
129 } else if element.is("option", ns::DATA_FORMS) {
130 if !field.is_list() {
131 return Err(Error::ParseError("Option element found in non-list field."));
132 }
133 let option = Option_::try_from(element.clone())?;
134 field.options.push(option);
135 } else if element.is("media", ns::MEDIA_ELEMENT) {
136 let media_element = MediaElement::try_from(element.clone())?;
137 field.media.push(media_element);
138 } else {
139 return Err(Error::ParseError(
140 "Field child isn’t a value, option or media element.",
141 ));
142 }
143 }
144 Ok(field)
145 }
146}
147
148impl From<Field> for Element {
149 fn from(field: Field) -> Element {
150 Element::builder("field")
151 .ns(ns::DATA_FORMS)
152 .attr("var", field.var)
153 .attr("type", field.type_)
154 .attr("label", field.label)
155 .append(if field.required {
156 Some(Element::builder("required").ns(ns::DATA_FORMS).build())
157 } else {
158 None
159 })
160 .append(field.options)
161 .append(
162 field
163 .values
164 .into_iter()
165 .map(|value| {
166 Element::builder("value")
167 .ns(ns::DATA_FORMS)
168 .append(value)
169 .build()
170 })
171 .collect::<Vec<_>>(),
172 )
173 .append(field.media)
174 .build()
175 }
176}
177
178generate_attribute!(
179 /// Represents the type of a [data form](struct.DataForm.html).
180 DataFormType, "type", {
181 /// This is a cancel request for a prior type="form" data form.
182 Cancel => "cancel",
183
184 /// This is a request for the recipient to fill this form and send it
185 /// back as type="submit".
186 Form => "form",
187
188 /// This is a result form, which contains what the requester asked for.
189 Result_ => "result",
190
191 /// This is a complete response to a form received before.
192 Submit => "submit",
193 }
194);
195
196/// This is a form to be sent to another entity for filling.
197#[derive(Debug, Clone)]
198pub struct DataForm {
199 /// The type of this form, telling the other party which action to execute.
200 pub type_: DataFormType,
201
202 /// An easy accessor for the FORM_TYPE of this form, see
203 /// [XEP-0068](https://xmpp.org/extensions/xep-0068.html) for more
204 /// information.
205 pub form_type: Option<String>,
206
207 /// The title of this form.
208 pub title: Option<String>,
209
210 /// The instructions given with this form.
211 pub instructions: Option<String>,
212
213 /// A list of fields comprising this form.
214 pub fields: Vec<Field>,
215}
216
217impl TryFrom<Element> for DataForm {
218 type Error = Error;
219
220 fn try_from(elem: Element) -> Result<DataForm, Error> {
221 check_self!(elem, "x", DATA_FORMS);
222 check_no_unknown_attributes!(elem, "x", ["type"]);
223 let type_ = get_attr!(elem, "type", Required);
224 let mut form = DataForm {
225 type_,
226 form_type: None,
227 title: None,
228 instructions: None,
229 fields: vec![],
230 };
231 for child in elem.children() {
232 if child.is("title", ns::DATA_FORMS) {
233 if form.title.is_some() {
234 return Err(Error::ParseError("More than one title in form element."));
235 }
236 check_no_children!(child, "title");
237 check_no_attributes!(child, "title");
238 form.title = Some(child.text());
239 } else if child.is("instructions", ns::DATA_FORMS) {
240 if form.instructions.is_some() {
241 return Err(Error::ParseError(
242 "More than one instructions in form element.",
243 ));
244 }
245 check_no_children!(child, "instructions");
246 check_no_attributes!(child, "instructions");
247 form.instructions = Some(child.text());
248 } else if child.is("field", ns::DATA_FORMS) {
249 let field = Field::try_from(child.clone())?;
250 if field.var == "FORM_TYPE" {
251 let mut field = field;
252 if form.form_type.is_some() {
253 return Err(Error::ParseError("More than one FORM_TYPE in a data form."));
254 }
255 if field.type_ != FieldType::Hidden {
256 return Err(Error::ParseError("Invalid field type for FORM_TYPE."));
257 }
258 if field.values.len() != 1 {
259 return Err(Error::ParseError("Wrong number of values in FORM_TYPE."));
260 }
261 form.form_type = field.values.pop();
262 } else {
263 form.fields.push(field);
264 }
265 } else {
266 return Err(Error::ParseError("Unknown child in data form element."));
267 }
268 }
269 Ok(form)
270 }
271}
272
273impl From<DataForm> for Element {
274 fn from(form: DataForm) -> Element {
275 Element::builder("x")
276 .ns(ns::DATA_FORMS)
277 .attr("type", form.type_)
278 .append(
279 form.title
280 .map(|title| Element::builder("title").ns(ns::DATA_FORMS).append(title)),
281 )
282 .append(form.instructions.map(|text| {
283 Element::builder("instructions")
284 .ns(ns::DATA_FORMS)
285 .append(text)
286 }))
287 .append(if let Some(form_type) = form.form_type {
288 vec![Element::builder("field").ns(ns::DATA_FORMS).attr("var", "FORM_TYPE").attr("type", "hidden").append(Element::builder("value").ns(ns::DATA_FORMS).append(form_type).build()).build()]
289 } else {
290 vec![]
291 })
292 .append(form.fields)
293 .build()
294 }
295}
296
297#[cfg(test)]
298mod tests {
299 use super::*;
300
301 #[cfg(target_pointer_width = "32")]
302 #[test]
303 fn test_size() {
304 assert_size!(Option_, 24);
305 assert_size!(FieldType, 1);
306 assert_size!(Field, 64);
307 assert_size!(DataFormType, 1);
308 assert_size!(DataForm, 52);
309 }
310
311 #[cfg(target_pointer_width = "64")]
312 #[test]
313 fn test_size() {
314 assert_size!(Option_, 48);
315 assert_size!(FieldType, 1);
316 assert_size!(Field, 128);
317 assert_size!(DataFormType, 1);
318 assert_size!(DataForm, 104);
319 }
320
321 #[test]
322 fn test_simple() {
323 let elem: Element = "<x xmlns='jabber:x:data' type='result'/>".parse().unwrap();
324 let form = DataForm::try_from(elem).unwrap();
325 assert_eq!(form.type_, DataFormType::Result_);
326 assert!(form.form_type.is_none());
327 assert!(form.fields.is_empty());
328 }
329
330 #[test]
331 fn test_invalid() {
332 let elem: Element = "<x xmlns='jabber:x:data'/>".parse().unwrap();
333 let error = DataForm::try_from(elem).unwrap_err();
334 let message = match error {
335 Error::ParseError(string) => string,
336 _ => panic!(),
337 };
338 assert_eq!(message, "Required attribute 'type' missing.");
339
340 let elem: Element = "<x xmlns='jabber:x:data' type='coucou'/>".parse().unwrap();
341 let error = DataForm::try_from(elem).unwrap_err();
342 let message = match error {
343 Error::ParseError(string) => string,
344 _ => panic!(),
345 };
346 assert_eq!(message, "Unknown value for 'type' attribute.");
347 }
348
349 #[test]
350 fn test_wrong_child() {
351 let elem: Element = "<x xmlns='jabber:x:data' type='cancel'><coucou/></x>"
352 .parse()
353 .unwrap();
354 let error = DataForm::try_from(elem).unwrap_err();
355 let message = match error {
356 Error::ParseError(string) => string,
357 _ => panic!(),
358 };
359 assert_eq!(message, "Unknown child in data form element.");
360 }
361
362 #[test]
363 fn option() {
364 let elem: Element =
365 "<option xmlns='jabber:x:data' label='Coucou !'><value>coucou</value></option>"
366 .parse()
367 .unwrap();
368 let option = Option_::try_from(elem).unwrap();
369 assert_eq!(&option.label.unwrap(), "Coucou !");
370 assert_eq!(&option.value, "coucou");
371
372 let elem: Element = "<option xmlns='jabber:x:data' label='Coucou !'/>"
373 .parse()
374 .unwrap();
375 let error = Option_::try_from(elem).unwrap_err();
376 let message = match error {
377 Error::ParseError(string) => string,
378 _ => panic!(),
379 };
380 assert_eq!(message, "Missing child value in option element.");
381
382 let elem: Element = "<option xmlns='jabber:x:data' label='Coucou !'><value>coucou</value><value>error</value></option>".parse().unwrap();
383 let error = Option_::try_from(elem).unwrap_err();
384 let message = match error {
385 Error::ParseError(string) => string,
386 _ => panic!(),
387 };
388 assert_eq!(
389 message,
390 "Element option must not have more than one value child."
391 );
392 }
393}