<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Migrations\Tasks;

[2] Fix | Delete

[3] Fix | Delete

use RuntimeException;

[4] Fix | Delete

use WPForms\Tasks\Task;

[5] Fix | Delete

use WPForms\Tasks\Meta;

[6] Fix | Delete

[7] Fix | Delete

/**

[8] Fix | Delete

* Upgrade task base class.

[9] Fix | Delete

*

[10] Fix | Delete

* @since 1.9.5

[11] Fix | Delete

*/

[12] Fix | Delete

abstract class UpgradeBaseTask extends Task {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Start status.

[16] Fix | Delete

*

[17] Fix | Delete

* @since 1.9.5

[18] Fix | Delete

*/

[19] Fix | Delete

private const START = 'start';

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* In progress status.

[23] Fix | Delete

*

[24] Fix | Delete

* @since 1.9.5

[25] Fix | Delete

*/

[26] Fix | Delete

private const IN_PROGRESS = 'in progress';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Completed status.

[30] Fix | Delete

*

[31] Fix | Delete

* @since 1.9.5

[32] Fix | Delete

*/

[33] Fix | Delete

private const COMPLETED = 'completed';

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Task action name.

[37] Fix | Delete

*

[38] Fix | Delete

* @since 1.9.5

[39] Fix | Delete

*

[40] Fix | Delete

* @var string

[41] Fix | Delete

*/

[42] Fix | Delete

private $action;

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Option name to store the task status.

[46] Fix | Delete

*

[47] Fix | Delete

* @since 1.9.5

[48] Fix | Delete

*

[49] Fix | Delete

* @var string

[50] Fix | Delete

*/

[51] Fix | Delete

private $status_option;

[52] Fix | Delete

[53] Fix | Delete

/**

[54] Fix | Delete

* Class constructor.

[55] Fix | Delete

*

[56] Fix | Delete

* @since 1.9.5

[57] Fix | Delete

*

[58] Fix | Delete

* @throws RuntimeException If class name doesn't contain a version.

[59] Fix | Delete

*/

[60] Fix | Delete

public function __construct() {

[61] Fix | Delete

[62] Fix | Delete

$class_parts = explode( '\\', static::class );

[63] Fix | Delete

$short_class_name = end( $class_parts );

[64] Fix | Delete

$short_class_name = strtolower( preg_replace( '/(?<!^)[A-Z]/', '_$0', $short_class_name ) );

[65] Fix | Delete

[66] Fix | Delete

$this->action = 'wpforms_process_migration_' . $short_class_name;

[67] Fix | Delete

$this->status_option = $this->action . '_status';

[68] Fix | Delete

[69] Fix | Delete

parent::__construct( $this->action );

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* Get current task status.

[74] Fix | Delete

*

[75] Fix | Delete

* @since 1.9.5

[76] Fix | Delete

*

[77] Fix | Delete

* @return string

[78] Fix | Delete

*/

[79] Fix | Delete

private function get_status(): string {

[80] Fix | Delete

[81] Fix | Delete

return (string) get_option( $this->status_option );

[82] Fix | Delete

}

[83] Fix | Delete

[84] Fix | Delete

/**

[85] Fix | Delete

* Update task status.

[86] Fix | Delete

* Use the constants self::START, self::IN_PROGRESS, self::COMPLETED.

[87] Fix | Delete

*

[88] Fix | Delete

* @since 1.9.5

[89] Fix | Delete

*

[90] Fix | Delete

* @param string $status New status.

[91] Fix | Delete

*

[92] Fix | Delete

* @return void

[93] Fix | Delete

*/

[94] Fix | Delete

private function update_status( string $status ): void {

[95] Fix | Delete

[96] Fix | Delete

update_option( $this->status_option, $status );

[97] Fix | Delete

}

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Initialize the task with all the proper checks.

[101] Fix | Delete

*

[102] Fix | Delete

* @since 1.9.5

[103] Fix | Delete

*/

[104] Fix | Delete

public function init(): void {

[105] Fix | Delete

[106] Fix | Delete

$status = $this->get_status();

[107] Fix | Delete

[108] Fix | Delete

if ( ! $status || $status === self::COMPLETED ) {

[109] Fix | Delete

return;

[110] Fix | Delete

}

[111] Fix | Delete

[112] Fix | Delete

$this->set_task_properties();

[113] Fix | Delete

$this->hooks();

[114] Fix | Delete

[115] Fix | Delete

if ( $status !== self::START ) {

[116] Fix | Delete

return;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

$this->update_status( self::IN_PROGRESS );

[120] Fix | Delete

[121] Fix | Delete

$this->init_migration();

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Create a task.

[126] Fix | Delete

*

[127] Fix | Delete

* @param array $args Task arguments.

[128] Fix | Delete

*

[129] Fix | Delete

* @since 1.9.5

[130] Fix | Delete

*

[131] Fix | Delete

* @return void

[132] Fix | Delete

*/

[133] Fix | Delete

protected function create_task( array $args = [] ): void {

[134] Fix | Delete

[135] Fix | Delete

$tasks = wpforms()->obj( 'tasks' );

[136] Fix | Delete

[137] Fix | Delete

if ( ! $tasks ) {

[138] Fix | Delete

wpforms_log(

[139] Fix | Delete

'Migration error',

[140] Fix | Delete

[

[141] Fix | Delete

'error' => "Object is not available: `null` returned by `wpforms()->obj( 'tasks' )`",

[142] Fix | Delete

'class' => static::class,

[143] Fix | Delete

'method' => __METHOD__,

[144] Fix | Delete

],

[145] Fix | Delete

[

[146] Fix | Delete

'type' => 'error',

[147] Fix | Delete

'force' => true,

[148] Fix | Delete

]

[149] Fix | Delete

);

[150] Fix | Delete

[151] Fix | Delete

return;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

$tasks

[155] Fix | Delete

->create( $this->action )

[156] Fix | Delete

->async()

[157] Fix | Delete

->params( ...$args )

[158] Fix | Delete

->register();

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* Set task properties.

[163] Fix | Delete

*

[164] Fix | Delete

* @since 1.9.5

[165] Fix | Delete

*

[166] Fix | Delete

* @return void

[167] Fix | Delete

*/

[168] Fix | Delete

abstract protected function set_task_properties(): void;

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* Add hooks.

[172] Fix | Delete

*

[173] Fix | Delete

* @since 1.9.5

[174] Fix | Delete

*/

[175] Fix | Delete

protected function hooks(): void {

[176] Fix | Delete

[177] Fix | Delete

add_action( $this->action, [ $this, 'migrate' ] );

[178] Fix | Delete

add_action( 'action_scheduler_after_process_queue', [ $this, 'after_process_queue' ] );

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

/**

[182] Fix | Delete

* Migrate an entry.

[183] Fix | Delete

*

[184] Fix | Delete

* @since 1.9.5

[185] Fix | Delete

*

[186] Fix | Delete

* @param int $meta_id Action meta id.

[187] Fix | Delete

*

[188] Fix | Delete

* @noinspection PhpMissingParamTypeInspection

[189] Fix | Delete

*/

[190] Fix | Delete

public function migrate( $meta_id ): void {

[191] Fix | Delete

[192] Fix | Delete

$params = ( new Meta() )->get( $meta_id );

[193] Fix | Delete

[194] Fix | Delete

if ( ! $params || ! isset( $params->data ) ) {

[195] Fix | Delete

return;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

$this->process_migration( (array) $params->data );

[199] Fix | Delete

}

[200] Fix | Delete

[201] Fix | Delete

/**

[202] Fix | Delete

* Execute an async migration task.

[203] Fix | Delete

*

[204] Fix | Delete

* @since 1.9.5

[205] Fix | Delete

*

[206] Fix | Delete

* @param array $data Migration data.

[207] Fix | Delete

*

[208] Fix | Delete

* @return void

[209] Fix | Delete

*/

[210] Fix | Delete

abstract protected function process_migration( array $data ): void;

[211] Fix | Delete

[212] Fix | Delete

/**

[213] Fix | Delete

* Set the status as completed after processing all queue action.

[214] Fix | Delete

*

[215] Fix | Delete

* @since 1.9.5

[216] Fix | Delete

*

[217] Fix | Delete

* @return void

[218] Fix | Delete

*/

[219] Fix | Delete

public function after_process_queue(): void {

[220] Fix | Delete

[221] Fix | Delete

$tasks = wpforms()->obj( 'tasks' );

[222] Fix | Delete

[223] Fix | Delete

if ( ! $tasks ) {

[224] Fix | Delete

wpforms_log(

[225] Fix | Delete

'Migration error',

[226] Fix | Delete

[

[227] Fix | Delete

'error' => "Object is not available: `null` returned by `wpforms()->obj( 'tasks' )`",

[228] Fix | Delete

'class' => static::class,

[229] Fix | Delete

'method' => __METHOD__,

[230] Fix | Delete

],

[231] Fix | Delete

[

[232] Fix | Delete

'type' => 'error',

[233] Fix | Delete

'force' => true,

[234] Fix | Delete

]

[235] Fix | Delete

);

[236] Fix | Delete

[237] Fix | Delete

return;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

if ( $tasks->is_scheduled( $this->action ) ) {

[241] Fix | Delete

return;

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

$this->finish_migration();

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

/**

[248] Fix | Delete

* Finish migration.

[249] Fix | Delete

*

[250] Fix | Delete

* @since 1.9.5

[251] Fix | Delete

*

[252] Fix | Delete

* @return void

[253] Fix | Delete

*/

[254] Fix | Delete

protected function finish_migration(): void {

[255] Fix | Delete

[256] Fix | Delete

$this->update_status( self::COMPLETED );

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

/**

[260] Fix | Delete

* Create migration tasks using the `create_task` method

[261] Fix | Delete

* or `finish_migration` method to complete it.

[262] Fix | Delete

*

[263] Fix | Delete

* @since 1.9.5

[264] Fix | Delete

*

[265] Fix | Delete

* @return void

[266] Fix | Delete

*/

[267] Fix | Delete

abstract protected function init_migration(): void;

[268] Fix | Delete

[269] Fix | Delete

/**

[270] Fix | Delete

* Determine if the task is completed.

[271] Fix | Delete

* Remove the status option to allow running the task again.

[272] Fix | Delete

*

[273] Fix | Delete

* @since 1.9.5

[274] Fix | Delete

*

[275] Fix | Delete

* @return bool True if a task is completed.

[276] Fix | Delete

*/

[277] Fix | Delete

public function is_completed(): bool {

[278] Fix | Delete

[279] Fix | Delete

$status = $this->get_status();

[280] Fix | Delete

$is_completed = $status === self::COMPLETED;

[281] Fix | Delete

[282] Fix | Delete

if ( $is_completed ) {

[283] Fix | Delete

delete_option( $this->status_option );

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

return $is_completed;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Maybe start the task.

[291] Fix | Delete

*

[292] Fix | Delete

* @since 1.9.5

[293] Fix | Delete

*/

[294] Fix | Delete

public function maybe_start(): void {

[295] Fix | Delete

[296] Fix | Delete

$status = $this->get_status();

[297] Fix | Delete

[298] Fix | Delete

if ( ! $status ) {

[299] Fix | Delete

$this->update_status( self::START );

[300] Fix | Delete

}

[301] Fix | Delete

}

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete