177 lines
6.1 KiB
PHP
177 lines
6.1 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Class ActionScheduler_Logger
|
||
|
|
* @codeCoverageIgnore
|
||
|
|
*/
|
||
|
|
abstract class ActionScheduler_Logger {
|
||
|
|
private static $logger = NULL;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @return ActionScheduler_Logger
|
||
|
|
*/
|
||
|
|
public static function instance() {
|
||
|
|
if ( empty(self::$logger) ) {
|
||
|
|
$class = apply_filters('action_scheduler_logger_class', 'ActionScheduler_wpCommentLogger');
|
||
|
|
self::$logger = new $class();
|
||
|
|
}
|
||
|
|
return self::$logger;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $action_id
|
||
|
|
* @param string $message
|
||
|
|
* @param DateTime $date
|
||
|
|
*
|
||
|
|
* @return string The log entry ID
|
||
|
|
*/
|
||
|
|
abstract public function log( $action_id, $message, DateTime $date = NULL );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $entry_id
|
||
|
|
*
|
||
|
|
* @return ActionScheduler_LogEntry
|
||
|
|
*/
|
||
|
|
abstract public function get_entry( $entry_id );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $action_id
|
||
|
|
*
|
||
|
|
* @return ActionScheduler_LogEntry[]
|
||
|
|
*/
|
||
|
|
abstract public function get_logs( $action_id );
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @codeCoverageIgnore
|
||
|
|
*/
|
||
|
|
public function init() {
|
||
|
|
$this->hook_stored_action();
|
||
|
|
add_action( 'action_scheduler_canceled_action', array( $this, 'log_canceled_action' ), 10, 1 );
|
||
|
|
add_action( 'action_scheduler_begin_execute', array( $this, 'log_started_action' ), 10, 2 );
|
||
|
|
add_action( 'action_scheduler_after_execute', array( $this, 'log_completed_action' ), 10, 3 );
|
||
|
|
add_action( 'action_scheduler_failed_execution', array( $this, 'log_failed_action' ), 10, 3 );
|
||
|
|
add_action( 'action_scheduler_failed_action', array( $this, 'log_timed_out_action' ), 10, 2 );
|
||
|
|
add_action( 'action_scheduler_unexpected_shutdown', array( $this, 'log_unexpected_shutdown' ), 10, 2 );
|
||
|
|
add_action( 'action_scheduler_reset_action', array( $this, 'log_reset_action' ), 10, 1 );
|
||
|
|
add_action( 'action_scheduler_execution_ignored', array( $this, 'log_ignored_action' ), 10, 2 );
|
||
|
|
add_action( 'action_scheduler_failed_fetch_action', array( $this, 'log_failed_fetch_action' ), 10, 2 );
|
||
|
|
add_action( 'action_scheduler_failed_to_schedule_next_instance', array( $this, 'log_failed_schedule_next_instance' ), 10, 2 );
|
||
|
|
add_action( 'action_scheduler_bulk_cancel_actions', array( $this, 'bulk_log_cancel_actions' ), 10, 1 );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function hook_stored_action() {
|
||
|
|
add_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function unhook_stored_action() {
|
||
|
|
remove_action( 'action_scheduler_stored_action', array( $this, 'log_stored_action' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_stored_action( $action_id ) {
|
||
|
|
$this->log( $action_id, __( 'action created', 'action-scheduler' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_canceled_action( $action_id ) {
|
||
|
|
$this->log( $action_id, __( 'action canceled', 'action-scheduler' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_started_action( $action_id, $context = '' ) {
|
||
|
|
if ( ! empty( $context ) ) {
|
||
|
|
/* translators: %s: context */
|
||
|
|
$message = sprintf( __( 'action started via %s', 'action-scheduler' ), $context );
|
||
|
|
} else {
|
||
|
|
$message = __( 'action started', 'action-scheduler' );
|
||
|
|
}
|
||
|
|
$this->log( $action_id, $message );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_completed_action( $action_id, $action = NULL, $context = '' ) {
|
||
|
|
if ( ! empty( $context ) ) {
|
||
|
|
/* translators: %s: context */
|
||
|
|
$message = sprintf( __( 'action complete via %s', 'action-scheduler' ), $context );
|
||
|
|
} else {
|
||
|
|
$message = __( 'action complete', 'action-scheduler' );
|
||
|
|
}
|
||
|
|
$this->log( $action_id, $message );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_failed_action( $action_id, Exception $exception, $context = '' ) {
|
||
|
|
if ( ! empty( $context ) ) {
|
||
|
|
/* translators: 1: context 2: exception message */
|
||
|
|
$message = sprintf( __( 'action failed via %1$s: %2$s', 'action-scheduler' ), $context, $exception->getMessage() );
|
||
|
|
} else {
|
||
|
|
/* translators: %s: exception message */
|
||
|
|
$message = sprintf( __( 'action failed: %s', 'action-scheduler' ), $exception->getMessage() );
|
||
|
|
}
|
||
|
|
$this->log( $action_id, $message );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_timed_out_action( $action_id, $timeout ) {
|
||
|
|
/* translators: %s: amount of time */
|
||
|
|
$this->log( $action_id, sprintf( __( 'action timed out after %s seconds', 'action-scheduler' ), $timeout ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_unexpected_shutdown( $action_id, $error ) {
|
||
|
|
if ( ! empty( $error ) ) {
|
||
|
|
/* translators: 1: error message 2: filename 3: line */
|
||
|
|
$this->log( $action_id, sprintf( __( 'unexpected shutdown: PHP Fatal error %1$s in %2$s on line %3$s', 'action-scheduler' ), $error['message'], $error['file'], $error['line'] ) );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_reset_action( $action_id ) {
|
||
|
|
$this->log( $action_id, __( 'action reset', 'action-scheduler' ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_ignored_action( $action_id, $context = '' ) {
|
||
|
|
if ( ! empty( $context ) ) {
|
||
|
|
/* translators: %s: context */
|
||
|
|
$message = sprintf( __( 'action ignored via %s', 'action-scheduler' ), $context );
|
||
|
|
} else {
|
||
|
|
$message = __( 'action ignored', 'action-scheduler' );
|
||
|
|
}
|
||
|
|
$this->log( $action_id, $message );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @param string $action_id
|
||
|
|
* @param Exception|NULL $exception The exception which occured when fetching the action. NULL by default for backward compatibility.
|
||
|
|
*
|
||
|
|
* @return ActionScheduler_LogEntry[]
|
||
|
|
*/
|
||
|
|
public function log_failed_fetch_action( $action_id, Exception $exception = NULL ) {
|
||
|
|
|
||
|
|
if ( ! is_null( $exception ) ) {
|
||
|
|
/* translators: %s: exception message */
|
||
|
|
$log_message = sprintf( __( 'There was a failure fetching this action: %s', 'action-scheduler' ), $exception->getMessage() );
|
||
|
|
} else {
|
||
|
|
$log_message = __( 'There was a failure fetching this action', 'action-scheduler' );
|
||
|
|
}
|
||
|
|
|
||
|
|
$this->log( $action_id, $log_message );
|
||
|
|
}
|
||
|
|
|
||
|
|
public function log_failed_schedule_next_instance( $action_id, Exception $exception ) {
|
||
|
|
/* translators: %s: exception message */
|
||
|
|
$this->log( $action_id, sprintf( __( 'There was a failure scheduling the next instance of this action: %s', 'action-scheduler' ), $exception->getMessage() ) );
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Bulk add cancel action log entries.
|
||
|
|
*
|
||
|
|
* Implemented here for backward compatibility. Should be implemented in parent loggers
|
||
|
|
* for more performant bulk logging.
|
||
|
|
*
|
||
|
|
* @param array $action_ids List of action ID.
|
||
|
|
*/
|
||
|
|
public function bulk_log_cancel_actions( $action_ids ) {
|
||
|
|
if ( empty( $action_ids ) ) {
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
foreach ( $action_ids as $action_id ) {
|
||
|
|
$this->log_canceled_action( $action_id );
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|