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 std::collections::HashMap;
8use try_from::TryFrom;
9
10use minidom::Element;
11
12use error::Error;
13
14use iq::{IqGetPayload, IqSetPayload, IqResultPayload};
15use data_forms::DataForm;
16
17use ns;
18
19/// Query for registering against a service.
20#[derive(Debug, Clone)]
21pub struct Query {
22 /// Deprecated fixed list of possible fields to fill before the user can
23 /// register.
24 pub fields: HashMap<String, String>,
25
26 /// Whether this account is already registered.
27 pub registered: bool,
28
29 /// Whether to remove this account.
30 pub remove: bool,
31
32 /// A data form the user must fill before being allowed to register.
33 pub form: Option<DataForm>,
34
35 // Not yet implemented.
36 //pub oob: Option<Oob>,
37}
38
39impl IqGetPayload for Query {}
40impl IqSetPayload for Query {}
41impl IqResultPayload for Query {}
42
43impl TryFrom<Element> for Query {
44 type Err = Error;
45
46 fn try_from(elem: Element) -> Result<Query, Error> {
47 check_self!(elem, "query", REGISTER, "IBR query");
48 let mut query = Query {
49 registered: false,
50 fields: HashMap::new(),
51 remove: false,
52 form: None,
53 };
54 for child in elem.children() {
55 let namespace = child.ns().unwrap();
56 if namespace == ns::REGISTER {
57 let name = child.name();
58 let fields = vec!["address", "city", "date", "email", "first", "instructions",
59 "key", "last", "misc", "name", "nick", "password", "phone",
60 "state", "text", "url", "username", "zip"];
61 if fields.binary_search(&name).is_ok() {
62 query.fields.insert(name.to_owned(), child.text());
63 } else if name == "registered" {
64 query.registered = true;
65 } else if name == "remove" {
66 query.remove = true;
67 } else {
68 return Err(Error::ParseError("Wrong field in ibr element."));
69 }
70 } else if child.is("x", ns::DATA_FORMS) {
71 query.form = Some(DataForm::try_from(child.clone())?);
72 } else {
73 return Err(Error::ParseError("Unknown child in ibr element."));
74 }
75 }
76 Ok(query)
77 }
78}
79
80impl From<Query> for Element {
81 fn from(query: Query) -> Element {
82 Element::builder("query")
83 .ns(ns::REGISTER)
84 .append(if query.registered { Some(Element::builder("registered").ns(ns::REGISTER)) } else { None })
85 .append(query.fields.into_iter().map(|(name, value)| {
86 Element::builder(name).ns(ns::REGISTER).append(value)
87 }).collect::<Vec<_>>())
88 .append(if query.remove { Some(Element::builder("remove").ns(ns::REGISTER)) } else { None })
89 .append(query.form)
90 .build()
91 }
92}
93
94#[cfg(test)]
95mod tests {
96 use super::*;
97 use compare_elements::NamespaceAwareCompare;
98
99 #[test]
100 fn test_simple() {
101 let elem: Element = "<query xmlns='jabber:iq:register'/>".parse().unwrap();
102 Query::try_from(elem).unwrap();
103 }
104
105 #[test]
106 fn test_ex2() {
107 let elem: Element = r#"
108<query xmlns='jabber:iq:register'>
109 <instructions>
110 Choose a username and password for use with this service.
111 Please also provide your email address.
112 </instructions>
113 <username/>
114 <password/>
115 <email/>
116</query>
117"#.parse().unwrap();
118 let query = Query::try_from(elem).unwrap();
119 assert_eq!(query.registered, false);
120 assert_eq!(query.fields["instructions"], "\n Choose a username and password for use with this service.\n Please also provide your email address.\n ");
121 assert_eq!(query.fields["username"], "");
122 assert_eq!(query.fields["password"], "");
123 assert_eq!(query.fields["email"], "");
124 assert_eq!(query.fields.contains_key("name"), false);
125
126 // FIXME: HashMap doesn’t keep the order right.
127 //let elem2 = query.into();
128 //assert_eq!(elem, elem2);
129 }
130
131 #[test]
132 fn test_ex9() {
133 let elem: Element = r#"
134<query xmlns='jabber:iq:register'>
135 <instructions>
136 Use the enclosed form to register. If your Jabber client does not
137 support Data Forms, visit http://www.shakespeare.lit/contests.php
138 </instructions>
139 <x xmlns='jabber:x:data' type='form'>
140 <title>Contest Registration</title>
141 <instructions>
142 Please provide the following information
143 to sign up for our special contests!
144 </instructions>
145 <field type='hidden' var='FORM_TYPE'>
146 <value>jabber:iq:register</value>
147 </field>
148 <field label='Given Name' var='first'>
149 <required/>
150 </field>
151 <field label='Family Name' var='last'>
152 <required/>
153 </field>
154 <field label='Email Address' var='email'>
155 <required/>
156 </field>
157 <field type='list-single' label='Gender' var='x-gender'>
158 <option label='Male'><value>M</value></option>
159 <option label='Female'><value>F</value></option>
160 </field>
161 </x>
162</query>
163"#.parse().unwrap();
164 let elem1 = elem.clone();
165 let query = Query::try_from(elem).unwrap();
166 assert_eq!(query.registered, false);
167 assert!(!query.fields["instructions"].is_empty());
168 let form = query.form.clone().unwrap();
169 assert!(!form.instructions.unwrap().is_empty());
170 assert!(form.fields.binary_search_by(|field| field.var.cmp(&String::from("first"))).is_ok());
171 assert!(form.fields.binary_search_by(|field| field.var.cmp(&String::from("x-gender"))).is_ok());
172 assert!(form.fields.binary_search_by(|field| field.var.cmp(&String::from("coucou"))).is_err());
173 let elem2 = query.into();
174 assert!(elem1.compare_to(&elem2));
175 }
176
177 #[test]
178 fn test_ex10() {
179 let elem: Element = r#"
180<query xmlns='jabber:iq:register'>
181 <x xmlns='jabber:x:data' type='submit'>
182 <field type='hidden' var='FORM_TYPE'>
183 <value>jabber:iq:register</value>
184 </field>
185 <field label='Given Name' var='first'>
186 <value>Juliet</value>
187 </field>
188 <field label='Family Name' var='last'>
189 <value>Capulet</value>
190 </field>
191 <field label='Email Address' var='email'>
192 <value>juliet@capulet.com</value>
193 </field>
194 <field type='list-single' label='Gender' var='x-gender'>
195 <value>F</value>
196 </field>
197 </x>
198</query>
199"#.parse().unwrap();
200 let elem1 = elem.clone();
201 let query = Query::try_from(elem).unwrap();
202 assert_eq!(query.registered, false);
203 for _ in &query.fields {
204 panic!();
205 }
206 let elem2 = query.into();
207 assert!(elem1.compare_to(&elem2));
208 }
209}