Edit File by line

<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Tasks;

[2] Fix | Delete

[3] Fix | Delete

use ActionScheduler_Action;

[4] Fix | Delete

use WPForms\Helpers\Transient;

[5] Fix | Delete

use WPForms\Tasks\Actions\EntryEmailsMetaCleanupTask;

[6] Fix | Delete

use WPForms\Tasks\Actions\EntryEmailsTask;

[7] Fix | Delete

use WPForms\Tasks\Actions\FormsLocatorScanTask;

[8] Fix | Delete

use WPForms\Tasks\Actions\AsyncRequestTask;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

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

[12] Fix | Delete

[13] Fix | Delete

* @since 1.5.9

[14] Fix | Delete

[15] Fix | Delete

class Tasks {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Group that will be assigned to all actions.

[19] Fix | Delete

[20] Fix | Delete

* @since 1.5.9

[21] Fix | Delete

[22] Fix | Delete

const GROUP = 'wpforms';

[23] Fix | Delete

[24] Fix | Delete

/**

[25] Fix | Delete

* Actions setting name.

[26] Fix | Delete

[27] Fix | Delete

* @since 1.7.3

[28] Fix | Delete

[29] Fix | Delete

const ACTIONS = 'actions';

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* WPForms pending or in-progress actions.

[33] Fix | Delete

[34] Fix | Delete

* @since 1.7.3

[35] Fix | Delete

[36] Fix | Delete

* @var array

[37] Fix | Delete

[38] Fix | Delete

private $active_actions;

[39] Fix | Delete

[40] Fix | Delete

/**

[41] Fix | Delete

* Perform certain things on class init.

[42] Fix | Delete

[43] Fix | Delete

* @since 1.5.9

[44] Fix | Delete

[45] Fix | Delete

public function init() {

[46] Fix | Delete

[47] Fix | Delete

// Get WPForms pending or in-progress actions.

[48] Fix | Delete

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

[49] Fix | Delete

[50] Fix | Delete

// Register WPForms tasks.

[51] Fix | Delete

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

[52] Fix | Delete

[53] Fix | Delete

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

[54] Fix | Delete

continue;

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

new $task();

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

$this->hooks();

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Hooks.

[65] Fix | Delete

[66] Fix | Delete

* @since 1.7.5

[67] Fix | Delete

[68] Fix | Delete

public function hooks() {

[69] Fix | Delete

[70] Fix | Delete

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

[71] Fix | Delete

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

[72] Fix | Delete

[73] Fix | Delete

[74] Fix | Delete

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

[75] Fix | Delete

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

[76] Fix | Delete

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

[77] Fix | Delete

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

[78] Fix | Delete

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

[79] Fix | Delete

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

[80] Fix | Delete

[81] Fix | Delete

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

[82] Fix | Delete

add_filter( 'wpforms_tasks_entry_emails_trigger_send_same_process', '__return_true' );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

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

[86] Fix | Delete

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

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Get the list of WPForms default scheduled tasks.

[91] Fix | Delete

* Tasks, that are fired under certain specific circumstances

[92] Fix | Delete

* (like sending form submission email notifications)

[93] Fix | Delete

* are not listed here.

[94] Fix | Delete

[95] Fix | Delete

* @since 1.5.9

[96] Fix | Delete

[97] Fix | Delete

* @return Task[] List of tasks classes.

[98] Fix | Delete

[99] Fix | Delete

public function get_tasks() {

[100] Fix | Delete

[101] Fix | Delete

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

[102] Fix | Delete

return [];

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

$tasks = [

[106] Fix | Delete

EntryEmailsMetaCleanupTask::class,

[107] Fix | Delete

FormsLocatorScanTask::class,

[108] Fix | Delete

AsyncRequestTask::class,

[109] Fix | Delete

];

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Filters the task class list to initialize.

[113] Fix | Delete

[114] Fix | Delete

* @since 1.5.9

[115] Fix | Delete

[116] Fix | Delete

* @param array $tasks Task class list.

[117] Fix | Delete

[118] Fix | Delete

return apply_filters( 'wpforms_tasks_get_tasks', $tasks );

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

/**

[122] Fix | Delete

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

[123] Fix | Delete

[124] Fix | Delete

* @since 1.5.9

[125] Fix | Delete

[126] Fix | Delete

public function admin_hide_as_menu() {

[127] Fix | Delete

[128] Fix | Delete

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

[129] Fix | Delete

if ( apply_filters( 'wpforms_tasks_admin_hide_as_menu', ! wpforms_debug() ) ) {

[130] Fix | Delete

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

[131] Fix | Delete

}

[132] Fix | Delete

}

[133] Fix | Delete

[134] Fix | Delete

/**

[135] Fix | Delete

* Create a new task.

[136] Fix | Delete

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

[137] Fix | Delete

* from the plugin runtime before they can be scheduled.

[138] Fix | Delete

[139] Fix | Delete

* Example:

[140] Fix | Delete

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

[141] Fix | Delete

* ->create( 'i_am_the_dude' )

[142] Fix | Delete

* ->async()

[143] Fix | Delete

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

[144] Fix | Delete

* ->register();

[145] Fix | Delete

[146] Fix | Delete

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

[147] Fix | Delete

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

[148] Fix | Delete

[149] Fix | Delete

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

[150] Fix | Delete

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

[151] Fix | Delete

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

[152] Fix | Delete

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

[153] Fix | Delete

[154] Fix | Delete

* @since 1.5.9

[155] Fix | Delete

[156] Fix | Delete

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

[157] Fix | Delete

[158] Fix | Delete

* @return \WPForms\Tasks\Task

[159] Fix | Delete

[160] Fix | Delete

public function create( $action ) {

[161] Fix | Delete

[162] Fix | Delete

return new Task( $action );

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

/**

[166] Fix | Delete

* Cancel all the AS actions for a group.

[167] Fix | Delete

[168] Fix | Delete

* @since 1.5.9

[169] Fix | Delete

[170] Fix | Delete

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

[171] Fix | Delete

[172] Fix | Delete

public function cancel_all( $group = '' ) {

[173] Fix | Delete

[174] Fix | Delete

if ( empty( $group ) ) {

[175] Fix | Delete

$group = self::GROUP;

[176] Fix | Delete

} else {

[177] Fix | Delete

$group = sanitize_key( $group );

[178] Fix | Delete

}

[179] Fix | Delete

[180] Fix | Delete

if ( class_exists( 'ActionScheduler_DBStore' ) ) {

[181] Fix | Delete

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

[182] Fix | Delete

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

[183] Fix | Delete

}

[184] Fix | Delete

}

[185] Fix | Delete

[186] Fix | Delete

/**

[187] Fix | Delete

* Whether ActionScheduler thinks that it has migrated or not.

[188] Fix | Delete

[189] Fix | Delete

* @since 1.5.9.3

[190] Fix | Delete

[191] Fix | Delete

* @return bool

[192] Fix | Delete

[193] Fix | Delete

public function is_usable() {

[194] Fix | Delete

[195] Fix | Delete

// No tasks if ActionScheduler wasn't loaded.

[196] Fix | Delete

if ( ! class_exists( 'ActionScheduler_DataController' ) ) {

[197] Fix | Delete

return false;

[198] Fix | Delete

}

[199] Fix | Delete

[200] Fix | Delete

return \ActionScheduler_DataController::is_migration_complete();

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

/**

[204] Fix | Delete

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

[205] Fix | Delete

[206] Fix | Delete

* @since 1.6.0

[207] Fix | Delete

[208] Fix | Delete

* @param string $hook Hook to check for.

[209] Fix | Delete

[210] Fix | Delete

* @return bool|null

[211] Fix | Delete

[212] Fix | Delete

public function is_scheduled( $hook ) {

[213] Fix | Delete

[214] Fix | Delete

if ( ! function_exists( 'as_has_scheduled_action' ) ) {

[215] Fix | Delete

return null;

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

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

[219] Fix | Delete

return true;

[220] Fix | Delete

}

[221] Fix | Delete

[222] Fix | Delete

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

[223] Fix | Delete

return as_has_scheduled_action( $hook );

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

/**

[227] Fix | Delete

* Get all WPForms pending or in-progress actions.

[228] Fix | Delete

[229] Fix | Delete

* @since 1.7.3

[230] Fix | Delete

[231] Fix | Delete

private function get_active_actions() {

[232] Fix | Delete

[233] Fix | Delete

global $wpdb;

[234] Fix | Delete

[235] Fix | Delete

$group = self::GROUP;

[236] Fix | Delete

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

[237] Fix | Delete

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

[238] Fix | Delete

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

[239] Fix | Delete

[240] Fix | Delete

// phpcs:disable WordPress.DB.DirectDatabaseQuery.NoCaching

[241] Fix | Delete

// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared

[242] Fix | Delete

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

[243] Fix | Delete

// phpcs:enable WordPress.DB.DirectDatabaseQuery.NoCaching

[244] Fix | Delete

// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared

[245] Fix | Delete

[246] Fix | Delete

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

[247] Fix | Delete

}

[248] Fix | Delete

[249] Fix | Delete

/**

[250] Fix | Delete

* Clear the meta after action complete.

[251] Fix | Delete

* Fired before an action is marked as completed.

[252] Fix | Delete

[253] Fix | Delete

* @since 1.7.5

[254] Fix | Delete

[255] Fix | Delete

* @param integer $action_id Action ID.

[256] Fix | Delete

* @param ActionScheduler_Action $action Action name.

[257] Fix | Delete

[258] Fix | Delete

public function clear_action_meta( $action_id, $action ) {

[259] Fix | Delete

[260] Fix | Delete

$action_schedule = $action->get_schedule();

[261] Fix | Delete

[262] Fix | Delete

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

[263] Fix | Delete

return;

[264] Fix | Delete

}

[265] Fix | Delete

[266] Fix | Delete

$hook_name = $action->get_hook();

[267] Fix | Delete

[268] Fix | Delete

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

[269] Fix | Delete

return;

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

$hook_args = $action->get_args();

[273] Fix | Delete

[274] Fix | Delete

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

[275] Fix | Delete

return;

[276] Fix | Delete

}

[277] Fix | Delete

[278] Fix | Delete

$meta = new Meta();

[279] Fix | Delete

[280] Fix | Delete

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

[281] Fix | Delete

}

[282] Fix | Delete

}

[283] Fix | Delete

[284] Fix | Delete