Interactivity API: Server Directive Processing Refactor (#58066)

* Initial SDP version

* Rename `initialState` to `state`

* Fix incorrect package

* Properly remove the SDP during the e2e tests

* Update multiline comments to fit WP standards

* Add @access private to WP_Interactivity_API_Directives_Processor

* Remove array check and rename bookmarks in WP_Interactivity_API_Directives_Processor

* Dont print config/state if it's empty

* Add failing test for </ >

* Add missing `object` word

* Missing indentation on ternary conditionals

* Improve namespace extraction from directive value

* Move modified properties to the end in set_style_property

* Replace tabindex comment

* Remove filter after processing and bump priority

* Replace own is_void with HTML API one

* Missing ternary indentation

* Avoid early returns

Because they don't seem to work: #57778 (comment)

* Update wp_register_script_module function

* Replaces some incorrect docblock comments with block comments

* Fix indent ternaries (again)

* Add more info about how extract_directive_value behaves

* Add more edge cases

* Improve wp_interactivity_process_directives_of_interactive_blocks comment

---------

Co-authored-by: Carlos Bravo <[email protected]>

lib/compat/wordpress-6.5/interactivity-api/class-wp-interactivity-api-directives-processor.php

@@ -0,0 +1,143 @@
+<?php
+/**
+ * Interactivity API: WP_Interactivity_API_Directives_Processor class.
+ *
+ * @package WordPress
+ * @subpackage Interactivity API
+ */
+
+if ( ! class_exists( 'WP_Interactivity_API_Directives_Processor' ) ) {
+	/**
+	 * Class used to iterate over the tags of an HTML string and help process the
+	 * directive attributes.
+	 *
+	 * @access private
+	 */
+	class WP_Interactivity_API_Directives_Processor extends Gutenberg_HTML_Tag_Processor_6_5 {
+		/**
+		 * Returns the content between two balanced tags.
+		 *
+		 * @access private
+		 *
+		 * @return string|null The content between the current opening and its matching closing tag or null if it doesn't
+		 *                     find the matching closing tag.
+		 */
+		public function get_content_between_balanced_tags() {
+			$bookmarks = $this->get_balanced_tag_bookmarks();
+			if ( ! $bookmarks ) {
+				return null;
+			}
+			list( $start_name, $end_name ) = $bookmarks;
+
+			$start = $this->bookmarks[ $start_name ]->start + $this->bookmarks[ $start_name ]->length + 1;
+			$end   = $this->bookmarks[ $end_name ]->start;
+
+			$this->seek( $start_name );
+			$this->release_bookmark( $start_name );
+			$this->release_bookmark( $end_name );
+
+			return substr( $this->html, $start, $end - $start );
+		}
+
+		/**
+		 * Sets the content between two balanced tags.
+		 *
+		 * @access private
+		 *
+		 * @param string $new_content The string to replace the content between the matching tags.
+		 * @return bool Whether the content was successfully replaced.
+		 */
+		public function set_content_between_balanced_tags( string $new_content ): bool {
+			$this->get_updated_html();
+
+			$bookmarks = $this->get_balanced_tag_bookmarks();
+			if ( ! $bookmarks ) {
+				return false;
+			}
+			list( $start_name, $end_name ) = $bookmarks;
+
+			$start = $this->bookmarks[ $start_name ]->start + $this->bookmarks[ $start_name ]->length + 1;
+			$end   = $this->bookmarks[ $end_name ]->start;
+
+			$this->seek( $start_name );
+			$this->release_bookmark( $start_name );
+			$this->release_bookmark( $end_name );
+
+			$this->lexical_updates[] = new Gutenberg_HTML_Text_Replacement_6_5( $start, $end - $start, esc_html( $new_content ) );
+			return true;
+		}
+
+		/**
+		 * Returns a pair of bookmarks for the current opening tag and the matching
+		 * closing tag.
+		 *
+		 * @return array|null A pair of bookmarks, or null if there's no matching closing tag.
+		 */
+		private function get_balanced_tag_bookmarks() {
+			static $i   = 0;
+			$start_name = 'start_of_balanced_tag_' . ++$i;
+
+			$this->set_bookmark( $start_name );
+			if ( ! $this->next_balanced_closer() ) {
+				$this->release_bookmark( $start_name );
+				return null;
+			}
+
+			$end_name = 'end_of_balanced_tag_' . ++$i;
+			$this->set_bookmark( $end_name );
+
+			return array( $start_name, $end_name );
+		}
+
+		/**
+		 * Finds the matching closing tag for an opening tag.
+		 *
+		 * When called while the processor is on an open tag, it traverses the HTML
+		 * until it finds the matching closing tag, respecting any in-between content,
+		 * including nested tags of the same name. Returns false when called on a
+		 * closing or void tag, or if no matching closing tag was found.
+		 *
+		 * @return bool Whether a matching closing tag was found.
+		 */
+		private function next_balanced_closer(): bool {
+			$depth    = 0;
+			$tag_name = $this->get_tag();
+
+			if ( $this->is_void() ) {
+				return false;
+			}
+
+			while ( $this->next_tag(
+				array(
+					'tag_name'    => $tag_name,
+					'tag_closers' => 'visit',
+				)
+			) ) {
+				if ( ! $this->is_tag_closer() ) {
+					++$depth;
+					continue;
+				}
+
+				if ( 0 === $depth ) {
+					return true;
+				}
+
+				--$depth;
+			}
+
+			return false;
+		}
+
+		/**
+		 * Checks whether the current tag is void.
+		 *
+		 * @access private
+		 *
+		 * @return bool Whether the current tag is void or not.
+		 */
+		public function is_void(): bool {
+			$tag_name = $this->get_tag();
+			return Gutenberg_HTML_Processor_6_5::is_void( null !== $tag_name ? $tag_name : '' );
+		}
+	}
+}