Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
28.36%
97 / 342
7.14%
2 / 28
 CRAP
0.00%
0 / 1
Initializer
28.36%
97 / 342
7.14%
2 / 28
 2615.66
0.00%
0 / 1
 init
100.00%
15 / 15
100.00%
1 / 1
 4
 is_licensing_ui_enabled
85.71%
6 / 7
0.00%
0 / 1
 2.01
 add_my_jetpack_menu_item
0.00%
0 / 9
0.00%
0 / 1
 2
 admin_init
0.00%
0 / 24
0.00%
0 / 1
 90
 add_onboarding_admin_body_class
0.00%
0 / 2
0.00%
0 / 1
 2
 can_use_analytics
0.00%
0 / 4
0.00%
0 / 1
 2
 register_wp_build_polyfills
83.33%
5 / 6
0.00%
0 / 1
 2.02
 enqueue_scripts
0.00%
0 / 81
0.00%
0 / 1
 42
 get_installed_jetpack_plugins
0.00%
0 / 9
0.00%
0 / 1
 2
 get_active_modules
0.00%
0 / 5
0.00%
0 / 1
 12
 is_jetpack_user_new
0.00%
0 / 21
0.00%
0 / 1
 56
 get_my_jetpack_flags
0.00%
0 / 5
0.00%
0 / 1
 2
 get_seo_opt_in_state
0.00%
0 / 6
0.00%
0 / 1
 6
 admin_page
0.00%
0 / 3
0.00%
0 / 1
 12
 register_rest_endpoints
100.00%
27 / 27
100.00%
1 / 1
 1
 permissions_callback
0.00%
0 / 1
0.00%
0 / 1
 2
 should_initialize
75.00%
3 / 4
0.00%
0 / 1
 2.06
 setup_historically_active_jetpack_modules_sync
0.00%
0 / 12
0.00%
0 / 1
 20
 get_site
0.00%
0 / 9
0.00%
0 / 1
 12
 get_site_info
0.00%
0 / 12
0.00%
0 / 1
 20
 is_commercial_site
66.67%
2 / 3
0.00%
0 / 1
 3.33
 is_registered
0.00%
0 / 1
0.00%
0 / 1
 2
 dismiss_welcome_banner
0.00%
0 / 2
0.00%
0 / 1
 2
 has_file_system_write_access
0.00%
0 / 18
0.00%
0 / 1
 42
 get_idc_container_id
0.00%
0 / 1
0.00%
0 / 1
 2
 maybe_show_red_bubble
95.12%
39 / 41
0.00%
0 / 1
 10
 enqueue_red_bubble_script
0.00%
0 / 9
0.00%
0 / 1
 2
 get_recommended_modules
0.00%
0 / 5
0.00%
0 / 1
 6
1<?php
2/**
3 * WP Admin page with information and configuration shared among all Jetpack stand-alone plugins
4 *
5 * @package automattic/my-jetpack
6 */
7
8namespace Automattic\Jetpack\My_Jetpack;
9
10use Automattic\Jetpack\Admin_UI\Admin_Menu;
11use Automattic\Jetpack\Agents_Manager\WP_REST_Jetpack_AI_JWT;
12use Automattic\Jetpack\Assets;
13use Automattic\Jetpack\Boost_Speed_Score\Speed_Score;
14use Automattic\Jetpack\Boost_Speed_Score\Speed_Score_History;
15use Automattic\Jetpack\Connection\Client;
16use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State;
17use Automattic\Jetpack\Connection\Manager as Connection_Manager;
18use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication;
19use Automattic\Jetpack\Constants as Jetpack_Constants;
20use Automattic\Jetpack\ExPlat;
21use Automattic\Jetpack\JITMS\JITM;
22use Automattic\Jetpack\Licensing;
23use Automattic\Jetpack\Menu_Badges\Menu_Badges;
24use Automattic\Jetpack\Menu_Badges\Notification_Counts;
25use Automattic\Jetpack\Modules;
26use Automattic\Jetpack\Plugins_Installer;
27use Automattic\Jetpack\Status;
28use Automattic\Jetpack\Status\Host as Status_Host;
29use Automattic\Jetpack\Sync\Functions as Sync_Functions;
30use Automattic\Jetpack\Terms_Of_Service;
31use Automattic\Jetpack\Tracking;
32use Automattic\Jetpack\WP_Build_Polyfills\WP_Build_Polyfills;
33use Jetpack;
34use WP_Error;
35
36/**
37 * The main Initializer class that registers the admin menu and eneuque the assets.
38 */
39class Initializer {
40
41    /**
42     * My Jetpack package version
43     *
44     * @var string
45     */
46    const PACKAGE_VERSION = '5.40.6';
47
48    /**
49     * HTML container ID for the IDC screen on My Jetpack page.
50     */
51    private const IDC_CONTAINER_ID = 'my-jetpack-identity-crisis-container';
52
53    public const JETPACK_PLUGIN_SLUGS = array(
54        'jetpack-backup',
55        'jetpack-boost',
56        'zerobscrm',
57        'jetpack',
58        'jetpack-protect',
59        'jetpack-social',
60        'jetpack-videopress',
61        'jetpack-search',
62    );
63
64    private const MY_JETPACK_SITE_INFO_TRANSIENT_KEY = 'my-jetpack-site-info';
65
66    /**
67     * Holds info/data about the site (from the /sites/%d endpoint)
68     *
69     * @var object
70     */
71    public static $site_info;
72
73    /**
74     * Initialize My Jetpack
75     *
76     * @return void
77     */
78    public static function init() {
79        if ( ! self::should_initialize() || did_action( 'my_jetpack_init' ) ) {
80            return;
81        }
82
83        // Extend jetpack plugins action links.
84        Products::extend_plugins_action_links();
85
86        // Set up the REST authentication hooks.
87        Connection_Rest_Authentication::init();
88
89        if ( self::is_licensing_ui_enabled() ) {
90            Licensing::instance()->initialize();
91        }
92
93        // Initialize Boost Speed Score
94        new Speed_Score( array(), 'jetpack-my-jetpack' );
95
96        // Add custom WP REST API endoints.
97        add_action( 'rest_api_init', array( __CLASS__, 'register_rest_endpoints' ) );
98
99        add_action( 'admin_menu', array( __CLASS__, 'add_my_jetpack_menu_item' ) );
100
101        add_action( 'admin_init', array( __CLASS__, 'setup_historically_active_jetpack_modules_sync' ) );
102        // Registered on admin_menu (not admin_init) and well before priority 100000, so the
103        // counts it registers exist before the menu-badges renderer runs on admin_menu 100000.
104        add_action( 'admin_menu', array( __CLASS__, 'maybe_show_red_bubble' ), 30 );
105
106        // Set up the ExPlat package endpoints
107        ExPlat::init();
108
109        // Sets up JITMS.
110        JITM::configure();
111
112        // Add "Jetpack Manage" menu item.
113        Jetpack_Manage::init();
114
115        /**
116         * Fires after the My Jetpack package is initialized
117         *
118         * @since 0.1.0
119         */
120        do_action( 'my_jetpack_init' );
121    }
122
123    /**
124     * Acts as a feature flag, returning a boolean for whether we should show the licensing UI.
125     *
126     * @since 1.2.0
127     *
128     * @return boolean
129     */
130    public static function is_licensing_ui_enabled() {
131        // Default changed to true in 1.5.0.
132        $is_enabled = true;
133
134        /*
135         * Bail if My Jetpack is not enabled,
136         * and thus the licensing UI shouldn't be enabled either.
137         */
138        if ( ! self::should_initialize() ) {
139            $is_enabled = false;
140        }
141
142        /**
143         * Acts as a feature flag, returning a boolean for whether we should show the licensing UI.
144         *
145         * @param bool $is_enabled Defaults to true.
146         *
147         * @since 1.2.0
148         * @since 1.5.0 Update default value to true.
149         */
150        return apply_filters(
151            'jetpack_my_jetpack_should_enable_add_license_screen',
152            $is_enabled
153        );
154    }
155
156    /**
157     * Add My Jetpack menu item to the admin menu.
158     *
159     * @return void
160     */
161    public static function add_my_jetpack_menu_item() {
162        $page_suffix = Admin_Menu::add_menu(
163            __( 'My Jetpack', 'jetpack-my-jetpack' ),
164            __( 'My Jetpack', 'jetpack-my-jetpack' ),
165            'edit_posts',
166            'my-jetpack',
167            array( __CLASS__, 'admin_page' ),
168            -1
169        );
170        add_action( 'load-' . $page_suffix, array( __CLASS__, 'admin_init' ) );
171    }
172
173    /**
174     * Callback for the load my jetpack page hook.
175     *
176     * @return void
177     */
178    public static function admin_init() {
179        $connection = new Connection_Manager();
180
181        // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- No nonce needed for redirect flow control
182        $step = isset( $_GET['step'] ) ? sanitize_text_field( wp_unslash( $_GET['step'] ) ) : '';
183
184        // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Checking for partner coupon redemption flow
185        $show_coupon_redemption = isset( $_GET['showCouponRedemption'] );
186
187        // Redirect to Jetpack dashboard for partner coupon redemption
188        if ( $show_coupon_redemption ) {
189            wp_safe_redirect( admin_url( 'admin.php?page=jetpack&showCouponRedemption=1#/dashboard' ) );
190            exit( 0 );
191        }
192
193        // Handle onboarding redirects based on connection status
194        $should_redirect = false;
195        $redirect_args   = array( 'page' => 'my-jetpack' );
196
197        if ( ! $connection->is_connected() && $step !== 'onboarding' ) {
198            // Redirect to onboarding if not connected
199            $redirect_args['step'] = 'onboarding';
200            $should_redirect       = true;
201        } elseif ( $connection->is_connected() && $step === 'onboarding' ) {
202            // Redirect away from onboarding if already connected
203            $should_redirect = true;
204        }
205
206        if ( $should_redirect ) {
207            $admin_page = add_query_arg( $redirect_args, admin_url( 'admin.php' ) );
208            $location   = wp_sanitize_redirect( $admin_page );
209
210            // Remove wp_get_referer filter applied in `fix_redirect` method of `Jetpack_Admin` class
211            remove_filter( 'wp_redirect', 'wp_get_referer' );
212            wp_safe_redirect( $location );
213
214            exit( 0 );
215        }
216
217        // If the user reaches the onboarding page, add a class to the body
218        if ( $step === 'onboarding' ) {
219            add_filter( 'admin_body_class', array( __CLASS__, 'add_onboarding_admin_body_class' ) );
220        }
221
222        self::$site_info = self::get_site_info();
223        add_filter( 'identity_crisis_container_id', array( static::class, 'get_idc_container_id' ) );
224        add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_scripts' ) );
225    }
226
227    /**
228     * Add a body class to the My Jetpack onboarding page.
229     * This class hides the WP Admin toolbar and the sidebar menu.
230     *
231     * @param string $classes The body classes.
232     * @return string The modified body classes.
233     */
234    public static function add_onboarding_admin_body_class( $classes ) {
235        $classes .= 'jetpack-admin-full-screen';
236        return $classes;
237    }
238
239    /**
240     * Returns whether we are in condition to track to use
241     * Analytics functionality like Tracks, MC, or GA.
242     */
243    public static function can_use_analytics() {
244        $status     = new Status();
245        $connection = new Connection_Manager();
246        $tracking   = new Tracking( 'jetpack', $connection );
247
248        return $tracking->should_enable_tracking( new Terms_Of_Service(), $status );
249    }
250
251    /**
252     * Register polyfills for the wp-notices / wp-private-apis / wp-theme handles the
253     * My Jetpack app bundle depends on but WP < 7.0 does not ship (or ships with an
254     * incomplete allowlist).
255     *
256     * @return void
257     */
258    public static function register_wp_build_polyfills() {
259        if ( ! class_exists( WP_Build_Polyfills::class ) ) {
260            return;
261        }
262
263        WP_Build_Polyfills::register(
264            'my-jetpack',
265            array( 'wp-notices', 'wp-private-apis', 'wp-theme' )
266        );
267    }
268
269    /**
270     * Enqueue admin page assets.
271     *
272     * @return void
273     */
274    public static function enqueue_scripts() {
275        // Register the wp-build-polyfills shim before the extension hook below or
276        // the app script can enqueue against wp-theme / wp-private-apis / wp-notices.
277        // WP_Build_Polyfills registers synchronously on its first caller, so calling
278        // it after a hook consumer would leave our handles recorded but unregistered
279        // for this request.
280        self::register_wp_build_polyfills();
281
282        /**
283         * Fires after the My Jetpack page is initialized.
284         * Allows for enqueuing additional scripts only on the My Jetpack page.
285         *
286         * @since 4.35.7
287         */
288        do_action( 'myjetpack_enqueue_scripts' );
289        Assets::register_script(
290            'my_jetpack_main_app',
291            '../build/index.js',
292            __FILE__,
293            array(
294                'enqueue'    => true,
295                'in_footer'  => true,
296                'textdomain' => 'jetpack-my-jetpack',
297            )
298        );
299        $modules             = new Modules();
300        $connection          = new Connection_Manager();
301        $speed_score_history = new Speed_Score_History( get_site_url() );
302        $latest_score        = $speed_score_history->latest();
303        $previous_score      = array();
304        if ( $speed_score_history->count() > 1 ) {
305            $previous_score = $speed_score_history->latest( 1 );
306        }
307        $latest_score['previousScores'] = $previous_score['scores'] ?? array();
308
309        $sandboxed_domain = '';
310        $is_dev_version   = false;
311        if ( class_exists( 'Jetpack' ) ) {
312            $is_dev_version   = Jetpack::is_development_version();
313            $sandboxed_domain = defined( 'JETPACK__SANDBOX_DOMAIN' ) ? JETPACK__SANDBOX_DOMAIN : '';
314        }
315
316        wp_localize_script(
317            'my_jetpack_main_app',
318            'myJetpackInitialState',
319            array(
320                'products'               => array(
321                    'items' => Products::get_products(),
322                ),
323                'plugins'                => Plugins_Installer::get_plugins(),
324                'themes'                 => Sync_Functions::get_themes(),
325                'myJetpackUrl'           => admin_url( 'admin.php?page=my-jetpack' ),
326                'myJetpackCheckoutUri'   => admin_url( 'admin.php?page=my-jetpack' ),
327                'topJetpackMenuItemUrl'  => Admin_Menu::get_top_level_menu_item_url(),
328                'siteSuffix'             => ( new Status() )->get_site_suffix(),
329                'siteUrl'                => esc_url( get_site_url() ),
330                'blogID'                 => Connection_Manager::get_site_id( true ),
331                'myJetpackVersion'       => self::PACKAGE_VERSION,
332                'myJetpackFlags'         => self::get_my_jetpack_flags(),
333                'fileSystemWriteAccess'  => self::has_file_system_write_access(),
334                'loadAddLicenseScreen'   => self::is_licensing_ui_enabled(),
335                'adminUrl'               => esc_url( admin_url() ),
336                'IDCContainerID'         => static::get_idc_container_id(),
337                'userIsAdmin'            => current_user_can( 'manage_options' ),
338                'lifecycleStats'         => array(
339                    'jetpackPlugins'            => self::get_installed_jetpack_plugins(),
340                    'historicallyActiveModules' => \Jetpack_Options::get_option( 'historically_active_modules', array() ),
341                    'brokenModules'             => Red_Bubble_Notifications::check_for_broken_modules(),
342                    'isSiteConnected'           => $connection->is_connected(),
343                    'isUserConnected'           => $connection->is_user_connected(),
344                    'modules'                   => self::get_active_modules(),
345                ),
346                'recommendedModules'     => array(
347                    'modules'    => self::get_recommended_modules(),
348                    'isFirstRun' => \Jetpack_Options::get_option( 'recommendations_first_run', true ),
349                    'dismissed'  => \Jetpack_Options::get_option( 'dismissed_recommendations', false ),
350                ),
351                'isStatsModuleActive'    => $modules->is_active( 'stats' ),
352                'canUserViewStats'       => current_user_can( 'manage_options' ) || current_user_can( 'view_stats' ),
353                'sandboxedDomain'        => $sandboxed_domain,
354                'isDevVersion'           => $is_dev_version,
355                'isAtomic'               => ( new Status_Host() )->is_woa_site(),
356                'isJetpackPluginActive'  => class_exists( 'Jetpack' ),
357                'latestBoostSpeedScores' => $latest_score,
358                'seoOptIn'               => self::get_seo_opt_in_state(),
359            )
360        );
361
362        wp_localize_script(
363            'my_jetpack_main_app',
364            'myJetpackRest',
365            array(
366                'apiRoot'  => esc_url_raw( rest_url() ),
367                'apiNonce' => wp_create_nonce( 'wp_rest' ),
368            )
369        );
370
371        // Connection Initial State.
372        Connection_Initial_State::render_script( 'my_jetpack_main_app' );
373
374        // Required for Analytics.
375        if ( self::can_use_analytics() ) {
376            Tracking::register_tracks_functions_scripts( true );
377        }
378    }
379
380    /**
381     * Get installed Jetpack plugins
382     *
383     * @return array
384     */
385    public static function get_installed_jetpack_plugins() {
386        $plugin_slugs = array_keys( Plugins_Installer::get_plugins() );
387        $plugin_slugs = array_map(
388            static function ( $slug ) {
389                $parts = explode( '/', $slug );
390                // Return the last segment of the filepath without the PHP extension
391                return str_replace( '.php', '', $parts[ count( $parts ) - 1 ] );
392            },
393            $plugin_slugs
394        );
395
396        return array_values( array_intersect( self::JETPACK_PLUGIN_SLUGS, $plugin_slugs ) );
397    }
398
399    /**
400     * Get active modules (except ones enabled by default)
401     *
402     * @return array
403     */
404    public static function get_active_modules() {
405        $modules        = new Modules();
406        $active_modules = $modules->get_active();
407
408        // if the Jetpack plugin is active, filter out the modules that are active by default
409        if ( class_exists( 'Jetpack' ) && ! empty( $active_modules ) ) {
410            $active_modules = array_diff( $active_modules, Jetpack::get_default_modules() );
411        }
412        return array_values( $active_modules );
413    }
414
415    /**
416     * Determine if the current user is "new" to Jetpack
417     * This is used to vary some messaging in My Jetpack
418     *
419     * On the front-end, purchases are also taken into account
420     *
421     * @return bool
422     */
423    public static function is_jetpack_user_new() {
424        // is the user connected?
425        $connection = new Connection_Manager();
426        if ( $connection->is_user_connected() ) {
427            return false;
428        }
429
430        // TODO: add a data point for the last known connection/ disconnection time
431
432        // are any modules active?
433        $active_modules = self::get_active_modules();
434        if ( ! empty( $active_modules ) ) {
435            return false;
436        }
437
438        // check for other Jetpack plugins that are installed on the site (active or not)
439        // If there's more than one Jetpack plugin active, this user is not "new"
440        $plugin_slugs              = array_keys( Plugins_Installer::get_plugins() );
441        $plugin_slugs              = array_map(
442            static function ( $slug ) {
443                $parts = explode( '/', $slug );
444                // Return the last segment of the filepath without the PHP extension
445                return str_replace( '.php', '', $parts[ count( $parts ) - 1 ] );
446            },
447            $plugin_slugs
448        );
449        $installed_jetpack_plugins = array_intersect( self::JETPACK_PLUGIN_SLUGS, $plugin_slugs );
450        if ( is_countable( $installed_jetpack_plugins ) && count( $installed_jetpack_plugins ) >= 2 ) {
451            return false;
452        }
453
454        // Does the site have any purchases?
455        $purchases = Wpcom_Products::get_site_current_purchases();
456        if ( ! empty( $purchases ) && ! is_wp_error( $purchases ) ) {
457            return false;
458        }
459
460        return true;
461    }
462
463    /**
464     *  Build flags for My Jetpack UI
465     *
466     *  @return array
467     */
468    public static function get_my_jetpack_flags() {
469        $flags = array(
470            'videoPressStats'          => Jetpack_Constants::is_true( 'JETPACK_MY_JETPACK_VIDEOPRESS_STATS_ENABLED' ),
471            'showFullJetpackStatsCard' => class_exists( 'Jetpack' ),
472        );
473
474        return $flags;
475    }
476
477    /**
478     * Build the state the My Jetpack "try the new SEO experience" opt-in card hydrates from.
479     *
480     * The card invites an existing self-hosted install to switch over to the new Jetpack SEO
481     * dashboard (JETPACK-1700). Gating lives server-side, where the signals actually are. The
482     * card shows only when all of:
483     *
484     * - the new SEO product is available — the `rsm_jetpack_seo` feature filter is on (the SEO
485     *   package autoloads regardless, so `class_exists()` alone isn't enough; the filter is the
486     *   real availability switch and the same one the SEO package gates its own surface behind);
487     * - the site is self-hosted — WordPress.com (Simple + Atomic) decides its own SEO surface, so
488     *   the opt-in card is for self-hosted installs only;
489     * - the install hasn't opted in yet — `jetpack_seo_surface_visible` is still false. On wpcom
490     *   the SEO package's `is_seo_surface_visible()` short-circuits to `true`, so the
491     *   "not visible yet" check also doubles as the self-hosted guard, but we check the platform
492     *   explicitly for clarity.
493     *
494     * Referenced through `class_exists()` rather than a hard composer dependency: both packages
495     * ship inside the Jetpack plugin and the SEO surface is feature-flagged, so a guarded read of
496     * its public API keeps this from adding plumbing to consumers that don't load SEO.
497     *
498     * The on-success destination is computed by the opt-in endpoint itself; we only seed the card
499     * with the same admin URL so the button has a sensible fallback before the request resolves.
500     *
501     * @return array{showCard: bool, redirect: string}
502     */
503    public static function get_seo_opt_in_state() {
504        // Guard with method_exists rather than class_exists: an older bundled SEO package can ship
505        // the Initializer class without this method, and class_exists alone would still fatal.
506        $seo_initializer = 'Automattic\Jetpack\SEO\Initializer';
507        // @phan-suppress-next-line PhanUndeclaredClassReference -- optional SEO package, guarded by method_exists.
508        $show_card = method_exists( $seo_initializer, 'is_optin_available' ) && $seo_initializer::is_optin_available();
509
510        return array(
511            'showCard' => $show_card,
512            'redirect' => admin_url( 'admin.php?page=jetpack-seo' ),
513        );
514    }
515
516    /**
517     * Echoes the admin page content.
518     *
519     * @return void
520     */
521    public static function admin_page() {
522        $step          = isset( $_GET['step'] ) ? sanitize_text_field( wp_unslash( $_GET['step'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
523        $is_onboarding = $step === 'onboarding';
524
525        // Add data attribute for onboarding, otherwise render normal container
526        echo '<div id="my-jetpack-container" ' . ( $is_onboarding ? 'data-route="onboarding"' : '' ) . '></div>';
527    }
528
529    /**
530     * Register the REST API routes.
531     *
532     * @return void
533     */
534    public static function register_rest_endpoints() {
535        new REST_Products();
536        new REST_Purchases();
537        new REST_Zendesk_Chat();
538        ( new WP_REST_Jetpack_AI_JWT() )->register_rest_route();
539        new REST_Recommendations_Evaluation();
540
541        Products::register_product_endpoints();
542        Historically_Active_Modules::register_rest_endpoints();
543        Jetpack_Manage::register_rest_endpoints();
544        Red_Bubble_Notifications::register_rest_endpoints();
545
546        register_rest_route(
547            'my-jetpack/v1',
548            'site',
549            array(
550                'methods'             => \WP_REST_Server::READABLE,
551                'callback'            => __CLASS__ . '::get_site',
552                'permission_callback' => __CLASS__ . '::permissions_callback',
553            )
554        );
555
556        register_rest_route(
557            'my-jetpack/v1',
558            'site/dismiss-welcome-banner',
559            array(
560                'methods'             => \WP_REST_Server::EDITABLE,
561                'callback'            => __CLASS__ . '::dismiss_welcome_banner',
562                'permission_callback' => __CLASS__ . '::permissions_callback',
563            )
564        );
565    }
566
567    /**
568     * Check user capability to access the endpoint.
569     *
570     * @access public
571     * @static
572     *
573     * @return true|WP_Error
574     */
575    public static function permissions_callback() {
576        return current_user_can( 'manage_options' );
577    }
578
579    /**
580     * Return true if we should initialize the My Jetpack admin page.
581     */
582    public static function should_initialize() {
583        $should = true;
584
585        // All options presented in My Jetpack require a connection to WordPress.com.
586        if ( ( new Status() )->is_offline_mode() ) {
587            $should = false;
588        }
589
590        /**
591         * Allows filtering whether My Jetpack should be initialized.
592         *
593         * @since 0.5.0-alpha
594         *
595         * @param bool $shoud_initialize Should we initialize My Jetpack?
596         */
597        return apply_filters( 'jetpack_my_jetpack_should_initialize', $should );
598    }
599
600    /**
601     * Hook into several connection-based actions to update the historically active Jetpack modules
602     * If the transient that indicates the list needs to be synced, update it and delete the transient
603     *
604     * @return void
605     */
606    public static function setup_historically_active_jetpack_modules_sync() {
607        // yummmm. ham.
608        $ham = new Historically_Active_Modules();
609        if ( get_transient( $ham::UPDATE_HISTORICALLY_ACTIVE_JETPACK_MODULES_KEY ) && ! wp_doing_ajax() ) {
610            $ham::update_historically_active_jetpack_modules();
611            delete_transient( $ham::UPDATE_HISTORICALLY_ACTIVE_JETPACK_MODULES_KEY );
612        }
613
614        $actions = array(
615            'jetpack_site_registered',
616            'jetpack_user_authorized',
617            'activated_plugin',
618        );
619
620        foreach ( $actions as $action ) {
621            add_action( $action, array( $ham, 'queue_historically_active_jetpack_modules_update' ), 5 );
622        }
623
624        // Modules are often updated async, so we need to update them right away as there will sometimes be no page reload.
625        add_action( 'jetpack_activate_module', array( $ham, 'update_historically_active_jetpack_modules' ), 5 );
626    }
627
628    /**
629     * Site full-data endpoint.
630     *
631     * @return object Site data.
632     */
633    public static function get_site() {
634        $site_id           = \Jetpack_Options::get_option( 'id' );
635        $wpcom_endpoint    = sprintf( '/sites/%d?force=wpcom', $site_id );
636        $wpcom_api_version = '1.1';
637        $response          = Client::wpcom_json_api_request_as_blog( $wpcom_endpoint, $wpcom_api_version );
638        $response_code     = wp_remote_retrieve_response_code( $response );
639        $body              = json_decode( wp_remote_retrieve_body( $response ) );
640
641        if ( is_wp_error( $response ) || empty( $response['body'] ) ) {
642            return new WP_Error( 'site_data_fetch_failed', 'Site data fetch failed', array( 'status' => $response_code ) );
643        }
644
645        return rest_ensure_response( $body );
646    }
647
648    /**
649     * Populates the self::$site_info var with site data from the /sites/%d endpoint
650     *
651     * @return object|WP_Error
652     */
653    public static function get_site_info() {
654        static $site_info = null;
655
656        if ( $site_info !== null ) {
657            return $site_info;
658        }
659
660        // Check for a cached value before doing lookup
661        $stored_site_info = get_transient( self::MY_JETPACK_SITE_INFO_TRANSIENT_KEY );
662        if ( $stored_site_info !== false ) {
663            return $stored_site_info;
664        }
665
666        $response = self::get_site();
667        if ( is_wp_error( $response ) ) {
668            return $response;
669        }
670        $site_info = $response->data;
671        set_transient( self::MY_JETPACK_SITE_INFO_TRANSIENT_KEY, $site_info, DAY_IN_SECONDS );
672
673        return $site_info;
674    }
675
676    /**
677     * Returns whether a site has been determined "commercial" or not.
678     *
679     * @return bool|null
680     */
681    public static function is_commercial_site() {
682        if ( is_wp_error( self::$site_info ) ) {
683            return null;
684        }
685
686        return empty( self::$site_info->options->is_commercial ) ? false : self::$site_info->options->is_commercial;
687    }
688
689    /**
690     * Check if site is registered (has been connected before).
691     *
692     * @return bool
693     */
694    public static function is_registered() {
695        return (bool) \Jetpack_Options::get_option( 'id' );
696    }
697
698    /**
699     * Dismiss the welcome banner.
700     *
701     * @return \WP_REST_Response
702     */
703    public static function dismiss_welcome_banner() {
704        \Jetpack_Options::update_option( 'dismissed_welcome_banner', true );
705        return rest_ensure_response( array( 'success' => true ) );
706    }
707
708    /**
709     * Returns "yes" if the site has file write access to the plugins folder, "no" otherwise.
710     *
711     * @return string
712     **/
713    public static function has_file_system_write_access() {
714
715        $cache = get_transient( 'my_jetpack_write_access' );
716
717        if ( false !== $cache ) {
718            return $cache;
719        }
720
721        if ( ! function_exists( 'get_filesystem_method' ) ) {
722            require_once ABSPATH . 'wp-admin/includes/file.php';
723        }
724
725        require_once ABSPATH . 'wp-admin/includes/template.php';
726
727        $write_access = 'no';
728
729        $filesystem_method = get_filesystem_method( array(), WP_PLUGIN_DIR );
730        if ( 'direct' === $filesystem_method ) {
731            $write_access = 'yes';
732        }
733
734        if ( 'no' === $write_access ) {
735            ob_start();
736            $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
737            ob_end_clean();
738
739            if ( $filesystem_credentials_are_stored ) {
740                $write_access = 'yes';
741            }
742        }
743
744        set_transient( 'my_jetpack_write_access', $write_access, 30 * MINUTE_IN_SECONDS );
745
746        return $write_access;
747    }
748
749    /**
750     * Get container IDC for the IDC screen.
751     *
752     * @return string
753     */
754    public static function get_idc_container_id() {
755        return static::IDC_CONTAINER_ID;
756    }
757
758    /**
759     * Conditionally append the red bubble notification to the "Jetpack" menu item if there are alerts to show.
760     *
761     * On My Jetpack page: Uses blocking behavior to fetch fresh data.
762     * On other admin pages: Uses cached data only to avoid blocking, with async JS fetch if cache is empty.
763     *
764     * @return void
765     */
766    public static function maybe_show_red_bubble() {
767        global $pagenow;
768
769        // Don't show red bubble alerts for non-admin users
770        // These alerts are generally only actionable for admins
771        if ( ! current_user_can( 'manage_options' ) ) {
772            return;
773        }
774
775        // Don't show any red bubbles when Jetpack is disconnected
776        // Users can't act on most alerts without a connection
777        $connection = new Connection_Manager();
778        if ( ! $connection->is_connected() ) {
779            return;
780        }
781
782        // Check if we're on the My Jetpack page.
783        // phpcs:ignore WordPress.Security.NonceVerification.Recommended
784        $page               = isset( $_GET['page'] ) ? sanitize_text_field( wp_unslash( $_GET['page'] ) ) : '';
785        $is_my_jetpack_page = $pagenow === 'admin.php' && $page === 'my-jetpack';
786
787        if ( $is_my_jetpack_page ) {
788            // On My Jetpack page: use blocking behavior for fresh data.
789            add_filter( 'my_jetpack_red_bubble_notification_slugs', array( Red_Bubble_Notifications::class, 'add_red_bubble_alerts' ) );
790            $red_bubble_alerts = Red_Bubble_Notifications::get_red_bubble_alerts();
791        } else {
792            // On other pages: use cached data only to avoid blocking.
793            $cached_alerts = Red_Bubble_Notifications::get_cached_alerts();
794
795            if ( false === $cached_alerts ) {
796                // No cache: warm it asynchronously via JS. Register a hidden zero-count
797                // placeholder so Menu_Renderer emits a `my-jetpack` badge element the
798                // warmer can reveal (see async-notification-bubble.ts) without a reload.
799                Menu_Badges::init(); // idempotent; wires the renderer.
800                Notification_Counts::register(
801                    'my-jetpack',
802                    array(
803                        'menu_slug' => 'my-jetpack',
804                        'count'     => 0,
805                        'type'      => 'count',
806                    )
807                );
808                add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_red_bubble_script' ) );
809                return;
810            }
811
812            $red_bubble_alerts = $cached_alerts;
813        }
814
815        // Filter out silent alerts.
816        $red_bubble_alerts = array_filter(
817            $red_bubble_alerts,
818            function ( $alert ) {
819                return empty( $alert['is_silent'] );
820            }
821        );
822
823        // Report each non-silent alert to the central menu-badges registry as an
824        // attention entry (count 1). The registry + renderer own the badge.
825        Menu_Badges::init(); // idempotent; wires the renderer.
826        foreach ( array_keys( $red_bubble_alerts ) as $slug ) {
827            // Protect reports its own count directly to the registry, but only when its
828            // standalone plugin is active (see class-jetpack-protect.php::admin_page_init()).
829            // If the standalone plugin isn't active, nobody else registers this count, so we
830            // must not skip it here or the alert silently disappears from the menu total.
831            if ( 'protect_has_threats' === $slug && Products\Protect::is_standalone_plugin_active() ) {
832                continue;
833            }
834            Notification_Counts::register(
835                'my-jetpack-' . $slug,
836                array(
837                    'menu_slug' => 'my-jetpack',
838                    'type'      => 'attention',
839                )
840            );
841        }
842    }
843
844    /**
845     * Enqueue the notification bubble script.
846     * Fetches fresh alert data via REST API without blocking page load.
847     *
848     * @return void
849     */
850    public static function enqueue_red_bubble_script() {
851        Assets::register_script(
852            'my-jetpack-notification-bubble',
853            '../build/async-notification-bubble.js',
854            __FILE__,
855            array(
856                'enqueue'   => true,
857                'in_footer' => true,
858            )
859        );
860    }
861
862    /**
863     * Get list of module names sorted by their recommendation score
864     *
865     * @return array|null
866     */
867    public static function get_recommended_modules() {
868        $recommendations_evaluation = \Jetpack_Options::get_option( 'recommendations_evaluation', null );
869
870        if ( ! $recommendations_evaluation ) {
871            return null;
872        }
873
874        arsort( $recommendations_evaluation ); // Sort by scores in descending order
875
876        return array_keys( $recommendations_evaluation ); // Get only module names
877    }
878}