Jetpack_React_Page - Code Metrics - Inspection of "Add more context to method docs" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/api-site-endpoint-v1-3 ( 55dbfd...927a28 )

by Kirk

created 2019-04-25 18:05 UTC

Jetpack_React_Page B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	319
Duplicated Lines	7.21 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

Metric	Value
dl	23
loc	319
rs	8.4
c	0
b	0
f	0
wmc	50
lcom	1
cbo	9

14 Methods

Rating	Name	Duplication	Size	Complexity
A	get_page_hook()	0	4	1
B	add_page_actions()	0	29	6
A	jetpack_add_dashboard_sub_nav_item()	6	8	4
A	jetpack_add_settings_sub_nav_item()	4	6	5
A	add_fallback_head_meta()	0	3	1
A	add_noscript_head_meta()	0	5	1
A	jetpack_menu_order()	13	13	4
A	page_render()	0	20	2
A	get_dismissed_jetpack_notices()	0	12	1
A	additional_styles()	0	3	1
A	page_admin_scripts()	0	27	5
F	get_initial_state()	0	131	16
A	get_external_services_connect_urls()	0	8	2
A	get_flattened_settings()	0	5	1

How to fix Duplicated Code Complexity

Duplicated Code

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

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

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

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

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

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

<?php
include_once( 'class.jetpack-admin-page.php' );

// Builds the landing page and its menu
class Jetpack_React_Page extends Jetpack_Admin_Page {

	protected $dont_show_if_not_active = false;

	protected $is_redirecting = false;

	function get_page_hook() {
		// Add the main admin Jetpack menu
		return add_menu_page( 'Jetpack', 'Jetpack', 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), 'div' );
	}

	function add_page_actions( $hook ) {
		/** This action is documented in class.jetpack.php */
		do_action( 'jetpack_admin_menu', $hook );

		// Place the Jetpack menu item on top and others in the order they appear
		add_filter( 'custom_menu_order',         '__return_true' );
		add_filter( 'menu_order',                array( $this, 'jetpack_menu_order' ) );

		if ( ! isset( $_GET['page'] ) || 'jetpack' !== $_GET['page'] ) {
			return; // No need to handle the fallback redirection if we are not on the Jetpack page
		}

		// Adding a redirect meta tag if the REST API is disabled
		if ( ! $this->is_rest_api_enabled() ) {
			$this->is_redirecting = true;
			add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
		}

		// Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled
		add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );

		// If this is the first time the user is viewing the admin, don't show JITMs.
		// This filter is added just in time because this function is called on admin_menu
		// and JITMs are initialized on admin_init
		if ( Jetpack::is_active() && ! Jetpack_Options::get_option( 'first_admin_view', false ) ) {
			Jetpack_Options::update_option( 'first_admin_view', true );
			add_filter( 'jetpack_just_in_time_msgs', '__return_false' );
		}
	}

	/**
	 * Add Jetpack Dashboard sub-link and point it to AAG if the user can view stats, manage modules or if Protect is active.
	 *
	 * Works in Dev Mode or when user is connected.
	 *
	 * @since 4.3.0
	 */
	function jetpack_add_dashboard_sub_nav_item() {
		if ( Jetpack::is_development_mode() || Jetpack::is_active() ) {
			global $submenu;
			if ( current_user_can( 'jetpack_admin_page' ) ) {
				$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/dashboard' );
			}
		}
	}

	/**
	 * If user is allowed to see the Jetpack Admin, add Settings sub-link.
	 *
	 * @since 4.3.0
	 */
	function jetpack_add_settings_sub_nav_item() {
		if ( ( Jetpack::is_development_mode() || Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
			global $submenu;
			$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/settings' );
		}
	}

	function add_fallback_head_meta() {
		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
	}

	function add_noscript_head_meta() {
		echo '<noscript>';
		$this->add_fallback_head_meta();
		echo '</noscript>';
	}

	function jetpack_menu_order( $menu_order ) {
		$jp_menu_order = array();

		foreach ( $menu_order as $index => $item ) {
			if ( $item != 'jetpack' )
				$jp_menu_order[] = $item;

			if ( $index == 0 )
				$jp_menu_order[] = 'jetpack';
		}

		return $jp_menu_order;
	}

	function page_render() {
		/** This action is already documented in views/admin/admin-page.php */
		do_action( 'jetpack_notices' );

		// Try fetching by patch
		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );

		if ( false === $static_html ) {

			// If we still have nothing, display an error
			echo '<p>';
			esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
			echo '<code>yarn distclean && yarn build</code>';
			echo '</p>';
		} else {

			// We got the static.html so let's display it
			echo $static_html;
		}
	}

	/**
	 * Gets array of any Jetpack notices that have been dismissed.
	 *
	 * @since 4.0.1
	 * @return mixed|void
	 */
	function get_dismissed_jetpack_notices() {
		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
		/**
		 * Array of notices that have been dismissed.
		 *
		 * @since 4.0.1
		 *
		 * @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
		 */
		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
		return $dismissed_notices;
	}

	function additional_styles() {
		Jetpack_Admin_Page::load_wrapper_styles();
	}

	function page_admin_scripts() {
		if ( $this->is_redirecting ) {
			return; // No need for scripts on a fallback page
		}

		$script_deps_path    = JETPACK__PLUGIN_DIR . '_inc/build/admin.deps.json';
		$script_dependencies = file_exists( $script_deps_path )
			? json_decode( file_get_contents( $script_deps_path ) )
			: array();
		$script_dependencies[] = 'wp-polyfill';

		wp_enqueue_script(
			'react-plugin',
			plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ),
			$script_dependencies,
			JETPACK__VERSION,
			true
		);

		if ( ! Jetpack::is_development_mode() && Jetpack::is_active() ) {
			// Required for Analytics.
			wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
		}

		// Add objects to be passed to the initial state of the app.
		wp_localize_script( 'react-plugin', 'Initial_State', $this->get_initial_state() );
	}

	function get_initial_state() {
		// Load API endpoint base classes and endpoints for getting the module list fed into the JS Admin Page
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
		$moduleListEndpoint = new Jetpack_Core_API_Module_List_Endpoint();
		$modules = $moduleListEndpoint->get_modules();

		// Preparing translated fields for JSON encoding by transforming all HTML entities to
		// respective characters.
		foreach( $modules as $slug => $data ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
			$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
			$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
			$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
		}

		// Collecting roles that can view site stats.
		$stats_roles = array();
		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );

		if ( ! function_exists( 'get_editable_roles' ) ) {
			require_once ABSPATH . 'wp-admin/includes/user.php';
		}
		foreach ( get_editable_roles() as $slug => $role ) {
			$stats_roles[ $slug ] = array(
				'name' => translate_user_role( $role['name'] ),
				'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
			);
		}

		// Get information about current theme.
		$current_theme = wp_get_theme();

		// Get all themes that Infinite Scroll provides support for natively.
		$inf_scr_support_themes = array();
		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes' ) as $path ) {
			if ( is_readable( $path ) ) {
				$inf_scr_support_themes[] = basename( $path, '.php' );
			}
		}

		// Get last post, to build the link to Customizer in the Related Posts module.
		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
		$last_post = isset( $last_post[0] ) && $last_post[0] instanceof WP_Post
if ($x instanceof DoesNotExist) {
    // Do something.
}
			? get_permalink( $last_post[0]->ID )
			: get_home_url();

		// Ensure that class to get the affiliate code is loaded
		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
		}

		return array(
			'WP_API_root' => esc_url_raw( rest_url() ),
			'WP_API_nonce' => wp_create_nonce( 'wp_rest' ),
			'pluginBaseUrl' => plugins_url( '', JETPACK__PLUGIN_FILE ),
			'connectionStatus' => array(
				'isActive'  => Jetpack::is_active(),
				'isStaging' => Jetpack::is_staging_site(),
				'devMode'   => array(
					'isActive' => Jetpack::is_development_mode(),
					'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
					'url'      => site_url() && false === strpos( site_url(), '.' ),
					'filter'   => apply_filters( 'jetpack_development_mode', false ),
				),
				'isPublic'	=> '1' == get_option( 'blog_public' ),
				'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
				'sandboxDomain' => JETPACK__SANDBOX_DOMAIN,
			),
			'connectUrl' => Jetpack::init()->build_connect_url( true, false, false ),
			'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
			'isDevVersion' => Jetpack::is_development_version(),
			'currentVersion' => JETPACK__VERSION,
			'is_gutenberg_available' => true,
			'getModules' => $modules,
			'showJumpstart' => jetpack_show_jumpstart(),
			'rawUrl' => Jetpack::build_raw_urls( get_home_url() ),
			'adminUrl' => esc_url( admin_url() ),
			'stats' => array(
				// data is populated asynchronously on page load
				'data'  => array(
					'general' => false,
					'day'     => false,
					'week'    => false,
					'month'   => false,
				),
				'roles' => $stats_roles,
			),
			'aff' => Jetpack_Affiliate::init()->get_affiliate_code(),
			'settings' => $this->get_flattened_settings( $modules ),
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
			'userData' => array(
//				'othersLinked' => Jetpack::get_other_linked_admins(),
				'currentUser'  => jetpack_current_user_data(),
			),
			'siteData' => array(
				'icon' => has_site_icon()
					? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
					: '',
				'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ),
				/**
				 * Whether promotions are visible or not.
				 *
				 * @since 4.8.0
				 *
				 * @param bool $are_promotions_active Status of promotions visibility. True by default.
				 */
				'showPromotions' => apply_filters( 'jetpack_show_promotions', true ),
				'isAtomicSite' => jetpack_is_atomic_site(),
				'plan' => Jetpack_Plan::get(),
				'showBackups' => Jetpack::show_backups_ui(),
			),
			'themeData' => array(
				'name'      => $current_theme->get( 'Name' ),
				'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
				'support'   => array(
					'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) || in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes ),
				),
			),
			'locale' => Jetpack::get_i18n_data_json(),
			'localeSlug' => join( '-', explode( '_', get_user_locale() ) ),
			'jetpackStateNotices' => array(
				'messageCode' => Jetpack::state( 'message' ),
				'errorCode' => Jetpack::state( 'error' ),
				'errorDescription' => Jetpack::state( 'error_description' ),
			),
			'tracksUserData' => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
			'currentIp' => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
			'lastPostUrl' => esc_url( $last_post ),
			'externalServicesConnectUrls' => $this->get_external_services_connect_urls()
		);
	}

	function get_external_services_connect_urls() {
		$connect_urls = array();
		jetpack_require_lib( 'class.jetpack-keyring-service-helper' );
		foreach ( Jetpack_Keyring_Service_Helper::$SERVICES as $service_name => $service_info ) {
			$connect_urls[ $service_name ] = Jetpack_Keyring_Service_Helper::connect_url( $service_name, $service_info[ 'for' ] );
		}
		return $connect_urls;
	}

	/**
	 * Returns an array of modules and settings both as first class members of the object.
	 *
	 * @param array $modules the result of an API request to get all modules.
	 *
	 * @return array flattened settings with modules.
	 */
	function get_flattened_settings( $modules ) {
		$core_api_endpoint = new Jetpack_Core_API_Data();
		$settings = $core_api_endpoint->get_all_options();
		return $settings->data;
	}
}

/*
 * Only show Jump Start on first activation.
 * Any option 'jumpstart' other than 'new connection' will hide it.
 *
 * The option can be of 4 things, and will be stored as such:
 * new_connection      : Brand new connection - Show
 * jumpstart_activated : Jump Start has been activated - dismiss
 * jumpstart_dismissed : Manual dismissal of Jump Start - dismiss
 * jetpack_action_taken: Deprecated since 7.3 But still listed here to respect behaviour for old versions.
 *                       Manual activation of a module already happened - dismiss.
 *
 * @todo move to functions.global.php when available
 * @since 3.6
 * @return bool | show or hide
 */
function jetpack_show_jumpstart() {
	if ( ! Jetpack::is_active() ) {
		return false;
	}
	$jumpstart_option = Jetpack_Options::get_option( 'jumpstart' );

	$hide_options = array(
		'jumpstart_activated',
		'jetpack_action_taken',
		'jumpstart_dismissed'
	);

	if ( ! $jumpstart_option || in_array( $jumpstart_option, $hide_options ) ) {
		return false;
	}

	return true;
}

/**
 * Gather data about the current user.
 *
 * @since 4.1.0
 *
 * @return array
 */
function jetpack_current_user_data() {
	$current_user = wp_get_current_user();
	$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
	$dotcom_data    = Jetpack::get_connected_user_data();
	// Add connected user gravatar to the returned dotcom_data.
	$dotcom_data['avatar'] = get_avatar_url( $dotcom_data['email'], array( 'size' => 64, 'default' => 'mysteryman' ) );

	$current_user_data = array(
		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
		'isMaster'    => $is_master_user,
		'username'    => $current_user->user_login,
		'id'          => $current_user->ID,
		'wpcomUser'   => $dotcom_data,
		'gravatar'    => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
		'permissions' => array(
			'admin_page'         => current_user_can( 'jetpack_admin_page' ),
			'connect'            => current_user_can( 'jetpack_connect' ),
			'disconnect'         => current_user_can( 'jetpack_disconnect' ),
			'manage_modules'     => current_user_can( 'jetpack_manage_modules' ),
			'network_admin'      => current_user_can( 'jetpack_network_admin_page' ),
			'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
			'edit_posts'         => current_user_can( 'edit_posts' ),
			'publish_posts'      => current_user_can( 'publish_posts' ),
			'manage_options'     => current_user_can( 'manage_options' ),
			'view_stats'		 => current_user_can( 'view_stats' ),
			'manage_plugins'	 => current_user_can( 'install_plugins' )
									&& current_user_can( 'activate_plugins' )
									&& current_user_can( 'update_plugins' )
									&& current_user_can( 'delete_plugins' ),
		),
	);

	return $current_user_data;
}


Push — add/api-site-endpoint-v1-3 ( 55dbfd...927a28 )

Jetpack_React_Page B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

1		<?php
2		include_once( 'class.jetpack-admin-page.php' );
3
4		// Builds the landing page and its menu
5		class Jetpack_React_Page extends Jetpack_Admin_Page {
6
7		protected $dont_show_if_not_active = false;
8
9		protected $is_redirecting = false;
10
11		function get_page_hook() {
12		// Add the main admin Jetpack menu
13		return add_menu_page( 'Jetpack', 'Jetpack', 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), 'div' );
14		}
15
16		function add_page_actions( $hook ) {
17		/** This action is documented in class.jetpack.php */
18		do_action( 'jetpack_admin_menu', $hook );
19
20		// Place the Jetpack menu item on top and others in the order they appear
21		add_filter( 'custom_menu_order', '__return_true' );
22		add_filter( 'menu_order', array( $this, 'jetpack_menu_order' ) );
23
24		if ( ! isset( $_GET['page'] ) \|\| 'jetpack' !== $_GET['page'] ) {
25		return; // No need to handle the fallback redirection if we are not on the Jetpack page
26		}
27
28		// Adding a redirect meta tag if the REST API is disabled
29		if ( ! $this->is_rest_api_enabled() ) {
30		$this->is_redirecting = true;
31		add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
32		}
33
34		// Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled
35		add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );
36
37		// If this is the first time the user is viewing the admin, don't show JITMs.
38		// This filter is added just in time because this function is called on admin_menu
39		// and JITMs are initialized on admin_init
40		if ( Jetpack::is_active() && ! Jetpack_Options::get_option( 'first_admin_view', false ) ) {
41		Jetpack_Options::update_option( 'first_admin_view', true );
42		add_filter( 'jetpack_just_in_time_msgs', '__return_false' );
43		}
44		}
45
46		/**
47		* Add Jetpack Dashboard sub-link and point it to AAG if the user can view stats, manage modules or if Protect is active.
48		*
49		* Works in Dev Mode or when user is connected.
50		*
51		* @since 4.3.0
52		*/
53		function jetpack_add_dashboard_sub_nav_item() {
54	View Code Duplication	if ( Jetpack::is_development_mode() \|\| Jetpack::is_active() ) {
55		global $submenu;
56		if ( current_user_can( 'jetpack_admin_page' ) ) {
57		$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/dashboard' );
58		}
59		}
60		}
61
62		/**
63		* If user is allowed to see the Jetpack Admin, add Settings sub-link.
64		*
65		* @since 4.3.0
66		*/
67		function jetpack_add_settings_sub_nav_item() {
68	View Code Duplication	if ( ( Jetpack::is_development_mode() \|\| Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
69		global $submenu;
70		$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/settings' );
71		}
72		}
73
74		function add_fallback_head_meta() {
75		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
76		}
77
78		function add_noscript_head_meta() {
79		echo '<noscript>';
80		$this->add_fallback_head_meta();
81		echo '</noscript>';
82		}
83
84	View Code Duplication	function jetpack_menu_order( $menu_order ) {
85		$jp_menu_order = array();
86
87		foreach ( $menu_order as $index => $item ) {
88		if ( $item != 'jetpack' )
89		$jp_menu_order[] = $item;
90
91		if ( $index == 0 )
92		$jp_menu_order[] = 'jetpack';
93		}
94
95		return $jp_menu_order;
96		}
97
98		function page_render() {
99		/** This action is already documented in views/admin/admin-page.php */
100		do_action( 'jetpack_notices' );
101
102		// Try fetching by patch
103		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );
104
105		if ( false === $static_html ) {
106
107		// If we still have nothing, display an error
108		echo '<p>';
109		esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
110		echo '<code>yarn distclean && yarn build</code>';
111		echo '</p>';
112		} else {
113
114		// We got the static.html so let's display it
115		echo $static_html;
116		}
117		}
118
119		/**
120		* Gets array of any Jetpack notices that have been dismissed.
121		*
122		* @since 4.0.1
123		* @return mixed\|void
124		*/
125		function get_dismissed_jetpack_notices() {
126		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
127		/**
128		* Array of notices that have been dismissed.
129		*
130		* @since 4.0.1
131		*
132		* @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
133		*/
134		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
135		return $dismissed_notices;
136		}
137
138		function additional_styles() {
139		Jetpack_Admin_Page::load_wrapper_styles();
140		}
141
142		function page_admin_scripts() {
143		if ( $this->is_redirecting ) {
144		return; // No need for scripts on a fallback page
145		}
146
147		$script_deps_path = JETPACK__PLUGIN_DIR . '_inc/build/admin.deps.json';
148		$script_dependencies = file_exists( $script_deps_path )
149		? json_decode( file_get_contents( $script_deps_path ) )
150		: array();
151		$script_dependencies[] = 'wp-polyfill';
152
153		wp_enqueue_script(
154		'react-plugin',
155		plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ),
156		$script_dependencies,
157		JETPACK__VERSION,
158		true
159		);
160
161		if ( ! Jetpack::is_development_mode() && Jetpack::is_active() ) {
162		// Required for Analytics.
163		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
164		}
165
166		// Add objects to be passed to the initial state of the app.
167		wp_localize_script( 'react-plugin', 'Initial_State', $this->get_initial_state() );
168		}
169
170		function get_initial_state() {
171		// Load API endpoint base classes and endpoints for getting the module list fed into the JS Admin Page
172		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
173		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
174		$moduleListEndpoint = new Jetpack_Core_API_Module_List_Endpoint();
175		$modules = $moduleListEndpoint->get_modules();
176
177		// Preparing translated fields for JSON encoding by transforming all HTML entities to
178		// respective characters.
179		foreach( $modules as $slug => $data ) {
		0 ignored issues – show Bug introduced 2017-10-06 18:49 UTC by Report Bug Copy Issue Report The expression `$modules` of type `string\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
180		$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
181		$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
182		$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
183		$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
184		}
185
186		// Collecting roles that can view site stats.
187		$stats_roles = array();
188		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );
189
190		if ( ! function_exists( 'get_editable_roles' ) ) {
191		require_once ABSPATH . 'wp-admin/includes/user.php';
192		}
193		foreach ( get_editable_roles() as $slug => $role ) {
194		$stats_roles[ $slug ] = array(
195		'name' => translate_user_role( $role['name'] ),
196		'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
197		);
198		}
199
200		// Get information about current theme.
201		$current_theme = wp_get_theme();
202
203		// Get all themes that Infinite Scroll provides support for natively.
204		$inf_scr_support_themes = array();
205		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes' ) as $path ) {
206		if ( is_readable( $path ) ) {
207		$inf_scr_support_themes[] = basename( $path, '.php' );
208		}
209		}
210
211		// Get last post, to build the link to Customizer in the Related Posts module.
212		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
213		$last_post = isset( $last_post[0] ) && $last_post[0] instanceof WP_Post
		0 ignored issues – show Bug introduced 2016-09-19 18:57 UTC by Report Bug Copy Issue Report The class `WP_Post` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
214		? get_permalink( $last_post[0]->ID )
215		: get_home_url();
216
217		// Ensure that class to get the affiliate code is loaded
218		if ( ! class_exists( 'Jetpack_Affiliate' ) ) {
219		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-affiliate.php';
220		}
221
222		return array(
223		'WP_API_root' => esc_url_raw( rest_url() ),
224		'WP_API_nonce' => wp_create_nonce( 'wp_rest' ),
225		'pluginBaseUrl' => plugins_url( '', JETPACK__PLUGIN_FILE ),
226		'connectionStatus' => array(
227		'isActive' => Jetpack::is_active(),
228		'isStaging' => Jetpack::is_staging_site(),
229		'devMode' => array(
230		'isActive' => Jetpack::is_development_mode(),
231		'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
232		'url' => site_url() && false === strpos( site_url(), '.' ),
233		'filter' => apply_filters( 'jetpack_development_mode', false ),
234		),
235		'isPublic' => '1' == get_option( 'blog_public' ),
236		'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
237		'sandboxDomain' => JETPACK__SANDBOX_DOMAIN,
238		),
239		'connectUrl' => Jetpack::init()->build_connect_url( true, false, false ),
240		'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
241		'isDevVersion' => Jetpack::is_development_version(),
242		'currentVersion' => JETPACK__VERSION,
243		'is_gutenberg_available' => true,
244		'getModules' => $modules,
245		'showJumpstart' => jetpack_show_jumpstart(),
246		'rawUrl' => Jetpack::build_raw_urls( get_home_url() ),
247		'adminUrl' => esc_url( admin_url() ),
248		'stats' => array(
249		// data is populated asynchronously on page load
250		'data' => array(
251		'general' => false,
252		'day' => false,
253		'week' => false,
254		'month' => false,
255		),
256		'roles' => $stats_roles,
257		),
258		'aff' => Jetpack_Affiliate::init()->get_affiliate_code(),
259		'settings' => $this->get_flattened_settings( $modules ),
		0 ignored issues – show Bug introduced 2017-10-06 18:49 UTC by Report Bug Copy Issue Report It seems like `$modules` defined by `$moduleListEndpoint->get_modules()` on line `175` can also be of type `string`; however, `Jetpack_React_Page::get_flattened_settings()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
260		'userData' => array(
261		// 'othersLinked' => Jetpack::get_other_linked_admins(),
262		'currentUser' => jetpack_current_user_data(),
263		),
264		'siteData' => array(
265		'icon' => has_site_icon()
266		? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
267		: '',
268		'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ),
269		/**
270		* Whether promotions are visible or not.
271		*
272		* @since 4.8.0
273		*
274		* @param bool $are_promotions_active Status of promotions visibility. True by default.
275		*/
276		'showPromotions' => apply_filters( 'jetpack_show_promotions', true ),
277		'isAtomicSite' => jetpack_is_atomic_site(),
278		'plan' => Jetpack_Plan::get(),
279		'showBackups' => Jetpack::show_backups_ui(),
280		),
281		'themeData' => array(
282		'name' => $current_theme->get( 'Name' ),
283		'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
284		'support' => array(
285		'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) \|\| in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes ),
286		),
287		),
288		'locale' => Jetpack::get_i18n_data_json(),
289		'localeSlug' => join( '-', explode( '_', get_user_locale() ) ),
290		'jetpackStateNotices' => array(
291		'messageCode' => Jetpack::state( 'message' ),
292		'errorCode' => Jetpack::state( 'error' ),
293		'errorDescription' => Jetpack::state( 'error_description' ),
294		),
295		'tracksUserData' => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
296		'currentIp' => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
297		'lastPostUrl' => esc_url( $last_post ),
298		'externalServicesConnectUrls' => $this->get_external_services_connect_urls()
299		);
300		}
301
302		function get_external_services_connect_urls() {
303		$connect_urls = array();
304		jetpack_require_lib( 'class.jetpack-keyring-service-helper' );
305		foreach ( Jetpack_Keyring_Service_Helper::$SERVICES as $service_name => $service_info ) {
306		$connect_urls[ $service_name ] = Jetpack_Keyring_Service_Helper::connect_url( $service_name, $service_info[ 'for' ] );
307		}
308		return $connect_urls;
309		}
310
311		/**
312		* Returns an array of modules and settings both as first class members of the object.
313		*
314		* @param array $modules the result of an API request to get all modules.
315		*
316		* @return array flattened settings with modules.
317		*/
318		function get_flattened_settings( $modules ) {
319		$core_api_endpoint = new Jetpack_Core_API_Data();
320		$settings = $core_api_endpoint->get_all_options();
321		return $settings->data;
322		}
323		}
324
325		/*
326		* Only show Jump Start on first activation.
327		* Any option 'jumpstart' other than 'new connection' will hide it.
328		*
329		* The option can be of 4 things, and will be stored as such:
330		* new_connection : Brand new connection - Show
331		* jumpstart_activated : Jump Start has been activated - dismiss
332		* jumpstart_dismissed : Manual dismissal of Jump Start - dismiss
333		* jetpack_action_taken: Deprecated since 7.3 But still listed here to respect behaviour for old versions.
334		* Manual activation of a module already happened - dismiss.
335		*
336		* @todo move to functions.global.php when available
337		* @since 3.6
338		* @return bool \| show or hide
339		*/
340		function jetpack_show_jumpstart() {
341		if ( ! Jetpack::is_active() ) {
342		return false;
343		}
344		$jumpstart_option = Jetpack_Options::get_option( 'jumpstart' );
345
346		$hide_options = array(
347		'jumpstart_activated',
348		'jetpack_action_taken',
349		'jumpstart_dismissed'
350		);
351
352		if ( ! $jumpstart_option \|\| in_array( $jumpstart_option, $hide_options ) ) {
353		return false;
354		}
355
356		return true;
357		}
358
359		/**
360		* Gather data about the current user.
361		*
362		* @since 4.1.0
363		*
364		* @return array
365		*/
366		function jetpack_current_user_data() {
367		$current_user = wp_get_current_user();
368		$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
369		$dotcom_data = Jetpack::get_connected_user_data();
370		// Add connected user gravatar to the returned dotcom_data.
371		$dotcom_data['avatar'] = get_avatar_url( $dotcom_data['email'], array( 'size' => 64, 'default' => 'mysteryman' ) );
372
373		$current_user_data = array(
374		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
375		'isMaster' => $is_master_user,
376		'username' => $current_user->user_login,
377		'id' => $current_user->ID,
378		'wpcomUser' => $dotcom_data,
379		'gravatar' => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
380		'permissions' => array(
381		'admin_page' => current_user_can( 'jetpack_admin_page' ),
382		'connect' => current_user_can( 'jetpack_connect' ),
383		'disconnect' => current_user_can( 'jetpack_disconnect' ),
384		'manage_modules' => current_user_can( 'jetpack_manage_modules' ),
385		'network_admin' => current_user_can( 'jetpack_network_admin_page' ),
386		'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
387		'edit_posts' => current_user_can( 'edit_posts' ),
388		'publish_posts' => current_user_can( 'publish_posts' ),
389		'manage_options' => current_user_can( 'manage_options' ),
390		'view_stats' => current_user_can( 'view_stats' ),
391		'manage_plugins' => current_user_can( 'install_plugins' )
392		&& current_user_can( 'activate_plugins' )
393		&& current_user_can( 'update_plugins' )
394		&& current_user_can( 'delete_plugins' ),
395		),
396		);
397
398		return $current_user_data;
399		}
400

Automattic / jetpack

Push — add/api-site-endpoint-v1-3 ( 55dbfd...927a28 )

Jetpack_React_Page B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

14 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like