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

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

jetpack Last commit date

class.jetpack-modules-list-table.php

363 lines

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