1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
use super::Message;
use std::collections::HashMap;
use std::error;
use std::fmt;
/// Errors related specifically to SIP <=> JSON routines
#[derive(Debug)]
pub enum SipJsonError {
/// Data does not contain the correct content, e.g. sip message code.
MessageFormatError(String),
/// Data cannot be successfully minipulated as JSON
JsonError(json::Error),
}
impl error::Error for SipJsonError {
fn source(&self) -> Option<&(dyn error::Error + 'static)> {
match *self {
SipJsonError::JsonError(ref err) => Some(err),
_ => None,
}
}
}
impl fmt::Display for SipJsonError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
SipJsonError::JsonError(ref err) => err.fmt(f),
SipJsonError::MessageFormatError(s) => {
write!(f, "SIP message could not be translated to/from JSON: {}", s)
}
}
}
}
impl Message {
/// Translate a SIP Message into a JSON object.
///
/// ```
/// use sip2::{Message, Field, FixedField};
/// use sip2::spec;
/// use json;
///
/// let msg = Message::new(
/// &spec::M_LOGIN,
/// vec![
/// FixedField::new(&spec::FF_UID_ALGO, "0").unwrap(),
/// FixedField::new(&spec::FF_PWD_ALGO, "0").unwrap(),
/// ],
/// vec![
/// Field::new(spec::F_LOGIN_UID.code, "sip_username"),
/// Field::new(spec::F_LOGIN_PWD.code, "sip_password"),
/// ]
/// );
///
/// let json_val = msg.to_json_value();
/// let expected = json::object!{
/// "code":"93",
/// "fixed_fields":["0","0"],
/// "fields":[{"CN":"sip_username"},{"CO":"sip_password"}]};
///
/// assert_eq!(expected, json_val);
/// ```
pub fn to_json_value(&self) -> json::JsonValue {
let ff: Vec<String> = self
.fixed_fields()
.iter()
.map(|f| f.value().to_string())
.collect();
let mut fields: Vec<HashMap<String, String>> = Vec::new();
for f in self.fields().iter() {
let mut map = HashMap::new();
map.insert(f.code().to_string(), f.value().to_string());
fields.push(map);
}
json::object! {
"code": self.spec().code,
"fixed_fields": ff,
"fields": fields
}
}
/// Translate a SIP Message into a JSON string.
///
/// ```
/// use sip2::{Message, Field, FixedField};
/// use sip2::spec;
///
/// let msg = Message::new(
/// &spec::M_LOGIN,
/// vec![
/// FixedField::new(&spec::FF_UID_ALGO, "0").unwrap(),
/// FixedField::new(&spec::FF_PWD_ALGO, "0").unwrap(),
/// ],
/// vec![
/// Field::new(spec::F_LOGIN_UID.code, "sip_username"),
/// Field::new(spec::F_LOGIN_PWD.code, "sip_password"),
/// ]
/// );
///
/// let json_str = msg.to_json();
///
/// // Comparing JSON strings is nontrivial with hashes.
/// // Assume completion means success. See to_json_value() for
/// // more rigorous testing.
/// assert_eq!(true, true);
/// ```
pub fn to_json(&self) -> String {
self.to_json_value().dump()
}
/// Translate a JSON object into a SIP Message.
///
/// ```
/// use sip2::{Message, Field, FixedField};
/// use sip2::spec;
/// use json;
///
/// let expected = Message::new(
/// &spec::M_LOGIN,
/// vec![
/// FixedField::new(&spec::FF_UID_ALGO, "0").unwrap(),
/// FixedField::new(&spec::FF_PWD_ALGO, "0").unwrap(),
/// ],
/// vec![
/// Field::new(spec::F_LOGIN_UID.code, "sip_username"),
/// Field::new(spec::F_LOGIN_PWD.code, "sip_password"),
/// ]
/// );
///
/// let json_val = json::object!{
/// "code":"93",
/// "fixed_fields":["0","0"],
/// "fields":[{"CN":"sip_username"},{"CO":"sip_password"}]};
///
/// let msg = Message::from_json_value(json_val).unwrap();
///
/// assert_eq!(expected, msg);
/// ```
pub fn from_json_value(mut json_value: json::JsonValue) -> Result<Message, SipJsonError> {
// Start with a message that's just the code plus fixed fields
// as a SIP string.
let mut strbuf = json_value["code"].take_string().ok_or_else(|| {
SipJsonError::MessageFormatError("Message requires a code".to_string())
})?;
while !json_value["fixed_fields"].is_empty() {
strbuf += &format!("{}", json_value["fixed_fields"].array_remove(0));
}
// Since we're creating this partial SIP string from raw
// JSON values, clean it up before parsing as SIP.
strbuf = super::util::sip_string(&strbuf);
let mut msg = match Message::from_sip(&strbuf) {
Ok(m) => m,
Err(e) => {
return Err(SipJsonError::MessageFormatError(format!(
"Message is not correctly formatted: {e} {}",
json_value.dump()
)))
}
};
// TODO this code could take better advantage of the fact
// that we're consuming the JsonValue.
for field in json_value["fields"].members() {
for (code, value) in field.entries() {
if value.is_object() || value.is_array() {
return Err(SipJsonError::MessageFormatError(format!(
"Message is not correctly formatted: {}",
json_value.dump()
)));
}
if value.is_null() {
msg.add_field(code, "");
} else {
msg.add_field(code, &format!("{}", value));
}
}
}
Ok(msg)
}
/// Translate a JSON string into a SIP Message.
///
/// ```
/// use sip2::{Message, Field, FixedField};
/// use sip2::spec;
/// use json;
///
/// let expected = Message::new(
/// &spec::M_LOGIN,
/// vec![
/// FixedField::new(&spec::FF_UID_ALGO, "0").unwrap(),
/// FixedField::new(&spec::FF_PWD_ALGO, "0").unwrap(),
/// ],
/// vec![
/// Field::new(spec::F_LOGIN_UID.code, "sip_username"),
/// Field::new(spec::F_LOGIN_PWD.code, "sip_password"),
/// ]
/// );
///
/// let json_str = r#"
/// {
/// "code":"93",
/// "fixed_fields":["0","0"],
/// "fields":[{"CN":"sip_username"},{"CO":"sip_password"}]
/// }
/// "#;
///
/// let msg = Message::from_json(&json_str).unwrap();
///
/// assert_eq!(expected, msg);
/// ```
pub fn from_json(msg_json: &str) -> Result<Message, SipJsonError> {
let json_value: json::JsonValue = match json::parse(msg_json) {
Ok(v) => v,
Err(e) => {
return Err(SipJsonError::JsonError(e));
}
};
Message::from_json_value(json_value)
}
}