Changeset 58870

Timestamp:

08/08/2024 04:13:25 PM (8 months ago)

Author:

dmsnell

Message:

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 [58868].

Props: dmsnell.
See #61576.

Location:

trunk

Files:

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

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

@@ -787 +787 @@
      */
     public function expects_closer( WP_HTML_Token $node = null ): ?bool {
-        $token_name      = $node->node_name ?? $this->get_token_name();
-        $token_namespace = $node->namespace ?? $this->get_namespace();
+        $token_name = $node->node_name ?? $this->get_token_name();
 
         if ( ! isset( $token_name ) ) {
             return null;
         }
+
+        $token_namespace        = $node->namespace ?? $this->get_namespace();
+        $token_has_self_closing = $node->has_self_closing_flag ?? $this->has_self_closing_flag();
 
         return ! (
@@ -804 +806 @@
             ( 'html' === $token_namespace && in_array( $token_name, array( 'IFRAME', 'NOEMBED', 'NOFRAMES', 'SCRIPT', 'STYLE', 'TEXTAREA', 'TITLE', 'XMP' ), true ) ) ||
             // Self-closing elements in foreign content.
-            ( isset( $node ) && 'html' !== $node->namespace && $node->has_self_closing_flag )
+            ( 'html' !== $token_namespace && $token_has_self_closing )
         );
     }

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

@@ -2922 +2922 @@
         }
 
-        $namespace = $this->get_namespace();
+        $namespace  = $this->get_namespace();
         $lower_name = strtolower( $attribute_name );
 

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

@@ -504 +504 @@
         $this->assertInstanceOf( get_class( $subclass_instance ), $subclass_processor, '::create_fragment did not return subclass instance.' );
     }
+
+    /**
+     * 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() );
+    }
 }

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

@@ -208 +208 @@
                     $tag_indent = $indent_level;
 
-                    if ( 'html' !== $namespace ) {
-                        if ( ! $processor->has_self_closing_flag() ) {
-                            ++$indent_level;
-                        }
-                    } elseif ( ! WP_HTML_Processor::is_void( $tag_name ) ) {
+                    if ( $processor->expects_closer() ) {
                         ++$indent_level;
                     }
@@ -276 +272 @@
                     $modifiable_text = $processor->get_modifiable_text();
                     if ( '' !== $modifiable_text ) {
-                        $output .= str_repeat( $indent, $indent_level ) . "\"{$modifiable_text}\"\n";
+                        $output .= str_repeat( $indent, $tag_indent + 1 ) . "\"{$modifiable_text}\"\n";
                     }
 
@@ -282 +278 @@
                         $output .= str_repeat( $indent, $indent_level ) . "content\n";
                         ++$indent_level;
-                    }
-
-                    if ( ! $processor->is_void( $tag_name ) && ! $processor->expects_closer() ) {
-                        --$indent_level;
                     }