<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Tasks\Actions;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Tasks\Meta;

[4] Fix | Delete

use WPForms\Tasks\Task;

[5] Fix | Delete

use WPForms\Tasks\Tasks;

[6] Fix | Delete

use WPForms_Entry_Fields_Handler;

[7] Fix | Delete

use WPForms_Entry_Handler;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Class Migration173Task.

[11] Fix | Delete

*

[12] Fix | Delete

* @since 1.7.3

[13] Fix | Delete

*/

[14] Fix | Delete

class Migration173Task extends Task {

[15] Fix | Delete

[16] Fix | Delete

/**

[17] Fix | Delete

* Action name for this task.

[18] Fix | Delete

*

[19] Fix | Delete

* @since 1.7.3

[20] Fix | Delete

*/

[21] Fix | Delete

const ACTION = 'wpforms_process_migration_173';

[22] Fix | Delete

[23] Fix | Delete

/**

[24] Fix | Delete

* Status option name.

[25] Fix | Delete

*

[26] Fix | Delete

* @since 1.7.3

[27] Fix | Delete

*/

[28] Fix | Delete

const STATUS = 'wpforms_process_migration_173_status';

[29] Fix | Delete

[30] Fix | Delete

/**

[31] Fix | Delete

* Start status.

[32] Fix | Delete

*

[33] Fix | Delete

* @since 1.7.3

[34] Fix | Delete

*/

[35] Fix | Delete

const START = 'start';

[36] Fix | Delete

[37] Fix | Delete

/**

[38] Fix | Delete

* In progress status.

[39] Fix | Delete

*

[40] Fix | Delete

* @since 1.7.3

[41] Fix | Delete

*/

[42] Fix | Delete

const IN_PROGRESS = 'in progress';

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Completed status.

[46] Fix | Delete

*

[47] Fix | Delete

* @since 1.7.3

[48] Fix | Delete

*/

[49] Fix | Delete

const COMPLETED = 'completed';

[50] Fix | Delete

[51] Fix | Delete

/**

[52] Fix | Delete

* Chunk size to use.

[53] Fix | Delete

* Specifies how many entries to load for scanning in one db request.

[54] Fix | Delete

* Affects memory usage.

[55] Fix | Delete

*

[56] Fix | Delete

* @since 1.7.3

[57] Fix | Delete

*/

[58] Fix | Delete

const CHUNK_SIZE = 50;

[59] Fix | Delete

[60] Fix | Delete

/**

[61] Fix | Delete

* Entry handler.

[62] Fix | Delete

*

[63] Fix | Delete

* @since 1.7.3

[64] Fix | Delete

*

[65] Fix | Delete

* @var WPForms_Entry_Handler

[66] Fix | Delete

*/

[67] Fix | Delete

private $entry_handler;

[68] Fix | Delete

[69] Fix | Delete

/**

[70] Fix | Delete

* Entry fields handler.

[71] Fix | Delete

*

[72] Fix | Delete

* @since 1.7.3

[73] Fix | Delete

*

[74] Fix | Delete

* @var WPForms_Entry_Fields_Handler

[75] Fix | Delete

*/

[76] Fix | Delete

private $entry_fields_handler;

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Class constructor.

[80] Fix | Delete

*

[81] Fix | Delete

* @since 1.7.3

[82] Fix | Delete

*/

[83] Fix | Delete

public function __construct() {

[84] Fix | Delete

[85] Fix | Delete

parent::__construct( self::ACTION );

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Initialize the task with all the proper checks.

[90] Fix | Delete

*

[91] Fix | Delete

* @since 1.7.3

[92] Fix | Delete

*/

[93] Fix | Delete

public function init() {

[94] Fix | Delete

[95] Fix | Delete

$this->entry_handler = wpforms()->obj( 'entry' );

[96] Fix | Delete

$this->entry_fields_handler = wpforms()->obj( 'entry_fields' );

[97] Fix | Delete

[98] Fix | Delete

if ( ! $this->entry_handler || ! $this->entry_fields_handler ) {

[99] Fix | Delete

return;

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

// Bail out if migration is not started or completed.

[103] Fix | Delete

$status = get_option( self::STATUS );

[104] Fix | Delete

[105] Fix | Delete

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

[106] Fix | Delete

return;

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

// Mark that migration is in progress.

[110] Fix | Delete

update_option( self::STATUS, self::IN_PROGRESS );

[111] Fix | Delete

[112] Fix | Delete

$this->hooks();

[113] Fix | Delete

[114] Fix | Delete

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

[115] Fix | Delete

[116] Fix | Delete

// Add new if none exists.

[117] Fix | Delete

if ( $tasks->is_scheduled( self::ACTION ) !== false ) {

[118] Fix | Delete

return;

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

// Init migration.

[122] Fix | Delete

$this->init_migration( $tasks );

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Add hooks.

[127] Fix | Delete

*

[128] Fix | Delete

* @since 1.7.3

[129] Fix | Delete

*/

[130] Fix | Delete

private function hooks() {

[131] Fix | Delete

[132] Fix | Delete

// Register the migrate action.

[133] Fix | Delete

add_action( self::ACTION, [ $this, 'migrate' ] );

[134] Fix | Delete

[135] Fix | Delete

// Register after process queue action.

[136] Fix | Delete

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

[137] Fix | Delete

}

[138] Fix | Delete

[139] Fix | Delete

/**

[140] Fix | Delete

* Migrate an entry.

[141] Fix | Delete

*

[142] Fix | Delete

* @since 1.7.3

[143] Fix | Delete

*

[144] Fix | Delete

* @param int $meta_id Action meta id.

[145] Fix | Delete

*/

[146] Fix | Delete

public function migrate( $meta_id ) {

[147] Fix | Delete

[148] Fix | Delete

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

[149] Fix | Delete

[150] Fix | Delete

if ( ! $params ) {

[151] Fix | Delete

return;

[152] Fix | Delete

}

[153] Fix | Delete

[154] Fix | Delete

list( $entry_id_chunk ) = $params->data;

[155] Fix | Delete

[156] Fix | Delete

foreach ( $entry_id_chunk as $entry_id ) {

[157] Fix | Delete

$this->save_entry( $entry_id );

[158] Fix | Delete

}

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

/**

[162] Fix | Delete

* After process queue action.

[163] Fix | Delete

* Set status as completed.

[164] Fix | Delete

*

[165] Fix | Delete

* @since 1.7.3

[166] Fix | Delete

*/

[167] Fix | Delete

public function after_process_queue() {

[168] Fix | Delete

[169] Fix | Delete

if ( as_has_scheduled_action( self::ACTION ) ) {

[170] Fix | Delete

return;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

// Mark that migration is finished.

[174] Fix | Delete

update_option( self::STATUS, self::COMPLETED );

[175] Fix | Delete

}

[176] Fix | Delete

[177] Fix | Delete

/**

[178] Fix | Delete

* Init migration.

[179] Fix | Delete

*

[180] Fix | Delete

* @since 1.7.3

[181] Fix | Delete

*

[182] Fix | Delete

* @param Tasks $tasks Tasks class instance.

[183] Fix | Delete

*/

[184] Fix | Delete

private function init_migration( $tasks ) {

[185] Fix | Delete

[186] Fix | Delete

// This part of the migration shouldn't take more than 1 second even on big sites.

[187] Fix | Delete

$entry_ids = $this->get_legacy_entry_ids();

[188] Fix | Delete

[189] Fix | Delete

if ( ! $entry_ids ) {

[190] Fix | Delete

// Mark that migration is completed.

[191] Fix | Delete

update_option( self::STATUS, self::COMPLETED );

[192] Fix | Delete

[193] Fix | Delete

return;

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* This part of the migration can take a while.

[198] Fix | Delete

* Saving hundreds of entries with a potentially very high number of entry fields could be time and memory consuming.

[199] Fix | Delete

* That is why we perform save via Action Scheduler.

[200] Fix | Delete

*/

[201] Fix | Delete

$entry_id_chunks = array_chunk( $entry_ids, self::CHUNK_SIZE, true );

[202] Fix | Delete

[203] Fix | Delete

foreach ( $entry_id_chunks as $entry_id_chunk ) {

[204] Fix | Delete

$tasks->create( self::ACTION )->async()->params( $entry_id_chunk )->register();

[205] Fix | Delete

}

[206] Fix | Delete

}

[207] Fix | Delete

[208] Fix | Delete

/**

[209] Fix | Delete

* Get entry ids which do not have relevant entry field records.

[210] Fix | Delete

*

[211] Fix | Delete

* @since 1.7.3

[212] Fix | Delete

*

[213] Fix | Delete

* @return int[]

[214] Fix | Delete

*/

[215] Fix | Delete

private function get_legacy_entry_ids() {

[216] Fix | Delete

[217] Fix | Delete

global $wpdb;

[218] Fix | Delete

[219] Fix | Delete

// phpcs:disable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.DirectDatabaseQuery.NoCaching

[220] Fix | Delete

$entries = $wpdb->get_results(

[221] Fix | Delete

"

[222] Fix | Delete

SELECT e.entry_id FROM {$this->entry_handler->table_name} e

[223] Fix | Delete

LEFT JOIN {$this->entry_fields_handler->table_name} ef

[224] Fix | Delete

ON e.entry_id=ef.entry_id

[225] Fix | Delete

WHERE

[226] Fix | Delete

e.status IN( 'partial', 'abandoned' ) AND

[227] Fix | Delete

ef.entry_id IS NULL"

[228] Fix | Delete

);

[229] Fix | Delete

// phpcs:enable WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.DirectDatabaseQuery.NoCaching

[230] Fix | Delete

[231] Fix | Delete

if ( ! $entries || ! is_array( $entries ) ) {

[232] Fix | Delete

return [];

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

return array_map( 'intval', wp_list_pluck( $entries, 'entry_id' ) );

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

/**

[239] Fix | Delete

* Save entry properly.

[240] Fix | Delete

*

[241] Fix | Delete

* @since 1.7.3

[242] Fix | Delete

*

[243] Fix | Delete

* @param int $entry_id Entry id.

[244] Fix | Delete

*/

[245] Fix | Delete

private function save_entry( $entry_id ) {

[246] Fix | Delete

[247] Fix | Delete

$entry = $this->entry_handler->get( $entry_id );

[248] Fix | Delete

[249] Fix | Delete

if ( ! $entry || ! isset( $entry->form_id, $entry->fields, $entry->date_modified ) ) {

[250] Fix | Delete

return;

[251] Fix | Delete

}

[252] Fix | Delete

[253] Fix | Delete

$fields = json_decode( $entry->fields, true );

[254] Fix | Delete

[255] Fix | Delete

if ( ! is_array( $fields ) ) {

[256] Fix | Delete

return;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

$form_data = [

[260] Fix | Delete

'id' => (int) $entry->form_id,

[261] Fix | Delete

'date' => $entry->date_modified,

[262] Fix | Delete

];

[263] Fix | Delete

[264] Fix | Delete

$this->entry_fields_handler->save( $fields, $form_data, $entry_id, true );

[265] Fix | Delete

}

[266] Fix | Delete

}

[267] Fix | Delete

[268] Fix | Delete