Issues in class.jetpack-admin.php - Fixed Issues - Inspection of "More UI clean up" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/sync-action ( 8b3b6b...1094d7 )

unknown

created 2016-05-05 10:52 UTC

class.jetpack-admin.php (2 issues)

Labels

Severity

Major 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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 ( is_null( self::$instance ) ) {
			self::$instance = new Jetpack_Admin;
		}
		return self::$instance;
	}

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

		jetpack_require_lib( 'admin-pages/class.jetpack-landing-page' );
		$this->landing_page = new Jetpack_Landing_Page;

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

		jetpack_require_lib( 'admin-pages/class.jetpack-my-jetpack-page' );
		$this->my_jetpack_page = new Jetpack_My_Jetpack_Page;

		if ( isset( $_POST['jetpack-set-master-user'] ) ) {
			add_action( 'init', array( $this->my_jetpack_page, 'jetpack_my_jetpack_change_user' ) );
		}

		Jetpack_Sync_Dashboard::init();

		// Add hooks for admin menus
		add_action( 'admin_menu',                    array( $this->landing_page, 'add_actions' ), 998 );
		add_action( 'jetpack_admin_menu',            array( $this, 'admin_menu_debugger' ) );
		add_action( 'jetpack_admin_menu',            array( $this->settings_page, 'add_actions' ) );
		add_action( 'jetpack_admin_menu',            array( $this->my_jetpack_page, 'add_actions' ) );
		add_action( 'jetpack_admin_menu',            array( $this, 'admin_menu_sync' ) );


		// 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 = $this->jetpack->get_available_modules();
		$active_modules    = $this->jetpack->get_active_modules();
		$modules           = array();
		$jetpack_active = Jetpack::is_active() || Jetpack::is_development_mode();
		foreach ( $available_modules as $module ) {
			if ( $module_array = $this->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 );

				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 {
			return Jetpack::is_active();
		}
	}

	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 );
				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() {
		$debugger_hook = add_submenu_page( null, __( 'Jetpack Debugging Center', 'jetpack' ), '', 'manage_options', 'jetpack-debugger', array( $this, 'debugger_page' ) );
		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
	}

	function admin_menu_sync() {
		$sync_hook = add_submenu_page( null, __( 'Jetpack Sync Status', 'jetpack' ), '', 'manage_options', 'jetpack-sync', array( 'Jetpack_Sync_Dashboard', 'dashboard_ui' ) );
		add_action( "admin_head-$sync_hook", array( 'Jetpack_Sync_Dashboard', 'jetpack_sync_admin_head' ) );
	}

	function debugger_page() {
		nocache_headers();
		if ( ! current_user_can( 'manage_options' ) ) {
			die( '-1' );
		}
		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 ( is_null( self::$instance ) ) {
19		self::$instance = new Jetpack_Admin;
20		}
21		return self::$instance;
22		}
23
24		private function __construct() {
25		$this->jetpack = Jetpack::init();
26
27		jetpack_require_lib( 'admin-pages/class.jetpack-landing-page' );
28		$this->landing_page = new Jetpack_Landing_Page;
29
30		jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' );
31		$this->settings_page = new Jetpack_Settings_Page;
32
33		jetpack_require_lib( 'admin-pages/class.jetpack-my-jetpack-page' );
34		$this->my_jetpack_page = new Jetpack_My_Jetpack_Page;
35
36		if ( isset( $_POST['jetpack-set-master-user'] ) ) {
37		add_action( 'init', array( $this->my_jetpack_page, 'jetpack_my_jetpack_change_user' ) );
38		}
39
40		Jetpack_Sync_Dashboard::init();
41
42		// Add hooks for admin menus
43		add_action( 'admin_menu', array( $this->landing_page, 'add_actions' ), 998 );
44		add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) );
45		add_action( 'jetpack_admin_menu', array( $this->settings_page, 'add_actions' ) );
46		add_action( 'jetpack_admin_menu', array( $this->my_jetpack_page, 'add_actions' ) );
47		add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_sync' ) );
48
49
50		// Add redirect to current page for activation/deactivation of modules
51		add_action( 'jetpack_pre_activate_module', array( $this, 'fix_redirect' ), 10, 2 );
52		add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ) );
53
54		// Add module bulk actions handler
55		add_action( 'jetpack_unrecognized_action', array( $this, 'handle_unrecognized_action' ) );
56		}
57
58	View Code Duplication	static function sort_requires_connection_last( $module1, $module2 ) {
59		if ( $module1['requires_connection'] == $module2['requires_connection'] ) {
60		return 0;
61		} elseif ( $module1['requires_connection'] ) {
62		return 1;
63		} elseif ( $module2['requires_connection'] ) {
64		return -1;
65		}
66
67		return 0;
68		}
69
70		// Produce JS understandable objects of modules containing information for
71		// presentation like description, name, configuration url, etc.
72		function get_modules() {
73		include_once( JETPACK__PLUGIN_DIR . 'modules/module-info.php' );
74		$available_modules = $this->jetpack->get_available_modules();
75		$active_modules = $this->jetpack->get_active_modules();
76		$modules = array();
77		$jetpack_active = Jetpack::is_active() \|\| Jetpack::is_development_mode();
78		foreach ( $available_modules as $module ) {
79		if ( $module_array = $this->jetpack->get_module( $module ) ) {
80		/**
81		* Filters each module's short description.
82		*
83		* @since 3.0.0
84		*
85		* @param string $module_array['description'] Module description.
86		* @param string $module Module slug.
87		*/
88		$short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
89		// Fix: correct multibyte strings truncate with checking for mbstring extension
90		$short_desc_trunc = ( function_exists( 'mb_strlen' ) )
91		? ( ( mb_strlen( $short_desc ) > 143 )
92		? mb_substr( $short_desc, 0, 140 ) . '...'
93		: $short_desc )
94		: ( ( strlen( $short_desc ) > 143 )
95		? substr( $short_desc, 0, 140 ) . '...'
96		: $short_desc );
97
98		$module_array['module'] = $module;
99		$module_array['activated'] = ( $jetpack_active ? in_array( $module, $active_modules ) : false );
100		$module_array['deactivate_nonce'] = wp_create_nonce( 'jetpack_deactivate-' . $module );
101		$module_array['activate_nonce'] = wp_create_nonce( 'jetpack_activate-' . $module );
102		$module_array['available'] = self::is_module_available( $module_array );
103		$module_array['short_description'] = $short_desc_trunc;
104		$module_array['configure_url'] = Jetpack::module_configuration_url( $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		return Jetpack::is_active();
199		}
200		}
201
202		function handle_unrecognized_action( $action ) {
203		switch( $action ) {
204		case 'bulk-activate' :
205		if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
206		break;
207		}
208
209		$modules = (array) $_GET['modules'];
210		$modules = array_map( 'sanitize_key', $modules );
211		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
212		foreach( $modules as $module ) {
213		Jetpack::log( 'activate', $module );
214		Jetpack::activate_module( $module, false );
215		}
216		// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
217		wp_safe_redirect( wp_get_referer() );
218		exit;
		0 ignored issues – show Coding Style Compatibility introduced 2016-04-21 06:38 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `handle_unrecognized_action()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
219	View Code Duplication	case 'bulk-deactivate' :
220		if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
221		break;
222		}
223
224		$modules = (array) $_GET['modules'];
225		$modules = array_map( 'sanitize_key', $modules );
226		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
227		foreach ( $modules as $module ) {
228		Jetpack::log( 'deactivate', $module );
229		Jetpack::deactivate_module( $module );
230		Jetpack::state( 'message', 'module_deactivated' );
231		}
232		Jetpack::state( 'module', $modules );
233		wp_safe_redirect( wp_get_referer() );
234		exit;
		0 ignored issues – show Coding Style Compatibility introduced 2016-04-21 06:38 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `handle_unrecognized_action()` contains an exit expression. An exit expression should only be used in rare cases. For example, if you write a short command line script. In most cases however, using an `exit` expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage. Loading history...
235		default:
236		return;
237		}
238		}
239
240		function fix_redirect( $module, $redirect = true ) {
241		if ( ! $redirect ) {
242		return;
243		}
244		if ( wp_get_referer() ) {
245		add_filter( 'wp_redirect', 'wp_get_referer' );
246		}
247		}
248
249		function admin_menu_debugger() {
250		$debugger_hook = add_submenu_page( null, __( 'Jetpack Debugging Center', 'jetpack' ), '', 'manage_options', 'jetpack-debugger', array( $this, 'debugger_page' ) );
251		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
252		}
253
254		function admin_menu_sync() {
255		$sync_hook = add_submenu_page( null, __( 'Jetpack Sync Status', 'jetpack' ), '', 'manage_options', 'jetpack-sync', array( 'Jetpack_Sync_Dashboard', 'dashboard_ui' ) );
256		add_action( "admin_head-$sync_hook", array( 'Jetpack_Sync_Dashboard', 'jetpack_sync_admin_head' ) );
257		}
258
259		function debugger_page() {
260		nocache_headers();
261		if ( ! current_user_can( 'manage_options' ) ) {
262		die( '-1' );
263		}
264		Jetpack_Debugger::jetpack_debug_display_handler();
265		}
266		}
267		Jetpack_Admin::init();
268

Automattic / jetpack

Push — add/sync-action ( 8b3b6b...1094d7 )

class.jetpack-admin.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like