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 TryFrom<Element> for Description {
90 type Error = Error;
91
92 fn try_from(elem: 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 = get_attr!(file_payload, "offset", default);
142 let length = get_attr!(file_payload, "length", optional);
143 let mut range_hashes = vec!();
144 for hash_element in file_payload.children() {
145 if !hash_element.is("hash", ns::HASHES) {
146 return Err(Error::ParseError("Unknown element in JingleFT range."));
147 }
148 range_hashes.push(Hash::try_from(hash_element.clone())?);
149 }
150 range = Some(Range {
151 offset: offset,
152 length: length,
153 hashes: range_hashes,
154 });
155 } else if file_payload.is("hash", ns::HASHES) {
156 hashes.push(Hash::try_from(file_payload.clone())?);
157 } else {
158 return Err(Error::ParseError("Unknown element in JingleFT file."));
159 }
160 }
161 }
162
163 Ok(Description {
164 file: File {
165 date: date,
166 media_type: media_type,
167 name: name,
168 desc: desc,
169 size: size,
170 range: range,
171 hashes: hashes,
172 },
173 })
174 }
175}
176
177impl Into<Element> for File {
178 fn into(self) -> Element {
179 let mut root = Element::builder("file")
180 .ns(ns::JINGLE_FT)
181 .build();
182 if let Some(date) = self.date {
183 root.append_child(Element::builder("date")
184 .ns(ns::JINGLE_FT)
185 .append(date)
186 .build());
187 }
188 if let Some(media_type) = self.media_type {
189 root.append_child(Element::builder("media-type")
190 .ns(ns::JINGLE_FT)
191 .append(media_type)
192 .build());
193 }
194 if let Some(name) = self.name {
195 root.append_child(Element::builder("name")
196 .ns(ns::JINGLE_FT)
197 .append(name)
198 .build());
199 }
200 if let Some(desc) = self.desc {
201 root.append_child(Element::builder("desc")
202 .ns(ns::JINGLE_FT)
203 .append(desc)
204 .build());
205 }
206 if let Some(size) = self.size {
207 root.append_child(Element::builder("size")
208 .ns(ns::JINGLE_FT)
209 .append(format!("{}", size))
210 .build());
211 }
212 if let Some(range) = self.range {
213 root.append_child(Element::builder("range")
214 .ns(ns::JINGLE_FT)
215 .append(range)
216 .build());
217 }
218 for hash in self.hashes {
219 root.append_child(hash.into());
220 }
221 root
222 }
223}
224
225impl Into<Element> for Description {
226 fn into(self) -> Element {
227 let file: Element = self.file.into();
228 Element::builder("description")
229 .ns(ns::JINGLE_FT)
230 .append(file)
231 .build()
232 }
233}
234
235#[cfg(test)]
236mod tests {
237 use super::*;
238 use hashes::Algo;
239 use base64;
240
241 #[test]
242 fn test_description() {
243 let elem: Element = r#"
244<description xmlns='urn:xmpp:jingle:apps:file-transfer:5'>
245 <file>
246 <media-type>text/plain</media-type>
247 <name>test.txt</name>
248 <date>2015-07-26T21:46:00</date>
249 <size>6144</size>
250 <hash xmlns='urn:xmpp:hashes:2'
251 algo='sha-1'>w0mcJylzCn+AfvuGdqkty2+KP48=</hash>
252 </file>
253</description>
254"#.parse().unwrap();
255
256 let desc = Description::try_from(elem).unwrap();
257 assert_eq!(desc.file.media_type, Some(String::from("text/plain")));
258 assert_eq!(desc.file.name, Some(String::from("test.txt")));
259 assert_eq!(desc.file.desc, None);
260 assert_eq!(desc.file.date, Some(String::from("2015-07-26T21:46:00")));
261 assert_eq!(desc.file.size, Some(6144u64));
262 assert_eq!(desc.file.range, None);
263 assert_eq!(desc.file.hashes[0].algo, Algo::Sha_1);
264 assert_eq!(desc.file.hashes[0].hash, base64::decode("w0mcJylzCn+AfvuGdqkty2+KP48=").unwrap());
265 }
266
267 #[test]
268 fn test_request() {
269 let elem: Element = r#"
270<description xmlns='urn:xmpp:jingle:apps:file-transfer:5'>
271 <file>
272 <hash xmlns='urn:xmpp:hashes:2'
273 algo='sha-1'>w0mcJylzCn+AfvuGdqkty2+KP48=</hash>
274 </file>
275</description>
276"#.parse().unwrap();
277
278 let desc = Description::try_from(elem).unwrap();
279 assert_eq!(desc.file.media_type, None);
280 assert_eq!(desc.file.name, None);
281 assert_eq!(desc.file.desc, None);
282 assert_eq!(desc.file.date, None);
283 assert_eq!(desc.file.size, None);
284 assert_eq!(desc.file.range, None);
285 assert_eq!(desc.file.hashes[0].algo, Algo::Sha_1);
286 assert_eq!(desc.file.hashes[0].hash, base64::decode("w0mcJylzCn+AfvuGdqkty2+KP48=").unwrap());
287 }
288}