Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HTML API: Allow additional fragment contexts. #7141

Open
wants to merge 14 commits into
base: trunk
Choose a base branch
from
Open

HTML API: Allow additional fragment contexts. #7141

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
704ab8e
HTML API: Allow any fragment context.
dmsnell Aug 1, 2024
691d39e
Update docs
dmsnell Aug 5, 2024
7005b6c
Start adding tests for fragment parser
dmsnell Aug 6, 2024
101d345
Add basic unit tests for SCRIPT fragment parsing.
dmsnell Aug 6, 2024
5583818
WPCS
dmsnell Aug 6, 2024
4291703
Merge branch 'trunk' into html-api/allow-any-fragment-context
dmsnell Aug 20, 2024
d47eadd
Move context parsing into a new private static method.
dmsnell Aug 20, 2024
d146461
Reject creating a fragment parser for self-contained elements.
dmsnell Aug 20, 2024
a175677
Forbit void elements.
dmsnell Aug 20, 2024
77f1a38
Add TODO about foreign content.
dmsnell Aug 20, 2024
640f458
Update unit tests for invalid contexts.
dmsnell Aug 20, 2024
c3f1a81
Remove normalization function from tests
dmsnell Aug 21, 2024
40f4967
Testing: Print stuff for test failures
dmsnell Aug 21, 2024
4c652ad
Fix tests, !== ! == ===
dmsnell Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 98 additions & 4 deletions src/wp-includes/html-api/class-wp-html-processor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,24 +281,62 @@ class WP_HTML_Processor extends WP_HTML_Tag_Processor {
*
* ## Current HTML Support
*
* - The only supported context is `<body>`, which is the default value.
* - The only supported document encoding is `UTF-8`, which is the default value.
*
* Example:
*
* // Usually, snippets of HTML ought to be processed in the default `<body>` context.
* $processor = WP_HTML_Processor::create_fragment( '<p>Hi</p>' );
*
* // Prevent inner closing tags from closing the containing element and leaking out.
* $processor = WP_HTML_Processor::create_fragment( 'No </div> escape.', '<div>' );
*
* @todo Set the SVG or MathML namespace when creating with context node SVG or MATH.
*
* @since 6.4.0
* @since 6.6.0 Returns `static` instead of `self` so it can create subclass instances.
* @since 6.7.0 Can create fragment in any context.
*
* @param string $html Input HTML fragment to process.
* @param string $context Context element for the fragment, must be default of `<body>`.
* @param string $context Context element for the fragment, an HTML start tag like `<body>`.
* @param string $encoding Text encoding of the document; must be default of 'UTF-8'.
* @return static|null The created processor if successful, otherwise null.
*/
public static function create_fragment( $html, $context = '<body>', $encoding = 'UTF-8' ) {
if ( '<body>' !== $context || 'UTF-8' !== $encoding ) {
if ( 'UTF-8' !== $encoding ) {
return null;
}

$context_node = self::parse_context_element( $context );
if ( null === $context_node ) {
_doing_it_wrong(
__METHOD__,
__( 'The context argument must be an HTML start tag.' ),
'6.7.0'
);
return null;
}

if ( self::is_void( $context_node[0] ) ) {
_doing_it_wrong(
__METHOD__,
__( 'The context argument may not specify a void element.' ),
'6.7.0'
);
return null;
}

if ( in_array( $context_node[0], array( 'IFRAME', 'NOEMBED', 'NOFRAMES', 'SCRIPT', 'STYLE', 'TEXTAREA', 'TITLE', 'XMP' ), true ) ) {
_doing_it_wrong(
__METHOD__,
__( 'The context argument may not specify a self-contained element.' ),
'6.7.0'
);
return null;
}

$processor = new static( $html, self::CONSTRUCTOR_UNLOCK_CODE );
$processor->state->context_node = array( 'BODY', array() );
$processor->state->context_node = $context_node;
$processor->state->insertion_mode = WP_HTML_Processor_State::INSERTION_MODE_IN_BODY;
Copy link

@apermo apermo Aug 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I understood your PR correctly, it's about allowing insertion to anything other than body, or is body in this case ambivalent?

So content body vs <body>?

Anyways, I'm uncertain wether this is intentional or if you forgot to touch this.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the fragment parser is synonymous with node.innerHTML = newHtml in JavaScript or with a DOM. in this case, <body> has been the default as a reasonably safe default for existing code, which likely is getting only a small chunk of the actual site HTML and then trying to process it.

so if you knew you were inside a <li> you would create the fragment parser in the <li> context and then the parse would change based on that. I probably don't fully understand this, because it's hard for me to come up with situations that lead to different parses, but it comes into play when inside SVGs or MathML elements, and when resetting some internals (the insertion mode).

basically this is not something most people will need to use, but it will be used by set_inner_html() to ensure appropriate parsing.

$processor->state->encoding = $encoding;
$processor->state->encoding_confidence = 'certain';
Expand Down Expand Up @@ -327,6 +365,62 @@ public static function create_fragment( $html, $context = '<body>', $encoding =
return $processor;
}

/**
* Parses an HTML span containing a context element for the fragment parser.
*
* Effectively this extracts the first token from an HTML input and if it's a
* starting tag, will return the tag name and any attributes on the tag.
*
* Example:
*
* array( 'BODY', array() ) === self::parse_context_element( '<body>' );
* array( 'SCRIPT', array( 'type' => 'javascript' ) ) === self::parse_context_element( '<script type=javascript>' );
*
* null === self::parse_context_element( 'BODY' );
* null === self::parse_context_element( '</div>' );
* null === self::parse_context_element( '<!-- comment -->' );
*
* @since 6.7.0
*
* @param string $context HTML string containing start tag for context element.
* @return array|null Element name and associative array of attributes if parsed, otherwise NULL.
*/
private static function parse_context_element( $context = '<body>' ): ?array {
if ( '<body>' === $context ) {
return array( 'BODY', array() );
}

/*
* Check if the context might be a self-contained element, in which case it would
* need a closing tag to avoid parsing an incomplete token. Adding closing tags
* for each one is a minor hack, but ensures that each one of them will appear in
* the context as a fully-parsed token.
*/
if ( '<' === $context[0] && 1 === strspn( $context, 'iInNsStTxX', 1, 1 ) ) {
$context .= '</iframe></noembed></noframes></script></style></textarea></title></xmp>';
}

// Parse out the context element as well as the attributes.
$context_processor = new WP_HTML_Tag_Processor( $context );
if (
! $context_processor->next_token() ||
'#tag' !== $context_processor->get_token_type() ||
$context_processor->is_tag_closer()
) {
return null;
}

$attributes = array();
$attribute_names = $context_processor->get_attribute_names_with_prefix( '' );
if ( isset( $attribute_names ) ) {
foreach ( $attribute_names as $name ) {
$attributes[ $name ] = $context_processor->get_attribute( $name );
}
}

return array( $context_processor->get_tag(), $attributes );
}

/**
* Creates an HTML processor in the full parsing mode.
*
Expand Down
84 changes: 84 additions & 0 deletions tests/phpunit/tests/html-api/wpHtmlProcessorFragmentParsing.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
<?php
/**
* Unit tests covering WP_HTML_Processor fragment parsing functionality.
*
* @package WordPress
* @subpackage HTML-API
*
* @since 6.7.0
*
* @group html-api
*
* @coversDefaultClass WP_HTML_Processor
*/
class Tests_HtmlApi_WpHtmlProcessorFragmentParsing extends WP_UnitTestCase {
/**
* Verifies that the fragment parser doesn't allow invalid context nodes.
*
* This includes void elements and self-contained elements because they can
* contain no inner HTML. Operations on self-contained elements should occur
* through methods such as {@see WP_HTML_Tag_Processor::set_modifiable_text}.
*
* @ticket 61576
*
* @dataProvider data_invalid_fragment_contexts
*
* @expectedIncorrectUsage WP_HTML_Processor::create_fragment
*
* @param string $context Invalid context node for fragment parser.
*/
public function test_rejects_invalid_fragment_contexts( string $context ) {
$this->assertNull(
WP_HTML_Processor::create_fragment( 'just a test', $context ),
"Should not have been able to create a fragment parser with context node {$context}"
);
}

/**
* Data provider.
*
* @ticket 61576
*
* @return array[]
*/
public static function data_invalid_fragment_contexts() {
return array(
// Invalid contexts.
'Invalid text' => array( 'just some text' ),
'Invalid comment' => array( '<!-- comment -->' ),
'Invalid closing' => array( '</div>' ),
'Invalid DOCTYPE' => array( '<!DOCTYPE html>' ),

// Void elements.
'AREA' => array( '<area>' ),
'BASE' => array( '<base>' ),
'BASEFONT' => array( '<basefont>' ),
'BGSOUND' => array( '<bgsound>' ),
'BR' => array( '<br>' ),
'COL' => array( '<col>' ),
'EMBED' => array( '<embed>' ),
'FRAME' => array( '<frame>' ),
'HR' => array( '<hr>' ),
'IMG' => array( '<img>' ),
'INPUT' => array( '<input>' ),
'KEYGEN' => array( '<keygen>' ),
'LINK' => array( '<link>' ),
'META' => array( '<meta>' ),
'PARAM' => array( '<param>' ),
'SOURCE' => array( '<source>' ),
'TRACK' => array( '<track>' ),
'WBR' => array( '<wbr>' ),

// Self-contained elements.
'IFRAME' => array( '<iframe>' ),
'NOEMBED' => array( '<noembed>' ),
'NOFRAMES' => array( '<noframes>' ),
'SCRIPT' => array( '<script>' ),
'SCRIPT with type' => array( '<script type="javascript">' ),
'STYLE' => array( '<style>' ),
'TEXTAREA' => array( '<textarea>' ),
'TITLE' => array( '<title>' ),
'XMP' => array( '<xmp>' ),
);
}
}
Loading