<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Tasks;

[2] Fix | Delete

[3] Fix | Delete

use InvalidArgumentException;

[4] Fix | Delete

use UnexpectedValueException;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Class Task.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.5.9

[10] Fix | Delete

*/

[11] Fix | Delete

class Task {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* This task is async (runs asap).

[15] Fix | Delete

*

[16] Fix | Delete

* @since 1.5.9

[17] Fix | Delete

*/

[18] Fix | Delete

const TYPE_ASYNC = 'async';

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* This task is a recurring.

[22] Fix | Delete

*

[23] Fix | Delete

* @since 1.5.9

[24] Fix | Delete

*/

[25] Fix | Delete

const TYPE_RECURRING = 'scheduled';

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* This task is run once.

[29] Fix | Delete

*

[30] Fix | Delete

* @since 1.5.9

[31] Fix | Delete

*/

[32] Fix | Delete

const TYPE_ONCE = 'once';

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Type of the task.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.5.9

[38] Fix | Delete

*

[39] Fix | Delete

* @var string

[40] Fix | Delete

*/

[41] Fix | Delete

private $type;

[42] Fix | Delete

[43] Fix | Delete

/**

[44] Fix | Delete

* Action that will be used as a hook.

[45] Fix | Delete

*

[46] Fix | Delete

* @since 1.5.9

[47] Fix | Delete

*

[48] Fix | Delete

* @var string

[49] Fix | Delete

*/

[50] Fix | Delete

private $action;

[51] Fix | Delete

[52] Fix | Delete

/**

[53] Fix | Delete

* Task meta ID.

[54] Fix | Delete

*

[55] Fix | Delete

* @since 1.5.9

[56] Fix | Delete

*

[57] Fix | Delete

* @var int

[58] Fix | Delete

*/

[59] Fix | Delete

private $meta_id;

[60] Fix | Delete

[61] Fix | Delete

/**

[62] Fix | Delete

* All the params that should be passed to the hook.

[63] Fix | Delete

*

[64] Fix | Delete

* @since 1.5.9

[65] Fix | Delete

*

[66] Fix | Delete

* @var array

[67] Fix | Delete

*/

[68] Fix | Delete

private $params;

[69] Fix | Delete

[70] Fix | Delete

/**

[71] Fix | Delete

* When the first instance of the job will run.

[72] Fix | Delete

* Used for ONCE ane RECURRING tasks.

[73] Fix | Delete

*

[74] Fix | Delete

* @since 1.5.9

[75] Fix | Delete

*

[76] Fix | Delete

* @var int

[77] Fix | Delete

*/

[78] Fix | Delete

private $timestamp;

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* How long to wait between runs.

[82] Fix | Delete

* Used for RECURRING tasks.

[83] Fix | Delete

*

[84] Fix | Delete

* @since 1.5.9

[85] Fix | Delete

*

[86] Fix | Delete

* @var int

[87] Fix | Delete

*/

[88] Fix | Delete

private $interval;

[89] Fix | Delete

[90] Fix | Delete

/**

[91] Fix | Delete

* Task meta.

[92] Fix | Delete

*

[93] Fix | Delete

* @since 1.7.0

[94] Fix | Delete

*

[95] Fix | Delete

* @var Meta

[96] Fix | Delete

*/

[97] Fix | Delete

private $meta;

[98] Fix | Delete

[99] Fix | Delete

/**

[100] Fix | Delete

* Log title.

[101] Fix | Delete

*

[102] Fix | Delete

* @since 1.9.1

[103] Fix | Delete

*

[104] Fix | Delete

* @var string

[105] Fix | Delete

*/

[106] Fix | Delete

protected $log_title = 'Task';

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Task constructor.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 1.5.9

[112] Fix | Delete

*

[113] Fix | Delete

* @param string $action Action of the task.

[114] Fix | Delete

*

[115] Fix | Delete

* @throws InvalidArgumentException When action is not a string.

[116] Fix | Delete

* @throws UnexpectedValueException When action is empty.

[117] Fix | Delete

*/

[118] Fix | Delete

public function __construct( $action ) {

[119] Fix | Delete

[120] Fix | Delete

if ( ! is_string( $action ) ) {

[121] Fix | Delete

throw new InvalidArgumentException( 'Task action should be a string.' );

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

$this->action = sanitize_key( $action );

[125] Fix | Delete

$this->meta = new Meta();

[126] Fix | Delete

[127] Fix | Delete

if ( empty( $this->action ) ) {

[128] Fix | Delete

throw new UnexpectedValueException( 'Task action cannot be empty.' );

[129] Fix | Delete

}

[130] Fix | Delete

}

[131] Fix | Delete

[132] Fix | Delete

/**

[133] Fix | Delete

* Define the type of the task as async.

[134] Fix | Delete

*

[135] Fix | Delete

* @since 1.5.9

[136] Fix | Delete

*

[137] Fix | Delete

* @return Task

[138] Fix | Delete

*/

[139] Fix | Delete

public function async() {

[140] Fix | Delete

[141] Fix | Delete

$this->type = self::TYPE_ASYNC;

[142] Fix | Delete

[143] Fix | Delete

return $this;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

/**

[147] Fix | Delete

* Define the type of the task as recurring.

[148] Fix | Delete

*

[149] Fix | Delete

* @since 1.5.9

[150] Fix | Delete

*

[151] Fix | Delete

* @param int $timestamp When the first instance of the job will run.

[152] Fix | Delete

* @param int $interval How long to wait between runs.

[153] Fix | Delete

*

[154] Fix | Delete

* @return Task

[155] Fix | Delete

*/

[156] Fix | Delete

public function recurring( $timestamp, $interval ) {

[157] Fix | Delete

[158] Fix | Delete

$this->type = self::TYPE_RECURRING;

[159] Fix | Delete

$this->timestamp = (int) $timestamp;

[160] Fix | Delete

$this->interval = (int) $interval;

[161] Fix | Delete

[162] Fix | Delete

return $this;

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Define the type of the task as one-time.

[167] Fix | Delete

*

[168] Fix | Delete

* @since 1.5.9

[169] Fix | Delete

*

[170] Fix | Delete

* @param int $timestamp When the first instance of the job will run.

[171] Fix | Delete

*

[172] Fix | Delete

* @return Task

[173] Fix | Delete

*/

[174] Fix | Delete

public function once( $timestamp ) {

[175] Fix | Delete

[176] Fix | Delete

$this->type = self::TYPE_ONCE;

[177] Fix | Delete

$this->timestamp = (int) $timestamp;

[178] Fix | Delete

[179] Fix | Delete

return $this;

[180] Fix | Delete

}

[181] Fix | Delete

[182] Fix | Delete

/**

[183] Fix | Delete

* Pass any number of params that should be saved to Meta table.

[184] Fix | Delete

*

[185] Fix | Delete

* @since 1.5.9

[186] Fix | Delete

*

[187] Fix | Delete

* @return Task

[188] Fix | Delete

*/

[189] Fix | Delete

public function params() {

[190] Fix | Delete

[191] Fix | Delete

$this->params = func_get_args();

[192] Fix | Delete

[193] Fix | Delete

return $this;

[194] Fix | Delete

}

[195] Fix | Delete

[196] Fix | Delete

/**

[197] Fix | Delete

* Register the action.

[198] Fix | Delete

* Should be the final call in a chain.

[199] Fix | Delete

*

[200] Fix | Delete

* @since 1.5.9

[201] Fix | Delete

*

[202] Fix | Delete

* @return null|string Action ID.

[203] Fix | Delete

*/

[204] Fix | Delete

public function register() {

[205] Fix | Delete

[206] Fix | Delete

$action_id = null;

[207] Fix | Delete

[208] Fix | Delete

// No processing if ActionScheduler is not usable.

[209] Fix | Delete

if ( ! wpforms()->obj( 'tasks' )->is_usable() ) {

[210] Fix | Delete

return $action_id;

[211] Fix | Delete

}

[212] Fix | Delete

[213] Fix | Delete

// Save data to tasks meta table.

[214] Fix | Delete

if ( $this->params !== null ) {

[215] Fix | Delete

$this->meta_id = $this->meta->add(

[216] Fix | Delete

[

[217] Fix | Delete

'action' => $this->action,

[218] Fix | Delete

'data' => $this->params,

[219] Fix | Delete

]

[220] Fix | Delete

);

[221] Fix | Delete

[222] Fix | Delete

if ( empty( $this->meta_id ) ) {

[223] Fix | Delete

return $action_id;

[224] Fix | Delete

}

[225] Fix | Delete

}

[226] Fix | Delete

[227] Fix | Delete

// Prevent 500 errors when Action Scheduler tables don't exist.

[228] Fix | Delete

try {

[229] Fix | Delete

[230] Fix | Delete

switch ( $this->type ) {

[231] Fix | Delete

case self::TYPE_ASYNC:

[232] Fix | Delete

$action_id = $this->register_async();

[233] Fix | Delete

break;

[234] Fix | Delete

[235] Fix | Delete

case self::TYPE_RECURRING:

[236] Fix | Delete

$action_id = $this->register_recurring();

[237] Fix | Delete

break;

[238] Fix | Delete

[239] Fix | Delete

case self::TYPE_ONCE:

[240] Fix | Delete

$action_id = $this->register_once();

[241] Fix | Delete

break;

[242] Fix | Delete

}

[243] Fix | Delete

} catch ( \RuntimeException $exception ) {

[244] Fix | Delete

$action_id = null;

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

return $action_id;

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Register the async task.

[252] Fix | Delete

*

[253] Fix | Delete

* @since 1.5.9

[254] Fix | Delete

*

[255] Fix | Delete

* @return null|string Action ID.

[256] Fix | Delete

* @noinspection PhpUndefinedFunctionInspection

[257] Fix | Delete

*/

[258] Fix | Delete

protected function register_async() {

[259] Fix | Delete

[260] Fix | Delete

if ( ! function_exists( 'as_enqueue_async_action' ) ) {

[261] Fix | Delete

return null;

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

return as_enqueue_async_action(

[265] Fix | Delete

$this->action,

[266] Fix | Delete

/**

[267] Fix | Delete

* Filter arguments passed to the async task.

[268] Fix | Delete

*

[269] Fix | Delete

* @since 1.9.4

[270] Fix | Delete

*

[271] Fix | Delete

* @param array $args Arguments passed to the async task.

[272] Fix | Delete

*

[273] Fix | Delete

* @return array

[274] Fix | Delete

*/

[275] Fix | Delete

(array) apply_filters(

[276] Fix | Delete

'wpforms_tasks_task_register_async_args',

[277] Fix | Delete

[

[278] Fix | Delete

'tasks_meta_id' => $this->meta_id,

[279] Fix | Delete

]

[280] Fix | Delete

),

[281] Fix | Delete

Tasks::GROUP

[282] Fix | Delete

);

[283] Fix | Delete

}

[284] Fix | Delete

[285] Fix | Delete

/**

[286] Fix | Delete

* Register the recurring task.

[287] Fix | Delete

*

[288] Fix | Delete

* @since 1.5.9

[289] Fix | Delete

*

[290] Fix | Delete

* @return null|string Action ID.

[291] Fix | Delete

* @noinspection PhpUndefinedFunctionInspection

[292] Fix | Delete

*/

[293] Fix | Delete

protected function register_recurring() {

[294] Fix | Delete

[295] Fix | Delete

if ( ! function_exists( 'as_schedule_recurring_action' ) ) {

[296] Fix | Delete

return null;

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

return as_schedule_recurring_action(

[300] Fix | Delete

$this->timestamp,

[301] Fix | Delete

$this->interval,

[302] Fix | Delete

$this->action,

[303] Fix | Delete

[ 'tasks_meta_id' => $this->meta_id ],

[304] Fix | Delete

Tasks::GROUP

[305] Fix | Delete

);

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

/**

[309] Fix | Delete

* Register the one-time task.

[310] Fix | Delete

*

[311] Fix | Delete

* @since 1.5.9

[312] Fix | Delete

*

[313] Fix | Delete

* @return null|string Action ID.

[314] Fix | Delete

* @noinspection PhpUndefinedFunctionInspection

[315] Fix | Delete

*/

[316] Fix | Delete

protected function register_once() {

[317] Fix | Delete

[318] Fix | Delete

if ( ! function_exists( 'as_schedule_single_action' ) ) {

[319] Fix | Delete

return null;

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

return as_schedule_single_action(

[323] Fix | Delete

$this->timestamp,

[324] Fix | Delete

$this->action,

[325] Fix | Delete

[ 'tasks_meta_id' => $this->meta_id ],

[326] Fix | Delete

Tasks::GROUP

[327] Fix | Delete

);

[328] Fix | Delete

}

[329] Fix | Delete

[330] Fix | Delete

/**

[331] Fix | Delete

* Cancel all occurrences of this task.

[332] Fix | Delete

*

[333] Fix | Delete

* @since 1.6.1

[334] Fix | Delete

*

[335] Fix | Delete

* @return null|bool|string Null if no matching action found,

[336] Fix | Delete

* false if AS library is missing,

[337] Fix | Delete

* true if scheduled task has no params,

[338] Fix | Delete

* string of the scheduled action ID if a scheduled action was found and unscheduled.

[339] Fix | Delete

* @noinspection PhpUndefinedFunctionInspection

[340] Fix | Delete

*/

[341] Fix | Delete

public function cancel() {

[342] Fix | Delete

[343] Fix | Delete

if ( ! function_exists( 'as_unschedule_all_actions' ) ) {

[344] Fix | Delete

return false;

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

if ( $this->params === null ) {

[348] Fix | Delete

as_unschedule_all_actions( $this->action );

[349] Fix | Delete

[350] Fix | Delete

return true;

[351] Fix | Delete

}

[352] Fix | Delete

[353] Fix | Delete

$this->meta_id = $this->meta->get_meta_id( $this->action, $this->params );

[354] Fix | Delete

[355] Fix | Delete

if ( $this->meta_id === null ) {

[356] Fix | Delete

return null;

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete

return as_unschedule_action( $this->action, [ 'tasks_meta_id' => $this->meta_id ], Tasks::GROUP );

[360] Fix | Delete

}

[361] Fix | Delete

[362] Fix | Delete

[363] Fix | Delete

[364] Fix | Delete

/**

[365] Fix | Delete

* Log message to WPForms logger and standard debug.log file.

[366] Fix | Delete

*

[367] Fix | Delete

* @since 1.9.1

[368] Fix | Delete

*

[369] Fix | Delete

* @param string $message The error message that should be logged.

[370] Fix | Delete

*/

[371] Fix | Delete

protected function log( $message ) {

[372] Fix | Delete

[373] Fix | Delete

wpforms_log( $this->log_title, $message, [ 'type' => 'log' ] );

[374] Fix | Delete

}

[375] Fix | Delete

}

[376] Fix | Delete

[377] Fix | Delete