Completed
Push — revert-5405-update/module-plac... ( 39c88e...712e0c )
by
unknown
21:19 queued 12:30
created

Jetpack_Modules_List_Table::views()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 10
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 2
eloc 7
nc 2
nop 0
dl 0
loc 10
rs 9.4285
c 0
b 0
f 0
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' => Jetpack::get_translated_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
		) );
66
67
		wp_enqueue_script( 'jetpack-modules-list-table' );
68
69
		/**
70
		 * Filters the js_templates callback value.
71
		 *
72
		 * @since 3.6.0
73
		 *
74
		 * @param array array( $this, 'js_templates' ) js_templates callback.
75
		 */
76
		add_action( 'admin_footer', apply_filters( 'jetpack_modules_list_table_js_template_callback', array( $this, 'js_templates' ) ), 9 );
77
	}
78
79
	function js_templates() {
80
		?>
81
		<script type="text/html" id="tmpl-Jetpack_Modules_List_Table_Template">
82
			<# var i = 0;
83
			if ( data.items.length ) {
84
			_.each( data.items, function( item, key, list ) {
85
				if ( item === undefined ) return; #>
86
				<tr class="jetpack-module <# if ( ++i % 2 ) { #> alternate<# } #><# if ( item.activated ) { #> active<# } #><# if ( ! item.available ) { #> unavailable<# } #>" id="{{{ item.module }}}">
87
					<th scope="row" class="check-column">
88
						<input type="checkbox" name="modules[]" value="{{{ item.module }}}" />
89
					</th>
90
					<td class='name column-name'>
91
						<span class='info'><a href="{{{item.learn_more_button}}}" target="blank">{{{ item.name }}}</a></span>
92
						<div class="row-actions">
93
						<# if ( item.configurable ) { #>
94
							<span class='configure'>{{{ item.configurable }}}</span>
95
						<# } #>
96
						<# if ( item.activated && 'vaultpress' !== item.module && item.available ) { #>
97
							<span class='delete'><a href="<?php echo admin_url( 'admin.php' ); ?>?page=jetpack&#038;action=deactivate&#038;module={{{ item.module }}}&#038;_wpnonce={{{ item.deactivate_nonce }}}"><?php _e( 'Deactivate', 'jetpack' ); ?></a></span>
98
						<# } else if ( item.available ) { #>
99
							<span class='activate'><a href="<?php echo admin_url( 'admin.php' ); ?>?page=jetpack&#038;action=activate&#038;module={{{ item.module }}}&#038;_wpnonce={{{ item.activate_nonce }}}"><?php _e( 'Activate', 'jetpack' ); ?></a></span>
100
						<# } #>
101
						</div>
102
					</td>
103
				</tr>
104
				<#
105
			});
106
			} else {
107
				#>
108
				<tr class="no-modules-found">
109
					<td colspan="2"><?php esc_html_e( 'No Modules Found' , 'jetpack' ); ?></td>
110
				</tr>
111
				<#
112
			}
113
			#>
114
		</script>
115
		<?php
116
	}
117
118
	function get_views() {
119
		$modules              = Jetpack_Admin::init()->get_modules();
120
		$array_of_module_tags = wp_list_pluck( $modules, 'module_tags' );
121
		$module_tags          = call_user_func_array( 'array_merge', $array_of_module_tags );
122
		$module_tags_unique   = array_count_values( $module_tags );
123
		ksort( $module_tags_unique );
124
125
		$format  = '<a href="%3$s"%4$s data-title="%1$s">%1$s <span class="count">(%2$s)</span></a>';
126
		$title   = __( 'All', 'jetpack' );
127
		$count   = count( $modules );
128
		$url     = esc_url( remove_query_arg( 'module_tag' ) );
129
		$current = empty( $_GET['module_tag'] ) ? ' class="current all"' : ' class="all"';
130
		$views   = array(
131
			'all' => sprintf( $format, $title, $count, $url, $current ),
132
		);
133
		foreach ( $module_tags_unique as $title => $count ) {
134
			if ( 'Jumpstart' == $title ) {
135
				continue;
136
			}
137
			$key           = sanitize_title( $title );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 11 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
138
			if ( 'centralized-management' === $key && Jetpack::is_module_active( 'manage' ) ) {
139
				continue;
140
			}
141
			$display_title = esc_html( wptexturize( $title ) );
142
			$url           = esc_url( add_query_arg( 'module_tag', urlencode( $title ) ) );
143
			$current       = '';
144
			if ( ! empty( $_GET['module_tag'] ) && $title == $_GET['module_tag'] )
145
				$current   = ' class="current"';
146
			$views[ $key ] = sprintf( $format, $display_title, $count, $url, $current );
147
		}
148
		return $views;
149
	}
150
151
	function views() {
152
		$views = $this->get_views();
153
154
		echo "<ul class='subsubsub'>\n";
155
		foreach ( $views as $class => $view ) {
156
			$views[ $class ] = "\t<li class='$class'>$view</li>";
157
		}
158
		echo implode( "\n", $views ) . "\n";
159
		echo "</ul>";
160
	}
161
162
	function filter_displayed_table_items( $modules ) {
163
		return array_filter( $modules, array( $this, 'is_module_displayed' ) );
164
	}
165
166
	static function is_module_available( $module ) {
167
		if ( ! is_array( $module ) || empty( $module ) )
168
			return false;
169
170
		if ( Jetpack::is_development_mode() ) {
171
			return ! ( $module['requires_connection'] );
172
		} else {
173
			return Jetpack::is_active();
174
		}
175
	}
176
177
	static function is_module_displayed( $module ) {
178
		// Handle module tag based filtering.
179
		if ( ! empty( $_REQUEST['module_tag'] ) ) {
180
			$module_tag = sanitize_text_field( $_REQUEST['module_tag'] );
181
			if ( ! in_array( $module_tag, $module['module_tags'] ) )
182
				return false;
183
		}
184
185
		// If nothing rejected it, include it!
186
		return true;
187
	}
188
189 View Code Duplication
	static function sort_requires_connection_last( $module1, $module2 ) {
190
		if ( $module1['requires_connection'] == $module2['requires_connection'] )
191
			return 0;
192
		if ( $module1['requires_connection'] )
193
			return 1;
194
		if ( $module2['requires_connection'] )
195
			return -1;
196
197
		return 0;
198
	}
199
200
	function get_columns() {
201
		$columns = array(
202
			'cb'          => '<input type="checkbox" />',
203
			'name'        => __( 'Name', 'jetpack' ),
204
		);
205
		return $columns;
206
	}
207
208
	function get_bulk_actions() {
209
		$actions = array(
210
			'bulk-activate'   => __( 'Activate',   'jetpack' ),
211
			'bulk-deactivate' => __( 'Deactivate', 'jetpack' ),
212
		);
213
		return $actions;
214
	}
215
216
	function single_row( $item ) {
217
		static $i = 0;
218
		$row_class = ( ++$i % 2 ) ? ' alternate' : '';
219
220
		if ( ! empty( $item['activated'] )  )
221
			$row_class .= ' active';
222
223
		if ( ! $this->is_module_available( $item ) )
224
			$row_class .= ' unavailable';
225
226
		echo '<tr class="jetpack-module' . esc_attr( $row_class ) . '" id="' . esc_attr( $item['module'] ) . '">';
227
		$this->single_row_columns( $item );
228
		echo '</tr>';
229
	}
230
231
	function get_table_classes() {
232
		return array( 'table', 'table-bordered', 'wp-list-table', 'widefat', 'fixed', 'jetpack-modules' );
233
	}
234
235
	function column_cb( $item ) {
236
		if ( ! $this->is_module_available( $item ) )
237
			return '';
238
239
		return sprintf( '<input type="checkbox" name="modules[]" value="%s" />', $item['module'] );
240
	}
241
242
	function column_icon( $item ) {
243
		$badge_text = $free_text = '';
244
		ob_start();
245
		?>
246
		<a href="#TB_inline?width=600&height=550&inlineId=more-info-module-settings-modal" class="thickbox">
247
			<div class="module-image">
248
				<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>
249
			</div>
250
		</a>
251
		<?php
252
		return ob_get_clean();
253
254
	}
255
256
	function column_name( $item ) {
257
		$actions = array(
258
			'info' => sprintf( '<a href="%s" target="blank">%s</a>', esc_url( $item['learn_more_button'] ), esc_html__( 'Feature Info', 'jetpack' ) ),
259
		);
260
261
		if ( ! empty( $item['configurable'] ) ) {
262
			$actions['configure'] = $item['configurable'];
263
		}
264
265
		if ( empty( $item['activated'] ) && $this->is_module_available( $item ) ) {
266
			$url = wp_nonce_url(
267
				Jetpack::admin_url( array(
268
					'page'   => 'jetpack',
269
					'action' => 'activate',
270
					'module' => $item['module'],
271
				) ),
272
				'jetpack_activate-' . $item['module']
273
			);
274
			$actions['activate'] = sprintf( '<a href="%s">%s</a>', esc_url( $url ), esc_html__( 'Activate', 'jetpack' ) );
275
		} elseif ( ! empty( $item['activated'] ) ) {
276
			$url = wp_nonce_url(
277
				Jetpack::admin_url( array(
278
					'page'   => 'jetpack',
279
					'action' => 'deactivate',
280
					'module' => $item['module'],
281
				) ),
282
				'jetpack_deactivate-' . $item['module']
283
			);
284
			$actions['delete'] = sprintf( '<a href="%s">%s</a>', esc_url( $url ), esc_html__( 'Deactivate', 'jetpack' ) );
285
		}
286
287
		return $this->row_actions( $actions ) . wptexturize( $item['name'] );
288
	}
289
290
	function column_description( $item ) {
291
		ob_start();
292
		/** This action is documented in class.jetpack-admin.php */
293
		echo apply_filters( 'jetpack_short_module_description', $item['description'], $item['module'] );
294
		/** This action is documented in class.jetpack-admin.php */
295
		do_action( 'jetpack_learn_more_button_' . $item['module'] );
296
		echo '<div id="more-info-' . $item['module'] . '" class="more-info">';
297
		/** This action is documented in class.jetpack-admin.php */
298
		do_action( 'jetpack_module_more_info_' . $item['module'] );
299
		echo '</div>';
300
		return ob_get_clean();
301
	}
302
303
	function column_module_tags( $item ) {
304
		$module_tags = array();
305
		foreach( $item['module_tags'] as $module_tag ) {
306
			$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 ) ) ) );
307
		}
308
		return implode( ', ', $module_tags );
309
	}
310
311
	function column_default( $item, $column_name ) {
312
		switch ( $column_name ) {
313
			case 'icon':
314
			case 'name':
315
			case 'description':
316
				break;
317
			default:
318
				return print_r( $item, true );
319
		}
320
	}
321
322
	//Check if the info parameter provided in the URL corresponds to an actual module
323
	function module_info_check( $info = false, $modules ) {
0 ignored issues
show
Coding Style introduced by
Parameters which have default values should be placed at the end.

If you place a parameter with a default value before a parameter with a default value, the default value of the first parameter will never be used as it will always need to be passed anyway:

// $a must always be passed; it's default value is never used.
function someFunction($a = 5, $b) { }
Loading history...
324
		if ( false == $info ) {
0 ignored issues
show
Coding Style Best Practice introduced by
It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

When comparing two booleans, it is generally considered safer to use the strict comparison operator.

Loading history...
325
			return false;
326
		} else if ( array_key_exists( $info, $modules ) ) {
327
			return $info;
328
		}
329
	}
330
331
	/**
332
	 * Core switched their `display_tablenav()` method to protected, so we can't access it directly.
333
	 * Instead, let's include an access function to make it doable without errors!
334
	 *
335
	 * @see https://github.com/WordPress/WordPress/commit/d28f6344de97616de8ece543ed290c4ba2383622
336
	 *
337
	 * @param string $which
338
	 *
339
	 * @return mixed
340
	 */
341
	function unprotected_display_tablenav( $which = 'top' ) {
342
		return $this->display_tablenav( $which );
343
	}
344
345
}
346