class-wc-admin-log-table-list.php — WooCommerce 10.9.4

woocommerce / includes / admin / class-wc-admin-log-table-list.php

woocommerce / includes / admin Last commit date

class-wc-admin-log-table-list.php

546 lines

1	<?php
2	/**
3	* WooCommerce Log Table List
4	*
5	* @author WooThemes
6	* @category Admin
7	* @package WooCommerce\Admin
8	* @version 1.0.0
9	*/
10
11	if ( ! defined( 'ABSPATH' ) ) {
12	exit;
13	}
14
15	if ( ! class_exists( 'WP_List_Table' ) ) {
16	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
17	}
18
19	class WC_Admin_Log_Table_List extends WP_List_Table {
20	/**
21	* The key for the user option of how many list table items to display per page.
22	*
23	* @const string
24	*/
25	public const PER_PAGE_USER_OPTION_KEY = 'woocommerce_status_log_items_per_page';
26
27	/**
28	* The key for the option that stores the list of unique sources that exist in the log table.
29	*
30	* @const string
31	*/
32	public const SOURCE_CACHE_OPTION_KEY = 'woocommerce_status_log_db_sources';
33
34	/**
35	* If the number of log entries is over this number, cache the query that gets the total count.
36	*/
37	private const ITEM_COUNT_CACHE_THRESHOLD = 100000;
38
39	/**
40	* Initialize the log table list.
41	*/
42	public function __construct() {
43	parent::__construct(
44	array(
45	'singular' => 'log',
46	'plural' => 'logs',
47	'ajax' => false,
48	)
49	);
50	}
51
52	/**
53	* Display level dropdown
54	*
55	* @global wpdb $wpdb
56	*/
57	public function level_dropdown() {
58	$labels = WC_Log_Levels::get_all_level_labels();
59
60	$levels = array_reduce(
61	array_keys( $labels ),
62	function( $carry, $item ) use ( $labels ) {
63	$carry[] = array(
64	'value' => $item,
65	'label' => $labels[ $item ],
66	);
67
68	return $carry;
69	},
70	array()
71	);
72
73	$selected_level = isset( $_REQUEST['level'] ) ? $_REQUEST['level'] : '';
74	?>
75	<label for="filter-by-level" class="screen-reader-text"><?php esc_html_e( 'Filter by level', 'woocommerce' ); ?></label>
76	<select name="level" id="filter-by-level">
77	<option<?php selected( $selected_level, '' ); ?> value=""><?php esc_html_e( 'All levels', 'woocommerce' ); ?></option>
78	<?php
79	foreach ( $levels as $l ) {
80	printf(
81	'<option%1$s value="%2$s">%3$s</option>',
82	selected( $selected_level, $l['value'], false ),
83	esc_attr( $l['value'] ),
84	esc_html( $l['label'] )
85	);
86	}
87	?>
88	</select>
89	<?php
90	}
91
92	/**
93	* Generates the table rows.
94	*
95	* @return void
96	*/
97	public function display_rows() {
98	foreach ( $this->items as $log ) {
99	$this->single_row( $log );
100	if ( ! empty( $log['context'] ) ) {
101	$this->context_row( $log );
102	}
103	}
104	}
105
106	/**
107	* Render the additional table row that contains extra log context data.
108	*
109	* @param array $log Log entry data.
110	*
111	* @return void
112	*/
113	protected function context_row( $log ) {
114	// Maintains alternating row background colors.
115	?>
116	<tr style="display: none"><td></td></tr>
117	<tr id="log-context-<?php echo esc_attr( $log['log_id'] ); ?>" class="log-context">
118	<td colspan="<?php echo esc_attr( $this->get_column_count() ); ?>">
119	<p><strong><?php esc_html_e( 'Additional context', 'woocommerce' ); ?></strong></p>
120	<pre><?php echo esc_html( $log['context'] ); ?></pre>
121	</td>
122	</tr>
123	<?php
124	}
125
126	/**
127	* Get list columns.
128	*
129	* @return array
130	*/
131	public function get_columns() {
132	return array(
133	'cb' => '<input type="checkbox" />',
134	'timestamp' => __( 'Timestamp', 'woocommerce' ),
135	'level' => __( 'Level', 'woocommerce' ),
136	'message' => __( 'Message', 'woocommerce' ),
137	'source' => __( 'Source', 'woocommerce' ),
138	'context' => __( 'Context', 'woocommerce' ),
139	);
140	}
141
142	/**
143	* Column cb.
144	*
145	* @param array $log
146	* @return string
147	*/
148	public function column_cb( $log ) {
149	return sprintf( '<input type="checkbox" name="log[]" value="%1$s" />', esc_attr( $log['log_id'] ) );
150	}
151
152	/**
153	* Timestamp column.
154	*
155	* @param array $log
156	* @return string
157	*/
158	public function column_timestamp( $log ) {
159	return esc_html(
160	mysql2date(
161	'Y-m-d H:i:s',
162	$log['timestamp']
163	)
164	);
165	}
166
167	/**
168	* Level column.
169	*
170	* @param array $log
171	* @return string
172	*/
173	public function column_level( $log ) {
174	$level_key = WC_Log_Levels::get_severity_level( $log['level'] );
175	$levels = WC_Log_Levels::get_all_level_labels();
176
177	if ( ! isset( $levels[ $level_key ] ) ) {
178	return '';
179	}
180
181	$level = $levels[ $level_key ];
182	$level_class = sanitize_html_class( 'log-level--' . $level_key );
183	return '<span class="log-level ' . $level_class . '">' . esc_html( $level ) . '</span>';
184	}
185
186	/**
187	* Message column.
188	*
189	* @param array $log
190	* @return string
191	*/
192	public function column_message( $log ) {
193	return sprintf(
194	'<pre>%s</pre>',
195	esc_html( $log['message'] )
196	);
197	}
198
199	/**
200	* Source column.
201	*
202	* @param array $log
203	* @return string
204	*/
205	public function column_source( $log ) {
206	return esc_html( $log['source'] );
207	}
208
209	/**
210	* Context column.
211	*
212	* @param array $log Log entry data.
213	*
214	* @return string
215	*/
216	public function column_context( $log ) {
217	$content = '';
218
219	if ( ! empty( $log['context'] ) ) {
220	ob_start();
221	?>
222	<button
223	class="log-toggle button button-secondary button-small"
224	data-log-id="<?php echo esc_attr( $log['log_id'] ); ?>"
225	data-toggle-status="off"
226	data-label-show="<?php esc_attr_e( 'Show context', 'woocommerce' ); ?>"
227	data-label-hide="<?php esc_attr_e( 'Hide context', 'woocommerce' ); ?>"
228	>
229	<span class="dashicons dashicons-arrow-down-alt2"></span>
230	<span class="log-toggle-label screen-reader-text"><?php esc_html_e( 'Show context', 'woocommerce' ); ?></span>
231	</button>
232	<?php
233	$content = ob_get_clean();
234	}
235
236	return $content;
237	}
238
239	/**
240	* Get bulk actions.
241	*
242	* @return array
243	*/
244	protected function get_bulk_actions() {
245	return array(
246	'delete' => __( 'Delete', 'woocommerce' ),
247	);
248	}
249
250	/**
251	* Extra controls to be displayed between bulk actions and pagination.
252	*
253	* @param string $which
254	*/
255	protected function extra_tablenav( $which ) {
256	if ( 'top' === $which ) {
257	echo '<div class="alignleft actions">';
258	$this->level_dropdown();
259	$this->source_dropdown();
260	submit_button( __( 'Filter', 'woocommerce' ), '', 'filter-action', false );
261	echo '</div>';
262	}
263	}
264
265	/**
266	* Get a list of sortable columns.
267	*
268	* @return array
269	*/
270	protected function get_sortable_columns() {
271	return array(
272	'timestamp' => array( 'timestamp', true ),
273	'level' => array( 'level', true ),
274	'source' => array( 'source', true ),
275	);
276	}
277
278	/**
279	* Display source dropdown
280	*
281	* @global wpdb $wpdb
282	*/
283	protected function source_dropdown() {
284	$sources = $this->get_sources();
285
286	if ( ! empty( $sources ) ) {
287	$selected_source = isset( $_REQUEST['source'] ) ? $_REQUEST['source'] : '';
288	?>
289	<label for="filter-by-source" class="screen-reader-text"><?php esc_html_e( 'Filter by source', 'woocommerce' ); ?></label>
290	<select name="source" id="filter-by-source">
291	<option<?php selected( $selected_source, '' ); ?> value=""><?php esc_html_e( 'All sources', 'woocommerce' ); ?></option>
292	<?php
293	foreach ( $sources as $s ) {
294	printf(
295	'<option%1$s value="%2$s">%3$s</option>',
296	selected( $selected_source, $s, false ),
297	esc_attr( $s ),
298	esc_html( $s )
299	);
300	}
301	?>
302	</select>
303	<?php
304	}
305	}
306
307	/**
308	* Get the list of unique sources in the log table.
309	*
310	* The query in this method can be slow when there are a high number of log entries. The list of sources also
311	* most likely doesn't change that often. So this indefinitely caches the list into the WP options table. The
312	* cache will get cleared by the log handler if a new source is being added. See WC_Log_Handler_DB::handle().
313	*
314	* @return array
315	*/
316	protected function get_sources() {
317	global $wpdb;
318
319	$sources = get_option( self::SOURCE_CACHE_OPTION_KEY, null );
320	if ( is_array( $sources ) ) {
321	return $sources;
322	}
323
324	$sql = "
325	SELECT DISTINCT source
326	FROM {$wpdb->prefix}woocommerce_log
327	WHERE source != ''
328	ORDER BY source ASC
329	";
330
331	// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Not necessary.
332	$sources = $wpdb->get_col( $sql );
333
334	update_option( self::SOURCE_CACHE_OPTION_KEY, $sources );
335
336	return $sources;
337	}
338
339	/**
340	* Prepare table list items.
341	*
342	* @global wpdb $wpdb
343	*/
344	public function prepare_items() {
345	global $wpdb;
346
347	$this->prepare_column_headers();
348
349	$per_page = $this->get_items_per_page(
350	self::PER_PAGE_USER_OPTION_KEY,
351	$this->get_per_page_default()
352	);
353
354	$where = $this->get_items_query_where();
355	$order = $this->get_items_query_order();
356	$limit = $this->get_items_query_limit();
357	$offset = $this->get_items_query_offset();
358
359	$query_items = "
360	SELECT log_id, timestamp, level, message, source, context
361	FROM {$wpdb->prefix}woocommerce_log
362	{$where} {$order} {$limit} {$offset}
363	";
364
365	// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The query parts are prepared in their respective methods.
366	$this->items = $wpdb->get_results( $query_items, ARRAY_A );
367	$total_items = $this->get_total_items_count();
368
369	$this->set_pagination_args(
370	array(
371	'total_items' => $total_items,
372	'per_page' => $per_page,
373	'total_pages' => ceil( $total_items / $per_page ),
374	)
375	);
376	}
377
378	/**
379	* Get the total count of log entries in the database.
380	*
381	* The query in this method can be slow if there are a large (100k+) rows in the database table, so this
382	* uses a transient to cache the count for 10 minutes if the count is over that threshold.
383	*
384	* @return int
385	*/
386	protected function get_total_items_count() {
387	global $wpdb;
388
389	$where = $this->get_items_query_where();
390	$version = \WC_Cache_Helper::get_transient_version( 'logs-db' );
391	$transient_key = 'wc-log-total-items-count-' . md5( $where );
392	$transient = get_transient( $transient_key );
393	if (
394	false !== $transient
395	&& isset( $transient['value'], $transient['version'] )
396	&& $transient['version'] === $version
397	) {
398	return $transient['value'];
399	}
400
401	$count_query = "
402	SELECT COUNT(*)
403	FROM {$wpdb->prefix}woocommerce_log
404	{$where}
405	";
406
407	// phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- The where clause is prepared in a separate method.
408	$count = intval( $wpdb->get_var( $count_query ) );
409
410	if ( $count > self::ITEM_COUNT_CACHE_THRESHOLD ) {
411	$transient = array(
412	'value' => $count,
413	'version' => \WC_Cache_Helper::get_transient_version( 'logs-db', true ),
414	);
415
416	set_transient( $transient_key, $transient, 10 * MINUTE_IN_SECONDS );
417	} else {
418	delete_transient( $transient_key );
419	}
420
421	return $count;
422	}
423
424	/**
425	* Get prepared LIMIT clause for items query
426	*
427	* @global wpdb $wpdb
428	*
429	* @return string Prepared LIMIT clause for items query.
430	*/
431	protected function get_items_query_limit() {
432	global $wpdb;
433
434	$per_page = $this->get_items_per_page(
435	self::PER_PAGE_USER_OPTION_KEY,
436	$this->get_per_page_default()
437	);
438
439	return $wpdb->prepare( 'LIMIT %d', $per_page );
440	}
441
442	/**
443	* Get prepared OFFSET clause for items query
444	*
445	* @global wpdb $wpdb
446	*
447	* @return string Prepared OFFSET clause for items query.
448	*/
449	protected function get_items_query_offset() {
450	global $wpdb;
451
452	$per_page = $this->get_items_per_page(
453	self::PER_PAGE_USER_OPTION_KEY,
454	$this->get_per_page_default()
455	);
456	$current_page = $this->get_pagenum();
457	if ( 1 < $current_page ) {
458	$offset = $per_page * ( $current_page - 1 );
459	} else {
460	$offset = 0;
461	}
462
463	return $wpdb->prepare( 'OFFSET %d', $offset );
464	}
465
466	/**
467	* Get prepared ORDER BY clause for items query
468	*
469	* @return string Prepared ORDER BY clause for items query.
470	*/
471	protected function get_items_query_order() {
472	$valid_orders = array( 'level', 'source', 'timestamp' );
473	if ( ! empty( $_REQUEST['orderby'] ) && in_array( $_REQUEST['orderby'], $valid_orders ) ) {
474	$by = wc_clean( $_REQUEST['orderby'] );
475	} else {
476	$by = 'log_id';
477	}
478	$by = esc_sql( $by );
479
480	if ( ! empty( $_REQUEST['order'] ) && 'asc' === strtolower( $_REQUEST['order'] ) ) {
481	$order = 'ASC';
482	} else {
483	$order = 'DESC';
484	}
485
486	$orderby = "ORDER BY {$by} {$order}";
487	if ( 'log_id' !== $by ) {
488	$orderby .= ", log_id {$order}";
489	}
490
491	return $orderby;
492	}
493
494	/**
495	* Get prepared WHERE clause for items query
496	*
497	* @global wpdb $wpdb
498	*
499	* @return string Prepared WHERE clause for items query.
500	*/
501	protected function get_items_query_where() {
502	global $wpdb;
503
504	$where_conditions = array();
505	$where_values = array();
506	if ( ! empty( $_REQUEST['level'] ) && WC_Log_Levels::is_valid_level( $_REQUEST['level'] ) ) {
507	$where_conditions[] = 'level >= %d';
508	$where_values[] = WC_Log_Levels::get_level_severity( $_REQUEST['level'] );
509	}
510	if ( ! empty( $_REQUEST['source'] ) ) {
511	$where_conditions[] = 'source = %s';
512	$where_values[] = wc_clean( $_REQUEST['source'] );
513	}
514	if ( ! empty( $_REQUEST['s'] ) ) {
515	$where_conditions[] = 'message like %s';
516	$where_values[] = '%' . $wpdb->esc_like( wc_clean( wp_unslash( $_REQUEST['s'] ) ) ) . '%';
517	}
518
519	if ( empty( $where_conditions ) ) {
520	return '';
521	}
522
523	return $wpdb->prepare( 'WHERE 1 = 1 AND ' . implode( ' AND ', $where_conditions ), $where_values );
524	}
525
526	/**
527	* Set _column_headers property for table list
528	*/
529	protected function prepare_column_headers() {
530	$this->_column_headers = array(
531	$this->get_columns(),
532	array(),
533	$this->get_sortable_columns(),
534	);
535	}
536
537	/**
538	* Helper to get the default value for the per_page arg.
539	*
540	* @return int
541	*/
542	public function get_per_page_default(): int {
543	return 20;
544	}
545	}
546