Completed
Push — fix/podcast-player-link-error-... ( b24311...d8cf64 )
by
unknown
88:09 queued 81:00
created

Jetpack   F

Complexity

Total Complexity 1044

Size/Duplication

Total Lines 7276
Duplicated Lines 5.44 %

Coupling/Cohesion

Components 4
Dependencies 36

Importance

Changes 0
Metric Value
wmc 1044
lcom 4
cbo 36
dl 396
loc 7276
rs 0.8
c 0
b 0
f 0

262 Methods

Rating   Name   Duplication   Size   Complexity  
A build_stats_url() 0 20 1
A xmlrpc_api_url() 0 4 1
A enable_module_configurable() 0 4 1
C get_activation_source() 0 49 14
A module_configuration_url() 0 14 1
A staticize_subdomain() 0 35 4
A login_form_json_api_authorization() 0 9 1
A jetpack_icon_user_connected() 0 4 1
A log() 0 40 3
B get_log() 0 36 11
A log_settings_change() 0 7 2
A get_stat_data() 0 14 3
A get_additional_stat_data() 0 11 2
A get_site_user_count() 0 15 4
A init() 0 8 2
A user_role_change() 0 4 1
D load_modules() 6 88 17
A check_rest_api_compat() 0 18 3
A get_active_plugins() 0 16 3
A get_parsed_plugin_data() 0 21 3
A get_parsed_theme_data() 0 22 3
A is_plugin_active() 0 3 1
B check_open_graph() 0 27 7
A check_twitter_tags() 0 24 5
A submit_security_report() 0 3 1
A get_option_names() 0 3 1
A get_option() 0 3 1
A update_option() 0 4 1
A update_options() 0 4 1
A delete_option() 0 4 1
A update_user_token() 0 4 1
B glob_php() 0 29 7
C activate_new_modules() 6 58 11
C get_available_modules() 0 60 13
B get_default_modules() 0 31 6
B handle_deprecated_modules() 0 27 8
B filter_default_modules() 0 24 6
A get_module_slug() 0 3 1
A get_module_path() 0 11 1
D get_module() 12 89 11
B get_file_data() 0 33 7
A translate_module_tag() 0 3 1
A get_i18n_data_json() 0 25 4
A setup_wp_i18n_locale_data() 0 10 2
A get_translated_modules() 0 13 4
B get_active_modules() 0 32 7
A is_module_active() 0 3 1
A is_module() 0 3 2
A catch_errors() 0 13 2
A catch_errors_on_shutdown() 0 3 1
A alias_directories() 0 8 1
F activate_default_modules() 21 166 36
D activate_module() 0 93 17
A activate_module_actions() 0 3 1
A deactivate_module() 0 17 1
B bail_on_activation() 0 40 5
A plugin_activation() 0 20 3
A do_version_bump() 0 5 2
A plugin_initialize() 6 17 3
A plugin_deactivation() 0 9 2
B disconnect() 0 46 6
A unlink_user() 0 4 1
B try_registration() 0 31 7
B admin_init() 0 45 11
A admin_body_class() 0 8 2
A add_jetpack_pagestyles() 0 3 1
B throw_error_on_activate_plugin() 0 24 7
A intercept_plugin_error_scrape_init() 0 3 1
A intercept_plugin_error_scrape() 0 11 4
B add_remote_request_handlers() 0 29 7
B remote_request_handlers() 0 40 7
F upload_handler() 0 131 24
A admin_help() 0 41 2
A admin_menu_css() 0 3 1
A admin_menu_order() 0 3 1
A jetpack_menu_order() 15 15 4
A admin_banner_styles() 8 21 4
A plugin_action_links() 0 15 4
F plugin_upgrade() 0 71 15
A upgrade_on_load() 0 30 5
A update_active_modules() 0 53 3
A delete_active_modules() 0 3 1
A add_configure_hook() 0 21 4
B __construct() 0 126 4
C configure() 0 74 11
A late_initialization() 0 18 1
A setup_xmlrpc_handlers() 19 19 2
A initialize_rest_api_registration_connector() 9 9 2
A add_wpcom_to_allowed_redirect_hosts() 0 3 1
A allow_wpcom_domain() 0 7 2
A point_edit_post_links_to_calypso() 0 28 3
A point_edit_comment_links_to_calypso() 0 11 1
A jetpack_track_last_sync_callback() 0 22 5
A jetpack_connection_banner_callback() 0 10 2
A remove_non_jetpack_xmlrpc_methods() 9 9 2
A alternate_xmlrpc() 9 9 2
A jetpack_jitm_ajax_callback() 0 3 1
A push_stats() 0 5 2
D jetpack_custom_caps() 0 73 21
A require_jetpack_authentication() 9 9 2
A plugin_textdomain() 0 4 1
B register_assets() 27 80 8
C guess_locale_from_lang() 39 39 12
A get_locale() 0 9 2
A jetpack_main_network_site_option() 0 3 1
A network_name() 0 4 1
A network_allow_new_registrations() 0 3 2
A network_add_new_users() 0 3 1
A network_site_upload_space() 0 4 2
A network_upload_file_types() 0 3 1
A network_max_upload_file_size() 0 4 1
A network_enable_administration_menus() 0 3 1
A maybe_clear_other_linked_admins_transient() 0 8 5
B get_other_linked_admins() 0 28 7
A is_main_network_option() 0 4 1
A is_multisite() 0 3 1
A is_multi_network() 15 15 3
A update_jetpack_main_network_site_option() 0 3 1
A update_jetpack_network_settings() 0 4 1
A is_single_user_site() 9 9 2
A file_system_write_access() 0 20 4
A is_version_controlled() 0 4 1
A featured_images_enabled() 0 4 2
A get_avatar_url() 0 11 1
A get_updates() 6 17 6
A get_update_details() 0 8 1
A refresh_update_data() 0 4 1
A refresh_theme_data() 0 3 1
A is_active() 0 3 1
A refresh_active_plan_from_wpcom() 0 4 1
A get_active_plan() 0 4 1
A active_plan_supports() 0 4 1
A is_development_mode() 0 3 1
A is_onboarding() 0 3 1
A development_mode_trigger_text() 0 16 6
A show_development_mode_notice() 0 28 4
A is_development_version() 0 15 1
A is_user_connected() 0 3 1
A get_connected_user_data() 26 26 4
A get_connected_user_email() 16 16 3
A get_master_user_email() 0 7 2
A current_user_is_connection_owner() 0 4 1
A current_user_ip() 0 20 5
A login_url() 0 7 2
A login_init() 0 17 2
B admin_notices() 0 125 7
A track_xmlrpc_error() 0 15 4
A stat() 0 6 2
B do_stats() 0 15 7
A do_server_side_stat() 0 12 3
A translate_current_user_to_role() 0 6 1
A translate_user_to_role() 0 6 1
A translate_role_to_cap() 0 6 1
A sign_role() 0 4 1
C build_connect_url() 0 62 12
A build_authorize_url() 0 23 3
B filter_connect_request_body() 0 30 6
A filter_connect_processing_url() 0 4 1
A filter_connect_redirect_url() 0 12 3
A authorize_starting() 0 24 2
A authorize_ending_linked() 0 4 1
A authorize_ending_authorized() 0 20 3
A get_assumed_site_creation_date() 0 4 1
A apply_activation_source_to_args() 11 11 3
A build_reconnect_url() 0 4 2
A admin_url() 0 5 1
A nonce_url_no_esc() 0 4 1
A dismiss_jetpack_notice() 0 17 5
A sort_modules() 0 7 3
A ajax_recheck_ssl() 0 10 1
A api_url() 0 5 1
A fix_url_for_bad_hosts() 0 4 1
C verify_onboarding_token() 0 45 15
A create_onboarding_token() 0 8 2
A invalidate_onboarding_token() 0 3 1
A validate_onboarding_token_action() 0 18 3
B permit_ssl() 0 42 11
A alert_auto_ssl_fail() 0 54 2
A connection() 0 10 2
A generate_secrets() 0 3 1
A get_secrets() 0 13 3
A delete_secrets() 0 3 1
A get_remote_query_timeout_limit() 0 4 1
A get_max_execution_time() 0 9 2
A set_min_time_limit() 8 8 2
A validate_remote_register_response() 0 3 1
A register() 0 17 3
A filter_register_request_body() 12 12 1
A filter_token_request_body() 12 12 1
A maybe_set_version_option() 0 14 3
A load_xml_rpc_client() 0 3 1
A reset_saved_auth_state() 0 9 2
A verify_xml_rpc_signature() 0 4 1
A internal_verify_xml_rpc_signature() 0 3 1
A authenticate_jetpack() 9 9 2
C wp_rest_authenticate() 0 74 16
A wp_rest_authentication_errors() 0 6 2
A add_nonce() 9 9 2
A xmlrpc_methods() 9 9 2
A public_xmlrpc_methods() 9 9 2
A jetpack_getOptions() 9 9 2
A xmlrpc_options() 9 9 2
A clean_nonces() 0 4 1
D state() 0 54 19
A restate() 0 3 1
B check_privacy() 0 34 6
C xmlrpc_async_call() 0 39 12
A post_login_form_to_signed_url() 0 14 5
A preserve_action_in_login_form_for_json_api_authorization() 0 4 1
A store_json_api_authorization_token() 0 6 1
A allow_wpcom_public_api_domain() 0 4 1
A is_redirect_encoded() 0 3 1
A allow_wpcom_environments() 0 7 1
A add_token_to_login_redirect_json_api_authorization() 0 12 1
F verify_json_api_authorization_request() 0 121 23
A login_message_json_api_authorization() 0 6 1
A get_content_width() 0 13 3
A get_cloud_site_options() 0 15 2
A check_identity_crisis() 0 7 4
A is_staging_site() 0 4 1
C validate_sync_error_idc_option() 0 48 17
A normalize_url_protocol_agnostic() 0 10 4
A get_sync_error_idc_option() 0 32 5
A sync_idc_optin() 0 18 3
B maybe_min_asset() 0 42 8
A set_suffix_on_min() 0 16 5
C maybe_inline_style() 0 50 13
A load_view() 0 11 2
B deprecated_hooks() 0 88 6
B absolutize_css_urls() 0 44 9
B implode_frontend_css() 0 57 10
A concat_remove_style_loader_tag() 0 10 4
A script_add_async() 0 7 2
B jetpack_check_heartbeat_data() 0 53 10
A get_jetpack_options_for_reset() 0 3 1
A build_raw_urls() 0 6 1
B dns_prefetch() 0 17 7
A wp_dashboard_setup() 0 35 5
A get_user_option_meta_box_order_dashboard() 0 25 5
A dashboard_widget() 0 8 1
B dashboard_widget_footer() 0 68 7
A jetpack_show_user_connected_icon() 0 13 3
A jetpack_user_col_style() 0 19 3
B is_akismet_active() 0 35 9
A is_function_in_backtrace() 0 3 1
A get_file_url_for_environment() 0 3 1
A is_rewind_enabled() 0 19 6
A get_calypso_env() 0 15 5
A get_calypso_host() 0 13 4
A jetpack_tos_agreed() 0 7 1
A handle_post_authorization_actions() 0 24 4
A show_backups_ui() 0 10 2
A prepare_manage_jetpack_notice() 0 3 1
A manage_activate_screen() 0 3 1
A admin_jetpack_manage_notice() 0 3 1
A opt_out_jetpack_manage_url() 0 3 1
A opt_in_jetpack_manage_url() 0 3 1
A opt_in_jetpack_manage_notice() 0 3 1
A can_display_jetpack_manage_notice() 0 3 1
A user_meta_cleanup() 0 15 3
A is_active_and_not_development_mode() 0 6 3
F admin_page_load() 32 277 55

How to fix   Duplicated Code    Complexity   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Jetpack often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Jetpack, and based on these observations, apply Extract Interface, too.

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
8
use Automattic\Jetpack\Constants;
9
use Automattic\Jetpack\Partner;
10
use Automattic\Jetpack\Roles;
11
use Automattic\Jetpack\Status;
12
use Automattic\Jetpack\Sync\Functions;
13
use Automattic\Jetpack\Sync\Health;
14
use Automattic\Jetpack\Sync\Sender;
15
use Automattic\Jetpack\Sync\Users;
16
use Automattic\Jetpack\Terms_Of_Service;
17
use Automattic\Jetpack\Tracking;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
20
/*
21
Options:
22
jetpack_options (array)
23
	An array of options.
24
	@see Jetpack_Options::get_option_names()
25
26
jetpack_register (string)
27
	Temporary verification secrets.
28
29
jetpack_activated (int)
30
	1: the plugin was activated normally
31
	2: the plugin was activated on this site because of a network-wide activation
32
	3: the plugin was auto-installed
33
	4: the plugin was manually disconnected (but is still installed)
34
35
jetpack_active_modules (array)
36
	Array of active module slugs.
37
38
jetpack_do_activate (bool)
39
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
40
*/
41
42
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
43
44
class Jetpack {
45
	public $xmlrpc_server = null;
46
47
	private $rest_authentication_status = null;
48
49
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
50
51
	/**
52
	 * @var array The handles of styles that are concatenated into jetpack.css.
53
	 *
54
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
55
	 */
56
	public $concatenated_style_handles = array(
57
		'jetpack-carousel',
58
		'grunion.css',
59
		'the-neverending-homepage',
60
		'jetpack_likes',
61
		'jetpack_related-posts',
62
		'sharedaddy',
63
		'jetpack-slideshow',
64
		'presentations',
65
		'quiz',
66
		'jetpack-subscriptions',
67
		'jetpack-responsive-videos-style',
68
		'jetpack-social-menu',
69
		'tiled-gallery',
70
		'jetpack_display_posts_widget',
71
		'gravatar-profile-widget',
72
		'goodreads-widget',
73
		'jetpack_social_media_icons_widget',
74
		'jetpack-top-posts-widget',
75
		'jetpack_image_widget',
76
		'jetpack-my-community-widget',
77
		'jetpack-authors-widget',
78
		'wordads',
79
		'eu-cookie-law-style',
80
		'flickr-widget-style',
81
		'jetpack-search-widget',
82
		'jetpack-simple-payments-widget-style',
83
		'jetpack-widget-social-icons-styles',
84
	);
85
86
	/**
87
	 * The handles of scripts that can be loaded asynchronously.
88
	 *
89
	 * @var array
90
	 */
91
	public $async_script_handles = array(
92
		'woocommerce-analytics',
93
	);
94
95
	/**
96
	 * Contains all assets that have had their URL rewritten to minified versions.
97
	 *
98
	 * @var array
99
	 */
100
	static $min_assets = array();
101
102
	public $plugins_to_deactivate = array(
103
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
104
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
105
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
106
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
107
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
108
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
109
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
110
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
111
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
112
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
113
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
114
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
115
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
116
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
117
	);
118
119
	/**
120
	 * Map of roles we care about, and their corresponding minimum capabilities.
121
	 *
122
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
123
	 *
124
	 * @access public
125
	 * @static
126
	 *
127
	 * @var array
128
	 */
129
	public static $capability_translations = array(
130
		'administrator' => 'manage_options',
131
		'editor'        => 'edit_others_posts',
132
		'author'        => 'publish_posts',
133
		'contributor'   => 'edit_posts',
134
		'subscriber'    => 'read',
135
	);
136
137
	/**
138
	 * Map of modules that have conflicts with plugins and should not be auto-activated
139
	 * if the plugins are active.  Used by filter_default_modules
140
	 *
141
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
142
	 * change `module-slug` and add this to your plugin:
143
	 *
144
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
145
	 * function my_jetpack_get_default_modules( $modules ) {
146
	 *     return array_diff( $modules, array( 'module-slug' ) );
147
	 * }
148
	 *
149
	 * @var array
150
	 */
151
	private $conflicting_plugins = array(
152
		'comments'           => array(
153
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
154
			'Disqus'                         => 'disqus-comment-system/disqus.php',
155
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
156
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
157
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
158
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
159
		),
160
		'comment-likes'      => array(
161
			'Epoch' => 'epoch/plugincore.php',
162
		),
163
		'contact-form'       => array(
164
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
165
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
166
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
167
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
168
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
169
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
170
		),
171
		'latex'              => array(
172
			'LaTeX for WordPress'     => 'latex/latex.php',
173
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
174
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
175
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
176
			'Enable Latex'            => 'enable-latex/enable-latex.php',
177
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
178
		),
179
		'protect'            => array(
180
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
181
			'Captcha'                           => 'captcha/captcha.php',
182
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
183
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
184
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
185
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
186
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
187
			'Security-protection'               => 'security-protection/security-protection.php',
188
			'Login Security'                    => 'login-security/login-security.php',
189
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
190
			'Wordfence Security'                => 'wordfence/wordfence.php',
191
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
192
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
193
		),
194
		'random-redirect'    => array(
195
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
196
		),
197
		'related-posts'      => array(
198
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
199
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
200
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
201
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
202
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
203
			'outbrain'                    => 'outbrain/outbrain.php',
204
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
205
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
206
		),
207
		'sharedaddy'         => array(
208
			'AddThis'     => 'addthis/addthis_social_widget.php',
209
			'Add To Any'  => 'add-to-any/add-to-any.php',
210
			'ShareThis'   => 'share-this/sharethis.php',
211
			'Shareaholic' => 'shareaholic/shareaholic.php',
212
		),
213
		'seo-tools'          => array(
214
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
215
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
216
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
217
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
218
			'The SEO Framework'              => 'autodescription/autodescription.php',
219
		),
220
		'verification-tools' => array(
221
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
222
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
223
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
224
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
225
			'The SEO Framework'              => 'autodescription/autodescription.php',
226
		),
227
		'widget-visibility'  => array(
228
			'Widget Logic'    => 'widget-logic/widget_logic.php',
229
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
230
		),
231
		'sitemaps'           => array(
232
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
233
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
234
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
235
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
236
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
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
			'Sitemap'                              => 'sitemap/sitemap.php',
243
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
244
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
245
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
246
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
247
		),
248
		'lazy-images'        => array(
249
			'Lazy Load'              => 'lazy-load/lazy-load.php',
250
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
251
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
252
		),
253
	);
254
255
	/**
256
	 * Plugins for which we turn off our Facebook OG Tags implementation.
257
	 *
258
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
259
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
260
	 *
261
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
262
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
263
	 */
264
	private $open_graph_conflicting_plugins = array(
265
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
266
		// 2 Click Social Media Buttons
267
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
268
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
269
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
270
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
271
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
272
		// Open Graph Meta Tags by Heateor
273
		'facebook/facebook.php',                                 // Facebook (official plugin)
274
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
275
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
276
		// Facebook Featured Image & OG Meta Tags
277
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
278
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
279
		// Facebook Open Graph Meta Tags for WordPress
280
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
281
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
282
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
283
		// Fedmich's Facebook Open Graph Meta
284
		'network-publisher/networkpub.php',                      // Network Publisher
285
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
286
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
287
		// NextScripts SNAP
288
		'og-tags/og-tags.php',                                   // OG Tags
289
		'opengraph/opengraph.php',                               // Open Graph
290
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
291
		// Open Graph Protocol Framework
292
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
293
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
294
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
295
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
296
		'sharepress/sharepress.php',                             // SharePress
297
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
298
		'social-discussions/social-discussions.php',             // Social Discussions
299
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
300
		'socialize/socialize.php',                               // Socialize
301
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
302
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
303
		// Tweet, Like, Google +1 and Share
304
		'wordbooker/wordbooker.php',                             // Wordbooker
305
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
306
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
307
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
308
		// WP Facebook Like Send & Open Graph Meta
309
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
310
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
311
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
312
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
313
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
314
	);
315
316
	/**
317
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
318
	 */
319
	private $twitter_cards_conflicting_plugins = array(
320
		// 'twitter/twitter.php',                       // The official one handles this on its own.
321
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
322
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
323
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
324
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
325
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
326
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
327
		'twitter-cards/twitter-cards.php',           // Twitter Cards
328
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
329
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
330
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
331
	);
332
333
	/**
334
	 * Message to display in admin_notice
335
	 *
336
	 * @var string
337
	 */
338
	public $message = '';
339
340
	/**
341
	 * Error to display in admin_notice
342
	 *
343
	 * @var string
344
	 */
345
	public $error = '';
346
347
	/**
348
	 * Modules that need more privacy description.
349
	 *
350
	 * @var string
351
	 */
352
	public $privacy_checks = '';
353
354
	/**
355
	 * Stats to record once the page loads
356
	 *
357
	 * @var array
358
	 */
359
	public $stats = array();
360
361
	/**
362
	 * Jetpack_Sync object
363
	 */
364
	public $sync;
365
366
	/**
367
	 * Verified data for JSON authorization request
368
	 */
369
	public $json_api_authorization_request = array();
370
371
	/**
372
	 * @var Automattic\Jetpack\Connection\Manager
373
	 */
374
	protected $connection_manager;
375
376
	/**
377
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
378
	 */
379
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
380
381
	/**
382
	 * Constant for login redirect key.
383
	 *
384
	 * @var string
385
	 * @since 8.4.0
386
	 */
387
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
388
389
	/**
390
	 * Holds the singleton instance of this class
391
	 *
392
	 * @since 2.3.3
393
	 * @var Jetpack
394
	 */
395
	static $instance = false;
396
397
	/**
398
	 * Singleton
399
	 *
400
	 * @static
401
	 */
402
	public static function init() {
403
		if ( ! self::$instance ) {
404
			self::$instance = new Jetpack();
405
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
406
		}
407
408
		return self::$instance;
409
	}
410
411
	/**
412
	 * Must never be called statically
413
	 */
414
	function plugin_upgrade() {
415
		if ( self::is_active() ) {
416
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
417
			if ( JETPACK__VERSION != $version ) {
418
				// Prevent multiple upgrades at once - only a single process should trigger
419
				// an upgrade to avoid stampedes
420
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
421
					return;
422
				}
423
424
				// Set a short lock to prevent multiple instances of the upgrade
425
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
426
427
				// check which active modules actually exist and remove others from active_modules list
428
				$unfiltered_modules = self::get_active_modules();
429
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
430
				if ( array_diff( $unfiltered_modules, $modules ) ) {
431
					self::update_active_modules( $modules );
432
				}
433
434
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
435
436
				// Upgrade to 4.3.0
437
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
438
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
439
				}
440
441
				// Make sure Markdown for posts gets turned back on
442
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
443
					update_option( 'wpcom_publish_posts_with_markdown', true );
444
				}
445
446
				/*
447
				 * Minileven deprecation. 8.3.0.
448
				 * Only delete options if not using
449
				 * the replacement standalone Minileven plugin.
450
				 */
451
				if (
452
					! self::is_plugin_active( 'minileven-master/minileven.php' )
453
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
454
				) {
455
					if ( get_option( 'wp_mobile_custom_css' ) ) {
456
						delete_option( 'wp_mobile_custom_css' );
457
					}
458
					if ( get_option( 'wp_mobile_excerpt' ) ) {
459
						delete_option( 'wp_mobile_excerpt' );
460
					}
461
					if ( get_option( 'wp_mobile_featured_images' ) ) {
462
						delete_option( 'wp_mobile_featured_images' );
463
					}
464
					if ( get_option( 'wp_mobile_app_promos' ) ) {
465
						delete_option( 'wp_mobile_app_promos' );
466
					}
467
				}
468
469
				// Upgrade to 8.4.0.
470
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
471
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
472
				}
473
474
				if ( did_action( 'wp_loaded' ) ) {
475
					self::upgrade_on_load();
476
				} else {
477
					add_action(
478
						'wp_loaded',
479
						array( __CLASS__, 'upgrade_on_load' )
480
					);
481
				}
482
			}
483
		}
484
	}
485
486
	/**
487
	 * Runs upgrade routines that need to have modules loaded.
488
	 */
489
	static function upgrade_on_load() {
490
491
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
492
		// This can happen in case Jetpack has been just upgraded and is
493
		// being initialized late during the page load. In this case we wait
494
		// until the next proper admin page load with Jetpack active.
495
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
496
			delete_transient( self::$plugin_upgrade_lock_key );
497
498
			return;
499
		}
500
501
		self::maybe_set_version_option();
502
503
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
504
			Jetpack_Widget_Conditions::migrate_post_type_rules();
505
		}
506
507
		if (
508
			class_exists( 'Jetpack_Sitemap_Manager' )
509
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
510
		) {
511
			do_action( 'jetpack_sitemaps_purge_data' );
512
		}
513
514
		// Delete old stats cache
515
		delete_option( 'jetpack_restapi_stats_cache' );
516
517
		delete_transient( self::$plugin_upgrade_lock_key );
518
	}
519
520
	/**
521
	 * Saves all the currently active modules to options.
522
	 * Also fires Action hooks for each newly activated and deactivated module.
523
	 *
524
	 * @param $modules Array Array of active modules to be saved in options.
525
	 *
526
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
Documentation introduced by
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
527
	 */
528
	static function update_active_modules( $modules ) {
529
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
530
		$active_modules       = self::get_active_modules();
531
		$new_active_modules   = array_diff( $modules, $current_modules );
532
		$new_inactive_modules = array_diff( $active_modules, $modules );
533
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
534
		$reindexed_modules    = array_values( $new_current_modules );
535
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
536
537
		foreach ( $new_active_modules as $module ) {
538
			/**
539
			 * Fires when a specific module is activated.
540
			 *
541
			 * @since 1.9.0
542
			 *
543
			 * @param string $module Module slug.
544
			 * @param boolean $success whether the module was activated. @since 4.2
545
			 */
546
			do_action( 'jetpack_activate_module', $module, $success );
547
			/**
548
			 * Fires when a module is activated.
549
			 * The dynamic part of the filter, $module, is the module slug.
550
			 *
551
			 * @since 1.9.0
552
			 *
553
			 * @param string $module Module slug.
554
			 */
555
			do_action( "jetpack_activate_module_$module", $module );
556
		}
557
558
		foreach ( $new_inactive_modules as $module ) {
559
			/**
560
			 * Fired after a module has been deactivated.
561
			 *
562
			 * @since 4.2.0
563
			 *
564
			 * @param string $module Module slug.
565
			 * @param boolean $success whether the module was deactivated.
566
			 */
567
			do_action( 'jetpack_deactivate_module', $module, $success );
568
			/**
569
			 * Fires when a module is deactivated.
570
			 * The dynamic part of the filter, $module, is the module slug.
571
			 *
572
			 * @since 1.9.0
573
			 *
574
			 * @param string $module Module slug.
575
			 */
576
			do_action( "jetpack_deactivate_module_$module", $module );
577
		}
578
579
		return $success;
580
	}
581
582
	static function delete_active_modules() {
583
		self::update_active_modules( array() );
584
	}
585
586
	/**
587
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
588
	 * available.
589
	 */
590
	public function add_configure_hook() {
591
		global $wp_filter;
592
593
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
594
		if ( false !== $current_priority ) {
595
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
596
		}
597
598
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
599
		sort( $taken_priorities );
600
601
		$first_priority = array_shift( $taken_priorities );
602
603
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
604
			$new_priority = - PHP_INT_MAX;
605
		} else {
606
			$new_priority = $first_priority - 1;
607
		}
608
609
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
610
	}
611
612
	/**
613
	 * Constructor.  Initializes WordPress hooks
614
	 */
615
	private function __construct() {
616
		/*
617
		 * Check for and alert any deprecated hooks
618
		 */
619
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
620
621
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
622
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
623
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
624
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
625
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
626
627
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
628
629
		add_filter(
630
			'jetpack_signature_check_token',
631
			array( __CLASS__, 'verify_onboarding_token' ),
632
			10,
633
			3
634
		);
635
636
		/**
637
		 * Prepare Gutenberg Editor functionality
638
		 */
639
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
640
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
641
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
642
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
643
644
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
645
646
		// Unlink user before deleting the user from WP.com.
647
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
648
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
649
650
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
651
652
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
653
		add_action( 'login_init', array( $this, 'login_init' ) );
654
655
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
656
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
657
658
		add_action( 'admin_init', array( $this, 'admin_init' ) );
659
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
660
661
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
662
663
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
664
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
665
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
666
667
		// returns HTTPS support status
668
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
669
670
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
671
672
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
673
674
		/**
675
		 * These actions run checks to load additional files.
676
		 * They check for external files or plugins, so they need to run as late as possible.
677
		 */
678
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
679
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
680
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
681
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
682
683
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
684
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
685
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
686
687
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
688
689
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
690
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
691
692
		// A filter to control all just in time messages
693
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
694
695
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
696
697
		// Hide edit post link if mobile app.
698
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
699
			add_filter( 'get_edit_post_link', '__return_empty_string' );
700
		}
701
702
		// Update the Jetpack plan from API on heartbeats
703
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
704
705
		/**
706
		 * This is the hack to concatenate all css files into one.
707
		 * For description and reasoning see the implode_frontend_css method
708
		 *
709
		 * Super late priority so we catch all the registered styles
710
		 */
711
		if ( ! is_admin() ) {
712
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
713
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
714
		}
715
716
		/**
717
		 * These are sync actions that we need to keep track of for jitms
718
		 */
719
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
720
721
		// Actually push the stats on shutdown.
722
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
723
			add_action( 'shutdown', array( $this, 'push_stats' ) );
724
		}
725
726
		/*
727
		 * Load some scripts asynchronously.
728
		 */
729
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
730
731
		// Actions for Manager::authorize().
732
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
733
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
734
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
735
736
		// Filters for the Manager::get_token() urls and request body.
737
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
738
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
739
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
740
	}
741
742
	/**
743
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
744
	 * Config object.
745
	 */
746
	public function configure() {
747
		$config = new Config();
748
749
		foreach (
750
			array(
751
				'connection',
752
				'sync',
753
				'tracking',
754
				'tos',
755
			)
756
			as $feature
757
		) {
758
			$config->ensure( $feature );
759
		}
760
761
		if ( is_admin() ) {
762
			$config->ensure( 'jitm' );
763
		}
764
765
		if ( ! $this->connection_manager ) {
766
			$this->connection_manager = new Connection_Manager();
767
		}
768
769
		/*
770
		 * Load things that should only be in Network Admin.
771
		 *
772
		 * For now blow away everything else until a more full
773
		 * understanding of what is needed at the network level is
774
		 * available
775
		 */
776
		if ( is_multisite() ) {
777
			$network = Jetpack_Network::init();
778
			$network->set_connection( $this->connection_manager );
779
		}
780
781
		if ( $this->connection_manager->is_active() ) {
782
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
783
784
			Jetpack_Heartbeat::init();
785
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
786
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
787
				Jetpack_Search_Performance_Logger::init();
788
			}
789
		}
790
791
		// Initialize remote file upload request handlers.
792
		$this->add_remote_request_handlers();
793
794
		/*
795
		 * Enable enhanced handling of previewing sites in Calypso
796
		 */
797
		if ( self::is_active() ) {
798
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
799
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
800
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
801
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
802
		}
803
804
		/*
805
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
806
		 * We should make sure to only do this for front end links.
807
		 */
808
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
809
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
810
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
811
812
			/*
813
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
814
			 * so they point moderation links on emails to Calypso.
815
			 */
816
			jetpack_require_lib( 'functions.wp-notify' );
817
		}
818
819
	}
820
821
	/**
822
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
823
	 * initialization code.
824
	 *
825
	 * @action plugins_loaded
826
	 */
827
	public function late_initialization() {
828
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
829
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
830
831
		Partner::init();
832
833
		/**
834
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
835
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
836
		 *
837
		 * @since 8.1.0
838
		 *
839
		 * @param Jetpack $jetpack the main plugin class object.
840
		 */
841
		do_action( 'jetpack_loaded', $this );
842
843
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
844
	}
845
846
	/**
847
	 * Sets up the XMLRPC request handlers.
848
	 *
849
	 * @deprecated since 7.7.0
850
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
851
	 *
852
	 * @param Array                 $request_params Incoming request parameters.
853
	 * @param Boolean               $is_active      Whether the connection is currently active.
854
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
855
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
856
	 */
857 View Code Duplication
	public function setup_xmlrpc_handlers(
858
		$request_params,
859
		$is_active,
860
		$is_signed,
861
		Jetpack_XMLRPC_Server $xmlrpc_server = null
862
	) {
863
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
864
865
		if ( ! $this->connection_manager ) {
866
			$this->connection_manager = new Connection_Manager();
867
		}
868
869
		return $this->connection_manager->setup_xmlrpc_handlers(
870
			$request_params,
871
			$is_active,
872
			$is_signed,
873
			$xmlrpc_server
874
		);
875
	}
876
877
	/**
878
	 * Initialize REST API registration connector.
879
	 *
880
	 * @deprecated since 7.7.0
881
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
882
	 */
883 View Code Duplication
	public function initialize_rest_api_registration_connector() {
884
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
885
886
		if ( ! $this->connection_manager ) {
887
			$this->connection_manager = new Connection_Manager();
888
		}
889
890
		$this->connection_manager->initialize_rest_api_registration_connector();
891
	}
892
893
	/**
894
	 * This is ported over from the manage module, which has been deprecated and baked in here.
895
	 *
896
	 * @param $domains
897
	 */
898
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
899
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
900
	}
901
902
	/**
903
	 * Return $domains, with 'wordpress.com' appended.
904
	 * This is ported over from the manage module, which has been deprecated and baked in here.
905
	 *
906
	 * @param $domains
907
	 * @return array
908
	 */
909
	function allow_wpcom_domain( $domains ) {
910
		if ( empty( $domains ) ) {
911
			$domains = array();
912
		}
913
		$domains[] = 'wordpress.com';
914
		return array_unique( $domains );
915
	}
916
917
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
918
		$post = get_post( $post_id );
919
920
		if ( empty( $post ) ) {
921
			return $default_url;
922
		}
923
924
		$post_type = $post->post_type;
925
926
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
927
		// https://en.support.wordpress.com/custom-post-types/
928
		$allowed_post_types = array(
929
			'post'                => 'post',
930
			'page'                => 'page',
931
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
932
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
933
		);
934
935
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
936
			return $default_url;
937
		}
938
939
		$path_prefix = $allowed_post_types[ $post_type ];
940
941
		$site_slug = self::build_raw_urls( get_home_url() );
942
943
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
944
	}
945
946
	function point_edit_comment_links_to_calypso( $url ) {
947
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
948
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
949
		return esc_url(
950
			sprintf(
951
				'https://wordpress.com/comment/%s/%d',
952
				self::build_raw_urls( get_home_url() ),
953
				$query_args['amp;c']
954
			)
955
		);
956
	}
957
958
	function jetpack_track_last_sync_callback( $params ) {
959
		/**
960
		 * Filter to turn off jitm caching
961
		 *
962
		 * @since 5.4.0
963
		 *
964
		 * @param bool false Whether to cache just in time messages
965
		 */
966
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
967
			return $params;
968
		}
969
970
		if ( is_array( $params ) && isset( $params[0] ) ) {
971
			$option = $params[0];
972
			if ( 'active_plugins' === $option ) {
973
				// use the cache if we can, but not terribly important if it gets evicted
974
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
975
			}
976
		}
977
978
		return $params;
979
	}
980
981
	function jetpack_connection_banner_callback() {
982
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
983
984
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
985
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
986
			wp_send_json_success();
987
		}
988
989
		wp_die();
990
	}
991
992
	/**
993
	 * Removes all XML-RPC methods that are not `jetpack.*`.
994
	 * Only used in our alternate XML-RPC endpoint, where we want to
995
	 * ensure that Core and other plugins' methods are not exposed.
996
	 *
997
	 * @deprecated since 7.7.0
998
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
999
	 *
1000
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1001
	 * @return array Filtered $methods
1002
	 */
1003 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1004
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1005
1006
		if ( ! $this->connection_manager ) {
1007
			$this->connection_manager = new Connection_Manager();
1008
		}
1009
1010
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1011
	}
1012
1013
	/**
1014
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1015
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1016
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1017
	 * which is accessible via a different URI. Most of the below is copied directly
1018
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1019
	 *
1020
	 * @deprecated since 7.7.0
1021
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1022
	 */
1023 View Code Duplication
	public function alternate_xmlrpc() {
1024
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1025
1026
		if ( ! $this->connection_manager ) {
1027
			$this->connection_manager = new Connection_Manager();
1028
		}
1029
1030
		$this->connection_manager->alternate_xmlrpc();
1031
	}
1032
1033
	/**
1034
	 * The callback for the JITM ajax requests.
1035
	 *
1036
	 * @deprecated since 7.9.0
1037
	 */
1038
	function jetpack_jitm_ajax_callback() {
1039
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1040
	}
1041
1042
	/**
1043
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1044
	 */
1045
	function push_stats() {
1046
		if ( ! empty( $this->stats ) ) {
1047
			$this->do_stats( 'server_side' );
1048
		}
1049
	}
1050
1051
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1052
		$is_development_mode = ( new Status() )->is_development_mode();
1053
		switch ( $cap ) {
1054
			case 'jetpack_connect':
1055
			case 'jetpack_reconnect':
1056
				if ( $is_development_mode ) {
1057
					$caps = array( 'do_not_allow' );
1058
					break;
1059
				}
1060
				/**
1061
				 * Pass through. If it's not development mode, these should match disconnect.
1062
				 * Let users disconnect if it's development mode, just in case things glitch.
1063
				 */
1064
			case 'jetpack_disconnect':
1065
				/**
1066
				 * In multisite, can individual site admins manage their own connection?
1067
				 *
1068
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1069
				 */
1070
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1071
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1072
						/**
1073
						 * We need to update the option name -- it's terribly unclear which
1074
						 * direction the override goes.
1075
						 *
1076
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1077
						 */
1078
						$caps = array( 'do_not_allow' );
1079
						break;
1080
					}
1081
				}
1082
1083
				$caps = array( 'manage_options' );
1084
				break;
1085
			case 'jetpack_manage_modules':
1086
			case 'jetpack_activate_modules':
1087
			case 'jetpack_deactivate_modules':
1088
				$caps = array( 'manage_options' );
1089
				break;
1090
			case 'jetpack_configure_modules':
1091
				$caps = array( 'manage_options' );
1092
				break;
1093
			case 'jetpack_manage_autoupdates':
1094
				$caps = array(
1095
					'manage_options',
1096
					'update_plugins',
1097
				);
1098
				break;
1099
			case 'jetpack_network_admin_page':
1100
			case 'jetpack_network_settings_page':
1101
				$caps = array( 'manage_network_plugins' );
1102
				break;
1103
			case 'jetpack_network_sites_page':
1104
				$caps = array( 'manage_sites' );
1105
				break;
1106
			case 'jetpack_admin_page':
1107
				if ( $is_development_mode ) {
1108
					$caps = array( 'manage_options' );
1109
					break;
1110
				} else {
1111
					$caps = array( 'read' );
1112
				}
1113
				break;
1114
			case 'jetpack_connect_user':
1115
				if ( $is_development_mode ) {
1116
					$caps = array( 'do_not_allow' );
1117
					break;
1118
				}
1119
				$caps = array( 'read' );
1120
				break;
1121
		}
1122
		return $caps;
1123
	}
1124
1125
	/**
1126
	 * Require a Jetpack authentication.
1127
	 *
1128
	 * @deprecated since 7.7.0
1129
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1130
	 */
1131 View Code Duplication
	public function require_jetpack_authentication() {
1132
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1133
1134
		if ( ! $this->connection_manager ) {
1135
			$this->connection_manager = new Connection_Manager();
1136
		}
1137
1138
		$this->connection_manager->require_jetpack_authentication();
1139
	}
1140
1141
	/**
1142
	 * Load language files
1143
	 *
1144
	 * @action plugins_loaded
1145
	 */
1146
	public static function plugin_textdomain() {
1147
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1148
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1149
	}
1150
1151
	/**
1152
	 * Register assets for use in various modules and the Jetpack admin page.
1153
	 *
1154
	 * @uses wp_script_is, wp_register_script, plugins_url
1155
	 * @action wp_loaded
1156
	 * @return null
1157
	 */
1158
	public function register_assets() {
1159
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1160
			wp_register_script(
1161
				'spin',
1162
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1163
				false,
1164
				'1.3'
1165
			);
1166
		}
1167
1168 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1169
			wp_register_script(
1170
				'jquery.spin',
1171
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1172
				array( 'jquery', 'spin' ),
1173
				'1.3'
1174
			);
1175
		}
1176
1177 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1178
			wp_register_script(
1179
				'jetpack-gallery-settings',
1180
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1181
				array( 'media-views' ),
1182
				'20121225'
1183
			);
1184
		}
1185
1186 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1187
			wp_register_script(
1188
				'jetpack-twitter-timeline',
1189
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1190
				array( 'jquery' ),
1191
				'4.0.0',
1192
				true
1193
			);
1194
		}
1195
1196
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1197
			wp_register_script(
1198
				'jetpack-facebook-embed',
1199
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1200
				array(),
1201
				null,
1202
				true
1203
			);
1204
1205
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1206
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1207
			if ( ! is_numeric( $fb_app_id ) ) {
1208
				$fb_app_id = '';
1209
			}
1210
			wp_localize_script(
1211
				'jetpack-facebook-embed',
1212
				'jpfbembed',
1213
				array(
1214
					'appid'  => $fb_app_id,
1215
					'locale' => $this->get_locale(),
1216
				)
1217
			);
1218
		}
1219
1220
		/**
1221
		 * As jetpack_register_genericons is by default fired off a hook,
1222
		 * the hook may have already fired by this point.
1223
		 * So, let's just trigger it manually.
1224
		 */
1225
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1226
		jetpack_register_genericons();
1227
1228
		/**
1229
		 * Register the social logos
1230
		 */
1231
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1232
		jetpack_register_social_logos();
1233
1234 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1235
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1236
		}
1237
	}
1238
1239
	/**
1240
	 * Guess locale from language code.
1241
	 *
1242
	 * @param string $lang Language code.
1243
	 * @return string|bool
1244
	 */
1245 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1246
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1247
			return 'en_US';
1248
		}
1249
1250
		if ( ! class_exists( 'GP_Locales' ) ) {
1251
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1252
				return false;
1253
			}
1254
1255
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1256
		}
1257
1258
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1259
			// WP.com: get_locale() returns 'it'
1260
			$locale = GP_Locales::by_slug( $lang );
1261
		} else {
1262
			// Jetpack: get_locale() returns 'it_IT';
1263
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1264
		}
1265
1266
		if ( ! $locale ) {
1267
			return false;
1268
		}
1269
1270
		if ( empty( $locale->facebook_locale ) ) {
1271
			if ( empty( $locale->wp_locale ) ) {
1272
				return false;
1273
			} else {
1274
				// Facebook SDK is smart enough to fall back to en_US if a
1275
				// locale isn't supported. Since supported Facebook locales
1276
				// can fall out of sync, we'll attempt to use the known
1277
				// wp_locale value and rely on said fallback.
1278
				return $locale->wp_locale;
1279
			}
1280
		}
1281
1282
		return $locale->facebook_locale;
1283
	}
1284
1285
	/**
1286
	 * Get the locale.
1287
	 *
1288
	 * @return string|bool
1289
	 */
1290
	function get_locale() {
1291
		$locale = $this->guess_locale_from_lang( get_locale() );
1292
1293
		if ( ! $locale ) {
1294
			$locale = 'en_US';
1295
		}
1296
1297
		return $locale;
1298
	}
1299
1300
	/**
1301
	 * Return the network_site_url so that .com knows what network this site is a part of.
1302
	 *
1303
	 * @param  bool $option
1304
	 * @return string
1305
	 */
1306
	public function jetpack_main_network_site_option( $option ) {
1307
		return network_site_url();
1308
	}
1309
	/**
1310
	 * Network Name.
1311
	 */
1312
	static function network_name( $option = null ) {
1313
		global $current_site;
1314
		return $current_site->site_name;
1315
	}
1316
	/**
1317
	 * Does the network allow new user and site registrations.
1318
	 *
1319
	 * @return string
1320
	 */
1321
	static function network_allow_new_registrations( $option = null ) {
1322
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1323
	}
1324
	/**
1325
	 * Does the network allow admins to add new users.
1326
	 *
1327
	 * @return boolian
1328
	 */
1329
	static function network_add_new_users( $option = null ) {
1330
		return (bool) get_site_option( 'add_new_users' );
1331
	}
1332
	/**
1333
	 * File upload psace left per site in MB.
1334
	 *  -1 means NO LIMIT.
1335
	 *
1336
	 * @return number
1337
	 */
1338
	static function network_site_upload_space( $option = null ) {
1339
		// value in MB
1340
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1341
	}
1342
1343
	/**
1344
	 * Network allowed file types.
1345
	 *
1346
	 * @return string
1347
	 */
1348
	static function network_upload_file_types( $option = null ) {
1349
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1350
	}
1351
1352
	/**
1353
	 * Maximum file upload size set by the network.
1354
	 *
1355
	 * @return number
1356
	 */
1357
	static function network_max_upload_file_size( $option = null ) {
1358
		// value in KB
1359
		return get_site_option( 'fileupload_maxk', 300 );
1360
	}
1361
1362
	/**
1363
	 * Lets us know if a site allows admins to manage the network.
1364
	 *
1365
	 * @return array
1366
	 */
1367
	static function network_enable_administration_menus( $option = null ) {
1368
		return get_site_option( 'menu_items' );
1369
	}
1370
1371
	/**
1372
	 * If a user has been promoted to or demoted from admin, we need to clear the
1373
	 * jetpack_other_linked_admins transient.
1374
	 *
1375
	 * @since 4.3.2
1376
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1377
	 *
1378
	 * @param int    $user_id   The user ID whose role changed.
1379
	 * @param string $role      The new role.
1380
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $old_roles not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1381
	 */
1382
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1383
		if ( 'administrator' == $role
1384
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1385
			|| is_null( $old_roles )
1386
		) {
1387
			delete_transient( 'jetpack_other_linked_admins' );
1388
		}
1389
	}
1390
1391
	/**
1392
	 * Checks to see if there are any other users available to become primary
1393
	 * Users must both:
1394
	 * - Be linked to wpcom
1395
	 * - Be an admin
1396
	 *
1397
	 * @return mixed False if no other users are linked, Int if there are.
1398
	 */
1399
	static function get_other_linked_admins() {
1400
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1401
1402
		if ( false === $other_linked_users ) {
1403
			$admins = get_users( array( 'role' => 'administrator' ) );
1404
			if ( count( $admins ) > 1 ) {
1405
				$available = array();
1406
				foreach ( $admins as $admin ) {
1407
					if ( self::is_user_connected( $admin->ID ) ) {
1408
						$available[] = $admin->ID;
1409
					}
1410
				}
1411
1412
				$count_connected_admins = count( $available );
1413
				if ( count( $available ) > 1 ) {
1414
					$other_linked_users = $count_connected_admins;
1415
				} else {
1416
					$other_linked_users = 0;
1417
				}
1418
			} else {
1419
				$other_linked_users = 0;
1420
			}
1421
1422
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1423
		}
1424
1425
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1426
	}
1427
1428
	/**
1429
	 * Return whether we are dealing with a multi network setup or not.
1430
	 * The reason we are type casting this is because we want to avoid the situation where
1431
	 * the result is false since when is_main_network_option return false it cases
1432
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1433
	 * database which could be set to anything as opposed to what this function returns.
1434
	 *
1435
	 * @param  bool $option
1436
	 *
1437
	 * @return boolean
1438
	 */
1439
	public function is_main_network_option( $option ) {
1440
		// return '1' or ''
1441
		return (string) (bool) self::is_multi_network();
1442
	}
1443
1444
	/**
1445
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1446
	 *
1447
	 * @param  string $option
1448
	 * @return boolean
1449
	 */
1450
	public function is_multisite( $option ) {
1451
		return (string) (bool) is_multisite();
1452
	}
1453
1454
	/**
1455
	 * Implemented since there is no core is multi network function
1456
	 * Right now there is no way to tell if we which network is the dominant network on the system
1457
	 *
1458
	 * @since  3.3
1459
	 * @return boolean
1460
	 */
1461 View Code Duplication
	public static function is_multi_network() {
1462
		global  $wpdb;
1463
1464
		// if we don't have a multi site setup no need to do any more
1465
		if ( ! is_multisite() ) {
1466
			return false;
1467
		}
1468
1469
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1470
		if ( $num_sites > 1 ) {
1471
			return true;
1472
		} else {
1473
			return false;
1474
		}
1475
	}
1476
1477
	/**
1478
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1479
	 *
1480
	 * @return null
1481
	 */
1482
	function update_jetpack_main_network_site_option() {
1483
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1484
	}
1485
	/**
1486
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1487
	 */
1488
	function update_jetpack_network_settings() {
1489
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1490
		// Only sync this info for the main network site.
1491
	}
1492
1493
	/**
1494
	 * Get back if the current site is single user site.
1495
	 *
1496
	 * @return bool
1497
	 */
1498 View Code Duplication
	public static function is_single_user_site() {
1499
		global $wpdb;
1500
1501
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1502
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1503
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1504
		}
1505
		return 1 === (int) $some_users;
1506
	}
1507
1508
	/**
1509
	 * Returns true if the site has file write access false otherwise.
1510
	 *
1511
	 * @return string ( '1' | '0' )
1512
	 **/
1513
	public static function file_system_write_access() {
1514
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1515
			require_once ABSPATH . 'wp-admin/includes/file.php';
1516
		}
1517
1518
		require_once ABSPATH . 'wp-admin/includes/template.php';
1519
1520
		$filesystem_method = get_filesystem_method();
1521
		if ( $filesystem_method === 'direct' ) {
1522
			return 1;
1523
		}
1524
1525
		ob_start();
1526
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1527
		ob_end_clean();
1528
		if ( $filesystem_credentials_are_stored ) {
1529
			return 1;
1530
		}
1531
		return 0;
1532
	}
1533
1534
	/**
1535
	 * Finds out if a site is using a version control system.
1536
	 *
1537
	 * @return string ( '1' | '0' )
1538
	 **/
1539
	public static function is_version_controlled() {
1540
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1541
		return (string) (int) Functions::is_version_controlled();
1542
	}
1543
1544
	/**
1545
	 * Determines whether the current theme supports featured images or not.
1546
	 *
1547
	 * @return string ( '1' | '0' )
1548
	 */
1549
	public static function featured_images_enabled() {
1550
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1551
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1552
	}
1553
1554
	/**
1555
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1556
	 *
1557
	 * @deprecated 4.7 use get_avatar_url instead.
1558
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1559
	 * @param int               $size Size of the avatar image
1560
	 * @param string            $default URL to a default image to use if no avatar is available
1561
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1562
	 *
1563
	 * @return array
1564
	 */
1565
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1566
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1567
		return get_avatar_url(
1568
			$id_or_email,
1569
			array(
1570
				'size'          => $size,
1571
				'default'       => $default,
1572
				'force_default' => $force_display,
1573
			)
1574
		);
1575
	}
1576
1577
	/**
1578
	 * jetpack_updates is saved in the following schema:
1579
	 *
1580
	 * array (
1581
	 *      'plugins'                       => (int) Number of plugin updates available.
1582
	 *      'themes'                        => (int) Number of theme updates available.
1583
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1584
	 *      'translations'                  => (int) Number of translation updates available.
1585
	 *      'total'                         => (int) Total of all available updates.
1586
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1587
	 * )
1588
	 *
1589
	 * @return array
1590
	 */
1591
	public static function get_updates() {
1592
		$update_data = wp_get_update_data();
1593
1594
		// Stores the individual update counts as well as the total count.
1595
		if ( isset( $update_data['counts'] ) ) {
1596
			$updates = $update_data['counts'];
1597
		}
1598
1599
		// If we need to update WordPress core, let's find the latest version number.
1600 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1601
			$cur = get_preferred_from_update_core();
1602
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1603
				$updates['wp_update_version'] = $cur->current;
1604
			}
1605
		}
1606
		return isset( $updates ) ? $updates : array();
1607
	}
1608
1609
	public static function get_update_details() {
1610
		$update_details = array(
1611
			'update_core'    => get_site_transient( 'update_core' ),
1612
			'update_plugins' => get_site_transient( 'update_plugins' ),
1613
			'update_themes'  => get_site_transient( 'update_themes' ),
1614
		);
1615
		return $update_details;
1616
	}
1617
1618
	public static function refresh_update_data() {
1619
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1620
1621
	}
1622
1623
	public static function refresh_theme_data() {
1624
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1625
	}
1626
1627
	/**
1628
	 * Is Jetpack active?
1629
	 */
1630
	public static function is_active() {
1631
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
1632
	}
1633
1634
	/**
1635
	 * Make an API call to WordPress.com for plan status
1636
	 *
1637
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1638
	 *
1639
	 * @return bool True if plan is updated, false if no update
1640
	 */
1641
	public static function refresh_active_plan_from_wpcom() {
1642
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1643
		return Jetpack_Plan::refresh_from_wpcom();
1644
	}
1645
1646
	/**
1647
	 * Get the plan that this Jetpack site is currently using
1648
	 *
1649
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1650
	 * @return array Active Jetpack plan details.
1651
	 */
1652
	public static function get_active_plan() {
1653
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1654
		return Jetpack_Plan::get();
1655
	}
1656
1657
	/**
1658
	 * Determine whether the active plan supports a particular feature
1659
	 *
1660
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1661
	 * @return bool True if plan supports feature, false if not.
1662
	 */
1663
	public static function active_plan_supports( $feature ) {
1664
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1665
		return Jetpack_Plan::supports( $feature );
1666
	}
1667
1668
	/**
1669
	 * Deprecated: Is Jetpack in development (offline) mode?
1670
	 *
1671
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1672
	 * and themes still use it, and we do not want to flood them with notices.
1673
	 *
1674
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1675
	 *
1676
	 * @deprecated since 8.0.
1677
	 */
1678
	public static function is_development_mode() {
1679
		return ( new Status() )->is_development_mode();
1680
	}
1681
1682
	/**
1683
	 * Whether the site is currently onboarding or not.
1684
	 * A site is considered as being onboarded if it currently has an onboarding token.
1685
	 *
1686
	 * @since 5.8
1687
	 *
1688
	 * @access public
1689
	 * @static
1690
	 *
1691
	 * @return bool True if the site is currently onboarding, false otherwise
1692
	 */
1693
	public static function is_onboarding() {
1694
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1695
	}
1696
1697
	/**
1698
	 * Determines reason for Jetpack development mode.
1699
	 */
1700
	public static function development_mode_trigger_text() {
1701
		if ( ! ( new Status() )->is_development_mode() ) {
1702
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1703
		}
1704
1705
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1706
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1707
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1708
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1709
		} else {
1710
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1711
		}
1712
1713
		return $notice;
1714
1715
	}
1716
	/**
1717
	 * Get Jetpack development mode notice text and notice class.
1718
	 *
1719
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1720
	 */
1721
	public static function show_development_mode_notice() {
1722
		if ( ( new Status() )->is_development_mode() ) {
1723
			$notice = sprintf(
1724
				/* translators: %s is a URL */
1725
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1726
				'https://jetpack.com/support/development-mode/'
1727
			);
1728
1729
			$notice .= ' ' . self::development_mode_trigger_text();
1730
1731
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1732
		}
1733
1734
		// Throw up a notice if using a development version and as for feedback.
1735
		if ( self::is_development_version() ) {
1736
			/* translators: %s is a URL */
1737
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), 'https://jetpack.com/contact-support/beta-group/' );
1738
1739
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1740
		}
1741
		// Throw up a notice if using staging mode
1742
		if ( ( new Status() )->is_staging_site() ) {
1743
			/* translators: %s is a URL */
1744
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1745
1746
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1747
		}
1748
	}
1749
1750
	/**
1751
	 * Whether Jetpack's version maps to a public release, or a development version.
1752
	 */
1753
	public static function is_development_version() {
1754
		/**
1755
		 * Allows filtering whether this is a development version of Jetpack.
1756
		 *
1757
		 * This filter is especially useful for tests.
1758
		 *
1759
		 * @since 4.3.0
1760
		 *
1761
		 * @param bool $development_version Is this a develoment version of Jetpack?
1762
		 */
1763
		return (bool) apply_filters(
1764
			'jetpack_development_version',
1765
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1766
		);
1767
	}
1768
1769
	/**
1770
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1771
	 */
1772
	public static function is_user_connected( $user_id = false ) {
1773
		return self::connection()->is_user_connected( $user_id );
1774
	}
1775
1776
	/**
1777
	 * Get the wpcom user data of the current|specified connected user.
1778
	 */
1779 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1780
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1781
		if ( ! $user_id ) {
1782
			$user_id = get_current_user_id();
1783
		}
1784
1785
		$transient_key = "jetpack_connected_user_data_$user_id";
1786
1787
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1788
			return $cached_user_data;
1789
		}
1790
1791
		$xml = new Jetpack_IXR_Client(
1792
			array(
1793
				'user_id' => $user_id,
1794
			)
1795
		);
1796
		$xml->query( 'wpcom.getUser' );
1797
		if ( ! $xml->isError() ) {
1798
			$user_data = $xml->getResponse();
1799
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1800
			return $user_data;
1801
		}
1802
1803
		return false;
1804
	}
1805
1806
	/**
1807
	 * Get the wpcom email of the current|specified connected user.
1808
	 */
1809 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1810
		if ( ! $user_id ) {
1811
			$user_id = get_current_user_id();
1812
		}
1813
1814
		$xml = new Jetpack_IXR_Client(
1815
			array(
1816
				'user_id' => $user_id,
1817
			)
1818
		);
1819
		$xml->query( 'wpcom.getUserEmail' );
1820
		if ( ! $xml->isError() ) {
1821
			return $xml->getResponse();
1822
		}
1823
		return false;
1824
	}
1825
1826
	/**
1827
	 * Get the wpcom email of the master user.
1828
	 */
1829
	public static function get_master_user_email() {
1830
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1831
		if ( $master_user_id ) {
1832
			return self::get_connected_user_email( $master_user_id );
1833
		}
1834
		return '';
1835
	}
1836
1837
	/**
1838
	 * Whether the current user is the connection owner.
1839
	 *
1840
	 * @deprecated since 7.7
1841
	 *
1842
	 * @return bool Whether the current user is the connection owner.
1843
	 */
1844
	public function current_user_is_connection_owner() {
1845
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1846
		return self::connection()->is_connection_owner();
1847
	}
1848
1849
	/**
1850
	 * Gets current user IP address.
1851
	 *
1852
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1853
	 *
1854
	 * @return string                  Current user IP address.
1855
	 */
1856
	public static function current_user_ip( $check_all_headers = false ) {
1857
		if ( $check_all_headers ) {
1858
			foreach ( array(
1859
				'HTTP_CF_CONNECTING_IP',
1860
				'HTTP_CLIENT_IP',
1861
				'HTTP_X_FORWARDED_FOR',
1862
				'HTTP_X_FORWARDED',
1863
				'HTTP_X_CLUSTER_CLIENT_IP',
1864
				'HTTP_FORWARDED_FOR',
1865
				'HTTP_FORWARDED',
1866
				'HTTP_VIA',
1867
			) as $key ) {
1868
				if ( ! empty( $_SERVER[ $key ] ) ) {
1869
					return $_SERVER[ $key ];
1870
				}
1871
			}
1872
		}
1873
1874
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1875
	}
1876
1877
	/**
1878
	 * Synchronize connected user role changes
1879
	 */
1880
	function user_role_change( $user_id ) {
1881
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1882
		Users::user_role_change( $user_id );
1883
	}
1884
1885
	/**
1886
	 * Loads the currently active modules.
1887
	 */
1888
	public static function load_modules() {
1889
		$is_development_mode = ( new Status() )->is_development_mode();
1890
		if (
1891
			! self::is_active()
1892
			&& ! $is_development_mode
1893
			&& ! self::is_onboarding()
1894
			&& (
1895
				! is_multisite()
1896
				|| ! get_site_option( 'jetpack_protect_active' )
1897
			)
1898
		) {
1899
			return;
1900
		}
1901
1902
		$version = Jetpack_Options::get_option( 'version' );
1903 View Code Duplication
		if ( ! $version ) {
1904
			$version = $old_version = JETPACK__VERSION . ':' . time();
1905
			/** This action is documented in class.jetpack.php */
1906
			do_action( 'updating_jetpack_version', $version, false );
1907
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1908
		}
1909
		list( $version ) = explode( ':', $version );
1910
1911
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1912
1913
		$modules_data = array();
1914
1915
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1916
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1917
			$updated_modules = array();
1918
			foreach ( $modules as $module ) {
1919
				$modules_data[ $module ] = self::get_module( $module );
1920
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1921
					continue;
1922
				}
1923
1924
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1925
					continue;
1926
				}
1927
1928
				$updated_modules[] = $module;
1929
			}
1930
1931
			$modules = array_diff( $modules, $updated_modules );
1932
		}
1933
1934
		foreach ( $modules as $index => $module ) {
1935
			// If we're in dev mode, disable modules requiring a connection
1936
			if ( $is_development_mode ) {
1937
				// Prime the pump if we need to
1938
				if ( empty( $modules_data[ $module ] ) ) {
1939
					$modules_data[ $module ] = self::get_module( $module );
1940
				}
1941
				// If the module requires a connection, but we're in local mode, don't include it.
1942
				if ( $modules_data[ $module ]['requires_connection'] ) {
1943
					continue;
1944
				}
1945
			}
1946
1947
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1948
				continue;
1949
			}
1950
1951
			if ( ! include_once self::get_module_path( $module ) ) {
1952
				unset( $modules[ $index ] );
1953
				self::update_active_modules( array_values( $modules ) );
1954
				continue;
1955
			}
1956
1957
			/**
1958
			 * Fires when a specific module is loaded.
1959
			 * The dynamic part of the hook, $module, is the module slug.
1960
			 *
1961
			 * @since 1.1.0
1962
			 */
1963
			do_action( 'jetpack_module_loaded_' . $module );
1964
		}
1965
1966
		/**
1967
		 * Fires when all the modules are loaded.
1968
		 *
1969
		 * @since 1.1.0
1970
		 */
1971
		do_action( 'jetpack_modules_loaded' );
1972
1973
		// 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.
1974
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1975
	}
1976
1977
	/**
1978
	 * Check if Jetpack's REST API compat file should be included
1979
	 *
1980
	 * @action plugins_loaded
1981
	 * @return null
1982
	 */
1983
	public function check_rest_api_compat() {
1984
		/**
1985
		 * Filters the list of REST API compat files to be included.
1986
		 *
1987
		 * @since 2.2.5
1988
		 *
1989
		 * @param array $args Array of REST API compat files to include.
1990
		 */
1991
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1992
1993
		if ( function_exists( 'bbpress' ) ) {
1994
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1995
		}
1996
1997
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1998
			require_once $_jetpack_rest_api_compat_include;
1999
		}
2000
	}
2001
2002
	/**
2003
	 * Gets all plugins currently active in values, regardless of whether they're
2004
	 * traditionally activated or network activated.
2005
	 *
2006
	 * @todo Store the result in core's object cache maybe?
2007
	 */
2008
	public static function get_active_plugins() {
2009
		$active_plugins = (array) get_option( 'active_plugins', array() );
2010
2011
		if ( is_multisite() ) {
2012
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2013
			// whereas active_plugins stores them in the values.
2014
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2015
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2016
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2017
			}
2018
		}
2019
2020
		sort( $active_plugins );
2021
2022
		return array_unique( $active_plugins );
2023
	}
2024
2025
	/**
2026
	 * Gets and parses additional plugin data to send with the heartbeat data
2027
	 *
2028
	 * @since 3.8.1
2029
	 *
2030
	 * @return array Array of plugin data
2031
	 */
2032
	public static function get_parsed_plugin_data() {
2033
		if ( ! function_exists( 'get_plugins' ) ) {
2034
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2035
		}
2036
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2037
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2038
		$active_plugins = self::get_active_plugins();
2039
2040
		$plugins = array();
2041
		foreach ( $all_plugins as $path => $plugin_data ) {
2042
			$plugins[ $path ] = array(
2043
				'is_active' => in_array( $path, $active_plugins ),
2044
				'file'      => $path,
2045
				'name'      => $plugin_data['Name'],
2046
				'version'   => $plugin_data['Version'],
2047
				'author'    => $plugin_data['Author'],
2048
			);
2049
		}
2050
2051
		return $plugins;
2052
	}
2053
2054
	/**
2055
	 * Gets and parses theme data to send with the heartbeat data
2056
	 *
2057
	 * @since 3.8.1
2058
	 *
2059
	 * @return array Array of theme data
2060
	 */
2061
	public static function get_parsed_theme_data() {
2062
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2063
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2064
2065
		$themes = array();
2066
		foreach ( $all_themes as $slug => $theme_data ) {
2067
			$theme_headers = array();
2068
			foreach ( $header_keys as $header_key ) {
2069
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2070
			}
2071
2072
			$themes[ $slug ] = array(
2073
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2074
				'slug'            => $slug,
2075
				'theme_root'      => $theme_data->get_theme_root_uri(),
2076
				'parent'          => $theme_data->parent(),
2077
				'headers'         => $theme_headers,
2078
			);
2079
		}
2080
2081
		return $themes;
2082
	}
2083
2084
	/**
2085
	 * Checks whether a specific plugin is active.
2086
	 *
2087
	 * We don't want to store these in a static variable, in case
2088
	 * there are switch_to_blog() calls involved.
2089
	 */
2090
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2091
		return in_array( $plugin, self::get_active_plugins() );
2092
	}
2093
2094
	/**
2095
	 * Check if Jetpack's Open Graph tags should be used.
2096
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2097
	 *
2098
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2099
	 * @action plugins_loaded
2100
	 * @return null
2101
	 */
2102
	public function check_open_graph() {
2103
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2104
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2105
		}
2106
2107
		$active_plugins = self::get_active_plugins();
2108
2109
		if ( ! empty( $active_plugins ) ) {
2110
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2111
				if ( in_array( $plugin, $active_plugins ) ) {
2112
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2113
					break;
2114
				}
2115
			}
2116
		}
2117
2118
		/**
2119
		 * Allow the addition of Open Graph Meta Tags to all pages.
2120
		 *
2121
		 * @since 2.0.3
2122
		 *
2123
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2124
		 */
2125
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2126
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2127
		}
2128
	}
2129
2130
	/**
2131
	 * Check if Jetpack's Twitter tags should be used.
2132
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2133
	 *
2134
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2135
	 * @action plugins_loaded
2136
	 * @return null
2137
	 */
2138
	public function check_twitter_tags() {
2139
2140
		$active_plugins = self::get_active_plugins();
2141
2142
		if ( ! empty( $active_plugins ) ) {
2143
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2144
				if ( in_array( $plugin, $active_plugins ) ) {
2145
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2146
					break;
2147
				}
2148
			}
2149
		}
2150
2151
		/**
2152
		 * Allow Twitter Card Meta tags to be disabled.
2153
		 *
2154
		 * @since 2.6.0
2155
		 *
2156
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2157
		 */
2158
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2159
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2160
		}
2161
	}
2162
2163
	/**
2164
	 * Allows plugins to submit security reports.
2165
	 *
2166
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2167
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2168
	 * @param array  $args         See definitions above
2169
	 */
2170
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2171
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2172
	}
2173
2174
	/* Jetpack Options API */
2175
2176
	public static function get_option_names( $type = 'compact' ) {
2177
		return Jetpack_Options::get_option_names( $type );
2178
	}
2179
2180
	/**
2181
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2182
	 *
2183
	 * @param string $name    Option name
2184
	 * @param mixed  $default (optional)
2185
	 */
2186
	public static function get_option( $name, $default = false ) {
2187
		return Jetpack_Options::get_option( $name, $default );
2188
	}
2189
2190
	/**
2191
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2192
	 *
2193
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2194
	 * @param string $name  Option name
2195
	 * @param mixed  $value Option value
2196
	 */
2197
	public static function update_option( $name, $value ) {
2198
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2199
		return Jetpack_Options::update_option( $name, $value );
2200
	}
2201
2202
	/**
2203
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2204
	 *
2205
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2206
	 * @param array $array array( option name => option value, ... )
2207
	 */
2208
	public static function update_options( $array ) {
2209
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2210
		return Jetpack_Options::update_options( $array );
2211
	}
2212
2213
	/**
2214
	 * Deletes the given option.  May be passed multiple option names as an array.
2215
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2216
	 *
2217
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2218
	 * @param string|array $names
2219
	 */
2220
	public static function delete_option( $names ) {
2221
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2222
		return Jetpack_Options::delete_option( $names );
2223
	}
2224
2225
	/**
2226
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2227
	 *
2228
	 * Enters a user token into the user_tokens option
2229
	 *
2230
	 * @param int    $user_id The user id.
2231
	 * @param string $token The user token.
2232
	 * @param bool   $is_master_user Whether the user is the master user.
2233
	 * @return bool
2234
	 */
2235
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2236
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2237
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2238
	}
2239
2240
	/**
2241
	 * Returns an array of all PHP files in the specified absolute path.
2242
	 * Equivalent to glob( "$absolute_path/*.php" ).
2243
	 *
2244
	 * @param string $absolute_path The absolute path of the directory to search.
2245
	 * @return array Array of absolute paths to the PHP files.
2246
	 */
2247
	public static function glob_php( $absolute_path ) {
2248
		if ( function_exists( 'glob' ) ) {
2249
			return glob( "$absolute_path/*.php" );
2250
		}
2251
2252
		$absolute_path = untrailingslashit( $absolute_path );
2253
		$files         = array();
2254
		if ( ! $dir = @opendir( $absolute_path ) ) {
2255
			return $files;
2256
		}
2257
2258
		while ( false !== $file = readdir( $dir ) ) {
2259
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2260
				continue;
2261
			}
2262
2263
			$file = "$absolute_path/$file";
2264
2265
			if ( ! is_file( $file ) ) {
2266
				continue;
2267
			}
2268
2269
			$files[] = $file;
2270
		}
2271
2272
		closedir( $dir );
2273
2274
		return $files;
2275
	}
2276
2277
	public static function activate_new_modules( $redirect = false ) {
2278
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2279
			return;
2280
		}
2281
2282
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2283 View Code Duplication
		if ( ! $jetpack_old_version ) {
2284
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2285
			/** This action is documented in class.jetpack.php */
2286
			do_action( 'updating_jetpack_version', $version, false );
2287
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2288
		}
2289
2290
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2291
2292
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2293
			return;
2294
		}
2295
2296
		$active_modules     = self::get_active_modules();
2297
		$reactivate_modules = array();
2298
		foreach ( $active_modules as $active_module ) {
2299
			$module = self::get_module( $active_module );
2300
			if ( ! isset( $module['changed'] ) ) {
2301
				continue;
2302
			}
2303
2304
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2305
				continue;
2306
			}
2307
2308
			$reactivate_modules[] = $active_module;
2309
			self::deactivate_module( $active_module );
2310
		}
2311
2312
		$new_version = JETPACK__VERSION . ':' . time();
2313
		/** This action is documented in class.jetpack.php */
2314
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2315
		Jetpack_Options::update_options(
2316
			array(
2317
				'version'     => $new_version,
2318
				'old_version' => $jetpack_old_version,
2319
			)
2320
		);
2321
2322
		self::state( 'message', 'modules_activated' );
2323
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
Documentation introduced by
JETPACK__VERSION is of type string, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
2324
2325
		if ( $redirect ) {
2326
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2327
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2328
				$page = $_GET['page'];
2329
			}
2330
2331
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2332
			exit;
2333
		}
2334
	}
2335
2336
	/**
2337
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2338
	 * Make sure to tuck away module "library" files in a sub-directory.
2339
	 */
2340
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2341
		static $modules = null;
2342
2343
		if ( ! isset( $modules ) ) {
2344
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2345
			// Use the cache if we're on the front-end and it's available...
2346
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2347
				$modules = $available_modules_option[ JETPACK__VERSION ];
2348
			} else {
2349
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2350
2351
				$modules = array();
2352
2353
				foreach ( $files as $file ) {
2354
					if ( ! $headers = self::get_module( $file ) ) {
2355
						continue;
2356
					}
2357
2358
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2359
				}
2360
2361
				Jetpack_Options::update_option(
2362
					'available_modules',
2363
					array(
2364
						JETPACK__VERSION => $modules,
2365
					)
2366
				);
2367
			}
2368
		}
2369
2370
		/**
2371
		 * Filters the array of modules available to be activated.
2372
		 *
2373
		 * @since 2.4.0
2374
		 *
2375
		 * @param array $modules Array of available modules.
2376
		 * @param string $min_version Minimum version number required to use modules.
2377
		 * @param string $max_version Maximum version number required to use modules.
2378
		 */
2379
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2380
2381
		if ( ! $min_version && ! $max_version ) {
2382
			return array_keys( $mods );
2383
		}
2384
2385
		$r = array();
2386
		foreach ( $mods as $slug => $introduced ) {
2387
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2388
				continue;
2389
			}
2390
2391
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2392
				continue;
2393
			}
2394
2395
			$r[] = $slug;
2396
		}
2397
2398
		return $r;
2399
	}
2400
2401
	/**
2402
	 * Default modules loaded on activation.
2403
	 */
2404
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2405
		$return = array();
2406
2407
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2408
			$module_data = self::get_module( $module );
2409
2410
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2411
				case 'yes':
2412
					$return[] = $module;
2413
					break;
2414
				case 'public':
2415
					if ( Jetpack_Options::get_option( 'public' ) ) {
2416
						$return[] = $module;
2417
					}
2418
					break;
2419
				case 'no':
2420
				default:
2421
					break;
2422
			}
2423
		}
2424
		/**
2425
		 * Filters the array of default modules.
2426
		 *
2427
		 * @since 2.5.0
2428
		 *
2429
		 * @param array $return Array of default modules.
2430
		 * @param string $min_version Minimum version number required to use modules.
2431
		 * @param string $max_version Maximum version number required to use modules.
2432
		 */
2433
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2434
	}
2435
2436
	/**
2437
	 * Checks activated modules during auto-activation to determine
2438
	 * if any of those modules are being deprecated.  If so, close
2439
	 * them out, and add any replacement modules.
2440
	 *
2441
	 * Runs at priority 99 by default.
2442
	 *
2443
	 * This is run late, so that it can still activate a module if
2444
	 * the new module is a replacement for another that the user
2445
	 * currently has active, even if something at the normal priority
2446
	 * would kibosh everything.
2447
	 *
2448
	 * @since 2.6
2449
	 * @uses jetpack_get_default_modules filter
2450
	 * @param array $modules
2451
	 * @return array
2452
	 */
2453
	function handle_deprecated_modules( $modules ) {
2454
		$deprecated_modules = array(
2455
			'debug'            => null,  // Closed out and moved to the debugger library.
2456
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2457
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2458
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2459
		);
2460
2461
		// Don't activate SSO if they never completed activating WPCC.
2462
		if ( self::is_module_active( 'wpcc' ) ) {
2463
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2464
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2465
				$deprecated_modules['wpcc'] = null;
2466
			}
2467
		}
2468
2469
		foreach ( $deprecated_modules as $module => $replacement ) {
2470
			if ( self::is_module_active( $module ) ) {
2471
				self::deactivate_module( $module );
2472
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2473
					$modules[] = $replacement;
2474
				}
2475
			}
2476
		}
2477
2478
		return array_unique( $modules );
2479
	}
2480
2481
	/**
2482
	 * Checks activated plugins during auto-activation to determine
2483
	 * if any of those plugins are in the list with a corresponding module
2484
	 * that is not compatible with the plugin. The module will not be allowed
2485
	 * to auto-activate.
2486
	 *
2487
	 * @since 2.6
2488
	 * @uses jetpack_get_default_modules filter
2489
	 * @param array $modules
2490
	 * @return array
2491
	 */
2492
	function filter_default_modules( $modules ) {
2493
2494
		$active_plugins = self::get_active_plugins();
2495
2496
		if ( ! empty( $active_plugins ) ) {
2497
2498
			// For each module we'd like to auto-activate...
2499
			foreach ( $modules as $key => $module ) {
2500
				// If there are potential conflicts for it...
2501
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2502
					// For each potential conflict...
2503
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2504
						// If that conflicting plugin is active...
2505
						if ( in_array( $plugin, $active_plugins ) ) {
2506
							// Remove that item from being auto-activated.
2507
							unset( $modules[ $key ] );
2508
						}
2509
					}
2510
				}
2511
			}
2512
		}
2513
2514
		return $modules;
2515
	}
2516
2517
	/**
2518
	 * Extract a module's slug from its full path.
2519
	 */
2520
	public static function get_module_slug( $file ) {
2521
		return str_replace( '.php', '', basename( $file ) );
2522
	}
2523
2524
	/**
2525
	 * Generate a module's path from its slug.
2526
	 */
2527
	public static function get_module_path( $slug ) {
2528
		/**
2529
		 * Filters the path of a modules.
2530
		 *
2531
		 * @since 7.4.0
2532
		 *
2533
		 * @param array $return The absolute path to a module's root php file
2534
		 * @param string $slug The module slug
2535
		 */
2536
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2537
	}
2538
2539
	/**
2540
	 * Load module data from module file. Headers differ from WordPress
2541
	 * plugin headers to avoid them being identified as standalone
2542
	 * plugins on the WordPress plugins page.
2543
	 */
2544
	public static function get_module( $module ) {
2545
		$headers = array(
2546
			'name'                      => 'Module Name',
2547
			'description'               => 'Module Description',
2548
			'sort'                      => 'Sort Order',
2549
			'recommendation_order'      => 'Recommendation Order',
2550
			'introduced'                => 'First Introduced',
2551
			'changed'                   => 'Major Changes In',
2552
			'deactivate'                => 'Deactivate',
2553
			'free'                      => 'Free',
2554
			'requires_connection'       => 'Requires Connection',
2555
			'auto_activate'             => 'Auto Activate',
2556
			'module_tags'               => 'Module Tags',
2557
			'feature'                   => 'Feature',
2558
			'additional_search_queries' => 'Additional Search Queries',
2559
			'plan_classes'              => 'Plans',
2560
		);
2561
2562
		$file = self::get_module_path( self::get_module_slug( $module ) );
2563
2564
		$mod = self::get_file_data( $file, $headers );
2565
		if ( empty( $mod['name'] ) ) {
2566
			return false;
2567
		}
2568
2569
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2570
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2571
		$mod['deactivate']           = empty( $mod['deactivate'] );
2572
		$mod['free']                 = empty( $mod['free'] );
2573
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2574
2575
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2576
			$mod['auto_activate'] = 'No';
2577
		} else {
2578
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2579
		}
2580
2581
		if ( $mod['module_tags'] ) {
2582
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2583
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2584
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2585
		} else {
2586
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2587
		}
2588
2589 View Code Duplication
		if ( $mod['plan_classes'] ) {
2590
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2591
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2592
		} else {
2593
			$mod['plan_classes'] = array( 'free' );
2594
		}
2595
2596 View Code Duplication
		if ( $mod['feature'] ) {
2597
			$mod['feature'] = explode( ',', $mod['feature'] );
2598
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2599
		} else {
2600
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2601
		}
2602
2603
		/**
2604
		 * Filters the feature array on a module.
2605
		 *
2606
		 * This filter allows you to control where each module is filtered: Recommended,
2607
		 * and the default "Other" listing.
2608
		 *
2609
		 * @since 3.5.0
2610
		 *
2611
		 * @param array   $mod['feature'] The areas to feature this module:
2612
		 *     'Recommended' shows on the main Jetpack admin screen.
2613
		 *     'Other' should be the default if no other value is in the array.
2614
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2615
		 * @param array   $mod All the currently assembled module data.
2616
		 */
2617
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2618
2619
		/**
2620
		 * Filter the returned data about a module.
2621
		 *
2622
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2623
		 * so please be careful.
2624
		 *
2625
		 * @since 3.6.0
2626
		 *
2627
		 * @param array   $mod    The details of the requested module.
2628
		 * @param string  $module The slug of the module, e.g. sharedaddy
2629
		 * @param string  $file   The path to the module source file.
2630
		 */
2631
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2632
	}
2633
2634
	/**
2635
	 * Like core's get_file_data implementation, but caches the result.
2636
	 */
2637
	public static function get_file_data( $file, $headers ) {
2638
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2639
		$file_name = basename( $file );
2640
2641
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2642
2643
		$file_data_option = get_transient( $cache_key );
2644
2645
		if ( ! is_array( $file_data_option ) ) {
2646
			delete_transient( $cache_key );
2647
			$file_data_option = false;
2648
		}
2649
2650
		if ( false === $file_data_option ) {
2651
			$file_data_option = array();
2652
		}
2653
2654
		$key           = md5( $file_name . serialize( $headers ) );
2655
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2656
2657
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2658
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2659
			return $file_data_option[ $key ];
2660
		}
2661
2662
		$data = get_file_data( $file, $headers );
2663
2664
		$file_data_option[ $key ] = $data;
2665
2666
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2667
2668
		return $data;
2669
	}
2670
2671
2672
	/**
2673
	 * Return translated module tag.
2674
	 *
2675
	 * @param string $tag Tag as it appears in each module heading.
2676
	 *
2677
	 * @return mixed
2678
	 */
2679
	public static function translate_module_tag( $tag ) {
2680
		return jetpack_get_module_i18n_tag( $tag );
2681
	}
2682
2683
	/**
2684
	 * Get i18n strings as a JSON-encoded string
2685
	 *
2686
	 * @return string The locale as JSON
2687
	 */
2688
	public static function get_i18n_data_json() {
2689
2690
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2691
		// JSON files with the file they should be included for. This is an md5
2692
		// of '_inc/build/admin.js'.
2693
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2694
2695
		$i18n_json =
2696
				   JETPACK__PLUGIN_DIR
2697
				   . 'languages/json/jetpack-'
2698
				   . get_user_locale()
2699
				   . '-'
2700
				   . $path_md5
2701
				   . '.json';
2702
2703
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2704
			$locale_data = @file_get_contents( $i18n_json );
2705
			if ( $locale_data ) {
2706
				return $locale_data;
2707
			}
2708
		}
2709
2710
		// Return valid empty Jed locale
2711
		return '{ "locale_data": { "messages": { "": {} } } }';
2712
	}
2713
2714
	/**
2715
	 * Add locale data setup to wp-i18n
2716
	 *
2717
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2718
	 *
2719
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2720
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2721
	 *
2722
	 * This method provides a safe way to request the setup multiple times but add the script at
2723
	 * most once.
2724
	 *
2725
	 * @since 6.7.0
2726
	 *
2727
	 * @return void
2728
	 */
2729
	public static function setup_wp_i18n_locale_data() {
2730
		static $script_added = false;
2731
		if ( ! $script_added ) {
2732
			$script_added = true;
2733
			wp_add_inline_script(
2734
				'wp-i18n',
2735
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2736
			);
2737
		}
2738
	}
2739
2740
	/**
2741
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2742
	 *
2743
	 * @since 3.9.2
2744
	 *
2745
	 * @param array $modules
2746
	 *
2747
	 * @return string|void
2748
	 */
2749
	public static function get_translated_modules( $modules ) {
2750
		foreach ( $modules as $index => $module ) {
2751
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2752
			if ( isset( $module['name'] ) ) {
2753
				$modules[ $index ]['name'] = $i18n_module['name'];
2754
			}
2755
			if ( isset( $module['description'] ) ) {
2756
				$modules[ $index ]['description']       = $i18n_module['description'];
2757
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2758
			}
2759
		}
2760
		return $modules;
2761
	}
2762
2763
	/**
2764
	 * Get a list of activated modules as an array of module slugs.
2765
	 */
2766
	public static function get_active_modules() {
2767
		$active = Jetpack_Options::get_option( 'active_modules' );
2768
2769
		if ( ! is_array( $active ) ) {
2770
			$active = array();
2771
		}
2772
2773
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2774
			$active[] = 'vaultpress';
2775
		} else {
2776
			$active = array_diff( $active, array( 'vaultpress' ) );
2777
		}
2778
2779
		// If protect is active on the main site of a multisite, it should be active on all sites.
2780
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2781
			$active[] = 'protect';
2782
		}
2783
2784
		/**
2785
		 * Allow filtering of the active modules.
2786
		 *
2787
		 * Gives theme and plugin developers the power to alter the modules that
2788
		 * are activated on the fly.
2789
		 *
2790
		 * @since 5.8.0
2791
		 *
2792
		 * @param array $active Array of active module slugs.
2793
		 */
2794
		$active = apply_filters( 'jetpack_active_modules', $active );
2795
2796
		return array_unique( $active );
2797
	}
2798
2799
	/**
2800
	 * Check whether or not a Jetpack module is active.
2801
	 *
2802
	 * @param string $module The slug of a Jetpack module.
2803
	 * @return bool
2804
	 *
2805
	 * @static
2806
	 */
2807
	public static function is_module_active( $module ) {
2808
		return in_array( $module, self::get_active_modules() );
2809
	}
2810
2811
	public static function is_module( $module ) {
2812
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2813
	}
2814
2815
	/**
2816
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2817
	 *
2818
	 * @param bool $catch True to start catching, False to stop.
2819
	 *
2820
	 * @static
2821
	 */
2822
	public static function catch_errors( $catch ) {
2823
		static $display_errors, $error_reporting;
2824
2825
		if ( $catch ) {
2826
			$display_errors  = @ini_set( 'display_errors', 1 );
2827
			$error_reporting = @error_reporting( E_ALL );
2828
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2829
		} else {
2830
			@ini_set( 'display_errors', $display_errors );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2831
			@error_reporting( $error_reporting );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2832
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2833
		}
2834
	}
2835
2836
	/**
2837
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2838
	 */
2839
	public static function catch_errors_on_shutdown() {
2840
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2841
	}
2842
2843
	/**
2844
	 * Rewrite any string to make paths easier to read.
2845
	 *
2846
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2847
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2848
	 *
2849
	 * @param $string
2850
	 * @return mixed
2851
	 */
2852
	public static function alias_directories( $string ) {
2853
		// ABSPATH has a trailing slash.
2854
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2855
		// WP_CONTENT_DIR does not have a trailing slash.
2856
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2857
2858
		return $string;
2859
	}
2860
2861
	public static function activate_default_modules(
2862
		$min_version = false,
2863
		$max_version = false,
2864
		$other_modules = array(),
2865
		$redirect = null,
2866
		$send_state_messages = null
2867
	) {
2868
		$jetpack = self::init();
2869
2870
		if ( is_null( $redirect ) ) {
2871
			if (
2872
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2873
			||
2874
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2875
			||
2876
				( defined( 'WP_CLI' ) && WP_CLI )
2877
			||
2878
				( defined( 'DOING_CRON' ) && DOING_CRON )
2879
			||
2880
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2881
			) {
2882
				$redirect = false;
2883
			} elseif ( is_admin() ) {
2884
				$redirect = true;
2885
			} else {
2886
				$redirect = false;
2887
			}
2888
		}
2889
2890
		if ( is_null( $send_state_messages ) ) {
2891
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2892
		}
2893
2894
		$modules = self::get_default_modules( $min_version, $max_version );
2895
		$modules = array_merge( $other_modules, $modules );
2896
2897
		// Look for standalone plugins and disable if active.
2898
2899
		$to_deactivate = array();
2900
		foreach ( $modules as $module ) {
2901
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2902
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2903
			}
2904
		}
2905
2906
		$deactivated = array();
2907
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2908
			list( $probable_file, $probable_title ) = $deactivate_me;
2909
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2910
				$deactivated[] = $module;
2911
			}
2912
		}
2913
2914
		if ( $deactivated ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2915
			if ( $send_state_messages ) {
2916
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2917
			}
2918
2919
			if ( $redirect ) {
2920
				$url = add_query_arg(
2921
					array(
2922
						'action'   => 'activate_default_modules',
2923
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2924
					),
2925
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2926
				);
2927
				wp_safe_redirect( $url );
2928
				exit;
2929
			}
2930
		}
2931
2932
		/**
2933
		 * Fires before default modules are activated.
2934
		 *
2935
		 * @since 1.9.0
2936
		 *
2937
		 * @param string $min_version Minimum version number required to use modules.
2938
		 * @param string $max_version Maximum version number required to use modules.
2939
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2940
		 */
2941
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2942
2943
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2944
		if ( $send_state_messages ) {
2945
			self::restate();
2946
			self::catch_errors( true );
2947
		}
2948
2949
		$active = self::get_active_modules();
2950
2951
		foreach ( $modules as $module ) {
2952
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2953
				$active[] = $module;
2954
				self::update_active_modules( $active );
2955
				continue;
2956
			}
2957
2958
			if ( $send_state_messages && in_array( $module, $active ) ) {
2959
				$module_info = self::get_module( $module );
2960 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2961
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2962
					if ( $active_state = self::state( $state ) ) {
2963
						$active_state = explode( ',', $active_state );
2964
					} else {
2965
						$active_state = array();
2966
					}
2967
					$active_state[] = $module;
2968
					self::state( $state, implode( ',', $active_state ) );
2969
				}
2970
				continue;
2971
			}
2972
2973
			$file = self::get_module_path( $module );
2974
			if ( ! file_exists( $file ) ) {
2975
				continue;
2976
			}
2977
2978
			// we'll override this later if the plugin can be included without fatal error
2979
			if ( $redirect ) {
2980
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2981
			}
2982
2983
			if ( $send_state_messages ) {
2984
				self::state( 'error', 'module_activation_failed' );
2985
				self::state( 'module', $module );
2986
			}
2987
2988
			ob_start();
2989
			require_once $file;
2990
2991
			$active[] = $module;
2992
2993 View Code Duplication
			if ( $send_state_messages ) {
2994
2995
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2996
				if ( $active_state = self::state( $state ) ) {
2997
					$active_state = explode( ',', $active_state );
2998
				} else {
2999
					$active_state = array();
3000
				}
3001
				$active_state[] = $module;
3002
				self::state( $state, implode( ',', $active_state ) );
3003
			}
3004
3005
			self::update_active_modules( $active );
3006
3007
			ob_end_clean();
3008
		}
3009
3010
		if ( $send_state_messages ) {
3011
			self::state( 'error', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3012
			self::state( 'module', false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3013
		}
3014
3015
		self::catch_errors( false );
3016
		/**
3017
		 * Fires when default modules are activated.
3018
		 *
3019
		 * @since 1.9.0
3020
		 *
3021
		 * @param string $min_version Minimum version number required to use modules.
3022
		 * @param string $max_version Maximum version number required to use modules.
3023
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3024
		 */
3025
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3026
	}
3027
3028
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3029
		/**
3030
		 * Fires before a module is activated.
3031
		 *
3032
		 * @since 2.6.0
3033
		 *
3034
		 * @param string $module Module slug.
3035
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3036
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3037
		 */
3038
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3039
3040
		$jetpack = self::init();
3041
3042
		if ( ! strlen( $module ) ) {
3043
			return false;
3044
		}
3045
3046
		if ( ! self::is_module( $module ) ) {
3047
			return false;
3048
		}
3049
3050
		// If it's already active, then don't do it again
3051
		$active = self::get_active_modules();
3052
		foreach ( $active as $act ) {
3053
			if ( $act == $module ) {
3054
				return true;
3055
			}
3056
		}
3057
3058
		$module_data = self::get_module( $module );
3059
3060
		$is_development_mode = ( new Status() )->is_development_mode();
3061
		if ( ! self::is_active() ) {
3062
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3063
				return false;
3064
			}
3065
3066
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3067
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3068
				return false;
3069
			}
3070
		}
3071
3072
		// Check and see if the old plugin is active
3073
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3074
			// Deactivate the old plugin
3075
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3076
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3077
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3078
				self::state( 'deactivated_plugins', $module );
3079
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3080
				exit;
3081
			}
3082
		}
3083
3084
		// Protect won't work with mis-configured IPs
3085
		if ( 'protect' === $module ) {
3086
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3087
			if ( ! jetpack_protect_get_ip() ) {
3088
				self::state( 'message', 'protect_misconfigured_ip' );
3089
				return false;
3090
			}
3091
		}
3092
3093
		if ( ! Jetpack_Plan::supports( $module ) ) {
3094
			return false;
3095
		}
3096
3097
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3098
		self::state( 'module', $module );
3099
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3100
3101
		self::catch_errors( true );
3102
		ob_start();
3103
		require self::get_module_path( $module );
3104
		/** This action is documented in class.jetpack.php */
3105
		do_action( 'jetpack_activate_module', $module );
3106
		$active[] = $module;
3107
		self::update_active_modules( $active );
3108
3109
		self::state( 'error', false ); // the override
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3110
		ob_end_clean();
3111
		self::catch_errors( false );
3112
3113
		if ( $redirect ) {
3114
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3115
		}
3116
		if ( $exit ) {
3117
			exit;
3118
		}
3119
		return true;
3120
	}
3121
3122
	function activate_module_actions( $module ) {
3123
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3124
	}
3125
3126
	public static function deactivate_module( $module ) {
3127
		/**
3128
		 * Fires when a module is deactivated.
3129
		 *
3130
		 * @since 1.9.0
3131
		 *
3132
		 * @param string $module Module slug.
3133
		 */
3134
		do_action( 'jetpack_pre_deactivate_module', $module );
3135
3136
		$jetpack = self::init();
0 ignored issues
show
Unused Code introduced by
$jetpack is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3137
3138
		$active = self::get_active_modules();
3139
		$new    = array_filter( array_diff( $active, (array) $module ) );
3140
3141
		return self::update_active_modules( $new );
3142
	}
3143
3144
	public static function enable_module_configurable( $module ) {
3145
		$module = self::get_module_slug( $module );
3146
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3147
	}
3148
3149
	/**
3150
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3151
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3152
	 *
3153
	 * @param string $module Module slug
3154
	 * @return string $url module configuration URL
3155
	 */
3156
	public static function module_configuration_url( $module ) {
3157
		$module      = self::get_module_slug( $module );
3158
		$default_url = self::admin_url() . "#/settings?term=$module";
3159
		/**
3160
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3161
		 *
3162
		 * @since 6.9.0
3163
		 *
3164
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3165
		 */
3166
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3167
3168
		return $url;
3169
	}
3170
3171
	/* Installation */
3172
	public static function bail_on_activation( $message, $deactivate = true ) {
3173
		?>
3174
<!doctype html>
3175
<html>
3176
<head>
3177
<meta charset="<?php bloginfo( 'charset' ); ?>">
3178
<style>
3179
* {
3180
	text-align: center;
3181
	margin: 0;
3182
	padding: 0;
3183
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3184
}
3185
p {
3186
	margin-top: 1em;
3187
	font-size: 18px;
3188
}
3189
</style>
3190
<body>
3191
<p><?php echo esc_html( $message ); ?></p>
3192
</body>
3193
</html>
3194
		<?php
3195
		if ( $deactivate ) {
3196
			$plugins = get_option( 'active_plugins' );
3197
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3198
			$update  = false;
3199
			foreach ( $plugins as $i => $plugin ) {
3200
				if ( $plugin === $jetpack ) {
3201
					$plugins[ $i ] = false;
3202
					$update        = true;
3203
				}
3204
			}
3205
3206
			if ( $update ) {
3207
				update_option( 'active_plugins', array_filter( $plugins ) );
3208
			}
3209
		}
3210
		exit;
3211
	}
3212
3213
	/**
3214
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3215
	 *
3216
	 * @static
3217
	 */
3218
	public static function plugin_activation( $network_wide ) {
3219
		Jetpack_Options::update_option( 'activated', 1 );
3220
3221
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3222
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3223
		}
3224
3225
		if ( $network_wide ) {
3226
			self::state( 'network_nag', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3227
		}
3228
3229
		// For firing one-off events (notices) immediately after activation
3230
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3231
3232
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3233
3234
		Health::on_jetpack_activated();
3235
3236
		self::plugin_initialize();
3237
	}
3238
3239
	public static function get_activation_source( $referer_url ) {
3240
3241
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3242
			return array( 'wp-cli', null );
3243
		}
3244
3245
		$referer = wp_parse_url( $referer_url );
3246
3247
		$source_type  = 'unknown';
3248
		$source_query = null;
3249
3250
		if ( ! is_array( $referer ) ) {
3251
			return array( $source_type, $source_query );
3252
		}
3253
3254
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3255
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3256
3257
		if ( isset( $referer['query'] ) ) {
3258
			parse_str( $referer['query'], $query_parts );
3259
		} else {
3260
			$query_parts = array();
3261
		}
3262
3263
		if ( $plugins_path === $referer['path'] ) {
3264
			$source_type = 'list';
3265
		} elseif ( $plugins_install_path === $referer['path'] ) {
3266
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3267
			switch ( $tab ) {
3268
				case 'popular':
3269
					$source_type = 'popular';
3270
					break;
3271
				case 'recommended':
3272
					$source_type = 'recommended';
3273
					break;
3274
				case 'favorites':
3275
					$source_type = 'favorites';
3276
					break;
3277
				case 'search':
3278
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3279
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3280
					break;
3281
				default:
3282
					$source_type = 'featured';
3283
			}
3284
		}
3285
3286
		return array( $source_type, $source_query );
3287
	}
3288
3289
	/**
3290
	 * Runs before bumping version numbers up to a new version
3291
	 *
3292
	 * @param  string $version    Version:timestamp
3293
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3294
	 * @return null              [description]
3295
	 */
3296
	public static function do_version_bump( $version, $old_version ) {
3297
		if ( ! $old_version ) { // For new sites
3298
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3299
		}
3300
	}
3301
3302
	/**
3303
	 * Sets the internal version number and activation state.
3304
	 *
3305
	 * @static
3306
	 */
3307
	public static function plugin_initialize() {
3308
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3309
			Jetpack_Options::update_option( 'activated', 2 );
3310
		}
3311
3312 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3313
			$version = $old_version = JETPACK__VERSION . ':' . time();
3314
			/** This action is documented in class.jetpack.php */
3315
			do_action( 'updating_jetpack_version', $version, false );
3316
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3317
		}
3318
3319
		self::load_modules();
3320
3321
		Jetpack_Options::delete_option( 'do_activate' );
3322
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3323
	}
3324
3325
	/**
3326
	 * Removes all connection options
3327
	 *
3328
	 * @static
3329
	 */
3330
	public static function plugin_deactivation() {
3331
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3332
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3333
			Jetpack_Network::init()->deactivate();
3334
		} else {
3335
			self::disconnect( false );
3336
			// Jetpack_Heartbeat::init()->deactivate();
3337
		}
3338
	}
3339
3340
	/**
3341
	 * Disconnects from the Jetpack servers.
3342
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3343
	 *
3344
	 * @static
3345
	 */
3346
	public static function disconnect( $update_activated_state = true ) {
3347
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3348
		$connection = self::connection();
3349
		$connection->clean_nonces( true );
3350
3351
		// If the site is in an IDC because sync is not allowed,
3352
		// let's make sure to not disconnect the production site.
3353
		if ( ! self::validate_sync_error_idc_option() ) {
3354
			$tracking = new Tracking();
3355
			$tracking->record_user_event( 'disconnect_site', array() );
3356
3357
			$connection->disconnect_site_wpcom();
3358
		}
3359
3360
		$connection->delete_all_connection_tokens();
3361
		Jetpack_IDC::clear_all_idc_options();
3362
3363
		if ( $update_activated_state ) {
3364
			Jetpack_Options::update_option( 'activated', 4 );
3365
		}
3366
3367
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3368
			// Check then record unique disconnection if site has never been disconnected previously
3369
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3370
				$jetpack_unique_connection['disconnected'] = 1;
3371
			} else {
3372
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3373
					// track unique disconnect
3374
					$jetpack = self::init();
3375
3376
					$jetpack->stat( 'connections', 'unique-disconnect' );
3377
					$jetpack->do_stats( 'server_side' );
3378
				}
3379
				// increment number of times disconnected
3380
				$jetpack_unique_connection['disconnected'] += 1;
3381
			}
3382
3383
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3384
		}
3385
3386
		// Delete all the sync related data. Since it could be taking up space.
3387
		Sender::get_instance()->uninstall();
3388
3389
		// Disable the Heartbeat cron
3390
		Jetpack_Heartbeat::init()->deactivate();
3391
	}
3392
3393
	/**
3394
	 * Unlinks the current user from the linked WordPress.com user.
3395
	 *
3396
	 * @deprecated since 7.7
3397
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3398
	 *
3399
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
3400
	 * @return Boolean Whether the disconnection of the user was successful.
3401
	 */
3402
	public static function unlink_user( $user_id = null ) {
3403
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3404
		return Connection_Manager::disconnect_user( $user_id );
3405
	}
3406
3407
	/**
3408
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3409
	 */
3410
	public static function try_registration() {
3411
		$terms_of_service = new Terms_Of_Service();
3412
		// The user has agreed to the TOS at some point by now.
3413
		$terms_of_service->agree();
3414
3415
		// Let's get some testing in beta versions and such.
3416
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3417
			// Before attempting to connect, let's make sure that the domains are viable.
3418
			$domains_to_check = array_unique(
3419
				array(
3420
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3421
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3422
				)
3423
			);
3424
			foreach ( $domains_to_check as $domain ) {
3425
				$result = self::connection()->is_usable_domain( $domain );
3426
				if ( is_wp_error( $result ) ) {
3427
					return $result;
3428
				}
3429
			}
3430
		}
3431
3432
		$result = self::register();
3433
3434
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3435
		if ( ! $result || is_wp_error( $result ) ) {
3436
			return $result;
3437
		} else {
3438
			return true;
3439
		}
3440
	}
3441
3442
	/**
3443
	 * Tracking an internal event log. Try not to put too much chaff in here.
3444
	 *
3445
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3446
	 */
3447
	public static function log( $code, $data = null ) {
3448
		// only grab the latest 200 entries
3449
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3450
3451
		// Append our event to the log
3452
		$log_entry = array(
3453
			'time'    => time(),
3454
			'user_id' => get_current_user_id(),
3455
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3456
			'code'    => $code,
3457
		);
3458
		// Don't bother storing it unless we've got some.
3459
		if ( ! is_null( $data ) ) {
3460
			$log_entry['data'] = $data;
3461
		}
3462
		$log[] = $log_entry;
3463
3464
		// Try add_option first, to make sure it's not autoloaded.
3465
		// @todo: Add an add_option method to Jetpack_Options
3466
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3467
			Jetpack_Options::update_option( 'log', $log );
3468
		}
3469
3470
		/**
3471
		 * Fires when Jetpack logs an internal event.
3472
		 *
3473
		 * @since 3.0.0
3474
		 *
3475
		 * @param array $log_entry {
3476
		 *  Array of details about the log entry.
3477
		 *
3478
		 *  @param string time Time of the event.
3479
		 *  @param int user_id ID of the user who trigerred the event.
3480
		 *  @param int blog_id Jetpack Blog ID.
3481
		 *  @param string code Unique name for the event.
3482
		 *  @param string data Data about the event.
3483
		 * }
3484
		 */
3485
		do_action( 'jetpack_log_entry', $log_entry );
3486
	}
3487
3488
	/**
3489
	 * Get the internal event log.
3490
	 *
3491
	 * @param $event (string) - only return the specific log events
3492
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3493
	 *
3494
	 * @return array of log events || WP_Error for invalid params
3495
	 */
3496
	public static function get_log( $event = false, $num = false ) {
3497
		if ( $event && ! is_string( $event ) ) {
3498
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('First param must be ...g or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3499
		}
3500
3501
		if ( $num && ! is_numeric( $num ) ) {
3502
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with __('Second param must be...c or empty', 'jetpack').

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3503
		}
3504
3505
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3506
3507
		// If nothing set - act as it did before, otherwise let's start customizing the output
3508
		if ( ! $num && ! $event ) {
3509
			return $entire_log;
3510
		} else {
3511
			$entire_log = array_reverse( $entire_log );
3512
		}
3513
3514
		$custom_log_output = array();
3515
3516
		if ( $event ) {
3517
			foreach ( $entire_log as $log_event ) {
3518
				if ( $event == $log_event['code'] ) {
3519
					$custom_log_output[] = $log_event;
3520
				}
3521
			}
3522
		} else {
3523
			$custom_log_output = $entire_log;
3524
		}
3525
3526
		if ( $num ) {
3527
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3528
		}
3529
3530
		return $custom_log_output;
3531
	}
3532
3533
	/**
3534
	 * Log modification of important settings.
3535
	 */
3536
	public static function log_settings_change( $option, $old_value, $value ) {
3537
		switch ( $option ) {
3538
			case 'jetpack_sync_non_public_post_stati':
3539
				self::log( $option, $value );
3540
				break;
3541
		}
3542
	}
3543
3544
	/**
3545
	 * Return stat data for WPCOM sync
3546
	 */
3547
	public static function get_stat_data( $encode = true, $extended = true ) {
3548
		$data = Jetpack_Heartbeat::generate_stats_array();
3549
3550
		if ( $extended ) {
3551
			$additional_data = self::get_additional_stat_data();
3552
			$data            = array_merge( $data, $additional_data );
3553
		}
3554
3555
		if ( $encode ) {
3556
			return json_encode( $data );
3557
		}
3558
3559
		return $data;
3560
	}
3561
3562
	/**
3563
	 * Get additional stat data to sync to WPCOM
3564
	 */
3565
	public static function get_additional_stat_data( $prefix = '' ) {
3566
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
3567
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3568
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3569
		$return[ "{$prefix}site-count" ]    = 0;
3570
3571
		if ( function_exists( 'get_blog_count' ) ) {
3572
			$return[ "{$prefix}site-count" ] = get_blog_count();
3573
		}
3574
		return $return;
3575
	}
3576
3577
	private static function get_site_user_count() {
3578
		global $wpdb;
3579
3580
		if ( function_exists( 'wp_is_large_network' ) ) {
3581
			if ( wp_is_large_network( 'users' ) ) {
3582
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3583
			}
3584
		}
3585
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3586
			// It wasn't there, so regenerate the data and save the transient
3587
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3588
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3589
		}
3590
		return $user_count;
3591
	}
3592
3593
	/* Admin Pages */
3594
3595
	function admin_init() {
3596
		// If the plugin is not connected, display a connect message.
3597
		if (
3598
			// the plugin was auto-activated and needs its candy
3599
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3600
		||
3601
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3602
			! Jetpack_Options::get_option( 'activated' )
3603
		) {
3604
			self::plugin_initialize();
3605
		}
3606
3607
		$is_development_mode = ( new Status() )->is_development_mode();
3608
		if ( ! self::is_active() && ! $is_development_mode ) {
3609
			Jetpack_Connection_Banner::init();
3610
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3611
			// Upgrade: 1.1 -> 1.1.1
3612
			// Check and see if host can verify the Jetpack servers' SSL certificate
3613
			$args       = array();
3614
			$connection = self::connection();
3615
			Client::_wp_remote_request(
3616
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3617
				$args,
3618
				true
3619
			);
3620
		}
3621
3622
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3623
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3624
		}
3625
3626
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3627
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3628
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3629
3630
		if ( self::is_active() || $is_development_mode ) {
3631
			// Artificially throw errors in certain whitelisted cases during plugin activation
3632
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3633
		}
3634
3635
		// Add custom column in wp-admin/users.php to show whether user is linked.
3636
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3637
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3638
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3639
	}
3640
3641
	function admin_body_class( $admin_body_class = '' ) {
3642
		$classes = explode( ' ', trim( $admin_body_class ) );
3643
3644
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3645
3646
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3647
		return " $admin_body_class ";
3648
	}
3649
3650
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3651
		return $admin_body_class . ' jetpack-pagestyles ';
3652
	}
3653
3654
	/**
3655
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3656
	 * This function artificially throws errors for such cases (whitelisted).
3657
	 *
3658
	 * @param string $plugin The activated plugin.
3659
	 */
3660
	function throw_error_on_activate_plugin( $plugin ) {
3661
		$active_modules = self::get_active_modules();
3662
3663
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3664
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3665
			$throw = false;
3666
3667
			// Try and make sure it really was the stats plugin
3668
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3669
				if ( 'stats.php' == basename( $plugin ) ) {
3670
					$throw = true;
3671
				}
3672
			} else {
3673
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3674
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3675
					$throw = true;
3676
				}
3677
			}
3678
3679
			if ( $throw ) {
3680
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3681
			}
3682
		}
3683
	}
3684
3685
	function intercept_plugin_error_scrape_init() {
3686
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3687
	}
3688
3689
	function intercept_plugin_error_scrape( $action, $result ) {
3690
		if ( ! $result ) {
3691
			return;
3692
		}
3693
3694
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3695
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3696
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3697
			}
3698
		}
3699
	}
3700
3701
	/**
3702
	 * Register the remote file upload request handlers, if needed.
3703
	 *
3704
	 * @access public
3705
	 */
3706
	public function add_remote_request_handlers() {
3707
		// Remote file uploads are allowed only via AJAX requests.
3708
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3709
			return;
3710
		}
3711
3712
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3713
		$remote_request_actions = array(
3714
			'jetpack_upload_file',
3715
			'jetpack_update_file',
3716
		);
3717
3718
		// phpcs:ignore WordPress.Security.NonceVerification
3719
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3720
			return;
3721
		}
3722
3723
		// Require Jetpack authentication for the remote file upload AJAX requests.
3724
		if ( ! $this->connection_manager ) {
3725
			$this->connection_manager = new Connection_Manager();
3726
		}
3727
3728
		$this->connection_manager->require_jetpack_authentication();
3729
3730
		// Register the remote file upload AJAX handlers.
3731
		foreach ( $remote_request_actions as $action ) {
3732
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3733
		}
3734
	}
3735
3736
	/**
3737
	 * Handler for Jetpack remote file uploads.
3738
	 *
3739
	 * @access public
3740
	 */
3741
	public function remote_request_handlers() {
3742
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3743
3744
		switch ( current_filter() ) {
3745
			case 'wp_ajax_nopriv_jetpack_upload_file':
3746
				$response = $this->upload_handler();
3747
				break;
3748
3749
			case 'wp_ajax_nopriv_jetpack_update_file':
3750
				$response = $this->upload_handler( true );
3751
				break;
3752
			default:
3753
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_handler'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3754
				break;
3755
		}
3756
3757
		if ( ! $response ) {
3758
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_error'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3759
		}
3760
3761
		if ( is_wp_error( $response ) ) {
3762
			$status_code       = $response->get_error_data();
0 ignored issues
show
Bug introduced by
The method get_error_data() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3763
			$error             = $response->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3764
			$error_description = $response->get_error_message();
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<Jetpack_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
3765
3766
			if ( ! is_int( $status_code ) ) {
3767
				$status_code = 400;
3768
			}
3769
3770
			status_header( $status_code );
3771
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3772
		}
3773
3774
		status_header( 200 );
3775
		if ( true === $response ) {
3776
			exit;
3777
		}
3778
3779
		die( json_encode( (object) $response ) );
3780
	}
3781
3782
	/**
3783
	 * Uploads a file gotten from the global $_FILES.
3784
	 * If `$update_media_item` is true and `post_id` is defined
3785
	 * the attachment file of the media item (gotten through of the post_id)
3786
	 * will be updated instead of add a new one.
3787
	 *
3788
	 * @param  boolean $update_media_item - update media attachment
3789
	 * @return array - An array describing the uploadind files process
3790
	 */
3791
	function upload_handler( $update_media_item = false ) {
3792
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3793
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 405.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3794
		}
3795
3796
		$user = wp_authenticate( '', '' );
3797
		if ( ! $user || is_wp_error( $user ) ) {
3798
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 403.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3799
		}
3800
3801
		wp_set_current_user( $user->ID );
3802
3803
		if ( ! current_user_can( 'upload_files' ) ) {
3804
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3805
		}
3806
3807
		if ( empty( $_FILES ) ) {
3808
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'no_files_uploaded'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3809
		}
3810
3811
		foreach ( array_keys( $_FILES ) as $files_key ) {
3812
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3813
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'missing_hmac'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3814
			}
3815
		}
3816
3817
		$media_keys = array_keys( $_FILES['media'] );
3818
3819
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
3820
		if ( ! $token || is_wp_error( $token ) ) {
3821
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_token'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3822
		}
3823
3824
		$uploaded_files = array();
3825
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3826
		unset( $GLOBALS['post'] );
3827
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3828
			$file = array();
3829
			foreach ( $media_keys as $media_key ) {
3830
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3831
			}
3832
3833
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3834
3835
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3836
			if ( $hmac_provided !== $hmac_file ) {
3837
				$uploaded_files[ $index ] = (object) array(
3838
					'error'             => 'invalid_hmac',
3839
					'error_description' => 'The corresponding HMAC for this file does not match',
3840
				);
3841
				continue;
3842
			}
3843
3844
			$_FILES['.jetpack.upload.'] = $file;
3845
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3846
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3847
				$post_id = 0;
3848
			}
3849
3850
			if ( $update_media_item ) {
3851
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3852
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'invalid_input'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3853
				}
3854
3855
				$media_array = $_FILES['media'];
3856
3857
				$file_array['name']     = $media_array['name'][0];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$file_array was never initialized. Although not strictly required by PHP, it is generally a good practice to add $file_array = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
3858
				$file_array['type']     = $media_array['type'][0];
3859
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3860
				$file_array['error']    = $media_array['error'][0];
3861
				$file_array['size']     = $media_array['size'][0];
3862
3863
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3864
3865
				if ( is_wp_error( $edited_media_item ) ) {
3866
					return $edited_media_item;
3867
				}
3868
3869
				$response = (object) array(
3870
					'id'   => (string) $post_id,
3871
					'file' => (string) $edited_media_item->post_title,
3872
					'url'  => (string) wp_get_attachment_url( $post_id ),
3873
					'type' => (string) $edited_media_item->post_mime_type,
3874
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3875
				);
3876
3877
				return (array) array( $response );
3878
			}
3879
3880
			$attachment_id = media_handle_upload(
3881
				'.jetpack.upload.',
3882
				$post_id,
3883
				array(),
3884
				array(
3885
					'action' => 'jetpack_upload_file',
3886
				)
3887
			);
3888
3889
			if ( ! $attachment_id ) {
3890
				$uploaded_files[ $index ] = (object) array(
3891
					'error'             => 'unknown',
3892
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3893
				);
3894
			} elseif ( is_wp_error( $attachment_id ) ) {
3895
				$uploaded_files[ $index ] = (object) array(
3896
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3897
					'error_description' => $attachment_id->get_error_message(),
3898
				);
3899
			} else {
3900
				$attachment               = get_post( $attachment_id );
3901
				$uploaded_files[ $index ] = (object) array(
3902
					'id'   => (string) $attachment_id,
3903
					'file' => $attachment->post_title,
3904
					'url'  => wp_get_attachment_url( $attachment_id ),
3905
					'type' => $attachment->post_mime_type,
3906
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3907
				);
3908
				// Zip files uploads are not supported unless they are done for installation purposed
3909
				// lets delete them in case something goes wrong in this whole process
3910
				if ( 'application/zip' === $attachment->post_mime_type ) {
3911
					// Schedule a cleanup for 2 hours from now in case of failed install.
3912
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3913
				}
3914
			}
3915
		}
3916
		if ( ! is_null( $global_post ) ) {
3917
			$GLOBALS['post'] = $global_post;
3918
		}
3919
3920
		return $uploaded_files;
3921
	}
3922
3923
	/**
3924
	 * Add help to the Jetpack page
3925
	 *
3926
	 * @since Jetpack (1.2.3)
3927
	 * @return false if not the Jetpack page
3928
	 */
3929
	function admin_help() {
3930
		$current_screen = get_current_screen();
3931
3932
		// Overview
3933
		$current_screen->add_help_tab(
3934
			array(
3935
				'id'      => 'home',
3936
				'title'   => __( 'Home', 'jetpack' ),
3937
				'content' =>
3938
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3939
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3940
					'<p>' . __( 'On this page, you are able to view the modules available within Jetpack, learn more about them, and activate or deactivate them as needed.', 'jetpack' ) . '</p>',
3941
			)
3942
		);
3943
3944
		// Screen Content
3945
		if ( current_user_can( 'manage_options' ) ) {
3946
			$current_screen->add_help_tab(
3947
				array(
3948
					'id'      => 'settings',
3949
					'title'   => __( 'Settings', 'jetpack' ),
3950
					'content' =>
3951
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3952
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3953
						'<ol>' .
3954
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3955
							'<li>' . __( 'Using the checkboxes next to each module, you can select multiple modules to toggle via the Bulk Actions menu at the top of the list.', 'jetpack' ) . '</li>' .
3956
						'</ol>' .
3957
						'<p>' . __( 'Using the tools on the right, you can search for specific modules, filter by module categories or which are active, or change the sorting order.', 'jetpack' ) . '</p>',
3958
				)
3959
			);
3960
		}
3961
3962
		// Help Sidebar
3963
		$current_screen->set_help_sidebar(
3964
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3965
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3966
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3967
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3968
		);
3969
	}
3970
3971
	function admin_menu_css() {
3972
		wp_enqueue_style( 'jetpack-icons' );
3973
	}
3974
3975
	function admin_menu_order() {
3976
		return true;
3977
	}
3978
3979 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3980
		$jp_menu_order = array();
3981
3982
		foreach ( $menu_order as $index => $item ) {
3983
			if ( $item != 'jetpack' ) {
3984
				$jp_menu_order[] = $item;
3985
			}
3986
3987
			if ( $index == 0 ) {
3988
				$jp_menu_order[] = 'jetpack';
3989
			}
3990
		}
3991
3992
		return $jp_menu_order;
3993
	}
3994
3995
	function admin_banner_styles() {
3996
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3997
3998 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3999
			wp_register_style(
4000
				'jetpack-dops-style',
4001
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4002
				array(),
4003
				JETPACK__VERSION
4004
			);
4005
		}
4006
4007
		wp_enqueue_style(
4008
			'jetpack',
4009
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4010
			array( 'jetpack-dops-style' ),
4011
			JETPACK__VERSION . '-20121016'
4012
		);
4013
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4014
		wp_style_add_data( 'jetpack', 'suffix', $min );
4015
	}
4016
4017
	function plugin_action_links( $actions ) {
4018
4019
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4020
4021
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4022
			return array_merge(
4023
				$jetpack_home,
4024
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4025
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4026
				$actions
4027
			);
4028
		}
4029
4030
		return array_merge( $jetpack_home, $actions );
4031
	}
4032
4033
	/**
4034
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4035
	 *
4036
	 * @param string $login_url The wp-login URL.
4037
	 * @param string $redirect  URL to redirect users after logging in.
4038
	 * @since Jetpack 8.4
4039
	 * @return string
4040
	 */
4041
	public function login_url( $login_url, $redirect ) {
4042
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4043
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4044
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4045
		}
4046
		return $login_url;
4047
	}
4048
4049
	/**
4050
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4051
	 *
4052
	 * @since Jetpack 8.4
4053
	 */
4054
	public function login_init() {
4055
		// phpcs:ignore WordPress.Security.NonceVerification
4056
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4057
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4058
			wp_safe_redirect(
4059
				add_query_arg(
4060
					array(
4061
						'forceInstall' => 1,
4062
						'url'          => rawurlencode( get_site_url() ),
4063
					),
4064
					// @todo provide way to go to specific calypso env.
4065
					self::get_calypso_host() . 'jetpack/connect'
4066
				)
4067
			);
4068
			exit;
4069
		}
4070
	}
4071
4072
	/*
4073
	 * Registration flow:
4074
	 * 1 - ::admin_page_load() action=register
4075
	 * 2 - ::try_registration()
4076
	 * 3 - ::register()
4077
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4078
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4079
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4080
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4081
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4082
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4083
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4084
	 *       jetpack_id, jetpack_secret, jetpack_public
4085
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4086
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4087
	 * 5 - user logs in with WP.com account
4088
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4089
	 *		- Manager::authorize()
4090
	 *		- Manager::get_token()
4091
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4092
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4093
	 *			- which responds with access_token, token_type, scope
4094
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4095
	 *		- Jetpack::activate_default_modules()
4096
	 *     		- Deactivates deprecated plugins
4097
	 *     		- Activates all default modules
4098
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4099
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4100
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4101
	 *     Done!
4102
	 */
4103
4104
	/**
4105
	 * Handles the page load events for the Jetpack admin page
4106
	 */
4107
	function admin_page_load() {
4108
		$error = false;
4109
4110
		// Make sure we have the right body class to hook stylings for subpages off of.
4111
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4112
4113
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4114
			// Should only be used in intermediate redirects to preserve state across redirects
4115
			self::restate();
4116
		}
4117
4118
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4119
			// @todo: Add validation against a known whitelist
4120
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4121
			// User clicked in the iframe to link their accounts
4122
			if ( ! self::is_user_connected() ) {
4123
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4124
4125
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4126
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4127
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4128
4129
				if ( isset( $_GET['notes_iframe'] ) ) {
4130
					$connect_url .= '&notes_iframe';
4131
				}
4132
				wp_redirect( $connect_url );
4133
				exit;
4134
			} else {
4135
				if ( ! isset( $_GET['calypso_env'] ) ) {
4136
					self::state( 'message', 'already_authorized' );
4137
					wp_safe_redirect( self::admin_url() );
4138
					exit;
4139
				} else {
4140
					$connect_url  = $this->build_connect_url( true, false, $from );
4141
					$connect_url .= '&already_authorized=true';
4142
					wp_redirect( $connect_url );
4143
					exit;
4144
				}
4145
			}
4146
		}
4147
4148
		if ( isset( $_GET['action'] ) ) {
4149
			switch ( $_GET['action'] ) {
4150
				case 'authorize':
4151
					if ( self::is_active() && self::is_user_connected() ) {
4152
						self::state( 'message', 'already_authorized' );
4153
						wp_safe_redirect( self::admin_url() );
4154
						exit;
4155
					}
4156
					self::log( 'authorize' );
4157
					$client_server = new Jetpack_Client_Server();
4158
					$client_server->client_authorize();
4159
					exit;
4160
				case 'register':
4161
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4162
						$error = 'cheatin';
4163
						break;
4164
					}
4165
					check_admin_referer( 'jetpack-register' );
4166
					self::log( 'register' );
4167
					self::maybe_set_version_option();
4168
					$registered = self::try_registration();
4169 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4170
						$error = $registered->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4171
						self::state( 'error', $error );
4172
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4173
4174
						/**
4175
						 * Jetpack registration Error.
4176
						 *
4177
						 * @since 7.5.0
4178
						 *
4179
						 * @param string|int $error The error code.
4180
						 * @param \WP_Error $registered The error object.
4181
						 */
4182
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4183
						break;
4184
					}
4185
4186
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4187
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4188
4189
					/**
4190
					 * Jetpack registration Success.
4191
					 *
4192
					 * @since 7.5.0
4193
					 *
4194
					 * @param string $from 'from' GET parameter;
4195
					 */
4196
					do_action( 'jetpack_connection_register_success', $from );
4197
4198
					$url = $this->build_connect_url( true, $redirect, $from );
4199
4200
					if ( ! empty( $_GET['onboarding'] ) ) {
4201
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4202
					}
4203
4204
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4205
						$url = add_query_arg( 'auth_approved', 'true', $url );
4206
					}
4207
4208
					wp_redirect( $url );
4209
					exit;
4210
				case 'activate':
4211
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4212
						$error = 'cheatin';
4213
						break;
4214
					}
4215
4216
					$module = stripslashes( $_GET['module'] );
4217
					check_admin_referer( "jetpack_activate-$module" );
4218
					self::log( 'activate', $module );
4219
					if ( ! self::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression self::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4220
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4221
					}
4222
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4223
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4224
					exit;
4225
				case 'activate_default_modules':
4226
					check_admin_referer( 'activate_default_modules' );
4227
					self::log( 'activate_default_modules' );
4228
					self::restate();
4229
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4230
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4231
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4232
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4233
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4234
					exit;
4235
				case 'disconnect':
4236
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4237
						$error = 'cheatin';
4238
						break;
4239
					}
4240
4241
					check_admin_referer( 'jetpack-disconnect' );
4242
					self::log( 'disconnect' );
4243
					self::disconnect();
4244
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4245
					exit;
4246
				case 'reconnect':
4247
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4248
						$error = 'cheatin';
4249
						break;
4250
					}
4251
4252
					check_admin_referer( 'jetpack-reconnect' );
4253
					self::log( 'reconnect' );
4254
					$this->disconnect();
4255
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4256
					exit;
4257 View Code Duplication
				case 'deactivate':
4258
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4259
						$error = 'cheatin';
4260
						break;
4261
					}
4262
4263
					$modules = stripslashes( $_GET['module'] );
4264
					check_admin_referer( "jetpack_deactivate-$modules" );
4265
					foreach ( explode( ',', $modules ) as $module ) {
4266
						self::log( 'deactivate', $module );
4267
						self::deactivate_module( $module );
4268
						self::state( 'message', 'module_deactivated' );
4269
					}
4270
					self::state( 'module', $modules );
4271
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4272
					exit;
4273
				case 'unlink':
4274
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4275
					check_admin_referer( 'jetpack-unlink' );
4276
					self::log( 'unlink' );
4277
					Connection_Manager::disconnect_user();
4278
					self::state( 'message', 'unlinked' );
4279
					if ( 'sub-unlink' == $redirect ) {
4280
						wp_safe_redirect( admin_url() );
4281
					} else {
4282
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4283
					}
4284
					exit;
4285
				case 'onboard':
4286
					if ( ! current_user_can( 'manage_options' ) ) {
4287
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4288
					} else {
4289
						self::create_onboarding_token();
4290
						$url = $this->build_connect_url( true );
4291
4292
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4293
							$url = add_query_arg( 'onboarding', $token, $url );
4294
						}
4295
4296
						$calypso_env = $this->get_calypso_env();
4297
						if ( ! empty( $calypso_env ) ) {
4298
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4299
						}
4300
4301
						wp_redirect( $url );
4302
						exit;
4303
					}
4304
					exit;
4305
				default:
4306
					/**
4307
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4308
					 *
4309
					 * @since 2.6.0
4310
					 *
4311
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4312
					 */
4313
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4314
			}
4315
		}
4316
4317
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4318
			self::activate_new_modules( true );
4319
		}
4320
4321
		$message_code = self::state( 'message' );
4322
		if ( self::state( 'optin-manage' ) ) {
4323
			$activated_manage = $message_code;
4324
			$message_code     = 'jetpack-manage';
4325
		}
4326
4327
		switch ( $message_code ) {
4328
			case 'jetpack-manage':
4329
				$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' ), 'https://wordpress.com/sites' ) . '</strong>';
4330
				if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4331
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4332
				}
4333
				break;
4334
4335
		}
4336
4337
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4338
4339
		if ( ! empty( $deactivated_plugins ) ) {
4340
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4341
			$deactivated_titles  = array();
4342
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4343
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4344
					continue;
4345
				}
4346
4347
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4348
			}
4349
4350
			if ( $deactivated_titles ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated_titles of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
4351
				if ( $this->message ) {
4352
					$this->message .= "<br /><br />\n";
4353
				}
4354
4355
				$this->message .= wp_sprintf(
4356
					_n(
4357
						'Jetpack contains the most recent version of the old %l plugin.',
4358
						'Jetpack contains the most recent versions of the old %l plugins.',
4359
						count( $deactivated_titles ),
4360
						'jetpack'
4361
					),
4362
					$deactivated_titles
4363
				);
4364
4365
				$this->message .= "<br />\n";
4366
4367
				$this->message .= _n(
4368
					'The old version has been deactivated and can be removed from your site.',
4369
					'The old versions have been deactivated and can be removed from your site.',
4370
					count( $deactivated_titles ),
4371
					'jetpack'
4372
				);
4373
			}
4374
		}
4375
4376
		$this->privacy_checks = self::state( 'privacy_checks' );
4377
4378
		if ( $this->message || $this->error || $this->privacy_checks ) {
4379
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4380
		}
4381
4382
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4383
	}
4384
4385
	function admin_notices() {
4386
4387
		if ( $this->error ) {
4388
			?>
4389
<div id="message" class="jetpack-message jetpack-err">
4390
	<div class="squeezer">
4391
		<h2>
4392
			<?php
4393
			echo wp_kses(
4394
				$this->error,
4395
				array(
4396
					'a'      => array( 'href' => array() ),
4397
					'small'  => true,
4398
					'code'   => true,
4399
					'strong' => true,
4400
					'br'     => true,
4401
					'b'      => true,
4402
				)
4403
			);
4404
			?>
4405
			</h2>
4406
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4407
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4408
<?php	endif; ?>
4409
	</div>
4410
</div>
4411
			<?php
4412
		}
4413
4414
		if ( $this->message ) {
4415
			?>
4416
<div id="message" class="jetpack-message">
4417
	<div class="squeezer">
4418
		<h2>
4419
			<?php
4420
			echo wp_kses(
4421
				$this->message,
4422
				array(
4423
					'strong' => array(),
4424
					'a'      => array( 'href' => true ),
4425
					'br'     => true,
4426
				)
4427
			);
4428
			?>
4429
			</h2>
4430
	</div>
4431
</div>
4432
			<?php
4433
		}
4434
4435
		if ( $this->privacy_checks ) :
4436
			$module_names = $module_slugs = array();
4437
4438
			$privacy_checks = explode( ',', $this->privacy_checks );
4439
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4440
			foreach ( $privacy_checks as $module_slug ) {
4441
				$module = self::get_module( $module_slug );
4442
				if ( ! $module ) {
4443
					continue;
4444
				}
4445
4446
				$module_slugs[] = $module_slug;
4447
				$module_names[] = "<strong>{$module['name']}</strong>";
4448
			}
4449
4450
			$module_slugs = join( ',', $module_slugs );
4451
			?>
4452
<div id="message" class="jetpack-message jetpack-err">
4453
	<div class="squeezer">
4454
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4455
		<p>
4456
			<?php
4457
			echo wp_kses(
4458
				wptexturize(
4459
					wp_sprintf(
4460
						_nx(
4461
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4462
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4463
							count( $privacy_checks ),
4464
							'%l = list of Jetpack module/feature names',
4465
							'jetpack'
4466
						),
4467
						$module_names
4468
					)
4469
				),
4470
				array( 'strong' => true )
4471
			);
4472
4473
			echo "\n<br />\n";
4474
4475
			echo wp_kses(
4476
				sprintf(
4477
					_nx(
4478
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4479
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4480
						count( $privacy_checks ),
4481
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4482
						'jetpack'
4483
					),
4484
					wp_nonce_url(
4485
						self::admin_url(
4486
							array(
4487
								'page'   => 'jetpack',
4488
								'action' => 'deactivate',
4489
								'module' => urlencode( $module_slugs ),
4490
							)
4491
						),
4492
						"jetpack_deactivate-$module_slugs"
4493
					),
4494
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4495
				),
4496
				array(
4497
					'a' => array(
4498
						'href'  => true,
4499
						'title' => true,
4500
					),
4501
				)
4502
			);
4503
			?>
4504
		</p>
4505
	</div>
4506
</div>
4507
			<?php
4508
endif;
4509
	}
4510
4511
	/**
4512
	 * We can't always respond to a signed XML-RPC request with a
4513
	 * helpful error message. In some circumstances, doing so could
4514
	 * leak information.
4515
	 *
4516
	 * Instead, track that the error occurred via a Jetpack_Option,
4517
	 * and send that data back in the heartbeat.
4518
	 * All this does is increment a number, but it's enough to find
4519
	 * trends.
4520
	 *
4521
	 * @param WP_Error $xmlrpc_error The error produced during
4522
	 *                               signature validation.
4523
	 */
4524
	function track_xmlrpc_error( $xmlrpc_error ) {
4525
		$code = is_wp_error( $xmlrpc_error )
4526
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4527
			: 'should-not-happen';
4528
4529
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4530
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4531
			// No need to update the option if we already have
4532
			// this code stored.
4533
			return;
4534
		}
4535
		$xmlrpc_errors[ $code ] = true;
4536
4537
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4538
	}
4539
4540
	/**
4541
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4542
	 */
4543
	function stat( $group, $detail ) {
4544
		if ( ! isset( $this->stats[ $group ] ) ) {
4545
			$this->stats[ $group ] = array();
4546
		}
4547
		$this->stats[ $group ][] = $detail;
4548
	}
4549
4550
	/**
4551
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4552
	 */
4553
	function do_stats( $method = '' ) {
4554
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4555
			foreach ( $this->stats as $group => $stats ) {
4556
				if ( is_array( $stats ) && count( $stats ) ) {
4557
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4558
					if ( 'server_side' === $method ) {
4559
						self::do_server_side_stat( $args );
4560
					} else {
4561
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4562
					}
4563
				}
4564
				unset( $this->stats[ $group ] );
4565
			}
4566
		}
4567
	}
4568
4569
	/**
4570
	 * Runs stats code for a one-off, server-side.
4571
	 *
4572
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4573
	 *
4574
	 * @return bool If it worked.
4575
	 */
4576
	static function do_server_side_stat( $args ) {
4577
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4578
		if ( is_wp_error( $response ) ) {
4579
			return false;
4580
		}
4581
4582
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4583
			return false;
4584
		}
4585
4586
		return true;
4587
	}
4588
4589
	/**
4590
	 * Builds the stats url.
4591
	 *
4592
	 * @param $args array|string The arguments to append to the URL.
4593
	 *
4594
	 * @return string The URL to be pinged.
4595
	 */
4596
	static function build_stats_url( $args ) {
4597
		$defaults = array(
4598
			'v'    => 'wpcom2',
4599
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4600
		);
4601
		$args     = wp_parse_args( $args, $defaults );
4602
		/**
4603
		 * Filter the URL used as the Stats tracking pixel.
4604
		 *
4605
		 * @since 2.3.2
4606
		 *
4607
		 * @param string $url Base URL used as the Stats tracking pixel.
4608
		 */
4609
		$base_url = apply_filters(
4610
			'jetpack_stats_base_url',
4611
			'https://pixel.wp.com/g.gif'
4612
		);
4613
		$url      = add_query_arg( $args, $base_url );
4614
		return $url;
4615
	}
4616
4617
	/**
4618
	 * Get the role of the current user.
4619
	 *
4620
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4621
	 *
4622
	 * @access public
4623
	 * @static
4624
	 *
4625
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4626
	 */
4627
	public static function translate_current_user_to_role() {
4628
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4629
4630
		$roles = new Roles();
4631
		return $roles->translate_current_user_to_role();
4632
	}
4633
4634
	/**
4635
	 * Get the role of a particular user.
4636
	 *
4637
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4638
	 *
4639
	 * @access public
4640
	 * @static
4641
	 *
4642
	 * @param \WP_User $user User object.
4643
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4644
	 */
4645
	public static function translate_user_to_role( $user ) {
4646
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4647
4648
		$roles = new Roles();
4649
		return $roles->translate_user_to_role( $user );
4650
	}
4651
4652
	/**
4653
	 * Get the minimum capability for a role.
4654
	 *
4655
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4656
	 *
4657
	 * @access public
4658
	 * @static
4659
	 *
4660
	 * @param string $role Role name.
4661
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4662
	 */
4663
	public static function translate_role_to_cap( $role ) {
4664
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4665
4666
		$roles = new Roles();
4667
		return $roles->translate_role_to_cap( $role );
4668
	}
4669
4670
	/**
4671
	 * Sign a user role with the master access token.
4672
	 * If not specified, will default to the current user.
4673
	 *
4674
	 * @deprecated since 7.7
4675
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4676
	 *
4677
	 * @access public
4678
	 * @static
4679
	 *
4680
	 * @param string $role    User role.
4681
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
4682
	 * @return string Signed user role.
4683
	 */
4684
	public static function sign_role( $role, $user_id = null ) {
4685
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4686
		return self::connection()->sign_role( $role, $user_id );
4687
	}
4688
4689
	/**
4690
	 * Builds a URL to the Jetpack connection auth page
4691
	 *
4692
	 * @since 3.9.5
4693
	 *
4694
	 * @param bool        $raw If true, URL will not be escaped.
4695
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4696
	 *                              If string, will be a custom redirect.
4697
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4698
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4699
	 *
4700
	 * @return string Connect URL
4701
	 */
4702
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4703
		$site_id    = Jetpack_Options::get_option( 'id' );
4704
		$blog_token = Jetpack_Data::get_access_token();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
4705
4706
		if ( $register || ! $blog_token || ! $site_id ) {
4707
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4708
4709
			if ( ! empty( $redirect ) ) {
4710
				$url = add_query_arg(
4711
					'redirect',
4712
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4713
					$url
4714
				);
4715
			}
4716
4717
			if ( is_network_admin() ) {
4718
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4719
			}
4720
4721
			$calypso_env = self::get_calypso_env();
4722
4723
			if ( ! empty( $calypso_env ) ) {
4724
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4725
			}
4726
		} else {
4727
4728
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4729
			// because otherwise this logic can get us in to a loop.
4730
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4731
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4732
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4733
4734
				$response = Client::wpcom_json_api_request_as_blog(
4735
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4736
					'1.1'
4737
				);
4738
4739
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4740
4741
					// Generating a register URL instead to refresh the existing token
4742
					return $this->build_connect_url( $raw, $redirect, $from, true );
4743
				}
4744
			}
4745
4746
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4702 can also be of type string; however, Jetpack::build_authorize_url() does only seem to accept boolean, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
4747
		}
4748
4749
		if ( $from ) {
4750
			$url = add_query_arg( 'from', $from, $url );
4751
		}
4752
4753
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4754
		/**
4755
		 * Filter the URL used when connecting a user to a WordPress.com account.
4756
		 *
4757
		 * @since 8.1.0
4758
		 *
4759
		 * @param string $url Connection URL.
4760
		 * @param bool   $raw If true, URL will not be escaped.
4761
		 */
4762
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4763
	}
4764
4765
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4766
4767
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4768
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4769
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4770
4771
		if ( $iframe ) {
4772
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4773
		}
4774
4775
		$c8n = self::connection();
4776
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
Documentation introduced by
$redirect is of type boolean, but the function expects a string|null.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4777
4778
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4779
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4780
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4781
4782
		if ( $iframe ) {
4783
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4784
		}
4785
4786
		return $url;
4787
	}
4788
4789
	/**
4790
	 * Filters the connection URL parameter array.
4791
	 *
4792
	 * @param Array $args default URL parameters used by the package.
4793
	 * @return Array the modified URL arguments array.
4794
	 */
4795
	public static function filter_connect_request_body( $args ) {
4796
		if (
4797
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4798
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4799
		) {
4800
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4801
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4802
				? $gp_locale->slug
4803
				: '';
4804
		}
4805
4806
		$tracking        = new Tracking();
4807
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4808
4809
		$args = array_merge(
4810
			$args,
4811
			array(
4812
				'_ui' => $tracks_identity['_ui'],
4813
				'_ut' => $tracks_identity['_ut'],
4814
			)
4815
		);
4816
4817
		$calypso_env = self::get_calypso_env();
4818
4819
		if ( ! empty( $calypso_env ) ) {
4820
			$args['calypso_env'] = $calypso_env;
4821
		}
4822
4823
		return $args;
4824
	}
4825
4826
	/**
4827
	 * Filters the URL that will process the connection data. It can be different from the URL
4828
	 * that we send the user to after everything is done.
4829
	 *
4830
	 * @param String $processing_url the default redirect URL used by the package.
4831
	 * @return String the modified URL.
4832
	 */
4833
	public static function filter_connect_processing_url( $processing_url ) {
4834
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4835
		return $processing_url;
4836
	}
4837
4838
	/**
4839
	 * Filters the redirection URL that is used for connect requests. The redirect
4840
	 * URL should return the user back to the Jetpack console.
4841
	 *
4842
	 * @param String $redirect the default redirect URL used by the package.
4843
	 * @return String the modified URL.
4844
	 */
4845
	public static function filter_connect_redirect_url( $redirect ) {
4846
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4847
		$redirect           = $redirect
4848
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4849
			: $jetpack_admin_page;
4850
4851
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4852
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4853
		}
4854
4855
		return $redirect;
4856
	}
4857
4858
	/**
4859
	 * This action fires at the beginning of the Manager::authorize method.
4860
	 */
4861
	public static function authorize_starting() {
4862
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4863
		// Checking if site has been active/connected previously before recording unique connection.
4864
		if ( ! $jetpack_unique_connection ) {
4865
			// jetpack_unique_connection option has never been set.
4866
			$jetpack_unique_connection = array(
4867
				'connected'    => 0,
4868
				'disconnected' => 0,
4869
				'version'      => '3.6.1',
4870
			);
4871
4872
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4873
4874
			// Track unique connection.
4875
			$jetpack = self::init();
4876
4877
			$jetpack->stat( 'connections', 'unique-connection' );
4878
			$jetpack->do_stats( 'server_side' );
4879
		}
4880
4881
		// Increment number of times connected.
4882
		$jetpack_unique_connection['connected'] += 1;
4883
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4884
	}
4885
4886
	/**
4887
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4888
	 * linked.
4889
	 */
4890
	public static function authorize_ending_linked() {
4891
		// Don't activate anything since we are just connecting a user.
4892
		self::state( 'message', 'linked' );
4893
	}
4894
4895
	/**
4896
	 * This action fires at the end of the Manager::authorize method when the master user is
4897
	 * authorized.
4898
	 *
4899
	 * @param array $data The request data.
4900
	 */
4901
	public static function authorize_ending_authorized( $data ) {
4902
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4903
		self::invalidate_onboarding_token();
4904
4905
		// If redirect_uri is SSO, ensure SSO module is enabled.
4906
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4907
4908
		/** This filter is documented in class.jetpack-cli.php */
4909
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4910
4911
		$activate_sso = (
4912
			isset( $redirect_options['action'] ) &&
4913
			'jetpack-sso' === $redirect_options['action'] &&
4914
			$jetpack_start_enable_sso
4915
		);
4916
4917
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4918
4919
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4920
	}
4921
4922
	/**
4923
	 * Get our assumed site creation date.
4924
	 * Calculated based on the earlier date of either:
4925
	 * - Earliest admin user registration date.
4926
	 * - Earliest date of post of any post type.
4927
	 *
4928
	 * @since 7.2.0
4929
	 * @deprecated since 7.8.0
4930
	 *
4931
	 * @return string Assumed site creation date and time.
4932
	 */
4933
	public static function get_assumed_site_creation_date() {
4934
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4935
		return self::connection()->get_assumed_site_creation_date();
4936
	}
4937
4938 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4939
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4940
4941
		if ( $activation_source_name ) {
4942
			$args['_as'] = urlencode( $activation_source_name );
4943
		}
4944
4945
		if ( $activation_source_keyword ) {
4946
			$args['_ak'] = urlencode( $activation_source_keyword );
4947
		}
4948
	}
4949
4950
	function build_reconnect_url( $raw = false ) {
4951
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4952
		return $raw ? $url : esc_url( $url );
4953
	}
4954
4955
	public static function admin_url( $args = null ) {
4956
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4957
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4958
		return $url;
4959
	}
4960
4961
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4962
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4963
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4964
	}
4965
4966
	function dismiss_jetpack_notice() {
4967
4968
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4969
			return;
4970
		}
4971
4972
		switch ( $_GET['jetpack-notice'] ) {
4973
			case 'dismiss':
4974
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4975
4976
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4977
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4978
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4979
				}
4980
				break;
4981
		}
4982
	}
4983
4984
	public static function sort_modules( $a, $b ) {
4985
		if ( $a['sort'] == $b['sort'] ) {
4986
			return 0;
4987
		}
4988
4989
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4990
	}
4991
4992
	function ajax_recheck_ssl() {
4993
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4994
		$result = self::permit_ssl( true );
4995
		wp_send_json(
4996
			array(
4997
				'enabled' => $result,
4998
				'message' => get_transient( 'jetpack_https_test_message' ),
4999
			)
5000
		);
5001
	}
5002
5003
	/* Client API */
5004
5005
	/**
5006
	 * Returns the requested Jetpack API URL
5007
	 *
5008
	 * @deprecated since 7.7
5009
	 * @return string
5010
	 */
5011
	public static function api_url( $relative_url ) {
5012
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5013
		$connection = self::connection();
5014
		return $connection->api_url( $relative_url );
5015
	}
5016
5017
	/**
5018
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5019
	 *
5020
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5021
	 */
5022
	public static function fix_url_for_bad_hosts( $url ) {
5023
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5024
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5025
	}
5026
5027
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5028
		// Default to a blog token.
5029
		$token_type = 'blog';
5030
5031
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5032
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5033
			if ( ! empty( $_GET['onboarding'] ) ) {
5034
				$jpo = $_GET;
5035
			} else {
5036
				$jpo = json_decode( $request_data, true );
5037
			}
5038
5039
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5040
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5041
5042
			if (
5043
				isset( $jpo_user )
5044
				&& isset( $jpo_token )
5045
				&& is_email( $jpo_user )
5046
				&& ctype_alnum( $jpo_token )
5047
				&& isset( $_GET['rest_route'] )
5048
				&& self::validate_onboarding_token_action(
5049
					$jpo_token,
5050
					$_GET['rest_route']
5051
				)
5052
			) {
5053
				$jp_user = get_user_by( 'email', $jpo_user );
5054
				if ( is_a( $jp_user, 'WP_User' ) ) {
5055
					wp_set_current_user( $jp_user->ID );
5056
					$user_can = is_multisite()
5057
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5058
						: current_user_can( 'manage_options' );
5059
					if ( $user_can ) {
5060
						$token_type              = 'user';
5061
						$token->external_user_id = $jp_user->ID;
5062
					}
5063
				}
5064
			}
5065
5066
			$token_data['type']    = $token_type;
5067
			$token_data['user_id'] = $token->external_user_id;
5068
		}
5069
5070
		return $token_data;
5071
	}
5072
5073
	/**
5074
	 * Create a random secret for validating onboarding payload
5075
	 *
5076
	 * @return string Secret token
5077
	 */
5078
	public static function create_onboarding_token() {
5079
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5080
			$token = wp_generate_password( 32, false );
5081
			Jetpack_Options::update_option( 'onboarding', $token );
5082
		}
5083
5084
		return $token;
5085
	}
5086
5087
	/**
5088
	 * Remove the onboarding token
5089
	 *
5090
	 * @return bool True on success, false on failure
5091
	 */
5092
	public static function invalidate_onboarding_token() {
5093
		return Jetpack_Options::delete_option( 'onboarding' );
5094
	}
5095
5096
	/**
5097
	 * Validate an onboarding token for a specific action
5098
	 *
5099
	 * @return boolean True if token/action pair is accepted, false if not
5100
	 */
5101
	public static function validate_onboarding_token_action( $token, $action ) {
5102
		// Compare tokens, bail if tokens do not match
5103
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5104
			return false;
5105
		}
5106
5107
		// List of valid actions we can take
5108
		$valid_actions = array(
5109
			'/jetpack/v4/settings',
5110
		);
5111
5112
		// Whitelist the action
5113
		if ( ! in_array( $action, $valid_actions ) ) {
5114
			return false;
5115
		}
5116
5117
		return true;
5118
	}
5119
5120
	/**
5121
	 * Checks to see if the URL is using SSL to connect with Jetpack
5122
	 *
5123
	 * @since 2.3.3
5124
	 * @return boolean
5125
	 */
5126
	public static function permit_ssl( $force_recheck = false ) {
5127
		// Do some fancy tests to see if ssl is being supported
5128
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5129
			$message = '';
5130
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5131
				$ssl = 0;
5132
			} else {
5133
				switch ( JETPACK_CLIENT__HTTPS ) {
5134
					case 'NEVER':
5135
						$ssl     = 0;
5136
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5137
						break;
5138
					case 'ALWAYS':
5139
					case 'AUTO':
5140
					default:
5141
						$ssl = 1;
5142
						break;
5143
				}
5144
5145
				// If it's not 'NEVER', test to see
5146
				if ( $ssl ) {
5147
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5148
						$ssl     = 0;
5149
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5150
					} else {
5151
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5152
						if ( is_wp_error( $response ) ) {
5153
							$ssl     = 0;
5154
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5155
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5156
							$ssl     = 0;
5157
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5158
						}
5159
					}
5160
				}
5161
			}
5162
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5163
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5164
		}
5165
5166
		return (bool) $ssl;
5167
	}
5168
5169
	/*
5170
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5171
	 */
5172
	public function alert_auto_ssl_fail() {
5173
		if ( ! current_user_can( 'manage_options' ) ) {
5174
			return;
5175
		}
5176
5177
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5178
		?>
5179
5180
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5181
			<div class="jp-banner__content">
5182
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5183
				<p><?php _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>
5184
				<p>
5185
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5186
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5187
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5188
				</p>
5189
				<p>
5190
					<?php
5191
					printf(
5192
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5193
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5194
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5195
					);
5196
					?>
5197
				</p>
5198
			</div>
5199
		</div>
5200
		<style>
5201
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5202
		</style>
5203
		<script type="text/javascript">
5204
			jQuery( document ).ready( function( $ ) {
5205
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5206
					var $this = $( this );
5207
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5208
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5209
					e.preventDefault();
5210
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5211
					$.post( ajaxurl, data )
5212
					  .done( function( response ) {
5213
						  if ( response.enabled ) {
5214
							  $( '#jetpack-ssl-warning' ).hide();
5215
						  } else {
5216
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5217
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5218
						  }
5219
					  }.bind( $this ) );
5220
				} );
5221
			} );
5222
		</script>
5223
5224
		<?php
5225
	}
5226
5227
	/**
5228
	 * Returns the Jetpack XML-RPC API
5229
	 *
5230
	 * @deprecated 8.0 Use Connection_Manager instead.
5231
	 * @return string
5232
	 */
5233
	public static function xmlrpc_api_url() {
5234
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5235
		return self::connection()->xmlrpc_api_url();
5236
	}
5237
5238
	/**
5239
	 * Returns the connection manager object.
5240
	 *
5241
	 * @return Automattic\Jetpack\Connection\Manager
5242
	 */
5243
	public static function connection() {
5244
		$jetpack = static::init();
5245
5246
		// If the connection manager hasn't been instantiated, do that now.
5247
		if ( ! $jetpack->connection_manager ) {
5248
			$jetpack->connection_manager = new Connection_Manager();
5249
		}
5250
5251
		return $jetpack->connection_manager;
5252
	}
5253
5254
	/**
5255
	 * Creates two secret tokens and the end of life timestamp for them.
5256
	 *
5257
	 * Note these tokens are unique per call, NOT static per site for connecting.
5258
	 *
5259
	 * @since 2.6
5260
	 * @param String  $action  The action name.
5261
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be false|integer?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5262
	 * @param Integer $exp     Expiration time in seconds.
5263
	 * @return array
5264
	 */
5265
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5266
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5267
	}
5268
5269
	public static function get_secrets( $action, $user_id ) {
5270
		$secrets = self::connection()->get_secrets( $action, $user_id );
5271
5272
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5273
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5274
		}
5275
5276
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5277
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5278
		}
5279
5280
		return $secrets;
5281
	}
5282
5283
	/**
5284
	 * @deprecated 7.5 Use Connection_Manager instead.
5285
	 *
5286
	 * @param $action
5287
	 * @param $user_id
5288
	 */
5289
	public static function delete_secrets( $action, $user_id ) {
5290
		return self::connection()->delete_secrets( $action, $user_id );
5291
	}
5292
5293
	/**
5294
	 * Builds the timeout limit for queries talking with the wpcom servers.
5295
	 *
5296
	 * Based on local php max_execution_time in php.ini
5297
	 *
5298
	 * @since 2.6
5299
	 * @return int
5300
	 * @deprecated
5301
	 **/
5302
	public function get_remote_query_timeout_limit() {
5303
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5304
		return self::get_max_execution_time();
5305
	}
5306
5307
	/**
5308
	 * Builds the timeout limit for queries talking with the wpcom servers.
5309
	 *
5310
	 * Based on local php max_execution_time in php.ini
5311
	 *
5312
	 * @since 5.4
5313
	 * @return int
5314
	 **/
5315
	public static function get_max_execution_time() {
5316
		$timeout = (int) ini_get( 'max_execution_time' );
5317
5318
		// Ensure exec time set in php.ini
5319
		if ( ! $timeout ) {
5320
			$timeout = 30;
5321
		}
5322
		return $timeout;
5323
	}
5324
5325
	/**
5326
	 * Sets a minimum request timeout, and returns the current timeout
5327
	 *
5328
	 * @since 5.4
5329
	 **/
5330 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5331
		$timeout = self::get_max_execution_time();
5332
		if ( $timeout < $min_timeout ) {
5333
			$timeout = $min_timeout;
5334
			set_time_limit( $timeout );
5335
		}
5336
		return $timeout;
5337
	}
5338
5339
	/**
5340
	 * Takes the response from the Jetpack register new site endpoint and
5341
	 * verifies it worked properly.
5342
	 *
5343
	 * @since 2.6
5344
	 * @deprecated since 7.7.0
5345
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5346
	 **/
5347
	public function validate_remote_register_response() {
5348
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5349
	}
5350
5351
	/**
5352
	 * @return bool|WP_Error
5353
	 */
5354
	public static function register() {
5355
		$tracking = new Tracking();
5356
		$tracking->record_user_event( 'jpc_register_begin' );
5357
5358
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5359
5360
		$connection   = self::connection();
5361
		$registration = $connection->register();
5362
5363
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5364
5365
		if ( ! $registration || is_wp_error( $registration ) ) {
5366
			return $registration;
5367
		}
5368
5369
		return true;
5370
	}
5371
5372
	/**
5373
	 * Filters the registration request body to include tracking properties.
5374
	 *
5375
	 * @param Array $properties
5376
	 * @return Array amended properties.
5377
	 */
5378 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5379
		$tracking        = new Tracking();
5380
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5381
5382
		return array_merge(
5383
			$properties,
5384
			array(
5385
				'_ui' => $tracks_identity['_ui'],
5386
				'_ut' => $tracks_identity['_ut'],
5387
			)
5388
		);
5389
	}
5390
5391
	/**
5392
	 * Filters the token request body to include tracking properties.
5393
	 *
5394
	 * @param Array $properties
5395
	 * @return Array amended properties.
5396
	 */
5397 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5398
		$tracking        = new Tracking();
5399
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5400
5401
		return array_merge(
5402
			$properties,
5403
			array(
5404
				'_ui' => $tracks_identity['_ui'],
5405
				'_ut' => $tracks_identity['_ut'],
5406
			)
5407
		);
5408
	}
5409
5410
	/**
5411
	 * If the db version is showing something other that what we've got now, bump it to current.
5412
	 *
5413
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
5414
	 */
5415
	public static function maybe_set_version_option() {
5416
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5417
		if ( JETPACK__VERSION != $version ) {
5418
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5419
5420
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5421
				/** This action is documented in class.jetpack.php */
5422
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5423
			}
5424
5425
			return true;
5426
		}
5427
		return false;
5428
	}
5429
5430
	/* Client Server API */
5431
5432
	/**
5433
	 * Loads the Jetpack XML-RPC client.
5434
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5435
	 *
5436
	 * @deprecated since 7.7.0
5437
	 */
5438
	public static function load_xml_rpc_client() {
5439
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5440
	}
5441
5442
	/**
5443
	 * Resets the saved authentication state in between testing requests.
5444
	 */
5445
	public function reset_saved_auth_state() {
5446
		$this->rest_authentication_status = null;
5447
5448
		if ( ! $this->connection_manager ) {
5449
			$this->connection_manager = new Connection_Manager();
5450
		}
5451
5452
		$this->connection_manager->reset_saved_auth_state();
5453
	}
5454
5455
	/**
5456
	 * Verifies the signature of the current request.
5457
	 *
5458
	 * @deprecated since 7.7.0
5459
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5460
	 *
5461
	 * @return false|array
5462
	 */
5463
	public function verify_xml_rpc_signature() {
5464
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5465
		return self::connection()->verify_xml_rpc_signature();
5466
	}
5467
5468
	/**
5469
	 * Verifies the signature of the current request.
5470
	 *
5471
	 * This function has side effects and should not be used. Instead,
5472
	 * use the memoized version `->verify_xml_rpc_signature()`.
5473
	 *
5474
	 * @deprecated since 7.7.0
5475
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5476
	 * @internal
5477
	 */
5478
	private function internal_verify_xml_rpc_signature() {
5479
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5480
	}
5481
5482
	/**
5483
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5484
	 *
5485
	 * @deprecated since 7.7.0
5486
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5487
	 *
5488
	 * @param \WP_User|mixed $user     User object if authenticated.
5489
	 * @param string         $username Username.
5490
	 * @param string         $password Password string.
5491
	 * @return \WP_User|mixed Authenticated user or error.
5492
	 */
5493 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5494
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5495
5496
		if ( ! $this->connection_manager ) {
5497
			$this->connection_manager = new Connection_Manager();
5498
		}
5499
5500
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5501
	}
5502
5503
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5504
	// Uses the existing XMLRPC request signing implementation.
5505
	function wp_rest_authenticate( $user ) {
5506
		if ( ! empty( $user ) ) {
5507
			// Another authentication method is in effect.
5508
			return $user;
5509
		}
5510
5511
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5512
			// Nothing to do for this authentication method.
5513
			return null;
5514
		}
5515
5516
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5517
			// Nothing to do for this authentication method.
5518
			return null;
5519
		}
5520
5521
		// Ensure that we always have the request body available.  At this
5522
		// point, the WP REST API code to determine the request body has not
5523
		// run yet.  That code may try to read from 'php://input' later, but
5524
		// this can only be done once per request in PHP versions prior to 5.6.
5525
		// So we will go ahead and perform this read now if needed, and save
5526
		// the request body where both the Jetpack signature verification code
5527
		// and the WP REST API code can see it.
5528
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5529
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5530
		}
5531
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5532
5533
		// Only support specific request parameters that have been tested and
5534
		// are known to work with signature verification.  A different method
5535
		// can be passed to the WP REST API via the '?_method=' parameter if
5536
		// needed.
5537
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5538
			$this->rest_authentication_status = new WP_Error(
5539
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5540
				__( 'This request method is not supported.', 'jetpack' ),
5541
				array( 'status' => 400 )
5542
			);
5543
			return null;
5544
		}
5545
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5546
			$this->rest_authentication_status = new WP_Error(
5547
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5548
				__( 'This request method does not support body parameters.', 'jetpack' ),
5549
				array( 'status' => 400 )
5550
			);
5551
			return null;
5552
		}
5553
5554
		if ( ! $this->connection_manager ) {
5555
			$this->connection_manager = new Connection_Manager();
5556
		}
5557
5558
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5559
5560
		if (
5561
			$verified &&
5562
			isset( $verified['type'] ) &&
5563
			'user' === $verified['type'] &&
5564
			! empty( $verified['user_id'] )
5565
		) {
5566
			// Authentication successful.
5567
			$this->rest_authentication_status = true;
5568
			return $verified['user_id'];
5569
		}
5570
5571
		// Something else went wrong.  Probably a signature error.
5572
		$this->rest_authentication_status = new WP_Error(
5573
			'rest_invalid_signature',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_signature'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5574
			__( 'The request is not signed correctly.', 'jetpack' ),
5575
			array( 'status' => 400 )
5576
		);
5577
		return null;
5578
	}
5579
5580
	/**
5581
	 * Report authentication status to the WP REST API.
5582
	 *
5583
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
5584
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5585
	 */
5586
	public function wp_rest_authentication_errors( $value ) {
5587
		if ( $value !== null ) {
5588
			return $value;
5589
		}
5590
		return $this->rest_authentication_status;
5591
	}
5592
5593
	/**
5594
	 * Add our nonce to this request.
5595
	 *
5596
	 * @deprecated since 7.7.0
5597
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5598
	 *
5599
	 * @param int    $timestamp Timestamp of the request.
5600
	 * @param string $nonce     Nonce string.
5601
	 */
5602 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5603
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5604
5605
		if ( ! $this->connection_manager ) {
5606
			$this->connection_manager = new Connection_Manager();
5607
		}
5608
5609
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5610
	}
5611
5612
	/**
5613
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5614
	 * Capture it here so we can verify the signature later.
5615
	 *
5616
	 * @deprecated since 7.7.0
5617
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5618
	 *
5619
	 * @param array $methods XMLRPC methods.
5620
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5621
	 */
5622 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5623
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5624
5625
		if ( ! $this->connection_manager ) {
5626
			$this->connection_manager = new Connection_Manager();
5627
		}
5628
5629
		return $this->connection_manager->xmlrpc_methods( $methods );
5630
	}
5631
5632
	/**
5633
	 * Register additional public XMLRPC methods.
5634
	 *
5635
	 * @deprecated since 7.7.0
5636
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5637
	 *
5638
	 * @param array $methods Public XMLRPC methods.
5639
	 * @return array Public XMLRPC methods, with the getOptions one.
5640
	 */
5641 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5642
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5643
5644
		if ( ! $this->connection_manager ) {
5645
			$this->connection_manager = new Connection_Manager();
5646
		}
5647
5648
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5649
	}
5650
5651
	/**
5652
	 * Handles a getOptions XMLRPC method call.
5653
	 *
5654
	 * @deprecated since 7.7.0
5655
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5656
	 *
5657
	 * @param array $args method call arguments.
5658
	 * @return array an amended XMLRPC server options array.
5659
	 */
5660 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5661
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5662
5663
		if ( ! $this->connection_manager ) {
5664
			$this->connection_manager = new Connection_Manager();
5665
		}
5666
5667
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
Bug introduced by
The method jetpack_getOptions() does not exist on Automattic\Jetpack\Connection\Manager. Did you maybe mean jetpack_get_options()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
5668
	}
5669
5670
	/**
5671
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5672
	 *
5673
	 * @deprecated since 7.7.0
5674
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5675
	 *
5676
	 * @param array $options Standard Core options.
5677
	 * @return array Amended options.
5678
	 */
5679 View Code Duplication
	public function xmlrpc_options( $options ) {
5680
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5681
5682
		if ( ! $this->connection_manager ) {
5683
			$this->connection_manager = new Connection_Manager();
5684
		}
5685
5686
		return $this->connection_manager->xmlrpc_options( $options );
5687
	}
5688
5689
	/**
5690
	 * Cleans nonces that were saved when calling ::add_nonce.
5691
	 *
5692
	 * @deprecated since 7.7.0
5693
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5694
	 *
5695
	 * @param bool $all whether to clean even non-expired nonces.
5696
	 */
5697
	public static function clean_nonces( $all = false ) {
5698
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5699
		return self::connection()->clean_nonces( $all );
5700
	}
5701
5702
	/**
5703
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5704
	 * SET: state( $key, $value );
5705
	 * GET: $value = state( $key );
5706
	 *
5707
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5708
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5709
	 * @param bool   $restate private
5710
	 */
5711
	public static function state( $key = null, $value = null, $restate = false ) {
5712
		static $state = array();
5713
		static $path, $domain;
5714
		if ( ! isset( $path ) ) {
5715
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5716
			$admin_url = self::admin_url();
5717
			$bits      = wp_parse_url( $admin_url );
5718
5719
			if ( is_array( $bits ) ) {
5720
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5721
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5722
			} else {
5723
				$path = $domain = null;
5724
			}
5725
		}
5726
5727
		// Extract state from cookies and delete cookies
5728
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5729
			$yum = $_COOKIE['jetpackState'];
5730
			unset( $_COOKIE['jetpackState'] );
5731
			foreach ( $yum as $k => $v ) {
5732
				if ( strlen( $v ) ) {
5733
					$state[ $k ] = $v;
5734
				}
5735
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5736
			}
5737
		}
5738
5739
		if ( $restate ) {
5740
			foreach ( $state as $k => $v ) {
5741
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5742
			}
5743
			return;
5744
		}
5745
5746
		// Get a state variable
5747
		if ( isset( $key ) && ! isset( $value ) ) {
5748
			if ( array_key_exists( $key, $state ) ) {
5749
				return $state[ $key ];
5750
			}
5751
			return null;
5752
		}
5753
5754
		// Set a state variable
5755
		if ( isset( $key ) && isset( $value ) ) {
5756
			if ( is_array( $value ) && isset( $value[0] ) ) {
5757
				$value = $value[0];
5758
			}
5759
			$state[ $key ] = $value;
5760
			if ( ! headers_sent() ) {
5761
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5762
			}
5763
		}
5764
	}
5765
5766
	public static function restate() {
5767
		self::state( null, null, true );
5768
	}
5769
5770
	public static function check_privacy( $file ) {
5771
		static $is_site_publicly_accessible = null;
5772
5773
		if ( is_null( $is_site_publicly_accessible ) ) {
5774
			$is_site_publicly_accessible = false;
5775
5776
			$rpc = new Jetpack_IXR_Client();
5777
5778
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5779
			if ( $success ) {
5780
				$response = $rpc->getResponse();
5781
				if ( $response ) {
5782
					$is_site_publicly_accessible = true;
5783
				}
5784
			}
5785
5786
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5787
		}
5788
5789
		if ( $is_site_publicly_accessible ) {
5790
			return;
5791
		}
5792
5793
		$module_slug = self::get_module_slug( $file );
5794
5795
		$privacy_checks = self::state( 'privacy_checks' );
5796
		if ( ! $privacy_checks ) {
5797
			$privacy_checks = $module_slug;
5798
		} else {
5799
			$privacy_checks .= ",$module_slug";
5800
		}
5801
5802
		self::state( 'privacy_checks', $privacy_checks );
5803
	}
5804
5805
	/**
5806
	 * Helper method for multicall XMLRPC.
5807
	 *
5808
	 * @param ...$args Args for the async_call.
5809
	 */
5810
	public static function xmlrpc_async_call( ...$args ) {
5811
		global $blog_id;
5812
		static $clients = array();
5813
5814
		$client_blog_id = is_multisite() ? $blog_id : 0;
5815
5816
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5817
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5818
			if ( function_exists( 'ignore_user_abort' ) ) {
5819
				ignore_user_abort( true );
5820
			}
5821
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5822
		}
5823
5824
		if ( ! empty( $args[0] ) ) {
5825
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5826
		} elseif ( is_multisite() ) {
5827
			foreach ( $clients as $client_blog_id => $client ) {
5828
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5829
					continue;
5830
				}
5831
5832
				$switch_success = switch_to_blog( $client_blog_id, true );
5833
				if ( ! $switch_success ) {
5834
					continue;
5835
				}
5836
5837
				flush();
5838
				$client->query();
5839
5840
				restore_current_blog();
5841
			}
5842
		} else {
5843
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5844
				flush();
5845
				$clients[0]->query();
5846
			}
5847
		}
5848
	}
5849
5850
	public static function staticize_subdomain( $url ) {
5851
5852
		// Extract hostname from URL
5853
		$host = wp_parse_url( $url, PHP_URL_HOST );
5854
5855
		// Explode hostname on '.'
5856
		$exploded_host = explode( '.', $host );
5857
5858
		// Retrieve the name and TLD
5859
		if ( count( $exploded_host ) > 1 ) {
5860
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5861
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5862
			// Rebuild domain excluding subdomains
5863
			$domain = $name . '.' . $tld;
5864
		} else {
5865
			$domain = $host;
5866
		}
5867
		// Array of Automattic domains
5868
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5869
5870
		// Return $url if not an Automattic domain
5871
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5872
			return $url;
5873
		}
5874
5875
		if ( is_ssl() ) {
5876
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5877
		}
5878
5879
		srand( crc32( basename( $url ) ) );
5880
		$static_counter = rand( 0, 2 );
5881
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5882
5883
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5884
	}
5885
5886
	/* JSON API Authorization */
5887
5888
	/**
5889
	 * Handles the login action for Authorizing the JSON API
5890
	 */
5891
	function login_form_json_api_authorization() {
5892
		$this->verify_json_api_authorization_request();
5893
5894
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5895
5896
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5897
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5898
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5899
	}
5900
5901
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5902
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5903
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5904
			return $url;
5905
		}
5906
5907
		$parsed_url = wp_parse_url( $url );
5908
		$url        = strtok( $url, '?' );
5909
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5910
		if ( ! empty( $parsed_url['query'] ) ) {
5911
			$url .= "&{$parsed_url['query']}";
5912
		}
5913
5914
		return $url;
5915
	}
5916
5917
	// Make sure the POSTed request is handled by the same action
5918
	function preserve_action_in_login_form_for_json_api_authorization() {
5919
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5920
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5921
	}
5922
5923
	// If someone logs in to approve API access, store the Access Code in usermeta
5924
	function store_json_api_authorization_token( $user_login, $user ) {
5925
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5926
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5927
		$token = wp_generate_password( 32, false );
5928
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5929
	}
5930
5931
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5932
	function allow_wpcom_public_api_domain( $domains ) {
5933
		$domains[] = 'public-api.wordpress.com';
5934
		return $domains;
5935
	}
5936
5937
	static function is_redirect_encoded( $redirect_url ) {
5938
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5939
	}
5940
5941
	// Add all wordpress.com environments to the safe redirect whitelist
5942
	function allow_wpcom_environments( $domains ) {
5943
		$domains[] = 'wordpress.com';
5944
		$domains[] = 'wpcalypso.wordpress.com';
5945
		$domains[] = 'horizon.wordpress.com';
5946
		$domains[] = 'calypso.localhost';
5947
		return $domains;
5948
	}
5949
5950
	// Add the Access Code details to the public-api.wordpress.com redirect
5951
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5952
		return add_query_arg(
5953
			urlencode_deep(
5954
				array(
5955
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5956
					'jetpack-user-id' => (int) $user->ID,
5957
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5958
				)
5959
			),
5960
			$redirect_to
5961
		);
5962
	}
5963
5964
5965
	/**
5966
	 * Verifies the request by checking the signature
5967
	 *
5968
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5969
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5970
	 *
5971
	 * @param null|array $environment
5972
	 */
5973
	function verify_json_api_authorization_request( $environment = null ) {
5974
		$environment = is_null( $environment )
5975
			? $_REQUEST
5976
			: $environment;
5977
5978
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5979
		$token                                     = Jetpack_Data::get_access_token( $envUserId, $envToken );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
5980
		if ( ! $token || empty( $token->secret ) ) {
5981
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5982
		}
5983
5984
		$die_error = __( 'Someone may be trying to trick you into giving them access to your site.  Or it could be you just encountered a bug :).  Either way, please close this window.', 'jetpack' );
5985
5986
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5987
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5988
			/**
5989
			 * Jetpack authorisation request Error.
5990
			 *
5991
			 * @since 7.5.0
5992
			 */
5993
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5994
			$die_error = sprintf(
5995
				/* translators: %s is a URL */
5996
				__( 'Your site is incorrectly double-encoding redirects from http to https. This is preventing Jetpack from authenticating your connection. Please visit our <a href="%s">support page</a> for details about how to resolve this.', 'jetpack' ),
5997
				'https://jetpack.com/support/double-encoding/'
5998
			);
5999
		}
6000
6001
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6002
6003
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6004
			$signature = $jetpack_signature->sign_request(
6005
				$environment['token'],
6006
				$environment['timestamp'],
6007
				$environment['nonce'],
6008
				'',
6009
				'GET',
6010
				$environment['jetpack_json_api_original_query'],
6011
				null,
6012
				true
6013
			);
6014
		} else {
6015
			$signature = $jetpack_signature->sign_current_request(
6016
				array(
6017
					'body'   => null,
6018
					'method' => 'GET',
6019
				)
6020
			);
6021
		}
6022
6023
		if ( ! $signature ) {
6024
			wp_die( $die_error );
6025
		} elseif ( is_wp_error( $signature ) ) {
6026
			wp_die( $die_error );
6027
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6028
			if ( is_ssl() ) {
6029
				// If we signed an HTTP request on the Jetpack Servers, but got redirected to HTTPS by the local blog, check the HTTP signature as well
6030
				$signature = $jetpack_signature->sign_current_request(
6031
					array(
6032
						'scheme' => 'http',
6033
						'body'   => null,
6034
						'method' => 'GET',
6035
					)
6036
				);
6037
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6038
					wp_die( $die_error );
6039
				}
6040
			} else {
6041
				wp_die( $die_error );
6042
			}
6043
		}
6044
6045
		$timestamp = (int) $environment['timestamp'];
6046
		$nonce     = stripslashes( (string) $environment['nonce'] );
6047
6048
		if ( ! $this->connection_manager ) {
6049
			$this->connection_manager = new Connection_Manager();
6050
		}
6051
6052
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6053
			// De-nonce the nonce, at least for 5 minutes.
6054
			// We have to reuse this nonce at least once (used the first time when the initial request is made, used a second time when the login form is POSTed)
6055
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6056
			if ( $old_nonce_time < time() - 300 ) {
6057
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6058
			}
6059
		}
6060
6061
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6062
		$data_filters = array(
6063
			'state'        => 'opaque',
6064
			'client_id'    => 'int',
6065
			'client_title' => 'string',
6066
			'client_image' => 'url',
6067
		);
6068
6069
		foreach ( $data_filters as $key => $sanitation ) {
6070
			if ( ! isset( $data->$key ) ) {
6071
				wp_die( $die_error );
6072
			}
6073
6074
			switch ( $sanitation ) {
6075
				case 'int':
6076
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6077
					break;
6078
				case 'opaque':
6079
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6080
					break;
6081
				case 'string':
6082
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6083
					break;
6084
				case 'url':
6085
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6086
					break;
6087
			}
6088
		}
6089
6090
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6091
			wp_die( $die_error );
6092
		}
6093
	}
6094
6095
	function login_message_json_api_authorization( $message ) {
6096
		return '<p class="message">' . sprintf(
6097
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6098
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6099
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6100
	}
6101
6102
	/**
6103
	 * Get $content_width, but with a <s>twist</s> filter.
6104
	 */
6105
	public static function get_content_width() {
6106
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6107
			? $GLOBALS['content_width']
6108
			: false;
6109
		/**
6110
		 * Filter the Content Width value.
6111
		 *
6112
		 * @since 2.2.3
6113
		 *
6114
		 * @param string $content_width Content Width value.
6115
		 */
6116
		return apply_filters( 'jetpack_content_width', $content_width );
6117
	}
6118
6119
	/**
6120
	 * Pings the WordPress.com Mirror Site for the specified options.
6121
	 *
6122
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6123
	 *
6124
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6125
	 */
6126
	public function get_cloud_site_options( $option_names ) {
6127
		$option_names = array_filter( (array) $option_names, 'is_string' );
6128
6129
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6130
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6131
		if ( $xml->isError() ) {
6132
			return array(
6133
				'error_code' => $xml->getErrorCode(),
6134
				'error_msg'  => $xml->getErrorMessage(),
6135
			);
6136
		}
6137
		$cloud_site_options = $xml->getResponse();
6138
6139
		return $cloud_site_options;
6140
	}
6141
6142
	/**
6143
	 * Checks if the site is currently in an identity crisis.
6144
	 *
6145
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6146
	 */
6147
	public static function check_identity_crisis() {
6148
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6149
			return false;
6150
		}
6151
6152
		return Jetpack_Options::get_option( 'sync_error_idc' );
6153
	}
6154
6155
	/**
6156
	 * Checks whether the home and siteurl specifically are whitelisted
6157
	 * Written so that we don't have re-check $key and $value params every time
6158
	 * we want to check if this site is whitelisted, for example in footer.php
6159
	 *
6160
	 * @since  3.8.0
6161
	 * @return bool True = already whitelisted False = not whitelisted
6162
	 */
6163
	public static function is_staging_site() {
6164
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6165
		return ( new Status() )->is_staging_site();
6166
	}
6167
6168
	/**
6169
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6170
	 *
6171
	 * @since 4.4.0
6172
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6173
	 *
6174
	 * @return bool
6175
	 */
6176
	public static function validate_sync_error_idc_option() {
6177
		$is_valid = false;
6178
6179
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6180
		if ( false === $idc_allowed ) {
6181
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6182
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6183
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6184
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6185
				$transient_duration = HOUR_IN_SECONDS;
6186
			} else {
6187
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6188
				$idc_allowed        = '1';
6189
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6190
			}
6191
6192
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6193
		}
6194
6195
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6196
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6197
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6198
			$local_options = self::get_sync_error_idc_option();
6199
			// Ensure all values are set.
6200
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6201
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6202
					$is_valid = true;
6203
				}
6204
			}
6205
6206
		}
6207
6208
		/**
6209
		 * Filters whether the sync_error_idc option is valid.
6210
		 *
6211
		 * @since 4.4.0
6212
		 *
6213
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6214
		 */
6215
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6216
6217
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6218
			// Since the option exists, and did not validate, delete it
6219
			Jetpack_Options::delete_option( 'sync_error_idc' );
6220
		}
6221
6222
		return $is_valid;
6223
	}
6224
6225
	/**
6226
	 * Normalizes a url by doing three things:
6227
	 *  - Strips protocol
6228
	 *  - Strips www
6229
	 *  - Adds a trailing slash
6230
	 *
6231
	 * @since 4.4.0
6232
	 * @param string $url
6233
	 * @return WP_Error|string
6234
	 */
6235
	public static function normalize_url_protocol_agnostic( $url ) {
6236
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6237
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6238
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'cannot_parse_url'.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
6239
		}
6240
6241
		// Strip www and protocols
6242
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6243
		return $url;
6244
	}
6245
6246
	/**
6247
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6248
	 *
6249
	 * @since 4.4.0
6250
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6251
	 *
6252
	 * @param array $response
6253
	 * @return array Array of the local urls, wpcom urls, and error code
6254
	 */
6255
	public static function get_sync_error_idc_option( $response = array() ) {
6256
		// Since the local options will hit the database directly, store the values
6257
		// in a transient to allow for autoloading and caching on subsequent views.
6258
		$local_options = get_transient( 'jetpack_idc_local' );
6259
		if ( false === $local_options ) {
6260
			$local_options = array(
6261
				'home'    => Functions::home_url(),
6262
				'siteurl' => Functions::site_url(),
6263
			);
6264
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6265
		}
6266
6267
		$options = array_merge( $local_options, $response );
6268
6269
		$returned_values = array();
6270
		foreach ( $options as $key => $option ) {
6271
			if ( 'error_code' === $key ) {
6272
				$returned_values[ $key ] = $option;
6273
				continue;
6274
			}
6275
6276
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6277
				continue;
6278
			}
6279
6280
			$returned_values[ $key ] = $normalized_url;
6281
		}
6282
6283
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6284
6285
		return $returned_values;
6286
	}
6287
6288
	/**
6289
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6290
	 * If set to true, the site will be put into staging mode.
6291
	 *
6292
	 * @since 4.3.2
6293
	 * @return bool
6294
	 */
6295
	public static function sync_idc_optin() {
6296
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6297
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6298
		} else {
6299
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6300
		}
6301
6302
		/**
6303
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6304
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6305
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6306
		 *
6307
		 * @since 4.3.2
6308
		 *
6309
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6310
		 */
6311
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6312
	}
6313
6314
	/**
6315
	 * Maybe Use a .min.css stylesheet, maybe not.
6316
	 *
6317
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6318
	 */
6319
	public static function maybe_min_asset( $url, $path, $plugin ) {
6320
		// Short out on things trying to find actual paths.
6321
		if ( ! $path || empty( $plugin ) ) {
6322
			return $url;
6323
		}
6324
6325
		$path = ltrim( $path, '/' );
6326
6327
		// Strip out the abspath.
6328
		$base = dirname( plugin_basename( $plugin ) );
6329
6330
		// Short out on non-Jetpack assets.
6331
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6332
			return $url;
6333
		}
6334
6335
		// File name parsing.
6336
		$file              = "{$base}/{$path}";
6337
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6338
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6339
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6340
		$extension         = array_shift( $file_name_parts_r );
6341
6342
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6343
			// Already pointing at the minified version.
6344
			if ( 'min' === $file_name_parts_r[0] ) {
6345
				return $url;
6346
			}
6347
6348
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6349
			if ( file_exists( $min_full_path ) ) {
6350
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6351
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6352
				if ( 'css' === $extension ) {
6353
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6354
					self::$min_assets[ $key ] = $path;
6355
				}
6356
			}
6357
		}
6358
6359
		return $url;
6360
	}
6361
6362
	/**
6363
	 * If the asset is minified, let's flag .min as the suffix.
6364
	 *
6365
	 * Attached to `style_loader_src` filter.
6366
	 *
6367
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6368
	 * @param string $handle The registered handle of the script in question.
6369
	 * @param string $href The url of the asset in question.
0 ignored issues
show
Bug introduced by
There is no parameter named $href. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6370
	 */
6371
	public static function set_suffix_on_min( $src, $handle ) {
6372
		if ( false === strpos( $src, '.min.css' ) ) {
6373
			return $src;
6374
		}
6375
6376
		if ( ! empty( self::$min_assets ) ) {
6377
			foreach ( self::$min_assets as $file => $path ) {
6378
				if ( false !== strpos( $src, $file ) ) {
6379
					wp_style_add_data( $handle, 'suffix', '.min' );
6380
					return $src;
6381
				}
6382
			}
6383
		}
6384
6385
		return $src;
6386
	}
6387
6388
	/**
6389
	 * Maybe inlines a stylesheet.
6390
	 *
6391
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6392
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6393
	 *
6394
	 * Attached to `style_loader_tag` filter.
6395
	 *
6396
	 * @param string $tag The tag that would link to the external asset.
6397
	 * @param string $handle The registered handle of the script in question.
6398
	 *
6399
	 * @return string
6400
	 */
6401
	public static function maybe_inline_style( $tag, $handle ) {
6402
		global $wp_styles;
6403
		$item = $wp_styles->registered[ $handle ];
6404
6405
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6406
			return $tag;
6407
		}
6408
6409
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6410
			$href = $matches[1];
6411
			// Strip off query string
6412
			if ( $pos = strpos( $href, '?' ) ) {
6413
				$href = substr( $href, 0, $pos );
6414
			}
6415
			// Strip off fragment
6416
			if ( $pos = strpos( $href, '#' ) ) {
6417
				$href = substr( $href, 0, $pos );
6418
			}
6419
		} else {
6420
			return $tag;
6421
		}
6422
6423
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6424
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6425
			return $tag;
6426
		}
6427
6428
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6429
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6430
			// And this isn't the pass that actually deals with the RTL version...
6431
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6432
				// Short out, as the RTL version will deal with it in a moment.
6433
				return $tag;
6434
			}
6435
		}
6436
6437
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6438
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6439
		if ( $css ) {
6440
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6441
			if ( empty( $item->extra['after'] ) ) {
6442
				wp_add_inline_style( $handle, $css );
6443
			} else {
6444
				array_unshift( $item->extra['after'], $css );
6445
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6446
			}
6447
		}
6448
6449
		return $tag;
6450
	}
6451
6452
	/**
6453
	 * Loads a view file from the views
6454
	 *
6455
	 * Data passed in with the $data parameter will be available in the
6456
	 * template file as $data['value']
6457
	 *
6458
	 * @param string $template - Template file to load
6459
	 * @param array  $data - Any data to pass along to the template
6460
	 * @return boolean - If template file was found
6461
	 **/
6462
	public function load_view( $template, $data = array() ) {
6463
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6464
6465
		if ( file_exists( $views_dir . $template ) ) {
6466
			require_once $views_dir . $template;
6467
			return true;
6468
		}
6469
6470
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6471
		return false;
6472
	}
6473
6474
	/**
6475
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6476
	 */
6477
	public function deprecated_hooks() {
6478
		global $wp_filter;
6479
6480
		/*
6481
		 * Format:
6482
		 * deprecated_filter_name => replacement_name
6483
		 *
6484
		 * If there is no replacement, use null for replacement_name
6485
		 */
6486
		$deprecated_list = array(
6487
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6488
			'wpl_sharing_2014_1'                           => null,
6489
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6490
			'jetpack_identity_crisis_options_to_check'     => null,
6491
			'update_option_jetpack_single_user_site'       => null,
6492
			'audio_player_default_colors'                  => null,
6493
			'add_option_jetpack_featured_images_enabled'   => null,
6494
			'add_option_jetpack_update_details'            => null,
6495
			'add_option_jetpack_updates'                   => null,
6496
			'add_option_jetpack_network_name'              => null,
6497
			'add_option_jetpack_network_allow_new_registrations' => null,
6498
			'add_option_jetpack_network_add_new_users'     => null,
6499
			'add_option_jetpack_network_site_upload_space' => null,
6500
			'add_option_jetpack_network_upload_file_types' => null,
6501
			'add_option_jetpack_network_enable_administration_menus' => null,
6502
			'add_option_jetpack_is_multi_site'             => null,
6503
			'add_option_jetpack_is_main_network'           => null,
6504
			'add_option_jetpack_main_network_site'         => null,
6505
			'jetpack_sync_all_registered_options'          => null,
6506
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6507
			'jetpack_is_post_mailable'                     => null,
6508
			'jetpack_seo_site_host'                        => null,
6509
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6510
			'jetpack_holiday_snow_option_name'             => null,
6511
			'jetpack_holiday_chance_of_snow'               => null,
6512
			'jetpack_holiday_snow_js_url'                  => null,
6513
			'jetpack_is_holiday_snow_season'               => null,
6514
			'jetpack_holiday_snow_option_updated'          => null,
6515
			'jetpack_holiday_snowing'                      => null,
6516
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6517
			'jetpack_cache_plans'                          => null,
6518
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6519
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6520
			'jetpack_enable_site_verification'             => null,
6521
			'can_display_jetpack_manage_notice'            => null,
6522
			// Removed in Jetpack 7.3.0
6523
			'atd_load_scripts'                             => null,
6524
			'atd_http_post_timeout'                        => null,
6525
			'atd_http_post_error'                          => null,
6526
			'atd_service_domain'                           => null,
6527
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6528
			// Removed in Jetpack 7.9.0
6529
			'jetpack_pwa_manifest'                         => null,
6530
			'jetpack_pwa_background_color'                 => null,
6531
			// Removed in Jetpack 8.3.0.
6532
			'jetpack_check_mobile'                         => null,
6533
			'jetpack_mobile_stylesheet'                    => null,
6534
			'jetpack_mobile_template'                      => null,
6535
			'mobile_reject_mobile'                         => null,
6536
			'mobile_force_mobile'                          => null,
6537
			'mobile_app_promo_download'                    => null,
6538
			'mobile_setup'                                 => null,
6539
			'jetpack_mobile_footer_before'                 => null,
6540
			'wp_mobile_theme_footer'                       => null,
6541
			'minileven_credits'                            => null,
6542
			'jetpack_mobile_header_before'                 => null,
6543
			'jetpack_mobile_header_after'                  => null,
6544
			'jetpack_mobile_theme_menu'                    => null,
6545
			'minileven_show_featured_images'               => null,
6546
			'minileven_attachment_size'                    => null,
6547
		);
6548
6549
		// This is a silly loop depth. Better way?
6550
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6551
			if ( has_action( $hook ) ) {
6552
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6553
					foreach ( $values as $hooked ) {
6554
						if ( is_callable( $hooked['function'] ) ) {
6555
							$function_name = 'an anonymous function';
6556
						} else {
6557
							$function_name = $hooked['function'];
6558
						}
6559
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6560
					}
6561
				}
6562
			}
6563
		}
6564
	}
6565
6566
	/**
6567
	 * Converts any url in a stylesheet, to the correct absolute url.
6568
	 *
6569
	 * Considerations:
6570
	 *  - Normal, relative URLs     `feh.png`
6571
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6572
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6573
	 *  - Absolute URLs             `http://domain.com/feh.png`
6574
	 *  - Domain root relative URLs `/feh.png`
6575
	 *
6576
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6577
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6578
	 *
6579
	 * @return mixed|string
6580
	 */
6581
	public static function absolutize_css_urls( $css, $css_file_url ) {
6582
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6583
		$css_dir = dirname( $css_file_url );
6584
		$p       = wp_parse_url( $css_dir );
6585
		$domain  = sprintf(
6586
			'%1$s//%2$s%3$s%4$s',
6587
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6588
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6589
			$p['host'],
6590
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6591
		);
6592
6593
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6594
			$find = $replace = array();
6595
			foreach ( $matches as $match ) {
6596
				$url = trim( $match['path'], "'\" \t" );
6597
6598
				// If this is a data url, we don't want to mess with it.
6599
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6600
					continue;
6601
				}
6602
6603
				// If this is an absolute or protocol-agnostic url,
6604
				// we don't want to mess with it.
6605
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6606
					continue;
6607
				}
6608
6609
				switch ( substr( $url, 0, 1 ) ) {
6610
					case '/':
6611
						$absolute = $domain . $url;
6612
						break;
6613
					default:
6614
						$absolute = $css_dir . '/' . $url;
6615
				}
6616
6617
				$find[]    = $match[0];
6618
				$replace[] = sprintf( 'url("%s")', $absolute );
6619
			}
6620
			$css = str_replace( $find, $replace, $css );
6621
		}
6622
6623
		return $css;
6624
	}
6625
6626
	/**
6627
	 * This methods removes all of the registered css files on the front end
6628
	 * from Jetpack in favor of using a single file. In effect "imploding"
6629
	 * all the files into one file.
6630
	 *
6631
	 * Pros:
6632
	 * - Uses only ONE css asset connection instead of 15
6633
	 * - Saves a minimum of 56k
6634
	 * - Reduces server load
6635
	 * - Reduces time to first painted byte
6636
	 *
6637
	 * Cons:
6638
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6639
	 *      should not cause any issues with themes.
6640
	 * - Plugins/themes dequeuing styles no longer do anything. See
6641
	 *      jetpack_implode_frontend_css filter for a workaround
6642
	 *
6643
	 * For some situations developers may wish to disable css imploding and
6644
	 * instead operate in legacy mode where each file loads seperately and
6645
	 * can be edited individually or dequeued. This can be accomplished with
6646
	 * the following line:
6647
	 *
6648
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6649
	 *
6650
	 * @since 3.2
6651
	 **/
6652
	public function implode_frontend_css( $travis_test = false ) {
6653
		$do_implode = true;
6654
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6655
			$do_implode = false;
6656
		}
6657
6658
		// Do not implode CSS when the page loads via the AMP plugin.
6659
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6660
			$do_implode = false;
6661
		}
6662
6663
		/**
6664
		 * Allow CSS to be concatenated into a single jetpack.css file.
6665
		 *
6666
		 * @since 3.2.0
6667
		 *
6668
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6669
		 */
6670
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6671
6672
		// Do not use the imploded file when default behavior was altered through the filter
6673
		if ( ! $do_implode ) {
6674
			return;
6675
		}
6676
6677
		// We do not want to use the imploded file in dev mode, or if not connected
6678
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6679
			if ( ! $travis_test ) {
6680
				return;
6681
			}
6682
		}
6683
6684
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6685
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6686
			return;
6687
		}
6688
6689
		/*
6690
		 * Now we assume Jetpack is connected and able to serve the single
6691
		 * file.
6692
		 *
6693
		 * In the future there will be a check here to serve the file locally
6694
		 * or potentially from the Jetpack CDN
6695
		 *
6696
		 * For now:
6697
		 * - Enqueue a single imploded css file
6698
		 * - Zero out the style_loader_tag for the bundled ones
6699
		 * - Be happy, drink scotch
6700
		 */
6701
6702
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6703
6704
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6705
6706
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6707
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6708
	}
6709
6710
	function concat_remove_style_loader_tag( $tag, $handle ) {
6711
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6712
			$tag = '';
6713
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6714
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6715
			}
6716
		}
6717
6718
		return $tag;
6719
	}
6720
6721
	/**
6722
	 * Add an async attribute to scripts that can be loaded asynchronously.
6723
	 * https://www.w3schools.com/tags/att_script_async.asp
6724
	 *
6725
	 * @since 7.7.0
6726
	 *
6727
	 * @param string $tag    The <script> tag for the enqueued script.
6728
	 * @param string $handle The script's registered handle.
6729
	 * @param string $src    The script's source URL.
6730
	 */
6731
	public function script_add_async( $tag, $handle, $src ) {
6732
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6733
			return preg_replace( '/^<script /i', '<script async ', $tag );
6734
		}
6735
6736
		return $tag;
6737
	}
6738
6739
	/*
6740
	 * Check the heartbeat data
6741
	 *
6742
	 * Organizes the heartbeat data by severity.  For example, if the site
6743
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6744
	 *
6745
	 * Data will be added to "caution" array, if it either:
6746
	 *  - Out of date Jetpack version
6747
	 *  - Out of date WP version
6748
	 *  - Out of date PHP version
6749
	 *
6750
	 * $return array $filtered_data
6751
	 */
6752
	public static function jetpack_check_heartbeat_data() {
6753
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6754
6755
		$good    = array();
6756
		$caution = array();
6757
		$bad     = array();
6758
6759
		foreach ( $raw_data as $stat => $value ) {
6760
6761
			// Check jetpack version
6762
			if ( 'version' == $stat ) {
6763
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6764
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6765
					continue;
6766
				}
6767
			}
6768
6769
			// Check WP version
6770
			if ( 'wp-version' == $stat ) {
6771
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6772
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6773
					continue;
6774
				}
6775
			}
6776
6777
			// Check PHP version
6778
			if ( 'php-version' == $stat ) {
6779
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6780
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6781
					continue;
6782
				}
6783
			}
6784
6785
			// Check ID crisis
6786
			if ( 'identitycrisis' == $stat ) {
6787
				if ( 'yes' == $value ) {
6788
					$bad[ $stat ] = $value;
6789
					continue;
6790
				}
6791
			}
6792
6793
			// The rest are good :)
6794
			$good[ $stat ] = $value;
6795
		}
6796
6797
		$filtered_data = array(
6798
			'good'    => $good,
6799
			'caution' => $caution,
6800
			'bad'     => $bad,
6801
		);
6802
6803
		return $filtered_data;
6804
	}
6805
6806
6807
	/*
6808
	 * This method is used to organize all options that can be reset
6809
	 * without disconnecting Jetpack.
6810
	 *
6811
	 * It is used in class.jetpack-cli.php to reset options
6812
	 *
6813
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6814
	 *
6815
	 * @return array of options to delete.
6816
	 */
6817
	public static function get_jetpack_options_for_reset() {
6818
		return Jetpack_Options::get_options_for_reset();
6819
	}
6820
6821
	/*
6822
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6823
	 * so we can bring them directly to their site in calypso.
6824
	 *
6825
	 * @param string | url
6826
	 * @return string | url without the guff
6827
	 */
6828
	public static function build_raw_urls( $url ) {
6829
		$strip_http = '/.*?:\/\//i';
6830
		$url        = preg_replace( $strip_http, '', $url );
6831
		$url        = str_replace( '/', '::', $url );
6832
		return $url;
6833
	}
6834
6835
	/**
6836
	 * Stores and prints out domains to prefetch for page speed optimization.
6837
	 *
6838
	 * @param mixed $new_urls
6839
	 */
6840
	public static function dns_prefetch( $new_urls = null ) {
6841
		static $prefetch_urls = array();
6842
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6843
			echo "\r\n";
6844
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6845
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6846
			}
6847
		} elseif ( ! empty( $new_urls ) ) {
6848
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6849
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6850
			}
6851
			foreach ( (array) $new_urls as $this_new_url ) {
6852
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6853
			}
6854
			$prefetch_urls = array_unique( $prefetch_urls );
6855
		}
6856
	}
6857
6858
	public function wp_dashboard_setup() {
6859
		if ( self::is_active() ) {
6860
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6861
		}
6862
6863
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6864
			$jetpack_logo = new Jetpack_Logo();
6865
			$widget_title = sprintf(
6866
				wp_kses(
6867
					/* translators: Placeholder is a Jetpack logo. */
6868
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6869
					array( 'span' => array() )
6870
				),
6871
				$jetpack_logo->get_jp_emblem( true )
6872
			);
6873
6874
			wp_add_dashboard_widget(
6875
				'jetpack_summary_widget',
6876
				$widget_title,
6877
				array( __CLASS__, 'dashboard_widget' )
6878
			);
6879
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6880
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6881
6882
			// If we're inactive and not in development mode, sort our box to the top.
6883
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6884
				global $wp_meta_boxes;
6885
6886
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6887
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6888
6889
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6890
			}
6891
		}
6892
	}
6893
6894
	/**
6895
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
6896
	 * @return mixed
6897
	 */
6898
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6899
		if ( ! is_array( $sorted ) ) {
6900
			return $sorted;
6901
		}
6902
6903
		foreach ( $sorted as $box_context => $ids ) {
6904
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6905
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6906
				continue;
6907
			}
6908
6909
			$ids_array = explode( ',', $ids );
6910
			$key       = array_search( 'dashboard_stats', $ids_array );
6911
6912
			if ( false !== $key ) {
6913
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6914
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6915
				$sorted[ $box_context ] = implode( ',', $ids_array );
6916
				// We've found it, stop searching, and just return.
6917
				break;
6918
			}
6919
		}
6920
6921
		return $sorted;
6922
	}
6923
6924
	public static function dashboard_widget() {
6925
		/**
6926
		 * Fires when the dashboard is loaded.
6927
		 *
6928
		 * @since 3.4.0
6929
		 */
6930
		do_action( 'jetpack_dashboard_widget' );
6931
	}
6932
6933
	public static function dashboard_widget_footer() {
6934
		?>
6935
		<footer>
6936
6937
		<div class="protect">
6938
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
6939
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6940
				<p class="blocked-count">
6941
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
6942
				</p>
6943
				<p><?php echo esc_html_x( 'Blocked malicious login attempts', '{#} Blocked malicious login attempts -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6944
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6945
				<a href="
6946
				<?php
6947
				echo esc_url(
6948
					wp_nonce_url(
6949
						self::admin_url(
6950
							array(
6951
								'action' => 'activate',
6952
								'module' => 'protect',
6953
							)
6954
						),
6955
						'jetpack_activate-protect'
6956
					)
6957
				);
6958
				?>
6959
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6960
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
6961
				</a>
6962
			<?php else : ?>
6963
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
6964
			<?php endif; ?>
6965
		</div>
6966
6967
		<div class="akismet">
6968
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
6969
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6970
				<p class="blocked-count">
6971
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
6972
				</p>
6973
				<p><?php echo esc_html_x( 'Blocked spam comments.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6974
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6975
				<a href="
6976
				<?php
6977
				echo esc_url(
6978
					wp_nonce_url(
6979
						add_query_arg(
6980
							array(
6981
								'action' => 'activate',
6982
								'plugin' => 'akismet/akismet.php',
6983
							),
6984
							admin_url( 'plugins.php' )
6985
						),
6986
						'activate-plugin_akismet/akismet.php'
6987
					)
6988
				);
6989
				?>
6990
							" class="button button-jetpack">
6991
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
6992
				</a>
6993
			<?php else : ?>
6994
				<p><a href="<?php echo esc_url( 'https://akismet.com/?utm_source=jetpack&utm_medium=link&utm_campaign=Jetpack%20Dashboard%20Widget%20Footer%20Link' ); ?>"><?php esc_html_e( 'Anti-spam can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
6995
			<?php endif; ?>
6996
		</div>
6997
6998
		</footer>
6999
		<?php
7000
	}
7001
7002
	/*
7003
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7004
	 */
7005
	function jetpack_icon_user_connected( $columns ) {
7006
		$columns['user_jetpack'] = '';
7007
		return $columns;
7008
	}
7009
7010
	/*
7011
	 * Show Jetpack icon if the user is linked.
7012
	 */
7013
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7014
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7015
			$jetpack_logo = new Jetpack_Logo();
7016
			$emblem_html  = sprintf(
7017
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7018
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7019
				$jetpack_logo->get_jp_emblem()
7020
			);
7021
			return $emblem_html;
7022
		}
7023
7024
		return $val;
7025
	}
7026
7027
	/*
7028
	 * Style the Jetpack user column
7029
	 */
7030
	function jetpack_user_col_style() {
7031
		global $current_screen;
7032
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7033
			?>
7034
			<style>
7035
				.fixed .column-user_jetpack {
7036
					width: 21px;
7037
				}
7038
				.jp-emblem-user-admin svg {
7039
					width: 20px;
7040
					height: 20px;
7041
				}
7042
				.jp-emblem-user-admin path {
7043
					fill: #00BE28;
7044
				}
7045
			</style>
7046
			<?php
7047
		}
7048
	}
7049
7050
	/**
7051
	 * Checks if Akismet is active and working.
7052
	 *
7053
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7054
	 * that implied usage of methods present since more recent version.
7055
	 * See https://github.com/Automattic/jetpack/pull/9585
7056
	 *
7057
	 * @since  5.1.0
7058
	 *
7059
	 * @return bool True = Akismet available. False = Aksimet not available.
7060
	 */
7061
	public static function is_akismet_active() {
7062
		static $status = null;
7063
7064
		if ( ! is_null( $status ) ) {
7065
			return $status;
7066
		}
7067
7068
		// Check if a modern version of Akismet is active.
7069
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7070
			$status = false;
7071
			return $status;
7072
		}
7073
7074
		// Make sure there is a key known to Akismet at all before verifying key.
7075
		$akismet_key = Akismet::get_api_key();
7076
		if ( ! $akismet_key ) {
7077
			$status = false;
7078
			return $status;
7079
		}
7080
7081
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7082
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7083
7084
		// 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.
7085
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7086
		// We cache the result of the Akismet key verification for ten minutes.
7087
		if ( ! $akismet_key_state || $recheck ) {
7088
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7089
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7090
		}
7091
7092
		$status = 'valid' === $akismet_key_state;
7093
7094
		return $status;
7095
	}
7096
7097
	/**
7098
	 * @deprecated
7099
	 *
7100
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7101
	 */
7102
	public static function is_function_in_backtrace() {
7103
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7104
	}
7105
7106
	/**
7107
	 * Given a minified path, and a non-minified path, will return
7108
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7109
	 *
7110
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7111
	 * root Jetpack directory.
7112
	 *
7113
	 * @since 5.6.0
7114
	 *
7115
	 * @param string $min_path
7116
	 * @param string $non_min_path
7117
	 * @return string The URL to the file
7118
	 */
7119
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7120
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7121
	}
7122
7123
	/**
7124
	 * Checks for whether Jetpack Backup & Scan is enabled.
7125
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7126
	 *
7127
	 * @return bool|int|mixed
7128
	 */
7129
	public static function is_rewind_enabled() {
7130
		if ( ! self::is_active() ) {
7131
			return false;
7132
		}
7133
7134
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7135
		if ( false === $rewind_enabled ) {
7136
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7137
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7138
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7139
				&& ! empty( $rewind_data['state'] )
7140
				&& 'active' === $rewind_data['state'] )
7141
				? 1
7142
				: 0;
7143
7144
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7145
		}
7146
		return $rewind_enabled;
7147
	}
7148
7149
	/**
7150
	 * Return Calypso environment value; used for developing Jetpack and pairing
7151
	 * it with different Calypso enrionments, such as localhost.
7152
	 *
7153
	 * @since 7.4.0
7154
	 *
7155
	 * @return string Calypso environment
7156
	 */
7157
	public static function get_calypso_env() {
7158
		if ( isset( $_GET['calypso_env'] ) ) {
7159
			return sanitize_key( $_GET['calypso_env'] );
7160
		}
7161
7162
		if ( getenv( 'CALYPSO_ENV' ) ) {
7163
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7164
		}
7165
7166
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7167
			return sanitize_key( CALYPSO_ENV );
7168
		}
7169
7170
		return '';
7171
	}
7172
7173
	/**
7174
	 * Returns the hostname with protocol for Calypso.
7175
	 * Used for developing Jetpack with Calypso.
7176
	 *
7177
	 * @since 8.4.0
7178
	 *
7179
	 * @return string Calypso host.
7180
	 */
7181
	public static function get_calypso_host() {
7182
		$calypso_env = self::get_calypso_env();
7183
		switch ( $calypso_env ) {
7184
			case 'development':
7185
				return 'http://calypso.localhost:3000/';
7186
			case 'wpcalypso':
7187
				return 'https://wpcalypso.wordpress.com/';
7188
			case 'horizon':
7189
				return 'https://horizon.wordpress.com/';
7190
			default:
7191
				return 'https://wordpress.com/';
7192
		}
7193
	}
7194
7195
	/**
7196
	 * Checks whether or not TOS has been agreed upon.
7197
	 * Will return true if a user has clicked to register, or is already connected.
7198
	 */
7199
	public static function jetpack_tos_agreed() {
7200
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7201
7202
		$terms_of_service = new Terms_Of_Service();
7203
		return $terms_of_service->has_agreed();
7204
7205
	}
7206
7207
	/**
7208
	 * Handles activating default modules as well general cleanup for the new connection.
7209
	 *
7210
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7211
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7212
	 * @param boolean $send_state_messages          Whether to send state messages.
7213
	 * @return void
7214
	 */
7215
	public static function handle_post_authorization_actions(
7216
		$activate_sso = false,
7217
		$redirect_on_activation_error = false,
7218
		$send_state_messages = true
7219
	) {
7220
		$other_modules = $activate_sso
7221
			? array( 'sso' )
7222
			: array();
7223
7224
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7225
			self::delete_active_modules();
7226
7227
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
999 is of type integer, but the function expects a boolean.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
7228
		} else {
7229
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7230
		}
7231
7232
		// Since this is a fresh connection, be sure to clear out IDC options
7233
		Jetpack_IDC::clear_all_idc_options();
7234
7235
		if ( $send_state_messages ) {
7236
			self::state( 'message', 'authorized' );
7237
		}
7238
	}
7239
7240
	/**
7241
	 * Returns a boolean for whether backups UI should be displayed or not.
7242
	 *
7243
	 * @return bool Should backups UI be displayed?
7244
	 */
7245
	public static function show_backups_ui() {
7246
		/**
7247
		 * Whether UI for backups should be displayed.
7248
		 *
7249
		 * @since 6.5.0
7250
		 *
7251
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7252
		 */
7253
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7254
	}
7255
7256
	/*
7257
	 * Deprecated manage functions
7258
	 */
7259
	function prepare_manage_jetpack_notice() {
7260
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7261
	}
7262
	function manage_activate_screen() {
7263
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7264
	}
7265
	function admin_jetpack_manage_notice() {
7266
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7267
	}
7268
	function opt_out_jetpack_manage_url() {
7269
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7270
	}
7271
	function opt_in_jetpack_manage_url() {
7272
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7273
	}
7274
	function opt_in_jetpack_manage_notice() {
7275
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7276
	}
7277
	function can_display_jetpack_manage_notice() {
7278
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7279
	}
7280
7281
	/**
7282
	 * Clean leftoveruser meta.
7283
	 *
7284
	 * Delete Jetpack-related user meta when it is no longer needed.
7285
	 *
7286
	 * @since 7.3.0
7287
	 *
7288
	 * @param int $user_id User ID being updated.
7289
	 */
7290
	public static function user_meta_cleanup( $user_id ) {
7291
		$meta_keys = array(
7292
			// AtD removed from Jetpack 7.3
7293
			'AtD_options',
7294
			'AtD_check_when',
7295
			'AtD_guess_lang',
7296
			'AtD_ignored_phrases',
7297
		);
7298
7299
		foreach ( $meta_keys as $meta_key ) {
7300
			if ( get_user_meta( $user_id, $meta_key ) ) {
7301
				delete_user_meta( $user_id, $meta_key );
7302
			}
7303
		}
7304
	}
7305
7306
	/**
7307
	 * Checks if a Jetpack site is both active and not in development.
7308
	 *
7309
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7310
	 *
7311
	 * @return bool True if Jetpack is active and not in development.
7312
	 */
7313
	public static function is_active_and_not_development_mode() {
7314
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7315
			return false;
7316
		}
7317
		return true;
7318
	}
7319
}
7320