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