Jetpack_Admin::add_no_store_header() - Code Metrics - Inspection of "Search: add settings and upgrade notice to main da..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/search-at-a-glance ( 7b47fd )

unknown

created 2018-03-20 22:55 UTC

Jetpack_Admin::add_no_store_header() A

↳ Parent: Jetpack_Admin

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	1
dl	0
loc	4
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( $_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();
		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 );

				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;
			}

			$plan = Jetpack::get_active_plan();
			return in_array( $module['module'], $plan['supports'] );
		}
	}

	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, __( '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 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( $_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		foreach ( $available_modules as $module ) {
77		if ( $module_array = Jetpack::get_module( $module ) ) {
78		/**
79		* Filters each module's short description.
80		*
81		* @since 3.0.0
82		*
83		* @param string $module_array['description'] Module description.
84		* @param string $module Module slug.
85		*/
86		$short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
87		// Fix: correct multibyte strings truncate with checking for mbstring extension
88		$short_desc_trunc = ( function_exists( 'mb_strlen' ) )
89		? ( ( mb_strlen( $short_desc ) > 143 )
90		? mb_substr( $short_desc, 0, 140 ) . '...'
91		: $short_desc )
92		: ( ( strlen( $short_desc ) > 143 )
93		? substr( $short_desc, 0, 140 ) . '...'
94		: $short_desc );
95
96		$module_array['module'] = $module;
97		$module_array['activated'] = ( $jetpack_active ? in_array( $module, $active_modules ) : false );
98		$module_array['deactivate_nonce'] = wp_create_nonce( 'jetpack_deactivate-' . $module );
99		$module_array['activate_nonce'] = wp_create_nonce( 'jetpack_activate-' . $module );
100		$module_array['available'] = self::is_module_available( $module_array );
101		$module_array['short_description'] = $short_desc_trunc;
102		$module_array['configure_url'] = Jetpack::module_configuration_url( $module );
103
104		ob_start();
105		/**
106		* Allow the display of a "Learn More" button.
107		* The dynamic part of the action, $module, is the module slug.
108		*
109		* @since 3.0.0
110		*/
111		do_action( 'jetpack_learn_more_button_' . $module );
112		$module_array['learn_more_button'] = ob_get_clean();
113
114		ob_start();
115		/**
116		* Allow the display of information text when Jetpack is connected to WordPress.com.
117		* The dynamic part of the action, $module, is the module slug.
118		*
119		* @since 3.0.0
120		*/
121		do_action( 'jetpack_module_more_info_' . $module );
122
123		/**
124		* Filter the long description of a module.
125		*
126		* @since 3.5.0
127		*
128		* @param string ob_get_clean() The module long description.
129		* @param string $module The module name.
130		*/
131		$module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module );
132
133		ob_start();
134		/**
135		* Filter the search terms for a module
136		*
137		* Search terms are typically added to the module headers, under "Additional Search Queries".
138		*
139		* Use syntax:
140		* function jetpack_$module_search_terms( $terms ) {
141		* $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' );
142		* return $terms;
143		* }
144		* add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
145		*
146		* @since 3.5.0
147		*
148		* @param string The search terms (comma separated).
149		*/
150		echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] );
151		$module_array['search_terms'] = ob_get_clean();
152
153		$module_array['configurable'] = false;
154		if (
155		current_user_can( 'manage_options' ) &&
156		/**
157		* Allow the display of a configuration link in the Jetpack Settings screen.
158		*
159		* @since 3.0.0
160		*
161		* @param string $module Module name.
162		* @param bool false Should the Configure module link be displayed? Default to false.
163		*/
164		apply_filters( 'jetpack_module_configurable_' . $module, false )
165		) {
166		$module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( Jetpack::module_configuration_url( $module ) ), __( 'Configure', 'jetpack' ) );
167		}
168
169		$modules[ $module ] = $module_array;
170		}
171		}
172
173		uasort( $modules, array( $this->jetpack, 'sort_modules' ) );
174
175		if ( ! Jetpack::is_active() ) {
176		uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) );
177		}
178
179		return $modules;
180		}
181
182		static function is_module_available( $module ) {
183		if ( ! is_array( $module ) \|\| empty( $module ) )
184		return false;
185
186		/**
187		* We never want to show VaultPress as activatable through Jetpack.
188		*/
189		if ( 'vaultpress' === $module['module'] ) {
190		return false;
191		}
192
193		if ( Jetpack::is_development_mode() ) {
194		return ! ( $module['requires_connection'] );
195		} else {
196		if ( ! Jetpack::is_active() ) {
197		return false;
198		}
199
200		$plan = Jetpack::get_active_plan();
201		return in_array( $module['module'], $plan['supports'] );
202		}
203		}
204
205		function handle_unrecognized_action( $action ) {
206		switch( $action ) {
207		case 'bulk-activate' :
208		if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
209		break;
210		}
211
212		$modules = (array) $_GET['modules'];
213		$modules = array_map( 'sanitize_key', $modules );
214		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
215		foreach( $modules as $module ) {
216		Jetpack::log( 'activate', $module );
217		Jetpack::activate_module( $module, false );
218		}
219		// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
220		wp_safe_redirect( wp_get_referer() );
221		exit;
		0 ignored issues – show Coding Style Compatibility introduced 2016-12-16 00:07 UTC by Report Bug Copy Issue Report 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...
222	View Code Duplication	case 'bulk-deactivate' :
223		if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
224		break;
225		}
226
227		$modules = (array) $_GET['modules'];
228		$modules = array_map( 'sanitize_key', $modules );
229		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
230		foreach ( $modules as $module ) {
231		Jetpack::log( 'deactivate', $module );
232		Jetpack::deactivate_module( $module );
233		Jetpack::state( 'message', 'module_deactivated' );
234		}
235		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...
236		wp_safe_redirect( wp_get_referer() );
237		exit;
		0 ignored issues – show Coding Style Compatibility introduced 2016-12-16 00:07 UTC by Report Bug Copy Issue Report 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...
238		default:
239		return;
240		}
241		}
242
243		function fix_redirect( $module, $redirect = true ) {
244		if ( ! $redirect ) {
245		return;
246		}
247		if ( wp_get_referer() ) {
248		add_filter( 'wp_redirect', 'wp_get_referer' );
249		}
250		}
251
252		function admin_menu_debugger() {
253		Jetpack_Debugger::disconnect_and_redirect();
254		$debugger_hook = add_submenu_page( null, __( 'Jetpack Debugging Center', 'jetpack' ), '', 'manage_options', 'jetpack-debugger', array( $this, 'debugger_page' ) );
255		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
256		}
257
258		function debugger_page() {
259		nocache_headers();
260		if ( ! current_user_can( 'manage_options' ) ) {
261		die( '-1' );
		0 ignored issues – show Coding Style Compatibility introduced 2015-11-20 23:04 UTC by Report Bug Copy Issue Report The method `debugger_page()` 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...
262		}
263		Jetpack_Debugger::jetpack_debug_display_handler();
264		}
265		}
266		Jetpack_Admin::init();
267

Automattic / jetpack

Push — add/search-at-a-glance ( 7b47fd )

Jetpack_Admin::add_no_store_header() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like