Skip to content

Commit b791c27

Browse files
dmsnelldmsnell
committed
HTML API: Add support for BUTTON element
In this patch we're adding support to process the BUTTON element. This requires adding some additional semantic rules to handle situations where a BUTTON element is already in scope.
1 parent 3f6e712 commit b791c27

6 files changed

Lines changed: 175 additions & 27 deletions

File tree

‎src/wp-includes/html-api/class-wp-html-open-elements.php‎

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,15 @@ public function has_element_in_specific_scope( $tag_name, $termination_list ) {
115115
if ( $node->node_name === $tag_name ) {
116116
return true;
117117
}
118+
119+
switch ( $node->node_name ) {
120+
case 'HTML':
121+
return false;
122+
}
123+
124+
if ( in_array( $node->node_name, $termination_list, true ) ) {
125+
return true;
126+
}
118127
}
119128

120129
return false;
@@ -175,19 +184,7 @@ public function has_element_in_list_item_scope( $tag_name ) { // phpcs:ignore Va
175184
* @return bool Whether given element is in scope.
176185
*/
177186
public function has_element_in_button_scope( $tag_name ) {
178-
return $this->has_element_in_specific_scope(
179-
$tag_name,
180-
array(
181-
182-
/*
183-
* Because it's not currently possible to encounter
184-
* one of the termination elements, they don't need
185-
* to be listed here. If they were, they would be
186-
* unreachable and only waste CPU cycles while
187-
* scanning through HTML.
188-
*/
189-
)
190-
);
187+
return $this->has_element_in_specific_scope( $tag_name, array( 'BUTTON' ) );
191188
}
192189

193190
/**
@@ -394,6 +391,10 @@ public function after_element_push( $item ) {
394391
* cases where the precalculated value needs to change.
395392
*/
396393
switch ( $item->node_name ) {
394+
case 'BUTTON':
395+
$this->has_p_in_button_scope = false;
396+
break;
397+
397398
case 'P':
398399
$this->has_p_in_button_scope = true;
399400
break;
@@ -419,6 +420,10 @@ public function after_element_pop( $item ) {
419420
* cases where the precalculated value needs to change.
420421
*/
421422
switch ( $item->node_name ) {
423+
case 'BUTTON':
424+
$this->has_p_in_button_scope = $this->has_element_in_button_scope( 'P' );
425+
break;
426+
422427
case 'P':
423428
$this->has_p_in_button_scope = $this->has_element_in_button_scope( 'P' );
424429
break;

‎src/wp-includes/html-api/class-wp-html-processor-state.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,19 @@ class WP_HTML_Processor_State {
107107
*/
108108
public $context_node = null;
109109

110+
/**
111+
* The frameset-ok flag indicates if a `FRAMESET` element is allowed in the current state.
112+
*
113+
* > The frameset-ok flag is set to "ok" when the parser is created. It is set to "not ok" after certain tokens are seen.
114+
*
115+
* @since 6.4.0
116+
*
117+
* @see https://html.spec.whatwg.org/#frameset-ok-flag
118+
*
119+
* @var bool
120+
*/
121+
public $frameset_ok = true;
122+
110123
/**
111124
* Constructor - creates a new and empty state value.
112125
*

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

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,13 @@ public function get_last_error() {
348348
*/
349349
public function next_tag( $query = null ) {
350350
if ( null === $query ) {
351-
return $this->step();
351+
while ( $this->step() ) {
352+
if ( ! $this->is_tag_closer() ) {
353+
return true;
354+
}
355+
}
356+
357+
return false;
352358
}
353359

354360
if ( is_string( $query ) ) {
@@ -365,7 +371,13 @@ public function next_tag( $query = null ) {
365371
}
366372

367373
if ( ! ( array_key_exists( 'breadcrumbs', $query ) && is_array( $query['breadcrumbs'] ) ) ) {
368-
return $this->step();
374+
while ( $this->step() ) {
375+
if ( ! $this->is_tag_closer() ) {
376+
return true;
377+
}
378+
}
379+
380+
return false;
369381
}
370382

371383
if ( isset( $query['tag_closers'] ) && 'visit' === $query['tag_closers'] ) {
@@ -382,7 +394,7 @@ public function next_tag( $query = null ) {
382394

383395
$crumb = end( $breadcrumbs );
384396
$target = strtoupper( $crumb );
385-
while ( $this->step() ) {
397+
while ( $match_offset > 0 && $this->step() ) {
386398
if ( $target !== $this->get_tag() ) {
387399
continue;
388400
}
@@ -394,7 +406,7 @@ public function next_tag( $query = null ) {
394406
}
395407

396408
$crumb = prev( $breadcrumbs );
397-
if ( false === $crumb && 0 === --$match_offset ) {
409+
if ( false === $crumb && 0 === --$match_offset && ! $this->is_tag_closer() ) {
398410
return true;
399411
}
400412
}
@@ -509,6 +521,22 @@ private function step_in_body() {
509521
$op = "{$op_sigil}{$tag_name}";
510522

511523
switch ( $op ) {
524+
/*
525+
* > A start tag whose tag name is "button"
526+
*/
527+
case '+BUTTON':
528+
if ( $this->state->stack_of_open_elements->has_element_in_scope( 'BUTTON' ) ) {
529+
// @TODO: Indicate a parse error once it's possible. This error does not impact the logic here.
530+
$this->generate_implied_end_tags();
531+
$this->state->stack_of_open_elements->pop_until( 'BUTTON' );
532+
}
533+
534+
$this->reconstruct_active_formatting_elements();
535+
$this->insert_html_element( $this->current_token );
536+
$this->state->frameset_ok = false;
537+
538+
return true;
539+
512540
/*
513541
* > A start tag whose tag name is one of: "address", "article", "aside",
514542
* > "blockquote", "center", "details", "dialog", "dir", "div", "dl",
@@ -534,15 +562,20 @@ private function step_in_body() {
534562
* > "menu", "nav", "ol", "pre", "search", "section", "summary", "ul"
535563
*/
536564
case '-BLOCKQUOTE':
565+
case '-BUTTON':
537566
case '-DIV':
538567
case '-FIGCAPTION':
539568
case '-FIGURE':
540569
if ( ! $this->state->stack_of_open_elements->has_element_in_scope( $tag_name ) ) {
570+
// @TODO: Report parse error.
541571
// Ignore the token.
542572
return $this->step();
543573
}
544574

545575
$this->generate_implied_end_tags();
576+
if ( $this->state->stack_of_open_elements->current_node()->node_name !== $tag_name ) {
577+
// @TODO: Record parse error: this error doesn't impact parsing.
578+
}
546579
$this->state->stack_of_open_elements->pop_until( $tag_name );
547580
return true;
548581

@@ -922,7 +955,7 @@ private function generate_implied_end_tags( $except_for_this_element = null ) {
922955
}
923956
}
924957

925-
/*
958+
/**
926959
* Closes elements that have implied end tags, thoroughly.
927960
*
928961
* See the HTML specification for an explanation why this is

‎tests/phpunit/tests/html-api/wpHtmlProcessorBreadcrumbs.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ public function data_single_tag_of_supported_elements() {
3939
'A',
4040
'B',
4141
'BIG',
42+
'BUTTON',
4243
'CODE',
4344
'DIV',
4445
'EM',
@@ -111,7 +112,6 @@ public function data_unsupported_elements() {
111112
'BLINK', // Deprecated
112113
'BODY',
113114
'BR',
114-
'BUTTON',
115115
'CANVAS',
116116
'CAPTION',
117117
'CENTER', // Neutralized

‎tests/phpunit/tests/html-api/wpHtmlProcessorSemanticRules.php‎

Lines changed: 105 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,110 @@ class Tests_HtmlApi_WpHtmlProcessorSemanticRules extends WP_UnitTestCase {
1616
* RULES FOR "IN BODY" MODE
1717
*******************************************************************/
1818

19+
/**
20+
* Verifies that when encountering an end tag for which there is no corresponding
21+
* element in scope, that it skips the tag entirely.
22+
*
23+
* @ticket {TICKET_NUMBER}
24+
*
25+
* @since 6.4.0
26+
*
27+
* @throws Exception
28+
*/
29+
public function test_in_body_skips_unexpected_button_closer() {
30+
$p = WP_HTML_Processor::createFragment( '<div>Test</button></div>' );
31+
32+
$p->step();
33+
$this->assertEquals( 'DIV', $p->get_tag(), 'Did not stop at initial DIV tag.' );
34+
$this->assertFalse( $p->is_tag_closer(), 'Did not find that initial DIV tag is an opener.' );
35+
36+
$this->assertTrue( $p->step(), 'Found no further tags when it should have found the closing DIV' );
37+
$this->assertEquals( 'DIV', $p->get_tag(), "Did not skip unexpected BUTTON; stopped at {$p->get_tag()}." );
38+
$this->assertTrue( $p->is_tag_closer(), 'Did not find that the terminal DIV tag is a closer.' );
39+
}
40+
41+
/**
42+
* Verifies insertion of a BUTTON element when no existing BUTTON is already in scope.
43+
*
44+
* @ticket 58961
45+
*
46+
* @since 6.4.0
47+
*
48+
* @throws WP_HTML_Unsupported_Exception
49+
*/
50+
public function test_in_body_button_with_no_button_in_scope() {
51+
$p = WP_HTML_Processor::createFragment( '<div><p>Click the button <button one>here</button>!</p></div><button two>not here</button>' );
52+
53+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected first button.' );
54+
$this->assertTrue( $p->get_attribute( 'one' ), 'Failed to match expected attribute on first button.' );
55+
$this->assertSame( array( 'HTML', 'BODY', 'DIV', 'P', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for first button.' );
56+
57+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected second button.' );
58+
$this->assertTrue( $p->get_attribute( 'two' ), 'Failed to match expected attribute on second button.' );
59+
$this->assertSame( array( 'HTML', 'BODY', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for second button.' );
60+
}
61+
62+
/**
63+
* Verifies what when inserting a BUTTON element, when a BUTTON is already in scope,
64+
* that the open button is closed with all other elements inside of it.
65+
*
66+
* @ticket 58961
67+
*
68+
* @since 6.4.0
69+
*
70+
* @throws WP_HTML_Unsupported_Exception
71+
*/
72+
public function test_in_body_button_with_button_in_scope_as_parent() {
73+
$p = WP_HTML_Processor::createFragment( '<div><p>Click the button <button one>almost<button two>here</button>!</p></div><button three>not here</button>' );
74+
75+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected first button.' );
76+
$this->assertTrue( $p->get_attribute( 'one' ), 'Failed to match expected attribute on first button.' );
77+
$this->assertSame( array( 'HTML', 'BODY', 'DIV', 'P', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for first button.' );
78+
79+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected second button.' );
80+
$this->assertTrue( $p->get_attribute( 'two' ), 'Failed to match expected attribute on second button.' );
81+
$this->assertSame( array( 'HTML', 'BODY', 'DIV', 'P', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for second button.' );
82+
83+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected third button.' );
84+
$this->assertTrue( $p->get_attribute( 'three' ), 'Failed to match expected attribute on third button.' );
85+
$this->assertSame( array( 'HTML', 'BODY', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for third button.' );
86+
}
87+
88+
/**
89+
* Verifies what when inserting a BUTTON element, when a BUTTON is already in scope,
90+
* that the open button is closed with all other elements inside of it, even if the
91+
* BUTTON in scope is not a direct parent of the new BUTTON element.
92+
*
93+
* @ticket 58961
94+
*
95+
* @since 6.4.0
96+
*
97+
* @throws WP_HTML_Unsupported_Exception
98+
*/
99+
public function test_in_body_button_with_button_in_scope_as_ancestor() {
100+
$p = WP_HTML_Processor::createFragment( '<div><button one><p>Click the button <span><button two>here</button>!</span></p></div><button three>not here</button>' );
101+
102+
// This button finds itself normally nesting inside the DIV.
103+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected first button.' );
104+
$this->assertTrue( $p->get_attribute( 'one' ), 'Failed to match expected attribute on first button.' );
105+
$this->assertSame( array( 'HTML', 'BODY', 'DIV', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for first button.' );
106+
107+
/*
108+
* Because the second button appears while a BUTTON is in scope, it generates implied end tags and closes
109+
* the BUTTON, P, and SPAN elements. It looks like the BUTTON is inside the SPAN, but we have another case
110+
* of an unexpected closing SPAN tag because the SPAN was closed by the second BUTTON. This element finds
111+
* itself a child of the most-recent open element above the most-recent BUTTON, or the DIV.
112+
*/
113+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected second button.' );
114+
$this->assertTrue( $p->get_attribute( 'two' ), 'Failed to match expected attribute on second button.' );
115+
$this->assertSame( array( 'HTML', 'BODY', 'DIV', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for second button.' );
116+
117+
// The third button is back to normal, because everything has been implicitly or explicitly closed by now.
118+
$this->assertTrue( $p->next_tag( 'BUTTON' ), 'Could not find expected third button.' );
119+
$this->assertTrue( $p->get_attribute( 'three' ), 'Failed to match expected attribute on third button.' );
120+
$this->assertSame( array( 'HTML', 'BODY', 'BUTTON' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting for third button.' );
121+
}
122+
19123
/*
20124
* Verifies that when "in body" and encountering "any other end tag"
21125
* that the HTML processor ignores the end tag if there's a special
@@ -57,7 +161,7 @@ public function test_in_body_any_other_end_tag_with_unclosed_non_special_element
57161
$this->assertSame( 'CODE', $p->get_tag(), "Expected to start test on CODE element but found {$p->get_tag()} instead." );
58162
$this->assertSame( array( 'HTML', 'BODY', 'DIV', 'SPAN', 'CODE' ), $p->get_breadcrumbs(), 'Failed to produce expected DOM nesting.' );
59163

60-
$this->assertTrue( $p->next_tag(), 'Failed to advance past CODE tag to expected SPAN closer.' );
164+
$this->assertTrue( $p->step(), 'Failed to advance past CODE tag to expected SPAN closer.' );
61165
$this->assertTrue( $p->is_tag_closer(), 'Expected to find closing SPAN, but found opener instead.' );
62166
$this->assertSame( array( 'HTML', 'BODY', 'DIV' ), $p->get_breadcrumbs(), 'Failed to advance past CODE tag to expected DIV opener.' );
63167

‎tests/phpunit/tests/html-api/wpHtmlSupportRequiredOpenElements.php‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,6 @@ public function test_has_element_in_button_scope_needs_support() {
176176
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
177177
$this->ensure_support_is_added_everywhere( 'DESC' );
178178
$this->ensure_support_is_added_everywhere( 'TITLE' );
179-
180-
$this->ensure_support_is_added_everywhere( 'BUTTON' );
181179
}
182180

183181
/**
@@ -218,9 +216,6 @@ public function test_after_element_pop_must_maintain_p_in_button_scope_flag() {
218216
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
219217
$this->ensure_support_is_added_everywhere( 'DESC' );
220218
$this->ensure_support_is_added_everywhere( 'TITLE' );
221-
222-
// This element is specific to BUTTON scope.
223-
$this->ensure_support_is_added_everywhere( 'BUTTON' );
224219
}
225220

226221
/**
@@ -261,8 +256,6 @@ public function test_after_element_push_must_maintain_p_in_button_scope_flag() {
261256
$this->ensure_support_is_added_everywhere( 'FOREIGNOBJECT' );
262257
$this->ensure_support_is_added_everywhere( 'DESC' );
263258
$this->ensure_support_is_added_everywhere( 'TITLE' );
264-
265-
$this->ensure_support_is_added_everywhere( 'BUTTON' );
266259
}
267260

268261
/**

0 commit comments

Comments
 (0)