// Copyright (c) 2017 Emmanuel Gil Peyrot // Copyright (c) 2017 Maxime “pep” Buquet // // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. use try_from::TryFrom; use std::str::FromStr; use std::collections::BTreeMap; use minidom::{Element, IntoElements, IntoAttributeValue, ElementEmitter}; use jid::Jid; use error::Error; use ns; use stanza_error::StanzaError; use muc::Muc; use caps::Caps; use delay::Delay; use idle::Idle; use ecaps2::ECaps2; #[derive(Debug, Clone, PartialEq)] pub enum Show { None, Away, Chat, Dnd, Xa, } impl Default for Show { fn default() -> Show { Show::None } } impl FromStr for Show { type Err = Error; fn from_str(s: &str) -> Result { Ok(match s { "away" => Show::Away, "chat" => Show::Chat, "dnd" => Show::Dnd, "xa" => Show::Xa, _ => return Err(Error::ParseError("Invalid value for show.")), }) } } impl IntoElements for Show { fn into_elements(self, emitter: &mut ElementEmitter) { if self == Show::None { return; } emitter.append_child( Element::builder("show") .append(match self { Show::None => unreachable!(), Show::Away => Some("away"), Show::Chat => Some("chat"), Show::Dnd => Some("dnd"), Show::Xa => Some("xa"), }) .build()) } } pub type Lang = String; pub type Status = String; pub type Priority = i8; /// Lists every known payload of a ``. #[derive(Debug, Clone)] pub enum PresencePayload { StanzaError(StanzaError), Muc(Muc), Caps(Caps), Delay(Delay), Idle(Idle), ECaps2(ECaps2), Unknown(Element), } impl TryFrom for PresencePayload { type Err = Error; fn try_from(elem: Element) -> Result { Ok(match (elem.name().as_ref(), elem.ns().unwrap().as_ref()) { ("error", ns::JABBER_CLIENT) => PresencePayload::StanzaError(StanzaError::try_from(elem)?), // XEP-0045 ("x", ns::MUC) => PresencePayload::Muc(Muc::try_from(elem)?), // XEP-0115 ("c", ns::CAPS) => PresencePayload::Caps(Caps::try_from(elem)?), // XEP-0203 ("delay", ns::DELAY) => PresencePayload::Delay(Delay::try_from(elem)?), // XEP-0319 ("idle", ns::IDLE) => PresencePayload::Idle(Idle::try_from(elem)?), // XEP-0390 ("c", ns::ECAPS2) => PresencePayload::ECaps2(ECaps2::try_from(elem)?), _ => PresencePayload::Unknown(elem), }) } } impl From for Element { fn from(payload: PresencePayload) -> Element { match payload { PresencePayload::StanzaError(stanza_error) => stanza_error.into(), PresencePayload::Muc(muc) => muc.into(), PresencePayload::Caps(caps) => caps.into(), PresencePayload::Delay(delay) => delay.into(), PresencePayload::Idle(idle) => idle.into(), PresencePayload::ECaps2(ecaps2) => ecaps2.into(), PresencePayload::Unknown(elem) => elem, } } } #[derive(Debug, Clone, PartialEq)] pub enum Type { /// This value is not an acceptable 'type' attribute, it is only used /// internally to signal the absence of 'type'. None, Error, Probe, Subscribe, Subscribed, Unavailable, Unsubscribe, Unsubscribed, } impl Default for Type { fn default() -> Type { Type::None } } impl FromStr for Type { type Err = Error; fn from_str(s: &str) -> Result { Ok(match s { "error" => Type::Error, "probe" => Type::Probe, "subscribe" => Type::Subscribe, "subscribed" => Type::Subscribed, "unavailable" => Type::Unavailable, "unsubscribe" => Type::Unsubscribe, "unsubscribed" => Type::Unsubscribed, _ => return Err(Error::ParseError("Invalid 'type' attribute on presence element.")), }) } } impl IntoAttributeValue for Type { fn into_attribute_value(self) -> Option { Some(match self { Type::None => return None, Type::Error => "error", Type::Probe => "probe", Type::Subscribe => "subscribe", Type::Subscribed => "subscribed", Type::Unavailable => "unavailable", Type::Unsubscribe => "unsubscribe", Type::Unsubscribed => "unsubscribed", }.to_owned()) } } #[derive(Debug, Clone)] pub struct Presence { pub from: Option, pub to: Option, pub id: Option, pub type_: Type, pub show: Show, pub statuses: BTreeMap, pub priority: Priority, pub payloads: Vec, } impl Presence { pub fn new(type_: Type) -> Presence { Presence { from: None, to: None, id: None, type_: type_, show: Show::None, statuses: BTreeMap::new(), priority: 0i8, payloads: vec!(), } } pub fn with_from(mut self, from: Option) -> Presence { self.from = from; self } pub fn with_to(mut self, to: Option) -> Presence { self.to = to; self } pub fn with_id(mut self, id: Option) -> Presence { self.id = id; self } pub fn with_show(mut self, show: Show) -> Presence { self.show = show; self } pub fn with_priority(mut self, priority: i8) -> Presence { self.priority = priority; self } pub fn with_payloads(mut self, payloads: Vec) -> Presence { self.payloads = payloads; self } } impl TryFrom for Presence { type Err = Error; fn try_from(root: Element) -> Result { if !root.is("presence", ns::JABBER_CLIENT) { return Err(Error::ParseError("This is not a presence element.")); } let mut show = None; let mut priority = None; let mut presence = Presence { from: get_attr!(root, "from", optional), to: get_attr!(root, "to", optional), id: get_attr!(root, "id", optional), type_: get_attr!(root, "type", default), show: Show::None, statuses: BTreeMap::new(), priority: 0i8, payloads: vec!(), }; for elem in root.children() { if elem.is("show", ns::JABBER_CLIENT) { if show.is_some() { return Err(Error::ParseError("More than one show element in a presence.")); } for _ in elem.children() { return Err(Error::ParseError("Unknown child in show element.")); } for _ in elem.attrs() { return Err(Error::ParseError("Unknown attribute in show element.")); } show = Some(Show::from_str(elem.text().as_ref())?); } else if elem.is("status", ns::JABBER_CLIENT) { for _ in elem.children() { return Err(Error::ParseError("Unknown child in status element.")); } for (attr, _) in elem.attrs() { if attr != "xml:lang" { return Err(Error::ParseError("Unknown attribute in status element.")); } } let lang = get_attr!(elem, "xml:lang", default); if presence.statuses.insert(lang, elem.text()).is_some() { return Err(Error::ParseError("Status element present twice for the same xml:lang.")); } } else if elem.is("priority", ns::JABBER_CLIENT) { if priority.is_some() { return Err(Error::ParseError("More than one priority element in a presence.")); } for _ in elem.children() { return Err(Error::ParseError("Unknown child in priority element.")); } for _ in elem.attrs() { return Err(Error::ParseError("Unknown attribute in priority element.")); } priority = Some(Priority::from_str(elem.text().as_ref())?); } else { presence.payloads.push(elem.clone()); } } if let Some(show) = show { presence.show = show; } if let Some(priority) = priority { presence.priority = priority; } Ok(presence) } } impl From for Element { fn from(presence: Presence) -> Element { Element::builder("presence") .ns(ns::JABBER_CLIENT) .attr("from", presence.from.and_then(|value| Some(String::from(value)))) .attr("to", presence.to.and_then(|value| Some(String::from(value)))) .attr("id", presence.id) .attr("type", presence.type_) .append(presence.show) .append(presence.statuses.iter().map(|(lang, status)| { Element::builder("status") .attr("xml:lang", match lang.as_ref() { "" => None, lang => Some(lang), }) .append(status) .build() }).collect::>()) .append(if presence.priority == 0 { None } else { Some(format!("{}", presence.priority)) }) .append(presence.payloads) .build() } } #[cfg(test)] mod tests { use super::*; #[test] fn test_simple() { let elem: Element = "".parse().unwrap(); let presence = Presence::try_from(elem).unwrap(); assert_eq!(presence.from, None); assert_eq!(presence.to, None); assert_eq!(presence.id, None); assert_eq!(presence.type_, Type::None); assert!(presence.payloads.is_empty()); } #[test] fn test_serialise() { let elem: Element = "".parse().unwrap(); let presence = Presence::new(Type::Unavailable); let elem2 = presence.into(); assert_eq!(elem, elem2); } #[test] fn test_show() { let elem: Element = "chat".parse().unwrap(); let presence = Presence::try_from(elem).unwrap(); assert_eq!(presence.payloads.len(), 0); assert_eq!(presence.show, Show::Chat); } #[test] fn test_missing_show_value() { // "online" used to be a pretty common mistake. let elem: Element = "".parse().unwrap(); let error = Presence::try_from(elem).unwrap_err(); let message = match error { Error::ParseError(string) => string, _ => panic!(), }; assert_eq!(message, "Invalid value for show."); } #[test] fn test_invalid_show() { // "online" used to be a pretty common mistake. let elem: Element = "online".parse().unwrap(); let error = Presence::try_from(elem).unwrap_err(); let message = match error { Error::ParseError(string) => string, _ => panic!(), }; assert_eq!(message, "Invalid value for show."); } #[test] fn test_empty_status() { let elem: Element = "".parse().unwrap(); let presence = Presence::try_from(elem).unwrap(); assert_eq!(presence.payloads.len(), 0); assert_eq!(presence.statuses.len(), 1); assert_eq!(presence.statuses[""], ""); } #[test] fn test_status() { let elem: Element = "Here!".parse().unwrap(); let presence = Presence::try_from(elem).unwrap(); assert_eq!(presence.payloads.len(), 0); assert_eq!(presence.statuses.len(), 1); assert_eq!(presence.statuses[""], "Here!"); } #[test] fn test_multiple_statuses() { let elem: Element = "Here!Là!".parse().unwrap(); let presence = Presence::try_from(elem).unwrap(); assert_eq!(presence.payloads.len(), 0); assert_eq!(presence.statuses.len(), 2); assert_eq!(presence.statuses[""], "Here!"); assert_eq!(presence.statuses["fr"], "Là!"); } #[test] fn test_invalid_multiple_statuses() { let elem: Element = "Here!Là!".parse().unwrap(); let error = Presence::try_from(elem).unwrap_err(); let message = match error { Error::ParseError(string) => string, _ => panic!(), }; assert_eq!(message, "Status element present twice for the same xml:lang."); } #[test] fn test_priority() { let elem: Element = "-1".parse().unwrap(); let presence = Presence::try_from(elem).unwrap(); assert_eq!(presence.payloads.len(), 0); assert_eq!(presence.priority, -1i8); } #[test] fn test_invalid_priority() { let elem: Element = "128".parse().unwrap(); let error = Presence::try_from(elem).unwrap_err(); match error { Error::ParseIntError(_) => (), _ => panic!(), }; } #[test] fn test_unknown_child() { let elem: Element = "".parse().unwrap(); let presence = Presence::try_from(elem).unwrap(); let payload = &presence.payloads[0]; assert!(payload.is("test", "invalid")); } #[test] fn test_invalid_status_child() { let elem: Element = "".parse().unwrap(); let error = Presence::try_from(elem).unwrap_err(); let message = match error { Error::ParseError(string) => string, _ => panic!(), }; assert_eq!(message, "Unknown child in status element."); } #[test] fn test_invalid_attribute() { let elem: Element = "".parse().unwrap(); let error = Presence::try_from(elem).unwrap_err(); let message = match error { Error::ParseError(string) => string, _ => panic!(), }; assert_eq!(message, "Unknown attribute in status element."); } #[test] fn test_serialise_status() { let status = Status::from("Hello world!"); let mut presence = Presence::new(Type::Unavailable); presence.statuses.insert(String::from(""), status); let elem: Element = presence.into(); assert!(elem.is("presence", ns::JABBER_CLIENT)); assert!(elem.children().next().unwrap().is("status", ns::JABBER_CLIENT)); } }