#![cfg_attr(not(any(feature = "json", test)), no_std)] #![deny(elided_lifetimes_in_paths)] #![deny(unreachable_pub)] use core::fmt::{self, Display, Formatter, Write}; use core::str; #[derive(Debug)] pub struct MarkupDisplay where E: Escaper, T: Display, { value: DisplayValue, escaper: E, } impl MarkupDisplay where E: Escaper, T: Display, { pub fn new_unsafe(value: T, escaper: E) -> Self { Self { value: DisplayValue::Unsafe(value), escaper, } } pub fn new_safe(value: T, escaper: E) -> Self { Self { value: DisplayValue::Safe(value), escaper, } } #[must_use] pub fn mark_safe(mut self) -> MarkupDisplay { self.value = match self.value { DisplayValue::Unsafe(t) => DisplayValue::Safe(t), _ => self.value, }; self } } impl Display for MarkupDisplay where E: Escaper, T: Display, { fn fmt(&self, fmt: &mut Formatter<'_>) -> fmt::Result { match self.value { DisplayValue::Unsafe(ref t) => write!( EscapeWriter { fmt, escaper: &self.escaper }, "{t}" ), DisplayValue::Safe(ref t) => t.fmt(fmt), } } } #[derive(Debug)] pub struct EscapeWriter<'a, E, W> { fmt: W, escaper: &'a E, } impl Write for EscapeWriter<'_, E, W> where W: Write, E: Escaper, { fn write_str(&mut self, s: &str) -> fmt::Result { self.escaper.write_escaped(&mut self.fmt, s) } } pub fn escape(string: &str, escaper: E) -> Escaped<'_, E> where E: Escaper, { Escaped { string, escaper } } #[derive(Debug)] pub struct Escaped<'a, E> where E: Escaper, { string: &'a str, escaper: E, } impl Display for Escaped<'_, E> where E: Escaper, { fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result { self.escaper.write_escaped(fmt, self.string) } } pub struct Html; impl Escaper for Html { fn write_escaped(&self, mut fmt: W, string: &str) -> fmt::Result where W: Write, { let mut last = 0; for (index, byte) in string.bytes().enumerate() { macro_rules! go { ($expr:expr) => {{ fmt.write_str(&string[last..index])?; fmt.write_str($expr)?; last = index + 1; }}; } match byte { b'<' => go!("<"), b'>' => go!(">"), b'&' => go!("&"), b'"' => go!("""), b'\'' => go!("'"), _ => {} } } fmt.write_str(&string[last..]) } } pub struct Text; impl Escaper for Text { fn write_escaped(&self, mut fmt: W, string: &str) -> fmt::Result where W: Write, { fmt.write_str(string) } } #[derive(Debug, PartialEq)] enum DisplayValue where T: Display, { Safe(T), Unsafe(T), } pub trait Escaper { fn write_escaped(&self, fmt: W, string: &str) -> fmt::Result where W: Write; } /// Escape chevrons, ampersand and apostrophes for use in JSON #[cfg(feature = "json")] #[derive(Debug, Clone, Default)] pub struct JsonEscapeBuffer(Vec); #[cfg(feature = "json")] impl JsonEscapeBuffer { pub fn new() -> Self { Self(Vec::new()) } pub fn finish(self) -> String { unsafe { String::from_utf8_unchecked(self.0) } } } #[cfg(feature = "json")] impl std::io::Write for JsonEscapeBuffer { fn write(&mut self, bytes: &[u8]) -> std::io::Result { let mut last = 0; for (index, byte) in bytes.iter().enumerate() { macro_rules! go { ($expr:expr) => {{ self.0.extend(&bytes[last..index]); self.0.extend($expr); last = index + 1; }}; } match byte { b'&' => go!(br#"\u0026"#), b'\'' => go!(br#"\u0027"#), b'<' => go!(br#"\u003c"#), b'>' => go!(br#"\u003e"#), _ => {} } } self.0.extend(&bytes[last..]); Ok(bytes.len()) } fn flush(&mut self) -> std::io::Result<()> { Ok(()) } } #[cfg(test)] mod tests { use super::*; use std::string::ToString; #[test] fn test_escape() { assert_eq!(escape("", Html).to_string(), ""); assert_eq!(escape("<&>", Html).to_string(), "<&>"); assert_eq!(escape("bla&", Html).to_string(), "bla&"); assert_eq!(escape("