use std::borrow::Cow;
pub fn escape_text(s: &str) -> Cow<'_, str> {
escape(s, false)
}
pub fn escape_attr(s: &str) -> Cow<'_, str> {
escape(s, true)
}
fn escape(s: &str, attr: bool) -> Cow<'_, str> {
let needs = s.bytes().any(|b| matches!(b, b'&' | b'<' | b'>') || (attr && matches!(b, b'"' | b'\'')));
if !needs {
return Cow::Borrowed(s);
}
let mut out = String::with_capacity(s.len() + 16);
for c in s.chars() {
match c {
'&' => out.push_str("&"),
'<' => out.push_str("<"),
'>' => out.push_str(">"),
'"' if attr => out.push_str("""),
'\'' if attr => out.push_str("'"),
c => out.push(c),
}
}
Cow::Owned(out)
}
pub(crate) fn escape_raw_text(s: &str) -> Cow<'_, str> {
if !s.contains("</") && !s.contains("<!--") {
return Cow::Borrowed(s);
}
Cow::Owned(s.replace("</", "<\\/").replace("<!--", "<\\!--"))
}
pub(crate) fn is_url_attr(name: &str) -> bool {
matches!(
name.to_ascii_lowercase().as_str(),
"href"
| "src"
| "action"
| "formaction"
| "poster"
| "cite"
| "background"
| "xlink:href"
| "manifest"
| "data"
)
}
pub fn is_safe_url(url: &str) -> bool {
let cleaned: String = url
.chars()
.filter(|c| !c.is_ascii_control() && !c.is_whitespace())
.take(32)
.collect::<String>()
.to_ascii_lowercase();
if cleaned.starts_with("javascript:") || cleaned.starts_with("vbscript:") {
return false;
}
if cleaned.starts_with("data:") {
return cleaned.starts_with("data:image/") && !cleaned.starts_with("data:image/svg");
}
true
}
pub(crate) fn is_valid_attr_name(name: &str) -> bool {
!name.is_empty()
&& name
.chars()
.all(|c| !c.is_control() && !c.is_whitespace() && !matches!(c, '"' | '\'' | '>' | '/' | '=' | '<' | '`'))
}
pub(crate) fn is_valid_tag_name(name: &str) -> bool {
let mut chars = name.chars();
matches!(chars.next(), Some(c) if c.is_ascii_alphabetic())
&& chars.all(|c| c.is_ascii_alphanumeric() || c == '-' || c == ':')
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn escapes() {
assert_eq!(escape_text("<a href='x'>&</a>"), "<a href='x'>&</a>");
assert_eq!(escape_attr("\"'<>&"), ""'<>&");
assert!(matches!(escape_text("plain"), Cow::Borrowed(_)));
}
#[test]
fn urls() {
assert!(is_safe_url("/about"));
assert!(is_safe_url("https://example.com/?q=javascript:"));
assert!(is_safe_url("data:image/png;base64,AAA"));
assert!(!is_safe_url("javascript:alert(1)"));
assert!(!is_safe_url(" JaVa\tScRiPt:alert(1)"));
assert!(!is_safe_url("\u{1}javascript:alert(1)"));
assert!(!is_safe_url("data:text/html,<script>"));
assert!(!is_safe_url("data:image/svg+xml,<svg onload=alert(1)>"));
assert!(!is_safe_url("vbscript:x"));
}
#[test]
fn raw_text() {
assert_eq!(escape_raw_text("a</script><script>"), "a<\\/script><script>");
}
#[test]
fn names() {
assert!(is_valid_attr_name("data-x"));
assert!(is_valid_attr_name("aria-label"));
assert!(!is_valid_attr_name("x onload=alert(1)"));
assert!(!is_valid_attr_name("a\"b"));
assert!(is_valid_tag_name("my-element"));
assert!(!is_valid_tag_name("script><img"));
}
}