Changeset 59502

Timestamp:

12/10/2024 09:11:35 AM (22 months ago)

Author:

gziolo

Message:

HTML API: Prevent bookmarks from being set on virtual tokens

Fixes the issue when an HTML_Processor bookmark was set at a virtual token (a node in the resulting document that does not correspond to an HTML token present in the input string), seek behavior was unreliable.

Props jonsurrell, gziolo.
Fixes #62521.

Location:

trunk

Files:

• src/wp-includes/html-api/class-wp-html-processor.php (modified) (3 diffs)
• tests/phpunit/tests/html-api/wpHtmlProcessor-bookmark.php (modified) (1 diff)

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

@@ -304 +304 @@
 
                 while ( $context_processor->next_tag() ) {
-                        $context_processor->set_bookmark( 'final_node' );
+                        if ( ! $context_processor->is_virtual() ) {
+                                $context_processor->set_bookmark( 'final_node' );
+                        }
                 }
 
@@ -5674 +5676 @@
          * HTML structure or unwanted processing overhead.
          *
+         * Bookmarks cannot be set on tokens that do no appear in the original
+         * HTML text. For example, the HTML `<table><td>` stops at tags `TABLE`,
+         * `TBODY`, `TR`, and `TD`. The `TBODY` and `TR` tags do not appear in
+         * the original HTML and cannot be used as bookmarks.
+         *
          * @since 6.4.0
          *
@@ -5680 +5687 @@
          */
         public function set_bookmark( $bookmark_name ): bool {
+                if ( $this->is_virtual() ) {
+                        _doing_it_wrong(
+                                __METHOD__,
+                                __( 'Cannot set bookmarks on tokens that do no appear in the original HTML text.' ),
+                                '6.8.0'
+                        );
+                        return false;
+                }
                 return parent::set_bookmark( "_{$bookmark_name}" );
         }

trunk/tests/phpunit/tests/html-api/wpHtmlProcessor-bookmark.php

@@ -158 +158 @@
                 );
         }
+
+        /**
+         * @ticket 62521
+         *
+         * @expectedIncorrectUsage WP_HTML_Processor::set_bookmark
+         */
+        public function test_bookmarks_not_allowed_on_virtual_nodes() {
+                $processor = WP_HTML_Processor::create_full_parser( 'text' );
+                $this->assertTrue( $processor->next_tag( 'BODY' ) );
+                $this->assertFalse( $processor->set_bookmark( 'mark' ) );
+                $this->assertTrue( $processor->next_token() );
+                $this->assertTrue( $processor->set_bookmark( 'mark' ) );
+        }
 }