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
use crate::{HtmlContent, HtmlFormatter};
use ammonia::Builder;
use std::{fmt, io, sync::OnceLock};
pub type SanitizeConfig = Builder<'static>;
static DEFAULT_SANITIZER: OnceLock<SanitizeConfig> = OnceLock::new();
fn default_sanitizer() -> &'static SanitizeConfig {
DEFAULT_SANITIZER.get_or_init(Builder::default)
}
#[derive(Clone, Copy)]
enum Sanitizer {
/// Use the default sanitizer.
Default,
/// Use the given sanitizer.
Builder(&'static SanitizeConfig),
}
impl Default for Sanitizer {
fn default() -> Self {
Self::Default
}
}
impl AsRef<SanitizeConfig> for Sanitizer {
fn as_ref(&self) -> &SanitizeConfig {
match self {
Self::Default => default_sanitizer(),
Self::Builder(builder) => builder,
}
}
}
/// A wrapper struct for adding potentially unsanitized HTML content that will be sanitized before rendering.
///
/// The `Sanitized` struct allows you to include HTML content that might be potentially unsafe,
/// and ensures that it's properly sanitized before being rendered within your HTML components.
/// This is particularly useful when you want to include user-generated content or any content
/// that might contain unsafe HTML elements or scripts.
#[derive(Clone)]
pub struct Sanitized<V>(V, Sanitizer);
impl<V: fmt::Debug> fmt::Debug for Sanitized<V> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_tuple("Sanitized").field(&self.0).finish()
}
}
impl<V> Sanitized<V>
where
V: AsRef<[u8]>,
{
/// Creates a new `Sanitized` instance with the HTML content to be sanitized before rendering.
///
/// # Arguments
///
/// - `value`: The HTML content to be sanitized as a byte slice.
///
/// # Returns
///
/// A `Sanitized` instance wrapping the HTML content that will be sanitized before rendering.
pub fn new(value: V) -> Self {
Self(value, Sanitizer::default())
}
/// Creates a new `Sanitized` instance with the HTML content and a custom sanitizer.
///
/// # Arguments
///
/// - `value`: The HTML content to be sanitized as a byte slice.
/// - `sanitizer`: The custom sanitizer to be used for this specific instance.
///
/// # Returns
///
/// A `Sanitized` instance wrapping the HTML content that will be sanitized using the specified sanitizer.
pub fn new_with_sanitizer(value: V, sanitizer: &'static SanitizeConfig) -> Self {
Self(value, Sanitizer::Builder(sanitizer))
}
/// Sets a custom sanitizer for this `Sanitized` instance.
///
/// This method allows you to override the default sanitizer for a specific `Sanitized` instance.
///
/// # Arguments
///
/// - `sanitizer`: The custom sanitizer to be used for this specific instance.
///
/// # Returns
///
/// A new `Sanitized` instance with the specified sanitizer.
pub fn with_sanitizer(self, sanitizer: &'static SanitizeConfig) -> Self {
Self(self.0, Sanitizer::Builder(sanitizer))
}
}
impl<V: AsRef<[u8]>> HtmlContent for Sanitized<V> {
fn fmt(self, formatter: &mut HtmlFormatter) -> fmt::Result {
let bytes = self.0.as_ref();
let bytes = self
.1
.as_ref()
.clean_from_reader(bytes)
.map_err(|_| fmt::Error)?;
bytes.write_to(IoWrite(formatter)).map_err(|_| fmt::Error)
}
}
struct IoWrite<'a, 'b>(&'a mut HtmlFormatter<'b>);
impl<'a, 'b> io::Write for IoWrite<'a, 'b> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
self.0.write_bytes(buf);
Ok(buf.len())
}
fn flush(&mut self) -> io::Result<()> {
Ok(())
}
}