<?php // @codingStandardsIgnoreLine.

[0] Fix | Delete

/**

[1] Fix | Delete

* Abstract WP_Background_Process class.

[2] Fix | Delete

*

[3] Fix | Delete

* @package WP-Background-Processing

[4] Fix | Delete

* @extends WP_Async_Request

[5] Fix | Delete

*/

[6] Fix | Delete

[7] Fix | Delete

defined( 'ABSPATH' ) || exit;

[8] Fix | Delete

[9] Fix | Delete

/**

[10] Fix | Delete

* Abstract WP_Background_Process class.

[11] Fix | Delete

*/

[12] Fix | Delete

abstract class WP_Background_Process extends WP_Async_Request {

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Action

[16] Fix | Delete

*

[17] Fix | Delete

* (default value: 'background_process')

[18] Fix | Delete

*

[19] Fix | Delete

* @var string

[20] Fix | Delete

* @access protected

[21] Fix | Delete

*/

[22] Fix | Delete

protected $action = 'background_process';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Start time of current process.

[26] Fix | Delete

*

[27] Fix | Delete

* (default value: 0)

[28] Fix | Delete

*

[29] Fix | Delete

* @var int

[30] Fix | Delete

* @access protected

[31] Fix | Delete

*/

[32] Fix | Delete

protected $start_time = 0;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Cron_hook_identifier

[36] Fix | Delete

*

[37] Fix | Delete

* @var mixed

[38] Fix | Delete

* @access protected

[39] Fix | Delete

*/

[40] Fix | Delete

protected $cron_hook_identifier;

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Cron_interval_identifier

[44] Fix | Delete

*

[45] Fix | Delete

* @var mixed

[46] Fix | Delete

* @access protected

[47] Fix | Delete

*/

[48] Fix | Delete

protected $cron_interval_identifier;

[49] Fix | Delete

[50] Fix | Delete

/**

[51] Fix | Delete

* Initiate new background process

[52] Fix | Delete

*/

[53] Fix | Delete

public function __construct() {

[54] Fix | Delete

parent::__construct();

[55] Fix | Delete

[56] Fix | Delete

$this->cron_hook_identifier = $this->identifier . '_cron';

[57] Fix | Delete

$this->cron_interval_identifier = $this->identifier . '_cron_interval';

[58] Fix | Delete

[59] Fix | Delete

add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );

[60] Fix | Delete

add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Dispatch

[65] Fix | Delete

*

[66] Fix | Delete

* @access public

[67] Fix | Delete

* @return array|WP_Error

[68] Fix | Delete

*/

[69] Fix | Delete

public function dispatch() {

[70] Fix | Delete

// Schedule the cron healthcheck.

[71] Fix | Delete

$this->schedule_event();

[72] Fix | Delete

[73] Fix | Delete

// Perform remote post.

[74] Fix | Delete

return parent::dispatch();

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

/**

[78] Fix | Delete

* Push to queue

[79] Fix | Delete

*

[80] Fix | Delete

* @param mixed $data Data.

[81] Fix | Delete

*

[82] Fix | Delete

* @return $this

[83] Fix | Delete

*/

[84] Fix | Delete

public function push_to_queue( $data ) {

[85] Fix | Delete

$this->data[] = $data;

[86] Fix | Delete

[87] Fix | Delete

return $this;

[88] Fix | Delete

}

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Save queue

[92] Fix | Delete

*

[93] Fix | Delete

* @return $this

[94] Fix | Delete

*/

[95] Fix | Delete

public function save() {

[96] Fix | Delete

$key = $this->generate_key();

[97] Fix | Delete

[98] Fix | Delete

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

[99] Fix | Delete

update_site_option( $key, $this->data );

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

return $this;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Update queue

[107] Fix | Delete

*

[108] Fix | Delete

* @param string $key Key.

[109] Fix | Delete

* @param array $data Data.

[110] Fix | Delete

*

[111] Fix | Delete

* @return $this

[112] Fix | Delete

*/

[113] Fix | Delete

public function update( $key, $data ) {

[114] Fix | Delete

if ( ! empty( $data ) ) {

[115] Fix | Delete

update_site_option( $key, $data );

[116] Fix | Delete

}

[117] Fix | Delete

[118] Fix | Delete

return $this;

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

* Delete queue

[123] Fix | Delete

*

[124] Fix | Delete

* @param string $key Key.

[125] Fix | Delete

*

[126] Fix | Delete

* @return $this

[127] Fix | Delete

*/

[128] Fix | Delete

public function delete( $key ) {

[129] Fix | Delete

delete_site_option( $key );

[130] Fix | Delete

[131] Fix | Delete

return $this;

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Generate key

[136] Fix | Delete

*

[137] Fix | Delete

* Generates a unique key based on microtime. Queue items are

[138] Fix | Delete

* given a unique key so that they can be merged upon save.

[139] Fix | Delete

*

[140] Fix | Delete

* @param int $length Length.

[141] Fix | Delete

*

[142] Fix | Delete

* @return string

[143] Fix | Delete

*/

[144] Fix | Delete

protected function generate_key( $length = 64 ) {

[145] Fix | Delete

$unique = md5( microtime() . rand() );

[146] Fix | Delete

$prepend = $this->identifier . '_batch_';

[147] Fix | Delete

[148] Fix | Delete

return substr( $prepend . $unique, 0, $length );

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

/**

[152] Fix | Delete

* Maybe process queue

[153] Fix | Delete

*

[154] Fix | Delete

* Checks whether data exists within the queue and that

[155] Fix | Delete

* the process is not already running.

[156] Fix | Delete

*/

[157] Fix | Delete

public function maybe_handle() {

[158] Fix | Delete

// Don't lock up other requests while processing

[159] Fix | Delete

session_write_close();

[160] Fix | Delete

[161] Fix | Delete

if ( $this->is_process_running() ) {

[162] Fix | Delete

// Background process already running.

[163] Fix | Delete

wp_die();

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

if ( $this->is_queue_empty() ) {

[167] Fix | Delete

// No data to process.

[168] Fix | Delete

wp_die();

[169] Fix | Delete

}

[170] Fix | Delete

[171] Fix | Delete

check_ajax_referer( $this->identifier, 'nonce' );

[172] Fix | Delete

[173] Fix | Delete

$this->handle();

[174] Fix | Delete

[175] Fix | Delete

wp_die();

[176] Fix | Delete

}

[177] Fix | Delete

[178] Fix | Delete

/**

[179] Fix | Delete

* Is queue empty

[180] Fix | Delete

*

[181] Fix | Delete

* @return bool

[182] Fix | Delete

*/

[183] Fix | Delete

protected function is_queue_empty() {

[184] Fix | Delete

global $wpdb;

[185] Fix | Delete

[186] Fix | Delete

$table = $wpdb->options;

[187] Fix | Delete

$column = 'option_name';

[188] Fix | Delete

[189] Fix | Delete

if ( is_multisite() ) {

[190] Fix | Delete

$table = $wpdb->sitemeta;

[191] Fix | Delete

$column = 'meta_key';

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

$key = $this->identifier . '_batch_%';

[195] Fix | Delete

[196] Fix | Delete

$count = $wpdb->get_var( $wpdb->prepare( "

[197] Fix | Delete

SELECT COUNT(*)

[198] Fix | Delete

FROM {$table}

[199] Fix | Delete

WHERE {$column} LIKE %s

[200] Fix | Delete

", $key ) );

[201] Fix | Delete

[202] Fix | Delete

return ! ( $count > 0 );

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

/**

[206] Fix | Delete

* Is process running

[207] Fix | Delete

*

[208] Fix | Delete

* Check whether the current process is already running

[209] Fix | Delete

* in a background process.

[210] Fix | Delete

*/

[211] Fix | Delete

protected function is_process_running() {

[212] Fix | Delete

if ( get_site_transient( $this->identifier . '_process_lock' ) ) {

[213] Fix | Delete

// Process already running.

[214] Fix | Delete

return true;

[215] Fix | Delete

}

[216] Fix | Delete

[217] Fix | Delete

return false;

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Lock process

[222] Fix | Delete

*

[223] Fix | Delete

* Lock the process so that multiple instances can't run simultaneously.

[224] Fix | Delete

* Override if applicable, but the duration should be greater than that

[225] Fix | Delete

* defined in the time_exceeded() method.

[226] Fix | Delete

*/

[227] Fix | Delete

protected function lock_process() {

[228] Fix | Delete

$this->start_time = time(); // Set start time of current process.

[229] Fix | Delete

[230] Fix | Delete

$lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute

[231] Fix | Delete

$lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );

[232] Fix | Delete

[233] Fix | Delete

set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );

[234] Fix | Delete

}

[235] Fix | Delete

[236] Fix | Delete

/**

[237] Fix | Delete

* Unlock process

[238] Fix | Delete

*

[239] Fix | Delete

* Unlock the process so that other instances can spawn.

[240] Fix | Delete

*

[241] Fix | Delete

* @return $this

[242] Fix | Delete

*/

[243] Fix | Delete

protected function unlock_process() {

[244] Fix | Delete

delete_site_transient( $this->identifier . '_process_lock' );

[245] Fix | Delete

[246] Fix | Delete

return $this;

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Get batch

[251] Fix | Delete

*

[252] Fix | Delete

* @return stdClass Return the first batch from the queue

[253] Fix | Delete

*/

[254] Fix | Delete

protected function get_batch() {

[255] Fix | Delete

global $wpdb;

[256] Fix | Delete

[257] Fix | Delete

$table = $wpdb->options;

[258] Fix | Delete

$column = 'option_name';

[259] Fix | Delete

$key_column = 'option_id';

[260] Fix | Delete

$value_column = 'option_value';

[261] Fix | Delete

[262] Fix | Delete

if ( is_multisite() ) {

[263] Fix | Delete

$table = $wpdb->sitemeta;

[264] Fix | Delete

$column = 'meta_key';

[265] Fix | Delete

$key_column = 'meta_id';

[266] Fix | Delete

$value_column = 'meta_value';

[267] Fix | Delete

}

[268] Fix | Delete

[269] Fix | Delete

$key = $this->identifier . '_batch_%';

[270] Fix | Delete

[271] Fix | Delete

$query = $wpdb->get_row( $wpdb->prepare( "

[272] Fix | Delete

SELECT *

[273] Fix | Delete

FROM {$table}

[274] Fix | Delete

WHERE {$column} LIKE %s

[275] Fix | Delete

ORDER BY {$key_column} ASC

[276] Fix | Delete

LIMIT 1

[277] Fix | Delete

", $key ) );

[278] Fix | Delete

[279] Fix | Delete

$batch = new stdClass();

[280] Fix | Delete

$batch->key = $query->$column;

[281] Fix | Delete

$batch->data = maybe_unserialize( $query->$value_column );

[282] Fix | Delete

[283] Fix | Delete

return $batch;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Handle

[288] Fix | Delete

*

[289] Fix | Delete

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

[290] Fix | Delete

* within server memory and time limit constraints.

[291] Fix | Delete

*/

[292] Fix | Delete

protected function handle() {

[293] Fix | Delete

$this->lock_process();

[294] Fix | Delete

[295] Fix | Delete

do {

[296] Fix | Delete

$batch = $this->get_batch();

[297] Fix | Delete

[298] Fix | Delete

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

[299] Fix | Delete

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

[300] Fix | Delete

[301] Fix | Delete

if ( false !== $task ) {

[302] Fix | Delete

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

[303] Fix | Delete

} else {

[304] Fix | Delete

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

[305] Fix | Delete

}

[306] Fix | Delete

[307] Fix | Delete

if ( $this->time_exceeded() || $this->memory_exceeded() ) {

[308] Fix | Delete

// Batch limits reached.

[309] Fix | Delete

break;

[310] Fix | Delete

}

[311] Fix | Delete

}

[312] Fix | Delete

[313] Fix | Delete

// Update or delete current batch.

[314] Fix | Delete

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

[315] Fix | Delete

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

[316] Fix | Delete

} else {

[317] Fix | Delete

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

[318] Fix | Delete

}

[319] Fix | Delete

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

[320] Fix | Delete

[321] Fix | Delete

$this->unlock_process();

[322] Fix | Delete

[323] Fix | Delete

// Start next batch or complete process.

[324] Fix | Delete

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

[325] Fix | Delete

$this->dispatch();

[326] Fix | Delete

} else {

[327] Fix | Delete

$this->complete();

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

wp_die();

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Memory exceeded

[335] Fix | Delete

*

[336] Fix | Delete

* Ensures the batch process never exceeds 90%

[337] Fix | Delete

* of the maximum WordPress memory.

[338] Fix | Delete

*

[339] Fix | Delete

* @return bool

[340] Fix | Delete

*/

[341] Fix | Delete

protected function memory_exceeded() {

[342] Fix | Delete

$memory_limit = $this->get_memory_limit() * 0.9; // 90% of max memory

[343] Fix | Delete

$current_memory = memory_get_usage( true );

[344] Fix | Delete

$return = false;

[345] Fix | Delete

[346] Fix | Delete

if ( $current_memory >= $memory_limit ) {

[347] Fix | Delete

$return = true;

[348] Fix | Delete

}

[349] Fix | Delete

[350] Fix | Delete

return apply_filters( $this->identifier . '_memory_exceeded', $return );

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

/**

[354] Fix | Delete

* Get memory limit

[355] Fix | Delete

*

[356] Fix | Delete

* @return int

[357] Fix | Delete

*/

[358] Fix | Delete

protected function get_memory_limit() {

[359] Fix | Delete

if ( function_exists( 'ini_get' ) ) {

[360] Fix | Delete

$memory_limit = ini_get( 'memory_limit' );

[361] Fix | Delete

} else {

[362] Fix | Delete

// Sensible default.

[363] Fix | Delete

$memory_limit = '128M';

[364] Fix | Delete

}

[365] Fix | Delete

[366] Fix | Delete

if ( ! $memory_limit || -1 === $memory_limit ) {

[367] Fix | Delete

// Unlimited, set to 32GB.

[368] Fix | Delete

$memory_limit = '32000M';

[369] Fix | Delete

}

[370] Fix | Delete

[371] Fix | Delete

return wp_convert_hr_to_bytes( $memory_limit );

[372] Fix | Delete

}

[373] Fix | Delete

[374] Fix | Delete

/**

[375] Fix | Delete

* Time exceeded.

[376] Fix | Delete

*

[377] Fix | Delete

* Ensures the batch never exceeds a sensible time limit.

[378] Fix | Delete

* A timeout limit of 30s is common on shared hosting.

[379] Fix | Delete

*

[380] Fix | Delete

* @return bool

[381] Fix | Delete

*/

[382] Fix | Delete

protected function time_exceeded() {

[383] Fix | Delete

$finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds

[384] Fix | Delete

$return = false;

[385] Fix | Delete

[386] Fix | Delete

if ( time() >= $finish ) {

[387] Fix | Delete

$return = true;

[388] Fix | Delete

}

[389] Fix | Delete

[390] Fix | Delete

return apply_filters( $this->identifier . '_time_exceeded', $return );

[391] Fix | Delete

}

[392] Fix | Delete

[393] Fix | Delete

/**

[394] Fix | Delete

* Complete.

[395] Fix | Delete

*

[396] Fix | Delete

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

[397] Fix | Delete

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

[398] Fix | Delete

*/

[399] Fix | Delete

protected function complete() {

[400] Fix | Delete

// Unschedule the cron healthcheck.

[401] Fix | Delete

$this->clear_scheduled_event();

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

/**

[405] Fix | Delete

* Schedule cron healthcheck

[406] Fix | Delete

*

[407] Fix | Delete

* @access public

[408] Fix | Delete

* @param mixed $schedules Schedules.

[409] Fix | Delete

* @return mixed

[410] Fix | Delete

*/

[411] Fix | Delete

public function schedule_cron_healthcheck( $schedules ) {

[412] Fix | Delete

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

[413] Fix | Delete

[414] Fix | Delete

if ( property_exists( $this, 'cron_interval' ) ) {

[415] Fix | Delete

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

[416] Fix | Delete

}

[417] Fix | Delete

[418] Fix | Delete

// Adds every 5 minutes to the existing schedules.

[419] Fix | Delete

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

[420] Fix | Delete

'interval' => MINUTE_IN_SECONDS * $interval,

[421] Fix | Delete

'display' => sprintf( __( 'Every %d minutes', 'woocommerce' ), $interval ),

[422] Fix | Delete

);

[423] Fix | Delete

[424] Fix | Delete

return $schedules;

[425] Fix | Delete

}

[426] Fix | Delete

[427] Fix | Delete

/**

[428] Fix | Delete

* Handle cron healthcheck

[429] Fix | Delete

*

[430] Fix | Delete

* Restart the background process if not already running

[431] Fix | Delete

* and data exists in the queue.

[432] Fix | Delete

*/

[433] Fix | Delete

public function handle_cron_healthcheck() {

[434] Fix | Delete

if ( $this->is_process_running() ) {

[435] Fix | Delete

// Background process already running.

[436] Fix | Delete

exit;

[437] Fix | Delete

}

[438] Fix | Delete

[439] Fix | Delete

if ( $this->is_queue_empty() ) {

[440] Fix | Delete

// No data to process.

[441] Fix | Delete

$this->clear_scheduled_event();

[442] Fix | Delete

exit;

[443] Fix | Delete

}

[444] Fix | Delete

[445] Fix | Delete

$this->handle();

[446] Fix | Delete

[447] Fix | Delete

exit;

[448] Fix | Delete

}

[449] Fix | Delete

[450] Fix | Delete

/**

[451] Fix | Delete

* Schedule event

[452] Fix | Delete

*/

[453] Fix | Delete

protected function schedule_event() {

[454] Fix | Delete

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

[455] Fix | Delete

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

[456] Fix | Delete

}

[457] Fix | Delete

}

[458] Fix | Delete

[459] Fix | Delete

/**

[460] Fix | Delete

* Clear scheduled event

[461] Fix | Delete

*/

[462] Fix | Delete

protected function clear_scheduled_event() {

[463] Fix | Delete

$timestamp = wp_next_scheduled( $this->cron_hook_identifier );

[464] Fix | Delete

[465] Fix | Delete

if ( $timestamp ) {

[466] Fix | Delete

wp_unschedule_event( $timestamp, $this->cron_hook_identifier );

[467] Fix | Delete

}

[468] Fix | Delete

}

[469] Fix | Delete

[470] Fix | Delete

/**

[471] Fix | Delete

* Cancel Process

[472] Fix | Delete

*

[473] Fix | Delete

* Stop processing queue items, clear cronjob and delete batch.

[474] Fix | Delete

*

[475] Fix | Delete

*/

[476] Fix | Delete

public function cancel_process() {

[477] Fix | Delete

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

[478] Fix | Delete

$batch = $this->get_batch();

[479] Fix | Delete

[480] Fix | Delete

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

[481] Fix | Delete

[482] Fix | Delete

wp_clear_scheduled_hook( $this->cron_hook_identifier );

[483] Fix | Delete

}

[484] Fix | Delete

[485] Fix | Delete

}

[486] Fix | Delete

[487] Fix | Delete

/**

[488] Fix | Delete

* Task

[489] Fix | Delete

*

[490] Fix | Delete

* Override this method to perform any actions required on each

[491] Fix | Delete

* queue item. Return the modified item for further processing

[492] Fix | Delete

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

[493] Fix | Delete

* item from the queue.

[494] Fix | Delete

*

[495] Fix | Delete

* @param mixed $item Queue item to iterate over.

[496] Fix | Delete

*

[497] Fix | Delete

* @return mixed

[498] Fix | Delete

*/

[499] Fix | Delete