Completed
Push — update/module-overrides-vaultp... ( 6f68aa...9a4218 )
by
unknown
25:48 queued 11:10
created

Jetpack   F

Complexity

Total Complexity 1157

Size/Duplication

Total Lines 7358
Duplicated Lines 3.83 %

Coupling/Cohesion

Components 5
Dependencies 25

Importance

Changes 0
Metric Value
wmc 1157
lcom 5
cbo 25
dl 282
loc 7358
rs 0.8
c 0
b 0
f 0

245 Methods

Rating   Name   Duplication   Size   Complexity  
A init() 0 9 2
B plugin_upgrade() 0 43 8
A upgrade_on_load() 0 27 5
A activate_manage() 0 7 4
B update_active_modules() 0 54 5
A delete_active_modules() 0 3 1
F __construct() 17 190 25
A point_edit_post_links_to_calypso() 0 28 3
A point_edit_comment_links_to_calypso() 0 8 1
A jetpack_track_last_sync_callback() 0 22 5
A jetpack_connection_banner_callback() 0 10 2
B jetpack_admin_ajax_tracks_callback() 0 23 8
C jetpack_jitm_ajax_callback() 18 57 12
A push_stats() 0 5 2
D jetpack_custom_caps() 0 66 20
A require_jetpack_authentication() 0 11 2
A plugin_textdomain() 0 4 1
B register_assets() 10 79 8
C guess_locale_from_lang() 39 39 12
A get_locale() 0 9 2
A devicepx() 0 5 3
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() 0 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() 4 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 8 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
B refresh_active_plan_from_wpcom() 0 21 6
C get_active_plan() 12 83 11
B active_plan_supports() 0 25 6
A is_development_mode() 0 21 3
A is_onboarding() 0 3 1
B show_development_mode_notice() 0 40 8
A is_development_version() 0 15 1
A is_user_connected() 0 8 3
A get_connected_user_data() 0 24 4
A get_connected_user_email() 14 14 3
A get_master_user_email() 0 7 2
A current_user_is_connection_owner() 0 4 4
A current_user_ip() 0 20 5
A extra_oembed_providers() 0 9 1
A user_role_change() 0 4 1
D load_modules() 6 89 17
A check_rest_api_compat() 0 16 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 14 3
B glob_php() 0 29 7
C activate_new_modules() 6 58 11
C get_available_modules() 0 57 13
B get_default_modules() 0 31 6
B handle_deprecated_modules() 0 26 8
B filter_default_modules() 0 24 6
A get_module_slug() 0 3 1
A get_module_path() 0 3 1
D get_module() 12 91 11
B get_file_data() 0 28 6
A translate_module_tag() 0 3 1
A get_i18n_data_json() 0 18 5
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 136 21
F activate_module() 8 97 18
A activate_module_actions() 0 3 1
A deactivate_module() 8 27 2
A enable_module_configurable() 0 4 1
A module_configuration_url() 0 4 1
A module_configuration_load() 0 4 1
A module_configuration_head() 0 4 1
A module_configuration_screen() 0 4 1
A module_configuration_activation_screen() 0 4 1
B bail_on_activation() 0 40 5
A plugin_activation() 0 17 3
C get_activation_source() 0 49 14
A do_version_bump() 0 7 2
A plugin_initialize() 6 17 3
A plugin_deactivation() 0 9 2
B disconnect() 0 61 6
A unlink_user() 0 31 5
B try_registration() 0 28 7
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() 5 15 4
C admin_init() 0 49 13
A admin_body_class() 0 8 2
A add_jetpack_pagestyles() 0 3 1
A prepare_manage_jetpack_notice() 0 5 1
A manage_activate_screen() 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
A add_remote_request_handlers() 0 4 1
B remote_request_handlers() 0 40 7
F upload_handler() 0 122 24
A admin_help() 0 41 2
A admin_menu_css() 0 3 1
A admin_menu_order() 0 3 1
A enqueue_gutenberg_locale() 0 6 1
A jetpack_menu_order() 15 15 4
A admin_head() 3 5 4
A admin_banner_styles() 0 21 4
A plugin_action_links() 0 15 4
A admin_jetpack_manage_notice() 0 30 4
A opt_out_jetpack_manage_url() 0 4 1
A opt_in_jetpack_manage_url() 0 3 1
A opt_in_jetpack_manage_notice() 0 10 1
A can_display_jetpack_manage_notice() 0 22 4
F admin_page_load() 25 275 60
C admin_notices() 0 97 13
A stat() 0 5 2
B do_stats() 0 15 7
A do_server_side_stat() 0 10 3
A build_stats_url() 0 20 1
A translate_current_user_to_role() 0 9 4
A translate_user_to_role() 0 9 4
A translate_role_to_cap() 0 7 2
A sign_role() 0 16 5
F build_connect_url() 0 121 20
A apply_activation_source_to_args() 0 11 3
A build_reconnect_url() 0 4 2
A admin_url() 0 5 1
A nonce_url_no_esc() 0 4 1
C dismiss_jetpack_notice() 30 74 15
A admin_screen_configure_module() 0 52 4
A display_activate_module_link() 0 52 4
A sort_modules() 0 6 3
A ajax_recheck_ssl() 0 8 1
A api_url() 0 3 1
A fix_url_for_bad_hosts() 0 16 4
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 49 2
A xmlrpc_api_url() 0 4 1
A generate_secrets() 0 26 4
A get_secrets() 0 15 3
A delete_secrets() 0 8 2
A get_remote_query_timeout_limit() 0 4 1
A get_max_execution_time() 0 9 2
A set_min_time_limit() 0 8 2
C validate_remote_register_response() 0 40 13
C register() 10 104 12
A maybe_set_version_option() 0 14 3
A load_xml_rpc_client() 0 4 1
A reset_saved_auth_state() 0 4 1
F verify_xml_rpc_signature() 0 130 38
B authenticate_jetpack() 0 23 6
D wp_rest_authenticate() 0 94 21
A wp_rest_authentication_errors() 0 6 2
A add_nonce() 0 38 3
A xmlrpc_methods() 0 4 1
A public_xmlrpc_methods() 0 6 2
A jetpack_getOptions() 0 40 3
A xmlrpc_options() 0 18 2
A clean_nonces() 0 21 4
D state() 0 50 18
A restate() 0 3 1
B check_privacy() 0 35 6
C xmlrpc_async_call() 0 42 12
A staticize_subdomain() 0 35 4
A login_form_json_api_authorization() 0 9 1
A post_login_form_to_signed_url() 0 13 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 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 93 21
A login_message_json_api_authorization() 0 6 1
A get_content_width() 0 11 2
A get_cloud_site_options() 0 16 2
A check_identity_crisis() 0 7 4
B is_staging_site() 0 59 10
C validate_sync_error_idc_option() 0 44 13
A normalize_url_protocol_agnostic() 0 10 4
A get_sync_error_idc_option() 0 33 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 61 6
B absolutize_css_urls() 0 44 9
B implode_frontend_css() 0 52 9
A concat_remove_style_loader_tag() 0 10 4
B jetpack_check_heartbeat_data() 0 53 10
A get_jetpack_options_for_reset() 0 3 1
A jumpstart_has_updated_module_option() 0 21 3
A build_raw_urls() 0 6 1
B dns_prefetch() 0 17 7
A wp_dashboard_setup() 0 24 5
A get_user_option_meta_box_order_dashboard() 0 25 5
A dashboard_widget() 0 8 1
B dashboard_widget_footer() 0 33 7
A get_jp_emblem() 0 3 1
A jetpack_icon_user_connected() 0 4 1
A jetpack_show_user_connected_icon() 0 12 3
A jetpack_user_col_style() 0 17 3
A is_akismet_active() 0 23 5
A is_function_in_backtrace() 0 23 5
A get_file_url_for_environment() 0 7 3
A is_rewind_enabled() 0 19 6
A jetpack_tos_agreed() 0 3 2
A handle_post_authorization_actions() 7 23 3
A is_gutenberg_available() 0 3 1
B load_jetpack_gutenberg() 0 65 5
A show_backups_ui() 0 10 2

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
3
/*
4
Options:
5
jetpack_options (array)
6
	An array of options.
7
	@see Jetpack_Options::get_option_names()
8
9
jetpack_register (string)
10
	Temporary verification secrets.
11
12
jetpack_activated (int)
13
	1: the plugin was activated normally
14
	2: the plugin was activated on this site because of a network-wide activation
15
	3: the plugin was auto-installed
16
	4: the plugin was manually disconnected (but is still installed)
17
18
jetpack_active_modules (array)
19
	Array of active module slugs.
20
21
jetpack_do_activate (bool)
22
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
23
*/
24
25
require_once( JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php' );
26
27
class Jetpack {
28
	public $xmlrpc_server = null;
29
30
	private $xmlrpc_verification = null;
31
	private $rest_authentication_status = null;
32
33
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
34
35
	/**
36
	 * @var array The handles of styles that are concatenated into jetpack.css
37
	 */
38
	public $concatenated_style_handles = array(
39
		'jetpack-carousel',
40
		'grunion.css',
41
		'the-neverending-homepage',
42
		'jetpack_likes',
43
		'jetpack_related-posts',
44
		'sharedaddy',
45
		'jetpack-slideshow',
46
		'presentations',
47
		'jetpack-subscriptions',
48
		'jetpack-responsive-videos-style',
49
		'jetpack-social-menu',
50
		'tiled-gallery',
51
		'jetpack_display_posts_widget',
52
		'gravatar-profile-widget',
53
		'goodreads-widget',
54
		'jetpack_social_media_icons_widget',
55
		'jetpack-top-posts-widget',
56
		'jetpack_image_widget',
57
		'jetpack-my-community-widget',
58
		'wordads',
59
		'eu-cookie-law-style',
60
		'flickr-widget-style',
61
		'jetpack-search-widget',
62
		'jetpack-simple-payments-widget-style',
63
	);
64
65
	/**
66
	 * Contains all assets that have had their URL rewritten to minified versions.
67
	 *
68
	 * @var array
69
	 */
70
	static $min_assets = array();
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $min_assets.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
71
72
	public $plugins_to_deactivate = array(
73
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
74
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
75
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
76
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
77
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
78
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
79
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
80
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
81
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
82
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
83
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
84
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
85
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
86
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
87
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
88
	);
89
90
	static $capability_translations = array(
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $capability_translations.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
91
		'administrator' => 'manage_options',
92
		'editor'        => 'edit_others_posts',
93
		'author'        => 'publish_posts',
94
		'contributor'   => 'edit_posts',
95
		'subscriber'    => 'read',
96
	);
97
98
	/**
99
	 * Map of modules that have conflicts with plugins and should not be auto-activated
100
	 * if the plugins are active.  Used by filter_default_modules
101
	 *
102
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
103
	 * change `module-slug` and add this to your plugin:
104
	 *
105
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
106
	 * function my_jetpack_get_default_modules( $modules ) {
107
	 *     return array_diff( $modules, array( 'module-slug' ) );
108
	 * }
109
	 *
110
	 * @var array
111
	 */
112
	private $conflicting_plugins = array(
113
		'comments'          => array(
114
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
115
			'Disqus'                               => 'disqus-comment-system/disqus.php',
116
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
117
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
118
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
119
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
120
		),
121
		'comment-likes' => array(
122
			'Epoch'                                => 'epoch/plugincore.php',
123
		),
124
		'contact-form'      => array(
125
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
126
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
127
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
128
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
129
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
130
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
131
		),
132
		'minileven'         => array(
133
			'WPtouch'                              => 'wptouch/wptouch.php',
134
		),
135
		'latex'             => array(
136
			'LaTeX for WordPress'                  => 'latex/latex.php',
137
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
138
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
139
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
140
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
141
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
142
		),
143
		'protect'           => array(
144
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
145
			'Captcha'                              => 'captcha/captcha.php',
146
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
147
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
148
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
149
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
150
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
151
			'Security-protection'                  => 'security-protection/security-protection.php',
152
			'Login Security'                       => 'login-security/login-security.php',
153
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
154
			'Wordfence Security'                   => 'wordfence/wordfence.php',
155
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
156
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
157
		),
158
		'random-redirect'   => array(
159
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
160
		),
161
		'related-posts'     => array(
162
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
163
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
164
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
165
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
166
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
167
			'outbrain'                             => 'outbrain/outbrain.php',
168
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
169
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
170
		),
171
		'sharedaddy'        => array(
172
			'AddThis'                              => 'addthis/addthis_social_widget.php',
173
			'Add To Any'                           => 'add-to-any/add-to-any.php',
174
			'ShareThis'                            => 'share-this/sharethis.php',
175
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
176
		),
177
		'seo-tools' => array(
178
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
179
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
180
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
181
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
182
			'The SEO Framework'                    => 'autodescription/autodescription.php',
183
		),
184
		'verification-tools' => array(
185
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
186
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
187
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
188
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
189
			'The SEO Framework'                    => 'autodescription/autodescription.php',
190
		),
191
		'widget-visibility' => array(
192
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
193
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
194
		),
195
		'sitemaps' => array(
196
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
197
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
198
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
199
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
200
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
201
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
202
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
203
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
204
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
205
			'The SEO Framework'                    => 'autodescription/autodescription.php',
206
			'Sitemap'                              => 'sitemap/sitemap.php',
207
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
208
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
209
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
210
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
211
		),
212
		'lazy-images' => array(
213
			'Lazy Load'              => 'lazy-load/lazy-load.php',
214
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
215
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
216
		),
217
	);
218
219
	/**
220
	 * Plugins for which we turn off our Facebook OG Tags implementation.
221
	 *
222
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
223
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
224
	 *
225
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
226
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
227
	 */
228
	private $open_graph_conflicting_plugins = array(
229
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
230
		                                                         // 2 Click Social Media Buttons
231
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
232
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
233
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
234
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
235
		                                                         // Open Graph Meta Tags by Heateor
236
		'facebook/facebook.php',                                 // Facebook (official plugin)
237
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
238
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
239
		                                                         // Facebook Featured Image & OG Meta Tags
240
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
241
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
242
		                                                         // Facebook Open Graph Meta Tags for WordPress
243
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
244
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
245
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
246
		                                                         // Fedmich's Facebook Open Graph Meta
247
		'network-publisher/networkpub.php',                      // Network Publisher
248
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
249
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
250
		                                                         // NextScripts SNAP
251
		'og-tags/og-tags.php',                                   // OG Tags
252
		'opengraph/opengraph.php',                               // Open Graph
253
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
254
		                                                         // Open Graph Protocol Framework
255
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
256
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
257
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
258
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
259
		'sharepress/sharepress.php',                             // SharePress
260
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
261
		'social-discussions/social-discussions.php',             // Social Discussions
262
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
263
		'socialize/socialize.php',                               // Socialize
264
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
265
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
266
		                                                         // Tweet, Like, Google +1 and Share
267
		'wordbooker/wordbooker.php',                             // Wordbooker
268
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
269
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
270
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
271
		                                                         // WP Facebook Like Send & Open Graph Meta
272
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
273
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
274
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
275
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
276
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
277
	);
278
279
	/**
280
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
281
	 */
282
	private $twitter_cards_conflicting_plugins = array(
283
	//	'twitter/twitter.php',                       // The official one handles this on its own.
284
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
285
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
286
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
287
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
288
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
289
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
290
		'twitter-cards/twitter-cards.php',           // Twitter Cards
291
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
292
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
293
	);
294
295
	/**
296
	 * Message to display in admin_notice
297
	 * @var string
298
	 */
299
	public $message = '';
300
301
	/**
302
	 * Error to display in admin_notice
303
	 * @var string
304
	 */
305
	public $error = '';
306
307
	/**
308
	 * Modules that need more privacy description.
309
	 * @var string
310
	 */
311
	public $privacy_checks = '';
312
313
	/**
314
	 * Stats to record once the page loads
315
	 *
316
	 * @var array
317
	 */
318
	public $stats = array();
319
320
	/**
321
	 * Jetpack_Sync object
322
	 */
323
	public $sync;
324
325
	/**
326
	 * Verified data for JSON authorization request
327
	 */
328
	public $json_api_authorization_request = array();
329
330
	/**
331
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
332
	 */
333
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
334
335
	/**
336
	 * Holds the singleton instance of this class
337
	 * @since 2.3.3
338
	 * @var Jetpack
339
	 */
340
	static $instance = false;
0 ignored issues
show
Coding Style introduced by
The visibility should be declared for property $instance.

The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using

class A {
    var $property;
}

the property is implicitly global.

To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2.

Loading history...
341
342
	/**
343
	 * Singleton
344
	 * @static
345
	 */
346
	public static function init() {
347
		if ( ! self::$instance ) {
348
			self::$instance = new Jetpack;
349
350
			self::$instance->plugin_upgrade();
351
		}
352
353
		return self::$instance;
354
	}
355
356
	/**
357
	 * Must never be called statically
358
	 */
359
	function plugin_upgrade() {
360
		if ( Jetpack::is_active() ) {
361
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
362
			if ( JETPACK__VERSION != $version ) {
363
				// Prevent multiple upgrades at once - only a single process should trigger
364
				// an upgrade to avoid stampedes
365
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
366
					return;
367
				}
368
369
				// Set a short lock to prevent multiple instances of the upgrade
370
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
371
372
				// check which active modules actually exist and remove others from active_modules list
373
				$unfiltered_modules = Jetpack::get_active_modules();
374
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
375
				if ( array_diff( $unfiltered_modules, $modules ) ) {
376
					Jetpack::update_active_modules( $modules );
377
				}
378
379
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
380
381
				// Upgrade to 4.3.0
382
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
383
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
384
				}
385
386
				// Make sure Markdown for posts gets turned back on
387
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
388
					update_option( 'wpcom_publish_posts_with_markdown', true );
389
				}
390
391
				if ( did_action( 'wp_loaded' ) ) {
392
					self::upgrade_on_load();
393
				} else {
394
					add_action(
395
						'wp_loaded',
396
						array( __CLASS__, 'upgrade_on_load' )
397
					);
398
				}
399
			}
400
		}
401
	}
402
403
	/**
404
	 * Runs upgrade routines that need to have modules loaded.
405
	 */
406
	static function upgrade_on_load() {
407
408
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
409
		// This can happen in case Jetpack has been just upgraded and is
410
		// being initialized late during the page load. In this case we wait
411
		// until the next proper admin page load with Jetpack active.
412
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
413
			delete_transient( self::$plugin_upgrade_lock_key );
414
415
			return;
416
		}
417
418
		Jetpack::maybe_set_version_option();
419
420
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
421
			Jetpack_Widget_Conditions::migrate_post_type_rules();
422
		}
423
424
		if (
425
			class_exists( 'Jetpack_Sitemap_Manager' )
426
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
427
		) {
428
			do_action( 'jetpack_sitemaps_purge_data' );
429
		}
430
431
		delete_transient( self::$plugin_upgrade_lock_key );
432
	}
433
434
	static function activate_manage( ) {
435
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
436
			self::activate_module( 'manage', false, false );
437
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
438
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
439
		}
440
	}
441
442
	static function update_active_modules( $modules ) {
443
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
444
445
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
446
447
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
448
			$new_active_modules = array_diff( $modules, $current_modules );
449
			foreach( $new_active_modules as $module ) {
450
				/**
451
				 * Fires when a specific module is activated.
452
				 *
453
				 * @since 1.9.0
454
				 *
455
				 * @param string $module Module slug.
456
				 * @param boolean $success whether the module was activated. @since 4.2
457
				 */
458
				do_action( 'jetpack_activate_module', $module, $success );
459
460
				/**
461
				 * Fires when a module is activated.
462
				 * The dynamic part of the filter, $module, is the module slug.
463
				 *
464
				 * @since 1.9.0
465
				 *
466
				 * @param string $module Module slug.
467
				 */
468
				do_action( "jetpack_activate_module_$module", $module );
469
			}
470
471
			$new_deactive_modules = array_diff( $current_modules, $modules );
472
			foreach( $new_deactive_modules as $module ) {
473
				/**
474
				 * Fired after a module has been deactivated.
475
				 *
476
				 * @since 4.2.0
477
				 *
478
				 * @param string $module Module slug.
479
				 * @param boolean $success whether the module was deactivated.
480
				 */
481
				do_action( 'jetpack_deactivate_module', $module, $success );
482
				/**
483
				 * Fires when a module is deactivated.
484
				 * The dynamic part of the filter, $module, is the module slug.
485
				 *
486
				 * @since 1.9.0
487
				 *
488
				 * @param string $module Module slug.
489
				 */
490
				do_action( "jetpack_deactivate_module_$module", $module );
491
			}
492
		}
493
494
		return $success;
495
	}
496
497
	static function delete_active_modules() {
498
		self::update_active_modules( array() );
499
	}
500
501
	/**
502
	 * Constructor.  Initializes WordPress hooks
503
	 */
504
	private function __construct() {
505
		/*
506
		 * Check for and alert any deprecated hooks
507
		 */
508
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
509
510
		/*
511
		 * Enable enhanced handling of previewing sites in Calypso
512
		 */
513
		if ( Jetpack::is_active() ) {
514
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
515
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
516
		}
517
518
		/*
519
		 * Load things that should only be in Network Admin.
520
		 *
521
		 * For now blow away everything else until a more full
522
		 * understanding of what is needed at the network level is
523
		 * available
524
		 */
525
		if( is_multisite() ) {
526
			Jetpack_Network::init();
527
		}
528
529
		// Load Gutenberg editor blocks
530
		add_action( 'init', array( $this, 'load_jetpack_gutenberg' ) );
531
532
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
533
534
		// Unlink user before deleting the user from .com
535
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
536
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
537
538
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
539
			@ini_set( 'display_errors', false ); // Display errors can cause the XML to be not well formed.
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...
540
541
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
542
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
543
544
			$this->require_jetpack_authentication();
545
546
			if ( Jetpack::is_active() ) {
547
				// Hack to preserve $HTTP_RAW_POST_DATA
548
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
549
550
				$signed = $this->verify_xml_rpc_signature();
551 View Code Duplication
				if ( $signed && ! is_wp_error( $signed ) ) {
552
					// The actual API methods.
553
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
554
				} else {
555
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
556
					// active Jetpack connection, so that additional users can link their account.
557
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
558
				}
559 View Code Duplication
			} else {
560
				// The bootstrap API methods.
561
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
562
				$signed = $this->verify_xml_rpc_signature();
563
				if ( $signed && ! is_wp_error( $signed ) ) {
564
					// the jetpack Provision method is available for blog-token-signed requests
565
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'provision_xmlrpc_methods' ) );
566
				}
567
			}
568
569
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
570
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
571
		} elseif (
572
			is_admin() &&
573
			isset( $_POST['action'] ) && (
574
				'jetpack_upload_file' == $_POST['action'] ||
575
				'jetpack_update_file' == $_POST['action']
576
			)
577
		) {
578
			$this->require_jetpack_authentication();
579
			$this->add_remote_request_handlers();
580
		} else {
581
			if ( Jetpack::is_active() ) {
582
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
583
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
584
			}
585
		}
586
587
		if ( Jetpack::is_active() ) {
588
			Jetpack_Heartbeat::init();
589
			if ( Jetpack::is_module_active( 'stats' ) && Jetpack::is_module_active( 'search' ) ) {
590
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
591
				Jetpack_Search_Performance_Logger::init();
592
			}
593
		}
594
595
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
596
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
597
598
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
599
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
600
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
601
		}
602
603
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
604
605
		add_action( 'admin_init', array( $this, 'admin_init' ) );
606
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
607
608
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
609
610
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
611
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
612
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
613
614
		// returns HTTPS support status
615
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
616
617
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
618
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
619
620
		// JITM AJAX callback function
621
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
622
623
		// Universal ajax callback for all tracking events triggered via js
624
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
625
626
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
627
628
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
629
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
630
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
631
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
632
633
		// gutenberg locale
634
		add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_gutenberg_locale' ) );
635
636
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
637
638
		/**
639
		 * These actions run checks to load additional files.
640
		 * They check for external files or plugins, so they need to run as late as possible.
641
		 */
642
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
643
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
644
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
645
646
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
647
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
648
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
649
650
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
651
652
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
653
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
654
655
		// A filter to control all just in time messages
656
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
657
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
658
659
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
660
		// We should make sure to only do this for front end links.
661
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
662
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
663
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
664
665
			//we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
666
			//so they point moderation links on emails to Calypso
667
			jetpack_require_lib( 'functions.wp-notify' );
668
		}
669
670
		// Update the Jetpack plan from API on heartbeats
671
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
672
673
		/**
674
		 * This is the hack to concatenate all css files into one.
675
		 * For description and reasoning see the implode_frontend_css method
676
		 *
677
		 * Super late priority so we catch all the registered styles
678
		 */
679
		if( !is_admin() ) {
680
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
681
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
682
		}
683
684
		/**
685
		 * These are sync actions that we need to keep track of for jitms
686
		 */
687
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
688
689
		// Actually push the stats on shutdown.
690
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
691
			add_action( 'shutdown', array( $this, 'push_stats' ) );
692
		}
693
	}
694
695
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
696
		$post = get_post( $post_id );
697
698
		if ( empty( $post ) ) {
699
			return $default_url;
700
		}
701
702
		$post_type = $post->post_type;
703
704
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
705
		// https://en.support.wordpress.com/custom-post-types/
706
		$allowed_post_types = array(
707
			'post' => 'post',
708
			'page' => 'page',
709
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
710
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
711
		);
712
713
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
714
			return $default_url;
715
		}
716
717
		$path_prefix = $allowed_post_types[ $post_type ];
718
719
		$site_slug  = Jetpack::build_raw_urls( get_home_url() );
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 2 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
720
721
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
722
	}
723
724
	function point_edit_comment_links_to_calypso( $url ) {
725
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
726
		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...
727
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d',
728
			Jetpack::build_raw_urls( get_home_url() ),
729
			$query_args['amp;c']
730
		) );
731
	}
732
733
	function jetpack_track_last_sync_callback( $params ) {
734
		/**
735
		 * Filter to turn off jitm caching
736
		 *
737
		 * @since 5.4.0
738
		 *
739
		 * @param bool false Whether to cache just in time messages
740
		 */
741
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
742
			return $params;
743
		}
744
745
		if ( is_array( $params ) && isset( $params[0] ) ) {
746
			$option = $params[0];
747
			if ( 'active_plugins' === $option ) {
748
				// use the cache if we can, but not terribly important if it gets evicted
749
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
750
			}
751
		}
752
753
		return $params;
754
	}
755
756
	function jetpack_connection_banner_callback() {
757
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
758
759
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
760
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
761
			wp_send_json_success();
762
		}
763
764
		wp_die();
765
	}
766
767
	function jetpack_admin_ajax_tracks_callback() {
768
		// Check for nonce
769
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
770
			wp_die( 'Permissions check failed.' );
771
		}
772
773
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
774
			wp_die( 'No valid event name or type.' );
775
		}
776
777
		$tracks_data = array();
778
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
779
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
780
				$tracks_data = $_REQUEST['tracksEventProp'];
781
			} else {
782
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
783
			}
784
		}
785
786
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
787
		wp_send_json_success();
788
		wp_die();
789
	}
790
791
	/**
792
	 * The callback for the JITM ajax requests.
793
	 */
794
	function jetpack_jitm_ajax_callback() {
795
		// Check for nonce
796
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
797
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
798
		}
799
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
800
			$module_slug = $_REQUEST['jitmModule'];
801
			Jetpack::log( 'activate', $module_slug );
802
			Jetpack::activate_module( $module_slug, false, false );
803
			Jetpack::state( 'message', 'no_message' );
804
805
			//A Jetpack module is being activated through a JITM, track it
806
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
807
			$this->do_stats( 'server_side' );
808
809
			wp_send_json_success();
810
		}
811
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
812
			// get the hide_jitm options array
813
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
814
			$module_slug = $_REQUEST['jitmModule'];
815
816
			if( ! $jetpack_hide_jitm ) {
817
				$jetpack_hide_jitm = array(
818
					$module_slug => 'hide'
819
				);
820
			} else {
821
				$jetpack_hide_jitm[$module_slug] = 'hide';
822
			}
823
824
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
825
826
			//jitm is being dismissed forever, track it
827
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
828
			$this->do_stats( 'server_side' );
829
830
			wp_send_json_success();
831
		}
832 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
833
			$module_slug = $_REQUEST['jitmModule'];
834
835
			// User went to WordPress.com, track this
836
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
837
			$this->do_stats( 'server_side' );
838
839
			wp_send_json_success();
840
		}
841 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
842
			$track = $_REQUEST['jitmModule'];
843
844
			// User is viewing JITM, track it.
845
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
846
			$this->do_stats( 'server_side' );
847
848
			wp_send_json_success();
849
		}
850
	}
851
852
	/**
853
	 * If there are any stats that need to be pushed, but haven't been, push them now.
854
	 */
855
	function push_stats() {
856
		if ( ! empty( $this->stats ) ) {
857
			$this->do_stats( 'server_side' );
858
		}
859
	}
860
861
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
862
		switch( $cap ) {
863
			case 'jetpack_connect' :
864
			case 'jetpack_reconnect' :
0 ignored issues
show
Coding Style introduced by
There must be a comment when fall-through is intentional in a non-empty case body
Loading history...
865
				if ( Jetpack::is_development_mode() ) {
866
					$caps = array( 'do_not_allow' );
867
					break;
868
				}
869
				/**
870
				 * Pass through. If it's not development mode, these should match disconnect.
871
				 * Let users disconnect if it's development mode, just in case things glitch.
872
				 */
873
			case 'jetpack_disconnect' :
874
				/**
875
				 * In multisite, can individual site admins manage their own connection?
876
				 *
877
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
878
				 */
879
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
880
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
881
						/**
882
						 * We need to update the option name -- it's terribly unclear which
883
						 * direction the override goes.
884
						 *
885
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
886
						 */
887
						$caps = array( 'do_not_allow' );
888
						break;
889
					}
890
				}
891
892
				$caps = array( 'manage_options' );
893
				break;
894
			case 'jetpack_manage_modules' :
895
			case 'jetpack_activate_modules' :
896
			case 'jetpack_deactivate_modules' :
897
				$caps = array( 'manage_options' );
898
				break;
899
			case 'jetpack_configure_modules' :
900
				$caps = array( 'manage_options' );
901
				break;
902
			case 'jetpack_network_admin_page':
903
			case 'jetpack_network_settings_page':
904
				$caps = array( 'manage_network_plugins' );
905
				break;
906
			case 'jetpack_network_sites_page':
907
				$caps = array( 'manage_sites' );
908
				break;
909
			case 'jetpack_admin_page' :
910
				if ( Jetpack::is_development_mode() ) {
911
					$caps = array( 'manage_options' );
912
					break;
913
				} else {
914
					$caps = array( 'read' );
915
				}
916
				break;
917
			case 'jetpack_connect_user' :
918
				if ( Jetpack::is_development_mode() ) {
919
					$caps = array( 'do_not_allow' );
920
					break;
921
				}
922
				$caps = array( 'read' );
923
				break;
924
		}
925
		return $caps;
926
	}
927
928
	function require_jetpack_authentication() {
929
		// Don't let anyone authenticate
930
		$_COOKIE = array();
931
		remove_all_filters( 'authenticate' );
932
		remove_all_actions( 'wp_login_failed' );
933
934
		if ( Jetpack::is_active() ) {
935
			// Allow Jetpack authentication
936
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
937
		}
938
	}
939
940
	/**
941
	 * Load language files
942
	 * @action plugins_loaded
943
	 */
944
	public static function plugin_textdomain() {
945
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
946
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
947
	}
948
949
	/**
950
	 * Register assets for use in various modules and the Jetpack admin page.
951
	 *
952
	 * @uses wp_script_is, wp_register_script, plugins_url
953
	 * @action wp_loaded
954
	 * @return null
955
	 */
956
	public function register_assets() {
957
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
958
			wp_register_script(
959
				'spin',
960
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
961
				false,
962
				'1.3'
963
			);
964
		}
965
966
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
967
			wp_register_script(
968
				'jquery.spin',
969
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
970
				array( 'jquery', 'spin' ),
971
				'1.3'
972
			);
973
		}
974
975 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
976
			wp_register_script(
977
				'jetpack-gallery-settings',
978
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
979
				array( 'media-views' ),
980
				'20121225'
981
			);
982
		}
983
984
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
985
			wp_register_script(
986
				'jetpack-twitter-timeline',
987
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
988
				array( 'jquery' ),
989
				'4.0.0',
990
				true
991
			);
992
		}
993
994
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
995
			wp_register_script(
996
				'jetpack-facebook-embed',
997
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
998
				array( 'jquery' ),
999
				null,
1000
				true
1001
			);
1002
1003
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1004
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1005
			if ( ! is_numeric( $fb_app_id ) ) {
1006
				$fb_app_id = '';
1007
			}
1008
			wp_localize_script(
1009
				'jetpack-facebook-embed',
1010
				'jpfbembed',
1011
				array(
1012
					'appid' => $fb_app_id,
1013
					'locale' => $this->get_locale(),
1014
				)
1015
			);
1016
		}
1017
1018
		/**
1019
		 * As jetpack_register_genericons is by default fired off a hook,
1020
		 * the hook may have already fired by this point.
1021
		 * So, let's just trigger it manually.
1022
		 */
1023
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1024
		jetpack_register_genericons();
1025
1026
		/**
1027
		 * Register the social logos
1028
		 */
1029
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1030
		jetpack_register_social_logos();
1031
1032 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1033
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1034
	}
1035
1036
	/**
1037
	 * Guess locale from language code.
1038
	 *
1039
	 * @param string $lang Language code.
1040
	 * @return string|bool
1041
	 */
1042 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1043
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1044
			return 'en_US';
1045
		}
1046
1047
		if ( ! class_exists( 'GP_Locales' ) ) {
1048
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1049
				return false;
1050
			}
1051
1052
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1053
		}
1054
1055
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1056
			// WP.com: get_locale() returns 'it'
1057
			$locale = GP_Locales::by_slug( $lang );
1058
		} else {
1059
			// Jetpack: get_locale() returns 'it_IT';
1060
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1061
		}
1062
1063
		if ( ! $locale ) {
1064
			return false;
1065
		}
1066
1067
		if ( empty( $locale->facebook_locale ) ) {
1068
			if ( empty( $locale->wp_locale ) ) {
1069
				return false;
1070
			} else {
1071
				// Facebook SDK is smart enough to fall back to en_US if a
1072
				// locale isn't supported. Since supported Facebook locales
1073
				// can fall out of sync, we'll attempt to use the known
1074
				// wp_locale value and rely on said fallback.
1075
				return $locale->wp_locale;
1076
			}
1077
		}
1078
1079
		return $locale->facebook_locale;
1080
	}
1081
1082
	/**
1083
	 * Get the locale.
1084
	 *
1085
	 * @return string|bool
1086
	 */
1087
	function get_locale() {
1088
		$locale = $this->guess_locale_from_lang( get_locale() );
1089
1090
		if ( ! $locale ) {
1091
			$locale = 'en_US';
1092
		}
1093
1094
		return $locale;
1095
	}
1096
1097
	/**
1098
	 * Device Pixels support
1099
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1100
	 */
1101
	function devicepx() {
1102
		if ( Jetpack::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1103
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1104
		}
1105
	}
1106
1107
	/**
1108
	 * Return the network_site_url so that .com knows what network this site is a part of.
1109
	 * @param  bool $option
1110
	 * @return string
1111
	 */
1112
	public function jetpack_main_network_site_option( $option ) {
1113
		return network_site_url();
1114
	}
1115
	/**
1116
	 * Network Name.
1117
	 */
1118
	static function network_name( $option = null ) {
1119
		global $current_site;
1120
		return $current_site->site_name;
1121
	}
1122
	/**
1123
	 * Does the network allow new user and site registrations.
1124
	 * @return string
1125
	 */
1126
	static function network_allow_new_registrations( $option = null ) {
1127
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1128
	}
1129
	/**
1130
	 * Does the network allow admins to add new users.
1131
	 * @return boolian
1132
	 */
1133
	static function network_add_new_users( $option = null ) {
1134
		return (bool) get_site_option( 'add_new_users' );
1135
	}
1136
	/**
1137
	 * File upload psace left per site in MB.
1138
	 *  -1 means NO LIMIT.
1139
	 * @return number
1140
	 */
1141
	static function network_site_upload_space( $option = null ) {
1142
		// value in MB
1143
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1144
	}
1145
1146
	/**
1147
	 * Network allowed file types.
1148
	 * @return string
1149
	 */
1150
	static function network_upload_file_types( $option = null ) {
1151
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1152
	}
1153
1154
	/**
1155
	 * Maximum file upload size set by the network.
1156
	 * @return number
1157
	 */
1158
	static function network_max_upload_file_size( $option = null ) {
1159
		// value in KB
1160
		return get_site_option( 'fileupload_maxk', 300 );
1161
	}
1162
1163
	/**
1164
	 * Lets us know if a site allows admins to manage the network.
1165
	 * @return array
1166
	 */
1167
	static function network_enable_administration_menus( $option = null ) {
1168
		return get_site_option( 'menu_items' );
1169
	}
1170
1171
	/**
1172
	 * If a user has been promoted to or demoted from admin, we need to clear the
1173
	 * jetpack_other_linked_admins transient.
1174
	 *
1175
	 * @since 4.3.2
1176
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1177
	 *
1178
	 * @param int    $user_id   The user ID whose role changed.
1179
	 * @param string $role      The new role.
1180
	 * @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...
1181
	 */
1182
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1183
		if ( 'administrator' == $role
1184
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1185
			|| is_null( $old_roles )
1186
		) {
1187
			delete_transient( 'jetpack_other_linked_admins' );
1188
		}
1189
	}
1190
1191
	/**
1192
	 * Checks to see if there are any other users available to become primary
1193
	 * Users must both:
1194
	 * - Be linked to wpcom
1195
	 * - Be an admin
1196
	 *
1197
	 * @return mixed False if no other users are linked, Int if there are.
1198
	 */
1199
	static function get_other_linked_admins() {
1200
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1201
1202
		if ( false === $other_linked_users ) {
1203
			$admins = get_users( array( 'role' => 'administrator' ) );
1204
			if ( count( $admins ) > 1 ) {
1205
				$available = array();
1206
				foreach ( $admins as $admin ) {
1207
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1208
						$available[] = $admin->ID;
1209
					}
1210
				}
1211
1212
				$count_connected_admins = count( $available );
1213
				if ( count( $available ) > 1 ) {
1214
					$other_linked_users = $count_connected_admins;
1215
				} else {
1216
					$other_linked_users = 0;
1217
				}
1218
			} else {
1219
				$other_linked_users = 0;
1220
			}
1221
1222
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1223
		}
1224
1225
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1226
	}
1227
1228
	/**
1229
	 * Return whether we are dealing with a multi network setup or not.
1230
	 * The reason we are type casting this is because we want to avoid the situation where
1231
	 * the result is false since when is_main_network_option return false it cases
1232
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1233
	 * database which could be set to anything as opposed to what this function returns.
1234
	 * @param  bool  $option
1235
	 *
1236
	 * @return boolean
1237
	 */
1238
	public function is_main_network_option( $option ) {
1239
		// return '1' or ''
1240
		return (string) (bool) Jetpack::is_multi_network();
1241
	}
1242
1243
	/**
1244
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1245
	 *
1246
	 * @param  string  $option
1247
	 * @return boolean
1248
	 */
1249
	public function is_multisite( $option ) {
1250
		return (string) (bool) is_multisite();
1251
	}
1252
1253
	/**
1254
	 * Implemented since there is no core is multi network function
1255
	 * Right now there is no way to tell if we which network is the dominant network on the system
1256
	 *
1257
	 * @since  3.3
1258
	 * @return boolean
1259
	 */
1260
	public static function is_multi_network() {
1261
		global  $wpdb;
1262
1263
		// if we don't have a multi site setup no need to do any more
1264
		if ( ! is_multisite() ) {
1265
			return false;
1266
		}
1267
1268
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1269
		if ( $num_sites > 1 ) {
1270
			return true;
1271
		} else {
1272
			return false;
1273
		}
1274
	}
1275
1276
	/**
1277
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1278
	 * @return null
1279
	 */
1280
	function update_jetpack_main_network_site_option() {
1281
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1282
	}
1283
	/**
1284
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1285
	 *
1286
	 */
1287
	function update_jetpack_network_settings() {
1288
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1289
		// Only sync this info for the main network site.
1290
	}
1291
1292
	/**
1293
	 * Get back if the current site is single user site.
1294
	 *
1295
	 * @return bool
1296
	 */
1297
	public static function is_single_user_site() {
1298
		global $wpdb;
1299
1300 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1301
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1302
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1303
		}
1304
		return 1 === (int) $some_users;
1305
	}
1306
1307
	/**
1308
	 * Returns true if the site has file write access false otherwise.
1309
	 * @return string ( '1' | '0' )
1310
	 **/
1311
	public static function file_system_write_access() {
1312
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1313
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1314
		}
1315
1316
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1317
1318
		$filesystem_method = get_filesystem_method();
1319
		if ( $filesystem_method === 'direct' ) {
1320
			return 1;
1321
		}
1322
1323
		ob_start();
1324
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1325
		ob_end_clean();
1326
		if ( $filesystem_credentials_are_stored ) {
1327
			return 1;
1328
		}
1329
		return 0;
1330
	}
1331
1332
	/**
1333
	 * Finds out if a site is using a version control system.
1334
	 * @return string ( '1' | '0' )
1335
	 **/
1336
	public static function is_version_controlled() {
1337
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1338
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1339
	}
1340
1341
	/**
1342
	 * Determines whether the current theme supports featured images or not.
1343
	 * @return string ( '1' | '0' )
1344
	 */
1345
	public static function featured_images_enabled() {
1346
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1347
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1348
	}
1349
1350
	/**
1351
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1352
	 *
1353
	 * @deprecated 4.7 use get_avatar_url instead.
1354
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1355
	 * @param int $size Size of the avatar image
1356
	 * @param string $default URL to a default image to use if no avatar is available
1357
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1358
	 *
1359
	 * @return array
1360
	 */
1361
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1362
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1363
		return get_avatar_url( $id_or_email, array(
1364
			'size' => $size,
1365
			'default' => $default,
1366
			'force_default' => $force_display,
1367
		) );
1368
	}
1369
1370
	/**
1371
	 * jetpack_updates is saved in the following schema:
1372
	 *
1373
	 * array (
1374
	 *      'plugins'                       => (int) Number of plugin updates available.
1375
	 *      'themes'                        => (int) Number of theme updates available.
1376
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1377
	 *      'translations'                  => (int) Number of translation updates available.
1378
	 *      'total'                         => (int) Total of all available updates.
1379
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1380
	 * )
1381
	 * @return array
1382
	 */
1383
	public static function get_updates() {
1384
		$update_data = wp_get_update_data();
1385
1386
		// Stores the individual update counts as well as the total count.
1387
		if ( isset( $update_data['counts'] ) ) {
1388
			$updates = $update_data['counts'];
1389
		}
1390
1391
		// If we need to update WordPress core, let's find the latest version number.
1392 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1393
			$cur = get_preferred_from_update_core();
1394
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1395
				$updates['wp_update_version'] = $cur->current;
1396
			}
1397
		}
1398
		return isset( $updates ) ? $updates : array();
1399
	}
1400
1401
	public static function get_update_details() {
1402
		$update_details = array(
1403
			'update_core' => get_site_transient( 'update_core' ),
1404
			'update_plugins' => get_site_transient( 'update_plugins' ),
1405
			'update_themes' => get_site_transient( 'update_themes' ),
1406
		);
1407
		return $update_details;
1408
	}
1409
1410
	public static function refresh_update_data() {
1411
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1412
1413
	}
1414
1415
	public static function refresh_theme_data() {
1416
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1417
	}
1418
1419
	/**
1420
	 * Is Jetpack active?
1421
	 */
1422
	public static function is_active() {
1423
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1424
	}
1425
1426
	/**
1427
	 * Make an API call to WordPress.com for plan status
1428
	 *
1429
	 * @uses Jetpack_Options::get_option()
1430
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1431
	 * @uses update_option()
1432
	 *
1433
	 * @access public
1434
	 * @static
1435
	 *
1436
	 * @return bool True if plan is updated, false if no update
1437
	 */
1438
	public static function refresh_active_plan_from_wpcom() {
1439
		// Make the API request
1440
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1441
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1442
1443
		// Bail if there was an error or malformed response
1444
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1445
			return false;
1446
		}
1447
1448
		// Decode the results
1449
		$results = json_decode( $response['body'], true );
1450
1451
		// Bail if there were no results or plan details returned
1452
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1453
			return false;
1454
		}
1455
1456
		// Store the option and return true if updated
1457
		return update_option( 'jetpack_active_plan', $results['plan'] );
1458
	}
1459
1460
	/**
1461
	 * Get the plan that this Jetpack site is currently using
1462
	 *
1463
	 * @uses get_option()
1464
	 *
1465
	 * @access public
1466
	 * @static
1467
	 *
1468
	 * @return array Active Jetpack plan details
1469
	 */
1470
	public static function get_active_plan() {
1471
		global $active_plan_cache;
1472
1473
		// this can be expensive to compute so we cache for the duration of a request
1474
		if ( is_array( $active_plan_cache ) && ! empty( $active_plan_cache ) ) {
1475
			return $active_plan_cache;
1476
		}
1477
1478
		$plan = get_option( 'jetpack_active_plan', array() );
1479
1480
		// Set the default options
1481
		$plan = wp_parse_args( $plan, array(
1482
			'product_slug' => 'jetpack_free',
1483
			'class'        => 'free',
1484
			'features'     => array(
1485
				'active' => array()
1486
			),
1487
		) );
1488
1489
		$supports = array();
1490
1491
		// Define what paid modules are supported by personal plans
1492
		$personal_plans = array(
1493
			'jetpack_personal',
1494
			'jetpack_personal_monthly',
1495
			'personal-bundle',
1496
			'personal-bundle-2y',
1497
		);
1498
1499
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1500
			// special support value, not a module but a separate plugin
1501
			$supports[] = 'akismet';
1502
			$plan['class'] = 'personal';
1503
		}
1504
1505
		// Define what paid modules are supported by premium plans
1506
		$premium_plans = array(
1507
			'jetpack_premium',
1508
			'jetpack_premium_monthly',
1509
			'value_bundle',
1510
			'value_bundle-2y',
1511
		);
1512
1513 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1514
			$supports[] = 'akismet';
1515
			$supports[] = 'simple-payments';
1516
			$supports[] = 'vaultpress';
1517
			$plan['class'] = 'premium';
1518
		}
1519
1520
		// Define what paid modules are supported by professional plans
1521
		$business_plans = array(
1522
			'jetpack_business',
1523
			'jetpack_business_monthly',
1524
			'business-bundle',
1525
			'business-bundle-2y',
1526
			'vip',
1527
		);
1528
1529 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1530
			$supports[] = 'akismet';
1531
			$supports[] = 'simple-payments';
1532
			$supports[] = 'vaultpress';
1533
			$plan['class'] = 'business';
1534
		}
1535
1536
		// get available features
1537
		foreach ( self::get_available_modules() as $module_slug ) {
1538
			$module = self::get_module( $module_slug );
1539
			if ( ! isset( $module ) || ! is_array( $module ) ) {
1540
				continue;
1541
			}
1542
			if ( in_array( 'free', $module['plan_classes'] ) || in_array( $plan['class'], $module['plan_classes'] ) ) {
1543
				$supports[] = $module_slug;
1544
			}
1545
		}
1546
1547
		$plan['supports'] = $supports;
1548
1549
		$active_plan_cache = $plan;
1550
1551
		return $plan;
1552
	}
1553
1554
	/**
1555
	 * Determine whether the active plan supports a particular feature
1556
	 *
1557
	 * @uses Jetpack::get_active_plan()
1558
	 *
1559
	 * @access public
1560
	 * @static
1561
	 *
1562
	 * @return bool True if plan supports feature, false if not
1563
	 */
1564
	public static function active_plan_supports( $feature ) {
1565
		$plan = Jetpack::get_active_plan();
1566
1567
		// Manually mapping WordPress.com features to Jetpack module slugs
1568
		foreach ( $plan['features']['active'] as $wpcom_feature ) {
1569
			switch ( $wpcom_feature ) {
1570
				case 'wordads-jetpack';
0 ignored issues
show
Coding Style introduced by
case statements should be defined using a colon.

As per the PSR-2 coding standard, case statements should not be wrapped in curly braces. There is no need for braces, since each case is terminated by the next break.

There is also the option to use a semicolon instead of a colon, this is discouraged because many programmers do not even know it works and the colon is universal between programming languages.

switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
1571
1572
				// WordAds are supported for this site
1573
				if ( 'wordads' === $feature ) {
1574
					return true;
1575
				}
1576
				break;
1577
			}
1578
		}
1579
1580
		if (
1581
			in_array( $feature, $plan['supports'] )
1582
			|| in_array( $feature, $plan['features']['active'] )
1583
		) {
1584
			return true;
1585
		}
1586
1587
		return false;
1588
	}
1589
1590
	/**
1591
	 * Is Jetpack in development (offline) mode?
1592
	 */
1593
	public static function is_development_mode() {
1594
		$development_mode = false;
1595
1596
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1597
			$development_mode = JETPACK_DEV_DEBUG;
1598
		} elseif ( $site_url = site_url() ) {
1599
			$development_mode = false === strpos( $site_url, '.' );
1600
		}
1601
1602
		/**
1603
		 * Filters Jetpack's development mode.
1604
		 *
1605
		 * @see https://jetpack.com/support/development-mode/
1606
		 *
1607
		 * @since 2.2.1
1608
		 *
1609
		 * @param bool $development_mode Is Jetpack's development mode active.
1610
		 */
1611
		$development_mode = ( bool ) apply_filters( 'jetpack_development_mode', $development_mode );
1612
		return $development_mode;
1613
	}
1614
1615
	/**
1616
	 * Whether the site is currently onboarding or not.
1617
	 * A site is considered as being onboarded if it currently has an onboarding token.
1618
	 *
1619
	 * @since 5.8
1620
	 *
1621
	 * @access public
1622
	 * @static
1623
	 *
1624
	 * @return bool True if the site is currently onboarding, false otherwise
1625
	 */
1626
	public static function is_onboarding() {
1627
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1628
	}
1629
1630
	/**
1631
	* Get Jetpack development mode notice text and notice class.
1632
	*
1633
	* Mirrors the checks made in Jetpack::is_development_mode
1634
	*
1635
	*/
1636
	public static function show_development_mode_notice() {
1637
		if ( Jetpack::is_development_mode() ) {
1638
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1639
				$notice = sprintf(
1640
					/* translators: %s is a URL */
1641
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1642
					'https://jetpack.com/support/development-mode/'
1643
				);
1644
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1645
				$notice = sprintf(
1646
					/* translators: %s is a URL */
1647
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1648
					'https://jetpack.com/support/development-mode/'
1649
				);
1650
			} else {
1651
				$notice = sprintf(
1652
					/* translators: %s is a URL */
1653
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1654
					'https://jetpack.com/support/development-mode/'
1655
				);
1656
			}
1657
1658
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1659
		}
1660
1661
		// Throw up a notice if using a development version and as for feedback.
1662
		if ( Jetpack::is_development_version() ) {
1663
			/* translators: %s is a URL */
1664
			$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/' );
1665
1666
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1667
		}
1668
		// Throw up a notice if using staging mode
1669
		if ( Jetpack::is_staging_site() ) {
1670
			/* translators: %s is a URL */
1671
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1672
1673
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1674
		}
1675
	}
1676
1677
	/**
1678
	 * Whether Jetpack's version maps to a public release, or a development version.
1679
	 */
1680
	public static function is_development_version() {
1681
		/**
1682
		 * Allows filtering whether this is a development version of Jetpack.
1683
		 *
1684
		 * This filter is especially useful for tests.
1685
		 *
1686
		 * @since 4.3.0
1687
		 *
1688
		 * @param bool $development_version Is this a develoment version of Jetpack?
1689
		 */
1690
		return (bool) apply_filters(
1691
			'jetpack_development_version',
1692
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1693
		);
1694
	}
1695
1696
	/**
1697
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1698
	 */
1699
	public static function is_user_connected( $user_id = false ) {
1700
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1701
		if ( ! $user_id ) {
1702
			return false;
1703
		}
1704
1705
		return (bool) Jetpack_Data::get_access_token( $user_id );
1706
	}
1707
1708
	/**
1709
	 * Get the wpcom user data of the current|specified connected user.
1710
	 */
1711
	public static function get_connected_user_data( $user_id = null ) {
1712
		if ( ! $user_id ) {
1713
			$user_id = get_current_user_id();
1714
		}
1715
1716
		$transient_key = "jetpack_connected_user_data_$user_id";
1717
1718
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1719
			return $cached_user_data;
1720
		}
1721
1722
		Jetpack::load_xml_rpc_client();
1723
		$xml = new Jetpack_IXR_Client( array(
1724
			'user_id' => $user_id,
1725
		) );
1726
		$xml->query( 'wpcom.getUser' );
1727
		if ( ! $xml->isError() ) {
1728
			$user_data = $xml->getResponse();
1729
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1730
			return $user_data;
1731
		}
1732
1733
		return false;
1734
	}
1735
1736
	/**
1737
	 * Get the wpcom email of the current|specified connected user.
1738
	 */
1739 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1740
		if ( ! $user_id ) {
1741
			$user_id = get_current_user_id();
1742
		}
1743
		Jetpack::load_xml_rpc_client();
1744
		$xml = new Jetpack_IXR_Client( array(
1745
			'user_id' => $user_id,
1746
		) );
1747
		$xml->query( 'wpcom.getUserEmail' );
1748
		if ( ! $xml->isError() ) {
1749
			return $xml->getResponse();
1750
		}
1751
		return false;
1752
	}
1753
1754
	/**
1755
	 * Get the wpcom email of the master user.
1756
	 */
1757
	public static function get_master_user_email() {
1758
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1759
		if ( $master_user_id ) {
1760
			return self::get_connected_user_email( $master_user_id );
1761
		}
1762
		return '';
1763
	}
1764
1765
	function current_user_is_connection_owner() {
1766
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1767
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1768
	}
1769
1770
	/**
1771
	 * Gets current user IP address.
1772
	 *
1773
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1774
	 *
1775
	 * @return string                  Current user IP address.
1776
	 */
1777
	public static function current_user_ip( $check_all_headers = false ) {
1778
		if ( $check_all_headers ) {
1779
			foreach ( array(
1780
				'HTTP_CF_CONNECTING_IP',
1781
				'HTTP_CLIENT_IP',
1782
				'HTTP_X_FORWARDED_FOR',
1783
				'HTTP_X_FORWARDED',
1784
				'HTTP_X_CLUSTER_CLIENT_IP',
1785
				'HTTP_FORWARDED_FOR',
1786
				'HTTP_FORWARDED',
1787
				'HTTP_VIA',
1788
			) as $key ) {
1789
				if ( ! empty( $_SERVER[ $key ] ) ) {
1790
					return $_SERVER[ $key ];
1791
				}
1792
			}
1793
		}
1794
1795
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1796
	}
1797
1798
	/**
1799
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1800
	 */
1801
	function extra_oembed_providers() {
1802
		// Cloudup: https://dev.cloudup.com/#oembed
1803
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1804
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1805
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1806
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1807
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1808
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1809
	}
1810
1811
	/**
1812
	 * Synchronize connected user role changes
1813
	 */
1814
	function user_role_change( $user_id ) {
1815
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1816
		Jetpack_Sync_Users::user_role_change( $user_id );
1817
	}
1818
1819
	/**
1820
	 * Loads the currently active modules.
1821
	 */
1822
	public static function load_modules() {
1823
		if (
1824
			! self::is_active()
1825
			&& ! self::is_development_mode()
1826
			&& ! self::is_onboarding()
1827
			&& (
1828
				! is_multisite()
1829
				|| ! get_site_option( 'jetpack_protect_active' )
1830
			)
1831
		) {
1832
			return;
1833
		}
1834
1835
		$version = Jetpack_Options::get_option( 'version' );
1836 View Code Duplication
		if ( ! $version ) {
1837
			$version = $old_version = JETPACK__VERSION . ':' . time();
1838
			/** This action is documented in class.jetpack.php */
1839
			do_action( 'updating_jetpack_version', $version, false );
1840
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1841
		}
1842
		list( $version ) = explode( ':', $version );
1843
1844
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1845
1846
		$modules_data = array();
1847
1848
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1849
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1850
			$updated_modules = array();
1851
			foreach ( $modules as $module ) {
1852
				$modules_data[ $module ] = Jetpack::get_module( $module );
1853
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1854
					continue;
1855
				}
1856
1857
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1858
					continue;
1859
				}
1860
1861
				$updated_modules[] = $module;
1862
			}
1863
1864
			$modules = array_diff( $modules, $updated_modules );
1865
		}
1866
1867
		$is_development_mode = Jetpack::is_development_mode();
1868
1869
		foreach ( $modules as $index => $module ) {
1870
			// If we're in dev mode, disable modules requiring a connection
1871
			if ( $is_development_mode ) {
1872
				// Prime the pump if we need to
1873
				if ( empty( $modules_data[ $module ] ) ) {
1874
					$modules_data[ $module ] = Jetpack::get_module( $module );
1875
				}
1876
				// If the module requires a connection, but we're in local mode, don't include it.
1877
				if ( $modules_data[ $module ]['requires_connection'] ) {
1878
					continue;
1879
				}
1880
			}
1881
1882
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1883
				continue;
1884
			}
1885
1886
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1887
				unset( $modules[ $index ] );
1888
				self::update_active_modules( array_values( $modules ) );
1889
				continue;
1890
			}
1891
1892
			/**
1893
			 * Fires when a specific module is loaded.
1894
			 * The dynamic part of the hook, $module, is the module slug.
1895
			 *
1896
			 * @since 1.1.0
1897
			 */
1898
			do_action( 'jetpack_module_loaded_' . $module );
1899
		}
1900
1901
		/**
1902
		 * Fires when all the modules are loaded.
1903
		 *
1904
		 * @since 1.1.0
1905
		 */
1906
		do_action( 'jetpack_modules_loaded' );
1907
1908
		// 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.
1909
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1910
	}
1911
1912
	/**
1913
	 * Check if Jetpack's REST API compat file should be included
1914
	 * @action plugins_loaded
1915
	 * @return null
1916
	 */
1917
	public function check_rest_api_compat() {
1918
		/**
1919
		 * Filters the list of REST API compat files to be included.
1920
		 *
1921
		 * @since 2.2.5
1922
		 *
1923
		 * @param array $args Array of REST API compat files to include.
1924
		 */
1925
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1926
1927
		if ( function_exists( 'bbpress' ) )
1928
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1929
1930
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1931
			require_once $_jetpack_rest_api_compat_include;
1932
	}
1933
1934
	/**
1935
	 * Gets all plugins currently active in values, regardless of whether they're
1936
	 * traditionally activated or network activated.
1937
	 *
1938
	 * @todo Store the result in core's object cache maybe?
0 ignored issues
show
Coding Style introduced by
Comment refers to a TODO task

This check looks TODO comments that have been left in the code.

``TODO``s show that something is left unfinished and should be attended to.

Loading history...
1939
	 */
1940
	public static function get_active_plugins() {
1941
		$active_plugins = (array) get_option( 'active_plugins', array() );
1942
1943
		if ( is_multisite() ) {
1944
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1945
			// whereas active_plugins stores them in the values.
1946
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1947
			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...
1948
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1949
			}
1950
		}
1951
1952
		sort( $active_plugins );
1953
1954
		return array_unique( $active_plugins );
1955
	}
1956
1957
	/**
1958
	 * Gets and parses additional plugin data to send with the heartbeat data
1959
	 *
1960
	 * @since 3.8.1
1961
	 *
1962
	 * @return array Array of plugin data
1963
	 */
1964
	public static function get_parsed_plugin_data() {
1965
		if ( ! function_exists( 'get_plugins' ) ) {
1966
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1967
		}
1968
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1969
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1970
		$active_plugins = Jetpack::get_active_plugins();
1971
1972
		$plugins = array();
1973
		foreach ( $all_plugins as $path => $plugin_data ) {
1974
			$plugins[ $path ] = array(
1975
					'is_active' => in_array( $path, $active_plugins ),
1976
					'file'      => $path,
1977
					'name'      => $plugin_data['Name'],
1978
					'version'   => $plugin_data['Version'],
1979
					'author'    => $plugin_data['Author'],
1980
			);
1981
		}
1982
1983
		return $plugins;
1984
	}
1985
1986
	/**
1987
	 * Gets and parses theme data to send with the heartbeat data
1988
	 *
1989
	 * @since 3.8.1
1990
	 *
1991
	 * @return array Array of theme data
1992
	 */
1993
	public static function get_parsed_theme_data() {
1994
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1995
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1996
1997
		$themes = array();
1998
		foreach ( $all_themes as $slug => $theme_data ) {
1999
			$theme_headers = array();
2000
			foreach ( $header_keys as $header_key ) {
2001
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2002
			}
2003
2004
			$themes[ $slug ] = array(
2005
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
2006
					'slug' => $slug,
2007
					'theme_root' => $theme_data->get_theme_root_uri(),
2008
					'parent' => $theme_data->parent(),
2009
					'headers' => $theme_headers
2010
			);
2011
		}
2012
2013
		return $themes;
2014
	}
2015
2016
	/**
2017
	 * Checks whether a specific plugin is active.
2018
	 *
2019
	 * We don't want to store these in a static variable, in case
2020
	 * there are switch_to_blog() calls involved.
2021
	 */
2022
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2023
		return in_array( $plugin, self::get_active_plugins() );
2024
	}
2025
2026
	/**
2027
	 * Check if Jetpack's Open Graph tags should be used.
2028
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2029
	 *
2030
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2031
	 * @action plugins_loaded
2032
	 * @return null
2033
	 */
2034
	public function check_open_graph() {
2035
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
2036
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2037
		}
2038
2039
		$active_plugins = self::get_active_plugins();
2040
2041
		if ( ! empty( $active_plugins ) ) {
2042
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2043
				if ( in_array( $plugin, $active_plugins ) ) {
2044
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2045
					break;
2046
				}
2047
			}
2048
		}
2049
2050
		/**
2051
		 * Allow the addition of Open Graph Meta Tags to all pages.
2052
		 *
2053
		 * @since 2.0.3
2054
		 *
2055
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2056
		 */
2057
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2058
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2059
		}
2060
	}
2061
2062
	/**
2063
	 * Check if Jetpack's Twitter tags should be used.
2064
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2065
	 *
2066
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2067
	 * @action plugins_loaded
2068
	 * @return null
2069
	 */
2070
	public function check_twitter_tags() {
2071
2072
		$active_plugins = self::get_active_plugins();
2073
2074
		if ( ! empty( $active_plugins ) ) {
2075
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2076
				if ( in_array( $plugin, $active_plugins ) ) {
2077
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2078
					break;
2079
				}
2080
			}
2081
		}
2082
2083
		/**
2084
		 * Allow Twitter Card Meta tags to be disabled.
2085
		 *
2086
		 * @since 2.6.0
2087
		 *
2088
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2089
		 */
2090
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2091
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2092
		}
2093
	}
2094
2095
	/**
2096
	 * Allows plugins to submit security reports.
2097
 	 *
2098
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2099
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2100
	 * @param array   $args         See definitions above
2101
	 */
2102
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2103
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2104
	}
2105
2106
/* Jetpack Options API */
2107
2108
	public static function get_option_names( $type = 'compact' ) {
2109
		return Jetpack_Options::get_option_names( $type );
2110
	}
2111
2112
	/**
2113
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2114
 	 *
2115
	 * @param string $name    Option name
2116
	 * @param mixed  $default (optional)
2117
	 */
2118
	public static function get_option( $name, $default = false ) {
2119
		return Jetpack_Options::get_option( $name, $default );
2120
	}
2121
2122
	/**
2123
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2124
 	 *
2125
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2126
	 * @param string $name  Option name
2127
	 * @param mixed  $value Option value
2128
	 */
2129
	public static function update_option( $name, $value ) {
2130
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2131
		return Jetpack_Options::update_option( $name, $value );
2132
	}
2133
2134
	/**
2135
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2136
 	 *
2137
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2138
	 * @param array $array array( option name => option value, ... )
2139
	 */
2140
	public static function update_options( $array ) {
2141
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2142
		return Jetpack_Options::update_options( $array );
2143
	}
2144
2145
	/**
2146
	 * Deletes the given option.  May be passed multiple option names as an array.
2147
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2148
	 *
2149
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2150
	 * @param string|array $names
2151
	 */
2152
	public static function delete_option( $names ) {
2153
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2154
		return Jetpack_Options::delete_option( $names );
2155
	}
2156
2157
	/**
2158
	 * Enters a user token into the user_tokens option
2159
	 *
2160
	 * @param int $user_id
2161
	 * @param string $token
2162
	 * return bool
2163
	 */
2164
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2165
		// not designed for concurrent updates
2166
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2167
		if ( ! is_array( $user_tokens ) )
2168
			$user_tokens = array();
2169
		$user_tokens[$user_id] = $token;
2170
		if ( $is_master_user ) {
2171
			$master_user = $user_id;
2172
			$options     = compact( 'user_tokens', 'master_user' );
2173
		} else {
2174
			$options = compact( 'user_tokens' );
2175
		}
2176
		return Jetpack_Options::update_options( $options );
2177
	}
2178
2179
	/**
2180
	 * Returns an array of all PHP files in the specified absolute path.
2181
	 * Equivalent to glob( "$absolute_path/*.php" ).
2182
	 *
2183
	 * @param string $absolute_path The absolute path of the directory to search.
2184
	 * @return array Array of absolute paths to the PHP files.
2185
	 */
2186
	public static function glob_php( $absolute_path ) {
2187
		if ( function_exists( 'glob' ) ) {
2188
			return glob( "$absolute_path/*.php" );
2189
		}
2190
2191
		$absolute_path = untrailingslashit( $absolute_path );
2192
		$files = array();
2193
		if ( ! $dir = @opendir( $absolute_path ) ) {
2194
			return $files;
2195
		}
2196
2197
		while ( false !== $file = readdir( $dir ) ) {
2198
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2199
				continue;
2200
			}
2201
2202
			$file = "$absolute_path/$file";
2203
2204
			if ( ! is_file( $file ) ) {
2205
				continue;
2206
			}
2207
2208
			$files[] = $file;
2209
		}
2210
2211
		closedir( $dir );
2212
2213
		return $files;
2214
	}
2215
2216
	public static function activate_new_modules( $redirect = false ) {
2217
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2218
			return;
2219
		}
2220
2221
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2222 View Code Duplication
		if ( ! $jetpack_old_version ) {
2223
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2224
			/** This action is documented in class.jetpack.php */
2225
			do_action( 'updating_jetpack_version', $version, false );
2226
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2227
		}
2228
2229
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2230
2231
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2232
			return;
2233
		}
2234
2235
		$active_modules     = Jetpack::get_active_modules();
2236
		$reactivate_modules = array();
2237
		foreach ( $active_modules as $active_module ) {
2238
			$module = Jetpack::get_module( $active_module );
2239
			if ( ! isset( $module['changed'] ) ) {
2240
				continue;
2241
			}
2242
2243
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2244
				continue;
2245
			}
2246
2247
			$reactivate_modules[] = $active_module;
2248
			Jetpack::deactivate_module( $active_module );
2249
		}
2250
2251
		$new_version = JETPACK__VERSION . ':' . time();
2252
		/** This action is documented in class.jetpack.php */
2253
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2254
		Jetpack_Options::update_options(
2255
			array(
2256
				'version'     => $new_version,
2257
				'old_version' => $jetpack_old_version,
2258
			)
2259
		);
2260
2261
		Jetpack::state( 'message', 'modules_activated' );
2262
		Jetpack::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules );
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...
2263
2264
		if ( $redirect ) {
2265
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2266
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2267
				$page = $_GET['page'];
2268
			}
2269
2270
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2271
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_new_modules() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2272
		}
2273
	}
2274
2275
	/**
2276
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2277
	 * Make sure to tuck away module "library" files in a sub-directory.
2278
	 */
2279
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2280
		static $modules = null;
2281
2282
		if ( ! isset( $modules ) ) {
2283
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2284
			// Use the cache if we're on the front-end and it's available...
2285
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2286
				$modules = $available_modules_option[ JETPACK__VERSION ];
2287
			} else {
2288
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2289
2290
				$modules = array();
2291
2292
				foreach ( $files as $file ) {
2293
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2294
						continue;
2295
					}
2296
2297
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2298
				}
2299
2300
				Jetpack_Options::update_option( 'available_modules', array(
2301
					JETPACK__VERSION => $modules,
2302
				) );
2303
			}
2304
		}
2305
2306
		/**
2307
		 * Filters the array of modules available to be activated.
2308
		 *
2309
		 * @since 2.4.0
2310
		 *
2311
		 * @param array $modules Array of available modules.
2312
		 * @param string $min_version Minimum version number required to use modules.
2313
		 * @param string $max_version Maximum version number required to use modules.
2314
		 */
2315
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2316
2317
		if ( ! $min_version && ! $max_version ) {
2318
			return array_keys( $mods );
2319
		}
2320
2321
		$r = array();
2322
		foreach ( $mods as $slug => $introduced ) {
2323
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2324
				continue;
2325
			}
2326
2327
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2328
				continue;
2329
			}
2330
2331
			$r[] = $slug;
2332
		}
2333
2334
		return $r;
2335
	}
2336
2337
	/**
2338
	 * Default modules loaded on activation.
2339
	 */
2340
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2341
		$return = array();
2342
2343
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2344
			$module_data = Jetpack::get_module( $module );
2345
2346
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2347
				case 'yes' :
2348
					$return[] = $module;
2349
					break;
2350
				case 'public' :
2351
					if ( Jetpack_Options::get_option( 'public' ) ) {
2352
						$return[] = $module;
2353
					}
2354
					break;
2355
				case 'no' :
2356
				default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
2357
					break;
2358
			}
2359
		}
2360
		/**
2361
		 * Filters the array of default modules.
2362
		 *
2363
		 * @since 2.5.0
2364
		 *
2365
		 * @param array $return Array of default modules.
2366
		 * @param string $min_version Minimum version number required to use modules.
2367
		 * @param string $max_version Maximum version number required to use modules.
2368
		 */
2369
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2370
	}
2371
2372
	/**
2373
	 * Checks activated modules during auto-activation to determine
2374
	 * if any of those modules are being deprecated.  If so, close
2375
	 * them out, and add any replacement modules.
2376
	 *
2377
	 * Runs at priority 99 by default.
2378
	 *
2379
	 * This is run late, so that it can still activate a module if
2380
	 * the new module is a replacement for another that the user
2381
	 * currently has active, even if something at the normal priority
2382
	 * would kibosh everything.
2383
	 *
2384
	 * @since 2.6
2385
	 * @uses jetpack_get_default_modules filter
2386
	 * @param array $modules
2387
	 * @return array
2388
	 */
2389
	function handle_deprecated_modules( $modules ) {
2390
		$deprecated_modules = array(
2391
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2392
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2393
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2394
		);
2395
2396
		// Don't activate SSO if they never completed activating WPCC.
2397
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2398
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2399
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2400
				$deprecated_modules['wpcc'] = null;
2401
			}
2402
		}
2403
2404
		foreach ( $deprecated_modules as $module => $replacement ) {
2405
			if ( Jetpack::is_module_active( $module ) ) {
2406
				self::deactivate_module( $module );
2407
				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...
2408
					$modules[] = $replacement;
2409
				}
2410
			}
2411
		}
2412
2413
		return array_unique( $modules );
2414
	}
2415
2416
	/**
2417
	 * Checks activated plugins during auto-activation to determine
2418
	 * if any of those plugins are in the list with a corresponding module
2419
	 * that is not compatible with the plugin. The module will not be allowed
2420
	 * to auto-activate.
2421
	 *
2422
	 * @since 2.6
2423
	 * @uses jetpack_get_default_modules filter
2424
	 * @param array $modules
2425
	 * @return array
2426
	 */
2427
	function filter_default_modules( $modules ) {
2428
2429
		$active_plugins = self::get_active_plugins();
2430
2431
		if ( ! empty( $active_plugins ) ) {
2432
2433
			// For each module we'd like to auto-activate...
2434
			foreach ( $modules as $key => $module ) {
2435
				// If there are potential conflicts for it...
2436
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2437
					// For each potential conflict...
2438
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2439
						// If that conflicting plugin is active...
2440
						if ( in_array( $plugin, $active_plugins ) ) {
2441
							// Remove that item from being auto-activated.
2442
							unset( $modules[ $key ] );
2443
						}
2444
					}
2445
				}
2446
			}
2447
		}
2448
2449
		return $modules;
2450
	}
2451
2452
	/**
2453
	 * Extract a module's slug from its full path.
2454
	 */
2455
	public static function get_module_slug( $file ) {
2456
		return str_replace( '.php', '', basename( $file ) );
2457
	}
2458
2459
	/**
2460
	 * Generate a module's path from its slug.
2461
	 */
2462
	public static function get_module_path( $slug ) {
2463
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2464
	}
2465
2466
	/**
2467
	 * Load module data from module file. Headers differ from WordPress
2468
	 * plugin headers to avoid them being identified as standalone
2469
	 * plugins on the WordPress plugins page.
2470
	 */
2471
	public static function get_module( $module ) {
2472
		$headers = array(
2473
			'name'                      => 'Module Name',
2474
			'description'               => 'Module Description',
2475
			'jumpstart_desc'            => 'Jumpstart Description',
2476
			'sort'                      => 'Sort Order',
2477
			'recommendation_order'      => 'Recommendation Order',
2478
			'introduced'                => 'First Introduced',
2479
			'changed'                   => 'Major Changes In',
2480
			'deactivate'                => 'Deactivate',
2481
			'free'                      => 'Free',
2482
			'requires_connection'       => 'Requires Connection',
2483
			'auto_activate'             => 'Auto Activate',
2484
			'module_tags'               => 'Module Tags',
2485
			'feature'                   => 'Feature',
2486
			'additional_search_queries' => 'Additional Search Queries',
2487
			'plan_classes'              => 'Plans',
2488
		);
2489
2490
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2491
2492
		$mod = Jetpack::get_file_data( $file, $headers );
2493
		if ( empty( $mod['name'] ) ) {
2494
			return false;
2495
		}
2496
2497
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2498
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2499
		$mod['deactivate']              = empty( $mod['deactivate'] );
2500
		$mod['free']                    = empty( $mod['free'] );
2501
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2502
2503
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2504
			$mod['auto_activate'] = 'No';
2505
		} else {
2506
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2507
		}
2508
2509
		if ( $mod['module_tags'] ) {
2510
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2511
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2512
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2513
		} else {
2514
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2515
		}
2516
2517 View Code Duplication
		if ( $mod['plan_classes'] ) {
2518
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2519
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2520
		} else {
2521
			$mod['plan_classes'] = array( 'free' );
2522
		}
2523
2524 View Code Duplication
		if ( $mod['feature'] ) {
2525
			$mod['feature'] = explode( ',', $mod['feature'] );
2526
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2527
		} else {
2528
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2529
		}
2530
2531
		/**
2532
		 * Filters the feature array on a module.
2533
		 *
2534
		 * This filter allows you to control where each module is filtered: Recommended,
2535
		 * Jumpstart, and the default "Other" listing.
2536
		 *
2537
		 * @since 3.5.0
2538
		 *
2539
		 * @param array   $mod['feature'] The areas to feature this module:
2540
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2541
		 *     'Recommended' shows on the main Jetpack admin screen.
2542
		 *     'Other' should be the default if no other value is in the array.
2543
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2544
		 * @param array   $mod All the currently assembled module data.
2545
		 */
2546
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2547
2548
		/**
2549
		 * Filter the returned data about a module.
2550
		 *
2551
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2552
		 * so please be careful.
2553
		 *
2554
		 * @since 3.6.0
2555
		 *
2556
		 * @param array   $mod    The details of the requested module.
2557
		 * @param string  $module The slug of the module, e.g. sharedaddy
2558
		 * @param string  $file   The path to the module source file.
2559
		 */
2560
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2561
	}
2562
2563
	/**
2564
	 * Like core's get_file_data implementation, but caches the result.
2565
	 */
2566
	public static function get_file_data( $file, $headers ) {
2567
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2568
		$file_name = basename( $file );
2569
2570
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2571
2572
		$file_data_option = get_transient( $cache_key );
2573
2574
		if ( false === $file_data_option ) {
2575
			$file_data_option = array();
2576
		}
2577
2578
		$key           = md5( $file_name . serialize( $headers ) );
2579
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2580
2581
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2582
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2583
			return $file_data_option[ $key ];
2584
		}
2585
2586
		$data = get_file_data( $file, $headers );
2587
2588
		$file_data_option[ $key ] = $data;
2589
2590
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2591
2592
		return $data;
2593
	}
2594
2595
2596
	/**
2597
	 * Return translated module tag.
2598
	 *
2599
	 * @param string $tag Tag as it appears in each module heading.
2600
	 *
2601
	 * @return mixed
2602
	 */
2603
	public static function translate_module_tag( $tag ) {
2604
		return jetpack_get_module_i18n_tag( $tag );
2605
	}
2606
2607
	/**
2608
	 * Get i18n strings as a JSON-encoded string
2609
	 *
2610
	 * @return string The locale as JSON
2611
	 */
2612
	public static function get_i18n_data_json() {
2613
		$i18n_json = JETPACK__PLUGIN_DIR . 'languages/json/jetpack-' . jetpack_get_user_locale() . '.json';
2614
2615
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2616
			$locale_data = @file_get_contents( $i18n_json );
2617
			if ( $locale_data ) {
2618
				return $locale_data;
2619
			}
2620
		}
2621
2622
		// Return valid empty Jed locale
2623
		return json_encode( array(
2624
			'' => array(
2625
				'domain' => 'jetpack',
2626
				'lang'   => is_admin() ? get_user_locale() : get_locale(),
2627
			),
2628
		) );
2629
	}
2630
2631
	/**
2632
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2633
	 *
2634
	 * @since 3.9.2
2635
	 *
2636
	 * @param array $modules
2637
	 *
2638
	 * @return string|void
2639
	 */
2640
	public static function get_translated_modules( $modules ) {
2641
		foreach ( $modules as $index => $module ) {
2642
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2643
			if ( isset( $module['name'] ) ) {
2644
				$modules[ $index ]['name'] = $i18n_module['name'];
2645
			}
2646
			if ( isset( $module['description'] ) ) {
2647
				$modules[ $index ]['description'] = $i18n_module['description'];
2648
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2649
			}
2650
		}
2651
		return $modules;
2652
	}
2653
2654
	/**
2655
	 * Get a list of activated modules as an array of module slugs.
2656
	 */
2657
	public static function get_active_modules() {
2658
		$active = Jetpack_Options::get_option( 'active_modules' );
2659
2660
		if ( ! is_array( $active ) ) {
2661
			$active = array();
2662
		}
2663
2664
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2665
			$active[] = 'vaultpress';
2666
		} else {
2667
			$active = array_diff( $active, array( 'vaultpress' ) );
2668
		}
2669
2670
		//If protect is active on the main site of a multisite, it should be active on all sites.
2671
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2672
			$active[] = 'protect';
2673
		}
2674
2675
		/**
2676
		 * Allow filtering of the active modules.
2677
		 *
2678
		 * Gives theme and plugin developers the power to alter the modules that
2679
		 * are activated on the fly.
2680
		 *
2681
		 * @since 5.8.0
2682
		 *
2683
		 * @param array $active Array of active module slugs.
2684
		 */
2685
		$active = apply_filters( 'jetpack_active_modules', $active );
2686
2687
		return array_unique( $active );
2688
	}
2689
2690
	/**
2691
	 * Check whether or not a Jetpack module is active.
2692
	 *
2693
	 * @param string $module The slug of a Jetpack module.
2694
	 * @return bool
2695
	 *
2696
	 * @static
2697
	 */
2698
	public static function is_module_active( $module ) {
2699
		return in_array( $module, self::get_active_modules() );
2700
	}
2701
2702
	public static function is_module( $module ) {
2703
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2704
	}
2705
2706
	/**
2707
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2708
	 *
2709
	 * @param bool $catch True to start catching, False to stop.
2710
	 *
2711
	 * @static
2712
	 */
2713
	public static function catch_errors( $catch ) {
2714
		static $display_errors, $error_reporting;
2715
2716
		if ( $catch ) {
2717
			$display_errors  = @ini_set( 'display_errors', 1 );
2718
			$error_reporting = @error_reporting( E_ALL );
2719
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2720
		} else {
2721
			@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...
2722
			@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...
2723
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2724
		}
2725
	}
2726
2727
	/**
2728
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2729
	 */
2730
	public static function catch_errors_on_shutdown() {
2731
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2732
	}
2733
2734
	/**
2735
	 * Rewrite any string to make paths easier to read.
2736
	 *
2737
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2738
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2739
	 *
2740
	 * @param $string
2741
	 * @return mixed
2742
	 */
2743
	public static function alias_directories( $string ) {
2744
		// ABSPATH has a trailing slash.
2745
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2746
		// WP_CONTENT_DIR does not have a trailing slash.
2747
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2748
2749
		return $string;
2750
	}
2751
2752
	public static function activate_default_modules(
2753
		$min_version = false,
2754
		$max_version = false,
2755
		$other_modules = array(),
2756
		$redirect = true,
2757
		$send_state_messages = true
2758
	) {
2759
		$jetpack = Jetpack::init();
2760
2761
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2762
		$modules = array_merge( $other_modules, $modules );
2763
2764
		// Look for standalone plugins and disable if active.
2765
2766
		$to_deactivate = array();
2767
		foreach ( $modules as $module ) {
2768
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2769
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2770
			}
2771
		}
2772
2773
		$deactivated = array();
2774
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2775
			list( $probable_file, $probable_title ) = $deactivate_me;
2776
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2777
				$deactivated[] = $module;
2778
			}
2779
		}
2780
2781
		if ( $deactivated && $redirect ) {
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...
2782
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2783
2784
			$url = add_query_arg(
2785
				array(
2786
					'action'   => 'activate_default_modules',
2787
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2788
				),
2789
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2790
			);
2791
			wp_safe_redirect( $url );
2792
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_default_modules() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2793
		}
2794
2795
		/**
2796
		 * Fires before default modules are activated.
2797
		 *
2798
		 * @since 1.9.0
2799
		 *
2800
		 * @param string $min_version Minimum version number required to use modules.
2801
		 * @param string $max_version Maximum version number required to use modules.
2802
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2803
		 */
2804
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2805
2806
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2807
		Jetpack::restate();
2808
		Jetpack::catch_errors( true );
2809
2810
		$active = Jetpack::get_active_modules();
2811
2812
		foreach ( $modules as $module ) {
2813
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2814
				$active[] = $module;
2815
				self::update_active_modules( $active );
2816
				continue;
2817
			}
2818
2819
			if ( $send_state_messages && in_array( $module, $active ) ) {
2820
				$module_info = Jetpack::get_module( $module );
2821 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2822
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2823
					if ( $active_state = Jetpack::state( $state ) ) {
2824
						$active_state = explode( ',', $active_state );
2825
					} else {
2826
						$active_state = array();
2827
					}
2828
					$active_state[] = $module;
2829
					Jetpack::state( $state, implode( ',', $active_state ) );
2830
				}
2831
				continue;
2832
			}
2833
2834
			$file = Jetpack::get_module_path( $module );
2835
			if ( ! file_exists( $file ) ) {
2836
				continue;
2837
			}
2838
2839
			// we'll override this later if the plugin can be included without fatal error
2840
			if ( $redirect ) {
2841
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2842
			}
2843
2844
			if ( $send_state_messages ) {
2845
				Jetpack::state( 'error', 'module_activation_failed' );
2846
				Jetpack::state( 'module', $module );
2847
			}
2848
2849
			ob_start();
2850
			require_once $file;
2851
2852
			$active[] = $module;
2853
2854 View Code Duplication
			if ( $send_state_messages ) {
2855
2856
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

Every assignment must have exactly one space before and one space after the equals operator.

To illustrate:

$a = "a";
$ab = "ab";
$abc = "abc";

will have no issues, while

$a   = "a";
$ab  = "ab";
$abc = "abc";

will report issues in lines 1 and 2.

Loading history...
2857
				if ( $active_state = Jetpack::state( $state ) ) {
2858
					$active_state = explode( ',', $active_state );
2859
				} else {
2860
					$active_state = array();
2861
				}
2862
				$active_state[] = $module;
2863
				Jetpack::state( $state, implode( ',', $active_state ) );
2864
			}
2865
2866
			Jetpack::update_active_modules( $active );
2867
2868
			ob_end_clean();
2869
		}
2870
2871
		if ( $send_state_messages ) {
2872
			Jetpack::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...
2873
			Jetpack::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...
2874
		}
2875
2876
		Jetpack::catch_errors( false );
2877
		/**
2878
		 * Fires when default modules are activated.
2879
		 *
2880
		 * @since 1.9.0
2881
		 *
2882
		 * @param string $min_version Minimum version number required to use modules.
2883
		 * @param string $max_version Maximum version number required to use modules.
2884
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2885
		 */
2886
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2887
	}
2888
2889
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2890
		/**
2891
		 * Fires before a module is activated.
2892
		 *
2893
		 * @since 2.6.0
2894
		 *
2895
		 * @param string $module Module slug.
2896
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2897
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2898
		 */
2899
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2900
2901
		$jetpack = Jetpack::init();
2902
2903
		if ( ! strlen( $module ) )
2904
			return false;
2905
2906
		if ( ! Jetpack::is_module( $module ) )
2907
			return false;
2908
2909
		// If it's already active, then don't do it again
2910
		$active = Jetpack::get_active_modules();
2911
		foreach ( $active as $act ) {
2912
			if ( $act == $module )
2913
				return true;
2914
		}
2915
2916
		$module_data = Jetpack::get_module( $module );
2917
2918
		if ( ! Jetpack::is_active() ) {
2919
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2920
				return false;
2921
2922
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2923
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2924
				return false;
2925
		}
2926
2927
		// Check and see if the old plugin is active
2928
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2929
			// Deactivate the old plugin
2930
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2931
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2932
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2933
				Jetpack::state( 'deactivated_plugins', $module );
2934
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2935
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2936
			}
2937
		}
2938
2939
		// Protect won't work with mis-configured IPs
2940
		if ( 'protect' === $module ) {
2941
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2942
			if ( ! jetpack_protect_get_ip() ) {
2943
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2944
				return false;
2945
			}
2946
		}
2947
2948
		if ( ! Jetpack::active_plan_supports( $module ) ) {
2949
			return false;
2950
		}
2951
2952
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2953
		Jetpack::state( 'module', $module );
2954
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2955
2956
		Jetpack::catch_errors( true );
2957
		ob_start();
2958
		require Jetpack::get_module_path( $module );
2959
		/** This action is documented in class.jetpack.php */
2960
		do_action( 'jetpack_activate_module', $module );
2961
		$active[] = $module;
2962
		Jetpack::update_active_modules( $active );
2963
2964
		Jetpack::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...
2965
		ob_end_clean();
2966
		Jetpack::catch_errors( false );
2967
2968
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2969 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2970
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2971
2972
			//Jump start is being dismissed send data to MC Stats
2973
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2974
2975
			$jetpack->do_stats( 'server_side' );
2976
		}
2977
2978
		if ( $redirect ) {
2979
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2980
		}
2981
		if ( $exit ) {
2982
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method activate_module() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
2983
		}
2984
		return true;
2985
	}
2986
2987
	function activate_module_actions( $module ) {
2988
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
2989
	}
2990
2991
	public static function deactivate_module( $module ) {
2992
		/**
2993
		 * Fires when a module is deactivated.
2994
		 *
2995
		 * @since 1.9.0
2996
		 *
2997
		 * @param string $module Module slug.
2998
		 */
2999
		do_action( 'jetpack_pre_deactivate_module', $module );
3000
3001
		$jetpack = Jetpack::init();
3002
3003
		$active = Jetpack::get_active_modules();
3004
		$new    = array_filter( array_diff( $active, (array) $module ) );
3005
3006
		// A flag for Jump Start so it's not shown again.
3007 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
3008
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
3009
3010
			//Jump start is being dismissed send data to MC Stats
3011
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
3012
3013
			$jetpack->do_stats( 'server_side' );
3014
		}
3015
3016
		return self::update_active_modules( $new );
3017
	}
3018
3019
	public static function enable_module_configurable( $module ) {
3020
		$module = Jetpack::get_module_slug( $module );
3021
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3022
	}
3023
3024
	public static function module_configuration_url( $module ) {
3025
		$module = Jetpack::get_module_slug( $module );
3026
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
3027
	}
3028
3029
	public static function module_configuration_load( $module, $method ) {
3030
		$module = Jetpack::get_module_slug( $module );
3031
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
3032
	}
3033
3034
	public static function module_configuration_head( $module, $method ) {
3035
		$module = Jetpack::get_module_slug( $module );
3036
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
3037
	}
3038
3039
	public static function module_configuration_screen( $module, $method ) {
3040
		$module = Jetpack::get_module_slug( $module );
3041
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
3042
	}
3043
3044
	public static function module_configuration_activation_screen( $module, $method ) {
3045
		$module = Jetpack::get_module_slug( $module );
3046
		add_action( 'display_activate_module_setting_' . $module, $method );
3047
	}
3048
3049
/* Installation */
3050
3051
	public static function bail_on_activation( $message, $deactivate = true ) {
3052
?>
3053
<!doctype html>
3054
<html>
3055
<head>
3056
<meta charset="<?php bloginfo( 'charset' ); ?>">
3057
<style>
3058
* {
3059
	text-align: center;
3060
	margin: 0;
3061
	padding: 0;
3062
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3063
}
3064
p {
3065
	margin-top: 1em;
3066
	font-size: 18px;
3067
}
3068
</style>
3069
<body>
3070
<p><?php echo esc_html( $message ); ?></p>
3071
</body>
3072
</html>
3073
<?php
3074
		if ( $deactivate ) {
3075
			$plugins = get_option( 'active_plugins' );
3076
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3077
			$update  = false;
3078
			foreach ( $plugins as $i => $plugin ) {
3079
				if ( $plugin === $jetpack ) {
3080
					$plugins[$i] = false;
3081
					$update = true;
3082
				}
3083
			}
3084
3085
			if ( $update ) {
3086
				update_option( 'active_plugins', array_filter( $plugins ) );
3087
			}
3088
		}
3089
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method bail_on_activation() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3090
	}
3091
3092
	/**
3093
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3094
	 * @static
3095
	 */
3096
	public static function plugin_activation( $network_wide ) {
3097
		Jetpack_Options::update_option( 'activated', 1 );
3098
3099
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3100
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3101
		}
3102
3103
		if ( $network_wide )
3104
			Jetpack::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...
3105
3106
		// For firing one-off events (notices) immediately after activation
3107
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3108
3109
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3110
3111
		Jetpack::plugin_initialize();
3112
	}
3113
3114
	public static function get_activation_source( $referer_url ) {
3115
3116
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3117
			return array( 'wp-cli', null );
3118
		}
3119
3120
		$referer = parse_url( $referer_url );
3121
3122
		$source_type = 'unknown';
3123
		$source_query = null;
3124
3125
		if ( ! is_array( $referer ) ) {
3126
			return array( $source_type, $source_query );
3127
		}
3128
3129
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3130
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3131
3132
		if ( isset( $referer['query'] ) ) {
3133
			parse_str( $referer['query'], $query_parts );
3134
		} else {
3135
			$query_parts = array();
3136
		}
3137
3138
		if ( $plugins_path === $referer['path'] ) {
3139
			$source_type = 'list';
3140
		} elseif ( $plugins_install_path === $referer['path'] ) {
3141
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3142
			switch( $tab ) {
3143
				case 'popular':
3144
					$source_type = 'popular';
3145
					break;
3146
				case 'recommended':
3147
					$source_type = 'recommended';
3148
					break;
3149
				case 'favorites':
3150
					$source_type = 'favorites';
3151
					break;
3152
				case 'search':
3153
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3154
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3155
					break;
3156
				default:
3157
					$source_type = 'featured';
3158
			}
3159
		}
3160
3161
		return array( $source_type, $source_query );
3162
	}
3163
3164
	/**
3165
	 * Runs before bumping version numbers up to a new version
3166
	 * @param  string $version    Version:timestamp
3167
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3168
	 * @return null              [description]
3169
	 */
3170
	public static function do_version_bump( $version, $old_version ) {
3171
3172
		if ( ! $old_version ) { // For new sites
3173
			// Setting up jetpack manage
3174
			Jetpack::activate_manage();
3175
		}
3176
	}
3177
3178
	/**
3179
	 * Sets the internal version number and activation state.
3180
	 * @static
3181
	 */
3182
	public static function plugin_initialize() {
3183
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3184
			Jetpack_Options::update_option( 'activated', 2 );
3185
		}
3186
3187 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3188
			$version = $old_version = JETPACK__VERSION . ':' . time();
3189
			/** This action is documented in class.jetpack.php */
3190
			do_action( 'updating_jetpack_version', $version, false );
3191
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3192
		}
3193
3194
		Jetpack::load_modules();
3195
3196
		Jetpack_Options::delete_option( 'do_activate' );
3197
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3198
	}
3199
3200
	/**
3201
	 * Removes all connection options
3202
	 * @static
3203
	 */
3204
	public static function plugin_deactivation( ) {
3205
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3206
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3207
			Jetpack_Network::init()->deactivate();
3208
		} else {
3209
			Jetpack::disconnect( false );
3210
			//Jetpack_Heartbeat::init()->deactivate();
3211
		}
3212
	}
3213
3214
	/**
3215
	 * Disconnects from the Jetpack servers.
3216
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3217
	 * @static
3218
	 */
3219
	public static function disconnect( $update_activated_state = true ) {
3220
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3221
		Jetpack::clean_nonces( true );
3222
3223
		// If the site is in an IDC because sync is not allowed,
3224
		// let's make sure to not disconnect the production site.
3225
		if ( ! self::validate_sync_error_idc_option() ) {
3226
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3227
			Jetpack::load_xml_rpc_client();
3228
			$xml = new Jetpack_IXR_Client();
3229
			$xml->query( 'jetpack.deregister' );
3230
		}
3231
3232
		Jetpack_Options::delete_option(
3233
			array(
3234
				'blog_token',
3235
				'user_token',
3236
				'user_tokens',
3237
				'master_user',
3238
				'time_diff',
3239
				'fallback_no_verify_ssl_certs',
3240
			)
3241
		);
3242
3243
		Jetpack_IDC::clear_all_idc_options();
3244
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3245
3246
		if ( $update_activated_state ) {
3247
			Jetpack_Options::update_option( 'activated', 4 );
3248
		}
3249
3250
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3251
			// Check then record unique disconnection if site has never been disconnected previously
3252
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3253
				$jetpack_unique_connection['disconnected'] = 1;
3254
			} else {
3255
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3256
					//track unique disconnect
3257
					$jetpack = Jetpack::init();
3258
3259
					$jetpack->stat( 'connections', 'unique-disconnect' );
3260
					$jetpack->do_stats( 'server_side' );
3261
				}
3262
				// increment number of times disconnected
3263
				$jetpack_unique_connection['disconnected'] += 1;
3264
			}
3265
3266
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3267
		}
3268
3269
		// Delete cached connected user data
3270
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3271
		delete_transient( $transient_key );
3272
3273
		// Delete all the sync related data. Since it could be taking up space.
3274
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3275
		Jetpack_Sync_Sender::get_instance()->uninstall();
3276
3277
		// Disable the Heartbeat cron
3278
		Jetpack_Heartbeat::init()->deactivate();
3279
	}
3280
3281
	/**
3282
	 * Unlinks the current user from the linked WordPress.com user
3283
	 */
3284
	public static function unlink_user( $user_id = null ) {
3285
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3286
			return false;
3287
3288
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3289
3290
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3291
			return false;
3292
3293
		if ( ! isset( $tokens[ $user_id ] ) )
3294
			return false;
3295
3296
		Jetpack::load_xml_rpc_client();
3297
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3298
		$xml->query( 'jetpack.unlink_user', $user_id );
3299
3300
		unset( $tokens[ $user_id ] );
3301
3302
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3303
3304
		/**
3305
		 * Fires after the current user has been unlinked from WordPress.com.
3306
		 *
3307
		 * @since 4.1.0
3308
		 *
3309
		 * @param int $user_id The current user's ID.
3310
		 */
3311
		do_action( 'jetpack_unlinked_user', $user_id );
3312
3313
		return true;
3314
	}
3315
3316
	/**
3317
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3318
	 */
3319
	public static function try_registration() {
3320
		// The user has agreed to the TOS at some point by now.
3321
		Jetpack_Options::update_option( 'tos_agreed', true );
3322
3323
		// Let's get some testing in beta versions and such.
3324
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3325
			// Before attempting to connect, let's make sure that the domains are viable.
3326
			$domains_to_check = array_unique( array(
3327
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3328
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3329
			) );
3330
			foreach ( $domains_to_check as $domain ) {
3331
				$result = Jetpack_Data::is_usable_domain( $domain );
3332
				if ( is_wp_error( $result ) ) {
3333
					return $result;
3334
				}
3335
			}
3336
		}
3337
3338
		$result = Jetpack::register();
3339
3340
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3341
		if ( ! $result || is_wp_error( $result ) ) {
3342
			return $result;
3343
		} else {
3344
			return true;
3345
		}
3346
	}
3347
3348
	/**
3349
	 * Tracking an internal event log. Try not to put too much chaff in here.
3350
	 *
3351
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3352
	 */
3353
	public static function log( $code, $data = null ) {
3354
		// only grab the latest 200 entries
3355
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3356
3357
		// Append our event to the log
3358
		$log_entry = array(
3359
			'time'    => time(),
3360
			'user_id' => get_current_user_id(),
3361
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3362
			'code'    => $code,
3363
		);
3364
		// Don't bother storing it unless we've got some.
3365
		if ( ! is_null( $data ) ) {
3366
			$log_entry['data'] = $data;
3367
		}
3368
		$log[] = $log_entry;
3369
3370
		// Try add_option first, to make sure it's not autoloaded.
3371
		// @todo: Add an add_option method to Jetpack_Options
0 ignored issues
show
Coding Style Best Practice introduced by
Comments for TODO tasks are often forgotten in the code; it might be better to use a dedicated issue tracker.
Loading history...
3372
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3373
			Jetpack_Options::update_option( 'log', $log );
3374
		}
3375
3376
		/**
3377
		 * Fires when Jetpack logs an internal event.
3378
		 *
3379
		 * @since 3.0.0
3380
		 *
3381
		 * @param array $log_entry {
3382
		 *	Array of details about the log entry.
3383
		 *
3384
		 *	@param string time Time of the event.
3385
		 *	@param int user_id ID of the user who trigerred the event.
3386
		 *	@param int blog_id Jetpack Blog ID.
3387
		 *	@param string code Unique name for the event.
3388
		 *	@param string data Data about the event.
3389
		 * }
3390
		 */
3391
		do_action( 'jetpack_log_entry', $log_entry );
3392
	}
3393
3394
	/**
3395
	 * Get the internal event log.
3396
	 *
3397
	 * @param $event (string) - only return the specific log events
3398
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3399
	 *
3400
	 * @return array of log events || WP_Error for invalid params
3401
	 */
3402
	public static function get_log( $event = false, $num = false ) {
3403
		if ( $event && ! is_string( $event ) ) {
3404
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3405
		}
3406
3407
		if ( $num && ! is_numeric( $num ) ) {
3408
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3409
		}
3410
3411
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3412
3413
		// If nothing set - act as it did before, otherwise let's start customizing the output
3414
		if ( ! $num && ! $event ) {
3415
			return $entire_log;
3416
		} else {
3417
			$entire_log = array_reverse( $entire_log );
3418
		}
3419
3420
		$custom_log_output = array();
3421
3422
		if ( $event ) {
3423
			foreach ( $entire_log as $log_event ) {
3424
				if ( $event == $log_event[ 'code' ] ) {
3425
					$custom_log_output[] = $log_event;
3426
				}
3427
			}
3428
		} else {
3429
			$custom_log_output = $entire_log;
3430
		}
3431
3432
		if ( $num ) {
3433
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3434
		}
3435
3436
		return $custom_log_output;
3437
	}
3438
3439
	/**
3440
	 * Log modification of important settings.
3441
	 */
3442
	public static function log_settings_change( $option, $old_value, $value ) {
3443
		switch( $option ) {
3444
			case 'jetpack_sync_non_public_post_stati':
3445
				self::log( $option, $value );
3446
				break;
3447
		}
3448
	}
3449
3450
	/**
3451
	 * Return stat data for WPCOM sync
3452
	 */
3453
	public static function get_stat_data( $encode = true, $extended = true ) {
3454
		$data = Jetpack_Heartbeat::generate_stats_array();
3455
3456
		if ( $extended ) {
3457
			$additional_data = self::get_additional_stat_data();
3458
			$data = array_merge( $data, $additional_data );
3459
		}
3460
3461
		if ( $encode ) {
3462
			return json_encode( $data );
3463
		}
3464
3465
		return $data;
3466
	}
3467
3468
	/**
3469
	 * Get additional stat data to sync to WPCOM
3470
	 */
3471
	public static function get_additional_stat_data( $prefix = '' ) {
3472
		$return["{$prefix}themes"]         = Jetpack::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...
3473
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3474
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3475
		$return["{$prefix}site-count"]     = 0;
3476
3477
		if ( function_exists( 'get_blog_count' ) ) {
3478
			$return["{$prefix}site-count"] = get_blog_count();
3479
		}
3480
		return $return;
3481
	}
3482
3483
	private static function get_site_user_count() {
3484
		global $wpdb;
3485
3486
		if ( function_exists( 'wp_is_large_network' ) ) {
3487
			if ( wp_is_large_network( 'users' ) ) {
3488
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3489
			}
3490
		}
3491 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3492
			// It wasn't there, so regenerate the data and save the transient
3493
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3494
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3495
		}
3496
		return $user_count;
3497
	}
3498
3499
	/* Admin Pages */
3500
3501
	function admin_init() {
3502
		// If the plugin is not connected, display a connect message.
3503
		if (
3504
			// the plugin was auto-activated and needs its candy
3505
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3506
		||
3507
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3508
			! Jetpack_Options::get_option( 'activated' )
3509
		) {
3510
			Jetpack::plugin_initialize();
3511
		}
3512
3513
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3514
			Jetpack_Connection_Banner::init();
3515
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3516
			// Upgrade: 1.1 -> 1.1.1
3517
			// Check and see if host can verify the Jetpack servers' SSL certificate
3518
			$args = array();
3519
			Jetpack_Client::_wp_remote_request(
3520
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3521
				$args,
3522
				true
3523
			);
3524
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3525
			// Show the notice on the Dashboard only for now
3526
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3527
		}
3528
3529
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3530
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3531
		}
3532
3533
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3534
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3535
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3536
3537
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3538
			// Artificially throw errors in certain whitelisted cases during plugin activation
3539
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3540
		}
3541
3542
		// Jetpack Manage Activation Screen from .com
3543
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3544
3545
		// Add custom column in wp-admin/users.php to show whether user is linked.
3546
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3547
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3548
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3549
	}
3550
3551
	function admin_body_class( $admin_body_class = '' ) {
3552
		$classes = explode( ' ', trim( $admin_body_class ) );
3553
3554
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3555
3556
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3557
		return " $admin_body_class ";
3558
	}
3559
3560
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3561
		return $admin_body_class . ' jetpack-pagestyles ';
3562
	}
3563
3564
	/**
3565
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3566
	 *
3567
	 * @return null
3568
	 */
3569
	function prepare_manage_jetpack_notice() {
3570
3571
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3572
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3573
	}
3574
3575
	function manage_activate_screen() {
3576
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3577
	}
3578
	/**
3579
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3580
	 * This function artificially throws errors for such cases (whitelisted).
3581
	 *
3582
	 * @param string $plugin The activated plugin.
3583
	 */
3584
	function throw_error_on_activate_plugin( $plugin ) {
3585
		$active_modules = Jetpack::get_active_modules();
3586
3587
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3588
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3589
			$throw = false;
3590
3591
			// Try and make sure it really was the stats plugin
3592
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3593
				if ( 'stats.php' == basename( $plugin ) ) {
3594
					$throw = true;
3595
				}
3596
			} else {
3597
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3598
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3599
					$throw = true;
3600
				}
3601
			}
3602
3603
			if ( $throw ) {
3604
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3605
			}
3606
		}
3607
	}
3608
3609
	function intercept_plugin_error_scrape_init() {
3610
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3611
	}
3612
3613
	function intercept_plugin_error_scrape( $action, $result ) {
3614
		if ( ! $result ) {
3615
			return;
3616
		}
3617
3618
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3619
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3620
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3621
			}
3622
		}
3623
	}
3624
3625
	function add_remote_request_handlers() {
3626
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3627
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3628
	}
3629
3630
	function remote_request_handlers() {
3631
		$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...
3632
3633
		switch ( current_filter() ) {
3634
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3635
			$response = $this->upload_handler();
3636
			break;
3637
3638
		case 'wp_ajax_nopriv_jetpack_update_file' :
3639
			$response = $this->upload_handler( true );
3640
			break;
3641
		default :
0 ignored issues
show
Coding Style introduced by
There must be no space before the colon in a DEFAULT statement

As per the PSR-2 coding standard, there must not be a space in front of the colon in the default statement.

switch ($expr) {
    default : //wrong
        doSomething();
        break;
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
3642
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3643
			break;
3644
		}
3645
3646
		if ( ! $response ) {
3647
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3648
		}
3649
3650
		if ( is_wp_error( $response ) ) {
3651
			$status_code       = $response->get_error_data();
3652
			$error             = $response->get_error_code();
3653
			$error_description = $response->get_error_message();
3654
3655
			if ( ! is_int( $status_code ) ) {
3656
				$status_code = 400;
3657
			}
3658
3659
			status_header( $status_code );
3660
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3661
		}
3662
3663
		status_header( 200 );
3664
		if ( true === $response ) {
3665
			exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3666
		}
3667
3668
		die( json_encode( (object) $response ) );
0 ignored issues
show
Coding Style Compatibility introduced by
The method remote_request_handlers() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
3669
	}
3670
3671
	/**
3672
	 * Uploads a file gotten from the global $_FILES.
3673
	 * If `$update_media_item` is true and `post_id` is defined
3674
	 * the attachment file of the media item (gotten through of the post_id)
3675
	 * will be updated instead of add a new one.
3676
	 *
3677
	 * @param  boolean $update_media_item - update media attachment
3678
	 * @return array - An array describing the uploadind files process
3679
	 */
3680
	function upload_handler( $update_media_item = false ) {
3681
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3682
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3683
		}
3684
3685
		$user = wp_authenticate( '', '' );
3686
		if ( ! $user || is_wp_error( $user ) ) {
3687
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3688
		}
3689
3690
		wp_set_current_user( $user->ID );
3691
3692
		if ( ! current_user_can( 'upload_files' ) ) {
3693
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3694
		}
3695
3696
		if ( empty( $_FILES ) ) {
3697
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3698
		}
3699
3700
		foreach ( array_keys( $_FILES ) as $files_key ) {
3701
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3702
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3703
			}
3704
		}
3705
3706
		$media_keys = array_keys( $_FILES['media'] );
3707
3708
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3709
		if ( ! $token || is_wp_error( $token ) ) {
3710
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3711
		}
3712
3713
		$uploaded_files = array();
3714
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3715
		unset( $GLOBALS['post'] );
3716
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3717
			$file = array();
3718
			foreach ( $media_keys as $media_key ) {
3719
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3720
			}
3721
3722
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3723
3724
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3725
			if ( $hmac_provided !== $hmac_file ) {
3726
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3727
				continue;
3728
			}
3729
3730
			$_FILES['.jetpack.upload.'] = $file;
3731
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3732
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3733
				$post_id = 0;
3734
			}
3735
3736
			if ( $update_media_item ) {
3737
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3738
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3739
				}
3740
3741
				$media_array = $_FILES['media'];
3742
3743
				$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...
3744
				$file_array['type'] = $media_array['type'][0];
3745
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3746
				$file_array['error'] = $media_array['error'][0];
3747
				$file_array['size'] = $media_array['size'][0];
3748
3749
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3750
3751
				if ( is_wp_error( $edited_media_item ) ) {
3752
					return $edited_media_item;
3753
				}
3754
3755
				$response = (object) array(
3756
					'id'   => (string) $post_id,
3757
					'file' => (string) $edited_media_item->post_title,
3758
					'url'  => (string) wp_get_attachment_url( $post_id ),
3759
					'type' => (string) $edited_media_item->post_mime_type,
3760
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3761
				);
3762
3763
				return (array) array( $response );
3764
			}
3765
3766
			$attachment_id = media_handle_upload(
3767
				'.jetpack.upload.',
3768
				$post_id,
3769
				array(),
3770
				array(
3771
					'action' => 'jetpack_upload_file',
3772
				)
3773
			);
3774
3775
			if ( ! $attachment_id ) {
3776
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3777
			} elseif ( is_wp_error( $attachment_id ) ) {
3778
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3779
			} else {
3780
				$attachment = get_post( $attachment_id );
3781
				$uploaded_files[$index] = (object) array(
3782
					'id'   => (string) $attachment_id,
3783
					'file' => $attachment->post_title,
3784
					'url'  => wp_get_attachment_url( $attachment_id ),
3785
					'type' => $attachment->post_mime_type,
3786
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3787
				);
3788
				// Zip files uploads are not supported unless they are done for installation purposed
3789
				// lets delete them in case something goes wrong in this whole process
3790
				if ( 'application/zip' === $attachment->post_mime_type ) {
3791
					// Schedule a cleanup for 2 hours from now in case of failed install.
3792
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3793
				}
3794
			}
3795
		}
3796
		if ( ! is_null( $global_post ) ) {
3797
			$GLOBALS['post'] = $global_post;
3798
		}
3799
3800
		return $uploaded_files;
3801
	}
3802
3803
	/**
3804
	 * Add help to the Jetpack page
3805
	 *
3806
	 * @since Jetpack (1.2.3)
3807
	 * @return false if not the Jetpack page
3808
	 */
3809
	function admin_help() {
3810
		$current_screen = get_current_screen();
3811
3812
		// Overview
3813
		$current_screen->add_help_tab(
3814
			array(
3815
				'id'		=> 'home',
3816
				'title'		=> __( 'Home', 'jetpack' ),
3817
				'content'	=>
3818
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3819
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3820
					'<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>',
3821
			)
3822
		);
3823
3824
		// Screen Content
3825
		if ( current_user_can( 'manage_options' ) ) {
3826
			$current_screen->add_help_tab(
3827
				array(
3828
					'id'		=> 'settings',
3829
					'title'		=> __( 'Settings', 'jetpack' ),
3830
					'content'	=>
3831
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3832
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3833
						'<ol>' .
3834
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3835
							'<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>' .
3836
						'</ol>' .
3837
						'<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>'
3838
				)
3839
			);
3840
		}
3841
3842
		// Help Sidebar
3843
		$current_screen->set_help_sidebar(
3844
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3845
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3846
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3847
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3848
		);
3849
	}
3850
3851
	function admin_menu_css() {
3852
		wp_enqueue_style( 'jetpack-icons' );
3853
	}
3854
3855
	function admin_menu_order() {
3856
		return true;
3857
	}
3858
3859
	function enqueue_gutenberg_locale() {
3860
		wp_add_inline_script(
3861
			'wp-i18n',
3862
			'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
3863
		);
3864
	}
3865
3866 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3867
		$jp_menu_order = array();
3868
3869
		foreach ( $menu_order as $index => $item ) {
3870
			if ( $item != 'jetpack' ) {
3871
				$jp_menu_order[] = $item;
3872
			}
3873
3874
			if ( $index == 0 ) {
3875
				$jp_menu_order[] = 'jetpack';
3876
			}
3877
		}
3878
3879
		return $jp_menu_order;
3880
	}
3881
3882
	function admin_head() {
3883 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3884
			/** This action is documented in class.jetpack-admin-page.php */
3885
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3886
	}
3887
3888
	function admin_banner_styles() {
3889
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3890
3891
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3892
			wp_register_style(
3893
				'jetpack-dops-style',
3894
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3895
				array(),
3896
				JETPACK__VERSION
3897
			);
3898
		}
3899
3900
		wp_enqueue_style(
3901
			'jetpack',
3902
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3903
			array( 'jetpack-dops-style' ),
3904
			 JETPACK__VERSION . '-20121016'
3905
		);
3906
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3907
		wp_style_add_data( 'jetpack', 'suffix', $min );
3908
	}
3909
3910
	function plugin_action_links( $actions ) {
3911
3912
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3913
3914
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3915
			return array_merge(
3916
				$jetpack_home,
3917
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3918
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3919
				$actions
3920
				);
3921
			}
3922
3923
		return array_merge( $jetpack_home, $actions );
3924
	}
3925
3926
	/**
3927
	 * This is the first banner
3928
	 * It should be visible only to user that can update the option
3929
	 * Are not connected
3930
	 *
3931
	 * @return null
3932
	 */
3933
	function admin_jetpack_manage_notice() {
3934
		$screen = get_current_screen();
3935
3936
		// Don't show the connect notice on the jetpack settings page.
3937
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3938
			return;
3939
		}
3940
3941
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3942
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3943
		/**
3944
		 * I think it would be great to have different wordsing depending on where you are
3945
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3946
		 * etc..
3947
		 */
3948
3949
		?>
3950
		<div id="message" class="updated jp-banner">
3951
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3952
				<div class="jp-banner__description-container">
3953
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3954
					<p class="jp-banner__description"><?php printf( __( 'Manage multiple Jetpack enabled sites from one single dashboard at wordpress.com. Allows all existing, connected Administrators to modify your site.', 'jetpack' ), 'https://jetpack.com/support/site-management' ); ?></p>
3955
					<p class="jp-banner__button-container">
3956
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3957
						<a href="https://jetpack.com/support/site-management" class="button" target="_blank" title="<?php esc_attr_e( 'Learn more about Jetpack Manage on Jetpack.com', 'jetpack' ); ?>"><?php _e( 'Learn more', 'jetpack' ); ?></a>
3958
					</p>
3959
				</div>
3960
		</div>
3961
		<?php
3962
	}
3963
3964
	/**
3965
	 * Returns the url that the user clicks to remove the notice for the big banner
3966
	 * @return string
3967
	 */
3968
	function opt_out_jetpack_manage_url() {
3969
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3970
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3971
	}
3972
	/**
3973
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3974
	 * @return string
3975
	 */
3976
	function opt_in_jetpack_manage_url() {
3977
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3978
	}
3979
3980
	function opt_in_jetpack_manage_notice() {
3981
		?>
3982
		<div class="wrap">
3983
			<div id="message" class="jetpack-message is-opt-in">
3984
				<?php echo sprintf( __( '<p><a href="%1$s" title="Opt in to WordPress.com Site Management" >Activate Site Management</a> to manage multiple sites from our centralized dashboard at wordpress.com/sites. <a href="%2$s" target="_blank">Learn more</a>.</p><a href="%1$s" class="jp-button">Activate Now</a>', 'jetpack' ), $this->opt_in_jetpack_manage_url(), 'https://jetpack.com/support/site-management' ); ?>
3985
			</div>
3986
		</div>
3987
		<?php
3988
3989
	}
3990
	/**
3991
	 * Determines whether to show the notice of not true = display notice
3992
	 * @return bool
3993
	 */
3994
	function can_display_jetpack_manage_notice() {
3995
		// never display the notice to users that can't do anything about it anyways
3996
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3997
			return false;
3998
3999
		// don't display if we are in development more
4000
		if( Jetpack::is_development_mode() ) {
4001
			return false;
4002
		}
4003
		// don't display if the site is private
4004
		if(  ! Jetpack_Options::get_option( 'public' ) )
4005
			return false;
4006
4007
		/**
4008
		 * Should the Jetpack Remote Site Management notice be displayed.
4009
		 *
4010
		 * @since 3.3.0
4011
		 *
4012
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
4013
		 */
4014
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
4015
	}
4016
4017
	/*
4018
	 * Registration flow:
4019
	 * 1 - ::admin_page_load() action=register
4020
	 * 2 - ::try_registration()
4021
	 * 3 - ::register()
4022
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4023
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4024
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4025
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4026
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4027
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4028
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4029
	 *       jetpack_id, jetpack_secret, jetpack_public
4030
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4031
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4032
	 * 5 - user logs in with WP.com account
4033
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4034
	 *		- Jetpack_Client_Server::authorize()
4035
	 *		- Jetpack_Client_Server::get_token()
4036
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4037
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4038
	 *			- which responds with access_token, token_type, scope
4039
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
4040
	 *		- Jetpack::activate_default_modules()
4041
	 *     		- Deactivates deprecated plugins
4042
	 *     		- Activates all default modules
4043
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4044
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4045
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4046
	 *     Done!
4047
	 */
4048
4049
	/**
4050
	 * Handles the page load events for the Jetpack admin page
4051
	 */
4052
	function admin_page_load() {
4053
		$error = false;
4054
4055
		// Make sure we have the right body class to hook stylings for subpages off of.
4056
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
4057
4058
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4059
			// Should only be used in intermediate redirects to preserve state across redirects
4060
			Jetpack::restate();
4061
		}
4062
4063
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4064
			// User clicked in the iframe to link their accounts
4065
			if ( ! Jetpack::is_user_connected() ) {
4066
				$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4067
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4068
4069
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4070
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4071
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4072
4073
				if ( isset( $_GET['notes_iframe'] ) )
4074
					$connect_url .= '&notes_iframe';
4075
				wp_redirect( $connect_url );
4076
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4077
			} else {
4078
				if ( ! isset( $_GET['calypso_env'] ) ) {
4079
					Jetpack::state( 'message', 'already_authorized' );
4080
					wp_safe_redirect( Jetpack::admin_url() );
4081
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4082
				} else {
4083
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
4084
					$connect_url .= '&already_authorized=true';
4085
					wp_redirect( $connect_url );
4086
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4087
				}
4088
			}
4089
		}
4090
4091
4092
		if ( isset( $_GET['action'] ) ) {
4093
			switch ( $_GET['action'] ) {
4094
			case 'authorize':
4095
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
4096
					Jetpack::state( 'message', 'already_authorized' );
4097
					wp_safe_redirect( Jetpack::admin_url() );
4098
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4099
				}
4100
				Jetpack::log( 'authorize' );
4101
				$client_server = new Jetpack_Client_Server;
4102
				$client_server->client_authorize();
4103
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4104
			case 'register' :
4105
				if ( ! current_user_can( 'jetpack_connect' ) ) {
4106
					$error = 'cheatin';
4107
					break;
4108
				}
4109
				check_admin_referer( 'jetpack-register' );
4110
				Jetpack::log( 'register' );
4111
				Jetpack::maybe_set_version_option();
4112
				$registered = Jetpack::try_registration();
4113
				if ( is_wp_error( $registered ) ) {
4114
					$error = $registered->get_error_code();
4115
					Jetpack::state( 'error', $error );
4116
					Jetpack::state( 'error', $registered->get_error_message() );
4117
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
4118
						'error_code' => $error,
4119
						'error_message' => $registered->get_error_message()
4120
					) );
4121
					break;
4122
				}
4123
4124
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
4125
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4126
4127
				JetpackTracking::record_user_event( 'jpc_register_success', array(
4128
					'from' => $from
4129
				) );
4130
4131
				$url = $this->build_connect_url( true, $redirect, $from );
4132
4133
				if ( ! empty( $_GET['onboarding'] ) ) {
4134
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4135
				}
4136
4137
				if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4138
					$url = add_query_arg( 'auth_approved', 'true', $url );
4139
				}
4140
4141
				wp_redirect( $url );
4142
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4143
			case 'activate' :
4144
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4145
					$error = 'cheatin';
4146
					break;
4147
				}
4148
4149
				$module = stripslashes( $_GET['module'] );
4150
				check_admin_referer( "jetpack_activate-$module" );
4151
				Jetpack::log( 'activate', $module );
4152
				if ( ! Jetpack::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Jetpack::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...
4153
					Jetpack::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4154
				}
4155
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4156
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4157
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4158
			case 'activate_default_modules' :
4159
				check_admin_referer( 'activate_default_modules' );
4160
				Jetpack::log( 'activate_default_modules' );
4161
				Jetpack::restate();
4162
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4163
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4164
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4165
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4166
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4167
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4168
			case 'disconnect' :
4169
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4170
					$error = 'cheatin';
4171
					break;
4172
				}
4173
4174
				check_admin_referer( 'jetpack-disconnect' );
4175
				Jetpack::log( 'disconnect' );
4176
				Jetpack::disconnect();
4177
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4178
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4179
			case 'reconnect' :
4180
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4181
					$error = 'cheatin';
4182
					break;
4183
				}
4184
4185
				check_admin_referer( 'jetpack-reconnect' );
4186
				Jetpack::log( 'reconnect' );
4187
				$this->disconnect();
4188
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4189
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4190 View Code Duplication
			case 'deactivate' :
4191
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4192
					$error = 'cheatin';
4193
					break;
4194
				}
4195
4196
				$modules = stripslashes( $_GET['module'] );
4197
				check_admin_referer( "jetpack_deactivate-$modules" );
4198
				foreach ( explode( ',', $modules ) as $module ) {
4199
					Jetpack::log( 'deactivate', $module );
4200
					Jetpack::deactivate_module( $module );
4201
					Jetpack::state( 'message', 'module_deactivated' );
4202
				}
4203
				Jetpack::state( 'module', $modules );
4204
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4205
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4206
			case 'unlink' :
4207
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4208
				check_admin_referer( 'jetpack-unlink' );
4209
				Jetpack::log( 'unlink' );
4210
				$this->unlink_user();
4211
				Jetpack::state( 'message', 'unlinked' );
4212
				if ( 'sub-unlink' == $redirect ) {
4213
					wp_safe_redirect( admin_url() );
4214
				} else {
4215
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4216
				}
4217
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4218
			case 'onboard' :
4219
				if ( ! current_user_can( 'manage_options' ) ) {
4220
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4221
				} else {
4222
					Jetpack::create_onboarding_token();
4223
					$url = $this->build_connect_url( true );
4224
4225
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4226
						$url = add_query_arg( 'onboarding', $token, $url );
4227
					}
4228
4229
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4230
					if ( $calypso_env ) {
4231
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4232
					}
4233
4234
					wp_redirect( $url );
4235
					exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4236
				}
4237
				exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method admin_page_load() contains an exit expression.

An exit expression should only be used in rare cases. For example, if you write a short command line script.

In most cases however, using an exit expression makes the code untestable and often causes incompatibilities with other libraries. Thus, unless you are absolutely sure it is required here, we recommend to refactor your code to avoid its usage.

Loading history...
4238
			default:
4239
				/**
4240
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4241
				 *
4242
				 * @since 2.6.0
4243
				 *
4244
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4245
				 */
4246
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4247
			}
4248
		}
4249
4250
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4251
			self::activate_new_modules( true );
4252
		}
4253
4254
		$message_code = Jetpack::state( 'message' );
4255
		if ( Jetpack::state( 'optin-manage' ) ) {
4256
			$activated_manage = $message_code;
4257
			$message_code = 'jetpack-manage';
4258
		}
4259
4260
		switch ( $message_code ) {
4261
		case 'jetpack-manage':
4262
			$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>';
4263
			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...
4264
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4265
			}
4266
			break;
4267
4268
		}
4269
4270
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4271
4272
		if ( ! empty( $deactivated_plugins ) ) {
4273
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4274
			$deactivated_titles  = array();
4275
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4276
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4277
					continue;
4278
				}
4279
4280
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4281
			}
4282
4283
			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...
4284
				if ( $this->message ) {
4285
					$this->message .= "<br /><br />\n";
4286
				}
4287
4288
				$this->message .= wp_sprintf(
4289
					_n(
4290
						'Jetpack contains the most recent version of the old %l plugin.',
4291
						'Jetpack contains the most recent versions of the old %l plugins.',
4292
						count( $deactivated_titles ),
4293
						'jetpack'
4294
					),
4295
					$deactivated_titles
4296
				);
4297
4298
				$this->message .= "<br />\n";
4299
4300
				$this->message .= _n(
4301
					'The old version has been deactivated and can be removed from your site.',
4302
					'The old versions have been deactivated and can be removed from your site.',
4303
					count( $deactivated_titles ),
4304
					'jetpack'
4305
				);
4306
			}
4307
		}
4308
4309
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4310
4311
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4312
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4313
		}
4314
4315 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4316
			/**
4317
			 * Fires when a module configuration page is loaded.
4318
			 * The dynamic part of the hook is the configure parameter from the URL.
4319
			 *
4320
			 * @since 1.1.0
4321
			 */
4322
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4323
		}
4324
4325
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4326
	}
4327
4328
	function admin_notices() {
4329
4330
		if ( $this->error ) {
4331
?>
4332
<div id="message" class="jetpack-message jetpack-err">
4333
	<div class="squeezer">
4334
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4335
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4336
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4337
<?php	endif; ?>
4338
	</div>
4339
</div>
4340
<?php
4341
		}
4342
4343
		if ( $this->message ) {
4344
?>
4345
<div id="message" class="jetpack-message">
4346
	<div class="squeezer">
4347
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4348
	</div>
4349
</div>
4350
<?php
4351
		}
4352
4353
		if ( $this->privacy_checks ) :
4354
			$module_names = $module_slugs = array();
4355
4356
			$privacy_checks = explode( ',', $this->privacy_checks );
4357
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4358
			foreach ( $privacy_checks as $module_slug ) {
4359
				$module = Jetpack::get_module( $module_slug );
4360
				if ( ! $module ) {
4361
					continue;
4362
				}
4363
4364
				$module_slugs[] = $module_slug;
4365
				$module_names[] = "<strong>{$module['name']}</strong>";
4366
			}
4367
4368
			$module_slugs = join( ',', $module_slugs );
4369
?>
4370
<div id="message" class="jetpack-message jetpack-err">
4371
	<div class="squeezer">
4372
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4373
		<p><?php
4374
			echo wp_kses(
4375
				wptexturize(
4376
					wp_sprintf(
4377
						_nx(
4378
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4379
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4380
							count( $privacy_checks ),
4381
							'%l = list of Jetpack module/feature names',
4382
							'jetpack'
4383
						),
4384
						$module_names
4385
					)
4386
				),
4387
				array( 'strong' => true )
4388
			);
4389
4390
			echo "\n<br />\n";
4391
4392
			echo wp_kses(
4393
				sprintf(
4394
					_nx(
4395
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4396
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4397
						count( $privacy_checks ),
4398
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4399
						'jetpack'
4400
					),
4401
					wp_nonce_url(
4402
						Jetpack::admin_url(
4403
							array(
4404
								'page'   => 'jetpack',
4405
								'action' => 'deactivate',
4406
								'module' => urlencode( $module_slugs ),
4407
							)
4408
						),
4409
						"jetpack_deactivate-$module_slugs"
4410
					),
4411
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4412
				),
4413
				array( 'a' => array( 'href' => true, 'title' => true ) )
4414
			);
4415
		?></p>
4416
	</div>
4417
</div>
4418
<?php endif;
4419
	// only display the notice if the other stuff is not there
4420
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4421
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4422
			$this->opt_in_jetpack_manage_notice();
4423
		}
4424
	}
4425
4426
	/**
4427
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4428
	 */
4429
	function stat( $group, $detail ) {
4430
		if ( ! isset( $this->stats[ $group ] ) )
4431
			$this->stats[ $group ] = array();
4432
		$this->stats[ $group ][] = $detail;
4433
	}
4434
4435
	/**
4436
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4437
	 */
4438
	function do_stats( $method = '' ) {
4439
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4440
			foreach ( $this->stats as $group => $stats ) {
4441
				if ( is_array( $stats ) && count( $stats ) ) {
4442
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4443
					if ( 'server_side' === $method ) {
4444
						self::do_server_side_stat( $args );
4445
					} else {
4446
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4447
					}
4448
				}
4449
				unset( $this->stats[ $group ] );
4450
			}
4451
		}
4452
	}
4453
4454
	/**
4455
	 * Runs stats code for a one-off, server-side.
4456
	 *
4457
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4458
	 *
4459
	 * @return bool If it worked.
4460
	 */
4461
	static function do_server_side_stat( $args ) {
4462
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4463
		if ( is_wp_error( $response ) )
4464
			return false;
4465
4466
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4467
			return false;
4468
4469
		return true;
4470
	}
4471
4472
	/**
4473
	 * Builds the stats url.
4474
	 *
4475
	 * @param $args array|string The arguments to append to the URL.
4476
	 *
4477
	 * @return string The URL to be pinged.
4478
	 */
4479
	static function build_stats_url( $args ) {
4480
		$defaults = array(
4481
			'v'    => 'wpcom2',
4482
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4483
		);
4484
		$args     = wp_parse_args( $args, $defaults );
4485
		/**
4486
		 * Filter the URL used as the Stats tracking pixel.
4487
		 *
4488
		 * @since 2.3.2
4489
		 *
4490
		 * @param string $url Base URL used as the Stats tracking pixel.
4491
		 */
4492
		$base_url = apply_filters(
4493
			'jetpack_stats_base_url',
4494
			'https://pixel.wp.com/g.gif'
4495
		);
4496
		$url      = add_query_arg( $args, $base_url );
4497
		return $url;
4498
	}
4499
4500
	static function translate_current_user_to_role() {
4501
		foreach ( self::$capability_translations as $role => $cap ) {
4502
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4503
				return $role;
4504
			}
4505
		}
4506
4507
		return false;
4508
	}
4509
4510
	static function translate_user_to_role( $user ) {
4511
		foreach ( self::$capability_translations as $role => $cap ) {
4512
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4513
				return $role;
4514
			}
4515
		}
4516
4517
		return false;
4518
    }
4519
4520
	static function translate_role_to_cap( $role ) {
4521
		if ( ! isset( self::$capability_translations[$role] ) ) {
4522
			return false;
4523
		}
4524
4525
		return self::$capability_translations[$role];
4526
	}
4527
4528
	static function sign_role( $role, $user_id = null ) {
4529
		if ( empty( $user_id ) ) {
4530
			$user_id = (int) get_current_user_id();
4531
		}
4532
4533
		if ( ! $user_id  ) {
4534
			return false;
4535
		}
4536
4537
		$token = Jetpack_Data::get_access_token();
4538
		if ( ! $token || is_wp_error( $token ) ) {
4539
			return false;
4540
		}
4541
4542
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4543
	}
4544
4545
4546
	/**
4547
	 * Builds a URL to the Jetpack connection auth page
4548
	 *
4549
	 * @since 3.9.5
4550
	 *
4551
	 * @param bool $raw If true, URL will not be escaped.
4552
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4553
	 *                              If string, will be a custom redirect.
4554
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4555
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4556
	 *
4557
	 * @return string Connect URL
4558
	 */
4559
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4560
		$site_id = Jetpack_Options::get_option( 'id' );
4561
		$token = Jetpack_Options::get_option( 'blog_token' );
4562
4563
		if ( $register || ! $token || ! $site_id ) {
4564
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4565
4566
			if ( ! empty( $redirect ) ) {
4567
				$url = add_query_arg(
4568
					'redirect',
4569
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4570
					$url
4571
				);
4572
			}
4573
4574
			if( is_network_admin() ) {
4575
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4576
			}
4577
		} else {
4578
4579
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4580
			// because otherwise this logic can get us in to a loop.
4581
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4582
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4583
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4584
4585
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4586
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4587
					'1.1'
4588
				);
4589
4590
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4591
					// Generating a register URL instead to refresh the existing token
4592
					return $this->build_connect_url( $raw, $redirect, $from, true );
4593
				}
4594
			}
4595
4596
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4597
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4598
			}
4599
4600
			$role = self::translate_current_user_to_role();
4601
			$signed_role = self::sign_role( $role );
4602
4603
			$user = wp_get_current_user();
4604
4605
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4606
			$redirect = $redirect
4607
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4608
				: $jetpack_admin_page;
4609
4610
			if( isset( $_REQUEST['is_multisite'] ) ) {
4611
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4612
			}
4613
4614
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4615
4616
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4617
				? get_site_icon_url()
4618
				: false;
4619
4620
			/**
4621
			 * Filter the type of authorization.
4622
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4623
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4624
			 *
4625
			 * @since 4.3.3
4626
			 *
4627
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4628
			 */
4629
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4630
4631
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4632
4633
			$args = urlencode_deep(
4634
				array(
4635
					'response_type' => 'code',
4636
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4637
					'redirect_uri'  => add_query_arg(
4638
						array(
4639
							'action'   => 'authorize',
4640
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4641
							'redirect' => urlencode( $redirect ),
4642
						),
4643
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4644
					),
4645
					'state'         => $user->ID,
4646
					'scope'         => $signed_role,
4647
					'user_email'    => $user->user_email,
4648
					'user_login'    => $user->user_login,
4649
					'is_active'     => Jetpack::is_active(),
4650
					'jp_version'    => JETPACK__VERSION,
4651
					'auth_type'     => $auth_type,
4652
					'secret'        => $secrets['secret_1'],
4653
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4654
					'blogname'      => get_option( 'blogname' ),
4655
					'site_url'      => site_url(),
4656
					'home_url'      => home_url(),
4657
					'site_icon'     => $site_icon,
4658
					'site_lang'     => get_locale(),
4659
					'_ui'           => $tracks_identity['_ui'],
4660
					'_ut'           => $tracks_identity['_ut']
4661
				)
4662
			);
4663
4664
			self::apply_activation_source_to_args( $args );
4665
4666
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4667
		}
4668
4669
		if ( $from ) {
4670
			$url = add_query_arg( 'from', $from, $url );
4671
		}
4672
4673
4674
		if ( isset( $_GET['calypso_env'] ) ) {
4675
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4676
		}
4677
4678
		return $raw ? $url : esc_url( $url );
4679
	}
4680
4681
	public static function apply_activation_source_to_args( &$args ) {
4682
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4683
4684
		if ( $activation_source_name ) {
4685
			$args['_as'] = urlencode( $activation_source_name );
4686
		}
4687
4688
		if ( $activation_source_keyword ) {
4689
			$args['_ak'] = urlencode( $activation_source_keyword );
4690
		}
4691
	}
4692
4693
	function build_reconnect_url( $raw = false ) {
4694
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4695
		return $raw ? $url : esc_url( $url );
4696
	}
4697
4698
	public static function admin_url( $args = null ) {
4699
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4700
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4701
		return $url;
4702
	}
4703
4704
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4705
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4706
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4707
	}
4708
4709
	function dismiss_jetpack_notice() {
4710
4711
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4712
			return;
4713
		}
4714
4715
		switch( $_GET['jetpack-notice'] ) {
4716
			case 'dismiss':
4717
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4718
4719
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4720
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4721
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4722
				}
4723
				break;
4724 View Code Duplication
			case 'jetpack-manage-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4725
4726
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4727
					// Don't show the banner again
4728
4729
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4730
					// redirect back to the page that had the notice
4731
					if ( wp_get_referer() ) {
4732
						wp_safe_redirect( wp_get_referer() );
4733
					} else {
4734
						// Take me to Jetpack
4735
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4736
					}
4737
				}
4738
				break;
4739 View Code Duplication
			case 'jetpack-protect-multisite-opt-out':
0 ignored issues
show
Coding Style introduced by
The case body in a switch statement must start on the line following the statement.

According to the PSR-2, the body of a case statement must start on the line immediately following the case statement.

switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

}

To learn more about the PSR-2 coding standard, please refer to the PHP-Fig.

Loading history...
4740
4741
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4742
					// Don't show the banner again
4743
4744
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4745
					// redirect back to the page that had the notice
4746
					if ( wp_get_referer() ) {
4747
						wp_safe_redirect( wp_get_referer() );
4748
					} else {
4749
						// Take me to Jetpack
4750
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4751
					}
4752
				}
4753
				break;
4754
			case 'jetpack-manage-opt-in':
4755
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4756
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4757
4758
					$redirection_url = Jetpack::admin_url();
4759
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4760
4761
					// Don't redirect form the Jetpack Setting Page
4762
					$referer_parsed = parse_url ( wp_get_referer() );
4763
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4764
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4765
						// Take the user to Jetpack home except when on the setting page
4766
						$redirection_url = wp_get_referer();
4767
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4768
					}
4769
					// Also update the JSON API FULL MANAGEMENT Option
4770
					Jetpack::activate_module( 'manage', false, false );
4771
4772
					// Special Message when option in.
4773
					Jetpack::state( 'optin-manage', 'true' );
4774
					// Activate the Module if not activated already
4775
4776
					// Redirect properly
4777
					wp_safe_redirect( $redirection_url );
4778
4779
				}
4780
				break;
4781
		}
4782
	}
4783
4784
	public static function admin_screen_configure_module( $module_id ) {
4785
4786
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4787
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4788
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4789
				/**
4790
				 * Fires to diplay a custom module activation screen.
4791
				 *
4792
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4793
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4794
				 *
4795
				 * @module manage
4796
				 *
4797
				 * @since 3.8.0
4798
				 *
4799
				 * @param int $module_id Module ID.
4800
				 */
4801
				do_action( 'display_activate_module_setting_' . $module_id );
4802
			} else {
4803
				self::display_activate_module_link( $module_id );
4804
			}
4805
4806
			return false;
4807
		} ?>
4808
4809
		<div id="jp-settings-screen" style="position: relative">
4810
			<h3>
4811
			<?php
4812
				$module = Jetpack::get_module( $module_id );
4813
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4814
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4815
			?>
4816
			</h3>
4817
			<?php
4818
				/**
4819
				 * Fires within the displayed message when a feature configuation is updated.
4820
				 *
4821
				 * @since 3.4.0
4822
				 *
4823
				 * @param int $module_id Module ID.
4824
				 */
4825
				do_action( 'jetpack_notices_update_settings', $module_id );
4826
				/**
4827
				 * Fires when a feature configuation screen is loaded.
4828
				 * The dynamic part of the hook, $module_id, is the module ID.
4829
				 *
4830
				 * @since 1.1.0
4831
				 */
4832
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4833
			?>
4834
		</div><?php
4835
	}
4836
4837
	/**
4838
	 * Display link to activate the module to see the settings screen.
4839
	 * @param  string $module_id
4840
	 * @return null
4841
	 */
4842
	public static function display_activate_module_link( $module_id ) {
4843
4844
		$info =  Jetpack::get_module( $module_id );
4845
		$extra = '';
4846
		$activate_url = wp_nonce_url(
4847
				Jetpack::admin_url(
4848
					array(
4849
						'page'   => 'jetpack',
4850
						'action' => 'activate',
4851
						'module' => $module_id,
4852
					)
4853
				),
4854
				"jetpack_activate-$module_id"
4855
			);
4856
4857
		?>
4858
4859
		<div class="wrap configure-module">
4860
			<div id="jp-settings-screen">
4861
				<?php
4862
				if ( $module_id == 'json-api' ) {
4863
4864
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4865
4866
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4867
4868
					$info['description'] = sprintf( __( 'Manage your multiple Jetpack sites from our centralized dashboard at wordpress.com/sites. <a href="%s" target="_blank">Learn more</a>.', 'jetpack' ), 'https://jetpack.com/support/site-management' );
4869
4870
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4871
				} ?>
4872
4873
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4874
				<div class="narrow">
4875
					<p><?php echo  $info['description']; ?></p>
4876
					<?php if( $extra ) { ?>
4877
					<p><?php echo esc_html( $extra ); ?></p>
4878
					<?php } ?>
4879
					<p>
4880
						<?php
4881
						if( wp_get_referer() ) {
4882
							printf( __( '<a class="button-primary" href="%s">Activate Now</a> or <a href="%s" >return to previous page</a>.', 'jetpack' ) , $activate_url, wp_get_referer() );
4883
						} else {
4884
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4885
						} ?>
4886
					</p>
4887
				</div>
4888
4889
			</div>
4890
		</div>
4891
4892
		<?php
4893
	}
4894
4895
	public static function sort_modules( $a, $b ) {
4896
		if ( $a['sort'] == $b['sort'] )
4897
			return 0;
4898
4899
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4900
	}
4901
4902
	function ajax_recheck_ssl() {
4903
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4904
		$result = Jetpack::permit_ssl( true );
4905
		wp_send_json( array(
4906
			'enabled' => $result,
4907
			'message' => get_transient( 'jetpack_https_test_message' )
4908
		) );
4909
	}
4910
4911
/* Client API */
4912
4913
	/**
4914
	 * Returns the requested Jetpack API URL
4915
	 *
4916
	 * @return string
4917
	 */
4918
	public static function api_url( $relative_url ) {
4919
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4920
	}
4921
4922
	/**
4923
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4924
	 */
4925
	public static function fix_url_for_bad_hosts( $url ) {
4926
		if ( 0 !== strpos( $url, 'https://' ) ) {
4927
			return $url;
4928
		}
4929
4930
		switch ( JETPACK_CLIENT__HTTPS ) {
4931
			case 'ALWAYS' :
4932
				return $url;
4933
			case 'NEVER' :
4934
				return set_url_scheme( $url, 'http' );
4935
			// default : case 'AUTO' :
4936
		}
4937
4938
		// we now return the unmodified SSL URL by default, as a security precaution
4939
		return $url;
4940
	}
4941
4942
	/**
4943
	 * Create a random secret for validating onboarding payload
4944
	 *
4945
	 * @return string Secret token
4946
	 */
4947
	public static function create_onboarding_token() {
4948
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4949
			$token = wp_generate_password( 32, false );
4950
			Jetpack_Options::update_option( 'onboarding', $token );
4951
		}
4952
4953
		return $token;
4954
	}
4955
4956
	/**
4957
	 * Remove the onboarding token
4958
	 *
4959
	 * @return bool True on success, false on failure
4960
	 */
4961
	public static function invalidate_onboarding_token() {
4962
		return Jetpack_Options::delete_option( 'onboarding' );
4963
	}
4964
4965
	/**
4966
	 * Validate an onboarding token for a specific action
4967
	 *
4968
	 * @return boolean True if token/action pair is accepted, false if not
4969
	 */
4970
	public static function validate_onboarding_token_action( $token, $action ) {
4971
		// Compare tokens, bail if tokens do not match
4972
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
4973
			return false;
4974
		}
4975
4976
		// List of valid actions we can take
4977
		$valid_actions = array(
4978
			'/jetpack/v4/settings',
4979
		);
4980
4981
		// Whitelist the action
4982
		if ( ! in_array( $action, $valid_actions ) ) {
4983
			return false;
4984
		}
4985
4986
		return true;
4987
	}
4988
4989
	/**
4990
	 * Checks to see if the URL is using SSL to connect with Jetpack
4991
	 *
4992
	 * @since 2.3.3
4993
	 * @return boolean
4994
	 */
4995
	public static function permit_ssl( $force_recheck = false ) {
4996
		// Do some fancy tests to see if ssl is being supported
4997
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4998
			$message = '';
4999
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5000
				$ssl = 0;
5001
			} else {
5002
				switch ( JETPACK_CLIENT__HTTPS ) {
5003
					case 'NEVER':
5004
						$ssl = 0;
5005
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5006
						break;
5007
					case 'ALWAYS':
5008
					case 'AUTO':
5009
					default:
5010
						$ssl = 1;
5011
						break;
5012
				}
5013
5014
				// If it's not 'NEVER', test to see
5015
				if ( $ssl ) {
5016
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5017
						$ssl = 0;
5018
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5019
					} else {
5020
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5021
						if ( is_wp_error( $response ) ) {
5022
							$ssl = 0;
5023
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5024
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5025
							$ssl = 0;
5026
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5027
						}
5028
					}
5029
				}
5030
			}
5031
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5032
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5033
		}
5034
5035
		return (bool) $ssl;
5036
	}
5037
5038
	/*
5039
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5040
	 */
5041
	public function alert_auto_ssl_fail() {
5042
		if ( ! current_user_can( 'manage_options' ) )
5043
			return;
5044
5045
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5046
		?>
5047
5048
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5049
			<div class="jp-banner__content">
5050
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5051
				<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>
5052
				<p>
5053
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5054
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5055
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5056
				</p>
5057
				<p>
5058
					<?php printf( __( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5059
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
5060
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
5061
				</p>
5062
			</div>
5063
		</div>
5064
		<style>
5065
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5066
		</style>
5067
		<script type="text/javascript">
5068
			jQuery( document ).ready( function( $ ) {
5069
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5070
					var $this = $( this );
5071
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5072
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5073
					e.preventDefault();
5074
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5075
					$.post( ajaxurl, data )
5076
					  .done( function( response ) {
5077
					  	if ( response.enabled ) {
5078
					  		$( '#jetpack-ssl-warning' ).hide();
5079
					  	} else {
5080
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5081
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5082
					  	}
5083
					  }.bind( $this ) );
5084
				} );
5085
			} );
5086
		</script>
5087
5088
		<?php
5089
	}
5090
5091
	/**
5092
	 * Returns the Jetpack XML-RPC API
5093
	 *
5094
	 * @return string
5095
	 */
5096
	public static function xmlrpc_api_url() {
5097
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
5098
		return untrailingslashit( $base ) . '/xmlrpc.php';
5099
	}
5100
5101
	/**
5102
	 * Creates two secret tokens and the end of life timestamp for them.
5103
	 *
5104
	 * Note these tokens are unique per call, NOT static per site for connecting.
5105
	 *
5106
	 * @since 2.6
5107
	 * @return array
5108
	 */
5109
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5110
		if ( ! $user_id ) {
5111
			$user_id = get_current_user_id();
5112
		}
5113
5114
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
5115
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5116
5117
		if (
5118
			isset( $secrets[ $secret_name ] ) &&
5119
			$secrets[ $secret_name ]['exp'] > time()
5120
		) {
5121
			return $secrets[ $secret_name ];
5122
		}
5123
5124
		$secret_value = array(
5125
			'secret_1'  => wp_generate_password( 32, false ),
5126
			'secret_2'  => wp_generate_password( 32, false ),
5127
			'exp'       => time() + $exp,
5128
		);
5129
5130
		$secrets[ $secret_name ] = $secret_value;
5131
5132
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5133
		return $secrets[ $secret_name ];
5134
	}
5135
5136
	public static function get_secrets( $action, $user_id ) {
5137
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5138
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5139
5140
		if ( ! isset( $secrets[ $secret_name ] ) ) {
5141
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5142
		}
5143
5144
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
5145
			self::delete_secrets( $action, $user_id );
5146
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5147
		}
5148
5149
		return $secrets[ $secret_name ];
5150
	}
5151
5152
	public static function delete_secrets( $action, $user_id ) {
5153
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5154
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5155
		if ( isset( $secrets[ $secret_name ] ) ) {
5156
			unset( $secrets[ $secret_name ] );
5157
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5158
		}
5159
	}
5160
5161
	/**
5162
	 * Builds the timeout limit for queries talking with the wpcom servers.
5163
	 *
5164
	 * Based on local php max_execution_time in php.ini
5165
	 *
5166
	 * @since 2.6
5167
	 * @return int
5168
	 * @deprecated
5169
	 **/
5170
	public function get_remote_query_timeout_limit() {
5171
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5172
		return Jetpack::get_max_execution_time();
5173
	}
5174
5175
	/**
5176
	 * Builds the timeout limit for queries talking with the wpcom servers.
5177
	 *
5178
	 * Based on local php max_execution_time in php.ini
5179
	 *
5180
	 * @since 5.4
5181
	 * @return int
5182
	 **/
5183
	public static function get_max_execution_time() {
5184
		$timeout = (int) ini_get( 'max_execution_time' );
5185
5186
		// Ensure exec time set in php.ini
5187
		if ( ! $timeout ) {
5188
			$timeout = 30;
5189
		}
5190
		return $timeout;
5191
	}
5192
5193
	/**
5194
	 * Sets a minimum request timeout, and returns the current timeout
5195
	 *
5196
	 * @since 5.4
5197
	 **/
5198
	public static function set_min_time_limit( $min_timeout ) {
5199
		$timeout = self::get_max_execution_time();
5200
		if ( $timeout < $min_timeout ) {
5201
			$timeout = $min_timeout;
5202
			set_time_limit( $timeout );
5203
		}
5204
		return $timeout;
5205
	}
5206
5207
5208
	/**
5209
	 * Takes the response from the Jetpack register new site endpoint and
5210
	 * verifies it worked properly.
5211
	 *
5212
	 * @since 2.6
5213
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5214
	 **/
5215
	public function validate_remote_register_response( $response ) {
5216
	  if ( is_wp_error( $response ) ) {
5217
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5218
		}
5219
5220
		$code   = wp_remote_retrieve_response_code( $response );
5221
		$entity = wp_remote_retrieve_body( $response );
5222
		if ( $entity )
5223
			$registration_response = json_decode( $entity );
5224
		else
5225
			$registration_response = false;
5226
5227
		$code_type = intval( $code / 100 );
5228
		if ( 5 == $code_type ) {
5229
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5230
		} elseif ( 408 == $code ) {
5231
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5232
		} elseif ( ! empty( $registration_response->error ) ) {
5233
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5234
				$error_description = __( "PHP's XML extension is not available. Jetpack requires the XML extension to communicate with WordPress.com. Please contact your hosting provider to enable PHP's XML extension.", 'jetpack' );
5235
			} else {
5236
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5237
			}
5238
5239
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5240
		} elseif ( 200 != $code ) {
5241
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5242
		}
5243
5244
		// Jetpack ID error block
5245
		if ( empty( $registration_response->jetpack_id ) ) {
5246
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5247
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5248
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is not a scalar. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
5249
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5250
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID begins with a numeral. Do not publicly post this error message! %s', 'jetpack' ) , $entity ), $entity );
5251
		}
5252
5253
	    return $registration_response;
5254
	}
5255
	/**
5256
	 * @return bool|WP_Error
5257
	 */
5258
	public static function register() {
5259
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5260
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5261
		$secrets = Jetpack::generate_secrets( 'register' );
5262
5263 View Code Duplication
		if (
5264
			empty( $secrets['secret_1'] ) ||
5265
			empty( $secrets['secret_2'] ) ||
5266
			empty( $secrets['exp'] )
5267
		) {
5268
			return new Jetpack_Error( 'missing_secrets' );
5269
		}
5270
5271
		// better to try (and fail) to set a higher timeout than this system
5272
		// supports than to have register fail for more users than it should
5273
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5274
5275
		$gmt_offset = get_option( 'gmt_offset' );
5276
		if ( ! $gmt_offset ) {
5277
			$gmt_offset = 0;
5278
		}
5279
5280
		$stats_options = get_option( 'stats_options' );
5281
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5282
5283
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5284
5285
		$args = array(
5286
			'method'  => 'POST',
5287
			'body'    => array(
5288
				'siteurl'         => site_url(),
5289
				'home'            => home_url(),
5290
				'gmt_offset'      => $gmt_offset,
5291
				'timezone_string' => (string) get_option( 'timezone_string' ),
5292
				'site_name'       => (string) get_option( 'blogname' ),
5293
				'secret_1'        => $secrets['secret_1'],
5294
				'secret_2'        => $secrets['secret_2'],
5295
				'site_lang'       => get_locale(),
5296
				'timeout'         => $timeout,
5297
				'stats_id'        => $stats_id,
5298
				'state'           => get_current_user_id(),
5299
				'_ui'             => $tracks_identity['_ui'],
5300
				'_ut'             => $tracks_identity['_ut'],
5301
				'jetpack_version' => JETPACK__VERSION
5302
			),
5303
			'headers' => array(
5304
				'Accept' => 'application/json',
5305
			),
5306
			'timeout' => $timeout,
5307
		);
5308
5309
		self::apply_activation_source_to_args( $args['body'] );
5310
5311
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5312
5313
		// Make sure the response is valid and does not contain any Jetpack errors
5314
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5315
		if ( is_wp_error( $registration_details ) ) {
5316
			return $registration_details;
5317
		} elseif ( ! $registration_details ) {
5318
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5319
		}
5320
5321 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5322
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5323
		}
5324
5325
		if ( isset( $registration_details->jetpack_public ) ) {
5326
			$jetpack_public = (int) $registration_details->jetpack_public;
5327
		} else {
5328
			$jetpack_public = false;
5329
		}
5330
5331
		Jetpack_Options::update_options(
5332
			array(
5333
				'id'         => (int)    $registration_details->jetpack_id,
5334
				'blog_token' => (string) $registration_details->jetpack_secret,
5335
				'public'     => $jetpack_public,
5336
			)
5337
		);
5338
5339
		/**
5340
		 * Fires when a site is registered on WordPress.com.
5341
		 *
5342
		 * @since 3.7.0
5343
		 *
5344
		 * @param int $json->jetpack_id Jetpack Blog ID.
5345
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5346
		 * @param int|bool $jetpack_public Is the site public.
5347
		 */
5348
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5349
5350
		// Initialize Jump Start for the first and only time.
5351
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5352
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5353
5354
			$jetpack = Jetpack::init();
5355
5356
			$jetpack->stat( 'jumpstart', 'unique-views' );
5357
			$jetpack->do_stats( 'server_side' );
5358
		};
5359
5360
		return true;
5361
	}
5362
5363
	/**
5364
	 * If the db version is showing something other that what we've got now, bump it to current.
5365
	 *
5366
	 * @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...
5367
	 */
5368
	public static function maybe_set_version_option() {
5369
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5370
		if ( JETPACK__VERSION != $version ) {
5371
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5372
5373
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5374
				/** This action is documented in class.jetpack.php */
5375
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5376
			}
5377
5378
			return true;
5379
		}
5380
		return false;
5381
	}
5382
5383
/* Client Server API */
5384
5385
	/**
5386
	 * Loads the Jetpack XML-RPC client
5387
	 */
5388
	public static function load_xml_rpc_client() {
5389
		require_once ABSPATH . WPINC . '/class-IXR.php';
5390
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5391
	}
5392
5393
	/**
5394
	 * Resets the saved authentication state in between testing requests.
5395
	 */
5396
	public function reset_saved_auth_state() {
5397
		$this->xmlrpc_verification = null;
5398
		$this->rest_authentication_status = null;
5399
	}
5400
5401
	function verify_xml_rpc_signature() {
5402
		if ( $this->xmlrpc_verification ) {
5403
			return $this->xmlrpc_verification;
5404
		}
5405
5406
		// It's not for us
5407
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5408
			return false;
5409
		}
5410
5411
		@list( $token_key, $version, $user_id ) = explode( ':', $_GET['token'] );
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...
5412
		if (
5413
			empty( $token_key )
5414
		||
5415
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5416
		) {
5417
			return false;
5418
		}
5419
5420
		if ( '0' === $user_id ) {
5421
			$token_type = 'blog';
5422
			$user_id = 0;
5423
		} else {
5424
			$token_type = 'user';
5425
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5426
				return false;
5427
			}
5428
			$user_id = (int) $user_id;
5429
5430
			$user = new WP_User( $user_id );
5431
			if ( ! $user || ! $user->exists() ) {
5432
				return false;
5433
			}
5434
		}
5435
5436
		$token = Jetpack_Data::get_access_token( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id 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...
5437
		if ( ! $token ) {
5438
			return false;
5439
		}
5440
5441
		$token_check = "$token_key.";
5442
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
5443
			return false;
5444
		}
5445
5446
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5447
5448
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5449
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5450
			$post_data   = $_POST;
5451
			$file_hashes = array();
5452
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5453
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5454
					continue;
5455
				}
5456
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5457
				$file_hashes[$post_data_key] = $post_data_value;
5458
			}
5459
5460
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5461
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5462
				$post_data[$post_data_key] = $post_data_value;
5463
			}
5464
5465
			ksort( $post_data );
5466
5467
			$body = http_build_query( stripslashes_deep( $post_data ) );
5468
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5469
			$body = file_get_contents( 'php://input' );
5470
		} else {
5471
			$body = null;
5472
		}
5473
5474
		$signature = $jetpack_signature->sign_current_request(
5475
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5476
		);
5477
5478
		if ( ! $signature ) {
5479
			return false;
5480
		} else if ( is_wp_error( $signature ) ) {
5481
			return $signature;
5482
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
5483
			return false;
5484
		}
5485
5486
		$timestamp = (int) $_GET['timestamp'];
5487
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5488
5489
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5490
			return false;
5491
		}
5492
5493
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5494
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5495
			if ( ! empty( $_GET['onboarding'] ) ) {
5496
				$jpo = $_GET;
5497
			} else {
5498
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5499
			}
5500
5501
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5502
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5503
5504
			if (
5505
				isset( $jpo_user ) && isset( $jpo_token ) &&
5506
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5507
				isset( $_GET['rest_route'] ) &&
5508
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5509
			) {
5510
				$jpUser = get_user_by( 'email', $jpo_user );
5511
				if ( is_a( $jpUser, 'WP_User' ) ) {
5512
					wp_set_current_user( $jpUser->ID );
5513
					$user_can = is_multisite()
5514
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5515
						: current_user_can( 'manage_options' );
5516
					if ( $user_can ) {
5517
						$token_type = 'user';
5518
						$token->external_user_id = $jpUser->ID;
5519
					}
5520
				}
5521
			}
5522
		}
5523
5524
		$this->xmlrpc_verification = array(
5525
			'type'    => $token_type,
5526
			'user_id' => $token->external_user_id,
5527
		);
5528
5529
		return $this->xmlrpc_verification;
5530
	}
5531
5532
	/**
5533
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5534
	 */
5535
	function authenticate_jetpack( $user, $username, $password ) {
5536
		if ( is_a( $user, 'WP_User' ) ) {
5537
			return $user;
5538
		}
5539
5540
		$token_details = $this->verify_xml_rpc_signature();
5541
5542
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5543
			return $user;
5544
		}
5545
5546
		if ( 'user' !== $token_details['type'] ) {
5547
			return $user;
5548
		}
5549
5550
		if ( ! $token_details['user_id'] ) {
5551
			return $user;
5552
		}
5553
5554
		nocache_headers();
5555
5556
		return new WP_User( $token_details['user_id'] );
5557
	}
5558
5559
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5560
	// Uses the existing XMLRPC request signing implementation.
5561
	function wp_rest_authenticate( $user ) {
5562
		if ( ! empty( $user ) ) {
5563
			// Another authentication method is in effect.
5564
			return $user;
5565
		}
5566
5567
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5568
			// Nothing to do for this authentication method.
5569
			return null;
5570
		}
5571
5572
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5573
			// Nothing to do for this authentication method.
5574
			return null;
5575
		}
5576
5577
		// Ensure that we always have the request body available.  At this
5578
		// point, the WP REST API code to determine the request body has not
5579
		// run yet.  That code may try to read from 'php://input' later, but
5580
		// this can only be done once per request in PHP versions prior to 5.6.
5581
		// So we will go ahead and perform this read now if needed, and save
5582
		// the request body where both the Jetpack signature verification code
5583
		// and the WP REST API code can see it.
5584
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5585
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5586
		}
5587
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5588
5589
		// Only support specific request parameters that have been tested and
5590
		// are known to work with signature verification.  A different method
5591
		// can be passed to the WP REST API via the '?_method=' parameter if
5592
		// needed.
5593
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5594
			$this->rest_authentication_status = new WP_Error(
5595
				'rest_invalid_request',
5596
				__( 'This request method is not supported.', 'jetpack' ),
5597
				array( 'status' => 400 )
5598
			);
5599
			return null;
5600
		}
5601
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5602
			$this->rest_authentication_status = new WP_Error(
5603
				'rest_invalid_request',
5604
				__( 'This request method does not support body parameters.', 'jetpack' ),
5605
				array( 'status' => 400 )
5606
			);
5607
			return null;
5608
		}
5609
5610
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5611
			$content_type = $_SERVER['CONTENT_TYPE'];
5612
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5613
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5614
		}
5615
5616
		if (
5617
			isset( $content_type ) &&
5618
			$content_type !== 'application/x-www-form-urlencoded' &&
5619
			$content_type !== 'application/json'
5620
		) {
5621
			$this->rest_authentication_status = new WP_Error(
5622
				'rest_invalid_request',
5623
				__( 'This Content-Type is not supported.', 'jetpack' ),
5624
				array( 'status' => 400 )
5625
			);
5626
			return null;
5627
		}
5628
5629
		$verified = $this->verify_xml_rpc_signature();
5630
5631
		if ( is_wp_error( $verified ) ) {
5632
			$this->rest_authentication_status = $verified;
5633
			return null;
5634
		}
5635
5636
		if (
5637
			$verified &&
5638
			isset( $verified['type'] ) &&
5639
			'user' === $verified['type'] &&
5640
			! empty( $verified['user_id'] )
5641
		) {
5642
			// Authentication successful.
5643
			$this->rest_authentication_status = true;
5644
			return $verified['user_id'];
5645
		}
5646
5647
		// Something else went wrong.  Probably a signature error.
5648
		$this->rest_authentication_status = new WP_Error(
5649
			'rest_invalid_signature',
5650
			__( 'The request is not signed correctly.', 'jetpack' ),
5651
			array( 'status' => 400 )
5652
		);
5653
		return null;
5654
	}
5655
5656
	/**
5657
	 * Report authentication status to the WP REST API.
5658
	 *
5659
	 * @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...
5660
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5661
	 */
5662
	public function wp_rest_authentication_errors( $value ) {
5663
		if ( $value !== null ) {
5664
			return $value;
5665
		}
5666
		return $this->rest_authentication_status;
5667
	}
5668
5669
	function add_nonce( $timestamp, $nonce ) {
5670
		global $wpdb;
5671
		static $nonces_used_this_request = array();
5672
5673
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5674
			return $nonces_used_this_request["$timestamp:$nonce"];
5675
		}
5676
5677
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5678
		$timestamp = (int) $timestamp;
5679
		$nonce     = esc_sql( $nonce );
5680
5681
		// Raw query so we can avoid races: add_option will also update
5682
		$show_errors = $wpdb->show_errors( false );
5683
5684
		$old_nonce = $wpdb->get_row(
5685
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5686
		);
5687
5688
		if ( is_null( $old_nonce ) ) {
5689
			$return = $wpdb->query(
5690
				$wpdb->prepare(
5691
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5692
					"jetpack_nonce_{$timestamp}_{$nonce}",
5693
					time(),
5694
					'no'
5695
				)
5696
			);
5697
		} else {
5698
			$return = false;
5699
		}
5700
5701
		$wpdb->show_errors( $show_errors );
5702
5703
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5704
5705
		return $return;
5706
	}
5707
5708
	/**
5709
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5710
	 * Capture it here so we can verify the signature later.
5711
	 */
5712
	function xmlrpc_methods( $methods ) {
5713
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5714
		return $methods;
5715
	}
5716
5717
	function public_xmlrpc_methods( $methods ) {
5718
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5719
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5720
		}
5721
		return $methods;
5722
	}
5723
5724
	function jetpack_getOptions( $args ) {
5725
		global $wp_xmlrpc_server;
5726
5727
		$wp_xmlrpc_server->escape( $args );
5728
5729
		$username	= $args[1];
5730
		$password	= $args[2];
5731
5732
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5733
			return $wp_xmlrpc_server->error;
5734
		}
5735
5736
		$options = array();
5737
		$user_data = $this->get_connected_user_data();
5738
		if ( is_array( $user_data ) ) {
5739
			$options['jetpack_user_id'] = array(
5740
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5741
				'readonly'      => true,
5742
				'value'         => $user_data['ID'],
5743
			);
5744
			$options['jetpack_user_login'] = array(
5745
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5746
				'readonly'      => true,
5747
				'value'         => $user_data['login'],
5748
			);
5749
			$options['jetpack_user_email'] = array(
5750
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5751
				'readonly'      => true,
5752
				'value'         => $user_data['email'],
5753
			);
5754
			$options['jetpack_user_site_count'] = array(
5755
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5756
				'readonly'      => true,
5757
				'value'         => $user_data['site_count'],
5758
			);
5759
		}
5760
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5761
		$args = stripslashes_deep( $args );
5762
		return $wp_xmlrpc_server->wp_getOptions( $args );
5763
	}
5764
5765
	function xmlrpc_options( $options ) {
5766
		$jetpack_client_id = false;
5767
		if ( self::is_active() ) {
5768
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5769
		}
5770
		$options['jetpack_version'] = array(
5771
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5772
				'readonly'      => true,
5773
				'value'         => JETPACK__VERSION,
5774
		);
5775
5776
		$options['jetpack_client_id'] = array(
5777
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5778
				'readonly'      => true,
5779
				'value'         => $jetpack_client_id,
5780
		);
5781
		return $options;
5782
	}
5783
5784
	public static function clean_nonces( $all = false ) {
5785
		global $wpdb;
5786
5787
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5788
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5789
5790
		if ( true !== $all ) {
5791
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5792
			$sql_args[] = time() - 3600;
5793
		}
5794
5795
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5796
5797
		$sql = $wpdb->prepare( $sql, $sql_args );
5798
5799
		for ( $i = 0; $i < 1000; $i++ ) {
5800
			if ( ! $wpdb->query( $sql ) ) {
5801
				break;
5802
			}
5803
		}
5804
	}
5805
5806
	/**
5807
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5808
	 * SET: state( $key, $value );
5809
	 * GET: $value = state( $key );
5810
	 *
5811
	 * @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...
5812
	 * @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...
5813
	 * @param bool $restate private
5814
	 */
5815
	public static function state( $key = null, $value = null, $restate = false ) {
5816
		static $state = array();
5817
		static $path, $domain;
5818
		if ( ! isset( $path ) ) {
5819
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5820
			$admin_url = Jetpack::admin_url();
5821
			$bits      = parse_url( $admin_url );
5822
5823
			if ( is_array( $bits ) ) {
5824
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5825
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5826
			} else {
5827
				$path = $domain = null;
5828
			}
5829
		}
5830
5831
		// Extract state from cookies and delete cookies
5832
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5833
			$yum = $_COOKIE[ 'jetpackState' ];
5834
			unset( $_COOKIE[ 'jetpackState' ] );
5835
			foreach ( $yum as $k => $v ) {
5836
				if ( strlen( $v ) )
5837
					$state[ $k ] = $v;
5838
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5839
			}
5840
		}
5841
5842
		if ( $restate ) {
5843
			foreach ( $state as $k => $v ) {
5844
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5845
			}
5846
			return;
5847
		}
5848
5849
		// Get a state variable
5850
		if ( isset( $key ) && ! isset( $value ) ) {
5851
			if ( array_key_exists( $key, $state ) )
5852
				return $state[ $key ];
5853
			return null;
5854
		}
5855
5856
		// Set a state variable
5857
		if ( isset ( $key ) && isset( $value ) ) {
5858
			if( is_array( $value ) && isset( $value[0] ) ) {
5859
				$value = $value[0];
5860
			}
5861
			$state[ $key ] = $value;
5862
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5863
		}
5864
	}
5865
5866
	public static function restate() {
5867
		Jetpack::state( null, null, true );
5868
	}
5869
5870
	public static function check_privacy( $file ) {
5871
		static $is_site_publicly_accessible = null;
5872
5873
		if ( is_null( $is_site_publicly_accessible ) ) {
5874
			$is_site_publicly_accessible = false;
5875
5876
			Jetpack::load_xml_rpc_client();
5877
			$rpc = new Jetpack_IXR_Client();
5878
5879
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5880
			if ( $success ) {
5881
				$response = $rpc->getResponse();
5882
				if ( $response ) {
5883
					$is_site_publicly_accessible = true;
5884
				}
5885
			}
5886
5887
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5888
		}
5889
5890
		if ( $is_site_publicly_accessible ) {
5891
			return;
5892
		}
5893
5894
		$module_slug = self::get_module_slug( $file );
5895
5896
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5897
		if ( ! $privacy_checks ) {
5898
			$privacy_checks = $module_slug;
5899
		} else {
5900
			$privacy_checks .= ",$module_slug";
5901
		}
5902
5903
		Jetpack::state( 'privacy_checks', $privacy_checks );
5904
	}
5905
5906
	/**
5907
	 * Helper method for multicall XMLRPC.
5908
	 */
5909
	public static function xmlrpc_async_call() {
5910
		global $blog_id;
5911
		static $clients = array();
5912
5913
		$client_blog_id = is_multisite() ? $blog_id : 0;
5914
5915
		if ( ! isset( $clients[$client_blog_id] ) ) {
5916
			Jetpack::load_xml_rpc_client();
5917
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5918
			if ( function_exists( 'ignore_user_abort' ) ) {
5919
				ignore_user_abort( true );
5920
			}
5921
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5922
		}
5923
5924
		$args = func_get_args();
5925
5926
		if ( ! empty( $args[0] ) ) {
5927
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5928
		} elseif ( is_multisite() ) {
5929
			foreach ( $clients as $client_blog_id => $client ) {
5930
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5931
					continue;
5932
				}
5933
5934
				$switch_success = switch_to_blog( $client_blog_id, true );
5935
				if ( ! $switch_success ) {
5936
					continue;
5937
				}
5938
5939
				flush();
5940
				$client->query();
5941
5942
				restore_current_blog();
5943
			}
5944
		} else {
5945
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5946
				flush();
5947
				$clients[0]->query();
5948
			}
5949
		}
5950
	}
5951
5952
	public static function staticize_subdomain( $url ) {
5953
5954
		// Extract hostname from URL
5955
		$host = parse_url( $url, PHP_URL_HOST );
5956
5957
		// Explode hostname on '.'
5958
		$exploded_host = explode( '.', $host );
5959
5960
		// Retrieve the name and TLD
5961
		if ( count( $exploded_host ) > 1 ) {
5962
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5963
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5964
			// Rebuild domain excluding subdomains
5965
			$domain = $name . '.' . $tld;
5966
		} else {
5967
			$domain = $host;
5968
		}
5969
		// Array of Automattic domains
5970
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5971
5972
		// Return $url if not an Automattic domain
5973
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5974
			return $url;
5975
		}
5976
5977
		if ( is_ssl() ) {
5978
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5979
		}
5980
5981
		srand( crc32( basename( $url ) ) );
5982
		$static_counter = rand( 0, 2 );
5983
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5984
5985
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5986
	}
5987
5988
/* JSON API Authorization */
5989
5990
	/**
5991
	 * Handles the login action for Authorizing the JSON API
5992
	 */
5993
	function login_form_json_api_authorization() {
5994
		$this->verify_json_api_authorization_request();
5995
5996
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5997
5998
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5999
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6000
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6001
	}
6002
6003
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6004
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6005
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6006
			return $url;
6007
		}
6008
6009
		$parsed_url = parse_url( $url );
6010
		$url = strtok( $url, '?' );
6011
		$url = "$url?{$_SERVER['QUERY_STRING']}";
6012
		if ( ! empty( $parsed_url['query'] ) )
6013
			$url .= "&{$parsed_url['query']}";
6014
6015
		return $url;
6016
	}
6017
6018
	// Make sure the POSTed request is handled by the same action
6019
	function preserve_action_in_login_form_for_json_api_authorization() {
6020
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6021
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6022
	}
6023
6024
	// If someone logs in to approve API access, store the Access Code in usermeta
6025
	function store_json_api_authorization_token( $user_login, $user ) {
6026
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6027
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6028
		$token = wp_generate_password( 32, false );
6029
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6030
	}
6031
6032
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6033
	function allow_wpcom_public_api_domain( $domains ) {
6034
		$domains[] = 'public-api.wordpress.com';
6035
		return $domains;
6036
	}
6037
6038
	// Add all wordpress.com environments to the safe redirect whitelist
6039
	function allow_wpcom_environments( $domains ) {
6040
		$domains[] = 'wordpress.com';
6041
		$domains[] = 'wpcalypso.wordpress.com';
6042
		$domains[] = 'horizon.wordpress.com';
6043
		$domains[] = 'calypso.localhost';
6044
		return $domains;
6045
	}
6046
6047
	// Add the Access Code details to the public-api.wordpress.com redirect
6048
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6049
		return add_query_arg(
6050
			urlencode_deep(
6051
				array(
6052
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6053
					'jetpack-user-id' => (int) $user->ID,
6054
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6055
				)
6056
			),
6057
			$redirect_to
6058
		);
6059
	}
6060
6061
6062
	/**
6063
	 * Verifies the request by checking the signature
6064
	 *
6065
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6066
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6067
	 *
6068
	 * @param null|array $environment
6069
	 */
6070
	function verify_json_api_authorization_request( $environment = null ) {
6071
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
6072
6073
		$environment = is_null( $environment )
6074
			? $_REQUEST
6075
			: $environment;
6076
6077
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envToken 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...
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...
6078
		$token = Jetpack_Data::get_access_token( $envUserId );
6079
		if ( ! $token || empty( $token->secret ) ) {
6080
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
6081
		}
6082
6083
		$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' );
6084
6085
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6086
6087
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6088
			$signature = $jetpack_signature->sign_request(
6089
				$environment['token'],
6090
				$environment['timestamp'],
6091
				$environment['nonce'],
6092
				'',
6093
				'GET',
6094
				$environment['jetpack_json_api_original_query'],
6095
				null,
6096
				true
6097
			);
6098
		} else {
6099
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
6100
		}
6101
6102
		if ( ! $signature ) {
6103
			wp_die( $die_error );
6104
		} else if ( is_wp_error( $signature ) ) {
6105
			wp_die( $die_error );
6106
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
6107
			if ( is_ssl() ) {
6108
				// 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
6109
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
6110
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) { // phpcs:ignore PHPCompatibility -- skipping since `hash_equals` is part of WP core
6111
					wp_die( $die_error );
6112
				}
6113
			} else {
6114
				wp_die( $die_error );
6115
			}
6116
		}
6117
6118
		$timestamp = (int) $environment['timestamp'];
6119
		$nonce     = stripslashes( (string) $environment['nonce'] );
6120
6121
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
6122
			// De-nonce the nonce, at least for 5 minutes.
6123
			// 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)
6124
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6125
			if ( $old_nonce_time < time() - 300 ) {
6126
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
6127
			}
6128
		}
6129
6130
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6131
		$data_filters = array(
6132
			'state'        => 'opaque',
6133
			'client_id'    => 'int',
6134
			'client_title' => 'string',
6135
			'client_image' => 'url',
6136
		);
6137
6138
		foreach ( $data_filters as $key => $sanitation ) {
6139
			if ( ! isset( $data->$key ) ) {
6140
				wp_die( $die_error );
6141
			}
6142
6143
			switch ( $sanitation ) {
6144
			case 'int' :
6145
				$this->json_api_authorization_request[$key] = (int) $data->$key;
6146
				break;
6147
			case 'opaque' :
6148
				$this->json_api_authorization_request[$key] = (string) $data->$key;
6149
				break;
6150
			case 'string' :
6151
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
6152
				break;
6153
			case 'url' :
6154
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
6155
				break;
6156
			}
6157
		}
6158
6159
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6160
			wp_die( $die_error );
6161
		}
6162
	}
6163
6164
	function login_message_json_api_authorization( $message ) {
6165
		return '<p class="message">' . sprintf(
6166
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6167
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6168
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6169
	}
6170
6171
	/**
6172
	 * Get $content_width, but with a <s>twist</s> filter.
6173
	 */
6174
	public static function get_content_width() {
6175
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6176
		/**
6177
		 * Filter the Content Width value.
6178
		 *
6179
		 * @since 2.2.3
6180
		 *
6181
		 * @param string $content_width Content Width value.
6182
		 */
6183
		return apply_filters( 'jetpack_content_width', $content_width );
6184
	}
6185
6186
	/**
6187
	 * Pings the WordPress.com Mirror Site for the specified options.
6188
	 *
6189
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6190
	 *
6191
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6192
	 */
6193
	public function get_cloud_site_options( $option_names ) {
6194
		$option_names = array_filter( (array) $option_names, 'is_string' );
6195
6196
		Jetpack::load_xml_rpc_client();
6197
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6198
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6199
		if ( $xml->isError() ) {
6200
			return array(
6201
				'error_code' => $xml->getErrorCode(),
6202
				'error_msg'  => $xml->getErrorMessage(),
6203
			);
6204
		}
6205
		$cloud_site_options = $xml->getResponse();
6206
6207
		return $cloud_site_options;
6208
	}
6209
6210
	/**
6211
	 * Checks if the site is currently in an identity crisis.
6212
	 *
6213
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6214
	 */
6215
	public static function check_identity_crisis() {
6216
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6217
			return false;
6218
		}
6219
6220
		return Jetpack_Options::get_option( 'sync_error_idc' );
6221
	}
6222
6223
	/**
6224
	 * Checks whether the home and siteurl specifically are whitelisted
6225
	 * Written so that we don't have re-check $key and $value params every time
6226
	 * we want to check if this site is whitelisted, for example in footer.php
6227
	 *
6228
	 * @since  3.8.0
6229
	 * @return bool True = already whitelisted False = not whitelisted
6230
	 */
6231
	public static function is_staging_site() {
6232
		$is_staging = false;
6233
6234
		$known_staging = array(
6235
			'urls' => array(
6236
				'#\.staging\.wpengine\.com$#i', // WP Engine
6237
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6238
				),
6239
			'constants' => array(
6240
				'IS_WPE_SNAPSHOT',      // WP Engine
6241
				'KINSTA_DEV_ENV',       // Kinsta.com
6242
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6243
				'JETPACK_STAGING_MODE', // Generic
6244
				)
6245
			);
6246
		/**
6247
		 * Filters the flags of known staging sites.
6248
		 *
6249
		 * @since 3.9.0
6250
		 *
6251
		 * @param array $known_staging {
6252
		 *     An array of arrays that each are used to check if the current site is staging.
6253
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6254
		 *     @type array $constants PHP constants of known staging/developement environments.
6255
		 *  }
6256
		 */
6257
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6258
6259
		if ( isset( $known_staging['urls'] ) ) {
6260
			foreach ( $known_staging['urls'] as $url ){
6261
				if ( preg_match( $url, site_url() ) ) {
6262
					$is_staging = true;
6263
					break;
6264
				}
6265
			}
6266
		}
6267
6268
		if ( isset( $known_staging['constants'] ) ) {
6269
			foreach ( $known_staging['constants'] as $constant ) {
6270
				if ( defined( $constant ) && constant( $constant ) ) {
6271
					$is_staging = true;
6272
				}
6273
			}
6274
		}
6275
6276
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6277
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6278
			$is_staging = true;
6279
		}
6280
6281
		/**
6282
		 * Filters is_staging_site check.
6283
		 *
6284
		 * @since 3.9.0
6285
		 *
6286
		 * @param bool $is_staging If the current site is a staging site.
6287
		 */
6288
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6289
	}
6290
6291
	/**
6292
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6293
	 *
6294
	 * @since 4.4.0
6295
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6296
	 *
6297
	 * @return bool
6298
	 */
6299
	public static function validate_sync_error_idc_option() {
6300
		$is_valid = false;
6301
6302
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6303
		if ( false === $idc_allowed ) {
6304
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6305
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6306
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6307
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6308
				$transient_duration = HOUR_IN_SECONDS;
6309
			} else {
6310
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6311
				$idc_allowed = '1';
6312
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6313
			}
6314
6315
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6316
		}
6317
6318
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6319
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6320
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6321
			$local_options = self::get_sync_error_idc_option();
6322
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6323
				$is_valid = true;
6324
			}
6325
		}
6326
6327
		/**
6328
		 * Filters whether the sync_error_idc option is valid.
6329
		 *
6330
		 * @since 4.4.0
6331
		 *
6332
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6333
		 */
6334
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6335
6336
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6337
			// Since the option exists, and did not validate, delete it
6338
			Jetpack_Options::delete_option( 'sync_error_idc' );
6339
		}
6340
6341
		return $is_valid;
6342
	}
6343
6344
	/**
6345
	 * Normalizes a url by doing three things:
6346
	 *  - Strips protocol
6347
	 *  - Strips www
6348
	 *  - Adds a trailing slash
6349
	 *
6350
	 * @since 4.4.0
6351
	 * @param string $url
6352
	 * @return WP_Error|string
6353
	 */
6354
	public static function normalize_url_protocol_agnostic( $url ) {
6355
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6356
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6357
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6358
		}
6359
6360
		// Strip www and protocols
6361
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6362
		return $url;
6363
	}
6364
6365
	/**
6366
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6367
	 *
6368
	 * @since 4.4.0
6369
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6370
	 *
6371
	 * @param array $response
6372
	 * @return array Array of the local urls, wpcom urls, and error code
6373
	 */
6374
	public static function get_sync_error_idc_option( $response = array() ) {
6375
		// Since the local options will hit the database directly, store the values
6376
		// in a transient to allow for autoloading and caching on subsequent views.
6377
		$local_options = get_transient( 'jetpack_idc_local' );
6378
		if ( false === $local_options ) {
6379
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6380
			$local_options = array(
6381
				'home'    => Jetpack_Sync_Functions::home_url(),
6382
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6383
			);
6384
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6385
		}
6386
6387
		$options = array_merge( $local_options, $response );
6388
6389
		$returned_values = array();
6390
		foreach( $options as $key => $option ) {
6391
			if ( 'error_code' === $key ) {
6392
				$returned_values[ $key ] = $option;
6393
				continue;
6394
			}
6395
6396
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6397
				continue;
6398
			}
6399
6400
			$returned_values[ $key ] = $normalized_url;
6401
		}
6402
6403
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6404
6405
		return $returned_values;
6406
	}
6407
6408
	/**
6409
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6410
	 * If set to true, the site will be put into staging mode.
6411
	 *
6412
	 * @since 4.3.2
6413
	 * @return bool
6414
	 */
6415
	public static function sync_idc_optin() {
6416
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6417
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6418
		} else {
6419
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6420
		}
6421
6422
		/**
6423
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6424
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6425
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6426
		 *
6427
		 * @since 4.3.2
6428
		 *
6429
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6430
		 */
6431
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6432
	}
6433
6434
	/**
6435
	 * Maybe Use a .min.css stylesheet, maybe not.
6436
	 *
6437
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6438
	 */
6439
	public static function maybe_min_asset( $url, $path, $plugin ) {
6440
		// Short out on things trying to find actual paths.
6441
		if ( ! $path || empty( $plugin ) ) {
6442
			return $url;
6443
		}
6444
6445
		$path = ltrim( $path, '/' );
6446
6447
		// Strip out the abspath.
6448
		$base = dirname( plugin_basename( $plugin ) );
6449
6450
		// Short out on non-Jetpack assets.
6451
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6452
			return $url;
6453
		}
6454
6455
		// File name parsing.
6456
		$file              = "{$base}/{$path}";
6457
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6458
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6459
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6460
		$extension         = array_shift( $file_name_parts_r );
6461
6462
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6463
			// Already pointing at the minified version.
6464
			if ( 'min' === $file_name_parts_r[0] ) {
6465
				return $url;
6466
			}
6467
6468
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6469
			if ( file_exists( $min_full_path ) ) {
6470
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6471
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6472
				if ( 'css' === $extension ) {
6473
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6474
					self::$min_assets[ $key ] = $path;
6475
				}
6476
			}
6477
		}
6478
6479
		return $url;
6480
	}
6481
6482
	/**
6483
	 * If the asset is minified, let's flag .min as the suffix.
6484
	 *
6485
	 * Attached to `style_loader_src` filter.
6486
	 *
6487
	 * @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...
6488
	 * @param string $handle The registered handle of the script in question.
6489
	 * @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...
6490
	 */
6491
	public static function set_suffix_on_min( $src, $handle ) {
6492
		if ( false === strpos( $src, '.min.css' ) ) {
6493
			return $src;
6494
		}
6495
6496
		if ( ! empty( self::$min_assets ) ) {
6497
			foreach ( self::$min_assets as $file => $path ) {
6498
				if ( false !== strpos( $src, $file ) ) {
6499
					wp_style_add_data( $handle, 'suffix', '.min' );
6500
					return $src;
6501
				}
6502
			}
6503
		}
6504
6505
		return $src;
6506
	}
6507
6508
	/**
6509
	 * Maybe inlines a stylesheet.
6510
	 *
6511
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6512
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6513
	 *
6514
	 * Attached to `style_loader_tag` filter.
6515
	 *
6516
	 * @param string $tag The tag that would link to the external asset.
6517
	 * @param string $handle The registered handle of the script in question.
6518
	 *
6519
	 * @return string
6520
	 */
6521
	public static function maybe_inline_style( $tag, $handle ) {
6522
		global $wp_styles;
6523
		$item = $wp_styles->registered[ $handle ];
6524
6525
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6526
			return $tag;
6527
		}
6528
6529
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6530
			$href = $matches[1];
6531
			// Strip off query string
6532
			if ( $pos = strpos( $href, '?' ) ) {
6533
				$href = substr( $href, 0, $pos );
6534
			}
6535
			// Strip off fragment
6536
			if ( $pos = strpos( $href, '#' ) ) {
6537
				$href = substr( $href, 0, $pos );
6538
			}
6539
		} else {
6540
			return $tag;
6541
		}
6542
6543
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6544
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6545
			return $tag;
6546
		}
6547
6548
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6549
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6550
			// And this isn't the pass that actually deals with the RTL version...
6551
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6552
				// Short out, as the RTL version will deal with it in a moment.
6553
				return $tag;
6554
			}
6555
		}
6556
6557
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6558
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6559
		if ( $css ) {
6560
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6561
			if ( empty( $item->extra['after'] ) ) {
6562
				wp_add_inline_style( $handle, $css );
6563
			} else {
6564
				array_unshift( $item->extra['after'], $css );
6565
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6566
			}
6567
		}
6568
6569
		return $tag;
6570
	}
6571
6572
	/**
6573
	 * Loads a view file from the views
6574
	 *
6575
	 * Data passed in with the $data parameter will be available in the
6576
	 * template file as $data['value']
6577
	 *
6578
	 * @param string $template - Template file to load
6579
	 * @param array $data - Any data to pass along to the template
6580
	 * @return boolean - If template file was found
6581
	 **/
6582
	public function load_view( $template, $data = array() ) {
6583
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6584
6585
		if( file_exists( $views_dir . $template ) ) {
6586
			require_once( $views_dir . $template );
6587
			return true;
6588
		}
6589
6590
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6591
		return false;
6592
	}
6593
6594
	/**
6595
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6596
	 */
6597
	public function deprecated_hooks() {
6598
		global $wp_filter;
6599
6600
		/*
6601
		 * Format:
6602
		 * deprecated_filter_name => replacement_name
6603
		 *
6604
		 * If there is no replacement, use null for replacement_name
6605
		 */
6606
		$deprecated_list = array(
6607
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6608
			'wpl_sharing_2014_1'                                     => null,
6609
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6610
			'jetpack_identity_crisis_options_to_check'               => null,
6611
			'update_option_jetpack_single_user_site'                 => null,
6612
			'audio_player_default_colors'                            => null,
6613
			'add_option_jetpack_featured_images_enabled'             => null,
6614
			'add_option_jetpack_update_details'                      => null,
6615
			'add_option_jetpack_updates'                             => null,
6616
			'add_option_jetpack_network_name'                        => null,
6617
			'add_option_jetpack_network_allow_new_registrations'     => null,
6618
			'add_option_jetpack_network_add_new_users'               => null,
6619
			'add_option_jetpack_network_site_upload_space'           => null,
6620
			'add_option_jetpack_network_upload_file_types'           => null,
6621
			'add_option_jetpack_network_enable_administration_menus' => null,
6622
			'add_option_jetpack_is_multi_site'                       => null,
6623
			'add_option_jetpack_is_main_network'                     => null,
6624
			'add_option_jetpack_main_network_site'                   => null,
6625
			'jetpack_sync_all_registered_options'                    => null,
6626
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6627
			'jetpack_is_post_mailable'                               => null,
6628
			'jetpack_seo_site_host'                                  => null,
6629
			'jetpack_installed_plugin'                               => 'jetpack_plugin_installed',
6630
			'jetpack_holiday_snow_option_name'                       => null,
6631
			'jetpack_holiday_chance_of_snow'                         => null,
6632
			'jetpack_holiday_snow_js_url'                            => null,
6633
			'jetpack_is_holiday_snow_season'                         => null,
6634
			'jetpack_holiday_snow_option_updated'                    => null,
6635
			'jetpack_holiday_snowing'                                => null,
6636
			'jetpack_sso_auth_cookie_expirtation'                    => 'jetpack_sso_auth_cookie_expiration',
6637
			'jetpack_cache_plans'                                    => null,
6638
			'jetpack_updated_theme'                                  => 'jetpack_updated_themes',
6639
			'jetpack_lazy_images_skip_image_with_atttributes'        => 'jetpack_lazy_images_skip_image_with_attributes',
6640
		);
6641
6642
		// This is a silly loop depth. Better way?
6643
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6644
			if ( has_action( $hook ) ) {
6645
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6646
					foreach( $values AS $hooked ) {
6647
						if ( is_callable( $hooked['function'] ) ) {
6648
							$function_name = 'an anonymous function';
6649
						} else {
6650
							$function_name = $hooked['function'];
6651
						}
6652
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6653
					}
6654
				}
6655
			}
6656
		}
6657
	}
6658
6659
	/**
6660
	 * Converts any url in a stylesheet, to the correct absolute url.
6661
	 *
6662
	 * Considerations:
6663
	 *  - Normal, relative URLs     `feh.png`
6664
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6665
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6666
	 *  - Absolute URLs             `http://domain.com/feh.png`
6667
	 *  - Domain root relative URLs `/feh.png`
6668
	 *
6669
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6670
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6671
	 *
6672
	 * @return mixed|string
6673
	 */
6674
	public static function absolutize_css_urls( $css, $css_file_url ) {
6675
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6676
		$css_dir = dirname( $css_file_url );
6677
		$p       = parse_url( $css_dir );
6678
		$domain  = sprintf(
6679
					'%1$s//%2$s%3$s%4$s',
6680
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6681
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6682
					$p['host'],
6683
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6684
				);
6685
6686
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6687
			$find = $replace = array();
6688
			foreach ( $matches as $match ) {
6689
				$url = trim( $match['path'], "'\" \t" );
6690
6691
				// If this is a data url, we don't want to mess with it.
6692
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6693
					continue;
6694
				}
6695
6696
				// If this is an absolute or protocol-agnostic url,
6697
				// we don't want to mess with it.
6698
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6699
					continue;
6700
				}
6701
6702
				switch ( substr( $url, 0, 1 ) ) {
6703
					case '/':
6704
						$absolute = $domain . $url;
6705
						break;
6706
					default:
6707
						$absolute = $css_dir . '/' . $url;
6708
				}
6709
6710
				$find[]    = $match[0];
6711
				$replace[] = sprintf( 'url("%s")', $absolute );
6712
			}
6713
			$css = str_replace( $find, $replace, $css );
6714
		}
6715
6716
		return $css;
6717
	}
6718
6719
	/**
6720
	 * This methods removes all of the registered css files on the front end
6721
	 * from Jetpack in favor of using a single file. In effect "imploding"
6722
	 * all the files into one file.
6723
	 *
6724
	 * Pros:
6725
	 * - Uses only ONE css asset connection instead of 15
6726
	 * - Saves a minimum of 56k
6727
	 * - Reduces server load
6728
	 * - Reduces time to first painted byte
6729
	 *
6730
	 * Cons:
6731
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6732
	 *		should not cause any issues with themes.
6733
	 * - Plugins/themes dequeuing styles no longer do anything. See
6734
	 *		jetpack_implode_frontend_css filter for a workaround
6735
	 *
6736
	 * For some situations developers may wish to disable css imploding and
6737
	 * instead operate in legacy mode where each file loads seperately and
6738
	 * can be edited individually or dequeued. This can be accomplished with
6739
	 * the following line:
6740
	 *
6741
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6742
	 *
6743
	 * @since 3.2
6744
	 **/
6745
	public function implode_frontend_css( $travis_test = false ) {
6746
		$do_implode = true;
6747
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6748
			$do_implode = false;
6749
		}
6750
6751
		/**
6752
		 * Allow CSS to be concatenated into a single jetpack.css file.
6753
		 *
6754
		 * @since 3.2.0
6755
		 *
6756
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6757
		 */
6758
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6759
6760
		// Do not use the imploded file when default behaviour was altered through the filter
6761
		if ( ! $do_implode ) {
6762
			return;
6763
		}
6764
6765
		// We do not want to use the imploded file in dev mode, or if not connected
6766
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6767
			if ( ! $travis_test ) {
6768
				return;
6769
			}
6770
		}
6771
6772
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6773
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6774
			return;
6775
		}
6776
6777
		/*
6778
		 * Now we assume Jetpack is connected and able to serve the single
6779
		 * file.
6780
		 *
6781
		 * In the future there will be a check here to serve the file locally
6782
		 * or potentially from the Jetpack CDN
6783
		 *
6784
		 * For now:
6785
		 * - Enqueue a single imploded css file
6786
		 * - Zero out the style_loader_tag for the bundled ones
6787
		 * - Be happy, drink scotch
6788
		 */
6789
6790
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6791
6792
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6793
6794
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6795
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6796
	}
6797
6798
	function concat_remove_style_loader_tag( $tag, $handle ) {
6799
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6800
			$tag = '';
6801
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6802
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6803
			}
6804
		}
6805
6806
		return $tag;
6807
	}
6808
6809
	/*
6810
	 * Check the heartbeat data
6811
	 *
6812
	 * Organizes the heartbeat data by severity.  For example, if the site
6813
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6814
	 *
6815
	 * Data will be added to "caution" array, if it either:
6816
	 *  - Out of date Jetpack version
6817
	 *  - Out of date WP version
6818
	 *  - Out of date PHP version
6819
	 *
6820
	 * $return array $filtered_data
6821
	 */
6822
	public static function jetpack_check_heartbeat_data() {
6823
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6824
6825
		$good    = array();
6826
		$caution = array();
6827
		$bad     = array();
6828
6829
		foreach ( $raw_data as $stat => $value ) {
6830
6831
			// Check jetpack version
6832
			if ( 'version' == $stat ) {
6833
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6834
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6835
					continue;
6836
				}
6837
			}
6838
6839
			// Check WP version
6840
			if ( 'wp-version' == $stat ) {
6841
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6842
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6843
					continue;
6844
				}
6845
			}
6846
6847
			// Check PHP version
6848
			if ( 'php-version' == $stat ) {
6849
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6850
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6851
					continue;
6852
				}
6853
			}
6854
6855
			// Check ID crisis
6856
			if ( 'identitycrisis' == $stat ) {
6857
				if ( 'yes' == $value ) {
6858
					$bad[ $stat ] = $value;
6859
					continue;
6860
				}
6861
			}
6862
6863
			// The rest are good :)
6864
			$good[ $stat ] = $value;
6865
		}
6866
6867
		$filtered_data = array(
6868
			'good'    => $good,
6869
			'caution' => $caution,
6870
			'bad'     => $bad
6871
		);
6872
6873
		return $filtered_data;
6874
	}
6875
6876
6877
	/*
6878
	 * This method is used to organize all options that can be reset
6879
	 * without disconnecting Jetpack.
6880
	 *
6881
	 * It is used in class.jetpack-cli.php to reset options
6882
	 *
6883
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6884
	 *
6885
	 * @return array of options to delete.
6886
	 */
6887
	public static function get_jetpack_options_for_reset() {
6888
		return Jetpack_Options::get_options_for_reset();
6889
	}
6890
6891
	/**
6892
	 * Check if an option of a Jetpack module has been updated.
6893
	 *
6894
	 * If any module option has been updated before Jump Start has been dismissed,
6895
	 * update the 'jumpstart' option so we can hide Jump Start.
6896
	 *
6897
	 * @param string $option_name
6898
	 *
6899
	 * @return bool
6900
	 */
6901
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6902
		// Bail if Jump Start has already been dismissed
6903
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6904
			return false;
6905
		}
6906
6907
		$jetpack = Jetpack::init();
6908
6909
		// Manual build of module options
6910
		$option_names = self::get_jetpack_options_for_reset();
6911
6912
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6913
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6914
6915
			//Jump start is being dismissed send data to MC Stats
6916
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6917
6918
			$jetpack->do_stats( 'server_side' );
6919
		}
6920
6921
	}
6922
6923
	/*
6924
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6925
	 * so we can bring them directly to their site in calypso.
6926
	 *
6927
	 * @param string | url
6928
	 * @return string | url without the guff
6929
	 */
6930
	public static function build_raw_urls( $url ) {
6931
		$strip_http = '/.*?:\/\//i';
6932
		$url = preg_replace( $strip_http, '', $url  );
6933
		$url = str_replace( '/', '::', $url );
6934
		return $url;
6935
	}
6936
6937
	/**
6938
	 * Stores and prints out domains to prefetch for page speed optimization.
6939
	 *
6940
	 * @param mixed $new_urls
6941
	 */
6942
	public static function dns_prefetch( $new_urls = null ) {
6943
		static $prefetch_urls = array();
6944
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6945
			echo "\r\n";
6946
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6947
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6948
			}
6949
		} elseif ( ! empty( $new_urls ) ) {
6950
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6951
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6952
			}
6953
			foreach ( (array) $new_urls as $this_new_url ) {
6954
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6955
			}
6956
			$prefetch_urls = array_unique( $prefetch_urls );
6957
		}
6958
	}
6959
6960
	public function wp_dashboard_setup() {
6961
		if ( self::is_active() ) {
6962
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6963
		}
6964
6965
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6966
			wp_add_dashboard_widget(
6967
				'jetpack_summary_widget',
6968
				esc_html__( 'Site Stats', 'jetpack' ),
6969
				array( __CLASS__, 'dashboard_widget' )
6970
			);
6971
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6972
6973
			// If we're inactive and not in development mode, sort our box to the top.
6974
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6975
				global $wp_meta_boxes;
6976
6977
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6978
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6979
6980
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6981
			}
6982
		}
6983
	}
6984
6985
	/**
6986
	 * @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...
6987
	 * @return mixed
6988
	 */
6989
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6990
		if ( ! is_array( $sorted ) ) {
6991
			return $sorted;
6992
		}
6993
6994
		foreach ( $sorted as $box_context => $ids ) {
6995
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6996
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6997
				continue;
6998
			}
6999
7000
			$ids_array = explode( ',', $ids );
7001
			$key = array_search( 'dashboard_stats', $ids_array );
7002
7003
			if ( false !== $key ) {
7004
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7005
				$ids_array[ $key ] = 'jetpack_summary_widget';
7006
				$sorted[ $box_context ] = implode( ',', $ids_array );
7007
				// We've found it, stop searching, and just return.
7008
				break;
7009
			}
7010
		}
7011
7012
		return $sorted;
7013
	}
7014
7015
	public static function dashboard_widget() {
7016
		/**
7017
		 * Fires when the dashboard is loaded.
7018
		 *
7019
		 * @since 3.4.0
7020
		 */
7021
		do_action( 'jetpack_dashboard_widget' );
7022
	}
7023
7024
	public static function dashboard_widget_footer() {
7025
		?>
7026
		<footer>
7027
7028
		<div class="protect">
7029
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
7030
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
7031
				<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>
7032
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
7033
				<a href="<?php echo esc_url( wp_nonce_url( Jetpack::admin_url( array( 'action' => 'activate', 'module' => 'protect' ) ), 'jetpack_activate-protect' ) ); ?>" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7034
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
7035
				</a>
7036
			<?php else : ?>
7037
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
7038
			<?php endif; ?>
7039
		</div>
7040
7041
		<div class="akismet">
7042
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7043
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
7044
				<p><?php echo esc_html_x( 'Spam comments blocked by Akismet.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
7045
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7046
				<a href="<?php echo esc_url( wp_nonce_url( add_query_arg( array( 'action' => 'activate', 'plugin' => 'akismet/akismet.php' ), admin_url( 'plugins.php' ) ), 'activate-plugin_akismet/akismet.php' ) ); ?>" class="button button-jetpack">
7047
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
7048
				</a>
7049
			<?php else : ?>
7050
				<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( 'Akismet can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
7051
			<?php endif; ?>
7052
		</div>
7053
7054
		</footer>
7055
		<?php
7056
	}
7057
7058
	/**
7059
	 * Return string containing the Jetpack logo.
7060
	 *
7061
	 * @since 3.9.0
7062
	 *
7063
	 * @return string
7064
	 */
7065
	public static function get_jp_emblem() {
7066
		return '<svg id="jetpack-logo__icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 32 32"><path fill="#00BE28" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16c8.8,0,16-7.2,16-16S24.8,0,16,0z M15.2,18.7h-8l8-15.5V18.7z M16.8,28.8 V13.3h8L16.8,28.8z"/></svg>';
7067
	}
7068
7069
	/*
7070
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7071
	 */
7072
	function jetpack_icon_user_connected( $columns ) {
7073
		$columns['user_jetpack'] = '';
7074
		return $columns;
7075
	}
7076
7077
	/*
7078
	 * Show Jetpack icon if the user is linked.
7079
	 */
7080
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7081
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
7082
			$emblem_html = sprintf(
7083
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7084
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7085
				Jetpack::get_jp_emblem()
7086
			);
7087
			return $emblem_html;
7088
		}
7089
7090
		return $val;
7091
	}
7092
7093
	/*
7094
	 * Style the Jetpack user column
7095
	 */
7096
	function jetpack_user_col_style() {
7097
		global $current_screen;
7098
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
7099
			<style>
7100
				.fixed .column-user_jetpack {
7101
					width: 21px;
7102
				}
7103
				.jp-emblem-user-admin svg {
7104
					width: 20px;
7105
					height: 20px;
7106
				}
7107
				.jp-emblem-user-admin path {
7108
					fill: #00BE28;
7109
				}
7110
			</style>
7111
		<?php }
7112
	}
7113
7114
	/**
7115
	 * Checks if Akismet is active and working.
7116
	 *
7117
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7118
	 * that implied usage of methods present since more recent version.
7119
	 * See https://github.com/Automattic/jetpack/pull/9585
7120
	 *
7121
	 * @since  5.1.0
7122
	 *
7123
	 * @return bool True = Akismet available. False = Aksimet not available.
7124
	 */
7125
	public static function is_akismet_active() {
7126
		if ( method_exists( 'Akismet' , 'http_post' ) ) {
7127
			$akismet_key = Akismet::get_api_key();
7128
			if ( ! $akismet_key ) {
7129
				return false;
7130
			}
7131
			$cached_key_verification = get_transient( 'jetpack_akismet_key_is_valid' );
7132
7133
			// We cache the result of the Akismet key verification for ten minutes.
7134
			if ( in_array( $cached_key_verification, array( 'valid', 'invalid' ) ) ) {
7135
				$akismet_key_state = $cached_key_verification;
7136
			} else {
7137
				$akismet_key_state = Akismet::verify_key( $akismet_key );
7138
				if ( 'failed' === $akismet_key_state ) {
7139
					return false;
7140
				}
7141
				set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7142
			}
7143
7144
			return ( 'valid' === $akismet_key_state );
7145
		}
7146
		return false;
7147
	}
7148
7149
	/**
7150
	 * Checks if one or more function names is in debug_backtrace
7151
	 *
7152
	 * @param $names Mixed string name of function or array of string names of functions
7153
	 *
7154
	 * @return bool
7155
	 */
7156
	public static function is_function_in_backtrace( $names ) {
7157
		$backtrace = debug_backtrace( false ); // phpcs:ignore PHPCompatibility
7158
		if ( ! is_array( $names ) ) {
7159
			$names = array( $names );
7160
		}
7161
		$names_as_keys = array_flip( $names );
7162
7163
		//Do check in constant O(1) time for PHP5.5+
7164
		if ( function_exists( 'array_column' ) ) {
7165
			$backtrace_functions = array_column( $backtrace, 'function' ); // phpcs:ignore PHPCompatibility
7166
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
7167
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
7168
			return ! empty ( $intersection );
7169
		}
7170
7171
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
7172
		foreach ( $backtrace as $call ) {
7173
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
7174
				return true;
7175
			}
7176
		}
7177
		return false;
7178
	}
7179
7180
	/**
7181
	 * Given a minified path, and a non-minified path, will return
7182
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7183
	 *
7184
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7185
	 * root Jetpack directory.
7186
	 *
7187
	 * @since 5.6.0
7188
	 *
7189
	 * @param string $min_path
7190
	 * @param string $non_min_path
7191
	 * @return string The URL to the file
7192
	 */
7193
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7194
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7195
			? $non_min_path
7196
			: $min_path;
7197
7198
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7199
	}
7200
7201
	/**
7202
	 * Checks for whether Jetpack Rewind is enabled.
7203
	 * Will return true if the state of Rewind is anything except "unavailable".
7204
	 * @return bool|int|mixed
7205
	 */
7206
	public static function is_rewind_enabled() {
7207
		if ( ! Jetpack::is_active() ) {
7208
			return false;
7209
		}
7210
7211
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7212
		if ( false === $rewind_enabled ) {
7213
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7214
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7215
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7216
				&& ! empty( $rewind_data['state'] )
7217
				&& 'active' === $rewind_data['state'] )
7218
				? 1
7219
				: 0;
7220
7221
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7222
		}
7223
		return $rewind_enabled;
7224
	}
7225
7226
	/**
7227
	 * Checks whether or not TOS has been agreed upon.
7228
	 * Will return true if a user has clicked to register, or is already connected.
7229
	 */
7230
	public static function jetpack_tos_agreed() {
7231
		return Jetpack_Options::get_option( 'tos_agreed' ) || Jetpack::is_active();
7232
	}
7233
7234
	/**
7235
	 * Handles activating default modules as well general cleanup for the new connection.
7236
	 *
7237
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7238
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7239
	 * @return void
7240
	 */
7241
	public static function handle_post_authorization_actions( $activate_sso = false, $redirect_on_activation_error = false ) {
7242
		$other_modules = $activate_sso
7243
			? array( 'sso' )
7244
			: array();
7245
7246 View Code Duplication
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7247
			Jetpack::delete_active_modules();
7248
7249
			Jetpack::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, false );
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...
7250
		} else {
7251
			Jetpack::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, false );
7252
		}
7253
7254
		// Since this is a fresh connection, be sure to clear out IDC options
7255
		Jetpack_IDC::clear_all_idc_options();
7256
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7257
7258
		// Start nonce cleaner
7259
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7260
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7261
7262
		Jetpack::state( 'message', 'authorized' );
7263
	}
7264
7265
	/**
7266
<<<<<<< HEAD
7267
	 * Check if Gutenberg editor is available
7268
	 *
7269
	 * @since 6.5.0
7270
	 *
7271
	 * @return bool
7272
	 */
7273
	public static function is_gutenberg_available() {
7274
		return function_exists( 'register_block_type' );
7275
	}
7276
7277
	/**
7278
	 * Load Gutenberg editor blocks.
7279
	 *
7280
	 * This section meant for unstable phase of developing Jetpack's
7281
	 * Gutenberg extensions. If still around after Sep. 15, 2018 then
7282
	 * please file an issue to remove it; if nobody responds within one
7283
	 * week then please delete the code.
7284
	 *
7285
	 *
7286
	 * Loading blocks is disabled by default and enabled via filter:
7287
	 *   add_filter( 'jetpack_gutenberg', '__return_true', 10 );
7288
	 *
7289
	 * When enabled, blocks are loaded from CDN by default. To load locally instead:
7290
	 *   add_filter( 'jetpack_gutenberg_cdn', '__return_false', 10 );
7291
	 *
7292
	 * Note that when loaded locally, you need to build the files yourself:
7293
	 * - _inc/blocks/jetpack-editor.js
7294
	 * - _inc/blocks/jetpack-editor.css
7295
	 *
7296
	 * CDN cache is busted once a day or when Jetpack version changes. To customize it:
7297
	 *   add_filter( 'jetpack_gutenberg_cdn_cache_buster', function( $version ) { return time(); }, 10, 1 );
7298
	 *
7299
	 * @since 6.5.0
7300
	 *
7301
	 * @return void
7302
	 */
7303
	public static function load_jetpack_gutenberg() {
7304
		/**
7305
		 * Filter to turn on loading Gutenberg blocks
7306
		 *
7307
		 * @since 6.5.0
7308
		 *
7309
		 * @param bool false Whether to load Gutenberg blocks
7310
		 */
7311
		if ( ! Jetpack::is_gutenberg_available() || ! apply_filters( 'jetpack_gutenberg', false ) ) {
7312
			return;
7313
		}
7314
7315
		/**
7316
		 * Filter to turn off serving blocks via CDN
7317
		 *
7318
		 * @since 6.5.0
7319
		 *
7320
		 * @param bool true Whether to load Gutenberg blocks from CDN
7321
		 */
7322
		if ( apply_filters( 'jetpack_gutenberg_cdn', true ) ) {
7323
			$editor_script = 'https://s0.wp.com/wp-content/mu-plugins/jetpack/_inc/blocks/jetpack-editor.js';
7324
			$editor_style = 'https://s0.wp.com/wp-content/mu-plugins/jetpack/_inc/blocks/jetpack-editor.css';
7325
7326
			/**
7327
			 * Filter to modify cache busting for Gutenberg block assets loaded from CDN
7328
			 *
7329
			 * @since 6.5.0
7330
			 *
7331
			 * @param string
7332
			 */
7333
			$version = apply_filters( 'jetpack_gutenberg_cdn_cache_buster', sprintf( '%s-%s', gmdate( 'd-m-Y' ), JETPACK__VERSION ) );
7334
		} else {
7335
			$editor_script = plugins_url( '_inc/blocks/jetpack-editor.js', JETPACK__PLUGIN_FILE );
7336
			$editor_style = plugins_url( '_inc/blocks/jetpack-editor.css', JETPACK__PLUGIN_FILE );
7337
			$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . '_inc/blocks/jetpack-editor.js' ) : JETPACK__VERSION;
7338
		}
7339
7340
		wp_register_script(
7341
			'jetpack-blocks-editor',
7342
			$editor_script,
7343
			array(
7344
				'wp-blocks',
7345
				'wp-components',
7346
				'wp-compose',
7347
				'wp-data',
7348
				'wp-editor',
7349
				'wp-element',
7350
				'wp-i18n',
7351
				'wp-plugins',
7352
			),
7353
			$version
7354
		);
7355
7356
		wp_register_style(
7357
			'jetpack-blocks-editor',
7358
			$editor_style,
7359
			array(),
7360
			$version
7361
		);
7362
7363
		register_block_type( 'jetpack/blocks', array(
7364
				'editor_script' => 'jetpack-blocks-editor',
7365
				'editor_style'  => 'jetpack-blocks-editor',
7366
		) );
7367
	}
7368
7369
	/**
7370
	 * Returns a boolean for whether backups UI should be displayed or not.
7371
	 *
7372
	 * @return bool Should backups UI be displayed?
7373
	 */
7374
	public static function show_backups_ui() {
7375
		/**
7376
		 * Whether UI for backups should be displayed.
7377
		 *
7378
		 * @since 6.5.0
7379
		 *
7380
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7381
		 */
7382
		return Jetpack::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7383
	}
7384
}
7385