2020-06-23 13:49:54 +02:00
< ? 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 );
2020-10-20 18:05:12 +02:00
// Inject the data-ampdevmode attribute into the inline <script> output via wp_localize_script(). To revisit after https://github.com/ampproject/amp-wp/issues/4598.
add_filter (
'amp_dev_mode_element_xpaths' ,
static function ( $expressions ) {
$expressions [] = '//script[ contains( text(), "Jetpack_Scan" ) ]' ;
return $expressions ;
}
);
2020-06-23 13:49:54 +02:00
}
/**
* 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 ;
}
2022-12-15 17:41:53 +01:00
// Check if Protect is active.
// It has its own notice in the admin bar.
if ( class_exists ( 'Jetpack_Protect' ) ) {
return false ;
}
2020-06-23 13:49:54 +02:00
// 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 ();
2022-06-16 14:01:47 +02:00
if ( $this -> has_threats () !== null ) {
2020-06-23 13:49:54 +02:00
return ;
}
// We don't know about threats in the cache lets load the JS that fetches the info and updates the admin bar.
2020-10-20 18:05:12 +02:00
Assets :: enqueue_async_script ( self :: SCRIPT_NAME , '_inc/build/scan/admin-bar-notice.min.js' , 'modules/scan/admin-bar-notice.js' , array ( 'admin-bar' ), self :: SCRIPT_VERSION , true );
2020-06-23 13:49:54 +02:00
$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!
2020-09-15 14:30:05 +02:00
$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; } }' ;
2020-06-23 13:49:54 +02:00
$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 () ) {
return 0 ;
}
$scan_state = get_transient ( 'jetpack_scan_state' );
return is_array ( $scan_state -> threats ) ? count ( $scan_state -> threats ) : 0 ;
}
}