<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Admin\Splash;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Migrations\Base as MigrationsBase;

[4] Fix | Delete

[5] Fix | Delete

/**

[6] Fix | Delete

* Splash upgrader.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.8.7

[9] Fix | Delete

*/

[10] Fix | Delete

class SplashUpgrader {

[11] Fix | Delete

[12] Fix | Delete

use SplashTrait;

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Available plugins.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 1.8.7

[18] Fix | Delete

*

[19] Fix | Delete

* @var array

[20] Fix | Delete

*/

[21] Fix | Delete

const AVAILABLE_PLUGINS = [

[22] Fix | Delete

'wpforms-lite',

[23] Fix | Delete

'wpforms',

[24] Fix | Delete

];

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Initialize class.

[28] Fix | Delete

*

[29] Fix | Delete

* @since 1.8.7

[30] Fix | Delete

*/

[31] Fix | Delete

public function init() {

[32] Fix | Delete

[33] Fix | Delete

$this->hooks();

[34] Fix | Delete

}

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Hooks.

[38] Fix | Delete

*

[39] Fix | Delete

* @since 1.8.7

[40] Fix | Delete

*/

[41] Fix | Delete

private function hooks() {

[42] Fix | Delete

[43] Fix | Delete

// Update splash data after plugin update.

[44] Fix | Delete

add_action( 'wpforms_migrations_base_core_upgraded', [ $this, 'update_splash_data_on_migration' ], 10, 2 );

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Update splash modal data.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 1.8.7

[51] Fix | Delete

* @deprecated 1.8.8

[52] Fix | Delete

*

[53] Fix | Delete

* @param object $upgrader Upgrader object.

[54] Fix | Delete

*/

[55] Fix | Delete

public function update_splash_data( $upgrader ) {

[56] Fix | Delete

[57] Fix | Delete

_deprecated_function( __METHOD__, '1.8.8 of the WPForms plugin', '\WPForms\Admin\Splash\SplashUpgrader::update_splash_data_on_migration()' );

[58] Fix | Delete

[59] Fix | Delete

$result = $upgrader->result ?? null;

[60] Fix | Delete

[61] Fix | Delete

// Check if plugin was updated successfully.

[62] Fix | Delete

if ( ! $result ) {

[63] Fix | Delete

return;

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

// Check if WPForms plugin was updated.

[67] Fix | Delete

$wpforms_updated = $this->is_wpforms_updated( $upgrader );

[68] Fix | Delete

[69] Fix | Delete

if ( ! $wpforms_updated ) {

[70] Fix | Delete

return;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

// Retrieve plugin version after update.

[74] Fix | Delete

$version = $this->get_plugin_updated_version( $upgrader );

[75] Fix | Delete

[76] Fix | Delete

if ( empty( $version ) ) {

[77] Fix | Delete

return;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

// Skip if plugin wasn't updated.

[81] Fix | Delete

// Continue if plugin was upgraded to the PRO version.

[82] Fix | Delete

if ( version_compare( $version, WPFORMS_VERSION, '<' ) ) {

[83] Fix | Delete

return;

[84] Fix | Delete

}

[85] Fix | Delete

[86] Fix | Delete

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

[87] Fix | Delete

[88] Fix | Delete

// Store updated plugin major version.

[89] Fix | Delete

$this->update_splash_data_version( $version );

[90] Fix | Delete

[91] Fix | Delete

// Force update splash data cache.

[92] Fix | Delete

wpforms()->get( 'splash_cache' )->update( true );

[93] Fix | Delete

[94] Fix | Delete

// Reset hide_welcome_block widget meta for all users.

[95] Fix | Delete

$this->remove_hide_welcome_block_widget_meta();

[96] Fix | Delete

}

[97] Fix | Delete

[98] Fix | Delete

/**

[99] Fix | Delete

* Update splash modal data on migration.

[100] Fix | Delete

*

[101] Fix | Delete

* @since 1.8.8

[102] Fix | Delete

*

[103] Fix | Delete

* @param string|mixed $previous_version Previous plugin version.

[104] Fix | Delete

* @param MigrationsBase $migrations_obj Migrations object.

[105] Fix | Delete

*/

[106] Fix | Delete

public function update_splash_data_on_migration( $previous_version, MigrationsBase $migrations_obj ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed

[107] Fix | Delete

[108] Fix | Delete

$plugin_version = $this->get_major_version( WPFORMS_VERSION );

[109] Fix | Delete

$data_version = $this->get_major_version( $this->get_splash_data_version() );

[110] Fix | Delete

$previous_version = $this->get_major_version( $previous_version );

[111] Fix | Delete

[112] Fix | Delete

// Skip if when the splash data is already updated.

[113] Fix | Delete

// It is possible when the plugin was downgraded.

[114] Fix | Delete

if (

[115] Fix | Delete

version_compare( $previous_version, '1.8.7', '>' ) &&

[116] Fix | Delete

version_compare( $plugin_version, $data_version, '<' )

[117] Fix | Delete

) {

[118] Fix | Delete

return;

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

// Force update splash data cache.

[122] Fix | Delete

wpforms()->get( 'splash_cache' )->update( true );

[123] Fix | Delete

[124] Fix | Delete

// Reset hide_welcome_block widget meta for all users.

[125] Fix | Delete

$this->remove_hide_welcome_block_widget_meta();

[126] Fix | Delete

[127] Fix | Delete

// Store updated plugin major version.

[128] Fix | Delete

$this->update_splash_data_version( $plugin_version );

[129] Fix | Delete

}

[130] Fix | Delete

[131] Fix | Delete

/**

[132] Fix | Delete

* Check if WPForms plugin was updated.

[133] Fix | Delete

*

[134] Fix | Delete

* @since 1.8.7

[135] Fix | Delete

*

[136] Fix | Delete

* @param object $upgrader Upgrader object.

[137] Fix | Delete

*

[138] Fix | Delete

* @return bool True if WPForms plugin was updated, false otherwise.

[139] Fix | Delete

*/

[140] Fix | Delete

private function is_wpforms_updated( $upgrader ): bool {

[141] Fix | Delete

[142] Fix | Delete

// Check if updated plugin is WPForms.

[143] Fix | Delete

if ( ! in_array( $upgrader->result['destination_name'] ?? '', self::AVAILABLE_PLUGINS, true ) ) {

[144] Fix | Delete

return false;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

return true;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Get plugin updated version.

[152] Fix | Delete

*

[153] Fix | Delete

* @since 1.8.7

[154] Fix | Delete

*

[155] Fix | Delete

* @param object $upgrader Upgrader object.

[156] Fix | Delete

*

[157] Fix | Delete

* @return string Plugin updated version.

[158] Fix | Delete

*/

[159] Fix | Delete

private function get_plugin_updated_version( $upgrader ): string { // phpcs:ignore Generic.Metrics.CyclomaticComplexity.TooHigh

[160] Fix | Delete

[161] Fix | Delete

// Get plugin data after update.

[162] Fix | Delete

$new_plugin_data = $upgrader->new_plugin_data ?? null;

[163] Fix | Delete

[164] Fix | Delete

if ( ! $new_plugin_data ) {

[165] Fix | Delete

return '';

[166] Fix | Delete

}

[167] Fix | Delete

[168] Fix | Delete

return $new_plugin_data['Version'] ?? '';

[169] Fix | Delete

}

[170] Fix | Delete

}

[171] Fix | Delete

[172] Fix | Delete