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: Prevent bookmarks from being set on virtual tokens #7862

Closed
wants to merge 6 commits into from
Closed

HTML API: Prevent bookmarks from being set on virtual tokens #7862

wants to merge 6 commits into from

Conversation

sirreal
Copy link
Member

@sirreal sirreal commented Nov 21, 2024 •
edited
Loading

Prevent tokens (with unreliable seek behavior) from being set at virtual tokens.

When an HTML_Processor bookmark is set at a virtual token (a node in the resulting document that does not correspond to an HTML token present in the input string), seek behavior becomes unreliable.

For example:

$processor = WP_HTML_Processor::create_full_parser( 'text only' );

$advance_and_log_tag = function () use ( $processor ) {
        assert( $processor->next_tag( array( 'tag_closers' => 'visit' ) ) );
        echo str_repeat( '  ', $processor->get_current_depth() ) .
                ( $processor->is_tag_closer() ? '  /' : '' ) .
                $processor->get_token_name() .
                "\n";
};

$advance_and_log_tag();
$advance_and_log_tag();
$advance_and_log_tag();
$advance_and_log_tag();
// Now at `<BODY>` virtual token, not present in the HTML string.
assert( 'BODY' === $processor->get_token_name() && ! $processor->is_tag_closer() );
assert( $processor->set_bookmark( 'apparently <BODY> open tag' ) );
$advance_and_log_tag();
$advance_and_log_tag();
// Now at `</HTML>` virtual token, not present in the HTML string.
assert( $processor->seek( 'apparently <BODY> open tag' ) );
// Expected to return to `<BODY>` open tag.
echo $processor->get_token_name() . "\n";
// prints: #text
assert( 'BODY' === $processor->get_token_name() );
// AssertionError!
The above prints:

  HTML
    HEAD
    /HEAD
    BODY
    /BODY
  /HTML
#text

Fatal error: Uncaught AssertionError: assert('BODY' === $processor->get_token_name()) …

Trac ticket: https://core.trac.wordpress.org/ticket/62521

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions GitHub Actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@sirreal sirreal marked this pull request as ready for review November 22, 2024 10:15
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 22, 2024 •
edited
Loading

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props jonsurrell, gziolo.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@gziolo
Copy link
Member

gziolo commented Dec 9, 2024

This looks good. Let's improve the developer hint when incorrect usage is detected.

@sirreal sirreal requested a review from gziolo December 9, 2024 14:42
@gziolo
Copy link
Member

gziolo commented Dec 10, 2024

Committed with https://core.trac.wordpress.org/changeset/59502.

@gziolo gziolo closed this Dec 10, 2024
@sirreal sirreal deleted the html-api/prevent-bookmarks-on-virtual-tokens branch December 12, 2024 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gziolo gziolo gziolo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sirreal @gziolo