<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[58870] trunk: HTML API: `expect_closer()` should report false for self-closing foreign elements.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/58870">58870</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/58870","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dmsnell</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-08-08 16:13:25 +0000 (Thu, 08 Aug 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>HTML API: `expect_closer()` should report false for self-closing foreign elements.
Previously, `WP_HTML_Processor::expects_closer()` would report `true` for self-closing foreign elements when called without supplying a node in question, but it should have been reporting `true` just as it does for HTML elements.
This patch adds a test case demonstrating the issue and a bugfix.
The `html5lib` test runner was relying on the incorrect behavior, accidentally working. This is also corrected and the `html5lib` test now relies on the correct behavior of `expects_closer()`.
Developed in https://github.com/wordpress/wordpress-develop/pull/7162
Discussed in https://core.trac.wordpress.org/ticket/61576
Follow-up to <a href="https://core.trac.wordpress.org/changeset/58868">[58868]</a>.
Props: dmsnell.
See <a href="https://core.trac.wordpress.org/ticket/61576">#61576</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmlprocessorphp">trunk/src/wp-includes/html-api/class-wp-html-processor.php</a></li>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmltagprocessorphp">trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php</a></li>
<li><a href="#trunktestsphpunittestshtmlapiwpHtmlProcessorphp">trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php</a></li>
<li><a href="#trunktestsphpunittestshtmlapiwpHtmlProcessorHtml5libphp">trunk/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeshtmlapiclasswphtmlprocessorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/html-api/class-wp-html-processor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-processor.php 2024-08-08 11:28:30 UTC (rev 58869)
+++ trunk/src/wp-includes/html-api/class-wp-html-processor.php 2024-08-08 16:13:25 UTC (rev 58870)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -786,13 +786,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or `null` if not matched on any token.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function expects_closer( WP_HTML_Token $node = null ): ?bool {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $token_name = $node->node_name ?? $this->get_token_name();
- $token_namespace = $node->namespace ?? $this->get_namespace();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $token_name = $node->node_name ?? $this->get_token_name();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $token_name ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return null;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $token_namespace = $node->namespace ?? $this->get_namespace();
+ $token_has_self_closing = $node->has_self_closing_flag ?? $this->has_self_closing_flag();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return ! (
</span><span class="cx" style="display: block; padding: 0 10px"> // Comments, text nodes, and other atomic tokens.
</span><span class="cx" style="display: block; padding: 0 10px"> '#' === $token_name[0] ||
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -803,7 +805,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Special atomic elements.
</span><span class="cx" style="display: block; padding: 0 10px"> ( 'html' === $token_namespace && in_array( $token_name, array( 'IFRAME', 'NOEMBED', 'NOFRAMES', 'SCRIPT', 'STYLE', 'TEXTAREA', 'TITLE', 'XMP' ), true ) ) ||
</span><span class="cx" style="display: block; padding: 0 10px"> // Self-closing elements in foreign content.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- ( isset( $node ) && 'html' !== $node->namespace && $node->has_self_closing_flag )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ ( 'html' !== $token_namespace && $token_has_self_closing )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludeshtmlapiclasswphtmltagprocessorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php 2024-08-08 11:28:30 UTC (rev 58869)
+++ trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php 2024-08-08 16:13:25 UTC (rev 58870)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2921,7 +2921,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return null;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $namespace = $this->get_namespace();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $namespace = $this->get_namespace();
</ins><span class="cx" style="display: block; padding: 0 10px"> $lower_name = strtolower( $attribute_name );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'math' === $namespace && 'definitionurl' === $lower_name ) {
</span></span></pre></div>
<a id="trunktestsphpunittestshtmlapiwpHtmlProcessorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php 2024-08-08 11:28:30 UTC (rev 58869)
+++ trunk/tests/phpunit/tests/html-api/wpHtmlProcessor.php 2024-08-08 16:13:25 UTC (rev 58870)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -503,4 +503,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $subclass_processor = call_user_func( array( get_class( $subclass_instance ), 'create_fragment' ), '' );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertInstanceOf( get_class( $subclass_instance ), $subclass_processor, '::create_fragment did not return subclass instance.' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensures that self-closing elements in foreign content properly report
+ * that they expect no closer.
+ *
+ * @ticket 61576
+ */
+ public function test_expects_closer_foreign_content_self_closing() {
+ $processor = WP_HTML_Processor::create_fragment( '<svg /><math>' );
+
+ $this->assertTrue( $processor->next_tag() );
+ $this->assertSame( 'SVG', $processor->get_tag() );
+ $this->assertFalse( $processor->expects_closer() );
+
+ $this->assertTrue( $processor->next_tag() );
+ $this->assertSame( 'MATH', $processor->get_tag() );
+ $this->assertTrue( $processor->expects_closer() );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestshtmlapiwpHtmlProcessorHtml5libphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php 2024-08-08 11:28:30 UTC (rev 58869)
+++ trunk/tests/phpunit/tests/html-api/wpHtmlProcessorHtml5lib.php 2024-08-08 16:13:25 UTC (rev 58870)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -207,11 +207,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $tag_indent = $indent_level;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'html' !== $namespace ) {
- if ( ! $processor->has_self_closing_flag() ) {
- ++$indent_level;
- }
- } elseif ( ! WP_HTML_Processor::is_void( $tag_name ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $processor->expects_closer() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> ++$indent_level;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,7 +271,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Self-contained tags contain their inner contents as modifiable text.
</span><span class="cx" style="display: block; padding: 0 10px"> $modifiable_text = $processor->get_modifiable_text();
</span><span class="cx" style="display: block; padding: 0 10px"> if ( '' !== $modifiable_text ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $output .= str_repeat( $indent, $indent_level ) . "\"{$modifiable_text}\"\n";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $output .= str_repeat( $indent, $tag_indent + 1 ) . "\"{$modifiable_text}\"\n";
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'html' === $namespace && 'TEMPLATE' === $token_name ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -283,10 +279,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ++$indent_level;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $processor->is_void( $tag_name ) && ! $processor->expects_closer() ) {
- --$indent_level;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case '#cdata-section':
</span></span></pre>
</div>
</div>
</body>
</html>