Jetpack_Admin_Page - Code Metrics - Inspection of "Admin: deactivate any active module that doesn't m..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — branch-4.4 ( b40dc3...78a28d )

unknown

created 2016-11-18 15:33 UTC

Jetpack_Admin_Page B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	175
Duplicated Lines	7.43 %

Coupling/Cohesion

Components	3
Dependencies	2

Importance

Changes

Metric	Value
dl	13
loc	175
rs	8.2857
c	0
b	0
f	0
wmc	39
lcom	3
cbo	2

17 Methods

Rating	Name	Duplication	Size	Complexity
	add_page_actions()	0	1	?
	get_page_hook()	0	1	?
	page_admin_scripts()	0	1	?
	page_render()	0	1	?
A	additional_styles()	0	1	1
A	__construct()	0	10	3
B	add_actions()	0	27	6
A	admin_head()	13	15	4
A	render()	0	8	2
A	admin_help()	0	3	1
A	admin_page_load()	0	4	1
A	admin_page_top()	0	3	1
A	admin_page_bottom()	0	3	1
A	admin_scripts()	0	4	1
A	admin_styles()	0	7	3
A	is_wp_version_too_old()	0	4	2
C	check_plan_deactivate_modules()	0	37	13

How to fix Duplicated Code

<?php

// Shared logic between Jetpack admin pages
abstract class Jetpack_Admin_Page {
	// Add page specific actions given the page hook
	abstract function add_page_actions( $hook );

	// Create a menu item for the page and returns the hook
	abstract function get_page_hook();

	// Enqueue and localize page specific scripts
	abstract function page_admin_scripts();

	// Render page specific HTML
	abstract function page_render();

	/**
	 * Should we block the page rendering because the site is in IDC?
	 * @var bool
	 */
	static $block_page_rendering_for_idc;
class A {
    var $property;
}

	/**
	 * Function called after admin_styles to load any additional needed styles.
	 *
	 * @since 4.3.0
	 */
	function additional_styles() {}

	function __construct() {
		$this->jetpack = Jetpack::init();
class MyClass { }

$x = new MyClass();
$x->foo = true;
		self::$block_page_rendering_for_idc = (
			Jetpack::validate_sync_error_idc_option() && ! Jetpack_Options::get_option( 'safe_mode_confirmed' )
		);

		if ( ! self::$block_page_rendering_for_idc ) {
			add_action( 'admin_enqueue_scripts', array( $this, 'additional_styles' ) );
		}
	}

	function add_actions() {

		// If user is not an admin and site is in Dev Mode, don't do anything
		if ( ! current_user_can( 'manage_options' ) && Jetpack::is_development_mode() ) {
			return;
		}

		// Don't add in the modules page unless modules are available!
		if ( $this->dont_show_if_not_active && ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
class MyClass { }

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

		// Initialize menu item for the page in the admin
		$hook = $this->get_page_hook();

		// Attach hooks common to all Jetpack admin pages based on the created
		// hook
		add_action( "load-$hook",                array( $this, 'admin_help'      ) );
		add_action( "load-$hook",                array( $this, 'admin_page_load' ) );
		add_action( "admin_head-$hook",          array( $this, 'admin_head'      ) );

		add_action( "admin_print_styles-$hook",  array( $this, 'admin_styles'    ) );
		add_action( "admin_print_scripts-$hook", array( $this, 'admin_scripts'   ) );

		// Attach page specific actions in addition to the above
		$this->add_page_actions( $hook );
	}

	function admin_head() {
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
			/**
			 * Fires in the <head> of a particular Jetpack configuation page.
			 *
			 * The dynamic portion of the hook name, `$_GET['configure']`,
			 * refers to the slug of module, such as 'stats', 'sso', etc.
			 * A complete hook for the latter would be
			 * 'jetpack_module_configuation_head_sso'.
			 *
			 * @since 3.0.0
			 */
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
		}
	}

	// Render the page with a common top and bottom part, and page specific content
	function render() {
		// We're in an IDC: we need a decision made before we show the UI again.
		if ( self::$block_page_rendering_for_idc ) {
			return;
		}

		$this->page_render();
	}

	function admin_help() {
		$this->jetpack->admin_help();
	}

	function admin_page_load() {
		// This is big.  For the moment, just call the existing one.
		$this->jetpack->admin_page_load();
	}

	function admin_page_top() {
		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
	}

	function admin_page_bottom() {
		include_once( JETPACK__PLUGIN_DIR . '_inc/footer.php' );
	}

	// Add page specific scripts and jetpack stats for all menu pages
	function admin_scripts() {
		$this->page_admin_scripts(); // Delegate to inheriting class
		add_action( 'admin_footer', array( $this->jetpack, 'do_stats' ) );
	}

	// Enqueue the Jetpack admin stylesheet
	function admin_styles() {
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';

		wp_enqueue_style( 'jetpack-admin', plugins_url( "css/jetpack-admin{$min}.css", JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION . '-20121016' );
		wp_style_add_data( 'jetpack-admin', 'rtl', 'replace' );
		wp_style_add_data( 'jetpack-admin', 'suffix', $min );
	}

	function is_wp_version_too_old() {
		global $wp_version;
		return ( ! function_exists( 'rest_api_init' ) || version_compare( $wp_version, '4.4-z', '<=' ) );
	}

	/**
	 * Checks the site plan and deactivates modules that were active but are no longer included in the plan.
	 *
	 * @since 4.4.0
	 *
	 * @param $page
	 *
	 * @return bool|array
	 */
	function check_plan_deactivate_modules( $page ) {
		if ( 'admin_page_jetpack_modules' !== $page && 'jetpack_page_jetpack_modules' !== $page ) {
			return false;
		}
		$previous = get_option( 'jetpack_active_plan', '' );
		$response = rest_do_request( new WP_REST_Request( 'GET', '/jetpack/v4/site' ) );
		$current = $response->get_data();
		$current = json_decode( $current['data'] );
		$to_deactivate = array();
		if ( isset( $current->plan->product_slug ) ) {
			if ( empty( $previous ) || ! isset( $previous['product_slug'] ) || $previous['product_slug'] !== $current->plan->product_slug ) {
				$active = Jetpack::get_active_modules();
				switch ( $current->plan->product_slug ) {
					case 'jetpack_free':
						$to_deactivate = array( 'seo-tools', 'videopress' );
						break;
					case 'jetpack_personal':
					case 'jetpack_personal_monthly':
						$to_deactivate = array( 'seo-tools', 'videopress' );
						break;
					case 'jetpack_premium':
					case 'jetpack_premium_monthly':
						$to_deactivate = array( 'seo-tools' );
						break;
				}
				$to_deactivate = array_intersect( $active, $to_deactivate );
				if ( ! empty( $to_deactivate ) ) {
					Jetpack::update_active_modules( array_filter( array_diff( $active, $to_deactivate ) ) );
				}
			}
		}
		return array(
			'previous'   => $previous,
			'current'    => $current,
			'deactivate' => $to_deactivate
		);
	}
}


1		<?php
2
3		// Shared logic between Jetpack admin pages
4		abstract class Jetpack_Admin_Page {
5		// Add page specific actions given the page hook
6		abstract function add_page_actions( $hook );
7
8		// Create a menu item for the page and returns the hook
9		abstract function get_page_hook();
10
11		// Enqueue and localize page specific scripts
12		abstract function page_admin_scripts();
13
14		// Render page specific HTML
15		abstract function page_render();
16
17		/**
18		* Should we block the page rendering because the site is in IDC?
19		* @var bool
20		*/
21		static $block_page_rendering_for_idc;
		0 ignored issues – show Coding Style introduced 2016-11-14 20:40 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$block_page_rendering_for_idc`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
22
23		/**
24		* Function called after admin_styles to load any additional needed styles.
25		*
26		* @since 4.3.0
27		*/
28		function additional_styles() {}
29
30		function __construct() {
31		$this->jetpack = Jetpack::init();
		0 ignored issues – show Bug introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The property `jetpack` 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...
32		self::$block_page_rendering_for_idc = (
33		Jetpack::validate_sync_error_idc_option() && ! Jetpack_Options::get_option( 'safe_mode_confirmed' )
34		);
35
36		if ( ! self::$block_page_rendering_for_idc ) {
37		add_action( 'admin_enqueue_scripts', array( $this, 'additional_styles' ) );
38		}
39		}
40
41		function add_actions() {
42
43		// If user is not an admin and site is in Dev Mode, don't do anything
44		if ( ! current_user_can( 'manage_options' ) && Jetpack::is_development_mode() ) {
45		return;
46		}
47
48		// Don't add in the modules page unless modules are available!
49		if ( $this->dont_show_if_not_active && ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
		0 ignored issues – show Bug introduced 2015-11-20 23:03 UTC by Report Bug Copy Issue Report The property `dont_show_if_not_active` 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...
50		return;
51		}
52
53		// Initialize menu item for the page in the admin
54		$hook = $this->get_page_hook();
55
56		// Attach hooks common to all Jetpack admin pages based on the created
57		// hook
58		add_action( "load-$hook", array( $this, 'admin_help' ) );
59		add_action( "load-$hook", array( $this, 'admin_page_load' ) );
60		add_action( "admin_head-$hook", array( $this, 'admin_head' ) );
61
62		add_action( "admin_print_styles-$hook", array( $this, 'admin_styles' ) );
63		add_action( "admin_print_scripts-$hook", array( $this, 'admin_scripts' ) );
64
65		// Attach page specific actions in addition to the above
66		$this->add_page_actions( $hook );
67		}
68
69		function admin_head() {
70	View Code Duplication	if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
71		/**
72		* Fires in the <head> of a particular Jetpack configuation page.
73		*
74		* The dynamic portion of the hook name, `$_GET['configure']`,
75		* refers to the slug of module, such as 'stats', 'sso', etc.
76		* A complete hook for the latter would be
77		* 'jetpack_module_configuation_head_sso'.
78		*
79		* @since 3.0.0
80		*/
81		do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
82		}
83		}
84
85		// Render the page with a common top and bottom part, and page specific content
86		function render() {
87		// We're in an IDC: we need a decision made before we show the UI again.
88		if ( self::$block_page_rendering_for_idc ) {
89		return;
90		}
91
92		$this->page_render();
93		}
94
95		function admin_help() {
96		$this->jetpack->admin_help();
97		}
98
99		function admin_page_load() {
100		// This is big. For the moment, just call the existing one.
101		$this->jetpack->admin_page_load();
102		}
103
104		function admin_page_top() {
105		include_once( JETPACK__PLUGIN_DIR . '_inc/header.php' );
106		}
107
108		function admin_page_bottom() {
109		include_once( JETPACK__PLUGIN_DIR . '_inc/footer.php' );
110		}
111
112		// Add page specific scripts and jetpack stats for all menu pages
113		function admin_scripts() {
114		$this->page_admin_scripts(); // Delegate to inheriting class
115		add_action( 'admin_footer', array( $this->jetpack, 'do_stats' ) );
116		}
117
118		// Enqueue the Jetpack admin stylesheet
119		function admin_styles() {
120		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
121
122		wp_enqueue_style( 'jetpack-admin', plugins_url( "css/jetpack-admin{$min}.css", JETPACK__PLUGIN_FILE ), array( 'genericons' ), JETPACK__VERSION . '-20121016' );
123		wp_style_add_data( 'jetpack-admin', 'rtl', 'replace' );
124		wp_style_add_data( 'jetpack-admin', 'suffix', $min );
125		}
126
127		function is_wp_version_too_old() {
128		global $wp_version;
129		return ( ! function_exists( 'rest_api_init' ) \|\| version_compare( $wp_version, '4.4-z', '<=' ) );
130		}
131
132		/**
133		* Checks the site plan and deactivates modules that were active but are no longer included in the plan.
134		*
135		* @since 4.4.0
136		*
137		* @param $page
138		*
139		* @return bool\|array
140		*/
141		function check_plan_deactivate_modules( $page ) {
142		if ( 'admin_page_jetpack_modules' !== $page && 'jetpack_page_jetpack_modules' !== $page ) {
143		return false;
144		}
145		$previous = get_option( 'jetpack_active_plan', '' );
146		$response = rest_do_request( new WP_REST_Request( 'GET', '/jetpack/v4/site' ) );
147		$current = $response->get_data();
148		$current = json_decode( $current['data'] );
149		$to_deactivate = array();
150		if ( isset( $current->plan->product_slug ) ) {
151		if ( empty( $previous ) \|\| ! isset( $previous['product_slug'] ) \|\| $previous['product_slug'] !== $current->plan->product_slug ) {
152		$active = Jetpack::get_active_modules();
153		switch ( $current->plan->product_slug ) {
154		case 'jetpack_free':
155		$to_deactivate = array( 'seo-tools', 'videopress' );
156		break;
157		case 'jetpack_personal':
158		case 'jetpack_personal_monthly':
159		$to_deactivate = array( 'seo-tools', 'videopress' );
160		break;
161		case 'jetpack_premium':
162		case 'jetpack_premium_monthly':
163		$to_deactivate = array( 'seo-tools' );
164		break;
165		}
166		$to_deactivate = array_intersect( $active, $to_deactivate );
167		if ( ! empty( $to_deactivate ) ) {
168		Jetpack::update_active_modules( array_filter( array_diff( $active, $to_deactivate ) ) );
169		}
170		}
171		}
172		return array(
173		'previous' => $previous,
174		'current' => $current,
175		'deactivate' => $to_deactivate
176		);
177		}
178		}
179

Automattic / jetpack

Push — branch-4.4 ( b40dc3...78a28d )

Jetpack_Admin_Page B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

17 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like