File "atomic-global-styles.php"

Full Path: /home/buyiwexj/public_html/wp-content/plugins/elementor/modules/global-classes/atomic-global-styles.php
File size: 13 KB
MIME-type: text/x-php
Charset: utf-8

<?php

namespace Elementor\Modules\GlobalClasses;

use Elementor\Modules\AtomicWidgets\Styles\CacheValidity\Cache_Validity;
use Elementor\Plugin;
use Elementor\Modules\AtomicWidgets\Styles\Atomic_Styles_Manager;

class Atomic_Global_Styles {
	const STYLES_KEY = 'global';
	const RELATED_KEY = 'related';
	const RELATED_REVERSE_KEY = 'related-reverse';

	private Global_Classes_Relations $relations;

	public function __construct( Global_Classes_Relations $relations ) {
		$this->relations = $relations;
	}

	public function register_hooks() {
		add_action(
			'elementor/atomic-widgets/styles/register',
			fn( Atomic_Styles_Manager $styles_manager, array $post_ids ) => $this->register_styles( $styles_manager, $post_ids ),
			20,
			2
		);

		add_action(
			'elementor/global_classes/update',
			fn( string $context, array $changes ) => $this->invalidate_cache_for_updated_classes( $context, $changes ),
			10,
			2
		);

		add_action(
			'deleted_post',
			fn( $post_id ) => $this->on_kit_delete( $post_id )
		);

		add_action(
			'elementor/core/files/clear_cache',
			fn() => $this->invalidate_all_cache(),
		);

		add_filter(
			'elementor/atomic-widgets/settings/transformers/classes',
			fn( $value ) => $this->transform_classes_names( $value )
		);

		add_action(
			'elementor/document/after_save',
			fn( $document ) => $this->on_document_save( $document )
		);
	}

	private function register_styles( Atomic_Styles_Manager $styles_manager, array $post_ids ) {
		$context = $this->get_context();

		$parent_to_embedded = [];
		$visited = [];

		foreach ( $post_ids as $post_id ) {
			$this->resolve_embedded_post_descendants( (int) $post_id, $parent_to_embedded, $visited );
		}

		$this->persist_relation_maps( $parent_to_embedded, $context );

		$all_embedded = [];
		foreach ( $parent_to_embedded as $children ) {
			$all_embedded = array_merge( $all_embedded, $children );
		}
		$all_embedded = array_flip( array_unique( $all_embedded ) ); // use as set

		foreach ( $post_ids as $post_id ) {
			$post_id_int = (int) $post_id;

			if ( isset( $all_embedded[ $post_id_int ] ) ) {
				// This post is embedded inside another rendered post – skip it so
				// it doesn't produce its own global-{id}-*.css file.
				continue;
			}

			$embedded_ids = $parent_to_embedded[ $post_id_int ] ?? [];
			$aggregate_ids = array_merge( [ $post_id_int ], $embedded_ids );

			$get_styles = fn() => $this->get_document_global_styles( $aggregate_ids, $context );

			$styles_manager->register(
				[ $this->get_cache_root_key(), $post_id, $context ],
				$get_styles
			);
		}
	}

	/**
	 * Recursively resolve embedded post descendants for a parent post id.
	 *
	 * Applies the `elementor/document/related_posts` filter transitively and
	 * guards against cycles with the shared $visited set.
	 *
	 * @param int              $pid                 Parent post id being inspected.
	 * @param array<int,int[]> $parent_to_embedded  Accumulated forward map.
	 * @param array<int,true>  $visited             Cycle guard.
	 * @return int[] Embedded descendant post ids to merge into $pid's global styles.
	 */
	private function resolve_embedded_post_descendants( int $pid, array &$parent_to_embedded, array &$visited ): array {
		if ( isset( $visited[ $pid ] ) ) {
			return $parent_to_embedded[ $pid ] ?? [];
		}

		$visited[ $pid ] = true;

		$related = (array) apply_filters( 'elementor/document/related_posts', [], $pid );
		$related = array_values( array_unique( array_map( 'intval', array_filter( $related, 'is_numeric' ) ) ) );

		$all_related = $related;

		foreach ( $related as $related_post ) {
			$further_related_posts = $this->resolve_embedded_post_descendants( $related_post, $parent_to_embedded, $visited );
			$all_related = array_values( array_unique( array_merge( $all_related, $further_related_posts ) ) );
		}

		$parent_to_embedded[ $pid ] = $all_related;

		return $all_related;
	}

	/**
	 * Returns the merged, ordered global class styles for one or more post ids.
	 *
	 * @param int[]  $post_ids One or more post ids whose classes should be merged.
	 * @param string $context  Frontend or preview context.
	 * @return array           Ordered style items ready for serialization.
	 */
	private function get_document_global_styles( array $post_ids, string $context ): array {
		$is_preview = Global_Classes_Repository::CONTEXT_PREVIEW === $context;

		$class_ids = [];
		foreach ( $post_ids as $pid ) {
			$ids = $this->relations->set_preview( $is_preview )->get_styles_by_post( (int) $pid );
			$class_ids = array_merge( $class_ids, $ids );
		}
		$class_ids = array_values( array_unique( $class_ids ) );

		if ( empty( $class_ids ) ) {
			return [];
		}

		$repository = Global_Classes_Repository::make();

		if ( $is_preview ) {
			$repository->set_preview( true );
		}

		$global_order = $repository->all_labels();
		$ordered_class_ids = array_values( array_intersect( array_keys( $global_order ), $class_ids ) );

		if ( empty( $ordered_class_ids ) ) {
			return [];
		}

		$items = $repository->get_by_ids( $ordered_class_ids );
		$reversed_order = array_reverse( $ordered_class_ids );

		$styles = [];

		foreach ( $reversed_order as $class_id ) {
			$item = $items[ $class_id ] ?? null;

			if ( ! $item ) {
				continue;
			}

			$resolved_label = $global_order[ $class_id ] ?? $item['label'];
			$item['id'] = $resolved_label;
			$item['label'] = $resolved_label;
			$styles[] = $item;
		}

		return $styles;
	}

	/**
	 * Persist the parent-to-child and child-to-parent relation maps.
	 *
	 * @param array<int,int[]> $parent_to_embedded Forward map: parent_id => child_ids[].
	 */
	private function persist_relation_maps( array $parent_to_embedded, string $context ): void {
		$cache_validity = new Cache_Validity();

		foreach ( $parent_to_embedded as $parent => $new_children ) {
			$forward_path = [ $this->get_cache_root_key( self::RELATED_KEY ), $parent, $context ];

			$old_related_posts = array_map( 'intval', (array) ( $cache_validity->get_meta( $forward_path ) ?? [] ) );
			$new_related_posts = array_map( 'intval', $new_children );

			$added_posts = array_diff( $new_related_posts, $old_related_posts );
			$removed_posts = array_diff( $old_related_posts, $new_related_posts );

			$cache_validity->validate( $forward_path, $new_related_posts );

			foreach ( $added_posts as $added_post ) {
				$this->add_reverse_relation( $cache_validity, $added_post, $parent, $context );
			}
			foreach ( $removed_posts as $removed_post ) {
				$this->remove_reverse_relation( $cache_validity, $removed_post, $parent, $context );
			}
		}
	}

	private function add_reverse_relation( Cache_Validity $cache_validity, int $child, int $parent, string $context ): void {
		$reverse_path = [ $this->get_cache_root_key( self::RELATED_REVERSE_KEY ), $child, $context ];

		$existing = array_map( 'intval', (array) ( $cache_validity->get_meta( $reverse_path ) ?? [] ) );

		if ( in_array( $parent, $existing, true ) ) {
			return;
		}

		$cache_validity->validate( $reverse_path, array_values( array_merge( $existing, [ $parent ] ) ) );
	}

	private function remove_reverse_relation( Cache_Validity $cache_validity, int $child, int $parent, string $context ): void {
		$reverse_path = [ $this->get_cache_root_key( self::RELATED_REVERSE_KEY ), $child, $context ];

		$existing = array_map( 'intval', (array) ( $cache_validity->get_meta( $reverse_path ) ?? [] ) );
		$pruned   = array_values( array_filter( $existing, fn( int $p ) => $p !== $parent ) );

		$cache_validity->validate( $reverse_path, $pruned );
	}

	/**
	 * Look up all parent post ids that declared $child_post_id as embedded.
	 *
	 * @param int $child_post_id
	 * @return int[]
	 */
	private function get_parent_post_ids( int $child_post_id, string $context ): array {
		$cache_validity = new Cache_Validity();

		$parents = $cache_validity->get_meta( [
			$this->get_cache_root_key( self::RELATED_REVERSE_KEY ),
			$child_post_id,
			$context,
		] );

		if ( ! is_array( $parents ) ) {
			return [];
		}

		return array_values( array_unique( array_map( 'intval', $parents ) ) );
	}

	/**
	 * Walk the reverse relation map transitively to collect every ancestor
	 * post that embeds $post_id (direct parent, grandparent, etc.).
	 *
	 * @param int $post_id
	 * @return int[]
	 */
	private function get_ancestor_post_ids( int $post_id, string $context ): array {
		$ancestors = [];
		$visited = [];
		$queue = [ $post_id ];

		while ( ! empty( $queue ) ) {
			$current = array_shift( $queue );

			foreach ( $this->get_parent_post_ids( $current, $context ) as $parent_id ) {
				if ( isset( $visited[ $parent_id ] ) ) {
					continue;
				}

				$visited[ $parent_id ] = true;
				$ancestors[] = $parent_id;
				$queue[] = $parent_id;
			}
		}

		return array_values( array_unique( array_map( 'intval', $ancestors ) ) );
	}

	private function on_kit_delete( $post_id ) {
		if ( ! Plugin::$instance->kits_manager->is_kit( $post_id ) ) {
			return;
		}

		$this->invalidate_all_cache();
	}

	/**
	 * When an embedded post (component/template) is saved, its own CSS cache
	 * is cleared by Global_Classes_Relations.  We additionally need to clear
	 * the parent's global CSS so it is regenerated with the updated child content.
	 */
	private function on_document_save( $document ): void {
		$post_id = (int) $document->get_main_id();
		$context = $this->get_context();

		$cache_validity = new Cache_Validity();
		$cache_validity->invalidate( [ $this->get_cache_root_key( self::RELATED_KEY ), $post_id, $context ] );

		foreach ( $this->get_ancestor_post_ids( $post_id, $context ) as $ancestor_id ) {
			$this->invalidate_document_cache( $ancestor_id, $context );

			$cache_validity->invalidate( [ $this->get_cache_root_key( self::RELATED_KEY ), $ancestor_id, $context ] );
		}
	}

	private function invalidate_cache_for_updated_classes( string $context, array $changes ) {
		if ( isset( $changes['order'] ) && $changes['order'] ) {
			$this->invalidate_all_cache( $context );

			return;
		}

		$affected = array_unique( array_merge(
			$changes['added'] ?? [],
			$changes['deleted'] ?? [],
			$changes['modified'] ?? []
		) );

		if ( empty( $affected ) ) {
			return;
		}

		$document_ids = [];
		$is_preview = Global_Classes_Repository::CONTEXT_PREVIEW === $context;

		if ( ! empty( $changes['affected_post_ids'] ) ) {
			foreach ( $changes['affected_post_ids'] as $post_id ) {
				$document_ids[ (int) $post_id ] = true;
			}
		}

		foreach ( $affected as $class_id ) {
			foreach ( $this->relations->set_preview( $is_preview )->get_posts_by_style( $class_id ) as $doc_id ) {
				$document_ids[ $doc_id ] = true;
			}
		}

		if ( empty( $document_ids ) ) {
			return;
		}

		// Also include ancestor posts of the directly-affected documents so that
		// aggregated CSS bundles are regenerated when a descendant class changes.
		$with_parents = $document_ids;
		foreach ( array_keys( $document_ids ) as $doc_id ) {
			foreach ( $this->get_ancestor_post_ids( (int) $doc_id, $context ) as $ancestor_id ) {
				$with_parents[ $ancestor_id ] = true;
			}
		}

		foreach ( array_keys( $with_parents ) as $post_id ) {
			$this->invalidate_document_cache( $post_id, $context );
		}
	}

	private function invalidate_document_cache( int $post_id, ?string $context = null ) {
		if ( empty( $context ) ) {
			do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key(), $post_id ] );
			do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key( self::RELATED_KEY ), $post_id ] );
			do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key( self::RELATED_REVERSE_KEY ), $post_id ] );
		} else {
			do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key(), $post_id, $context ] );
			do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key( self::RELATED_KEY ), $post_id, $context ] );
			do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key( self::RELATED_REVERSE_KEY ), $post_id, $context ] );
		}
	}

	private function invalidate_all_cache( ?string $context = null ) {
		if ( empty( $context ) || Global_Classes_Repository::CONTEXT_FRONTEND === $context ) {
			do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key() ] );

			$cache_validity = new Cache_Validity();
			$cache_validity->invalidate( [ $this->get_cache_root_key( self::RELATED_KEY ) ] );
			$cache_validity->invalidate( [ $this->get_cache_root_key( self::RELATED_REVERSE_KEY ) ] );

			return;
		}

		do_action( 'elementor/atomic-widgets/styles/clear', [ $this->get_cache_root_key(), $context ] );
	}

	private function transform_classes_names( $ids ) {

		$labels = Global_Classes_Repository::make()
			->set_preview( $this->is_preview() )
			->all_labels();

		return array_map(
			static function( $id ) use ( $labels ) {
				return $labels[ $id ] ?? $id;
			},
			$ids
		);
	}

	private function get_context(): string {
		return $this->is_preview()
			? Global_Classes_Repository::CONTEXT_PREVIEW
			: Global_Classes_Repository::CONTEXT_FRONTEND;
	}

	private function is_preview(): bool {
		return Plugin::$instance->preview->is_editor_or_preview();
	}

	private function get_cache_root_key( string $key = null ): string {
		return $key ? self::STYLES_KEY . '_' . $key : self::STYLES_KEY;
	}
}