Changeset 58893 for trunk

Timestamp:

08/13/2024 10:12:01 PM (21 months ago)

Author:

dmsnell

Message:

HTML API: Only stop on full matches for requested tag name.

An optimization pass on the HTML API left a bug in the matches()
method, whereby it would falsely detect a tag name match if the
found tag were a lexical subset of the requested tag. This occurred
because of the use of substr_compare() without checking that the
outer lengths matched.

This patch resolves the bug by adding the length check.

Developed in ​https://github.com/wordpress/wordpress-develop/pull/7189
Discussed in https://core.trac.wordpress.org/ticket/61545

Follow-up to [58613].
Props dmsnell, westonruter.
See #61545.

Location:

trunk

Files:

• src/wp-includes/html-api/class-wp-html-tag-processor.php (modified) (1 diff)
• tests/phpunit/tests/html-api/wpHtmlTagProcessor.php (modified) (1 diff)

trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -4010 +4010 @@
 
         // Does the tag name match the requested tag name in a case-insensitive manner?
-        if ( isset( $this->sought_tag_name ) && 0 !== substr_compare( $this->html, $this->sought_tag_name, $this->tag_name_starts_at, $this->tag_name_length, true ) ) {
+        if (
+            isset( $this->sought_tag_name ) &&
+            (
+                strlen( $this->sought_tag_name ) !== $this->tag_name_length ||
+                0 !== substr_compare( $this->html, $this->sought_tag_name, $this->tag_name_starts_at, $this->tag_name_length, true )
+            )
+        ) {
             return false;
         }

trunk/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php

@@ -600 +600 @@
 
         $this->assertFalse( $processor->next_tag( 'p' ), 'Querying a non-existing tag did not return false' );
+    }
+
+    /**
+     * @ticket 61545
+     */
+    public function test_next_tag_should_not_match_on_substrings_of_a_requested_tag() {
+        $processor = new WP_HTML_Tag_Processor( '<p><pic><picture>' );
+
+        $this->assertTrue(
+            $processor->next_tag( 'PICTURE' ),
+            'Failed to find a tag when requested: check test setup.'
+        );
+
+        $this->assertSame(
+            'PICTURE',
+            $processor->get_tag(),
+            'Should have skipped past substring tag matches, directly finding the PICTURE element.'
+        );
+
+        $processor = new WP_HTML_Tag_Processor( '<p><pic>' );
+
+        $this->assertFalse(
+            $processor->next_tag( 'PICTURE' ),
+            "Should not have found any PICTURE element, but found '{$processor->get_token_name()}' instead."
+        );
     }