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::convert::TryFrom;
8
9use hashes::Hash;
10
11use minidom::{Element, IntoElements, ElementEmitter};
12
13use error::Error;
14use ns;
15
16#[derive(Debug, Clone, PartialEq)]
17pub struct Range {
18 pub offset: u64,
19 pub length: Option<u64>,
20 pub hashes: Vec<Hash>,
21}
22
23impl IntoElements for Range {
24 fn into_elements(self, emitter: &mut ElementEmitter) {
25 let mut elem = Element::builder("range")
26 .ns(ns::JINGLE_FT)
27 .attr("offset", format!("{}", self.offset))
28 .attr("length", match self.length {
29 Some(length) => Some(format!("{}", length)),
30 None => None
31 })
32 .build();
33 for hash in self.hashes {
34 elem.append_child((&hash).into());
35 }
36 emitter.append_child(elem);
37 }
38}
39
40#[derive(Debug, Clone)]
41pub struct File {
42 pub date: Option<String>,
43 pub media_type: Option<String>,
44 pub name: Option<String>,
45 pub desc: Option<String>,
46 pub size: Option<u64>,
47 pub range: Option<Range>,
48 pub hashes: Vec<Hash>,
49}
50
51#[derive(Debug, Clone)]
52pub struct Description {
53 pub file: File,
54}
55
56#[derive(Debug, Clone)]
57pub enum Creator {
58 Initiator,
59 Responder,
60}
61
62#[derive(Debug, Clone)]
63pub struct Checksum {
64 pub name: String,
65 pub creator: Creator,
66 pub file: File,
67}
68
69#[derive(Debug, Clone)]
70pub struct Received {
71 pub name: String,
72 pub creator: Creator,
73}
74
75impl IntoElements for Received {
76 fn into_elements(self, emitter: &mut ElementEmitter) {
77 let elem = Element::builder("received")
78 .ns(ns::JINGLE_FT)
79 .attr("name", self.name)
80 .attr("creator", match self.creator {
81 Creator::Initiator => "initiator",
82 Creator::Responder => "responder",
83 })
84 .build();
85 emitter.append_child(elem);
86 }
87}
88
89impl<'a> TryFrom<&'a Element> for Description {
90 type Error = Error;
91
92 fn try_from(elem: &'a Element) -> Result<Description, Error> {
93 if !elem.is("description", ns::JINGLE_FT) {
94 return Err(Error::ParseError("This is not a JingleFT description element."));
95 }
96 if elem.children().collect::<Vec<_>>().len() != 1 {
97 return Err(Error::ParseError("JingleFT description element must have exactly one child."));
98 }
99
100 let mut date = None;
101 let mut media_type = None;
102 let mut name = None;
103 let mut desc = None;
104 let mut size = None;
105 let mut range = None;
106 let mut hashes = vec!();
107 for description_payload in elem.children() {
108 if !description_payload.is("file", ns::JINGLE_FT) {
109 return Err(Error::ParseError("Unknown element in JingleFT description."));
110 }
111 for file_payload in description_payload.children() {
112 if file_payload.is("date", ns::JINGLE_FT) {
113 if date.is_some() {
114 return Err(Error::ParseError("File must not have more than one date."));
115 }
116 date = Some(file_payload.text());
117 } else if file_payload.is("media-type", ns::JINGLE_FT) {
118 if media_type.is_some() {
119 return Err(Error::ParseError("File must not have more than one media-type."));
120 }
121 media_type = Some(file_payload.text());
122 } else if file_payload.is("name", ns::JINGLE_FT) {
123 if name.is_some() {
124 return Err(Error::ParseError("File must not have more than one name."));
125 }
126 name = Some(file_payload.text());
127 } else if file_payload.is("desc", ns::JINGLE_FT) {
128 if desc.is_some() {
129 return Err(Error::ParseError("File must not have more than one desc."));
130 }
131 desc = Some(file_payload.text());
132 } else if file_payload.is("size", ns::JINGLE_FT) {
133 if size.is_some() {
134 return Err(Error::ParseError("File must not have more than one size."));
135 }
136 size = Some(file_payload.text().parse()?);
137 } else if file_payload.is("range", ns::JINGLE_FT) {
138 if range.is_some() {
139 return Err(Error::ParseError("File must not have more than one range."));
140 }
141 let offset = file_payload.attr("offset").unwrap_or("0").parse()?;
142 let length = match file_payload.attr("length") {
143 Some(length) => Some(length.parse()?),
144 None => None,
145 };
146 let mut range_hashes = vec!();
147 for hash_element in file_payload.children() {
148 if !hash_element.is("hash", ns::HASHES) {
149 return Err(Error::ParseError("Unknown element in JingleFT range."));
150 }
151 range_hashes.push(Hash::try_from(hash_element)?);
152 }
153 range = Some(Range {
154 offset: offset,
155 length: length,
156 hashes: range_hashes,
157 });
158 } else if file_payload.is("hash", ns::HASHES) {
159 hashes.push(Hash::try_from(file_payload)?);
160 } else {
161 return Err(Error::ParseError("Unknown element in JingleFT file."));
162 }
163 }
164 }
165
166 Ok(Description {
167 file: File {
168 date: date,
169 media_type: media_type,
170 name: name,
171 desc: desc,
172 size: size,
173 range: range,
174 hashes: hashes,
175 },
176 })
177 }
178}
179
180impl<'a> Into<Element> for &'a File {
181 fn into(self) -> Element {
182 let mut root = Element::builder("file")
183 .ns(ns::JINGLE_FT)
184 .build();
185 if let Some(ref date) = self.date {
186 root.append_child(Element::builder("date")
187 .ns(ns::JINGLE_FT)
188 .append(date.clone())
189 .build());
190 }
191 if let Some(ref media_type) = self.media_type {
192 root.append_child(Element::builder("media-type")
193 .ns(ns::JINGLE_FT)
194 .append(media_type.clone())
195 .build());
196 }
197 if let Some(ref name) = self.name {
198 root.append_child(Element::builder("name")
199 .ns(ns::JINGLE_FT)
200 .append(name.clone())
201 .build());
202 }
203 if let Some(ref desc) = self.desc {
204 root.append_child(Element::builder("desc")
205 .ns(ns::JINGLE_FT)
206 .append(desc.clone())
207 .build());
208 }
209 if let Some(ref size) = self.size {
210 root.append_child(Element::builder("size")
211 .ns(ns::JINGLE_FT)
212 .append(format!("{}", size))
213 .build());
214 }
215 if let Some(ref range) = self.range {
216 root.append_child(Element::builder("range")
217 .ns(ns::JINGLE_FT)
218 .append(range.clone())
219 .build());
220 }
221 for hash in self.hashes.clone() {
222 root.append_child((&hash).into());
223 }
224 root
225 }
226}
227
228impl<'a> Into<Element> for &'a Description {
229 fn into(self) -> Element {
230 let file: Element = (&self.file).into();
231 Element::builder("description")
232 .ns(ns::JINGLE_FT)
233 .append(file)
234 .build()
235 }
236}
237
238#[cfg(test)]
239mod tests {
240 use super::*;
241
242 #[test]
243 fn test_description() {
244 let elem: Element = r#"
245<description xmlns='urn:xmpp:jingle:apps:file-transfer:5'>
246 <file>
247 <media-type>text/plain</media-type>
248 <name>test.txt</name>
249 <date>2015-07-26T21:46:00</date>
250 <size>6144</size>
251 <hash xmlns='urn:xmpp:hashes:2'
252 algo='sha-1'>w0mcJylzCn+AfvuGdqkty2+KP48=</hash>
253 </file>
254</description>
255"#.parse().unwrap();
256
257 let desc = Description::try_from(&elem).unwrap();
258 assert_eq!(desc.file.media_type, Some(String::from("text/plain")));
259 assert_eq!(desc.file.name, Some(String::from("test.txt")));
260 assert_eq!(desc.file.desc, None);
261 assert_eq!(desc.file.date, Some(String::from("2015-07-26T21:46:00")));
262 assert_eq!(desc.file.size, Some(6144u64));
263 assert_eq!(desc.file.range, None);
264 assert_eq!(desc.file.hashes[0].algo, "sha-1");
265 assert_eq!(desc.file.hashes[0].hash, "w0mcJylzCn+AfvuGdqkty2+KP48=");
266 }
267
268 #[test]
269 fn test_request() {
270 let elem: Element = r#"
271<description xmlns='urn:xmpp:jingle:apps:file-transfer:5'>
272 <file>
273 <hash xmlns='urn:xmpp:hashes:2'
274 algo='sha-1'>w0mcJylzCn+AfvuGdqkty2+KP48=</hash>
275 </file>
276</description>
277"#.parse().unwrap();
278
279 let desc = Description::try_from(&elem).unwrap();
280 assert_eq!(desc.file.media_type, None);
281 assert_eq!(desc.file.name, None);
282 assert_eq!(desc.file.desc, None);
283 assert_eq!(desc.file.date, None);
284 assert_eq!(desc.file.size, None);
285 assert_eq!(desc.file.range, None);
286 assert_eq!(desc.file.hashes[0].algo, "sha-1");
287 assert_eq!(desc.file.hashes[0].hash, "w0mcJylzCn+AfvuGdqkty2+KP48=");
288 }
289}