admin-bar-notice.js
6 years ago
class-admin-bar-notice.php
3 years ago
class-admin-sidebar-link.php
3 years ago
scan.php
4 years ago
class-admin-sidebar-link.php
226 lines
| 1 | <?php |
| 2 | /** |
| 3 | * A class that adds a scan and backup link to the admin sidebar. |
| 4 | * |
| 5 | * @package automattic/jetpack |
| 6 | */ |
| 7 | |
| 8 | namespace Automattic\Jetpack\Scan; |
| 9 | |
| 10 | use Automattic\Jetpack\My_Jetpack\Products\Backup; |
| 11 | use Automattic\Jetpack\Redirect; |
| 12 | use Automattic\Jetpack\Status\Host; |
| 13 | use Jetpack_Core_Json_Api_Endpoints; |
| 14 | |
| 15 | /** |
| 16 | * Class Main |
| 17 | * |
| 18 | * Responsible for showing the link if available. |
| 19 | * |
| 20 | * @package Automattic\Jetpack\Scan |
| 21 | */ |
| 22 | class Admin_Sidebar_Link { |
| 23 | |
| 24 | const SCHEDULE_ACTION_HOOK = 'jetpack_scan_refresh_states_event'; |
| 25 | |
| 26 | /** |
| 27 | * The singleton instance of this class. |
| 28 | * |
| 29 | * @var Admin_Sidebar_Link |
| 30 | */ |
| 31 | protected static $instance; |
| 32 | |
| 33 | /** |
| 34 | * Used to check if we need to schedule the refresh or we need to do it. |
| 35 | * |
| 36 | * @var boolean | null |
| 37 | */ |
| 38 | private $schedule_refresh_checked; |
| 39 | |
| 40 | /** |
| 41 | * Get the singleton instance of the class. |
| 42 | * |
| 43 | * @return Admin_Sidebar_Link |
| 44 | */ |
| 45 | public static function instance() { |
| 46 | if ( ! isset( self::$instance ) ) { |
| 47 | self::$instance = new Admin_Sidebar_Link(); |
| 48 | self::$instance->init_hooks(); |
| 49 | } |
| 50 | |
| 51 | return self::$instance; |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Adds action hooks. |
| 56 | */ |
| 57 | public function init_hooks() { |
| 58 | add_action( 'jetpack_admin_menu', array( $this, 'maybe_add_admin_link' ), 99 ); |
| 59 | add_action( self::SCHEDULE_ACTION_HOOK, array( $this, 'refresh_state_cache' ) ); |
| 60 | } |
| 61 | |
| 62 | /** |
| 63 | * Adds a link to the Scan and Backup page. |
| 64 | */ |
| 65 | public function maybe_add_admin_link() { |
| 66 | if ( ! $this->should_show_link() ) { |
| 67 | return; |
| 68 | } |
| 69 | |
| 70 | if ( $this->should_show_scan() ) { |
| 71 | $menu_label = __( 'Scan', 'jetpack' ); |
| 72 | $url = Redirect::get_url( 'calypso-scanner' ); |
| 73 | add_submenu_page( 'jetpack', $menu_label, esc_html( $menu_label ) . ' <span class="dashicons dashicons-external"></span>', 'manage_options', esc_url( $url ), null, $this->get_link_offset() ); |
| 74 | } |
| 75 | |
| 76 | if ( $this->should_show_backup() ) { |
| 77 | $menu_label = __( 'VaultPress', 'jetpack' ); |
| 78 | $url = Redirect::get_url( 'calypso-backups' ); |
| 79 | add_submenu_page( 'jetpack', $menu_label, esc_html( $menu_label ) . ' <span class="dashicons dashicons-external"></span>', 'manage_options', esc_url( $url ), null, $this->get_link_offset() ); |
| 80 | } |
| 81 | } |
| 82 | |
| 83 | /** |
| 84 | * We create a menu offset by counting all the pages that have a jetpack_admin_page set as the capability. |
| 85 | * |
| 86 | * This makes it so that the highlight of the pages works as expected. When you click on the Setting or Dashboard. |
| 87 | * |
| 88 | * @return int Menu offset. |
| 89 | */ |
| 90 | private function get_link_offset() { |
| 91 | global $submenu; |
| 92 | $offset = 0; |
| 93 | |
| 94 | if ( ! array_key_exists( 'jetpack', $submenu ) ) { |
| 95 | return $offset; |
| 96 | } |
| 97 | |
| 98 | foreach ( $submenu['jetpack'] as $link ) { |
| 99 | if ( 'jetpack_admin_page' !== $link[1] ) { |
| 100 | break; |
| 101 | } |
| 102 | ++$offset; |
| 103 | } |
| 104 | |
| 105 | return $offset; |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Refreshes the state cache via API call. Called via cron. |
| 110 | */ |
| 111 | public function refresh_state_cache() { |
| 112 | Jetpack_Core_Json_Api_Endpoints::get_scan_state(); |
| 113 | Jetpack_Core_Json_Api_Endpoints::get_rewind_data(); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Returns true if the link should appear. |
| 118 | * |
| 119 | * @return boolean |
| 120 | */ |
| 121 | private function should_show_link() { |
| 122 | // Jetpack Scan/Backup is currently not supported on multisite. |
| 123 | if ( is_multisite() ) { |
| 124 | return false; |
| 125 | } |
| 126 | |
| 127 | // Check if VaultPress is active, the assumption there is that VaultPress is working. |
| 128 | // It has its link the adminbar. |
| 129 | if ( class_exists( 'VaultPress' ) ) { |
| 130 | return false; |
| 131 | } |
| 132 | |
| 133 | return $this->should_show_scan() || $this->should_show_backup(); |
| 134 | } |
| 135 | |
| 136 | /** |
| 137 | * Check if we should display the Scan menu item. |
| 138 | * |
| 139 | * It will only be displayed if site has Scan enabled, is not an Atomic site, and the stand-alone Protect plugin is not active, because it will have a menu item of its own. |
| 140 | * |
| 141 | * @return boolean |
| 142 | */ |
| 143 | private function should_show_scan() { |
| 144 | return $this->has_scan() && ! $this->has_protect_plugin() && ! ( new Host() )->is_woa_site(); |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Check if we should display the Backup menu item. |
| 149 | * |
| 150 | * It will only be displayed if site has Backup enabled and the stand-alone Backup plugin is not active, because it will have a menu item of its own. |
| 151 | * |
| 152 | * @return boolean |
| 153 | */ |
| 154 | private function should_show_backup() { |
| 155 | return $this->has_backup() && ! $this->has_backup_plugin(); |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Detects if Scan is enabled. |
| 160 | * |
| 161 | * @return boolean |
| 162 | */ |
| 163 | private function has_scan() { |
| 164 | $this->maybe_refresh_transient_cache(); |
| 165 | $scan_state = get_transient( 'jetpack_scan_state' ); |
| 166 | if ( ! $scan_state ) { |
| 167 | return false; |
| 168 | } |
| 169 | |
| 170 | return isset( $scan_state->state ) && 'unavailable' !== $scan_state->state; |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * Detects if Protect plugin is active. |
| 175 | * |
| 176 | * @return boolean |
| 177 | */ |
| 178 | private function has_protect_plugin() { |
| 179 | return class_exists( 'Jetpack_Protect' ); |
| 180 | } |
| 181 | |
| 182 | /** |
| 183 | * Detects if Backup is enabled. |
| 184 | * |
| 185 | * @return boolean |
| 186 | */ |
| 187 | private function has_backup() { |
| 188 | $this->maybe_refresh_transient_cache(); |
| 189 | $rewind_state = get_transient( 'jetpack_rewind_state' ); |
| 190 | if ( ! $rewind_state ) { |
| 191 | return false; |
| 192 | } |
| 193 | |
| 194 | return isset( $rewind_state->state ) && 'unavailable' !== $rewind_state->state; |
| 195 | } |
| 196 | |
| 197 | /** |
| 198 | * Detects if Backup plugin is active. |
| 199 | * |
| 200 | * @return boolean |
| 201 | */ |
| 202 | private function has_backup_plugin() { |
| 203 | return Backup::is_active(); |
| 204 | } |
| 205 | |
| 206 | /** |
| 207 | * Triggers a cron job to refresh the Scan and Rewind state cache. |
| 208 | */ |
| 209 | private function maybe_refresh_transient_cache() { |
| 210 | if ( $this->schedule_refresh_checked ) { |
| 211 | return; |
| 212 | } |
| 213 | |
| 214 | // Do we have a jetpack_scan and jetpack_rewind state set? |
| 215 | if ( get_transient( 'jetpack_scan_state' ) && get_transient( 'jetpack_rewind_state' ) ) { |
| 216 | return; |
| 217 | } |
| 218 | |
| 219 | if ( false === wp_next_scheduled( self::SCHEDULE_ACTION_HOOK ) ) { |
| 220 | wp_schedule_single_event( time(), self::SCHEDULE_ACTION_HOOK ); |
| 221 | } |
| 222 | |
| 223 | $this->schedule_refresh_checked = true; |
| 224 | } |
| 225 | } |
| 226 |