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

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

jetpack Last commit date

class.jetpack-modules-list-table.php

361 lines

1	<?php
2
3	use Automattic\Jetpack\Assets;
4
5	if ( ! class_exists( 'WP_List_Table' ) ) {
6	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
7	}
8
9	class Jetpack_Modules_List_Table extends WP_List_Table {
10
11	function __construct() {
12	parent::__construct();
13
14	Jetpack::init();
15
16	if ( $this->compat_fields && is_array( $this->compat_fields ) ) {
17	array_push( $this->compat_fields, 'all_items' );
18	}
19
20	/**
21	* Filters the list of modules available to be displayed in the Jetpack Settings screen.
22	*
23	* @since 3.0.0
24	*
25	* @param array $modules Array of Jetpack modules.
26	*/
27	$this->all_items = apply_filters( 'jetpack_modules_list_table_items', Jetpack_Admin::init()->get_modules() );
28	$this->items = $this->all_items;
29	$this->items = $this->filter_displayed_table_items( $this->items );
30	$this->_column_headers = array( $this->get_columns(), array(), array(), 'name' );
31	$modal_info = isset( $_GET['info'] ) ? $_GET['info'] : false;
32
33	wp_register_script(
34	'models.jetpack-modules',
35	Assets::get_file_url_for_environment(
36	'_inc/build/jetpack-modules.models.min.js',
37	'_inc/jetpack-modules.models.js'
38	),
39	array( 'backbone', 'underscore' ),
40	JETPACK__VERSION
41	);
42	wp_register_script(
43	'views.jetpack-modules',
44	Assets::get_file_url_for_environment(
45	'_inc/build/jetpack-modules.views.min.js',
46	'_inc/jetpack-modules.views.js'
47	),
48	array( 'backbone', 'underscore', 'wp-util' ),
49	JETPACK__VERSION
50	);
51	wp_register_script(
52	'jetpack-modules-list-table',
53	Assets::get_file_url_for_environment(
54	'_inc/build/jetpack-modules.min.js',
55	'_inc/jetpack-modules.js'
56	),
57	array(
58	'views.jetpack-modules',
59	'models.jetpack-modules',
60	'jquery',
61	),
62	JETPACK__VERSION,
63	true
64	);
65
66	wp_localize_script(
67	'jetpack-modules-list-table',
68	'jetpackModulesData',
69	array(
70	'modules' => Jetpack::get_translated_modules( $this->all_items ),
71	'i18n' => array(
72	'search_placeholder' => __( 'Search Modules…', 'jetpack' ),
73	),
74	'modalinfo' => $this->module_info_check( $modal_info, $this->all_items ),
75	'nonces' => array(
76	'bulk' => wp_create_nonce( 'bulk-jetpack_page_jetpack_modules' ),
77	),
78	)
79	);
80
81	wp_enqueue_script( 'jetpack-modules-list-table' );
82
83	/**
84	* Filters the js_templates callback value.
85	*
86	* @since 3.6.0
87	*
88	* @param array array( $this, 'js_templates' ) js_templates callback.
89	*/
90	add_action( 'admin_footer', apply_filters( 'jetpack_modules_list_table_js_template_callback', array( $this, 'js_templates' ) ), 9 );
91	}
92
93	function js_templates() {
94	?>
95	<script type="text/html" id="tmpl-Jetpack_Modules_List_Table_Template">
96	<# var i = 0;
97	if ( data.items.length ) {
98	_.each( data.items, function( item, key, list ) {
99	if ( item === undefined ) return; #>
100	<tr class="jetpack-module <# if ( ++i % 2 ) { #> alternate<# } #><# if ( item.activated ) { #> active<# } #><# if ( ! item.available ) { #> unavailable<# } #>" id="{{{ item.module }}}">
101	<th scope="row" class="check-column">
102	<# if ( 'videopress' !== item.module ) { #>
103	<input type="checkbox" name="modules[]" value="{{{ item.module }}}" />
104	<# } #>
105	</th>
106	<td class='name column-name'>
107	<span class='info'><a href="{{{item.learn_more_button}}}" target="blank">{{{ item.name }}}</a></span>
108	<div class="row-actions">
109	<# if ( item.configurable ) { #>
110	<span class='configure'>{{{ item.configurable }}}</span>
111	<# } #>
112	<# if ( item.activated && 'vaultpress' !== item.module && item.available && 'videopress' !== item.module ) { #>
113	<span class='delete'><a href="<?php echo admin_url( 'admin.php' ); ?>?page=jetpack&action=deactivate&module={{{ item.module }}}&_wpnonce={{{ item.deactivate_nonce }}}"><?php _e( 'Deactivate', 'jetpack' ); ?></a></span>
114	<# } else if ( item.available && 'videopress' !== item.module ) { #>
115	<span class='activate'><a href="<?php echo admin_url( 'admin.php' ); ?>?page=jetpack&action=activate&module={{{ item.module }}}&_wpnonce={{{ item.activate_nonce }}}"><?php _e( 'Activate', 'jetpack' ); ?></a></span>
116	<# } #>
117	<# if ( ! item.available ) { #>
118	<span class='unavailable_reason'>{{{ item.unavailable_reason }}}</span>
119	<# } #>
120	</div>
121	</td>
122	</tr>
123	<#
124	});
125	} else {
126	#>
127	<tr class="no-modules-found">
128	<td colspan="2"><?php esc_html_e( 'No Modules Found', 'jetpack' ); ?></td>
129	</tr>
130	<#
131	}
132	#>
133	</script>
134	<?php
135	}
136
137	function get_views() {
138	/** This filter is already documented in class.jetpack-modules-list-table.php */
139	$modules = apply_filters( 'jetpack_modules_list_table_items', Jetpack_Admin::init()->get_modules() );
140	$array_of_module_tags = wp_list_pluck( $modules, 'module_tags' );
141	$module_tags = array_merge( ...array_values( $array_of_module_tags ) );
142	$module_tags_unique = array_count_values( $module_tags );
143	ksort( $module_tags_unique );
144
145	$format = '<a href="%3$s"%4$s data-title="%1$s">%1$s <span class="count">(%2$s)</span></a>';
146	$title = __( 'All', 'jetpack' );
147	$count = count( $modules );
148	$url = esc_url( remove_query_arg( 'module_tag' ) );
149	$current = empty( $_GET['module_tag'] ) ? ' class="current all"' : ' class="all"';
150	$views = array(
151	'all' => sprintf( $format, $title, $count, $url, $current ),
152	);
153	foreach ( $module_tags_unique as $title => $count ) {
154	$key = sanitize_title( $title );
155	$display_title = esc_html( wptexturize( $title ) );
156	$url = esc_url( add_query_arg( 'module_tag', urlencode( $title ) ) );
157	$current = '';
158	if ( ! empty( $_GET['module_tag'] ) && $title == $_GET['module_tag'] ) {
159	$current = ' class="current"';
160	}
161	$views[ $key ] = sprintf( $format, $display_title, $count, $url, $current );
162	}
163	return $views;
164	}
165
166	function views() {
167	$views = $this->get_views();
168
169	echo "<ul class='subsubsub'>\n";
170	foreach ( $views as $class => $view ) {
171	$views[ $class ] = "\t<li class='$class'>$view</li>";
172	}
173	echo implode( "\n", $views ) . "\n";
174	echo '</ul>';
175	}
176
177	function filter_displayed_table_items( $modules ) {
178	return array_filter( $modules, array( $this, 'is_module_displayed' ) );
179	}
180
181	static function is_module_displayed( $module ) {
182	// Handle module tag based filtering.
183	if ( ! empty( $_REQUEST['module_tag'] ) ) {
184	$module_tag = sanitize_text_field( $_REQUEST['module_tag'] );
185	if ( ! in_array( $module_tag, $module['module_tags'] ) ) {
186	return false;
187	}
188	}
189
190	// If nothing rejected it, include it!
191	return true;
192	}
193
194	static function sort_requires_connection_last( $module1, $module2 ) {
195	if ( $module1['requires_connection'] == $module2['requires_connection'] ) {
196	return 0;
197	}
198	if ( $module1['requires_connection'] ) {
199	return 1;
200	}
201	if ( $module2['requires_connection'] ) {
202	return -1;
203	}
204
205	return 0;
206	}
207
208	function get_columns() {
209	$columns = array(
210	'cb' => '<input type="checkbox" />',
211	'name' => __( 'Name', 'jetpack' ),
212	);
213	return $columns;
214	}
215
216	function get_bulk_actions() {
217	$actions = array(
218	'bulk-activate' => __( 'Activate', 'jetpack' ),
219	'bulk-deactivate' => __( 'Deactivate', 'jetpack' ),
220	);
221	return $actions;
222	}
223
224	function single_row( $item ) {
225	static $i = 0;
226	$row_class = ( ++$i % 2 ) ? ' alternate' : '';
227
228	if ( ! empty( $item['activated'] ) ) {
229	$row_class .= ' active';
230	}
231
232	if ( ! Jetpack_Admin::is_module_available( $item ) ) {
233	$row_class .= ' unavailable';
234	}
235
236	echo '<tr class="jetpack-module' . esc_attr( $row_class ) . '" id="' . esc_attr( $item['module'] ) . '">';
237	$this->single_row_columns( $item );
238	echo '</tr>';
239	}
240
241	function get_table_classes() {
242	return array( 'table', 'table-bordered', 'wp-list-table', 'widefat', 'fixed', 'jetpack-modules' );
243	}
244
245	function column_cb( $item ) {
246	if ( ! Jetpack_Admin::is_module_available( $item ) ) {
247	return '';
248	}
249
250	return sprintf( '<input type="checkbox" name="modules[]" value="%s" />', $item['module'] );
251	}
252
253	function column_icon( $item ) {
254	$badge_text = $free_text = '';
255	ob_start();
256	?>
257	<a href="#TB_inline?width=600&height=550&inlineId=more-info-module-settings-modal" class="thickbox">
258	<div class="module-image">
259	<p><span class="module-image-badge"><?php echo $badge_text; ?></span><span class="module-image-free" style="display: none"><?php echo $free_text; ?></span></p>
260	</div>
261	</a>
262	<?php
263	return ob_get_clean();
264
265	}
266
267	function column_name( $item ) {
268	$actions = array(
269	'info' => sprintf( '<a href="%s" target="blank">%s</a>', esc_url( $item['learn_more_button'] ), esc_html__( 'Feature Info', 'jetpack' ) ),
270	);
271
272	if ( ! empty( $item['configurable'] ) ) {
273	$actions['configure'] = $item['configurable'];
274	}
275
276	if ( empty( $item['activated'] ) && Jetpack_Admin::is_module_available( $item ) ) {
277	$url = wp_nonce_url(
278	Jetpack::admin_url(
279	array(
280	'page' => 'jetpack',
281	'action' => 'activate',
282	'module' => $item['module'],
283	)
284	),
285	'jetpack_activate-' . $item['module']
286	);
287	$actions['activate'] = sprintf( '<a href="%s">%s</a>', esc_url( $url ), esc_html__( 'Activate', 'jetpack' ) );
288	} elseif ( ! empty( $item['activated'] ) ) {
289	$url = wp_nonce_url(
290	Jetpack::admin_url(
291	array(
292	'page' => 'jetpack',
293	'action' => 'deactivate',
294	'module' => $item['module'],
295	)
296	),
297	'jetpack_deactivate-' . $item['module']
298	);
299	$actions['delete'] = sprintf( '<a href="%s">%s</a>', esc_url( $url ), esc_html__( 'Deactivate', 'jetpack' ) );
300	}
301
302	return $this->row_actions( $actions ) . wptexturize( $item['name'] );
303	}
304
305	function column_description( $item ) {
306	ob_start();
307	/** This action is documented in class.jetpack-admin.php */
308	echo apply_filters( 'jetpack_short_module_description', $item['description'], $item['module'] );
309	/** This action is documented in class.jetpack-admin.php */
310	do_action( 'jetpack_learn_more_button_' . $item['module'] );
311	echo '<div id="more-info-' . $item['module'] . '" class="more-info">';
312	/** This action is documented in class.jetpack-admin.php */
313	do_action( 'jetpack_module_more_info_' . $item['module'] );
314	echo '</div>';
315	return ob_get_clean();
316	}
317
318	function column_module_tags( $item ) {
319	$module_tags = array();
320	foreach ( $item['module_tags'] as $module_tag ) {
321	$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', urlencode( $module_tag ) ) ) );
322	}
323	return implode( ', ', $module_tags );
324	}
325
326	function column_default( $item, $column_name ) {
327	switch ( $column_name ) {
328	case 'icon':
329	case 'name':
330	case 'description':
331	break;
332	default:
333	return print_r( $item, true );
334	}
335	}
336
337	// Check if the info parameter provided in the URL corresponds to an actual module
338	function module_info_check( $info, $modules ) {
339	if ( false == $info ) {
340	return false;
341	} elseif ( array_key_exists( $info, $modules ) ) {
342	return $info;
343	}
344	}
345
346	/**
347	* Core switched their `display_tablenav()` method to protected, so we can't access it directly.
348	* Instead, let's include an access function to make it doable without errors!
349	*
350	* @see https://github.com/WordPress/WordPress/commit/d28f6344de97616de8ece543ed290c4ba2383622
351	*
352	* @param string $which
353	*
354	* @return mixed
355	*/
356	function unprotected_display_tablenav( $which = 'top' ) {
357	return $this->display_tablenav( $which );
358	}
359
360	}
361