html-helpers 0.2.1

DEPRECATED: This crate has been renamed to htmlr. Please use htmlr instead.
Documentation 
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

use crate::Result;
use html_escape::encode_double_quoted_attribute;
use scraper::ElementRef;

// region:    --- Constants

/// Tags to remove explicitly, regardless of content (unless within <head>).
pub(super) const TAGS_TO_REMOVE: &[&str] = &["script", "link", "style", "svg", "base"];

/// Tags that should be removed if they become effectively empty (contain only whitespace/comments)
/// after processing children. Applies only outside the <head> element.
pub(super) const REMOVABLE_EMPTY_TAGS: &[&str] =
	&["div", "span", "p", "i", "b", "em", "strong", "section", "article", "header", "footer", "nav", "aside"];

/// Keywords to check within the 'property' attribute of <meta> tags to determine if they should be kept.
pub(super) const META_PROPERTY_KEYWORDS: &[&str] = &["title", "url", "image", "description"];

/// Attribute names allowed on <meta> tags within the <head>.
pub(super) const ALLOWED_META_ATTRS: &[&str] = &["property", "content"];

/// Attribute names allowed on elements outside the <head>.
pub(super) const ALLOWED_BODY_ATTRS: &[&str] = &["class", "aria-label", "href", "title", "id"];

/// Tags considered block-level for indentation purposes (used when indent > 0).
#[rustfmt::skip]
pub(super) const BLOCK_LEVEL_TAGS: &[&str] = &[
	"html", "head", "body", "a", "div", "p", "section", "article", "header", "footer", "nav", "aside",
	"ul", "ol", "li", "table", "tr", "td", "th", "h1", "h2", "h3", "h4", "h5", "h6",
	"pre", "blockquote", "main", "form", "fieldset", "details", "summary", "figure", "figcaption",
	"dl", "dt", "dd", "br", "hr", "img", "input", "meta", "link", "script", "style",
];

/// HTML void elements (should not have closing tags).
#[rustfmt::skip]
pub(super) const VOID_ELEMENTS: &[&str] = &[
	"area", "base", "br", "col", "embed", "hr", "img", "input", "link", "meta",
	"param", "source", "track", "wbr",
];

// endregion: --- Constants

/// Removes empty lines from the given content, returning the cleaned string.
pub(super) fn remove_empty_lines(content: String) -> Result<String> {
	let lines: Vec<&str> = content.lines().filter(|line| !line.trim().is_empty()).collect();
	Ok(lines.join("\n"))
}

/// Checks if a string contains only whitespace characters.
pub(super) fn is_string_effectively_empty(s: &str) -> bool {
	s.trim().is_empty()
}

/// Checks if a `<meta>` tag element should be kept based on its `property` attribute.
pub(super) fn should_keep_meta(element: ElementRef) -> bool {
	// Check if the element is actually a <meta> tag
	if element.value().name() != "meta" {
		return false;
	}

	if let Some(prop_value) = element.value().attr("property") {
		let value_lower = prop_value.to_lowercase();
		// Check if the property value contains any of the relevant keywords
		META_PROPERTY_KEYWORDS
			.iter()
			.any(|&keyword| value_lower.contains(keyword))
	} else {
		// No 'property' attribute found
		false
	}
}

/// Filters attributes of an element and writes the allowed ones to the output string.
pub(super) fn filter_and_write_attributes(
	element: ElementRef,
	is_in_head_context: bool,
	output: &mut String,
) -> Result<()> {
	let tag_name = element.value().name();

	// Determine the correct list of allowed attributes based on context
	let allowed_attrs: &[&str] = if is_in_head_context {
		match tag_name {
			"meta" => ALLOWED_META_ATTRS,
			"title" => &[], // No attributes allowed on title
			_ => &[],       // Default deny for other unexpected tags in head
		}
	} else {
		// Outside head context
		ALLOWED_BODY_ATTRS
	};

	// Iterate over attributes and append allowed ones
	for (name, value) in element.value().attrs() {
		// Check against the determined allowlist
		if allowed_attrs.contains(&name) {
			output.push(' ');
			output.push_str(name);
			output.push_str("=\"");
			// Encode attribute value correctly
			output.push_str(&encode_double_quoted_attribute(value));
			output.push('"');
		}
	}

	Ok(())
}