' );
+HTML
+ );
// Find first tag of interest.
while ( $p->next_tag() && null === $p->get_attribute( 'one' ) ) {
diff --git a/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php b/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php
new file mode 100644
index 0000000000000..538144910550f
--- /dev/null
+++ b/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php
@@ -0,0 +1,734 @@
+assertFalse(
+ $processor->next_token(),
+ "Should not have found any tokens but found {$processor->get_token_type()}."
+ );
+ }
+
+ /**
+ * Ensures that normative text nodes are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_text_node() {
+ $processor = new WP_HTML_Tag_Processor( 'Hello, World!' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#text',
+ $processor->get_token_type(),
+ "Should have found #text token type but found {$processor->get_token_type()} instead."
+ );
+
+ $this->assertSame(
+ 'Hello, World!',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that normative Elements are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_element() {
+ $processor = new WP_HTML_Tag_Processor( '
Hello, World!
' );
+ $processor->next_token();
+
+ $this->assertSame(
+ 'DIV',
+ $processor->get_token_name(),
+ "Should have found DIV tag name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ 'test',
+ $processor->get_attribute( 'id' ),
+ "Should have found id attribute value 'test' but found {$processor->get_attribute( 'id' )} instead."
+ );
+
+ $this->assertTrue(
+ $processor->get_attribute( 'inert' ),
+ "Should have found boolean attribute 'inert' but didn't."
+ );
+
+ $attributes = $processor->get_attribute_names_with_prefix( '' );
+ $attribute_list = array_map( 'Tests_HtmlApi_WpHtmlProcessor_Token_Scanning::quoted', $attributes );
+ $this->assertSame(
+ array( 'id', 'inert' ),
+ $attributes,
+ 'Should have found only two attributes but found ' . implode( ', ', $attribute_list ) . ' instead.'
+ );
+
+ $this->assertSame(
+ '',
+ $processor->get_modifiable_text(),
+ "Should have found empty modifiable text but found '{$processor->get_modifiable_text()}' instead."
+ );
+ }
+
+ /**
+ * Ensures that normative SCRIPT elements are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_script_element() {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertSame(
+ 'SCRIPT',
+ $processor->get_token_name(),
+ "Should have found SCRIPT tag name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ 'module',
+ $processor->get_attribute( 'type' ),
+ "Should have found type attribute value 'module' but found {$processor->get_attribute( 'type' )} instead."
+ );
+
+ $attributes = $processor->get_attribute_names_with_prefix( '' );
+ $attribute_list = array_map( 'Tests_HtmlApi_WpHtmlProcessor_Token_Scanning::quoted', $attributes );
+ $this->assertSame(
+ array( 'type' ),
+ $attributes,
+ "Should have found single 'type' attribute but found " . implode( ', ', $attribute_list ) . ' instead.'
+ );
+
+ $this->assertSame(
+ 'console.log( "Hello, World!" );',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that normative TEXTAREA elements are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_textarea_element() {
+ $processor = new WP_HTML_Tag_Processor(
+ <<
+Is > XHTML?
+
+HTML
+ );
+ $processor->next_token();
+
+ $this->assertSame(
+ 'TEXTAREA',
+ $processor->get_token_name(),
+ "Should have found TEXTAREA tag name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ '30',
+ $processor->get_attribute( 'rows' ),
+ "Should have found rows attribute value 'module' but found {$processor->get_attribute( 'rows' )} instead."
+ );
+
+ $this->assertSame(
+ '80',
+ $processor->get_attribute( 'cols' ),
+ "Should have found cols attribute value 'module' but found {$processor->get_attribute( 'cols' )} instead."
+ );
+
+ $attributes = $processor->get_attribute_names_with_prefix( '' );
+ $attribute_list = array_map( 'Tests_HtmlApi_WpHtmlProcessor_Token_Scanning::quoted', $attributes );
+ $this->assertSame(
+ array( 'rows', 'cols' ),
+ $attributes,
+ 'Should have found only two attributes but found ' . implode( ', ', $attribute_list ) . ' instead.'
+ );
+
+ // Note that the leading newline should be removed from the TEXTAREA contents.
+ $this->assertSame(
+ "Is > XHTML?\n",
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that normative TITLE elements are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_title_element() {
+ $processor = new WP_HTML_Tag_Processor(
+ <<
+Is > XHTML?
+
+HTML
+ );
+ $processor->next_token();
+
+ $this->assertSame(
+ 'TITLE',
+ $processor->get_token_name(),
+ "Should have found TITLE tag name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ 'multi-line-title',
+ $processor->get_attribute( 'class' ),
+ "Should have found class attribute value 'multi-line-title' but found {$processor->get_attribute( 'rows' )} instead."
+ );
+
+ $attributes = $processor->get_attribute_names_with_prefix( '' );
+ $attribute_list = array_map( 'Tests_HtmlApi_WpHtmlProcessor_Token_Scanning::quoted', $attributes );
+ $this->assertSame(
+ array( 'class' ),
+ $attributes,
+ 'Should have found only one attribute but found ' . implode( ', ', $attribute_list ) . ' instead.'
+ );
+
+ $this->assertSame(
+ "\nIs > XHTML?\n",
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that normative RAWTEXT elements are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ *
+ * @dataProvider data_rawtext_elements
+ *
+ * @param string $tag_name The name of the RAWTEXT tag to test.
+ */
+ public function test_basic_assertion_rawtext_elements( $tag_name ) {
+ $processor = new WP_HTML_Tag_Processor(
+ <<
+Is > XHTML?
+
+HTML
+ );
+ $processor->next_token();
+
+ $this->assertSame(
+ $tag_name,
+ $processor->get_token_name(),
+ "Should have found {$tag_name} tag name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ 'multi-line-title',
+ $processor->get_attribute( 'class' ),
+ "Should have found class attribute value 'multi-line-title' but found {$processor->get_attribute( 'rows' )} instead."
+ );
+
+ $attributes = $processor->get_attribute_names_with_prefix( '' );
+ $attribute_list = array_map( 'Tests_HtmlApi_WpHtmlProcessor_Token_Scanning::quoted', $attributes );
+ $this->assertSame(
+ array( 'class' ),
+ $attributes,
+ 'Should have found only one attribute but found ' . implode( ', ', $attribute_list ) . ' instead.'
+ );
+
+ $this->assertSame(
+ "\nIs > XHTML?\n",
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[].
+ */
+ public function data_rawtext_elements() {
+ return array(
+ 'IFRAME' => array( 'IFRAME' ),
+ 'NOEMBED' => array( 'NOEMBED' ),
+ 'NOFRAMES' => array( 'NOFRAMES' ),
+ 'STYLE' => array( 'STYLE' ),
+ 'XMP' => array( 'XMP' ),
+ );
+ }
+
+ /**
+ * Ensures that normative CDATA sections are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_cdata_section() {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_name(),
+ "Should have found comment token but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ WP_HTML_Processor::COMMENT_AS_CDATA_LOOKALIKE,
+ $processor->get_comment_type(),
+ 'Should have detected a CDATA-like invalid comment.'
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ 'this is a comment',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that abruptly-closed CDATA sections are properly parsed as comments.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_abruptly_closed_cdata_section() {
+ $processor = new WP_HTML_Tag_Processor( ' a comment]]>' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_name(),
+ "Should have found a bogus comment but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ '[CDATA[this is ',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+
+ $processor->next_token();
+
+ $this->assertSame(
+ '#text',
+ $processor->get_token_name(),
+ "Should have found text node but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ ' a comment]]>',
+ $processor->get_modifiable_text(),
+ 'Should have found remaining syntax from abruptly-closed CDATA section.'
+ );
+ }
+
+ /**
+ * Ensures that normative Processing Instruction nodes are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_processing_instruction() {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_name(),
+ "Should have found comment token but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertSame(
+ WP_HTML_Processor::COMMENT_AS_PI_NODE_LOOKALIKE,
+ $processor->get_comment_type(),
+ 'Should have detected a Processing Instruction-like invalid comment.'
+ );
+
+ $this->assertSame(
+ 'wp-bit',
+ $processor->get_tag(),
+ "Should have found PI target as tag name but found {$processor->get_tag()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ ' {"just": "kidding"}',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that abruptly-closed Processing Instruction nodes are properly parsed as comments.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_abruptly_closed_processing_instruction() {
+ $processor = new WP_HTML_Tag_Processor( '=5.3.6"?>' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_type(),
+ "Should have found bogus comment but found {$processor->get_token_type()} instead."
+ );
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_name(),
+ "Should have found #comment as name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ 'version="',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+
+ $processor->next_token();
+
+ $this->assertSame(
+ '=5.3.6"?>',
+ $processor->get_modifiable_text(),
+ 'Should have found remaining syntax from abruptly-closed Processing Instruction.'
+ );
+ }
+
+ /**
+ * Ensures that common comments are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @dataProvider data_common_comments
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ *
+ * @param string $html Contains the comment in full.
+ * @param string $text Contains the appropriate modifiable text.
+ */
+ public function test_basic_assertion_common_comments( $html, $text ) {
+ $processor = new WP_HTML_Tag_Processor( $html );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_type(),
+ "Should have found comment but found {$processor->get_token_type()} instead."
+ );
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_name(),
+ "Should have found #comment as name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ $text,
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[].
+ */
+ public function data_common_comments() {
+ return array(
+ 'Shortest comment' => array( '', '' ),
+ 'Short comment' => array( '', '' ),
+ 'Short comment w/o text' => array( '', '' ),
+ 'Short comment with text' => array( '', '-' ),
+ 'PI node without target' => array( '', ' missing?' ),
+ 'Invalid PI node' => array( '', '/missing/' ),
+ 'Invalid ! directive' => array( '', 'something else' ),
+ );
+ }
+
+ /**
+ * Ensures that normative HTML comments are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_html_comment() {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_type(),
+ "Should have found comment but found {$processor->get_token_type()} instead."
+ );
+
+ $this->assertSame(
+ '#comment',
+ $processor->get_token_name(),
+ "Should have found #comment as name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ ' wp:paragraph ',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that normative DOCTYPE elements are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_doctype() {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#doctype',
+ $processor->get_token_type(),
+ "Should have found DOCTYPE but found {$processor->get_token_type()} instead."
+ );
+
+ $this->assertSame(
+ 'html',
+ $processor->get_token_name(),
+ "Should have found 'html' as name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ ' html',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that normative presumptuous tag closers (empty closers) are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_presumptuous_tag() {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#presumptuous-tag',
+ $processor->get_token_type(),
+ "Should have found presumptuous tag but found {$processor->get_token_type()} instead."
+ );
+
+ $this->assertSame(
+ '#presumptuous-tag',
+ $processor->get_token_name(),
+ "Should have found #presumptuous-tag as name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ '',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Ensures that normative funky comments are properly parsed.
+ *
+ * @ticket 60170
+ *
+ * @since 6.5.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_funky_comment() {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertSame(
+ '#funky-comment',
+ $processor->get_token_type(),
+ "Should have found funky comment but found {$processor->get_token_type()} instead."
+ );
+
+ $this->assertSame(
+ '#funky-comment',
+ $processor->get_token_name(),
+ "Should have found #funky-comment as name but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_tag(),
+ 'Should not have been able to query tag name on non-element token.'
+ );
+
+ $this->assertNull(
+ $processor->get_attribute( 'type' ),
+ 'Should not have been able to query attributes on non-element token.'
+ );
+
+ $this->assertSame(
+ '%url',
+ $processor->get_modifiable_text(),
+ 'Found incorrect modifiable text.'
+ );
+ }
+
+ /**
+ * Test helper that wraps a string in double quotes.
+ *
+ * @param string $s The string to wrap in double-quotes.
+ * @return string The string wrapped in double-quotes.
+ */
+ private static function quoted( $s ) {
+ return "\"$s\"";
+ }
+}
diff --git a/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php b/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php
index 8a681d2cb0042..6040d94b6fb5e 100644
--- a/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php
+++ b/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php
@@ -557,8 +557,10 @@ public function test_next_tag_should_stop_on_rcdata_and_script_tag_closers_when_
$p = new WP_HTML_Tag_Processor( '' );
$p->next_tag();
- $this->assertTrue( $p->next_tag( array( 'tag_closers' => 'visit' ) ), 'Did not find the tag closer' );
- $this->assertTrue( $p->is_tag_closer(), 'Indicated a ' );
$this->assertTrue( $p->next_tag( array( 'tag_closers' => 'visit' ) ), 'Did not find the tag closer when there was no tag opener' );
@@ -566,8 +568,10 @@ public function test_next_tag_should_stop_on_rcdata_and_script_tag_closers_when_
$p = new WP_HTML_Tag_Processor( '
' );
$p->next_tag();
- $this->assertTrue( $p->next_tag( array( 'tag_closers' => 'visit' ) ), 'Did not find the tag closer' );
- $this->assertTrue( $p->is_tag_closer(), 'Indicated a
' );
$this->assertTrue( $p->next_tag( array( 'tag_closers' => 'visit' ) ), 'Did not find the tag closer when there was no tag opener' );
@@ -575,8 +579,10 @@ public function test_next_tag_should_stop_on_rcdata_and_script_tag_closers_when_
$p = new WP_HTML_Tag_Processor( '
abc' );
$p->next_tag();
- $this->assertTrue( $p->next_tag( array( 'tag_closers' => 'visit' ) ), 'Did not find the tag closer' );
- $this->assertTrue( $p->is_tag_closer(), 'Indicated a
tag opener is a tag closer' );
+ $this->assertFalse(
+ $p->next_tag( array( 'tag_closers' => 'visit' ) ),
+ 'Should not have found closing TITLE when closing an opener.'
+ );
$p = new WP_HTML_Tag_Processor( 'abc' );
$this->assertTrue( $p->next_tag( array( 'tag_closers' => 'visit' ) ), 'Did not find the tag closer when there was no tag opener' );
@@ -2357,6 +2363,7 @@ public function data_html_without_tags() {
'No tags' => array( 'this is nothing more than a text node' ),
'Text with comments' => array( 'One comment.' ),
'Empty tag closer' => array( '' ),
+ 'CDATA as HTML comment' => array( '' ),
'Processing instruction' => array( '' ),
'Combination XML-like' => array( '' ),
);
@@ -2410,7 +2417,6 @@ public function data_incomplete_syntax_elements() {
'Incomplete CDATA' => array( ' array( ' array( '' => array( '' ),
'Unclosed IFRAME' => array( '