ldc-groupe/content/plugins/wp-crontrol/src/event.php

<?php
/**
 * Functions related to cron events.
 *
 * @package wp-crontrol
 */

namespace Crontrol\Event;

use stdClass;
use Crontrol\Schedule;
use WP_Error;

/**
 * Executes a cron event immediately.
 *
 * Executes an event by scheduling a new single event with the same arguments.
 *
 * @param string $hookname The hook name of the cron event to run.
 * @param string $sig      The cron event signature.
 * @return bool Whether the execution was successful.
 */
function run( $hookname, $sig ) {
	$crons = _get_cron_array();
	foreach ( $crons as $time => $cron ) {
		if ( isset( $cron[ $hookname ][ $sig ] ) ) {
			$args = $cron[ $hookname ][ $sig ]['args'];
			delete_transient( 'doing_cron' );
			$scheduled = force_schedule_single_event( $hookname, $args ); // UTC

			if ( false === $scheduled ) {
				return $scheduled;
			}

			add_filter( 'cron_request', function( array $cron_request_array ) {
				$cron_request_array['url'] = add_query_arg( 'crontrol-single-event', 1, $cron_request_array['url'] );
				return $cron_request_array;
			} );

			spawn_cron();

			sleep( 1 );

			return true;
		}
	}
	return false;
}

/**
 * Forcibly schedules a single event for the purpose of manually running it.
 *
 * This is used instead of `wp_schedule_single_event()` to avoid the duplicate check that's otherwise performed.
 *
 * @param string $hook Action hook to execute when the event is run.
 * @param array  $args Optional. Array containing each separate argument to pass to the hook's callback function.
 * @return bool True if event successfully scheduled. False for failure.
 */
function force_schedule_single_event( $hook, $args = array() ) {
	$event = (object) array(
		'hook'      => $hook,
		'timestamp' => 1,
		'schedule'  => false,
		'args'      => $args,
	);
	$crons = (array) _get_cron_array();
	$key   = md5( serialize( $event->args ) );

	$crons[ $event->timestamp ][ $event->hook ][ $key ] = array(
		'schedule' => $event->schedule,
		'args'     => $event->args,
	);
	uksort( $crons, 'strnatcasecmp' );

	return _set_cron_array( $crons );
}

/**
 * Adds a new cron event.
 *
 * @param string $next_run_local The time that the event should be run at, in the site's timezone.
 * @param string $schedule       The recurrence of the cron event.
 * @param string $hookname       The name of the hook to execute.
 * @param array  $args           Arguments to add to the cron event.
 * @return bool Whether the addition was successful.
 */
function add( $next_run_local, $schedule, $hookname, array $args ) {
	$next_run_local = strtotime( $next_run_local, current_time( 'timestamp' ) );

	if ( false === $next_run_local ) {
		return false;
	}

	$next_run_utc = get_gmt_from_date( gmdate( 'Y-m-d H:i:s', $next_run_local ), 'U' );

	if ( ! is_array( $args ) ) {
		$args = array();
	}

	if ( 'crontrol_cron_job' === $hookname && ! empty( $args['code'] ) && class_exists( '\ParseError' ) ) {
		try {
			// phpcs:ignore Squiz.PHP.Eval.Discouraged
			eval( sprintf(
				'return true; %s',
				$args['code']
			) );
		// phpcs:ignore PHPCompatibility.Classes.NewClasses.parseerrorFound
		} catch ( \ParseError $e ) {
			$args['syntax_error_message'] = $e->getMessage();
			$args['syntax_error_line']    = $e->getLine();
		}
	}

	if ( '_oneoff' === $schedule ) {
		return ( false !== wp_schedule_single_event( $next_run_utc, $hookname, $args ) );
	} else {
		return ( false !== wp_schedule_event( $next_run_utc, $schedule, $hookname, $args ) );
	}
}

/**
 * Deletes a cron event.
 *
 * @param string $to_delete    The hook name of the event to delete.
 * @param string $sig          The cron event signature.
 * @param string $next_run_utc The UTC time that the event would be run at.
 * @return bool Whether the deletion was successful.
 */
function delete( $to_delete, $sig, $next_run_utc ) {
	$crons = _get_cron_array();
	if ( isset( $crons[ $next_run_utc ][ $to_delete ][ $sig ] ) ) {
		$args        = $crons[ $next_run_utc ][ $to_delete ][ $sig ]['args'];
		$unscheduled = wp_unschedule_event( $next_run_utc, $to_delete, $args );

		if ( false === $unscheduled ) {
			return $unscheduled;
		}

		return true;
	}
	return false;
}

/**
 * Returns a flattened array of cron events.
 *
 * @return object[] An array of cron event objects.
 */
function get() {
	$crons  = _get_cron_array();
	$events = array();

	if ( empty( $crons ) ) {
		return array();
	}

	foreach ( $crons as $time => $cron ) {
		foreach ( $cron as $hook => $dings ) {
			foreach ( $dings as $sig => $data ) {

				// This is a prime candidate for a Crontrol_Event class but I'm not bothering currently.
				$events[ "$hook-$sig-$time" ] = (object) array(
					'hook'     => $hook,
					'time'     => $time, // UTC
					'sig'      => $sig,
					'args'     => $data['args'],
					'schedule' => $data['schedule'],
					'interval' => isset( $data['interval'] ) ? $data['interval'] : null,
				);

			}
		}
	}

	// Ensure events are always returned in date descending order.
	// External cron runners such as Cavalcade don't guarantee events are returned in order of time.
	uasort( $events, function( $a, $b ) {
		if ( $a->time === $b->time ) {
			return 0;
		} else {
			return ( $a->time > $b->time ) ? 1 : -1;
		}
	} );

	return $events;
}

/**
 * Returns an array of the number of events for each hook.
 *
 * @return int[] Array of number of events for each hook, keyed by the hook name.
 */
function count_by_hook() {
	$crons  = _get_cron_array();
	$events = array();

	if ( empty( $crons ) ) {
		return array();
	}

	foreach ( $crons as $time => $cron ) {
		foreach ( $cron as $hook => $dings ) {
			if ( ! isset( $events[ $hook ] ) ) {
				$events[ $hook ] = 0;
			}

			$events[ $hook ] += count( $dings );
		}
	}

	return $events;
}

/**
 * Returns the schedule display name for a given event.
 *
 * @param stdClass $event A WP-Cron event.
 * @return string|WP_Error The interval display name, or a WP_Error object if no such schedule exists.
 */
function get_schedule_name( stdClass $event ) {
	$schedules = Schedule\get();

	if ( isset( $schedules[ $event->schedule ] ) ) {
		return $schedules[ $event->schedule ]['display'];
	}

	return new WP_Error( 'unknown_schedule', sprintf(
		/* translators: %s: Schedule name */
		__( 'Unknown (%s)', 'wp-crontrol' ),
		$event->schedule
	) );
}

/**
 * Determines whether an event is late.
 *
 * An event which has missed its schedule by more than 10 minutes is considered late.
 *
 * @param stdClass $event The event.
 * @return bool Whether the event is late.
 */
function is_late( stdClass $event ) {
	$until = $event->time - time();

	return ( $until < ( 0 - ( 10 * MINUTE_IN_SECONDS ) ) );
}

/**
 * Initialises and returns the list table for events.
 *
 * @return Table The list table.
 */
function get_list_table() {
	static $table = null;

	if ( ! $table ) {
		require_once __DIR__ . '/event-list-table.php';

		$table = new Table();
		$table->prepare_items();

	}

	return $table;
}