Jetpack_Admin::wrap_debugger_page() - Code Metrics - Inspection of "changelog: add #10190" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/changelog-66 ( 3dd88f...f645f6 )

by Jeremy

created 2018-09-24 12:48 UTC

Jetpack_Admin::wrap_debugger_page() A

↳ Parent: Jetpack_Admin

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	7
rs	10
c	0
b	0
f	0

<?php


// Build the Jetpack admin menu as a whole
class Jetpack_Admin {

	/**
	 * @var Jetpack_Admin
	 **/
	private static $instance = null;

	/**
	 * @var Jetpack
	 **/
	private $jetpack;

	static function init() {
		if( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) {
			add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
		}

		if ( is_null( self::$instance ) ) {
			self::$instance = new Jetpack_Admin;
		}
		return self::$instance;
	}

	static function add_no_store_header( $headers ) {
		$headers['Cache-Control'] .= ', no-store';
		return $headers;
	}

	private function __construct() {
		$this->jetpack = Jetpack::init();

		jetpack_require_lib( 'admin-pages/class.jetpack-react-page' );
		$this->jetpack_react = new Jetpack_React_Page;


		jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' );
		$this->fallback_page = new Jetpack_Settings_Page;
class MyClass { }

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

		add_action( 'admin_menu',                    array( $this->jetpack_react, 'add_actions' ), 998 );

		add_action( 'jetpack_admin_menu',            array( $this->jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) );

		add_action( 'jetpack_admin_menu',            array( $this->jetpack_react, 'jetpack_add_settings_sub_nav_item' ) );

		add_action( 'jetpack_admin_menu',            array( $this, 'admin_menu_debugger' ) );
		add_action( 'jetpack_admin_menu',            array( $this->fallback_page, 'add_actions' ) );

		// Add redirect to current page for activation/deactivation of modules
		add_action( 'jetpack_pre_activate_module',   array( $this, 'fix_redirect' ), 10, 2 );
		add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ) );

		// Add module bulk actions handler
		add_action( 'jetpack_unrecognized_action',   array( $this, 'handle_unrecognized_action' ) );
	}

	static function sort_requires_connection_last( $module1, $module2 ) {
		if ( $module1['requires_connection'] == $module2['requires_connection'] ) {
			return 0;
		} elseif ( $module1['requires_connection'] ) {
			return 1;
		} elseif ( $module2['requires_connection'] ) {
			return -1;
		}

		return 0;
	}

	// Produce JS understandable objects of modules containing information for
	// presentation like description, name, configuration url, etc.
	function get_modules() {
		include_once( JETPACK__PLUGIN_DIR . 'modules/module-info.php' );
		$available_modules = Jetpack::get_available_modules();
		$active_modules    = Jetpack::get_active_modules();
		$modules           = array();
		$jetpack_active = Jetpack::is_active() || Jetpack::is_development_mode();
		$overrides = Jetpack_Modules_Overrides::instance();
		foreach ( $available_modules as $module ) {
			if ( $module_array = Jetpack::get_module( $module ) ) {
				/**
				 * Filters each module's short description.
				 *
				 * @since 3.0.0
				 *
				 * @param string $module_array['description'] Module description.
				 * @param string $module Module slug.
				 */
				$short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
				// Fix: correct multibyte strings truncate with checking for mbstring extension
				$short_desc_trunc = ( function_exists( 'mb_strlen' ) )
							? ( ( mb_strlen( $short_desc ) > 143 )
								? mb_substr( $short_desc, 0, 140 ) . '...'
								: $short_desc )
							: ( ( strlen( $short_desc ) > 143 )
								? substr( $short_desc, 0, 140 ) . '...'
								: $short_desc );

				$module_array['module']            = $module;
				$module_array['activated']         = ( $jetpack_active ? in_array( $module, $active_modules ) : false );
				$module_array['deactivate_nonce']  = wp_create_nonce( 'jetpack_deactivate-' . $module );
				$module_array['activate_nonce']    = wp_create_nonce( 'jetpack_activate-' . $module );
				$module_array['available']         = self::is_module_available( $module_array );
				$module_array['short_description'] = $short_desc_trunc;
				$module_array['configure_url']     = Jetpack::module_configuration_url( $module );
				$module_array['override']          = $overrides->get_module_override( $module );

				ob_start();
				/**
				 * Allow the display of a "Learn More" button.
				 * The dynamic part of the action, $module, is the module slug.
				 *
				 * @since 3.0.0
				 */
				do_action( 'jetpack_learn_more_button_' . $module );
				$module_array['learn_more_button'] = ob_get_clean();

				ob_start();
				/**
				 * Allow the display of information text when Jetpack is connected to WordPress.com.
				 * The dynamic part of the action, $module, is the module slug.
				 *
				 * @since 3.0.0
				 */
				do_action( 'jetpack_module_more_info_' . $module );

				/**
				* Filter the long description of a module.
	 			*
	 			* @since 3.5.0
	 			*
	 			* @param string ob_get_clean() The module long description.
				* @param string $module The module name.
	 			*/
				$module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module );

				ob_start();
				/**
				 * Filter the search terms for a module
				 *
				 * Search terms are typically added to the module headers, under "Additional Search Queries".
				 *
				 * Use syntax:
				 * function jetpack_$module_search_terms( $terms ) {
				 *  $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' );
				 *  return $terms;
				 * }
				 * add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
				 *
				 * @since 3.5.0
				 *
				 * @param string The search terms (comma separated).
				 */
				echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] );
				$module_array['search_terms'] = ob_get_clean();

				$module_array['configurable'] = false;
				if (
					current_user_can( 'manage_options' ) &&
					/**
					 * Allow the display of a configuration link in the Jetpack Settings screen.
					 *
					 * @since 3.0.0
					 *
					 * @param string $module Module name.
					 * @param bool false Should the Configure module link be displayed? Default to false.
					 */
					apply_filters( 'jetpack_module_configurable_' . $module, false )
				) {
					$module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( Jetpack::module_configuration_url( $module ) ), __( 'Configure', 'jetpack' ) );
				}

				$modules[ $module ] = $module_array;
			}
		}

		uasort( $modules, array( $this->jetpack, 'sort_modules' ) );

		if ( ! Jetpack::is_active() ) {
			uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) );
		}

		return $modules;
	}

	static function is_module_available( $module ) {
		if ( ! is_array( $module ) || empty( $module ) )
			return false;

		/**
		 * We never want to show VaultPress as activatable through Jetpack.
		 */
		if ( 'vaultpress' === $module['module'] ) {
			return false;
		}

		if ( Jetpack::is_development_mode() ) {
			return ! ( $module['requires_connection'] );
		} else {
			if ( ! Jetpack::is_active() ) {
				return false;
			}

			return Jetpack::active_plan_supports( $module['module'] );
		}
	}

	function handle_unrecognized_action( $action ) {
		switch( $action ) {
			case 'bulk-activate' :
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
					break;
				}

				$modules = (array) $_GET['modules'];
				$modules = array_map( 'sanitize_key', $modules );
				check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
				foreach( $modules as $module ) {
					Jetpack::log( 'activate', $module );
					Jetpack::activate_module( $module, false );
				}
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
				wp_safe_redirect( wp_get_referer() );
				exit;
			case 'bulk-deactivate' :
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
					break;
				}

				$modules = (array) $_GET['modules'];
				$modules = array_map( 'sanitize_key', $modules );
				check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
				foreach ( $modules as $module ) {
					Jetpack::log( 'deactivate', $module );
					Jetpack::deactivate_module( $module );
					Jetpack::state( 'message', 'module_deactivated' );
				}
				Jetpack::state( 'module', $modules );
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
				wp_safe_redirect( wp_get_referer() );
				exit;
			default:
				return;
		}
	}

	function fix_redirect( $module, $redirect = true ) {
		if ( ! $redirect ) {
			return;
		}
		if ( wp_get_referer() ) {
			add_filter( 'wp_redirect', 'wp_get_referer' );
		}
	}

	function admin_menu_debugger() {
		Jetpack_Debugger::disconnect_and_redirect();
		$debugger_hook = add_submenu_page(
			null,
			__( 'Debugging Center', 'jetpack' ),
			'',
			'manage_options',
			'jetpack-debugger',
			array( $this, 'wrap_debugger_page' )
		);
		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
	}

	function wrap_debugger_page( ) {
		nocache_headers();
		if ( ! current_user_can( 'manage_options' ) ) {
			die( '-1' );
		}
		Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) );
	}

	function debugger_page() {
		Jetpack_Debugger::jetpack_debug_display_handler();
	}
}
Jetpack_Admin::init();


1		<?php
2
3
4		// Build the Jetpack admin menu as a whole
5		class Jetpack_Admin {
6
7		/**
8		* @var Jetpack_Admin
9		**/
10		private static $instance = null;
11
12		/**
13		* @var Jetpack
14		**/
15		private $jetpack;
16
17		static function init() {
18		if( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) {
19		add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
20		}
21
22		if ( is_null( self::$instance ) ) {
23		self::$instance = new Jetpack_Admin;
24		}
25		return self::$instance;
26		}
27
28		static function add_no_store_header( $headers ) {
29		$headers['Cache-Control'] .= ', no-store';
30		return $headers;
31		}
32
33		private function __construct() {
34		$this->jetpack = Jetpack::init();
35
36		jetpack_require_lib( 'admin-pages/class.jetpack-react-page' );
37		$this->jetpack_react = new Jetpack_React_Page;
		0 ignored issues – show Bug introduced 2017-04-18 21:07 UTC by Report Bug Copy Issue Report The property `jetpack_react` does not seem to exist. Did you mean `jetpack`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
38
39		jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' );
40		$this->fallback_page = new Jetpack_Settings_Page;
		0 ignored issues – show Bug introduced 2016-06-08 14:30 UTC by Report Bug Copy Issue Report 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...
41
42		add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 );
		0 ignored issues – show Bug introduced 2016-03-04 20:01 UTC by Report Bug Copy Issue Report The property `jetpack_react` does not seem to exist. Did you mean `jetpack`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
43		add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) );
		0 ignored issues – show Bug introduced 2016-06-24 10:13 UTC by Report Bug Copy Issue Report The property `jetpack_react` does not seem to exist. Did you mean `jetpack`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
44		add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_settings_sub_nav_item' ) );
		0 ignored issues – show Bug introduced 2016-06-24 10:13 UTC by Report Bug Copy Issue Report The property `jetpack_react` does not seem to exist. Did you mean `jetpack`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
45		add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) );
46		add_action( 'jetpack_admin_menu', array( $this->fallback_page, '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() \|\| Jetpack::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 );
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 );
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( Jetpack::module_configuration_url( $module ) ), __( 'Configure', 'jetpack' ) );
169		}
170
171		$modules[ $module ] = $module_array;
172		}
173		}
174
175		uasort( $modules, array( $this->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		* We never want to show VaultPress as activatable through Jetpack.
190		*/
191		if ( 'vaultpress' === $module['module'] ) {
192		return false;
193		}
194
195		if ( Jetpack::is_development_mode() ) {
196		return ! ( $module['requires_connection'] );
197		} else {
198		if ( ! Jetpack::is_active() ) {
199		return false;
200		}
201
202		return Jetpack::active_plan_supports( $module['module'] );
203		}
204		}
205
206		function handle_unrecognized_action( $action ) {
207		switch( $action ) {
208		case 'bulk-activate' :
209		if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
210		break;
211		}
212
213		$modules = (array) $_GET['modules'];
214		$modules = array_map( 'sanitize_key', $modules );
215		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
216		foreach( $modules as $module ) {
217		Jetpack::log( 'activate', $module );
218		Jetpack::activate_module( $module, false );
219		}
220		// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
221		wp_safe_redirect( wp_get_referer() );
222		exit;
223	View Code Duplication	case 'bulk-deactivate' :
224		if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
225		break;
226		}
227
228		$modules = (array) $_GET['modules'];
229		$modules = array_map( 'sanitize_key', $modules );
230		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
231		foreach ( $modules as $module ) {
232		Jetpack::log( 'deactivate', $module );
233		Jetpack::deactivate_module( $module );
234		Jetpack::state( 'message', 'module_deactivated' );
235		}
236		Jetpack::state( 'module', $modules );
		0 ignored issues – show Documentation introduced 2016-01-30 16:25 UTC by Report Bug Copy Issue Report `$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...
237		wp_safe_redirect( wp_get_referer() );
238		exit;
239		default:
240		return;
241		}
242		}
243
244		function fix_redirect( $module, $redirect = true ) {
245		if ( ! $redirect ) {
246		return;
247		}
248		if ( wp_get_referer() ) {
249		add_filter( 'wp_redirect', 'wp_get_referer' );
250		}
251		}
252
253		function admin_menu_debugger() {
254		Jetpack_Debugger::disconnect_and_redirect();
255		$debugger_hook = add_submenu_page(
256		null,
257		__( 'Debugging Center', 'jetpack' ),
258		'',
259		'manage_options',
260		'jetpack-debugger',
261		array( $this, 'wrap_debugger_page' )
262		);
263		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
264		}
265
266		function wrap_debugger_page( ) {
267		nocache_headers();
268		if ( ! current_user_can( 'manage_options' ) ) {
269		die( '-1' );
270		}
271		Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) );
272		}
273
274		function debugger_page() {
275		Jetpack_Debugger::jetpack_debug_display_handler();
276		}
277		}
278		Jetpack_Admin::init();
279

Automattic / jetpack

Push — add/changelog-66 ( 3dd88f...f645f6 )

Jetpack_Admin::wrap_debugger_page() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like