Add backport of fix in Core-62085

Restore deprecated method without using it

Author: westonruter

plugins/optimization-detective/class-od-html-tag-processor.php

@@ -234,6 +234,31 @@ final class OD_HTML_Tag_Processor extends WP_HTML_Tag_Processor {
 	 */
 	private $reached_end_of_document = false;
 
+	/**
+	 * Count for the number of times that the cursor was moved.
+	 *
+	 * The use of this has been replaced with {@see self::$cursor_at_bookmark}.
+	 *
+	 * @since 0.6.0
+	 * @var non-negative-int
+	 * @see self::next_token()
+	 */
+	private $cursor_move_count = 0;
+
+	/**
+	 * The bookmark that the cursor is currently known to be at.
+	 *
+	 * This is used as a backport for the WP 6.8 fix in {@link https://core.trac.wordpress.org/ticket/62085} which
+	 * no-ops seek() calls in which the cursor is already at the provided bookmark.
+	 *
+	 * @since n.e.x.t
+	 * @var string|null
+	 * @see self::next_token()
+	 * @see self::seek()
+	 * @see self::set_bookmark()
+	 */
+	private $cursor_at_bookmark = null;
+
 	/**
 	 * Finds the next tag.
 	 *
@@ -311,6 +336,8 @@ public function expects_closer( ?string $tag_name = null ): bool {
 	public function next_token(): bool {
 		$this->current_stored_xpath = null; // Clear cache.
 		$this->current_xpath        = null; // Clear cache.
+		$this->cursor_at_bookmark   = null;
+		++$this->cursor_move_count;
 		if ( ! parent::next_token() ) {
 			$this->open_stack_tags       = array();
 			$this->open_stack_attributes = array();
@@ -409,6 +436,20 @@ public function next_token(): bool {
 		return true;
 	}
 
+	/**
+	 * Gets the number of times the cursor has moved.
+	 *
+	 * @since 0.6.0
+	 * @deprecated n.e.x.t The use of this has been replaced with {@see self::$cursor_at_bookmark}.
+	 * @codeCoverageIgnore
+	 *
+	 * @return non-negative-int Count of times the cursor has moved.
+	 */
+	public function get_cursor_move_count(): int {
+		_deprecated_function( __METHOD__, 'optimization-detective n.e.x.t' );
+		return $this->cursor_move_count;
+	}
+
 	/**
 	 * Updates or creates a new attribute on the currently matched tag with the passed value.
 	 *
@@ -486,8 +527,14 @@ public function get_current_depth(): int {
 	 * @return bool Whether the internal cursor was successfully moved to the bookmark's location.
 	 */
 	public function seek( $bookmark_name ): bool {
+		// This is only needed prior to WP 6.8 per <https://core.trac.wordpress.org/ticket/62085>.
+		if ( $bookmark_name === $this->cursor_at_bookmark ) {
+			return true;
+		}
+
 		$result = parent::seek( $bookmark_name );
 		if ( $result ) {
+			$this->cursor_at_bookmark    = $bookmark_name;
 			$this->open_stack_tags       = $this->bookmarked_open_stacks[ $bookmark_name ]['tags'];
 			$this->open_stack_attributes = $this->bookmarked_open_stacks[ $bookmark_name ]['attributes'];
 			$this->open_stack_indices    = $this->bookmarked_open_stacks[ $bookmark_name ]['indices'];
@@ -507,6 +554,8 @@ public function seek( $bookmark_name ): bool {
 	public function set_bookmark( $name ): bool {
 		$result = parent::set_bookmark( $name );
 		if ( $result ) {
+			$this->cursor_at_bookmark = $name; // Only needed prior to WP 6.8 per <https://core.trac.wordpress.org/ticket/62085>.
+
 			$this->bookmarked_open_stacks[ $name ] = array(
 				'tags'       => $this->open_stack_tags,
 				'attributes' => $this->open_stack_attributes,
@@ -535,6 +584,10 @@ public function release_bookmark( $name ): bool {
 			return false;
 		}
 		unset( $this->bookmarked_open_stacks[ $name ] );
+		if ( $this->cursor_at_bookmark === $name ) {
+			// Only needed prior to WP 6.8 per <https://core.trac.wordpress.org/ticket/62085>.
+			$this->cursor_at_bookmark = null;
+		}
 		return parent::release_bookmark( $name );
 	}