Jetpack_Admin::is_module_available() - Code Metrics - Inspection of "Jetpack Modules: Add explanation when a module is..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/add_unavailable_reason_... ( c4afdd )

unknown

created 2021-04-22 13:13 UTC

Jetpack_Admin::is_module_available() C

↳ Parent: Jetpack_Admin

Complexity

Conditions	12
Paths	8

Size

Total Lines

Duplication

Lines	9
Ratio	17.31 %

Importance

Changes

Metric	Value
cc	12
nc	8
nop	1
dl	9
loc	52
rs	6.9666
c	0
b	0
f	0

How to fix Long Method Complexity

<?php

use Automattic\Jetpack\Status;
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;

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

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

	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() {
		jetpack_require_lib( 'admin-pages/class.jetpack-react-page' );
		$this->jetpack_react = new Jetpack_React_Page();
class MyClass { }

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

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

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

		jetpack_require_lib( 'admin-pages/class-jetpack-about-page' );
		$this->jetpack_about = new Jetpack_About_Page();
class MyClass { }

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

		add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 );
		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_action( 'jetpack_admin_menu', array( $this->jetpack_about, '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' ) );

		if ( class_exists( 'Akismet_Admin' ) ) {
			// If the site has Jetpack Anti-Spam, change the Akismet menu label accordingly.
			$site_products      = Jetpack_Plan::get_products();
			$anti_spam_products = array( 'jetpack_anti_spam_monthly', 'jetpack_anti_spam' );
			if ( ! empty( array_intersect( $anti_spam_products, array_column( $site_products, 'product_slug' ) ) ) ) {
				// Prevent Akismet from adding a menu item.
				add_action(
					'admin_menu',
					function () {
						remove_action( 'admin_menu', array( 'Akismet_Admin', 'admin_menu' ), 5 );
					},
					4
				);

				// Add an Anti-spam menu item for Jetpack.
				add_action(
					'jetpack_admin_menu',
					function () {
						add_submenu_page( 'jetpack', __( 'Anti-Spam', 'jetpack' ), __( 'Anti-Spam', 'jetpack' ), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
					}
				);
				add_action( 'admin_enqueue_scripts', array( $this, 'akismet_logo_replacement_styles' ) );
			}
		}

		add_filter( 'jetpack_display_jitms_on_screen', array( $this, 'should_display_jitms_on_screen' ), 10, 2 );
	}

	/**
	 * Generate styles to replace Akismet logo for the Jetpack logo. It's a workaround until we create a proper settings page for
	 * Jetpack Anti-Spam. Without this, we would have to change the logo from Akismet codebase and we want to avoid that.
	 */
	public function akismet_logo_replacement_styles() {
		$logo            = new Jetpack_Logo();
		$logo_base64     = base64_encode( $logo->get_jp_emblem_larger() );
		$logo_base64_url = "data:image/svg+xml;base64,{$logo_base64}";
		$style           = ".akismet-masthead__logo-container { background: url({$logo_base64_url}) no-repeat .25rem; height: 1.8125rem; } .akismet-masthead__logo { display: none; }";
		wp_add_inline_style( 'admin-bar', $style );
	}

	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_connection_ready() || ( new Status() )->is_offline_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;

				$is_available = self::is_module_available( $module_array );

				$module_array['activated']          = ( $jetpack_active ? in_array( $module, $active_modules, true ) : false );
				$module_array['deactivate_nonce']   = wp_create_nonce( 'jetpack_deactivate-' . $module );
				$module_array['activate_nonce']     = wp_create_nonce( 'jetpack_activate-' . $module );
				$module_array['available']          = $is_available;
				$module_array['unavailable_reason'] = $is_available ? '' : self::get_module_unavailable_reason( $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( $module_array['configure_url'] ), __( 'Configure', 'jetpack' ) );
				}

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

		uasort( $modules, array( 'Jetpack', 'sort_modules' ) );

		if ( ! Jetpack::is_connection_ready() ) {
			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;
		}

		/*
		 * WooCommerce Analytics should only be available
		 * when running WooCommerce 3+
		 */
		if (
			'woocommerce-analytics' === $module['module']
			&& (
				! class_exists( 'WooCommerce' )
				|| version_compare( WC_VERSION, '3.0', '<' )
			)
		) {
			return false;
		}

		/*
		 * In Offline mode, modules that require a site or user
		 * level connection should be unavailable.
		 */
		if ( ( new Status() )->is_offline_mode() ) {
			return ! ( $module['requires_connection'] || $module['requires_user_connection'] );
		}

		/*
		 * Jetpack not connected.
		 */
		if ( ! Jetpack::is_connection_ready() ) {
			return false;
		}

		/*
		 * Jetpack connected at a site level only. Make sure to make
		 * modules that require a user connection unavailable.
		 */
		if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
			return false;
		}

		return Jetpack_Plan::supports( $module['module'] );

	}

	/**
	 * Returns why a module is unavailable.
	 *
	 * @param  array $module The module.
	 * @return string|false A string stating why the module is not available or false if the module is available.
	 */
	public static function get_module_unavailable_reason( $module ) {
		if ( ! is_array( $module ) || empty( $module ) ) {
			return false;
		}

		if ( self::is_module_available( $module ) ) {
			return false;
		}

		/*
		 * Jetpack not connected.
		 */
		if ( ! Jetpack::is_connection_ready() ) {
			return 'Jetpack is not connected';
		}

		/*
		 * In Offline mode, modules that require a site or user
		 * level connection should be unavailable.
		 */
		if ( ( new Status() )->is_offline_mode() ) {
			if ( $module['requires_connection'] || $module['requires_user_connection'] ) {
				return 'Offline mode';
			}
		}

		/*
		 * Jetpack connected at a site level only and module requires a user connection.
		 */
		if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
			return 'Requires a connected WordPress.com account';
		}

		/*
		 * WooCommerce Analytics should only be available
		 * when running WooCommerce 3+
		 */
		if (
			'woocommerce-analytics' === $module['module']
			&& (
					! class_exists( 'WooCommerce' )
					|| version_compare( WC_VERSION, '3.0', '<' )
				)
			) {
			return 'Requires WooCommerce 3+ plugin';
		}

		/*
		 * Plan restrictions.
		 */
		if ( ! Jetpack_Plan::supports( $module['module'] ) ) {
			return 'Not supported by current plan';
		}

		return '';
	}

	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_require_lib( '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_require_lib( 'debugger' );
		Jetpack_Debugger::jetpack_debug_display_handler();
	}

	/**
	 * Determines if JITMs should display on a particular screen.
	 *
	 * @param bool   $value The default value of the filter.
	 * @param string $screen_id The ID of the screen being tested for JITM display.
	 *
	 * @return bool True if JITMs should display, false otherwise.
	 */
	public function should_display_jitms_on_screen( $value, $screen_id ) {
		// Disable all JITMs on these pages.
		if (
		in_array(
			$screen_id,
			array(
				'jetpack_page_akismet-key-config',
				'admin_page_jetpack_modules',
			),
			true
		) ) {
			return false;
		}

		// Disable all JITMs on pages where the recommendations banner is displaying.
		if (
			in_array(
				$screen_id,
				array(
					'dashboard',
					'plugins',
					'jetpack_page_stats',
				),
				true
			)
			&& \Jetpack_Recommendations_Banner::can_be_displayed()
		) {
			return false;
		}

		return $value;
	}
}
Jetpack_Admin::init();


1		<?php
2
3		use Automattic\Jetpack\Status;
4		use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
5
6		// Build the Jetpack admin menu as a whole
7		class Jetpack_Admin {
8
9		/**
10		* @var Jetpack_Admin
11		**/
12		private static $instance = null;
13
14		static function init() {
15		if ( isset( $_GET['page'] ) && $_GET['page'] === 'jetpack' ) {
16		add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
17		}
18
19		if ( is_null( self::$instance ) ) {
20		self::$instance = new Jetpack_Admin();
21		}
22		return self::$instance;
23		}
24
25		static function add_no_store_header( $headers ) {
26		$headers['Cache-Control'] .= ', no-store';
27		return $headers;
28		}
29
30		private function __construct() {
31		jetpack_require_lib( 'admin-pages/class.jetpack-react-page' );
32		$this->jetpack_react = new Jetpack_React_Page();
		0 ignored issues – show Bug introduced 2019-12-17 05:17 UTC by Report Bug Copy Issue Report 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...
33
34		jetpack_require_lib( 'admin-pages/class.jetpack-settings-page' );
35		$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...
36
37		jetpack_require_lib( 'admin-pages/class-jetpack-about-page' );
38		$this->jetpack_about = new Jetpack_About_Page();
		0 ignored issues – show Bug introduced 2019-12-17 05:17 UTC by Report Bug Copy Issue Report 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...
39
40		add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 );
41		add_action( 'admin_menu', array( $this->jetpack_react, 'add_actions' ), 998 );
42		add_action( 'jetpack_admin_menu', array( $this->jetpack_react, 'jetpack_add_dashboard_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		if ( class_exists( 'Akismet_Admin' ) ) {
56		// If the site has Jetpack Anti-Spam, change the Akismet menu label accordingly.
57		$site_products = Jetpack_Plan::get_products();
58		$anti_spam_products = array( 'jetpack_anti_spam_monthly', 'jetpack_anti_spam' );
59		if ( ! empty( array_intersect( $anti_spam_products, array_column( $site_products, 'product_slug' ) ) ) ) {
60		// Prevent Akismet from adding a menu item.
61		add_action(
62		'admin_menu',
63		function () {
64		remove_action( 'admin_menu', array( 'Akismet_Admin', 'admin_menu' ), 5 );
65		},
66		4
67		);
68
69		// Add an Anti-spam menu item for Jetpack.
70		add_action(
71		'jetpack_admin_menu',
72		function () {
73		add_submenu_page( 'jetpack', __( 'Anti-Spam', 'jetpack' ), __( 'Anti-Spam', 'jetpack' ), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
74		}
75		);
76		add_action( 'admin_enqueue_scripts', array( $this, 'akismet_logo_replacement_styles' ) );
77		}
78		}
79
80		add_filter( 'jetpack_display_jitms_on_screen', array( $this, 'should_display_jitms_on_screen' ), 10, 2 );
81		}
82
83		/**
84		* Generate styles to replace Akismet logo for the Jetpack logo. It's a workaround until we create a proper settings page for
85		* Jetpack Anti-Spam. Without this, we would have to change the logo from Akismet codebase and we want to avoid that.
86		*/
87		public function akismet_logo_replacement_styles() {
88		$logo = new Jetpack_Logo();
89		$logo_base64 = base64_encode( $logo->get_jp_emblem_larger() );
90		$logo_base64_url = "data:image/svg+xml;base64,{$logo_base64}";
91		$style = ".akismet-masthead__logo-container { background: url({$logo_base64_url}) no-repeat .25rem; height: 1.8125rem; } .akismet-masthead__logo { display: none; }";
92		wp_add_inline_style( 'admin-bar', $style );
93		}
94
95	View Code Duplication	static function sort_requires_connection_last( $module1, $module2 ) {
96		if ( $module1['requires_connection'] == $module2['requires_connection'] ) {
97		return 0;
98		} elseif ( $module1['requires_connection'] ) {
99		return 1;
100		} elseif ( $module2['requires_connection'] ) {
101		return -1;
102		}
103
104		return 0;
105		}
106
107		// Produce JS understandable objects of modules containing information for
108		// presentation like description, name, configuration url, etc.
109		function get_modules() {
110		include_once JETPACK__PLUGIN_DIR . 'modules/module-info.php';
111		$available_modules = Jetpack::get_available_modules();
112		$active_modules = Jetpack::get_active_modules();
113		$modules = array();
114		$jetpack_active = Jetpack::is_connection_ready() \|\| ( new Status() )->is_offline_mode();
115		$overrides = Jetpack_Modules_Overrides::instance();
116		foreach ( $available_modules as $module ) {
117		if ( $module_array = Jetpack::get_module( $module ) ) {
118		/**
119		* Filters each module's short description.
120		*
121		* @since 3.0.0
122		*
123		* @param string $module_array['description'] Module description.
124		* @param string $module Module slug.
125		*/
126		$short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
		0 ignored issues – show Unused Code introduced 2020-05-15 22:01 UTC by Report Bug Copy Issue Report 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...
127		// Fix: correct multibyte strings truncate with checking for mbstring extension
128		$short_desc_trunc = ( function_exists( 'mb_strlen' ) )
129		? ( ( mb_strlen( $short_desc ) > 143 )
130		? mb_substr( $short_desc, 0, 140 ) . '...'
131		: $short_desc )
132		: ( ( strlen( $short_desc ) > 143 )
133		? substr( $short_desc, 0, 140 ) . '...'
134		: $short_desc );
135
136		$module_array['module'] = $module;
137
138		$is_available = self::is_module_available( $module_array );
139
140		$module_array['activated'] = ( $jetpack_active ? in_array( $module, $active_modules, true ) : false );
141		$module_array['deactivate_nonce'] = wp_create_nonce( 'jetpack_deactivate-' . $module );
142		$module_array['activate_nonce'] = wp_create_nonce( 'jetpack_activate-' . $module );
143		$module_array['available'] = $is_available;
144		$module_array['unavailable_reason'] = $is_available ? '' : self::get_module_unavailable_reason( $module_array );
145		$module_array['short_description'] = $short_desc_trunc;
146		$module_array['configure_url'] = Jetpack::module_configuration_url( $module );
147		$module_array['override'] = $overrides->get_module_override( $module );
148
149		ob_start();
150		/**
151		* Allow the display of a "Learn More" button.
152		* The dynamic part of the action, $module, is the module slug.
153		*
154		* @since 3.0.0
155		*/
156		do_action( 'jetpack_learn_more_button_' . $module );
157		$module_array['learn_more_button'] = ob_get_clean();
158
159		ob_start();
160		/**
161		* Allow the display of information text when Jetpack is connected to WordPress.com.
162		* The dynamic part of the action, $module, is the module slug.
163		*
164		* @since 3.0.0
165		*/
166		do_action( 'jetpack_module_more_info_' . $module );
167
168		/**
169		* Filter the long description of a module.
170		*
171		* @since 3.5.0
172		*
173		* @param string ob_get_clean() The module long description.
174		* @param string $module The module name.
175		*/
176		$module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module );
		0 ignored issues – show Unused Code introduced 2020-05-15 22:01 UTC by Report Bug Copy Issue Report 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...
177
178		ob_start();
179		/**
180		* Filter the search terms for a module
181		*
182		* Search terms are typically added to the module headers, under "Additional Search Queries".
183		*
184		* Use syntax:
185		* function jetpack_$module_search_terms( $terms ) {
186		* $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' );
187		* return $terms;
188		* }
189		* add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
190		*
191		* @since 3.5.0
192		*
193		* @param string The search terms (comma separated).
194		*/
195		echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] );
196		$module_array['search_terms'] = ob_get_clean();
197
198		$module_array['configurable'] = false;
199		if (
200		current_user_can( 'manage_options' ) &&
201		/**
202		* Allow the display of a configuration link in the Jetpack Settings screen.
203		*
204		* @since 3.0.0
205		*
206		* @param string $module Module name.
207		* @param bool false Should the Configure module link be displayed? Default to false.
208		*/
209		apply_filters( 'jetpack_module_configurable_' . $module, false )
210		) {
211		$module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $module_array['configure_url'] ), __( 'Configure', 'jetpack' ) );
212		}
213
214		$modules[ $module ] = $module_array;
215		}
216		}
217
218		uasort( $modules, array( 'Jetpack', 'sort_modules' ) );
219
220		if ( ! Jetpack::is_connection_ready() ) {
221		uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) );
222		}
223
224		return $modules;
225		}
226
227		static function is_module_available( $module ) {
228		if ( ! is_array( $module ) \|\| empty( $module ) ) {
229		return false;
230		}
231
232		/**
233		* We never want to show VaultPress as activatable through Jetpack.
234		*/
235		if ( 'vaultpress' === $module['module'] ) {
236		return false;
237		}
238
239		/*
240		* WooCommerce Analytics should only be available
241		* when running WooCommerce 3+
242		*/
243	View Code Duplication	if (
244		'woocommerce-analytics' === $module['module']
245		&& (
246		! class_exists( 'WooCommerce' )
247		\|\| version_compare( WC_VERSION, '3.0', '<' )
248		)
249		) {
250		return false;
251		}
252
253		/*
254		* In Offline mode, modules that require a site or user
255		* level connection should be unavailable.
256		*/
257		if ( ( new Status() )->is_offline_mode() ) {
258		return ! ( $module['requires_connection'] \|\| $module['requires_user_connection'] );
259		}
260
261		/*
262		* Jetpack not connected.
263		*/
264		if ( ! Jetpack::is_connection_ready() ) {
265		return false;
266		}
267
268		/*
269		* Jetpack connected at a site level only. Make sure to make
270		* modules that require a user connection unavailable.
271		*/
272		if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
273		return false;
274		}
275
276		return Jetpack_Plan::supports( $module['module'] );
277
278		}
279
280		/**
281		* Returns why a module is unavailable.
282		*
283		* @param array $module The module.
284		* @return string\|false A string stating why the module is not available or false if the module is available.
285		*/
286		public static function get_module_unavailable_reason( $module ) {
287		if ( ! is_array( $module ) \|\| empty( $module ) ) {
288		return false;
289		}
290
291		if ( self::is_module_available( $module ) ) {
292		return false;
293		}
294
295		/*
296		* Jetpack not connected.
297		*/
298		if ( ! Jetpack::is_connection_ready() ) {
299		return 'Jetpack is not connected';
300		}
301
302		/*
303		* In Offline mode, modules that require a site or user
304		* level connection should be unavailable.
305		*/
306		if ( ( new Status() )->is_offline_mode() ) {
307		if ( $module['requires_connection'] \|\| $module['requires_user_connection'] ) {
308		return 'Offline mode';
309		}
310		}
311
312		/*
313		* Jetpack connected at a site level only and module requires a user connection.
314		*/
315		if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
316		return 'Requires a connected WordPress.com account';
317		}
318
319		/*
320		* WooCommerce Analytics should only be available
321		* when running WooCommerce 3+
322		*/
323	View Code Duplication	if (
324		'woocommerce-analytics' === $module['module']
325		&& (
326		! class_exists( 'WooCommerce' )
327		\|\| version_compare( WC_VERSION, '3.0', '<' )
328		)
329		) {
330		return 'Requires WooCommerce 3+ plugin';
331		}
332
333		/*
334		* Plan restrictions.
335		*/
336		if ( ! Jetpack_Plan::supports( $module['module'] ) ) {
337		return 'Not supported by current plan';
338		}
339
340		return '';
341		}
342
343		function handle_unrecognized_action( $action ) {
344		switch ( $action ) {
345		case 'bulk-activate':
346		if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
347		break;
348		}
349
350		$modules = (array) $_GET['modules'];
351		$modules = array_map( 'sanitize_key', $modules );
352		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
353		foreach ( $modules as $module ) {
354		Jetpack::log( 'activate', $module );
355		Jetpack::activate_module( $module, false );
356		}
357		// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
358		wp_safe_redirect( wp_get_referer() );
359		exit;
360	View Code Duplication	case 'bulk-deactivate':
361		if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
362		break;
363		}
364
365		$modules = (array) $_GET['modules'];
366		$modules = array_map( 'sanitize_key', $modules );
367		check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
368		foreach ( $modules as $module ) {
369		Jetpack::log( 'deactivate', $module );
370		Jetpack::deactivate_module( $module );
371		Jetpack::state( 'message', 'module_deactivated' );
372		}
373		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...
374		wp_safe_redirect( wp_get_referer() );
375		exit;
376		default:
377		return;
378		}
379		}
380
381		function fix_redirect( $module, $redirect = true ) {
382		if ( ! $redirect ) {
383		return;
384		}
385		if ( wp_get_referer() ) {
386		add_filter( 'wp_redirect', 'wp_get_referer' );
387		}
388		}
389
390		function admin_menu_debugger() {
391		jetpack_require_lib( 'debugger' );
392		Jetpack_Debugger::disconnect_and_redirect();
393		$debugger_hook = add_submenu_page(
394		null,
395		__( 'Debugging Center', 'jetpack' ),
396		'',
397		'manage_options',
398		'jetpack-debugger',
399		array( $this, 'wrap_debugger_page' )
400		);
401		add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
402		}
403
404		function wrap_debugger_page() {
405		nocache_headers();
406		if ( ! current_user_can( 'manage_options' ) ) {
407		die( '-1' );
408		}
409		Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ) );
410		}
411
412		function debugger_page() {
413		jetpack_require_lib( 'debugger' );
414		Jetpack_Debugger::jetpack_debug_display_handler();
415		}
416
417		/**
418		* Determines if JITMs should display on a particular screen.
419		*
420		* @param bool $value The default value of the filter.
421		* @param string $screen_id The ID of the screen being tested for JITM display.
422		*
423		* @return bool True if JITMs should display, false otherwise.
424		*/
425		public function should_display_jitms_on_screen( $value, $screen_id ) {
426		// Disable all JITMs on these pages.
427		if (
428		in_array(
429		$screen_id,
430		array(
431		'jetpack_page_akismet-key-config',
432		'admin_page_jetpack_modules',
433		),
434		true
435		) ) {
436		return false;
437		}
438
439		// Disable all JITMs on pages where the recommendations banner is displaying.
440		if (
441		in_array(
442		$screen_id,
443		array(
444		'dashboard',
445		'plugins',
446		'jetpack_page_stats',
447		),
448		true
449		)
450		&& \Jetpack_Recommendations_Banner::can_be_displayed()
451		) {
452		return false;
453		}
454
455		return $value;
456		}
457		}
458		Jetpack_Admin::init();
459

Automattic / jetpack

Push — update/add_unavailable_reason_... ( c4afdd )

Jetpack_Admin::is_module_available() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like