<?php

[0] Fix | Delete

[1] Fix | Delete

// phpcs:disable Generic.Commenting.DocComment.MissingShort

[2] Fix | Delete

/** @noinspection PhpExpressionResultUnusedInspection */

[3] Fix | Delete

/** @noinspection PhpPropertyOnlyWrittenInspection */

[4] Fix | Delete

/** @noinspection UnusedConstructorDependenciesInspection */

[5] Fix | Delete

/** @noinspection PhpUnusedAliasInspection */

[6] Fix | Delete

// phpcs:enable Generic.Commenting.DocComment.MissingShort

[7] Fix | Delete

[8] Fix | Delete

namespace WPForms\Migrations;

[9] Fix | Delete

[10] Fix | Delete

// phpcs:disable WPForms.PHP.UseStatement.UnusedUseStatement

[11] Fix | Delete

use WPForms\Migrations\Migrations;

[12] Fix | Delete

use WPForms\Migrations\Tasks\UpgradeBaseTask;

[13] Fix | Delete

use WPForms\Pro\Migrations\Migrations as MigrationsPro;

[14] Fix | Delete

// phpcs:enable WPForms.PHP.UseStatement.UnusedUseStatement

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Class UpgradeBase contains both Lite and Pro plugin upgrade methods.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 1.7.5

[20] Fix | Delete

*/

[21] Fix | Delete

abstract class UpgradeBase {

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Migration class instance.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 1.7.5

[27] Fix | Delete

*

[28] Fix | Delete

* @var Migrations|MigrationsPro

[29] Fix | Delete

*/

[30] Fix | Delete

protected $migrations;

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Primary class constructor.

[34] Fix | Delete

*

[35] Fix | Delete

* @since 1.7.5

[36] Fix | Delete

*

[37] Fix | Delete

* @param Migrations|MigrationsPro $migrations Instance of Migrations class.

[38] Fix | Delete

*/

[39] Fix | Delete

public function __construct( $migrations ) {

[40] Fix | Delete

[41] Fix | Delete

$this->migrations = $migrations;

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Run upgrade.

[46] Fix | Delete

*

[47] Fix | Delete

* @since 1.7.5

[48] Fix | Delete

*

[49] Fix | Delete

* @return bool|null Upgrade result:

[50] Fix | Delete

* true - the upgrade completed successfully,

[51] Fix | Delete

* false - in the case of failure,

[52] Fix | Delete

* null - upgrade started but not yet finished (background task).

[53] Fix | Delete

*/

[54] Fix | Delete

abstract public function run();

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Run the async upgrade via an Action Scheduler (AS) task.

[58] Fix | Delete

* The AS task has to support STATUS option with START, IN_PROGRESS, and COMPLETED values.

[59] Fix | Delete

* Also, the AS task must have the init() method.

[60] Fix | Delete

*

[61] Fix | Delete

* @since 1.7.5

[62] Fix | Delete

*

[63] Fix | Delete

* @param string $classname Classname of an async AS task.

[64] Fix | Delete

*

[65] Fix | Delete

* @return bool|null Upgrade result:

[66] Fix | Delete

* true - the upgrade completed successfully,

[67] Fix | Delete

* false - in the case of failure,

[68] Fix | Delete

* null - upgrade started but not yet finished (background task).

[69] Fix | Delete

*/

[70] Fix | Delete

protected function run_async( string $classname ) { // phpcs:ignore WPForms.PHP.HooksMethod.InvalidPlaceForAddingHooks

[71] Fix | Delete

[72] Fix | Delete

$instance = new $classname();

[73] Fix | Delete

[74] Fix | Delete

if ( $this->is_completed( $instance ) ) {

[75] Fix | Delete

return true;

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

$this->maybe_start( $instance );

[79] Fix | Delete

[80] Fix | Delete

// Class Tasks does not exist at this point, so we have to add an action on init.

[81] Fix | Delete

add_action(

[82] Fix | Delete

'init',

[83] Fix | Delete

static function () use ( $instance ) {

[84] Fix | Delete

[85] Fix | Delete

$instance->init();

[86] Fix | Delete

},

[87] Fix | Delete

PHP_INT_MAX

[88] Fix | Delete

);

[89] Fix | Delete

[90] Fix | Delete

return null;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

/**

[94] Fix | Delete

* Determine if the async AS task is completed.

[95] Fix | Delete

*

[96] Fix | Delete

* @since 1.9.5

[97] Fix | Delete

*

[98] Fix | Delete

* @param object $instance Instance of an async AS task.

[99] Fix | Delete

*

[100] Fix | Delete

* @use UpgradeBaseTask::is_completed()

[101] Fix | Delete

*

[102] Fix | Delete

* @return bool

[103] Fix | Delete

*/

[104] Fix | Delete

private function is_completed( $instance ): bool {

[105] Fix | Delete

[106] Fix | Delete

if ( method_exists( $instance, 'is_completed' ) ) {

[107] Fix | Delete

return $instance->is_completed();

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

// Legacy tasks.

[111] Fix | Delete

$status = get_option( $instance::STATUS );

[112] Fix | Delete

[113] Fix | Delete

if ( $status === $instance::COMPLETED ) {

[114] Fix | Delete

delete_option( $instance::STATUS );

[115] Fix | Delete

[116] Fix | Delete

return true;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

return false;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

/**

[123] Fix | Delete

* Start the async AS task if it wasn't started yet.

[124] Fix | Delete

*

[125] Fix | Delete

* @since 1.9.5

[126] Fix | Delete

*

[127] Fix | Delete

* @param object $instance Instance of an async AS task.

[128] Fix | Delete

*

[129] Fix | Delete

* @use UpgradeBaseTask::maybe_start()

[130] Fix | Delete

*/

[131] Fix | Delete

private function maybe_start( $instance ): void {

[132] Fix | Delete

[133] Fix | Delete

if ( method_exists( $instance, 'maybe_start' ) ) {

[134] Fix | Delete

$instance->maybe_start();

[135] Fix | Delete

[136] Fix | Delete

return;

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

// Legacy tasks.

[140] Fix | Delete

$status = get_option( $instance::STATUS );

[141] Fix | Delete

[142] Fix | Delete

if ( ! $status ) {

[143] Fix | Delete

update_option( $instance::STATUS, $instance::START );

[144] Fix | Delete

}

[145] Fix | Delete

}

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete