Completed
Push — deprecate/woocommerce-analytic... ( 9287d9 )
by Jeremy
16:10 queued 07:14
created

Jetpack_Admin   A

Complexity

Total Complexity 41

Size/Duplication

Total Lines 275
Duplicated Lines 9.82 %

Coupling/Cohesion

Components 1
Dependencies 9

Importance

Changes 0
Metric Value
dl 27
loc 275
rs 9.1199
c 0
b 0
f 0
wmc 41
lcom 1
cbo 9

11 Methods

Rating   Name   Duplication   Size   Complexity  
A sort_requires_connection_last() 11 11 4
C get_modules() 0 113 11
B is_module_available() 0 22 6
B handle_unrecognized_action() 16 37 7
A fix_redirect() 0 8 3
A init() 0 10 4
A add_no_store_header() 0 4 1
A __construct() 0 26 1
A admin_menu_debugger() 0 13 1
A wrap_debugger_page() 0 7 2
A debugger_page() 0 4 1

How to fix   Duplicated Code    Complexity   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Jetpack_Admin often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Jetpack_Admin, and based on these observations, apply Extract Interface, too.

1
<?php
2
3
use Automattic\Jetpack\Status;
4
5
// Build the Jetpack admin menu as a whole
6
class Jetpack_Admin {
7
8
	/**
9
	 * @var Jetpack_Admin
10
	 **/
11
	private static $instance = null;
12
13
	static function init() {
14
		if ( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) {
15
			add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
16
		}
17
18
		if ( is_null( self::$instance ) ) {
19
			self::$instance = new Jetpack_Admin();
20
		}
21
		return self::$instance;
22
	}
23
24
	static function add_no_store_header( $headers ) {
25
		$headers['Cache-Control'] .= ', no-store';
26
		return $headers;
27
	}
28
29
	private function __construct() {
30
		jetpack_require_lib( 'admin-pages/class.jetpack-react-page' );
31
		$this->jetpack_react = new Jetpack_React_Page();
0 ignored issues
show
Bug introduced by
The property jetpack_react does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
32
33
		jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' );
34
		$this->fallback_page = new Jetpack_Settings_Page();
0 ignored issues
show
Bug introduced by
The property fallback_page does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
35
36
		jetpack_require_lib( 'admin-pages/class-jetpack-about-page' );
37
		$this->jetpack_about = new Jetpack_About_Page();
0 ignored issues
show
Bug introduced by
The property jetpack_about does not exist. Did you maybe forget to declare it?

In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code:

class MyClass { }

$x = new MyClass();
$x->foo = true;

Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion:

class MyClass {
    public $foo;
}

$x = new MyClass();
$x->foo = true;
Loading history...
38
39
		add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 );
40
		add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 );
41
		add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) );
42
		add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_set_up_sub_nav_item' ) );
43
		add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_settings_sub_nav_item' ) );
44
		add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) );
45
		add_action( 'jetpack_admin_menu', array( $this->fallback_page, 'add_actions' ) );
46
		add_action( 'jetpack_admin_menu', array( $this->jetpack_about, 'add_actions' ) );
47
48
		// Add redirect to current page for activation/deactivation of modules
49
		add_action( 'jetpack_pre_activate_module', array( $this, 'fix_redirect' ), 10, 2 );
50
		add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ) );
51
52
		// Add module bulk actions handler
53
		add_action( 'jetpack_unrecognized_action', array( $this, 'handle_unrecognized_action' ) );
54
	}
55
56 View Code Duplication
	static function sort_requires_connection_last( $module1, $module2 ) {
57
		if ( $module1['requires_connection'] == $module2['requires_connection'] ) {
58
			return 0;
59
		} elseif ( $module1['requires_connection'] ) {
60
			return 1;
61
		} elseif ( $module2['requires_connection'] ) {
62
			return -1;
63
		}
64
65
		return 0;
66
	}
67
68
	// Produce JS understandable objects of modules containing information for
69
	// presentation like description, name, configuration url, etc.
70
	function get_modules() {
71
		include_once JETPACK__PLUGIN_DIR . 'modules/module-info.php';
72
		$available_modules = Jetpack::get_available_modules();
73
		$active_modules    = Jetpack::get_active_modules();
74
		$modules           = array();
75
		$jetpack_active    = Jetpack::is_active() || ( new Status() )->is_development_mode();
76
		$overrides         = Jetpack_Modules_Overrides::instance();
77
		foreach ( $available_modules as $module ) {
78
			if ( $module_array = Jetpack::get_module( $module ) ) {
79
				/**
80
				 * Filters each module's short description.
81
				 *
82
				 * @since 3.0.0
83
				 *
84
				 * @param string $module_array['description'] Module description.
85
				 * @param string $module Module slug.
86
				 */
87
				$short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $module.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
88
				// Fix: correct multibyte strings truncate with checking for mbstring extension
89
				$short_desc_trunc = ( function_exists( 'mb_strlen' ) )
90
							? ( ( mb_strlen( $short_desc ) > 143 )
91
								? mb_substr( $short_desc, 0, 140 ) . '...'
92
								: $short_desc )
93
							: ( ( strlen( $short_desc ) > 143 )
94
								? substr( $short_desc, 0, 140 ) . '...'
95
								: $short_desc );
96
97
				$module_array['module']            = $module;
98
				$module_array['activated']         = ( $jetpack_active ? in_array( $module, $active_modules ) : false );
99
				$module_array['deactivate_nonce']  = wp_create_nonce( 'jetpack_deactivate-' . $module );
100
				$module_array['activate_nonce']    = wp_create_nonce( 'jetpack_activate-' . $module );
101
				$module_array['available']         = self::is_module_available( $module_array );
102
				$module_array['short_description'] = $short_desc_trunc;
103
				$module_array['configure_url']     = Jetpack::module_configuration_url( $module );
104
				$module_array['override']          = $overrides->get_module_override( $module );
105
106
				ob_start();
107
				/**
108
				 * Allow the display of a "Learn More" button.
109
				 * The dynamic part of the action, $module, is the module slug.
110
				 *
111
				 * @since 3.0.0
112
				 */
113
				do_action( 'jetpack_learn_more_button_' . $module );
114
				$module_array['learn_more_button'] = ob_get_clean();
115
116
				ob_start();
117
				/**
118
				 * Allow the display of information text when Jetpack is connected to WordPress.com.
119
				 * The dynamic part of the action, $module, is the module slug.
120
				 *
121
				 * @since 3.0.0
122
				 */
123
				do_action( 'jetpack_module_more_info_' . $module );
124
125
				/**
126
				* Filter the long description of a module.
127
				*
128
				* @since 3.5.0
129
				*
130
				* @param string ob_get_clean() The module long description.
131
				* @param string $module The module name.
132
				*/
133
				$module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $module.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
134
135
				ob_start();
136
				/**
137
				 * Filter the search terms for a module
138
				 *
139
				 * Search terms are typically added to the module headers, under "Additional Search Queries".
140
				 *
141
				 * Use syntax:
142
				 * function jetpack_$module_search_terms( $terms ) {
143
				 *  $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' );
144
				 *  return $terms;
145
				 * }
146
				 * add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
147
				 *
148
				 * @since 3.5.0
149
				 *
150
				 * @param string The search terms (comma separated).
151
				 */
152
				echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] );
153
				$module_array['search_terms'] = ob_get_clean();
154
155
				$module_array['configurable'] = false;
156
				if (
157
					current_user_can( 'manage_options' ) &&
158
					/**
159
					 * Allow the display of a configuration link in the Jetpack Settings screen.
160
					 *
161
					 * @since 3.0.0
162
					 *
163
					 * @param string $module Module name.
164
					 * @param bool false Should the Configure module link be displayed? Default to false.
165
					 */
166
					apply_filters( 'jetpack_module_configurable_' . $module, false )
167
				) {
168
					$module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $module_array['configure_url'] ), __( 'Configure', 'jetpack' ) );
169
				}
170
171
				$modules[ $module ] = $module_array;
172
			}
173
		}
174
175
		uasort( $modules, array( 'Jetpack', 'sort_modules' ) );
176
177
		if ( ! Jetpack::is_active() ) {
178
			uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) );
179
		}
180
181
		return $modules;
182
	}
183
184
	static function is_module_available( $module ) {
185
		if ( ! is_array( $module ) || empty( $module ) ) {
186
			return false;
187
		}
188
189
		/**
190
		 * We never want to show VaultPress as activatable through Jetpack.
191
		 */
192
		if ( 'vaultpress' === $module['module'] ) {
193
			return false;
194
		}
195
196
		if ( ( new Status() )->is_development_mode() ) {
197
			return ! ( $module['requires_connection'] );
198
		} else {
199
			if ( ! Jetpack::is_active() ) {
200
				return false;
201
			}
202
203
			return Jetpack_Plan::supports( $module['module'] );
204
		}
205
	}
206
207
	function handle_unrecognized_action( $action ) {
208
		switch ( $action ) {
209
			case 'bulk-activate':
210
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
211
					break;
212
				}
213
214
				$modules = (array) $_GET['modules'];
215
				$modules = array_map( 'sanitize_key', $modules );
216
				check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
217
				foreach ( $modules as $module ) {
218
					Jetpack::log( 'activate', $module );
219
					Jetpack::activate_module( $module, false );
220
				}
221
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
222
				wp_safe_redirect( wp_get_referer() );
223
				exit;
224 View Code Duplication
			case 'bulk-deactivate':
225
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
226
					break;
227
				}
228
229
				$modules = (array) $_GET['modules'];
230
				$modules = array_map( 'sanitize_key', $modules );
231
				check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
232
				foreach ( $modules as $module ) {
233
					Jetpack::log( 'deactivate', $module );
234
					Jetpack::deactivate_module( $module );
235
					Jetpack::state( 'message', 'module_deactivated' );
236
				}
237
				Jetpack::state( 'module', $modules );
0 ignored issues
show
Documentation introduced by
$modules is of type array, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
238
				wp_safe_redirect( wp_get_referer() );
239
				exit;
240
			default:
241
				return;
242
		}
243
	}
244
245
	function fix_redirect( $module, $redirect = true ) {
246
		if ( ! $redirect ) {
247
			return;
248
		}
249
		if ( wp_get_referer() ) {
250
			add_filter( 'wp_redirect', 'wp_get_referer' );
251
		}
252
	}
253
254
	function admin_menu_debugger() {
255
		jetpack_require_lib( 'debugger' );
256
		Jetpack_Debugger::disconnect_and_redirect();
257
		$debugger_hook = add_submenu_page(
258
			null,
259
			__( 'Debugging Center', 'jetpack' ),
260
			'',
261
			'manage_options',
262
			'jetpack-debugger',
263
			array( $this, 'wrap_debugger_page' )
264
		);
265
		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
266
	}
267
268
	function wrap_debugger_page() {
269
		nocache_headers();
270
		if ( ! current_user_can( 'manage_options' ) ) {
271
			die( '-1' );
272
		}
273
		Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) );
274
	}
275
276
	function debugger_page() {
277
		jetpack_require_lib( 'debugger' );
278
		Jetpack_Debugger::jetpack_debug_display_handler();
279
	}
280
}
281
Jetpack_Admin::init();
282