pep/xmpp-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Support comment and write to quick-xml Writer

Browse source
This commit is contained in:
Yue Liu 2018-01-05 20:20:12 -08:00 committed by Yue Liu
parent 74fb62f953
commit f456600efd
2 changed files with 125 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

128
src/element.rs
View file

@ -10,7 +10,8 @@ use std::borrow::Cow;
use error::{Error, ErrorKind, Result};
use quick_xml::reader::Reader as EventReader;
use quick_xml::events::{Event, BytesStart};
use quick_xml::writer::Writer as EventWriter;
use quick_xml::events::{Event, BytesStart, BytesEnd, BytesText, BytesDecl};
use std::io::BufRead;
@ -21,20 +22,50 @@ use std::slice;
use convert::{IntoElements, IntoAttributeValue, ElementEmitter};
use namespace_set::NamespaceSet;
/// Escape XML text
pub fn write_escaped<W: Write>(writer: &mut W, input: &str) -> Result<()> {
for c in input.chars() {
match c {
'&' => write!(writer, "&amp;")?,
'<' => write!(writer, "&lt;")?,
'>' => write!(writer, "&gt;")?,
'\'' => write!(writer, "&apos;")?,
'"' => write!(writer, "&quot;")?,
_ => write!(writer, "{}", c)?,
/// helper function to escape a `&[u8]` and replace all
/// xml special characters (<, >, &, ', ") with their corresponding
/// xml escaped value.
pub fn escape(raw: &[u8]) -> Cow<[u8]> {
let mut escapes: Vec<(usize, &'static [u8])> = Vec::new();
let mut bytes = raw.iter();
fn to_escape(b: u8) -> bool {
match b {
b'<' | b'>' | b'\'' | b'&' | b'"' => true,
_ => false,
}
}
Ok(())
let mut loc = 0;
while let Some(i) = bytes.position(|&b| to_escape(b)) {
loc += i;
match raw[loc] {
b'<' => escapes.push((loc, b"&lt;")),
b'>' => escapes.push((loc, b"&gt;")),
b'\'' => escapes.push((loc, b"&apos;")),
b'&' => escapes.push((loc, b"&amp;")),
b'"' => escapes.push((loc, b"&quot;")),
_ => unreachable!("Only '<', '>','\', '&' and '\"' are escaped"),
}
loc += 1;
}
if escapes.is_empty() {
Cow::Borrowed(raw)
} else {
let len = raw.len();
let mut v = Vec::with_capacity(len);
let mut start = 0;
for (i, r) in escapes {
v.extend_from_slice(&raw[start..i]);
v.extend_from_slice(r);
start = i + 1;
}
if start < len {
v.extend_from_slice(&raw[start..]);
}
Cow::Owned(v)
}
}
/// A node in an element tree.
@ -44,6 +75,8 @@ pub enum Node {
Element(Element),
/// A text node.
Text(String),
/// A comment node.
Comment(String),
}
impl Node {
@ -64,6 +97,7 @@ impl Node {
match *self {
Node::Element(ref e) => Some(e),
Node::Text(_) => None,
Node::Comment(_) => None,
}
}
@ -84,14 +118,22 @@ impl Node {
match *self {
Node::Element(_) => None,
Node::Text(ref s) => Some(s),
Node::Comment(_) => None,
}
}
fn write_to_inner<W: Write>(&self, writer: &mut W) -> Result<()>{
fn write_to_inner<W: Write>(&self, writer: &mut EventWriter<W>) -> Result<()>{
match *self {
Node::Element(ref elmt) => elmt.write_to_inner(writer)?,
Node::Text(ref s) => write_escaped(writer, s)?,
}
Node::Text(ref s) => {
writer.write_event(Event::Text(BytesText::from_str(s)))?;
()
},
Node::Comment(ref s) => {
writer.write_event(Event::Comment(BytesText::from_str(s)))?;
()
},
};
Ok(())
}
@ -382,7 +424,13 @@ impl Element {
Event::Eof => {
break;
},
Event::Comment { .. } |
Event::Comment(s) => {
let comment = reader.decode(&s).into_owned();
if comment != "" {
let current_elem = stack.last_mut().unwrap();
current_elem.append_comment_node(comment);
}
},
Event::Decl { .. } |
Event::PI { .. } |
Event::DocType { .. } => (),
@ -393,51 +441,48 @@ impl Element {
/// Output a document to a `Writer`.
pub fn write_to<W: Write>(&self, writer: &mut W) -> Result<()> {
write!(writer, "<?xml version=\"1.0\" encoding=\"utf-8\"?>")?;
self.to_writer(&mut EventWriter::new(writer))
}
/// Output the document to quick-xml `Writer`
pub fn to_writer<W: Write>(&self, writer: &mut EventWriter<W>) -> Result<()> {
writer.write_event(Event::Decl(BytesDecl::new(b"1.0", Some(b"utf-8"), None)))?;
self.write_to_inner(writer)
}
/// Like `write_to()` but without the `<?xml?>` prelude
pub fn write_to_inner<W: Write>(&self, writer: &mut W) -> Result<()> {
pub fn write_to_inner<W: Write>(&self, writer: &mut EventWriter<W>) -> Result<()> {
let name = match self.prefix {
None => Cow::Borrowed(&self.name),
Some(ref prefix) => Cow::Owned(format!("{}:{}", prefix, self.name)),
};
write!(writer, "<{}", name)?;
let mut start = BytesStart::borrowed(name.as_bytes(), name.len());
for (prefix, ns) in self.namespaces.declared_ns() {
match *prefix {
None => {
write!(writer, " xmlns=\"")?;
write_escaped(writer, ns)?;
write!(writer, "\"")?;
},
None => start.push_attribute(("xmlns", ns.as_ref())),
Some(ref prefix) => {
write!(writer, " xmlns:{}=\"", prefix)?;
write_escaped(writer, ns)?;
write!(writer, "\"")?;
let key = format!("xmlns:{}", prefix);
start.push_attribute((key.as_bytes(), ns.as_bytes()))
},
}
}
for (key, value) in &self.attributes {
write!(writer, " {}=\"", key)?;
write_escaped(writer, value)?;
write!(writer, "\"")?;
start.push_attribute((key.as_bytes(), escape(value.as_bytes()).as_ref()));
}
if self.children.is_empty() {
write!(writer, " />")?;
writer.write_event(Event::Empty(start))?;
return Ok(())
}
write!(writer, ">")?;
writer.write_event(Event::Start(start))?;
for child in &self.children {
child.write_to_inner(writer)?;
}
write!(writer, "</{}>", name)?;
writer.write_event(Event::End(BytesEnd::borrowed(name.as_bytes())))?;
Ok(())
}
@ -576,6 +621,21 @@ impl Element {
self.children.push(Node::Text(child.into()));
}
/// Appends a comment node to an `Element`.
///
/// # Examples
///
/// ```rust
/// use minidom::Element;
///
/// let mut elem = Element::bare("node");
///
/// elem.append_comment_node("comment");
/// ```
pub fn append_comment_node<S: Into<String>>(&mut self, child: S) {
self.children.push(Node::Comment(child.into()));
}
/// Appends a node to an `Element`.
///
/// # Examples

33
src/tests.rs
View file

@ -4,7 +4,7 @@ use quick_xml::reader::Reader;
use element::Element;
const TEST_STRING: &'static str = r#"<?xml version="1.0" encoding="utf-8"?><root xmlns="root_ns" a="b" xml:lang="en">meow<child c="d" /><child xmlns="child_ns" d="e" xml:lang="fr" />nya</root>"#;
const TEST_STRING: &'static str = r#"<?xml version="1.0" encoding="utf-8"?><root xmlns="root_ns" a="b" xml:lang="en">meow<child c="d"/><child xmlns="child_ns" d="e" xml:lang="fr"/>nya</root>"#;
fn build_test_tree() -> Element {
let mut root = Element::builder("root")
@ -27,6 +27,19 @@ fn build_test_tree() -> Element {
root
}
const COMMENT_TEST_STRING: &'static str = r#"<?xml version="1.0" encoding="utf-8"?><root><!--This is a child.--><child attr="val"><!--This is a grandchild.--><grandchild/></child></root>"#;
fn build_comment_test_tree() -> Element {
let mut root = Element::builder("root").build();
root.append_comment_node("This is a child.");
let mut child = Element::builder("child").attr("attr", "val").build();
child.append_comment_node("This is a grandchild.");
let grand_child = Element::builder("grandchild").build();
child.append_child(grand_child);
root.append_child(child);
root
}
#[test]
fn reader_works() {
let mut reader = Reader::from_str(TEST_STRING);
@ -53,7 +66,7 @@ fn writer_escapes_attributes() {
root.write_to(&mut writer).unwrap();
}
assert_eq!(String::from_utf8(writer).unwrap(),
r#"<?xml version="1.0" encoding="utf-8"?><root a="&quot;Air&quot; quotes" />"#
r#"<?xml version="1.0" encoding="utf-8"?><root a="&quot;Air&quot; quotes"/>"#
);
}
@ -197,3 +210,19 @@ fn namespace_inherited_prefixed2() {
assert_eq!(child.name(), "message");
assert_eq!(child.ns(), Some("jabber:client".to_owned()));
}
#[test]
fn read_comments() {
let mut reader = Reader::from_str(COMMENT_TEST_STRING);
assert_eq!(Element::from_reader(&mut reader).unwrap(), build_comment_test_tree());
}
#[test]
fn write_comments() {
let root = build_comment_test_tree();
let mut writer = Vec::new();
{
root.write_to(&mut writer).unwrap();
}
assert_eq!(String::from_utf8(writer).unwrap(), COMMENT_TEST_STRING);
}