Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
30.03% |
106 / 353 |
|
6.90% |
2 / 29 |
CRAP | |
0.00% |
0 / 1 |
| Initializer | |
30.03% |
106 / 353 |
|
6.90% |
2 / 29 |
2680.02 | |
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 / 82 |
|
0.00% |
0 / 1 |
42 | |||
| add_script_data | |
90.00% |
9 / 10 |
|
0.00% |
0 / 1 |
4.02 | |||
| 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 | |
| 8 | namespace Automattic\Jetpack\My_Jetpack; |
| 9 | |
| 10 | use Automattic\Jetpack\Admin_UI\Admin_Menu; |
| 11 | use Automattic\Jetpack\Agents_Manager\WP_REST_Jetpack_AI_JWT; |
| 12 | use Automattic\Jetpack\Assets; |
| 13 | use Automattic\Jetpack\Boost_Speed_Score\Speed_Score; |
| 14 | use Automattic\Jetpack\Boost_Speed_Score\Speed_Score_History; |
| 15 | use Automattic\Jetpack\Connection\Client; |
| 16 | use Automattic\Jetpack\Connection\Initial_State as Connection_Initial_State; |
| 17 | use Automattic\Jetpack\Connection\Manager as Connection_Manager; |
| 18 | use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication; |
| 19 | use Automattic\Jetpack\Constants as Jetpack_Constants; |
| 20 | use Automattic\Jetpack\ExPlat; |
| 21 | use Automattic\Jetpack\JITMS\JITM; |
| 22 | use Automattic\Jetpack\Licensing; |
| 23 | use Automattic\Jetpack\Menu_Badges\Menu_Badges; |
| 24 | use Automattic\Jetpack\Menu_Badges\Notification_Counts; |
| 25 | use Automattic\Jetpack\Modules; |
| 26 | use Automattic\Jetpack\Plugins_Installer; |
| 27 | use Automattic\Jetpack\Status; |
| 28 | use Automattic\Jetpack\Status\Host as Status_Host; |
| 29 | use Automattic\Jetpack\Sync\Functions as Sync_Functions; |
| 30 | use Automattic\Jetpack\Terms_Of_Service; |
| 31 | use Automattic\Jetpack\Tracking; |
| 32 | use Automattic\Jetpack\WP_Build_Polyfills\WP_Build_Polyfills; |
| 33 | use Jetpack; |
| 34 | use WP_Error; |
| 35 | |
| 36 | /** |
| 37 | * The main Initializer class that registers the admin menu and eneuque the assets. |
| 38 | */ |
| 39 | class Initializer { |
| 40 | |
| 41 | /** |
| 42 | * My Jetpack package version |
| 43 | * |
| 44 | * @var string |
| 45 | */ |
| 46 | const PACKAGE_VERSION = '5.40.7'; |
| 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 | add_filter( 'jetpack_admin_js_script_data', array( __CLASS__, 'add_script_data' ) ); |
| 290 | Assets::register_script( |
| 291 | 'my_jetpack_main_app', |
| 292 | '../build/index.js', |
| 293 | __FILE__, |
| 294 | array( |
| 295 | 'enqueue' => true, |
| 296 | 'in_footer' => true, |
| 297 | 'textdomain' => 'jetpack-my-jetpack', |
| 298 | ) |
| 299 | ); |
| 300 | $modules = new Modules(); |
| 301 | $connection = new Connection_Manager(); |
| 302 | $speed_score_history = new Speed_Score_History( get_site_url() ); |
| 303 | $latest_score = $speed_score_history->latest(); |
| 304 | $previous_score = array(); |
| 305 | if ( $speed_score_history->count() > 1 ) { |
| 306 | $previous_score = $speed_score_history->latest( 1 ); |
| 307 | } |
| 308 | $latest_score['previousScores'] = $previous_score['scores'] ?? array(); |
| 309 | |
| 310 | $sandboxed_domain = ''; |
| 311 | $is_dev_version = false; |
| 312 | if ( class_exists( 'Jetpack' ) ) { |
| 313 | $is_dev_version = Jetpack::is_development_version(); |
| 314 | $sandboxed_domain = defined( 'JETPACK__SANDBOX_DOMAIN' ) ? JETPACK__SANDBOX_DOMAIN : ''; |
| 315 | } |
| 316 | |
| 317 | wp_localize_script( |
| 318 | 'my_jetpack_main_app', |
| 319 | 'myJetpackInitialState', |
| 320 | array( |
| 321 | 'products' => array( |
| 322 | 'items' => Products::get_products(), |
| 323 | ), |
| 324 | 'plugins' => Plugins_Installer::get_plugins(), |
| 325 | 'themes' => Sync_Functions::get_themes(), |
| 326 | 'myJetpackUrl' => admin_url( 'admin.php?page=my-jetpack' ), |
| 327 | 'myJetpackCheckoutUri' => admin_url( 'admin.php?page=my-jetpack' ), |
| 328 | 'topJetpackMenuItemUrl' => Admin_Menu::get_top_level_menu_item_url(), |
| 329 | 'siteSuffix' => ( new Status() )->get_site_suffix(), |
| 330 | 'siteUrl' => esc_url( get_site_url() ), |
| 331 | 'blogID' => Connection_Manager::get_site_id( true ), |
| 332 | 'myJetpackVersion' => self::PACKAGE_VERSION, |
| 333 | 'myJetpackFlags' => self::get_my_jetpack_flags(), |
| 334 | 'fileSystemWriteAccess' => self::has_file_system_write_access(), |
| 335 | 'loadAddLicenseScreen' => self::is_licensing_ui_enabled(), |
| 336 | 'adminUrl' => esc_url( admin_url() ), |
| 337 | 'IDCContainerID' => static::get_idc_container_id(), |
| 338 | 'userIsAdmin' => current_user_can( 'manage_options' ), |
| 339 | 'lifecycleStats' => array( |
| 340 | 'jetpackPlugins' => self::get_installed_jetpack_plugins(), |
| 341 | 'historicallyActiveModules' => \Jetpack_Options::get_option( 'historically_active_modules', array() ), |
| 342 | 'brokenModules' => Red_Bubble_Notifications::check_for_broken_modules(), |
| 343 | 'isSiteConnected' => $connection->is_connected(), |
| 344 | 'isUserConnected' => $connection->is_user_connected(), |
| 345 | 'modules' => self::get_active_modules(), |
| 346 | ), |
| 347 | 'recommendedModules' => array( |
| 348 | 'modules' => self::get_recommended_modules(), |
| 349 | 'isFirstRun' => \Jetpack_Options::get_option( 'recommendations_first_run', true ), |
| 350 | 'dismissed' => \Jetpack_Options::get_option( 'dismissed_recommendations', false ), |
| 351 | ), |
| 352 | 'isStatsModuleActive' => $modules->is_active( 'stats' ), |
| 353 | 'canUserViewStats' => current_user_can( 'manage_options' ) || current_user_can( 'view_stats' ), |
| 354 | 'sandboxedDomain' => $sandboxed_domain, |
| 355 | 'isDevVersion' => $is_dev_version, |
| 356 | 'isAtomic' => ( new Status_Host() )->is_woa_site(), |
| 357 | 'isJetpackPluginActive' => class_exists( 'Jetpack' ), |
| 358 | 'latestBoostSpeedScores' => $latest_score, |
| 359 | 'seoOptIn' => self::get_seo_opt_in_state(), |
| 360 | ) |
| 361 | ); |
| 362 | |
| 363 | wp_localize_script( |
| 364 | 'my_jetpack_main_app', |
| 365 | 'myJetpackRest', |
| 366 | array( |
| 367 | 'apiRoot' => esc_url_raw( rest_url() ), |
| 368 | 'apiNonce' => wp_create_nonce( 'wp_rest' ), |
| 369 | ) |
| 370 | ); |
| 371 | |
| 372 | // Connection Initial State. |
| 373 | Connection_Initial_State::render_script( 'my_jetpack_main_app' ); |
| 374 | |
| 375 | // Required for Analytics. |
| 376 | if ( self::can_use_analytics() ) { |
| 377 | Tracking::register_tracks_functions_scripts( true ); |
| 378 | } |
| 379 | } |
| 380 | |
| 381 | /** |
| 382 | * Add My Jetpack data to the unified script data object. |
| 383 | * |
| 384 | * @param array $data The script data. |
| 385 | * @return array |
| 386 | */ |
| 387 | public static function add_script_data( $data ) { |
| 388 | $block_availability = class_exists( '\Jetpack_Gutenberg' ) |
| 389 | ? \Jetpack_Gutenberg::get_cached_availability() |
| 390 | : array(); |
| 391 | |
| 392 | $data['myJetpack']['siteEditor'] = array( |
| 393 | 'isBlockTheme' => function_exists( 'wp_is_block_theme' ) && wp_is_block_theme(), |
| 394 | 'isSharingBlockAvailable' => isset( $block_availability['sharing-buttons'] ) |
| 395 | && $block_availability['sharing-buttons']['available'], |
| 396 | 'activeThemeStylesheet' => get_stylesheet(), |
| 397 | ); |
| 398 | |
| 399 | return $data; |
| 400 | } |
| 401 | |
| 402 | /** |
| 403 | * Get installed Jetpack plugins |
| 404 | * |
| 405 | * @return array |
| 406 | */ |
| 407 | public static function get_installed_jetpack_plugins() { |
| 408 | $plugin_slugs = array_keys( Plugins_Installer::get_plugins() ); |
| 409 | $plugin_slugs = array_map( |
| 410 | static function ( $slug ) { |
| 411 | $parts = explode( '/', $slug ); |
| 412 | // Return the last segment of the filepath without the PHP extension |
| 413 | return str_replace( '.php', '', $parts[ count( $parts ) - 1 ] ); |
| 414 | }, |
| 415 | $plugin_slugs |
| 416 | ); |
| 417 | |
| 418 | return array_values( array_intersect( self::JETPACK_PLUGIN_SLUGS, $plugin_slugs ) ); |
| 419 | } |
| 420 | |
| 421 | /** |
| 422 | * Get active modules (except ones enabled by default) |
| 423 | * |
| 424 | * @return array |
| 425 | */ |
| 426 | public static function get_active_modules() { |
| 427 | $modules = new Modules(); |
| 428 | $active_modules = $modules->get_active(); |
| 429 | |
| 430 | // if the Jetpack plugin is active, filter out the modules that are active by default |
| 431 | if ( class_exists( 'Jetpack' ) && ! empty( $active_modules ) ) { |
| 432 | $active_modules = array_diff( $active_modules, Jetpack::get_default_modules() ); |
| 433 | } |
| 434 | return array_values( $active_modules ); |
| 435 | } |
| 436 | |
| 437 | /** |
| 438 | * Determine if the current user is "new" to Jetpack |
| 439 | * This is used to vary some messaging in My Jetpack |
| 440 | * |
| 441 | * On the front-end, purchases are also taken into account |
| 442 | * |
| 443 | * @return bool |
| 444 | */ |
| 445 | public static function is_jetpack_user_new() { |
| 446 | // is the user connected? |
| 447 | $connection = new Connection_Manager(); |
| 448 | if ( $connection->is_user_connected() ) { |
| 449 | return false; |
| 450 | } |
| 451 | |
| 452 | // TODO: add a data point for the last known connection/ disconnection time |
| 453 | |
| 454 | // are any modules active? |
| 455 | $active_modules = self::get_active_modules(); |
| 456 | if ( ! empty( $active_modules ) ) { |
| 457 | return false; |
| 458 | } |
| 459 | |
| 460 | // check for other Jetpack plugins that are installed on the site (active or not) |
| 461 | // If there's more than one Jetpack plugin active, this user is not "new" |
| 462 | $plugin_slugs = array_keys( Plugins_Installer::get_plugins() ); |
| 463 | $plugin_slugs = array_map( |
| 464 | static function ( $slug ) { |
| 465 | $parts = explode( '/', $slug ); |
| 466 | // Return the last segment of the filepath without the PHP extension |
| 467 | return str_replace( '.php', '', $parts[ count( $parts ) - 1 ] ); |
| 468 | }, |
| 469 | $plugin_slugs |
| 470 | ); |
| 471 | $installed_jetpack_plugins = array_intersect( self::JETPACK_PLUGIN_SLUGS, $plugin_slugs ); |
| 472 | if ( is_countable( $installed_jetpack_plugins ) && count( $installed_jetpack_plugins ) >= 2 ) { |
| 473 | return false; |
| 474 | } |
| 475 | |
| 476 | // Does the site have any purchases? |
| 477 | $purchases = Wpcom_Products::get_site_current_purchases(); |
| 478 | if ( ! empty( $purchases ) && ! is_wp_error( $purchases ) ) { |
| 479 | return false; |
| 480 | } |
| 481 | |
| 482 | return true; |
| 483 | } |
| 484 | |
| 485 | /** |
| 486 | * Build flags for My Jetpack UI |
| 487 | * |
| 488 | * @return array |
| 489 | */ |
| 490 | public static function get_my_jetpack_flags() { |
| 491 | $flags = array( |
| 492 | 'videoPressStats' => Jetpack_Constants::is_true( 'JETPACK_MY_JETPACK_VIDEOPRESS_STATS_ENABLED' ), |
| 493 | 'showFullJetpackStatsCard' => class_exists( 'Jetpack' ), |
| 494 | ); |
| 495 | |
| 496 | return $flags; |
| 497 | } |
| 498 | |
| 499 | /** |
| 500 | * Build the state the My Jetpack "try the new SEO experience" opt-in card hydrates from. |
| 501 | * |
| 502 | * The card invites an existing self-hosted install to switch over to the new Jetpack SEO |
| 503 | * dashboard (JETPACK-1700). Gating lives server-side, where the signals actually are. The |
| 504 | * card shows only when all of: |
| 505 | * |
| 506 | * - the new SEO product is available — the `rsm_jetpack_seo` feature filter is on (the SEO |
| 507 | * package autoloads regardless, so `class_exists()` alone isn't enough; the filter is the |
| 508 | * real availability switch and the same one the SEO package gates its own surface behind); |
| 509 | * - the site is self-hosted — WordPress.com (Simple + Atomic) decides its own SEO surface, so |
| 510 | * the opt-in card is for self-hosted installs only; |
| 511 | * - the install hasn't opted in yet — `jetpack_seo_surface_visible` is still false. On wpcom |
| 512 | * the SEO package's `is_seo_surface_visible()` short-circuits to `true`, so the |
| 513 | * "not visible yet" check also doubles as the self-hosted guard, but we check the platform |
| 514 | * explicitly for clarity. |
| 515 | * |
| 516 | * Referenced through `class_exists()` rather than a hard composer dependency: both packages |
| 517 | * ship inside the Jetpack plugin and the SEO surface is feature-flagged, so a guarded read of |
| 518 | * its public API keeps this from adding plumbing to consumers that don't load SEO. |
| 519 | * |
| 520 | * The on-success destination is computed by the opt-in endpoint itself; we only seed the card |
| 521 | * with the same admin URL so the button has a sensible fallback before the request resolves. |
| 522 | * |
| 523 | * @return array{showCard: bool, redirect: string} |
| 524 | */ |
| 525 | public static function get_seo_opt_in_state() { |
| 526 | // Guard with method_exists rather than class_exists: an older bundled SEO package can ship |
| 527 | // the Initializer class without this method, and class_exists alone would still fatal. |
| 528 | $seo_initializer = 'Automattic\Jetpack\SEO\Initializer'; |
| 529 | // @phan-suppress-next-line PhanUndeclaredClassReference -- optional SEO package, guarded by method_exists. |
| 530 | $show_card = method_exists( $seo_initializer, 'is_optin_available' ) && $seo_initializer::is_optin_available(); |
| 531 | |
| 532 | return array( |
| 533 | 'showCard' => $show_card, |
| 534 | 'redirect' => admin_url( 'admin.php?page=jetpack-seo' ), |
| 535 | ); |
| 536 | } |
| 537 | |
| 538 | /** |
| 539 | * Echoes the admin page content. |
| 540 | * |
| 541 | * @return void |
| 542 | */ |
| 543 | public static function admin_page() { |
| 544 | $step = isset( $_GET['step'] ) ? sanitize_text_field( wp_unslash( $_GET['step'] ) ) : ''; // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
| 545 | $is_onboarding = $step === 'onboarding'; |
| 546 | |
| 547 | // Add data attribute for onboarding, otherwise render normal container |
| 548 | echo '<div id="my-jetpack-container" ' . ( $is_onboarding ? 'data-route="onboarding"' : '' ) . '></div>'; |
| 549 | } |
| 550 | |
| 551 | /** |
| 552 | * Register the REST API routes. |
| 553 | * |
| 554 | * @return void |
| 555 | */ |
| 556 | public static function register_rest_endpoints() { |
| 557 | new REST_Products(); |
| 558 | new REST_Purchases(); |
| 559 | new REST_Zendesk_Chat(); |
| 560 | ( new WP_REST_Jetpack_AI_JWT() )->register_rest_route(); |
| 561 | new REST_Recommendations_Evaluation(); |
| 562 | |
| 563 | Products::register_product_endpoints(); |
| 564 | Historically_Active_Modules::register_rest_endpoints(); |
| 565 | Jetpack_Manage::register_rest_endpoints(); |
| 566 | Red_Bubble_Notifications::register_rest_endpoints(); |
| 567 | |
| 568 | register_rest_route( |
| 569 | 'my-jetpack/v1', |
| 570 | 'site', |
| 571 | array( |
| 572 | 'methods' => \WP_REST_Server::READABLE, |
| 573 | 'callback' => __CLASS__ . '::get_site', |
| 574 | 'permission_callback' => __CLASS__ . '::permissions_callback', |
| 575 | ) |
| 576 | ); |
| 577 | |
| 578 | register_rest_route( |
| 579 | 'my-jetpack/v1', |
| 580 | 'site/dismiss-welcome-banner', |
| 581 | array( |
| 582 | 'methods' => \WP_REST_Server::EDITABLE, |
| 583 | 'callback' => __CLASS__ . '::dismiss_welcome_banner', |
| 584 | 'permission_callback' => __CLASS__ . '::permissions_callback', |
| 585 | ) |
| 586 | ); |
| 587 | } |
| 588 | |
| 589 | /** |
| 590 | * Check user capability to access the endpoint. |
| 591 | * |
| 592 | * @access public |
| 593 | * @static |
| 594 | * |
| 595 | * @return true|WP_Error |
| 596 | */ |
| 597 | public static function permissions_callback() { |
| 598 | return current_user_can( 'manage_options' ); |
| 599 | } |
| 600 | |
| 601 | /** |
| 602 | * Return true if we should initialize the My Jetpack admin page. |
| 603 | */ |
| 604 | public static function should_initialize() { |
| 605 | $should = true; |
| 606 | |
| 607 | // All options presented in My Jetpack require a connection to WordPress.com. |
| 608 | if ( ( new Status() )->is_offline_mode() ) { |
| 609 | $should = false; |
| 610 | } |
| 611 | |
| 612 | /** |
| 613 | * Allows filtering whether My Jetpack should be initialized. |
| 614 | * |
| 615 | * @since 0.5.0-alpha |
| 616 | * |
| 617 | * @param bool $shoud_initialize Should we initialize My Jetpack? |
| 618 | */ |
| 619 | return apply_filters( 'jetpack_my_jetpack_should_initialize', $should ); |
| 620 | } |
| 621 | |
| 622 | /** |
| 623 | * Hook into several connection-based actions to update the historically active Jetpack modules |
| 624 | * If the transient that indicates the list needs to be synced, update it and delete the transient |
| 625 | * |
| 626 | * @return void |
| 627 | */ |
| 628 | public static function setup_historically_active_jetpack_modules_sync() { |
| 629 | // yummmm. ham. |
| 630 | $ham = new Historically_Active_Modules(); |
| 631 | if ( get_transient( $ham::UPDATE_HISTORICALLY_ACTIVE_JETPACK_MODULES_KEY ) && ! wp_doing_ajax() ) { |
| 632 | $ham::update_historically_active_jetpack_modules(); |
| 633 | delete_transient( $ham::UPDATE_HISTORICALLY_ACTIVE_JETPACK_MODULES_KEY ); |
| 634 | } |
| 635 | |
| 636 | $actions = array( |
| 637 | 'jetpack_site_registered', |
| 638 | 'jetpack_user_authorized', |
| 639 | 'activated_plugin', |
| 640 | ); |
| 641 | |
| 642 | foreach ( $actions as $action ) { |
| 643 | add_action( $action, array( $ham, 'queue_historically_active_jetpack_modules_update' ), 5 ); |
| 644 | } |
| 645 | |
| 646 | // Modules are often updated async, so we need to update them right away as there will sometimes be no page reload. |
| 647 | add_action( 'jetpack_activate_module', array( $ham, 'update_historically_active_jetpack_modules' ), 5 ); |
| 648 | } |
| 649 | |
| 650 | /** |
| 651 | * Site full-data endpoint. |
| 652 | * |
| 653 | * @return object Site data. |
| 654 | */ |
| 655 | public static function get_site() { |
| 656 | $site_id = \Jetpack_Options::get_option( 'id' ); |
| 657 | $wpcom_endpoint = sprintf( '/sites/%d?force=wpcom', $site_id ); |
| 658 | $wpcom_api_version = '1.1'; |
| 659 | $response = Client::wpcom_json_api_request_as_blog( $wpcom_endpoint, $wpcom_api_version ); |
| 660 | $response_code = wp_remote_retrieve_response_code( $response ); |
| 661 | $body = json_decode( wp_remote_retrieve_body( $response ) ); |
| 662 | |
| 663 | if ( is_wp_error( $response ) || empty( $response['body'] ) ) { |
| 664 | return new WP_Error( 'site_data_fetch_failed', 'Site data fetch failed', array( 'status' => $response_code ) ); |
| 665 | } |
| 666 | |
| 667 | return rest_ensure_response( $body ); |
| 668 | } |
| 669 | |
| 670 | /** |
| 671 | * Populates the self::$site_info var with site data from the /sites/%d endpoint |
| 672 | * |
| 673 | * @return object|WP_Error |
| 674 | */ |
| 675 | public static function get_site_info() { |
| 676 | static $site_info = null; |
| 677 | |
| 678 | if ( $site_info !== null ) { |
| 679 | return $site_info; |
| 680 | } |
| 681 | |
| 682 | // Check for a cached value before doing lookup |
| 683 | $stored_site_info = get_transient( self::MY_JETPACK_SITE_INFO_TRANSIENT_KEY ); |
| 684 | if ( $stored_site_info !== false ) { |
| 685 | return $stored_site_info; |
| 686 | } |
| 687 | |
| 688 | $response = self::get_site(); |
| 689 | if ( is_wp_error( $response ) ) { |
| 690 | return $response; |
| 691 | } |
| 692 | $site_info = $response->data; |
| 693 | set_transient( self::MY_JETPACK_SITE_INFO_TRANSIENT_KEY, $site_info, DAY_IN_SECONDS ); |
| 694 | |
| 695 | return $site_info; |
| 696 | } |
| 697 | |
| 698 | /** |
| 699 | * Returns whether a site has been determined "commercial" or not. |
| 700 | * |
| 701 | * @return bool|null |
| 702 | */ |
| 703 | public static function is_commercial_site() { |
| 704 | if ( is_wp_error( self::$site_info ) ) { |
| 705 | return null; |
| 706 | } |
| 707 | |
| 708 | return empty( self::$site_info->options->is_commercial ) ? false : self::$site_info->options->is_commercial; |
| 709 | } |
| 710 | |
| 711 | /** |
| 712 | * Check if site is registered (has been connected before). |
| 713 | * |
| 714 | * @return bool |
| 715 | */ |
| 716 | public static function is_registered() { |
| 717 | return (bool) \Jetpack_Options::get_option( 'id' ); |
| 718 | } |
| 719 | |
| 720 | /** |
| 721 | * Dismiss the welcome banner. |
| 722 | * |
| 723 | * @return \WP_REST_Response |
| 724 | */ |
| 725 | public static function dismiss_welcome_banner() { |
| 726 | \Jetpack_Options::update_option( 'dismissed_welcome_banner', true ); |
| 727 | return rest_ensure_response( array( 'success' => true ) ); |
| 728 | } |
| 729 | |
| 730 | /** |
| 731 | * Returns "yes" if the site has file write access to the plugins folder, "no" otherwise. |
| 732 | * |
| 733 | * @return string |
| 734 | **/ |
| 735 | public static function has_file_system_write_access() { |
| 736 | |
| 737 | $cache = get_transient( 'my_jetpack_write_access' ); |
| 738 | |
| 739 | if ( false !== $cache ) { |
| 740 | return $cache; |
| 741 | } |
| 742 | |
| 743 | if ( ! function_exists( 'get_filesystem_method' ) ) { |
| 744 | require_once ABSPATH . 'wp-admin/includes/file.php'; |
| 745 | } |
| 746 | |
| 747 | require_once ABSPATH . 'wp-admin/includes/template.php'; |
| 748 | |
| 749 | $write_access = 'no'; |
| 750 | |
| 751 | $filesystem_method = get_filesystem_method( array(), WP_PLUGIN_DIR ); |
| 752 | if ( 'direct' === $filesystem_method ) { |
| 753 | $write_access = 'yes'; |
| 754 | } |
| 755 | |
| 756 | if ( 'no' === $write_access ) { |
| 757 | ob_start(); |
| 758 | $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() ); |
| 759 | ob_end_clean(); |
| 760 | |
| 761 | if ( $filesystem_credentials_are_stored ) { |
| 762 | $write_access = 'yes'; |
| 763 | } |
| 764 | } |
| 765 | |
| 766 | set_transient( 'my_jetpack_write_access', $write_access, 30 * MINUTE_IN_SECONDS ); |
| 767 | |
| 768 | return $write_access; |
| 769 | } |
| 770 | |
| 771 | /** |
| 772 | * Get container IDC for the IDC screen. |
| 773 | * |
| 774 | * @return string |
| 775 | */ |
| 776 | public static function get_idc_container_id() { |
| 777 | return static::IDC_CONTAINER_ID; |
| 778 | } |
| 779 | |
| 780 | /** |
| 781 | * Conditionally append the red bubble notification to the "Jetpack" menu item if there are alerts to show. |
| 782 | * |
| 783 | * On My Jetpack page: Uses blocking behavior to fetch fresh data. |
| 784 | * On other admin pages: Uses cached data only to avoid blocking, with async JS fetch if cache is empty. |
| 785 | * |
| 786 | * @return void |
| 787 | */ |
| 788 | public static function maybe_show_red_bubble() { |
| 789 | global $pagenow; |
| 790 | |
| 791 | // Don't show red bubble alerts for non-admin users |
| 792 | // These alerts are generally only actionable for admins |
| 793 | if ( ! current_user_can( 'manage_options' ) ) { |
| 794 | return; |
| 795 | } |
| 796 | |
| 797 | // Don't show any red bubbles when Jetpack is disconnected |
| 798 | // Users can't act on most alerts without a connection |
| 799 | $connection = new Connection_Manager(); |
| 800 | if ( ! $connection->is_connected() ) { |
| 801 | return; |
| 802 | } |
| 803 | |
| 804 | // Check if we're on the My Jetpack page. |
| 805 | // phpcs:ignore WordPress.Security.NonceVerification.Recommended |
| 806 | $page = isset( $_GET['page'] ) ? sanitize_text_field( wp_unslash( $_GET['page'] ) ) : ''; |
| 807 | $is_my_jetpack_page = $pagenow === 'admin.php' && $page === 'my-jetpack'; |
| 808 | |
| 809 | if ( $is_my_jetpack_page ) { |
| 810 | // On My Jetpack page: use blocking behavior for fresh data. |
| 811 | add_filter( 'my_jetpack_red_bubble_notification_slugs', array( Red_Bubble_Notifications::class, 'add_red_bubble_alerts' ) ); |
| 812 | $red_bubble_alerts = Red_Bubble_Notifications::get_red_bubble_alerts(); |
| 813 | } else { |
| 814 | // On other pages: use cached data only to avoid blocking. |
| 815 | $cached_alerts = Red_Bubble_Notifications::get_cached_alerts(); |
| 816 | |
| 817 | if ( false === $cached_alerts ) { |
| 818 | // No cache: warm it asynchronously via JS. Register a hidden zero-count |
| 819 | // placeholder so Menu_Renderer emits a `my-jetpack` badge element the |
| 820 | // warmer can reveal (see async-notification-bubble.ts) without a reload. |
| 821 | Menu_Badges::init(); // idempotent; wires the renderer. |
| 822 | Notification_Counts::register( |
| 823 | 'my-jetpack', |
| 824 | array( |
| 825 | 'menu_slug' => 'my-jetpack', |
| 826 | 'count' => 0, |
| 827 | 'type' => 'count', |
| 828 | ) |
| 829 | ); |
| 830 | add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_red_bubble_script' ) ); |
| 831 | return; |
| 832 | } |
| 833 | |
| 834 | $red_bubble_alerts = $cached_alerts; |
| 835 | } |
| 836 | |
| 837 | // Filter out silent alerts. |
| 838 | $red_bubble_alerts = array_filter( |
| 839 | $red_bubble_alerts, |
| 840 | function ( $alert ) { |
| 841 | return empty( $alert['is_silent'] ); |
| 842 | } |
| 843 | ); |
| 844 | |
| 845 | // Report each non-silent alert to the central menu-badges registry as an |
| 846 | // attention entry (count 1). The registry + renderer own the badge. |
| 847 | Menu_Badges::init(); // idempotent; wires the renderer. |
| 848 | foreach ( array_keys( $red_bubble_alerts ) as $slug ) { |
| 849 | // Protect reports its own count directly to the registry, but only when its |
| 850 | // standalone plugin is active (see class-jetpack-protect.php::admin_page_init()). |
| 851 | // If the standalone plugin isn't active, nobody else registers this count, so we |
| 852 | // must not skip it here or the alert silently disappears from the menu total. |
| 853 | if ( 'protect_has_threats' === $slug && Products\Protect::is_standalone_plugin_active() ) { |
| 854 | continue; |
| 855 | } |
| 856 | Notification_Counts::register( |
| 857 | 'my-jetpack-' . $slug, |
| 858 | array( |
| 859 | 'menu_slug' => 'my-jetpack', |
| 860 | 'type' => 'attention', |
| 861 | ) |
| 862 | ); |
| 863 | } |
| 864 | } |
| 865 | |
| 866 | /** |
| 867 | * Enqueue the notification bubble script. |
| 868 | * Fetches fresh alert data via REST API without blocking page load. |
| 869 | * |
| 870 | * @return void |
| 871 | */ |
| 872 | public static function enqueue_red_bubble_script() { |
| 873 | Assets::register_script( |
| 874 | 'my-jetpack-notification-bubble', |
| 875 | '../build/async-notification-bubble.js', |
| 876 | __FILE__, |
| 877 | array( |
| 878 | 'enqueue' => true, |
| 879 | 'in_footer' => true, |
| 880 | ) |
| 881 | ); |
| 882 | } |
| 883 | |
| 884 | /** |
| 885 | * Get list of module names sorted by their recommendation score |
| 886 | * |
| 887 | * @return array|null |
| 888 | */ |
| 889 | public static function get_recommended_modules() { |
| 890 | $recommendations_evaluation = \Jetpack_Options::get_option( 'recommendations_evaluation', null ); |
| 891 | |
| 892 | if ( ! $recommendations_evaluation ) { |
| 893 | return null; |
| 894 | } |
| 895 | |
| 896 | arsort( $recommendations_evaluation ); // Sort by scores in descending order |
| 897 | |
| 898 | return array_keys( $recommendations_evaluation ); // Get only module names |
| 899 | } |
| 900 | } |