<?php
/**
 * Module: BackgroundStyle class.
 *
 * @package Divi
 * @since ??
 */

namespace ET\Builder\Packages\Module\Options\Background;

if ( ! defined( 'ABSPATH' ) ) {
	die( 'Direct access forbidden.' );
}

use ET\Builder\Packages\GlobalData\GlobalData;
use ET\Builder\Packages\ModuleUtils\ModuleUtils;
use ET\Builder\Packages\StyleLibrary\Declarations\Background\Background;
use ET\Builder\Packages\Module\Options\Background\BackgroundUtils;
use ET\Builder\Packages\Module\Layout\Components\Style\Utils\Utils;
use ET\Builder\Framework\Breakpoint\Breakpoint;

/**
 * BackgroundStyle class.
 *
 * This class provides a set of background style options.
 *
 * @since ??
 */
class BackgroundStyle {

	/**
	 * Get background style component.
	 *
	 * This function is equivalent of JS function:
	 * {@link /docs/builder-api/js-beta/divi-module/functions/BackgroundStyle BackgroundStyle} in
	 * `@divi/module` package.
	 *
	 * @since ??
	 *
	 * @param array $args {
	 *     An array of arguments.
	 *
	 *     @type string        $selector                 The CSS selector.
	 *     @type array         $selectors                Optional. An array of selectors for each breakpoint and state. Default `[]`.
	 *     @type callable      $selectorFunction         Optional. The function to be called to generate CSS selector. Default `null`.
	 *     @type array         $propertySelectors        Optional. The property selectors that you want to unpack. Default `[]`.
	 *     @type array         $featureSelectors         Optional. The feature selectors that you want to unpack. Default `[]`.
	 *     @type array         $attr                     An array of module attribute data.
	 *     @type array         $defaultPrintedStyleAttr  Optional. An array of default printed style attribute data. Default `[]`.
	 *     @type array|bool    $important                Optional. Whether to apply "!important" flag to the style declarations.
	 *                                                   Default `false`.
	 *     @type bool          $asStyle                  Optional. Whether to wrap the style declaration with style tag or not.
	 *                                                   Default `true`.
	 *     @type string        $mode                     Optional. The mode of the style. Default `builder`.
	 *     @type string|null   $orderClass               Optional. The selector class name.
	 *     @type bool          $isInsideStickyModule     Optional. Whether the module is inside sticky module or not. Default `false`.
	 *     @type string|null   $stickyParentOrderClass   Optional. The sticky parent order class name. Default `null`.
	 *     @type string        $attrs_json               Optional. The JSON string of module attribute data, use to improve performance.
	 *     @type string        $returnType               Optional. This is the type of value that the function will return.
	 *                                                   Can be either `string` or `array`. Default `array`.
	 *     @type string        $atRules                  Optional. CSS at-rules to wrap the style declarations in. Default `''`.
	 *     @type bool          $hasBackgroundPresets     Optional. Whether background presets are actively applied. Default `false`.
	 *     @type bool          $hasDefaultBackground     Optional. Whether the module has a default render background. Default `false`.
	 * }
	 *
	 * @return string|array The background style component.
	 *
	 * @example:
	 * ```php
	 * // Apply style using default arguments.
	 * $args = [];
	 * $style = BackgroundStyle::style( $args );
	 *
	 * // Apply style with specific selectors and properties.
	 * $args = [
	 *     'selectors' => [
	 *         '.element1',
	 *         '.element2',
	 *     ],
	 *     'propertySelectors' => [
	 *         '.element1 .property1',
	 *         '.element2 .property2',
	 *     ]
	 * ];
	 * $style = BackgroundStyle::style( $args );
	 * ```
	 */
	public static function style( array $args ) {
		$args = wp_parse_args(
			$args,
			[
				'selectors'              => [],
				'selectorFunction'       => null,
				'propertySelectors'      => [],
				'featureSelectors'       => null,
				'important'              => false,
				'asStyle'                => true,
				'mode'                   => 'builder',
				'orderClass'             => null,
				'attrs_json'             => null,
				'returnType'             => 'array',
				'atRules'                => '',
				'hasBackgroundPresets'   => false,
				'hasDefaultBackground'   => false,
				'isInsideStickyModule'   => false,
				'stickyParentOrderClass' => null,
			]
		);

		$selector           = $args['selector'];
		$selectors          = $args['selectors'];
		$selector_function  = $args['selectorFunction'];
		$property_selectors = $args['propertySelectors'];
		$feature_selectors  = $args['featureSelectors'];
		$attr               = ModuleUtils::get_and_inherit_background_attr(
			[
				'attr'                 => $args['attr'] ?? [],
				'hasBackgroundPresets' => $args['hasBackgroundPresets'] ?? false,
			]
		);

		/**
		 * Apply hybrid inheritance transform override logic for mask and pattern.
		 *
		 * CRITICAL: This complex override is necessary because background attributes require
		 * different inheritance behaviors for different properties:
		 *
		 * 1. OBJECT MERGING (enabled, style, color): Use 'getAndInheritAll' to merge properties
		 *    from larger breakpoints. Example: Desktop has color="#ff0000", tablet adds
		 *    style="chevrons" → tablet gets both color and style.
		 *
		 * 2. ARRAY OVERRIDING (transform): Use 'getOrInheritAll' semantics to completely
		 *    replace arrays. Example: Desktop has transform=["invert"], phone sets
		 *    transform=[] → phone should show NO invert, not merge with desktop.
		 *
		 * The standard get_and_inherit_background_attr() uses 'getOrInheritClosest' mode which
		 * doesn't handle this hybrid requirement. Empty arrays [] are intentional overrides
		 * that must replace inherited values, not be treated as "no value set".
		 *
		 * Without this override: Phone with transform=[] would inherit desktop's ["invert"]
		 * With this override: Phone with transform=[] correctly shows no transforms.
		 */
		$original_attr       = $args['attr'] ?? [];
		$base_breakpoint     = Breakpoint::get_base_breakpoint_name();
		$breakpoint_names    = Breakpoint::get_enabled_breakpoint_names();
		$states              = [ 'value', 'hover' ];
		$find_inherited_type = static function ( $breakpoint, $state, $type ) use ( $attr, $base_breakpoint, $breakpoint_names ) {
			$current_breakpoint = $breakpoint;
			$current_state      = $state;

			while ( true ) {
				$parent_breakpoint = ModuleUtils::get_inherit_breakpoint(
					[
						'breakpoint'      => $current_breakpoint,
						'state'           => $current_state,
						'baseBreakpoint'  => $base_breakpoint,
						'breakpointNames' => $breakpoint_names,
					]
				);
				$parent_state      = ModuleUtils::get_inherit_state(
					[
						'breakpoint'      => $current_breakpoint,
						'state'           => $current_state,
						'baseBreakpoint'  => $base_breakpoint,
						'breakpointNames' => $breakpoint_names,
					]
				);

				if ( $parent_breakpoint === $current_breakpoint && $parent_state === $current_state ) {
					return [];
				}

				$parent_type = $attr[ $parent_breakpoint ][ $parent_state ][ $type ] ?? [];
				if ( ! empty( $parent_type ) ) {
					return $parent_type;
				}

				$current_breakpoint = $parent_breakpoint;
				$current_state      = $parent_state;
			}
		};

		foreach ( $breakpoint_names as $breakpoint ) {
			foreach ( $states as $state ) {
				// Apply transform override for mask and pattern.
				// Empty arrays [] are intentional overrides that must replace inherited values.
				foreach ( [ 'mask', 'pattern' ] as $type ) {
					$transform_override = $original_attr[ $breakpoint ][ $state ][ $type ]['transform'] ?? null;
					if ( null !== $transform_override ) {
						// Ensure breakpoint, state, and type objects exist before applying override.
						$attr[ $breakpoint ]           = $attr[ $breakpoint ] ?? [];
						$attr[ $breakpoint ][ $state ] = $attr[ $breakpoint ][ $state ] ?? [];
						$current_type                  = $attr[ $breakpoint ][ $state ][ $type ] ?? [];

						// If type object is empty, inherit from the closest non-empty breakpoint.
						if ( empty( $current_type ) ) {
							$inherited_type = $find_inherited_type( $breakpoint, $state, $type );
							if ( ! empty( $inherited_type ) ) {
								$current_type = $inherited_type;
							}
						}

						$current_type['transform']              = $transform_override;
						$attr[ $breakpoint ][ $state ][ $type ] = $current_type;
					}
				}
			}
		}

		$important              = $args['important'];
		$mode                   = $args['mode'];
		$order_class            = $args['orderClass'];
		$return_as_array        = 'array' === $args['returnType'];
		$at_rules               = $args['atRules'];
		$has_background_presets = $args['hasBackgroundPresets'];
		$has_default_background = $args['hasDefaultBackground'];
		$children               = $return_as_array ? [] : '';

		$is_inside_sticky_module   = $args['isInsideStickyModule'];
		$sticky_parent_order_class = $args['stickyParentOrderClass'];

		// Bail, if noting is there to process.
		if ( empty( $attr ) ) {
			return $children;
		}

		// If attrs_json is provided use that, otherwise JSON encode the attributes array.
		$attr_json = null === $args['attrs_json'] ? wp_json_encode( $attr ) : $args['attrs_json'];

		// Check if a module attribute has a color, gradient or image.
		$has_background = strpos( $attr_json, '"gradient"' ) || strpos( $attr_json, '"color"' ) || strpos( $attr_json, '"image"' );

		// Create a copy of the attribute because it will be modified.
		$formatted_attr             = $attr;
		$default_printed_style_attr = $args['defaultPrintedStyleAttr'] ?? [];

		if ( ! empty( $default_printed_style_attr ) && is_array( $formatted_attr ) ) {
			foreach ( $formatted_attr as $breakpoint => $state_values ) {
				if ( is_array( $state_values ) ) {
					foreach ( $state_values as $state => $attr_value ) {
						$default_printed_color = $default_printed_style_attr[ $breakpoint ][ $state ]['color'] ?? null;

						// If color is empty string and there's a preset color, convert to transparent.
						if ( '' === ( $attr_value['color'] ?? null ) &&
							is_string( $default_printed_color ) &&
							'' !== $default_printed_color ) {
							$formatted_attr[ $breakpoint ][ $state ]['color'] = 'transparent';
						}
					}
				}
			}
		}

		// This ensures the transparent background overrides the default background CSS.
		if ( $has_default_background && is_array( $formatted_attr ) ) {
			foreach ( $formatted_attr as $breakpoint => $state_values ) {
				if ( is_array( $state_values ) ) {
					foreach ( $state_values as $state => $attr_value ) {
						// If color is empty string and module has default background, apply !important.
						if ( '' === ( $attr_value['color'] ?? null ) ) {
							$formatted_attr[ $breakpoint ][ $state ]['color'] = 'transparent';
						}
					}
				}
			}
		}

		$children_background = $has_background ? Utils::style_statements(
			[
				'selectors'               => ! empty( $selectors ) ? $selectors : [ 'desktop' => [ 'value' => $selector ] ],
				'selectorFunction'        => $selector_function,
				'propertySelectors'       => $property_selectors,
				'attr'                    => $formatted_attr,
				'defaultPrintedStyleAttr' => $args['defaultPrintedStyleAttr'] ?? [],
				'important'               => $important,
				'mode'                    => $mode,
				'declarationFunction'     => function ( $props ) use ( $has_background_presets ) {
					return Background::style_declaration(
						array_merge(
							$props,
							[
								'defaultAttr'          => [
									'gradient' => Background::$background_default_attr['gradient'] ?? null,
								],
								'hasBackgroundPresets' => $has_background_presets,
							]
						)
					);
				},
				'orderClass'              => $order_class,
				'isInsideStickyModule'    => $is_inside_sticky_module,
				'stickyParentOrderClass'  => $sticky_parent_order_class,
				'returnType'              => $args['returnType'],
				'atRules'                 => $at_rules,

			]
		) : null;

		if ( $children_background && $return_as_array ) {
			array_push( $children, ...$children_background );
		} elseif ( $children_background ) {
			$children .= $children_background;
		}

		// Check if a module attribute has a mask.
		$has_mask            = (bool) strpos( $attr_json, 'mask' );
		$children_background = $has_mask ? Utils::style_statements(
			[
				'selectors'              => $feature_selectors['mask']
											?? BackgroundUtils::get_background_mask_selectors( $selector ),
				'attr'                   => $attr,
				'important'              => $important,
				'mode'                   => $mode,
				'declarationFunction'    => function ( $props ) {
					// Below we check if the mask color value is a global color value i.e a CSS variable or $variable syntax.
					// If it is a global color value, we get the HEX/RGBA color value from the global colors store.
					// We cannot use CSS variables as dynamic values in SVGs (usage in `backgroundMaskStyleDeclaration`).
					// So we need to replace the CSS variable with the actual color value.
					// see https://chatgpt.com/share/66fc3ee3-b810-8004-80e4-660256d8361c and  https://stackoverflow.com/a/42331003.
					$background_mask_color = $props['attrValue']['mask']['color'] ?? '';

					if ( ! empty( $background_mask_color ) ) {
						// Check if this is a complex CSS relative HSL or $variable syntax - use new method.
						if ( false !== strpos( $background_mask_color, '$variable(' ) || false !== strpos( $background_mask_color, 'hsl(from ' ) ) {
							// Use new method for $variable syntax and CSS relative HSL.
							$resolved_color = GlobalData::resolve_global_color_variable( $background_mask_color );

							if ( $resolved_color !== $background_mask_color ) {
								$props['attrValue']['mask']['color'] = $resolved_color;
							}
						} else {
							// Try the original method for simple CSS variables like var(--gcid-xxx).
							$global_color_id = GlobalData::get_global_color_id_from_value( $background_mask_color );

							if ( $global_color_id ) {
								// Original method: handle simple CSS variables.
								$mask_color = GlobalData::get_global_color_by_id( $global_color_id )['color'] ?? '';

								if ( ! empty( $mask_color ) ) {
									$props['attrValue']['mask']['color'] = $mask_color;
								}
							}
						}
					}

					return Background::background_mask_style_declaration( $props );
				},
				'orderClass'             => $order_class,
				'isInsideStickyModule'   => $is_inside_sticky_module,
				'stickyParentOrderClass' => $sticky_parent_order_class,
				'returnType'             => $args['returnType'],
			]
		) : null;

		if ( $children_background && $return_as_array ) {
			array_push( $children, ...$children_background );
		} elseif ( $children_background ) {
			$children .= $children_background;
		}

		// Check if a module attribute has a pattern.
		$has_pattern         = (bool) strpos( $attr_json, 'pattern' );
		$children_background = $has_pattern ? Utils::style_statements(
			[
				'selectors'              => $feature_selectors['pattern']
											?? BackgroundUtils::get_background_pattern_selectors( $selector ),
				'attr'                   => $attr,
				'important'              => $important,
				'mode'                   => $mode,
				'declarationFunction'    => function ( $props ) {
					// Below we check if the pattern color value is a global color value i.e a CSS variable or $variable syntax.
					// If it is a global color value, we get the HEX/RGBA color value from the global colors store.
					// We cannot use CSS variables as dynamic values in SVGs (usage in `backgroundPatternStyleDeclaration`).
					// So we need to replace the CSS variable with the actual color value.
					// see https://chatgpt.com/share/66fc3ee3-b810-8004-80e4-660256d8361c and  https://stackoverflow.com/a/42331003.
					$background_pattern_color = $props['attrValue']['pattern']['color'] ?? '';

					if ( ! empty( $background_pattern_color ) ) {
						// Check if this is a complex CSS relative HSL or $variable syntax - use new method.
						if ( false !== strpos( $background_pattern_color, '$variable(' ) || false !== strpos( $background_pattern_color, 'hsl(from ' ) ) {
							// Use new method for $variable syntax and CSS relative HSL.
							$resolved_color = GlobalData::resolve_global_color_variable( $background_pattern_color );

							if ( $resolved_color !== $background_pattern_color ) {
								$props['attrValue']['pattern']['color'] = $resolved_color;
							}
						} else {
							// Try the original method for simple CSS variables like var(--gcid-xxx).
							$global_color_id = GlobalData::get_global_color_id_from_value( $background_pattern_color );

							if ( $global_color_id ) {
								// Original method: handle simple CSS variables.
								$pattern_color = GlobalData::get_global_color_by_id( $global_color_id )['color'] ?? '';

								if ( ! empty( $pattern_color ) ) {
									$props['attrValue']['pattern']['color'] = $pattern_color;
								}
							}
						}
					}

					return Background::background_pattern_style_declaration( $props );
				},
				'orderClass'             => $order_class,
				'isInsideStickyModule'   => $is_inside_sticky_module,
				'stickyParentOrderClass' => $sticky_parent_order_class,
				'returnType'             => $args['returnType'],
			]
		) : null;

		if ( $children_background && $return_as_array ) {
			array_push( $children, ...$children_background );
		} elseif ( $children_background ) {
			$children .= $children_background;
		}

		return Utils::style_wrapper(
			[
				'attr'     => $attr,
				'children' => $children,
			]
		);
	}
}