ActionScheduler_AdminView.php — WooCommerce 10.9.4

woocommerce / packages / action-scheduler / classes / ActionScheduler_AdminView.php

woocommerce / packages / action-scheduler / classes Last commit date

ActionScheduler_AdminView.php

312 lines

1	<?php
2
3	/**
4	* Class ActionScheduler_AdminView
5	*
6	* @codeCoverageIgnore
7	*/
8	class ActionScheduler_AdminView extends ActionScheduler_AdminView_Deprecated {
9
10	/**
11	* Instance.
12	*
13	* @var null\|self
14	*/
15	private static $admin_view = null;
16
17	/**
18	* Screen ID.
19	*
20	* @var string
21	*/
22	private static $screen_id = 'tools_page_action-scheduler';
23
24	/**
25	* ActionScheduler_ListTable instance.
26	*
27	* @var ActionScheduler_ListTable
28	*/
29	protected $list_table;
30
31	/**
32	* Get instance.
33	*
34	* @return ActionScheduler_AdminView
35	* @codeCoverageIgnore
36	*/
37	public static function instance() {
38
39	if ( empty( self::$admin_view ) ) {
40	$class = apply_filters( 'action_scheduler_admin_view_class', 'ActionScheduler_AdminView' );
41	self::$admin_view = new $class();
42	}
43
44	return self::$admin_view;
45	}
46
47	/**
48	* Initialize.
49	*
50	* @codeCoverageIgnore
51	*/
52	public function init() {
53	if ( is_admin() && ( ! defined( 'DOING_AJAX' ) \|\| ! DOING_AJAX ) ) {
54
55	if ( class_exists( 'WooCommerce' ) ) {
56	add_action( 'woocommerce_admin_status_content_action-scheduler', array( $this, 'render_admin_ui' ) );
57	add_action( 'woocommerce_system_status_report', array( $this, 'system_status_report' ) );
58	add_filter( 'woocommerce_admin_status_tabs', array( $this, 'register_system_status_tab' ) );
59	}
60
61	add_action( 'admin_menu', array( $this, 'register_menu' ) );
62	add_action( 'admin_notices', array( $this, 'maybe_check_pastdue_actions' ) );
63	add_action( 'current_screen', array( $this, 'add_help_tabs' ) );
64	}
65	}
66
67	/**
68	* Print system status report.
69	*/
70	public function system_status_report() {
71	$table = new ActionScheduler_wcSystemStatus( ActionScheduler::store() );
72	$table->render();
73	}
74
75	/**
76	* Registers action-scheduler into WooCommerce > System status.
77	*
78	* @param array $tabs An associative array of tab key => label.
79	* @return array $tabs An associative array of tab key => label, including Action Scheduler's tabs
80	*/
81	public function register_system_status_tab( array $tabs ) {
82	$tabs['action-scheduler'] = __( 'Scheduled Actions', 'woocommerce' );
83
84	return $tabs;
85	}
86
87	/**
88	* Include Action Scheduler's administration under the Tools menu.
89	*
90	* A menu under the Tools menu is important for backward compatibility (as that's
91	* where it started), and also provides more convenient access than the WooCommerce
92	* System Status page, and for sites where WooCommerce isn't active.
93	*/
94	public function register_menu() {
95	$hook_suffix = add_submenu_page(
96	'tools.php',
97	__( 'Scheduled Actions', 'woocommerce' ),
98	__( 'Scheduled Actions', 'woocommerce' ),
99	'manage_options',
100	'action-scheduler',
101	array( $this, 'render_admin_ui' )
102	);
103	add_action( 'load-' . $hook_suffix, array( $this, 'process_admin_ui' ) );
104	}
105
106	/**
107	* Triggers processing of any pending actions.
108	*/
109	public function process_admin_ui() {
110	$this->get_list_table();
111	}
112
113	/**
114	* Renders the Admin UI
115	*/
116	public function render_admin_ui() {
117	$table = $this->get_list_table();
118	$table->display_page();
119	}
120
121	/**
122	* Get the admin UI object and process any requested actions.
123	*
124	* @return ActionScheduler_ListTable
125	*/
126	protected function get_list_table() {
127	if ( null === $this->list_table ) {
128	$this->list_table = new ActionScheduler_ListTable( ActionScheduler::store(), ActionScheduler::logger(), ActionScheduler::runner() );
129	$this->list_table->process_actions();
130	}
131
132	return $this->list_table;
133	}
134
135	/**
136	* Action: admin_notices
137	*
138	* Maybe check past-due actions, and print notice.
139	*
140	* @uses $this->check_pastdue_actions()
141	*/
142	public function maybe_check_pastdue_actions() {
143
144	// Filter to prevent checking actions (ex: inappropriate user).
145	if ( ! apply_filters( 'action_scheduler_check_pastdue_actions', current_user_can( 'manage_options' ) ) ) {
146	return;
147	}
148
149	// Get last check transient.
150	$last_check = get_transient( 'action_scheduler_last_pastdue_actions_check' );
151
152	// If transient exists, we're within interval, so bail.
153	if ( ! empty( $last_check ) ) {
154	return;
155	}
156
157	// Perform the check.
158	$this->check_pastdue_actions();
159	}
160
161	/**
162	* Check past-due actions, and print notice.
163	*/
164	protected function check_pastdue_actions() {
165
166	// Set thresholds.
167	$threshold_seconds = (int) apply_filters( 'action_scheduler_pastdue_actions_seconds', DAY_IN_SECONDS );
168	$threshold_min = (int) apply_filters( 'action_scheduler_pastdue_actions_min', 1 );
169
170	// Set fallback value for past-due actions count.
171	$num_pastdue_actions = 0;
172
173	// Allow third-parties to preempt the default check logic.
174	$check = apply_filters( 'action_scheduler_pastdue_actions_check_pre', null );
175
176	// If no third-party preempted and there are no past-due actions, return early.
177	if ( ! is_null( $check ) ) {
178	return;
179	}
180
181	// Scheduled actions query arguments.
182	$query_args = array(
183	'date' => as_get_datetime_object( time() - $threshold_seconds ),
184	'status' => ActionScheduler_Store::STATUS_PENDING,
185	'per_page' => $threshold_min,
186	);
187
188	// If no third-party preempted, run default check.
189	if ( is_null( $check ) ) {
190	$store = ActionScheduler_Store::instance();
191	$num_pastdue_actions = (int) $store->query_actions( $query_args, 'count' );
192
193	// Check if past-due actions count is greater than or equal to threshold.
194	$check = ( $num_pastdue_actions >= $threshold_min );
195	$check = (bool) apply_filters( 'action_scheduler_pastdue_actions_check', $check, $num_pastdue_actions, $threshold_seconds, $threshold_min );
196	}
197
198	// If check failed, set transient and abort.
199	if ( ! boolval( $check ) ) {
200	$interval = apply_filters( 'action_scheduler_pastdue_actions_check_interval', round( $threshold_seconds / 4 ), $threshold_seconds );
201	set_transient( 'action_scheduler_last_pastdue_actions_check', time(), $interval );
202
203	return;
204	}
205
206	$actions_url = add_query_arg(
207	array(
208	'page' => 'action-scheduler',
209	'status' => 'past-due',
210	'order' => 'asc',
211	),
212	admin_url( 'tools.php' )
213	);
214
215	// Print notice.
216	echo '<div class="notice notice-warning"><p>';
217	printf(
218	wp_kses(
219	// translators: 1) is the number of affected actions, 2) is a link to an admin screen.
220	_n(
221	'<strong>Action Scheduler:</strong> %1$d <a href="%2$s">past-due action</a> found; something may be wrong. <a href="https://actionscheduler.org/faq/#my-site-has-past-due-actions-what-can-i-do" target="_blank">Read documentation »</a>',
222	'<strong>Action Scheduler:</strong> %1$d <a href="%2$s">past-due actions</a> found; something may be wrong. <a href="https://actionscheduler.org/faq/#my-site-has-past-due-actions-what-can-i-do" target="_blank">Read documentation »</a>',
223	$num_pastdue_actions,
224	'woocommerce'
225	),
226	array(
227	'strong' => array(),
228	'a' => array(
229	'href' => true,
230	'target' => true,
231	),
232	)
233	),
234	absint( $num_pastdue_actions ),
235	esc_attr( esc_url( $actions_url ) )
236	);
237	echo '</p></div>';
238
239	// Facilitate third-parties to evaluate and print notices.
240	do_action( 'action_scheduler_pastdue_actions_extra_notices', $query_args );
241	}
242
243	/**
244	* Provide more information about the screen and its data in the help tab.
245	*/
246	public function add_help_tabs() {
247	$screen = get_current_screen();
248
249	if ( ! $screen \|\| self::$screen_id !== $screen->id ) {
250	return;
251	}
252
253	$as_version = ActionScheduler_Versions::instance()->latest_version();
254	$as_source = ActionScheduler_SystemInformation::active_source();
255	$as_source_path = ActionScheduler_SystemInformation::active_source_path();
256	$as_source_markup = sprintf( '<code>%s</code>', esc_html( $as_source_path ) );
257
258	if ( ! empty( $as_source ) ) {
259	$as_source_markup = sprintf(
260	'%s: <abbr title="%s">%s</abbr>',
261	ucfirst( $as_source['type'] ),
262	esc_attr( $as_source_path ),
263	esc_html( $as_source['name'] )
264	);
265	}
266
267	$screen->add_help_tab(
268	array(
269	'id' => 'action_scheduler_about',
270	'title' => __( 'About', 'woocommerce' ),
271	'content' =>
272	// translators: %s is the Action Scheduler version.
273	'<h2>' . sprintf( __( 'About Action Scheduler %s', 'woocommerce' ), $as_version ) . '</h2>' .
274	'<p>' .
275	__( 'Action Scheduler is a scalable, traceable job queue for background processing large sets of actions. Action Scheduler works by triggering an action hook to run at some time in the future. Scheduled actions can also be scheduled to run on a recurring schedule.', 'woocommerce' ) .
276	'</p>' .
277	'<h3>' . esc_html__( 'Source', 'woocommerce' ) . '</h3>' .
278	'<p>' .
279	esc_html__( 'Action Scheduler is currently being loaded from the following location. This can be useful when debugging, or if requested by the support team.', 'woocommerce' ) .
280	'</p>' .
281	'<p>' . $as_source_markup . '</p>' .
282	'<h3>' . esc_html__( 'WP CLI', 'woocommerce' ) . '</h3>' .
283	'<p>' .
284	sprintf(
285	/* translators: %1$s is WP CLI command (not translatable) */
286	esc_html__( 'WP CLI commands are available: execute %1$s for a list of available commands.', 'woocommerce' ),
287	'<code>wp help action-scheduler</code>'
288	) .
289	'</p>',
290	)
291	);
292
293	$screen->add_help_tab(
294	array(
295	'id' => 'action_scheduler_columns',
296	'title' => __( 'Columns', 'woocommerce' ),
297	'content' =>
298	'<h2>' . __( 'Scheduled Action Columns', 'woocommerce' ) . '</h2>' .
299	'<ul>' .
300	sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Hook', 'woocommerce' ), __( 'Name of the action hook that will be triggered.', 'woocommerce' ) ) .
301	sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Status', 'woocommerce' ), __( 'Action statuses are Pending, Complete, Canceled, Failed', 'woocommerce' ) ) .
302	sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Arguments', 'woocommerce' ), __( 'Optional data array passed to the action hook.', 'woocommerce' ) ) .
303	sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Group', 'woocommerce' ), __( 'Optional action group.', 'woocommerce' ) ) .
304	sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Recurrence', 'woocommerce' ), __( 'The action\'s schedule frequency.', 'woocommerce' ) ) .
305	sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Scheduled', 'woocommerce' ), __( 'The date/time the action is/was scheduled to run.', 'woocommerce' ) ) .
306	sprintf( '<li><strong>%1$s</strong>: %2$s</li>', __( 'Log', 'woocommerce' ), __( 'Activity log for the action.', 'woocommerce' ) ) .
307	'</ul>',
308	)
309	);
310	}
311	}
312