Admin_Bar_Notice::init_hooks() - Code Metrics - Inspection of "Changelog: add #15849" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/86-changelog ( 142a60...d9a8fc )

by Jeremy

created 2020-05-26 13:27 UTC

Admin_Bar_Notice::init_hooks() A

↳ Parent: Admin_Bar_Notice

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0

<?php
/**
 * A class that adds the scan notice to the admin bar.
 *
 * @package automattic/jetpack
 */

namespace Automattic\Jetpack\Scan;

use Automattic\Jetpack\Assets;
use Automattic\Jetpack\Redirect;

/**
 * Class Main
 *
 * Responsible for loading the admin bar notice if threats are found.
 *
 * @package Automattic\Jetpack\Scan
 */
class Admin_Bar_Notice {
	const SCRIPT_NAME    = 'jetpack-scan-show-notice';
	const SCRIPT_VERSION = '1';

	/**
	 * The singleton instance of this class.
	 *
	 * @var Admin_Bar_Notice
	 */
	protected static $instance;

	/**
	 * Get the singleton instance of the class.
	 *
	 * @return Admin_Bar_Notice
	 */
	public static function instance() {
		if ( ! isset( self::$instance ) ) {
			self::$instance = new Admin_Bar_Notice();
			self::$instance->init_hooks();
		}

		return self::$instance;
	}
	/**
	 * Initalize the hooks as needed.
	 */
	private function init_hooks() {
		if ( ! $this->should_try_to_display_notice() ) {
			return;
		}

		add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_toolbar_script' ) );
		add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_toolbar_script' ) );
		add_action( 'admin_bar_menu', array( $this, 'add_threats_to_toolbar' ), 999 );
	}

	/**
	 * Whether to even try to display the notice or now.
	 *
	 * @return bool
	 */
	private function should_try_to_display_notice() {
		// Jetpack Scan is currently not supported on multisite.
		if ( is_multisite() ) {
			return false;
		}

		// Check if VaultPress is active, the assumtion there is that VaultPress is working.
		// It has its own notice in the admin bar.
		if ( class_exists( 'VaultPress' ) ) {
			return false;
		}

		// Only show the notice to admins.
		if ( ! current_user_can( 'manage_options' ) ) {
			return false;
		}

		return true;
	}

	/**
	 * Add the inline styles and scripts if they are needed.
	 */
	public function enqueue_toolbar_script() {
		$this->add_inline_styles();

		if ( ! is_null( $this->has_threats() ) ) {
			return;
		}

		// We don't know about threats in the cache lets load the JS that fetches the info and updates the admin bar.
		Assets::enqueue_async_script( self::SCRIPT_NAME, '_inc/build/scan/admin-bar-notice.min.js', 'modules/scan/admin-bar-notice.js', array(), self::SCRIPT_VERSION, true );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$script_data = array(
			'nonce'              => wp_create_nonce( 'wp_rest' ),
			'scan_endpoint'      => get_rest_url( null, 'jetpack/v4/scan' ),
			'scan_dashboard_url' => Redirect::get_url( 'calypso-scanner' ),
			/* translators: %s is the alert icon */
			'singular'           => sprintf( esc_html__( '%s Threat found', 'jetpack' ), $this->get_icon() ),
			/* translators: %s is the alert icon */
			'multiple'           => sprintf( esc_html__( '%s Threats found', 'jetpack' ), $this->get_icon() ),
		);
		wp_localize_script( self::SCRIPT_NAME, 'Jetpack_Scan', $script_data );
	}

	/**
	 * Adds the inline styles if they are needed.
	 */
	public function add_inline_styles() {
		// We know there are no threats so lets not include any css.
		if ( false === $this->has_threats() ) {
			return;
		}

		// We might be showing the threats in the admin bar lets make sure that they look great!
		$hide_wording_on_mobile = '#wp-admin-bar-jetpack-scan-notice .is-hidden { display:none; } @media screen and (max-width: 959px ) { #wpadminbar #wp-admin-bar-jetpack-scan-notice { width:32px; } #wpadminbar #wp-admin-bar-jetpack-scan-notice a { color: transparent!important; }';
		$style                  = '#wp-admin-bar-jetpack-scan-notice svg { float:left; margin-top: 4px; margin-right: 6px; width: 18px; height: 22px; }' . $hide_wording_on_mobile;
		if ( is_rtl() ) {
			$style = '#wp-admin-bar-jetpack-scan-notice svg { float:right; margin-top: 4px; margin-left: 6px; width: 18px; height: 22px; }' . $hide_wording_on_mobile;
		}
		wp_add_inline_style( 'admin-bar', $style );
	}

	/**
	 * Add the link to the admin bar.
	 *
	 * @param WP_Admin_Bar $wp_admin_bar WP Admin Bar class object.
	 */
	public function add_threats_to_toolbar( $wp_admin_bar ) {
		if ( ! $this->should_try_to_display_notice() ) {
			return;
		}

		$has_threats = $this->has_threats();
		if ( false === $has_threats ) {
			return;
		}

		$node = array(
			'id'     => 'jetpack-scan-notice',
			'title'  => '',
			'parent' => 'top-secondary',
			'meta'   => array(
				'title' => esc_attr__( 'View security scan details', 'jetpack' ),
				'class' => 'error is-hidden',
			),
		);

		if ( $has_threats ) {
			$node['href']            = esc_url( Redirect::get_url( 'calypso-scanner' ) );
			$node['meta']['onclick'] = 'window.open( this.href ); return false;';
			$node['meta']['class']   = 'error';
			$node['title']           = sprintf(
				esc_html(
				/* translators: %s is the alert icon */
					_n( '%s Threat found', '%s Threats found', $this->get_threat_count(), 'jetpack' )
				),
				$this->get_icon()
			);
		}

		$wp_admin_bar->add_node( $node );
	}

	/**
	 * Returns the shield icon.
	 *
	 * @return string
	 */
	private function get_icon() {
		return '<svg width="18" height="22" viewBox="0 0 18 22" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9 0L0 4V10C0 15.55 3.84 20.74 9 22C14.16 20.74 18 15.55 18 10V4L9 0Z" fill="#D63638"/><path d="M7.99121 6.00894H10.0085V11.9968H7.99121V6.00894Z" fill="#FFF"/><path d="M7.99121 14.014H10.0085V15.9911H7.99121V14.014Z" fill="#FFF"/></svg>';
	}

	/**
	 *
	 * Return Whether boolean cached threats exist or null if the state is unknown.
	 * * @return boolean or null
	 */
	public function has_threats() {
		$scan_state = get_transient( 'jetpack_scan_state' );
		if ( empty( $scan_state ) ) {
			return null;
		}
		// Return true if there is at least one threat found.
		return (bool) isset( $scan_state->threats[0] );
	}

	/**
	 * Returns the number of threats found or 0.
	 *
	 * @return int
	 */
	public function get_threat_count() {
		if ( ! $this->has_threats() ) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
			return 0;
		}

		$scan_state = get_transient( 'jetpack_scan_state' );
		return is_array( $scan_state->threats ) ? count( $scan_state->threats ) : 0;
	}
}


1			<?php
2			/**
3			* A class that adds the scan notice to the admin bar.
4			*
5			* @package automattic/jetpack
6			*/
7
8			namespace Automattic\Jetpack\Scan;
9
10			use Automattic\Jetpack\Assets;
11			use Automattic\Jetpack\Redirect;
12
13			/**
14			* Class Main
15			*
16			* Responsible for loading the admin bar notice if threats are found.
17			*
18			* @package Automattic\Jetpack\Scan
19			*/
20			class Admin_Bar_Notice {
21			const SCRIPT_NAME = 'jetpack-scan-show-notice';
22			const SCRIPT_VERSION = '1';
23
24			/**
25			* The singleton instance of this class.
26			*
27			* @var Admin_Bar_Notice
28			*/
29			protected static $instance;
30
31			/**
32			* Get the singleton instance of the class.
33			*
34			* @return Admin_Bar_Notice
35			*/
36			public static function instance() {
37			if ( ! isset( self::$instance ) ) {
38			self::$instance = new Admin_Bar_Notice();
39			self::$instance->init_hooks();
40			}
41
42			return self::$instance;
43			}
44			/**
45			* Initalize the hooks as needed.
46			*/
47			private function init_hooks() {
48			if ( ! $this->should_try_to_display_notice() ) {
49			return;
50			}
51
52			add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_toolbar_script' ) );
53			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_toolbar_script' ) );
54			add_action( 'admin_bar_menu', array( $this, 'add_threats_to_toolbar' ), 999 );
55			}
56
57			/**
58			* Whether to even try to display the notice or now.
59			*
60			* @return bool
61			*/
62			private function should_try_to_display_notice() {
63			// Jetpack Scan is currently not supported on multisite.
64			if ( is_multisite() ) {
65			return false;
66			}
67
68			// Check if VaultPress is active, the assumtion there is that VaultPress is working.
69			// It has its own notice in the admin bar.
70			if ( class_exists( 'VaultPress' ) ) {
71			return false;
72			}
73
74			// Only show the notice to admins.
75			if ( ! current_user_can( 'manage_options' ) ) {
76			return false;
77			}
78
79			return true;
80			}
81
82			/**
83			* Add the inline styles and scripts if they are needed.
84			*/
85			public function enqueue_toolbar_script() {
86			$this->add_inline_styles();
87
88			if ( ! is_null( $this->has_threats() ) ) {
89			return;
90			}
91
92			// We don't know about threats in the cache lets load the JS that fetches the info and updates the admin bar.
93			Assets::enqueue_async_script( self::SCRIPT_NAME, '_inc/build/scan/admin-bar-notice.min.js', 'modules/scan/admin-bar-notice.js', array(), self::SCRIPT_VERSION, true );
			0 ignored issues – show Documentation introduced 2020-05-20 09:31 UTC by Report Bug Copy Issue Report `self::SCRIPT_VERSION` is of type `string`, but the function expects a `boolean`. 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...
94
95			$script_data = array(
96			'nonce' => wp_create_nonce( 'wp_rest' ),
97			'scan_endpoint' => get_rest_url( null, 'jetpack/v4/scan' ),
98			'scan_dashboard_url' => Redirect::get_url( 'calypso-scanner' ),
99			/* translators: %s is the alert icon */
100			'singular' => sprintf( esc_html__( '%s Threat found', 'jetpack' ), $this->get_icon() ),
101			/* translators: %s is the alert icon */
102			'multiple' => sprintf( esc_html__( '%s Threats found', 'jetpack' ), $this->get_icon() ),
103			);
104			wp_localize_script( self::SCRIPT_NAME, 'Jetpack_Scan', $script_data );
105			}
106
107			/**
108			* Adds the inline styles if they are needed.
109			*/
110			public function add_inline_styles() {
111			// We know there are no threats so lets not include any css.
112			if ( false === $this->has_threats() ) {
113			return;
114			}
115
116			// We might be showing the threats in the admin bar lets make sure that they look great!
117			$hide_wording_on_mobile = '#wp-admin-bar-jetpack-scan-notice .is-hidden { display:none; } @media screen and (max-width: 959px ) { #wpadminbar #wp-admin-bar-jetpack-scan-notice { width:32px; } #wpadminbar #wp-admin-bar-jetpack-scan-notice a { color: transparent!important; }';
118			$style = '#wp-admin-bar-jetpack-scan-notice svg { float:left; margin-top: 4px; margin-right: 6px; width: 18px; height: 22px; }' . $hide_wording_on_mobile;
119			if ( is_rtl() ) {
120			$style = '#wp-admin-bar-jetpack-scan-notice svg { float:right; margin-top: 4px; margin-left: 6px; width: 18px; height: 22px; }' . $hide_wording_on_mobile;
121			}
122			wp_add_inline_style( 'admin-bar', $style );
123			}
124
125			/**
126			* Add the link to the admin bar.
127			*
128			* @param WP_Admin_Bar $wp_admin_bar WP Admin Bar class object.
129			*/
130			public function add_threats_to_toolbar( $wp_admin_bar ) {
131			if ( ! $this->should_try_to_display_notice() ) {
132			return;
133			}
134
135			$has_threats = $this->has_threats();
136			if ( false === $has_threats ) {
137			return;
138			}
139
140			$node = array(
141			'id' => 'jetpack-scan-notice',
142			'title' => '',
143			'parent' => 'top-secondary',
144			'meta' => array(
145			'title' => esc_attr__( 'View security scan details', 'jetpack' ),
146			'class' => 'error is-hidden',
147			),
148			);
149
150			if ( $has_threats ) {
151			$node['href'] = esc_url( Redirect::get_url( 'calypso-scanner' ) );
152			$node['meta']['onclick'] = 'window.open( this.href ); return false;';
153			$node['meta']['class'] = 'error';
154			$node['title'] = sprintf(
155			esc_html(
156			/* translators: %s is the alert icon */
157			_n( '%s Threat found', '%s Threats found', $this->get_threat_count(), 'jetpack' )
158			),
159			$this->get_icon()
160			);
161			}
162
163			$wp_admin_bar->add_node( $node );
164			}
165
166			/**
167			* Returns the shield icon.
168			*
169			* @return string
170			*/
171			private function get_icon() {
172			return '<svg width="18" height="22" viewBox="0 0 18 22" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M9 0L0 4V10C0 15.55 3.84 20.74 9 22C14.16 20.74 18 15.55 18 10V4L9 0Z" fill="#D63638"/><path d="M7.99121 6.00894H10.0085V11.9968H7.99121V6.00894Z" fill="#FFF"/><path d="M7.99121 14.014H10.0085V15.9911H7.99121V14.014Z" fill="#FFF"/></svg>';
173			}
174
175			/**
176			*
177			* Return Whether boolean cached threats exist or null if the state is unknown.
178			* * @return boolean or null
179			*/
180			public function has_threats() {
181			$scan_state = get_transient( 'jetpack_scan_state' );
182			if ( empty( $scan_state ) ) {
183			return null;
184			}
185			// Return true if there is at least one threat found.
186			return (bool) isset( $scan_state->threats[0] );
187			}
188
189			/**
190			* Returns the number of threats found or 0.
191			*
192			* @return int
193			*/
194			public function get_threat_count() {
195			if ( ! $this->has_threats() ) {
			0 ignored issues – show Bug Best Practice introduced 2020-05-20 11:56 UTC by Report Bug Copy Issue Report The expression `$this->has_threats()` of type `null\|boolean` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
196			return 0;
197			}
198
199			$scan_state = get_transient( 'jetpack_scan_state' );
200			return is_array( $scan_state->threats ) ? count( $scan_state->threats ) : 0;
201			}
202			}
203

Automattic / jetpack

Push — add/86-changelog ( 142a60...d9a8fc )

Admin_Bar_Notice::init_hooks() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like