beforeafter',
+ <<<'TREE'
+
+ "before"
+
+ "after"
+
+ TREE,
+ );
}
/**
+ * @ticket 65582
* @ticket 63527
* @ticket 64531
*
diff --git a/tests/phpunit/tests/dependencies/wpInlineScriptTag.php b/tests/phpunit/tests/dependencies/wpInlineScriptTag.php
index e8fabd7226e84..590872ee3fd6c 100644
--- a/tests/phpunit/tests/dependencies/wpInlineScriptTag.php
+++ b/tests/phpunit/tests/dependencies/wpInlineScriptTag.php
@@ -169,9 +169,10 @@ public function test_script_tag_repeat_attributes() {
* Test failure conditions setting inline script tag contents.
*
* @ticket 64500
+ *
+ * @expectedIncorrectUsage WP_HTML_Tag_Processor::set_modifiable_text
*/
public function test_script_tag_dangerous_unescapeable_contents() {
- $this->setExpectedIncorrectUsage( 'wp_get_inline_script_tag' );
/*
* cannot be printed inside a script tag
* the `example/example` type is an unknown type with no known escaping rules.
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php b/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php
index e332ec12a0a91..74f4a650f5afb 100644
--- a/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessor-serialize.php
@@ -382,12 +382,71 @@ public function data_bogus_comments() {
'CDATA look-alike' => array( '' ),
'Immediately-closed markup instruction' => array( '' ),
'Warning Symbol' => array( '' ),
- 'PHP block look-alike' => array( '<', '?php foo(); ?', '>' ),
+ 'PHP short echo tag' => array( '<', '?= "Hello" ?', '>' ),
'Funky comment' => array( '' ),
'XML Processing Instruction look-alike' => array( '<', '?xml foo ', '>' ),
);
}
+ /**
+ * Ensures that processing instructions are serialized in their normative form.
+ *
+ * Note that the serialized form separates the target from the data with a
+ * single space and always terminates with `?>`, regardless of the original
+ * syntax. The closer's `?` is dropped on parse, so this form represents any
+ * data, including data ending in `?`.
+ *
+ * @ticket 61530
+ *
+ * @dataProvider data_processing_instructions
+ *
+ * @param string $html Input containing a processing instruction.
+ * @param string $expected Normative serialization of the input.
+ */
+ public function test_serializes_processing_instructions( string $html, string $expected ): void {
+ $this->assertSame(
+ WP_HTML_Processor::normalize( $html ),
+ $expected,
+ 'Should have serialized the processing instruction in its normative form.'
+ );
+ }
+
+ /**
+ * Ensures that normalizing an already-normalized processing instruction does not change it.
+ *
+ * @ticket 61530
+ *
+ * @dataProvider data_processing_instructions
+ *
+ * @param string $html Input containing a processing instruction.
+ * @param string $expected Normative serialization of the input.
+ */
+ public function test_processing_instruction_normalization_is_idempotent( string $html, string $expected ): void {
+ $this->assertSame(
+ $expected,
+ WP_HTML_Processor::normalize( $expected ),
+ 'Normalizing an already-normalized processing instruction should not change it.'
+ );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_processing_instructions(): array {
+ return array(
+ 'PHP block' => array( '', '' ),
+ 'Unclosed PHP block' => array( '', '' ),
+ 'Empty data' => array( '', '' ),
+ 'Whitespace-only data' => array( '', '' ),
+ 'Data ending in question mark' => array( '', '' ),
+ 'Data of a lone question mark' => array( '', '' ),
+ 'Data with question mark runs' => array( '', '' ),
+ 'Question mark then whitespace' => array( '', '' ),
+ );
+ }
+
/**
* Ensures that NULL bytes are properly handled.
*
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessor.php b/tests/phpunit/tests/html-api/wpHtmlProcessor.php
index a978422c20098..f3b051ca3639e 100644
--- a/tests/phpunit/tests/html-api/wpHtmlProcessor.php
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessor.php
@@ -303,16 +303,18 @@ public function test_expects_closer_expects_no_closer_for_self_contained_tokens(
/**
* Data provider.
*
- * @return array[]
+ * @return array
*/
- public static function data_self_contained_node_tokens() {
+ public static function data_self_contained_node_tokens(): array {
$self_contained_nodes = array(
- 'Normative comment' => array( '' ),
- 'Comment with invalid closing' => array( '' ),
- 'CDATA Section lookalike' => array( '' ),
- 'Processing Instruction lookalike' => array( '' ),
- 'Funky comment' => array( '' ),
- 'Text node' => array( 'Trombone' ),
+ 'Normative comment' => array( '' ),
+ 'Comment with invalid closing' => array( '' ),
+ 'CDATA Section lookalike' => array( '' ),
+ 'Processing Instruction' => array( '' ),
+ 'Bogus PI-lookalike xml comment' => array( '' ),
+ 'Bogus comment' => array( '' ),
+ 'Funky comment' => array( '' ),
+ 'Text node' => array( 'Trombone' ),
);
foreach ( self::data_void_tags_not_ignored_in_body() as $tag_name => $_name ) {
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessorComments.php b/tests/phpunit/tests/html-api/wpHtmlProcessorComments.php
index 4ea17f2318b51..79dd8c204c111 100644
--- a/tests/phpunit/tests/html-api/wpHtmlProcessorComments.php
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessorComments.php
@@ -32,17 +32,20 @@ public function test_comment_processing( $html, $expected_comment_type, $expecte
/**
* Data provider.
*
- * @return array[]
+ * @return array
*/
- public static function data_comments() {
+ public static function data_comments(): array {
return array(
- 'Normative comment' => array( '', WP_HTML_Processor::COMMENT_AS_HTML_COMMENT, ' A comment. ' ),
- 'Abruptly closed comment' => array( '', WP_HTML_Processor::COMMENT_AS_ABRUPTLY_CLOSED_COMMENT, '' ),
- 'Invalid HTML comment !' => array( '', WP_HTML_Processor::COMMENT_AS_INVALID_HTML, ' Bang opener ' ),
- 'Invalid HTML comment ?' => array( '', WP_HTML_Processor::COMMENT_AS_INVALID_HTML, ' Question opener ' ),
- 'CDATA comment' => array( '', WP_HTML_Processor::COMMENT_AS_CDATA_LOOKALIKE, ' cdata body ' ),
- 'Processing instruction comment' => array( '', WP_HTML_Processor::COMMENT_AS_PI_NODE_LOOKALIKE, ' Instruction body. ', 'pi-target' ),
- 'Processing instruction php' => array( '', WP_HTML_Processor::COMMENT_AS_PI_NODE_LOOKALIKE, ' const HTML_COMMENT = true; ', 'php' ),
+ 'Normative comment' => array( '', WP_HTML_Processor::COMMENT_AS_HTML_COMMENT, ' A comment. ' ),
+ 'Abruptly closed comment' => array( '', WP_HTML_Processor::COMMENT_AS_ABRUPTLY_CLOSED_COMMENT, '' ),
+ 'Invalid HTML comment !' => array( '', WP_HTML_Processor::COMMENT_AS_INVALID_HTML, ' Bang opener ' ),
+ 'Invalid HTML comment ?' => array( '', WP_HTML_Processor::COMMENT_AS_INVALID_HTML, ' Question opener ' ),
+ 'CDATA comment' => array( '', WP_HTML_Processor::COMMENT_AS_CDATA_LOOKALIKE, ' cdata body ' ),
+ 'Processing instruction xml' => array( '', WP_HTML_Processor::COMMENT_AS_PI_NODE_LOOKALIKE, ' version="1.0" ', 'xml' ),
+ 'Processing instruction xml-stylesheet' => array( '', WP_HTML_Processor::COMMENT_AS_PI_NODE_LOOKALIKE, ' href="a.css" ', 'xml-stylesheet' ),
+ 'Processing instruction XML-valid target' => array( '', WP_HTML_Processor::COMMENT_AS_PI_NODE_LOOKALIKE, ' const HTML_COMMENT = true; ', 'wp.bit' ),
+ 'Processing instruction bad target' => array( '', WP_HTML_Processor::COMMENT_AS_INVALID_HTML, '$var Not a target. ?' ),
+ 'PHP short echo tag' => array( '', WP_HTML_Processor::COMMENT_AS_INVALID_HTML, '= "Hello" ?' ),
);
}
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessorModifiableText.php b/tests/phpunit/tests/html-api/wpHtmlProcessorModifiableText.php
index 5d093ae05dd07..3072a46aa91d0 100644
--- a/tests/phpunit/tests/html-api/wpHtmlProcessorModifiableText.php
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessorModifiableText.php
@@ -77,6 +77,8 @@ public static function data_modifiable_text_special_textarea(): array {
*
* @ticket 64751
* @dataProvider data_set_modifiable_fails_non_atomic_tags
+ *
+ * @expectedIncorrectUsage WP_HTML_Tag_Processor::set_modifiable_text
*/
public function test_set_modifiable_fails_non_atomic_tags(
string $html,
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessorProcessingInstructions.php b/tests/phpunit/tests/html-api/wpHtmlProcessorProcessingInstructions.php
new file mode 100644
index 0000000000000..d0d111cf913c6
--- /dev/null
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessorProcessingInstructions.php
@@ -0,0 +1,226 @@
+next_token();
+
+ $this->assertSame( '#processing-instruction', $processor->get_token_name() );
+ $this->assertSame( '#processing-instruction', $processor->get_token_type() );
+ $this->assertSame( $expected_target, $processor->get_tag() );
+ $this->assertSame( $expected_data, $processor->get_modifiable_text() );
+ $this->assertNull( $processor->get_comment_type() );
+ }
+
+ /**
+ * Data provider.
+ *
+ * The whitespace following the target is not part of the data, but all
+ * further text through the closing `>` is, excepting a final `?` when
+ * the processing instruction is closed by `?>`.
+ *
+ * @return array
+ */
+ public static function data_processing_instructions(): array {
+ return array(
+ 'Basic' => array( '', 'pi-target', 'Instruction body. ' ),
+ 'PHP block' => array( '', 'php', 'const HTML_COMMENT = true; ' ),
+ 'No data' => array( '', 'something', '' ),
+ 'No data, questionable close' => array( '', 'something', '' ),
+ 'Unclosed data' => array( '', 'something', 'good' ),
+ 'Data with spaces' => array( '', 'something', 'else is good' ),
+ 'Whitespace after target' => array( "", 'hey', 'there' ),
+ 'Tab terminates target' => array( "", 'hey', 'there=1' ),
+ 'Question mark in data' => array( '', 'hey', '?there' ),
+ 'Question mark data run' => array( '', 'something', '? ' ),
+ 'Data ending in question mark' => array( '', 'wp-bit', 'smile?' ),
+ 'Ends at first closer' => array( ' ?>', 't', 'd ' ),
+ 'Case preserved in target' => array( '', 'all-KINDS-of-CaSeS', 'data' ),
+ 'Underscore target' => array( '', '_x132', 'data' ),
+ 'Single-character target' => array( '', 'x', 'data' ),
+ 'Digits and hyphens in target' => array( '', 'r2-d2', 'data' ),
+ 'XML lookalike target prefix' => array( '', 'xml2', 'data' ),
+ 'IMAGE target not rewritten' => array( '', 'IMAGE', 'data' ),
+ );
+ }
+
+ /**
+ * Ensures that invalid or reserved processing instruction targets
+ * produce comments instead of processing instruction nodes.
+ *
+ * The comment cases are more fully covered in the comment processing tests.
+ *
+ * @ticket 61530
+ *
+ * @dataProvider data_invalid_targets
+ *
+ * @param string $html Input whose processing-instruction-like syntax has an invalid target.
+ */
+ public function test_invalid_targets_become_comments( string $html ): void {
+ $processor = WP_HTML_Processor::create_fragment( $html );
+ $processor->next_token();
+
+ $this->assertSame( '#comment', $processor->get_token_name() );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public static function data_invalid_targets(): array {
+ return array(
+ 'Reserved xml target' => array( '' ),
+ 'Reserved xml-stylesheet target' => array( '' ),
+ 'Reserved target, cased' => array( '' ),
+ 'Leading digit' => array( '' ),
+ 'Leading hyphen' => array( '' ),
+ 'Colon in target' => array( '' ),
+ 'Dot in target' => array( '' ),
+ 'Non-ASCII target' => array( '' ),
+ 'Empty target' => array( '' ),
+ 'Whitespace target' => array( '' ),
+ 'PHP short echo tag' => array( '' ),
+ );
+ }
+
+ /**
+ * Ensures that a document ending inside a processing instruction
+ * pauses the processor at an incomplete token.
+ *
+ * @ticket 61530
+ *
+ * @dataProvider data_incomplete_processing_instructions
+ *
+ * @param string $html Input ending inside a processing instruction.
+ */
+ public function test_incomplete_processing_instruction( string $html ): void {
+ $processor = WP_HTML_Processor::create_full_parser( $html );
+
+ $this->assertFalse( $processor->next_token() );
+ $this->assertTrue( $processor->paused_at_incomplete_token() );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public static function data_incomplete_processing_instructions(): array {
+ return array(
+ 'Bare opener' => array( ' array( ' array( ' array( ' array( ' array( ' ".
+ */
+ public function test_processing_instruction_placement( string $html, string $breadcrumbs ): void {
+ $processor = WP_HTML_Processor::create_full_parser( $html );
+
+ while ( $processor->next_token() ) {
+ if ( '#processing-instruction' === $processor->get_token_type() ) {
+ $this->assertSame(
+ $breadcrumbs,
+ implode( ' > ', $processor->get_breadcrumbs() ),
+ 'Found the processing instruction in the wrong location.'
+ );
+ return;
+ }
+ }
+
+ $this->fail( 'Failed to find the processing instruction in the document.' );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public static function data_processing_instruction_placement(): array {
+ return array(
+ 'Before HTML' => array( '', '#processing-instruction' ),
+ 'In HEAD' => array( '', 'HTML > HEAD > #processing-instruction' ),
+ 'After HEAD' => array( '', 'HTML > #processing-instruction' ),
+ 'In BODY' => array( '', 'HTML > BODY > DIV > #processing-instruction' ),
+ 'In TABLE' => array( '
', 'HTML > BODY > TABLE > #processing-instruction' ),
+ 'In TABLE ROW' => array( '
', 'HTML > BODY > TABLE > TBODY > TR > #processing-instruction' ),
+ 'In TEMPLATE' => array( '', 'HTML > BODY > TEMPLATE > #processing-instruction' ),
+ 'In foreign content' => array( '', 'HTML > BODY > SVG > #processing-instruction' ),
+ );
+ }
+
+ /**
+ * Ensures that processing-instruction-like syntax inside raw text
+ * elements is not parsed as a processing instruction.
+ *
+ * @ticket 61530
+ *
+ * @dataProvider data_raw_text_elements
+ *
+ * @param string $html Input containing processing-instruction-like syntax in a raw text element.
+ */
+ public function test_no_processing_instruction_in_raw_text( string $html ): void {
+ $processor = WP_HTML_Processor::create_fragment( $html );
+
+ while ( $processor->next_token() ) {
+ $this->assertNotSame(
+ '#processing-instruction',
+ $processor->get_token_type(),
+ 'Should not have found a processing instruction inside a raw text element.'
+ );
+ }
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public static function data_raw_text_elements(): array {
+ return array(
+ 'SCRIPT' => array( '' ),
+ 'STYLE' => array( '' ),
+ 'TEXTAREA' => array( '' ),
+ 'TITLE' => array( '<?wp-bit?> ' ),
+ );
+ }
+}
diff --git a/tests/phpunit/tests/html-api/wpHtmlProcessorWebPlatformTests.php b/tests/phpunit/tests/html-api/wpHtmlProcessorWebPlatformTests.php
index 7aa26f5ecc01a..58ca90a857da0 100644
--- a/tests/phpunit/tests/html-api/wpHtmlProcessorWebPlatformTests.php
+++ b/tests/phpunit/tests/html-api/wpHtmlProcessorWebPlatformTests.php
@@ -37,9 +37,6 @@ class Tests_HtmlApi_WebPlatformTests extends WP_UnitTestCase {
'tests2/line0686' => 'Unimplemented: This parser does not add missing attributes to existing HTML or BODY tags.',
'tests2/line0697' => 'Unimplemented: This parser does not add missing attributes to existing HTML or BODY tags.',
'tests2/line0709' => 'Unimplemented: This parser does not add missing attributes to existing HTML or BODY tags.',
- 'tests1/line0601' => 'Unimplemented: This parser treats processing instructions as comments.',
- 'tests1/line0640' => 'Unimplemented: This parser treats processing instructions as comments.',
- 'html5test-com/line0129' => 'Unimplemented: This parser treats processing instructions as comments.',
'menuitem-element/line0161' => 'Unimplemented: This parser does not support customizable SELECT element content.',
'tests9/line0048' => 'Unimplemented: This parser does not support customizable SELECT element content.',
'tests9/line0059' => 'Unimplemented: This parser does not support customizable SELECT element content.',
@@ -60,16 +57,6 @@ class Tests_HtmlApi_WebPlatformTests extends WP_UnitTestCase {
'webkit02/line0706' => 'Unimplemented: This parser does not support customizable SELECT element content.',
'webkit02/line0732' => 'Unimplemented: This parser does not support customizable SELECT element content.',
'webkit02/line0748' => 'Unimplemented: This parser does not support customizable SELECT element content.',
-
- 'tests1/line0602' => 'Unimplemented: Updated Processing Instruction parsing.',
- 'tests1/line0641' => 'Unimplemented: Updated Processing Instruction parsing.',
- );
-
- /**
- * Skip test files that exercise parser behavior unsupported by the HTML API.
- */
- const SKIP_TEST_PREFIXES = array(
- 'processing-instructions/' => 'Unimplemented: Updated Processing Instruction parsing.',
);
/**
@@ -178,12 +165,6 @@ private static function should_skip_test( ?string $test_context_element, string
return true;
}
- foreach ( array_keys( self::SKIP_TEST_PREFIXES ) as $test_prefix ) {
- if ( str_starts_with( $test_name, $test_prefix ) ) {
- return true;
- }
- }
-
return false;
}
@@ -344,6 +325,15 @@ static function ( $a, $b ) {
$output .= str_repeat( self::TREE_INDENT, $indent_level ) . "\n";
break;
+ case '#processing-instruction':
+ /*
+ * Processing instructions must be "".
+ */
+ $pi_data = $processor->get_modifiable_text();
+ $output .= str_repeat( self::TREE_INDENT, $indent_level ) . "get_tag()} {$pi_data}?>\n";
+ break;
+
case '#comment':
// Comments must be "<" then "!-- " then the data then " -->".
$output .= str_repeat( self::TREE_INDENT, $indent_level ) . "\n";
@@ -474,14 +464,6 @@ public static function parse_web_platform_test_file( $filename ) {
* the tree of the parsed DOM. Each node must be represented by a single line. Each line
* must start with "| ", followed by two spaces per parent node that the node has before
* the root document node.
- *
- * - Element nodes must be represented by a "<" then the tag name string ">", and all the attributes must be given, sorted lexicographically by UTF-16 code unit according to their attribute name string, on subsequent lines, as if they were children of the element node.
- * - Attribute nodes must have the attribute name string, then an "=" sign, then the attribute value in double quotes (").
- * - Text nodes must be the string, in double quotes. Newlines aren't escaped.
- * - Comments must be "<" then "!-- " then the data then " -->".
- * - DOCTYPEs must be "".
- * - Processing instructions must be "". (The HTML parser cannot emit processing instructions, but scripts can, and the WebVTT to DOM rules can emit them.)
- * - Template contents are represented by the string "content" with the children below it.
*/
case 'document':
if ( '|' === $line[0] ) {
diff --git a/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php b/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php
index de61377e21d55..e6c77024848dd 100644
--- a/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php
+++ b/tests/phpunit/tests/html-api/wpHtmlTagProcessor-token-scanning.php
@@ -579,6 +579,7 @@ public function test_empty_cdata_in_foreign_content() {
* @ticket 60170
*
* @since 6.5.0
+ * @since 7.1.0 Processing instructions produce their own token type.
*
* @covers WP_HTML_Tag_Processor::next_token
*/
@@ -586,6 +587,49 @@ public function test_basic_assertion_processing_instruction() {
$processor = new WP_HTML_Tag_Processor( '' );
$processor->next_token();
+ $this->assertSame(
+ '#processing-instruction',
+ $processor->get_token_name(),
+ "Should have found processing instruction token but found {$processor->get_token_name()} instead."
+ );
+
+ $this->assertNull(
+ $processor->get_comment_type(),
+ 'Should not have detected a comment type on a non-comment token.'
+ );
+
+ $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 Processing Instruction nodes with reserved XML targets
+ * are properly parsed as bogus comments.
+ *
+ * @ticket 60170
+ *
+ * @since 7.1.0
+ *
+ * @covers WP_HTML_Tag_Processor::next_token
+ */
+ public function test_basic_assertion_xml_processing_instruction(): void {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
$this->assertSame(
'#comment',
$processor->get_token_name(),
@@ -599,21 +643,27 @@ public function test_basic_assertion_processing_instruction() {
);
$this->assertSame(
- 'wp-bit',
+ 'xml',
$processor->get_tag(),
"Should have found PI target as tag name but found {$processor->get_tag()} instead."
);
$this->assertNull(
- $processor->get_attribute( 'type' ),
+ $processor->get_attribute( 'version' ),
'Should not have been able to query attributes on non-element token.'
);
$this->assertSame(
- ' {"just": "kidding"}',
+ ' version="1.0"',
$processor->get_modifiable_text(),
'Found incorrect modifiable text.'
);
+
+ $this->assertSame(
+ '?xml version="1.0"?',
+ $processor->get_full_comment_text(),
+ 'Found incorrect full comment text.'
+ );
}
/**
diff --git a/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php b/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php
index 88762ddbb60c4..84d90a84190fc 100644
--- a/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php
+++ b/tests/phpunit/tests/html-api/wpHtmlTagProcessor.php
@@ -657,7 +657,8 @@ public static function data_html_nth_token_substring() {
'Abruptly closed comment' => array( '', 1, '' ),
'Empty comment' => array( '', 1, '' ),
'Funky comment' => array( '', 1, '' ),
- 'PI lookalike comment' => array( '', 1, '' ),
+ 'Processing instruction' => array( '', 1, '' ),
+ 'PI lookalike comment' => array( '', 1, '' ),
'CDATA lookalike comment' => array( '', 1, '' ),
);
}
diff --git a/tests/phpunit/tests/html-api/wpHtmlTagProcessorModifiableText.php b/tests/phpunit/tests/html-api/wpHtmlTagProcessorModifiableText.php
index 4a09403b7b23e..35b5ed88baec0 100644
--- a/tests/phpunit/tests/html-api/wpHtmlTagProcessorModifiableText.php
+++ b/tests/phpunit/tests/html-api/wpHtmlTagProcessorModifiableText.php
@@ -349,6 +349,8 @@ public function test_get_modifiable_text_ignores_newlines_after_seeking() {
*
* @dataProvider data_tokens_not_supporting_modifiable_text_updates
*
+ * @expectedIncorrectUsage WP_HTML_Tag_Processor::set_modifiable_text
+ *
* @param string $html Contains HTML with a token not supporting modifiable text updates.
* @param int $advance_n_tokens Count of times to run `next_token()` before reaching target node.
*/
@@ -428,6 +430,8 @@ public static function data_tokens_with_basic_modifiable_text_updates() {
return array(
'Text node (start)' => array( 'Text', 1, 'Blubber', 'Blubber' ),
'Text node (middle)' => array( 'Bold move', 2, 'yo', 'yo' ),
+ 'PI node' => array( 'beforeafter', 2, 'other', 'beforeafter' ),
+ 'PI node (no separator)' => array( '', 1, '{"just": "kidding"}', '' ),
'Text node (end)' => array( '![]()
of a dog', 2, 'of a cat', '![]()
of a cat' ),
'Encoded text node' => array( 'birds and dogs ', 2, ' & ', '<birds> & <dogs> ' ),
'SCRIPT tag' => array( 'beforeafter', 2, 'const img = "![]()
&
";', 'beforeafter' ), @@ -441,6 +445,134 @@ public static function data_tokens_with_basic_modifiable_text_updates() { ); } + /** + * Ensures that processing instruction data updates re-parse to the value which was set. + * + * The processing instruction syntax cannot represent every data value verbatim: + * a separating space must be added when the data would abut the target, and + * the update always writes the `?>` form of the closer, whose `?` is dropped + * when parsing, so that data ending in `?` remains intact. + * + * @ticket 61530 + * + * @dataProvider data_processing_instruction_data_updates + * + * @param string $html Contains a processing instruction as its first token. + * @param string $new_data Data to set on the processing instruction. + * @param string $expected Expected document after the update. + */ + public function test_sets_processing_instruction_data( string $html, string $new_data, string $expected ): void { + $processor = new WP_HTML_Tag_Processor( $html ); + $processor->next_token(); + + $this->assertSame( + '#processing-instruction', + $processor->get_token_name(), + 'Should have found a processing instruction: check test setup.' + ); + + $target = $processor->get_tag(); + + $this->assertTrue( + $processor->set_modifiable_text( $new_data ), + 'Should have set the processing instruction data.' + ); + + $this->assertSame( + $new_data, + $processor->get_modifiable_text(), + 'Should have read back the enqueued data before flushing the update.' + ); + + $this->assertSame( + $expected, + $processor->get_updated_html(), + 'Should have updated the document as expected.' + ); + + $this->assertSame( + $new_data, + $processor->get_modifiable_text(), + 'Should have read back the data after flushing the update.' + ); + + $this->assertSame( + $target, + $processor->get_tag(), + 'Should not have changed the processing instruction target.' + ); + + $reparsed = new WP_HTML_Tag_Processor( $expected ); + $reparsed->next_token(); + + $this->assertSame( + '#processing-instruction', + $reparsed->get_token_name(), + 'Should have found a processing instruction when re-parsing the updated document.' + ); + + $this->assertSame( + $target, + $reparsed->get_tag(), + 'Should have preserved the target when re-parsing the updated document.' + ); + + $this->assertSame( + $new_data, + $reparsed->get_modifiable_text(), + 'Should have found the set data when re-parsing the updated document.' + ); + } + + /** + * Data provider. + * + * @return array
+ */
+ public static function data_processing_instruction_data_updates(): array {
+ return array(
+ 'Replace data' => array( '', 'after', '' ),
+ 'Bare closer rewritten' => array( '', 'after', '' ),
+ 'Separator inserted' => array( '', '{"just": "kidding"}', '' ),
+ 'Separator inserted (bare closer)' => array( '', 'data', '' ),
+ 'Data abutting target' => array( '', 'x', '' ),
+ 'Data ending in ?' => array( '', 'd?', '' ),
+ 'Data ending in ? (?> closer)' => array( '', 'd?', '' ),
+ 'Data of only ?' => array( '', '?', '' ),
+ 'Emptied (?> closer)' => array( '', '', '' ),
+ 'Emptied (bare closer)' => array( '', '', '' ),
+ 'Empty data set on empty data' => array( '', '', '' ),
+ 'Whitespace run normalized' => array( "", 'new', '' ),
+ );
+ }
+
+ /**
+ * Ensures that repeated processing instruction data updates replace
+ * each other instead of accumulating syntax adjustments.
+ *
+ * @ticket 61530
+ */
+ public function test_replaces_previous_processing_instruction_data_update(): void {
+ $processor = new WP_HTML_Tag_Processor( '' );
+ $processor->next_token();
+
+ $this->assertTrue(
+ $processor->set_modifiable_text( 'first?' ),
+ 'Should have set the initial processing instruction data.'
+ );
+
+ $this->assertTrue(
+ $processor->set_modifiable_text( 'second' ),
+ 'Should have replaced the pending processing instruction data.'
+ );
+
+ $this->assertSame(
+ '',
+ $processor->get_updated_html(),
+ 'Should have applied only the last update to the document.'
+ );
+ }
+
/**
* Ensures that updates with potentially-compromising values aren't accepted.
*
@@ -453,6 +585,8 @@ public static function data_tokens_with_basic_modifiable_text_updates() {
*
* @dataProvider data_unallowed_modifiable_text_updates
*
+ * @expectedIncorrectUsage WP_HTML_Tag_Processor::set_modifiable_text
+ *
* @param string $html_with_nonempty_modifiable_text Will be used to find the test element.
* @param string $invalid_update Update containing possibly-compromising text.
*/
@@ -490,6 +624,10 @@ public static function data_unallowed_modifiable_text_updates() {
return array(
'Comment with -->' => array( '', 'Comments end in -->' ),
'Comment with --!>' => array( '', 'Invalid but legitimate comments end in --!>' ),
+ 'PI with >' => array( '', 'Processing instructions end at the first >' ),
+ 'PI with leading space' => array( '', ' leading whitespace is skipped after the target' ),
+ 'PI with leading tab' => array( '', "\tleading whitespace is skipped after the target" ),
+ 'PI with only whitespace' => array( '', ' ' ),
'Non-JS SCRIPT with ', '
";', 'beforeafter' ), @@ -441,6 +445,134 @@ public static function data_tokens_with_basic_modifiable_text_updates() { ); } + /** + * Ensures that processing instruction data updates re-parse to the value which was set. + * + * The processing instruction syntax cannot represent every data value verbatim: + * a separating space must be added when the data would abut the target, and + * the update always writes the `?>` form of the closer, whose `?` is dropped + * when parsing, so that data ending in `?` remains intact. + * + * @ticket 61530 + * + * @dataProvider data_processing_instruction_data_updates + * + * @param string $html Contains a processing instruction as its first token. + * @param string $new_data Data to set on the processing instruction. + * @param string $expected Expected document after the update. + */ + public function test_sets_processing_instruction_data( string $html, string $new_data, string $expected ): void { + $processor = new WP_HTML_Tag_Processor( $html ); + $processor->next_token(); + + $this->assertSame( + '#processing-instruction', + $processor->get_token_name(), + 'Should have found a processing instruction: check test setup.' + ); + + $target = $processor->get_tag(); + + $this->assertTrue( + $processor->set_modifiable_text( $new_data ), + 'Should have set the processing instruction data.' + ); + + $this->assertSame( + $new_data, + $processor->get_modifiable_text(), + 'Should have read back the enqueued data before flushing the update.' + ); + + $this->assertSame( + $expected, + $processor->get_updated_html(), + 'Should have updated the document as expected.' + ); + + $this->assertSame( + $new_data, + $processor->get_modifiable_text(), + 'Should have read back the data after flushing the update.' + ); + + $this->assertSame( + $target, + $processor->get_tag(), + 'Should not have changed the processing instruction target.' + ); + + $reparsed = new WP_HTML_Tag_Processor( $expected ); + $reparsed->next_token(); + + $this->assertSame( + '#processing-instruction', + $reparsed->get_token_name(), + 'Should have found a processing instruction when re-parsing the updated document.' + ); + + $this->assertSame( + $target, + $reparsed->get_tag(), + 'Should have preserved the target when re-parsing the updated document.' + ); + + $this->assertSame( + $new_data, + $reparsed->get_modifiable_text(), + 'Should have found the set data when re-parsing the updated document.' + ); + } + + /** + * Data provider. + * + * @return array