<!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>[58040] trunk: HTML API: Fix detection of single-length funky comments.</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/58040">58040</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/58040","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-04-24 07:43:02 +0000 (Wed, 24 Apr 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: Fix detection of single-length funky comments.
Since <a href="https://core.trac.wordpress.org/changeset/60428">[60428]</a> the Tag Processor has been misidentifying single-character
funky comments. It has been asserting that the full token-length for a
funky comment must be at least three characters after the opening (e.g.
`</1>`), but it has been starting to look for the closing `>` after
those same three characters. This means that it has been skipping the
actual close of these funky comments and swallowing up the next syntax
until it finds a `>`, often consuming the next tag in the process.
This patch fixes the detector and restores finding the following token.
Developed in https://github.com/WordPress/wordpress-develop/pull/6412
Discussed in https://core.trac.wordpress.org/ticket/60170
Follow-up to <a href="https://core.trac.wordpress.org/changeset/60428">[60428]</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/60170">#60170</a>.
Props dmsnell, gziolo, jonsurrell.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeshtmlapiclasswphtmltagprocessorphp">trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php</a></li>
<li><a href="#trunktestsphpunittestshtmlapiwpHtmlTagProcessortokenscanningphp">trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php</a></li>
<li><a href="#trunktestsphpunittestsinteractivityapiwpInteractivityAPIphp">trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-04-23 18:55:26 UTC (rev 58039)
+++ trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php 2024-04-24 07:43:02 UTC (rev 58040)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1629,7 +1629,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * `<!` transitions to markup declaration open state
</span><span class="cx" style="display: block; padding: 0 10px"> * https://html.spec.whatwg.org/multipage/parsing.html#markup-declaration-open-state
</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[ $at + 1 ] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->is_closing_tag && '!' === $html[ $at + 1 ] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * `<!--` transitions to a comment state – apply further comment rules.
</span><span class="cx" style="display: block; padding: 0 10px"> * https://html.spec.whatwg.org/multipage/parsing.html#tag-open-state
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1809,6 +1809,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * See https://html.spec.whatwg.org/#parse-error-missing-end-tag-name
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( '>' === $html[ $at + 1 ] ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // `<>` is interpreted as plaintext.
+ if ( ! $this->is_closing_tag ) {
+ ++$at;
+ continue;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->parser_state = self::STATE_PRESUMPTUOUS_TAG;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->token_length = $at + 2 - $this->token_starts_at;
</span><span class="cx" style="display: block; padding: 0 10px"> $this->bytes_already_parsed = $at + 2;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1819,7 +1825,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * `<?` transitions to a bogus comment state – skip to the nearest >
</span><span class="cx" style="display: block; padding: 0 10px"> * See https://html.spec.whatwg.org/multipage/parsing.html#tag-open-state
</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[ $at + 1 ] ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->is_closing_tag && '?' === $html[ $at + 1 ] ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $closer_at = strpos( $html, '>', $at + 2 );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false === $closer_at ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->parser_state = self::STATE_INCOMPLETE_INPUT;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1891,7 +1897,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</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">- $closer_at = strpos( $html, '>', $at + 3 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $closer_at = strpos( $html, '>', $at + 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( false === $closer_at ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->parser_state = self::STATE_INCOMPLETE_INPUT;
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestshtmlapiwpHtmlTagProcessortokenscanningphp"></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/wpHtmlTagProcessor-token-scanning.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php 2024-04-23 18:55:26 UTC (rev 58039)
+++ trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php 2024-04-24 07:43:02 UTC (rev 58040)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -761,6 +761,59 @@
</span><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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Ensures that various funky comments are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.6.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ *
+ * @dataProvider data_various_funky_comments
+ *
+ * @param string $funky_comment_html HTML containing a funky comment.
+ * @param string $modifiable_text Expected modifiable text of first funky comment in HTML.
+ */
+ public function test_various_funky_comments( $funky_comment_html, $modifiable_text ) {
+ $processor = new WP_HTML_Tag_Processor( $funky_comment_html );
+ while ( '#funky-comment' !== $processor->get_token_type() && $processor->next_token() ) {
+ continue;
+ }
+
+ $this->assertSame(
+ '#funky-comment',
+ $processor->get_token_type(),
+ 'Failed to find the expected funky comment.'
+ );
+
+ $this->assertSame(
+ $modifiable_text,
+ $processor->get_modifiable_text(),
+ 'Found the wrong modifiable text span inside a funky comment.'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[].
+ */
+ public static function data_various_funky_comments() {
+ return array(
+ 'Space' => array( '</ >', ' ' ),
+ 'Short-bang' => array( '</!>', '!' ),
+ 'Question mark' => array( '</?>', '?' ),
+ 'Short-slash' => array( '<//>', '/' ),
+ 'Bit (no attrs)' => array( '<//wp:post-meta>', '/wp:post-meta' ),
+ 'Bit (attrs)' => array( '<//wp:post-meta key=isbn>', '/wp:post-meta key=isbn' ),
+ 'Curly-wrapped' => array( '</{json}>', '{json}' ),
+ 'Before P' => array( '</1><p>', '1' ),
+ 'After P' => array( '<p></__("Read more")></p>', '__("Read more")' ),
+ 'Reference' => array( '</>>', '>' ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test helper that wraps a string in double quotes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $s The string to wrap in double-quotes.
</span></span></pre></div>
<a id="trunktestsphpunittestsinteractivityapiwpInteractivityAPIphp"></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/interactivity-api/wpInteractivityAPI.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php 2024-04-23 18:55:26 UTC (rev 58039)
+++ trunk/tests/phpunit/tests/interactivity-api/wpInteractivityAPI.php 2024-04-24 07:43:02 UTC (rev 58040)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -588,29 +588,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 60356
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @covers ::process_directives
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @dataProvider data_html_with_unbalanced_tags
+ *
+ * @param string $html HTML containing unbalanced tags and also a directive.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_process_directives_doesnt_change_html_if_contains_unbalanced_tags() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_process_directives_doesnt_change_html_if_contains_unbalanced_tags( $html ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->interactivity->state( 'myPlugin', array( 'id' => 'some-id' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $html_samples = array(
- '<div data-wp-bind--id="myPlugin::state.id">Inner content</div></div>',
- '<div data-wp-bind--id="myPlugin::state.id">Inner content</div><div>',
- '<div><div data-wp-bind--id="myPlugin::state.id">Inner content</div>',
- '</div><div data-wp-bind--id="myPlugin::state.id">Inner content</div>',
- '<div data-wp-bind--id="myPlugin::state.id">Inner<div>content</div>',
- '<div data-wp-bind--id="myPlugin::state.id">Inner</div>content</div>',
- '<div data-wp-bind--id="myPlugin::state.id"><span>Inner content</div>',
- '<div data-wp-bind--id="myPlugin::state.id">Inner content</div></span>',
- '<div data-wp-bind--id="myPlugin::state.id"><span>Inner content</div></span>',
- '<div data-wp-bind--id="myPlugin::state.id">Inner conntent</ ></div>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $processed_html = $this->interactivity->process_directives( $html );
+ $p = new WP_HTML_Tag_Processor( $processed_html );
+ $p->next_tag();
+ $this->assertNull( $p->get_attribute( 'id' ) );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[].
+ */
+ public static function data_html_with_unbalanced_tags() {
+ return array(
+ 'DIV closer after' => array( '<div data-wp-bind--id="myPlugin::state.id">Inner content</div></div>' ),
+ 'DIV opener after' => array( '<div data-wp-bind--id="myPlugin::state.id">Inner content</div><div>' ),
+ 'DIV opener before' => array( '<div><div data-wp-bind--id="myPlugin::state.id">Inner content</div>' ),
+ 'DIV closer before' => array( '</div><div data-wp-bind--id="myPlugin::state.id">Inner content</div>' ),
+ 'DIV opener inside' => array( '<div data-wp-bind--id="myPlugin::state.id">Inner<div>content</div>' ),
+ 'DIV closer inside' => array( '<div data-wp-bind--id="myPlugin::state.id">Inner</div>content</div>' ),
+ 'SPAN opener inside' => array( '<div data-wp-bind--id="myPlugin::state.id"><span>Inner content</div>' ),
+ 'SPAN closer after' => array( '<div data-wp-bind--id="myPlugin::state.id">Inner content</div></span>' ),
+ 'SPAN overlapping' => array( '<div data-wp-bind--id="myPlugin::state.id"><span>Inner content</div></span>' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- foreach ( $html_samples as $html ) {
- $processed_html = $this->interactivity->process_directives( $html );
- $p = new WP_HTML_Tag_Processor( $processed_html );
- $p->next_tag();
- $this->assertNull( $p->get_attribute( 'id' ) );
- }
</del><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>
</div>
</body>
</html>