<?php

[0] Fix | Delete

namespace Elementor\Modules\DevTools;

[1] Fix | Delete

[2] Fix | Delete

use Elementor\Utils;

[3] Fix | Delete

[4] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[5] Fix | Delete

exit; // Exit if accessed directly.

[6] Fix | Delete

}

[7] Fix | Delete

[8] Fix | Delete

class Deprecation {

[9] Fix | Delete

const SOFT_VERSIONS_COUNT = 4;

[10] Fix | Delete

const HARD_VERSIONS_COUNT = 8;

[11] Fix | Delete

[12] Fix | Delete

private $current_version = null;

[13] Fix | Delete

private $soft_deprecated_notices = [];

[14] Fix | Delete

[15] Fix | Delete

public function __construct( $current_version ) {

[16] Fix | Delete

$this->current_version = $current_version;

[17] Fix | Delete

}

[18] Fix | Delete

[19] Fix | Delete

public function get_settings() {

[20] Fix | Delete

return [

[21] Fix | Delete

'soft_notices' => $this->soft_deprecated_notices,

[22] Fix | Delete

'soft_version_count' => self::SOFT_VERSIONS_COUNT,

[23] Fix | Delete

'hard_version_count' => self::HARD_VERSIONS_COUNT,

[24] Fix | Delete

'current_version' => ELEMENTOR_VERSION,

[25] Fix | Delete

];

[26] Fix | Delete

}

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Get total of major.

[30] Fix | Delete

*

[31] Fix | Delete

* Since `get_total_major` cannot determine how much really versions between 2.9.0 and 3.3.0 if there is 2.10.0 version for example,

[32] Fix | Delete

* versions with major2 more then 9 will be added to total.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 3.1.0

[35] Fix | Delete

*

[36] Fix | Delete

* @param array $parsed_version

[37] Fix | Delete

*

[38] Fix | Delete

* @return int

[39] Fix | Delete

*/

[40] Fix | Delete

public function get_total_major( $parsed_version ) {

[41] Fix | Delete

$major1 = $parsed_version['major1'];

[42] Fix | Delete

$major2 = $parsed_version['major2'];

[43] Fix | Delete

$major2 = $major2 > 9 ? 9 : $major2;

[44] Fix | Delete

$minor = 0;

[45] Fix | Delete

[46] Fix | Delete

$total = intval( "{$major1}{$major2}{$minor}" );

[47] Fix | Delete

[48] Fix | Delete

if ( $total > 99 ) {

[49] Fix | Delete

$total = $total / 10;

[50] Fix | Delete

} else {

[51] Fix | Delete

$total = intval( $total / 10 );

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

if ( $parsed_version['major2'] > 9 ) {

[55] Fix | Delete

$total += $parsed_version['major2'] - 9;

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

return $total;

[59] Fix | Delete

}

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* Get next version.

[63] Fix | Delete

*

[64] Fix | Delete

* @since 3.1.0

[65] Fix | Delete

*

[66] Fix | Delete

* @param string $version

[67] Fix | Delete

* @param int $count

[68] Fix | Delete

*

[69] Fix | Delete

* @return string|false

[70] Fix | Delete

*/

[71] Fix | Delete

public function get_next_version( $version, $count = 1 ) {

[72] Fix | Delete

$version = $this->parse_version( $version );

[73] Fix | Delete

[74] Fix | Delete

if ( ! $version ) {

[75] Fix | Delete

return false;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

$version['total'] = $this->get_total_major( $version ) + $count;

[79] Fix | Delete

[80] Fix | Delete

$total = $version['total'];

[81] Fix | Delete

[82] Fix | Delete

if ( $total > 9 ) {

[83] Fix | Delete

$version['major1'] = intval( $total / 10 );

[84] Fix | Delete

$version['major2'] = $total % 10;

[85] Fix | Delete

} else {

[86] Fix | Delete

$version['major1'] = 0;

[87] Fix | Delete

$version['major2'] = $total;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

$version['minor'] = 0;

[91] Fix | Delete

[92] Fix | Delete

return $this->implode_version( $version );

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

/**

[96] Fix | Delete

* Implode parsed version to string version.

[97] Fix | Delete

*

[98] Fix | Delete

* @since 3.1.0

[99] Fix | Delete

*

[100] Fix | Delete

* @param array $parsed_version

[101] Fix | Delete

*

[102] Fix | Delete

* @return string

[103] Fix | Delete

*/

[104] Fix | Delete

public function implode_version( $parsed_version ) {

[105] Fix | Delete

$major1 = $parsed_version['major1'];

[106] Fix | Delete

$major2 = $parsed_version['major2'];

[107] Fix | Delete

$minor = $parsed_version['minor'];

[108] Fix | Delete

[109] Fix | Delete

return "{$major1}.{$major2}.{$minor}";

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

/**

[113] Fix | Delete

* Parse to an informative array.

[114] Fix | Delete

*

[115] Fix | Delete

* @since 3.1.0

[116] Fix | Delete

*

[117] Fix | Delete

* @param string $version

[118] Fix | Delete

*

[119] Fix | Delete

* @return array|false

[120] Fix | Delete

*/

[121] Fix | Delete

public function parse_version( $version ) {

[122] Fix | Delete

$version_explode = explode( '.', $version );

[123] Fix | Delete

$version_explode_count = count( $version_explode );

[124] Fix | Delete

[125] Fix | Delete

if ( $version_explode_count < 3 || $version_explode_count > 4 ) {

[126] Fix | Delete

trigger_error( 'Invalid Semantic Version string provided' );

[127] Fix | Delete

[128] Fix | Delete

return false;

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

list( $major1, $major2, $minor ) = $version_explode;

[132] Fix | Delete

[133] Fix | Delete

$result = [

[134] Fix | Delete

'major1' => intval( $major1 ),

[135] Fix | Delete

'major2' => intval( $major2 ),

[136] Fix | Delete

'minor' => intval( $minor ),

[137] Fix | Delete

];

[138] Fix | Delete

[139] Fix | Delete

if ( $version_explode_count > 3 ) {

[140] Fix | Delete

$result['build'] = $version_explode[3];

[141] Fix | Delete

}

[142] Fix | Delete

[143] Fix | Delete

return $result;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Compare two versions, result is equal to diff of major versions.

[148] Fix | Delete

* Notice: If you want to compare between 2.9.0 and 3.3.0, and there is also a 2.10.0 version, you cannot get the right comparison

[149] Fix | Delete

* Since $this->deprecation->get_total_major cannot determine how much really versions between 2.9.0 and 3.3.0.

[150] Fix | Delete

*

[151] Fix | Delete

* @since 3.1.0

[152] Fix | Delete

*

[153] Fix | Delete

* @param {string} $version1

[154] Fix | Delete

* @param {string} $version2

[155] Fix | Delete

*

[156] Fix | Delete

* @return int|false

[157] Fix | Delete

*/

[158] Fix | Delete

public function compare_version( $version1, $version2 ) {

[159] Fix | Delete

$version1 = self::parse_version( $version1 );

[160] Fix | Delete

$version2 = self::parse_version( $version2 );

[161] Fix | Delete

[162] Fix | Delete

if ( $version1 && $version2 ) {

[163] Fix | Delete

$versions = [ &$version1, &$version2 ];

[164] Fix | Delete

[165] Fix | Delete

foreach ( $versions as &$version ) {

[166] Fix | Delete

$version['total'] = self::get_total_major( $version );

[167] Fix | Delete

}

[168] Fix | Delete

[169] Fix | Delete

return $version1['total'] - $version2['total'];

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete

return false;

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

/**

[176] Fix | Delete

* Check Deprecation

[177] Fix | Delete

*

[178] Fix | Delete

* Checks whether the given entity is valid. If valid, this method checks whether the deprecation

[179] Fix | Delete

* should be soft (browser console notice) or hard (use WordPress' native deprecation methods).

[180] Fix | Delete

*

[181] Fix | Delete

* @since 3.1.0

[182] Fix | Delete

*

[183] Fix | Delete

* @param string $entity - The Deprecated entity (the function/hook itself)

[184] Fix | Delete

* @param string $version

[185] Fix | Delete

* @param string $replacement Optional

[186] Fix | Delete

* @param string $base_version Optional. Default is `null`

[187] Fix | Delete

*

[188] Fix | Delete

* @return bool

[189] Fix | Delete

* @throws \Exception Invalid deprecation.

[190] Fix | Delete

*/

[191] Fix | Delete

private function check_deprecation( $entity, $version, $replacement, $base_version = null ) {

[192] Fix | Delete

if ( null === $base_version ) {

[193] Fix | Delete

$base_version = $this->current_version;

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

$diff = $this->compare_version( $base_version, $version );

[197] Fix | Delete

[198] Fix | Delete

if ( false === $diff ) {

[199] Fix | Delete

throw new \Exception( 'Invalid deprecation diff.' );

[200] Fix | Delete

}

[201] Fix | Delete

[202] Fix | Delete

$print_deprecated = false;

[203] Fix | Delete

[204] Fix | Delete

if ( defined( 'WP_DEBUG' ) && WP_DEBUG && $diff <= self::SOFT_VERSIONS_COUNT ) {

[205] Fix | Delete

// Soft deprecated.

[206] Fix | Delete

if ( ! isset( $this->soft_deprecated_notices[ $entity ] ) ) {

[207] Fix | Delete

$this->soft_deprecated_notices[ $entity ] = [

[208] Fix | Delete

$version,

[209] Fix | Delete

$replacement,

[210] Fix | Delete

];

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

if ( Utils::is_elementor_debug() ) {

[214] Fix | Delete

$print_deprecated = true;

[215] Fix | Delete

}

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

return $print_deprecated;

[219] Fix | Delete

}

[220] Fix | Delete

[221] Fix | Delete

/**

[222] Fix | Delete

* Deprecated Function

[223] Fix | Delete

*

[224] Fix | Delete

* Handles the deprecation process for functions.

[225] Fix | Delete

*

[226] Fix | Delete

* @since 3.1.0

[227] Fix | Delete

*

[228] Fix | Delete

* @param string $function

[229] Fix | Delete

* @param string $version

[230] Fix | Delete

* @param string $replacement Optional. Default is ''

[231] Fix | Delete

* @param string $base_version Optional. Default is `null`

[232] Fix | Delete

* @throws \Exception Deprecation error.

[233] Fix | Delete

*/

[234] Fix | Delete

public function deprecated_function( $function, $version, $replacement = '', $base_version = null ) {

[235] Fix | Delete

$print_deprecated = $this->check_deprecation( $function, $version, $replacement, $base_version );

[236] Fix | Delete

[237] Fix | Delete

if ( $print_deprecated ) {

[238] Fix | Delete

// PHPCS - We need to echo special characters because they can exist in function calls.

[239] Fix | Delete

_deprecated_function( $function, esc_html( $version ), $replacement ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[240] Fix | Delete

}

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

/**

[244] Fix | Delete

* Deprecated Hook

[245] Fix | Delete

*

[246] Fix | Delete

* Handles the deprecation process for hooks.

[247] Fix | Delete

*

[248] Fix | Delete

* @param string $hook

[249] Fix | Delete

* @param string $version

[250] Fix | Delete

* @param string $replacement Optional. Default is ''

[251] Fix | Delete

* @param string $base_version Optional. Default is `null`

[252] Fix | Delete

* @throws \Exception Deprecation error.

[253] Fix | Delete

* @since 3.1.0

[254] Fix | Delete

*/

[255] Fix | Delete

public function deprecated_hook( $hook, $version, $replacement = '', $base_version = null ) {

[256] Fix | Delete

$print_deprecated = $this->check_deprecation( $hook, $version, $replacement, $base_version );

[257] Fix | Delete

[258] Fix | Delete

if ( $print_deprecated ) {

[259] Fix | Delete

_deprecated_hook( esc_html( $hook ), esc_html( $version ), esc_html( $replacement ) );

[260] Fix | Delete

}

[261] Fix | Delete

}

[262] Fix | Delete

[263] Fix | Delete

/**

[264] Fix | Delete

* Deprecated Argument

[265] Fix | Delete

*

[266] Fix | Delete

* Handles the deprecation process for function arguments.

[267] Fix | Delete

*

[268] Fix | Delete

* @since 3.1.0

[269] Fix | Delete

*

[270] Fix | Delete

* @param string $argument

[271] Fix | Delete

* @param string $version

[272] Fix | Delete

* @param string $replacement

[273] Fix | Delete

* @param string $message

[274] Fix | Delete

* @throws \Exception Deprecation error.

[275] Fix | Delete

*/

[276] Fix | Delete

public function deprecated_argument( $argument, $version, $replacement = '', $message = '' ) {

[277] Fix | Delete

$print_deprecated = $this->check_deprecation( $argument, $version, $replacement );

[278] Fix | Delete

[279] Fix | Delete

if ( $print_deprecated ) {

[280] Fix | Delete

$message = empty( $message ) ? '' : ' ' . $message;

[281] Fix | Delete

// These arguments are escaped because they are printed later, and are not escaped when printed.

[282] Fix | Delete

$error_message_args = [ esc_html( $argument ), esc_html( $version ) ];

[283] Fix | Delete

[284] Fix | Delete

if ( $replacement ) {

[285] Fix | Delete

/* translators: 1: Function argument, 2: Elementor version number, 3: Replacement argument name. */

[286] Fix | Delete

$translation_string = esc_html__( 'The %1$s argument is deprecated since version %2$s! Use %3$s instead.', 'elementor' );

[287] Fix | Delete

$error_message_args[] = $replacement;

[288] Fix | Delete

} else {

[289] Fix | Delete

/* translators: 1: Function argument, 2: Elementor version number. */

[290] Fix | Delete

$translation_string = esc_html__( 'The %1$s argument is deprecated since version %2$s!', 'elementor' );

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

trigger_error(

[294] Fix | Delete

vsprintf(

[295] Fix | Delete

// PHPCS - $translation_string is already escaped above.

[296] Fix | Delete

$translation_string, // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[297] Fix | Delete

// PHPCS - $error_message_args is an array.

[298] Fix | Delete

$error_message_args // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[299] Fix | Delete

) . esc_html( $message ),

[300] Fix | Delete

E_USER_DEPRECATED

[301] Fix | Delete

);

[302] Fix | Delete

}

[303] Fix | Delete

}

[304] Fix | Delete

[305] Fix | Delete

/**

[306] Fix | Delete

* Do Deprecated Action

[307] Fix | Delete

*

[308] Fix | Delete

* A method used to run deprecated actions through Elementor's deprecation process.

[309] Fix | Delete

*

[310] Fix | Delete

* @param string $hook

[311] Fix | Delete

* @param array $args

[312] Fix | Delete

* @param string $version

[313] Fix | Delete

* @param string $replacement

[314] Fix | Delete

* @param null|string $base_version

[315] Fix | Delete

*

[316] Fix | Delete

* @throws \Exception Deprecation error.

[317] Fix | Delete

* @since 3.1.0

[318] Fix | Delete

*/

[319] Fix | Delete

public function do_deprecated_action( $hook, $args, $version, $replacement = '', $base_version = null ) {

[320] Fix | Delete

if ( ! has_action( $hook ) ) {

[321] Fix | Delete

return;

[322] Fix | Delete

}

[323] Fix | Delete

[324] Fix | Delete

$this->deprecated_hook( $hook, $version, $replacement, $base_version );

[325] Fix | Delete

[326] Fix | Delete

do_action_ref_array( $hook, $args );

[327] Fix | Delete

}

[328] Fix | Delete

[329] Fix | Delete

/**

[330] Fix | Delete

* Apply Deprecated Filter

[331] Fix | Delete

*

[332] Fix | Delete

* A method used to run deprecated filters through Elementor's deprecation process.

[333] Fix | Delete

*

[334] Fix | Delete

* @param string $hook

[335] Fix | Delete

* @param array $args

[336] Fix | Delete

* @param string $version

[337] Fix | Delete

* @param string $replacement

[338] Fix | Delete

* @param null|string $base_version

[339] Fix | Delete

*

[340] Fix | Delete

* @return mixed

[341] Fix | Delete

* @throws \Exception Deprecation error.

[342] Fix | Delete

* @since 3.2.0

[343] Fix | Delete

*/

[344] Fix | Delete

public function apply_deprecated_filter( $hook, $args, $version, $replacement = '', $base_version = null ) {

[345] Fix | Delete

if ( ! has_action( $hook ) ) {

[346] Fix | Delete

// `$args` should be an array, but in order to keep BC, we need to support non-array values.

[347] Fix | Delete

if ( is_array( $args ) ) {

[348] Fix | Delete

return $args[0] ?? null;

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

return $args;

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

// BC - See the comment above.

[355] Fix | Delete

if ( ! is_array( $args ) ) {

[356] Fix | Delete

$args = [ $args ];

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

// Avoid associative arrays.

[360] Fix | Delete

$args = array_values( $args );

[361] Fix | Delete

[362] Fix | Delete

$this->deprecated_hook( $hook, $version, $replacement, $base_version );

[363] Fix | Delete

[364] Fix | Delete

return apply_filters_ref_array( $hook, $args );

[365] Fix | Delete

}

[366] Fix | Delete

}

[367] Fix | Delete

[368] Fix | Delete