Jetpack_React_Page - Code Metrics - Inspection of "Theme Promo Card: Improve readability" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fix/typo-pro-promo ( e5832e...fc698e )

unknown

created 2018-06-07 15:00 UTC

Jetpack_React_Page C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	335
Duplicated Lines	10.45 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
dl	35
loc	335
rs	6.8
c	0
b	0
f	0
wmc	55
lcom	1
cbo	5

15 Methods

Rating	Name	Duplication	Size	Complexity
A	get_page_hook()	0	6	1
A	add_fallback_head_meta()	0	3	1
A	add_noscript_head_meta()	0	5	1
A	get_dismissed_jetpack_notices()	0	12	1
A	get_i18n_data()	0	14	4
A	additional_styles()	0	6	2
B	add_page_actions()	0	24	6
B	jetpack_add_settings_sub_nav_item()	4	6	5
A	add_legacy_browsers_head_script()	0	10	1
A	jetpack_menu_order()	13	13	4
A	render_nojs_configurable()	0	14	3
B	page_render()	12	25	3
A	jetpack_add_dashboard_sub_nav_item()	6	8	4
A	get_flattened_settings()	0	5	1
F	page_admin_scripts()	0	135	18

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() {
		$title = _x( 'Jetpack', 'The menu item label', 'jetpack' );

		// Add the main admin Jetpack menu
		return add_menu_page( 'Jetpack', $title, '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'] || ! empty( $_GET['configure'] ) ) {
			return; // No need to handle the fallback redirection if we are not on the Jetpack page
		}

		// Adding a redirect meta tag for older WordPress versions or if the REST API is disabled
		if ( $this->is_wp_version_too_old() || ! $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' ) );

		// Adding a redirect tag wrapped in browser conditional comments
		add_action( 'admin_head', array( $this, 'add_legacy_browsers_head_script' ) );
	}

	/**
	 * 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 add_legacy_browsers_head_script() {
		echo
			"<script type=\"text/javascript\">\n"
			. "/*@cc_on\n"
			. "if ( @_jscript_version <= 10) {\n"
			. "window.location.href = '?page=jetpack_modules';\n"
			. "}\n"
			. "@*/\n"
			. "</script>";
	}

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

	// Render the configuration page for the module if it exists and an error
	// screen if the module is not configurable
	// @todo remove when real settings are in place

	function render_nojs_configurable( $module_name ) {
		$module_name = preg_replace( '/[^\da-z\-]+/', '', $_GET['configure'] );

		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
		echo '<div class="wrap configure-module">';

		if ( Jetpack::is_module( $module_name ) && current_user_can( 'jetpack_configure_modules' ) ) {
			Jetpack::admin_screen_configure_module( $module_name );
		} else {
			echo '<h2>' . esc_html__( 'Error, bad module.', 'jetpack' ) . '</h2>';
		}

		echo '</div><!-- /wrap -->';
	}

	function page_render() {
		// Handle redirects to configuration pages
		if ( ! empty( $_GET['configure'] ) ) {
			return $this->render_nojs_configurable( $_GET['configure'] );
		}

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

	function get_i18n_data() {

		$i18n_json = JETPACK__PLUGIN_DIR . 'languages/json/jetpack-' . jetpack_get_user_locale() . '.json';

		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
			$locale_data = @file_get_contents( $i18n_json );
			if ( $locale_data ) {
				return $locale_data;
			}
		}

		// Return empty if we have nothing to return so it doesn't fail when parsed in JS
		return '{}';
	}

	/**
	 * 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() {
		$rtl = is_rtl() ? '.rtl' : '';

		wp_enqueue_style( 'dops-css', plugins_url( "_inc/build/admin.dops-style$rtl.css", JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
		wp_enqueue_style( 'components-css', plugins_url( "_inc/build/style.min$rtl.css", JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
	}

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

		$is_dev_mode = Jetpack::is_development_mode();

		// Enqueue jp.js and localize it
		wp_enqueue_script( 'react-plugin', plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION, true );

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

		// 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,
			);
		}

		// 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'] );
		}

		// 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();

		// 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' );
			}
		}

		// Add objects to be passed to the initial state of the app
		wp_localize_script( 'react-plugin', 'Initial_State', 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' => $is_dev_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(),
			),
			'connectUrl' => Jetpack::init()->build_connect_url( true, false, false ),
			'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
			'isDevVersion' => Jetpack::is_development_version(),
			'currentVersion' => JETPACK__VERSION,
			'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,
			),
			'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(),
			),
			'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' => $this->get_i18n_data(),
			'localeSlug' => join( '-', explode( '_', jetpack_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 ),
		) );
	}

	/**
	 * 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
 * jetpack_action_taken: Manual activation of a module already happened - dismiss
 * jumpstart_dismissed : Manual dismissal of Jump Start - 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;
}

/**
 * Set the admin language, based on user language.
 *
 * @since 4.5.0
 *
 * @return string
 *
 * @todo Remove this function when WordPress 4.8 is released

 * and replace `jetpack_get_user_locale()` in this file with `get_user_locale()`.
 */
function jetpack_get_user_locale() {
	$locale = get_locale();

	if ( function_exists( 'get_user_locale' ) ) {
		$locale = get_user_locale();
	}

	return $locale;
}


Push — fix/typo-pro-promo ( e5832e...fc698e )

Jetpack_React_Page C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 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		$title = _x( 'Jetpack', 'The menu item label', 'jetpack' );
13
14		// Add the main admin Jetpack menu
15		return add_menu_page( 'Jetpack', $title, 'jetpack_admin_page', 'jetpack', array( $this, 'render' ), 'div' );
16		}
17
18		function add_page_actions( $hook ) {
19		/** This action is documented in class.jetpack.php */
20		do_action( 'jetpack_admin_menu', $hook );
21
22		// Place the Jetpack menu item on top and others in the order they appear
23		add_filter( 'custom_menu_order', '__return_true' );
24		add_filter( 'menu_order', array( $this, 'jetpack_menu_order' ) );
25
26		if ( ! isset( $_GET['page'] ) \|\| 'jetpack' !== $_GET['page'] \|\| ! empty( $_GET['configure'] ) ) {
27		return; // No need to handle the fallback redirection if we are not on the Jetpack page
28		}
29
30		// Adding a redirect meta tag for older WordPress versions or if the REST API is disabled
31		if ( $this->is_wp_version_too_old() \|\| ! $this->is_rest_api_enabled() ) {
32		$this->is_redirecting = true;
33		add_action( 'admin_head', array( $this, 'add_fallback_head_meta' ) );
34		}
35
36		// Adding a redirect meta tag wrapped in noscript tags for all browsers in case they have JavaScript disabled
37		add_action( 'admin_head', array( $this, 'add_noscript_head_meta' ) );
38
39		// Adding a redirect tag wrapped in browser conditional comments
40		add_action( 'admin_head', array( $this, 'add_legacy_browsers_head_script' ) );
41		}
42
43		/**
44		* Add Jetpack Dashboard sub-link and point it to AAG if the user can view stats, manage modules or if Protect is active.
45		*
46		* Works in Dev Mode or when user is connected.
47		*
48		* @since 4.3.0
49		*/
50		function jetpack_add_dashboard_sub_nav_item() {
51	View Code Duplication	if ( Jetpack::is_development_mode() \|\| Jetpack::is_active() ) {
52		global $submenu;
53		if ( current_user_can( 'jetpack_admin_page' ) ) {
54		$submenu['jetpack'][] = array( __( 'Dashboard', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/dashboard' );
55		}
56		}
57		}
58
59		/**
60		* If user is allowed to see the Jetpack Admin, add Settings sub-link.
61		*
62		* @since 4.3.0
63		*/
64		function jetpack_add_settings_sub_nav_item() {
65	View Code Duplication	if ( ( Jetpack::is_development_mode() \|\| Jetpack::is_active() ) && current_user_can( 'jetpack_admin_page' ) && current_user_can( 'edit_posts' ) ) {
66		global $submenu;
67		$submenu['jetpack'][] = array( __( 'Settings', 'jetpack' ), 'jetpack_admin_page', 'admin.php?page=jetpack#/settings' );
68		}
69		}
70
71		function add_fallback_head_meta() {
72		echo '<meta http-equiv="refresh" content="0; url=?page=jetpack_modules">';
73		}
74
75		function add_noscript_head_meta() {
76		echo '<noscript>';
77		$this->add_fallback_head_meta();
78		echo '</noscript>';
79		}
80
81		function add_legacy_browsers_head_script() {
82		echo
83		"<script type=\"text/javascript\">\n"
84		. "/*@cc_on\n"
85		. "if ( @_jscript_version <= 10) {\n"
86		. "window.location.href = '?page=jetpack_modules';\n"
87		. "}\n"
88		. "@*/\n"
89		. "</script>";
90		}
91
92	View Code Duplication	function jetpack_menu_order( $menu_order ) {
93		$jp_menu_order = array();
94
95		foreach ( $menu_order as $index => $item ) {
96		if ( $item != 'jetpack' )
97		$jp_menu_order[] = $item;
98
99		if ( $index == 0 )
100		$jp_menu_order[] = 'jetpack';
101		}
102
103		return $jp_menu_order;
104		}
105
106		// Render the configuration page for the module if it exists and an error
107		// screen if the module is not configurable
108		// @todo remove when real settings are in place
		0 ignored issues – show Coding Style Best Practice introduced 2016-05-16 15:13 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
109		function render_nojs_configurable( $module_name ) {
110		$module_name = preg_replace( '/[^\da-z\-]+/', '', $_GET['configure'] );
111
112		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
113		echo '<div class="wrap configure-module">';
114
115		if ( Jetpack::is_module( $module_name ) && current_user_can( 'jetpack_configure_modules' ) ) {
116		Jetpack::admin_screen_configure_module( $module_name );
117		} else {
118		echo '<h2>' . esc_html__( 'Error, bad module.', 'jetpack' ) . '</h2>';
119		}
120
121		echo '</div><!-- /wrap -->';
122		}
123
124		function page_render() {
125		// Handle redirects to configuration pages
126		if ( ! empty( $_GET['configure'] ) ) {
127		return $this->render_nojs_configurable( $_GET['configure'] );
128		}
129
130		/** This action is already documented in views/admin/admin-page.php */
131		do_action( 'jetpack_notices' );
132
133		// Try fetching by patch
134		$static_html = @file_get_contents( JETPACK__PLUGIN_DIR . '_inc/build/static.html' );
135
136	View Code Duplication	if ( false === $static_html ) {
137
138		// If we still have nothing, display an error
139		echo '<p>';
140		esc_html_e( 'Error fetching static.html. Try running: ', 'jetpack' );
141		echo '<code>yarn distclean && yarn build</code>';
142		echo '</p>';
143		} else {
144
145		// We got the static.html so let's display it
146		echo $static_html;
147		}
148		}
149
150		function get_i18n_data() {
151
152		$i18n_json = JETPACK__PLUGIN_DIR . 'languages/json/jetpack-' . jetpack_get_user_locale() . '.json';
153
154		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
155		$locale_data = @file_get_contents( $i18n_json );
156		if ( $locale_data ) {
157		return $locale_data;
158		}
159		}
160
161		// Return empty if we have nothing to return so it doesn't fail when parsed in JS
162		return '{}';
163		}
164
165		/**
166		* Gets array of any Jetpack notices that have been dismissed.
167		*
168		* @since 4.0.1
169		* @return mixed\|void
170		*/
171		function get_dismissed_jetpack_notices() {
172		$jetpack_dismissed_notices = get_option( 'jetpack_dismissed_notices', array() );
173		/**
174		* Array of notices that have been dismissed.
175		*
176		* @since 4.0.1
177		*
178		* @param array $jetpack_dismissed_notices If empty, will not show any Jetpack notices.
179		*/
180		$dismissed_notices = apply_filters( 'jetpack_dismissed_notices', $jetpack_dismissed_notices );
181		return $dismissed_notices;
182		}
183
184		function additional_styles() {
185		$rtl = is_rtl() ? '.rtl' : '';
186
187		wp_enqueue_style( 'dops-css', plugins_url( "_inc/build/admin.dops-style$rtl.css", JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
188		wp_enqueue_style( 'components-css', plugins_url( "_inc/build/style.min$rtl.css", JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
189		}
190
191		function page_admin_scripts() {
192		if ( $this->is_redirecting ) {
193		return; // No need for scripts on a fallback page
194		}
195
196		$is_dev_mode = Jetpack::is_development_mode();
197
198		// Enqueue jp.js and localize it
199		wp_enqueue_script( 'react-plugin', plugins_url( '_inc/build/admin.js', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION, true );
200
201		if ( ! $is_dev_mode && Jetpack::is_active() ) {
202		// Required for Analytics
203		wp_enqueue_script( 'jp-tracks', '//stats.wp.com/w.js', array(), gmdate( 'YW' ), true );
204		}
205
206		// Collecting roles that can view site stats.
207		$stats_roles = array();
208		$enabled_roles = function_exists( 'stats_get_option' ) ? stats_get_option( 'roles' ) : array( 'administrator' );
209
210		if ( ! function_exists( 'get_editable_roles' ) ) {
211		require_once ABSPATH . 'wp-admin/includes/user.php';
212		}
213		foreach ( get_editable_roles() as $slug => $role ) {
214		$stats_roles[ $slug ] = array(
215		'name' => translate_user_role( $role['name'] ),
216		'canView' => is_array( $enabled_roles ) ? in_array( $slug, $enabled_roles, true ) : false,
217		);
218		}
219
220		// Load API endpoint base classes and endpoints for getting the module list fed into the JS Admin Page
221		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-xmlrpc-consumer-endpoint.php';
222		require_once JETPACK__PLUGIN_DIR . '_inc/lib/core-api/class.jetpack-core-api-module-endpoints.php';
223		$moduleListEndpoint = new Jetpack_Core_API_Module_List_Endpoint();
224		$modules = $moduleListEndpoint->get_modules();
225
226		// Preparing translated fields for JSON encoding by transforming all HTML entities to
227		// respective characters.
228		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...
229		$modules[ $slug ]['name'] = html_entity_decode( $data['name'] );
230		$modules[ $slug ]['description'] = html_entity_decode( $data['description'] );
231		$modules[ $slug ]['short_description'] = html_entity_decode( $data['short_description'] );
232		$modules[ $slug ]['long_description'] = html_entity_decode( $data['long_description'] );
233		}
234
235		// Get last post, to build the link to Customizer in the Related Posts module.
236		$last_post = get_posts( array( 'posts_per_page' => 1 ) );
237		$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...
238		? get_permalink( $last_post[0]->ID )
239		: get_home_url();
240
241		// Get information about current theme.
242		$current_theme = wp_get_theme();
243
244		// Get all themes that Infinite Scroll provides support for natively.
245		$inf_scr_support_themes = array();
246		foreach ( Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules/infinite-scroll/themes' ) as $path ) {
247		if ( is_readable( $path ) ) {
248		$inf_scr_support_themes[] = basename( $path, '.php' );
249		}
250		}
251
252		// Add objects to be passed to the initial state of the app
253		wp_localize_script( 'react-plugin', 'Initial_State', array(
254		'WP_API_root' => esc_url_raw( rest_url() ),
255		'WP_API_nonce' => wp_create_nonce( 'wp_rest' ),
256		'pluginBaseUrl' => plugins_url( '', JETPACK__PLUGIN_FILE ),
257		'connectionStatus' => array(
258		'isActive' => Jetpack::is_active(),
259		'isStaging' => Jetpack::is_staging_site(),
260		'devMode' => array(
261		'isActive' => $is_dev_mode,
262		'constant' => defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG,
263		'url' => site_url() && false === strpos( site_url(), '.' ),
264		'filter' => apply_filters( 'jetpack_development_mode', false ),
265		),
266		'isPublic' => '1' == get_option( 'blog_public' ),
267		'isInIdentityCrisis' => Jetpack::validate_sync_error_idc_option(),
268		),
269		'connectUrl' => Jetpack::init()->build_connect_url( true, false, false ),
270		'dismissedNotices' => $this->get_dismissed_jetpack_notices(),
271		'isDevVersion' => Jetpack::is_development_version(),
272		'currentVersion' => JETPACK__VERSION,
273		'getModules' => $modules,
274		'showJumpstart' => jetpack_show_jumpstart(),
275		'rawUrl' => Jetpack::build_raw_urls( get_home_url() ),
276		'adminUrl' => esc_url( admin_url() ),
277		'stats' => array(
278		// data is populated asynchronously on page load
279		'data' => array(
280		'general' => false,
281		'day' => false,
282		'week' => false,
283		'month' => false,
284		),
285		'roles' => $stats_roles,
286		),
287		'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 `224` 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...
288		'userData' => array(
289		// 'othersLinked' => Jetpack::get_other_linked_admins(),
290		'currentUser' => jetpack_current_user_data(),
291		),
292		'siteData' => array(
293		'icon' => has_site_icon()
294		? apply_filters( 'jetpack_photon_url', get_site_icon_url(), array( 'w' => 64 ) )
295		: '',
296		'siteVisibleToSearchEngines' => '1' == get_option( 'blog_public' ),
297		/**
298		* Whether promotions are visible or not.
299		*
300		* @since 4.8.0
301		*
302		* @param bool $are_promotions_active Status of promotions visibility. True by default.
303		*/
304		'showPromotions' => apply_filters( 'jetpack_show_promotions', true ),
305		'isAtomicSite' => jetpack_is_atomic_site(),
306		),
307		'themeData' => array(
308		'name' => $current_theme->get( 'Name' ),
309		'hasUpdate' => (bool) get_theme_update_available( $current_theme ),
310		'support' => array(
311		'infinite-scroll' => current_theme_supports( 'infinite-scroll' ) \|\| in_array( $current_theme->get_stylesheet(), $inf_scr_support_themes ),
312		),
313		),
314		'locale' => $this->get_i18n_data(),
315		'localeSlug' => join( '-', explode( '_', jetpack_get_user_locale() ) ),
316		'jetpackStateNotices' => array(
317		'messageCode' => Jetpack::state( 'message' ),
318		'errorCode' => Jetpack::state( 'error' ),
319		'errorDescription' => Jetpack::state( 'error_description' ),
320		),
321		'tracksUserData' => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
322		'currentIp' => function_exists( 'jetpack_protect_get_ip' ) ? jetpack_protect_get_ip() : false,
323		'lastPostUrl' => esc_url( $last_post ),
324		) );
325		}
326
327		/**
328		* Returns an array of modules and settings both as first class members of the object.
329		*
330		* @param array $modules the result of an API request to get all modules.
331		*
332		* @return array flattened settings with modules.
333		*/
334		function get_flattened_settings( $modules ) {
335		$core_api_endpoint = new Jetpack_Core_API_Data();
336		$settings = $core_api_endpoint->get_all_options();
337		return $settings->data;
338		}
339		}
340
341		/*
342		* Only show Jump Start on first activation.
343		* Any option 'jumpstart' other than 'new connection' will hide it.
344		*
345		* The option can be of 4 things, and will be stored as such:
346		* new_connection : Brand new connection - Show
347		* jumpstart_activated : Jump Start has been activated - dismiss
348		* jetpack_action_taken: Manual activation of a module already happened - dismiss
349		* jumpstart_dismissed : Manual dismissal of Jump Start - dismiss
350		*
351		* @todo move to functions.global.php when available
		0 ignored issues – show Coding Style Best Practice introduced 2017-03-31 20:33 UTC by Report Bug Copy Issue Report Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker. Loading history...
352		* @since 3.6
353		* @return bool \| show or hide
354		*/
355		function jetpack_show_jumpstart() {
356		if ( ! Jetpack::is_active() ) {
357		return false;
358		}
359		$jumpstart_option = Jetpack_Options::get_option( 'jumpstart' );
360
361		$hide_options = array(
362		'jumpstart_activated',
363		'jetpack_action_taken',
364		'jumpstart_dismissed'
365		);
366
367		if ( ! $jumpstart_option \|\| in_array( $jumpstart_option, $hide_options ) ) {
368		return false;
369		}
370
371		return true;
372		}
373
374		/**
375		* Gather data about the current user.
376		*
377		* @since 4.1.0
378		*
379		* @return array
380		*/
381		function jetpack_current_user_data() {
382		$current_user = wp_get_current_user();
383		$is_master_user = $current_user->ID == Jetpack_Options::get_option( 'master_user' );
384		$dotcom_data = Jetpack::get_connected_user_data();
385		// Add connected user gravatar to the returned dotcom_data.
386		$dotcom_data['avatar'] = get_avatar_url( $dotcom_data['email'], array( 'size' => 64, 'default' => 'mysteryman' ) );
387
388		$current_user_data = array(
389		'isConnected' => Jetpack::is_user_connected( $current_user->ID ),
390		'isMaster' => $is_master_user,
391		'username' => $current_user->user_login,
392		'id' => $current_user->ID,
393		'wpcomUser' => $dotcom_data,
394		'gravatar' => get_avatar( $current_user->ID, 40, 'mm', '', array( 'force_display' => true ) ),
395		'permissions' => array(
396		'admin_page' => current_user_can( 'jetpack_admin_page' ),
397		'connect' => current_user_can( 'jetpack_connect' ),
398		'disconnect' => current_user_can( 'jetpack_disconnect' ),
399		'manage_modules' => current_user_can( 'jetpack_manage_modules' ),
400		'network_admin' => current_user_can( 'jetpack_network_admin_page' ),
401		'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
402		'edit_posts' => current_user_can( 'edit_posts' ),
403		'publish_posts' => current_user_can( 'publish_posts' ),
404		'manage_options' => current_user_can( 'manage_options' ),
405		'view_stats' => current_user_can( 'view_stats' ),
406		'manage_plugins' => current_user_can( 'install_plugins' )
407		&& current_user_can( 'activate_plugins' )
408		&& current_user_can( 'update_plugins' )
409		&& current_user_can( 'delete_plugins' ),
410		),
411		);
412
413		return $current_user_data;
414		}
415
416		/**
417		* Set the admin language, based on user language.
418		*
419		* @since 4.5.0
420		*
421		* @return string
422		*
423		* @todo Remove this function when WordPress 4.8 is released
		0 ignored issues – show Coding Style introduced 2016-12-21 12:41 UTC by Report Bug Copy Issue Report Comment refers to a TODO task This check looks `TODO` comments that have been left in the code. ``TODO``s show that something is left unfinished and should be attended to. Loading history...
424		* and replace `jetpack_get_user_locale()` in this file with `get_user_locale()`.
425		*/
426		function jetpack_get_user_locale() {
427		$locale = get_locale();
428
429		if ( function_exists( 'get_user_locale' ) ) {
430		$locale = get_user_locale();
431		}
432
433		return $locale;
434		}
435

Automattic / jetpack

Push — fix/typo-pro-promo ( e5832e...fc698e )

Jetpack_React_Page C

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 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