<?php

[0] Fix | Delete

[1] Fix | Delete

namespace Elementor\Modules\Components;

[2] Fix | Delete

[3] Fix | Delete

use Elementor\Core\Utils\Collection;

[4] Fix | Delete

use Elementor\Modules\Components\Documents\Component as Component_Document;

[5] Fix | Delete

use Elementor\Plugin;

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

class Circular_Dependency_Validator {

[12] Fix | Delete

const COMPONENT_WIDGET_TYPE = 'e-component';

[13] Fix | Delete

const MAX_RECURSION_DEPTH = 50;

[14] Fix | Delete

[15] Fix | Delete

private array $components_cache = [];

[16] Fix | Delete

[17] Fix | Delete

public static function make(): Circular_Dependency_Validator {

[18] Fix | Delete

return new self();

[19] Fix | Delete

}

[20] Fix | Delete

[21] Fix | Delete

public function validate( $component_id, array $elements, array $unsaved_components = [] ): array {

[22] Fix | Delete

$inner_components_ids = $this->get_inner_component_ids( $elements );

[23] Fix | Delete

[24] Fix | Delete

if ( in_array( $component_id, $inner_components_ids, false ) ) {

[25] Fix | Delete

return $this->build_error_response( $component_id );

[26] Fix | Delete

}

[27] Fix | Delete

[28] Fix | Delete

foreach ( $inner_components_ids as $ref_id ) {

[29] Fix | Delete

if ( $this->is_component_eventually_contains( $ref_id, $component_id, $unsaved_components, [] ) ) {

[30] Fix | Delete

return $this->build_error_response( $component_id, $ref_id );

[31] Fix | Delete

}

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

return [

[35] Fix | Delete

'success' => true,

[36] Fix | Delete

'messages' => [],

[37] Fix | Delete

];

[38] Fix | Delete

}

[39] Fix | Delete

[40] Fix | Delete

public function validate_new_components( Collection $items ): array {

[41] Fix | Delete

$unsaved_components = [];

[42] Fix | Delete

[43] Fix | Delete

foreach ( $items->all() as $item ) {

[44] Fix | Delete

$unsaved_components[ $item['uid'] ] = $item['elements'] ?? [];

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

foreach ( $unsaved_components as $uid => $elements ) {

[48] Fix | Delete

$result = $this->validate( $uid, $elements, $unsaved_components );

[49] Fix | Delete

[50] Fix | Delete

if ( ! $result['success'] ) {

[51] Fix | Delete

return $result;

[52] Fix | Delete

}

[53] Fix | Delete

}

[54] Fix | Delete

[55] Fix | Delete

return [

[56] Fix | Delete

'success' => true,

[57] Fix | Delete

'messages' => [],

[58] Fix | Delete

];

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

private function is_component_eventually_contains( $component_id, $forbidden_id, array $unsaved_components, array $visited_path ): bool {

[62] Fix | Delete

if ( in_array( $component_id, $visited_path, false ) ) {

[63] Fix | Delete

return false;

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

if ( count( $visited_path ) >= self::MAX_RECURSION_DEPTH ) {

[67] Fix | Delete

return false;

[68] Fix | Delete

}

[69] Fix | Delete

[70] Fix | Delete

$elements = $this->get_elements_for_component( $component_id, $unsaved_components );

[71] Fix | Delete

[72] Fix | Delete

if ( empty( $elements ) ) {

[73] Fix | Delete

return false;

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

$nested_ids = $this->get_inner_component_ids( $elements );

[77] Fix | Delete

[78] Fix | Delete

if ( in_array( $forbidden_id, $nested_ids, false ) ) {

[79] Fix | Delete

return true;

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

$visited_path[] = $component_id;

[83] Fix | Delete

[84] Fix | Delete

foreach ( $nested_ids as $nested_id ) {

[85] Fix | Delete

if ( $this->is_component_eventually_contains( $nested_id, $forbidden_id, $unsaved_components, $visited_path ) ) {

[86] Fix | Delete

return true;

[87] Fix | Delete

}

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

return false;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

private function get_elements_for_component( $component_id, array $unsaved_components ): array {

[94] Fix | Delete

if ( isset( $unsaved_components[ $component_id ] ) ) {

[95] Fix | Delete

return $unsaved_components[ $component_id ];

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

return $this->get_component_elements( $component_id );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

private function get_component_elements( $component_id ): array {

[102] Fix | Delete

if ( ! is_int( $component_id ) ) {

[103] Fix | Delete

return [];

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

if ( isset( $this->components_cache[ $component_id ] ) ) {

[107] Fix | Delete

return $this->components_cache[ $component_id ];

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

$doc = Plugin::$instance->documents->get( $component_id );

[111] Fix | Delete

[112] Fix | Delete

if ( ! $doc instanceof Component_Document ) {

[113] Fix | Delete

$this->components_cache[ $component_id ] = [];

[114] Fix | Delete

return [];

[115] Fix | Delete

}

[116] Fix | Delete

[117] Fix | Delete

$elements = $doc->get_elements_data();

[118] Fix | Delete

$this->components_cache[ $component_id ] = $elements;

[119] Fix | Delete

[120] Fix | Delete

return $elements;

[121] Fix | Delete

}

[122] Fix | Delete

[123] Fix | Delete

private function get_inner_component_ids( array $elements ): array {

[124] Fix | Delete

$ids = [];

[125] Fix | Delete

[126] Fix | Delete

foreach ( $elements as $element ) {

[127] Fix | Delete

$widget_type = $element['widgetType'] ?? null;

[128] Fix | Delete

[129] Fix | Delete

if ( self::COMPONENT_WIDGET_TYPE === $widget_type ) {

[130] Fix | Delete

$component_id = $this->extract_component_id_from_settings( $element['settings'] ?? [] );

[131] Fix | Delete

[132] Fix | Delete

if ( null !== $component_id ) {

[133] Fix | Delete

$ids[] = $component_id;

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

if ( ! empty( $element['elements'] ) ) {

[138] Fix | Delete

$ids = array_merge( $ids, $this->get_inner_component_ids( $element['elements'] ) );

[139] Fix | Delete

}

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

return array_unique( $ids, SORT_REGULAR );

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

private function extract_component_id_from_settings( array $settings ) {

[146] Fix | Delete

return $settings['component_instance']['value']['component_id']['value'] ?? null;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

private function build_error_response( $component_id, $via_component_id = null ): array {

[150] Fix | Delete

if ( null === $via_component_id ) {

[151] Fix | Delete

$message = sprintf(

[152] Fix | Delete

// translators: %s: Component ID that references itself.

[153] Fix | Delete

esc_html__( 'Circular dependency detected: Component "%s" references itself.', 'elementor' ),

[154] Fix | Delete

$component_id

[155] Fix | Delete

);

[156] Fix | Delete

} else {

[157] Fix | Delete

$message = sprintf(

[158] Fix | Delete

// translators: %1$s: Component ID, %2$s: Component ID that creates the cycle.

[159] Fix | Delete

esc_html__( 'Circular dependency detected: Component "%1$s" would create a cycle via component "%2$s".', 'elementor' ),

[160] Fix | Delete

$component_id,

[161] Fix | Delete

$via_component_id

[162] Fix | Delete

);

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

return [

[166] Fix | Delete

'success' => false,

[167] Fix | Delete

'messages' => [ $message ],

[168] Fix | Delete

];

[169] Fix | Delete

}

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete