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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
//! This library provides a basic API for serializing / deserializng xmlrpc.
//! Combine with your transport or server of choice for an easy and quick xmlrpc experience.
use quick_xml::{events::Event, name::QName, Reader, Writer};
use serde::Deserialize;
use serde_transcode::transcode;
mod error;
mod util;
mod value;
use util::{ReaderExt, ValueDeserializer, ValueSerializer, WriterExt};
pub use error::{Error, Fault, Result};
pub use value::{to_value, Value};
/// Parses the body of an xmlrpc http request and attempts to convert it to the desired type.
/// ```
/// let val: String = serde_xmlrpc::response_from_str(
/// r#"<?xml version="1.0" encoding="utf-8"?>
/// <methodResponse>
/// <params>
/// <param><value><string>hello world</string></value></param>
/// </params>
/// </methodResponse>"#).unwrap();
///
/// assert_eq!(val, "hello world".to_string());
/// ```
pub fn response_from_str<'a, T>(input: &'a str) -> Result<T>
where
T: serde::de::Deserialize<'a>,
{
let mut reader = Reader::from_str(input);
reader.expand_empty_elements(true);
reader.trim_text(true);
// Check the first event. This will determine if we're loading a Fault or a
// Value.
loop {
match reader.read_event().map_err(error::DecodingError::from)? {
Event::Decl(_) => continue,
Event::Start(e) if e.name() == QName(b"methodResponse") => {
break;
}
e => return Err(error::DecodingError::UnexpectedEvent(format!("{:?}", e)).into()),
};
}
match reader.read_event().map_err(error::DecodingError::from)? {
Event::Start(e) if e.name() == QName(b"params") => {
reader.expect_tag(QName(b"param"))?;
reader.expect_tag(QName(b"value"))?;
let deserializer = ValueDeserializer::new(&mut reader)?;
let ret = T::deserialize(deserializer)?;
reader
.read_to_end(QName(b"param"))
.map_err(error::DecodingError::from)?;
reader
.read_to_end(e.name())
.map_err(error::DecodingError::from)?;
Ok(ret)
}
Event::Start(e) if e.name() == QName(b"fault") => {
// The inner portion of a fault is just a Value tag, so we
// deserialize it from a value.
reader.expect_tag(QName(b"value"))?;
let deserializer = ValueDeserializer::new(&mut reader)?;
let fault: Fault = Fault::deserialize(deserializer)?;
// Pull the reader back out so we can verify the end tag.
//let mut reader = deserializer.into_inner();
reader
.read_to_end(e.name())
.map_err(error::DecodingError::from)?;
Err(fault.into())
}
e => Err(error::DecodingError::UnexpectedEvent(format!("{:?}", e)).into()),
}
}
/// Attempt to serialize a xmlrpc response from a list of values.
/// Each item in the list will be represented as a separate "param" in xmlrpc parlance.
/// ```
/// use serde_xmlrpc::{response_to_string,Value};
/// let body = response_to_string(vec![Value::Int(42), Value::String("data".to_string())].into_iter()).unwrap();
/// assert_eq!(body,
/// r#"<?xml version="1.0" encoding="utf-8"?><methodResponse><params><param><value><int>42</int></value></param><param><value><string>data</string></value></param></params></methodResponse>"#
/// );
/// ```
pub fn response_to_string(params: impl Iterator<Item = Value>) -> Result<String> {
let mut writer = Writer::new(Vec::new());
writer.write_decl()?;
writer.write_start_tag("methodResponse")?;
writer.write_start_tag("params")?;
for value in params {
writer.write_start_tag("param")?;
let deserializer = value::Deserializer::from_value(value);
let serializer = ValueSerializer::new(&mut writer);
transcode(deserializer, serializer)?;
writer.write_end_tag("param")?;
}
writer.write_end_tag("params")?;
writer.write_end_tag("methodResponse")?;
Ok(String::from_utf8(writer.into_inner()).map_err(error::EncodingError::from)?)
}
/// Expects an input string which is a valid xmlrpc request body, and parses out the method name and parameters from it.
/// This function would typically be used by a server to parse incoming requests.
/// * Returns a tuple of (method name, Arguments) if successful
/// This does not parse the types of the arguments, as typically the server needs to resolve
/// the method name before it can know the expected types.
pub fn request_from_str(request: &str) -> Result<(String, Vec<Value>)> {
let mut reader = Reader::from_str(request);
reader.expand_empty_elements(true);
reader.trim_text(true);
// Search for methodCall start
loop {
match reader.read_event().map_err(error::DecodingError::from)? {
Event::Decl(_) => continue,
Event::Start(e) if e.name() == QName(b"methodCall") => {
break;
}
e => return Err(error::DecodingError::UnexpectedEvent(format!("{:?}", e)).into()),
};
}
// This code currently assumes that the <methodName> will always precede <params>
// in the xmlrpc request, I'm not certain that this is actually enforced by the
// specification, but could find not counter example where it wasn't true... -Carter
let method_name = match reader.read_event().map_err(error::DecodingError::from)? {
Event::Start(e) if e.name() == QName(b"methodName") => reader
.read_text(e.name())
.map_err(error::DecodingError::from)?,
e => return Err(error::DecodingError::UnexpectedEvent(format!("{:?}", e)).into()),
};
match reader.read_event().map_err(error::DecodingError::from)? {
Event::Start(e) if e.name() == QName(b"params") => {
let mut params = Vec::new();
let params = loop {
break match reader.read_event().map_err(error::DecodingError::from)? {
// Read each parameter into a Value
Event::Start(e) if e.name() == QName(b"param") => {
reader.expect_tag(QName(b"value"))?;
let deserializer = ValueDeserializer::new(&mut reader)?;
let serializer = value::Serializer::new();
let x = transcode(deserializer, serializer)?;
params.push(x);
reader
.read_to_end(e.name())
.map_err(error::DecodingError::from)?;
continue;
}
// Once we see the relevant params end tag, we know we have all the params.
Event::End(e) if e.name() == QName(b"params") => params,
e => {
return Err(error::DecodingError::UnexpectedEvent(format!("{:?}", e)).into())
}
};
};
// We can skip reading to the end of the params tag because if we're
// here, we've already hit the end tag.
Ok((method_name.into_owned(), params))
}
e => Err(error::DecodingError::UnexpectedEvent(format!("{:?}", e)).into()),
}
}
/// Takes in the name of a method call and a list of parameters and attempts to convert them to a String
/// which would be a valid body for an xmlrpc request.
///
/// ```
/// let body = serde_xmlrpc::request_to_string("myMethod", vec![1.into(), "param2".into()]);
/// ```
pub fn request_to_string(name: &str, args: Vec<Value>) -> Result<String> {
let mut writer = Writer::new(Vec::new());
writer.write_decl()?;
writer.write_start_tag("methodCall")?;
writer.write_tag("methodName", name)?;
writer.write_start_tag("params")?;
for value in args {
writer.write_start_tag("param")?;
let deserializer = value::Deserializer::from_value(value);
let serializer = ValueSerializer::new(&mut writer);
transcode(deserializer, serializer)?;
writer.write_end_tag("param")?;
}
writer.write_end_tag("params")?;
writer.write_end_tag("methodCall")?;
Ok(String::from_utf8(writer.into_inner()).map_err(error::EncodingError::from)?)
}
/// Attempts to parse an individual value out of a str.
/// ```
/// let x = serde_xmlrpc::value_from_str("<value><int>42</int></value>").unwrap().as_i32();
/// assert_eq!(x, Some(42));
/// ```
pub fn value_from_str(input: &str) -> Result<Value> {
let mut reader = Reader::from_str(input);
reader.expand_empty_elements(true);
reader.trim_text(true);
reader.expect_tag(QName(b"value"))?;
let deserializer = ValueDeserializer::new(&mut reader)?;
let serializer = value::Serializer::new();
transcode(deserializer, serializer)
}
/// Attempts to convert any data type which can be represented as an xmlrpc value into a String.
/// ```
/// let a = serde_xmlrpc::value_to_string(42);
/// let b = serde_xmlrpc::value_to_string("Text");
/// let c = serde_xmlrpc::value_to_string(false);
/// ```
pub fn value_to_string<I>(val: I) -> Result<String>
where
I: Into<Value>,
{
let d = value::Deserializer::from_value(val.into());
let mut writer = Writer::new(Vec::new());
let s = ValueSerializer::new(&mut writer);
transcode(d, s)?;
Ok(String::from_utf8(writer.into_inner()).map_err(error::EncodingError::from)?)
}
/// Attempts to convert a Vec of values to any data type which can be deserialized.
/// This is typically used with [request_from_str] to implement server behavior:
/// ```
/// let val = r#"<?xml version=\"1.0\"?>
/// <methodCall>
/// <methodName>requestTopic</methodName>
/// <params>
/// <param><value>/rosout</value></param>
/// <param><value><int>42</int></value></param>
/// </params>
/// </methodCall>"#;
/// // Parse the request
/// let (method, vals) = serde_xmlrpc::request_from_str(val).unwrap();
/// // Now that we know what method is being called we can typecast our args
/// let (a, b): (String, i32) = serde_xmlrpc::from_values(vals).unwrap();
/// ```
pub fn from_values<T: serde::de::DeserializeOwned>(values: Vec<Value>) -> Result<T> {
// Wrap input vec into our value type so it is compatible with our deserializer
// Kinda a cheap hack, but I like returning Vec<Value> for the args to a function
// instead of a Value which is itself an array...
let val = Value::Array(values);
from_value(val)
}
/// Attempts to deserialize the Value into the given type, equivalent API of
/// [serde_json::from_value](https://docs.rs/serde_json/latest/serde_json/fn.from_value.html).
/// ```
/// use serde_xmlrpc::{from_value, Value};
/// let val = Value::Array(vec![Value::Int(3), Value::String("Test".to_string())]);
/// let (x, y): (i32, String) = from_value(val).unwrap();
/// ```
pub fn from_value<T: serde::de::DeserializeOwned>(value: Value) -> Result<T> {
let d = value::Deserializer::from_value(value);
T::deserialize(d)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_stringify_request() {
assert_eq!(
request_to_string("hello world", vec![]).unwrap(),
r#"<?xml version="1.0" encoding="utf-8"?><methodCall><methodName>hello world</methodName><params></params></methodCall>"#.to_owned()
)
}
/// A 32-bit signed integer (`<i4>` or `<int>`).
#[test]
fn parse_int_values() {
assert_eq!(
value_from_str("<value><int>42</int></value>")
.unwrap()
.as_i32(),
Some(42)
);
assert_eq!(
value_from_str("<value><int>-42</int></value>")
.unwrap()
.as_i32(),
Some(-42)
);
assert_eq!(
value_from_str("<value><int>2147483647</int></value>")
.unwrap()
.as_i32(),
Some(2147483647)
);
}
/// A 64-bit signed integer (`<i8>`).
#[test]
fn parse_long_values() {
assert_eq!(
value_from_str("<value><int>42</int></value>")
.unwrap()
.as_i64(),
Some(42)
);
assert_eq!(
value_from_str("<value><int>9223372036854775807</int></value>")
.unwrap()
.as_i64(),
Some(9223372036854775807)
);
}
/// A boolean value (`<boolean>`, 0 == `false`, 1 == `true`).
#[test]
fn parse_boolean_values() {
assert_eq!(
value_from_str("<value><boolean>1</boolean></value>")
.unwrap()
.as_bool(),
Some(true)
);
assert_eq!(
value_from_str("<value><boolean>0</boolean></value>")
.unwrap()
.as_bool(),
Some(false)
);
}
/// A string (`<string>`). Note that these can also appear as a raw
/// value tag as well.
#[test]
fn parse_string_values() {
assert_eq!(
value_from_str("<value><string>hello</string></value>")
.unwrap()
.as_str(),
Some("hello")
);
assert_eq!(
value_from_str("<value>world</value>").unwrap().as_str(),
Some("world")
);
assert_eq!(value_from_str("<value />").unwrap().as_str(), Some(""));
}
/// A double-precision IEEE 754 floating point number (`<double>`).
#[test]
fn parse_double_values() {
assert_eq!(
value_from_str("<value><double>1</double></value>")
.unwrap()
.as_f64(),
Some(1.0)
);
assert_eq!(
value_from_str("<value><double>0</double></value>")
.unwrap()
.as_f64(),
Some(0.0)
);
assert_eq!(
value_from_str("<value><double>42</double></value>")
.unwrap()
.as_f64(),
Some(42.0)
);
assert_eq!(
value_from_str("<value><double>3.14</double></value>")
.unwrap()
.as_f64(),
Some(3.14)
);
assert_eq!(
value_from_str("<value><double>-3.14</double></value>")
.unwrap()
.as_f64(),
Some(-3.14)
);
}
/// An ISO 8601 formatted date/time value (`<dateTime.iso8601>`).
/// Base64-encoded binary data (`<base64>`).
#[test]
fn parse_base64_values() {
assert_eq!(
value_from_str("<value><base64>aGVsbG8gd29ybGQ=</base64></value>")
.unwrap()
.as_bytes(),
Some(&b"hello world"[..])
);
}
/// A mapping of named values (`<struct>`).
/// A list of arbitrary (heterogeneous) values (`<array>`).
#[test]
fn parse_array_values() {
assert_eq!(
value_from_str(
"<value><array><data><value></value><value><nil /></value></data></array></value>"
)
.unwrap()
.as_array(),
Some(&[Value::String("".to_owned()), Value::Nil][..])
);
}
/// The empty (Unit) value (`<nil/>`).
#[test]
fn parse_nil_values() {
assert_eq!(
value_from_str("<value><nil /></value>").unwrap(),
Value::Nil
);
}
#[test]
fn parse_fault() {
let err = response_from_str::<String>(
r#"<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<fault>
<value>
<struct>
<member>
<name>faultCode</name>
<value><int>4</int></value>
</member>
<member>
<name>faultString</name>
<value><string>Too many parameters.</string></value>
</member>
</struct>
</value>
</fault>
</methodResponse>"#,
)
.unwrap_err();
match err {
error::Error::Fault(f) => assert_eq!(
f,
error::Fault {
fault_code: 4,
fault_string: "Too many parameters.".into(),
}
),
_ => {
println!("{:?}", err);
assert!(false);
}
}
}
#[test]
fn parse_value() {
let val: String = response_from_str(
r#"<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param><value><string>hello world</string></value></param>
</params>
</methodResponse>"#,
)
.unwrap();
assert_eq!(val, "hello world".to_string());
}
#[test]
fn test_parse_request_multiple_params() {
let val = r#"<?xml version=\"1.0\"?>
<methodCall>
<methodName>requestTopic</methodName>
<params>
<param><value>/rosout</value></param>
<param><value><int>42</int></value></param>
<param><value><array><data><value><array><data><value>TCPROS</value></data></array></value></data></array></value></param>
</params>
</methodCall>"#;
let (method, vals) = request_from_str(val).unwrap();
assert_eq!(&method, "requestTopic");
// This is a little redundant with test_from_values, but is easiest way
// to confirm parsing was perfect
let (a, b, c): (String, i32, Vec<Vec<String>>) = from_values(vals).unwrap();
assert_eq!(a, "/rosout");
assert_eq!(b, 42);
assert_eq!(c, vec![vec!["TCPROS".to_string()]]);
}
#[test]
fn test_response_to_value() {
// Ensure Value implementes serde::Deserialize. This allows reading
// responses into a Value rather than a specific type.
let val: Value = response_from_str(
r#"<?xml version="1.0" encoding="utf-8"?>
<methodResponse>
<params>
<param><value><string>hello world</string></value></param>
</params>
</methodResponse>"#,
)
.unwrap();
assert_eq!(val, Value::String("hello world".to_string()));
}
#[test]
fn test_from_values() {
let vals = vec![
Value::Int(32),
Value::Double(1.0),
Value::String("hello".to_string()),
];
let (a, b, c): (i32, f64, String) = from_values(vals).unwrap();
assert_eq!(a, 32);
assert_eq!(b, 1.0);
assert_eq!(c, "hello");
}
}