<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Based on https://github.com/woocommerce/woocommerce/blob/master/includes/abstracts/class-wc-background-process.php

[2] Fix | Delete

* & https://github.com/woocommerce/woocommerce/blob/master/includes/class-wc-background-updater.php

[3] Fix | Delete

*

[4] Fix | Delete

* @package Elementor\Core\Base

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

namespace Elementor\Core\Base;

[8] Fix | Delete

[9] Fix | Delete

use Elementor\Plugin;

[10] Fix | Delete

use Elementor\Core\Base\BackgroundProcess\WP_Background_Process;

[11] Fix | Delete

[12] Fix | Delete

[13] Fix | Delete

defined( 'ABSPATH' ) || exit;

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* WC_Background_Process class.

[17] Fix | Delete

*/

[18] Fix | Delete

abstract class Background_Task extends WP_Background_Process {

[19] Fix | Delete

protected $current_item;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Dispatch updater.

[23] Fix | Delete

*

[24] Fix | Delete

* Updater will still run via cron job if this fails for any reason.

[25] Fix | Delete

*/

[26] Fix | Delete

public function dispatch() {

[27] Fix | Delete

$dispatched = parent::dispatch();

[28] Fix | Delete

[29] Fix | Delete

if ( is_wp_error( $dispatched ) ) {

[30] Fix | Delete

wp_die( esc_html( $dispatched ) );

[31] Fix | Delete

}

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

public function query_col( $sql ) {

[35] Fix | Delete

global $wpdb;

[36] Fix | Delete

[37] Fix | Delete

// Add Calc.

[38] Fix | Delete

$item = $this->get_current_item();

[39] Fix | Delete

if ( empty( $item['total'] ) ) {

[40] Fix | Delete

$sql = preg_replace( '/^SELECT/', 'SELECT SQL_CALC_FOUND_ROWS', $sql );

[41] Fix | Delete

}

[42] Fix | Delete

[43] Fix | Delete

// Add offset & limit.

[44] Fix | Delete

$sql = preg_replace( '/;$/', '', $sql );

[45] Fix | Delete

$sql .= ' LIMIT %d, %d;';

[46] Fix | Delete

[47] Fix | Delete

$results = $wpdb->get_col( $wpdb->prepare( $sql, $this->get_current_offset(), $this->get_limit() ) ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared

[48] Fix | Delete

[49] Fix | Delete

if ( ! empty( $results ) ) {

[50] Fix | Delete

$this->set_total();

[51] Fix | Delete

}

[52] Fix | Delete

[53] Fix | Delete

return $results;

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

public function should_run_again( $updated_rows ) {

[57] Fix | Delete

return count( $updated_rows ) === $this->get_limit();

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

public function get_current_offset() {

[61] Fix | Delete

$limit = $this->get_limit();

[62] Fix | Delete

return ( $this->current_item['iterate_num'] - 1 ) * $limit;

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

public function get_limit() {

[66] Fix | Delete

return $this->manager->get_query_limit();

[67] Fix | Delete

}

[68] Fix | Delete

[69] Fix | Delete

public function set_total() {

[70] Fix | Delete

global $wpdb;

[71] Fix | Delete

[72] Fix | Delete

if ( empty( $this->current_item['total'] ) ) {

[73] Fix | Delete

$total_rows = $wpdb->get_var( 'SELECT FOUND_ROWS();' );

[74] Fix | Delete

$total_iterates = ceil( $total_rows / $this->get_limit() );

[75] Fix | Delete

$this->current_item['total'] = $total_iterates;

[76] Fix | Delete

}

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Complete

[81] Fix | Delete

*

[82] Fix | Delete

* Override if applicable, but ensure that the below actions are

[83] Fix | Delete

* performed, or, call parent::complete().

[84] Fix | Delete

*/

[85] Fix | Delete

protected function complete() {

[86] Fix | Delete

$this->manager->on_runner_complete( true );

[87] Fix | Delete

[88] Fix | Delete

parent::complete();

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

public function continue_run() {

[92] Fix | Delete

// Used to fire an action added in WP_Background_Process::_construct() that calls WP_Background_Process::handle_cron_healthcheck().

[93] Fix | Delete

// This method will make sure the database updates are executed even if cron is disabled. Nothing will happen if the updates are already running.

[94] Fix | Delete

do_action( $this->cron_hook_identifier );

[95] Fix | Delete

}

[96] Fix | Delete

[97] Fix | Delete

/**

[98] Fix | Delete

* @return mixed

[99] Fix | Delete

*/

[100] Fix | Delete

public function get_current_item() {

[101] Fix | Delete

return $this->current_item;

[102] Fix | Delete

}

[103] Fix | Delete

[104] Fix | Delete

/**

[105] Fix | Delete

* Get batch.

[106] Fix | Delete

*

[107] Fix | Delete

* @return \stdClass Return the first batch from the queue.

[108] Fix | Delete

*/

[109] Fix | Delete

protected function get_batch() {

[110] Fix | Delete

$batch = parent::get_batch();

[111] Fix | Delete

$batch->data = array_filter( (array) $batch->data );

[112] Fix | Delete

[113] Fix | Delete

return $batch;

[114] Fix | Delete

}

[115] Fix | Delete

[116] Fix | Delete

/**

[117] Fix | Delete

* Handle cron healthcheck

[118] Fix | Delete

*

[119] Fix | Delete

* Restart the background process if not already running

[120] Fix | Delete

* and data exists in the queue.

[121] Fix | Delete

*/

[122] Fix | Delete

public function handle_cron_healthcheck() {

[123] Fix | Delete

if ( $this->is_process_running() ) {

[124] Fix | Delete

// Background process already running.

[125] Fix | Delete

return;

[126] Fix | Delete

}

[127] Fix | Delete

[128] Fix | Delete

if ( $this->is_queue_empty() ) {

[129] Fix | Delete

// No data to process.

[130] Fix | Delete

$this->clear_scheduled_event();

[131] Fix | Delete

return;

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

$this->handle();

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

/**

[138] Fix | Delete

* Schedule fallback event.

[139] Fix | Delete

*/

[140] Fix | Delete

protected function schedule_event() {

[141] Fix | Delete

if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {

[142] Fix | Delete

wp_schedule_event( time() + 10, $this->cron_interval_identifier, $this->cron_hook_identifier );

[143] Fix | Delete

}

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Is the updater running?

[148] Fix | Delete

*

[149] Fix | Delete

* @return boolean

[150] Fix | Delete

*/

[151] Fix | Delete

public function is_running() {

[152] Fix | Delete

return false === $this->is_queue_empty();

[153] Fix | Delete

}

[154] Fix | Delete

[155] Fix | Delete

/**

[156] Fix | Delete

* See if the batch limit has been exceeded.

[157] Fix | Delete

*

[158] Fix | Delete

* @return bool

[159] Fix | Delete

*/

[160] Fix | Delete

protected function batch_limit_exceeded() {

[161] Fix | Delete

return $this->time_exceeded() || $this->memory_exceeded();

[162] Fix | Delete

}

[163] Fix | Delete

[164] Fix | Delete

/**

[165] Fix | Delete

* Handle.

[166] Fix | Delete

*

[167] Fix | Delete

* Pass each queue item to the task handler, while remaining

[168] Fix | Delete

* within server memory and time limit constraints.

[169] Fix | Delete

*/

[170] Fix | Delete

protected function handle() {

[171] Fix | Delete

$this->manager->on_runner_start();

[172] Fix | Delete

[173] Fix | Delete

$this->lock_process();

[174] Fix | Delete

[175] Fix | Delete

do {

[176] Fix | Delete

$batch = $this->get_batch();

[177] Fix | Delete

[178] Fix | Delete

foreach ( $batch->data as $key => $value ) {

[179] Fix | Delete

$task = $this->task( $value );

[180] Fix | Delete

[181] Fix | Delete

if ( false !== $task ) {

[182] Fix | Delete

$batch->data[ $key ] = $task;

[183] Fix | Delete

} else {

[184] Fix | Delete

unset( $batch->data[ $key ] );

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

if ( $this->batch_limit_exceeded() ) {

[188] Fix | Delete

// Batch limits reached.

[189] Fix | Delete

break;

[190] Fix | Delete

}

[191] Fix | Delete

}

[192] Fix | Delete

[193] Fix | Delete

// Update or delete current batch.

[194] Fix | Delete

if ( ! empty( $batch->data ) ) {

[195] Fix | Delete

$this->update( $batch->key, $batch->data );

[196] Fix | Delete

} else {

[197] Fix | Delete

$this->delete( $batch->key );

[198] Fix | Delete

}

[199] Fix | Delete

} while ( ! $this->batch_limit_exceeded() && ! $this->is_queue_empty() );

[200] Fix | Delete

[201] Fix | Delete

$this->unlock_process();

[202] Fix | Delete

[203] Fix | Delete

// Start next batch or complete process.

[204] Fix | Delete

if ( ! $this->is_queue_empty() ) {

[205] Fix | Delete

$this->dispatch();

[206] Fix | Delete

} else {

[207] Fix | Delete

$this->complete();

[208] Fix | Delete

}

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Use the protected `is_process_running` method as a public method.

[213] Fix | Delete

*

[214] Fix | Delete

* @return bool

[215] Fix | Delete

*/

[216] Fix | Delete

public function is_process_locked() {

[217] Fix | Delete

return $this->is_process_running();

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

public function handle_immediately( $callbacks ) {

[221] Fix | Delete

$this->manager->on_runner_start();

[222] Fix | Delete

[223] Fix | Delete

$this->lock_process();

[224] Fix | Delete

[225] Fix | Delete

foreach ( $callbacks as $callback ) {

[226] Fix | Delete

$item = [

[227] Fix | Delete

'callback' => $callback,

[228] Fix | Delete

];

[229] Fix | Delete

[230] Fix | Delete

do {

[231] Fix | Delete

$item = $this->task( $item );

[232] Fix | Delete

} while ( $item );

[233] Fix | Delete

}

[234] Fix | Delete

[235] Fix | Delete

$this->unlock_process();

[236] Fix | Delete

}

[237] Fix | Delete

[238] Fix | Delete

/**

[239] Fix | Delete

* Task

[240] Fix | Delete

*

[241] Fix | Delete

* Override this method to perform any actions required on each

[242] Fix | Delete

* queue item. Return the modified item for further processing

[243] Fix | Delete

* in the next pass through. Or, return false to remove the

[244] Fix | Delete

* item from the queue.

[245] Fix | Delete

*

[246] Fix | Delete

* @param array $item

[247] Fix | Delete

*

[248] Fix | Delete

* @return array|bool

[249] Fix | Delete

*/

[250] Fix | Delete

protected function task( $item ) {

[251] Fix | Delete

$result = false;

[252] Fix | Delete

[253] Fix | Delete

if ( ! isset( $item['iterate_num'] ) ) {

[254] Fix | Delete

$item['iterate_num'] = 1;

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

$logger = Plugin::$instance->logger->get_logger();

[258] Fix | Delete

$callback = $this->format_callback_log( $item );

[259] Fix | Delete

[260] Fix | Delete

if ( is_callable( $item['callback'] ) ) {

[261] Fix | Delete

$progress = '';

[262] Fix | Delete

[263] Fix | Delete

if ( 1 < $item['iterate_num'] ) {

[264] Fix | Delete

if ( empty( $item['total'] ) ) {

[265] Fix | Delete

$progress = sprintf( '(x%s)', $item['iterate_num'] );

[266] Fix | Delete

} else {

[267] Fix | Delete

$percent = ceil( $item['iterate_num'] / ( $item['total'] / 100 ) );

[268] Fix | Delete

$progress = sprintf( '(%s of %s, %s%%)', $item['iterate_num'], $item['total'], $percent );

[269] Fix | Delete

}

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

$logger->info( sprintf( '%s Start %s', $callback, $progress ) );

[273] Fix | Delete

[274] Fix | Delete

$this->current_item = $item;

[275] Fix | Delete

[276] Fix | Delete

$result = (bool) call_user_func( $item['callback'], $this );

[277] Fix | Delete

[278] Fix | Delete

// get back the updated item.

[279] Fix | Delete

$item = $this->current_item;

[280] Fix | Delete

$this->current_item = null;

[281] Fix | Delete

[282] Fix | Delete

if ( $result ) {

[283] Fix | Delete

if ( empty( $item['total'] ) ) {

[284] Fix | Delete

$logger->info( sprintf( '%s callback needs to run again', $callback ) );

[285] Fix | Delete

} elseif ( 1 === $item['iterate_num'] ) {

[286] Fix | Delete

$logger->info( sprintf( '%s callback needs to run more %d times', $callback, $item['total'] - $item['iterate_num'] ) );

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

++$item['iterate_num'];

[290] Fix | Delete

} else {

[291] Fix | Delete

$logger->info( sprintf( '%s Finished', $callback ) );

[292] Fix | Delete

}

[293] Fix | Delete

} else {

[294] Fix | Delete

$logger->notice( sprintf( 'Could not find %s callback', $callback ) );

[295] Fix | Delete

}

[296] Fix | Delete

[297] Fix | Delete

return $result ? $item : false;

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete

/**

[301] Fix | Delete

* Schedule cron healthcheck.

[302] Fix | Delete

*

[303] Fix | Delete

* @param array $schedules Schedules.

[304] Fix | Delete

* @return array

[305] Fix | Delete

*/

[306] Fix | Delete

public function schedule_cron_healthcheck( $schedules ) {

[307] Fix | Delete

$interval = apply_filters( $this->identifier . '_cron_interval', 5 );

[308] Fix | Delete

[309] Fix | Delete

// Adds every 5 minutes to the existing schedules.

[310] Fix | Delete

$schedules[ $this->identifier . '_cron_interval' ] = [

[311] Fix | Delete

'interval' => MINUTE_IN_SECONDS * $interval,

[312] Fix | Delete

'display' => sprintf(

[313] Fix | Delete

/* translators: %d: Interval in minutes. */

[314] Fix | Delete

esc_html__( 'Every %d minutes', 'elementor' ),

[315] Fix | Delete

$interval

[316] Fix | Delete

),

[317] Fix | Delete

];

[318] Fix | Delete

[319] Fix | Delete

return $schedules;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

/**

[323] Fix | Delete

* See if the batch limit has been exceeded.

[324] Fix | Delete

*

[325] Fix | Delete

* @return bool

[326] Fix | Delete

*/

[327] Fix | Delete

public function is_memory_exceeded() {

[328] Fix | Delete

return $this->memory_exceeded();

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

/**

[332] Fix | Delete

* Delete all batches.

[333] Fix | Delete

*

[334] Fix | Delete

* @return self

[335] Fix | Delete

*/

[336] Fix | Delete

public function delete_all_batches() {

[337] Fix | Delete

global $wpdb;

[338] Fix | Delete

[339] Fix | Delete

$table = $wpdb->options;

[340] Fix | Delete

$column = 'option_name';

[341] Fix | Delete

[342] Fix | Delete

if ( is_multisite() ) {

[343] Fix | Delete

$table = $wpdb->sitemeta;

[344] Fix | Delete

$column = 'meta_key';

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

$key = $wpdb->esc_like( $this->identifier . '_batch_' ) . '%';

[348] Fix | Delete

[349] Fix | Delete

$wpdb->query( $wpdb->prepare( "DELETE FROM {$table} WHERE {$column} LIKE %s", $key ) ); // @codingStandardsIgnoreLine.

[350] Fix | Delete

[351] Fix | Delete

return $this;

[352] Fix | Delete

}

[353] Fix | Delete

[354] Fix | Delete

/**

[355] Fix | Delete

* Kill process.

[356] Fix | Delete

*

[357] Fix | Delete

* Stop processing queue items, clear cronjob and delete all batches.

[358] Fix | Delete

*/

[359] Fix | Delete

public function kill_process() {

[360] Fix | Delete

if ( ! $this->is_queue_empty() ) {

[361] Fix | Delete

$this->delete_all_batches();

[362] Fix | Delete

wp_clear_scheduled_hook( $this->cron_hook_identifier );

[363] Fix | Delete

}

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

public function set_current_item( $item ) {

[367] Fix | Delete

$this->current_item = $item;

[368] Fix | Delete

}

[369] Fix | Delete

[370] Fix | Delete

protected function format_callback_log( $item ) {

[371] Fix | Delete

return implode( '::', (array) $item['callback'] );

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* @var \Elementor\Core\Base\Background_Task_Manager

[376] Fix | Delete

*/

[377] Fix | Delete

protected $manager;

[378] Fix | Delete

[379] Fix | Delete

public function __construct( $manager ) {

[380] Fix | Delete

$this->manager = $manager;

[381] Fix | Delete

// Uses unique prefix per blog so each blog has separate queue.

[382] Fix | Delete

$this->prefix = 'elementor_' . get_current_blog_id();

[383] Fix | Delete

$this->action = $this->manager->get_action();

[384] Fix | Delete

[385] Fix | Delete

parent::__construct();

[386] Fix | Delete

}

[387] Fix | Delete

}

[388] Fix | Delete

[389] Fix | Delete