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