Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
39.49% covered (danger)
39.49%
938 / 2375
28.89% covered (danger)
28.89%
52 / 180
CRAP
0.00% covered (danger)
0.00%
0 / 1
Jetpack
39.54% covered (danger)
39.54%
938 / 2372
28.89% covered (danger)
28.89%
52 / 180
146497.21
0.00% covered (danger)
0.00%
0 / 1
 init
40.00% covered (danger)
40.00%
2 / 5
0.00% covered (danger)
0.00%
0 / 1
2.86
 plugin_upgrade
0.00% covered (danger)
0.00%
0 / 51
0.00% covered (danger)
0.00%
0 / 1
420
 upgrade_on_load
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
20
 update_active_modules
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 delete_active_modules
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 add_configure_hook
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
12
 __construct
0.00% covered (danger)
0.00%
0 / 68
0.00% covered (danger)
0.00%
0 / 1
12
 should_eager_load_packages
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
5
 configure_import_package
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
3
 get_module_deactivation_note
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
2
 offers_backup_dashboard
50.00% covered (danger)
50.00%
3 / 6
0.00% covered (danger)
0.00%
0 / 1
10.50
 configure_backup_package
83.33% covered (warning)
83.33%
5 / 6
0.00% covered (danger)
0.00%
0 / 1
4.07
 is_premium_analytics_enabled
66.67% covered (warning)
66.67%
12 / 18
0.00% covered (danger)
0.00%
0 / 1
8.81
 register_premium_analytics_enablement_setting
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
2
 configure
91.95% covered (success)
91.95%
80 / 87
0.00% covered (danger)
0.00%
0 / 1
23.28
 late_initialization
96.30% covered (success)
96.30%
26 / 27
0.00% covered (danger)
0.00%
0 / 1
4
 add_wpcom_to_allowed_redirect_hosts
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 allow_wpcom_domain
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 point_edit_post_links_to_calypso
n/a
0 / 0
n/a
0 / 0
3
 point_edit_comment_links_to_calypso
n/a
0 / 0
n/a
0 / 0
1
 filter_sync_callable_whitelist
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
1
 filter_sync_multisite_callable_whitelist
100.00% covered (success)
100.00%
10 / 10
100.00% covered (success)
100.00%
1 / 1
1
 push_stats
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
6
 jetpack_custom_caps
76.19% covered (warning)
76.19%
16 / 21
0.00% covered (danger)
0.00%
0 / 1
7.66
 register_assets
97.44% covered (success)
97.44%
38 / 39
0.00% covered (danger)
0.00%
0 / 1
5
 guess_locale_from_lang
12.50% covered (danger)
12.50%
2 / 16
0.00% covered (danger)
0.00%
0 / 1
108.47
 get_locale
75.00% covered (warning)
75.00%
3 / 4
0.00% covered (danger)
0.00%
0 / 1
2.06
 jetpack_main_network_site_option
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 network_name
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 network_allow_new_registrations
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
 network_add_new_users
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 network_site_upload_space
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
2
 network_upload_file_types
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 network_max_upload_file_size
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 network_enable_administration_menus
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 maybe_clear_other_linked_admins_transient
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
5
 get_other_linked_admins
93.33% covered (success)
93.33%
14 / 15
0.00% covered (danger)
0.00%
0 / 1
7.01
 is_main_network_option
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 is_multisite
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 is_multi_network
83.33% covered (warning)
83.33%
5 / 6
0.00% covered (danger)
0.00%
0 / 1
3.04
 is_single_user_site
100.00% covered (success)
100.00%
5 / 5
100.00% covered (success)
100.00%
1 / 1
2
 file_system_write_access
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
20
 get_updates
66.67% covered (warning)
66.67%
6 / 9
0.00% covered (danger)
0.00%
0 / 1
5.93
 get_update_details
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
2
 is_active
n/a
0 / 0
n/a
0 / 0
1
 is_connection_ready
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 development_mode_trigger_text
0.00% covered (danger)
0.00%
0 / 13
0.00% covered (danger)
0.00%
0 / 1
72
 show_development_mode_notice
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
12
 is_development_version
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
1
 get_connected_user_email
0.00% covered (danger)
0.00%
0 / 11
0.00% covered (danger)
0.00%
0 / 1
12
 get_master_user_email
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 current_user_ip
n/a
0 / 0
n/a
0 / 0
1
 load_modules
64.44% covered (warning)
64.44%
29 / 45
0.00% covered (danger)
0.00%
0 / 1
40.82
 check_rest_api_compat
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 get_active_plugins
66.67% covered (warning)
66.67%
2 / 3
0.00% covered (danger)
0.00%
0 / 1
2.15
 get_parsed_plugin_data
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
12
 get_parsed_theme_data
0.00% covered (danger)
0.00%
0 / 15
0.00% covered (danger)
0.00%
0 / 1
12
 is_plugin_active
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 check_open_graph
0.00% covered (danger)
0.00%
0 / 11
0.00% covered (danger)
0.00%
0 / 1
56
 check_twitter_tags
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
30
 get_option_names
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 get_option
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 glob_php
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 activate_new_modules
0.00% covered (danger)
0.00%
0 / 38
0.00% covered (danger)
0.00%
0 / 1
132
 get_available_modules
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 get_default_modules
93.75% covered (success)
93.75%
15 / 16
0.00% covered (danger)
0.00%
0 / 1
8.02
 handle_deprecated_modules
66.67% covered (warning)
66.67%
12 / 18
0.00% covered (danger)
0.00%
0 / 1
10.37
 filter_default_modules
53.85% covered (warning)
53.85%
7 / 13
0.00% covered (danger)
0.00%
0 / 1
14.29
 get_module_slug
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 get_module_path
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 get_module
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 get_file_data
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 translate_module_tag
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 get_translated_modules
100.00% covered (success)
100.00%
12 / 12
100.00% covered (success)
100.00%
1 / 1
7
 get_active_modules
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 is_module_active
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 is_module
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 catch_errors
n/a
0 / 0
n/a
0 / 0
1
 catch_errors_on_shutdown
n/a
0 / 0
n/a
0 / 0
1
 alias_directories
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
2
 activate_default_modules
40.96% covered (danger)
40.96%
34 / 83
0.00% covered (danger)
0.00%
0 / 1
318.68
 activate_module
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 deactivate_module
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 enable_module_configurable
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 module_configuration_url
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
1
 bail_on_activation
0.00% covered (danger)
0.00%
0 / 16
0.00% covered (danger)
0.00%
0 / 1
30
 plugin_activation
85.71% covered (warning)
85.71%
12 / 14
0.00% covered (danger)
0.00%
0 / 1
7.14
 get_activation_source
93.55% covered (success)
93.55%
29 / 31
0.00% covered (danger)
0.00%
0 / 1
13.05
 do_version_bump
n/a
0 / 0
n/a
0 / 0
1
 activate_subscriptions_module_for_existing_sites
77.78% covered (warning)
77.78%
7 / 9
0.00% covered (danger)
0.00%
0 / 1
6.40
 register_upgrade_init_hooks
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 reconcile_ai_master_optout
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
5
 cleanup_seo_module_state_options
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 seed_seo_visibility_cohort
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 set_update_modal_display
n/a
0 / 0
n/a
0 / 0
1
 enqueue_block_style
n/a
0 / 0
n/a
0 / 0
2
 plugin_initialize
90.91% covered (success)
90.91%
10 / 11
0.00% covered (danger)
0.00%
0 / 1
4.01
 handle_default_module_activation
88.24% covered (warning)
88.24%
15 / 17
0.00% covered (danger)
0.00%
0 / 1
5.04
 plugin_deactivation
90.00% covered (success)
90.00%
9 / 10
0.00% covered (danger)
0.00%
0 / 1
4.02
 on_idc_disconnect
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 disconnect
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 jetpack_site_disconnected
100.00% covered (success)
100.00%
6 / 6
100.00% covered (success)
100.00%
1 / 1
2
 disconnect_user
n/a
0 / 0
n/a
0 / 0
1
 registration_check_domains
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
20
 log
0.00% covered (danger)
0.00%
0 / 16
0.00% covered (danger)
0.00%
0 / 1
20
 get_log
0.00% covered (danger)
0.00%
0 / 17
0.00% covered (danger)
0.00%
0 / 1
132
 log_settings_change
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 get_stat_data
n/a
0 / 0
n/a
0 / 0
4
 get_additional_stat_data
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
6
 get_site_user_count
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
20
 admin_init
0.00% covered (danger)
0.00%
0 / 21
0.00% covered (danger)
0.00%
0 / 1
240
 admin_body_class
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
6
 add_jetpack_pagestyles
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 throw_error_on_activate_plugin
0.00% covered (danger)
0.00%
0 / 11
0.00% covered (danger)
0.00%
0 / 1
56
 plugins_page_init_jetpack_state
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 intercept_plugin_error_scrape_init
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 intercept_plugin_error_scrape
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
30
 add_remote_request_handlers
15.38% covered (danger)
15.38%
2 / 13
0.00% covered (danger)
0.00%
0 / 1
36.69
 remote_request_handlers
0.00% covered (danger)
0.00%
0 / 22
0.00% covered (danger)
0.00%
0 / 1
72
 upload_handler
0.00% covered (danger)
0.00%
0 / 93
0.00% covered (danger)
0.00%
0 / 1
870
 plugin_action_links
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
20
 deactivate_dialog
0.00% covered (danger)
0.00%
0 / 15
0.00% covered (danger)
0.00%
0 / 1
12
 jetpack_plugin_portal_containers
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 login_url
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
2
 login_init
91.67% covered (success)
91.67%
11 / 12
0.00% covered (danger)
0.00%
0 / 1
2.00
 get_registration_error_description
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
20
 admin_page_load
0.00% covered (danger)
0.00%
0 / 144
0.00% covered (danger)
0.00%
0 / 1
2162
 admin_notices
0.00% covered (danger)
0.00%
0 / 106
0.00% covered (danger)
0.00%
0 / 1
56
 initialize_stats
50.00% covered (danger)
50.00%
1 / 2
0.00% covered (danger)
0.00%
0 / 1
2.50
 stat
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 do_stats
80.00% covered (warning)
80.00%
4 / 5
0.00% covered (danger)
0.00%
0 / 1
2.03
 do_server_side_stat
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
2
 build_stats_url
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
2
 build_connect_url
68.97% covered (warning)
68.97%
20 / 29
0.00% covered (danger)
0.00%
0 / 1
16.30
 build_authorize_url
n/a
0 / 0
n/a
0 / 0
1
 filter_connect_request_body
n/a
0 / 0
n/a
0 / 0
1
 filter_jetpack_current_user_connection_data
94.74% covered (success)
94.74%
18 / 19
0.00% covered (danger)
0.00%
0 / 1
6.01
 filter_connect_redirect_url
n/a
0 / 0
n/a
0 / 0
1
 authorize_starting
0.00% covered (danger)
0.00%
0 / 13
0.00% covered (danger)
0.00%
0 / 1
6
 handle_unique_registrations_stats
100.00% covered (success)
100.00%
7 / 7
100.00% covered (success)
100.00%
1 / 1
2
 authorize_ending_linked
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 authorize_ending_authorized
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
12
 activate_default_modules_on_site_register
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 reconnection_completed
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 apply_activation_source_to_args
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 build_reconnect_url
0.00% covered (danger)
0.00%
0 / 2
0.00% covered (danger)
0.00%
0 / 1
6
 admin_url
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 nonce_url_no_esc
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 dismiss_jetpack_notice
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
30
 sort_modules
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 ajax_recheck_ssl
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
2
 verify_onboarding_token
n/a
0 / 0
n/a
0 / 0
15
 create_onboarding_token
n/a
0 / 0
n/a
0 / 0
2
 invalidate_onboarding_token
n/a
0 / 0
n/a
0 / 0
1
 validate_onboarding_token_action
n/a
0 / 0
n/a
0 / 0
3
 permit_ssl
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
6
 get_ssl_test_message
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
30
 alert_auto_ssl_fail
0.00% covered (danger)
0.00%
0 / 28
0.00% covered (danger)
0.00%
0 / 1
6
 connection
75.00% covered (warning)
75.00%
3 / 4
0.00% covered (danger)
0.00%
0 / 1
2.06
 get_secrets
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
12
 filter_token_request_body
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
2
 maybe_set_version_option
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
12
 state
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 restate
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 should_set_cookie
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 check_privacy
0.00% covered (danger)
0.00%
0 / 18
0.00% covered (danger)
0.00%
0 / 1
42
 login_form_json_api_authorization
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
2
 post_login_form_to_signed_url
0.00% covered (danger)
0.00%
0 / 9
0.00% covered (danger)
0.00%
0 / 1
42
 preserve_action_in_login_form_for_json_api_authorization
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
12
 store_json_api_authorization_token
n/a
0 / 0
n/a
0 / 0
1
 allow_wpcom_public_api_domain
n/a
0 / 0
n/a
0 / 0
1
 is_redirect_encoded
n/a
0 / 0
n/a
0 / 0
1
 allow_wpcom_environments
n/a
0 / 0
n/a
0 / 0
1
 add_token_to_login_redirect_json_api_authorization
n/a
0 / 0
n/a
0 / 0
1
 verify_json_api_authorization_request
n/a
0 / 0
n/a
0 / 0
1
 login_message_json_api_authorization
n/a
0 / 0
n/a
0 / 0
1
 get_content_width
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
3
 get_cloud_site_options
0.00% covered (danger)
0.00%
0 / 10
0.00% covered (danger)
0.00%
0 / 1
6
 check_identity_crisis
n/a
0 / 0
n/a
0 / 0
1
 normalize_url_protocol_agnostic
80.00% covered (warning)
80.00%
4 / 5
0.00% covered (danger)
0.00%
0 / 1
4.13
 maybe_min_asset
28.57% covered (danger)
28.57%
6 / 21
0.00% covered (danger)
0.00%
0 / 1
31.32
 set_suffix_on_min
50.00% covered (danger)
50.00%
4 / 8
0.00% covered (danger)
0.00%
0 / 1
10.50
 maybe_inline_style
n/a
0 / 0
n/a
0 / 0
1
 load_view
0.00% covered (danger)
0.00%
0 / 7
0.00% covered (danger)
0.00%
0 / 1
20
 register_jetpack_connection_tests
100.00% covered (success)
100.00%
3 / 3
100.00% covered (success)
100.00%
1 / 1
1
 deprecated_hooks
100.00% covered (success)
100.00%
284 / 284
100.00% covered (success)
100.00%
1 / 1
5
 absolutize_css_urls
100.00% covered (success)
100.00%
28 / 28
100.00% covered (success)
100.00%
1 / 1
10
 jetpack_check_heartbeat_data
0.00% covered (danger)
0.00%
0 / 35
0.00% covered (danger)
0.00%
0 / 1
156
 get_jetpack_options_for_reset
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 get_user_option_meta_box_order_dashboard
0.00% covered (danger)
0.00%
0 / 12
0.00% covered (danger)
0.00%
0 / 1
30
 is_akismet_active
0.00% covered (danger)
0.00%
0 / 17
0.00% covered (danger)
0.00%
0 / 1
90
 get_file_url_for_environment
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 is_rewind_enabled
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
110
 get_calypso_env
n/a
0 / 0
n/a
0 / 0
1
 get_calypso_host
100.00% covered (success)
100.00%
8 / 8
100.00% covered (success)
100.00%
1 / 1
5
 handle_post_authorization_actions
58.33% covered (warning)
58.33%
7 / 12
0.00% covered (danger)
0.00%
0 / 1
5.16
 show_backups_ui
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
20
 show_scan_ui
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
12
 user_meta_cleanup
88.89% covered (warning)
88.89%
8 / 9
0.00% covered (danger)
0.00%
0 / 1
3.01
 is_active_and_not_offline_mode
66.67% covered (warning)
66.67%
2 / 3
0.00% covered (danger)
0.00%
0 / 1
3.33
 get_products_for_purchase
0.00% covered (danger)
0.00%
0 / 134
0.00% covered (danger)
0.00%
0 / 1
6
 get_partner_coupon_product_descriptions
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
 current_user_can_purchase
0.00% covered (danger)
0.00%
0 / 5
0.00% covered (danger)
0.00%
0 / 1
12
 add_5_star_review_link
0.00% covered (danger)
0.00%
0 / 8
0.00% covered (danger)
0.00%
0 / 1
6
 initialize_tracking
75.00% covered (warning)
75.00%
3 / 4
0.00% covered (danger)
0.00%
0 / 1
4.25
 run_initialize_tracking_action
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 maybe_initialize_rest_jsonapi
0.00% covered (danger)
0.00%
0 / 4
0.00% covered (danger)
0.00%
0 / 1
20
 plugin_post_activation
0.00% covered (danger)
0.00%
0 / 14
0.00% covered (danger)
0.00%
0 / 1
56
1<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2/**
3 * The mega-class.
4 *
5 * This contains too much, so please think twice before adding more.
6 *
7 * @package automattic/jetpack
8 */
9
10use Automattic\Jetpack\Assets;
11use Automattic\Jetpack\Boost_Speed_Score\Speed_Score;
12use Automattic\Jetpack\Config;
13use Automattic\Jetpack\Connection\Authorize_Json_Api;
14use Automattic\Jetpack\Connection\Client;
15use Automattic\Jetpack\Connection\Manager as Connection_Manager;
16use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication;
17use Automattic\Jetpack\Connection\Secrets;
18use Automattic\Jetpack\Connection\Tokens;
19use Automattic\Jetpack\Connection\Utils as Connection_Utils;
20use Automattic\Jetpack\Connection\Webhooks\Authorize_Redirect;
21use Automattic\Jetpack\Constants;
22use Automattic\Jetpack\CookieState;
23use Automattic\Jetpack\Current_Plan as Jetpack_Plan;
24use Automattic\Jetpack\Device_Detection\User_Agent_Info;
25use Automattic\Jetpack\Errors;
26use Automattic\Jetpack\Feature_Policy;
27use Automattic\Jetpack\Files;
28use Automattic\Jetpack\Heartbeat;
29use Automattic\Jetpack\Identity_Crisis;
30use Automattic\Jetpack\Import\Main as Import_Main;
31use Automattic\Jetpack\Licensing;
32use Automattic\Jetpack\Modules;
33use Automattic\Jetpack\My_Jetpack\Initializer as My_Jetpack_Initializer;
34use Automattic\Jetpack\Newsletter\Reader_Link;
35use Automattic\Jetpack\Paths;
36use Automattic\Jetpack\Plugin\Deprecate;
37use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
38use Automattic\Jetpack\Podcast\Podcast;
39use Automattic\Jetpack\Redirect;
40use Automattic\Jetpack\Scan_Page\Jetpack_Scan as Scan_Page_Init;
41use Automattic\Jetpack\SEO\Initializer as Jetpack_SEO_Initializer;
42use Automattic\Jetpack\Status;
43use Automattic\Jetpack\Status\Host;
44use Automattic\Jetpack\Status\Visitor;
45use Automattic\Jetpack\Sync\Actions as Sync_Actions;
46use Automattic\Jetpack\Sync\Health;
47use Automattic\Jetpack\Sync\Sender;
48use Automattic\Jetpack\Terms_Of_Service;
49use Automattic\Jetpack\Tracking;
50use Automattic\Woocommerce_Analytics;
51
52if ( ! defined( 'ABSPATH' ) ) {
53    exit( 0 );
54}
55
56/*
57Options:
58jetpack_options (array)
59    An array of options.
60    @see Jetpack_Options::get_option_names()
61
62jetpack_register (string)
63    Temporary verification secrets.
64
65jetpack_activated (int)
66    1: the plugin was activated normally
67    2: the plugin was activated on this site because of a network-wide activation
68    3: the plugin was auto-installed
69    4: the plugin was manually disconnected (but is still installed)
70
71jetpack_active_modules (array)
72    Array of active module slugs.
73
74jetpack_do_activate (bool)
75    Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
76*/
77
78require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
79
80/**
81 * The Jetpack class.
82 */
83class Jetpack {
84    /**
85     * Marks a Jetpack plugin whose Backup dashboard follows the site's plan, not the backup module.
86     *
87     * @since 16.4
88     *
89     * @var bool
90     */
91    const BACKUP_FOLLOWS_PLAN = true;
92
93    /**
94     * XMLRPC server instance.
95     *
96     * @var null|Jetpack_XMLRPC_Server XMLRPC server used by Jetpack.
97     */
98    public $xmlrpc_server = null;
99
100    /**
101     * Contains all assets that have had their URL rewritten to minified versions.
102     *
103     * @var array
104     */
105    public static $min_assets = array();
106
107    /**
108     * Plugins to deactivate.
109     *
110     * @var array Plugins to deactivate by module.
111     */
112    public $plugins_to_deactivate = array(
113        'contact-form'        => array(
114            array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
115            array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
116        ),
117        'gravatar-hovercards' => array(
118            array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
119        ),
120        'latex'               => array(
121            array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
122        ),
123        'random-redirect'     => array(
124            array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
125        ),
126        'sharedaddy'          => array(
127            array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
128            array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
129        ),
130        'shortlinks'          => array(
131            array( 'stats/stats.php', 'WordPress.com Stats' ),
132        ),
133        'stats'               => array(
134            array( 'stats/stats.php', 'WordPress.com Stats' ),
135        ),
136        'twitter-widget'      => array(
137            array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
138        ),
139        'videopress'          => array(
140            array( 'video/video.php', 'VideoPress' ),
141        ),
142        'widget-visibility'   => array(
143            array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
144            array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
145        ),
146    );
147
148    /**
149     * Map of roles we care about, and their corresponding minimum capabilities.
150     *
151     * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
152     *
153     * @access public
154     * @static
155     *
156     * @var array
157     */
158    public static $capability_translations = array(
159        'administrator' => 'manage_options',
160        'editor'        => 'edit_others_posts',
161        'author'        => 'publish_posts',
162        'contributor'   => 'edit_posts',
163        'subscriber'    => 'read',
164    );
165
166    /**
167     * Map of modules that have conflicts with plugins and should not be auto-activated
168     * if the plugins are active.  Used by filter_default_modules
169     *
170     * Plugin Authors: If you'd like to prevent a single module from auto-activating,
171     * change `module-slug` and add this to your plugin:
172     *
173     * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
174     * function my_jetpack_get_default_modules( $modules ) {
175     *     return array_diff( $modules, array( 'module-slug' ) );
176     * }
177     *
178     * @var array
179     */
180    private $conflicting_plugins = array(
181        'comments'           => array(
182            'Intense Debate'                 => 'intensedebate/intensedebate.php',
183            'Disqus'                         => 'disqus-comment-system/disqus.php',
184            'Livefyre'                       => 'livefyre-comments/livefyre.php',
185            'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
186            'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
187            'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
188        ),
189        'comment-likes'      => array(
190            'Epoch' => 'epoch/plugincore.php',
191        ),
192        'latex'              => array(
193            'LaTeX for WordPress'     => 'latex/latex.php',
194            'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
195            'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
196            'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
197            'Enable Latex'            => 'enable-latex/enable-latex.php',
198            'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
199        ),
200        'protect'            => array(
201            'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
202            'Captcha'                           => 'captcha/captcha.php',
203            'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
204            'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
205            'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
206            'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
207            'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
208            'Security-protection'               => 'security-protection/security-protection.php',
209            'Login Security'                    => 'login-security/login-security.php',
210            'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
211            'Wordfence Security'                => 'wordfence/wordfence.php',
212            'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
213            'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
214        ),
215        'random-redirect'    => array(
216            'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
217        ),
218        'related-posts'      => array(
219            'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
220            'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
221            'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
222            'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
223            'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
224            'outbrain'                    => 'outbrain/outbrain.php',
225            'Shareaholic'                 => 'shareaholic/shareaholic.php',
226            'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
227        ),
228        'sharedaddy'         => array(
229            'AddThis'     => 'addthis/addthis_social_widget.php',
230            'Add To Any'  => 'add-to-any/add-to-any.php',
231            'ShareThis'   => 'share-this/sharethis.php',
232            'Shareaholic' => 'shareaholic/shareaholic.php',
233        ),
234        'seo-tools'          => array(
235            'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
236            'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
237            'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
238            'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
239            'The SEO Framework'              => 'autodescription/autodescription.php',
240            'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
241            'Slim SEO'                       => 'slim-seo/slim-seo.php',
242            'SEOKEY'                         => 'seo-key/seo-key.php',
243            'SEOKEY Pro'                     => 'seo-key-pro/seo-key.php',
244            'SEOPress'                       => 'wp-seopress/seopress.php',
245            'SEOPress Pro'                   => 'wp-seopress-pro/seopress-pro.php',
246        ),
247        'verification-tools' => array(
248            'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
249            'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
250            'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
251            'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
252            'The SEO Framework'              => 'autodescription/autodescription.php',
253            'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
254            'Slim SEO'                       => 'slim-seo/slim-seo.php',
255        ),
256        'widget-visibility'  => array(
257            'Widget Logic'    => 'widget-logic/widget_logic.php',
258            'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
259        ),
260        'sitemaps'           => array(
261            'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
262            'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
263            'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
264            'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
265            'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
266            'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
267            'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
268            'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
269            'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
270            'The SEO Framework'                    => 'autodescription/autodescription.php',
271            'Sitemap'                              => 'sitemap/sitemap.php',
272            'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
273            'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
274            'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
275            'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
276            'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
277            'Slim SEO'                             => 'slim-seo/slim-seo.php',
278        ),
279    );
280
281    /**
282     * Plugins for which we turn off our Facebook OG Tags implementation.
283     *
284     * Note: the following plugins automatically deactivate Jetpack's Open
285     * Graph tags via filter when their Social Meta modules are active:
286     *
287     * - All in One SEO Pack, All in one SEO Pack Pro
288     * - WordPress SEO by Yoast, WordPress SEO Premium by Yoast
289     *
290     * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
291     * add_filter( 'jetpack_enable_open_graph', '__return_false' );
292     *
293     * @var array Array of plugin slugs.
294     */
295    private $open_graph_conflicting_plugins = array(
296        '2-click-socialmedia-buttons/2-click-socialmedia-buttons.php', // 2 Click Social Media Buttons.
297        'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook.
298        'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags.
299        'complete-open-graph/complete-open-graph.php',           // Complete Open Graph.
300        'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail.
301        'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php', // Open Graph Meta Tags by Heateor.
302        'facebook/facebook.php',                                 // Facebook (official plugin).
303        'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one.
304        'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php', // Facebook Featured Image & OG Meta Tags.
305        'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags.
306        'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php', // Facebook Open Graph Meta Tags for WordPress.
307        'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag.
308        'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer.
309        'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php', // Fedmich's Facebook Open Graph Meta.
310        'network-publisher/networkpub.php',                      // Network Publisher.
311        'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG.
312        'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php', // NextScripts SNAP.
313        'og-tags/og-tags.php',                                   // OG Tags.
314        'opengraph/opengraph.php',                               // Open Graph.
315        'open-graph-protocol-framework/open-graph-protocol-framework.php', // Open Graph Protocol Framework.
316        'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments.
317        'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate.
318        'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic.
319        'shareaholic/sexy-bookmarks.php',                        // Shareaholic.
320        'sharepress/sharepress.php',                             // SharePress.
321        'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect.
322        'social-discussions/social-discussions.php',             // Social Discussions.
323        'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit.
324        'socialize/socialize.php',                               // Socialize.
325        'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLYâ„¢.
326        'only-tweet-like-share-and-google-1/tweet-like-plusone.php', // Tweet, Like, Google +1 and Share.
327        'wordbooker/wordbooker.php',                             // Wordbooker.
328        'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization.
329        'wp-caregiver/wp-caregiver.php',                         // WP Caregiver.
330        'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php', // WP Facebook Like Send & Open Graph Meta.
331        'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol.
332        'wp-ogp/wp-ogp.php',                                     // WP-OGP.
333        'wp-seopress/seopress.php',                              // SEOPress.
334        'wp-seopress-pro/seopress-pro.php',                      // SEOPress Pro.
335        'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin.
336        'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button.
337        'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox.
338        'seo-by-rank-math/rank-math.php',                        // Rank Math.
339        'slim-seo/slim-seo.php',                                 // Slim SEO.
340    );
341
342    /**
343     * Plugins for which we turn off our Twitter Cards Tags implementation.
344     *
345     * @var array Plugins that conflict with Twitter cards.
346     */
347    private $twitter_cards_conflicting_plugins = array(
348        // phpcs:ignore Squiz.PHP.CommentedOutCode.Found
349        // 'twitter/twitter.php',                       // The official one handles this on its own.
350        // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
351            'eewee-twitter-card/index.php',              // Eewee Twitter Card.
352        'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards.
353        'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards.
354        'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',  // Pure Web Brilliant's Social Graph Twitter Cards Extension.
355        'twitter-cards/twitter-cards.php',           // Twitter Cards.
356        'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta.
357        'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter.
358        'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards.
359        'seo-by-rank-math/rank-math.php',            // Rank Math.
360        'slim-seo/slim-seo.php',                     // Slim SEO.
361    );
362
363    /**
364     * Message to display in admin_notice
365     *
366     * @var string
367     */
368    public $message = '';
369
370    /**
371     * Error to display in admin_notice
372     *
373     * @var string
374     */
375    public $error = '';
376
377    /**
378     * Modules that need more privacy description.
379     *
380     * @var string
381     */
382    public $privacy_checks = '';
383
384    /**
385     * Stats to record once the page loads
386     *
387     * @var array
388     */
389    public $stats = array();
390
391    /**
392     * Jetpack_Sync object
393     *
394     * @todo This is also seemingly unused.
395     *
396     * @var object
397     */
398    public $sync;
399
400    /**
401     * Verified data for JSON authorization request
402     *
403     * @deprecated 13.4
404     *
405     * @var array
406     */
407    public $json_api_authorization_request = array();
408
409    /**
410     * Connection manager.
411     *
412     * @var Automattic\Jetpack\Connection\Manager
413     */
414    protected $connection_manager;
415
416    /**
417     * Plugin lock key.
418     *
419     * @var string Transient key used to prevent multiple simultaneous plugin upgrades
420     */
421    public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
422
423    /**
424     * Holds an instance of Automattic\Jetpack\A8c_Mc_Stats
425     *
426     * @var Automattic\Jetpack\A8c_Mc_Stats
427     */
428    public $a8c_mc_stats_instance;
429
430    /**
431     * Constant for login redirect key.
432     *
433     * @var string
434     * @since 8.4.0
435     */
436    public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
437
438    /**
439     * Holds the singleton instance of this class
440     *
441     * @since 2.3.3
442     * @var Jetpack
443     */
444    public static $instance = false;
445
446    /**
447     * Resolved answer for `is_premium_analytics_enabled()`, or null before the first call.
448     *
449     * @since 16.1
450     * @var bool|null
451     */
452    private static $premium_analytics_enabled = null;
453
454    /**
455     * Singleton
456     *
457     * @static
458     */
459    public static function init() {
460        if ( ! self::$instance ) {
461            self::$instance = new Jetpack();
462            add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
463            add_action( 'jetpack_idc_disconnect', array( __CLASS__, 'on_idc_disconnect' ) );
464        }
465
466        return self::$instance;
467    }
468
469    /**
470     * Must never be called statically
471     */
472    public function plugin_upgrade() {
473        if ( self::is_connection_ready() ) {
474            list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
475            if ( JETPACK__VERSION !== $version ) {
476                // Prevent multiple upgrades at once - only a single process should trigger an upgrade to avoid stampedes.
477                if ( wp_using_ext_object_cache() ) {
478                    if ( true !== wp_cache_add( self::$plugin_upgrade_lock_key, 1, 'transient', 10 ) ) {
479                        return;
480                    }
481                } else {
482                    if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
483                        return;
484                    }
485
486                    set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
487                }
488
489                // check which active modules actually exist and remove others from active_modules list.
490                $unfiltered_modules = self::get_active_modules();
491                $modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
492                if ( array_diff( $unfiltered_modules, $modules ) ) {
493                    self::update_active_modules( $modules );
494                }
495
496                self::register_upgrade_init_hooks();
497
498                // Upgrade to 4.3.0.
499                if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
500                    Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
501                }
502
503                // Make sure Markdown for posts gets turned back on.
504                if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
505                    update_option( 'wpcom_publish_posts_with_markdown', true );
506                }
507
508                /*
509                 * Minileven deprecation. 8.3.0.
510                 * Only delete options if not using
511                 * the replacement standalone Minileven plugin.
512                 */
513                if (
514                    ! self::is_plugin_active( 'minileven-master/minileven.php' )
515                    && ! self::is_plugin_active( 'minileven/minileven.php' )
516                ) {
517                    if ( get_option( 'wp_mobile_custom_css' ) ) {
518                        delete_option( 'wp_mobile_custom_css' );
519                    }
520                    if ( get_option( 'wp_mobile_excerpt' ) ) {
521                        delete_option( 'wp_mobile_excerpt' );
522                    }
523                    if ( get_option( 'wp_mobile_featured_images' ) ) {
524                        delete_option( 'wp_mobile_featured_images' );
525                    }
526                    if ( get_option( 'wp_mobile_app_promos' ) ) {
527                        delete_option( 'wp_mobile_app_promos' );
528                    }
529                }
530
531                // Upgrade to 8.4.0.
532                if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
533                    Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
534                }
535
536                // Update to 8.8.x (WordPress 5.5 Compatibility).
537                if ( Jetpack_Options::get_option( 'autoupdate_plugins' ) ) {
538                    $updated = update_site_option(
539                        'auto_update_plugins',
540                        array_unique(
541                            array_merge(
542                                (array) Jetpack_Options::get_option( 'autoupdate_plugins', array() ),
543                                (array) get_site_option( 'auto_update_plugins', array() )
544                            )
545                        )
546                    );
547
548                    if ( $updated ) {
549                        Jetpack_Options::delete_option( 'autoupdate_plugins' );
550                    } // Should we have some type of fallback if something fails here?
551                }
552
553                // Set the newsletter send default option for existing sites.
554                if ( false === get_option( 'wpcom_newsletter_send_default' ) ) {
555                    add_option( 'wpcom_newsletter_send_default', 1 );
556                }
557
558                // Its handler went with the Recommendations assistant.
559                wp_clear_scheduled_hook( 'jetpack_recommend_videopress' );
560
561                if ( did_action( 'wp_loaded' ) ) {
562                    self::upgrade_on_load();
563                } else {
564                    add_action(
565                        'wp_loaded',
566                        array( __CLASS__, 'upgrade_on_load' )
567                    );
568                }
569            }
570        }
571    }
572
573    /**
574     * Runs upgrade routines that need to have modules loaded.
575     */
576    public static function upgrade_on_load() {
577
578        // Not attempting any upgrades if jetpack_modules_loaded did not fire.
579        // This can happen in case Jetpack has been just upgraded and is
580        // being initialized late during the page load. In this case we wait
581        // until the next proper admin page load with Jetpack active.
582        if ( ! did_action( 'jetpack_modules_loaded' ) ) {
583            delete_transient( self::$plugin_upgrade_lock_key );
584
585            return;
586        }
587
588        self::maybe_set_version_option();
589
590        if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
591            Jetpack_Widget_Conditions::migrate_post_type_rules();
592        }
593
594        if (
595            class_exists( 'Jetpack_Sitemap_Manager' )
596        ) {
597            do_action( 'jetpack_sitemaps_purge_data' );
598        }
599
600        // Delete old stats cache.
601        delete_option( 'jetpack_restapi_stats_cache' );
602
603        delete_transient( self::$plugin_upgrade_lock_key );
604    }
605
606    /**
607     * Saves all the currently active modules to options.
608     * Also fires Action hooks for each newly activated and deactivated module.
609     *
610     * @param array $modules Array of active modules to be saved in options.
611     *
612     * @return bool $success true for success, false for failure.
613     */
614    public static function update_active_modules( $modules ) {
615        return ( new Modules() )->update_active( $modules );
616    }
617
618    /**
619     * Remove all active modules.
620     *
621     * @return void
622     */
623    public static function delete_active_modules() {
624        self::update_active_modules( array() );
625    }
626
627    /**
628     * Adds a hook to plugins_loaded at a priority that's currently the earliest
629     * available.
630     */
631    public function add_configure_hook() {
632        global $wp_filter;
633
634        $current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
635        if ( false !== $current_priority ) {
636            remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
637        }
638
639        $taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
640        sort( $taken_priorities );
641
642        $first_priority = array_shift( $taken_priorities );
643
644        if ( $first_priority <= PHP_INT_MIN ) {
645            $new_priority = PHP_INT_MIN;
646        } else {
647            $new_priority = $first_priority - 1;
648        }
649
650        add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
651    }
652
653    /**
654     * Constructor.  Initializes WordPress hooks
655     */
656    private function __construct() {
657        /*
658         * Check for and alert any deprecated hooks
659         */
660        add_action( 'init', array( $this, 'deprecated_hooks' ) );
661
662        // Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
663        add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
664        add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
665        add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
666        add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
667
668        /**
669         * Prepare Gutenberg Editor functionality
670         *
671         * The hooks previously here have been moved to modules/blocks.php but leaving this here pending
672         * a longer investigation to see if code is expecting the Gutenberg class to always be available.
673         */
674        require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
675        \Automattic\Jetpack\Plugin\Unavailable_Blocks::init();
676        add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
677
678        add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
679
680        add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
681        add_action( 'login_init', array( $this, 'login_init' ) );
682
683        // Set up the REST authentication hooks.
684        Connection_Rest_Authentication::init();
685
686        // Register Jetpack-specific connection tests (sync health, etc.) with the connection
687        // package's health test suite. This runs on all requests (not just admin), because
688        // the connection/test REST endpoint can be called outside admin context.
689        add_action( 'jetpack_connection_tests_loaded', array( $this, 'register_jetpack_connection_tests' ) );
690
691        add_action( 'admin_init', array( $this, 'admin_init' ) );
692        add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
693
694        add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
695
696        // Filter the dashboard meta box order to swap the new one in in place of the old one.
697        add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
698
699        // WordPress dashboard widget.
700        require_once JETPACK__PLUGIN_DIR . 'class-jetpack-stats-dashboard-widget.php';
701        add_action( 'wp_dashboard_setup', array( new Jetpack_Stats_Dashboard_Widget(), 'init' ) );
702
703        // Returns HTTPS support status.
704        add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
705
706        add_action( 'wp_loaded', array( $this, 'register_assets' ) );
707
708        /**
709         * These actions run checks to load additional files.
710         * They check for external files or plugins, so they need to run as late as possible.
711         */
712        add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
713        add_action( 'web_stories_story_head', array( $this, 'check_open_graph' ), 1 );
714        add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
715        add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
716
717        add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
718        add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
719
720        add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
721
722        add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
723        add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
724
725        add_action(
726            'plugins_loaded',
727            function () {
728                if ( User_Agent_Info::is_mobile_app() ) {
729                    add_filter( 'get_edit_post_link', '__return_empty_string' );
730                }
731            }
732        );
733
734        // Update the site's Jetpack plan and products from API on heartbeats.
735        add_action( 'jetpack_heartbeat', array( Jetpack_Plan::class, 'refresh_from_wpcom' ) );
736
737        // The Connection package fetches the site record for `jetpack/v4/site`; reuse it to refresh the plan.
738        add_action( 'jetpack_site_data_fetched', array( Jetpack_Plan::class, 'update_from_site_record' ) );
739
740        // Actually push the stats on shutdown.
741        if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
742            add_action( 'shutdown', array( $this, 'push_stats' ) );
743        }
744
745        // After a successful connection.
746        add_action( 'jetpack_site_registered', array( $this, 'activate_default_modules_on_site_register' ) );
747        add_action( 'jetpack_site_registered', array( $this, 'handle_unique_registrations_stats' ) );
748        add_action( 'jetpack_site_registered', array( Reader_Link::class, 'activate_on_connection' ), 9 );
749        add_action( 'jetpack_site_registered', array( \Automattic\Jetpack\Reprint_Export\Reprint_Exporter::class, 'discard_credentials' ) );
750
751        // Actions for Manager::authorize().
752        add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
753        add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
754        add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
755
756        Jetpack_Client_Server::init();
757        add_action( 'jetpack_client_authorize_error', array( Jetpack_Client_Server::class, 'client_authorize_error' ) );
758        add_filter( 'jetpack_client_authorize_already_authorized_url', array( Jetpack_Client_Server::class, 'client_authorize_already_authorized_url' ) );
759        add_action( 'jetpack_client_authorize_processing', array( Jetpack_Client_Server::class, 'client_authorize_processing' ) );
760        add_filter( 'jetpack_client_authorize_fallback_url', array( Jetpack_Client_Server::class, 'client_authorize_fallback_url' ) );
761
762        // Filters for the Manager::get_token() urls and request body.
763        add_filter( 'jetpack_token_redirect_url', array( Authorize_Redirect::class, 'filter_connect_redirect_url' ) );
764        add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
765
766        // Filter for the `jetpack/v4/connection/data` API response.
767        add_filter( 'jetpack_current_user_connection_data', array( __CLASS__, 'filter_jetpack_current_user_connection_data' ) );
768
769        // Actions for successful reconnect.
770        add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
771
772        // Actions for successful disconnect.
773        add_action( 'jetpack_site_disconnected', array( $this, 'jetpack_site_disconnected' ) );
774
775        // Actions for licensing.
776        Licensing::instance()->initialize();
777
778        // Filters for Sync Callables.
779        add_filter( 'jetpack_sync_callable_whitelist', array( $this, 'filter_sync_callable_whitelist' ), 10, 1 );
780        add_filter( 'jetpack_sync_multisite_callable_whitelist', array( $this, 'filter_sync_multisite_callable_whitelist' ), 10, 1 );
781
782        // Make resources use static domain when possible.
783        add_filter( 'jetpack_static_url', array( 'Automattic\\Jetpack\\Assets', 'staticize_subdomain' ) );
784
785        // Validate the domain names in Jetpack development versions.
786        add_action( 'jetpack_pre_register', array( static::class, 'registration_check_domains' ) );
787
788        // Register product descriptions for partner coupon usage.
789        add_filter( 'jetpack_partner_coupon_products', array( $this, 'get_partner_coupon_product_descriptions' ) );
790
791        // Add 5-star
792        add_filter( 'plugin_row_meta', array( $this, 'add_5_star_review_link' ), 10, 2 );
793        add_action( 'init', array( Deprecate::class, 'instance' ) );
794
795        // Register Jetpack module management abilities (WordPress Abilities API, WP 6.9+).
796        \Automattic\Jetpack\Plugin\Abilities\Modules_Abilities::init();
797
798        // Register Connection abilities (WordPress Abilities API, WP 6.9+). Scoped to the
799        // Jetpack plugin for now: the Connection package no longer auto-wires these, so
800        // connection-only consumers (Boost, Protect, Search, etc.) do not register them yet.
801        \Automattic\Jetpack\Connection\Abilities\Connection_Abilities::init();
802    }
803
804    /**
805     * Whether the current request should eagerly initialize the admin/REST-only
806     * packages (the Import package and My Jetpack) now, at `plugins_loaded` time.
807     *
808     * Returns true for admin, cron, POST, and WP-CLI requests â€” the contexts,
809     * knowable this early, where those packages have work to do. Returns false
810     * for a plain front-end GET *and* for a REST request: the two can't be told
811     * apart yet (this runs before `rest_api_init`), so callers defer the REST
812     * case by initializing the package on `rest_api_init` instead, while a plain
813     * page view never fires that hook and so loads nothing. This keeps
814     * admin/REST-only PHP out of opcache on the front-end GET hot path.
815     *
816     * No in-repo code depends on the deferral. The one externally observable
817     * change is timing: the packages' documented init hooks
818     * (`jetpack_import_initialized`, `jetpack_feature_import_enabled`, and
819     * `my_jetpack_init`) no longer fire on a plain front-end GET â€” they fire on
820     * the admin, cron, POST, WP-CLI, and REST requests where the packages load.
821     *
822     * @return bool
823     */
824    private static function should_eager_load_packages() {
825        $is_post_request = isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' === strtoupper( sanitize_text_field( wp_unslash( $_SERVER['REQUEST_METHOD'] ) ) );
826        $is_wp_cli       = Constants::is_true( 'WP_CLI' );
827
828        return is_admin() || wp_doing_cron() || $is_post_request || $is_wp_cli;
829    }
830
831    /**
832     * Configure the Import package from a deferred hook.
833     *
834     * The eager path uses Config::ensure( 'import' ), but the deferred REST path
835     * runs after Config::on_plugins_loaded() has already processed its feature
836     * flags, so it needs a hookable bootstrap callback. Preserve Config's
837     * feature-enabled action for hook consumers.
838     *
839     * @since 16.0
840     *
841     * @return void
842     */
843    public static function configure_import_package() {
844        if ( class_exists( Import_Main::class ) ) {
845            Import_Main::configure();
846
847            if ( ! did_action( 'jetpack_feature_import_enabled' ) ) {
848                do_action( 'jetpack_feature_import_enabled' );
849            }
850        }
851    }
852
853    /**
854     * What switching a module off leaves unchanged, for interfaces that still offer it; empty when nothing.
855     *
856     * @since 16.4
857     *
858     * @param string $module Module slug.
859     * @return string
860     */
861    public static function get_module_deactivation_note( $module ) {
862        return 'backup' === $module
863            ? __( 'Backups are controlled by your site’s plan.', 'jetpack' )
864            : '';
865    }
866
867    /**
868     * Whether to offer the bundled Backup dashboard; Backup::offers_jetpack_dashboard() decides.
869     *
870     * @return bool
871     */
872    private static function offers_backup_dashboard() {
873        $product = 'Automattic\\Jetpack\\My_Jetpack\\Products\\Backup';
874
875        if ( method_exists( $product, 'offers_jetpack_dashboard' ) ) {
876            return $product::offers_jetpack_dashboard();
877        }
878
879        // Another plugin may have loaded an older My Jetpack without it: the same gates, on the current plan only.
880        if ( is_multisite() || ! self::is_connection_ready() || ! self::connection()->has_connected_owner() || ! Jetpack_Plan::supports( 'backups' ) ) {
881            return false;
882        }
883
884        /**
885         * Filters whether the Jetpack plugin offers its bundled Backup dashboard.
886         *
887         * Resolved at the earliest `plugins_loaded` priority, so hook it from a mu-plugin.
888         *
889         * @since 16.3
890         *
891         * @param bool $enabled Whether to initialize the bundled Backup dashboard. Default true.
892         */
893        return (bool) apply_filters( 'jetpack_backup_dashboard_enabled', true );
894    }
895
896    /**
897     * Enable the bundled Backup dashboard.
898     *
899     * The standalone plugin initializes the package first, so with both active this is a no-op.
900     *
901     * @return void
902     */
903    public static function configure_backup_package() {
904        if ( ! self::offers_backup_dashboard() ) {
905            return;
906        }
907
908        $backup = 'Automattic\\Jetpack\\Backup\\V0005\\Jetpack_Backup';
909
910        // An older package would take over the connection (see Jetpack_Backup::DEFAULT_INIT_OPTIONS);
911        // only the standalone plugin ships one that old, and it draws its own menu.
912        if ( ! class_exists( $backup ) || ! defined( $backup . '::DEFAULT_INIT_OPTIONS' ) ) {
913            return;
914        }
915
916        $backup::initialize( array( 'manage_connection' => false ) );
917    }
918
919    /**
920     * Whether the bundled Stats v2 dashboard is enabled.
921     *
922     * Resolves `Enablement::is_enabled()` once per request (WOOA7S-1595). The classic Stats menu
923     * stays beside Stats v2 until `jetpack-stats-classic-page-retired` retires it.
924     *
925     * The package has to be loadable for this to be true, so a site with the
926     * flag on but a missing package answers false here and never adds the
927     * Stats v2 menu (a warning is logged instead).
928     *
929     * @since 16.1
930     *
931     * @return bool
932     */
933    public static function is_premium_analytics_enabled() {
934        if ( null !== self::$premium_analytics_enabled ) {
935            return self::$premium_analytics_enabled;
936        }
937
938        // The fallback covers an older package, loaded ahead of ours, that predates the shared rule and the retirement flag.
939        $enablement = 'Automattic\Jetpack\PremiumAnalytics\Enablement';
940        if ( method_exists( $enablement, 'is_enabled' ) ) {
941            $flag = $enablement::is_enabled();
942        } elseif ( ! self::is_module_active( 'stats' ) ) {
943            $flag = false;
944        } else {
945            /** This filter is documented in projects/packages/premium-analytics/src/class-enablement.php */
946            $flag = (bool) apply_filters(
947                'jetpack_premium_analytics_enabled',
948                (bool) get_option( 'jetpack_premium_analytics_enabled' )
949            );
950        }
951
952        self::$premium_analytics_enabled = $flag && class_exists( 'Automattic\Jetpack\PremiumAnalytics\Analytics' );
953
954        if ( $flag && ! self::$premium_analytics_enabled ) {
955            wp_trigger_error(
956                __METHOD__,
957                'The jetpack_premium_analytics_enabled flag is on but the Premium Analytics package is not loadable; keeping the Stats UI in place.'
958            );
959        }
960
961        return self::$premium_analytics_enabled;
962    }
963
964    /**
965     * Expose the setting that turns the Premium Analytics dashboard on and off.
966     *
967     * Deliberately not behind is_premium_analytics_enabled(): this is the setting that flips that
968     * check, so it has to answer while the dashboard is still off.
969     *
970     * @since 16.2
971     *
972     * @return void
973     */
974    public static function register_premium_analytics_enablement_setting() {
975        if ( class_exists( 'Automattic\Jetpack\PremiumAnalytics\Enablement_Setting' ) ) {
976            \Automattic\Jetpack\PremiumAnalytics\Enablement_Setting::register();
977        }
978    }
979
980    /**
981     * Before everything else starts getting initalized, we need to initialize Jetpack using the
982     * Config object.
983     */
984    public function configure() {
985        $config = new Config();
986
987        foreach (
988            array(
989                'jitm',
990                'sync',
991                'account_protection',
992                'waf',
993            )
994            as $feature
995        ) {
996            $config->ensure( $feature );
997        }
998
999        // Enable the VideoPress admin UI (the "Jetpack > VideoPress" dashboard) inside the
1000        // Jetpack plugin, mirroring the standalone Jetpack VideoPress plugin. The dashboard
1001        // only renders when the VideoPress module is active (Status::is_active()); when it
1002        // is not, the menu item links to the My Jetpack interstitial to activate it.
1003        $config->ensure( 'videopress', array( 'admin_ui' => true ) );
1004
1005        // The Backup dashboard is only an admin menu and REST routes, so it is deferred like Import below.
1006        if ( self::should_eager_load_packages() ) {
1007            self::configure_backup_package();
1008        } else {
1009            add_action( 'rest_api_init', array( __CLASS__, 'configure_backup_package' ), 0 );
1010        }
1011
1012        /*
1013         * The Import package only registers `jetpack/v4/import` REST routes â€” it
1014         * does nothing when rendering a front-end page â€” so gate its `ensure()`
1015         * to keep its PHP out of opcache on the front-end GET hot path. It still
1016         * loads on admin, cron, POST, and WP-CLI requests, and on `rest_api_init`
1017         * for REST: a REST request can't be identified yet at `plugins_loaded`
1018         * (this runs before `Config::on_plugins_loaded`, and `rest_api_init`
1019         * fires later), so it is initialized directly when that hook fires, while
1020         * a plain page view never fires it and so loads nothing.
1021         *
1022         * JITM stays eager (above): unlike Import, its `register()` adds a
1023         * `jetpack_sync_before_send_updated_option` filter that records the
1024         * `jetpack_last_plugin_sync` transient, and a Jetpack Sync send can fire
1025         * on a plain front-end GET â€” including the dedicated-sync `spawn-sync`
1026         * GET, which runs on `init` and exits before `rest_api_init`. Deferring
1027         * JITM would skip that bookkeeping and leave its message cache stale after
1028         * a plugin change, so it loads on every request as before.
1029         */
1030        if ( self::should_eager_load_packages() ) {
1031            $config->ensure( 'import' );
1032        } else {
1033            add_action(
1034                'rest_api_init',
1035                array( __CLASS__, 'configure_import_package' ),
1036                0
1037            );
1038        }
1039
1040        /*
1041         * The Stats and Stats Admin packages only do work when the Stats module
1042         * is active (the front-end tracking pixel) or on wp-admin, REST, cron,
1043         * POST, and WP-CLI requests: the Stats dashboard page, the stats /
1044         * stats-app REST endpoints (which the block editor also calls for
1045         * email-open rates), the transient-cleanup cron, the connection
1046         * package's package-version tracker (which runs on POSTs and reads the
1047         * `jetpack_package_versions` filter that Stats registers), and CLI
1048         * introspection such as the heartbeat inspector. On a plain front-end
1049         * GET page view with the module off they are inert: the pixel
1050         * short-circuits on `Stats\Main::should_track()` and every other entry
1051         * point only hooks rest_api_init, admin, cron, the POST-only tracker, or
1052         * is reached through WP-CLI.
1053         * Skip loading them â€” and eagerly constructing the Stats Admin REST
1054         * controller â€” on that hot path to keep their PHP out of opcache, but
1055         * keep loading them everywhere else exactly as before so the stats REST
1056         * permission mapping (view_stats, registered by Stats\Main), the
1057         * editor's stats-app calls, the cleanup cron, and the package-version
1058         * tracker are all unchanged.
1059         *
1060         * REST requests are not yet identifiable here (REST_REQUEST is defined
1061         * after plugins_loaded), so defer those to rest_api_init. Call the
1062         * package initializers directly rather than `$config->ensure()`: ensure()
1063         * only flags a feature for `Config::on_plugins_loaded()` (plugins_loaded
1064         * priority 2), which has already run by the time rest_api_init fires.
1065         * Priority 0 runs before each package's own priority-10 route
1066         * registration, so their routes still register within the same dispatch.
1067         * A plain page view never fires rest_api_init, so the packages stay
1068         * unloaded there. See JETPACK-1747.
1069         */
1070        $is_post_request = isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' === $_SERVER['REQUEST_METHOD'];
1071        $is_wp_cli       = defined( 'WP_CLI' ) && WP_CLI;
1072
1073        if ( self::is_module_active( 'stats' ) || is_admin() || wp_doing_cron() || $is_post_request || $is_wp_cli ) {
1074            $config->ensure( 'stats' );
1075            $config->ensure( 'stats_admin' );
1076        } else {
1077            add_action(
1078                'rest_api_init',
1079                static function () {
1080                    if ( class_exists( 'Automattic\Jetpack\Stats\Main' ) ) {
1081                        \Automattic\Jetpack\Stats\Main::init();
1082                    }
1083                    if ( class_exists( 'Automattic\Jetpack\Stats_Admin\Main' ) ) {
1084                        \Automattic\Jetpack\Stats_Admin\Main::init();
1085                    }
1086                },
1087                0
1088            );
1089        }
1090
1091        // Stats v2 (WOOA7S-1595). Unlike Stats above it cannot be deferred when enabled â€” see
1092        // Analytics::init() for why.
1093        if ( self::is_premium_analytics_enabled() ) {
1094            \Automattic\Jetpack\PremiumAnalytics\Analytics::init();
1095            if ( class_exists( 'Automattic\Jetpack\WooCommerceStats\Analytics_Dashboard' ) ) {
1096                \Automattic\Jetpack\WooCommerceStats\Analytics_Dashboard::init();
1097            }
1098        }
1099
1100        // Outside the check above on purpose â€” see Enablement_Setting. Deferred like Stats, to keep
1101        // the autoload off the front-end hot path.
1102        add_action( 'rest_api_init', array( __CLASS__, 'register_premium_analytics_enablement_setting' ), 0 );
1103
1104        $config->ensure(
1105            'connection',
1106            array(
1107                'slug' => 'jetpack',
1108                'name' => 'Jetpack',
1109            )
1110        );
1111
1112        // Identity crisis package.
1113        $config->ensure(
1114            'identity_crisis',
1115            array(
1116                'slug'       => 'jetpack',
1117                'admin_page' => '/wp-admin/admin.php?page=jetpack',
1118            )
1119        );
1120
1121        $config->ensure( 'search' );
1122
1123        if ( ! $this->connection_manager ) {
1124            $this->connection_manager = new Connection_Manager( 'jetpack' );
1125        }
1126
1127        $modules = new Automattic\Jetpack\Modules();
1128        if ( $modules->is_active( 'publicize' ) && $this->connection_manager->has_connected_user() ) {
1129            $config->ensure( 'publicize' );
1130        }
1131
1132        add_action( 'jetpack_initialize_tracking', array( $this, 'initialize_tracking' ) );
1133
1134        /*
1135         * Load things that should only be in Network Admin.
1136         *
1137         * For now blow away everything else until a more full
1138         * understanding of what is needed at the network level is
1139         * available
1140         */
1141        if ( is_multisite() ) {
1142            $network = Jetpack_Network::init();
1143            $network->set_connection( $this->connection_manager );
1144        }
1145
1146        $is_connection_ready = self::is_connection_ready();
1147
1148        if ( $is_connection_ready ) {
1149            add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
1150            $this->run_initialize_tracking_action();
1151
1152            Jetpack_Heartbeat::init();
1153            if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
1154                require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
1155                Jetpack_Search_Performance_Logger::init();
1156            }
1157        } else {
1158            add_action( 'jetpack_agreed_to_terms_of_service', array( $this, 'run_initialize_tracking_action' ) );
1159            add_action( 'rest_api_init', array( $this, 'run_initialize_tracking_action' ) );
1160            add_filter(
1161                'xmlrpc_methods',
1162                function ( $methods ) {
1163                    $this->run_initialize_tracking_action();
1164                    return $methods;
1165                },
1166                1
1167            );
1168        }
1169
1170        // Initialize remote file upload request handlers.
1171        $this->add_remote_request_handlers();
1172
1173        /*
1174         * Enable enhanced handling of previewing sites in Calypso
1175         */
1176        if ( $is_connection_ready ) {
1177            require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
1178            add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
1179            add_action( 'rest_api_init', array( $this, 'maybe_initialize_rest_jsonapi' ) );
1180        }
1181    }
1182
1183    /**
1184     * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
1185     * initialization code.
1186     *
1187     * @action plugins_loaded
1188     */
1189    public function late_initialization() {
1190        add_action( 'after_setup_theme', array( 'Jetpack', 'load_modules' ), -2 );
1191
1192        /*
1193         * My Jetpack is a wp-admin dashboard. Its Initializer::init() only wires
1194         * up admin-menu, admin_init, and rest_api_init surfaces â€” and eagerly
1195         * loads every product class (backup, boost, protect, â€¦) just to register
1196         * admin plugin-action links â€” so none of it is needed on a plain
1197         * front-end GET page view. (The pieces that do immediate work, e.g.
1198         * Connection REST authentication and Licensing, are already initialized
1199         * unconditionally in Jetpack's constructor, so they are unaffected here.)
1200         *
1201         * Gate the call to the request types where My Jetpack actually does work.
1202         * REST can't be detected yet at plugins_loaded, so initialize on
1203         * rest_api_init for that branch; a plain page view never fires it, so My
1204         * Jetpack stays unloaded there.
1205         */
1206        if ( self::should_eager_load_packages() ) {
1207            My_Jetpack_Initializer::init();
1208        } else {
1209            add_action( 'rest_api_init', array( My_Jetpack_Initializer::class, 'init' ), 0 );
1210        }
1211
1212        Scan_Page_Init::initialize();
1213        Jetpack_SEO_Initializer::init();
1214
1215        if ( ( new Modules() )->is_active( 'podcast' ) ) {
1216            Podcast::init();
1217        } else {
1218            add_action(
1219                'jetpack_register_gutenberg_extensions',
1220                static function () {
1221                    Jetpack_Gutenberg::set_extension_unavailable( 'podcast-episode', 'missing_module', array( 'module' => 'podcast' ) );
1222                }
1223            );
1224        }
1225
1226        /*
1227         * Initialize Boost Speed Score. It only does work on REST requests (the
1228         * dashboard speed-score endpoints) and on a few Jetpack Boost lifecycle
1229         * actions, so defer constructing it â€” and loading the boost-speed-score
1230         * package classes â€” until one of those hooks actually fires instead of on
1231         * every request. Priority 0 ensures the object's own callbacks (added in
1232         * its constructor at the default priority) still run for the firing hook.
1233         */
1234        $initialize_speed_score = static function () {
1235            static $initialized = false;
1236            if ( $initialized ) {
1237                return;
1238            }
1239            $initialized = true;
1240            new Speed_Score( array(), 'jetpack-dashboard' );
1241        };
1242        add_action( 'rest_api_init', $initialize_speed_score, 0 );
1243        add_action( 'jetpack_boost_deactivate', $initialize_speed_score, 0 );
1244        add_action( 'jetpack_boost_environment_changed', $initialize_speed_score, 0 );
1245        add_action( 'handle_environment_change', $initialize_speed_score, 0 );
1246
1247        /**
1248         * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
1249         * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
1250         *
1251         * @since 8.1.0
1252         *
1253         * @param Jetpack $jetpack the main plugin class object.
1254         */
1255        do_action( 'jetpack_loaded', $this );
1256
1257        add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 2 );
1258    }
1259
1260    /**
1261     * This is ported over from the manage module, which has been deprecated and baked in here.
1262     */
1263    public function add_wpcom_to_allowed_redirect_hosts() {
1264        add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
1265    }
1266
1267    /**
1268     * Return $domains, with 'wordpress.com' appended.
1269     * This is ported over from the manage module, which has been deprecated and baked in here.
1270     *
1271     * @param array $domains Array of domains allowed for redirect.
1272     *
1273     * @return array
1274     */
1275    public function allow_wpcom_domain( $domains ) {
1276        if ( empty( $domains ) ) {
1277            $domains = array();
1278        }
1279        $domains[] = 'wordpress.com';
1280        return array_unique( $domains );
1281    }
1282
1283    /**
1284     * Redirect edit post links to Calypso.
1285     *
1286     * @deprecated since 13.9
1287     *
1288     * @param string $default_url Post edit URL.
1289     * @param int    $post_id Post ID.
1290     *
1291     * @return string
1292     */
1293    public function point_edit_post_links_to_calypso( $default_url, $post_id ) {
1294        _deprecated_function( __METHOD__, '13.9' );
1295
1296        $post = get_post( $post_id );
1297
1298        if ( empty( $post ) ) {
1299            return $default_url;
1300        }
1301
1302        $post_type = $post->post_type;
1303
1304        // Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
1305        // https://en.support.wordpress.com/custom-post-types/.
1306        $allowed_post_types = array(
1307            'post',
1308            'page',
1309            'jetpack-portfolio',
1310            'jetpack-testimonial',
1311        );
1312
1313        if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
1314            return $default_url;
1315        }
1316
1317        return Redirect::get_url(
1318            'calypso-edit-' . $post_type,
1319            array(
1320                'path' => $post_id,
1321            )
1322        );
1323    }
1324
1325    /**
1326     * Redirect edit comment links to Calypso.
1327     *
1328     * @deprecated since 13.9
1329     *
1330     * @param string $url Comment edit URL.
1331     *
1332     * @return string
1333     */
1334    public function point_edit_comment_links_to_calypso( $url ) {
1335        _deprecated_function( __METHOD__, '13.9' );
1336
1337        // Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
1338        $query_args = null;
1339        wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
1340
1341        return Redirect::get_url(
1342            'calypso-edit-comment',
1343            array(
1344                'path' => $query_args['amp;c'],
1345            )
1346        );
1347    }
1348
1349    /**
1350     * Extend Sync callables with Jetpack Plugin functions.
1351     *
1352     * @param array $callables list of callables.
1353     *
1354     * @return array list of callables.
1355     */
1356    public function filter_sync_callable_whitelist( $callables ) {
1357        // Jetpack Functions.
1358        $jetpack_callables = array(
1359            'single_user_site'         => array( 'Jetpack', 'is_single_user_site' ),
1360            'updates'                  => array( 'Jetpack', 'get_updates' ),
1361            'available_jetpack_blocks' => array( 'Jetpack_Gutenberg', 'get_availability' ), // Includes both Gutenberg blocks *and* plugins.
1362            'theme_styles'             => array( 'Automattic\\Jetpack\\Plugin\\Theme_Styles_Sync', 'get_theme_styles' ),
1363        );
1364        return array_merge( $callables, $jetpack_callables );
1365    }
1366
1367    /**
1368     * Extend Sync multisite callables with Jetpack Plugin functions.
1369     *
1370     * @param array $callables list of callables.
1371     *
1372     * @return array list of callables.
1373     */
1374    public function filter_sync_multisite_callable_whitelist( $callables ) {
1375
1376        // Jetpack Funtions.
1377        $jetpack_multisite_callables = array(
1378            'network_name'                        => array( 'Jetpack', 'network_name' ),
1379            'network_allow_new_registrations'     => array( 'Jetpack', 'network_allow_new_registrations' ),
1380            'network_add_new_users'               => array( 'Jetpack', 'network_add_new_users' ),
1381            'network_site_upload_space'           => array( 'Jetpack', 'network_site_upload_space' ),
1382            'network_upload_file_types'           => array( 'Jetpack', 'network_upload_file_types' ),
1383            'network_enable_administration_menus' => array( 'Jetpack', 'network_enable_administration_menus' ),
1384        );
1385        $callables                   = array_merge( $callables, $jetpack_multisite_callables );
1386
1387        return $callables;
1388    }
1389
1390    /**
1391     * If there are any stats that need to be pushed, but haven't been, push them now.
1392     */
1393    public function push_stats() {
1394        if ( ! empty( $this->stats ) ) {
1395            $this->do_stats( 'server_side' );
1396        }
1397    }
1398
1399    /**
1400     * Sets the Jetpack custom capabilities.
1401     *
1402     * @param string[] $caps    Array of the user's capabilities.
1403     * @param string   $cap     Capability name.
1404     */
1405    public function jetpack_custom_caps( $caps, $cap ) {
1406        switch ( $cap ) {
1407            case 'jetpack_manage_autoupdates':
1408                $caps = array(
1409                    'manage_options',
1410                    'update_plugins',
1411                );
1412                break;
1413            case 'jetpack_network_admin_page':
1414            case 'jetpack_network_settings_page':
1415                $caps = array( 'manage_network_plugins' );
1416                break;
1417            case 'jetpack_network_sites_page':
1418                $caps = array( 'manage_sites' );
1419                break;
1420            case 'jetpack_admin_page':
1421                $is_offline_mode = ( new Status() )->is_offline_mode();
1422                if ( $is_offline_mode ) {
1423                    $caps = array( 'manage_options' );
1424                    break;
1425                } else {
1426                    $caps = array( 'edit_posts' );
1427                }
1428                break;
1429        }
1430        return $caps;
1431    }
1432
1433    /**
1434     * Register assets for use in various modules and the Jetpack admin page.
1435     *
1436     * @uses wp_script_is, wp_register_script, plugins_url
1437     * @action wp_loaded
1438     * @return void
1439     */
1440    public function register_assets() {
1441        if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1442            wp_register_script(
1443                'jetpack-gallery-settings',
1444                Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1445                array( 'media-views' ),
1446                '20121225',
1447                true
1448            );
1449        }
1450
1451        if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1452            wp_register_script(
1453                'jetpack-twitter-timeline',
1454                Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1455                array(),
1456                '4.0.0',
1457                true
1458            );
1459        }
1460
1461        if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1462            wp_register_script(
1463                'jetpack-facebook-embed',
1464                Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1465                array(),
1466                JETPACK__VERSION,
1467                true
1468            );
1469
1470            /** This filter is documented in modules/sharedaddy/sharing-sources.php */
1471            $fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1472            if ( ! is_numeric( $fb_app_id ) ) {
1473                $fb_app_id = '';
1474            }
1475            wp_localize_script(
1476                'jetpack-facebook-embed',
1477                'jpfbembed',
1478                array(
1479                    'appid'  => $fb_app_id,
1480                    'locale' => $this->get_locale(),
1481                )
1482            );
1483        }
1484
1485        /**
1486         * As jetpack_register_genericons is by default fired off a hook,
1487         * the hook may have already fired by this point.
1488         * So, let's just trigger it manually.
1489         */
1490        require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1491        jetpack_register_genericons();
1492
1493        /**
1494         * Register the social logos
1495         */
1496        require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1497        jetpack_register_social_logos();
1498    }
1499
1500    /**
1501     * Guess locale from language code.
1502     *
1503     * @param string $lang Language code.
1504     * @return string|bool
1505     */
1506    public function guess_locale_from_lang( $lang ) {
1507        if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1508            return 'en_US';
1509        }
1510
1511        if ( ! class_exists( 'GP_Locales' ) ) {
1512            if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1513                return false;
1514            }
1515
1516            require JETPACK__GLOTPRESS_LOCALES_PATH;
1517        }
1518
1519        if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1520            // WP.com: get_locale() returns 'it'.
1521            $locale = GP_Locales::by_slug( $lang );
1522        } else {
1523            // Jetpack: get_locale() returns 'it_IT';.
1524            $locale = GP_Locales::by_field( 'facebook_locale', $lang );
1525        }
1526
1527        if ( ! $locale ) {
1528            return false;
1529        }
1530
1531        if ( empty( $locale->facebook_locale ) ) {
1532            if ( empty( $locale->wp_locale ) ) {
1533                return false;
1534            } else {
1535                // Facebook SDK is smart enough to fall back to en_US if a
1536                // locale isn't supported. Since supported Facebook locales
1537                // can fall out of sync, we'll attempt to use the known
1538                // wp_locale value and rely on said fallback.
1539                return $locale->wp_locale;
1540            }
1541        }
1542
1543        return $locale->facebook_locale;
1544    }
1545
1546    /**
1547     * Get the locale.
1548     *
1549     * @return string|bool
1550     */
1551    public function get_locale() {
1552        $locale = $this->guess_locale_from_lang( get_locale() );
1553
1554        if ( ! $locale ) {
1555            $locale = 'en_US';
1556        }
1557
1558        return $locale;
1559    }
1560
1561    /**
1562     * Return the network_site_url so that .com knows what network this site is a part of.
1563     *
1564     * @return string
1565     */
1566    public function jetpack_main_network_site_option() {
1567        return network_site_url();
1568    }
1569    /**
1570     * Network Name.
1571     */
1572    public static function network_name() {
1573        global $current_site;
1574        return $current_site->site_name;
1575    }
1576    /**
1577     * Does the network allow new user and site registrations.
1578     *
1579     * @return string
1580     */
1581    public static function network_allow_new_registrations() {
1582        return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ), true ) ? get_site_option( 'registration' ) : 'none' );
1583    }
1584    /**
1585     * Does the network allow admins to add new users.
1586     *
1587     * @return bool
1588     */
1589    public static function network_add_new_users() {
1590        return (bool) get_site_option( 'add_new_users' );
1591    }
1592    /**
1593     * File upload psace left per site in MB.
1594     *  -1 means NO LIMIT.
1595     *
1596     * @return int
1597     */
1598    public static function network_site_upload_space() {
1599        // value in MB.
1600        return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1601    }
1602
1603    /**
1604     * Network allowed file types.
1605     *
1606     * @return string
1607     */
1608    public static function network_upload_file_types() {
1609        return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1610    }
1611
1612    /**
1613     * Maximum file upload size set by the network.
1614     *
1615     * @return int
1616     */
1617    public static function network_max_upload_file_size() {
1618        // value in KB.
1619        return get_site_option( 'fileupload_maxk', 300 );
1620    }
1621
1622    /**
1623     * Lets us know if a site allows admins to manage the network.
1624     *
1625     * @return array
1626     */
1627    public static function network_enable_administration_menus() {
1628        return get_site_option( 'menu_items' );
1629    }
1630
1631    /**
1632     * If a user has been promoted to or demoted from admin, we need to clear the
1633     * jetpack_other_linked_admins transient.
1634     *
1635     * @since 4.3.2
1636     * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1637     *
1638     * @param int    $user_id   The user ID whose role changed.
1639     * @param string $role      The new role.
1640     * @param array  $old_roles An array of the user's previous roles.
1641     */
1642    public function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1643        if ( 'administrator' === $role
1644            || ( is_array( $old_roles ) && in_array( 'administrator', $old_roles, true ) )
1645            || $old_roles === null
1646        ) {
1647            delete_transient( 'jetpack_other_linked_admins' );
1648        }
1649    }
1650
1651    /**
1652     * Checks to see if there are any other users available to become primary
1653     * Users must both:
1654     * - Be linked to wpcom
1655     * - Be an admin
1656     *
1657     * @return mixed False if no other users are linked, Int if there are.
1658     */
1659    public static function get_other_linked_admins() {
1660        $other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1661
1662        if ( false === $other_linked_users ) {
1663            $admins = get_users( array( 'role' => 'administrator' ) );
1664            if ( count( $admins ) > 1 ) {
1665                $available = array();
1666                foreach ( $admins as $admin ) {
1667                    if ( self::connection()->is_user_connected( $admin->ID ) ) {
1668                        $available[] = $admin->ID;
1669                    }
1670                }
1671
1672                $count_connected_admins = count( $available );
1673                if ( count( $available ) > 1 ) {
1674                    $other_linked_users = $count_connected_admins;
1675                } else {
1676                    $other_linked_users = 0;
1677                }
1678            } else {
1679                $other_linked_users = 0;
1680            }
1681
1682            set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1683        }
1684
1685        return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1686    }
1687
1688    /**
1689     * Return whether we are dealing with a multi network setup or not.
1690     * The reason we are type casting this is because we want to avoid the situation where
1691     * the result is false since when is_main_network_option return false it cases
1692     * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1693     * database which could be set to anything as opposed to what this function returns.
1694     *
1695     * @return boolean
1696     */
1697    public function is_main_network_option() {
1698        // returns either an '1' or an empty string.
1699        return (string) (bool) self::is_multi_network();
1700    }
1701
1702    /**
1703     * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1704     *
1705     * @return string
1706     */
1707    public function is_multisite() {
1708        return (string) (bool) is_multisite();
1709    }
1710
1711    /**
1712     * Implemented since there is no core is multi network function
1713     * Right now there is no way to tell if we which network is the dominant network on the system
1714     *
1715     * @since  3.3
1716     * @return boolean
1717     */
1718    public static function is_multi_network() {
1719        global  $wpdb;
1720
1721        // if we don't have a multi site setup no need to do any more.
1722        if ( ! is_multisite() ) {
1723            return false;
1724        }
1725
1726        $num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1727        if ( $num_sites > 1 ) {
1728            return true;
1729        } else {
1730            return false;
1731        }
1732    }
1733
1734    /**
1735     * Get back if the current site is single user site.
1736     *
1737     * @return bool
1738     */
1739    public static function is_single_user_site() {
1740        global $wpdb;
1741
1742        $some_users = get_transient( 'jetpack_is_single_user' );
1743        if ( false === $some_users ) {
1744            $some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1745            set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1746        }
1747        return 1 === (int) $some_users;
1748    }
1749
1750    /**
1751     * Returns true if the site has file write access false otherwise.
1752     *
1753     * @return string ( '1' | '0' )
1754     **/
1755    public static function file_system_write_access() {
1756        if ( ! function_exists( 'get_filesystem_method' ) ) {
1757            require_once ABSPATH . 'wp-admin/includes/file.php';
1758        }
1759
1760        require_once ABSPATH . 'wp-admin/includes/template.php';
1761
1762        $filesystem_method = get_filesystem_method();
1763        if ( 'direct' === $filesystem_method ) {
1764            return 1;
1765        }
1766
1767        ob_start();
1768        $filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1769        ob_end_clean();
1770        if ( $filesystem_credentials_are_stored ) {
1771            return 1;
1772        }
1773        return 0;
1774    }
1775
1776    // phpcs:disable WordPress.WP.CapitalPDangit.MisspelledInComment
1777    /**
1778     * Gets updates and stores in jetpack_updates.
1779     *
1780     * The jetpack_updates option is saved in the following schema:
1781     *
1782     * array (
1783     *      'plugins'                       => (int) Number of plugin updates available.
1784     *      'themes'                        => (int) Number of theme updates available.
1785     *      'wordpress'                     => (int) Number of WordPress core updates available.
1786     *      'translations'                  => (int) Number of translation updates available.
1787     *      'total'                         => (int) Total of all available updates.
1788     *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1789     * )
1790     *
1791     * @return array
1792     */
1793    public static function get_updates() {
1794        $updates     = array();
1795        $update_data = wp_get_update_data();
1796
1797        // Stores the individual update counts as well as the total count.
1798        if ( isset( $update_data['counts'] ) ) {
1799            $updates = $update_data['counts'];
1800        }
1801
1802        // If we need to update WordPress core, let's find the latest version number.
1803        if ( ! empty( $updates['wordpress'] ) ) {
1804            $cur = get_preferred_from_update_core();
1805            if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1806                $updates['wp_update_version'] = $cur->current;
1807            }
1808        }
1809        return $updates;
1810    }
1811    // phpcs:enable WordPress.WP.CapitalPDangit.MisspelledInComment
1812
1813    /**
1814     * Get update details for core, plugins, and themes.
1815     *
1816     * @return array
1817     */
1818    public static function get_update_details() {
1819        $update_details = array(
1820            'update_core'    => get_site_transient( 'update_core' ),
1821            'update_plugins' => get_site_transient( 'update_plugins' ),
1822            'update_themes'  => get_site_transient( 'update_themes' ),
1823        );
1824        return $update_details;
1825    }
1826
1827    /**
1828     * Is Jetpack active?
1829     * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1830     *
1831     * This method is deprecated since 9.6.0. Please use one of the methods provided by the Manager class in the Connection package,
1832     * or Jetpack::is_connection_ready if you want to know when the Jetpack plugin starts considering the connection ready to be used.
1833     *
1834     * Since this method has a wide spread use, we decided not to throw any deprecation warnings for now.
1835     *
1836     * @deprecated 9.6.0
1837     *
1838     * @return bool
1839     */
1840    public static function is_active() {
1841        return self::connection()->has_connected_owner();
1842    }
1843
1844    /**
1845     * Returns true if the current site is connected to WordPress.com and has the minimum requirements to enable Jetpack UI
1846     *
1847     * This method was introduced just before the release of the possibility to use Jetpack without a user connection, while
1848     * it was available only when no_user_testing_mode was enabled. In the near future, this will return is_connected for all
1849     * users and this option will be available by default for everybody.
1850     *
1851     * @since 9.6.0
1852     * @since 9.7.0 returns is_connected in all cases and adds filter to the returned value
1853     *
1854     * @return bool is the site connection ready to be used?
1855     */
1856    public static function is_connection_ready() {
1857        /**
1858         * Allows filtering whether the connection is ready to be used. If true, this will enable the Jetpack UI and modules
1859         *
1860         * Modules will be enabled depending on the connection status and if the module requires a connection or user connection.
1861         *
1862         * @since 9.7.0
1863         *
1864         * @param bool                                  $is_connection_ready Is the connection ready?
1865         * @param Automattic\Jetpack\Connection\Manager $connection_manager Instance of the Manager class, can be used to check the connection status.
1866         */
1867        return apply_filters( 'jetpack_is_connection_ready', self::connection()->is_connected(), self::connection() );
1868    }
1869
1870    /**
1871     * Determines reason for Jetpack offline mode.
1872     */
1873    public static function development_mode_trigger_text() {
1874        $status = new Status();
1875
1876        if ( ! $status->is_offline_mode() ) {
1877            return __( 'Jetpack is not in Offline Mode.', 'jetpack' );
1878        }
1879
1880        if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1881            $notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1882        } elseif ( defined( 'WP_LOCAL_DEV' ) && WP_LOCAL_DEV ) {
1883            $notice = __( 'The WP_LOCAL_DEV constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1884        } elseif ( $status->is_local_site() ) {
1885            $notice = __( 'The site URL is a known local development environment URL (e.g. http://localhost).', 'jetpack' );
1886        } elseif ( get_option( 'jetpack_offline_mode' ) ) {
1887            $notice = __( 'The jetpack_offline_mode option is set to true.', 'jetpack' );
1888        } else {
1889            $notice = __( 'The jetpack_offline_mode filter is set to true.', 'jetpack' );
1890        }
1891
1892        return $notice;
1893    }
1894    /**
1895     * Get Jetpack offline mode notice text and notice class.
1896     *
1897     * Mirrors the checks made in Automattic\Jetpack\Status->is_offline_mode
1898     */
1899    public static function show_development_mode_notice() {
1900        if ( ( new Status() )->is_offline_mode() ) {
1901            $notice = sprintf(
1902                /* translators: %s is a URL */
1903                __( 'In <a href="%s" target="_blank">Offline Mode</a>:', 'jetpack' ),
1904                esc_url( Redirect::get_url( 'jetpack-support-development-mode' ) )
1905            );
1906
1907            $notice .= ' ' . self::development_mode_trigger_text();
1908
1909            echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- All provided text.
1910        }
1911
1912        // Throw up a notice if using a development version and as for feedback.
1913        if ( self::is_development_version() ) {
1914            /* translators: %s is a URL */
1915            $notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), esc_url( Redirect::get_url( 'jetpack-contact-support-beta-group' ) ) );
1916
1917            echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>'; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- All provided text.
1918        }
1919    }
1920
1921    /**
1922     * Whether Jetpack's version maps to a public release, or a development version.
1923     */
1924    public static function is_development_version() {
1925        /**
1926         * Allows filtering whether this is a development version of Jetpack.
1927         *
1928         * This filter is especially useful for tests.
1929         *
1930         * @since 4.3.0
1931         *
1932         * @param bool $development_version Is this a develoment version of Jetpack?
1933         */
1934        return (bool) apply_filters(
1935            'jetpack_development_version',
1936            ! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1937        );
1938    }
1939
1940    /**
1941     * Get the wpcom email of the current|specified connected user.
1942     *
1943     * @param null|int $user_id User ID or will use get_current_user_id if null.
1944     */
1945    public static function get_connected_user_email( $user_id = null ) {
1946        if ( ! $user_id ) {
1947            $user_id = get_current_user_id();
1948        }
1949
1950        $xml = new Jetpack_IXR_Client(
1951            array(
1952                'user_id' => $user_id,
1953            )
1954        );
1955        $xml->query( 'wpcom.getUserEmail' );
1956        if ( ! $xml->isError() ) {
1957            return $xml->getResponse();
1958        }
1959        return false;
1960    }
1961
1962    /**
1963     * Get the wpcom email of the master user.
1964     */
1965    public static function get_master_user_email() {
1966        $master_user_id = Jetpack_Options::get_option( 'master_user' );
1967        if ( $master_user_id ) {
1968            return self::get_connected_user_email( $master_user_id );
1969        }
1970        return '';
1971    }
1972
1973    /**
1974     * Gets current user IP address.
1975     *
1976     * @param  bool $check_all_headers Check all headers? Default is `false`.
1977     *
1978     * @deprecated Jetpack 10.6
1979     *
1980     * @return string                  Current user IP address.
1981     */
1982    public static function current_user_ip( $check_all_headers = false ) {
1983        _deprecated_function( __METHOD__, 'jetpack-10.6', 'Automattic\\Jetpack\\Status\\Visitor::get_ip' );
1984
1985        return ( new Visitor() )->get_ip( $check_all_headers );
1986    }
1987
1988    /**
1989     * Loads the currently active modules.
1990     */
1991    public static function load_modules() {
1992        $status = new Status();
1993
1994        if (
1995            ! self::is_connection_ready()
1996            && ! $status->is_offline_mode()
1997            && (
1998                ! is_multisite()
1999                || ! get_site_option( 'jetpack_protect_active' )
2000            )
2001        ) {
2002            return;
2003        }
2004
2005        $version = Jetpack_Options::get_option( 'version' );
2006        if ( ! $version ) {
2007            $version     = JETPACK__VERSION . ':' . time();
2008            $old_version = $version;
2009            /** This action is documented in class.jetpack.php */
2010            do_action( 'updating_jetpack_version', $version, false );
2011            Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2012        }
2013        list( $version ) = explode( ':', $version );
2014
2015        $modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
2016
2017        $modules_data = array();
2018
2019        // Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
2020        if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
2021            $updated_modules = array();
2022            foreach ( $modules as $module ) {
2023                $modules_data[ $module ] = self::get_module( $module );
2024                if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
2025                    continue;
2026                }
2027
2028                if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
2029                    continue;
2030                }
2031
2032                $updated_modules[] = $module;
2033            }
2034
2035            $modules = array_diff( $modules, $updated_modules );
2036        }
2037
2038        $is_site_connection = false;
2039
2040        if ( method_exists( self::connection(), 'is_site_connection' ) ) {
2041            $is_site_connection = self::connection()->is_site_connection();
2042        }
2043
2044        foreach ( $modules as $index => $module ) {
2045            // If we're in offline/site-connection mode, disable modules requiring a connection/user connection.
2046            if ( $status->is_offline_mode() || $is_site_connection ) {
2047                // Prime the pump if we need to.
2048                if ( empty( $modules_data[ $module ] ) ) {
2049                    $modules_data[ $module ] = self::get_module( $module );
2050                }
2051                // If the module requires a connection, but we're in local mode, don't include it.
2052                if ( $status->is_offline_mode() && $modules_data[ $module ]['requires_connection'] ) {
2053                    continue;
2054                }
2055
2056                if ( $is_site_connection && $modules_data[ $module ]['requires_user_connection'] ) {
2057                    continue;
2058                }
2059            }
2060
2061            if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
2062                continue;
2063            }
2064
2065            if ( ! include_once self::get_module_path( $module ) ) { // phpcs:ignore WordPressVIPMinimum.Files.IncludingFile.NotAbsolutePath
2066                unset( $modules[ $index ] );
2067                self::update_active_modules( array_values( $modules ) );
2068                continue;
2069            }
2070
2071            /**
2072             * Fires when a specific module is loaded.
2073             * The dynamic part of the hook, $module, is the module slug.
2074             *
2075             * @since 1.1.0
2076             */
2077            do_action( 'jetpack_module_loaded_' . $module );
2078        }
2079
2080        /**
2081         * Fires when all the modules are loaded.
2082         *
2083         * @since 1.1.0
2084         */
2085        do_action( 'jetpack_modules_loaded' );
2086
2087        // Load module-specific code that is needed even when a module isn't active. Loaded here because code contained therein may need actions such as setup_theme.
2088        require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
2089    }
2090
2091    /**
2092     * Check if Jetpack's REST API compat file should be included
2093     *
2094     * @action plugins_loaded
2095     * @return void
2096     */
2097    public function check_rest_api_compat() {
2098        /**
2099         * Filters the list of REST API compat files to be included.
2100         *
2101         * @since 2.2.5
2102         *
2103         * @param array $args Array of REST API compat files to include.
2104         */
2105        $_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2106
2107        foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2108            require_once $_jetpack_rest_api_compat_include;
2109        }
2110    }
2111
2112    /**
2113     * Gets all plugins currently active in values, regardless of whether they're
2114     * traditionally activated or network activated.
2115     *
2116     * @todo Store the result in core's object cache maybe?
2117     */
2118    public static function get_active_plugins() {
2119        // Older Connection copies can load first and lack this method.
2120        if ( ! method_exists( Heartbeat::class, 'get_active_plugins' ) ) {
2121            return array();
2122        }
2123
2124        return Heartbeat::get_active_plugins();
2125    }
2126
2127    /**
2128     * Gets and parses additional plugin data to send with the heartbeat data
2129     *
2130     * @since 3.8.1
2131     *
2132     * @return array Array of plugin data
2133     */
2134    public static function get_parsed_plugin_data() {
2135        if ( ! function_exists( 'get_plugins' ) ) {
2136            require_once ABSPATH . 'wp-admin/includes/plugin.php';
2137        }
2138        /** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2139        $all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2140        $active_plugins = self::get_active_plugins();
2141
2142        $plugins = array();
2143        foreach ( $all_plugins as $path => $plugin_data ) {
2144            $plugins[ $path ] = array(
2145                'is_active' => in_array( $path, $active_plugins, true ),
2146                'file'      => $path,
2147                'name'      => $plugin_data['Name'],
2148                'version'   => $plugin_data['Version'],
2149                'author'    => $plugin_data['Author'],
2150            );
2151        }
2152
2153        return $plugins;
2154    }
2155
2156    /**
2157     * Gets and parses theme data to send with the heartbeat data
2158     *
2159     * @since 3.8.1
2160     *
2161     * @return array Array of theme data
2162     */
2163    public static function get_parsed_theme_data() {
2164        $all_themes  = wp_get_themes( array( 'allowed' => true ) );
2165        $header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2166
2167        $themes = array();
2168        foreach ( $all_themes as $slug => $theme_data ) {
2169            $theme_headers = array();
2170            foreach ( $header_keys as $header_key ) {
2171                $theme_headers[ $header_key ] = $theme_data->get( $header_key );
2172            }
2173
2174            $themes[ $slug ] = array(
2175                'is_active_theme' => wp_get_theme()->get_template() === $slug,
2176                'slug'            => $slug,
2177                'theme_root'      => $theme_data->get_theme_root_uri(),
2178                'parent'          => $theme_data->parent(),
2179                'headers'         => $theme_headers,
2180            );
2181        }
2182
2183        return $themes;
2184    }
2185
2186    /**
2187     * Checks whether a specific plugin is active.
2188     *
2189     * We don't want to store these in a static variable, in case
2190     * there are switch_to_blog() calls involved.
2191     *
2192     * @param string $plugin Plugin to check in 'folder/file.php` format.
2193     */
2194    public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2195        return in_array( $plugin, self::get_active_plugins(), true );
2196    }
2197
2198    /**
2199     * Check if Jetpack's Open Graph tags should be used.
2200     * If certain plugins are active, Jetpack's og tags are suppressed.
2201     *
2202     * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2203     * @action plugins_loaded
2204     * @return void
2205     */
2206    public function check_open_graph() {
2207        if ( in_array( 'publicize', self::get_active_modules(), true ) || in_array( 'sharedaddy', self::get_active_modules(), true ) ) {
2208            include_once JETPACK__PLUGIN_DIR . 'enhanced-open-graph.php';
2209            add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2210        }
2211
2212        $active_plugins = self::get_active_plugins();
2213
2214        if ( ! empty( $active_plugins ) ) {
2215            foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2216                if ( in_array( $plugin, $active_plugins, true ) ) {
2217                    add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2218                    break;
2219                }
2220            }
2221        }
2222
2223        /**
2224         * Allow the addition of Open Graph Meta Tags to all pages.
2225         *
2226         * @since 2.0.3
2227         *
2228         * @param bool false Should Open Graph Meta tags be added. Default to false.
2229         */
2230        if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2231            require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2232        }
2233    }
2234
2235    /**
2236     * Check if Jetpack's Twitter tags should be used.
2237     * If certain plugins are active, Jetpack's twitter tags are suppressed.
2238     *
2239     * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2240     * @action plugins_loaded
2241     * @return void
2242     */
2243    public function check_twitter_tags() {
2244
2245        $active_plugins = self::get_active_plugins();
2246
2247        if ( ! empty( $active_plugins ) ) {
2248            foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2249                if ( in_array( $plugin, $active_plugins, true ) ) {
2250                    add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2251                    break;
2252                }
2253            }
2254        }
2255
2256        /**
2257         * Allow Twitter Card Meta tags to be disabled.
2258         *
2259         * @since 2.6.0
2260         *
2261         * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2262         */
2263        if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2264            // @todo Remove this require once the deprecated Jetpack_Twitter_Cards wrapper has been removed.
2265            // Twitter Cards functionality now lives in the jetpack-post-media package (Automattic\Jetpack\Post_Media\Twitter_Cards).
2266            require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2267        }
2268    }
2269
2270    /* Jetpack Options API */
2271
2272    /**
2273     * Gets the option names from Jetpack_Options.
2274     *
2275     * @param string $type Jetpack option type.
2276     *
2277     * @return array
2278     */
2279    public static function get_option_names( $type = 'compact' ) {
2280        return Jetpack_Options::get_option_names( $type );
2281    }
2282
2283    /**
2284     * Returns the requested option.
2285     *
2286     * Looks in jetpack_options or jetpack_$name as appropriate.
2287     *
2288     * @param string $name    Option name.
2289     * @param mixed  $default Default value.
2290     */
2291    public static function get_option( $name, $default = false ) {
2292        return Jetpack_Options::get_option( $name, $default );
2293    }
2294
2295    /**
2296     * Returns an array of all PHP files in the specified absolute path.
2297     * Equivalent to glob( "$absolute_path/*.php" ).
2298     *
2299     * @param string $absolute_path The absolute path of the directory to search.
2300     * @return array Array of absolute paths to the PHP files.
2301     */
2302    public static function glob_php( $absolute_path ) {
2303        return ( new Files() )->glob_php( $absolute_path );
2304    }
2305
2306    /**
2307     * Activate new modules.
2308     *
2309     * @param bool $redirect Should this function redirect after activation.
2310     *
2311     * @return void
2312     */
2313    public static function activate_new_modules( $redirect = false ) {
2314        if ( ! self::is_connection_ready() && ! ( new Status() )->is_offline_mode() ) {
2315            return;
2316        }
2317
2318        $jetpack_old_version = Jetpack_Options::get_option( 'version' );
2319        if ( ! $jetpack_old_version ) {
2320            $old_version         = '1.1:' . time();
2321            $version             = $old_version;
2322            $jetpack_old_version = $version;
2323            /** This action is documented in class.jetpack.php */
2324            do_action( 'updating_jetpack_version', $version, false );
2325            Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2326        }
2327
2328        list( $jetpack_version ) = explode( ':', $jetpack_old_version );
2329
2330        if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2331            return;
2332        }
2333
2334        $active_modules     = self::get_active_modules();
2335        $reactivate_modules = array();
2336        foreach ( $active_modules as $active_module ) {
2337            $module = self::get_module( $active_module );
2338            if ( ! isset( $module['changed'] ) ) {
2339                continue;
2340            }
2341
2342            if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2343                continue;
2344            }
2345
2346            $reactivate_modules[] = $active_module;
2347            self::deactivate_module( $active_module );
2348        }
2349
2350        $new_version = JETPACK__VERSION . ':' . time();
2351        /** This action is documented in class.jetpack.php */
2352        do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2353        Jetpack_Options::update_options(
2354            array(
2355                'version'     => $new_version,
2356                'old_version' => $jetpack_old_version,
2357            )
2358        );
2359
2360        self::state( 'message', 'modules_activated' );
2361
2362        self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
2363
2364        if ( $redirect ) {
2365            $page = 'jetpack'; // make sure we redirect to either settings or the jetpack page.
2366            if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ), true ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- we're not changing the site.
2367                $page = sanitize_text_field( wp_unslash( $_GET['page'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- we're not changing the site.
2368            }
2369            wp_safe_redirect( self::admin_url( 'page=' . rawurlencode( $page ) ) );
2370            exit( 0 );
2371        }
2372    }
2373
2374    /**
2375     * List available Jetpack modules. Simply lists .php files in /modules/.
2376     * Make sure to tuck away module "library" files in a sub-directory.
2377     *
2378     * @param bool|string $min_version Only return modules introduced in this version or later. Default is false, do not filter.
2379     * @param bool|string $max_version Only return modules introduced before this version. Default is false, do not filter.
2380     * @param bool|null   $requires_connection Pass a boolean value to only return modules that require (or do not require) a connection.
2381     * @param bool|null   $requires_user_connection Pass a boolean value to only return modules that require (or do not require) a user connection.
2382     *
2383     * @return array $modules Array of module slugs
2384     */
2385    public static function get_available_modules( $min_version = false, $max_version = false, $requires_connection = null, $requires_user_connection = null ) {
2386        return ( new Modules() )->get_available( $min_version, $max_version, $requires_connection, $requires_user_connection );
2387    }
2388
2389    /**
2390     * Get default modules loaded on activation.
2391     *
2392     * @param bool|string $min_version Only return modules introduced in this version or later. Default is false, do not filter.
2393     * @param bool|string $max_version Only return modules introduced before this version. Default is false, do not filter.
2394     * @param bool|null   $requires_connection Pass a boolean value to only return modules that require (or do not require) a connection.
2395     * @param bool|null   $requires_user_connection Pass a boolean value to only return modules that require (or do not require) a user connection.
2396     *
2397     * @return array $modules Array of module slugs
2398     */
2399    public static function get_default_modules( $min_version = false, $max_version = false, $requires_connection = null, $requires_user_connection = null ) {
2400        $return = array();
2401
2402        foreach ( self::get_available_modules( $min_version, $max_version, $requires_connection, $requires_user_connection ) as $module ) {
2403            $module_data = self::get_module( $module );
2404
2405            switch ( strtolower( $module_data['auto_activate'] ) ) {
2406                case 'yes':
2407                    $return[] = $module;
2408                    break;
2409                case 'public':
2410                    if ( Jetpack_Options::get_option( 'public' ) ) {
2411                        $return[] = $module;
2412                    }
2413                    break;
2414                case 'no':
2415                default:
2416                    break;
2417            }
2418        }
2419        if ( method_exists( Feature_Policy::class, 'ensure_hooks' ) ) {
2420            Feature_Policy::ensure_hooks();
2421        }
2422
2423        /**
2424         * Filters the array of default modules.
2425         *
2426         * @since 2.5.0
2427         *
2428         * @param array $return Array of default modules.
2429         * @param string $min_version Minimum version number required to use modules.
2430         * @param string $max_version Maximum version number required to use modules.
2431         * @param bool|null $requires_connection Value of the Requires Connection filter.
2432         * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
2433         */
2434        return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version, $requires_connection, $requires_user_connection );
2435    }
2436
2437    /**
2438     * Checks activated modules during auto-activation to determine
2439     * if any of those modules are being deprecated.  If so, close
2440     * them out, and add any replacement modules.
2441     *
2442     * Runs at priority 99 by default.
2443     *
2444     * This is run late, so that it can still activate a module if
2445     * the new module is a replacement for another that the user
2446     * currently has active, even if something at the normal priority
2447     * would kibosh everything.
2448     *
2449     * @since 2.6
2450     * @uses jetpack_get_default_modules filter
2451     * @param array $modules Array of Jetpack modules.
2452     * @return array
2453     */
2454    public function handle_deprecated_modules( $modules ) {
2455        $deprecated_modules = array(
2456            'debug'                 => null,  // Closed out and moved to the debugger library.
2457            'wpcc'                  => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2458            'gplus-authorship'      => null,  // Closed out in 3.2 -- Google dropped support.
2459            'minileven'             => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2460            'lazy-images'           => null, // Closed out in 12.8 -- WordPress core now has native lazy loading.
2461            'enhanced-distribution' => null, // Closed out in 13.3 -- WP.com is winding down the firehose.
2462        );
2463
2464        // Don't activate SSO if they never completed activating WPCC.
2465        if ( self::is_module_active( 'wpcc' ) ) {
2466            $wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2467            if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2468                $deprecated_modules['wpcc'] = null;
2469            }
2470        }
2471
2472        foreach ( $deprecated_modules as $module => $replacement ) {
2473            if ( self::is_module_active( $module ) ) {
2474                self::deactivate_module( $module );
2475                if ( $replacement ) {
2476                    $modules[] = $replacement;
2477                }
2478            }
2479        }
2480
2481        return array_unique( $modules );
2482    }
2483
2484    /**
2485     * Checks activated plugins during auto-activation to determine
2486     * if any of those plugins are in the list with a corresponding module
2487     * that is not compatible with the plugin. The module will not be allowed
2488     * to auto-activate.
2489     *
2490     * @since 2.6
2491     * @uses jetpack_get_default_modules filter
2492     * @param array $modules Array of Jetpack modules.
2493     * @return array
2494     */
2495    public function filter_default_modules( $modules ) {
2496
2497        $active_plugins = self::get_active_plugins();
2498
2499        if ( ! empty( $active_plugins ) ) {
2500
2501            // For each module we'd like to auto-activate...
2502            foreach ( $modules as $key => $module ) {
2503                // If there are potential conflicts for it...
2504                if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2505                    // For each potential conflict...
2506                    foreach ( $this->conflicting_plugins[ $module ] as $plugin ) {
2507                        // If that conflicting plugin is active...
2508                        if ( in_array( $plugin, $active_plugins, true ) ) {
2509                            // Remove that item from being auto-activated.
2510                            unset( $modules[ $key ] );
2511                        }
2512                    }
2513                }
2514            }
2515        }
2516
2517        // Special case to convert block setting to a block module.
2518        $block_key = array_search( 'blocks', $modules, true );
2519        if ( $block_key !== false ) { // Only care if 'blocks' made it through the previous filters.
2520            $block_option = get_option( 'jetpack_blocks_disabled', null );
2521            if ( $block_option ) {
2522                unset( $modules[ $block_key ] );
2523            }
2524        }
2525
2526        return $modules;
2527    }
2528
2529    /**
2530     * Extract a module's slug from its full path.
2531     *
2532     * @param string $file Full path to a file.
2533     *
2534     * @return string Module slug.
2535     */
2536    public static function get_module_slug( $file ) {
2537        return ( new Modules() )->get_slug( $file );
2538    }
2539
2540    /**
2541     * Generate a module's path from its slug.
2542     *
2543     * @param string $slug Module slug.
2544     */
2545    public static function get_module_path( $slug ) {
2546        return ( new Modules() )->get_path( $slug );
2547    }
2548
2549    /**
2550     * Load module data from module file. Headers differ from WordPress
2551     * plugin headers to avoid them being identified as standalone
2552     * plugins on the WordPress plugins page.
2553     *
2554     * @param string $module The module slug.
2555     */
2556    public static function get_module( $module ) {
2557        return ( new Modules() )->get( $module );
2558    }
2559
2560    /**
2561     * Like core's get_file_data implementation, but caches the result.
2562     *
2563     * @param string $file Absolute path to the file.
2564     * @param array  $headers List of headers, in the format array( 'HeaderKey' => 'Header Name' ).
2565     */
2566    public static function get_file_data( $file, $headers ) {
2567        return ( new Modules() )->get_file_data( $file, $headers );
2568    }
2569
2570    /**
2571     * Return translated module tag.
2572     *
2573     * @param string $tag Tag as it appears in each module heading.
2574     *
2575     * @return mixed
2576     */
2577    public static function translate_module_tag( $tag ) {
2578        return jetpack_get_module_i18n_tag( $tag );
2579    }
2580
2581    /**
2582     * Return module name translation. Uses matching string created in modules/module-headings.php.
2583     *
2584     * The module list is globbed from `modules/` at runtime, so a module can be listed with no
2585     * entry in that generated file. Fall back to the untranslated header rather than overwriting
2586     * it with the null `jetpack_get_module_i18n()` returns for an unknown slug.
2587     *
2588     * @since 3.9.2
2589     *
2590     * @param array $modules Array of Jetpack modules.
2591     *
2592     * @return array
2593     */
2594    public static function get_translated_modules( $modules ) {
2595        foreach ( $modules as $index => $module ) {
2596            $i18n_module = jetpack_get_module_i18n( $module['module'] );
2597            $name        = $i18n_module['name'] ?? null;
2598            $description = $i18n_module['description'] ?? null;
2599
2600            if ( null !== $name && isset( $module['name'] ) ) {
2601                $modules[ $index ]['name'] = $name;
2602            }
2603            if ( null !== $description && isset( $module['description'] ) ) {
2604                $modules[ $index ]['description']       = $description;
2605                $modules[ $index ]['short_description'] = $description;
2606            }
2607            if ( isset( $module['module_tags'] ) ) {
2608                $modules[ $index ]['module_tags'] = array_map( 'jetpack_get_module_i18n_tag', $module['module_tags'] );
2609            }
2610        }
2611        return $modules;
2612    }
2613
2614    /**
2615     * Get a list of activated modules as an array of module slugs.
2616     */
2617    public static function get_active_modules() {
2618        return ( new Modules() )->get_active();
2619    }
2620
2621    /**
2622     * Check whether or not a Jetpack module is active.
2623     *
2624     * @param string $module The slug of a Jetpack module.
2625     * @return bool
2626     *
2627     * @static
2628     */
2629    public static function is_module_active( $module ) {
2630        return ( new Modules() )->is_active( $module );
2631    }
2632
2633    /**
2634     * Is slug a valid module.
2635     *
2636     * @param string $module Module slug.
2637     *
2638     * @return bool
2639     */
2640    public static function is_module( $module ) {
2641        return ( new Modules() )->is_module( $module );
2642    }
2643
2644    /**
2645     * Catches PHP errors.  Must be used in conjunction with output buffering.
2646     *
2647     * @deprecated since 13.5
2648     * @param bool $catch True to start catching, False to stop.
2649     *
2650     * @static
2651     * @deprecated 13.5
2652     * @see \Automattic\Jetpack\Errors
2653     */
2654    public static function catch_errors( $catch ) {
2655        _deprecated_function( __METHOD__, '13.5' );
2656        // @phan-suppress-next-line PhanDeprecatedClass
2657        return ( new Errors() )->catch_errors( $catch );
2658    }
2659
2660    /**
2661     * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2662     *
2663     * @deprecated since 13.5
2664     */
2665    public static function catch_errors_on_shutdown() {
2666        _deprecated_function( __METHOD__, '13.5' );
2667        self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2668    }
2669
2670    /**
2671     * Rewrite any string to make paths easier to read.
2672     *
2673     * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2674     * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2675     *
2676     * @param string $string String to attempt rewrite.
2677     * @return mixed
2678     */
2679    public static function alias_directories( $string ) {
2680        // ABSPATH has a trailing slash.
2681        $string = str_replace( ABSPATH, 'ABSPATH/', $string );
2682        // WP_CONTENT_DIR does not have a trailing slash.
2683        $string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2684
2685        return $string;
2686    }
2687
2688    /**
2689     * Activates default Jetpack modules.
2690     *
2691     * @param null|string $min_version Only return modules introduced in this version or later. Default is false, do not filter.
2692     * @param null|string $max_version Only return modules introduced before this version. Default is false, do not filter.
2693     * @param array       $other_modules Other modules to activate.
2694     * @param null|bool   $redirect Should there be a redirection after activation.
2695     * @param bool        $send_state_messages If a state message should be sent.
2696     * @param bool|null   $requires_connection Pass a boolean value to only return modules that require (or do not require) a connection.
2697     * @param bool|null   $requires_user_connection Pass a boolean value to only return modules that require (or do not require) a user connection.
2698     *
2699     * @return void
2700     */
2701    public static function activate_default_modules(
2702        $min_version = false,
2703        $max_version = false,
2704        $other_modules = array(),
2705        $redirect = null,
2706        $send_state_messages = null,
2707        $requires_connection = null,
2708        $requires_user_connection = null
2709    ) {
2710        $jetpack = self::init();
2711
2712        if ( $redirect === null ) {
2713            if (
2714                ( defined( 'REST_REQUEST' ) && REST_REQUEST )
2715            ||
2716                ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2717            ||
2718                ( defined( 'WP_CLI' ) && WP_CLI )
2719            ||
2720                ( defined( 'DOING_CRON' ) && DOING_CRON )
2721            ||
2722                ( defined( 'DOING_AJAX' ) && DOING_AJAX )
2723            ) {
2724                $redirect = false;
2725            } elseif ( is_admin() ) {
2726                $redirect = true;
2727            } else {
2728                $redirect = false;
2729            }
2730        }
2731
2732        if ( $send_state_messages === null ) {
2733            $send_state_messages = current_user_can( 'jetpack_activate_modules' );
2734        }
2735
2736        $modules = self::get_default_modules( $min_version, $max_version, $requires_connection, $requires_user_connection );
2737        $modules = array_merge( $other_modules, $modules );
2738
2739        // Look for standalone plugins and disable if active.
2740
2741        $to_deactivate = array();
2742        foreach ( $modules as $module ) {
2743            if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2744                $to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2745            }
2746        }
2747
2748        $deactivated = array();
2749        foreach ( $to_deactivate as $module => $deactivate_us ) {
2750            foreach ( $deactivate_us as $i => $deactivate_me ) {
2751                list( $probable_file, $probable_title ) = $deactivate_me;
2752                if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2753                    $deactivated[] = "$module:$i";
2754                }
2755            }
2756        }
2757
2758        if ( $deactivated ) {
2759            if ( $send_state_messages ) {
2760                self::state( 'deactivated_plugins', implode( ',', $deactivated ) );
2761            }
2762
2763            if ( $redirect ) {
2764                $url = add_query_arg(
2765                    array(
2766                        'action'   => 'activate_default_modules',
2767                        '_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2768                    ),
2769                    add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2770                );
2771                wp_safe_redirect( $url );
2772                exit( 0 );
2773            }
2774        }
2775
2776        /**
2777         * Fires before default modules are activated.
2778         *
2779         * @since 1.9.0
2780         *
2781         * @param string    $min_version Minimum version number required to use modules.
2782         * @param string    $max_version Maximum version number required to use modules.
2783         * @param array     $other_modules Array of other modules to activate alongside the default modules.
2784         * @param bool|null $requires_connection Value of the Requires Connection filter.
2785         * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
2786         */
2787        do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules, $requires_connection, $requires_user_connection );
2788
2789        // Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating.
2790        if ( $send_state_messages ) {
2791            self::restate();
2792        }
2793
2794        $active = self::get_active_modules();
2795
2796        foreach ( $modules as $module ) {
2797            if ( did_action( "jetpack_module_loaded_$module" ) ) {
2798                $active[] = $module;
2799                self::update_active_modules( $active );
2800                continue;
2801            }
2802
2803            if ( $send_state_messages && in_array( $module, $active, true ) ) {
2804                $module_info = self::get_module( $module );
2805                if ( ! $module_info['deactivate'] ) {
2806                    $state        = in_array( $module, $other_modules, true ) ? 'reactivated_modules' : 'activated_modules';
2807                    $active_state = self::state( $state );
2808                    if ( $active_state ) {
2809                        $active_state = explode( ',', $active_state );
2810                    } else {
2811                        $active_state = array();
2812                    }
2813                    $active_state[] = $module;
2814                    self::state( $state, implode( ',', $active_state ) );
2815                }
2816                continue;
2817            }
2818
2819            $file = self::get_module_path( $module );
2820            if ( ! file_exists( $file ) ) {
2821                continue;
2822            }
2823
2824            // we'll override this later if the plugin can be included without fatal error.
2825            if ( $redirect ) {
2826                wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2827            }
2828
2829            if ( $send_state_messages ) {
2830                self::state( 'error', 'module_activation_failed' );
2831                self::state( 'module', $module );
2832            }
2833
2834            ob_start();
2835            require_once $file;
2836
2837            $active[] = $module;
2838
2839            if ( $send_state_messages ) {
2840
2841                $state        = in_array( $module, $other_modules, true ) ? 'reactivated_modules' : 'activated_modules';
2842                $active_state = self::state( $state );
2843                if ( $active_state ) {
2844                    $active_state = explode( ',', $active_state );
2845                } else {
2846                    $active_state = array();
2847                }
2848                $active_state[] = $module;
2849                self::state( $state, implode( ',', $active_state ) );
2850            }
2851
2852            self::update_active_modules( $active );
2853
2854            ob_end_clean();
2855        }
2856
2857        if ( $send_state_messages ) {
2858            self::state( 'error', false );
2859            self::state( 'module', false );
2860        }
2861        /**
2862         * Fires when default modules are activated.
2863         *
2864         * @since 1.9.0
2865         *
2866         * @param string    $min_version Minimum version number required to use modules.
2867         * @param string    $max_version Maximum version number required to use modules.
2868         * @param array     $other_modules Array of other modules to activate alongside the default modules.
2869         * @param bool|null $requires_connection Value of the Requires Connection filter.
2870         * @param bool|null $requires_user_connection Value of the Requires User Connection filter.
2871         */
2872        do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules, $requires_connection, $requires_user_connection );
2873    }
2874
2875    /**
2876     * Activate a module.
2877     *
2878     * @param string $module Module slug.
2879     * @param bool   $exit Should exit be called after deactivation.
2880     * @param bool   $redirect Should there be a redirection after activation.
2881     *
2882     * @return bool|void
2883     */
2884    public static function activate_module( $module, $exit = true, $redirect = true ) {
2885        return ( new Modules() )->activate( $module, $exit, $redirect );
2886    }
2887
2888    /**
2889     * Deactivate module.
2890     *
2891     * @param string $module Module slug.
2892     *
2893     * @return bool
2894     */
2895    public static function deactivate_module( $module ) {
2896        return ( new Modules() )->deactivate( $module );
2897    }
2898
2899    /**
2900     * Enable a configuable module.
2901     *
2902     * @param string $module Module slug.
2903     *
2904     * @return void
2905     */
2906    public static function enable_module_configurable( $module ) {
2907        $module = self::get_module_slug( $module );
2908        add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2909    }
2910
2911    /**
2912     * Composes a module configure URL. It uses Jetpack settings search as default value
2913     * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
2914     *
2915     * @param string $module Module slug.
2916     * @return string $url module configuration URL.
2917     */
2918    public static function module_configuration_url( $module ) {
2919        $module      = self::get_module_slug( $module );
2920        $default_url = self::admin_url( array( 'page' => 'jetpack-settings' ) ) . "#/settings?term=$module";
2921        /**
2922         * Allows to modify configure_url of specific module to be able to redirect to some custom location.
2923         *
2924         * @since 6.9.0
2925         *
2926         * @param string $default_url Default url, which redirects to jetpack settings page.
2927         */
2928        $url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
2929
2930        return $url;
2931    }
2932
2933    /* Installation */
2934    /**
2935     * Bail on activation if there is an issue.
2936     *
2937     * @param string $message Error message.
2938     * @param bool   $deactivate Deactivate Jetpack or not.
2939     *
2940     * @return never
2941     */
2942    public static function bail_on_activation( $message, $deactivate = true ) {
2943        ?>
2944<!doctype html>
2945<html>
2946<head>
2947<meta charset="<?php bloginfo( 'charset' ); ?>">
2948<style>
2949* {
2950    text-align: center;
2951    margin: 0;
2952    padding: 0;
2953    font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2954}
2955p {
2956    margin-top: 1em;
2957    font-size: 18px;
2958}
2959</style>
2960<body>
2961<p><?php echo esc_html( $message ); ?></p>
2962</body>
2963</html>
2964        <?php
2965        if ( $deactivate ) {
2966            $plugins = get_option( 'active_plugins' );
2967            $jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2968            $update  = false;
2969            foreach ( $plugins as $i => $plugin ) {
2970                if ( $plugin === $jetpack ) {
2971                    $plugins[ $i ] = false;
2972                    $update        = true;
2973                }
2974            }
2975
2976            if ( $update ) {
2977                update_option( 'active_plugins', array_filter( $plugins ) );
2978            }
2979        }
2980        exit( 0 );
2981    }
2982
2983    /**
2984     * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2985     *
2986     * @param bool $network_wide Network-wide activation.
2987     */
2988    public static function plugin_activation( $network_wide ) {
2989        Jetpack_Options::update_option( 'activated', 1 );
2990
2991        if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2992            /* translators: Jetpack version number. */
2993            self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2994        }
2995
2996        if ( $network_wide ) {
2997            self::state( 'network_nag', true );
2998        }
2999
3000        // For firing one-off events (notices) immediately after activation.
3001        set_transient( 'activated_jetpack', true, 0.1 * MINUTE_IN_SECONDS );
3002
3003        update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3004
3005        Health::on_jetpack_activated();
3006
3007        \Automattic\Jetpack\Reprint_Export\Reprint_Exporter::discard_credentials();
3008
3009        if ( self::is_connection_ready() && method_exists( 'Automattic\Jetpack\Sync\Actions', 'do_only_first_initial_sync' ) ) {
3010            Sync_Actions::do_only_first_initial_sync();
3011        }
3012
3013        if ( ! defined( 'WC_ANALYTICS' ) && class_exists( 'Automattic\Woocommerce_Analytics' ) ) {
3014            Woocommerce_Analytics::maybe_add_proxy_speed_module();
3015        }
3016
3017        self::plugin_initialize();
3018    }
3019
3020    /**
3021     * Returns the activation source.
3022     *
3023     * @param string $referer_url URL.
3024     *
3025     * @return array source_type, source_query.
3026     */
3027    public static function get_activation_source( $referer_url ) {
3028        if ( defined( 'WP_CLI' ) && WP_CLI ) {
3029            return array( 'wp-cli', null );
3030        }
3031
3032        $referer = wp_parse_url( $referer_url );
3033
3034        $source_type  = 'unknown';
3035        $source_query = null;
3036
3037        if ( ! is_array( $referer ) || ! isset( $referer['path'] ) ) {
3038            return array( $source_type, $source_query );
3039        }
3040
3041        $plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3042        $plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3043
3044        if ( isset( $referer['query'] ) ) {
3045            parse_str( $referer['query'], $query_parts );
3046        } else {
3047            $query_parts = array();
3048        }
3049
3050        if ( $plugins_path === $referer['path'] ) {
3051            $source_type = 'list';
3052        } elseif ( $plugins_install_path === $referer['path'] ) {
3053            $tab = $query_parts['tab'] ?? 'featured';
3054            switch ( $tab ) {
3055                case 'popular':
3056                    $source_type = 'popular';
3057                    break;
3058                case 'recommended':
3059                    $source_type = 'recommended';
3060                    break;
3061                case 'favorites':
3062                    $source_type = 'favorites';
3063                    break;
3064                case 'search':
3065                    $source_type  = 'search-' . ( $query_parts['type'] ?? 'term' );
3066                    $source_query = $query_parts['s'] ?? null;
3067                    break;
3068                default:
3069                    $source_type = 'featured';
3070            }
3071        }
3072
3073        return array( $source_type, $source_query );
3074    }
3075
3076    /**
3077     * Runs before bumping version numbers up to a new version.
3078     *
3079     * Only ever registered the hooks for the release post update modal, which has been removed.
3080     * No longer hooked to `updating_jetpack_version`.
3081     *
3082     * @deprecated 16.2
3083     *
3084     * @param string $version     Version:timestamp.
3085     * @param string $old_version Old Version:timestamp or false if not set yet.
3086     */
3087    public static function do_version_bump( $version, $old_version ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- Signature preserved for the deprecation shim.
3088        _deprecated_function( __METHOD__, 'jetpack-16.2' );
3089    }
3090
3091    /**
3092     * Enables the Newsletter (subscriptions) module for existing sites now that it is a default-on module.
3093     *
3094     * Fresh installs receive the module via its "Auto Activate: Yes" header, so this only handles sites
3095     * upgrading from a version where the module defaulted off. It runs once per site (guarded by the
3096     * subscriptions_default_on_migrated option). Fresh installs are marked as migrated immediately so the
3097     * migration never runs for them. After it has run, the user's choice to deactivate the module again
3098     * (for example from the My Jetpack Products page) is respected and never reverted.
3099     *
3100     * The module requires a connection, so on a disconnected site the migration is deferred without setting
3101     * the guard, allowing a later version bump to retry once the site is connected.
3102     *
3103     * @param string       $version     New Jetpack version:timestamp.
3104     * @param string|false $old_version Previous Jetpack version:timestamp, or false on a fresh install.
3105     */
3106    public static function activate_subscriptions_module_for_existing_sites( $version, $old_version ) {
3107        if ( get_option( 'jetpack_subscriptions_default_on_migrated' ) ) {
3108            return;
3109        }
3110
3111        // Fresh installs get the module via its "Auto Activate: Yes" header. Mark them as migrated so a
3112        // later opt-out is never reverted by the existing-site path on a subsequent version bump.
3113        if ( ! $old_version ) {
3114            update_option( 'jetpack_subscriptions_default_on_migrated', true );
3115            return;
3116        }
3117
3118        if ( ! self::is_connection_ready() ) {
3119            return;
3120        }
3121
3122        // Mark as migrated only once the module is active, so a transient activation failure is retried on
3123        // a later version bump rather than being silently skipped.
3124        if ( self::is_module_active( 'subscriptions' ) || self::activate_module( 'subscriptions', false, false ) ) {
3125            update_option( 'jetpack_subscriptions_default_on_migrated', true );
3126        }
3127    }
3128
3129    /**
3130     * Option flag that records the AI master-switch opt-out reconciliation has run,
3131     * so it never runs twice.
3132     *
3133     * @var string
3134     */
3135    const AI_MASTER_OPTOUT_MIGRATED_OPTION = 'jetpack_ai_master_optout_migrated';
3136
3137    /**
3138     * Register the on-upgrade init hooks whose relative ORDER matters, extracted so
3139     * the ordering can be asserted in tests without invoking plugin_upgrade() (whose
3140     * guards make it unreliable to trigger under test). activate_new_modules()
3141     * (init, default priority 10) auto-activates "Auto Activate: Yes" modules
3142     * including the `ai` master; reconcile_ai_master_optout() must run at a LATER
3143     * priority to honor an explicit AI opt-out.
3144     *
3145     * @return void
3146     */
3147    public static function register_upgrade_init_hooks() {
3148        add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
3149        add_action( 'init', array( __CLASS__, 'reconcile_ai_master_optout' ), 20 );
3150    }
3151
3152    /**
3153     * Preserves an explicit Jetpack AI opt-out when the `ai` module becomes the site-wide
3154     * master switch off WordPress.com Simple (self-hosted and Atomic).
3155     *
3156     * The `ai` module is "Auto Activate: Yes", so on upgrade {@see self::activate_new_modules()}
3157     * turns it on for connected sites â€” the desired default-on / auto-enable-on-connection
3158     * behavior, which this method deliberately leaves alone. The one case it corrects is a site
3159     * that had explicitly disabled Jetpack AI (the `jetpack_ai_enabled` option present and falsey)
3160     * before the module shipped: that opt-out must survive the module becoming the master, so the
3161     * module is deactivated for exactly those sites. An absent or truthy option is left untouched.
3162     *
3163     * Ordering is the whole point. `activate_new_modules()` is hooked on `init` at priority 10 and
3164     * auto-activates the module there; this method is hooked on `init` at priority 20 (see
3165     * {@see self::plugin_upgrade()}), so it runs AFTER the auto-activation and its deactivation is
3166     * the final state. A version-guarded block that ran inline during `plugins_loaded` would be
3167     * undone by the later auto-activation, which is why this is a late-init hook rather than an
3168     * inline upgrade step.
3169     *
3170     * WordPress.com Simple never runs modules â€” the option stays the master there â€” so this is a
3171     * no-op on Simple. The {@see self::AI_MASTER_OPTOUT_MIGRATED_OPTION} flag makes it run exactly
3172     * once, which matters because off-Simple the option is no longer the master after this runs:
3173     * a stale falsey option must not keep re-deactivating a module the user later turns back on.
3174     *
3175     * @return void
3176     */
3177    public static function reconcile_ai_master_optout() {
3178        if ( get_option( self::AI_MASTER_OPTOUT_MIGRATED_OPTION ) ) {
3179            return;
3180        }
3181
3182        // Simple keeps the `jetpack_ai_enabled` option as the master; modules don't run there.
3183        if ( ( new Host() )->is_wpcom_simple() ) {
3184            return;
3185        }
3186
3187        // A sentinel default distinguishes an absent option (leave auto-activation alone) from one
3188        // explicitly stored falsey (an opt-out to preserve).
3189        $stored = get_option( 'jetpack_ai_enabled', 'not-set' );
3190        if ( 'not-set' !== $stored && ! (bool) $stored ) {
3191            ( new Modules() )->deactivate( 'ai' );
3192        }
3193
3194        update_option( self::AI_MASTER_OPTOUT_MIGRATED_OPTION, true );
3195    }
3196
3197    /**
3198     * Deletes obsolete SEO module-state options without changing module activation.
3199     *
3200     * @since 16.3
3201     */
3202    public static function cleanup_seo_module_state_options() {
3203        delete_option( 'jetpack_seo_sitemap_enabled' );
3204        delete_option( 'jetpack_seo_canonical_urls_enabled' );
3205        delete_option( 'jetpack_seo_module_state_reconciled' );
3206    }
3207
3208    /**
3209     * Seeds the Jetpack SEO discoverability cohort once, so the new SEO surface is
3210     * auto-discoverable on fresh installs but opt-in on existing ones (JETPACK-1700).
3211     *
3212     * Hooked on `updating_jetpack_version`, which fires on every install including the
3213     * first â€” with `$old_version === false` on a brand-new site (the same signal
3214     * {@see self::activate_subscriptions_module_for_existing_sites()} keys off). Fresh
3215     * installs are seeded visible; existing installs are seeded hidden and opt in later
3216     * via the legacy Traffic page or My Jetpack. Deactivation deletes the stored version,
3217     * so a reactivation before this option exists counts as fresh. `add_option()` makes
3218     * this seed-once: it never overrides a value a later opt-in (or opt-out) has set.
3219     * WordPress.com sites ignore this option entirely (always visible) â€” see
3220     * {@see \Automattic\Jetpack\SEO\Initializer::is_seo_surface_visible()}.
3221     *
3222     * @param string       $version     The new Jetpack version (unused).
3223     * @param string|false $old_version The previous version, or false on a fresh install.
3224     */
3225    public static function seed_seo_visibility_cohort( $version, $old_version ) {
3226        // Drop the superseded key (see VISIBILITY_OPTION); it plays no part in the seed.
3227        delete_option( 'jetpack_seo_surface_visible' );
3228        add_option( Jetpack_SEO_Initializer::VISIBILITY_OPTION, ! $old_version );
3229    }
3230
3231    /**
3232     * Sets the display_update_modal state.
3233     *
3234     * The release post update modal that read this state has been removed. The write is kept so the
3235     * method still behaves as documented for the deprecation window. When this is deleted, also drop
3236     * the matching `display_update_modal` guard in Automattic\Jetpack\CookieState::should_set_cookie(),
3237     * which exists only to keep this key out of the cookie on the Jetpack admin screen.
3238     *
3239     * @deprecated 16.2
3240     */
3241    public static function set_update_modal_display() {
3242        _deprecated_function( __METHOD__, 'jetpack-16.2' );
3243        self::state( 'display_update_modal', true );
3244    }
3245
3246    /**
3247     * Enqueues the block library styles.
3248     *
3249     * Only ever used by the release post update modal, which has been removed.
3250     *
3251     * @deprecated 16.2
3252     *
3253     * @param string $hook The current admin page.
3254     */
3255    public static function enqueue_block_style( $hook ) {
3256        _deprecated_function( __METHOD__, 'jetpack-16.2' );
3257        if ( 'toplevel_page_jetpack' === $hook ) {
3258            wp_enqueue_style( 'wp-block-library' );
3259        }
3260    }
3261
3262    /**
3263     * Sets the internal version number and activation state.
3264     *
3265     * @static
3266     */
3267    public static function plugin_initialize() {
3268        if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3269            Jetpack_Options::update_option( 'activated', 2 );
3270        }
3271
3272        if ( ! Jetpack_Options::get_option( 'version' ) ) {
3273            $old_version = JETPACK__VERSION . ':' . time();
3274            $version     = $old_version;
3275            /** This action is documented in class.jetpack.php */
3276            do_action( 'updating_jetpack_version', $version, false );
3277            Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3278        }
3279
3280        if ( self::is_connection_ready() ) {
3281            self::handle_default_module_activation( true );
3282        }
3283
3284        self::load_modules();
3285
3286        Jetpack_Options::delete_option( 'do_activate' );
3287    }
3288
3289    /**
3290     * Handles the activation of the default modules depending on the current state of the site:
3291     *  - If the site already has the jetpack_active_modules option, activate those.
3292     *  - If the site has a site-only connection, only activate the default modules that require only a site connection.
3293     *  - If the site has a user connection, activate the default modules that require a user connection.
3294     *
3295     * @param bool $should_activate_user_modules Whether the status of the user connection should be checked and the default modules that
3296     *                                           require a user connection activated.
3297     */
3298    private static function handle_default_module_activation( $should_activate_user_modules ) {
3299        $active_modules = Jetpack_Options::get_option( 'active_modules' );
3300        if ( $active_modules ) {
3301            self::delete_active_modules();
3302
3303            /**
3304             * Previously active modules could mean two things. First, it could mean
3305             * that Jetpack was previously active on the site. In this case we would like
3306             * to only activate the modules that were set to active.
3307             * Another case could be that the module option was set by a standalone
3308             * plugin. In that case the `active_modules_initalized` option will not
3309             * be set, so we need to enable default Jetpack modules as well.
3310             */
3311            if ( ! Jetpack_Options::get_option( 'active_modules_initialized' ) ) {
3312                $default_modules = self::get_default_modules();
3313                $active_modules  = array_merge( $active_modules, $default_modules );
3314                Jetpack_Options::update_option( 'active_modules_initialized', true );
3315            }
3316
3317            self::activate_default_modules(
3318                999, // This version trick basically excludes every default module.
3319                1,
3320                $active_modules,
3321                false
3322            );
3323        } elseif ( $should_activate_user_modules && ( new Connection_Manager() )->get_connection_owner_id() ) { // Check for a user connection.
3324            self::activate_default_modules( false, false, array(), false, null, null, null );
3325            Jetpack_Options::update_option( 'active_modules_initialized', true );
3326        } else {
3327            self::activate_default_modules( false, false, array(), false, null, null, false );
3328        }
3329    }
3330
3331    /**
3332     * Removes all connection options
3333     *
3334     * @static
3335     */
3336    public static function plugin_deactivation() {
3337        require_once ABSPATH . '/wp-admin/includes/plugin.php';
3338        $tracking = new Tracking();
3339        $tracking->record_user_event( 'deactivate_plugin', array() );
3340        if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3341            Jetpack_Network::init()->deactivate();
3342        } else {
3343            add_filter( 'jetpack_update_activated_state_on_disconnect', '__return_false' );
3344            self::disconnect();
3345            Jetpack_Options::delete_option( 'version' );
3346        }
3347
3348        if ( ! defined( 'WC_ANALYTICS' ) && class_exists( 'Automattic\Woocommerce_Analytics' ) ) {
3349            Woocommerce_Analytics::maybe_remove_proxy_speed_module();
3350        }
3351    }
3352
3353    /**
3354     * Set activated option to 4 on jetpack_idc_disconnect action.
3355     */
3356    public static function on_idc_disconnect() {
3357        \Jetpack_Options::update_option( 'activated', 4 );
3358    }
3359
3360    /**
3361     * Disconnects from the Jetpack servers.
3362     * Forgets all connection details and tells the Jetpack servers to do the same.
3363     *
3364     * Will not disconnect if there are other plugins using the connection.
3365     *
3366     * @since 11.0 Do not disconnect if other plugins are using the connection.
3367     *
3368     * @static
3369     */
3370    public static function disconnect() {
3371
3372        $connection = self::connection();
3373
3374        // If the site is in an IDC because sync is not allowed,
3375        // let's make sure to not disconnect the production site.
3376        $connection->remove_connection( ! Identity_Crisis::validate_sync_error_idc_option() );
3377    }
3378
3379    /**
3380     * Happens after a successful disconnection.
3381     *
3382     * @static
3383     */
3384    public static function jetpack_site_disconnected() {
3385        Identity_Crisis::clear_all_idc_options();
3386
3387        \Automattic\Jetpack\Reprint_Export\Reprint_Exporter::discard_credentials();
3388
3389        // Delete all the sync related data. Since it could be taking up space.
3390        Sender::get_instance()->uninstall();
3391
3392        /**
3393         * Filters whether the Jetpack activated state should be updated after disconnecting.
3394         *
3395         * @since 10.0.0
3396         *
3397         * @param bool $update_activated_state Whether activated state should be updated after disconnecting, defaults to true.
3398         */
3399        $update_activated_state = apply_filters( 'jetpack_update_activated_state_on_disconnect', true );
3400
3401        if ( $update_activated_state ) {
3402            Jetpack_Options::update_option( 'activated', 4 );
3403        }
3404    }
3405
3406    /**
3407     * Disconnects the user.
3408     *
3409     * @deprecated 13.4
3410     * @see \Automattic\Jetpack\Connection\Manager::disconnect_user()
3411     *
3412     * @param int $user_id The user ID to disconnect.
3413     */
3414    public function disconnect_user( $user_id ) {
3415        $this->connection_manager->disconnect_user( $user_id );
3416    }
3417
3418    /**
3419     * Checking the domain names in beta versions.
3420     * If this is a development version, before attempting to connect, let's make sure that the domains are viable.
3421     *
3422     * @param null|\WP_Error $error The domain validation error, or `null` if everything's fine.
3423     *
3424     * @return null|\WP_Error The domain validation error, or `null` if everything's fine.
3425     */
3426    public static function registration_check_domains( $error ) {
3427        if ( static::is_development_version() ) {
3428            $domains_to_check = array_unique(
3429                array(
3430                    'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3431                    'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3432                )
3433            );
3434            foreach ( $domains_to_check as $domain ) {
3435                $result = static::connection()->is_usable_domain( $domain );
3436                if ( is_wp_error( $result ) ) {
3437                    return $result;
3438                }
3439            }
3440        }
3441
3442        return $error;
3443    }
3444
3445    /**
3446     * Tracking an internal event log. Try not to put too much chaff in here.
3447     *
3448     * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3449     *
3450     * @param mixed $code Error code to log.
3451     * @param mixed $data Data to log.
3452     */
3453    public static function log( $code, $data = null ) {
3454
3455        $raw_log = Jetpack_Options::get_option( 'log', array() );
3456        // This can be modified by the `jetpack_options` filter, so abort if we don't have an array.
3457        if ( ! is_array( $raw_log ) ) {
3458            return;
3459        }
3460
3461        // only grab the latest 200 entries.
3462        $log = array_slice( $raw_log, -199, 199 );
3463
3464        // Append our event to the log.
3465        $log_entry = array(
3466            'time'    => time(),
3467            'user_id' => get_current_user_id(),
3468            'blog_id' => Jetpack_Options::get_option( 'id' ),
3469            'code'    => $code,
3470        );
3471        // Don't bother storing it unless we've got some.
3472        if ( $data !== null ) {
3473            $log_entry['data'] = $data;
3474        }
3475        $log[] = $log_entry;
3476
3477        // Try add_option first, to make sure it's not autoloaded.
3478        // @todo: Add an add_option method to Jetpack_Options.
3479        if ( ! add_option( 'jetpack_log', $log, '', 'no' ) ) {
3480            Jetpack_Options::update_option( 'log', $log );
3481        }
3482
3483        /**
3484         * Fires when Jetpack logs an internal event.
3485         *
3486         * @since 3.0.0
3487         *
3488         * @param array $log_entry {
3489         *  Array of details about the log entry.
3490         *
3491         *  @param string time Time of the event.
3492         *  @param int user_id ID of the user who trigerred the event.
3493         *  @param int blog_id Jetpack Blog ID.
3494         *  @param string code Unique name for the event.
3495         *  @param string data Data about the event.
3496         * }
3497         */
3498        do_action( 'jetpack_log_entry', $log_entry );
3499    }
3500
3501    /**
3502     * Get the internal event log.
3503     *
3504     * @param string $event only return the specific log events.
3505     * @param int    $num - get specific number of latest results, limited to 200.
3506     *
3507     * @return array of log events || WP_Error for invalid params
3508     */
3509    public static function get_log( $event = false, $num = false ) {
3510        if ( $event && ! is_string( $event ) ) {
3511            return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3512        }
3513
3514        if ( $num && ! is_numeric( $num ) ) {
3515            return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3516        }
3517
3518        $entire_log = Jetpack_Options::get_option( 'log', array() );
3519
3520        // If nothing set - act as it did before, otherwise let's start customizing the output.
3521        if ( ! $num && ! $event ) {
3522            return $entire_log;
3523        } else {
3524            $entire_log = array_reverse( $entire_log );
3525        }
3526
3527        $custom_log_output = array();
3528
3529        if ( $event ) {
3530            foreach ( $entire_log as $log_event ) {
3531                if ( $event === $log_event['code'] ) {
3532                    $custom_log_output[] = $log_event;
3533                }
3534            }
3535        } else {
3536            $custom_log_output = $entire_log;
3537        }
3538
3539        if ( $num ) {
3540            $custom_log_output = array_slice( $custom_log_output, 0, $num );
3541        }
3542
3543        return $custom_log_output;
3544    }
3545
3546    /**
3547     * Log modification of important settings.
3548     *
3549     * @param string $option Option name.
3550     * @param string $old_value Old value of option.
3551     * @param string $value New value of option.
3552     */
3553    public static function log_settings_change( $option, $old_value, $value ) {
3554        switch ( $option ) {
3555            case 'jetpack_sync_non_public_post_stati':
3556                self::log( $option, $value );
3557                break;
3558        }
3559    }
3560
3561    /**
3562     * Return stat data for WPCOM sync.
3563     *
3564     * The Sync stats module was this method's last caller and moved to the Connection package's
3565     * `Heartbeat::generate_stats_array()`, which assembles the heartbeat data through the
3566     * `jetpack_heartbeat_stats_array` filter. Note the package method does not include the extended
3567     * data from `get_additional_stat_data()`, so callers relying on `$extended` need to add it themselves.
3568     *
3569     * @deprecated 16.2
3570     *
3571     * @param bool $encode JSON encode the result.
3572     * @param bool $extended Adds additional stats data.
3573     *
3574     * @return array|string Stats data. Array if $encode is false. JSON-encoded string is $encode is true.
3575     */
3576    public static function get_stat_data( $encode = true, $extended = true ) {
3577        _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\\Jetpack\\Heartbeat::generate_stats_array' );
3578
3579        $env_stats = method_exists( Heartbeat::class, 'get_environment_stats' )
3580            ? Heartbeat::get_environment_stats()
3581            : array();
3582        $data      = array_merge( Jetpack_Heartbeat::generate_stats_array(), $env_stats );
3583
3584        if ( $extended ) {
3585            $additional_data = self::get_additional_stat_data();
3586            $data            = array_merge( $data, $additional_data );
3587        }
3588
3589        if ( $encode ) {
3590            return wp_json_encode( $data, JSON_UNESCAPED_SLASHES );
3591        }
3592
3593        return $data;
3594    }
3595
3596    /**
3597     * Get additional stat data to sync to WPCOM
3598     *
3599     * @param string $prefix Stats prefix.
3600     *
3601     * @return array stats values.
3602     */
3603    public static function get_additional_stat_data( $prefix = '' ) {
3604        $return                             = array();
3605        $return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
3606        $return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3607        $return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3608        $return[ "{$prefix}site-count" ]    = 0;
3609
3610        if ( function_exists( 'get_blog_count' ) ) {
3611            $return[ "{$prefix}site-count" ] = get_blog_count();
3612        }
3613        return $return;
3614    }
3615
3616    /**
3617     * Get current site's user count.
3618     *
3619     * @return int|string|null Number of users on the site. -1 for a large network.
3620     */
3621    private static function get_site_user_count() {
3622        global $wpdb;
3623
3624        if ( function_exists( 'wp_is_large_network' ) ) {
3625            if ( wp_is_large_network( 'users' ) ) {
3626                return -1; // Not a real value but should tell us that we are dealing with a large network.
3627            }
3628        }
3629        $user_count = get_transient( 'jetpack_site_user_count' );
3630        if ( false === ( $user_count ) ) {
3631            // It wasn't there, so regenerate the data and save the transient.
3632            $user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3633            set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3634        }
3635        return $user_count;
3636    }
3637
3638    /* Admin Pages */
3639
3640    /**
3641     * Admin init function.
3642     *
3643     * Runs on admin_init hook.
3644     *
3645     * @return void
3646     */
3647    public function admin_init() {
3648        // If the plugin is not connected, display a connect message.
3649        if (
3650            // the plugin was auto-activated and needs its candy.
3651            Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3652        ||
3653            // the plugin is active, but was never activated.  Probably came from a site-wide network activation.
3654            ! Jetpack_Options::get_option( 'activated' )
3655        ) {
3656            self::plugin_initialize();
3657        }
3658
3659        $is_offline_mode              = ( new Status() )->is_offline_mode();
3660        $fallback_no_verify_ssl_certs = Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' );
3661        /** Already documented in automattic/jetpack-connection::src/class-client.php */
3662        $client_verify_ssl_certs = apply_filters( 'jetpack_client_verify_ssl_certs', false );
3663
3664        // Run post-activation actions if needed.
3665        $this->plugin_post_activation();
3666
3667        if ( ( self::is_connection_ready() || $is_offline_mode ) && false === $fallback_no_verify_ssl_certs && ! $client_verify_ssl_certs ) {
3668            // Upgrade: 1.1 -> 1.1.1
3669            // Check and see if host can verify the Jetpack servers' SSL certificate.
3670            $args = array();
3671            // @phan-suppress-next-line PhanAccessMethodInternal -- Phan is correct, but the usage is intentional.
3672            Client::_wp_remote_request( self::connection()->api_url( 'test' ), $args, true );
3673        }
3674
3675        if (
3676            current_user_can( 'manage_options' )
3677            && ! self::permit_ssl()
3678            && ! $is_offline_mode
3679        ) {
3680            add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3681        }
3682
3683        add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3684        add_action( 'load-plugins.php', array( $this, 'plugins_page_init_jetpack_state' ) );
3685
3686        if ( ! ( is_multisite() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) && ! is_network_admin() ) ) {
3687            add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3688        }
3689
3690        add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3691
3692        if ( self::is_connection_ready() || $is_offline_mode ) {
3693            // Artificially throw errors in certain specific cases during plugin activation.
3694            add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3695        }
3696    }
3697
3698    /**
3699     * Adds body classes.
3700     *
3701     * @param string $admin_body_class Body classes.
3702     *
3703     * @return string
3704     */
3705    public function admin_body_class( $admin_body_class = '' ) {
3706        $classes = explode( ' ', trim( $admin_body_class ) );
3707
3708        $classes[] = self::is_connection_ready() ? 'jetpack-connected' : 'jetpack-disconnected';
3709
3710        $admin_body_class = implode( ' ', array_unique( $classes ) );
3711        return " $admin_body_class ";
3712    }
3713
3714    /**
3715     * Adds Jetpack Page styles by appending class to the admin body class.
3716     *
3717     * @param string $admin_body_class Existing admin body class string.
3718     *
3719     * @return string
3720     */
3721    public static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3722        return $admin_body_class . ' jetpack-pagestyles ';
3723    }
3724
3725    /**
3726     * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3727     * This function artificially throws errors for such cases (per a specific list).
3728     *
3729     * @param string $plugin The activated plugin.
3730     * @throws RuntimeException If a conflicting plugin is detected.
3731     */
3732    public function throw_error_on_activate_plugin( $plugin ) {
3733        $active_modules = self::get_active_modules();
3734
3735        // The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3736        if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules, true ) ) {
3737            $throw = false;
3738
3739            // Try and make sure it really was the stats plugin.
3740            if ( ! class_exists( 'ReflectionFunction' ) ) {
3741                if ( 'stats.php' === basename( $plugin ) ) {
3742                    $throw = true;
3743                }
3744            } else {
3745                // @phan-suppress-next-line PhanUndeclaredFunctionInCallable -- Checked above. See also https://github.com/phan/phan/issues/1204.
3746                $reflection = new ReflectionFunction( 'stats_get_api_key' );
3747                if ( basename( $plugin ) === basename( $reflection->getFileName() ) ) {
3748                    $throw = true;
3749                }
3750            }
3751
3752            if ( $throw ) {
3753                /* translators: Plugin name to deactivate. */
3754                throw new RuntimeException( sprintf( __( 'Jetpack contains the most recent version of the old "%1$s" plugin.', 'jetpack' ), 'WordPress.com Stats' ) );
3755            }
3756        }
3757    }
3758
3759    /**
3760     * Call to Jetpack::state on the load-plugins.php hook.
3761     * In case the jetpackState cookie is populated, this call will read and re-set the cookie before HTTP headers are sent.
3762     */
3763    public function plugins_page_init_jetpack_state() {
3764        self::state( 'message' );
3765    }
3766
3767    /**
3768     * Adds the intercept action to the check_admin_referer hook.
3769     *
3770     * @return void
3771     */
3772    public function intercept_plugin_error_scrape_init() {
3773        add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3774    }
3775
3776    /**
3777     * Detect if conflicting plugin is being deactivated.
3778     *
3779     * @param string   $action The nonce action.
3780     * @param bool|int $result False if the nonce is invalid, 1 if the nonce is valid and generated between 0-12 hours ago, 2 if the nonce is valid and generated between 12-24 hours ago.
3781     *
3782     * @return void
3783     */
3784    public function intercept_plugin_error_scrape( $action, $result ) {
3785        if ( ! $result ) {
3786            return;
3787        }
3788
3789        foreach ( $this->plugins_to_deactivate as $deactivate_us ) {
3790            foreach ( $deactivate_us as $deactivate_me ) {
3791                if ( "plugin-activation-error_{$deactivate_me[0]}" === $action ) {
3792                    /* translators: Plugin name to deactivate. */
3793                    self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3794                }
3795            }
3796        }
3797    }
3798
3799    /**
3800     * Register the remote file upload request handlers, if needed.
3801     *
3802     * @access public
3803     */
3804    public function add_remote_request_handlers() {
3805        // Remote file uploads are allowed only via AJAX requests.
3806        if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3807            return;
3808        }
3809
3810        // Remote file uploads are allowed only for a set of specific AJAX actions.
3811        $remote_request_actions = array(
3812            'jetpack_upload_file',
3813            'jetpack_update_file',
3814        );
3815
3816        // phpcs:ignore WordPress.Security.NonceVerification
3817        if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3818            return;
3819        }
3820
3821        // Require Jetpack authentication for the remote file upload AJAX requests.
3822        if ( ! $this->connection_manager ) {
3823            $this->connection_manager = new Connection_Manager();
3824        }
3825
3826        $this->connection_manager->require_jetpack_authentication();
3827
3828        // Register the remote file upload AJAX handlers.
3829        foreach ( $remote_request_actions as $action ) {
3830            add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3831        }
3832    }
3833
3834    /**
3835     * Handler for Jetpack remote file uploads.
3836     *
3837     * @access public
3838     * @return never
3839     */
3840    public function remote_request_handlers() {
3841        switch ( current_filter() ) {
3842            case 'wp_ajax_nopriv_jetpack_upload_file':
3843                $response = $this->upload_handler();
3844                break;
3845
3846            case 'wp_ajax_nopriv_jetpack_update_file':
3847                $response = $this->upload_handler( true );
3848                break;
3849            default:
3850                $response = new WP_Error( 'unknown_handler', 'Unknown Handler', 400 );
3851                break;
3852        }
3853
3854        if ( ! $response ) {
3855            $response = new WP_Error( 'unknown_error', 'Unknown Error', 400 );
3856        }
3857
3858        if ( is_wp_error( $response ) ) {
3859            $status_code       = $response->get_error_data();
3860            $error             = $response->get_error_code();
3861            $error_description = $response->get_error_message();
3862
3863            if ( ! is_int( $status_code ) ) {
3864                $status_code = 400;
3865            }
3866
3867            wp_send_json( (object) compact( 'error', 'error_description' ), $status_code, JSON_UNESCAPED_SLASHES );
3868        }
3869
3870        if ( true === $response ) {
3871            status_header( 200 );
3872            exit( 0 );
3873        }
3874
3875        wp_send_json( (object) $response, 200, JSON_UNESCAPED_SLASHES );
3876    }
3877
3878    /**
3879     * Uploads a file gotten from the global $_FILES.
3880     * If `$update_media_item` is true and `post_id` is defined
3881     * the attachment file of the media item (gotten through of the post_id)
3882     * will be updated instead of add a new one.
3883     *
3884     * @param  boolean $update_media_item - update media attachment.
3885     * @return array|WP_Error - An array describing the uploading files process.
3886     */
3887    public function upload_handler( $update_media_item = false ) {
3888        if ( isset( $_SERVER['REQUEST_METHOD'] ) && 'POST' !== strtoupper( sanitize_text_field( wp_unslash( $_SERVER['REQUEST_METHOD'] ) ) ) ) {
3889            return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
3890        }
3891
3892        $user = wp_authenticate( '', '' );
3893        if ( ! $user || is_wp_error( $user ) ) {
3894            return new WP_Error( 403, get_status_header_desc( 403 ), 403 );
3895        }
3896
3897        wp_set_current_user( $user->ID );
3898
3899        if ( ! current_user_can( 'upload_files' ) ) {
3900            return new WP_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3901        }
3902
3903        if ( empty( $_FILES ) ) {
3904            return new WP_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3905        }
3906
3907        foreach ( array_keys( $_FILES ) as $files_key ) {
3908            if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing -- no site changes here.
3909                return new WP_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3910            }
3911        }
3912
3913        $media_keys = isset( $_FILES['media'] ) ? array_keys( $_FILES['media'] ) : array(); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Unslash is not needed for `$_FILES`, the sniff is wrong. Sanitization should happen below.
3914
3915        $token = ( new Tokens() )->get_access_token( get_current_user_id() );
3916        if ( ! $token || is_wp_error( $token ) ) {
3917            return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3918        }
3919
3920        /**
3921         * Optionally block uploads processed through Jetpack's upload_handler().
3922         * The filter may return false or WP_Error to block this particular upload.
3923         *
3924         * @since 10.8
3925         *
3926         * @param bool|WP_Error $allowed If false or WP_Error, block the upload. If true, allow the upload.
3927         * @param mixed $_FILES The $_FILES attempting to be uploaded.
3928         */
3929        $can_upload = apply_filters( 'jetpack_upload_handler_can_upload', true, $_FILES );
3930        if ( ! $can_upload || is_wp_error( $can_upload ) ) {
3931            if ( is_wp_error( $can_upload ) ) {
3932                return $can_upload;
3933            }
3934            return new WP_Error( 'handler_cannot_upload', __( 'The upload handler cannot upload files', 'jetpack' ), 400 );
3935        }
3936
3937        $uploaded_files = array();
3938        $global_post    = $GLOBALS['post'] ?? null;
3939        unset( $GLOBALS['post'] );
3940        if ( empty( $_FILES['media']['name'] ) ) {
3941            // Nothing to process, just return.
3942            return $uploaded_files;
3943        }
3944        foreach ( $_FILES['media']['name'] as $index => $name ) { // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- As above, unslash sniff is wrong. Validation should happen below.
3945            $file = array();
3946            foreach ( $media_keys as $media_key ) {
3947                $file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ] ?? null; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash,,WordPress.Security.NonceVerification.Missing,WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- As above, the unslash sniff is wrong.
3948            }
3949
3950            list( $hmac_provided, $salt ) = isset( $_POST['_jetpack_file_hmac_media'][ $index ] ) ? explode( ':', filter_var( wp_unslash( $_POST['_jetpack_file_hmac_media'][ $index ] ) ) ) : array( 'no', '' ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce should have been checked by the caller.
3951
3952            $hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3953            if ( $hmac_provided !== $hmac_file ) {
3954                $uploaded_files[ $index ] = (object) array(
3955                    'error'             => 'invalid_hmac',
3956                    'error_description' => 'The corresponding HMAC for this file does not match',
3957                );
3958                continue;
3959            }
3960
3961            $_FILES['.jetpack.upload.'] = $file;
3962            $post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0; // phpcs:ignore WordPress.Security.NonceVerification.Missing -- caller should have checked a nonce.
3963            if ( ! current_user_can( 'edit_post', $post_id ) ) {
3964                $post_id = 0;
3965            }
3966
3967            if ( $update_media_item ) {
3968                if ( ! isset( $post_id ) || 0 === $post_id ) {
3969                    return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3970                }
3971
3972                $media_array = $_FILES['media']; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.MissingUnslash, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
3973
3974                $file_array             = array();
3975                $file_array['name']     = $media_array['name'][0];
3976                $file_array['type']     = $media_array['type'][0];
3977                $file_array['tmp_name'] = $media_array['tmp_name'][0];
3978                $file_array['error']    = $media_array['error'][0];
3979                $file_array['size']     = $media_array['size'][0];
3980
3981                $edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3982
3983                if ( is_wp_error( $edited_media_item ) ) {
3984                    return $edited_media_item;
3985                }
3986
3987                $response = (object) array(
3988                    'id'   => (string) $post_id,
3989                    'file' => (string) $edited_media_item->post_title,
3990                    'url'  => (string) wp_get_attachment_url( $post_id ),
3991                    'type' => (string) $edited_media_item->post_mime_type,
3992                    'meta' => (array) wp_get_attachment_metadata( $post_id ),
3993                );
3994
3995                return array( $response );
3996            }
3997
3998            $attachment_id = media_handle_upload(
3999                '.jetpack.upload.',
4000                $post_id,
4001                array(),
4002                array(
4003                    'action' => 'jetpack_upload_file',
4004                )
4005            );
4006
4007            if ( ! $attachment_id ) {
4008                $uploaded_files[ $index ] = (object) array(
4009                    'error'             => 'unknown',
4010                    'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
4011                );
4012            } elseif ( is_wp_error( $attachment_id ) ) {
4013                $uploaded_files[ $index ] = (object) array(
4014                    'error'             => 'attachment_' . $attachment_id->get_error_code(),
4015                    'error_description' => $attachment_id->get_error_message(),
4016                );
4017            } else {
4018                $attachment               = get_post( $attachment_id );
4019                $uploaded_files[ $index ] = (object) array(
4020                    'id'   => (string) $attachment_id,
4021                    'file' => $attachment->post_title,
4022                    'url'  => wp_get_attachment_url( $attachment_id ),
4023                    'type' => $attachment->post_mime_type,
4024                    'meta' => wp_get_attachment_metadata( $attachment_id ),
4025                );
4026            }
4027        }
4028        if ( $global_post !== null ) {
4029            $GLOBALS['post'] = $global_post; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
4030        }
4031
4032        return $uploaded_files;
4033    }
4034
4035    /**
4036     * Add action links for the Jetpack plugin.
4037     *
4038     * @param array $actions Plugin actions.
4039     *
4040     * @return array
4041     */
4042    public function plugin_action_links( $actions ) {
4043        if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_connection_ready() || ( new Status() )->is_offline_mode() ) ) {
4044            return array_merge(
4045                array( 'settings' => sprintf( '<a href="%s">%s</a>', esc_url( self::admin_url( 'page=jetpack-settings#/settings' ) ), __( 'Settings', 'jetpack' ) ) ),
4046                $actions
4047            );
4048        }
4049
4050        return $actions;
4051    }
4052
4053    /**
4054     * Adds the deactivation warning modal for Jetpack.
4055     *
4056     * @param string $hook The current admin page.
4057     *
4058     * @return void
4059     */
4060    public function deactivate_dialog( $hook ) {
4061        if (
4062            'plugins.php' === $hook
4063            && self::is_connection_ready()
4064        ) {
4065
4066            // Register jp-tracks-functions dependency.
4067            Tracking::register_tracks_functions_scripts( true );
4068
4069            // add a deactivation script that will pick up deactivation actions for the Jetpack plugin.
4070            Assets::register_script(
4071                'jetpack-plugins-page-js',
4072                '_inc/build/plugins-page.js',
4073                JETPACK__PLUGIN_FILE,
4074                array(
4075                    'in_footer'  => true,
4076                    'textdomain' => 'jetpack',
4077                )
4078            );
4079            Assets::enqueue_script( 'jetpack-plugins-page-js' );
4080
4081            // Add objects to be passed to the initial state of the app.
4082            // Use wp_add_inline_script instead of wp_localize_script, see https://core.trac.wordpress.org/ticket/25280.
4083            wp_add_inline_script( 'jetpack-plugins-page-js', 'var Initial_State=' . wp_json_encode( Jetpack_Redux_State_Helper::get_plugins_page_state(), JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ) . ';', 'before' );
4084
4085            add_action( 'admin_footer', array( $this, 'jetpack_plugin_portal_containers' ) );
4086        }
4087    }
4088
4089    /**
4090     * Outputs the wrapper for the plugin modal
4091     * Contents are loaded by React script
4092     *
4093     * @return void
4094     */
4095    public function jetpack_plugin_portal_containers() {
4096        $this->load_view( 'admin/jetpack-plugin-portal-containers.php' );
4097    }
4098
4099    /**
4100     * Filters the login URL to include the registration flow in case the user isn't logged in.
4101     *
4102     * @param string $login_url The wp-login URL.
4103     * @param string $redirect  URL to redirect users after logging in.
4104     * @since Jetpack 8.4
4105     * @return string
4106     */
4107    public function login_url( $login_url, $redirect ) {
4108        parse_str( (string) wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4109        if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4110            $login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4111        }
4112        return $login_url;
4113    }
4114
4115    /**
4116     * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4117     *
4118     * @since Jetpack 8.4
4119     */
4120    public function login_init() {
4121        // phpcs:ignore WordPress.Security.NonceVerification
4122        if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4123            add_filter( 'allowed_redirect_hosts', array( Host::class, 'allow_wpcom_environments' ) );
4124            wp_safe_redirect(
4125                add_query_arg(
4126                    array(
4127                        'forceInstall' => 1,
4128                        'url'          => rawurlencode( get_site_url() ),
4129                    ),
4130                    // @todo provide way to go to specific calypso env.
4131                    self::get_calypso_host() . 'jetpack/connect'
4132                )
4133            );
4134            exit( 0 );
4135        }
4136    }
4137
4138    /*
4139     * Registration flow:
4140     * 1 - ::admin_page_load() action=register
4141     * 2 - ::try_registration()
4142     * 3 - ::register()
4143     *     - Creates jetpack_register option containing two secrets and a timestamp
4144     *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4145     *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4146     *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4147     *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4148     *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4149     *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4150     *       jetpack_id, jetpack_secret, jetpack_public
4151     *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4152     * 4 - redirect to https://wordpress.com/start/jetpack-connect
4153     * 5 - user logs in with WP.com account
4154     * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4155     *      - Manager::authorize()
4156     *      - Manager::get_token()
4157     *      - GET https://jetpack.wordpress.com/jetpack.token/1/ with
4158     *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4159     *          - which responds with access_token, token_type, scope
4160     *      - Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4161     *      - Jetpack::activate_default_modules()
4162     *          - Deactivates deprecated plugins
4163     *          - Activates all default modules
4164     *      - Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4165     * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4166     * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4167     *     Done!
4168     */
4169
4170    /**
4171     * Build the user-facing description stored alongside a registration error code.
4172     *
4173     * @since 16.2
4174     *
4175     * @see Automattic\Jetpack\Connection\Utils::get_registration_error_description()
4176     *
4177     * @param string $error_code The WP_Error code.
4178     * @param string $message    The WP_Error message.
4179     * @return string The description, empty when the message is not user-facing copy.
4180     */
4181    public static function get_registration_error_description( $error_code, $message ) {
4182        if ( method_exists( Connection_Utils::class, 'get_registration_error_description' ) ) {
4183            return Connection_Utils::get_registration_error_description( $error_code, $message );
4184        }
4185
4186        // Fallback for connection packages that predate it. A raw body would also overflow the state cookie.
4187        if ( 'jetpack_id' === $error_code || is_numeric( $message ) ) {
4188            return '';
4189        }
4190
4191        return mb_substr( (string) $message, 0, 250 );
4192    }
4193
4194    /**
4195     * Handles the page load events for the Jetpack admin page
4196     */
4197    public function admin_page_load() {
4198        $error = false;
4199
4200        // Make sure we have the right body class to hook stylings for subpages off of.
4201        add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4202
4203        if ( ! empty( $_GET['jetpack_restate'] ) ) {
4204            // Should only be used in intermediate redirects to preserve state across redirects.
4205            self::restate();
4206        }
4207
4208        if ( isset( $_GET['action'] ) ) {
4209            switch ( $_GET['action'] ) {
4210                /**
4211                 * Cases authorize and authorize_redirect are now handled by Connection package Webhooks
4212                 */
4213                case 'authorize_redirect':
4214                case 'authorize':
4215                    break;
4216                case 'register':
4217                    if ( ! current_user_can( 'jetpack_connect' ) ) {
4218                        $error = 'cheatin';
4219                        break;
4220                    }
4221                    check_admin_referer( 'jetpack-register' );
4222                    self::log( 'register' );
4223                    self::maybe_set_version_option();
4224                    $from = isset( $_GET['from'] ) ? sanitize_text_field( wp_unslash( $_GET['from'] ) ) : false;
4225                    if ( $from ) {
4226                        static::connection()->add_register_request_param( 'from', (string) $from );
4227                    }
4228                    $registered = static::connection()->try_registration( true, true );
4229                    if ( is_wp_error( $registered ) ) {
4230                        $error = $registered->get_error_code();
4231                        self::state( 'error', $error );
4232
4233                        self::state( 'error_description', self::get_registration_error_description( $error, $registered->get_error_message() ) );
4234
4235                        /**
4236                         * Jetpack registration Error.
4237                         *
4238                         * @since 7.5.0
4239                         *
4240                         * @param string|int $error The error code.
4241                         * @param \WP_Error $registered The error object.
4242                         */
4243                        do_action( 'jetpack_connection_register_fail', $error, $registered );
4244                        break;
4245                    }
4246
4247                    $redirect = isset( $_GET['redirect'] ) ? wp_unslash( $_GET['redirect'] ) : false; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
4248
4249                    /**
4250                     * Jetpack registration Success.
4251                     *
4252                     * @since 7.5.0
4253                     *
4254                     * @param string $from 'from' GET parameter;
4255                     */
4256                    do_action( 'jetpack_connection_register_success', $from );
4257
4258                    $url = $this->build_connect_url( true, $redirect, $from );
4259
4260                    if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4261                        $url = add_query_arg( 'auth_approved', 'true', $url );
4262                    }
4263
4264                    add_filter( 'allowed_redirect_hosts', array( Host::class, 'allow_wpcom_environments' ) );
4265                    wp_safe_redirect( $url );
4266                    exit( 0 );
4267                case 'activate':
4268                    if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4269                        $error = 'cheatin';
4270                        break;
4271                    }
4272
4273                    $module = isset( $_GET['module'] ) ? sanitize_text_field( wp_unslash( $_GET['module'] ) ) : '';
4274                    check_admin_referer( "jetpack_activate-$module" );
4275                    self::log( 'activate', $module );
4276                    if ( ! self::activate_module( $module ) ) {
4277                        /* translators: module/feature name */
4278                        self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4279                    }
4280                    // The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4281                    wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4282                    exit( 0 );
4283                case 'activate_default_modules':
4284                    check_admin_referer( 'activate_default_modules' );
4285                    self::log( 'activate_default_modules' );
4286                    self::restate();
4287                    $min_version   = isset( $_GET['min_version'] ) ? sanitize_text_field( wp_unslash( $_GET['min_version'] ) ) : false;
4288                    $max_version   = isset( $_GET['max_version'] ) ? sanitize_text_field( wp_unslash( $_GET['max_version'] ) ) : false;
4289                    $other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? array_map( 'sanitize_text_field', wp_unslash( $_GET['other_modules'] ) ) : array();
4290                    self::activate_default_modules( $min_version, $max_version, $other_modules );
4291                    wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4292                    exit( 0 );
4293                case 'disconnect':
4294                    if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4295                        $error = 'cheatin';
4296                        break;
4297                    }
4298
4299                    check_admin_referer( 'jetpack-disconnect' );
4300                    self::log( 'disconnect' );
4301                    self::disconnect();
4302                    wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4303                    exit( 0 );
4304                case 'reconnect':
4305                    if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4306                        $error = 'cheatin';
4307                        break;
4308                    }
4309
4310                    check_admin_referer( 'jetpack-reconnect' );
4311                    self::log( 'reconnect' );
4312                    self::disconnect();
4313
4314                    add_filter( 'allowed_redirect_hosts', array( Host::class, 'allow_wpcom_environments' ) );
4315                    wp_safe_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4316                    exit( 0 );
4317                case 'deactivate':
4318                    if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4319                        $error = 'cheatin';
4320                        break;
4321                    }
4322
4323                    $modules = sanitize_text_field( wp_unslash( $_GET['module'] ) );
4324                    check_admin_referer( "jetpack_deactivate-$modules" );
4325                    foreach ( explode( ',', $modules ) as $module ) {
4326                        self::log( 'deactivate', $module );
4327                        self::deactivate_module( $module );
4328                        self::state( 'message', 'module_deactivated' );
4329                    }
4330                    self::state( 'module', $modules );
4331                    wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4332                    exit( 0 );
4333                case 'unlink':
4334                    $redirect = isset( $_GET['redirect'] ) ? sanitize_text_field( wp_unslash( $_GET['redirect'] ) ) : '';
4335                    check_admin_referer( 'jetpack-unlink' );
4336                    self::log( 'unlink' );
4337                    $this->connection_manager->disconnect_user();
4338                    self::state( 'message', 'unlinked' );
4339                    if ( 'sub-unlink' === $redirect ) {
4340                        wp_safe_redirect( admin_url() );
4341                    } else {
4342                        wp_safe_redirect( self::admin_url( array( 'page' => rawurlencode( $redirect ) ) ) );
4343                    }
4344                    exit( 0 );
4345                default:
4346                    /**
4347                     * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4348                     *
4349                     * @since 2.6.0
4350                     *
4351                     * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4352                     */
4353                    do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4354            }
4355        }
4356
4357        $error = $error ? $error : self::state( 'error' );
4358        if ( ! $error ) {
4359            self::activate_new_modules( true );
4360        }
4361
4362        $activated_manage = false;
4363        $message_code     = self::state( 'message' );
4364        if ( self::state( 'optin-manage' ) ) {
4365            $activated_manage = $message_code;
4366            $message_code     = 'jetpack-manage';
4367        }
4368
4369        switch ( $message_code ) {
4370            case 'jetpack-manage':
4371                $sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4372                // translators: %s is the URL to the "Sites" panel on wordpress.com.
4373                $this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), $sites_url ) . '</strong>';
4374                if ( $activated_manage ) {
4375                    $this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4376                }
4377                break;
4378
4379        }
4380
4381        $deactivated_plugins = self::state( 'deactivated_plugins' );
4382
4383        if ( ! empty( $deactivated_plugins ) ) {
4384            $deactivated_plugins = explode( ',', $deactivated_plugins );
4385            $deactivated_titles  = array();
4386            foreach ( $deactivated_plugins as $deactivated_plugin ) {
4387                list( $module, $idx ) = explode( ':', $deactivated_plugin );
4388                if ( ! isset( $this->plugins_to_deactivate[ $module ][ $idx ] ) ) {
4389                    continue;
4390                }
4391
4392                $deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $module ][ $idx ][1] ) . '</strong>';
4393            }
4394
4395            if ( $deactivated_titles ) {
4396                if ( $this->message ) {
4397                    $this->message .= "<br /><br />\n";
4398                }
4399
4400                $this->message .= wp_sprintf(
4401                    _n(
4402                        'Jetpack contains the most recent version of the old %l plugin.',
4403                        'Jetpack contains the most recent versions of the old %l plugins.',
4404                        count( $deactivated_titles ),
4405                        'jetpack'
4406                    ),
4407                    $deactivated_titles
4408                );
4409
4410                $this->message .= "<br />\n";
4411
4412                $this->message .= _n(
4413                    'The old version has been deactivated and can be removed from your site.',
4414                    'The old versions have been deactivated and can be removed from your site.',
4415                    count( $deactivated_titles ),
4416                    'jetpack'
4417                );
4418            }
4419        }
4420
4421        $this->privacy_checks = self::state( 'privacy_checks' );
4422
4423        if ( $this->message || $this->error || $this->privacy_checks ) {
4424            add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4425        }
4426
4427        add_filter( 'jetpack_short_module_description', 'wptexturize' );
4428    }
4429
4430    /**
4431     * Display admin notice upon error.
4432     *
4433     * @return void
4434     */
4435    public function admin_notices() {
4436
4437        if ( $this->error ) {
4438            ?>
4439<div id="message" class="jetpack-message jetpack-err">
4440    <div class="squeezer">
4441        <h2>
4442            <?php
4443            echo wp_kses(
4444                $this->error,
4445                array(
4446                    'a'      => array( 'href' => array() ),
4447                    'small'  => true,
4448                    'code'   => true,
4449                    'strong' => true,
4450                    'br'     => true,
4451                    'b'      => true,
4452                )
4453            );
4454            ?>
4455            </h2>
4456            <?php
4457            $desc = self::state( 'error_description' );
4458            if ( $desc ) :
4459                ?>
4460        <p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4461<?php    endif; ?>
4462    </div>
4463</div>
4464            <?php
4465        }
4466
4467        if ( $this->message ) {
4468            ?>
4469<div id="message" class="jetpack-message">
4470    <div class="squeezer">
4471        <h2>
4472            <?php
4473            echo wp_kses(
4474                $this->message,
4475                array(
4476                    'strong' => array(),
4477                    'a'      => array( 'href' => true ),
4478                    'br'     => true,
4479                )
4480            );
4481            ?>
4482            </h2>
4483    </div>
4484</div>
4485            <?php
4486        }
4487
4488        if ( $this->privacy_checks ) :
4489            $module_names = array();
4490            $module_slugs = array();
4491
4492            $privacy_checks = explode( ',', $this->privacy_checks );
4493            $privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4494            foreach ( $privacy_checks as $module_slug ) {
4495                $module = self::get_module( $module_slug );
4496                if ( ! $module ) {
4497                    continue;
4498                }
4499
4500                $module_slugs[] = $module_slug;
4501                $module_names[] = "<strong>{$module['name']}</strong>";
4502            }
4503
4504            $module_slugs = implode( ',', $module_slugs );
4505            ?>
4506<div id="message" class="jetpack-message jetpack-err">
4507    <div class="squeezer">
4508        <h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4509        <p>
4510            <?php
4511            echo wp_kses(
4512                wptexturize(
4513                    wp_sprintf(
4514                        _nx(
4515                            "Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4516                            "Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4517                            count( $privacy_checks ),
4518                            '%l = list of Jetpack module/feature names',
4519                            'jetpack'
4520                        ),
4521                        $module_names
4522                    )
4523                ),
4524                array( 'strong' => true )
4525            );
4526
4527            echo "\n<br />\n";
4528
4529            echo wp_kses(
4530                sprintf(
4531                        /* translators: URL to deactivate Jetpack features. */
4532                    _nx(
4533                        'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4534                        'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4535                        count( $privacy_checks ),
4536                        '%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4537                        'jetpack'
4538                    ),
4539                    esc_url(
4540                        wp_nonce_url(
4541                            self::admin_url(
4542                                array(
4543                                    'page'   => 'jetpack',
4544                                    'action' => 'deactivate',
4545                                    'module' => rawurlencode( $module_slugs ),
4546                                )
4547                            ),
4548                            "jetpack_deactivate-$module_slugs"
4549                        )
4550                    ),
4551                    esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4552                ),
4553                array(
4554                    'a' => array(
4555                        'href'  => true,
4556                        'title' => true,
4557                    ),
4558                )
4559            );
4560            ?>
4561        </p>
4562    </div>
4563</div>
4564            <?php
4565endif;
4566    }
4567
4568    /**
4569     * Initialize the jetpack stats instance only when needed
4570     *
4571     * @return void
4572     */
4573    private function initialize_stats() {
4574        if ( $this->a8c_mc_stats_instance === null ) {
4575            $this->a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4576        }
4577    }
4578
4579    /**
4580     * Record a stat for later output.  This will only currently output in the admin_footer.
4581     *
4582     * @param string $group Stats group.
4583     * @param string $detail Stats detail.
4584     */
4585    public function stat( $group, $detail ) {
4586        $this->initialize_stats();
4587        $this->a8c_mc_stats_instance->add( $group, $detail );
4588
4589        // Keep a local copy for backward compatibility (there are some direct checks on this).
4590        $this->stats = $this->a8c_mc_stats_instance->get_current_stats();
4591    }
4592
4593    /**
4594     * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4595     *
4596     * @param string $method Used to check if method is "server-side".
4597     */
4598    public function do_stats( $method = '' ) {
4599        $this->initialize_stats();
4600        if ( 'server_side' === $method ) {
4601            $this->a8c_mc_stats_instance->do_server_side_stats();
4602        } else {
4603            $this->a8c_mc_stats_instance->do_stats();
4604        }
4605
4606        // Keep a local copy for backward compatibility (there are some direct checks on this).
4607        $this->stats = array();
4608    }
4609
4610    /**
4611     * Runs stats code for a one-off, server-side.
4612     *
4613     * @param array|string $args The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4614     *
4615     * @return bool If it worked.
4616     */
4617    public static function do_server_side_stat( $args ) {
4618        $url                   = self::build_stats_url( $args );
4619        $a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4620        return $a8c_mc_stats_instance->do_server_side_stat( $url );
4621    }
4622
4623    /**
4624     * Builds the stats url.
4625     *
4626     * @param array|string $args The arguments to append to the URL.
4627     *
4628     * @return string The URL to be pinged.
4629     */
4630    public static function build_stats_url( $args ) {
4631
4632        $a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4633        return $a8c_mc_stats_instance->build_stats_url( $args );
4634    }
4635
4636    /**
4637     * Builds a URL to the Jetpack connection auth page
4638     *
4639     * @since 3.9.5
4640     *
4641     * @param bool        $raw If true, URL will not be escaped.
4642     * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4643     *                              If string, will be a custom redirect.
4644     * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4645     * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0.
4646     *
4647     * @return string Connect URL
4648     */
4649    public function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4650        $site_id    = Jetpack_Options::get_option( 'id' );
4651        $blog_token = ( new Tokens() )->get_access_token();
4652
4653        if ( $register || ! $blog_token || ! $site_id ) {
4654            $url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4655
4656            if ( ! empty( $redirect ) ) {
4657                $url = add_query_arg(
4658                    'redirect',
4659                    rawurlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4660                    $url
4661                );
4662            }
4663
4664            if ( is_network_admin() ) {
4665                $url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4666            }
4667
4668            $calypso_env = ( new Host() )->get_calypso_env();
4669
4670            if ( ! empty( $calypso_env ) ) {
4671                $url = add_query_arg( 'calypso_env', $calypso_env, $url );
4672            }
4673        } else {
4674
4675            // Let's check the existing blog token to see if we need to re-register. We only check once per minute
4676            // because otherwise this logic can get us in to a loop.
4677            $last_connect_url_check = (int) Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' );
4678            if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4679                Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4680
4681                $response = Client::wpcom_json_api_request_as_blog(
4682                    sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4683                    '1.1'
4684                );
4685
4686                if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4687
4688                    // Generating a register URL instead to refresh the existing token.
4689                    return $this->build_connect_url( $raw, $redirect, $from, true );
4690                }
4691            }
4692
4693            $url = ( new Authorize_Redirect( static::connection() ) )->build_authorize_url( $redirect );
4694        }
4695
4696        if ( $from ) {
4697            $url = add_query_arg( 'from', $from, $url );
4698        }
4699
4700        $url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4701        /**
4702         * Filter the URL used when connecting a user to a WordPress.com account.
4703         *
4704         * @since 8.1.0
4705         *
4706         * @param string $url Connection URL.
4707         * @param bool   $raw If true, URL will not be escaped.
4708         */
4709        return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4710    }
4711
4712    /**
4713     * Create the Jetpack authorization URL.
4714     *
4715     * @param bool|string $redirect URL to redirect to.
4716     * @param null        $deprecated Deprecated since Jetpack 10.9.
4717     *
4718     * @todo Update default value for redirect since the called function expects a string.
4719     *
4720     * @deprecated 13.4
4721     *
4722     * @return mixed|void
4723     */
4724    public static function build_authorize_url( $redirect = false, $deprecated = null ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
4725        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Authorize_Redirect::build_authorize_url' );
4726
4727        return ( new Authorize_Redirect( static::connection() ) )->build_authorize_url( $redirect );
4728    }
4729
4730    /**
4731     * Filters the connection URL parameter array.
4732     *
4733     * @deprecated 13.4
4734     *
4735     * @param array $args default URL parameters used by the package.
4736     * @return array the modified URL arguments array.
4737     */
4738    public static function filter_connect_request_body( $args ) {
4739        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Authorize_Redirect::filter_connect_request_body' );
4740
4741        return Authorize_Redirect::filter_connect_request_body( $args );
4742    }
4743
4744    /**
4745     * Filters the `jetpack/v4/connection/data` API response of the Connection package in order to
4746     * add Jetpack-the-plugin related permissions.
4747     *
4748     * @since 10.0
4749     *
4750     * @param array $current_user_connection_data An array containing the current user connection data.
4751     * @return array
4752     */
4753    public static function filter_jetpack_current_user_connection_data( $current_user_connection_data ) {
4754        $jetpack_permissions = array(
4755            'admin_page'         => current_user_can( 'jetpack_admin_page' ),
4756            'manage_modules'     => current_user_can( 'jetpack_manage_modules' ),
4757            'network_admin'      => current_user_can( 'jetpack_network_admin_page' ),
4758            'network_sites_page' => current_user_can( 'jetpack_network_sites_page' ),
4759            'edit_posts'         => current_user_can( 'edit_posts' ),
4760            'publish_posts'      => current_user_can( 'publish_posts' ),
4761            'manage_options'     => current_user_can( 'manage_options' ),
4762            'view_stats'         => current_user_can( 'view_stats' ),
4763            'manage_plugins'     => current_user_can( 'install_plugins' )
4764                                    && current_user_can( 'activate_plugins' )
4765                                    && current_user_can( 'update_plugins' )
4766                                    && current_user_can( 'delete_plugins' ),
4767        );
4768
4769        if ( isset( $current_user_connection_data['permissions'] ) &&
4770            is_array( $current_user_connection_data['permissions'] ) ) {
4771                $current_user_connection_data['permissions'] = array_merge( $current_user_connection_data['permissions'], $jetpack_permissions );
4772        } else {
4773            $current_user_connection_data['permissions'] = $jetpack_permissions;
4774        }
4775
4776        return $current_user_connection_data;
4777    }
4778
4779    /**
4780     * Filters the redirection URL that is used for connect requests. The redirect
4781     * URL should return the user back to the Jetpack console.
4782     *
4783     * @deprecated 13.4
4784     *
4785     * @param String $redirect the default redirect URL used by the package.
4786     * @return String the modified URL.
4787     */
4788    public static function filter_connect_redirect_url( $redirect ) {
4789        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Authorize_Redirect::filter_connect_redirect_url' );
4790        return Authorize_Redirect::filter_connect_redirect_url( $redirect );
4791    }
4792
4793    /**
4794     * This action fires at the beginning of the Manager::authorize method.
4795     */
4796    public static function authorize_starting() {
4797        $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4798        // Checking if site has been active/connected previously before recording unique connection.
4799        if ( ! $jetpack_unique_connection ) {
4800            // jetpack_unique_connection option has never been set.
4801            $jetpack_unique_connection = array(
4802                'connected'    => 0,
4803                'disconnected' => 0,
4804                'version'      => '3.6.1',
4805            );
4806
4807            update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4808
4809            // Track unique connection.
4810            $jetpack = self::init();
4811
4812            $jetpack->stat( 'connections', 'unique-connection' );
4813            $jetpack->do_stats( 'server_side' );
4814        }
4815
4816        // Increment number of times connected.
4817        $jetpack_unique_connection['connected'] += 1;
4818        Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4819    }
4820
4821    /**
4822     * This action fires when the site is registered (connected at a site level).
4823     */
4824    public function handle_unique_registrations_stats() {
4825        $jetpack_unique_registrations = Jetpack_Options::get_option( 'unique_registrations' );
4826        // Checking if site has been registered previously before recording unique connection.
4827        if ( ! $jetpack_unique_registrations ) {
4828
4829            $jetpack_unique_registrations = 0;
4830
4831            $this->stat( 'connections', 'unique-registrations' );
4832            $this->do_stats( 'server_side' );
4833        }
4834
4835        // Increment number of times connected.
4836        ++$jetpack_unique_registrations;
4837        Jetpack_Options::update_option( 'unique_registrations', $jetpack_unique_registrations );
4838    }
4839
4840    /**
4841     * This action fires at the end of the Manager::authorize method when a secondary user is
4842     * linked.
4843     */
4844    public static function authorize_ending_linked() {
4845        // Don't activate anything since we are just connecting a user.
4846        self::state( 'message', 'linked' );
4847    }
4848
4849    /**
4850     * This action fires at the end of the Manager::authorize method when the master user is
4851     * authorized.
4852     *
4853     * @param array $data The request data.
4854     */
4855    public static function authorize_ending_authorized( $data ) {
4856        // If redirect_uri is SSO, ensure SSO module is enabled.
4857        parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4858
4859        /** This filter is documented in class.jetpack-cli.php */
4860        $jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4861
4862        $activate_sso = (
4863            isset( $redirect_options['action'] ) &&
4864            'jetpack-sso' === $redirect_options['action'] &&
4865            $jetpack_start_enable_sso
4866        );
4867
4868        $do_redirect_on_error = ( 'client' === $data['auth_type'] );
4869
4870        self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4871    }
4872
4873    /**
4874     * Fires on the jetpack_site_registered hook and acitvates default modules
4875     */
4876    public static function activate_default_modules_on_site_register() {
4877        self::handle_default_module_activation( false );
4878
4879        // Since this is a fresh connection, be sure to clear out IDC options.
4880        Identity_Crisis::clear_all_idc_options();
4881    }
4882
4883    /**
4884     * This action fires at the end of the REST_Connector connection_reconnect method when the
4885     * reconnect process is completed.
4886     * Note that this currently only happens when we don't need the user to re-authorize
4887     * their WP.com account, eg in cases where we are restoring a connection with
4888     * unhealthy blog token.
4889     */
4890    public static function reconnection_completed() {
4891        self::state( 'message', 'reconnection_completed' );
4892    }
4893
4894    /**
4895     * Apply activation source to a query string array.
4896     *
4897     * @param array $args Args used for a query string.
4898     *
4899     * @return void
4900     */
4901    public static function apply_activation_source_to_args( &$args ) {
4902        list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4903
4904        if ( $activation_source_name ) {
4905            $args['_as'] = rawurlencode( $activation_source_name );
4906        }
4907
4908        if ( $activation_source_keyword ) {
4909            $args['_ak'] = rawurlencode( $activation_source_keyword );
4910        }
4911    }
4912
4913    /**
4914     * Returns the reconnection URL.
4915     *
4916     * @param bool $raw True to return an unescaped URL. False returns value after `esc_url`.
4917     *
4918     * @return string|null
4919     */
4920    public function build_reconnect_url( $raw = false ) {
4921        $url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4922        return $raw ? $url : esc_url( $url );
4923    }
4924
4925    /**
4926     * Jetpack Admin URL.
4927     *
4928     * @param array $args Query string args.
4929     *
4930     * @return string Jetpack admin URL.
4931     */
4932    public static function admin_url( $args = null ) {
4933        return ( new Paths() )->admin_url( $args );
4934    }
4935
4936    /**
4937     * Creates a nonce from an URL.
4938     *
4939     * @param string $actionurl URL for action.
4940     * @param string $action Nonce action.
4941     * @param string $name Query arg name.
4942     *
4943     * @return string
4944     */
4945    public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4946        $actionurl = str_replace( '&amp;', '&', $actionurl );
4947        return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4948    }
4949
4950    /**
4951     * Dismiss Jetpack notices.
4952     *
4953     * @return void
4954     */
4955    public function dismiss_jetpack_notice() {
4956        if ( ! isset( $_GET['jetpack-notice'] ) ) {
4957            return;
4958        }
4959
4960        switch ( $_GET['jetpack-notice'] ) {
4961            case 'dismiss':
4962                if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4963
4964                    require_once ABSPATH . 'wp-admin/includes/plugin.php';
4965                    deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4966                    wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4967                }
4968                break;
4969        }
4970    }
4971
4972    /**
4973     * Determines which module has a higher sort order.
4974     *
4975     * @param array $a Modules array.
4976     * @param array $b Modules array.
4977     *
4978     * @return int 0 if the same sort or (+/-) to indicate which is greater.
4979     */
4980    public static function sort_modules( $a, $b ) {
4981        return $a['sort'] <=> $b['sort'];
4982    }
4983
4984    /**
4985     * Recheck SSL status for use via an AJAX call.
4986     *
4987     * Sends data back via `wp_send_json`.
4988     *
4989     * @return void
4990     */
4991    public function ajax_recheck_ssl() {
4992        check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4993        $result = self::permit_ssl( true );
4994        wp_send_json(
4995            array(
4996                'enabled' => $result,
4997                'message' => self::get_ssl_test_message(),
4998            ),
4999            null, // @phan-suppress-current-line PhanTypeMismatchArgumentProbablyReal -- It takes null, but its phpdoc only says int.
5000            JSON_UNESCAPED_SLASHES
5001        );
5002    }
5003
5004    /* Client API */
5005
5006    /**
5007     * Verify the onboarding token.
5008     *
5009     * @deprecated since 13.9
5010     *
5011     * @param array  $token_data Token data.
5012     * @param string $token Token value.
5013     * @param string $request_data JSON-encoded request data.
5014     *
5015     * @return mixed
5016     */
5017    public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5018        _deprecated_function( __METHOD__, '13.9' );
5019        // Default to a blog token.
5020        $token_type = 'blog';
5021
5022        // Let's see if this is onboarding. In such case, use user token type and the provided user id.
5023        if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes, if caller is changing the site the nonce should be verified there.
5024            if ( ! empty( $_GET['onboarding'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
5025                $jpo = $_GET; // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
5026            } else {
5027                $jpo = json_decode( $request_data, true );
5028            }
5029
5030            $jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5031            $jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5032
5033            if (
5034                isset( $jpo_user )
5035                && isset( $jpo_token )
5036                && is_email( $jpo_user )
5037                && ctype_alnum( $jpo_token )
5038                && isset( $_GET['rest_route'] ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no site changes.
5039                && self::validate_onboarding_token_action(
5040                    $jpo_token,
5041                    wp_unslash( $_GET['rest_route'] ) // phpcs:ignore WordPress.Security.NonceVerification.Recommended, WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- no site changes.
5042                )
5043            ) {
5044                $jp_user = get_user_by( 'email', $jpo_user );
5045                if ( is_a( $jp_user, 'WP_User' ) ) {
5046                    wp_set_current_user( $jp_user->ID );
5047                    $user_can = is_multisite()
5048                        ? current_user_can_for_site( get_current_blog_id(), 'manage_options' )
5049                        : current_user_can( 'manage_options' );
5050                    if ( $user_can ) {
5051                        $token_type              = 'user';
5052                        $token->external_user_id = $jp_user->ID;
5053                    }
5054                }
5055            }
5056
5057            $token_data['type']    = $token_type;
5058            $token_data['user_id'] = $token->external_user_id;
5059        }
5060
5061        return $token_data;
5062    }
5063
5064    /**
5065     * Create a random secret for validating onboarding payload
5066     *
5067     * @deprecated since 13.9
5068     * @return string Secret token
5069     */
5070    public static function create_onboarding_token() {
5071        _deprecated_function( __METHOD__, '13.9' );
5072        $token = Jetpack_Options::get_option( 'onboarding' );
5073        if ( false === ( $token ) ) {
5074            $token = wp_generate_password( 32, false );
5075            Jetpack_Options::update_option( 'onboarding', $token );
5076        }
5077
5078        return $token;
5079    }
5080
5081    /**
5082     * Remove the onboarding token
5083     *
5084     * @deprecated since 13.9
5085     * @return bool True on success, false on failure
5086     */
5087    public static function invalidate_onboarding_token() {
5088        _deprecated_function( __METHOD__, '13.9' );
5089        return Jetpack_Options::delete_option( 'onboarding' );
5090    }
5091
5092    /**
5093     * Validate an onboarding token for a specific action
5094     *
5095     * @deprecated since 13.9
5096     *
5097     * @param string $token Onboarding token.
5098     * @param string $action Action name.
5099     *
5100     * @return boolean True if token/action pair is accepted, false if not
5101     */
5102    public static function validate_onboarding_token_action( $token, $action ) {
5103        _deprecated_function( __METHOD__, '13.9' );
5104        // Compare tokens, bail if tokens do not match.
5105        if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5106            return false;
5107        }
5108
5109        // List of valid actions we can take.
5110        $valid_actions = array(
5111            '/jetpack/v4/settings',
5112        );
5113
5114        // Only allow valid actions.
5115        if ( ! in_array( $action, $valid_actions, true ) ) {
5116            return false;
5117        }
5118
5119        return true;
5120    }
5121
5122    /**
5123     * Checks to see if the URL is using SSL to connect with Jetpack
5124     *
5125     * @param bool $force_recheck Force SSL recheck.
5126     *
5127     * @return boolean
5128     * @since 2.3.3
5129     */
5130    public static function permit_ssl( $force_recheck = false ) {
5131        if ( ! method_exists( Heartbeat::class, 'permit_ssl' ) ) {
5132            // Skip the SSL-fail notice when the check cannot run.
5133            return true;
5134        }
5135
5136        return Heartbeat::permit_ssl( $force_recheck );
5137    }
5138
5139    /**
5140     * Returns a localized message describing the last SSL connectivity failure, if any.
5141     *
5142     * The Connection package's canonical SSL check stores a neutral reason code; this maps it to
5143     * a translated, `jetpack`-domain message for display in the admin notice and AJAX recheck.
5144     *
5145     * @since 16.1
5146     *
5147     * @return string The localized message, or an empty string when there is no failure.
5148     */
5149    public static function get_ssl_test_message() {
5150        if ( ! method_exists( Heartbeat::class, 'get_ssl_test_error' ) ) {
5151            return '';
5152        }
5153
5154        $error = Heartbeat::get_ssl_test_error();
5155
5156        switch ( $error['code'] ) {
5157            case 'no_ssl_support':
5158                return __( 'WordPress reports no SSL support', 'jetpack' );
5159            case 'bad_response':
5160                return __( 'Response was not OK: ', 'jetpack' ) . $error['detail'];
5161            default:
5162                return '';
5163        }
5164    }
5165
5166    /**
5167     * Displays an admin_notice, alerting the user that outbound SSL isn't working.
5168     */
5169    public function alert_auto_ssl_fail() {
5170        if ( ! current_user_can( 'manage_options' ) ) {
5171            return;
5172        }
5173
5174        $ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5175        ?>
5176
5177        <div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5178            <div class="jp-banner__content">
5179                <h2><?php esc_html_e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5180                <p><?php esc_html_e( 'Your site could not connect to WordPress.com via HTTPS. This could be due to any number of reasons, including faulty SSL certificates, misconfigured or missing SSL libraries, or network issues.', 'jetpack' ); ?></p>
5181                <p>
5182                    <?php esc_html_e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5183                    <a href="#" id="jetpack-recheck-ssl-button"><?php esc_html_e( 'Try again', 'jetpack' ); ?></a>
5184                    <span id="jetpack-recheck-ssl-output"><?php echo esc_html( self::get_ssl_test_message() ); ?></span>
5185                </p>
5186                <p>
5187                    <?php
5188                    printf(
5189                            /* translators: Both are URLs. First for the connection debug tool and the second for a support page. */
5190                        __( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ), // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- we're building known HTML.
5191                        esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5192                        esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5193                    );
5194                    ?>
5195                </p>
5196            </div>
5197        </div>
5198        <style>
5199            #jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5200        </style>
5201        <script type="text/javascript">
5202            jQuery( document ).ready( function( $ ) {
5203                $( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5204                    var $this = $( this );
5205                    $this.html( <?php echo wp_json_encode( esc_html__( 'Checking', 'jetpack' ), JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ); ?> );
5206                    $( '#jetpack-recheck-ssl-output' ).html( '' );
5207                    e.preventDefault();
5208                    var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': <?php echo wp_json_encode( $ajax_nonce, JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ); ?> };
5209                    $.post( ajaxurl, data )
5210                    .done( function( response ) {
5211                        if ( response.enabled ) {
5212                            $( '#jetpack-ssl-warning' ).hide();
5213                        } else {
5214                            this.html( <?php echo wp_json_encode( esc_html__( 'Try again', 'jetpack' ), JSON_UNESCAPED_SLASHES | JSON_HEX_TAG | JSON_HEX_AMP ); ?> );
5215                            $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5216                        }
5217                    }.bind( $this ) );
5218                } );
5219            } );
5220        </script>
5221
5222        <?php
5223    }
5224
5225    /**
5226     * Returns the connection manager object.
5227     *
5228     * @return Automattic\Jetpack\Connection\Manager
5229     */
5230    public static function connection() {
5231        $jetpack = static::init();
5232
5233        // If the connection manager hasn't been instantiated, do that now.
5234        if ( ! $jetpack->connection_manager ) {
5235            $jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5236        }
5237
5238        return $jetpack->connection_manager;
5239    }
5240
5241    /**
5242     * Get verification secrets.
5243     *
5244     * @param string $action Action name.
5245     * @param int    $user_id User ID.
5246     *
5247     * @return array|string|WP_Error
5248     */
5249    public static function get_secrets( $action, $user_id ) {
5250        $secrets = ( new Secrets() )->get( $action, $user_id );
5251
5252        if ( Secrets::SECRETS_MISSING === $secrets ) {
5253            return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5254        }
5255
5256        if ( Secrets::SECRETS_EXPIRED === $secrets ) {
5257            return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5258        }
5259
5260        return $secrets;
5261    }
5262
5263    /**
5264     * Filters the token request body to include tracking properties.
5265     *
5266     * @param array $properties Token request properties.
5267     *
5268     * @return array amended properties.
5269     */
5270    public static function filter_token_request_body( $properties ) {
5271        $tracking        = new Tracking();
5272        $tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5273
5274        return array_merge(
5275            $properties,
5276            array(
5277                '_ui' => $tracks_identity['_ui'],
5278                '_ut' => $tracks_identity['_ut'],
5279            )
5280        );
5281    }
5282
5283    /**
5284     * If the db version is showing something other that what we've got now, bump it to current.
5285     *
5286     * @return bool True if the option was incorrect and updated, false if nothing happened.
5287     */
5288    public static function maybe_set_version_option() {
5289        list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5290        if ( JETPACK__VERSION !== $version ) {
5291            Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5292
5293            if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5294                /** This action is documented in class.jetpack.php */
5295                do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5296            }
5297
5298            return true;
5299        }
5300        return false;
5301    }
5302
5303    /* Client Server API */
5304
5305    /**
5306     * State is passed via cookies from one request to the next, but never to subsequent requests.
5307     * SET: state( $key, $value );
5308     * GET: $value = state( $key );
5309     *
5310     * @param string $key State key.
5311     * @param string $value Value.
5312     * @param bool   $restate Reset the cookie (private).
5313     */
5314    public static function state( $key = null, $value = null, $restate = false ) {
5315        return ( new CookieState() )->state( $key, $value, $restate );
5316    }
5317
5318    /**
5319     * Set an empty state.
5320     *
5321     * @return void
5322     */
5323    public static function restate() {
5324        self::state( null, null, true );
5325    }
5326
5327    /**
5328     * Determines whether the jetpackState[$key] value should be added to the
5329     * cookie.
5330     *
5331     * @param string $key The state key.
5332     *
5333     * @return boolean Whether the value should be added to the cookie.
5334     */
5335    public static function should_set_cookie( $key ) {
5336        return ( new CookieState() )->should_set_cookie( $key );
5337    }
5338
5339    /**
5340     * Check if site is publicly accessible.
5341     *
5342     * @param string $file Module file.
5343     *
5344     * @return void
5345     */
5346    public static function check_privacy( $file ) {
5347        static $is_site_publicly_accessible = null;
5348
5349        if ( $is_site_publicly_accessible === null ) {
5350            $is_site_publicly_accessible = false;
5351
5352            $rpc = new Jetpack_IXR_Client();
5353
5354            $success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5355            if ( $success ) {
5356                $response = $rpc->getResponse();
5357                if ( $response ) {
5358                    $is_site_publicly_accessible = true;
5359                }
5360            }
5361
5362            Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5363        }
5364
5365        if ( $is_site_publicly_accessible ) {
5366            return;
5367        }
5368
5369        $module_slug = self::get_module_slug( $file );
5370
5371        $privacy_checks = self::state( 'privacy_checks' );
5372        if ( ! $privacy_checks ) {
5373            $privacy_checks = $module_slug;
5374        } else {
5375            $privacy_checks .= ",$module_slug";
5376        }
5377
5378        self::state( 'privacy_checks', $privacy_checks );
5379    }
5380
5381    /* JSON API Authorization */
5382
5383    /**
5384     * Handles the login action for Authorizing the JSON API
5385     */
5386    public function login_form_json_api_authorization() {
5387        $authorize_json_api = new Authorize_Json_Api();
5388        $authorize_json_api->verify_json_api_authorization_request();
5389
5390        add_action( 'wp_login', array( $authorize_json_api, 'store_json_api_authorization_token' ), 10, 2 );
5391
5392        add_action( 'login_message', array( $authorize_json_api, 'login_message_json_api_authorization' ) );
5393        add_action( 'login_form', array( $this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5394        add_filter( 'site_url', array( $this, 'post_login_form_to_signed_url' ), 10, 3 );
5395    }
5396
5397    /**
5398     * Make sure the login form is POSTed to the signed URL so we can reverify the request.
5399     *
5400     * @param string $url Redirect URL.
5401     * @param string $path Path.
5402     * @param string $scheme URL Scheme.
5403     */
5404    public function post_login_form_to_signed_url( $url, $path, $scheme ) {
5405        if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5406            return $url;
5407        }
5408        $query_string = isset( $_SERVER['QUERY_STRING'] ) ? wp_unslash( $_SERVER['QUERY_STRING'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
5409        $parsed_url   = wp_parse_url( $url );
5410        $url          = strtok( $url, '?' );
5411        $url          = "$url?{$query_string}";
5412        if ( ! empty( $parsed_url['query'] ) ) {
5413            $url .= "&{$parsed_url['query']}";
5414        }
5415
5416        return $url;
5417    }
5418
5419    /**
5420     * Make sure the POSTed request is handled by the same action.
5421     */
5422    public function preserve_action_in_login_form_for_json_api_authorization() {
5423        $http_host   = isset( $_SERVER['HTTP_HOST'] ) ? wp_unslash( $_SERVER['HTTP_HOST'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- escaped with esc_url below.
5424        $request_uri = isset( $_SERVER['REQUEST_URI'] ) ? wp_unslash( $_SERVER['REQUEST_URI'] ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- escaped with esc_url below.
5425        echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5426        echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $http_host . $request_uri ) ) . "' />\n";
5427    }
5428
5429    /**
5430     * If someone logs in to approve API access, store the Access Code in usermeta.
5431     *
5432     * @deprecated 13.4
5433     *
5434     * @param string  $user_login Unused.
5435     * @param WP_User $user User logged in.
5436     */
5437    public function store_json_api_authorization_token( $user_login, $user ) {
5438        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Automattic\\Jetpack\\Connection\\Authorize_Json_Api::store_json_api_authorization_token' );
5439
5440        return ( new Authorize_Json_Api() )->store_json_api_authorization_token( $user_login, $user );
5441    }
5442
5443    /**
5444     * Add public-api.wordpress.com to the safe redirect allowed list - only added when someone allows API access.
5445     *
5446     * To be used with a filter of allowed domains for a redirect.
5447     *
5448     * @deprecated 13.4
5449     *
5450     * @param array $domains Allowed WP.com Environments.
5451     */
5452    public function allow_wpcom_public_api_domain( $domains ) {
5453        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Automattic\\Jetpack\\Status\\Host::allow_wpcom_public_api_domain' );
5454
5455        return Host::allow_wpcom_public_api_domain( $domains );
5456    }
5457
5458    /**
5459     * Check if the redirect is encoded.
5460     *
5461     * @deprecated 13.4
5462     *
5463     * @param string $redirect_url Redirect URL.
5464     *
5465     * @return bool If redirect has been encoded.
5466     */
5467    public static function is_redirect_encoded( $redirect_url ) {
5468        _deprecated_function( __METHOD__, 'jetpack-13.4' );
5469        return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5470    }
5471
5472    /**
5473     * Add all wordpress.com environments to the safe redirect allowed list.
5474     *
5475     * To be used with a filter of allowed domains for a redirect.
5476     *
5477     * @param array $domains Allowed WP.com Environments.
5478     *
5479     * @deprecated since 11.1
5480     */
5481    public function allow_wpcom_environments( $domains ) {
5482        return Host::allow_wpcom_environments( $domains );
5483    }
5484
5485    /**
5486     * Add the Access Code details to the public-api.wordpress.com redirect.
5487     *
5488     * @deprecated 13.4
5489     *
5490     * @param string  $redirect_to URL.
5491     * @param string  $original_redirect_to URL.
5492     * @param WP_User $user WP_User for the redirect.
5493     *
5494     * @return string
5495     */
5496    public function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5497        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Automattic\\Jetpack\\Connection\\Authorize_Json_Api::add_token_to_login_redirect_json_api_authorization' );
5498
5499        return ( new Authorize_Json_Api() )->add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user );
5500    }
5501
5502    /**
5503     * Verifies the request by checking the signature
5504     *
5505     * @deprecated 13.4
5506     *
5507     * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5508     * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5509     *
5510     * @param null|array $environment Value to override $_REQUEST.
5511     */
5512    public function verify_json_api_authorization_request( $environment = null ) {
5513        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Automattic\\Jetpack\\Connection\\Authorize_Json_Api::verify_json_api_authorization_request' );
5514
5515        return ( new Authorize_Json_Api() )->verify_json_api_authorization_request( $environment );
5516    }
5517
5518    /**
5519     * HTML for the JSON API authorization notice.
5520     *
5521     * @deprecated 13.4
5522     *
5523     * @return string
5524     */
5525    public function login_message_json_api_authorization() {
5526        _deprecated_function( __METHOD__, 'jetpack-13.4', 'Automattic\\Jetpack\\Connection\\Authorize_Json_Api::login_message_json_api_authorization' );
5527
5528        return ( new Authorize_Json_Api() )->login_message_json_api_authorization();
5529    }
5530
5531    /**
5532     * Get $content_width, but with a <s>twist</s> filter.
5533     */
5534    public static function get_content_width() {
5535        $content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5536            ? $GLOBALS['content_width']
5537            : false;
5538        /**
5539         * Filter the Content Width value.
5540         *
5541         * @since 2.2.3
5542         *
5543         * @param string $content_width Content Width value.
5544         */
5545        return apply_filters( 'jetpack_content_width', $content_width );
5546    }
5547
5548    /**
5549     * Pings the WordPress.com Mirror Site for the specified options.
5550     *
5551     * @param string|array $option_names The option names to request from the WordPress.com Mirror Site.
5552     *
5553     * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5554     */
5555    public function get_cloud_site_options( $option_names ) {
5556        $option_names = array_filter( (array) $option_names, 'is_string' );
5557
5558        $xml = new Jetpack_IXR_Client();
5559        $xml->query( 'jetpack.fetchSiteOptions', $option_names );
5560        if ( $xml->isError() ) {
5561            return array(
5562                'error_code' => $xml->getErrorCode(),
5563                'error_msg'  => $xml->getErrorMessage(),
5564            );
5565        }
5566        $cloud_site_options = $xml->getResponse();
5567
5568        return $cloud_site_options;
5569    }
5570
5571    /**
5572     * Checks if the site is currently in an identity crisis.
5573     *
5574     * Now delegates to the Connection package so this matches what the heartbeat itself reports.
5575     * Note the package guards on `Connection\Manager::is_connected()` where this used to guard on
5576     * `Jetpack::is_connection_ready()`, so the `jetpack_is_connection_ready` filter no longer applies.
5577     *
5578     * @deprecated 16.2
5579     *
5580     * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5581     */
5582    public static function check_identity_crisis() {
5583        _deprecated_function( __METHOD__, 'jetpack-16.2', 'Automattic\\Jetpack\\Identity_Crisis::check_identity_crisis' );
5584
5585        return Identity_Crisis::check_identity_crisis();
5586    }
5587
5588    /**
5589     * Normalizes a url by doing three things:
5590     *  - Strips protocol
5591     *  - Strips www
5592     *  - Adds a trailing slash
5593     *
5594     * @since 4.4.0
5595     * @param string $url URL.
5596     * @return WP_Error|string
5597     */
5598    public static function normalize_url_protocol_agnostic( $url ) {
5599        $parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5600        if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
5601            /* translators: URL string */
5602            return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5603        }
5604
5605        // Strip www and protocols.
5606        $url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5607        return $url;
5608    }
5609
5610    /**
5611     * Maybe Use a .min.css stylesheet, maybe not.
5612     *
5613     * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5614     *
5615     * @param string $url URL.
5616     * @param string $path File path.
5617     * @param string $plugin Plugin.
5618     *
5619     * @return mixed
5620     */
5621    public static function maybe_min_asset( $url, $path, $plugin ) {
5622        // Short out on things trying to find actual paths.
5623        if ( ! $path || empty( $plugin ) ) {
5624            return $url;
5625        }
5626
5627        $path = ltrim( $path, '/' );
5628
5629        // Strip out the abspath.
5630        $base = dirname( plugin_basename( $plugin ) );
5631
5632        // Short out on non-Jetpack assets.
5633        if ( ! str_starts_with( $base, 'jetpack/' ) ) {
5634            return $url;
5635        }
5636
5637        // File name parsing.
5638        $file              = "{$base}/{$path}";
5639        $full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5640        $file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5641        $file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5642        $extension         = array_shift( $file_name_parts_r );
5643
5644        if ( in_array( strtolower( $extension ), array( 'css', 'js' ), true ) ) {
5645            // Already pointing at the minified version.
5646            if ( 'min' === $file_name_parts_r[0] ) {
5647                return $url;
5648            }
5649
5650            $min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5651            if ( file_exists( $min_full_path ) ) {
5652                $url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5653                // If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
5654                if ( 'css' === $extension ) {
5655                    $key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
5656                    self::$min_assets[ $key ] = $path;
5657                }
5658            }
5659        }
5660
5661        return $url;
5662    }
5663
5664    /**
5665     * If the asset is minified, let's flag .min as the suffix.
5666     *
5667     * Attached to `style_loader_src` filter.
5668     *
5669     * @param string $src source file.
5670     * @param string $handle The registered handle of the script in question.
5671     *
5672     * @return mixed
5673     */
5674    public static function set_suffix_on_min( $src, $handle ) {
5675        if ( ! is_string( $src ) || ! str_contains( $src, '.min.css' ) ) {
5676            return $src;
5677        }
5678
5679        if ( ! empty( self::$min_assets ) ) {
5680            foreach ( self::$min_assets as $file => $path ) {
5681                if ( str_contains( $src, $file ) ) {
5682                    wp_style_add_data( $handle, 'suffix', '.min' );
5683                    return $src;
5684                }
5685            }
5686        }
5687
5688        return $src;
5689    }
5690
5691    /**
5692     * Maybe inlines a stylesheet.
5693     *
5694     * @deprecated since 11.7.
5695     *
5696     * @param string $tag The tag that would link to the external asset.
5697     * @param string $handle The registered handle of the script in question.
5698     *
5699     * @return string
5700     */
5701    public static function maybe_inline_style( $tag, $handle ) { //phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
5702        _deprecated_function( __METHOD__, '11.7', 'wp_maybe_inline_styles' );
5703
5704        return $tag;
5705    }
5706
5707    /**
5708     * Loads a view file from the views
5709     *
5710     * Data passed in with the $data parameter will be available in the
5711     * template file as $data['value']
5712     *
5713     * @html-template-var array $data
5714     *
5715     * @param string $template - Template file to load.
5716     * @param array  $data - Any data to pass along to the template.
5717     * @return boolean - If template file was found.
5718     **/
5719    public function load_view( $template, $data = array() ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable -- This is used via the required files.
5720        $views_dir = JETPACK__PLUGIN_DIR . 'views/';
5721
5722        if ( file_exists( $views_dir . $template ) ) {
5723            require_once $views_dir . $template;
5724            return true;
5725        }
5726
5727        if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
5728            trigger_error( sprintf( 'Jetpack: Unable to find view file: %s', esc_html( $views_dir . $template ) ), E_USER_WARNING ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_trigger_error
5729        }
5730        return false;
5731    }
5732
5733    /**
5734     * Register Jetpack-specific tests on the connection package's health test suite.
5735     *
5736     * @param \Automattic\Jetpack\Connection\Connection_Health_Tests $connection_tests The test suite instance.
5737     */
5738    public function register_jetpack_connection_tests( $connection_tests ) {
5739        require_once JETPACK__PLUGIN_DIR . '_inc/lib/debugger/class-jetpack-cxn-tests.php';
5740        $jetpack_tests = new Jetpack_Cxn_Tests();
5741        $jetpack_tests->register_tests_on( $connection_tests );
5742    }
5743
5744    /**
5745     * Throws warnings for deprecated hooks to be removed from Jetpack that cannot remain in the original place in the code.
5746     */
5747    public function deprecated_hooks() {
5748        $filter_deprecated_list = array(
5749            'jetpack_bail_on_shortcode'                    => array(
5750                'replacement' => 'jetpack_shortcodes_to_include',
5751                'version'     => 'jetpack-3.1.0',
5752            ),
5753            'wpl_sharing_2014_1'                           => array(
5754                'replacement' => null,
5755                'version'     => 'jetpack-3.6.0',
5756            ),
5757            'jetpack-tools-to-include'                     => array(
5758                'replacement' => 'jetpack_tools_to_include',
5759                'version'     => 'jetpack-3.9.0',
5760            ),
5761            'jetpack_identity_crisis_options_to_check'     => array(
5762                'replacement' => null,
5763                'version'     => 'jetpack-4.0.0',
5764            ),
5765            'update_option_jetpack_single_user_site'       => array(
5766                'replacement' => null,
5767                'version'     => 'jetpack-4.3.0',
5768            ),
5769            'audio_player_default_colors'                  => array(
5770                'replacement' => null,
5771                'version'     => 'jetpack-4.3.0',
5772            ),
5773            'add_option_jetpack_featured_images_enabled'   => array(
5774                'replacement' => null,
5775                'version'     => 'jetpack-4.3.0',
5776            ),
5777            'add_option_jetpack_update_details'            => array(
5778                'replacement' => null,
5779                'version'     => 'jetpack-4.3.0',
5780            ),
5781            'add_option_jetpack_updates'                   => array(
5782                'replacement' => null,
5783                'version'     => 'jetpack-4.3.0',
5784            ),
5785            'add_option_jetpack_network_name'              => array(
5786                'replacement' => null,
5787                'version'     => 'jetpack-4.3.0',
5788            ),
5789            'add_option_jetpack_network_allow_new_registrations' => array(
5790                'replacement' => null,
5791                'version'     => 'jetpack-4.3.0',
5792            ),
5793            'add_option_jetpack_network_add_new_users'     => array(
5794                'replacement' => null,
5795                'version'     => 'jetpack-4.3.0',
5796            ),
5797            'add_option_jetpack_network_site_upload_space' => array(
5798                'replacement' => null,
5799                'version'     => 'jetpack-4.3.0',
5800            ),
5801            'add_option_jetpack_network_upload_file_types' => array(
5802                'replacement' => null,
5803                'version'     => 'jetpack-4.3.0',
5804            ),
5805            'add_option_jetpack_network_enable_administration_menus' => array(
5806                'replacement' => null,
5807                'version'     => 'jetpack-4.3.0',
5808            ),
5809            'add_option_jetpack_is_multi_site'             => array(
5810                'replacement' => null,
5811                'version'     => 'jetpack-4.3.0',
5812            ),
5813            'add_option_jetpack_is_main_network'           => array(
5814                'replacement' => null,
5815                'version'     => 'jetpack-4.3.0',
5816            ),
5817            'add_option_jetpack_main_network_site'         => array(
5818                'replacement' => null,
5819                'version'     => 'jetpack-4.3.0',
5820            ),
5821            'jetpack_sync_all_registered_options'          => array(
5822                'replacement' => null,
5823                'version'     => 'jetpack-4.3.0',
5824            ),
5825            'jetpack_has_identity_crisis'                  => array(
5826                'replacement' => 'jetpack_sync_error_idc_validation',
5827                'version'     => 'jetpack-4.4.0',
5828            ),
5829            'jetpack_is_post_mailable'                     => array(
5830                'replacement' => null,
5831                'version'     => 'jetpack-4.4.0',
5832            ),
5833            'jetpack_seo_site_host'                        => array(
5834                'replacement' => null,
5835                'version'     => 'jetpack-5.1.0',
5836            ),
5837            'jetpack_installed_plugin'                     => array(
5838                'replacement' => 'jetpack_plugin_installed',
5839                'version'     => 'jetpack-6.0.0',
5840            ),
5841            'jetpack_holiday_snow_option_name'             => array(
5842                'replacement' => null,
5843                'version'     => 'jetpack-6.0.0',
5844            ),
5845            'jetpack_holiday_chance_of_snow'               => array(
5846                'replacement' => null,
5847                'version'     => 'jetpack-6.0.0',
5848            ),
5849            'jetpack_holiday_snow_js_url'                  => array(
5850                'replacement' => null,
5851                'version'     => 'jetpack-6.0.0',
5852            ),
5853            'jetpack_is_holiday_snow_season'               => array(
5854                'replacement' => null,
5855                'version'     => 'jetpack-6.0.0',
5856            ),
5857            'jetpack_holiday_snow_option_updated'          => array(
5858                'replacement' => null,
5859                'version'     => 'jetpack-6.0.0',
5860            ),
5861            'jetpack_holiday_snowing'                      => array(
5862                'replacement' => null,
5863                'version'     => 'jetpack-6.0.0',
5864            ),
5865            'jetpack_sso_auth_cookie_expirtation'          => array(
5866                'replacement' => 'jetpack_sso_auth_cookie_expiration',
5867                'version'     => 'jetpack-6.1.0',
5868            ),
5869            'jetpack_cache_plans'                          => array(
5870                'replacement' => null,
5871                'version'     => 'jetpack-6.1.0',
5872            ),
5873            'jetpack_enable_site_verification'             => array(
5874                'replacement' => null,
5875                'version'     => 'jetpack-6.5.0',
5876            ),
5877            'can_display_jetpack_manage_notice'            => array(
5878                'replacement' => null,
5879                'version'     => 'jetpack-7.3.0',
5880            ),
5881            'atd_http_post_timeout'                        => array(
5882                'replacement' => null,
5883                'version'     => 'jetpack-7.3.0',
5884            ),
5885            'atd_service_domain'                           => array(
5886                'replacement' => null,
5887                'version'     => 'jetpack-7.3.0',
5888            ),
5889            'atd_load_scripts'                             => array(
5890                'replacement' => null,
5891                'version'     => 'jetpack-7.3.0',
5892            ),
5893            'jetpack_widget_authors_exclude'               => array(
5894                'replacement' => 'jetpack_widget_authors_params',
5895                'version'     => 'jetpack-7.7.0',
5896            ),
5897            // Removed in Jetpack 7.9.0.
5898            'jetpack_pwa_manifest'                         => array(
5899                'replacement' => null,
5900                'version'     => 'jetpack-7.9.0',
5901            ),
5902            'jetpack_pwa_background_color'                 => array(
5903                'replacement' => null,
5904                'version'     => 'jetpack-7.9.0',
5905            ),
5906            'jetpack_check_mobile'                         => array(
5907                'replacement' => null,
5908                'version'     => 'jetpack-8.3.0',
5909            ),
5910            'jetpack_mobile_stylesheet'                    => array(
5911                'replacement' => null,
5912                'version'     => 'jetpack-8.3.0',
5913            ),
5914            'jetpack_mobile_template'                      => array(
5915                'replacement' => null,
5916                'version'     => 'jetpack-8.3.0',
5917            ),
5918            'jetpack_mobile_theme_menu'                    => array(
5919                'replacement' => null,
5920                'version'     => 'jetpack-8.3.0',
5921            ),
5922            'minileven_show_featured_images'               => array(
5923                'replacement' => null,
5924                'version'     => 'jetpack-8.3.0',
5925            ),
5926            'minileven_attachment_size'                    => array(
5927                'replacement' => null,
5928                'version'     => 'jetpack-8.3.0',
5929            ),
5930            'instagram_cache_oembed_api_response_body'     => array(
5931                'replacement' => null,
5932                'version'     => 'jetpack-9.1.0',
5933            ),
5934            'jetpack_can_make_outbound_https'              => array(
5935                'replacement' => null,
5936                'version'     => 'jetpack-9.1.0',
5937            ),
5938            'sharing_email_can_send'                       => array(
5939                'replacement' => null,
5940                'version'     => 'jetpack-11.0.0',
5941            ),
5942            'sharing_email_check'                          => array(
5943                'replacement' => null,
5944                'version'     => 'jetpack-11.0.0',
5945            ),
5946            'sharing_services_email'                       => array(
5947                'replacement' => null,
5948                'version'     => 'jetpack-11.0.0',
5949            ),
5950            'jetpack_dsp_promote_posts_enabled'            => array(
5951                'replacement' => null,
5952                'version'     => 'jetpack-11.8.0',
5953            ),
5954            'jetpack_are_blogging_prompts_enabled'         => array(
5955                'replacement' => null,
5956                'version'     => 'jetpack-11.8.0',
5957            ),
5958            'jetpack_subscriptions_modal_enabled'          => array(
5959                'replacement' => null,
5960                'version'     => 'jetpack-12.7.0',
5961            ),
5962            'jetpack_pre_connection_prompt_helpers'        => array(
5963                'replacement' => null,
5964                'version'     => 'jetpack-13.2.0',
5965            ),
5966            'jetpack_contact_form_use_package'             => array(
5967                'replacement' => null,
5968                'version'     => 'jetpack-13.4.0',
5969            ),
5970            // jetpack_implode_frontend_css has been removed, but is not listed here. The updated behavior is exactly the only use of the filter.
5971            // We can reassess formally deprecating it here later; for now, it would be noise with no functional difference.
5972        );
5973
5974        foreach ( $filter_deprecated_list as $tag => $args ) {
5975            if ( has_filter( $tag ) ) {
5976                apply_filters_deprecated( $tag, array( null ), $args['version'], $args['replacement'] );
5977            }
5978        }
5979
5980        $action_deprecated_list = array(
5981            'jetpack_updated_theme'        => array(
5982                'replacement' => 'jetpack_updated_themes',
5983                'version'     => 'jetpack-6.2.0',
5984            ),
5985            'atd_http_post_error'          => array(
5986                'replacement' => null,
5987                'version'     => 'jetpack-7.3.0',
5988            ),
5989            'mobile_reject_mobile'         => array(
5990                'replacement' => null,
5991                'version'     => 'jetpack-8.3.0',
5992            ),
5993            'mobile_force_mobile'          => array(
5994                'replacement' => null,
5995                'version'     => 'jetpack-8.3.0',
5996            ),
5997            'mobile_app_promo_download'    => array(
5998                'replacement' => null,
5999                'version'     => 'jetpack-8.3.0',
6000            ),
6001            'mobile_setup'                 => array(
6002                'replacement' => null,
6003                'version'     => 'jetpack-8.3.0',
6004            ),
6005            'jetpack_mobile_footer_before' => array(
6006                'replacement' => null,
6007                'version'     => 'jetpack-8.3.0',
6008            ),
6009            'wp_mobile_theme_footer'       => array(
6010                'replacement' => null,
6011                'version'     => 'jetpack-8.3.0',
6012            ),
6013            'minileven_credits'            => array(
6014                'replacement' => null,
6015                'version'     => 'jetpack-8.3.0',
6016            ),
6017            'jetpack_mobile_header_before' => array(
6018                'replacement' => null,
6019                'version'     => 'jetpack-8.3.0',
6020            ),
6021            'jetpack_mobile_header_after'  => array(
6022                'replacement' => null,
6023                'version'     => 'jetpack-8.3.0',
6024            ),
6025            'sharing_email_dialog'         => array(
6026                'replacement' => null,
6027                'version'     => 'jetpack-11.0.0',
6028            ),
6029            'sharing_email_send_post'      => array(
6030                'replacement' => null,
6031                'version'     => 'jetpack-11.0.0',
6032            ),
6033        );
6034
6035        foreach ( $action_deprecated_list as $tag => $args ) {
6036            if ( has_action( $tag ) ) {
6037                do_action_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6038            }
6039        }
6040    }
6041
6042    /**
6043     * Converts any url in a stylesheet, to the correct absolute url.
6044     *
6045     * Considerations:
6046     *  - Normal, relative URLs     `feh.png`
6047     *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6048     *  - Schema-agnostic URLs      `//domain.com/feh.png`
6049     *  - Absolute URLs             `http://domain.com/feh.png`
6050     *  - Domain root relative URLs `/feh.png`
6051     *
6052     * @param string $css The raw CSS -- should be read in directly from the file.
6053     * @param string $css_file_url The URL that the file can be accessed at, for calculating paths from.
6054     *
6055     * @return mixed|string
6056     */
6057    public static function absolutize_css_urls( $css, $css_file_url ) {
6058        $pattern = '#url\((?P<path>[^)]*)\)#i';
6059        $css_dir = dirname( $css_file_url );
6060        $p       = wp_parse_url( $css_dir );
6061        $domain  = sprintf(
6062            '%1$s//%2$s%3$s%4$s',
6063            isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6064            isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6065            $p['host'],
6066            isset( $p['port'] ) ? ":{$p['port']}" : ''
6067        );
6068
6069        if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6070            $replace = array();
6071            $find    = array();
6072            foreach ( $matches as $match ) {
6073                $url = trim( $match['path'], "'\" \t" );
6074
6075                // If this is a data url, we don't want to mess with it.
6076                if ( str_starts_with( $url, 'data:' ) ) {
6077                    continue;
6078                }
6079
6080                // If this is an absolute or protocol-agnostic url,
6081                // we don't want to mess with it.
6082                if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6083                    continue;
6084                }
6085
6086                switch ( substr( $url, 0, 1 ) ) {
6087                    case '/':
6088                        $absolute = $domain . $url;
6089                        break;
6090                    default:
6091                        $absolute = $css_dir . '/' . $url;
6092                }
6093
6094                $find[]    = $match[0];
6095                $replace[] = sprintf( 'url("%s")', $absolute );
6096            }
6097            $css = str_replace( $find, $replace, $css );
6098        }
6099
6100        return $css;
6101    }
6102
6103    /**
6104     * Check the heartbeat data
6105     *
6106     * Organizes the heartbeat data by severity.  For example, if the site
6107     * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6108     *
6109     * Data will be added to "caution" array, if it either:
6110     *  - Out of date Jetpack version
6111     *  - Out of date WP version
6112     *  - Out of date PHP version
6113     *
6114     * $return array $filtered_data
6115     */
6116    public static function jetpack_check_heartbeat_data() {
6117        /*
6118         * Site environment stats (incl. wp-version/php-version checked below) now live in the Connection package,
6119         * and the IDC stat is contributed by the Connection package's `jetpack_heartbeat_stats_array` filter
6120         * callback. We rebuild the stat here rather than running that filter: the filter's callbacks have side
6121         * effects (Connection\Manager::add_stats_to_heartbeat() consumes and deletes the `xmlrpc_errors` option)
6122         * and return non-scalar values, neither of which is appropriate for this read-only diagnostic.
6123         */
6124        $env_stats = method_exists( Heartbeat::class, 'get_environment_stats' )
6125            ? Heartbeat::get_environment_stats()
6126            : array();
6127        $raw_data  = array_merge(
6128            Jetpack_Heartbeat::generate_stats_array(),
6129            $env_stats,
6130            array( 'identitycrisis' => Identity_Crisis::check_identity_crisis() ? 'yes' : 'no' )
6131        );
6132
6133        $good    = array();
6134        $caution = array();
6135        $bad     = array();
6136
6137        foreach ( $raw_data as $stat => $value ) {
6138
6139            // Check jetpack version.
6140            if ( 'version' === $stat ) {
6141                if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6142                    $caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6143                    continue;
6144                }
6145            }
6146
6147            // Check WP version.
6148            if ( 'wp-version' === $stat ) {
6149                if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6150                    $caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6151                    continue;
6152                }
6153            }
6154
6155            // Check PHP version.
6156            if ( 'php-version' === $stat ) {
6157                if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6158                    $caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6159                    continue;
6160                }
6161            }
6162
6163            // Check ID crisis.
6164            if ( 'identitycrisis' === $stat ) {
6165                if ( 'yes' === $value ) {
6166                    $bad[ $stat ] = $value;
6167                    continue;
6168                }
6169            }
6170
6171            // The rest are good :).
6172            $good[ $stat ] = $value;
6173        }
6174
6175        $filtered_data = array(
6176            'good'    => $good,
6177            'caution' => $caution,
6178            'bad'     => $bad,
6179        );
6180
6181        return $filtered_data;
6182    }
6183
6184    /**
6185     * This method is used to organize all options that can be reset
6186     * without disconnecting Jetpack.
6187     *
6188     * It is used in class.jetpack-cli.php to reset options
6189     *
6190     * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6191     *
6192     * @return array of options to delete.
6193     */
6194    public static function get_jetpack_options_for_reset() {
6195        return Jetpack_Options::get_options_for_reset();
6196    }
6197
6198    /**
6199     * Get the user's meta box order.
6200     *
6201     * @param array $sorted Value for the user's option.
6202     * @return mixed
6203     */
6204    public function get_user_option_meta_box_order_dashboard( $sorted ) {
6205        if ( ! is_array( $sorted ) ) {
6206            return $sorted;
6207        }
6208
6209        foreach ( $sorted as $box_context => $ids ) {
6210            if ( ! str_contains( $ids, 'dashboard_stats' ) ) {
6211                // If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6212                continue;
6213            }
6214
6215            $ids_array = explode( ',', $ids );
6216            $key       = array_search( 'dashboard_stats', $ids_array, true );
6217
6218            if ( false !== $key ) {
6219                // If we've found that exact value in the option (and not `google_dashboard_stats` for example).
6220                $ids_array[ $key ]      = 'jetpack_summary_widget';
6221                $sorted[ $box_context ] = implode( ',', $ids_array );
6222                // We've found it, stop searching, and just return.
6223                break;
6224            }
6225        }
6226
6227        return $sorted;
6228    }
6229    /**
6230     * Checks if Akismet is active and working.
6231     *
6232     * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6233     * that implied usage of methods present since more recent version.
6234     * See https://github.com/Automattic/jetpack/pull/9585
6235     *
6236     * @since  5.1.0
6237     *
6238     * @return bool True = Akismet available. False = Aksimet not available.
6239     */
6240    public static function is_akismet_active() {
6241        static $status = null;
6242
6243        if ( $status !== null ) {
6244            return $status;
6245        }
6246
6247        // Check if a modern version of Akismet is active.
6248        if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6249            $status = false;
6250            return $status;
6251        }
6252
6253        // Make sure there is a key known to Akismet at all before verifying key.
6254        $akismet_key = Akismet::get_api_key();
6255        if ( ! $akismet_key ) {
6256            $status = false;
6257            return $status;
6258        }
6259
6260        // Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6261        $akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6262
6263        // Do not used the cache result in wp-admin or REST API requests if the key isn't valid, in case someone is actively renewing, etc.
6264        $recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6265        // We cache the result of the Akismet key verification for ten minutes.
6266        if ( ! $akismet_key_state || $recheck ) {
6267            $akismet_key_state = Akismet::verify_key( $akismet_key );
6268            set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6269        }
6270
6271        $status = 'valid' === $akismet_key_state;
6272
6273        return $status;
6274    }
6275
6276    /**
6277     * Given a minified path, and a non-minified path, will return
6278     * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6279     *
6280     * Both `$min_base` and `$non_min_base` are expected to be relative to the
6281     * root Jetpack directory.
6282     *
6283     * @since 5.6.0
6284     *
6285     * @param string $min_path Minimized path.
6286     * @param string $non_min_path Non-minimized path.
6287     * @return string The URL to the file
6288     */
6289    public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6290        return Assets::get_file_url_for_environment( $min_path, $non_min_path );
6291    }
6292
6293    /**
6294     * Checks for whether Jetpack Backup is enabled.
6295     * Will return true if the state of Backup is anything except "unavailable".
6296     *
6297     * @return bool|int|mixed
6298     */
6299    public static function is_rewind_enabled() {
6300        // Rewind is a paid feature, therefore requires a user-level connection.
6301        if ( ! static::connection()->has_connected_owner() ) {
6302            return false;
6303        }
6304        $rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6305        $recheck        = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && '0' === $rewind_enabled;
6306        if ( false === $rewind_enabled || $recheck ) {
6307            require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.core-rest-api-endpoints.php';
6308            $rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6309            $rewind_enabled = ( ! is_wp_error( $rewind_data )
6310                && ! empty( $rewind_data['state'] )
6311                && 'active' === $rewind_data['state'] )
6312                ? 1
6313                : 0;
6314            set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
6315        }
6316        return $rewind_enabled;
6317    }
6318
6319    /**
6320     * Return Calypso environment value; used for developing Jetpack and pairing
6321     * it with different Calypso enrionments, such as localhost.
6322     *
6323     * @deprecated 12.4 Moved to the Status package.
6324     *
6325     * @return string Calypso environment
6326     */
6327    public static function get_calypso_env() {
6328        _deprecated_function( __METHOD__, 'jetpack-12.4', '\Automattic\Jetpack\Status\Host->get_calypso_env' );
6329        return ( new Host() )->get_calypso_env();
6330    }
6331
6332    /**
6333     * Returns the hostname with protocol for Calypso.
6334     * Used for developing Jetpack with Calypso.
6335     *
6336     * @since 8.4.0
6337     *
6338     * @return string Calypso host.
6339     */
6340    public static function get_calypso_host() {
6341        $calypso_env = ( new Host() )->get_calypso_env();
6342        switch ( $calypso_env ) {
6343            case 'development':
6344                return 'http://calypso.localhost:3000/';
6345            case 'wpcalypso':
6346                return 'https://wpcalypso.wordpress.com/';
6347            case 'horizon':
6348                return 'https://horizon.wordpress.com/';
6349            default:
6350                return 'https://wordpress.com/';
6351        }
6352    }
6353
6354    /**
6355     * Handles activating default modules as well general cleanup for the new connection.
6356     *
6357     * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
6358     * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
6359     * @param boolean $send_state_messages          Whether to send state messages.
6360     * @return void
6361     */
6362    public static function handle_post_authorization_actions(
6363        $activate_sso = false,
6364        $redirect_on_activation_error = false,
6365        $send_state_messages = true
6366    ) {
6367        $other_modules = $activate_sso
6368            ? array( 'sso' )
6369            : array();
6370
6371        if ( Jetpack_Options::get_option( 'active_modules_initialized' ) ) {
6372            $active_modules = self::get_active_modules();
6373            self::delete_active_modules();
6374
6375            self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
6376        } else {
6377            // Default modules that don't require a user were already activated on site_register.
6378            // This time let's activate only those that require a user, this assures we don't reactivate manually deactivated modules while the site was connected only at a site level.
6379            self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages, null, true );
6380            Jetpack_Options::update_option( 'active_modules_initialized', true );
6381        }
6382
6383        // Since this is a fresh connection, be sure to clear out IDC options.
6384        Identity_Crisis::clear_all_idc_options();
6385
6386        if ( $send_state_messages ) {
6387            self::state( 'message', 'authorized' );
6388        }
6389    }
6390
6391    /**
6392     * Whether UI for backups should be displayed.
6393     *
6394     * On WPCom platforms this is gated on the backups-self-serve site feature.
6395     * On self-hosted Jetpack sites it falls back to the jetpack_show_backups filter.
6396     *
6397     * @return bool Should backups UI be displayed?
6398     */
6399    public static function show_backups_ui() {
6400        if ( ( new \Automattic\Jetpack\Status\Host() )->is_wpcom_platform() ) {
6401            return function_exists( 'wpcom_site_has_feature' ) && wpcom_site_has_feature( 'backups-self-serve' );
6402        }
6403
6404        /**
6405         * Whether UI for backups should be displayed.
6406         *
6407         * @since 6.5.0
6408         *
6409         * @param bool $show_backups Should UI for backups be displayed? True by default.
6410         */
6411        return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
6412    }
6413
6414    /**
6415     * Whether UI for security scanning should be displayed.
6416     *
6417     * On WPCom platforms this is gated on the scan-self-serve site feature.
6418     * On self-hosted Jetpack sites it always returns true.
6419     *
6420     * @return bool Should scan UI be displayed?
6421     */
6422    public static function show_scan_ui() {
6423        if ( ( new \Automattic\Jetpack\Status\Host() )->is_wpcom_platform() ) {
6424            return function_exists( 'wpcom_site_has_feature' ) && wpcom_site_has_feature( 'scan-self-serve' );
6425        }
6426
6427        return true;
6428    }
6429
6430    /**
6431     * Clean leftoveruser meta.
6432     *
6433     * Delete Jetpack-related user meta when it is no longer needed.
6434     *
6435     * @since 7.3.0
6436     *
6437     * @param int $user_id User ID being updated.
6438     */
6439    public static function user_meta_cleanup( $user_id ) {
6440        $meta_keys = array(
6441            // AtD removed from Jetpack 7.3.
6442            'AtD_options',
6443            'AtD_check_when',
6444            'AtD_guess_lang',
6445            'AtD_ignored_phrases',
6446        );
6447
6448        foreach ( $meta_keys as $meta_key ) {
6449            if ( get_user_meta( $user_id, $meta_key ) ) {
6450                delete_user_meta( $user_id, $meta_key );
6451            }
6452        }
6453    }
6454
6455    /**
6456     * Checks if a Jetpack site is both active and not in offline mode.
6457     *
6458     * This is a DRY function to avoid repeating `Jetpack::is_connection_ready && ! Automattic\Jetpack\Status->is_offline_mode`.
6459     *
6460     * @since 8.8.0
6461     *
6462     * @return bool True if Jetpack is active and not in offline mode.
6463     */
6464    public static function is_active_and_not_offline_mode() {
6465        if ( ! self::is_connection_ready() || ( new Status() )->is_offline_mode() ) {
6466            return false;
6467        }
6468        return true;
6469    }
6470
6471    /**
6472     * Returns the list of products that we have available for purchase.
6473     *
6474     * This method will not take current purchases or upgrades into account
6475     * but is instead a static list of products Jetpack offers with some
6476     * corresponding sales text/materials.
6477     *
6478     * @param bool $show_legacy Determine if we should include legacy product/plan details.
6479     * @return array
6480     */
6481    public static function get_products_for_purchase( $show_legacy = false ) {
6482        $products = array();
6483
6484        $products['backup'] = array(
6485            'title'             => __( 'Jetpack Backup', 'jetpack' ),
6486            'slug'              => 'jetpack_backup_t1_yearly',
6487            'description'       => __( 'Never lose a word, image, page, or time worrying about your site with automated backups & one-click restores.', 'jetpack' ),
6488            'show_promotion'    => true,
6489            'discount_percent'  => 50,
6490            'included_in_plans' => array( 'security' ),
6491            'features'          => array(
6492                _x( 'Real-time cloud backups', 'Backup Product Feature', 'jetpack' ),
6493                _x( '10GB of backup storage', 'Backup Product Feature', 'jetpack' ),
6494                _x( '30-day archive & activity log*', 'Backup Product Feature', 'jetpack' ),
6495                _x( 'One-click restores', 'Backup Product Feature', 'jetpack' ),
6496            ),
6497            'disclaimer'        => array(
6498                'text'      => __( '* Subject to your usage and storage limit.', 'jetpack' ),
6499                'link_text' => __( 'Learn more', 'jetpack' ),
6500                'url'       => Redirect::get_url( 'jetpack-faq-backup-disclaimer' ),
6501            ),
6502        );
6503
6504        $products['creator'] = array(
6505            'title'             => __( 'Jetpack Creator', 'jetpack' ),
6506            'slug'              => 'jetpack_creator_yearly',
6507            'description'       => __( 'Craft stunning content, boost your subscriber base, and monetize your online presence.', 'jetpack' ),
6508            'show_promotion'    => true,
6509            'discount_percent'  => 50,
6510            'included_in_plans' => array( 'complete' ),
6511            'features'          => array(
6512                _x( 'Unlimited subscriber imports', 'Creator Product Feature', 'jetpack' ),
6513                _x( 'Earn more from your content', 'Creator Product Feature', 'jetpack' ),
6514                _x( 'Accept payments with PayPal', 'Creator Product Feature', 'jetpack' ),
6515                _x( 'Increase earnings with WordAds', 'Creator Product Feature', 'jetpack' ),
6516            ),
6517        );
6518
6519        $products['growth'] = array(
6520            'title'             => __( 'Jetpack Growth', 'jetpack' ),
6521            'slug'              => 'jetpack_growth_yearly',
6522            'description'       => __( 'Essential tools to help you grow your audience, track visitor engagement, and turn leads into loyal customers and advocates.', 'jetpack' ),
6523            'show_promotion'    => true,
6524            'discount_percent'  => 50,
6525            'included_in_plans' => array( 'complete' ),
6526            'features'          => array(
6527                _x( 'Jetpack Social', 'Growth Product Feature', 'jetpack' ),
6528                _x( 'Jetpack Stats (10K site views, upgradeable)', 'Growth Product Feature', 'jetpack' ),
6529                _x( 'Unlimited subscriber imports', 'Growth Product Feature', 'jetpack' ),
6530                _x( 'Earn more from your content', 'Growth Product Feature', 'jetpack' ),
6531                _x( 'Accept payments with PayPal', 'Growth Product Feature', 'jetpack' ),
6532                _x( 'Increase earnings with WordAds', 'Growth Product Feature', 'jetpack' ),
6533            ),
6534        );
6535
6536        $products['scan'] = array(
6537            'title'             => __( 'Jetpack Scan', 'jetpack' ),
6538            'slug'              => 'jetpack_scan',
6539            'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats and malware.', 'jetpack' ),
6540            'show_promotion'    => true,
6541            'discount_percent'  => 50,
6542            'included_in_plans' => array( 'security' ),
6543            'features'          => array(
6544                _x( 'Automated daily scanning', 'Scan Product Feature', 'jetpack' ),
6545                _x( 'One-click fixes for most issues', 'Scan Product Feature', 'jetpack' ),
6546                _x( 'Instant email notifications', 'Scan Product Feature', 'jetpack' ),
6547                _x( 'Access to latest Firewall rules', 'Scan Product Feature', 'jetpack' ),
6548            ),
6549        );
6550
6551        $products['search'] = array(
6552            'title'             => __( 'Jetpack Site Search', 'jetpack' ),
6553            'slug'              => 'jetpack_search',
6554            'description'       => __( 'Help your site visitors find answers instantly so they keep reading and buying. Great for sites with a lot of content.', 'jetpack' ),
6555            'show_promotion'    => true,
6556            'discount_percent'  => 50,
6557            'included_in_plans' => array(),
6558            'features'          => array(
6559                _x( 'Instant search and indexing', 'Search Product Feature', 'jetpack' ),
6560                _x( 'Powerful filtering', 'Search Product Feature', 'jetpack' ),
6561                _x( 'Supports 38 languages', 'Search Product Feature', 'jetpack' ),
6562                _x( 'Spelling correction', 'Search Product Feature', 'jetpack' ),
6563            ),
6564        );
6565
6566        $products['akismet'] = array(
6567            'title'             => __( 'Akismet Anti-spam', 'jetpack' ),
6568            'slug'              => 'jetpack_anti_spam',
6569            'description'       => __( 'Save time and get better responses by automatically blocking spam from your comments and forms.', 'jetpack' ),
6570            'show_promotion'    => true,
6571            'discount_percent'  => 50,
6572            'included_in_plans' => array( 'security' ),
6573            'features'          => array(
6574                _x( 'Comment and form spam protection', 'Anti-Spam Product Feature', 'jetpack' ),
6575                _x( 'Block spam without CAPTCHAs', 'Anti-Spam Product Feature', 'jetpack' ),
6576                _x( 'Advanced stats', 'Anti-Spam Product Feature', 'jetpack' ),
6577            ),
6578        );
6579
6580        $products['security'] = array(
6581            'title'             => _x( 'Security', 'Jetpack product name', 'jetpack' ),
6582            'slug'              => 'jetpack_security_t1_yearly',
6583            'description'       => __( 'Comprehensive site security, including Backup, Scan, and Anti-spam.', 'jetpack' ),
6584            'show_promotion'    => true,
6585            'discount_percent'  => 50,
6586            'included_in_plans' => array(),
6587            'features'          => array(
6588                _x( 'Real-time cloud backups with 10GB storage', 'Security Tier 1 Feature', 'jetpack' ),
6589                _x( 'Automated real-time malware scan', 'Security Daily Plan Feature', 'jetpack' ),
6590                _x( 'One-click fixes for most threats', 'Security Daily Plan Feature', 'jetpack' ),
6591                _x( 'Comment & form spam protection', 'Security Daily Plan Feature', 'jetpack' ),
6592            ),
6593        );
6594
6595        $products['videopress'] = array(
6596            'title'             => __( 'Jetpack VideoPress', 'jetpack' ),
6597            'slug'              => 'jetpack_videopress',
6598            'description'       => __( 'High-quality, ad-free video built specifically for WordPress.', 'jetpack' ),
6599            'show_promotion'    => true,
6600            'discount_percent'  => 50,
6601            'included_in_plans' => array(),
6602            'features'          => array(
6603                _x( '1TB of storage', 'VideoPress Product Feature', 'jetpack' ),
6604                _x( 'Built into WordPress editor', 'VideoPress Product Feature', 'jetpack' ),
6605                _x( 'Ad-free and customizable player', 'VideoPress Product Feature', 'jetpack' ),
6606                _x( 'Unlimited users', 'VideoPress Product Feature', 'jetpack' ),
6607            ),
6608        );
6609
6610        if ( $show_legacy ) {
6611            $products['jetpack_backup_daily'] = array(
6612                'title'             => __( 'Jetpack Backup', 'jetpack' ),
6613                'slug'              => 'jetpack_backup_daily',
6614                'description'       => __( 'Never lose a word, image, page, or time worrying about your site with automated backups & one-click restores.', 'jetpack' ),
6615                'show_promotion'    => false,
6616                'discount_percent'  => 0,
6617                'included_in_plans' => array(),
6618                'features'          => array(
6619                    _x( 'Automated daily backups (off-site)', 'Backup Product Feature', 'jetpack' ),
6620                    _x( 'One-click restores', 'Backup Product Feature', 'jetpack' ),
6621                    _x( 'Unlimited backup storage', 'Backup Product Feature', 'jetpack' ),
6622                ),
6623            );
6624        }
6625
6626        return $products;
6627    }
6628
6629    /**
6630     * Register product descriptions for partner coupon usage.
6631     *
6632     * @since 10.4.0
6633     *
6634     * @param array $products An array of registered products.
6635     *
6636     * @return array
6637     */
6638    public function get_partner_coupon_product_descriptions( $products ) {
6639        return array_merge( $products, self::get_products_for_purchase( true ) );
6640    }
6641
6642    /**
6643     * Determine if the current user is allowed to make Jetpack purchases without
6644     * a WordPress.com account
6645     *
6646     * @return boolean True if the user can make purchases, false if not
6647     */
6648    public static function current_user_can_purchase() {
6649
6650        // The site must be site-connected to Jetpack (no users connected).
6651        if ( ! self::connection()->is_site_connection() ) {
6652            return false;
6653        }
6654
6655        // Make sure only administrators can make purchases.
6656        if ( ! current_user_can( 'manage_options' ) ) {
6657            return false;
6658        }
6659
6660        return true;
6661    }
6662
6663    /**
6664     * Add 5-star review link on the Jetpack Plugin meta, in the plugins list table (on the plugins page).
6665     *
6666     * @param array  $plugin_meta An array of the plugin's metadata.
6667     * @param string $plugin_file Path to the plugin file.
6668     *
6669     * @return array $plugin_meta An array of the plugin's metadata.
6670     */
6671    public function add_5_star_review_link( $plugin_meta, $plugin_file ) {
6672        if ( $plugin_file !== 'jetpack/jetpack.php' ) {
6673            return $plugin_meta;
6674        }
6675
6676        $u    = get_current_user_id();
6677        $site = get_site_url();
6678
6679        $plugin_meta[] = '<a href="https://jetpack.com/redirect?source=jetpack-plugin-review&site=' . esc_attr( $site ) . '&u=' . esc_attr( $u ) . '" target="_blank" rel="noopener noreferrer" title="' . esc_attr__( 'Rate Jetpack on WordPress.org', 'jetpack' ) . '" style="color: #ffb900">'
6680            . str_repeat( '<span class="dashicons dashicons-star-filled" style="font-size: 16px; width:16px; height: 16px"></span>', 5 )
6681            . '</a>';
6682
6683        return $plugin_meta;
6684    }
6685
6686    /**
6687     * Lazy instantiation of the Plugin_Tracking object.
6688     *
6689     * @since 13.9
6690     *
6691     * @return void
6692     */
6693    public function initialize_tracking() {
6694        if ( did_action( 'jetpack_initialize_tracking' ) > 1 ) {
6695            // Only need to run once.
6696            return;
6697        }
6698
6699        if ( ( new Tracking( 'jetpack', $this->connection_manager ) )->should_enable_tracking( new Terms_Of_Service(), new Status() ) || static::is_connection_ready() ) {
6700            ( new Plugin_Tracking() )->init();
6701        }
6702    }
6703
6704    /**
6705     * Run the "initialize tracking" hook.
6706     *
6707     * @since 13.9
6708     */
6709    public function run_initialize_tracking_action() {
6710        /**
6711         * Fires when the tracking needs to be initialized.
6712         * Doesn't necessarily mean that will actually happen, depends if the 'jetpack_tos_agreed' option is set.
6713         *
6714         * @since 13.9
6715         */
6716        do_action( 'jetpack_initialize_tracking' );
6717    }
6718
6719    /**
6720     * Initialize REST jsonAPI if needed.
6721     *
6722     * @return void
6723     */
6724    public function maybe_initialize_rest_jsonapi() {
6725        // phpcs:ignore WordPress.Security.NonceVerification.Recommended
6726        if ( ! empty( $_GET['jsonapi'] ) && ( ! defined( 'IS_WPCOM' ) || ! IS_WPCOM ) ) {
6727            require_once ABSPATH . 'wp-admin/includes/admin.php'; // JSON API relies on WP functionality not autoloaded in REST.
6728
6729            define( 'WPCOM_JSON_API__BASE', 'public-api.wordpress.com/rest/v1' );
6730            require_once JETPACK__PLUGIN_DIR . 'class.json-api-endpoints.php';
6731        }
6732    }
6733
6734    /**
6735     * Run plugin post-activation actions if we need to.
6736     *
6737     * @return void
6738     */
6739    private function plugin_post_activation() {
6740        if ( ( new Status() )->is_offline_mode() ) {
6741            return;
6742        }
6743
6744        if ( get_transient( 'activated_jetpack' ) ) {
6745            delete_transient( 'activated_jetpack' );
6746
6747            if ( ( new Host() )->is_woa_site() ) {
6748                $redirect_url = static::admin_url( 'page=jetpack' );
6749            } elseif ( is_network_admin() ) {
6750                $redirect_url = admin_url( 'network/admin.php?page=jetpack' );
6751            } elseif ( get_transient( 'my_jetpack_product_activated' ) ) {
6752                // don't redirect if this is an activation that just came from My Jetpack
6753                // My Jetpack has its own set of post-activation redirects
6754                return;
6755            } elseif ( My_Jetpack_Initializer::should_initialize() ) {
6756                $redirect_url = static::admin_url( 'page=my-jetpack' );
6757            } else {
6758                $redirect_url = static::admin_url( 'page=jetpack' );
6759            }
6760
6761            wp_safe_redirect( $redirect_url );
6762        }
6763    }
6764}