& Edward Dale * @copyright Copyright 2008 Edward Dale, 2012-2021 John Blackbourn * @license http://www.gnu.org/licenses/gpl.txt GPL 2.0 * @link https://wordpress.org/plugins/wp-crontrol/ * @since 0.2 */ namespace Crontrol; use WP_Error; defined( 'ABSPATH' ) || die(); require_once __DIR__ . '/src/event.php'; require_once __DIR__ . '/src/schedule.php'; const TRANSIENT = 'crontrol-message-%d'; /** * Hook onto all of the actions and filters needed by the plugin. */ function init_hooks() { $plugin_file = plugin_basename( __FILE__ ); add_action( 'init', __NAMESPACE__ . '\action_init' ); add_action( 'init', __NAMESPACE__ . '\action_handle_posts' ); add_action( 'admin_menu', __NAMESPACE__ . '\action_admin_menu' ); add_action( 'wp_ajax_crontrol_checkhash', __NAMESPACE__ . '\ajax_check_events_hash' ); add_filter( "plugin_action_links_{$plugin_file}", __NAMESPACE__ . '\plugin_action_links', 10, 4 ); add_filter( 'removable_query_args', __NAMESPACE__ . '\filter_removable_query_args' ); add_filter( 'pre_unschedule_event', __NAMESPACE__ . '\maybe_clear_doing_cron' ); add_filter( 'plugin_row_meta', __NAMESPACE__ . '\filter_plugin_row_meta', 10, 4 ); add_action( 'load-tools_page_crontrol_admin_manage_page', __NAMESPACE__ . '\setup_manage_page' ); add_filter( 'cron_schedules', __NAMESPACE__ . '\filter_cron_schedules' ); add_action( 'crontrol_cron_job', __NAMESPACE__ . '\action_php_cron_event' ); add_action( 'admin_enqueue_scripts', __NAMESPACE__ . '\enqueue_assets' ); add_action( 'crontrol/tab-header', __NAMESPACE__ . '\show_cron_status', 20 ); } /** * Sets an error message to show to the current user after a redirect. * * @param string $message The error message text. * @return bool Whether the message was saved. */ function set_message( $message ) { $key = sprintf( TRANSIENT, get_current_user_id() ); return set_transient( $key, $message, 60 ); } /** * Gets the error message to show to the current user after a redirect. * * @return string The error message text. */ function get_message() { $key = sprintf( TRANSIENT, get_current_user_id() ); return get_transient( $key ); } /** * Filters the array of row meta for each plugin in the Plugins list table. * * @param string[] $plugin_meta An array of the plugin's metadata. * @param string $plugin_file Path to the plugin file relative to the plugins directory. * @return string[] An array of the plugin's metadata. */ function filter_plugin_row_meta( array $plugin_meta, $plugin_file ) { if ( 'wp-crontrol/wp-crontrol.php' !== $plugin_file ) { return $plugin_meta; } $plugin_meta[] = sprintf( '%2$s', 'https://github.com/sponsors/johnbillion', esc_html_x( 'Sponsor', 'verb', 'wp-crontrol' ) ); return $plugin_meta; } /** * Run using the 'init' action. */ function action_init() { load_plugin_textdomain( 'wp-crontrol', false, dirname( plugin_basename( __FILE__ ) ) . '/languages' ); } /** * Handles any POSTs made by the plugin. Run using the 'init' action. */ function action_handle_posts() { if ( isset( $_POST['action'] ) && ( 'new_cron' === $_POST['action'] ) ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to add new cron events.', 'wp-crontrol' ), 401 ); } check_admin_referer( 'new-cron' ); extract( wp_unslash( $_POST ), EXTR_PREFIX_ALL, 'in' ); if ( 'crontrol_cron_job' === $in_hookname && ! current_user_can( 'edit_files' ) ) { wp_die( esc_html__( 'You are not allowed to add new PHP cron events.', 'wp-crontrol' ), 401 ); } $in_args = json_decode( $in_args, true ); if ( empty( $in_args ) ) { $in_args = array(); } $next_run_local = ( 'custom' === $in_next_run_date_local ) ? $in_next_run_date_local_custom_date . ' ' . $in_next_run_date_local_custom_time : $in_next_run_date_local; add_filter( 'schedule_event', function( $event ) { if ( ! $event ) { return $event; } /** * Fires after a new cron event is added. * * @param object $event { * An object containing the event's data. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. * @type string|false $schedule How often the event should subsequently recur. * @type array $args Array containing each separate argument to pass to the hook's callback function. * @type int $interval The interval time in seconds for the schedule. Only present for recurring events. * } */ do_action( 'crontrol/added_new_event', $event ); return $event; }, 99 ); $added = Event\add( $next_run_local, $in_schedule, $in_hookname, $in_args ); $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '5', 'crontrol_name' => rawurlencode( $in_hookname ), ); if ( is_wp_error( $added ) ) { set_message( $added->get_error_message() ); $redirect['crontrol_message'] = 'error'; } wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } elseif ( isset( $_POST['action'] ) && ( 'new_php_cron' === $_POST['action'] ) ) { if ( ! current_user_can( 'edit_files' ) ) { wp_die( esc_html__( 'You are not allowed to add new PHP cron events.', 'wp-crontrol' ), 401 ); } check_admin_referer( 'new-cron' ); extract( wp_unslash( $_POST ), EXTR_PREFIX_ALL, 'in' ); $next_run_local = ( 'custom' === $in_next_run_date_local ) ? $in_next_run_date_local_custom_date . ' ' . $in_next_run_date_local_custom_time : $in_next_run_date_local; $args = array( 'code' => $in_hookcode, 'name' => $in_eventname, ); add_filter( 'schedule_event', function( $event ) { if ( ! $event ) { return $event; } /** * Fires after a new PHP cron event is added. * * @param object $event { * An object containing the event's data. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. * @type string|false $schedule How often the event should subsequently recur. * @type array $args Array containing each separate argument to pass to the hook's callback function. * @type int $interval The interval time in seconds for the schedule. Only present for recurring events. * } */ do_action( 'crontrol/added_new_php_event', $event ); return $event; }, 99 ); $added = Event\add( $next_run_local, $in_schedule, 'crontrol_cron_job', $args ); $hookname = ( ! empty( $in_eventname ) ) ? $in_eventname : __( 'PHP Cron', 'wp-crontrol' ); $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '5', 'crontrol_name' => rawurlencode( $hookname ), ); if ( is_wp_error( $added ) ) { set_message( $added->get_error_message() ); $redirect['crontrol_message'] = 'error'; } wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } elseif ( isset( $_POST['action'] ) && ( 'edit_cron' === $_POST['action'] ) ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to edit cron events.', 'wp-crontrol' ), 401 ); } extract( wp_unslash( $_POST ), EXTR_PREFIX_ALL, 'in' ); check_admin_referer( "edit-cron_{$in_original_hookname}_{$in_original_sig}_{$in_original_next_run_utc}" ); if ( 'crontrol_cron_job' === $in_hookname && ! current_user_can( 'edit_files' ) ) { wp_die( esc_html__( 'You are not allowed to edit PHP cron events.', 'wp-crontrol' ), 401 ); } $in_args = json_decode( $in_args, true ); if ( empty( $in_args ) ) { $in_args = array(); } $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '4', 'crontrol_name' => rawurlencode( $in_hookname ), ); $original = Event\get_single( $in_original_hookname, $in_original_sig, $in_original_next_run_utc ); if ( is_wp_error( $original ) ) { set_message( $original->get_error_message() ); $redirect['crontrol_message'] = 'error'; wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } $deleted = Event\delete( $in_original_hookname, $in_original_sig, $in_original_next_run_utc ); if ( is_wp_error( $deleted ) ) { set_message( $deleted->get_error_message() ); $redirect['crontrol_message'] = 'error'; wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } $next_run_local = ( 'custom' === $in_next_run_date_local ) ? $in_next_run_date_local_custom_date . ' ' . $in_next_run_date_local_custom_time : $in_next_run_date_local; add_filter( 'schedule_event', function( $event ) use ( $original ) { if ( ! $event || ! $original ) { return $event; } /** * Fires after a cron event is edited. * * @param object $event { * An object containing the new event's data. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. * @type string|false $schedule How often the event should subsequently recur. * @type array $args Array containing each separate argument to pass to the hook's callback function. * @type int $interval The interval time in seconds for the schedule. Only present for recurring events. * } * @param object $original { * An object containing the original event's data. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. * @type string|false $schedule How often the event should subsequently recur. * @type array $args Array containing each separate argument to pass to the hook's callback function. * @type int $interval The interval time in seconds for the schedule. Only present for recurring events. * } */ do_action( 'crontrol/edited_event', $event, $original ); return $event; }, 99 ); $added = Event\add( $next_run_local, $in_schedule, $in_hookname, $in_args ); if ( is_wp_error( $added ) ) { set_message( $added->get_error_message() ); $redirect['crontrol_message'] = 'error'; } wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } elseif ( isset( $_POST['action'] ) && ( 'edit_php_cron' === $_POST['action'] ) ) { if ( ! current_user_can( 'edit_files' ) ) { wp_die( esc_html__( 'You are not allowed to edit PHP cron events.', 'wp-crontrol' ), 401 ); } extract( wp_unslash( $_POST ), EXTR_PREFIX_ALL, 'in' ); check_admin_referer( "edit-cron_{$in_original_hookname}_{$in_original_sig}_{$in_original_next_run_utc}" ); $args = array( 'code' => $in_hookcode, 'name' => $in_eventname, ); $hookname = ( ! empty( $in_eventname ) ) ? $in_eventname : __( 'PHP Cron', 'wp-crontrol' ); $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '4', 'crontrol_name' => rawurlencode( $hookname ), ); $original = Event\get_single( $in_original_hookname, $in_original_sig, $in_original_next_run_utc ); if ( is_wp_error( $original ) ) { set_message( $original->get_error_message() ); $redirect['crontrol_message'] = 'error'; wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } $deleted = Event\delete( $in_original_hookname, $in_original_sig, $in_original_next_run_utc ); if ( is_wp_error( $deleted ) ) { set_message( $deleted->get_error_message() ); $redirect['crontrol_message'] = 'error'; wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } $next_run_local = ( 'custom' === $in_next_run_date_local ) ? $in_next_run_date_local_custom_date . ' ' . $in_next_run_date_local_custom_time : $in_next_run_date_local; add_filter( 'schedule_event', function( $event ) use ( $original ) { if ( ! $event || ! $original ) { return $event; } /** * Fires after a PHP cron event is edited. * * @param object $event { * An object containing the new event's data. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. * @type string|false $schedule How often the event should subsequently recur. * @type array $args Array containing each separate argument to pass to the hook's callback function. * @type int $interval The interval time in seconds for the schedule. Only present for recurring events. * } * @param object $original { * An object containing the original event's data. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. * @type string|false $schedule How often the event should subsequently recur. * @type array $args Array containing each separate argument to pass to the hook's callback function. * @type int $interval The interval time in seconds for the schedule. Only present for recurring events. * } */ do_action( 'crontrol/edited_php_event', $event, $original ); return $event; }, 99 ); $added = Event\add( $next_run_local, $in_schedule, 'crontrol_cron_job', $args ); if ( is_wp_error( $added ) ) { set_message( $added->get_error_message() ); $redirect['crontrol_message'] = 'error'; } wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } elseif ( isset( $_POST['new_schedule'] ) ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to add new cron schedules.', 'wp-crontrol' ), 401 ); } check_admin_referer( 'new-sched' ); $name = wp_unslash( $_POST['internal_name'] ); $interval = absint( $_POST['interval'] ); $display = wp_unslash( $_POST['display_name'] ); Schedule\add( $name, $interval, $display ); $redirect = array( 'page' => 'crontrol_admin_options_page', 'crontrol_message' => '3', 'crontrol_name' => rawurlencode( $name ), ); wp_safe_redirect( add_query_arg( $redirect, admin_url( 'options-general.php' ) ) ); exit; } elseif ( isset( $_GET['action'] ) && 'delete-sched' === $_GET['action'] ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to delete cron schedules.', 'wp-crontrol' ), 401 ); } $schedule = wp_unslash( $_GET['id'] ); check_admin_referer( "delete-sched_{$schedule}" ); Schedule\delete( $schedule ); $redirect = array( 'page' => 'crontrol_admin_options_page', 'crontrol_message' => '2', 'crontrol_name' => rawurlencode( $schedule ), ); wp_safe_redirect( add_query_arg( $redirect, admin_url( 'options-general.php' ) ) ); exit; } elseif ( ( isset( $_POST['action'] ) && 'delete_crons' === $_POST['action'] ) || ( isset( $_POST['action2'] ) && 'delete_crons' === $_POST['action2'] ) ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to delete cron events.', 'wp-crontrol' ), 401 ); } check_admin_referer( 'bulk-crontrol-events' ); if ( empty( $_POST['delete'] ) ) { return; } $delete = wp_unslash( $_POST['delete'] ); $deleted = 0; foreach ( $delete as $next_run_utc => $events ) { foreach ( $events as $hook => $sig ) { if ( 'crontrol_cron_job' === $hook && ! current_user_can( 'edit_files' ) ) { continue; } $event = Event\get_single( urldecode( $hook ), $sig, $next_run_utc ); $deleted = Event\delete( urldecode( $hook ), $sig, $next_run_utc ); if ( ! is_wp_error( $deleted ) ) { $deleted++; /** This action is documented in wp-crontrol.php */ do_action( 'crontrol/deleted_event', $event ); } } } $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_name' => $deleted, 'crontrol_message' => '9', ); wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } elseif ( isset( $_GET['action'] ) && 'delete-cron' === $_GET['action'] ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to delete cron events.', 'wp-crontrol' ), 401 ); } $hook = wp_unslash( $_GET['id'] ); $sig = wp_unslash( $_GET['sig'] ); $next_run_utc = intval( $_GET['next_run_utc'] ); check_admin_referer( "delete-cron_{$hook}_{$sig}_{$next_run_utc}" ); if ( 'crontrol_cron_job' === $hook && ! current_user_can( 'edit_files' ) ) { wp_die( esc_html__( 'You are not allowed to delete PHP cron events.', 'wp-crontrol' ), 401 ); } $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '6', 'crontrol_name' => rawurlencode( $hook ), ); $event = Event\get_single( $hook, $sig, $next_run_utc ); if ( is_wp_error( $event ) ) { set_message( $event->get_error_message() ); $redirect['crontrol_message'] = 'error'; wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } $deleted = Event\delete( $hook, $sig, $next_run_utc ); if ( is_wp_error( $deleted ) ) { set_message( $deleted->get_error_message() ); $redirect['crontrol_message'] = 'error'; } else { /** * Fires after a cron event is deleted. * * @param object $event { * An object containing the event's data. * * @type string $hook Action hook to execute when the event is run. * @type int $timestamp Unix timestamp (UTC) for when to next run the event. * @type string|false $schedule How often the event should subsequently recur. * @type array $args Array containing each separate argument to pass to the hook's callback function. * @type int $interval The interval time in seconds for the schedule. Only present for recurring events. * } */ do_action( 'crontrol/deleted_event', $event ); } wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } elseif ( isset( $_GET['action'] ) && 'delete-hook' === $_GET['action'] ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to delete cron events.', 'wp-crontrol' ), 401 ); } $hook = wp_unslash( $_GET['id'] ); $deleted = false; check_admin_referer( "delete-hook_{$hook}" ); if ( 'crontrol_cron_job' === $hook ) { wp_die( esc_html__( 'You are not allowed to delete PHP cron events.', 'wp-crontrol' ), 401 ); } if ( function_exists( 'wp_unschedule_hook' ) ) { $deleted = wp_unschedule_hook( $hook ); } if ( 0 === $deleted ) { $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '3', 'crontrol_name' => rawurlencode( $hook ), ); wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } elseif ( $deleted ) { /** * Fires after all cron events with the given hook are deleted. * * @param string $hook The hook name. * @param int $deleted The number of events that were deleted. */ do_action( 'crontrol/deleted_all_with_hook', $hook, $deleted ); $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '2', 'crontrol_name' => rawurlencode( $hook ), ); wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } else { $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '7', 'crontrol_name' => rawurlencode( $hook ), ); wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } } elseif ( isset( $_GET['action'] ) && 'run-cron' === $_GET['action'] ) { if ( ! current_user_can( 'manage_options' ) ) { wp_die( esc_html__( 'You are not allowed to run cron events.', 'wp-crontrol' ), 401 ); } $hook = wp_unslash( $_GET['id'] ); $sig = wp_unslash( $_GET['sig'] ); check_admin_referer( "run-cron_{$hook}_{$sig}" ); $ran = Event\run( $hook, $sig ); $redirect = array( 'page' => 'crontrol_admin_manage_page', 'crontrol_message' => '1', 'crontrol_name' => rawurlencode( $hook ), ); if ( is_wp_error( $ran ) ) { set_message( $ran->get_error_message() ); $redirect['crontrol_message'] = 'error'; } wp_safe_redirect( add_query_arg( $redirect, admin_url( 'tools.php' ) ) ); exit; } } /** * Adds options & management pages to the admin menu. * * Run using the 'admin_menu' action. */ function action_admin_menu() { $schedules = add_options_page( esc_html__( 'Cron Schedules', 'wp-crontrol' ), esc_html__( 'Cron Schedules', 'wp-crontrol' ), 'manage_options', 'crontrol_admin_options_page', __NAMESPACE__ . '\admin_options_page' ); $events = add_management_page( esc_html__( 'Cron Events', 'wp-crontrol' ), esc_html__( 'Cron Events', 'wp-crontrol' ), 'manage_options', 'crontrol_admin_manage_page', __NAMESPACE__ . '\admin_manage_page' ); add_action( "load-{$schedules}", __NAMESPACE__ . '\admin_help_tab' ); add_action( "load-{$events}", __NAMESPACE__ . '\admin_help_tab' ); } /** * Adds a Help tab with links to help resources; */ function admin_help_tab() { $screen = get_current_screen(); $content = '

' . __( 'There are several places to get help with issues relating to WP-Cron:', 'wp-crontrol' ) . '

'; $content .= ''; $screen->add_help_tab( array( 'id' => 'crontrol-help', 'title' => __( 'Help', 'wp-crontrol' ), 'content' => $content, ) ); } /** * Adds items to the plugin's action links on the Plugins listing screen. * * @param string[] $actions Array of action links. * @param string $plugin_file Path to the plugin file relative to the plugins directory. * @param array $plugin_data An array of plugin data. * @param string $context The plugin context. * @return string[] Array of action links. */ function plugin_action_links( $actions, $plugin_file, $plugin_data, $context ) { $new = array( 'crontrol-events' => sprintf( '%s', esc_url( admin_url( 'tools.php?page=crontrol_admin_manage_page' ) ), esc_html__( 'Events', 'wp-crontrol' ) ), 'crontrol-schedules' => sprintf( '%s', esc_url( admin_url( 'options-general.php?page=crontrol_admin_options_page' ) ), esc_html__( 'Schedules', 'wp-crontrol' ) ), 'crontrol-help' => sprintf( '%s', 'https://github.com/johnbillion/wp-crontrol/wiki', esc_html__( 'Help', 'wp-crontrol' ) ), ); return array_merge( $new, $actions ); } /** * Gives WordPress the plugin's set of cron schedules. * * Called by the `cron_schedules` filter. * * @param array[] $scheds Array of cron schedule arrays. Usually empty. * @return array[] Array of modified cron schedule arrays. */ function filter_cron_schedules( array $scheds ) { $new_scheds = get_option( 'crontrol_schedules', array() ); if ( ! is_array( $new_scheds ) ) { return $scheds; } return array_merge( $new_scheds, $scheds ); } /** * Displays the options page for the plugin. */ function admin_options_page() { $messages = array( '2' => array( /* translators: 1: The name of the cron schedule. */ __( 'Deleted the cron schedule %s.', 'wp-crontrol' ), 'success', ), '3' => array( /* translators: 1: The name of the cron schedule. */ __( 'Added the cron schedule %s.', 'wp-crontrol' ), 'success', ), ); if ( isset( $_GET['crontrol_message'] ) && isset( $_GET['crontrol_name'] ) && isset( $messages[ $_GET['crontrol_message'] ] ) ) { $hook = wp_unslash( $_GET['crontrol_name'] ); $message = wp_unslash( $_GET['crontrol_message'] ); printf( '

%2$s

', esc_attr( $messages[ $message ][1] ), sprintf( esc_html( $messages[ $message ][0] ), '' . esc_html( $hook ) . '' ) ); } require_once __DIR__ . '/src/schedule-list-table.php'; $table = new Schedule_List_Table(); $table->prepare_items(); ?>

views(); ?>

display(); ?>
items ) ) ); } /** * Gets the status of WP-Cron functionality on the site by performing a test spawn if necessary. Cached for one hour when all is well. * * @param bool $cache Whether to use the cached result from previous calls. * @return true|WP_Error Boolean true if the cron spawner is working as expected, or a `WP_Error` object if not. */ function test_cron_spawn( $cache = true ) { global $wp_version; $cron_runner_plugins = array( '\HM\Cavalcade\Plugin\Job' => 'Cavalcade', '\Automattic\WP\Cron_Control' => 'Cron Control', ); foreach ( $cron_runner_plugins as $class => $plugin ) { if ( class_exists( $class ) ) { return new WP_Error( 'crontrol_info', sprintf( /* translators: 1: The name of the plugin that controls the running of cron events. */ __( 'WP-Cron spawning is being managed by the %s plugin.', 'wp-crontrol' ), $plugin ) ); } } if ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ) { return new WP_Error( 'crontrol_info', sprintf( /* translators: 1: The name of the PHP constant that is set. */ __( 'The %s constant is set to true. WP-Cron spawning is disabled.', 'wp-crontrol' ), 'DISABLE_WP_CRON' ) ); } if ( defined( 'ALTERNATE_WP_CRON' ) && ALTERNATE_WP_CRON ) { return new WP_Error( 'crontrol_info', sprintf( /* translators: 1: The name of the PHP constant that is set. */ __( 'The %s constant is set to true.', 'wp-crontrol' ), 'ALTERNATE_WP_CRON' ) ); } $cached_status = get_transient( 'crontrol-cron-test-ok' ); if ( $cache && $cached_status ) { return true; } $sslverify = version_compare( $wp_version, 4.0, '<' ); $doing_wp_cron = sprintf( '%.22F', microtime( true ) ); $cron_request = apply_filters( 'cron_request', array( 'url' => add_query_arg( 'doing_wp_cron', $doing_wp_cron, site_url( 'wp-cron.php' ) ), 'key' => $doing_wp_cron, 'args' => array( 'timeout' => 3, 'blocking' => true, 'sslverify' => apply_filters( 'https_local_ssl_verify', $sslverify ), ), ) ); $cron_request['args']['blocking'] = true; $result = wp_remote_post( $cron_request['url'], $cron_request['args'] ); if ( is_wp_error( $result ) ) { return $result; } elseif ( wp_remote_retrieve_response_code( $result ) >= 300 ) { return new WP_Error( 'unexpected_http_response_code', sprintf( /* translators: 1: The HTTP response code. */ __( 'Unexpected HTTP response code: %s', 'wp-crontrol' ), intval( wp_remote_retrieve_response_code( $result ) ) ) ); } else { set_transient( 'crontrol-cron-test-ok', 1, 3600 ); return true; } } /** * Determines whether the given feature is enabled. * * The feature directly corresponds to one of WP Crontrol's tabs. Currently the only feature * that's not enabled by default is "logs" which are provided by WP Crontrol Pro. * * @param string $feature The feature name. * @return bool Whether the specified tab is active. */ function is_feature_enabled( $feature ) { $enabled = ( 'logs' !== $feature ); return apply_filters( "crontrol/enabled/{$feature}", $enabled ); } /** * Shows the status of WP-Cron functionality on the site. Only displays a message when there's a problem. * * @param string $tab The tab name. */ function show_cron_status( $tab ) { if ( ! is_feature_enabled( $tab ) ) { return; } if ( 'UTC' !== date_default_timezone_get() ) { ?>
%1$s

%3$s

', /* translators: %s: Help page URL. */ esc_html__( 'PHP default timezone is not set to UTC. This may cause issues with cron event timings.', 'wp-crontrol' ), 'https://github.com/johnbillion/wp-crontrol/wiki/PHP-default-timezone-is-not-set-to-UTC', esc_html__( 'More information', 'wp-crontrol' ) ); ?>
get_error_code() ) { ?>

get_error_message() ); ?>

%1$s

%3$s

', sprintf( /* translators: 1: Error message text. */ esc_html__( 'There was a problem spawning a call to the WP-Cron system on your site. This means WP-Cron events on your site may not work. The problem was: %s', 'wp-crontrol' ), '

' . esc_html( $status->get_error_message() ) . '' ), 'https://github.com/johnbillion/wp-crontrol/wiki/Problems-with-spawning-a-call-to-the-WP-Cron-system', esc_html__( 'More information', 'wp-crontrol' ) ); ?>

hook && intval( $_GET['next_run_utc'] ) === $event->time && $event->sig === $_GET['sig'] ) { $existing = array( 'hookname' => $event->hook, 'next_run' => $event->time, // UTC 'schedule' => ( $event->schedule ? $event->schedule : '_oneoff' ), 'sig' => $event->sig, 'args' => $event->args, ); break; } } if ( empty( $existing ) ) { ?>
%1$s

', esc_html__( 'The event you are trying to edit does not exist.', 'wp-crontrol' ) ); ?>
functions.php' ); } if ( is_array( $existing ) ) { $other_fields = wp_nonce_field( "edit-cron_{$existing['hookname']}_{$existing['sig']}_{$existing['next_run']}", '_wpnonce', true, false ); $other_fields .= sprintf( '', esc_attr( $existing['hookname'] ) ); $other_fields .= sprintf( '', esc_attr( $existing['sig'] ) ); $other_fields .= sprintf( '', esc_attr( $existing['next_run'] ) ); if ( ! empty( $existing['args'] ) ) { $display_args = wp_json_encode( $existing['args'] ); } $action = $is_editing_php ? 'edit_php_cron' : 'edit_cron'; $button = __( 'Update Event', 'wp-crontrol' ); $next_run_gmt = gmdate( 'Y-m-d H:i:s', $existing['next_run'] ); $next_run_date_local = get_date_from_gmt( $next_run_gmt, 'Y-m-d' ); $next_run_time_local = get_date_from_gmt( $next_run_gmt, 'H:i:s' ); } else { $other_fields = wp_nonce_field( 'new-cron', '_wpnonce', true, false ); $existing = array( 'hookname' => '', 'args' => array(), 'next_run' => 'now', // UTC 'schedule' => false, ); $button = __( 'Add Event', 'wp-crontrol' ); $next_run_date_local = ''; $next_run_time_local = ''; } if ( $is_editing_php ) { if ( ! isset( $existing['args']['code'] ) ) { $existing['args']['code'] = ''; } if ( ! isset( $existing['args']['name'] ) ) { $existing['args']['name'] = ''; } } $can_add_php = current_user_can( 'edit_files' ) && ! $editing; $allowed = ( ! $is_editing_php || current_user_can( 'edit_files' ) ); ?>
%s', esc_html( $heading ) ); printf( '

%s

', // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped $helper_text ); ?>
', esc_attr( $action ) ); } elseif ( $can_add_php ) { ?>

<?php' ); ?>

[25]', '["asdf"]', '["i","want",25,"cakes"]' ); ?>

array( /* translators: 1: The name of the cron event. */ __( 'Scheduled the cron event %s to run now. The original event will not be affected.', 'wp-crontrol' ), 'success', ), '2' => array( /* translators: 1: The name of the cron event. */ __( 'Deleted all %s cron events.', 'wp-crontrol' ), 'success', ), '3' => array( /* translators: 1: The name of the cron event. */ __( 'There are no %s cron events to delete.', 'wp-crontrol' ), 'info', ), '4' => array( /* translators: 1: The name of the cron event. */ __( 'Saved the cron event %s.', 'wp-crontrol' ), 'success', ), '5' => array( /* translators: 1: The name of the cron event. */ __( 'Created the cron event %s.', 'wp-crontrol' ), 'success', ), '6' => array( /* translators: 1: The name of the cron event. */ __( 'Deleted the cron event %s.', 'wp-crontrol' ), 'success', ), '7' => array( /* translators: 1: The name of the cron event. */ __( 'Failed to the delete the cron event %s.', 'wp-crontrol' ), 'error', ), '8' => array( /* translators: 1: The name of the cron event. */ __( 'Failed to the execute the cron event %s.', 'wp-crontrol' ), 'error', ), '9' => array( __( 'Deleted the selected cron events.', 'wp-crontrol' ), 'success', ), '10' => array( /* translators: 1: The name of the cron event. */ __( 'Failed to save the cron event %s.', 'wp-crontrol' ), 'error', ), 'error' => array(), ); if ( isset( $_GET['crontrol_name'] ) && isset( $_GET['crontrol_message'] ) && isset( $messages[ $_GET['crontrol_message'] ] ) ) { $hook = wp_unslash( $_GET['crontrol_name'] ); $message = wp_unslash( $_GET['crontrol_message'] ); $link = ''; if ( 'error' === $message ) { $messages['error'] = array( get_message(), 'error', ); } printf( '

%2$s%3$s

', esc_attr( $messages[ $message ][1] ), sprintf( esc_html( $messages[ $message ][0] ), '' . esc_html( $hook ) . '' ), // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped $link ); } $tabs = get_tab_states(); $table = Event\get_list_table(); switch ( true ) { case $tabs['events']: ?>

' . esc_html__( 'Add New', 'wp-crontrol' ) . ''; ?>
views(); ?>
search_box( __( 'Search Hook Names', 'wp-crontrol' ), 'cron-event' ); ?>
display(); ?>

( ! empty( $_GET['page'] ) && 'crontrol_admin_manage_page' === $_GET['page'] && empty( $_GET['action'] ) ), 'schedules' => ( ! empty( $_GET['page'] ) && 'crontrol_admin_options_page' === $_GET['page'] ), 'add-event' => ( ! empty( $_GET['action'] ) && 'new-cron' === $_GET['action'] ), 'edit-event' => ( ! empty( $_GET['action'] ) && 'edit-cron' === $_GET['action'] ), ); } /** * Output the cron-related tabs if we're on a cron-related admin screen. */ function do_tabs() { $tabs = get_tab_states(); $tab = array_filter( $tabs ); if ( ! $tab ) { return; } $tab = array_keys( $tab ); $tab = reset( $tab ); $links = array( 'events' => array( 'tools.php?page=crontrol_admin_manage_page', __( 'Cron Events', 'wp-crontrol' ), ), 'schedules' => array( 'options-general.php?page=crontrol_admin_options_page', __( 'Cron Schedules', 'wp-crontrol' ), ), ); ?>
$callbacks ) { foreach ( $callbacks as $callback ) { $callback = populate_callback( $callback ); $actions[] = array( 'priority' => $priority, 'callback' => $callback, ); } } } return $actions; } /** * Populates the details of the given callback function. * * @param array $callback A callback entry. * @return array The updated callback entry. */ function populate_callback( array $callback ) { // If Query Monitor is installed, use its rich callback analysis. if ( method_exists( '\QM_Util', 'populate_callback' ) ) { return \QM_Util::populate_callback( $callback ); } if ( is_string( $callback['function'] ) && ( false !== strpos( $callback['function'], '::' ) ) ) { $callback['function'] = explode( '::', $callback['function'] ); } if ( is_array( $callback['function'] ) ) { if ( is_object( $callback['function'][0] ) ) { $class = get_class( $callback['function'][0] ); $access = '->'; } else { $class = $callback['function'][0]; $access = '::'; } $callback['name'] = $class . $access . $callback['function'][1] . '()'; } elseif ( is_object( $callback['function'] ) ) { if ( is_a( $callback['function'], 'Closure' ) ) { $callback['name'] = 'Closure'; } else { $class = get_class( $callback['function'] ); $callback['name'] = $class . '->__invoke()'; } } else { $callback['name'] = $callback['function'] . '()'; } return $callback; } /** * Returns a user-friendly representation of the callback function. * * @param array $callback The callback entry. * @return string The displayable version of the callback name. */ function output_callback( array $callback ) { $qm = WP_PLUGIN_DIR . '/query-monitor/query-monitor.php'; $html = plugin_dir_path( $qm ) . 'output/Html.php'; // If Query Monitor is installed, use its rich callback output. if ( class_exists( '\QueryMonitor' ) && file_exists( $html ) ) { require_once $html; if ( class_exists( '\QM_Output_Html' ) ) { if ( ! empty( $callback['callback']['error'] ) ) { $return = '' . $callback['callback']['name'] . ''; $return .= '
'; $return .= esc_html( $callback['callback']['error']->get_error_message() ); $return .= ''; return $return; } return \QM_Output_Html::output_filename( $callback['callback']['name'], $callback['callback']['file'], $callback['callback']['line'] ); } } return '' . $callback['callback']['name'] . ''; } /** * Pretty-prints the difference in two times. * * @param int $older_date Unix timestamp. * @param int $newer_date Unix timestamp. * @return string The pretty time_since value * @link http://binarybonsai.com/code/timesince.txt */ function time_since( $older_date, $newer_date ) { return interval( $newer_date - $older_date ); } /** * Converts a period of time in seconds into a human-readable format representing the interval. * * Example: * * echo \Crontrol\interval( 90 ); * // 1 minute 30 seconds * * @param int $since A period of time in seconds. * @return string An interval represented as a string. */ function interval( $since ) { // Array of time period chunks. $chunks = array( /* translators: 1: The number of years in an interval of time. */ array( 60 * 60 * 24 * 365, _n_noop( '%s year', '%s years', 'wp-crontrol' ) ), /* translators: 1: The number of months in an interval of time. */ array( 60 * 60 * 24 * 30, _n_noop( '%s month', '%s months', 'wp-crontrol' ) ), /* translators: 1: The number of weeks in an interval of time. */ array( 60 * 60 * 24 * 7, _n_noop( '%s week', '%s weeks', 'wp-crontrol' ) ), /* translators: 1: The number of days in an interval of time. */ array( 60 * 60 * 24, _n_noop( '%s day', '%s days', 'wp-crontrol' ) ), /* translators: 1: The number of hours in an interval of time. */ array( 60 * 60, _n_noop( '%s hour', '%s hours', 'wp-crontrol' ) ), /* translators: 1: The number of minutes in an interval of time. */ array( 60, _n_noop( '%s minute', '%s minutes', 'wp-crontrol' ) ), /* translators: 1: The number of seconds in an interval of time. */ array( 1, _n_noop( '%s second', '%s seconds', 'wp-crontrol' ) ), ); if ( $since <= 0 ) { return __( 'now', 'wp-crontrol' ); } /** * We only want to output two chunks of time here, eg: * x years, xx months * x days, xx hours * so there's only two bits of calculation below: */ $j = count( $chunks ); // Step one: the first chunk. for ( $i = 0; $i < $j; $i++ ) { $seconds = $chunks[ $i ][0]; $name = $chunks[ $i ][1]; // Finding the biggest chunk (if the chunk fits, break). $count = floor( $since / $seconds ); if ( $count ) { break; } } // Set output var. $output = sprintf( translate_nooped_plural( $name, $count, 'wp-crontrol' ), $count ); // Step two: the second chunk. if ( $i + 1 < $j ) { $seconds2 = $chunks[ $i + 1 ][0]; $name2 = $chunks[ $i + 1 ][1]; $count2 = floor( ( $since - ( $seconds * $count ) ) / $seconds2 ); if ( $count2 ) { // Add to output var. $output .= ' ' . sprintf( translate_nooped_plural( $name2, $count2, 'wp-crontrol' ), $count2 ); } } return $output; } /** * Sets up the Events listing screen. */ function setup_manage_page() { // Initialise the list table Event\get_list_table(); // Add the initially hidden admin notice about the out of date events list add_action( 'admin_notices', function() { printf( '

%s

', esc_html__( 'The scheduled cron events have changed since you first opened this page. Reload the page to see the up to date list.', 'wp-crontrol' ) ); } ); } /** * Registers the stylesheet and JavaScript for the admin areas. * * @param string $hook_suffix The admin screen ID. */ function enqueue_assets( $hook_suffix ) { $tab = get_tab_states(); if ( ! array_filter( $tab ) ) { return; } $ver = filemtime( plugin_dir_path( __FILE__ ) . 'css/wp-crontrol.css' ); wp_enqueue_style( 'wp-crontrol', plugin_dir_url( __FILE__ ) . 'css/wp-crontrol.css', array( 'dashicons' ), $ver ); $ver = filemtime( plugin_dir_path( __FILE__ ) . 'js/wp-crontrol.js' ); wp_enqueue_script( 'wp-crontrol', plugin_dir_url( __FILE__ ) . 'js/wp-crontrol.js', array( 'jquery', 'wp-a11y' ), $ver, true ); $vars = array(); if ( ! empty( $tab['events'] ) ) { $vars['eventsHash'] = md5( json_encode( Event\get_list_table()->items ) ); $vars['eventsHashInterval'] = 20; } if ( ! empty( $tab['add-event'] ) || ! empty( $tab['edit-event'] ) ) { if ( function_exists( 'wp_enqueue_code_editor' ) && current_user_can( 'edit_files' ) ) { $settings = wp_enqueue_code_editor( array( 'type' => 'text/x-php', ) ); if ( false !== $settings ) { $vars['codeEditor'] = $settings; } } } wp_localize_script( 'wp-crontrol', 'wpCrontrol', $vars ); } /** * Filters the list of query arguments which get removed from admin area URLs in WordPress. * * @param string[] $args List of removable query arguments. * @return string[] Updated list of removable query arguments. */ function filter_removable_query_args( array $args ) { return array_merge( $args, array( 'crontrol_message', 'crontrol_name', ) ); } /** * Returns an array of cron event hooks that are persistently added by WordPress core. * * @return string[] Array of hook names. */ function get_persistent_core_hooks() { return array( 'delete_expired_transients', 'recovery_mode_clean_expired_keys', 'update_network_counts', 'wp_https_detection', 'wp_privacy_delete_old_export_files', 'wp_scheduled_auto_draft_delete', 'wp_scheduled_delete', 'wp_site_health_scheduled_check', 'wp_update_plugins', 'wp_update_themes', 'wp_version_check', ); } /** * Returns an array of all cron event hooks that are added by WordPress core. * * @return string[] Array of hook names. */ function get_all_core_hooks() { return array_merge( get_persistent_core_hooks(), array( 'do_pings', 'importer_scheduled_cleanup', 'publish_future_post', 'upgrader_scheduled_cleanup', 'wp_maybe_auto_update', 'wp_split_shared_term_batch', 'wp_update_comment_type_batch', ) ); } /** * Returns an array of cron schedules that are added by WordPress core. * * @return string[] Array of schedule names. */ function get_core_schedules() { return array( 'hourly', 'twicedaily', 'daily', 'weekly', ); } /** * Encodes some input as JSON for output. * * @param mixed $input The input. * @return string The JSON-encoded output. */ function json_output( $input ) { $json_options = 0; if ( defined( 'JSON_UNESCAPED_SLASHES' ) ) { // phpcs:ignore PHPCompatibility.Constants.NewConstants.json_unescaped_slashesFound $json_options |= JSON_UNESCAPED_SLASHES; } if ( defined( 'JSON_PRETTY_PRINT' ) ) { $json_options |= JSON_PRETTY_PRINT; } return wp_json_encode( $input, $json_options ); } /** * Evaluates the code in a PHP cron event using eval. * * Security: Only users with the `edit_files` capability can manage PHP cron events. This means if a user cannot edit * files on the site (eg. through the Plugin Editor or Theme Editor) then they cannot edit or add a PHP cron event. By * default, only Administrators have this capability, and with Multisite enabled only Super Admins have this capability. * * If file editing has been disabled via the `DISALLOW_FILE_MODS` or `DISALLOW_FILE_EDIT` configuration constants then * no user will have the `edit_files` capability, which means editing or adding a PHP cron event will not be permitted. * * Therefore, the user access level required to execute arbitrary PHP code does not change with WP Crontrol activated. * * @param string $code The PHP code to evaluate. */ function action_php_cron_event( $code ) { // phpcs:ignore Squiz.PHP.Eval.Discouraged eval( $code ); } // Get this show on the road. init_hooks();