ZT_Debug_Bar_Cron::display_event_hook() - Code Metrics - Inspection of "Merge pull request #53 from tollmanz/feature/simpl..." - tollmanz/debug-bar-cron - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 82e83c...02d327 )

by Juliette

created 2016-05-07 00:42 UTC

ZT_Debug_Bar_Cron::display_event_hook() A

↳ Parent: ZT_Debug_Bar_Cron

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	5
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	7
rs	9.4285

<?php
/**
 * Debug Bar Cron - Debug Bar Panel.
 *
 * @package     WordPress\Plugins\Debug Bar Cron
 * @author      Zack Tollman, Helen Hou-Sandi, Juliette Reinders Folmer
 * @link        https://github.com/tollmanz/debug-bar-cron
 * @version     0.1.2
 * @license     http://creativecommons.org/licenses/GPL/2.0/ GNU General Public License, version 2 or higher
 */

// Avoid direct calls to this file.
if ( ! function_exists( 'add_action' ) ) {
	header( 'Status: 403 Forbidden' );
	header( 'HTTP/1.1 403 Forbidden' );
	exit();
}

/**
 * The class in this file extends the functionality provided by the parent plugin "Debug Bar".
 */
if ( ! class_exists( 'ZT_Debug_Bar_Cron' ) && class_exists( 'Debug_Bar_Panel' ) ) {

	/**
	 * Add a new Debug Bar Panel.
	 */
	class ZT_Debug_Bar_Cron extends Debug_Bar_Panel {

		const DBCRON_STYLES_VERSION = '1.0';

		const DBCRON_NAME = 'debug-bar-cron';

		/**
		 * Holds all of the cron events.
		 *
		 * @var array
		 */
		private $_crons;

		/**
		 * Holds only the cron events initiated by WP core.
		 *
		 * @var array
		 */
		private $_core_crons;

		/**
		 * Holds the cron events created by plugins or themes.
		 *
		 * @var array
		 */
		private $_user_crons;

		/**
		 * Total number of cron events.
		 *
		 * @var int
		 */
		private $_total_crons = 0;

		/**
		 * Total number of cron events created by plugins and themes.
		 *
		 * @var int
		 */
		private $_total_user_crons = 0;

		/**
		 * Total number of WP core cron events.
		 *
		 * @var int
		 */
		private $_total_core_crons = 0;

		/**
		 * Whether cron is being executed or not.
		 *
		 * @var string
		 */
		private $_doing_cron = 'No';

		/**
		 * Lists all crons that are defined in WP Core.
		 *
		 * @var array
		 *
		 * @internal To find all, search WP trunk for `wp_schedule_(single_)?event`.
		 */
		private $_core_cron_hooks = array(
			'do_pings',
			'importer_scheduled_cleanup',     // WP 3.1+.
			'publish_future_post',
			'update_network_counts',          // WP 3.1+.
			'upgrader_scheduled_cleanup',     // WP 3.3+.
			'wp_maybe_auto_update',           // WP 3.7+.
			'wp_scheduled_auto_draft_delete', // WP 3.4+.
			'wp_scheduled_delete',            // WP 2.9+.
			'wp_split_shared_term_batch',     // WP 4.3+.
			'wp_update_plugins',
			'wp_update_themes',
			'wp_version_check',
		);



		/**
		 * Give the panel a title and set the enqueues.
		 *
		 * @return void
		 */
		public function init() {
			load_plugin_textdomain( 'debug-bar-cron' );
			$this->title( __( 'Cron', 'debug-bar-cron' ) );
			add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) );
			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) );
		}


		/**
		 * Enqueue styles.
		 *
		 * @return void
		 */
		public function enqueue_scripts_styles() {
			$suffix = ( ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min' );

			wp_enqueue_style(
				self::DBCRON_NAME,
				plugins_url( 'css/' . self::DBCRON_NAME . $suffix . '.css', __FILE__ ),
				array( 'debug-bar' ),
				self::DBCRON_STYLES_VERSION
			);
		}


		/**
		 * Show the menu item in Debug Bar.
		 *
		 * @return void
		 */
		public function prerender() {
			$this->set_visible( true );
		}


		/**
		 * Show the contents of the page.
		 *
		 * @return void
		 */
		public function render() {
			$this->get_crons();

			$this->_doing_cron = get_transient( 'doing_cron' ) ? __( 'Yes', 'debug-bar-cron' ) : __( 'No', 'debug-bar-cron' );

			// Get the time of the next event.
			$cron_times          = ( is_array( $this->_crons ) ? array_keys( $this->_crons ) : array() );
			$unix_time_next_cron = (int) $cron_times[0];
			$time_next_cron      = date( 'Y-m-d H:i:s', $unix_time_next_cron );

			$human_time_next_cron = human_time_diff( $unix_time_next_cron );

			// Add a class if past current time and doing cron is not running.
			$times_class = $this->is_time_in_past( $unix_time_next_cron ) ? ' past' : '';

			$this->load_debug_bar_pretty_output();

			echo // WPCS: XSS ok.
			'
			<div class="debug-bar-cron">
				<h2><span>', esc_html__( 'Total Events', 'debug-bar-cron' ), ':</span>', $this->_total_crons, '</h2>
				<h2><span>', esc_html__( 'Core Events', 'debug-bar-cron' ), ':</span>', $this->_total_core_crons, '</h2>
				<h2><span>', esc_html__( 'Custom Events', 'debug-bar-cron' ), ':</span>', $this->_total_user_crons, '</h2>
				<h2><span>', esc_html__( 'Doing Cron', 'debug-bar-cron' ), ':</span>', esc_html( $this->_doing_cron ), '</h2>
				<h2 class="times', esc_attr( $times_class ), '"><span>', esc_html__( 'Next Event', 'debug-bar-cron' ), ':</span>
					', esc_html( $time_next_cron ), '<br />
					', $unix_time_next_cron, '<br />
					', esc_html( $this->display_past_time( $human_time_next_cron, $unix_time_next_cron ) ), '
				</h2>
				<h2><span>', esc_html__( 'Current Time', 'debug-bar-cron' ), ':</span>', esc_html( date( 'H:i:s' ) ), '</h2>

				<div class="clear"></div>

				<h3>', esc_html__( 'Schedules', 'debug-bar-cron' ), '</h3>';

			$this->display_schedules();

			echo '
				<h3>', esc_html__( 'Custom Events', 'debug-bar-cron' ), '</h3>';

			$this->display_events( $this->_user_crons, __( 'No Custom Events scheduled.', 'debug-bar-cron' ) );

			echo '
				<h3>', esc_html__( 'Core Events', 'debug-bar-cron' ), '</h3>';

			$this->display_events( $this->_core_crons, __( 'No Core Events scheduled.', 'debug-bar-cron' ) );

			echo '
			</div>';

			$this->reset_debug_bar_pretty_output();
		}


		/**
		 * Gets all of the cron jobs.
		 *
		 * @return array|null Array of crons.
		 */
		private function get_crons() {
			if ( is_array( $this->_crons ) ) {
				return $this->_crons;
			}

			$crons = _get_cron_array();
			if ( is_array( $crons ) && ! empty( $crons ) ) {
				$this->_crons = $crons;
				$this->sort_count_crons();
			}

			return $this->_crons;
		}


		/**
		 * Sort and count crons.
		 *
		 * This function sorts the cron jobs into core crons, and custom crons. It also tallies
		 * a total count for the crons as this number is otherwise tough to get.
		 */
		private function sort_count_crons() {
			foreach ( $this->_crons as $time => $time_cron_array ) {
				foreach ( $time_cron_array as $hook => $data ) {
					$this->_total_crons += count( $data );

					if ( in_array( $hook, $this->_core_cron_hooks, true ) ) {
						$this->_core_crons[ $time ][ $hook ] = $data;
						$this->_total_core_crons            += count( $data );
					} else {
						$this->_user_crons[ $time ][ $hook ] = $data;
						$this->_total_user_crons            += count( $data );
					}
				}
			}
		}


		/**
		 * Displays the events in an easy to read table.
		 *
		 * @param array  $events        Array of events.
		 * @param string $no_events_msg Message to display if there are no events.
		 */
		private function display_events( $events, $no_events_msg ) {
			// Exit early if no events found.
			if ( ! is_array( $events ) || empty( $events ) ) {
				echo '
				<p>', esc_html( $no_events_msg ), '</p>';
				return;
			}

			echo '
				<table class="zt-debug-bar-cron-table zt-debug-bar-cron-event-table">
					<thead><tr>
						<th class="col1">', esc_html__( 'Next Execution', 'debug-bar-cron' ), '</th>
						<th class="col2">', esc_html__( 'Hook', 'debug-bar-cron' ), '</th>
						<th class="col3">', esc_html__( 'Interval Hook', 'debug-bar-cron' ), '</th>
						<th class="col4">', esc_html__( 'Interval Value', 'debug-bar-cron' ), '</th>
						<th class="col5">', esc_html__( 'Args', 'debug-bar-cron' ), '</th>
					</tr></thead>
					<tbody>';

			foreach ( $events as $time => $time_cron_array ) {
				$time        = (int) $time;
				$event_count = $this->get_arg_set_count( $time_cron_array );
				$show_time   = true;

				foreach ( $time_cron_array as $hook => $data ) {
					$row_attributes = $this->get_event_row_attributes( $time, $hook );
					$arg_set_count  = count( $data );
					$show_hook      = true;

					foreach ( $data as $hash => $info ) {
						echo // WPCS: xss ok.
						'
						<tr', $row_attributes, '>';

						if ( true === $show_time ) {
							$this->display_event_time( $time, $event_count );
							$show_time = false;
						}

						if ( true === $show_hook ) {
							$this->display_event_hook( $hook, $arg_set_count );
							$show_hook = false;
						}

						// Report the schedule.
						echo '
							<td>';
						$this->display_event_schedule( $info );
						echo '</td>';

						// Report the interval.
						echo '
							<td class="intervals">';
						$this->display_event_intervals( $info );
						echo '</td>';

						// Report the args.
						echo '
							<td>';
						$this->display_event_cron_arguments( $info['args'] );
						echo '</td>
						</tr>';
					}
					unset( $hash, $info );
				}
				unset( $hook, $data, $row_attributes, $arg_set_count, $show_hook );
			}
			unset( $time, $time_cron_array, $hook_count, $show_time );

			echo '
					</tbody>
				</table>';
		}


		/**
		 * Count the number of argument sets for a cron time.
		 *
		 * @param array $hook_array Array of hooks with argument sets.
		 *
		 * @return int
		 */
		private function get_arg_set_count( $hook_array ) {
			$count = 0;
			foreach ( $hook_array as $set ) {
				$count += count( $set );
			}
			return $count;
		}


		/**
		 * Create a HTML attribute string for an event row.
		 *
		 * @param int    $time Unix timestamp.
		 * @param string $hook Action hook for the cron job.
		 *
		 * @return string
		 */
		private function get_event_row_attributes( $time, $hook ) {
			$attributes = '';
			$classes    = array();

			// Add a class if past current time.
			if ( $this->is_time_in_past( $time ) ) {
				$classes[] = 'past';
			}

			// Verify if any events are hooked in.
			if ( false === has_action( $hook ) ) {
				/* translators: This text will display as a tooltip. %1$s will be replaced by a line break. */
				$attributes .= ' title="' . sprintf( esc_attr__( 'No actions are hooked into this event at this time.%1$sThe most likely reason for this is that a plugin or theme was de-activated or uninstalled and didn\'t clean up after itself.%1$sHowever, a number of plugins also use the best practice of lean loading and only hook in conditionally, so check carefully if you intend to remove this event.', 'debug-bar-cron' ), "\n" ) . '"';
				$classes[]   = 'empty-event';
			}

			if ( ! empty( $classes ) ) {
				$attributes .= ' class="' . implode( ' ', $classes ) . '"';
			}

			return $attributes;
		}


		/**
		 * Display the timing for the event as a date, timestamp and human readable time difference.
		 *
		 * @param int $time        Timestamp.
		 * @param int $event_count Number of events running at this time.
		 */
		private function display_event_time( $time, $event_count ) {
			$row_span = ( $event_count > 1 ) ? ' rowspan="' . $event_count . '"' : '';

			echo // WPCS: xss ok.
			'
			<td' . $row_span . '>
				', date( 'Y-m-d H:i:s', $time ), '<br />
				', $time, '<br />
				', esc_html( $this->display_past_time( human_time_diff( $time ), $time ) ), '
			</td>';
		}


		/**
		 * Display the name of the cron job event hook.
		 *
		 * @param string $hook          Hook name.
		 * @param int    $arg_set_count Number of events running at this time and on this hook.
		 */
		private function display_event_hook( $hook, $arg_set_count ) {
			$row_span = ( $arg_set_count > 1 ) ? ' rowspan="' . $arg_set_count . '"' : '';

			echo // WPCS: xss ok.
			'
			<td' . $row_span . '>', esc_html( $hook ), '</td>';
		}


		/**
		 * Displays the the event schedule name for recurring events or else 'single event'.
		 *
		 * @param array $info Event info array.
		 */
		private function display_event_schedule( $info ) {
			if ( ! empty( $info['schedule'] ) ) {
				echo esc_html( $info['schedule'] );
			} else {
				echo esc_html__( 'Single Event', 'debug-bar-cron' );
			}
		}


		/**
		 * Displays the event interval in seconds, minutes and hours.
		 *
		 * @param array $info Event info array.
		 */
		private function display_event_intervals( $info ) {
			if ( ! empty( $info['interval'] ) ) {
				$interval = (int) $info['interval'];
				/* translators: %s is number of seconds. */
				printf( esc_html__( '%ss', 'debug-bar-cron' ) . '<br />', $interval ); // WPCS: XSS ok.
				/* translators: %s is number of minutes. */
				printf( esc_html__( '%sm', 'debug-bar-cron' ) . '<br />', $this->get_minutes( $interval ) ); // WPCS: XSS ok.
				/* translators: %s is number of hours. */
				printf( esc_html__( '%sh', 'debug-bar-cron' ), $this->get_hours( $interval ) ); // WPCS: XSS ok.
				unset( $interval );
			} else {
				echo esc_html__( 'Single Event', 'debug-bar-cron' );
			}
		}


		/**
		 * Displays the cron arguments in a readable format.
		 *
		 * @param mixed $args Cron argument(s).
		 *
		 * @return void
		 */
		private function display_event_cron_arguments( $args ) {
			// Arguments defaults to an empty array if no arguments are given.
			if ( is_array( $args ) && array() === $args ) {
				echo esc_html__( 'No Args', 'debug-bar-cron' );
				return;
			}

			// Ok, we have an argument, let's pretty print it.
			$this->print_pretty_output( $args );
		}


		/**
		 * Displays all of the schedules defined.
		 *
		 * @return void
		 */
		private function display_schedules() {
			echo '
				<table class="zt-debug-bar-cron-table zt-debug-bar-cron-schedule-table">
					<thead><tr>
						<th class="col1">', esc_html__( 'Interval Hook', 'debug-bar-cron' ), '</th>
						<th class="col2">', esc_html__( 'Interval (S)', 'debug-bar-cron' ), '</th>
						<th class="col3">', esc_html__( 'Interval (M)', 'debug-bar-cron' ), '</th>
						<th class="col4">', esc_html__( 'Interval (H)', 'debug-bar-cron' ), '</th>
						<th class="col5">', esc_html__( 'Display Name', 'debug-bar-cron' ), '</th>
					</tr></thead>
					<tbody>';

			$schedules = wp_get_schedules();
			ksort( $schedules );
			uasort( $schedules, array( $this, 'schedules_sorting' ) );
			foreach ( $schedules as $interval_hook => $data ) {
				$interval = (int) $data['interval'];
				echo // WPCS: XSS ok.
				'
						<tr>
							<td>', esc_html( $interval_hook ), '</td>
							<td>', $interval, '</td>
							<td>', $this->get_minutes( $interval ), '</td>
							<td>', $this->get_hours( $interval ), '</td>
							<td>', esc_html( $data['display'] ) . '</td>
						</tr>';
			}

			echo '
					</tbody>
				</table>';
		}

		/**
		 * Sorting method for cron schedules. Order by schedules interval.
		 *
		 * @param array $schedule_a First element of comparison pair.
		 * @param array $schedule_b Second element of comparison pair.
		 *
		 * @return int Return 1 if $schedule_a argument 'interval' greater then $schedule_b argument 'interval',
		 *             0 if both intervals equivalent and -1 otherwise.
		 */
		private function schedules_sorting( $schedule_a, $schedule_b ) {
			if ( (int) $schedule_a['interval'] === (int) $schedule_b['interval'] ) {
				return 0;
			} else {
				return ( ( (int) $schedule_a['interval'] > (int) $schedule_b['interval'] ) ? 1 : -1 );
			}
		}

		/**
		 * Verify if a given timestamp is in the past or the future.
		 *
		 * @param int $time Unix timestamp.
		 *
		 * @return bool True if the time has passed, false otherwise.
		 */
		private function is_time_in_past( $time ) {
			return ( time() > $time && 'No' === $this->_doing_cron );
		}


		/**
		 * Transform a time in seconds to minutes rounded to 2 decimals.
		 *
		 * @param int $time Unix timestamp.
		 *
		 * @return float
		 */
		private function get_minutes( $time ) {
			return round( ( (int) $time / 60 ), 2 );
		}


		/**
		 * Transform a time in seconds to hours rounded to 2 decimals.
		 *
		 * @param int $time Unix timestamp.
		 *
		 * @return float
		 */
		private function get_hours( $time ) {
			return round( ( (int) $time / 3600 ), 2 );
		}


		/**
		 * Compares time with current time and adds ' ago' if current time is greater than event time.
		 *
		 * @param string $human_time Human readable time difference.
		 * @param int    $time       Unix time of event.
		 *
		 * @return string
		 */
		private function display_past_time( $human_time, $time ) {
			if ( time() > $time ) {
				/* translators: %s is a human readable time difference. */
				return sprintf( __( '%s ago', 'debug-bar-cron' ), $human_time );
			} else {
				return $human_time;
			}
		}


		/**
		 * Load the pretty output class & set the recursion limit.
		 */
		private function load_debug_bar_pretty_output() {
			if ( ! class_exists( 'Debug_Bar_Pretty_Output' ) ) {
				require_once plugin_dir_path( __FILE__ ) . 'inc/debug-bar-pretty-output/class-debug-bar-pretty-output.php';
			}

			// Limit recursion depth if possible - method available since DBPO v1.4.
			if ( method_exists( 'Debug_Bar_Pretty_Output', 'limit_recursion' ) ) {
				Debug_Bar_Pretty_Output::limit_recursion( 2 );
			}
		}


		/**
		 * Print any type of variable with colour coding and a variable type indication.
		 *
		 * @param mixed $variable The variable to print.
		 */
		private function print_pretty_output( $variable ) {
			if ( defined( 'Debug_Bar_Pretty_Output::VERSION' ) ) {
				echo Debug_Bar_Pretty_Output::get_output( $variable, '', true ); // WPCS: XSS ok.
			} else {
				// An old version of the pretty output class was loaded.
				// Real possibility as there are several DB plugins using the pretty print class.
				Debug_Bar_Pretty_Output::output( $variable, '', true );
			}
		}


		/**
		 * Unset recursion depth limit for the pretty output class.
		 *
		 * @internal Method available since DBPO v1.4.
		 */
		private function reset_debug_bar_pretty_output() {
			if ( method_exists( 'Debug_Bar_Pretty_Output', 'unset_recursion_limit' ) ) {
				Debug_Bar_Pretty_Output::unset_recursion_limit();
			}
		}
	} // End of class ZT_Debug_Bar_Cron.

} // End of if class_exists wrapper.


1			<?php
2			/**
3			* Debug Bar Cron - Debug Bar Panel.
4			*
5			* @package WordPress\Plugins\Debug Bar Cron
6			* @author Zack Tollman, Helen Hou-Sandi, Juliette Reinders Folmer
7			* @link https://github.com/tollmanz/debug-bar-cron
8			* @version 0.1.2
9			* @license http://creativecommons.org/licenses/GPL/2.0/ GNU General Public License, version 2 or higher
10			*/
11
12			// Avoid direct calls to this file.
13			if ( ! function_exists( 'add_action' ) ) {
14			header( 'Status: 403 Forbidden' );
15			header( 'HTTP/1.1 403 Forbidden' );
16			exit();
17			}
18
19			/**
20			* The class in this file extends the functionality provided by the parent plugin "Debug Bar".
21			*/
22			if ( ! class_exists( 'ZT_Debug_Bar_Cron' ) && class_exists( 'Debug_Bar_Panel' ) ) {
23
24			/**
25			* Add a new Debug Bar Panel.
26			*/
27			class ZT_Debug_Bar_Cron extends Debug_Bar_Panel {
28
29			const DBCRON_STYLES_VERSION = '1.0';
30
31			const DBCRON_NAME = 'debug-bar-cron';
32
33			/**
34			* Holds all of the cron events.
35			*
36			* @var array
37			*/
38			private $_crons;
39
40			/**
41			* Holds only the cron events initiated by WP core.
42			*
43			* @var array
44			*/
45			private $_core_crons;
46
47			/**
48			* Holds the cron events created by plugins or themes.
49			*
50			* @var array
51			*/
52			private $_user_crons;
53
54			/**
55			* Total number of cron events.
56			*
57			* @var int
58			*/
59			private $_total_crons = 0;
60
61			/**
62			* Total number of cron events created by plugins and themes.
63			*
64			* @var int
65			*/
66			private $_total_user_crons = 0;
67
68			/**
69			* Total number of WP core cron events.
70			*
71			* @var int
72			*/
73			private $_total_core_crons = 0;
74
75			/**
76			* Whether cron is being executed or not.
77			*
78			* @var string
79			*/
80			private $_doing_cron = 'No';
81
82			/**
83			* Lists all crons that are defined in WP Core.
84			*
85			* @var array
86			*
87			* @internal To find all, search WP trunk for `wp_schedule_(single_)?event`.
88			*/
89			private $_core_cron_hooks = array(
90			'do_pings',
91			'importer_scheduled_cleanup', // WP 3.1+.
92			'publish_future_post',
93			'update_network_counts', // WP 3.1+.
94			'upgrader_scheduled_cleanup', // WP 3.3+.
95			'wp_maybe_auto_update', // WP 3.7+.
96			'wp_scheduled_auto_draft_delete', // WP 3.4+.
97			'wp_scheduled_delete', // WP 2.9+.
98			'wp_split_shared_term_batch', // WP 4.3+.
99			'wp_update_plugins',
100			'wp_update_themes',
101			'wp_version_check',
102			);
103
104
105
106			/**
107			* Give the panel a title and set the enqueues.
108			*
109			* @return void
110			*/
111			public function init() {
112			load_plugin_textdomain( 'debug-bar-cron' );
113			$this->title( __( 'Cron', 'debug-bar-cron' ) );
114			add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) );
115			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts_styles' ) );
116			}
117
118
119			/**
120			* Enqueue styles.
121			*
122			* @return void
123			*/
124			public function enqueue_scripts_styles() {
125			$suffix = ( ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min' );
126
127			wp_enqueue_style(
128			self::DBCRON_NAME,
129			plugins_url( 'css/' . self::DBCRON_NAME . $suffix . '.css', __FILE__ ),
130			array( 'debug-bar' ),
131			self::DBCRON_STYLES_VERSION
132			);
133			}
134
135
136			/**
137			* Show the menu item in Debug Bar.
138			*
139			* @return void
140			*/
141			public function prerender() {
142			$this->set_visible( true );
143			}
144
145
146			/**
147			* Show the contents of the page.
148			*
149			* @return void
150			*/
151			public function render() {
152			$this->get_crons();
153
154			$this->_doing_cron = get_transient( 'doing_cron' ) ? __( 'Yes', 'debug-bar-cron' ) : __( 'No', 'debug-bar-cron' );
155
156			// Get the time of the next event.
157			$cron_times = ( is_array( $this->_crons ) ? array_keys( $this->_crons ) : array() );
158			$unix_time_next_cron = (int) $cron_times[0];
159			$time_next_cron = date( 'Y-m-d H:i:s', $unix_time_next_cron );
160
161			$human_time_next_cron = human_time_diff( $unix_time_next_cron );
162
163			// Add a class if past current time and doing cron is not running.
164			$times_class = $this->is_time_in_past( $unix_time_next_cron ) ? ' past' : '';
165
166			$this->load_debug_bar_pretty_output();
167
168			echo // WPCS: XSS ok.
169			'
170			<div class="debug-bar-cron">
171			<h2><span>', esc_html__( 'Total Events', 'debug-bar-cron' ), ':</span>', $this->_total_crons, '</h2>
172			<h2><span>', esc_html__( 'Core Events', 'debug-bar-cron' ), ':</span>', $this->_total_core_crons, '</h2>
173			<h2><span>', esc_html__( 'Custom Events', 'debug-bar-cron' ), ':</span>', $this->_total_user_crons, '</h2>
174			<h2><span>', esc_html__( 'Doing Cron', 'debug-bar-cron' ), ':</span>', esc_html( $this->_doing_cron ), '</h2>
175			<h2 class="times', esc_attr( $times_class ), '"><span>', esc_html__( 'Next Event', 'debug-bar-cron' ), ':</span>
176			', esc_html( $time_next_cron ), '<br />
177			', $unix_time_next_cron, '<br />
178			', esc_html( $this->display_past_time( $human_time_next_cron, $unix_time_next_cron ) ), '
179			</h2>
180			<h2><span>', esc_html__( 'Current Time', 'debug-bar-cron' ), ':</span>', esc_html( date( 'H:i:s' ) ), '</h2>
181
182			<div class="clear"></div>
183
184			<h3>', esc_html__( 'Schedules', 'debug-bar-cron' ), '</h3>';
185
186			$this->display_schedules();
187
188			echo '
189			<h3>', esc_html__( 'Custom Events', 'debug-bar-cron' ), '</h3>';
190
191			$this->display_events( $this->_user_crons, __( 'No Custom Events scheduled.', 'debug-bar-cron' ) );
192
193			echo '
194			<h3>', esc_html__( 'Core Events', 'debug-bar-cron' ), '</h3>';
195
196			$this->display_events( $this->_core_crons, __( 'No Core Events scheduled.', 'debug-bar-cron' ) );
197
198			echo '
199			</div>';
200
201			$this->reset_debug_bar_pretty_output();
202			}
203
204
205			/**
206			* Gets all of the cron jobs.
207			*
208			* @return array\|null Array of crons.
209			*/
210			private function get_crons() {
211			if ( is_array( $this->_crons ) ) {
212			return $this->_crons;
213			}
214
215			$crons = _get_cron_array();
216			if ( is_array( $crons ) && ! empty( $crons ) ) {
217			$this->_crons = $crons;
218			$this->sort_count_crons();
219			}
220
221			return $this->_crons;
222			}
223
224
225			/**
226			* Sort and count crons.
227			*
228			* This function sorts the cron jobs into core crons, and custom crons. It also tallies
229			* a total count for the crons as this number is otherwise tough to get.
230			*/
231			private function sort_count_crons() {
232			foreach ( $this->_crons as $time => $time_cron_array ) {
233			foreach ( $time_cron_array as $hook => $data ) {
234			$this->_total_crons += count( $data );
235
236			if ( in_array( $hook, $this->_core_cron_hooks, true ) ) {
237			$this->_core_crons[ $time ][ $hook ] = $data;
238			$this->_total_core_crons += count( $data );
239			} else {
240			$this->_user_crons[ $time ][ $hook ] = $data;
241			$this->_total_user_crons += count( $data );
242			}
243			}
244			}
245			}
246
247
248			/**
249			* Displays the events in an easy to read table.
250			*
251			* @param array $events Array of events.
252			* @param string $no_events_msg Message to display if there are no events.
253			*/
254			private function display_events( $events, $no_events_msg ) {
255			// Exit early if no events found.
256			if ( ! is_array( $events ) \|\| empty( $events ) ) {
257			echo '
258			<p>', esc_html( $no_events_msg ), '</p>';
259			return;
260			}
261
262			echo '
263			<table class="zt-debug-bar-cron-table zt-debug-bar-cron-event-table">
264			<thead><tr>
265			<th class="col1">', esc_html__( 'Next Execution', 'debug-bar-cron' ), '</th>
266			<th class="col2">', esc_html__( 'Hook', 'debug-bar-cron' ), '</th>
267			<th class="col3">', esc_html__( 'Interval Hook', 'debug-bar-cron' ), '</th>
268			<th class="col4">', esc_html__( 'Interval Value', 'debug-bar-cron' ), '</th>
269			<th class="col5">', esc_html__( 'Args', 'debug-bar-cron' ), '</th>
270			</tr></thead>
271			<tbody>';
272
273			foreach ( $events as $time => $time_cron_array ) {
274			$time = (int) $time;
275			$event_count = $this->get_arg_set_count( $time_cron_array );
276			$show_time = true;
277
278			foreach ( $time_cron_array as $hook => $data ) {
279			$row_attributes = $this->get_event_row_attributes( $time, $hook );
280			$arg_set_count = count( $data );
281			$show_hook = true;
282
283			foreach ( $data as $hash => $info ) {
284			echo // WPCS: xss ok.
285			'
286			<tr', $row_attributes, '>';
287
288			if ( true === $show_time ) {
289			$this->display_event_time( $time, $event_count );
290			$show_time = false;
291			}
292
293			if ( true === $show_hook ) {
294			$this->display_event_hook( $hook, $arg_set_count );
295			$show_hook = false;
296			}
297
298			// Report the schedule.
299			echo '
300			<td>';
301			$this->display_event_schedule( $info );
302			echo '</td>';
303
304			// Report the interval.
305			echo '
306			<td class="intervals">';
307			$this->display_event_intervals( $info );
308			echo '</td>';
309
310			// Report the args.
311			echo '
312			<td>';
313			$this->display_event_cron_arguments( $info['args'] );
314			echo '</td>
315			</tr>';
316			}
317			unset( $hash, $info );
318			}
319			unset( $hook, $data, $row_attributes, $arg_set_count, $show_hook );
320			}
321			unset( $time, $time_cron_array, $hook_count, $show_time );
322
323			echo '
324			</tbody>
325			</table>';
326			}
327
328
329			/**
330			* Count the number of argument sets for a cron time.
331			*
332			* @param array $hook_array Array of hooks with argument sets.
333			*
334			* @return int
335			*/
336			private function get_arg_set_count( $hook_array ) {
337			$count = 0;
338			foreach ( $hook_array as $set ) {
339			$count += count( $set );
340			}
341			return $count;
342			}
343
344
345			/**
346			* Create a HTML attribute string for an event row.
347			*
348			* @param int $time Unix timestamp.
349			* @param string $hook Action hook for the cron job.
350			*
351			* @return string
352			*/
353			private function get_event_row_attributes( $time, $hook ) {
354			$attributes = '';
355			$classes = array();
356
357			// Add a class if past current time.
358			if ( $this->is_time_in_past( $time ) ) {
359			$classes[] = 'past';
360			}
361
362			// Verify if any events are hooked in.
363			if ( false === has_action( $hook ) ) {
364			/* translators: This text will display as a tooltip. %1$s will be replaced by a line break. */
365			$attributes .= ' title="' . sprintf( esc_attr__( 'No actions are hooked into this event at this time.%1$sThe most likely reason for this is that a plugin or theme was de-activated or uninstalled and didn\'t clean up after itself.%1$sHowever, a number of plugins also use the best practice of lean loading and only hook in conditionally, so check carefully if you intend to remove this event.', 'debug-bar-cron' ), "\n" ) . '"';
366			$classes[] = 'empty-event';
367			}
368
369			if ( ! empty( $classes ) ) {
370			$attributes .= ' class="' . implode( ' ', $classes ) . '"';
371			}
372
373			return $attributes;
374			}
375
376
377			/**
378			* Display the timing for the event as a date, timestamp and human readable time difference.
379			*
380			* @param int $time Timestamp.
381			* @param int $event_count Number of events running at this time.
382			*/
383			private function display_event_time( $time, $event_count ) {
384			$row_span = ( $event_count > 1 ) ? ' rowspan="' . $event_count . '"' : '';
385
386			echo // WPCS: xss ok.
387			'
388			<td' . $row_span . '>
389			', date( 'Y-m-d H:i:s', $time ), '<br />
390			', $time, '<br />
391			', esc_html( $this->display_past_time( human_time_diff( $time ), $time ) ), '
392			</td>';
393			}
394
395
396			/**
397			* Display the name of the cron job event hook.
398			*
399			* @param string $hook Hook name.
400			* @param int $arg_set_count Number of events running at this time and on this hook.
401			*/
402			private function display_event_hook( $hook, $arg_set_count ) {
403			$row_span = ( $arg_set_count > 1 ) ? ' rowspan="' . $arg_set_count . '"' : '';
404
405			echo // WPCS: xss ok.
406			'
407			<td' . $row_span . '>', esc_html( $hook ), '</td>';
408			}
409
410
411			/**
412			* Displays the the event schedule name for recurring events or else 'single event'.
413			*
414			* @param array $info Event info array.
415			*/
416			private function display_event_schedule( $info ) {
417			if ( ! empty( $info['schedule'] ) ) {
418			echo esc_html( $info['schedule'] );
419			} else {
420			echo esc_html__( 'Single Event', 'debug-bar-cron' );
421			}
422			}
423
424
425			/**
426			* Displays the event interval in seconds, minutes and hours.
427			*
428			* @param array $info Event info array.
429			*/
430			private function display_event_intervals( $info ) {
431			if ( ! empty( $info['interval'] ) ) {
432			$interval = (int) $info['interval'];
433			/* translators: %s is number of seconds. */
434			printf( esc_html__( '%ss', 'debug-bar-cron' ) . '<br />', $interval ); // WPCS: XSS ok.
435			/* translators: %s is number of minutes. */
436			printf( esc_html__( '%sm', 'debug-bar-cron' ) . '<br />', $this->get_minutes( $interval ) ); // WPCS: XSS ok.
437			/* translators: %s is number of hours. */
438			printf( esc_html__( '%sh', 'debug-bar-cron' ), $this->get_hours( $interval ) ); // WPCS: XSS ok.
439			unset( $interval );
440			} else {
441			echo esc_html__( 'Single Event', 'debug-bar-cron' );
442			}
443			}
444
445
446			/**
447			* Displays the cron arguments in a readable format.
448			*
449			* @param mixed $args Cron argument(s).
450			*
451			* @return void
452			*/
453			private function display_event_cron_arguments( $args ) {
454			// Arguments defaults to an empty array if no arguments are given.
455			if ( is_array( $args ) && array() === $args ) {
456			echo esc_html__( 'No Args', 'debug-bar-cron' );
457			return;
458			}
459
460			// Ok, we have an argument, let's pretty print it.
461			$this->print_pretty_output( $args );
462			}
463
464
465			/**
466			* Displays all of the schedules defined.
467			*
468			* @return void
469			*/
470			private function display_schedules() {
471			echo '
472			<table class="zt-debug-bar-cron-table zt-debug-bar-cron-schedule-table">
473			<thead><tr>
474			<th class="col1">', esc_html__( 'Interval Hook', 'debug-bar-cron' ), '</th>
475			<th class="col2">', esc_html__( 'Interval (S)', 'debug-bar-cron' ), '</th>
476			<th class="col3">', esc_html__( 'Interval (M)', 'debug-bar-cron' ), '</th>
477			<th class="col4">', esc_html__( 'Interval (H)', 'debug-bar-cron' ), '</th>
478			<th class="col5">', esc_html__( 'Display Name', 'debug-bar-cron' ), '</th>
479			</tr></thead>
480			<tbody>';
481
482			$schedules = wp_get_schedules();
483			ksort( $schedules );
484			uasort( $schedules, array( $this, 'schedules_sorting' ) );
485			foreach ( $schedules as $interval_hook => $data ) {
486			$interval = (int) $data['interval'];
487			echo // WPCS: XSS ok.
488			'
489			<tr>
490			<td>', esc_html( $interval_hook ), '</td>
491			<td>', $interval, '</td>
492			<td>', $this->get_minutes( $interval ), '</td>
493			<td>', $this->get_hours( $interval ), '</td>
494			<td>', esc_html( $data['display'] ) . '</td>
495			</tr>';
496			}
497
498			echo '
499			</tbody>
500			</table>';
501			}
502
503			/**
504			* Sorting method for cron schedules. Order by schedules interval.
505			*
506			* @param array $schedule_a First element of comparison pair.
507			* @param array $schedule_b Second element of comparison pair.
508			*
509			* @return int Return 1 if $schedule_a argument 'interval' greater then $schedule_b argument 'interval',
510			* 0 if both intervals equivalent and -1 otherwise.
511			*/
512			private function schedules_sorting( $schedule_a, $schedule_b ) {
513			if ( (int) $schedule_a['interval'] === (int) $schedule_b['interval'] ) {
514			return 0;
515			} else {
516			return ( ( (int) $schedule_a['interval'] > (int) $schedule_b['interval'] ) ? 1 : -1 );
517			}
518			}
519
520			/**
521			* Verify if a given timestamp is in the past or the future.
522			*
523			* @param int $time Unix timestamp.
524			*
525			* @return bool True if the time has passed, false otherwise.
526			*/
527			private function is_time_in_past( $time ) {
528			return ( time() > $time && 'No' === $this->_doing_cron );
529			}
530
531
532			/**
533			* Transform a time in seconds to minutes rounded to 2 decimals.
534			*
535			* @param int $time Unix timestamp.
536			*
537			* @return float
538			*/
539			private function get_minutes( $time ) {
540			return round( ( (int) $time / 60 ), 2 );
541			}
542
543
544			/**
545			* Transform a time in seconds to hours rounded to 2 decimals.
546			*
547			* @param int $time Unix timestamp.
548			*
549			* @return float
550			*/
551			private function get_hours( $time ) {
552			return round( ( (int) $time / 3600 ), 2 );
553			}
554
555
556			/**
557			* Compares time with current time and adds ' ago' if current time is greater than event time.
558			*
559			* @param string $human_time Human readable time difference.
560			* @param int $time Unix time of event.
561			*
562			* @return string
563			*/
564			private function display_past_time( $human_time, $time ) {
565			if ( time() > $time ) {
566			/* translators: %s is a human readable time difference. */
567			return sprintf( __( '%s ago', 'debug-bar-cron' ), $human_time );
568			} else {
569			return $human_time;
570			}
571			}
572
573
574			/**
575			* Load the pretty output class & set the recursion limit.
576			*/
577			private function load_debug_bar_pretty_output() {
578			if ( ! class_exists( 'Debug_Bar_Pretty_Output' ) ) {
579			require_once plugin_dir_path( __FILE__ ) . 'inc/debug-bar-pretty-output/class-debug-bar-pretty-output.php';
580			}
581
582			// Limit recursion depth if possible - method available since DBPO v1.4.
583			if ( method_exists( 'Debug_Bar_Pretty_Output', 'limit_recursion' ) ) {
584			Debug_Bar_Pretty_Output::limit_recursion( 2 );
585			}
586			}
587
588
589			/**
590			* Print any type of variable with colour coding and a variable type indication.
591			*
592			* @param mixed $variable The variable to print.
593			*/
594			private function print_pretty_output( $variable ) {
595			if ( defined( 'Debug_Bar_Pretty_Output::VERSION' ) ) {
596			echo Debug_Bar_Pretty_Output::get_output( $variable, '', true ); // WPCS: XSS ok.
597			} else {
598			// An old version of the pretty output class was loaded.
599			// Real possibility as there are several DB plugins using the pretty print class.
600			Debug_Bar_Pretty_Output::output( $variable, '', true );
601			}
602			}
603
604
605			/**
606			* Unset recursion depth limit for the pretty output class.
607			*
608			* @internal Method available since DBPO v1.4.
609			*/
610			private function reset_debug_bar_pretty_output() {
611			if ( method_exists( 'Debug_Bar_Pretty_Output', 'unset_recursion_limit' ) ) {
612			Debug_Bar_Pretty_Output::unset_recursion_limit();
613			}
614			}
615			} // End of class ZT_Debug_Bar_Cron.
616
617			} // End of if class_exists wrapper.
618

tollmanz / debug-bar-cron

GitHub Access Token became invalid

Push — master ( 82e83c...02d327 )

ZT_Debug_Bar_Cron::display_event_hook() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like