<?php

[0] Fix | Delete

[1] Fix | Delete

// phpcs:ignore Generic.Commenting.DocComment.MissingShort

[2] Fix | Delete

/** @noinspection PhpUndefinedClassInspection */

[3] Fix | Delete

[4] Fix | Delete

namespace WPForms\Tasks;

[5] Fix | Delete

[6] Fix | Delete

use ActionScheduler;

[7] Fix | Delete

use ActionScheduler_Action;

[8] Fix | Delete

use ActionScheduler_DataController;

[9] Fix | Delete

use ActionScheduler_DBStore;

[10] Fix | Delete

use WPForms\Helpers\Transient;

[11] Fix | Delete

use WPForms\Tasks\Actions\EntryEmailsMetaCleanupTask;

[12] Fix | Delete

use WPForms\Tasks\Actions\EntryEmailsTask;

[13] Fix | Delete

use WPForms\Tasks\Actions\FormsLocatorScanTask;

[14] Fix | Delete

use WPForms\Tasks\Actions\AsyncRequestTask;

[15] Fix | Delete

use WPForms\Tasks\Actions\PurgeSpamTask;

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Class Tasks manages the tasks queue and provides API to work with it.

[19] Fix | Delete

*

[20] Fix | Delete

* @since 1.5.9

[21] Fix | Delete

*/

[22] Fix | Delete

class Tasks {

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Group that will be assigned to all actions.

[26] Fix | Delete

*

[27] Fix | Delete

* @since 1.5.9

[28] Fix | Delete

*/

[29] Fix | Delete

const GROUP = 'wpforms';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Actions setting name.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.7.3

[35] Fix | Delete

*/

[36] Fix | Delete

const ACTIONS = 'actions';

[37] Fix | Delete

[38] Fix | Delete

/**

[39] Fix | Delete

* WPForms pending or in-progress actions.

[40] Fix | Delete

*

[41] Fix | Delete

* @since 1.7.3

[42] Fix | Delete

*

[43] Fix | Delete

* @var array

[44] Fix | Delete

*/

[45] Fix | Delete

private $active_actions;

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Determine if WPForms task is executing.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 1.9.4

[51] Fix | Delete

*

[52] Fix | Delete

* @var bool

[53] Fix | Delete

*/

[54] Fix | Delete

private static $task_executing = false;

[55] Fix | Delete

[56] Fix | Delete

/**

[57] Fix | Delete

* Perform certain things on class init.

[58] Fix | Delete

*

[59] Fix | Delete

* @since 1.5.9

[60] Fix | Delete

*/

[61] Fix | Delete

public function init() {

[62] Fix | Delete

[63] Fix | Delete

// Get WPForms pending or in-progress actions.

[64] Fix | Delete

$this->active_actions = $this->get_active_actions();

[65] Fix | Delete

[66] Fix | Delete

// Register WPForms tasks.

[67] Fix | Delete

foreach ( $this->get_tasks() as $task ) {

[68] Fix | Delete

[69] Fix | Delete

if ( ! is_subclass_of( $task, Task::class ) ) {

[70] Fix | Delete

continue;

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

new $task();

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

$this->hooks();

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

/**

[80] Fix | Delete

* Hooks.

[81] Fix | Delete

*

[82] Fix | Delete

* @since 1.7.5

[83] Fix | Delete

*/

[84] Fix | Delete

public function hooks() {

[85] Fix | Delete

[86] Fix | Delete

add_action( 'delete_expired_transients', [ Transient::class, 'delete_all_expired' ], 11 );

[87] Fix | Delete

add_action( 'admin_menu', [ $this, 'admin_hide_as_menu' ], PHP_INT_MAX );

[88] Fix | Delete

[89] Fix | Delete

/*

[90] Fix | Delete

* By default we send emails in the same process as the form submission is done.

[91] Fix | Delete

* That means that when many emails are set in form Notifications -

[92] Fix | Delete

* the form submission can take a while because of all those emails that are sending in the background.

[93] Fix | Delete

* Since WPForms 1.6.0 users can enable a new option in Settings > Emails,

[94] Fix | Delete

* called "Optimize Email Sending", to send email in async way.

[95] Fix | Delete

* This feature was enabled for WPForms 1.5.9, but some users were not happy.

[96] Fix | Delete

*/

[97] Fix | Delete

if ( ! (bool) wpforms_setting( 'email-async', false ) ) {

[98] Fix | Delete

add_filter( 'wpforms_tasks_entry_emails_trigger_send_same_process', '__return_true' );

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

add_action( EntryEmailsTask::ACTION, [ EntryEmailsTask::class, 'process' ] );

[102] Fix | Delete

add_action( 'action_scheduler_after_execute', [ $this, 'clear_action_meta' ], PHP_INT_MAX, 2 );

[103] Fix | Delete

[104] Fix | Delete

add_action( 'action_scheduler_begin_execute', [ $this, 'start_executing' ], 1 );

[105] Fix | Delete

add_action( 'action_scheduler_after_execute', [ $this, 'stop_executing' ], 1, 2 );

[106] Fix | Delete

}

[107] Fix | Delete

[108] Fix | Delete

/**

[109] Fix | Delete

* Public interface to check if WPForms task is executing.

[110] Fix | Delete

*

[111] Fix | Delete

* @since 1.9.4

[112] Fix | Delete

*

[113] Fix | Delete

* @return bool

[114] Fix | Delete

*/

[115] Fix | Delete

public static function is_executing(): bool {

[116] Fix | Delete

[117] Fix | Delete

return self::$task_executing;

[118] Fix | Delete

}

[119] Fix | Delete

[120] Fix | Delete

/**

[121] Fix | Delete

* Set a flag to indicate that WPForms task is executing.

[122] Fix | Delete

*

[123] Fix | Delete

* @since 1.9.4

[124] Fix | Delete

*

[125] Fix | Delete

* @param int $action_id The action ID to process.

[126] Fix | Delete

*/

[127] Fix | Delete

public function start_executing( $action_id ) {

[128] Fix | Delete

[129] Fix | Delete

$action_id = (int) $action_id;

[130] Fix | Delete

[131] Fix | Delete

if ( ! class_exists( 'ActionScheduler' ) ) {

[132] Fix | Delete

return;

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

$store = ActionScheduler::store();

[136] Fix | Delete

[137] Fix | Delete

if ( ! $store ) {

[138] Fix | Delete

return;

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

$action = $store->fetch_action( $action_id );

[142] Fix | Delete

[143] Fix | Delete

if ( ! $action || $action->get_group() !== self::GROUP ) {

[144] Fix | Delete

return;

[145] Fix | Delete

}

[146] Fix | Delete

[147] Fix | Delete

self::$task_executing = true;

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* Fires before WPForms task is executing.

[151] Fix | Delete

*

[152] Fix | Delete

* @since 1.9.4

[153] Fix | Delete

*

[154] Fix | Delete

* @param int $action_id The action ID to process.

[155] Fix | Delete

* @param ActionScheduler_Action $action Action Scheduler action object.

[156] Fix | Delete

*/

[157] Fix | Delete

do_action( 'wpforms_tasks_start_executing', $action_id, $action );

[158] Fix | Delete

}

[159] Fix | Delete

[160] Fix | Delete

/**

[161] Fix | Delete

* Set a flag to indicate that WPForms task is executing.

[162] Fix | Delete

*

[163] Fix | Delete

* @since 1.9.4

[164] Fix | Delete

*

[165] Fix | Delete

* @param int $action_id The action ID to process.

[166] Fix | Delete

* @param ActionScheduler_Action $action Action Scheduler action object.

[167] Fix | Delete

*/

[168] Fix | Delete

public function stop_executing( $action_id, $action ) {

[169] Fix | Delete

[170] Fix | Delete

if ( ! $action || ! method_exists( $action, 'get_group' ) || $action->get_group() !== self::GROUP ) {

[171] Fix | Delete

return;

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

self::$task_executing = false;

[175] Fix | Delete

[176] Fix | Delete

/**

[177] Fix | Delete

* Fires after WPForms task is executed.

[178] Fix | Delete

*

[179] Fix | Delete

* @since 1.9.4

[180] Fix | Delete

*

[181] Fix | Delete

* @param int $action_id The action ID to process.

[182] Fix | Delete

* @param ActionScheduler_Action $action Action Scheduler action object.

[183] Fix | Delete

*/

[184] Fix | Delete

do_action( 'wpforms_tasks_stop_executing', $action_id, $action );

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Get the list of WPForms default scheduled tasks.

[189] Fix | Delete

* Tasks, that are fired under certain specific circumstances

[190] Fix | Delete

* (like sending form submission email notifications)

[191] Fix | Delete

* are not listed here.

[192] Fix | Delete

*

[193] Fix | Delete

* @since 1.5.9

[194] Fix | Delete

*

[195] Fix | Delete

* @return Task[] List of tasks classes.

[196] Fix | Delete

*/

[197] Fix | Delete

public function get_tasks() {

[198] Fix | Delete

[199] Fix | Delete

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

[200] Fix | Delete

return [];

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

$tasks = [

[204] Fix | Delete

EntryEmailsMetaCleanupTask::class,

[205] Fix | Delete

FormsLocatorScanTask::class,

[206] Fix | Delete

AsyncRequestTask::class,

[207] Fix | Delete

PurgeSpamTask::class,

[208] Fix | Delete

];

[209] Fix | Delete

[210] Fix | Delete

/**

[211] Fix | Delete

* Filters the task class list to initialize.

[212] Fix | Delete

*

[213] Fix | Delete

* @since 1.5.9

[214] Fix | Delete

*

[215] Fix | Delete

* @param array $tasks Task class list.

[216] Fix | Delete

*/

[217] Fix | Delete

return apply_filters( 'wpforms_tasks_get_tasks', $tasks );

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

/**

[221] Fix | Delete

* Hide Action Scheduler admin area when not in debug mode.

[222] Fix | Delete

*

[223] Fix | Delete

* @since 1.5.9

[224] Fix | Delete

* @since 1.9.4 Does not hide the menu when some popular plugins are active.

[225] Fix | Delete

*/

[226] Fix | Delete

public function admin_hide_as_menu(): void {

[227] Fix | Delete

[228] Fix | Delete

$plugin_exceptions = [

[229] Fix | Delete

'action-scheduler/action-scheduler.php',

[230] Fix | Delete

'woocommerce/woocommerce.php',

[231] Fix | Delete

'wp-rocket/wp-rocket.php',

[232] Fix | Delete

];

[233] Fix | Delete

[234] Fix | Delete

/**

[235] Fix | Delete

* Filters the list of plugins for which

[236] Fix | Delete

* the Action Scheduler Tools -> Scheduled Actions menu item

[237] Fix | Delete

* should remain visible.

[238] Fix | Delete

*

[239] Fix | Delete

* @since 1.9.4

[240] Fix | Delete

*

[241] Fix | Delete

* @param array $plugin_exceptions List of plugin exceptions.

[242] Fix | Delete

*/

[243] Fix | Delete

$plugin_exceptions = apply_filters( 'wpforms_tasks_action_scheduler_tools_plugin_exceptions', $plugin_exceptions );

[244] Fix | Delete

$show_as_menu =

[245] Fix | Delete

( defined( 'WPFORMS_SHOW_ACTION_SCHEDULER_MENU' ) && constant( 'WPFORMS_SHOW_ACTION_SCHEDULER_MENU' ) ) ||

[246] Fix | Delete

wpforms_debug() ||

[247] Fix | Delete

! empty( array_filter( $plugin_exceptions, 'is_plugin_active' ) );

[248] Fix | Delete

$hide_as_menu = ! $show_as_menu;

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Filter to redefine that WPForms hides Tools > Action Scheduler menu item.

[252] Fix | Delete

*

[253] Fix | Delete

* @since 1.5.9

[254] Fix | Delete

*

[255] Fix | Delete

* @param bool $hide_as_menu Hide Tools > Action Scheduler menu item.

[256] Fix | Delete

*/

[257] Fix | Delete

if ( apply_filters( 'wpforms_tasks_admin_hide_as_menu', $hide_as_menu ) ) {

[258] Fix | Delete

remove_submenu_page( 'tools.php', 'action-scheduler' );

[259] Fix | Delete

}

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Create a new task.

[264] Fix | Delete

* Used for "inline" tasks, that require additional information

[265] Fix | Delete

* from the plugin runtime before they can be scheduled.

[266] Fix | Delete

*

[267] Fix | Delete

* Example:

[268] Fix | Delete

* wpforms()->obj( 'tasks' )

[269] Fix | Delete

* ->create( 'i_am_the_dude' )

[270] Fix | Delete

* ->async()

[271] Fix | Delete

* ->params( 'The Big Lebowski', 1998 )

[272] Fix | Delete

* ->register();

[273] Fix | Delete

*

[274] Fix | Delete

* This `i_am_the_dude` action will be later processed as:

[275] Fix | Delete

* add_action( 'i_am_the_dude', 'thats_what_you_call_me' );

[276] Fix | Delete

*

[277] Fix | Delete

* Function `thats_what_you_call_me()` will receive `$meta_id` param,

[278] Fix | Delete

* and you will be able to receive all params from the action like this:

[279] Fix | Delete

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

[280] Fix | Delete

* list( $name, $year ) = $params->data;

[281] Fix | Delete

*

[282] Fix | Delete

* @since 1.5.9

[283] Fix | Delete

*

[284] Fix | Delete

* @param string $action Action that will be used as a hook.

[285] Fix | Delete

*

[286] Fix | Delete

* @return Task

[287] Fix | Delete

*/

[288] Fix | Delete

public function create( $action ) {

[289] Fix | Delete

[290] Fix | Delete

return new Task( $action );

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

/**

[294] Fix | Delete

* Cancel all the AS actions for a group.

[295] Fix | Delete

*

[296] Fix | Delete

* @since 1.5.9

[297] Fix | Delete

*

[298] Fix | Delete

* @param string $group Group to cancel all actions for.

[299] Fix | Delete

*/

[300] Fix | Delete

public function cancel_all( $group = '' ) {

[301] Fix | Delete

[302] Fix | Delete

if ( empty( $group ) ) {

[303] Fix | Delete

$group = self::GROUP;

[304] Fix | Delete

} else {

[305] Fix | Delete

$group = sanitize_key( $group );

[306] Fix | Delete

}

[307] Fix | Delete

[308] Fix | Delete

if ( class_exists( 'ActionScheduler_DBStore' ) ) {

[309] Fix | Delete

ActionScheduler_DBStore::instance()->cancel_actions_by_group( $group );

[310] Fix | Delete

$this->active_actions = $this->get_active_actions();

[311] Fix | Delete

}

[312] Fix | Delete

}

[313] Fix | Delete

[314] Fix | Delete

/**

[315] Fix | Delete

* Whether ActionScheduler thinks that it has migrated or not.

[316] Fix | Delete

*

[317] Fix | Delete

* @since 1.5.9.3

[318] Fix | Delete

*

[319] Fix | Delete

* @return bool

[320] Fix | Delete

*/

[321] Fix | Delete

public function is_usable() {

[322] Fix | Delete

[323] Fix | Delete

// No tasks if ActionScheduler wasn't loaded.

[324] Fix | Delete

if ( ! class_exists( 'ActionScheduler_DataController' ) ) {

[325] Fix | Delete

return false;

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

return ActionScheduler_DataController::is_migration_complete();

[329] Fix | Delete

}

[330] Fix | Delete

[331] Fix | Delete

/**

[332] Fix | Delete

* Whether task has been scheduled and is pending or in-progress.

[333] Fix | Delete

*

[334] Fix | Delete

* @since 1.6.0

[335] Fix | Delete

*

[336] Fix | Delete

* @param string $hook Hook to check for.

[337] Fix | Delete

*

[338] Fix | Delete

* @return bool|null

[339] Fix | Delete

* @noinspection PhpUndefinedFunctionInspection

[340] Fix | Delete

*/

[341] Fix | Delete

public function is_scheduled( $hook ) {

[342] Fix | Delete

[343] Fix | Delete

if ( ! function_exists( 'as_has_scheduled_action' ) ) {

[344] Fix | Delete

return null;

[345] Fix | Delete

}

[346] Fix | Delete

[347] Fix | Delete

if ( in_array( $hook, $this->active_actions, true ) ) {

[348] Fix | Delete

return true;

[349] Fix | Delete

}

[350] Fix | Delete

[351] Fix | Delete

// Action is not in the array, so it is not scheduled or belongs to another group.

[352] Fix | Delete

return as_has_scheduled_action( $hook );

[353] Fix | Delete

}

[354] Fix | Delete

[355] Fix | Delete

/**

[356] Fix | Delete

* Get all WPForms pending or in-progress actions.

[357] Fix | Delete

*

[358] Fix | Delete

* @since 1.7.3

[359] Fix | Delete

*/

[360] Fix | Delete

private function get_active_actions() {

[361] Fix | Delete

[362] Fix | Delete

global $wpdb;

[363] Fix | Delete

[364] Fix | Delete

$group = self::GROUP;

[365] Fix | Delete

$sql = "SELECT a.hook FROM {$wpdb->prefix}actionscheduler_actions a

[366] Fix | Delete

JOIN {$wpdb->prefix}actionscheduler_groups g ON g.group_id = a.group_id

[367] Fix | Delete

WHERE g.slug = '$group' AND a.status IN ( 'in-progress', 'pending' )";

[368] Fix | Delete

[369] Fix | Delete

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

[370] Fix | Delete

$results = $wpdb->get_results( $sql, 'ARRAY_N' );

[371] Fix | Delete

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

[372] Fix | Delete

[373] Fix | Delete

return $results ? array_merge( ...$results ) : [];

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete

/**

[377] Fix | Delete

* Delete a task by its ID.

[378] Fix | Delete

*

[379] Fix | Delete

* @since 1.9.6.1

[380] Fix | Delete

*

[381] Fix | Delete

* @param int $action_id Action ID.

[382] Fix | Delete

*/

[383] Fix | Delete

public function delete_action( $action_id ): void {

[384] Fix | Delete

[385] Fix | Delete

global $wpdb;

[386] Fix | Delete

[387] Fix | Delete

$sql = "DELETE FROM {$wpdb->prefix}actionscheduler_actions WHERE action_id = %d";

[388] Fix | Delete

[389] Fix | Delete

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

[390] Fix | Delete

$wpdb->query( $wpdb->prepare( $sql, (int) $action_id ) );

[391] Fix | Delete

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

[392] Fix | Delete

}

[393] Fix | Delete

[394] Fix | Delete

/**

[395] Fix | Delete

* Fetch action by ID.

[396] Fix | Delete

*

[397] Fix | Delete

* @since 1.9.6.1

[398] Fix | Delete

*

[399] Fix | Delete

* @param int $action_id Action ID.

[400] Fix | Delete

*

[401] Fix | Delete

* @return null|ActionScheduler_Action

[402] Fix | Delete

*/

[403] Fix | Delete

public function fetch_action( $action_id ): ?ActionScheduler_Action {

[404] Fix | Delete

[405] Fix | Delete

if ( ! class_exists( 'ActionScheduler' ) ) {

[406] Fix | Delete

return null;

[407] Fix | Delete

}

[408] Fix | Delete

[409] Fix | Delete

return ActionScheduler::store()->fetch_action( $action_id );

[410] Fix | Delete

}

[411] Fix | Delete

[412] Fix | Delete

/**

[413] Fix | Delete

* Clear the meta after action complete.

[414] Fix | Delete

* Fired before an action is marked as completed.

[415] Fix | Delete

*

[416] Fix | Delete

* @since 1.7.5

[417] Fix | Delete

*

[418] Fix | Delete

* @param integer $action_id Action ID.

[419] Fix | Delete

* @param ActionScheduler_Action $action Action name.

[420] Fix | Delete

*/

[421] Fix | Delete

public function clear_action_meta( $action_id, $action ) {

[422] Fix | Delete

[423] Fix | Delete

$action_schedule = $action->get_schedule();

[424] Fix | Delete

[425] Fix | Delete

if ( $action_schedule === null || $action_schedule->is_recurring() ) {

[426] Fix | Delete

return;

[427] Fix | Delete

}

[428] Fix | Delete

[429] Fix | Delete

$hook_name = $action->get_hook();

[430] Fix | Delete

[431] Fix | Delete

if ( ! $this->is_scheduled( $hook_name ) ) {

[432] Fix | Delete

return;

[433] Fix | Delete

}

[434] Fix | Delete

[435] Fix | Delete

$hook_args = $action->get_args();

[436] Fix | Delete

[437] Fix | Delete

if ( ! isset( $hook_args['tasks_meta_id'] ) ) {

[438] Fix | Delete

return;

[439] Fix | Delete

}

[440] Fix | Delete

[441] Fix | Delete

$meta = new Meta();

[442] Fix | Delete

[443] Fix | Delete

$meta->delete( $hook_args['tasks_meta_id'] );

[444] Fix | Delete

}

[445] Fix | Delete

}

[446] Fix | Delete

[447] Fix | Delete