jetpack / modules / scan / class-admin-sidebar-link.php

class-admin-sidebar-link.php in Jetpack – WP Security, Backup, Speed, & Growth 16.3-a.1, at modules/scan/class-admin-sidebar-link.php

241 lines 6.0 KB

Raw Download Zip

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\Admin_UI\Admin_Menu;
11	use Automattic\Jetpack\My_Jetpack\Products\Backup;
12	use Automattic\Jetpack\Redirect;
13	use Automattic\Jetpack\Status\Host;
14	use Jetpack_Core_Json_Api_Endpoints;
15
16	/**
17	* Class Main
18	*
19	* Responsible for showing the link if available.
20	*
21	* @package Automattic\Jetpack\Scan
22	*/
23	class Admin_Sidebar_Link {
24
25	const SCHEDULE_ACTION_HOOK = 'jetpack_scan_refresh_states_event';
26
27	/**
28	* The singleton instance of this class.
29	*
30	* @var Admin_Sidebar_Link
31	*/
32	protected static $instance;
33
34	/**
35	* Used to check if we need to schedule the refresh or we need to do it.
36	*
37	* @var boolean \| null
38	*/
39	private $schedule_refresh_checked;
40
41	/**
42	* Get the singleton instance of the class.
43	*
44	* @return Admin_Sidebar_Link
45	*/
46	public static function instance() {
47	if ( ! isset( self::$instance ) ) {
48	self::$instance = new Admin_Sidebar_Link();
49	self::$instance->init_hooks();
50	}
51
52	return self::$instance;
53	}
54
55	/**
56	* Adds action hooks.
57	*/
58	public function init_hooks() {
59	add_action( 'jetpack_admin_menu', array( $this, 'maybe_add_admin_link' ), 99 );
60	add_action( self::SCHEDULE_ACTION_HOOK, array( $this, 'refresh_state_cache' ) );
61	}
62
63	/**
64	* Adds a link to the Scan and Backup page.
65	*/
66	public function maybe_add_admin_link() {
67	if ( ! $this->should_show_link() ) {
68	return;
69	}
70
71	if ( $this->should_show_scan() ) {
72	Admin_Menu::add_menu(
73	/** "Scan" is a product name, do not translate. */
74	'Scan',
75	'Scan <span aria-hidden="true">↗</span>',
76	'manage_options',
77	esc_url( Redirect::get_url( 'cloud-scan-history-wp-menu' ) ),
78	null,
79	Admin_Menu::POSITION_EXTERNAL,
80	array( 'key' => 'jetpack-scan-cloud' )
81	);
82	}
83
84	// Add scan item which shows history page only. This is mutally exclusive from the scan item above and is only shown for Atomic sitse.
85	if ( $this->should_show_scan_history_only() ) {
86	Admin_Menu::add_menu(
87	/** "Scan" is a product name, do not translate. */
88	'Scan',
89	'Scan <span aria-hidden="true">↗</span>',
90	'manage_options',
91	esc_url( Redirect::get_url( 'cloud-scan-history-wp-menu' ) ),
92	null,
93	Admin_Menu::POSITION_EXTERNAL,
94	array( 'key' => 'jetpack-scan-cloud' )
95	);
96	}
97
98	if ( $this->should_show_backup() ) {
99	Admin_Menu::add_menu(
100	/** "VaultPress Backup" is a product name, do not translate. */
101	'VaultPress Backup',
102	'VaultPress Backup <span aria-hidden="true">↗</span>',
103	'manage_options',
104	esc_url( Redirect::get_url( 'calypso-backups' ) ),
105	null,
106	Admin_Menu::POSITION_EXTERNAL,
107	array( 'key' => 'jetpack-backup-cloud' )
108	);
109	}
110	}
111
112	/**
113	* Refreshes the state cache via API call. Called via cron.
114	*/
115	public function refresh_state_cache() {
116	Jetpack_Core_Json_Api_Endpoints::get_scan_state();
117	Jetpack_Core_Json_Api_Endpoints::get_rewind_data();
118	}
119
120	/**
121	* Returns true if the link should appear.
122	*
123	* @return boolean
124	*/
125	private function should_show_link() {
126	// Jetpack Scan/Backup is currently not supported on multisite.
127	if ( is_multisite() ) {
128	return false;
129	}
130
131	// Check if VaultPress is active, the assumption there is that VaultPress is working.
132	// It has its link the adminbar.
133	if ( class_exists( 'VaultPress' ) ) {
134	return false;
135	}
136
137	return $this->should_show_scan() \|\| $this->should_show_backup() \|\| $this->should_show_scan_history_only();
138	}
139
140	/**
141	* Check if we should display the Scan menu item.
142	*
143	* 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.
144	*
145	* @return boolean
146	*/
147	private function should_show_scan() {
148	return $this->has_scan() && ! $this->has_protect_plugin() && ! ( new Host() )->is_woa_site();
149	}
150
151	/**
152	* Check if we should display the Scan menu item history.
153	*
154	* It will only be displayed if site has Scan enabled, is an Atomic site.
155	*
156	* @return boolean
157	*/
158	private function should_show_scan_history_only() {
159	return $this->has_scan() && ( new Host() )->is_woa_site() && get_option( 'wpcom_admin_interface' ) === 'wp-admin';
160	}
161
162	/**
163	* Check if we should display the Backup menu item.
164	*
165	* 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.
166	*
167	* @return boolean
168	*/
169	private function should_show_backup() {
170	return $this->has_backup() && ! $this->has_backup_plugin();
171	}
172
173	/**
174	* Detects if Scan is enabled.
175	*
176	* @return boolean
177	*/
178	private function has_scan() {
179	$this->maybe_refresh_transient_cache();
180	$scan_state = get_transient( 'jetpack_scan_state' );
181	if ( ! $scan_state ) {
182	return false;
183	}
184
185	return isset( $scan_state->state ) && 'unavailable' !== $scan_state->state;
186	}
187
188	/**
189	* Detects if Protect plugin is active.
190	*
191	* @return boolean
192	*/
193	private function has_protect_plugin() {
194	return class_exists( 'Jetpack_Protect' );
195	}
196
197	/**
198	* Detects if Backup is enabled.
199	*
200	* @return boolean
201	*/
202	private function has_backup() {
203	$this->maybe_refresh_transient_cache();
204	$rewind_state = get_transient( 'jetpack_rewind_state' );
205	if ( ! $rewind_state ) {
206	return false;
207	}
208
209	return isset( $rewind_state->state ) && 'unavailable' !== $rewind_state->state;
210	}
211
212	/**
213	* Detects if Backup plugin is active.
214	*
215	* @return boolean
216	*/
217	private function has_backup_plugin() {
218	return Backup::is_standalone_plugin_active();
219	}
220
221	/**
222	* Triggers a cron job to refresh the Scan and Rewind state cache.
223	*/
224	private function maybe_refresh_transient_cache() {
225	if ( $this->schedule_refresh_checked ) {
226	return;
227	}
228
229	// Do we have a jetpack_scan and jetpack_rewind state set?
230	if ( get_transient( 'jetpack_scan_state' ) && get_transient( 'jetpack_rewind_state' ) ) {
231	return;
232	}
233
234	if ( false === wp_next_scheduled( self::SCHEDULE_ACTION_HOOK ) ) {
235	wp_schedule_single_event( time(), self::SCHEDULE_ACTION_HOOK );
236	}
237
238	$this->schedule_refresh_checked = true;
239	}
240	}
241