class.jetpack-modules-list-table.php — Jetpack – WP Security, Backup, Speed, & Growth 12.7.3

jetpack / class.jetpack-modules-list-table.php

jetpack Last commit date

class.jetpack-modules-list-table.php

477 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Jetpack modules list table.
4	*
5	* @package automattic/jetpack
6	*/
7
8	use Automattic\Jetpack\Assets;
9
10	if ( ! class_exists( 'WP_List_Table' ) ) {
11	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
12	}
13
14	/**
15	* Jetpack modules list table.
16	*/
17	class Jetpack_Modules_List_Table extends WP_List_Table {
18
19	/** Constructor. */
20	public function __construct() {
21	parent::__construct();
22
23	Jetpack::init();
24
25	if ( $this->compat_fields && is_array( $this->compat_fields ) ) {
26	array_push( $this->compat_fields, 'all_items' );
27	}
28
29	/**
30	* Filters the list of modules available to be displayed in the Jetpack Settings screen.
31	*
32	* @since 3.0.0
33	*
34	* @param array $modules Array of Jetpack modules.
35	*/
36	$this->all_items = apply_filters( 'jetpack_modules_list_table_items', Jetpack_Admin::init()->get_modules() );
37	$this->items = $this->all_items;
38	$this->items = $this->filter_displayed_table_items( $this->items );
39	$this->_column_headers = array( $this->get_columns(), array(), array(), 'name' );
40	// phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Nonce: This is a view, not a model or controller. InputNotSanitized: Sanitized below via `$this->module_info_check()`.
41	$modal_info = isset( $_GET['info'] ) ? wp_unslash( $_GET['info'] ) : false;
42
43	// Adding in a hidden h1 heading for screen-readers.
44	?>
45	<h1 class="screen-reader-text"><?php esc_html_e( 'Jetpack Modules List', 'jetpack' ); ?></h1>
46	<?php
47
48	wp_register_script(
49	'models.jetpack-modules',
50	Assets::get_file_url_for_environment(
51	'_inc/build/jetpack-modules.models.min.js',
52	'_inc/jetpack-modules.models.js'
53	),
54	array( 'jquery', 'backbone', 'underscore' ),
55	JETPACK__VERSION,
56	false // @todo Can this be put in the footer?
57	);
58	wp_register_script(
59	'views.jetpack-modules',
60	Assets::get_file_url_for_environment(
61	'_inc/build/jetpack-modules.views.min.js',
62	'_inc/jetpack-modules.views.js'
63	),
64	array( 'jquery', 'backbone', 'underscore', 'wp-util' ),
65	JETPACK__VERSION,
66	false // @todo Can this be put in the footer?
67	);
68	wp_register_script(
69	'jetpack-modules-list-table',
70	Assets::get_file_url_for_environment(
71	'_inc/build/jetpack-modules.min.js',
72	'_inc/jetpack-modules.js'
73	),
74	array(
75	'views.jetpack-modules',
76	'models.jetpack-modules',
77	'jquery',
78	),
79	JETPACK__VERSION,
80	true
81	);
82
83	wp_localize_script(
84	'jetpack-modules-list-table',
85	'jetpackModulesData',
86	array(
87	'modules' => Jetpack::get_translated_modules( $this->all_items ),
88	'i18n' => array(
89	'search_placeholder' => __( 'Search modules…', 'jetpack' ),
90	),
91	'modalinfo' => $this->module_info_check( $modal_info, $this->all_items ),
92	'nonces' => array(
93	'bulk' => wp_create_nonce( 'bulk-jetpack_page_jetpack_modules' ),
94	),
95	)
96	);
97
98	wp_enqueue_script( 'jetpack-modules-list-table' );
99
100	/**
101	* Filters the js_templates callback value.
102	*
103	* @since 3.6.0
104	*
105	* @param array array( $this, 'js_templates' ) js_templates callback.
106	*/
107	add_action( 'admin_footer', apply_filters( 'jetpack_modules_list_table_js_template_callback', array( $this, 'js_templates' ) ), 9 );
108	}
109
110	/**
111	* Output row template.
112	*/
113	public function js_templates() {
114	?>
115	<script type="text/html" id="tmpl-Jetpack_Modules_List_Table_Template">
116	<# var i = 0;
117	if ( data.items.length ) {
118	_.each( data.items, function( item, key, list ) {
119	if ( item === undefined ) return;
120	if ( 'lazy-images' == item.module && ! item.activated ) return; #>
121	<tr class="jetpack-module <# if ( ++i % 2 ) { #> alternate<# } #><# if ( item.activated ) { #> active<# } #><# if ( ! item.available ) { #> unavailable<# } #>" id="{{{ item.module }}}">
122	<th scope="row" class="check-column">
123	<input type="checkbox" name="modules[]" value="{{{ item.module }}}" {{{ item.disabled }}} />
124	</th>
125	<td class='name column-name'>
126	<p class='info'><a href="{{{item.learn_more_button}}}" target="blank" style="text-decoration: none;">{{{ item.name }}}</a></p>
127	<div class="row-actions">
128	<# if ( item.configurable ) { #>
129	<span class='configure'>{{{ item.configurable }}}</span>
130	<# } #>
131	<# if ( item.activated && 'vaultpress' !== item.module && item.available ) { #>
132	<span class='delete'><a class="dops-button is-compact" href="<?php echo esc_url( admin_url( 'admin.php' ) ); ?>?page=jetpack&action=deactivate&module={{{ item.module }}}&_wpnonce={{{ item.deactivate_nonce }}}"><?php esc_html_e( 'Deactivate', 'jetpack' ); ?></a></span>
133	<# } else if ( item.available ) { #>
134	<span class='activate'><a class="dops-button is-compact" href="<?php echo esc_url( admin_url( 'admin.php' ) ); ?>?page=jetpack&action=activate&module={{{ item.module }}}&_wpnonce={{{ item.activate_nonce }}}"><?php esc_html_e( 'Activate', 'jetpack' ); ?></a></span>
135	<# } #>
136	<# if ( ! item.available ) { #>
137	<p class='unavailable_reason'>{{{ item.unavailable_reason }}}</p>
138	<# } #>
139	</div>
140	</td>
141	</tr>
142	<#
143	});
144	} else {
145	#>
146	<tr class="no-modules-found">
147	<td colspan="2"><?php esc_html_e( 'No Modules Found', 'jetpack' ); ?></td>
148	</tr>
149	<#
150	}
151	#>
152	</script>
153	<?php
154	}
155
156	/**
157	* Get views data.
158	*
159	* @return array Maps identifier to display HTML.
160	*/
161	public function get_views() {
162	/** This filter is already documented in class.jetpack-modules-list-table.php */
163	$modules = apply_filters( 'jetpack_modules_list_table_items', Jetpack_Admin::init()->get_modules() );
164	$array_of_module_tags = wp_list_pluck( $modules, 'module_tags' );
165	$module_tags = array_merge( ...array_values( $array_of_module_tags ) );
166	$module_tags = array_map( 'jetpack_get_module_i18n_tag', $module_tags );
167	$module_tags_unique = array_count_values( $module_tags );
168	ksort( $module_tags_unique );
169
170	$format = '<a href="%3$s" %4$s data-title="%1$s">%1$s</a> <span class="count">(%2$s)</span>';
171	$title = __( 'All', 'jetpack' );
172	$count = is_countable( $modules ) ? count( $modules ) : 0;
173	$url = esc_url( remove_query_arg( 'module_tag' ) );
174	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller.
175	$views = array(
176	'all' => sprintf( $format, $title, $count, $url, 'class="all"' ),
177	);
178	foreach ( $module_tags_unique as $title => $count ) {
179	$key = sanitize_title( $title );
180	$display_title = esc_html( wptexturize( $title ) );
181	$url = esc_url( add_query_arg( 'module_tag', rawurlencode( $title ) ) );
182	$views[ $key ] = sprintf( $format, $display_title, $count, $url, '' );
183	}
184	return $views;
185	}
186
187	/**
188	* Output views HTML.
189	*/
190	public function views() {
191	$views = $this->get_views();
192
193	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller.
194	$module_tag = empty( $_GET['module_tag'] ) ? 'all' : sanitize_title( wp_unslash( $_GET['module_tag'] ) );
195
196	echo "<ul class='subsubsub'>\n";
197	foreach ( $views as $class => $view ) {
198	$class_name = $class;
199	if ( $class === $module_tag ) {
200	$class_name .= ' current';
201	}
202
203	$views[ $class ] = "\t<li class='$class_name'>$view</li>";
204	}
205	echo implode( "\n", $views ) . "\n"; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Is HTML. Escaping happens in get_views().
206	echo '</ul>';
207	}
208
209	/**
210	* Filter a modules array for displayed items.
211	*
212	* @param array $modules Modules.
213	* @return array Displayed modules.
214	*/
215	public function filter_displayed_table_items( $modules ) {
216	return array_filter( $modules, array( $this, 'is_module_displayed' ) );
217	}
218
219	/**
220	* Determine if a module is displayed.
221	*
222	* @param array $module Module data.
223	* @return bool
224	*/
225	public static function is_module_displayed( $module ) {
226	// Handle module tag based filtering.
227	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller.
228	if ( ! empty( $_REQUEST['module_tag'] ) ) {
229	// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- This is a view, not a model or controller.
230	$module_tag = sanitize_text_field( wp_unslash( $_REQUEST['module_tag'] ) );
231	if ( ! in_array( $module_tag, array_map( 'jetpack_get_module_i18n_tag', $module['module_tags'] ), true ) ) {
232	return false;
233	}
234	}
235
236	// If nothing rejected it, include it!
237	return true;
238	}
239
240	/**
241	* Sort callback to put modules with `requires_connection` last.
242	*
243	* @param array $module1 Module data.
244	* @param array $module2 Module data.
245	* @return int Indicating the relative ordering of module1 and module2.
246	*/
247	public static function sort_requires_connection_last( $module1, $module2 ) {
248	if ( (bool) $module1['requires_connection'] === (bool) $module2['requires_connection'] ) {
249	return 0;
250	}
251	if ( $module1['requires_connection'] ) {
252	return 1;
253	}
254	if ( $module2['requires_connection'] ) {
255	return -1;
256	}
257
258	return 0;
259	}
260
261	/**
262	* Get table columns.
263	*
264	* @return string[] Column name to header HTML.
265	*/
266	public function get_columns() {
267	$columns = array(
268	'cb' => '<input type="checkbox" />',
269	'name' => __( 'Name', 'jetpack' ),
270	);
271	return $columns;
272	}
273
274	/**
275	* Get bulk actions for the table.
276	*
277	* @return string[] Actions, code => text.
278	*/
279	public function get_bulk_actions() {
280	$actions = array(
281	'bulk-activate' => __( 'Activate', 'jetpack' ),
282	'bulk-deactivate' => __( 'Deactivate', 'jetpack' ),
283	);
284	return $actions;
285	}
286
287	/**
288	* Print a single row of the table.
289	*
290	* @param object\|array $item Item.
291	*/
292	public function single_row( $item ) {
293	static $i = 0;
294	$row_class = ( ( ++$i ) % 2 ) ? ' alternate' : '';
295
296	if ( ! empty( $item['activated'] ) ) {
297	$row_class .= ' active';
298	}
299
300	if ( ! Jetpack_Admin::is_module_available( $item ) ) {
301	$row_class .= ' unavailable';
302	}
303
304	echo '<tr class="jetpack-module' . esc_attr( $row_class ) . '" id="' . esc_attr( $item['module'] ) . '">';
305	$this->single_row_columns( $item );
306	echo '</tr>';
307	}
308
309	/**
310	* Table classes.
311	*
312	* @return string[] HTML.
313	*/
314	public function get_table_classes() {
315	return array( 'table', 'table-bordered', 'wp-list-table', 'widefat', 'fixed' );
316	}
317
318	/**
319	* Column checkbox.
320	*
321	* @param object\|array $item Item.
322	* @return string HTML.
323	*/
324	public function column_cb( $item ) {
325	if ( ! Jetpack_Admin::is_module_available( $item ) ) {
326	return '';
327	}
328
329	return sprintf( '<input type="checkbox" name="modules[]" value="%s" />', $item['module'] );
330	}
331
332	/**
333	* Column icon.
334	*
335	* @return string HTML.
336	*/
337	public function column_icon() {
338	$badge_text = '';
339	$free_text = '';
340	ob_start();
341	?>
342	<a href="#TB_inline?width=600&height=550&inlineId=more-info-module-settings-modal" class="thickbox">
343	<div class="module-image">
344	<p><span class="module-image-badge"><?php echo esc_html( $badge_text ); ?></span><span class="module-image-free" style="display: none"><?php echo esc_html( $free_text ); ?></span></p>
345	</div>
346	</a>
347	<?php
348	return ob_get_clean();
349	}
350
351	/**
352	* Column name.
353	*
354	* @param object\|array $item Item.
355	* @return string HTML.
356	*/
357	public function column_name( $item ) {
358	$actions = array(
359	'info' => sprintf( '<a href="%s" target="blank">%s</a>', esc_url( $item['learn_more_button'] ), esc_html__( 'Feature Info', 'jetpack' ) ),
360	);
361
362	if ( ! empty( $item['configurable'] ) ) {
363	$actions['configure'] = $item['configurable'];
364	}
365
366	if ( empty( $item['activated'] ) && Jetpack_Admin::is_module_available( $item ) ) {
367	$url = wp_nonce_url(
368	Jetpack::admin_url(
369	array(
370	'page' => 'jetpack',
371	'action' => 'activate',
372	'module' => $item['module'],
373	)
374	),
375	'jetpack_activate-' . $item['module']
376	);
377	$actions['activate'] = sprintf( '<a href="%s">%s</a>', esc_url( $url ), esc_html__( 'Activate', 'jetpack' ) );
378	} elseif ( ! empty( $item['activated'] ) ) {
379	$url = wp_nonce_url(
380	Jetpack::admin_url(
381	array(
382	'page' => 'jetpack',
383	'action' => 'deactivate',
384	'module' => $item['module'],
385	)
386	),
387	'jetpack_deactivate-' . $item['module']
388	);
389	$actions['delete'] = sprintf( '<a href="%s">%s</a>', esc_url( $url ), esc_html__( 'Deactivate', 'jetpack' ) );
390	}
391
392	return $this->row_actions( $actions ) . wptexturize( $item['name'] );
393	}
394
395	/**
396	* Column description.
397	*
398	* @param object\|array $item Item.
399	* @return string HTML.
400	*/
401	public function column_description( $item ) {
402	ob_start();
403	// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
404	/** This action is documented in class.jetpack-admin.php */
405	echo apply_filters( 'jetpack_short_module_description', $item['description'], $item['module'] );
406	/** This action is documented in class.jetpack-admin.php */
407	do_action( 'jetpack_learn_more_button_' . $item['module'] );
408	echo '<div id="more-info-' . $item['module'] . '" class="more-info">';
409	/** This action is documented in class.jetpack-admin.php */
410	do_action( 'jetpack_module_more_info_' . $item['module'] );
411	echo '</div>';
412	// phpcs:enable WordPress.Security.EscapeOutput.OutputNotEscaped
413	return ob_get_clean();
414	}
415
416	/**
417	* Return module tags HTML.
418	*
419	* @param object\|array $item Item.
420	* @return string HTML.
421	*/
422	public function column_module_tags( $item ) {
423	$module_tags = array();
424	foreach ( array_map( 'jetpack_get_module_i18n_tag', $item['module_tags'] ) as $module_tag ) {
425	$module_tags[] = sprintf( '<a href="%3$s" data-title="%2$s">%1$s</a>', esc_html( $module_tag ), esc_attr( $module_tag ), esc_url( add_query_arg( 'module_tag', rawurlencode( $module_tag ) ) ) );
426	}
427	return implode( ', ', $module_tags );
428	}
429
430	/**
431	* Column default value.
432	*
433	* @param object\|array $item Item.
434	* @param string $column_name Column name.
435	* @return string
436	*/
437	public function column_default( $item, $column_name ) {
438	switch ( $column_name ) {
439	case 'icon':
440	case 'name':
441	case 'description':
442	return '';
443	default:
444	// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r
445	return print_r( $item, true );
446	}
447	}
448
449	/**
450	* Check if the info parameter provided in the URL corresponds to an actual module.
451	*
452	* @param string\|false $info Info parameter.
453	* @param array $modules Modules array.
454	* @return string\|false
455	*/
456	public function module_info_check( $info, $modules ) {
457	if ( ! $info ) {
458	return false;
459	} elseif ( array_key_exists( $info, $modules ) ) {
460	return $info;
461	}
462	}
463
464	/**
465	* Core switched their `display_tablenav()` method to protected, so we can't access it directly.
466	* Instead, let's include an access function to make it doable without errors!
467	*
468	* @see https://github.com/WordPress/WordPress/commit/d28f6344de97616de8ece543ed290c4ba2383622
469	*
470	* @param string $which Which nav table to display.
471	* @return mixed
472	*/
473	public function unprotected_display_tablenav( $which = 'top' ) {
474	return $this->display_tablenav( $which );
475	}
476	}
477