class.jetpack-admin.php — Jetpack – WP Security, Backup, Speed, & Growth 12.4.2

jetpack / class.jetpack-admin.php

jetpack Last commit date

class.jetpack-admin.php

634 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* Build the Jetpack admin menu as a whole.
4	*
5	* @package automattic/jetpack
6	*/
7
8	use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
9	use Automattic\Jetpack\Partner_Coupon as Jetpack_Partner_Coupon;
10	use Automattic\Jetpack\Status;
11	use Automattic\Jetpack\Status\Host;
12
13	/**
14	* Build the Jetpack admin menu as a whole.
15	*/
16	class Jetpack_Admin {
17
18	/**
19	* Static instance.
20	*
21	* @var Jetpack_Admin
22	*/
23	private static $instance = null;
24
25	/**
26	* Initialize and fetch the static instance.
27	*
28	* @return self
29	*/
30	public static function init() {
31	// phpcs:ignore WordPress.Security.NonceVerification.Recommended
32	if ( isset( $_GET['page'] ) && 'jetpack' === $_GET['page'] ) {
33	add_filter( 'nocache_headers', array( 'Jetpack_Admin', 'add_no_store_header' ), 100 );
34	}
35
36	if ( self::$instance === null ) {
37	self::$instance = new Jetpack_Admin();
38	}
39	return self::$instance;
40	}
41
42	/**
43	* Filter callback to add `no-store` to the `Cache-Control` header.
44	*
45	* @param array $headers Headers array.
46	* @return array Modified headers array.
47	*/
48	public static function add_no_store_header( $headers ) {
49	$headers['Cache-Control'] .= ', no-store';
50	return $headers;
51	}
52
53	/** Constructor. */
54	private function __construct() {
55	require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class.jetpack-react-page.php';
56	$jetpack_react = new Jetpack_React_Page();
57
58	require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class.jetpack-settings-page.php';
59	$fallback_page = new Jetpack_Settings_Page();
60
61	require_once JETPACK__PLUGIN_DIR . '_inc/lib/admin-pages/class-jetpack-about-page.php';
62	$jetpack_about = new Jetpack_About_Page();
63
64	add_action( 'admin_init', array( $jetpack_react, 'react_redirects' ), 0 );
65	add_action( 'admin_menu', array( $jetpack_react, 'add_actions' ), 998 );
66	add_action( 'jetpack_admin_menu', array( $jetpack_react, 'jetpack_add_dashboard_sub_nav_item' ) );
67	add_action( 'jetpack_admin_menu', array( $jetpack_react, 'jetpack_add_settings_sub_nav_item' ) );
68	add_action( 'jetpack_admin_menu', array( $this, 'admin_menu_debugger' ) );
69	add_action( 'jetpack_admin_menu', array( $fallback_page, 'add_actions' ) );
70	add_action( 'jetpack_admin_menu', array( $jetpack_about, 'add_actions' ) );
71
72	// Add redirect to current page for activation/deactivation of modules.
73	add_action( 'jetpack_pre_activate_module', array( $this, 'fix_redirect' ), 10, 2 );
74	add_action( 'jetpack_pre_deactivate_module', array( $this, 'fix_redirect' ), 10, 2 );
75
76	// Add module bulk actions handler.
77	add_action( 'jetpack_unrecognized_action', array( $this, 'handle_unrecognized_action' ) );
78
79	if ( class_exists( 'Akismet_Admin' ) ) {
80	// If the site has Jetpack Anti-Spam, change the Akismet menu label and logo accordingly.
81	$site_products = array_column( Jetpack_Plan::get_products(), 'product_slug' );
82	$has_anti_spam_product = count( array_intersect( array( 'jetpack_anti_spam', 'jetpack_anti_spam_monthly' ), $site_products ) ) > 0;
83
84	if ( Jetpack_Plan::supports( 'antispam' ) \|\| $has_anti_spam_product ) {
85	// Prevent Akismet from adding a menu item.
86	add_action(
87	'admin_menu',
88	function () {
89	remove_action( 'admin_menu', array( 'Akismet_Admin', 'admin_menu' ), 5 );
90	},
91	4
92	);
93
94	// Add an Anti-spam menu item for Jetpack.
95	add_action(
96	'jetpack_admin_menu',
97	function () {
98	add_submenu_page( 'jetpack', __( 'Anti-Spam', 'jetpack' ), __( 'Anti-Spam', 'jetpack' ), 'manage_options', 'akismet-key-config', array( 'Akismet_Admin', 'display_page' ) );
99	}
100	);
101	add_action( 'admin_enqueue_scripts', array( $this, 'akismet_logo_replacement_styles' ) );
102	}
103	}
104
105	// Ensure an Additional CSS menu item is added to the Appearance menu whenever Jetpack is connected.
106	add_action( 'admin_menu', array( $this, 'additional_css_menu' ) );
107
108	add_filter( 'jetpack_display_jitms_on_screen', array( $this, 'should_display_jitms_on_screen' ), 10, 2 );
109
110	// Register Jetpack partner coupon hooks.
111	Jetpack_Partner_Coupon::register_coupon_admin_hooks( 'jetpack', Jetpack::admin_url() );
112	}
113
114	/**
115	* Generate styles to replace Akismet logo for the Jetpack Akismet Anti-Spam logo.
116	Without this, we would have to change the logo from Akismet codebase and we want to avoid that.
117	*/
118	public function akismet_logo_replacement_styles() {
119	$logo_url = esc_url( plugins_url( 'images/products/logo-anti-spam.svg', JETPACK__PLUGIN_FILE ) );
120	$style = ".akismet-masthead__logo-container { background: url({$logo_url}) no-repeat; min-height: 42px; margin: 20px 0; padding: 0 !important; } .akismet-masthead__logo { display: none; }";
121	$style .= '@media screen and (max-width: 782px) { .akismet-masthead__logo-container { margin-left: 4px; } }';
122	wp_add_inline_style( 'admin-bar', $style );
123	}
124
125	/**
126	* Handle our Additional CSS menu item and legacy page declaration.
127	*
128	* @since 11.0 . Prior to that, this function was located in custom-css-4.7.php (now custom-css.php).
129	*/
130	public static function additional_css_menu() {
131	/*
132	* Custom CSS for the Customizer is deprecated for block themes as of WP 6.1, so we only expose it with a menu
133	* if the site already has existing CSS code.
134	*/
135	if ( function_exists( 'wp_is_block_theme' ) && wp_is_block_theme() ) {
136	$styles = wp_get_custom_css();
137	if ( ! $styles ) {
138	return;
139	}
140	}
141
142	// If the site is a WoA site and the custom-css feature is not available, return.
143	// See https://github.com/Automattic/jetpack/pull/19965 for more on how this menu item is dealt with on WoA sites.
144	if ( ( new Host() )->is_woa_site() && ! ( in_array( 'custom-css', Jetpack::get_available_modules(), true ) ) ) {
145	return;
146	} elseif ( class_exists( 'Jetpack' ) && Jetpack::is_module_active( 'custom-css' ) ) { // If the Custom CSS module is enabled, add the Additional CSS menu item and link to the Customizer.
147	// Add in our legacy page to support old bookmarks and such.
148	add_submenu_page( '', __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss', array( __CLASS__, 'customizer_redirect' ) );
149
150	// Add in our new page slug that will redirect to the customizer.
151	$hook = add_theme_page( __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss-customizer-redirect', array( __CLASS__, 'customizer_redirect' ) );
152	add_action( "load-{$hook}", array( __CLASS__, 'customizer_redirect' ) );
153	} elseif ( class_exists( 'Jetpack' ) && Jetpack::is_connection_ready() ) { // Link to the Jetpack Settings > Writing page, highlighting the Custom CSS setting.
154	add_submenu_page( '', __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss', array( __CLASS__, 'theme_enhancements_redirect' ) );
155
156	$hook = add_theme_page( __( 'CSS', 'jetpack' ), __( 'Additional CSS', 'jetpack' ), 'edit_theme_options', 'editcss-theme-enhancements-redirect', array( __CLASS__, 'theme_enhancements_redirect' ) );
157	add_action( "load-{$hook}", array( __CLASS__, 'theme_enhancements_redirect' ) );
158	}
159	}
160
161	/**
162	* Handle the redirect for the customizer. This is necessary because
163	* we can't directly add customizer links to the admin menu.
164	*
165	* @since 11.0 . Prior to that, this function was located in custom-css-4.7.php (now custom-css.php).
166	*
167	* There is a core patch in trac that would make this unnecessary.
168	*
169	* @link https://core.trac.wordpress.org/ticket/39050
170	*/
171	public static function customizer_redirect() {
172	wp_safe_redirect(
173	self::customizer_link(
174	array(
175	'return_url' => wp_get_referer(),
176	)
177	)
178	);
179	exit;
180	}
181
182	/**
183	* Handle the Additional CSS redirect to the Jetpack settings Theme Enhancements section.
184	*
185	* @since 11.0
186	*/
187	public static function theme_enhancements_redirect() {
188	wp_safe_redirect(
189	'admin.php?page=jetpack#/writing?term=custom-css'
190	);
191	exit;
192	}
193
194	/**
195	* Build the URL to deep link to the Customizer.
196	*
197	* You can modify the return url via $args.
198	*
199	* @since 11.0 in this file. This method is also located in custom-css-4.7.php to cover legacy scenarios.
200	*
201	* @param array $args Array of parameters.
202	* @return string
203	*/
204	public static function customizer_link( $args = array() ) {
205	if ( isset( $_SERVER['REQUEST_URI'] ) ) {
206	$args = wp_parse_args(
207	$args,
208	array(
209	'return_url' => rawurlencode( wp_unslash( $_SERVER['REQUEST_URI'] ) ), // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
210	)
211	);
212	}
213
214	return add_query_arg(
215	array(
216	array(
217	'autofocus' => array(
218	'section' => 'custom_css',
219	),
220	),
221	'return' => $args['return_url'],
222	),
223	admin_url( 'customize.php' )
224	);
225	}
226
227	/**
228	* Sort callback to put modules with `requires_connection` last.
229	*
230	* @param array $module1 Module data.
231	* @param array $module2 Module data.
232	* @return int Indicating the relative ordering of module1 and module2.
233	*/
234	public static function sort_requires_connection_last( $module1, $module2 ) {
235	if ( (bool) $module1['requires_connection'] === (bool) $module2['requires_connection'] ) {
236	return 0;
237	} elseif ( $module1['requires_connection'] ) {
238	return 1;
239	} elseif ( $module2['requires_connection'] ) {
240	return -1;
241	}
242
243	return 0;
244	}
245
246	/**
247	* Produce JS understandable objects of modules containing information for
248	* presentation like description, name, configuration url, etc.
249	*/
250	public function get_modules() {
251	include_once JETPACK__PLUGIN_DIR . 'modules/module-info.php';
252	$available_modules = Jetpack::get_available_modules();
253	$active_modules = Jetpack::get_active_modules();
254	$modules = array();
255	$jetpack_active = Jetpack::is_connection_ready() \|\| ( new Status() )->is_offline_mode();
256	$overrides = Jetpack_Modules_Overrides::instance();
257	foreach ( $available_modules as $module ) {
258	$module_array = Jetpack::get_module( $module );
259	if ( $module_array ) {
260	/**
261	* Filters each module's short description.
262	*
263	* @since 3.0.0
264	*
265	* @param string $module_array['description'] Module description.
266	* @param string $module Module slug.
267	*/
268	$short_desc = apply_filters( 'jetpack_short_module_description', $module_array['description'], $module );
269	// Fix: correct multibyte strings truncate with checking for mbstring extension.
270	$short_desc_trunc = ( function_exists( 'mb_strlen' ) )
271	? ( ( mb_strlen( $short_desc ) > 143 )
272	? mb_substr( $short_desc, 0, 140 ) . '...'
273	: $short_desc )
274	: ( ( strlen( $short_desc ) > 143 )
275	? substr( $short_desc, 0, 140 ) . '...'
276	: $short_desc );
277
278	$module_array['module'] = $module;
279
280	$is_available = self::is_module_available( $module_array );
281
282	$module_array['activated'] = ( $jetpack_active ? in_array( $module, $active_modules, true ) : false );
283	$module_array['deactivate_nonce'] = wp_create_nonce( 'jetpack_deactivate-' . $module );
284	$module_array['activate_nonce'] = wp_create_nonce( 'jetpack_activate-' . $module );
285	$module_array['available'] = $is_available;
286	$module_array['unavailable_reason'] = $is_available ? false : self::get_module_unavailable_reason( $module_array );
287	$module_array['short_description'] = $short_desc_trunc;
288	$module_array['configure_url'] = Jetpack::module_configuration_url( $module );
289	$module_array['override'] = $overrides->get_module_override( $module );
290	$module_array['disabled'] = $is_available ? '' : 'disabled="disabled"';
291
292	ob_start();
293	/**
294	* Allow the display of a "Learn More" button.
295	* The dynamic part of the action, $module, is the module slug.
296	*
297	* @since 3.0.0
298	*/
299	do_action( 'jetpack_learn_more_button_' . $module );
300	$module_array['learn_more_button'] = ob_get_clean();
301
302	ob_start();
303	/**
304	* Allow the display of information text when Jetpack is connected to WordPress.com.
305	* The dynamic part of the action, $module, is the module slug.
306	*
307	* @since 3.0.0
308	*/
309	do_action( 'jetpack_module_more_info_' . $module );
310
311	/**
312	* Filter the long description of a module.
313	*
314	* @since 3.5.0
315	*
316	* @param string ob_get_clean() The module long description.
317	* @param string $module The module name.
318	*/
319	$module_array['long_description'] = apply_filters( 'jetpack_long_module_description', ob_get_clean(), $module );
320
321	ob_start();
322	/**
323	* Filter the search terms for a module
324	*
325	* Search terms are typically added to the module headers, under "Additional Search Queries".
326	*
327	* Use syntax:
328	* function jetpack_$module_search_terms( $terms ) {
329	* $terms = _x( 'term 1, term 2', 'search terms', 'jetpack' );
330	* return $terms;
331	* }
332	* add_filter( 'jetpack_search_terms_$module', 'jetpack_$module_search_terms' );
333	*
334	* @since 3.5.0
335	*
336	* @param string The search terms (comma separated).
337	*/
338	echo apply_filters( 'jetpack_search_terms_' . $module, $module_array['additional_search_queries'] ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
339	$module_array['search_terms'] = ob_get_clean();
340
341	$module_array['configurable'] = false;
342	if (
343	current_user_can( 'manage_options' ) &&
344	/**
345	* Allow the display of a configuration link in the Jetpack Settings screen.
346	*
347	* @since 3.0.0
348	*
349	* @param string $module Module name.
350	* @param bool false Should the Configure module link be displayed? Default to false.
351	*/
352	apply_filters( 'jetpack_module_configurable_' . $module, false )
353	) {
354	$module_array['configurable'] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $module_array['configure_url'] ), __( 'Configure', 'jetpack' ) );
355	}
356
357	$modules[ $module ] = $module_array;
358	}
359	}
360
361	uasort( $modules, array( 'Jetpack', 'sort_modules' ) );
362
363	if ( ! Jetpack::is_connection_ready() ) {
364	uasort( $modules, array( __CLASS__, 'sort_requires_connection_last' ) );
365	}
366
367	return $modules;
368	}
369
370	/**
371	* Check if a module is available.
372	*
373	* @param array $module Module data.
374	*/
375	public static function is_module_available( $module ) {
376	if ( ! is_array( $module ) \|\| empty( $module ) ) {
377	return false;
378	}
379
380	/**
381	* We never want to show VaultPress as activatable through Jetpack.
382	*/
383	if ( 'vaultpress' === $module['module'] ) {
384	return false;
385	}
386
387	/*
388	* WooCommerce Analytics should only be available
389	* when running WooCommerce 3+
390	*/
391	if (
392	'woocommerce-analytics' === $module['module']
393	&& (
394	! class_exists( 'WooCommerce' )
395	\|\| version_compare( WC_VERSION, '3.0', '<' )
396	)
397	) {
398	return false;
399	}
400
401	/*
402	* In Offline mode, modules that require a site or user
403	* level connection should be unavailable.
404	*/
405	if ( ( new Status() )->is_offline_mode() ) {
406	return ! ( $module['requires_connection'] \|\| $module['requires_user_connection'] );
407	}
408
409	/*
410	* Jetpack not connected.
411	*/
412	if ( ! Jetpack::is_connection_ready() ) {
413	return false;
414	}
415
416	/*
417	* Jetpack connected at a site level only. Make sure to make
418	* modules that require a user connection unavailable.
419	*/
420	if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
421	return false;
422	}
423
424	return Jetpack_Plan::supports( $module['module'] );
425	}
426
427	/**
428	* Returns why a module is unavailable.
429	*
430	* @param array $module The module.
431	* @return string\|false A string stating why the module is not available or false if the module is available.
432	*/
433	public static function get_module_unavailable_reason( $module ) {
434	if ( ! is_array( $module ) \|\| empty( $module ) ) {
435	return false;
436	}
437
438	if ( self::is_module_available( $module ) ) {
439	return false;
440	}
441
442	/**
443	* We never want to show VaultPress as activatable through Jetpack so return an empty string.
444	*/
445	if ( 'vaultpress' === $module['module'] ) {
446	return '';
447	}
448
449	/*
450	* WooCommerce Analytics should only be available
451	* when running WooCommerce 3+
452	*/
453	if (
454	'woocommerce-analytics' === $module['module']
455	&& (
456	! class_exists( 'WooCommerce' )
457	\|\| version_compare( WC_VERSION, '3.0', '<' )
458	)
459	) {
460	return __( 'Requires WooCommerce 3+ plugin', 'jetpack' );
461	}
462
463	/*
464	* In Offline mode, modules that require a site or user
465	* level connection should be unavailable.
466	*/
467	if ( ( new Status() )->is_offline_mode() ) {
468	if ( $module['requires_connection'] \|\| $module['requires_user_connection'] ) {
469	return __( 'Offline mode', 'jetpack' );
470	}
471	}
472
473	/*
474	* Jetpack not connected.
475	*/
476	if ( ! Jetpack::is_connection_ready() ) {
477	return __( 'Jetpack is not connected', 'jetpack' );
478	}
479
480	/*
481	* Jetpack connected at a site level only and module requires a user connection.
482	*/
483	if ( ! Jetpack::connection()->has_connected_owner() && $module['requires_user_connection'] ) {
484	return __( 'Requires a connected WordPress.com account', 'jetpack' );
485	}
486
487	/*
488	* Plan restrictions.
489	*/
490	if ( ! Jetpack_Plan::supports( $module['module'] ) ) {
491	return __( 'Not supported by current plan', 'jetpack' );
492	}
493
494	return '';
495	}
496
497	/**
498	* Handle an unrecognized action.
499	*
500	* @param string $action Action.
501	*/
502	public function handle_unrecognized_action( $action ) {
503	switch ( $action ) {
504	case 'bulk-activate':
505	check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
506	if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
507	break;
508	}
509
510	$modules = isset( $_GET['modules'] ) ? array_map( 'sanitize_key', wp_unslash( (array) $_GET['modules'] ) ) : array();
511	foreach ( $modules as $module ) {
512	Jetpack::log( 'activate', $module );
513	Jetpack::activate_module( $module, false );
514	}
515	// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
516	wp_safe_redirect( wp_get_referer() );
517	exit;
518	case 'bulk-deactivate':
519	check_admin_referer( 'bulk-jetpack_page_jetpack_modules' );
520	if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
521	break;
522	}
523
524	$modules = isset( $_GET['modules'] ) ? array_map( 'sanitize_key', wp_unslash( (array) $_GET['modules'] ) ) : array();
525	foreach ( $modules as $module ) {
526	Jetpack::log( 'deactivate', $module );
527	Jetpack::deactivate_module( $module );
528	Jetpack::state( 'message', 'module_deactivated' );
529	}
530	Jetpack::state( 'module', $modules );
531	wp_safe_redirect( wp_get_referer() );
532	exit;
533	default:
534	return;
535	}
536	}
537
538	/**
539	* Fix redirect.
540	*
541	* Apparently we redirect to the referrer instead of whatever WordPress
542	* wants to redirect to when activating and deactivating modules.
543	*
544	* @param string $module Module slug.
545	* @param bool $redirect Should we exit after the module has been activated. Default to true.
546	*/
547	public function fix_redirect( $module, $redirect = true ) {
548	if ( ! $redirect ) {
549	return;
550	}
551	if ( wp_get_referer() ) {
552	add_filter( 'wp_redirect', 'wp_get_referer' );
553	}
554	}
555
556	/**
557	* Add debugger admin menu.
558	*/
559	public function admin_menu_debugger() {
560	require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
561	Jetpack_Debugger::disconnect_and_redirect();
562	$debugger_hook = add_submenu_page(
563	'',
564	__( 'Debugging Center', 'jetpack' ),
565	'',
566	'manage_options',
567	'jetpack-debugger',
568	array( $this, 'wrap_debugger_page' )
569	);
570	add_action( "admin_head-$debugger_hook", array( 'Jetpack_Debugger', 'jetpack_debug_admin_head' ) );
571	}
572
573	/**
574	* Wrap debugger page.
575	*/
576	public function wrap_debugger_page() {
577	nocache_headers();
578	if ( ! current_user_can( 'manage_options' ) ) {
579	die( '-1' );
580	}
581	Jetpack_Admin_Page::wrap_ui( array( $this, 'debugger_page' ), array( 'is-wide' => true ) );
582	}
583
584	/**
585	* Display debugger page.
586	*/
587	public function debugger_page() {
588	require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger.php';
589	Jetpack_Debugger::jetpack_debug_display_handler();
590	}
591
592	/**
593	* Determines if JITMs should display on a particular screen.
594	*
595	* @param bool $value The default value of the filter.
596	* @param string $screen_id The ID of the screen being tested for JITM display.
597	*
598	* @return bool True if JITMs should display, false otherwise.
599	*/
600	public function should_display_jitms_on_screen( $value, $screen_id ) {
601	// Disable all JITMs on these pages.
602	if (
603	in_array(
604	$screen_id,
605	array(
606	'jetpack_page_akismet-key-config',
607	'admin_page_jetpack_modules',
608	),
609	true
610	) ) {
611	return false;
612	}
613
614	// Disable all JITMs on pages where the recommendations banner is displaying.
615	if (
616	in_array(
617	$screen_id,
618	array(
619	'dashboard',
620	'plugins',
621	'jetpack_page_stats',
622	),
623	true
624	)
625	&& \Jetpack_Recommendations_Banner::can_be_displayed()
626	) {
627	return false;
628	}
629
630	return $value;
631	}
632	}
633	Jetpack_Admin::init();
634