installed plugin WPScan version 1.15.1
This commit is contained in:
Gitium
@ -0,0 +1,146 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_DBLogger
|
||||
*
|
||||
* Action logs data table data store.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
class ActionScheduler_DBLogger extends ActionScheduler_Logger {
|
||||
|
||||
/**
|
||||
* Add a record to an action log.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
* @param string $message Message to be saved in the log entry.
|
||||
* @param DateTime $date Timestamp of the log entry.
|
||||
*
|
||||
* @return int The log entry ID.
|
||||
*/
|
||||
public function log( $action_id, $message, DateTime $date = null ) {
|
||||
if ( empty( $date ) ) {
|
||||
$date = as_get_datetime_object();
|
||||
} else {
|
||||
$date = clone $date;
|
||||
}
|
||||
|
||||
$date_gmt = $date->format( 'Y-m-d H:i:s' );
|
||||
ActionScheduler_TimezoneHelper::set_local_timezone( $date );
|
||||
$date_local = $date->format( 'Y-m-d H:i:s' );
|
||||
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$wpdb->insert( $wpdb->actionscheduler_logs, [
|
||||
'action_id' => $action_id,
|
||||
'message' => $message,
|
||||
'log_date_gmt' => $date_gmt,
|
||||
'log_date_local' => $date_local,
|
||||
], [ '%d', '%s', '%s', '%s' ] );
|
||||
|
||||
return $wpdb->insert_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an action log entry.
|
||||
*
|
||||
* @param int $entry_id Log entry ID.
|
||||
*
|
||||
* @return ActionScheduler_LogEntry
|
||||
*/
|
||||
public function get_entry( $entry_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$entry = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE log_id=%d", $entry_id ) );
|
||||
|
||||
return $this->create_entry_from_db_record( $entry );
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an action log entry from a database record.
|
||||
*
|
||||
* @param object $record Log entry database record object.
|
||||
*
|
||||
* @return ActionScheduler_LogEntry
|
||||
*/
|
||||
private function create_entry_from_db_record( $record ) {
|
||||
if ( empty( $record ) ) {
|
||||
return new ActionScheduler_NullLogEntry();
|
||||
}
|
||||
|
||||
$date = as_get_datetime_object( $record->log_date_gmt );
|
||||
|
||||
return new ActionScheduler_LogEntry( $record->action_id, $record->message, $date );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the an action's log entries from the database.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @return ActionScheduler_LogEntry[]
|
||||
*/
|
||||
public function get_logs( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$records = $wpdb->get_results( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_logs} WHERE action_id=%d", $action_id ) );
|
||||
|
||||
return array_map( [ $this, 'create_entry_from_db_record' ], $records );
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the data store.
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
public function init() {
|
||||
|
||||
$table_maker = new ActionScheduler_LoggerSchema();
|
||||
$table_maker->register_tables();
|
||||
|
||||
parent::init();
|
||||
|
||||
add_action( 'action_scheduler_deleted_action', [ $this, 'clear_deleted_action_logs' ], 10, 1 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete the action logs for an action.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function clear_deleted_action_logs( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$wpdb->delete( $wpdb->actionscheduler_logs, [ 'action_id' => $action_id, ], [ '%d' ] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Bulk add cancel action log entries.
|
||||
*
|
||||
* @param array $action_ids List of action ID.
|
||||
*/
|
||||
public function bulk_log_cancel_actions( $action_ids ) {
|
||||
if ( empty( $action_ids ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$date = as_get_datetime_object();
|
||||
$date_gmt = $date->format( 'Y-m-d H:i:s' );
|
||||
ActionScheduler_TimezoneHelper::set_local_timezone( $date );
|
||||
$date_local = $date->format( 'Y-m-d H:i:s' );
|
||||
$message = __( 'action canceled', 'action-scheduler' );
|
||||
$format = '(%d, ' . $wpdb->prepare( '%s, %s, %s', $message, $date_gmt, $date_local ) . ')';
|
||||
$sql_query = "INSERT {$wpdb->actionscheduler_logs} (action_id, message, log_date_gmt, log_date_local) VALUES ";
|
||||
$value_rows = [];
|
||||
|
||||
foreach ( $action_ids as $action_id ) {
|
||||
$value_rows[] = $wpdb->prepare( $format, $action_id );
|
||||
}
|
||||
$sql_query .= implode( ',', $value_rows );
|
||||
|
||||
$wpdb->query( $sql_query );
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,870 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_DBStore
|
||||
*
|
||||
* Action data table data store.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
class ActionScheduler_DBStore extends ActionScheduler_Store {
|
||||
|
||||
/**
|
||||
* Used to share information about the before_date property of claims internally.
|
||||
*
|
||||
* This is used in preference to passing the same information as a method param
|
||||
* for backwards-compatibility reasons.
|
||||
*
|
||||
* @var DateTime|null
|
||||
*/
|
||||
private $claim_before_date = null;
|
||||
|
||||
/** @var int */
|
||||
protected static $max_args_length = 8000;
|
||||
|
||||
/** @var int */
|
||||
protected static $max_index_length = 191;
|
||||
|
||||
/**
|
||||
* Initialize the data store
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
public function init() {
|
||||
$table_maker = new ActionScheduler_StoreSchema();
|
||||
$table_maker->register_tables();
|
||||
}
|
||||
|
||||
/**
|
||||
* Save an action.
|
||||
*
|
||||
* @param ActionScheduler_Action $action Action object.
|
||||
* @param DateTime $date Optional schedule date. Default null.
|
||||
*
|
||||
* @return int Action ID.
|
||||
*/
|
||||
public function save_action( ActionScheduler_Action $action, \DateTime $date = null ) {
|
||||
try {
|
||||
|
||||
$this->validate_action( $action );
|
||||
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$data = [
|
||||
'hook' => $action->get_hook(),
|
||||
'status' => ( $action->is_finished() ? self::STATUS_COMPLETE : self::STATUS_PENDING ),
|
||||
'scheduled_date_gmt' => $this->get_scheduled_date_string( $action, $date ),
|
||||
'scheduled_date_local' => $this->get_scheduled_date_string_local( $action, $date ),
|
||||
'schedule' => serialize( $action->get_schedule() ),
|
||||
'group_id' => $this->get_group_id( $action->get_group() ),
|
||||
];
|
||||
$args = wp_json_encode( $action->get_args() );
|
||||
if ( strlen( $args ) <= static::$max_index_length ) {
|
||||
$data['args'] = $args;
|
||||
} else {
|
||||
$data['args'] = $this->hash_args( $args );
|
||||
$data['extended_args'] = $args;
|
||||
}
|
||||
|
||||
$table_name = ! empty( $wpdb->actionscheduler_actions ) ? $wpdb->actionscheduler_actions : $wpdb->prefix . 'actionscheduler_actions';
|
||||
$wpdb->insert( $table_name, $data );
|
||||
$action_id = $wpdb->insert_id;
|
||||
|
||||
if ( is_wp_error( $action_id ) ) {
|
||||
throw new RuntimeException( $action_id->get_error_message() );
|
||||
}
|
||||
elseif ( empty( $action_id ) ) {
|
||||
throw new RuntimeException( $wpdb->last_error ? $wpdb->last_error : __( 'Database error.', 'action-scheduler' ) );
|
||||
}
|
||||
|
||||
do_action( 'action_scheduler_stored_action', $action_id );
|
||||
|
||||
return $action_id;
|
||||
} catch ( \Exception $e ) {
|
||||
/* translators: %s: error message */
|
||||
throw new \RuntimeException( sprintf( __( 'Error saving action: %s', 'action-scheduler' ), $e->getMessage() ), 0 );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a hash from json_encoded $args using MD5 as this isn't for security.
|
||||
*
|
||||
* @param string $args JSON encoded action args.
|
||||
* @return string
|
||||
*/
|
||||
protected function hash_args( $args ) {
|
||||
return md5( $args );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get action args query param value from action args.
|
||||
*
|
||||
* @param array $args Action args.
|
||||
* @return string
|
||||
*/
|
||||
protected function get_args_for_query( $args ) {
|
||||
$encoded = wp_json_encode( $args );
|
||||
if ( strlen( $encoded ) <= static::$max_index_length ) {
|
||||
return $encoded;
|
||||
}
|
||||
return $this->hash_args( $encoded );
|
||||
}
|
||||
/**
|
||||
* Get a group's ID based on its name/slug.
|
||||
*
|
||||
* @param string $slug The string name of a group.
|
||||
* @param bool $create_if_not_exists Whether to create the group if it does not already exist. Default, true - create the group.
|
||||
*
|
||||
* @return int The group's ID, if it exists or is created, or 0 if it does not exist and is not created.
|
||||
*/
|
||||
protected function get_group_id( $slug, $create_if_not_exists = true ) {
|
||||
if ( empty( $slug ) ) {
|
||||
return 0;
|
||||
}
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$group_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT group_id FROM {$wpdb->actionscheduler_groups} WHERE slug=%s", $slug ) );
|
||||
if ( empty( $group_id ) && $create_if_not_exists ) {
|
||||
$group_id = $this->create_group( $slug );
|
||||
}
|
||||
|
||||
return $group_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an action group.
|
||||
*
|
||||
* @param string $slug Group slug.
|
||||
*
|
||||
* @return int Group ID.
|
||||
*/
|
||||
protected function create_group( $slug ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$wpdb->insert( $wpdb->actionscheduler_groups, [ 'slug' => $slug ] );
|
||||
|
||||
return (int) $wpdb->insert_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an action.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @return ActionScheduler_Action
|
||||
*/
|
||||
public function fetch_action( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$data = $wpdb->get_row( $wpdb->prepare(
|
||||
"SELECT a.*, g.slug AS `group` FROM {$wpdb->actionscheduler_actions} a LEFT JOIN {$wpdb->actionscheduler_groups} g ON a.group_id=g.group_id WHERE a.action_id=%d",
|
||||
$action_id
|
||||
) );
|
||||
|
||||
if ( empty( $data ) ) {
|
||||
return $this->get_null_action();
|
||||
}
|
||||
|
||||
if ( ! empty( $data->extended_args ) ) {
|
||||
$data->args = $data->extended_args;
|
||||
unset( $data->extended_args );
|
||||
}
|
||||
|
||||
try {
|
||||
$action = $this->make_action_from_db_record( $data );
|
||||
} catch ( ActionScheduler_InvalidActionException $exception ) {
|
||||
do_action( 'action_scheduler_failed_fetch_action', $action_id, $exception );
|
||||
return $this->get_null_action();
|
||||
}
|
||||
|
||||
return $action;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a null action.
|
||||
*
|
||||
* @return ActionScheduler_NullAction
|
||||
*/
|
||||
protected function get_null_action() {
|
||||
return new ActionScheduler_NullAction();
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an action from a database record.
|
||||
*
|
||||
* @param object $data Action database record.
|
||||
*
|
||||
* @return ActionScheduler_Action|ActionScheduler_CanceledAction|ActionScheduler_FinishedAction
|
||||
*/
|
||||
protected function make_action_from_db_record( $data ) {
|
||||
|
||||
$hook = $data->hook;
|
||||
$args = json_decode( $data->args, true );
|
||||
$schedule = unserialize( $data->schedule );
|
||||
|
||||
$this->validate_args( $args, $data->action_id );
|
||||
$this->validate_schedule( $schedule, $data->action_id );
|
||||
|
||||
if ( empty( $schedule ) ) {
|
||||
$schedule = new ActionScheduler_NullSchedule();
|
||||
}
|
||||
$group = $data->group ? $data->group : '';
|
||||
|
||||
return ActionScheduler::factory()->get_stored_action( $data->status, $data->hook, $args, $schedule, $group );
|
||||
}
|
||||
|
||||
/**
|
||||
* Find an action.
|
||||
*
|
||||
* @param string $hook Action hook.
|
||||
* @param array $params Parameters of the action to find.
|
||||
*
|
||||
* @return string|null ID of the next action matching the criteria or NULL if not found.
|
||||
*/
|
||||
public function find_action( $hook, $params = [] ) {
|
||||
$params = wp_parse_args( $params, [
|
||||
'args' => null,
|
||||
'status' => self::STATUS_PENDING,
|
||||
'group' => '',
|
||||
] );
|
||||
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$query = "SELECT a.action_id FROM {$wpdb->actionscheduler_actions} a";
|
||||
$args = [];
|
||||
if ( ! empty( $params[ 'group' ] ) ) {
|
||||
$query .= " INNER JOIN {$wpdb->actionscheduler_groups} g ON g.group_id=a.group_id AND g.slug=%s";
|
||||
$args[] = $params[ 'group' ];
|
||||
}
|
||||
$query .= " WHERE a.hook=%s";
|
||||
$args[] = $hook;
|
||||
if ( ! is_null( $params[ 'args' ] ) ) {
|
||||
$query .= " AND a.args=%s";
|
||||
$args[] = $this->get_args_for_query( $params[ 'args' ] );
|
||||
}
|
||||
|
||||
$order = 'ASC';
|
||||
if ( ! empty( $params[ 'status' ] ) ) {
|
||||
$query .= " AND a.status=%s";
|
||||
$args[] = $params[ 'status' ];
|
||||
|
||||
if ( self::STATUS_PENDING == $params[ 'status' ] ) {
|
||||
$order = 'ASC'; // Find the next action that matches.
|
||||
} else {
|
||||
$order = 'DESC'; // Find the most recent action that matches.
|
||||
}
|
||||
}
|
||||
|
||||
$query .= " ORDER BY scheduled_date_gmt $order LIMIT 1";
|
||||
|
||||
$query = $wpdb->prepare( $query, $args );
|
||||
|
||||
$id = $wpdb->get_var( $query );
|
||||
|
||||
return $id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the SQL statement to query (or count) actions.
|
||||
*
|
||||
* @param array $query Filtering options.
|
||||
* @param string $select_or_count Whether the SQL should select and return the IDs or just the row count.
|
||||
*
|
||||
* @return string SQL statement already properly escaped.
|
||||
*/
|
||||
protected function get_query_actions_sql( array $query, $select_or_count = 'select' ) {
|
||||
|
||||
if ( ! in_array( $select_or_count, array( 'select', 'count' ) ) ) {
|
||||
throw new InvalidArgumentException( __( 'Invalid value for select or count parameter. Cannot query actions.', 'action-scheduler' ) );
|
||||
}
|
||||
|
||||
$query = wp_parse_args( $query, [
|
||||
'hook' => '',
|
||||
'args' => null,
|
||||
'date' => null,
|
||||
'date_compare' => '<=',
|
||||
'modified' => null,
|
||||
'modified_compare' => '<=',
|
||||
'group' => '',
|
||||
'status' => '',
|
||||
'claimed' => null,
|
||||
'per_page' => 5,
|
||||
'offset' => 0,
|
||||
'orderby' => 'date',
|
||||
'order' => 'ASC',
|
||||
] );
|
||||
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$sql = ( 'count' === $select_or_count ) ? 'SELECT count(a.action_id)' : 'SELECT a.action_id';
|
||||
$sql .= " FROM {$wpdb->actionscheduler_actions} a";
|
||||
$sql_params = [];
|
||||
|
||||
if ( ! empty( $query[ 'group' ] ) || 'group' === $query[ 'orderby' ] ) {
|
||||
$sql .= " LEFT JOIN {$wpdb->actionscheduler_groups} g ON g.group_id=a.group_id";
|
||||
}
|
||||
|
||||
$sql .= " WHERE 1=1";
|
||||
|
||||
if ( ! empty( $query[ 'group' ] ) ) {
|
||||
$sql .= " AND g.slug=%s";
|
||||
$sql_params[] = $query[ 'group' ];
|
||||
}
|
||||
|
||||
if ( $query[ 'hook' ] ) {
|
||||
$sql .= " AND a.hook=%s";
|
||||
$sql_params[] = $query[ 'hook' ];
|
||||
}
|
||||
if ( ! is_null( $query[ 'args' ] ) ) {
|
||||
$sql .= " AND a.args=%s";
|
||||
$sql_params[] = $this->get_args_for_query( $query[ 'args' ] );
|
||||
}
|
||||
|
||||
if ( $query[ 'status' ] ) {
|
||||
$sql .= " AND a.status=%s";
|
||||
$sql_params[] = $query[ 'status' ];
|
||||
}
|
||||
|
||||
if ( $query[ 'date' ] instanceof \DateTime ) {
|
||||
$date = clone $query[ 'date' ];
|
||||
$date->setTimezone( new \DateTimeZone( 'UTC' ) );
|
||||
$date_string = $date->format( 'Y-m-d H:i:s' );
|
||||
$comparator = $this->validate_sql_comparator( $query[ 'date_compare' ] );
|
||||
$sql .= " AND a.scheduled_date_gmt $comparator %s";
|
||||
$sql_params[] = $date_string;
|
||||
}
|
||||
|
||||
if ( $query[ 'modified' ] instanceof \DateTime ) {
|
||||
$modified = clone $query[ 'modified' ];
|
||||
$modified->setTimezone( new \DateTimeZone( 'UTC' ) );
|
||||
$date_string = $modified->format( 'Y-m-d H:i:s' );
|
||||
$comparator = $this->validate_sql_comparator( $query[ 'modified_compare' ] );
|
||||
$sql .= " AND a.last_attempt_gmt $comparator %s";
|
||||
$sql_params[] = $date_string;
|
||||
}
|
||||
|
||||
if ( $query[ 'claimed' ] === true ) {
|
||||
$sql .= " AND a.claim_id != 0";
|
||||
} elseif ( $query[ 'claimed' ] === false ) {
|
||||
$sql .= " AND a.claim_id = 0";
|
||||
} elseif ( ! is_null( $query[ 'claimed' ] ) ) {
|
||||
$sql .= " AND a.claim_id = %d";
|
||||
$sql_params[] = $query[ 'claimed' ];
|
||||
}
|
||||
|
||||
if ( ! empty( $query['search'] ) ) {
|
||||
$sql .= " AND (a.hook LIKE %s OR (a.extended_args IS NULL AND a.args LIKE %s) OR a.extended_args LIKE %s";
|
||||
for( $i = 0; $i < 3; $i++ ) {
|
||||
$sql_params[] = sprintf( '%%%s%%', $query['search'] );
|
||||
}
|
||||
|
||||
$search_claim_id = (int) $query['search'];
|
||||
if ( $search_claim_id ) {
|
||||
$sql .= ' OR a.claim_id = %d';
|
||||
$sql_params[] = $search_claim_id;
|
||||
}
|
||||
|
||||
$sql .= ')';
|
||||
}
|
||||
|
||||
if ( 'select' === $select_or_count ) {
|
||||
if ( strtoupper( $query[ 'order' ] ) == 'ASC' ) {
|
||||
$order = 'ASC';
|
||||
} else {
|
||||
$order = 'DESC';
|
||||
}
|
||||
switch ( $query['orderby'] ) {
|
||||
case 'hook':
|
||||
$sql .= " ORDER BY a.hook $order";
|
||||
break;
|
||||
case 'group':
|
||||
$sql .= " ORDER BY g.slug $order";
|
||||
break;
|
||||
case 'modified':
|
||||
$sql .= " ORDER BY a.last_attempt_gmt $order";
|
||||
break;
|
||||
case 'none':
|
||||
break;
|
||||
case 'date':
|
||||
default:
|
||||
$sql .= " ORDER BY a.scheduled_date_gmt $order";
|
||||
break;
|
||||
}
|
||||
|
||||
if ( $query[ 'per_page' ] > 0 ) {
|
||||
$sql .= " LIMIT %d, %d";
|
||||
$sql_params[] = $query[ 'offset' ];
|
||||
$sql_params[] = $query[ 'per_page' ];
|
||||
}
|
||||
}
|
||||
|
||||
if ( ! empty( $sql_params ) ) {
|
||||
$sql = $wpdb->prepare( $sql, $sql_params );
|
||||
}
|
||||
|
||||
return $sql;
|
||||
}
|
||||
|
||||
/**
|
||||
* Query for action count of list of action IDs.
|
||||
*
|
||||
* @param array $query Query parameters.
|
||||
* @param string $query_type Whether to select or count the results. Default, select.
|
||||
*
|
||||
* @return null|string|array The IDs of actions matching the query
|
||||
*/
|
||||
public function query_actions( $query = [], $query_type = 'select' ) {
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$sql = $this->get_query_actions_sql( $query, $query_type );
|
||||
|
||||
return ( 'count' === $query_type ) ? $wpdb->get_var( $sql ) : $wpdb->get_col( $sql );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a count of all actions in the store, grouped by status.
|
||||
*
|
||||
* @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
|
||||
*/
|
||||
public function action_counts() {
|
||||
global $wpdb;
|
||||
|
||||
$sql = "SELECT a.status, count(a.status) as 'count'";
|
||||
$sql .= " FROM {$wpdb->actionscheduler_actions} a";
|
||||
$sql .= " GROUP BY a.status";
|
||||
|
||||
$actions_count_by_status = array();
|
||||
$action_stati_and_labels = $this->get_status_labels();
|
||||
|
||||
foreach ( $wpdb->get_results( $sql ) as $action_data ) {
|
||||
// Ignore any actions with invalid status
|
||||
if ( array_key_exists( $action_data->status, $action_stati_and_labels ) ) {
|
||||
$actions_count_by_status[ $action_data->status ] = $action_data->count;
|
||||
}
|
||||
}
|
||||
|
||||
return $actions_count_by_status;
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancel an action.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function cancel_action( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$updated = $wpdb->update(
|
||||
$wpdb->actionscheduler_actions,
|
||||
[ 'status' => self::STATUS_CANCELED ],
|
||||
[ 'action_id' => $action_id ],
|
||||
[ '%s' ],
|
||||
[ '%d' ]
|
||||
);
|
||||
if ( empty( $updated ) ) {
|
||||
/* translators: %s: action ID */
|
||||
throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
do_action( 'action_scheduler_canceled_action', $action_id );
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancel pending actions by hook.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $hook Hook name.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function cancel_actions_by_hook( $hook ) {
|
||||
$this->bulk_cancel_actions( [ 'hook' => $hook ] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancel pending actions by group.
|
||||
*
|
||||
* @param string $group Group slug.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function cancel_actions_by_group( $group ) {
|
||||
$this->bulk_cancel_actions( [ 'group' => $group ] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Bulk cancel actions.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param array $query_args Query parameters.
|
||||
*/
|
||||
protected function bulk_cancel_actions( $query_args ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
if ( ! is_array( $query_args ) ) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Don't cancel actions that are already canceled.
|
||||
if ( isset( $query_args['status'] ) && $query_args['status'] == self::STATUS_CANCELED ) {
|
||||
return;
|
||||
}
|
||||
|
||||
$action_ids = true;
|
||||
$query_args = wp_parse_args(
|
||||
$query_args,
|
||||
[
|
||||
'per_page' => 1000,
|
||||
'status' => self::STATUS_PENDING,
|
||||
]
|
||||
);
|
||||
|
||||
while ( $action_ids ) {
|
||||
$action_ids = $this->query_actions( $query_args );
|
||||
if ( empty( $action_ids ) ) {
|
||||
break;
|
||||
}
|
||||
|
||||
$format = array_fill( 0, count( $action_ids ), '%d' );
|
||||
$query_in = '(' . implode( ',', $format ) . ')';
|
||||
$parameters = $action_ids;
|
||||
array_unshift( $parameters, self::STATUS_CANCELED );
|
||||
|
||||
$wpdb->query(
|
||||
$wpdb->prepare( // wpcs: PreparedSQLPlaceholders replacement count ok.
|
||||
"UPDATE {$wpdb->actionscheduler_actions} SET status = %s WHERE action_id IN {$query_in}",
|
||||
$parameters
|
||||
)
|
||||
);
|
||||
|
||||
do_action( 'action_scheduler_bulk_cancel_actions', $action_ids );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an action.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function delete_action( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$deleted = $wpdb->delete( $wpdb->actionscheduler_actions, [ 'action_id' => $action_id ], [ '%d' ] );
|
||||
if ( empty( $deleted ) ) {
|
||||
throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
do_action( 'action_scheduler_deleted_action', $action_id );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the schedule date for an action.
|
||||
*
|
||||
* @param string $action_id Action ID.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* @return \DateTime The local date the action is scheduled to run, or the date that it ran.
|
||||
*/
|
||||
public function get_date( $action_id ) {
|
||||
$date = $this->get_date_gmt( $action_id );
|
||||
ActionScheduler_TimezoneHelper::set_local_timezone( $date );
|
||||
return $date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the GMT schedule date for an action.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @throws \InvalidArgumentException
|
||||
* @return \DateTime The GMT date the action is scheduled to run, or the date that it ran.
|
||||
*/
|
||||
protected function get_date_gmt( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$record = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d", $action_id ) );
|
||||
if ( empty( $record ) ) {
|
||||
throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
if ( $record->status == self::STATUS_PENDING ) {
|
||||
return as_get_datetime_object( $record->scheduled_date_gmt );
|
||||
} else {
|
||||
return as_get_datetime_object( $record->last_attempt_gmt );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Stake a claim on actions.
|
||||
*
|
||||
* @param int $max_actions Maximum number of action to include in claim.
|
||||
* @param \DateTime $before_date Jobs must be schedule before this date. Defaults to now.
|
||||
*
|
||||
* @return ActionScheduler_ActionClaim
|
||||
*/
|
||||
public function stake_claim( $max_actions = 10, \DateTime $before_date = null, $hooks = array(), $group = '' ) {
|
||||
$claim_id = $this->generate_claim_id();
|
||||
|
||||
$this->claim_before_date = $before_date;
|
||||
$this->claim_actions( $claim_id, $max_actions, $before_date, $hooks, $group );
|
||||
$action_ids = $this->find_actions_by_claim_id( $claim_id );
|
||||
$this->claim_before_date = null;
|
||||
|
||||
return new ActionScheduler_ActionClaim( $claim_id, $action_ids );
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a new action claim.
|
||||
*
|
||||
* @return int Claim ID.
|
||||
*/
|
||||
protected function generate_claim_id() {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$now = as_get_datetime_object();
|
||||
$wpdb->insert( $wpdb->actionscheduler_claims, [ 'date_created_gmt' => $now->format( 'Y-m-d H:i:s' ) ] );
|
||||
|
||||
return $wpdb->insert_id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark actions claimed.
|
||||
*
|
||||
* @param string $claim_id Claim Id.
|
||||
* @param int $limit Number of action to include in claim.
|
||||
* @param \DateTime $before_date Should use UTC timezone.
|
||||
*
|
||||
* @return int The number of actions that were claimed.
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected function claim_actions( $claim_id, $limit, \DateTime $before_date = null, $hooks = array(), $group = '' ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$now = as_get_datetime_object();
|
||||
$date = is_null( $before_date ) ? $now : clone $before_date;
|
||||
|
||||
// can't use $wpdb->update() because of the <= condition
|
||||
$update = "UPDATE {$wpdb->actionscheduler_actions} SET claim_id=%d, last_attempt_gmt=%s, last_attempt_local=%s";
|
||||
$params = array(
|
||||
$claim_id,
|
||||
$now->format( 'Y-m-d H:i:s' ),
|
||||
current_time( 'mysql' ),
|
||||
);
|
||||
|
||||
$where = "WHERE claim_id = 0 AND scheduled_date_gmt <= %s AND status=%s";
|
||||
$params[] = $date->format( 'Y-m-d H:i:s' );
|
||||
$params[] = self::STATUS_PENDING;
|
||||
|
||||
if ( ! empty( $hooks ) ) {
|
||||
$placeholders = array_fill( 0, count( $hooks ), '%s' );
|
||||
$where .= ' AND hook IN (' . join( ', ', $placeholders ) . ')';
|
||||
$params = array_merge( $params, array_values( $hooks ) );
|
||||
}
|
||||
|
||||
if ( ! empty( $group ) ) {
|
||||
|
||||
$group_id = $this->get_group_id( $group, false );
|
||||
|
||||
// throw exception if no matching group found, this matches ActionScheduler_wpPostStore's behaviour
|
||||
if ( empty( $group_id ) ) {
|
||||
/* translators: %s: group name */
|
||||
throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'action-scheduler' ), $group ) );
|
||||
}
|
||||
|
||||
$where .= ' AND group_id = %d';
|
||||
$params[] = $group_id;
|
||||
}
|
||||
|
||||
$order = "ORDER BY attempts ASC, scheduled_date_gmt ASC, action_id ASC LIMIT %d";
|
||||
$params[] = $limit;
|
||||
|
||||
$sql = $wpdb->prepare( "{$update} {$where} {$order}", $params );
|
||||
|
||||
$rows_affected = $wpdb->query( $sql );
|
||||
if ( $rows_affected === false ) {
|
||||
throw new \RuntimeException( __( 'Unable to claim actions. Database error.', 'action-scheduler' ) );
|
||||
}
|
||||
|
||||
return (int) $rows_affected;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the number of active claims.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function get_claim_count() {
|
||||
global $wpdb;
|
||||
|
||||
$sql = "SELECT COUNT(DISTINCT claim_id) FROM {$wpdb->actionscheduler_actions} WHERE claim_id != 0 AND status IN ( %s, %s)";
|
||||
$sql = $wpdb->prepare( $sql, [ self::STATUS_PENDING, self::STATUS_RUNNING ] );
|
||||
|
||||
return (int) $wpdb->get_var( $sql );
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an action's claim ID, as stored in the claim_id column.
|
||||
*
|
||||
* @param string $action_id Action ID.
|
||||
* @return mixed
|
||||
*/
|
||||
public function get_claim_id( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$sql = "SELECT claim_id FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d";
|
||||
$sql = $wpdb->prepare( $sql, $action_id );
|
||||
|
||||
return (int) $wpdb->get_var( $sql );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the action IDs of action in a claim.
|
||||
*
|
||||
* @return int[]
|
||||
*/
|
||||
public function find_actions_by_claim_id( $claim_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$action_ids = array();
|
||||
$before_date = isset( $this->claim_before_date ) ? $this->claim_before_date : as_get_datetime_object();
|
||||
$cut_off = $before_date->format( 'Y-m-d H:i:s' );
|
||||
|
||||
$sql = $wpdb->prepare(
|
||||
"SELECT action_id, scheduled_date_gmt FROM {$wpdb->actionscheduler_actions} WHERE claim_id = %d",
|
||||
$claim_id
|
||||
);
|
||||
|
||||
// Verify that the scheduled date for each action is within the expected bounds (in some unusual
|
||||
// cases, we cannot depend on MySQL to honor all of the WHERE conditions we specify).
|
||||
foreach ( $wpdb->get_results( $sql ) as $claimed_action ) {
|
||||
if ( $claimed_action->scheduled_date_gmt <= $cut_off ) {
|
||||
$action_ids[] = absint( $claimed_action->action_id );
|
||||
}
|
||||
}
|
||||
|
||||
return $action_ids;
|
||||
}
|
||||
|
||||
/**
|
||||
* Release actions from a claim and delete the claim.
|
||||
*
|
||||
* @param ActionScheduler_ActionClaim $claim Claim object.
|
||||
*/
|
||||
public function release_claim( ActionScheduler_ActionClaim $claim ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$wpdb->update( $wpdb->actionscheduler_actions, [ 'claim_id' => 0 ], [ 'claim_id' => $claim->get_id() ], [ '%d' ], [ '%d' ] );
|
||||
$wpdb->delete( $wpdb->actionscheduler_claims, [ 'claim_id' => $claim->get_id() ], [ '%d' ] );
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove the claim from an action.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function unclaim_action( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$wpdb->update(
|
||||
$wpdb->actionscheduler_actions,
|
||||
[ 'claim_id' => 0 ],
|
||||
[ 'action_id' => $action_id ],
|
||||
[ '%s' ],
|
||||
[ '%d' ]
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark an action as failed.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function mark_failure( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$updated = $wpdb->update(
|
||||
$wpdb->actionscheduler_actions,
|
||||
[ 'status' => self::STATUS_FAILED ],
|
||||
[ 'action_id' => $action_id ],
|
||||
[ '%s' ],
|
||||
[ '%d' ]
|
||||
);
|
||||
if ( empty( $updated ) ) {
|
||||
throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add execution message to action log.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function log_execution( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$sql = "UPDATE {$wpdb->actionscheduler_actions} SET attempts = attempts+1, status=%s, last_attempt_gmt = %s, last_attempt_local = %s WHERE action_id = %d";
|
||||
$sql = $wpdb->prepare( $sql, self::STATUS_RUNNING, current_time( 'mysql', true ), current_time( 'mysql' ), $action_id );
|
||||
$wpdb->query( $sql );
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark an action as complete.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function mark_complete( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$updated = $wpdb->update(
|
||||
$wpdb->actionscheduler_actions,
|
||||
[
|
||||
'status' => self::STATUS_COMPLETE,
|
||||
'last_attempt_gmt' => current_time( 'mysql', true ),
|
||||
'last_attempt_local' => current_time( 'mysql' ),
|
||||
],
|
||||
[ 'action_id' => $action_id ],
|
||||
[ '%s' ],
|
||||
[ '%d' ]
|
||||
);
|
||||
if ( empty( $updated ) ) {
|
||||
throw new \InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an action's status.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_status( $action_id ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$sql = "SELECT status FROM {$wpdb->actionscheduler_actions} WHERE action_id=%d";
|
||||
$sql = $wpdb->prepare( $sql, $action_id );
|
||||
$status = $wpdb->get_var( $sql );
|
||||
|
||||
if ( $status === null ) {
|
||||
throw new \InvalidArgumentException( __( 'Invalid action ID. No status found.', 'action-scheduler' ) );
|
||||
} elseif ( empty( $status ) ) {
|
||||
throw new \RuntimeException( __( 'Unknown status found for action.', 'action-scheduler' ) );
|
||||
} else {
|
||||
return $status;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,426 @@
|
||||
<?php
|
||||
|
||||
use ActionScheduler_Store as Store;
|
||||
use Action_Scheduler\Migration\Runner;
|
||||
use Action_Scheduler\Migration\Config;
|
||||
use Action_Scheduler\Migration\Controller;
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_HybridStore
|
||||
*
|
||||
* A wrapper around multiple stores that fetches data from both.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
class ActionScheduler_HybridStore extends Store {
|
||||
const DEMARKATION_OPTION = 'action_scheduler_hybrid_store_demarkation';
|
||||
|
||||
private $primary_store;
|
||||
private $secondary_store;
|
||||
private $migration_runner;
|
||||
|
||||
/**
|
||||
* @var int The dividing line between IDs of actions created
|
||||
* by the primary and secondary stores.
|
||||
*
|
||||
* Methods that accept an action ID will compare the ID against
|
||||
* this to determine which store will contain that ID. In almost
|
||||
* all cases, the ID should come from the primary store, but if
|
||||
* client code is bypassing the API functions and fetching IDs
|
||||
* from elsewhere, then there is a chance that an unmigrated ID
|
||||
* might be requested.
|
||||
*/
|
||||
private $demarkation_id = 0;
|
||||
|
||||
/**
|
||||
* ActionScheduler_HybridStore constructor.
|
||||
*
|
||||
* @param Config $config Migration config object.
|
||||
*/
|
||||
public function __construct( Config $config = null ) {
|
||||
$this->demarkation_id = (int) get_option( self::DEMARKATION_OPTION, 0 );
|
||||
if ( empty( $config ) ) {
|
||||
$config = Controller::instance()->get_migration_config_object();
|
||||
}
|
||||
$this->primary_store = $config->get_destination_store();
|
||||
$this->secondary_store = $config->get_source_store();
|
||||
$this->migration_runner = new Runner( $config );
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the table data store tables.
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
public function init() {
|
||||
add_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10, 2 );
|
||||
$this->primary_store->init();
|
||||
$this->secondary_store->init();
|
||||
remove_action( 'action_scheduler/created_table', [ $this, 'set_autoincrement' ], 10 );
|
||||
}
|
||||
|
||||
/**
|
||||
* When the actions table is created, set its autoincrement
|
||||
* value to be one higher than the posts table to ensure that
|
||||
* there are no ID collisions.
|
||||
*
|
||||
* @param string $table_name
|
||||
* @param string $table_suffix
|
||||
*
|
||||
* @return void
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
public function set_autoincrement( $table_name, $table_suffix ) {
|
||||
if ( ActionScheduler_StoreSchema::ACTIONS_TABLE === $table_suffix ) {
|
||||
if ( empty( $this->demarkation_id ) ) {
|
||||
$this->demarkation_id = $this->set_demarkation_id();
|
||||
}
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
/**
|
||||
* A default date of '0000-00-00 00:00:00' is invalid in MySQL 5.7 when configured with
|
||||
* sql_mode including both STRICT_TRANS_TABLES and NO_ZERO_DATE.
|
||||
*/
|
||||
$default_date = new DateTime( 'tomorrow' );
|
||||
$null_action = new ActionScheduler_NullAction();
|
||||
$date_gmt = $this->get_scheduled_date_string( $null_action, $default_date );
|
||||
$date_local = $this->get_scheduled_date_string_local( $null_action, $default_date );
|
||||
|
||||
$row_count = $wpdb->insert(
|
||||
$wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
|
||||
[
|
||||
'action_id' => $this->demarkation_id,
|
||||
'hook' => '',
|
||||
'status' => '',
|
||||
'scheduled_date_gmt' => $date_gmt,
|
||||
'scheduled_date_local' => $date_local,
|
||||
'last_attempt_gmt' => $date_gmt,
|
||||
'last_attempt_local' => $date_local,
|
||||
]
|
||||
);
|
||||
if ( $row_count > 0 ) {
|
||||
$wpdb->delete(
|
||||
$wpdb->{ActionScheduler_StoreSchema::ACTIONS_TABLE},
|
||||
[ 'action_id' => $this->demarkation_id ]
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Store the demarkation id in WP options.
|
||||
*
|
||||
* @param int $id The ID to set as the demarkation point between the two stores
|
||||
* Leave null to use the next ID from the WP posts table.
|
||||
*
|
||||
* @return int The new ID.
|
||||
*
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
private function set_demarkation_id( $id = null ) {
|
||||
if ( empty( $id ) ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$id = (int) $wpdb->get_var( "SELECT MAX(ID) FROM $wpdb->posts" );
|
||||
$id ++;
|
||||
}
|
||||
update_option( self::DEMARKATION_OPTION, $id );
|
||||
|
||||
return $id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Find the first matching action from the secondary store.
|
||||
* If it exists, migrate it to the primary store immediately.
|
||||
* After it migrates, the secondary store will logically contain
|
||||
* the next matching action, so return the result thence.
|
||||
*
|
||||
* @param string $hook
|
||||
* @param array $params
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function find_action( $hook, $params = [] ) {
|
||||
$found_unmigrated_action = $this->secondary_store->find_action( $hook, $params );
|
||||
if ( ! empty( $found_unmigrated_action ) ) {
|
||||
$this->migrate( [ $found_unmigrated_action ] );
|
||||
}
|
||||
|
||||
return $this->primary_store->find_action( $hook, $params );
|
||||
}
|
||||
|
||||
/**
|
||||
* Find actions matching the query in the secondary source first.
|
||||
* If any are found, migrate them immediately. Then the secondary
|
||||
* store will contain the canonical results.
|
||||
*
|
||||
* @param array $query
|
||||
* @param string $query_type Whether to select or count the results. Default, select.
|
||||
*
|
||||
* @return int[]
|
||||
*/
|
||||
public function query_actions( $query = [], $query_type = 'select' ) {
|
||||
$found_unmigrated_actions = $this->secondary_store->query_actions( $query, 'select' );
|
||||
if ( ! empty( $found_unmigrated_actions ) ) {
|
||||
$this->migrate( $found_unmigrated_actions );
|
||||
}
|
||||
|
||||
return $this->primary_store->query_actions( $query, $query_type );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a count of all actions in the store, grouped by status
|
||||
*
|
||||
* @return array Set of 'status' => int $count pairs for statuses with 1 or more actions of that status.
|
||||
*/
|
||||
public function action_counts() {
|
||||
$unmigrated_actions_count = $this->secondary_store->action_counts();
|
||||
$migrated_actions_count = $this->primary_store->action_counts();
|
||||
$actions_count_by_status = array();
|
||||
|
||||
foreach ( $this->get_status_labels() as $status_key => $status_label ) {
|
||||
|
||||
$count = 0;
|
||||
|
||||
if ( isset( $unmigrated_actions_count[ $status_key ] ) ) {
|
||||
$count += $unmigrated_actions_count[ $status_key ];
|
||||
}
|
||||
|
||||
if ( isset( $migrated_actions_count[ $status_key ] ) ) {
|
||||
$count += $migrated_actions_count[ $status_key ];
|
||||
}
|
||||
|
||||
$actions_count_by_status[ $status_key ] = $count;
|
||||
}
|
||||
|
||||
$actions_count_by_status = array_filter( $actions_count_by_status );
|
||||
|
||||
return $actions_count_by_status;
|
||||
}
|
||||
|
||||
/**
|
||||
* If any actions would have been claimed by the secondary store,
|
||||
* migrate them immediately, then ask the primary store for the
|
||||
* canonical claim.
|
||||
*
|
||||
* @param int $max_actions
|
||||
* @param DateTime|null $before_date
|
||||
*
|
||||
* @return ActionScheduler_ActionClaim
|
||||
*/
|
||||
public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' ) {
|
||||
$claim = $this->secondary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
|
||||
|
||||
$claimed_actions = $claim->get_actions();
|
||||
if ( ! empty( $claimed_actions ) ) {
|
||||
$this->migrate( $claimed_actions );
|
||||
}
|
||||
|
||||
$this->secondary_store->release_claim( $claim );
|
||||
|
||||
return $this->primary_store->stake_claim( $max_actions, $before_date, $hooks, $group );
|
||||
}
|
||||
|
||||
/**
|
||||
* Migrate a list of actions to the table data store.
|
||||
*
|
||||
* @param array $action_ids List of action IDs.
|
||||
*/
|
||||
private function migrate( $action_ids ) {
|
||||
$this->migration_runner->migrate_actions( $action_ids );
|
||||
}
|
||||
|
||||
/**
|
||||
* Save an action to the primary store.
|
||||
*
|
||||
* @param ActionScheduler_Action $action Action object to be saved.
|
||||
* @param DateTime $date Optional. Schedule date. Default null.
|
||||
*
|
||||
* @return int The action ID
|
||||
*/
|
||||
public function save_action( ActionScheduler_Action $action, DateTime $date = null ) {
|
||||
return $this->primary_store->save_action( $action, $date );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve an existing action whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function fetch_action( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id, true );
|
||||
if ( $store ) {
|
||||
return $store->fetch_action( $action_id );
|
||||
} else {
|
||||
return new ActionScheduler_NullAction();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancel an existing action whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function cancel_action( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id );
|
||||
if ( $store ) {
|
||||
$store->cancel_action( $action_id );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an existing action whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function delete_action( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id );
|
||||
if ( $store ) {
|
||||
$store->delete_action( $action_id );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the schedule date an existing action whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function get_date( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id );
|
||||
if ( $store ) {
|
||||
return $store->get_date( $action_id );
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark an existing action as failed whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function mark_failure( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id );
|
||||
if ( $store ) {
|
||||
$store->mark_failure( $action_id );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Log the execution of an existing action whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function log_execution( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id );
|
||||
if ( $store ) {
|
||||
$store->log_execution( $action_id );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark an existing action complete whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function mark_complete( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id );
|
||||
if ( $store ) {
|
||||
$store->mark_complete( $action_id );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an existing action status whether migrated or not.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function get_status( $action_id ) {
|
||||
$store = $this->get_store_from_action_id( $action_id );
|
||||
if ( $store ) {
|
||||
return $store->get_status( $action_id );
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return which store an action is stored in.
|
||||
*
|
||||
* @param int $action_id ID of the action.
|
||||
* @param bool $primary_first Optional flag indicating search the primary store first.
|
||||
* @return ActionScheduler_Store
|
||||
*/
|
||||
protected function get_store_from_action_id( $action_id, $primary_first = false ) {
|
||||
if ( $primary_first ) {
|
||||
$stores = [
|
||||
$this->primary_store,
|
||||
$this->secondary_store,
|
||||
];
|
||||
} elseif ( $action_id < $this->demarkation_id ) {
|
||||
$stores = [
|
||||
$this->secondary_store,
|
||||
$this->primary_store,
|
||||
];
|
||||
} else {
|
||||
$stores = [
|
||||
$this->primary_store,
|
||||
];
|
||||
}
|
||||
|
||||
foreach ( $stores as $store ) {
|
||||
$action = $store->fetch_action( $action_id );
|
||||
if ( ! is_a( $action, 'ActionScheduler_NullAction' ) ) {
|
||||
return $store;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/* * * * * * * * * * * * * * * * * * * * * * * * * * *
|
||||
* All claim-related functions should operate solely
|
||||
* on the primary store.
|
||||
* * * * * * * * * * * * * * * * * * * * * * * * * * */
|
||||
|
||||
/**
|
||||
* Get the claim count from the table data store.
|
||||
*/
|
||||
public function get_claim_count() {
|
||||
return $this->primary_store->get_claim_count();
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the claim ID for an action from the table data store.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function get_claim_id( $action_id ) {
|
||||
return $this->primary_store->get_claim_id( $action_id );
|
||||
}
|
||||
|
||||
/**
|
||||
* Release a claim in the table data store.
|
||||
*
|
||||
* @param ActionScheduler_ActionClaim $claim Claim object.
|
||||
*/
|
||||
public function release_claim( ActionScheduler_ActionClaim $claim ) {
|
||||
$this->primary_store->release_claim( $claim );
|
||||
}
|
||||
|
||||
/**
|
||||
* Release claims on an action in the table data store.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function unclaim_action( $action_id ) {
|
||||
$this->primary_store->unclaim_action( $action_id );
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a list of action IDs by claim.
|
||||
*
|
||||
* @param int $claim_id Claim ID.
|
||||
*/
|
||||
public function find_actions_by_claim_id( $claim_id ) {
|
||||
return $this->primary_store->find_actions_by_claim_id( $claim_id );
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,240 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_wpCommentLogger
|
||||
*/
|
||||
class ActionScheduler_wpCommentLogger extends ActionScheduler_Logger {
|
||||
const AGENT = 'ActionScheduler';
|
||||
const TYPE = 'action_log';
|
||||
|
||||
/**
|
||||
* @param string $action_id
|
||||
* @param string $message
|
||||
* @param DateTime $date
|
||||
*
|
||||
* @return string The log entry ID
|
||||
*/
|
||||
public function log( $action_id, $message, DateTime $date = NULL ) {
|
||||
if ( empty($date) ) {
|
||||
$date = as_get_datetime_object();
|
||||
} else {
|
||||
$date = as_get_datetime_object( clone $date );
|
||||
}
|
||||
$comment_id = $this->create_wp_comment( $action_id, $message, $date );
|
||||
return $comment_id;
|
||||
}
|
||||
|
||||
protected function create_wp_comment( $action_id, $message, DateTime $date ) {
|
||||
|
||||
$comment_date_gmt = $date->format('Y-m-d H:i:s');
|
||||
ActionScheduler_TimezoneHelper::set_local_timezone( $date );
|
||||
$comment_data = array(
|
||||
'comment_post_ID' => $action_id,
|
||||
'comment_date' => $date->format('Y-m-d H:i:s'),
|
||||
'comment_date_gmt' => $comment_date_gmt,
|
||||
'comment_author' => self::AGENT,
|
||||
'comment_content' => $message,
|
||||
'comment_agent' => self::AGENT,
|
||||
'comment_type' => self::TYPE,
|
||||
);
|
||||
return wp_insert_comment($comment_data);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $entry_id
|
||||
*
|
||||
* @return ActionScheduler_LogEntry
|
||||
*/
|
||||
public function get_entry( $entry_id ) {
|
||||
$comment = $this->get_comment( $entry_id );
|
||||
if ( empty($comment) || $comment->comment_type != self::TYPE ) {
|
||||
return new ActionScheduler_NullLogEntry();
|
||||
}
|
||||
|
||||
$date = as_get_datetime_object( $comment->comment_date_gmt );
|
||||
ActionScheduler_TimezoneHelper::set_local_timezone( $date );
|
||||
return new ActionScheduler_LogEntry( $comment->comment_post_ID, $comment->comment_content, $date );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $action_id
|
||||
*
|
||||
* @return ActionScheduler_LogEntry[]
|
||||
*/
|
||||
public function get_logs( $action_id ) {
|
||||
$status = 'all';
|
||||
if ( get_post_status($action_id) == 'trash' ) {
|
||||
$status = 'post-trashed';
|
||||
}
|
||||
$comments = get_comments(array(
|
||||
'post_id' => $action_id,
|
||||
'orderby' => 'comment_date_gmt',
|
||||
'order' => 'ASC',
|
||||
'type' => self::TYPE,
|
||||
'status' => $status,
|
||||
));
|
||||
$logs = array();
|
||||
foreach ( $comments as $c ) {
|
||||
$entry = $this->get_entry( $c );
|
||||
if ( !empty($entry) ) {
|
||||
$logs[] = $entry;
|
||||
}
|
||||
}
|
||||
return $logs;
|
||||
}
|
||||
|
||||
protected function get_comment( $comment_id ) {
|
||||
return get_comment( $comment_id );
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* @param WP_Comment_Query $query
|
||||
*/
|
||||
public function filter_comment_queries( $query ) {
|
||||
foreach ( array('ID', 'parent', 'post_author', 'post_name', 'post_parent', 'type', 'post_type', 'post_id', 'post_ID') as $key ) {
|
||||
if ( !empty($query->query_vars[$key]) ) {
|
||||
return; // don't slow down queries that wouldn't include action_log comments anyway
|
||||
}
|
||||
}
|
||||
$query->query_vars['action_log_filter'] = TRUE;
|
||||
add_filter( 'comments_clauses', array( $this, 'filter_comment_query_clauses' ), 10, 2 );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $clauses
|
||||
* @param WP_Comment_Query $query
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function filter_comment_query_clauses( $clauses, $query ) {
|
||||
if ( !empty($query->query_vars['action_log_filter']) ) {
|
||||
$clauses['where'] .= $this->get_where_clause();
|
||||
}
|
||||
return $clauses;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make sure Action Scheduler logs are excluded from comment feeds, which use WP_Query, not
|
||||
* the WP_Comment_Query class handled by @see self::filter_comment_queries().
|
||||
*
|
||||
* @param string $where
|
||||
* @param WP_Query $query
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function filter_comment_feed( $where, $query ) {
|
||||
if ( is_comment_feed() ) {
|
||||
$where .= $this->get_where_clause();
|
||||
}
|
||||
return $where;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return a SQL clause to exclude Action Scheduler comments.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_where_clause() {
|
||||
global $wpdb;
|
||||
return sprintf( " AND {$wpdb->comments}.comment_type != '%s'", self::TYPE );
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove action log entries from wp_count_comments()
|
||||
*
|
||||
* @param array $stats
|
||||
* @param int $post_id
|
||||
*
|
||||
* @return object
|
||||
*/
|
||||
public function filter_comment_count( $stats, $post_id ) {
|
||||
global $wpdb;
|
||||
|
||||
if ( 0 === $post_id ) {
|
||||
$stats = $this->get_comment_count();
|
||||
}
|
||||
|
||||
return $stats;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the comment counts from our cache, or the database if the cached version isn't set.
|
||||
*
|
||||
* @return object
|
||||
*/
|
||||
protected function get_comment_count() {
|
||||
global $wpdb;
|
||||
|
||||
$stats = get_transient( 'as_comment_count' );
|
||||
|
||||
if ( ! $stats ) {
|
||||
$stats = array();
|
||||
|
||||
$count = $wpdb->get_results( "SELECT comment_approved, COUNT( * ) AS num_comments FROM {$wpdb->comments} WHERE comment_type NOT IN('order_note','action_log') GROUP BY comment_approved", ARRAY_A );
|
||||
|
||||
$total = 0;
|
||||
$stats = array();
|
||||
$approved = array( '0' => 'moderated', '1' => 'approved', 'spam' => 'spam', 'trash' => 'trash', 'post-trashed' => 'post-trashed' );
|
||||
|
||||
foreach ( (array) $count as $row ) {
|
||||
// Don't count post-trashed toward totals
|
||||
if ( 'post-trashed' != $row['comment_approved'] && 'trash' != $row['comment_approved'] ) {
|
||||
$total += $row['num_comments'];
|
||||
}
|
||||
if ( isset( $approved[ $row['comment_approved'] ] ) ) {
|
||||
$stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
|
||||
}
|
||||
}
|
||||
|
||||
$stats['total_comments'] = $total;
|
||||
$stats['all'] = $total;
|
||||
|
||||
foreach ( $approved as $key ) {
|
||||
if ( empty( $stats[ $key ] ) ) {
|
||||
$stats[ $key ] = 0;
|
||||
}
|
||||
}
|
||||
|
||||
$stats = (object) $stats;
|
||||
set_transient( 'as_comment_count', $stats );
|
||||
}
|
||||
|
||||
return $stats;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete comment count cache whenever there is new comment or the status of a comment changes. Cache
|
||||
* will be regenerated next time ActionScheduler_wpCommentLogger::filter_comment_count() is called.
|
||||
*/
|
||||
public function delete_comment_count_cache() {
|
||||
delete_transient( 'as_comment_count' );
|
||||
}
|
||||
|
||||
/**
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
public function init() {
|
||||
add_action( 'action_scheduler_before_process_queue', array( $this, 'disable_comment_counting' ), 10, 0 );
|
||||
add_action( 'action_scheduler_after_process_queue', array( $this, 'enable_comment_counting' ), 10, 0 );
|
||||
|
||||
parent::init();
|
||||
|
||||
add_action( 'pre_get_comments', array( $this, 'filter_comment_queries' ), 10, 1 );
|
||||
add_action( 'wp_count_comments', array( $this, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
|
||||
add_action( 'comment_feed_where', array( $this, 'filter_comment_feed' ), 10, 2 );
|
||||
|
||||
// Delete comments count cache whenever there is a new comment or a comment status changes
|
||||
add_action( 'wp_insert_comment', array( $this, 'delete_comment_count_cache' ) );
|
||||
add_action( 'wp_set_comment_status', array( $this, 'delete_comment_count_cache' ) );
|
||||
}
|
||||
|
||||
public function disable_comment_counting() {
|
||||
wp_defer_comment_counting(true);
|
||||
}
|
||||
public function enable_comment_counting() {
|
||||
wp_defer_comment_counting(false);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,885 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_wpPostStore
|
||||
*/
|
||||
class ActionScheduler_wpPostStore extends ActionScheduler_Store {
|
||||
const POST_TYPE = 'scheduled-action';
|
||||
const GROUP_TAXONOMY = 'action-group';
|
||||
const SCHEDULE_META_KEY = '_action_manager_schedule';
|
||||
const DEPENDENCIES_MET = 'as-post-store-dependencies-met';
|
||||
|
||||
/**
|
||||
* Used to share information about the before_date property of claims internally.
|
||||
*
|
||||
* This is used in preference to passing the same information as a method param
|
||||
* for backwards-compatibility reasons.
|
||||
*
|
||||
* @var DateTime|null
|
||||
*/
|
||||
private $claim_before_date = null;
|
||||
|
||||
/** @var DateTimeZone */
|
||||
protected $local_timezone = NULL;
|
||||
|
||||
public function save_action( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ){
|
||||
try {
|
||||
$this->validate_action( $action );
|
||||
$post_array = $this->create_post_array( $action, $scheduled_date );
|
||||
$post_id = $this->save_post_array( $post_array );
|
||||
$this->save_post_schedule( $post_id, $action->get_schedule() );
|
||||
$this->save_action_group( $post_id, $action->get_group() );
|
||||
do_action( 'action_scheduler_stored_action', $post_id );
|
||||
return $post_id;
|
||||
} catch ( Exception $e ) {
|
||||
throw new RuntimeException( sprintf( __( 'Error saving action: %s', 'action-scheduler' ), $e->getMessage() ), 0 );
|
||||
}
|
||||
}
|
||||
|
||||
protected function create_post_array( ActionScheduler_Action $action, DateTime $scheduled_date = NULL ) {
|
||||
$post = array(
|
||||
'post_type' => self::POST_TYPE,
|
||||
'post_title' => $action->get_hook(),
|
||||
'post_content' => json_encode($action->get_args()),
|
||||
'post_status' => ( $action->is_finished() ? 'publish' : 'pending' ),
|
||||
'post_date_gmt' => $this->get_scheduled_date_string( $action, $scheduled_date ),
|
||||
'post_date' => $this->get_scheduled_date_string_local( $action, $scheduled_date ),
|
||||
);
|
||||
return $post;
|
||||
}
|
||||
|
||||
protected function save_post_array( $post_array ) {
|
||||
add_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10, 1 );
|
||||
add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 );
|
||||
|
||||
$has_kses = false !== has_filter( 'content_save_pre', 'wp_filter_post_kses' );
|
||||
|
||||
if ( $has_kses ) {
|
||||
// Prevent KSES from corrupting JSON in post_content.
|
||||
kses_remove_filters();
|
||||
}
|
||||
|
||||
$post_id = wp_insert_post($post_array);
|
||||
|
||||
if ( $has_kses ) {
|
||||
kses_init_filters();
|
||||
}
|
||||
|
||||
remove_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10 );
|
||||
remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 );
|
||||
|
||||
if ( is_wp_error($post_id) || empty($post_id) ) {
|
||||
throw new RuntimeException( __( 'Unable to save action.', 'action-scheduler' ) );
|
||||
}
|
||||
return $post_id;
|
||||
}
|
||||
|
||||
public function filter_insert_post_data( $postdata ) {
|
||||
if ( $postdata['post_type'] == self::POST_TYPE ) {
|
||||
$postdata['post_author'] = 0;
|
||||
if ( $postdata['post_status'] == 'future' ) {
|
||||
$postdata['post_status'] = 'publish';
|
||||
}
|
||||
}
|
||||
return $postdata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a (probably unique) post name for scheduled actions in a more performant manner than wp_unique_post_slug().
|
||||
*
|
||||
* When an action's post status is transitioned to something other than 'draft', 'pending' or 'auto-draft, like 'publish'
|
||||
* or 'failed' or 'trash', WordPress will find a unique slug (stored in post_name column) using the wp_unique_post_slug()
|
||||
* function. This is done to ensure URL uniqueness. The approach taken by wp_unique_post_slug() is to iterate over existing
|
||||
* post_name values that match, and append a number 1 greater than the largest. This makes sense when manually creating a
|
||||
* post from the Edit Post screen. It becomes a bottleneck when automatically processing thousands of actions, with a
|
||||
* database containing thousands of related post_name values.
|
||||
*
|
||||
* WordPress 5.1 introduces the 'pre_wp_unique_post_slug' filter for plugins to address this issue.
|
||||
*
|
||||
* We can short-circuit WordPress's wp_unique_post_slug() approach using the 'pre_wp_unique_post_slug' filter. This
|
||||
* method is available to be used as a callback on that filter. It provides a more scalable approach to generating a
|
||||
* post_name/slug that is probably unique. Because Action Scheduler never actually uses the post_name field, or an
|
||||
* action's slug, being probably unique is good enough.
|
||||
*
|
||||
* For more backstory on this issue, see:
|
||||
* - https://github.com/woocommerce/action-scheduler/issues/44 and
|
||||
* - https://core.trac.wordpress.org/ticket/21112
|
||||
*
|
||||
* @param string $override_slug Short-circuit return value.
|
||||
* @param string $slug The desired slug (post_name).
|
||||
* @param int $post_ID Post ID.
|
||||
* @param string $post_status The post status.
|
||||
* @param string $post_type Post type.
|
||||
* @return string
|
||||
*/
|
||||
public function set_unique_post_slug( $override_slug, $slug, $post_ID, $post_status, $post_type ) {
|
||||
if ( self::POST_TYPE == $post_type ) {
|
||||
$override_slug = uniqid( self::POST_TYPE . '-', true ) . '-' . wp_generate_password( 32, false );
|
||||
}
|
||||
return $override_slug;
|
||||
}
|
||||
|
||||
protected function save_post_schedule( $post_id, $schedule ) {
|
||||
update_post_meta( $post_id, self::SCHEDULE_META_KEY, $schedule );
|
||||
}
|
||||
|
||||
protected function save_action_group( $post_id, $group ) {
|
||||
if ( empty($group) ) {
|
||||
wp_set_object_terms( $post_id, array(), self::GROUP_TAXONOMY, FALSE );
|
||||
} else {
|
||||
wp_set_object_terms( $post_id, array($group), self::GROUP_TAXONOMY, FALSE );
|
||||
}
|
||||
}
|
||||
|
||||
public function fetch_action( $action_id ) {
|
||||
$post = $this->get_post( $action_id );
|
||||
if ( empty($post) || $post->post_type != self::POST_TYPE ) {
|
||||
return $this->get_null_action();
|
||||
}
|
||||
|
||||
try {
|
||||
$action = $this->make_action_from_post( $post );
|
||||
} catch ( ActionScheduler_InvalidActionException $exception ) {
|
||||
do_action( 'action_scheduler_failed_fetch_action', $post->ID, $exception );
|
||||
return $this->get_null_action();
|
||||
}
|
||||
|
||||
return $action;
|
||||
}
|
||||
|
||||
protected function get_post( $action_id ) {
|
||||
if ( empty($action_id) ) {
|
||||
return NULL;
|
||||
}
|
||||
return get_post($action_id);
|
||||
}
|
||||
|
||||
protected function get_null_action() {
|
||||
return new ActionScheduler_NullAction();
|
||||
}
|
||||
|
||||
protected function make_action_from_post( $post ) {
|
||||
$hook = $post->post_title;
|
||||
|
||||
$args = json_decode( $post->post_content, true );
|
||||
$this->validate_args( $args, $post->ID );
|
||||
|
||||
$schedule = get_post_meta( $post->ID, self::SCHEDULE_META_KEY, true );
|
||||
$this->validate_schedule( $schedule, $post->ID );
|
||||
|
||||
$group = wp_get_object_terms( $post->ID, self::GROUP_TAXONOMY, array('fields' => 'names') );
|
||||
$group = empty( $group ) ? '' : reset($group);
|
||||
|
||||
return ActionScheduler::factory()->get_stored_action( $this->get_action_status_by_post_status( $post->post_status ), $hook, $args, $schedule, $group );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $post_status
|
||||
*
|
||||
* @throws InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels()
|
||||
* @return string
|
||||
*/
|
||||
protected function get_action_status_by_post_status( $post_status ) {
|
||||
|
||||
switch ( $post_status ) {
|
||||
case 'publish' :
|
||||
$action_status = self::STATUS_COMPLETE;
|
||||
break;
|
||||
case 'trash' :
|
||||
$action_status = self::STATUS_CANCELED;
|
||||
break;
|
||||
default :
|
||||
if ( ! array_key_exists( $post_status, $this->get_status_labels() ) ) {
|
||||
throw new InvalidArgumentException( sprintf( 'Invalid post status: "%s". No matching action status available.', $post_status ) );
|
||||
}
|
||||
$action_status = $post_status;
|
||||
break;
|
||||
}
|
||||
|
||||
return $action_status;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $action_status
|
||||
* @throws InvalidArgumentException if $post_status not in known status fields returned by $this->get_status_labels()
|
||||
* @return string
|
||||
*/
|
||||
protected function get_post_status_by_action_status( $action_status ) {
|
||||
|
||||
switch ( $action_status ) {
|
||||
case self::STATUS_COMPLETE :
|
||||
$post_status = 'publish';
|
||||
break;
|
||||
case self::STATUS_CANCELED :
|
||||
$post_status = 'trash';
|
||||
break;
|
||||
default :
|
||||
if ( ! array_key_exists( $action_status, $this->get_status_labels() ) ) {
|
||||
throw new InvalidArgumentException( sprintf( 'Invalid action status: "%s".', $action_status ) );
|
||||
}
|
||||
$post_status = $action_status;
|
||||
break;
|
||||
}
|
||||
|
||||
return $post_status;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $hook
|
||||
* @param array $params
|
||||
*
|
||||
* @return string ID of the next action matching the criteria or NULL if not found
|
||||
*/
|
||||
public function find_action( $hook, $params = array() ) {
|
||||
$params = wp_parse_args( $params, array(
|
||||
'args' => NULL,
|
||||
'status' => ActionScheduler_Store::STATUS_PENDING,
|
||||
'group' => '',
|
||||
));
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$query = "SELECT p.ID FROM {$wpdb->posts} p";
|
||||
$args = array();
|
||||
if ( !empty($params['group']) ) {
|
||||
$query .= " INNER JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID";
|
||||
$query .= " INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id";
|
||||
$query .= " INNER JOIN {$wpdb->terms} t ON tt.term_id=t.term_id AND t.slug=%s";
|
||||
$args[] = $params['group'];
|
||||
}
|
||||
$query .= " WHERE p.post_title=%s";
|
||||
$args[] = $hook;
|
||||
$query .= " AND p.post_type=%s";
|
||||
$args[] = self::POST_TYPE;
|
||||
if ( !is_null($params['args']) ) {
|
||||
$query .= " AND p.post_content=%s";
|
||||
$args[] = json_encode($params['args']);
|
||||
}
|
||||
|
||||
if ( ! empty( $params['status'] ) ) {
|
||||
$query .= " AND p.post_status=%s";
|
||||
$args[] = $this->get_post_status_by_action_status( $params['status'] );
|
||||
}
|
||||
|
||||
switch ( $params['status'] ) {
|
||||
case self::STATUS_COMPLETE:
|
||||
case self::STATUS_RUNNING:
|
||||
case self::STATUS_FAILED:
|
||||
$order = 'DESC'; // Find the most recent action that matches
|
||||
break;
|
||||
case self::STATUS_PENDING:
|
||||
default:
|
||||
$order = 'ASC'; // Find the next action that matches
|
||||
break;
|
||||
}
|
||||
$query .= " ORDER BY post_date_gmt $order LIMIT 1";
|
||||
|
||||
$query = $wpdb->prepare( $query, $args );
|
||||
|
||||
$id = $wpdb->get_var($query);
|
||||
return $id;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the SQL statement to query (or count) actions.
|
||||
*
|
||||
* @param array $query Filtering options
|
||||
* @param string $select_or_count Whether the SQL should select and return the IDs or just the row count
|
||||
* @throws InvalidArgumentException if $select_or_count not count or select
|
||||
* @return string SQL statement. The returned SQL is already properly escaped.
|
||||
*/
|
||||
protected function get_query_actions_sql( array $query, $select_or_count = 'select' ) {
|
||||
|
||||
if ( ! in_array( $select_or_count, array( 'select', 'count' ) ) ) {
|
||||
throw new InvalidArgumentException( __( 'Invalid schedule. Cannot save action.', 'action-scheduler' ) );
|
||||
}
|
||||
|
||||
$query = wp_parse_args( $query, array(
|
||||
'hook' => '',
|
||||
'args' => NULL,
|
||||
'date' => NULL,
|
||||
'date_compare' => '<=',
|
||||
'modified' => NULL,
|
||||
'modified_compare' => '<=',
|
||||
'group' => '',
|
||||
'status' => '',
|
||||
'claimed' => NULL,
|
||||
'per_page' => 5,
|
||||
'offset' => 0,
|
||||
'orderby' => 'date',
|
||||
'order' => 'ASC',
|
||||
'search' => '',
|
||||
) );
|
||||
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$sql = ( 'count' === $select_or_count ) ? 'SELECT count(p.ID)' : 'SELECT p.ID ';
|
||||
$sql .= "FROM {$wpdb->posts} p";
|
||||
$sql_params = array();
|
||||
if ( empty( $query['group'] ) && 'group' === $query['orderby'] ) {
|
||||
$sql .= " LEFT JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID";
|
||||
$sql .= " LEFT JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id";
|
||||
$sql .= " LEFT JOIN {$wpdb->terms} t ON tt.term_id=t.term_id";
|
||||
} elseif ( ! empty( $query['group'] ) ) {
|
||||
$sql .= " INNER JOIN {$wpdb->term_relationships} tr ON tr.object_id=p.ID";
|
||||
$sql .= " INNER JOIN {$wpdb->term_taxonomy} tt ON tr.term_taxonomy_id=tt.term_taxonomy_id";
|
||||
$sql .= " INNER JOIN {$wpdb->terms} t ON tt.term_id=t.term_id";
|
||||
$sql .= " AND t.slug=%s";
|
||||
$sql_params[] = $query['group'];
|
||||
}
|
||||
$sql .= " WHERE post_type=%s";
|
||||
$sql_params[] = self::POST_TYPE;
|
||||
if ( $query['hook'] ) {
|
||||
$sql .= " AND p.post_title=%s";
|
||||
$sql_params[] = $query['hook'];
|
||||
}
|
||||
if ( !is_null($query['args']) ) {
|
||||
$sql .= " AND p.post_content=%s";
|
||||
$sql_params[] = json_encode($query['args']);
|
||||
}
|
||||
|
||||
if ( ! empty( $query['status'] ) ) {
|
||||
$sql .= " AND p.post_status=%s";
|
||||
$sql_params[] = $this->get_post_status_by_action_status( $query['status'] );
|
||||
}
|
||||
|
||||
if ( $query['date'] instanceof DateTime ) {
|
||||
$date = clone $query['date'];
|
||||
$date->setTimezone( new DateTimeZone('UTC') );
|
||||
$date_string = $date->format('Y-m-d H:i:s');
|
||||
$comparator = $this->validate_sql_comparator($query['date_compare']);
|
||||
$sql .= " AND p.post_date_gmt $comparator %s";
|
||||
$sql_params[] = $date_string;
|
||||
}
|
||||
|
||||
if ( $query['modified'] instanceof DateTime ) {
|
||||
$modified = clone $query['modified'];
|
||||
$modified->setTimezone( new DateTimeZone('UTC') );
|
||||
$date_string = $modified->format('Y-m-d H:i:s');
|
||||
$comparator = $this->validate_sql_comparator($query['modified_compare']);
|
||||
$sql .= " AND p.post_modified_gmt $comparator %s";
|
||||
$sql_params[] = $date_string;
|
||||
}
|
||||
|
||||
if ( $query['claimed'] === TRUE ) {
|
||||
$sql .= " AND p.post_password != ''";
|
||||
} elseif ( $query['claimed'] === FALSE ) {
|
||||
$sql .= " AND p.post_password = ''";
|
||||
} elseif ( !is_null($query['claimed']) ) {
|
||||
$sql .= " AND p.post_password = %s";
|
||||
$sql_params[] = $query['claimed'];
|
||||
}
|
||||
|
||||
if ( ! empty( $query['search'] ) ) {
|
||||
$sql .= " AND (p.post_title LIKE %s OR p.post_content LIKE %s OR p.post_password LIKE %s)";
|
||||
for( $i = 0; $i < 3; $i++ ) {
|
||||
$sql_params[] = sprintf( '%%%s%%', $query['search'] );
|
||||
}
|
||||
}
|
||||
|
||||
if ( 'select' === $select_or_count ) {
|
||||
switch ( $query['orderby'] ) {
|
||||
case 'hook':
|
||||
$orderby = 'p.post_title';
|
||||
break;
|
||||
case 'group':
|
||||
$orderby = 't.name';
|
||||
break;
|
||||
case 'status':
|
||||
$orderby = 'p.post_status';
|
||||
break;
|
||||
case 'modified':
|
||||
$orderby = 'p.post_modified';
|
||||
break;
|
||||
case 'claim_id':
|
||||
$orderby = 'p.post_password';
|
||||
break;
|
||||
case 'schedule':
|
||||
case 'date':
|
||||
default:
|
||||
$orderby = 'p.post_date_gmt';
|
||||
break;
|
||||
}
|
||||
if ( 'ASC' === strtoupper( $query['order'] ) ) {
|
||||
$order = 'ASC';
|
||||
} else {
|
||||
$order = 'DESC';
|
||||
}
|
||||
$sql .= " ORDER BY $orderby $order";
|
||||
if ( $query['per_page'] > 0 ) {
|
||||
$sql .= " LIMIT %d, %d";
|
||||
$sql_params[] = $query['offset'];
|
||||
$sql_params[] = $query['per_page'];
|
||||
}
|
||||
}
|
||||
|
||||
return $wpdb->prepare( $sql, $sql_params );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $query
|
||||
* @param string $query_type Whether to select or count the results. Default, select.
|
||||
* @return string|array The IDs of actions matching the query
|
||||
*/
|
||||
public function query_actions( $query = array(), $query_type = 'select' ) {
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$sql = $this->get_query_actions_sql( $query, $query_type );
|
||||
|
||||
return ( 'count' === $query_type ) ? $wpdb->get_var( $sql ) : $wpdb->get_col( $sql );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a count of all actions in the store, grouped by status
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function action_counts() {
|
||||
|
||||
$action_counts_by_status = array();
|
||||
$action_stati_and_labels = $this->get_status_labels();
|
||||
$posts_count_by_status = (array) wp_count_posts( self::POST_TYPE, 'readable' );
|
||||
|
||||
foreach ( $posts_count_by_status as $post_status_name => $count ) {
|
||||
|
||||
try {
|
||||
$action_status_name = $this->get_action_status_by_post_status( $post_status_name );
|
||||
} catch ( Exception $e ) {
|
||||
// Ignore any post statuses that aren't for actions
|
||||
continue;
|
||||
}
|
||||
if ( array_key_exists( $action_status_name, $action_stati_and_labels ) ) {
|
||||
$action_counts_by_status[ $action_status_name ] = $count;
|
||||
}
|
||||
}
|
||||
|
||||
return $action_counts_by_status;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $action_id
|
||||
*
|
||||
* @throws InvalidArgumentException
|
||||
*/
|
||||
public function cancel_action( $action_id ) {
|
||||
$post = get_post( $action_id );
|
||||
if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
|
||||
throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
do_action( 'action_scheduler_canceled_action', $action_id );
|
||||
add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 );
|
||||
wp_trash_post( $action_id );
|
||||
remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 );
|
||||
}
|
||||
|
||||
public function delete_action( $action_id ) {
|
||||
$post = get_post( $action_id );
|
||||
if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
|
||||
throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
do_action( 'action_scheduler_deleted_action', $action_id );
|
||||
|
||||
wp_delete_post( $action_id, TRUE );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $action_id
|
||||
*
|
||||
* @throws InvalidArgumentException
|
||||
* @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran.
|
||||
*/
|
||||
public function get_date( $action_id ) {
|
||||
$next = $this->get_date_gmt( $action_id );
|
||||
return ActionScheduler_TimezoneHelper::set_local_timezone( $next );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $action_id
|
||||
*
|
||||
* @throws InvalidArgumentException
|
||||
* @return ActionScheduler_DateTime The date the action is schedule to run, or the date that it ran.
|
||||
*/
|
||||
public function get_date_gmt( $action_id ) {
|
||||
$post = get_post( $action_id );
|
||||
if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
|
||||
throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
if ( $post->post_status == 'publish' ) {
|
||||
return as_get_datetime_object( $post->post_modified_gmt );
|
||||
} else {
|
||||
return as_get_datetime_object( $post->post_date_gmt );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $max_actions
|
||||
* @param DateTime $before_date Jobs must be schedule before this date. Defaults to now.
|
||||
* @param array $hooks Claim only actions with a hook or hooks.
|
||||
* @param string $group Claim only actions in the given group.
|
||||
*
|
||||
* @return ActionScheduler_ActionClaim
|
||||
* @throws RuntimeException When there is an error staking a claim.
|
||||
* @throws InvalidArgumentException When the given group is not valid.
|
||||
*/
|
||||
public function stake_claim( $max_actions = 10, DateTime $before_date = null, $hooks = array(), $group = '' ) {
|
||||
$this->claim_before_date = $before_date;
|
||||
$claim_id = $this->generate_claim_id();
|
||||
$this->claim_actions( $claim_id, $max_actions, $before_date, $hooks, $group );
|
||||
$action_ids = $this->find_actions_by_claim_id( $claim_id );
|
||||
$this->claim_before_date = null;
|
||||
|
||||
return new ActionScheduler_ActionClaim( $claim_id, $action_ids );
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function get_claim_count(){
|
||||
global $wpdb;
|
||||
|
||||
$sql = "SELECT COUNT(DISTINCT post_password) FROM {$wpdb->posts} WHERE post_password != '' AND post_type = %s AND post_status IN ('in-progress','pending')";
|
||||
$sql = $wpdb->prepare( $sql, array( self::POST_TYPE ) );
|
||||
|
||||
return $wpdb->get_var( $sql );
|
||||
}
|
||||
|
||||
protected function generate_claim_id() {
|
||||
$claim_id = md5(microtime(true) . rand(0,1000));
|
||||
return substr($claim_id, 0, 20); // to fit in db field with 20 char limit
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $claim_id
|
||||
* @param int $limit
|
||||
* @param DateTime $before_date Should use UTC timezone.
|
||||
* @param array $hooks Claim only actions with a hook or hooks.
|
||||
* @param string $group Claim only actions in the given group.
|
||||
*
|
||||
* @return int The number of actions that were claimed
|
||||
* @throws RuntimeException When there is a database error.
|
||||
* @throws InvalidArgumentException When the group is invalid.
|
||||
*/
|
||||
protected function claim_actions( $claim_id, $limit, DateTime $before_date = null, $hooks = array(), $group = '' ) {
|
||||
// Set up initial variables.
|
||||
$date = null === $before_date ? as_get_datetime_object() : clone $before_date;
|
||||
$limit_ids = ! empty( $group );
|
||||
$ids = $limit_ids ? $this->get_actions_by_group( $group, $limit, $date ) : array();
|
||||
|
||||
// If limiting by IDs and no posts found, then return early since we have nothing to update.
|
||||
if ( $limit_ids && 0 === count( $ids ) ) {
|
||||
return 0;
|
||||
}
|
||||
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
/*
|
||||
* Build up custom query to update the affected posts. Parameters are built as a separate array
|
||||
* to make it easier to identify where they are in the query.
|
||||
*
|
||||
* We can't use $wpdb->update() here because of the "ID IN ..." clause.
|
||||
*/
|
||||
$update = "UPDATE {$wpdb->posts} SET post_password = %s, post_modified_gmt = %s, post_modified = %s";
|
||||
$params = array(
|
||||
$claim_id,
|
||||
current_time( 'mysql', true ),
|
||||
current_time( 'mysql' ),
|
||||
);
|
||||
|
||||
// Build initial WHERE clause.
|
||||
$where = "WHERE post_type = %s AND post_status = %s AND post_password = ''";
|
||||
$params[] = self::POST_TYPE;
|
||||
$params[] = ActionScheduler_Store::STATUS_PENDING;
|
||||
|
||||
if ( ! empty( $hooks ) ) {
|
||||
$placeholders = array_fill( 0, count( $hooks ), '%s' );
|
||||
$where .= ' AND post_title IN (' . join( ', ', $placeholders ) . ')';
|
||||
$params = array_merge( $params, array_values( $hooks ) );
|
||||
}
|
||||
|
||||
/*
|
||||
* Add the IDs to the WHERE clause. IDs not escaped because they came directly from a prior DB query.
|
||||
*
|
||||
* If we're not limiting by IDs, then include the post_date_gmt clause.
|
||||
*/
|
||||
if ( $limit_ids ) {
|
||||
$where .= ' AND ID IN (' . join( ',', $ids ) . ')';
|
||||
} else {
|
||||
$where .= ' AND post_date_gmt <= %s';
|
||||
$params[] = $date->format( 'Y-m-d H:i:s' );
|
||||
}
|
||||
|
||||
// Add the ORDER BY clause and,ms limit.
|
||||
$order = 'ORDER BY menu_order ASC, post_date_gmt ASC, ID ASC LIMIT %d';
|
||||
$params[] = $limit;
|
||||
|
||||
// Run the query and gather results.
|
||||
$rows_affected = $wpdb->query( $wpdb->prepare( "{$update} {$where} {$order}", $params ) );
|
||||
if ( $rows_affected === false ) {
|
||||
throw new RuntimeException( __( 'Unable to claim actions. Database error.', 'action-scheduler' ) );
|
||||
}
|
||||
|
||||
return (int) $rows_affected;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get IDs of actions within a certain group and up to a certain date/time.
|
||||
*
|
||||
* @param string $group The group to use in finding actions.
|
||||
* @param int $limit The number of actions to retrieve.
|
||||
* @param DateTime $date DateTime object representing cutoff time for actions. Actions retrieved will be
|
||||
* up to and including this DateTime.
|
||||
*
|
||||
* @return array IDs of actions in the appropriate group and before the appropriate time.
|
||||
* @throws InvalidArgumentException When the group does not exist.
|
||||
*/
|
||||
protected function get_actions_by_group( $group, $limit, DateTime $date ) {
|
||||
// Ensure the group exists before continuing.
|
||||
if ( ! term_exists( $group, self::GROUP_TAXONOMY )) {
|
||||
throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'action-scheduler' ), $group ) );
|
||||
}
|
||||
|
||||
// Set up a query for post IDs to use later.
|
||||
$query = new WP_Query();
|
||||
$query_args = array(
|
||||
'fields' => 'ids',
|
||||
'post_type' => self::POST_TYPE,
|
||||
'post_status' => ActionScheduler_Store::STATUS_PENDING,
|
||||
'has_password' => false,
|
||||
'posts_per_page' => $limit * 3,
|
||||
'suppress_filters' => true,
|
||||
'no_found_rows' => true,
|
||||
'orderby' => array(
|
||||
'menu_order' => 'ASC',
|
||||
'date' => 'ASC',
|
||||
'ID' => 'ASC',
|
||||
),
|
||||
'date_query' => array(
|
||||
'column' => 'post_date_gmt',
|
||||
'before' => $date->format( 'Y-m-d H:i' ),
|
||||
'inclusive' => true,
|
||||
),
|
||||
'tax_query' => array(
|
||||
array(
|
||||
'taxonomy' => self::GROUP_TAXONOMY,
|
||||
'field' => 'slug',
|
||||
'terms' => $group,
|
||||
'include_children' => false,
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
return $query->query( $query_args );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $claim_id
|
||||
* @return array
|
||||
*/
|
||||
public function find_actions_by_claim_id( $claim_id ) {
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$sql = "SELECT ID, post_date_gmt FROM {$wpdb->posts} WHERE post_type = %s AND post_password = %s";
|
||||
$sql = $wpdb->prepare( $sql, array( self::POST_TYPE, $claim_id ) );
|
||||
|
||||
$action_ids = array();
|
||||
$before_date = isset( $this->claim_before_date ) ? $this->claim_before_date : as_get_datetime_object();
|
||||
$cut_off = $before_date->format( 'Y-m-d H:i:s' );
|
||||
|
||||
// Verify that the scheduled date for each action is within the expected bounds (in some unusual
|
||||
// cases, we cannot depend on MySQL to honor all of the WHERE conditions we specify).
|
||||
foreach ( $wpdb->get_results( $sql ) as $claimed_action ) {
|
||||
if ( $claimed_action->post_date_gmt <= $cut_off ) {
|
||||
$action_ids[] = absint( $claimed_action->ID );
|
||||
}
|
||||
}
|
||||
|
||||
return $action_ids;
|
||||
}
|
||||
|
||||
public function release_claim( ActionScheduler_ActionClaim $claim ) {
|
||||
$action_ids = $this->find_actions_by_claim_id( $claim->get_id() );
|
||||
if ( empty( $action_ids ) ) {
|
||||
return; // nothing to do
|
||||
}
|
||||
$action_id_string = implode( ',', array_map( 'intval', $action_ids ) );
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$sql = "UPDATE {$wpdb->posts} SET post_password = '' WHERE ID IN ($action_id_string) AND post_password = %s";
|
||||
$sql = $wpdb->prepare( $sql, array( $claim->get_id() ) );
|
||||
$result = $wpdb->query( $sql );
|
||||
if ( $result === false ) {
|
||||
/* translators: %s: claim ID */
|
||||
throw new RuntimeException( sprintf( __( 'Unable to unlock claim %s. Database error.', 'action-scheduler' ), $claim->get_id() ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $action_id
|
||||
*/
|
||||
public function unclaim_action( $action_id ) {
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$sql = "UPDATE {$wpdb->posts} SET post_password = '' WHERE ID = %d AND post_type = %s";
|
||||
$sql = $wpdb->prepare( $sql, $action_id, self::POST_TYPE );
|
||||
$result = $wpdb->query( $sql );
|
||||
if ( $result === false ) {
|
||||
/* translators: %s: action ID */
|
||||
throw new RuntimeException( sprintf( __( 'Unable to unlock claim on action %s. Database error.', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
}
|
||||
|
||||
public function mark_failure( $action_id ) {
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
$sql = "UPDATE {$wpdb->posts} SET post_status = %s WHERE ID = %d AND post_type = %s";
|
||||
$sql = $wpdb->prepare( $sql, self::STATUS_FAILED, $action_id, self::POST_TYPE );
|
||||
$result = $wpdb->query( $sql );
|
||||
if ( $result === false ) {
|
||||
/* translators: %s: action ID */
|
||||
throw new RuntimeException( sprintf( __( 'Unable to mark failure on action %s. Database error.', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an action's claim ID, as stored in the post password column
|
||||
*
|
||||
* @param string $action_id
|
||||
* @return mixed
|
||||
*/
|
||||
public function get_claim_id( $action_id ) {
|
||||
return $this->get_post_column( $action_id, 'post_password' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Return an action's status, as stored in the post status column
|
||||
*
|
||||
* @param string $action_id
|
||||
* @return mixed
|
||||
*/
|
||||
public function get_status( $action_id ) {
|
||||
$status = $this->get_post_column( $action_id, 'post_status' );
|
||||
|
||||
if ( $status === null ) {
|
||||
throw new InvalidArgumentException( __( 'Invalid action ID. No status found.', 'action-scheduler' ) );
|
||||
}
|
||||
|
||||
return $this->get_action_status_by_post_status( $status );
|
||||
}
|
||||
|
||||
private function get_post_column( $action_id, $column_name ) {
|
||||
/** @var \wpdb $wpdb */
|
||||
global $wpdb;
|
||||
return $wpdb->get_var( $wpdb->prepare( "SELECT {$column_name} FROM {$wpdb->posts} WHERE ID=%d AND post_type=%s", $action_id, self::POST_TYPE ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $action_id
|
||||
*/
|
||||
public function log_execution( $action_id ) {
|
||||
/** @var wpdb $wpdb */
|
||||
global $wpdb;
|
||||
|
||||
$sql = "UPDATE {$wpdb->posts} SET menu_order = menu_order+1, post_status=%s, post_modified_gmt = %s, post_modified = %s WHERE ID = %d AND post_type = %s";
|
||||
$sql = $wpdb->prepare( $sql, self::STATUS_RUNNING, current_time('mysql', true), current_time('mysql'), $action_id, self::POST_TYPE );
|
||||
$wpdb->query($sql);
|
||||
}
|
||||
|
||||
/**
|
||||
* Record that an action was completed.
|
||||
*
|
||||
* @param int $action_id ID of the completed action.
|
||||
* @throws InvalidArgumentException|RuntimeException
|
||||
*/
|
||||
public function mark_complete( $action_id ) {
|
||||
$post = get_post( $action_id );
|
||||
if ( empty( $post ) || ( $post->post_type != self::POST_TYPE ) ) {
|
||||
throw new InvalidArgumentException( sprintf( __( 'Unidentified action %s', 'action-scheduler' ), $action_id ) );
|
||||
}
|
||||
add_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10, 1 );
|
||||
add_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10, 5 );
|
||||
$result = wp_update_post(array(
|
||||
'ID' => $action_id,
|
||||
'post_status' => 'publish',
|
||||
), TRUE);
|
||||
remove_filter( 'wp_insert_post_data', array( $this, 'filter_insert_post_data' ), 10 );
|
||||
remove_filter( 'pre_wp_unique_post_slug', array( $this, 'set_unique_post_slug' ), 10 );
|
||||
if ( is_wp_error( $result ) ) {
|
||||
throw new RuntimeException( $result->get_error_message() );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Mark action as migrated when there is an error deleting the action.
|
||||
*
|
||||
* @param int $action_id Action ID.
|
||||
*/
|
||||
public function mark_migrated( $action_id ) {
|
||||
wp_update_post(
|
||||
array(
|
||||
'ID' => $action_id,
|
||||
'post_status' => 'migrated'
|
||||
)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine whether the post store can be migrated.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function migration_dependencies_met( $setting ) {
|
||||
global $wpdb;
|
||||
|
||||
$dependencies_met = get_transient( self::DEPENDENCIES_MET );
|
||||
if ( empty( $dependencies_met ) ) {
|
||||
$maximum_args_length = apply_filters( 'action_scheduler_maximum_args_length', 191 );
|
||||
$found_action = $wpdb->get_var(
|
||||
$wpdb->prepare(
|
||||
"SELECT ID FROM {$wpdb->posts} WHERE post_type = %s AND CHAR_LENGTH(post_content) > %d LIMIT 1",
|
||||
$maximum_args_length,
|
||||
self::POST_TYPE
|
||||
)
|
||||
);
|
||||
$dependencies_met = $found_action ? 'no' : 'yes';
|
||||
set_transient( self::DEPENDENCIES_MET, $dependencies_met, DAY_IN_SECONDS );
|
||||
}
|
||||
|
||||
return 'yes' == $dependencies_met ? $setting : false;
|
||||
}
|
||||
|
||||
/**
|
||||
* InnoDB indexes have a maximum size of 767 bytes by default, which is only 191 characters with utf8mb4.
|
||||
*
|
||||
* Previously, AS wasn't concerned about args length, as we used the (unindex) post_content column. However,
|
||||
* as we prepare to move to custom tables, and can use an indexed VARCHAR column instead, we want to warn
|
||||
* developers of this impending requirement.
|
||||
*
|
||||
* @param ActionScheduler_Action $action
|
||||
*/
|
||||
protected function validate_action( ActionScheduler_Action $action ) {
|
||||
try {
|
||||
parent::validate_action( $action );
|
||||
} catch ( Exception $e ) {
|
||||
$message = sprintf( __( '%s Support for strings longer than this will be removed in a future version.', 'action-scheduler' ), $e->getMessage() );
|
||||
_doing_it_wrong( 'ActionScheduler_Action::$args', $message, '2.1.0' );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
public function init() {
|
||||
add_filter( 'action_scheduler_migration_dependencies_met', array( $this, 'migration_dependencies_met' ) );
|
||||
|
||||
$post_type_registrar = new ActionScheduler_wpPostStore_PostTypeRegistrar();
|
||||
$post_type_registrar->register();
|
||||
|
||||
$post_status_registrar = new ActionScheduler_wpPostStore_PostStatusRegistrar();
|
||||
$post_status_registrar->register();
|
||||
|
||||
$taxonomy_registrar = new ActionScheduler_wpPostStore_TaxonomyRegistrar();
|
||||
$taxonomy_registrar->register();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,58 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_wpPostStore_PostStatusRegistrar
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
class ActionScheduler_wpPostStore_PostStatusRegistrar {
|
||||
public function register() {
|
||||
register_post_status( ActionScheduler_Store::STATUS_RUNNING, array_merge( $this->post_status_args(), $this->post_status_running_labels() ) );
|
||||
register_post_status( ActionScheduler_Store::STATUS_FAILED, array_merge( $this->post_status_args(), $this->post_status_failed_labels() ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the args array for the post type definition
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function post_status_args() {
|
||||
$args = array(
|
||||
'public' => false,
|
||||
'exclude_from_search' => false,
|
||||
'show_in_admin_all_list' => true,
|
||||
'show_in_admin_status_list' => true,
|
||||
);
|
||||
|
||||
return apply_filters( 'action_scheduler_post_status_args', $args );
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the args array for the post type definition
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function post_status_failed_labels() {
|
||||
$labels = array(
|
||||
'label' => _x( 'Failed', 'post', 'action-scheduler' ),
|
||||
/* translators: %s: count */
|
||||
'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'action-scheduler' ),
|
||||
);
|
||||
|
||||
return apply_filters( 'action_scheduler_post_status_failed_labels', $labels );
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the args array for the post type definition
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function post_status_running_labels() {
|
||||
$labels = array(
|
||||
'label' => _x( 'In-Progress', 'post', 'action-scheduler' ),
|
||||
/* translators: %s: count */
|
||||
'label_count' => _n_noop( 'In-Progress <span class="count">(%s)</span>', 'In-Progress <span class="count">(%s)</span>', 'action-scheduler' ),
|
||||
);
|
||||
|
||||
return apply_filters( 'action_scheduler_post_status_running_labels', $labels );
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_wpPostStore_PostTypeRegistrar
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
class ActionScheduler_wpPostStore_PostTypeRegistrar {
|
||||
public function register() {
|
||||
register_post_type( ActionScheduler_wpPostStore::POST_TYPE, $this->post_type_args() );
|
||||
}
|
||||
|
||||
/**
|
||||
* Build the args array for the post type definition
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function post_type_args() {
|
||||
$args = array(
|
||||
'label' => __( 'Scheduled Actions', 'action-scheduler' ),
|
||||
'description' => __( 'Scheduled actions are hooks triggered on a cetain date and time.', 'action-scheduler' ),
|
||||
'public' => false,
|
||||
'map_meta_cap' => true,
|
||||
'hierarchical' => false,
|
||||
'supports' => array('title', 'editor','comments'),
|
||||
'rewrite' => false,
|
||||
'query_var' => false,
|
||||
'can_export' => true,
|
||||
'ep_mask' => EP_NONE,
|
||||
'labels' => array(
|
||||
'name' => __( 'Scheduled Actions', 'action-scheduler' ),
|
||||
'singular_name' => __( 'Scheduled Action', 'action-scheduler' ),
|
||||
'menu_name' => _x( 'Scheduled Actions', 'Admin menu name', 'action-scheduler' ),
|
||||
'add_new' => __( 'Add', 'action-scheduler' ),
|
||||
'add_new_item' => __( 'Add New Scheduled Action', 'action-scheduler' ),
|
||||
'edit' => __( 'Edit', 'action-scheduler' ),
|
||||
'edit_item' => __( 'Edit Scheduled Action', 'action-scheduler' ),
|
||||
'new_item' => __( 'New Scheduled Action', 'action-scheduler' ),
|
||||
'view' => __( 'View Action', 'action-scheduler' ),
|
||||
'view_item' => __( 'View Action', 'action-scheduler' ),
|
||||
'search_items' => __( 'Search Scheduled Actions', 'action-scheduler' ),
|
||||
'not_found' => __( 'No actions found', 'action-scheduler' ),
|
||||
'not_found_in_trash' => __( 'No actions found in trash', 'action-scheduler' ),
|
||||
),
|
||||
);
|
||||
|
||||
$args = apply_filters('action_scheduler_post_type_args', $args);
|
||||
return $args;
|
||||
}
|
||||
}
|
||||
|
||||
@ -0,0 +1,26 @@
|
||||
<?php
|
||||
|
||||
/**
|
||||
* Class ActionScheduler_wpPostStore_TaxonomyRegistrar
|
||||
* @codeCoverageIgnore
|
||||
*/
|
||||
class ActionScheduler_wpPostStore_TaxonomyRegistrar {
|
||||
public function register() {
|
||||
register_taxonomy( ActionScheduler_wpPostStore::GROUP_TAXONOMY, ActionScheduler_wpPostStore::POST_TYPE, $this->taxonomy_args() );
|
||||
}
|
||||
|
||||
protected function taxonomy_args() {
|
||||
$args = array(
|
||||
'label' => __( 'Action Group', 'action-scheduler' ),
|
||||
'public' => false,
|
||||
'hierarchical' => false,
|
||||
'show_admin_column' => true,
|
||||
'query_var' => false,
|
||||
'rewrite' => false,
|
||||
);
|
||||
|
||||
$args = apply_filters( 'action_scheduler_taxonomy_args', $args );
|
||||
return $args;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user