Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HTML Search: filter script and style elements from search result summary text. #12057

Merged
merged 13 commits into from
Mar 17, 2024
Merged

HTML Search: filter script and style elements from search result summary text. #12057

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
12a094d
tests: add test coverage demonstrating that script text is unexpected…
jayaddison Mar 9, 2024
b51b66d
search: remove HTML script tags from the summary text in search results
jayaddison Mar 9, 2024
de34bcb
tests: add test coverage demonstrating that comments in HTML are not …
jayaddison Mar 9, 2024
74fd90b
tests: search: wrap sample HTML document body content within HTML <bo…
jayaddison Mar 9, 2024
ab78df5
tests: search: relocate <script> tag to become a child element of the…
jayaddison Mar 9, 2024
c069318
tests: add test coverage demonstrating that style element text is une…
jayaddison Mar 9, 2024
1314c10
search: remove HTML style elements from the summary text in search re…
jayaddison Mar 9, 2024
73f0111
Merge branch 'master' into issue-12052/search-result-summary-html-fil…
jayaddison Mar 15, 2024
b8c1543
Add CHANGES.rst entry
jayaddison Mar 15, 2024
296a42e
[refactor] Read search-summary filter queries from an array
jayaddison Mar 17, 2024
fd207ca
Merge branch 'master' into issue-12052/search-result-summary-html-fil…
jayaddison Mar 17, 2024
829a81a
Merge branch 'master' into issue-12052/search-result-summary-html-fil…
picnixz Mar 17, 2024
7a39cda
Merge branch 'master' into issue-12052/search-result-summary-html-fil…
picnixz Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGES.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,9 @@ Bugs fixed
Patch by Bénédikt Tran.
* #11894: Do not add checksums to css files if building using the htmlhelp builder.
Patch by mkay.
* #12052: Remove ``<script>`` and ``<style>`` tags from the content of search result
summary snippets.
Patch by James Addison.

Testing
-------
Expand Down
2 changes: 2 additions & 0 deletions sphinx/themes/basic/static/searchtools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ const Search = {
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
jayaddison marked this conversation as resolved.
Show resolved Hide resolved
htmlElement.querySelectorAll("script").forEach((el) => { el.remove() });
htmlElement.querySelectorAll("style").forEach((el) => { el.remove() });
if (anchor) {
const anchorContent = htmlElement.querySelector(anchor);
if (anchorContent) return anchorContent.textContent;
Expand Down
41 changes: 27 additions & 14 deletions tests/js/searchtools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,20 +61,33 @@ describe('Basic html theme search', function() {
describe("htmlToText", function() {

const testHTML = `<html>
<div class="body" role="main">
<section id="getting-started">
<h1>Getting Started</h1>
<p>Some text</p>
</section>
<section id="other-section">
<h1>Other Section</h1>
<p>Other text</p>
</section>
<section id="yet-another-section">
<h1>Yet Another Section</h1>
<p>More text</p>
</section>
</div>
<body>
<script src="directory/filename.js"></script>
<div class="body" role="main">
<script>
console.log('dynamic');
</script>
<style>
div.body p.centered {
text-align: center;
margin-top: 25px;
}
</style>
<!-- main content -->
<section id="getting-started">
<h1>Getting Started</h1>
<p>Some text</p>
</section>
<section id="other-section">
<h1>Other Section</h1>
<p>Other text</p>
</section>
<section id="yet-another-section">
<h1>Yet Another Section</h1>
<p>More text</p>
</section>
</div>
</body>
</html>`;

it("basic case", () => {
Expand Down