vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2025-10-16 12:05:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

HTML-API: Introduce minimal HTML Processor.

Browse Source 
This patch introduces the //first// of //many// iterations on the evolution of the HTML API, the HTML Processor, which is built in order to understand HTML structure including nesting, misnesting, and complicated semantic rules.

In the first iteration, the HTML Processor is arbitrarily limited to a minimal subset of functionality so that we can review it, ship it, test it, and collect feedback before moving forward. This means that this patch is more or less an extension to the Tag Processor query language, providing the ability not only to scan for a tag of a given name, but also to find an HTML element in a specific nesting path.

The HTML Processor also aborts any time it encounters:
 - a tag that isn't a `P`, `DIV`, `FIGURE`, `FIGCAPTION`, `IMG`, `STRONG`, `B`, `EM`, `I`, `A`, `BIG`, `CODE`, `FONT`, `SMALL`, `STRIKE`, `TT`, or `U` tag. this limit exists because many HTML elements require specific rules and we are trying to limit the number of rules introduced at once. this work is targeted at existing work in places like the image block.
 - certain misnesting constructs that evoke complicated resolution inside the HTML spec. where possible and where simple to do reliably, certain parse errors are handled. in most cases the HTML Processor aborts.

The structure of the HTML Processor is established in this patch. Further spec-compliance comes through filling out //more of the same// kind and nature of code as is found in this patch. Certain critical HTML algorithms are partially supported, and where support requires more than is present, the HTML Processor acknowledges this and refuses to operate.

In this patch are explorations for how to verify that new HTML support is fully added (instead of allowing for partial updates that leave some code paths non-compliant). Performance is hard to measure since support is so limited at the current time, but it should generally follow the performance of the Tag Processor somewhat close as the overhead is minimized as much as practical.

Props dmsnell, zieladam, costdev.
Fixes #58517.

git-svn-id: https://develop.svn.wordpress.org/trunk@56274 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Bernie Reiter 2023-07-20 13:41:21 +00:00
parent cb42d7226f
commit f4fa4dd1ba
11 changed files with 3034 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

188
src/wp-includes/html-api/class-wp-html-active-formatting-elements.php Normal file
View File

@ -0,0 +1,188 @@
<?php
/**
* HTML API: WP_HTML_Active_Formatting_Elements class
*
* @package WordPress
* @subpackage HTML-API
* @since 6.4.0
*/
/**
* Core class used by the HTML processor during HTML parsing
* for managing the stack of active formatting elements.
*
* This class is designed for internal use by the HTML processor.
*
* > Initially, the list of active formatting elements is empty.
* > It is used to handle mis-nested formatting element tags.
* >
* > The list contains elements in the formatting category, and markers.
* > The markers are inserted when entering applet, object, marquee,
* > template, td, th, and caption elements, and are used to prevent
* > formatting from "leaking" into applet, object, marquee, template,
* > td, th, and caption elements.
* >
* > In addition, each element in the list of active formatting elements
* > is associated with the token for which it was created, so that
* > further elements can be created for that token if necessary.
*
* @since 6.4.0
*
* @access private
*
* @see https://html.spec.whatwg.org/#list-of-active-formatting-elements
* @see WP_HTML_Processor
*/
class WP_HTML_Active_Formatting_Elements {
/**
* Holds the stack of active formatting element references.
*
* @since 6.4.0
*
* @var WP_HTML_Token[]
*/
private $stack = array();
/**
* Reports if a specific node is in the stack of active formatting elements.
*
* @since 6.4.0
*
* @param WP_HTML_Token $token Look for this node in the stack.
* @return bool Whether the referenced node is in the stack of active formatting elements.
*
*/
public function contains_node( $token ) {
foreach ( $this->walk_up() as $item ) {
if ( $token->bookmark_name === $item->bookmark_name ) {
return true;
}
}
return false;
}
/**
* Returns how many nodes are currently in the stack of active formatting elements.
*
* @since 6.4.0
*
* @return int How many node are in the stack of active formatting elements.
*/
public function count() {
return count( $this->stack );
}
/**
* Returns the node at the end of the stack of active formatting elements,
* if one exists. If the stack is empty, returns null.
*
* @since 6.4.0
*
* @return WP_HTML_Token|null Last node in the stack of active formatting elements, if one exists, otherwise null.
*/
public function current_node() {
$current_node = end( $this->stack );
return $current_node ? $current_node : null;
}
/**
* Pushes a node onto the stack of active formatting elements.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#push-onto-the-list-of-active-formatting-elements
*
* @param WP_HTML_Token $token Push this node onto the stack.
*/
public function push( $token ) {
/*
* > If there are already three elements in the list of active formatting elements after the last marker,
* > if any, or anywhere in the list if there are no markers, that have the same tag name, namespace, and
* > attributes as element, then remove the earliest such element from the list of active formatting
* > elements. For these purposes, the attributes must be compared as they were when the elements were
* > created by the parser; two elements have the same attributes if all their parsed attributes can be
* > paired such that the two attributes in each pair have identical names, namespaces, and values
* > (the order of the attributes does not matter).
*
* @TODO: Implement the "Noah's Ark clause" to only add up to three of any given kind of formatting elements to the stack.
*/
// > Add element to the list of active formatting elements.
$this->stack[] = $token;
}
/**
* Removes a node from the stack of active formatting elements.
*
* @since 6.4.0
*
* @param WP_HTML_Token $token Remove this node from the stack, if it's there already.
* @return bool Whether the node was found and removed from the stack of active formatting elements.
*/
public function remove_node( $token ) {
foreach ( $this->walk_up() as $position_from_end => $item ) {
if ( $token->bookmark_name !== $item->bookmark_name ) {
continue;
}
$position_from_start = $this->count() - $position_from_end - 1;
array_splice( $this->stack, $position_from_start, 1 );
return true;
}
return false;
}
/**
* Steps through the stack of active formatting elements, starting with the
* top element (added first) and walking downwards to the one added last.
*
* This generator function is designed to be used inside a "foreach" loop.
*
* Example:
*
* $html = '<em><strong><a>We are here';
* foreach ( $stack->walk_down() as $node ) {
* echo "{$node->node_name} -> ";
* }
* > EM -> STRONG -> A ->
*
* To start with the most-recently added element and walk towards the top,
* @see WP_HTML_Active_Formatting_Elements::walk_up
*
* @since 6.4.0
*/
public function walk_down() {
$count = count( $this->stack );
for ( $i = 0; $i < $count; $i++ ) {
yield $this->stack[ $i ];
}
}
/**
* Steps through the stack of active formatting elements, starting with the
* bottom element (added last) and walking upwards to the one added first.
*
* This generator function is designed to be used inside a "foreach" loop.
*
* Example:
*
* $html = '<em><strong><a>We are here';
* foreach ( $stack->walk_up() as $node ) {
* echo "{$node->node_name} -> ";
* }
* > A -> STRONG -> EM ->
*
* To start with the first added element and walk towards the bottom,
* @see WP_HTML_Active_Formatting_Elements::walk_down
*
* @since 6.4.0
*/
public function walk_up() {
for ( $i = count( $this->stack ) - 1; $i >= 0; $i-- ) {
yield $this->stack[ $i ];
}
}
}

413
src/wp-includes/html-api/class-wp-html-open-elements.php Normal file
View File

@ -0,0 +1,413 @@
<?php
/**
* HTML API: WP_HTML_Open_Elements class
*
* @package WordPress
* @subpackage HTML-API
* @since 6.4.0
*/
/**
* Core class used by the HTML processor during HTML parsing
* for managing the stack of open elements.
*
* This class is designed for internal use by the HTML processor.
*
* > Initially, the stack of open elements is empty. The stack grows
* > downwards; the topmost node on the stack is the first one added
* > to the stack, and the bottommost node of the stack is the most
* > recently added node in the stack (notwithstanding when the stack
* > is manipulated in a random access fashion as part of the handling
* > for misnested tags).
*
* @since 6.4.0
*
* @access private
*
* @see https://html.spec.whatwg.org/#stack-of-open-elements
* @see WP_HTML_Processor
*/
class WP_HTML_Open_Elements {
/**
* Holds the stack of open element references.
*
* @since 6.4.0
*
* @var WP_HTML_Token[]
*/
public $stack = array();
/**
* Whether a P element is in button scope currently.
*
* This class optimizes scope lookup by pre-calculating
* this value when elements are added and removed to the
* stack of open elements which might change its value.
* This avoids frequent iteration over the stack.
*
* @since 6.4.0
*
* @var bool
*/
private $has_p_in_button_scope = false;
/**
* Reports if a specific node is in the stack of open elements.
*
* @since 6.4.0
*
* @param WP_HTML_Token $token Look for this node in the stack.
* @return bool Whether the referenced node is in the stack of open elements.
*/
public function contains_node( $token ) {
foreach ( $this->walk_up() as $item ) {
if ( $token->bookmark_name === $item->bookmark_name ) {
return true;
}
}
return false;
}
/**
* Returns how many nodes are currently in the stack of open elements.
*
* @since 6.4.0
*
* @return int How many node are in the stack of open elements.
*/
public function count() {
return count( $this->stack );
}
/**
* Returns the node at the end of the stack of open elements,
* if one exists. If the stack is empty, returns null.
*
* @since 6.4.0
*
* @return WP_HTML_Token|null Last node in the stack of open elements, if one exists, otherwise null.
*/
public function current_node() {
$current_node = end( $this->stack );
return $current_node ? $current_node : null;
}
/**
* Returns whether an element is in a specific scope.
*
* ## HTML Support
*
* This function skips checking for the termination list because there
* are no supported elements which appear in the termination list.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#has-an-element-in-the-specific-scope
*
* @param string $tag_name Name of tag check.
* @param string[] $termination_list List of elements that terminate the search.
* @return bool Whether the element was found in a specific scope.
*/
public function has_element_in_specific_scope( $tag_name, $termination_list ) {
foreach ( $this->walk_up() as $node ) {
if ( $node->node_name === $tag_name ) {
return true;
}
}
return false;
}
/**
* Returns whether a particular element is in scope.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#has-an-element-in-scope
*
* @param string $tag_name Name of tag to check.
* @return bool Whether given element is in scope.
*/
public function has_element_in_scope( $tag_name ) {
return $this->has_element_in_specific_scope(
$tag_name,
array(
/*
* Because it's not currently possible to encounter
* one of the termination elements, they don't need
* to be listed here. If they were, they would be
* unreachable and only waste CPU cycles while
* scanning through HTML.
*/
)
);
}
/**
* Returns whether a particular element is in list item scope.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#has-an-element-in-list-item-scope
*
* @param string $tag_name Name of tag to check.
* @return bool Whether given element is in scope.
*/
public function has_element_in_list_item_scope( $tag_name ) {
throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on list item scope.' );
}
/**
* Returns whether a particular element is in button scope.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#has-an-element-in-button-scope
*
* @param string $tag_name Name of tag to check.
* @return bool Whether given element is in scope.
*/
public function has_element_in_button_scope( $tag_name ) {
return $this->has_element_in_specific_scope(
$tag_name,
array(
/*
* Because it's not currently possible to encounter
* one of the termination elements, they don't need
* to be listed here. If they were, they would be
* unreachable and only waste CPU cycles while
* scanning through HTML.
*/
)
);
}
/**
* Returns whether a particular element is in table scope.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#has-an-element-in-table-scope
*
* @param string $tag_name Name of tag to check.
* @return bool Whether given element is in scope.
*/
public function has_element_in_table_scope( $tag_name ) {
throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on table scope.' );
}
/**
* Returns whether a particular element is in select scope.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#has-an-element-in-select-scope
*
* @param string $tag_name Name of tag to check.
* @return bool Whether given element is in scope.
*/
public function has_element_in_select_scope( $tag_name ) {
throw new WP_HTML_Unsupported_Exception( 'Cannot process elements depending on select scope.' );
}
/**
* Returns whether a P is in BUTTON scope.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#has-an-element-in-button-scope
*
* @return bool
*/
public function has_p_in_button_scope() {
return $this->has_p_in_button_scope;
}
/**
* Pops a node off of the stack of open elements.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#stack-of-open-elements
*
* @return bool Whether a node was popped off of the stack.
*/
public function pop() {
$item = array_pop( $this->stack );
if ( null === $item ) {
return false;
}
$this->after_element_pop( $item );
return true;
}
/**
* Pops nodes off of the stack of open elements until one with the given tag name has been popped.
*
* @since 6.4.0
*
* @see WP_HTML_Open_Elements::pop
*
* @param string $tag_name Name of tag that needs to be popped off of the stack of open elements.
* @return bool Whether a tag of the given name was found and popped off of the stack of open elements.
*/
public function pop_until( $tag_name ) {
foreach ( $this->walk_up() as $item ) {
$this->pop();
if ( $tag_name === $item->node_name ) {
return true;
}
}
return false;
}
/**
* Pushes a node onto the stack of open elements.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#stack-of-open-elements
*
* @param WP_HTML_Token $stack_item Item to add onto stack.
*/
public function push( $stack_item ) {
$this->stack[] = $stack_item;
$this->after_element_push( $stack_item );
}
/**
* Removes a specific node from the stack of open elements.
*
* @since 6.4.0
*
* @param WP_HTML_Token $token The node to remove from the stack of open elements.
* @return bool Whether the node was found and removed from the stack of open elements.
*/
public function remove_node( $token ) {
foreach ( $this->walk_up() as $position_from_end => $item ) {
if ( $token->bookmark_name !== $item->bookmark_name ) {
continue;
}
$position_from_start = $this->count() - $position_from_end - 1;
array_splice( $this->stack, $position_from_start, 1 );
$this->after_element_pop( $item );
return true;
}
return false;
}
/**
* Steps through the stack of open elements, starting with the top element
* (added first) and walking downwards to the one added last.
*
* This generator function is designed to be used inside a "foreach" loop.
*
* Example:
*
* $html = '<em><strong><a>We are here';
* foreach ( $stack->walk_down() as $node ) {
* echo "{$node->node_name} -> ";
* }
* > EM -> STRONG -> A ->
*
* To start with the most-recently added element and walk towards the top,
* @see WP_HTML_Open_Elements::walk_up
*
* @since 6.4.0
*/
public function walk_down() {
$count = count( $this->stack );
for ( $i = 0; $i < $count; $i++ ) {
yield $this->stack[ $i ];
}
}
/**
* Steps through the stack of open elements, starting with the bottom element
* (added last) and walking upwards to the one added first.
*
* This generator function is designed to be used inside a "foreach" loop.
*
* Example:
*
* $html = '<em><strong><a>We are here';
* foreach ( $stack->walk_up() as $node ) {
* echo "{$node->node_name} -> ";
* }
* > A -> STRONG -> EM ->
*
* To start with the first added element and walk towards the bottom,
* @see WP_HTML_Open_Elements::walk_down
*
* @since 6.4.0
*/
public function walk_up() {
for ( $i = count( $this->stack ) - 1; $i >= 0; $i-- ) {
yield $this->stack[ $i ];
}
}
/*
* Internal helpers.
*/
/**
* Updates internal flags after adding an element.
*
* Certain conditions (such as "has_p_in_button_scope") are maintained here as
* flags that are only modified when adding and removing elements. This allows
* the HTML Processor to quickly check for these conditions instead of iterating
* over the open stack elements upon each new tag it encounters. These flags,
* however, need to be maintained as items are added and removed from the stack.
*
* @since 6.4.0
*
* @param WP_HTML_Token $item Element that was added to the stack of open elements.
*/
public function after_element_push( $item ) {
/*
* When adding support for new elements, expand this switch to trap
* cases where the precalculated value needs to change.
*/
switch ( $item->node_name ) {
case 'P':
$this->has_p_in_button_scope = true;
break;
}
}
/**
* Updates internal flags after removing an element.
*
* Certain conditions (such as "has_p_in_button_scope") are maintained here as
* flags that are only modified when adding and removing elements. This allows
* the HTML Processor to quickly check for these conditions instead of iterating
* over the open stack elements upon each new tag it encounters. These flags,
* however, need to be maintained as items are added and removed from the stack.
*
* @since 6.4.0
*
* @param WP_HTML_Token $item Element that was removed from the stack of open elements.
*/
public function after_element_pop( $item ) {
/*
* When adding support for new elements, expand this switch to trap
* cases where the precalculated value needs to change.
*/
switch ( $item->node_name ) {
case 'P':
$this->has_p_in_button_scope = $this->has_element_in_button_scope( 'P' );
break;
}
}
}

121
src/wp-includes/html-api/class-wp-html-processor-state.php Normal file
View File

@ -0,0 +1,121 @@
<?php
/**
* HTML API: WP_HTML_Processor_State class
*
* @package WordPress
* @subpackage HTML-API
* @since 6.4.0
*/
/**
* Core class used by the HTML processor during HTML parsing
* for managing the internal parsing state.
*
* This class is designed for internal use by the HTML processor.
*
* @since 6.4.0
*
* @access private
*
* @see WP_HTML_Processor
*/
class WP_HTML_Processor_State {
/*
* Insertion mode constants.
*
* These constants exist and are named to make it easier to
* discover and recognize the supported insertion modes in
* the parser.
*
* Out of all the possible insertion modes, only those
* supported by the parser are listed here. As support
* is added to the parser for more modes, add them here
* following the same naming and value pattern.
*
* @see https://html.spec.whatwg.org/#the-insertion-mode
*/
/**
* Initial insertion mode for full HTML parser.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#the-initial-insertion-mode
* @see WP_HTML_Processor_State::$insertion_mode
*
* @var string
*/
const INSERTION_MODE_INITIAL = 'insertion-mode-initial';
/**
* In body insertion mode for full HTML parser.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#parsing-main-inbody
* @see WP_HTML_Processor_State::$insertion_mode
*
* @var string
*/
const INSERTION_MODE_IN_BODY = 'insertion-mode-in-body';
/**
* Tracks open elements while scanning HTML.
*
* This property is initialized in the constructor and never null.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#stack-of-open-elements
*
* @var WP_HTML_Open_Elements
*/
public $stack_of_open_elements = null;
/**
* Tracks open formatting elements, used to handle mis-nested formatting element tags.
*
* This property is initialized in the constructor and never null.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#list-of-active-formatting-elements
*
* @var WP_HTML_Active_Formatting_Elements
*/
public $active_formatting_elements = null;
/**
* Tree construction insertion mode.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#insertion-mode
*
* @var string
*/
public $insertion_mode = self::INSERTION_MODE_INITIAL;
/**
* Context node initializing fragment parser, if created as a fragment parser.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#concept-frag-parse-context
*
* @var [string, array]|null
*/
public $context_node = null;
/**
* Constructor - creates a new and empty state value.
*
* @since 6.4.0
*
* @see WP_HTML_Processor
*/
public function __construct() {
$this->stack_of_open_elements = new WP_HTML_Open_Elements();
$this->active_formatting_elements = new WP_HTML_Active_Formatting_Elements();
}
}

1266
src/wp-includes/html-api/class-wp-html-processor.php Normal file
View File

File diff suppressed because it is too large Load Diff

8
src/wp-includes/html-api/class-wp-html-tag-processor.php
View File

@ -522,7 +522,7 @@ class WP_HTML_Tag_Processor {
* @type string|null $class_name Tag must contain this whole class name to match.
* @type string|null $tag_closers "visit" or "skip": whether to stop on tag closers, e.g. </div>.
* }
* @return boolean Whether a tag was matched.
* @return bool Whether a tag was matched.
*/
public function next_tag( $query = null ) {
$this->parse_query( $query );
@ -673,7 +673,7 @@ class WP_HTML_Tag_Processor {
return false;
}
if ( ! array_key_exists( $name, $this->bookmarks ) && count( $this->bookmarks ) >= self::MAX_BOOKMARKS ) {
if ( ! array_key_exists( $name, $this->bookmarks ) && count( $this->bookmarks ) >= static::MAX_BOOKMARKS ) {
_doing_it_wrong(
__METHOD__,
__( 'Too many bookmarks: cannot create any more.' ),
@ -1538,7 +1538,7 @@ class WP_HTML_Tag_Processor {
return false;
}
if ( ++$this->seek_count > self::MAX_SEEK_OPS ) {
if ( ++$this->seek_count > static::MAX_SEEK_OPS ) {
_doing_it_wrong(
__METHOD__,
__( 'Too many calls to seek() - this can lead to performance issues.' ),
@ -2221,7 +2221,7 @@ class WP_HTML_Tag_Processor {
*
* @since 6.2.0
*
* @return boolean Whether the given tag and its attribute match the search criteria.
* @return bool Whether the given tag and its attribute match the search criteria.
*/
private function matches() {
if ( $this->is_closing_tag && ! $this->stop_on_tag_closers ) {

95
src/wp-includes/html-api/class-wp-html-token.php Normal file
View File

@ -0,0 +1,95 @@
<?php
/**
* HTML API: WP_HTML_Token class
*
* @package WordPress
* @subpackage HTML-API
* @since 6.4.0
*/
/**
* Core class used by the HTML processor during HTML parsing
* for referring to tokens in the input HTML string.
*
* This class is designed for internal use by the HTML processor.
*
* @since 6.4.0
*
* @access private
*
* @see WP_HTML_Processor
*/
class WP_HTML_Token {
/**
* Name of bookmark corresponding to source of token in input HTML string.
*
* Having a bookmark name does not imply that the token still exists. It
* may be that the source token and underlying bookmark was wiped out by
* some modification to the source HTML.
*
* @since 6.4.0
*
* @var string
*/
public $bookmark_name = null;
/**
* Name of node; lowercase names such as "marker" are not HTML elements.
*
* For HTML elements/tags this value should come from {@see WP_HTML_Processor::get_tag}.
*
* @since 6.4.0
*
* @var string
*/
public $node_name = null;
/**
* Whether node contains the self-closing flag.
*
* A node may have a self-closing flag when it shouldn't. This value
* only reports if the flag is present in the original HTML.
*
* @since 6.4.0
*
* @see https://html.spec.whatwg.org/#self-closing-flag
*
* @var bool
*/
public $has_self_closing_flag = false;
/**
* Called when token is garbage-collected or otherwise destroyed.
*
* @var callable|null
*/
public $on_destroy = null;
/**
* Constructor - creates a reference to a token in some external HTML string.
*
* @since 6.4.0
*
* @param string $bookmark_name Name of bookmark corresponding to location in HTML where token is found.
* @param string $node_name Name of node token represents; if uppercase, an HTML element; if lowercase, a special value like "marker".
* @param bool $has_self_closing_flag Whether the source token contains the self-closing flag, regardless of whether it's valid.
* @param callable $on_destroy Function to call when destroying token, useful for releasing the bookmark.
*/
public function __construct( $bookmark_name, $node_name, $has_self_closing_flag, $on_destroy = null ) {
$this->bookmark_name = $bookmark_name;
$this->node_name = $node_name;
$this->has_self_closing_flag = $has_self_closing_flag;
$this->on_destroy = $on_destroy;
}
/**
* Destructor.
*
* @since 6.4.0
*/
public function __destruct() {
if ( is_callable( $this->on_destroy ) ) {
call_user_func( $this->on_destroy, $this->bookmark_name );
}
}
}

31
src/wp-includes/html-api/class-wp-html-unsupported-exception.php Normal file
View File

@ -0,0 +1,31 @@
<?php
/**
* HTML API: WP_HTML_Unsupported_Exception class
*
* @package WordPress
* @subpackage HTML-API
* @since 6.4.0
*/
/**
* Core class used by the HTML processor during HTML parsing
* for indicating that a given operation is unsupported.
*
* This class is designed for internal use by the HTML processor.
*
* The HTML API aims to operate in compliance with the HTML5
* specification, but does not implement the full specification.
* In cases where it lacks support it should not cause breakage
* or unexpected behavior. In the cases where it recognizes that
* it cannot proceed, this class is used to abort from any
* operation and signify that the given HTML cannot be processed.
*
* @since 6.4.0
*
* @access private
*
* @see WP_HTML_Processor
*/
class WP_HTML_Unsupported_Exception extends Exception {
}

6
src/wp-settings.php
View File

@ -239,6 +239,12 @@ require ABSPATH . WPINC . '/html-api/class-wp-html-attribute-token.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-span.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-text-replacement.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-tag-processor.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-unsupported-exception.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-active-formatting-elements.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-open-elements.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-token.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-processor-state.php';
require ABSPATH . WPINC . '/html-api/class-wp-html-processor.php';
require ABSPATH . WPINC . '/class-wp-http.php';
require ABSPATH . WPINC . '/class-wp-http-streams.php';
require ABSPATH . WPINC . '/class-wp-http-curl.php';

118
tests/phpunit/tests/html-api/wpHtmlProcessor.php Normal file
View File

@ -0,0 +1,118 @@
<?php
/**
* Unit tests covering WP_HTML_Processor functionality.
*
* @package WordPress
* @subpackage HTML-API
*
* @since 6.4.0
*
* @group html-api
*
* @coversDefaultClass WP_HTML_Processor
*/
class Tests_HtmlApi_wpHtmlProcessor extends WP_UnitTestCase {
/**
* Ensure that the HTML Processor's public constructor function warns a developer to call
* the static creator methods instead of directly instantiating a new class.
*
* The Tag Processor's constructor method is public and PHP doesn't allow changing the
* visibility for a method on a subclass, which means that the HTML Processor must
* maintain the public interface. However, constructors cannot fail to construct, so
* if there are pre-conditions (such as the context node, the encoding form, and the
* parsing mode with the HTML Processor) these must be handled through static factory
* methods on the class.
*
* The HTML Processor requires a sentinel string as an optional parameter that hints
* at using the static methods. In the absence of the optional parameter it instructs
* the callee that it should be using those static methods instead.
*
* @ticket 58517
*
* @covers WP_HTML_Processor::__construct
*/
public function test_warns_that_the_static_creator_methods_should_be_called_instead_of_the_public_constructor() {
$this->setExpectedIncorrectUsage( 'WP_HTML_Processor::__construct' );
new WP_HTML_Processor( '<p>Light roast.</p>' );
$this->assertNotNull(
$this->caught_doing_it_wrong['WP_HTML_Processor::__construct'],
"Calling the public constructor should warn to call the static creator methods instead, but didn't."
);
}
/**
* Ensures that the HTML Processor maintains its internal state through seek calls.
*
* Because the HTML Processor must track a stack of open elements and active formatting
* elements, when it seeks to another location within its document it must adjust those
* stacks, its internal state, in such a way that they remain valid after the seek.
*
* For instance, if currently matched inside an LI element and the Processor seeks to
* an earlier location before the parent UL, then it should not report that it's still
* inside an open LI element.
*
* @ticket 58517
*
* @covers WP_HTML_Processor::next_tag
* @covers WP_HTML_Processor::seek
*
* @throws WP_HTML_Unsupported_Exception
*/
public function test_clear_to_navigate_after_seeking() {
$p = WP_HTML_Processor::createFragment( '<div one><strong></strong></div><p><strong two></strong></p>' );
while ( $p->next_tag() ) {
// Create a bookmark before entering a stack of elements and formatting elements.
if ( null !== $p->get_attribute( 'one' ) ) {
$this->assertTrue( $p->set_bookmark( 'one' ) );
continue;
}
// Create a bookmark inside of that stack.
if ( null !== $p->get_attribute( 'two' ) ) {
$p->set_bookmark( 'two' );
break;
}
}
// Ensure that it's possible to seek back to the outside location.
$this->assertTrue( $p->seek( 'one' ), 'Could not seek to earlier-seen location.' );
$this->assertSame( 'DIV', $p->get_tag(), "Should have jumped back to DIV but found {$p->get_tag()} instead." );
/*
* Ensure that the P element from the inner location isn't still on the stack of open elements.
* If it were, then the first STRONG element, inside the outer DIV would match the next call.
*/
$this->assertTrue( $p->next_tag( array( 'breadcrumbs' => array( 'P', 'STRONG' ) ) ), 'Failed to find given location after seeking.' );
// Only if the stack is properly managed will the processor advance to the inner STRONG element.
$this->assertTrue( $p->get_attribute( 'two' ), "Found the wrong location given the breadcrumbs, at {$p->get_tag()}." );
// Ensure that in seeking backwards the processor reports the correct full set of breadcrumbs.
$this->assertTrue( $p->seek( 'one' ), 'Failed to jump back to first bookmark.' );
$this->assertSame( array( 'HTML', 'BODY', 'DIV' ), $p->get_breadcrumbs(), 'Found wrong set of breadcrumbs navigating to node "one".' );
// Ensure that in seeking forwards the processor reports the correct full set of breadcrumbs.
$this->assertTrue( $p->seek( 'two' ), 'Failed to jump forward to second bookmark.' );
$this->assertTrue( $p->get_attribute( 'two' ), "Found the wrong location given the bookmark, at {$p->get_tag()}." );
$this->assertSame( array( 'HTML', 'BODY', 'P', 'STRONG' ), $p->get_breadcrumbs(), 'Found wrong set of bookmarks navigating to node "two".' );
}
/**
* Ensures that support is added for reconstructing active formatting elements
* before the HTML Processor handles situations with unclosed formats requiring it.
*
* @ticket 58517
*
* @covers WP_HTML_Processor::reconstruct_active_formatting_elements
*/
public function test_fails_to_reconstruct_formatting_elements() {
$p = WP_HTML_Processor::createFragment( '<p><em>One<p><em>Two<p><em>Three<p><em>Four' );
$this->assertTrue( $p->next_tag( 'EM' ), 'Could not find first EM.' );
$this->assertFalse( $p->next_tag( 'EM' ), 'Should have aborted before finding second EM as it required reconstructing the first EM.' );
}
}

427
tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php Normal file
View File

@ -0,0 +1,427 @@
<?php
/**
* Unit tests covering WP_HTML_Processor functionality.
*
* @package WordPress
* @subpackage HTML-API
*
* @since 6.4.0
*
* @group html-api
*
* @coversDefaultClass WP_HTML_Processor
*/
class Tests_HtmlApi_wpHtmlProcessorBreadcrumbs extends WP_UnitTestCase {
/**
* @ticket 58517
*
* @covers WP_HTML_Processor::step
*
* @dataProvider data_single_tag_of_supported_elements
*
* @param string $html HTML with at least one tag to scan.
* @param string $tag_name Name of first tag in HTML (because HTML treats IMAGE as IMG this may not match the HTML).
*/
public function test_navigates_into_normative_html_for_supported_elements( $html, $tag_name ) {
$p = WP_HTML_Processor::createFragment( $html );
$this->assertTrue( $p->step(), "Failed to step into supported {$tag_name} element." );
$this->assertSame( $tag_name, $p->get_tag(), "Misread {$tag_name} as a {$p->get_tag()} element." );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_single_tag_of_supported_elements() {
$supported_elements = array(
'A',
'B',
'BIG',
'CODE',
'DIV',
'EM',
'FIGCAPTION',
'FIGURE',
'FONT',
'I',
'IMG',
'P',
'SMALL',
'STRIKE',
'STRONG',
'TT',
'U',
);
$data = array();
foreach ( $supported_elements as $tag_name ) {
$data[ $tag_name ] = array( "<{$tag_name}>", $tag_name );
}
$data['IMAGE (treated as an IMG)'] = array( '<image>', 'IMG' );
return $data;
}
/**
* Ensures that no new HTML elements are accidentally partially-supported.
*
* When introducing support for new HTML elements, there are multiple places
* in the HTML Processor that need to be updated, until the time that the class
* has full HTML5 support. Because of this, these tests lock down the interface
* to ensure that support isn't accidentally updated in one place for a new
* element while overlooked in another.
*
* @ticket 58517
*
* @covers WP_HTML_Processor::step
*
* @dataProvider data_unsupported_elements
*
* @param string $html HTML string containing unsupported elements.
*/
public function test_fails_when_encountering_unsupported_tag( $html ) {
$p = WP_HTML_Processor::createFragment( $html );
$this->assertFalse( $p->step(), "Should not have stepped into unsupported {$p->get_tag()} element." );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_unsupported_elements() {
$unsupported_elements = array(
'ABBR',
'ACRONYM', // Neutralized
'ADDRESS',
'APPLET', // Deprecated
'AREA',
'ARTICLE',
'ASIDE',
'AUDIO',
'BASE',
'BDI',
'BDO',
'BGSOUND', // Deprecated; self-closing if self-closing flag provided, otherwise normal.
'BLINK', // Deprecated
'BODY',
'BR',
'BUTTON',
'CANVAS',
'CAPTION',
'CENTER', // Neutralized
'CITE',
'COL',
'COLGROUP',
'DATA',
'DATALIST',
'DD',
'DEL',
'DETAILS',
'DEFN',
'DIALOG',
'DL',
'DT',
'EMBED',
'FIELDSET',
'FOOTER',
'FORM',
'FRAME',
'FRAMESET',
'H1',
'H2',
'H3',
'H4',
'H5',
'H6',
'HEAD',
'HEADER',
'HGROUP',
'HR',
'HTML',
'IFRAME',
'INPUT',
'INS',
'ISINDEX', // Deprecated
'KBD',
'KEYGEN', // Deprecated; void
'LABEL',
'LEGEND',
'LI',
'LINK',
'LISTING', // Deprecated, use PRE instead.
'MAIN',
'MAP',
'MARK',
'MARQUEE', // Deprecated
'MATH',
'MENU',
'META',
'METER',
'MULTICOL', // Deprecated
'NAV',
'NEXTID', // Deprecated
'NOBR', // Neutralized
'NOEMBED', // Neutralized
'NOFRAMES', // Neutralized
'NOSCRIPT',
'OBJECT',
'OL',
'OPTGROUP',
'OPTION',
'OUTPUT',
'PICTURE',
'PLAINTEXT', // Neutralized
'PRE',
'PROGRESS',
'Q',
'RB', // Neutralized
'RP',
'RT',
'RTC', // Neutralized
'RUBY',
'SAMP',
'SCRIPT',
'SECTION',
'SELECT',
'SLOT',
'SOURCE',
'SPACER', // Deprecated
'SPAN',
'STYLE',
'SUB',
'SUMMARY',
'SUP',
'SVG',
'TABLE',
'TBODY',
'TD',
'TEMPLATE',
'TEXTAREA',
'TFOOT',
'TH',
'THEAD',
'TIME',
'TITLE',
'TR',
'TRACK',
'UL',
'VAR',
'VIDEO',
'WBR',
'XMP', // Deprecated, use PRE instead.
// Made up elements, custom elements.
'X-NOT-AN-HTML-ELEMENT',
'HUMAN-TIME',
);
$data = array();
foreach ( $unsupported_elements as $tag_name ) {
$data[ $tag_name ] = array( "<{$tag_name}>" );
}
return $data;
}
/**
* @ticket 58517
*
* @dataProvider data_unsupported_markup
*
* @param string $html HTML containing unsupported markup.
*/
public function test_fails_when_encountering_unsupported_markup( $html, $description ) {
$p = WP_HTML_Processor::createFragment( $html );
while ( $p->step() && null === $p->get_attribute( 'supported' ) ) {
continue;
}
$this->assertTrue( $p->get_attribute( 'supported' ), 'Did not find required supported element.' );
$this->assertFalse( $p->step(), "Didn't properly reject unsupported markup: {$description}" );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_unsupported_markup() {
return array(
'A with formatting following unclosed A' => array(
'<a><strong>Click <a supported><big unsupported>Here</big></a></strong></a>',
'Unclosed formatting requires complicated reconstruction.',
),
'A after unclosed A inside DIV' => array(
'<a><div supported><a unsupported></div></a>',
'A is a formatting element, which requires more complicated reconstruction.',
),
);
}
/**
* @ticket 58517
*
* @covers WP_HTML_Processor::next_tag
*
* @dataProvider data_html_target_with_breadcrumbs
*
* @param string $html HTML string with tags in it, one of which contains the "target" attribute.
* @param array $breadcrumbs Breadcrumbs of element with "target" attribute set.
* @param int $n How many breadcrumb matches to scan through in order to find "target" element.
*/
public function test_finds_correct_tag_given_breadcrumbs( $html, $breadcrumbs, $n ) {
$p = WP_HTML_Processor::createFragment( $html );
$p->next_tag(
array(
'breadcrumbs' => $breadcrumbs,
'match_offset' => $n,
)
);
$this->assertNotNull( $p->get_tag(), 'Failed to find target node.' );
$this->assertTrue( $p->get_attribute( 'target' ), "Found {$p->get_tag()} element didn't contain the necessary 'target' attribute." );
}
/**
* @ticket 58517
*
* @covers WP_HTML_Processor::get_breadcrumbs
*
* @dataProvider data_html_target_with_breadcrumbs
*
* @param string $html HTML string with tags in it, one of which contains the "target" attribute.
* @param array $breadcrumbs Breadcrumbs of element with "target" attribute set.
* @param int $ignored_n Not used in this test but provided in the dataset for other tests.
* @return void
*/
public function test_reports_correct_breadcrumbs_for_html( $html, $breadcrumbs, $ignored_n ) {
$p = WP_HTML_Processor::createFragment( $html );
while ( $p->next_tag() && null === $p->get_attribute( 'target' ) ) {
continue;
}
$this->assertNotNull( $p->get_tag(), 'Failed to find the target node.' );
$this->assertSame( $breadcrumbs, $p->get_breadcrumbs(), 'Found the wrong path from the root of the HTML document to the target node.' );
}
/**
* Data provider.
*
* @return array[]
*/
public function data_html_target_with_breadcrumbs() {
return array(
'Simple IMG tag' => array( '<img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
'Two sibling IMG tags' => array( '<img><img target>', array( 'HTML', 'BODY', 'IMG' ), 2 ),
'Three sibling IMG tags, an IMAGE in last place' => array( '<img><img><image target>', array( 'HTML', 'BODY', 'IMG' ), 3 ),
'IMG inside a DIV' => array( '<div><img target></div>', array( 'HTML', 'BODY', 'DIV', 'IMG' ), 1 ),
'DIV inside a DIV' => array( '<div><div target></div>', array( 'HTML', 'BODY', 'DIV', 'DIV' ), 1 ),
'IMG inside many DIVS' => array( '<div><div><div><div><img target></div></div></div></div>', array( 'HTML', 'BODY', 'DIV', 'DIV', 'DIV', 'DIV', 'IMG' ), 1 ),
'DIV inside DIV after IMG' => array( '<div><img><div target></div></div>', array( 'HTML', 'BODY', 'DIV', 'DIV' ), 1 ),
'IMG after DIV' => array( '<div></div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
'IMG after two DIVs' => array( '<div></div><div></div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
'IMG after two DIVs with nesting' => array( '<div><div><img></div></div><div></div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
'IMG after invalid DIV closer' => array( '</div><img target>', array( 'HTML', 'BODY', 'IMG' ), 1 ),
'EM inside DIV' => array( '<div>The weather is <em target>beautiful</em>.</div>', array( 'HTML', 'BODY', 'DIV', 'EM' ), 1 ),
'EM after closed EM' => array( '<em></em><em target></em>', array( 'HTML', 'BODY', 'EM' ), 2 ),
'EM after closed EMs' => array( '<em></em><em><em></em></em><em></em><em></em><em target></em>', array( 'HTML', 'BODY', 'EM' ), 6 ),
'EM after unclosed EM' => array( '<em><em target></em>', array( 'HTML', 'BODY', 'EM', 'EM' ), 1 ),
'EM after unclosed EM after DIV' => array( '<em><div><em target>', array( 'HTML', 'BODY', 'EM', 'DIV', 'EM' ), 1 ),
// This should work for all formatting elements, but if two work, the others probably do too.
'CODE after unclosed CODE after DIV' => array( '<code><div><code target>', array( 'HTML', 'BODY', 'CODE', 'DIV', 'CODE' ), 1 ),
'P after unclosed P' => array( '<p><p target>', array( 'HTML', 'BODY', 'P' ), 2 ),
'Unclosed EM inside P after unclosed P' => array( '<em><p><p><em target>', array( 'HTML', 'BODY', 'EM', 'P', 'EM' ), 1 ),
'P after closed P' => array( '<p><i>something</i></p><p target>This one</p>', array( 'HTML', 'BODY', 'P' ), 2 ),
'A after unclosed A' => array( '<a><a target>', array( 'HTML', 'BODY', 'A' ), 2 ),
'A after unclosed A, after a P' => array( '<p><a><a target>', array( 'HTML', 'BODY', 'P', 'A' ), 2 ),
// This one adds a test at a deep stack depth to ensure things work for situations beyond short test docs.
'Large HTML document with deep P' => array(
'<div><div><div><div><div><div><div><div><p></p><p></p><p><div><strong><em><code></code></em></strong></div></p></div></div></div></div></div></div></div></div><div><div><div><div><div><div><div><div><p></p><p></p><p><div><strong><em><code target></code></em></strong></div></p></div></div></div></div></div></div></div></div>',
array( 'HTML', 'BODY', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'DIV', 'STRONG', 'EM', 'CODE' ),
2,
),
);
}
/**
* Ensures that the ability to set attributes isn't broken by the HTML Processor.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Processor::set_attribute
*/
public function test_can_modify_attributes_after_finding_tag() {
$p = WP_HTML_Processor::createFragment( '<div><figure><img><figcaption>test</figcaption></figure>' );
$this->assertTrue( $p->next_tag( array( 'breadcrumbs' => array( 'figcaption' ) ) ), 'Unable to find given tag.' );
$p->set_attribute( 'found-it', true );
$this->assertSame( '<div><figure><img><figcaption found-it>test</figcaption></figure>', $p->get_updated_html() );
}
/**
* Ensures that the ability to scan for a given tag name isn't broken by the HTML Processor.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Processor::next_tag
*/
public function test_can_query_an_element_by_tag_name() {
$p = WP_HTML_Processor::createFragment( '<div><DIV><strong><img></strong></DIV>' );
$p->next_tag( 'IMG' );
$p->set_attribute( 'loading', 'lazy' );
$this->assertSame( '<div><DIV><strong><img loading="lazy"></strong></DIV>', $p->get_updated_html() );
}
/**
* Ensures that basic seeking behavior isn't broken by the HTML Processor.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Processor::seek
*/
public function test_can_seek_back_and_forth() {
$p = WP_HTML_Processor::createFragment( '<div><p one><div><p><div two><p><div><p><div><p three>' );
// Find first tag of interest.
while ( $p->next_tag() && null === $p->get_attribute( 'one' ) ) {
continue;
}
$p->set_bookmark( 'first' );
// Find second tag of interest.
while ( $p->next_tag() && null === $p->get_attribute( 'two' ) ) {
continue;
}
$p->set_bookmark( 'second' );
// Find third tag of interest.
while ( $p->next_tag() && null === $p->get_attribute( 'three' ) ) {
continue;
}
$p->set_bookmark( 'third' );
// Seek backwards.
$p->seek( 'first' );
// Seek forwards. If the current token isn't also updated this could appear like a backwards seek.
$p->seek( 'second' );
$this->assertTrue( $p->get_attribute( 'two' ) );
}
}

365
tests/phpunit/tests/html-api/wpHtmlSupportRequiredOpenElements.php Normal file
View File

@ -0,0 +1,365 @@
<?php
/**
* Unit tests for the HTML API indicating that changes are needed to the
* WP_HTML_Open_Elements class before specific features are added to the API.
*
* Note! Duplication of test cases and the helper function in this file are intentional.
* This test file exists to warn developers of related areas of code that need to update
* together when adding support for new elements to the HTML Processor. For example,
* when adding support for the BUTTON element it's necessary to update multiple methods
* in the class governing the stack of open elements as well as the HTML Processor class
* itself. This is because each element might bring with it semantic rules that impact
* the way the document should be parsed. BUTTON creates a kind of boundary in the
* DOM tree and implicitly closes existing open BUTTON elements.
*
* Without these tests a developer needs to investigate all possible places they
* might need to update when adding support for more elements and risks overlooking
* important parts that, in the absence of the related support, will lead to errors.
*
* @package WordPress
* @subpackage HTML-API
*
* @since 6.4.0
*
* @group html-api
*
* @coversDefaultClass WP_HTML_Processor
*/
class Tests_HtmlApi_wpHtmlSupportRequiredOpenElements extends WP_UnitTestCase {
/**
* Fails to assert if the HTML Processor handles the given tag.
*
* This test helper is used throughout this test file for one purpose only: to
* fail a test if the HTML Processor handles the given tag. In other words, it
* ensures that the HTML Processor aborts when encountering the given tag.
*
* This is used to ensure that when support for a new tag is added to the
* HTML Processor it receives full support and not partial support, which
* could lead to a variety of issues.
*
* Do not remove this helper function as it provides semantic meaning to the
* assertions in the tests in this file and its behavior is incredibly specific
* and limited and doesn't warrant adding a new abstraction into WP_UnitTestCase.
*
* @param string $tag_name the HTML Processor should abort when encountering this tag, e.g. "BUTTON".
*/
private function ensure_support_is_added_everywhere( $tag_name ) {
$p = WP_HTML_Processor::createFragment( "<$tag_name>" );
$this->assertFalse( $p->step(), "Must support terminating elements in specific scope check before adding support for the {$tag_name} element." );
}
/**
* The check for whether an element is in a scope depends on
* looking for a number of terminating elements in the stack of open
* elements. Until the listed elements are supported in the HTML
* processor, there are no terminating elements and there's no
* point in taking the time to look for them.
*
* @since 6.4.0
*
* @ticket 58517
*/
public function test_has_element_in_scope_needs_support() {
// These elements impact all scopes.
$this->ensure_support_is_added_everywhere( 'APPLET' );
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'MARQUEE' );
$this->ensure_support_is_added_everywhere( 'OBJECT' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// MathML Elements
$this->ensure_support_is_added_everywhere( 'MI' );
$this->ensure_support_is_added_everywhere( 'MO' );
$this->ensure_support_is_added_everywhere( 'MN' );
$this->ensure_support_is_added_everywhere( 'MS' );
$this->ensure_support_is_added_everywhere( 'MTEXT' );
$this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
/*
* SVG elements: note that TITLE is both an HTML element and an SVG element
* so care must be taken when adding support for either one.
*/
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
$this->ensure_support_is_added_everywhere( 'DESC' );
$this->ensure_support_is_added_everywhere( 'TITLE' );
}
/**
* The check for whether an element is in list item scope depends on
* the elements for any scope, plus UL and OL.
*
* The method for asserting list item scope doesn't currently exist
* because the LI element isn't yet supported and the LI element is
* the only element that needs to know about list item scope.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Open_Elements::has_element_in_list_item_scope
*/
public function test_has_element_in_list_item_scope_needs_support() {
// These elements impact all scopes.
$this->ensure_support_is_added_everywhere( 'APPLET' );
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'MARQUEE' );
$this->ensure_support_is_added_everywhere( 'OBJECT' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// MathML Elements
$this->ensure_support_is_added_everywhere( 'MI' );
$this->ensure_support_is_added_everywhere( 'MO' );
$this->ensure_support_is_added_everywhere( 'MN' );
$this->ensure_support_is_added_everywhere( 'MS' );
$this->ensure_support_is_added_everywhere( 'MTEXT' );
$this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
/*
* SVG elements: note that TITLE is both an HTML element and an SVG element
* so care must be taken when adding support for either one.
*/
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
$this->ensure_support_is_added_everywhere( 'DESC' );
$this->ensure_support_is_added_everywhere( 'TITLE' );
// These elements are specific to list item scope.
$this->ensure_support_is_added_everywhere( 'OL' );
$this->ensure_support_is_added_everywhere( 'UL' );
// This element is the only element that depends on list item scope.
$this->ensure_support_is_added_everywhere( 'LI' );
}
/**
* The check for whether an element is in BUTTON scope depends on
* the elements for any scope, plus BUTTON.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Open_Elements::has_element_in_button_scope
*/
public function test_has_element_in_button_scope_needs_support() {
// These elements impact all scopes.
$this->ensure_support_is_added_everywhere( 'APPLET' );
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'MARQUEE' );
$this->ensure_support_is_added_everywhere( 'OBJECT' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// MathML Elements
$this->ensure_support_is_added_everywhere( 'MI' );
$this->ensure_support_is_added_everywhere( 'MO' );
$this->ensure_support_is_added_everywhere( 'MN' );
$this->ensure_support_is_added_everywhere( 'MS' );
$this->ensure_support_is_added_everywhere( 'MTEXT' );
$this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
/*
* SVG elements: note that TITLE is both an HTML element and an SVG element
* so care must be taken when adding support for either one.
*/
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
$this->ensure_support_is_added_everywhere( 'DESC' );
$this->ensure_support_is_added_everywhere( 'TITLE' );
$this->ensure_support_is_added_everywhere( 'BUTTON' );
}
/**
* The optimization maintaining a flag for "P is in BUTTON scope" requires
* updating that flag every time an element is popped from the stack of
* open elements.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Open_Elements::after_element_pop
*/
public function test_after_element_pop_must_maintain_p_in_button_scope_flag() {
// These elements impact all scopes.
$this->ensure_support_is_added_everywhere( 'APPLET' );
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'MARQUEE' );
$this->ensure_support_is_added_everywhere( 'OBJECT' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// MathML Elements
$this->ensure_support_is_added_everywhere( 'MI' );
$this->ensure_support_is_added_everywhere( 'MO' );
$this->ensure_support_is_added_everywhere( 'MN' );
$this->ensure_support_is_added_everywhere( 'MS' );
$this->ensure_support_is_added_everywhere( 'MTEXT' );
$this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
/*
* SVG elements: note that TITLE is both an HTML element and an SVG element
* so care must be taken when adding support for either one.
*/
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
$this->ensure_support_is_added_everywhere( 'DESC' );
$this->ensure_support_is_added_everywhere( 'TITLE' );
// This element is specific to BUTTON scope.
$this->ensure_support_is_added_everywhere( 'BUTTON' );
}
/**
* The optimization maintaining a flag for "P is in BUTTON scope" requires
* updating that flag every time an element is pushed onto the stack of
* open elements.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Open_Elements::after_element_push
*/
public function test_after_element_push_must_maintain_p_in_button_scope_flag() {
// These elements impact all scopes.
$this->ensure_support_is_added_everywhere( 'APPLET' );
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'MARQUEE' );
$this->ensure_support_is_added_everywhere( 'OBJECT' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// MathML Elements
$this->ensure_support_is_added_everywhere( 'MI' );
$this->ensure_support_is_added_everywhere( 'MO' );
$this->ensure_support_is_added_everywhere( 'MN' );
$this->ensure_support_is_added_everywhere( 'MS' );
$this->ensure_support_is_added_everywhere( 'MTEXT' );
$this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
/*
* SVG elements: note that TITLE is both an HTML element and an SVG element
* so care must be taken when adding support for either one.
*/
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
$this->ensure_support_is_added_everywhere( 'DESC' );
$this->ensure_support_is_added_everywhere( 'TITLE' );
$this->ensure_support_is_added_everywhere( 'BUTTON' );
}
/**
* The check for whether an element is in TABLE scope depends on
* the HTML, TABLE, and TEMPLATE elements.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Open_Elements::has_element_in_table_scope
*/
public function test_has_element_in_table_scope_needs_support() {
// These elements impact all scopes.
$this->ensure_support_is_added_everywhere( 'APPLET' );
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'MARQUEE' );
$this->ensure_support_is_added_everywhere( 'OBJECT' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// MathML Elements
$this->ensure_support_is_added_everywhere( 'MI' );
$this->ensure_support_is_added_everywhere( 'MO' );
$this->ensure_support_is_added_everywhere( 'MN' );
$this->ensure_support_is_added_everywhere( 'MS' );
$this->ensure_support_is_added_everywhere( 'MTEXT' );
$this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
/*
* SVG elements: note that TITLE is both an HTML element and an SVG element
* so care must be taken when adding support for either one.
*/
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
$this->ensure_support_is_added_everywhere( 'DESC' );
$this->ensure_support_is_added_everywhere( 'TITLE' );
// These elements are specific to TABLE scope.
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// These elements depend on table scope.
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'COL' );
$this->ensure_support_is_added_everywhere( 'COLGROUP' );
$this->ensure_support_is_added_everywhere( 'TBODY' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TFOOT' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'THEAD' );
$this->ensure_support_is_added_everywhere( 'TR' );
}
/**
* The check for whether an element is in SELECT scope depends on
* the OPTGROUP and OPTION elements.
*
* @since 6.4.0
*
* @ticket 58517
*
* @covers WP_HTML_Open_Elements::has_element_in_select_scope
*/
public function test_has_element_in_select_scope_needs_support() {
// These elements impact all scopes.
$this->ensure_support_is_added_everywhere( 'APPLET' );
$this->ensure_support_is_added_everywhere( 'CAPTION' );
$this->ensure_support_is_added_everywhere( 'HTML' );
$this->ensure_support_is_added_everywhere( 'TABLE' );
$this->ensure_support_is_added_everywhere( 'TD' );
$this->ensure_support_is_added_everywhere( 'TH' );
$this->ensure_support_is_added_everywhere( 'MARQUEE' );
$this->ensure_support_is_added_everywhere( 'OBJECT' );
$this->ensure_support_is_added_everywhere( 'TEMPLATE' );
// MathML Elements
$this->ensure_support_is_added_everywhere( 'MI' );
$this->ensure_support_is_added_everywhere( 'MO' );
$this->ensure_support_is_added_everywhere( 'MN' );
$this->ensure_support_is_added_everywhere( 'MS' );
$this->ensure_support_is_added_everywhere( 'MTEXT' );
$this->ensure_support_is_added_everywhere( 'ANNOTATION-XML' );
/*
* SVG elements: note that TITLE is both an HTML element and an SVG element
* so care must be taken when adding support for either one.
*/
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
$this->ensure_support_is_added_everywhere( 'DESC' );
$this->ensure_support_is_added_everywhere( 'TITLE' );
// These elements are specific to SELECT scope.
$this->ensure_support_is_added_everywhere( 'OPTGROUP' );
$this->ensure_support_is_added_everywhere( 'OPTION' );
}
}