Changeset 55555 for trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

Timestamp:

03/16/2023 01:09:55 PM (18 months ago)

Author:

hellofromTonya

Message:

HTML API: Add bookmark invalidation logic.

While WP_HTML_Tag_Processor currently only supports changing a given tag's attributes, the plan is to provide methods to make broader changes (possibly through a subclass of WP_HTML_Tag_Processor). The API will have the potential of replacing a tag that a bookmark points to. To prepare, this changeset makes sure that all bookmarks affected by a HTML replacement are invalidated (i.e. released).

Changes:

• Extends the existing loop in WP_HTML_Tag_Processor::apply_attributes_updates() that adjusts bookmarks' start and end positions upon HTML changes to check if the entire bookmark is within a portion of the HTML that has been replaced.
• Adds `WP_HTML_Tag_Processor::has_bookmark() to check whether the given bookmark name exists.

References:

• ​Gutenberg PR 47559
• ​Released in Gutenberg 15.3.0

Follow-up to [55203].

Props bernhard-reiter, dmsnell, zieladam.
Fixes #57788.

File:

• trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php (modified) (4 diffs)

trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -1405 +1405 @@
      *
      * @since 6.2.0
+     * @since 6.3.0 Invalidate any bookmarks whose targets are overwritten.
      *
      * @return void
@@ -1435 +1436 @@
          * replacements adjust offsets in the input document.
          */
-        foreach ( $this->bookmarks as $bookmark ) {
+        foreach ( $this->bookmarks as $bookmark_name => $bookmark ) {
             /*
              * Each lexical update which appears before the bookmark's endpoints
@@ -1446 +1447 @@
 
             foreach ( $this->lexical_updates as $diff ) {
-                $update_head = $bookmark->start >= $diff->start;
-                $update_tail = $bookmark->end >= $diff->start;
-
-                if ( ! $update_head && ! $update_tail ) {
+                if ( $bookmark->start < $diff->start && $bookmark->end < $diff->start ) {
                     break;
                 }
 
+                if ( $bookmark->start >= $diff->start && $bookmark->end < $diff->end ) {
+                    $this->release_bookmark( $bookmark_name );
+                    continue 2;
+                }
+
                 $delta = strlen( $diff->text ) - ( $diff->end - $diff->start );
 
-                if ( $update_head ) {
+                if ( $bookmark->start >= $diff->start ) {
                     $head_delta += $delta;
                 }
 
-                if ( $update_tail ) {
+                if ( $bookmark->end >= $diff->end ) {
                     $tail_delta += $delta;
                 }
@@ -1469 +1472 @@
 
         $this->lexical_updates = array();
+    }
+
+    /**
+     * Checks whether a bookmark with the given name exists.
+     *
+     * @since 6.3.0
+     *
+     * @param string $bookmark_name Name to identify a bookmark that potentially exists.
+     * @return bool Whether that bookmark exists.
+     */
+    public function has_bookmark( $bookmark_name ) {
+        return array_key_exists( $bookmark_name, $this->bookmarks );
     }