Completed
Push — add/alternative-xmlrpc-transpo... ( 33fbde )
by
unknown
09:02
created

Jetpack   F

Complexity

Total Complexity 1005

Size/Duplication

Total Lines 6369
Duplicated Lines 3.88 %

Coupling/Cohesion

Components 3
Dependencies 21

Importance

Changes 0
Metric Value
dl 247
loc 6369
rs 0.6314
c 0
b 0
f 0
wmc 1005
lcom 3
cbo 21

218 Methods

Rating   Name   Duplication   Size   Complexity  
C jetpack_jitm_ajax_callback() 18 57 12
A __destruct() 0 5 2
C guess_locale_from_lang() 39 39 12
A get_locale() 0 9 2
A devicepx() 0 5 2
A jetpack_main_network_site_option() 0 3 1
A network_name() 0 4 1
A network_allow_new_registrations() 0 3 2
A network_add_new_users() 0 3 1
A network_site_upload_space() 0 4 2
A network_upload_file_types() 0 3 1
A network_max_upload_file_size() 0 4 1
A network_enable_administration_menus() 0 3 1
C jetpack_custom_caps() 0 66 20
A admin_body_class() 0 8 2
A add_jetpack_pagestyles() 0 3 1
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 init() 0 9 2
B plugin_upgrade() 0 23 5
A activate_manage() 0 7 4
B update_active_modules() 0 54 5
A delete_active_modules() 0 3 1
D __construct() 0 146 16
A rest_verify_registration() 0 5 1
B jetpack_admin_ajax_tracks_callback() 0 19 7
A require_jetpack_authentication() 0 11 2
A plugin_textdomain() 0 4 1
C register_assets() 11 52 8
B maybe_clear_other_linked_admins_transient() 0 8 5
C 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
B 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
B get_active_plan() 20 66 6
A active_plan_supports() 0 9 2
A is_development_mode() 0 20 3
C show_development_mode_notice() 0 40 8
A is_development_version() 0 15 1
A is_user_connected() 0 8 3
B 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 extra_oembed_providers() 0 8 1
A user_role_change() 0 4 1
D load_modules() 6 84 18
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
C check_open_graph() 0 27 7
B 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 create_nonce() 0 14 4
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
C 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
C 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
C get_module() 0 83 10
B get_file_data() 0 21 5
A translate_module_tag() 0 3 1
A get_translated_modules() 0 13 4
B get_active_modules() 0 20 7
D activate_default_modules() 10 117 17
D activate_module() 8 93 16
A activate_module_actions() 0 3 1
B 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 12 3
A do_version_bump() 0 7 2
A plugin_initialize() 6 16 3
A plugin_deactivation() 0 9 2
B disconnect() 0 61 6
B unlink_user() 0 31 5
C try_registration() 0 25 7
B log() 0 40 3
C 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 prepare_manage_jetpack_notice() 0 5 1
A manage_activate_screen() 0 3 1
C 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 3 1
B remote_request_handlers() 0 34 6
F upload_handler() 0 91 20
B admin_help() 0 41 2
A admin_menu_css() 0 3 1
A admin_menu_order() 0 3 1
A jetpack_menu_order() 15 15 4
A admin_head() 3 5 4
A admin_banner_styles() 8 21 4
A plugin_action_links() 0 15 4
B 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
B can_display_jetpack_manage_notice() 0 22 4
F admin_page_load() 25 226 48
D 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_role_to_cap() 0 7 2
A sign_role() 0 12 4
F build_connect_url() 0 84 15
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 debugger_page() 0 8 2
B admin_screen_configure_module() 0 52 4
B 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
C permit_ssl() 0 42 11
A alert_auto_ssl_fail() 0 49 2
A xmlrpc_api_url() 0 4 1
A generate_secrets() 0 8 1
A get_remote_query_timeout_limit() 0 6 2
C validate_remote_register_response() 0 40 13
D register() 5 90 13
A maybe_set_version_option() 0 14 3
A load_xml_rpc_client() 0 4 1
A reset_saved_auth_state() 0 4 1
D verify_xml_rpc_signature() 0 99 24
B authenticate_jetpack() 0 23 6
D wp_rest_authenticate() 0 94 21
A wp_rest_authentication_errors() 0 6 2
B add_nonce() 0 38 3
A xmlrpc_methods() 0 4 1
A public_xmlrpc_methods() 0 6 2
B jetpack_getOptions() 0 40 3
A xmlrpc_options() 0 18 2
A clean_nonces() 0 21 4
C state() 0 50 18
A restate() 0 3 1
B check_privacy() 0 35 6
C xmlrpc_async_call() 0 42 12
B staticize_subdomain() 0 35 4
A login_form_json_api_authorization() 0 9 1
B 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 add_token_to_login_redirect_json_api_authorization() 0 12 1
F verify_json_api_authorization_request() 0 92 21
A login_message_json_api_authorization() 0 6 1
A get_content_width() 0 11 2
D get_avatar_url() 0 28 9
A get_cloud_site_options() 0 16 2
A check_identity_crisis() 0 7 4
C is_staging_site() 0 59 10
C validate_sync_error_idc_option() 0 44 13
A normalize_url_protocol_agnostic() 0 10 2
B get_sync_error_idc_option() 0 24 4
A sync_idc_optin() 0 18 3
C maybe_min_asset() 0 35 7
C maybe_inline_style() 0 50 13
A load_view() 0 11 2
B deprecated_hooks() 0 49 6
D absolutize_css_urls() 0 44 9
C implode_frontend_css() 0 52 9
A concat_remove_style_loader_tag() 0 10 4
C jetpack_check_heartbeat_data() 0 53 10
A get_jetpack_options_for_reset() 0 67 3
A jumpstart_has_updated_module_option() 0 21 3
A build_raw_urls() 0 6 1
B dns_prefetch() 0 17 7
C wp_dashboard_setup() 0 28 7
B get_user_option_meta_box_order_dashboard() 0 25 5
A dashboard_widget() 0 8 1
C dashboard_widget_footer() 0 33 7
B dashboard_widget_connect_to_wpcom() 0 22 4
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

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
class Jetpack {
26
	public $xmlrpc_server = null;
27
28
	private $xmlrpc_verification = null;
29
	private $rest_authentication_status = null;
30
31
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
32
33
	/**
34
	 * @var array The handles of styles that are concatenated into jetpack.css
35
	 */
36
	public $concatenated_style_handles = array(
37
		'jetpack-carousel',
38
		'grunion.css',
39
		'the-neverending-homepage',
40
		'jetpack_likes',
41
		'jetpack_related-posts',
42
		'sharedaddy',
43
		'jetpack-slideshow',
44
		'presentations',
45
		'jetpack-subscriptions',
46
		'jetpack-responsive-videos-style',
47
		'jetpack-social-menu',
48
		'tiled-gallery',
49
		'jetpack_display_posts_widget',
50
		'gravatar-profile-widget',
51
		'goodreads-widget',
52
		'jetpack_social_media_icons_widget',
53
		'jetpack-top-posts-widget',
54
		'jetpack_image_widget',
55
		'jetpack-my-community-widget',
56
		'wordads',
57
	);
58
59
	public $plugins_to_deactivate = array(
60
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
61
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
62
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
63
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
64
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
65
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
66
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
67
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
68
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
69
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
70
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
71
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
72
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
73
		'omnisearch'          => array( 'jetpack-omnisearch/omnisearch.php', 'Jetpack Omnisearch' ),
74
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
75
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
76
	);
77
78
	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...
79
		'administrator' => 'manage_options',
80
		'editor'        => 'edit_others_posts',
81
		'author'        => 'publish_posts',
82
		'contributor'   => 'edit_posts',
83
		'subscriber'    => 'read',
84
	);
85
86
	/**
87
	 * Map of modules that have conflicts with plugins and should not be auto-activated
88
	 * if the plugins are active.  Used by filter_default_modules
89
	 *
90
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
91
	 * change `module-slug` and add this to your plugin:
92
	 *
93
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
94
	 * function my_jetpack_get_default_modules( $modules ) {
95
	 *     return array_diff( $modules, array( 'module-slug' ) );
96
	 * }
97
	 *
98
	 * @var array
99
	 */
100
	private $conflicting_plugins = array(
101
		'comments'          => array(
102
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
103
			'Disqus'                               => 'disqus-comment-system/disqus.php',
104
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
105
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
106
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
107
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
108
		),
109
		'contact-form'      => array(
110
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
111
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
112
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
113
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
114
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
115
		),
116
		'minileven'         => array(
117
			'WPtouch'                              => 'wptouch/wptouch.php',
118
		),
119
		'latex'             => array(
120
			'LaTeX for WordPress'                  => 'latex/latex.php',
121
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
122
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
123
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
124
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
125
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
126
		),
127
		'protect'           => array(
128
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
129
			'Captcha'                              => 'captcha/captcha.php',
130
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
131
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
132
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
133
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
134
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
135
			'Security-protection'                  => 'security-protection/security-protection.php',
136
			'Login Security'                       => 'login-security/login-security.php',
137
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
138
			'Wordfence Security'                   => 'wordfence/wordfence.php',
139
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
140
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
141
		),
142
		'random-redirect'   => array(
143
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
144
		),
145
		'related-posts'     => array(
146
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
147
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
148
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
149
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
150
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
151
			'outbrain'                             => 'outbrain/outbrain.php',
152
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
153
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
154
		),
155
		'sharedaddy'        => array(
156
			'AddThis'                              => 'addthis/addthis_social_widget.php',
157
			'Add To Any'                           => 'add-to-any/add-to-any.php',
158
			'ShareThis'                            => 'share-this/sharethis.php',
159
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
160
		),
161
		'seo-tools' => array(
162
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
163
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
164
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
165
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
166
		),
167
		'verification-tools' => array(
168
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
169
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
170
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
171
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
172
		),
173
		'widget-visibility' => array(
174
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
175
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
176
		),
177
		'sitemaps' => array(
178
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
179
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
180
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
181
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
182
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
183
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
184
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
185
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
186
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
187
			'Sitemap'                              => 'sitemap/sitemap.php',
188
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
189
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
190
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
191
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
192
		),
193
	);
194
195
	/**
196
	 * Plugins for which we turn off our Facebook OG Tags implementation.
197
	 *
198
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
199
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
200
	 *
201
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
202
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
203
	 */
204
	private $open_graph_conflicting_plugins = array(
205
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
206
		                                                         // 2 Click Social Media Buttons
207
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
208
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
209
		'autodescription/autodescription.php',                   // The SEO Framework
210
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
211
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
212
		                                                         // Open Graph Meta Tags by Heateor
213
		'facebook/facebook.php',                                 // Facebook (official plugin)
214
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
215
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
216
		                                                         // Facebook Featured Image & OG Meta Tags
217
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
218
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
219
		                                                         // Facebook Open Graph Meta Tags for WordPress
220
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
221
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
222
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
223
		                                                         // Fedmich's Facebook Open Graph Meta
224
		'header-footer/plugin.php',                              // Header and Footer
225
		'network-publisher/networkpub.php',                      // Network Publisher
226
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
227
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
228
		                                                         // NextScripts SNAP
229
		'og-tags/og-tags.php',                                   // OG Tags
230
		'opengraph/opengraph.php',                               // Open Graph
231
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
232
		                                                         // Open Graph Protocol Framework
233
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
234
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
235
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
236
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
237
		'sharepress/sharepress.php',                             // SharePress
238
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
239
		'social-discussions/social-discussions.php',             // Social Discussions
240
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
241
		'socialize/socialize.php',                               // Socialize
242
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
243
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
244
		                                                         // Tweet, Like, Google +1 and Share
245
		'wordbooker/wordbooker.php',                             // Wordbooker
246
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
247
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
248
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
249
		                                                         // WP Facebook Like Send & Open Graph Meta
250
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
251
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
252
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
253
		'wp-fb-share-like-button/wp_fb_share-like_widget.php'    // WP Facebook Like Button
254
	);
255
256
	/**
257
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
258
	 */
259
	private $twitter_cards_conflicting_plugins = array(
260
	//	'twitter/twitter.php',                       // The official one handles this on its own.
261
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
262
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
263
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
264
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
265
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
266
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
267
		'twitter-cards/twitter-cards.php',           // Twitter Cards
268
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
269
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
270
	);
271
272
	/**
273
	 * Message to display in admin_notice
274
	 * @var string
275
	 */
276
	public $message = '';
277
278
	/**
279
	 * Error to display in admin_notice
280
	 * @var string
281
	 */
282
	public $error = '';
283
284
	/**
285
	 * Modules that need more privacy description.
286
	 * @var string
287
	 */
288
	public $privacy_checks = '';
289
290
	/**
291
	 * Stats to record once the page loads
292
	 *
293
	 * @var array
294
	 */
295
	public $stats = array();
296
297
	/**
298
	 * Jetpack_Sync object
299
	 */
300
	public $sync;
301
302
	/**
303
	 * Verified data for JSON authorization request
304
	 */
305
	public $json_api_authorization_request = array();
306
307
	/**
308
	 * Holds the singleton instance of this class
309
	 * @since 2.3.3
310
	 * @var Jetpack
311
	 */
312
	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...
313
314
	/**
315
	 * Singleton
316
	 * @static
317
	 */
318
	public static function init() {
319
		if ( ! self::$instance ) {
320
			self::$instance = new Jetpack;
321
322
			self::$instance->plugin_upgrade();
323
		}
324
325
		return self::$instance;
326
	}
327
328
	/**
329
	 * Must never be called statically
330
	 */
331
	function plugin_upgrade() {
332
		if ( Jetpack::is_active() ) {
333
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
334
			if ( JETPACK__VERSION != $version ) {
335
336
				// Check which active modules actually exist and remove others from active_modules list
337
				$unfiltered_modules = Jetpack::get_active_modules();
338
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
339
				if ( array_diff( $unfiltered_modules, $modules ) ) {
340
					Jetpack::update_active_modules( $modules );
341
				}
342
343
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
344
345
				// Upgrade to 4.3.0
346
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
347
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
348
				}
349
350
				Jetpack::maybe_set_version_option();
351
			}
352
		}
353
	}
354
355
	static function activate_manage( ) {
356
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
357
			self::activate_module( 'manage', false, false );
358
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
359
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
360
		}
361
	}
362
363
	static function update_active_modules( $modules ) {
364
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
365
366
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
367
368
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
369
			$new_active_modules = array_diff( $modules, $current_modules );
370
			foreach( $new_active_modules as $module ) {
371
				/**
372
				 * Fires when a specific module is activated.
373
				 *
374
				 * @since 1.9.0
375
				 *
376
				 * @param string $module Module slug.
377
				 * @param boolean $success whether the module was activated. @since 4.2
378
				 */
379
				do_action( 'jetpack_activate_module', $module, $success );
380
381
				/**
382
				 * Fires when a module is activated.
383
				 * The dynamic part of the filter, $module, is the module slug.
384
				 *
385
				 * @since 1.9.0
386
				 *
387
				 * @param string $module Module slug.
388
				 */
389
				do_action( "jetpack_activate_module_$module", $module );
390
			}
391
392
			$new_deactive_modules = array_diff( $current_modules, $modules );
393
			foreach( $new_deactive_modules as $module ) {
394
				/**
395
				 * Fired after a module has been deactivated.
396
				 *
397
				 * @since 4.2.0
398
				 *
399
				 * @param string $module Module slug.
400
				 * @param boolean $success whether the module was deactivated.
401
				 */
402
				do_action( 'jetpack_deactivate_module', $module, $success );
403
				/**
404
				 * Fires when a module is deactivated.
405
				 * The dynamic part of the filter, $module, is the module slug.
406
				 *
407
				 * @since 1.9.0
408
				 *
409
				 * @param string $module Module slug.
410
				 */
411
				do_action( "jetpack_deactivate_module_$module", $module );
412
			}
413
		}
414
415
		return $success;
416
	}
417
418
	static function delete_active_modules() {
419
		self::update_active_modules( array() );
420
	}
421
422
	/**
423
	 * Constructor.  Initializes WordPress hooks
424
	 */
425
	private function __construct() {
426
		/*
427
		 * Check for and alert any deprecated hooks
428
		 */
429
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
430
431
432
		/*
433
		 * Load things that should only be in Network Admin.
434
		 *
435
		 * For now blow away everything else until a more full
436
		 * understanding of what is needed at the network level is
437
		 * available
438
		 */
439
		if( is_multisite() ) {
440
			Jetpack_Network::init();
441
		}
442
443
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
444
445
		// Unlink user before deleting the user from .com
446
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
447
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
448
449
		// define a few REST endpoints for getting through the connection process
450
		// without XMLRPC
451
		add_action( 'rest_api_init', function () {
452
			register_rest_route( 'jetpack/v1', '/verify_registration', array(
453
				'methods' => 'POST',
454
				'callback' => array( $this, 'rest_verify_registration' ),
455
			) );
456
		} );
457
458
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
459
			@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...
460
461
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
462
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
463
464
			$this->require_jetpack_authentication();
465
466
			if ( Jetpack::is_active() ) {
467
				// Hack to preserve $HTTP_RAW_POST_DATA
468
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
469
470
				$signed = $this->verify_xml_rpc_signature();
471
				if ( $signed && ! is_wp_error( $signed ) ) {
472
					// The actual API methods.
473
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
474
				} else {
475
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
476
					// active Jetpack connection, so that additional users can link their account.
477
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
478
				}
479
			} else {
480
				// The bootstrap API methods.
481
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
482
			}
483
484
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
485
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
486
		} elseif ( is_admin() && isset( $_POST['action'] ) && 'jetpack_upload_file' == $_POST['action'] ) {
487
			$this->require_jetpack_authentication();
488
			$this->add_remote_request_handlers();
489
		} else {
490
			if ( Jetpack::is_active() ) {
491
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
492
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
493
			}
494
		}
495
496
		if ( Jetpack::is_active() ) {
497
			Jetpack_Heartbeat::init();
498
		}
499
500
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
501
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
502
503
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
504
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
505
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
506
		}
507
508
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
509
510
		add_action( 'admin_init', array( $this, 'admin_init' ) );
511
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
512
513
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
514
515
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
516
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
517
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
518
519
		// returns HTTPS support status
520
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
521
522
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
523
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
524
525
		// JITM AJAX callback function
526
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
527
528
		// Universal ajax callback for all tracking events triggered via js
529
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
530
531
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
532
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
533
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
534
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
535
536
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
537
538
		/**
539
		 * These actions run checks to load additional files.
540
		 * They check for external files or plugins, so they need to run as late as possible.
541
		 */
542
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
543
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
544
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
545
546
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
547
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
548
549
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
550
551
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
552
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
553
554
		// A filter to control all just in time messages
555
		add_filter( 'jetpack_just_in_time_msgs', '__return_true' );
556
557
		// Update the Jetpack plan from API on heartbeats
558
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
559
560
		/**
561
		 * This is the hack to concatinate all css files into one.
562
		 * For description and reasoning see the implode_frontend_css method
563
		 *
564
		 * Super late priority so we catch all the registered styles
565
		 */
566
		if( !is_admin() ) {
567
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
568
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
569
		}
570
	}
571
572
	function rest_verify_registration( $request ) {
573
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
574
		$xmlrpc_server = new Jetpack_XMLRPC_Server();
575
		return $xmlrpc_server->verify_registration( array( $request['secret_1'], $request['state'] ) );
576
	}
577
578
	function jetpack_admin_ajax_tracks_callback() {
579
		// Check for nonce
580
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
581
			wp_die( 'Permissions check failed.' );
582
		}
583
584
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
585
			wp_die( 'No valid event name or type.' );
586
		}
587
588
		$tracks_data = array();
589
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
590
			$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
591
		}
592
593
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
594
		wp_send_json_success();
595
		wp_die();
596
	}
597
598
	/**
599
	 * The callback for the JITM ajax requests.
600
	 */
601
	function jetpack_jitm_ajax_callback() {
602
		// Check for nonce
603
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
604
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
605
		}
606
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
607
			$module_slug = $_REQUEST['jitmModule'];
608
			Jetpack::log( 'activate', $module_slug );
609
			Jetpack::activate_module( $module_slug, false, false );
610
			Jetpack::state( 'message', 'no_message' );
611
612
			//A Jetpack module is being activated through a JITM, track it
613
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
614
			$this->do_stats( 'server_side' );
615
616
			wp_send_json_success();
617
		}
618
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
619
			// get the hide_jitm options array
620
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
621
			$module_slug = $_REQUEST['jitmModule'];
622
623
			if( ! $jetpack_hide_jitm ) {
624
				$jetpack_hide_jitm = array(
625
					$module_slug => 'hide'
626
				);
627
			} else {
628
				$jetpack_hide_jitm[$module_slug] = 'hide';
629
			}
630
631
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
632
633
			//jitm is being dismissed forever, track it
634
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
635
			$this->do_stats( 'server_side' );
636
637
			wp_send_json_success();
638
		}
639 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
640
			$module_slug = $_REQUEST['jitmModule'];
641
642
			// User went to WordPress.com, track this
643
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
644
			$this->do_stats( 'server_side' );
645
646
			wp_send_json_success();
647
		}
648 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
649
			$track = $_REQUEST['jitmModule'];
650
651
			// User is viewing JITM, track it.
652
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
653
			$this->do_stats( 'server_side' );
654
655
			wp_send_json_success();
656
		}
657
	}
658
659
	/**
660
	 * If there are any stats that need to be pushed, but haven't been, push them now.
661
	 */
662
	function __destruct() {
663
		if ( ! empty( $this->stats ) ) {
664
			$this->do_stats( 'server_side' );
665
		}
666
	}
667
668
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
0 ignored issues
show
Unused Code introduced by
The parameter $user_id is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $args is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
669
		switch( $cap ) {
670
			case 'jetpack_connect' :
671
			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...
672
				if ( Jetpack::is_development_mode() ) {
673
					$caps = array( 'do_not_allow' );
674
					break;
675
				}
676
				/**
677
				 * Pass through. If it's not development mode, these should match disconnect.
678
				 * Let users disconnect if it's development mode, just in case things glitch.
679
				 */
680
			case 'jetpack_disconnect' :
681
				/**
682
				 * In multisite, can individual site admins manage their own connection?
683
				 *
684
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
685
				 */
686
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
687
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
688
						/**
689
						 * We need to update the option name -- it's terribly unclear which
690
						 * direction the override goes.
691
						 *
692
						 * @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...
693
						 */
694
						$caps = array( 'do_not_allow' );
695
						break;
696
					}
697
				}
698
699
				$caps = array( 'manage_options' );
700
				break;
701
			case 'jetpack_manage_modules' :
702
			case 'jetpack_activate_modules' :
703
			case 'jetpack_deactivate_modules' :
704
				$caps = array( 'manage_options' );
705
				break;
706
			case 'jetpack_configure_modules' :
707
				$caps = array( 'manage_options' );
708
				break;
709
			case 'jetpack_network_admin_page':
710
			case 'jetpack_network_settings_page':
711
				$caps = array( 'manage_network_plugins' );
712
				break;
713
			case 'jetpack_network_sites_page':
714
				$caps = array( 'manage_sites' );
715
				break;
716
			case 'jetpack_admin_page' :
717
				if ( Jetpack::is_development_mode() ) {
718
					$caps = array( 'manage_options' );
719
					break;
720
				} else {
721
					$caps = array( 'read' );
722
				}
723
				break;
724
			case 'jetpack_connect_user' :
725
				if ( Jetpack::is_development_mode() ) {
726
					$caps = array( 'do_not_allow' );
727
					break;
728
				}
729
				$caps = array( 'read' );
730
				break;
731
		}
732
		return $caps;
733
	}
734
735
	function require_jetpack_authentication() {
736
		// Don't let anyone authenticate
737
		$_COOKIE = array();
738
		remove_all_filters( 'authenticate' );
739
		remove_all_actions( 'wp_login_failed' );
740
741
		if ( Jetpack::is_active() ) {
742
			// Allow Jetpack authentication
743
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
744
		}
745
	}
746
747
	/**
748
	 * Load language files
749
	 * @action plugins_loaded
750
	 */
751
	public static function plugin_textdomain() {
752
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
753
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
754
	}
755
756
	/**
757
	 * Register assets for use in various modules and the Jetpack admin page.
758
	 *
759
	 * @uses wp_script_is, wp_register_script, plugins_url
760
	 * @action wp_loaded
761
	 * @return null
762
	 */
763
	public function register_assets() {
764
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
765
			wp_register_script( 'spin', plugins_url( '_inc/spin.js', JETPACK__PLUGIN_FILE ), false, '1.3' );
766
		}
767
768 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
769
			wp_register_script( 'jquery.spin', plugins_url( '_inc/jquery.spin.js', JETPACK__PLUGIN_FILE ) , array( 'jquery', 'spin' ), '1.3' );
770
		}
771
772 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
773
			wp_register_script( 'jetpack-gallery-settings', plugins_url( '_inc/gallery-settings.js', JETPACK__PLUGIN_FILE ), array( 'media-views' ), '20121225' );
774
		}
775
776 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
777
			wp_register_script( 'jetpack-twitter-timeline', plugins_url( '_inc/twitter-timeline.js', JETPACK__PLUGIN_FILE ) , array( 'jquery' ), '4.0.0', true );
778
		}
779
780
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
781
			wp_register_script( 'jetpack-facebook-embed', plugins_url( '_inc/facebook-embed.js', __FILE__ ), array( 'jquery' ), null, true );
782
783
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
784
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
785
			if ( ! is_numeric( $fb_app_id ) ) {
786
				$fb_app_id = '';
787
			}
788
			wp_localize_script(
789
				'jetpack-facebook-embed',
790
				'jpfbembed',
791
				array(
792
					'appid' => $fb_app_id,
793
					'locale' => $this->get_locale(),
794
				)
795
			);
796
		}
797
798
		/**
799
		 * As jetpack_register_genericons is by default fired off a hook,
800
		 * the hook may have already fired by this point.
801
		 * So, let's just trigger it manually.
802
		 */
803
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
804
		jetpack_register_genericons();
805
806
		/**
807
		 * Register the social logos
808
		 */
809
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
810
		jetpack_register_social_logos();
811
812 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
813
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
814
	}
815
816
	/**
817
	 * Guess locale from language code.
818
	 *
819
	 * @param string $lang Language code.
820
	 * @return string|bool
821
	 */
822 View Code Duplication
	function guess_locale_from_lang( $lang ) {
823
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
824
			return 'en_US';
825
		}
826
827
		if ( ! class_exists( 'GP_Locales' ) ) {
828
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
829
				return false;
830
			}
831
832
			require JETPACK__GLOTPRESS_LOCALES_PATH;
833
		}
834
835
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
836
			// WP.com: get_locale() returns 'it'
837
			$locale = GP_Locales::by_slug( $lang );
838
		} else {
839
			// Jetpack: get_locale() returns 'it_IT';
840
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
841
		}
842
843
		if ( ! $locale ) {
844
			return false;
845
		}
846
847
		if ( empty( $locale->facebook_locale ) ) {
848
			if ( empty( $locale->wp_locale ) ) {
849
				return false;
850
			} else {
851
				// Facebook SDK is smart enough to fall back to en_US if a
852
				// locale isn't supported. Since supported Facebook locales
853
				// can fall out of sync, we'll attempt to use the known
854
				// wp_locale value and rely on said fallback.
855
				return $locale->wp_locale;
856
			}
857
		}
858
859
		return $locale->facebook_locale;
860
	}
861
862
	/**
863
	 * Get the locale.
864
	 *
865
	 * @return string|bool
866
	 */
867
	function get_locale() {
868
		$locale = $this->guess_locale_from_lang( get_locale() );
869
870
		if ( ! $locale ) {
871
			$locale = 'en_US';
872
		}
873
874
		return $locale;
875
	}
876
877
	/**
878
	 * Device Pixels support
879
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
880
	 */
881
	function devicepx() {
882
		if ( Jetpack::is_active() ) {
883
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
884
		}
885
	}
886
887
	/**
888
	 * Return the network_site_url so that .com knows what network this site is a part of.
889
	 * @param  bool $option
890
	 * @return string
891
	 */
892
	public function jetpack_main_network_site_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
893
		return network_site_url();
894
	}
895
	/**
896
	 * Network Name.
897
	 */
898
	static function network_name( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
899
		global $current_site;
900
		return $current_site->site_name;
901
	}
902
	/**
903
	 * Does the network allow new user and site registrations.
904
	 * @return string
905
	 */
906
	static function network_allow_new_registrations( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
907
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
908
	}
909
	/**
910
	 * Does the network allow admins to add new users.
911
	 * @return boolian
912
	 */
913
	static function network_add_new_users( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
914
		return (bool) get_site_option( 'add_new_users' );
915
	}
916
	/**
917
	 * File upload psace left per site in MB.
918
	 *  -1 means NO LIMIT.
919
	 * @return number
920
	 */
921
	static function network_site_upload_space( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
922
		// value in MB
923
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
924
	}
925
926
	/**
927
	 * Network allowed file types.
928
	 * @return string
929
	 */
930
	static function network_upload_file_types( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
931
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
932
	}
933
934
	/**
935
	 * Maximum file upload size set by the network.
936
	 * @return number
937
	 */
938
	static function network_max_upload_file_size( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
939
		// value in KB
940
		return get_site_option( 'fileupload_maxk', 300 );
941
	}
942
943
	/**
944
	 * Lets us know if a site allows admins to manage the network.
945
	 * @return array
946
	 */
947
	static function network_enable_administration_menus( $option = null ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
948
		return get_site_option( 'menu_items' );
949
	}
950
951
	/**
952
	 * If a user has been promoted to or demoted from admin, we need to clear the
953
	 * jetpack_other_linked_admins transient.
954
	 *
955
	 * @since 4.3.2
956
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
957
	 *
958
	 * @param int    $user_id   The user ID whose role changed.
959
	 * @param string $role      The new role.
960
	 * @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...
961
	 */
962
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
963
		if ( 'administrator' == $role
964
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
965
			|| is_null( $old_roles )
966
		) {
967
			delete_transient( 'jetpack_other_linked_admins' );
968
		}
969
	}
970
971
	/**
972
	 * Checks to see if there are any other users available to become primary
973
	 * Users must both:
974
	 * - Be linked to wpcom
975
	 * - Be an admin
976
	 *
977
	 * @return mixed False if no other users are linked, Int if there are.
978
	 */
979
	static function get_other_linked_admins() {
980
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
981
982
		if ( false === $other_linked_users ) {
983
			$admins = get_users( array( 'role' => 'administrator' ) );
984
			if ( count( $admins ) > 1 ) {
985
				$available = array();
986
				foreach ( $admins as $admin ) {
987
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
988
						$available[] = $admin->ID;
989
					}
990
				}
991
992
				$count_connected_admins = count( $available );
993
				if ( count( $available ) > 1 ) {
994
					$other_linked_users = $count_connected_admins;
995
				} else {
996
					$other_linked_users = 0;
997
				}
998
			} else {
999
				$other_linked_users = 0;
1000
			}
1001
1002
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1003
		}
1004
1005
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1006
	}
1007
1008
	/**
1009
	 * Return whether we are dealing with a multi network setup or not.
1010
	 * The reason we are type casting this is because we want to avoid the situation where
1011
	 * the result is false since when is_main_network_option return false it cases
1012
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1013
	 * database which could be set to anything as opposed to what this function returns.
1014
	 * @param  bool  $option
1015
	 *
1016
	 * @return boolean
1017
	 */
1018
	public function is_main_network_option( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1019
		// return '1' or ''
1020
		return (string) (bool) Jetpack::is_multi_network();
1021
	}
1022
1023
	/**
1024
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1025
	 *
1026
	 * @param  string  $option
1027
	 * @return boolean
1028
	 */
1029
	public function is_multisite( $option ) {
0 ignored issues
show
Unused Code introduced by
The parameter $option is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1030
		return (string) (bool) is_multisite();
1031
	}
1032
1033
	/**
1034
	 * Implemented since there is no core is multi network function
1035
	 * Right now there is no way to tell if we which network is the dominant network on the system
1036
	 *
1037
	 * @since  3.3
1038
	 * @return boolean
1039
	 */
1040
	public static function is_multi_network() {
1041
		global  $wpdb;
1042
1043
		// if we don't have a multi site setup no need to do any more
1044
		if ( ! is_multisite() ) {
1045
			return false;
1046
		}
1047
1048
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1049
		if ( $num_sites > 1 ) {
1050
			return true;
1051
		} else {
1052
			return false;
1053
		}
1054
	}
1055
1056
	/**
1057
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1058
	 * @return null
1059
	 */
1060
	function update_jetpack_main_network_site_option() {
1061
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1062
	}
1063
	/**
1064
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1065
	 *
1066
	 */
1067
	function update_jetpack_network_settings() {
1068
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1069
		// Only sync this info for the main network site.
1070
	}
1071
1072
	/**
1073
	 * Get back if the current site is single user site.
1074
	 *
1075
	 * @return bool
1076
	 */
1077
	public static function is_single_user_site() {
1078
		global $wpdb;
1079
1080 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1081
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1082
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1083
		}
1084
		return 1 === (int) $some_users;
1085
	}
1086
1087
	/**
1088
	 * Returns true if the site has file write access false otherwise.
1089
	 * @return string ( '1' | '0' )
1090
	 **/
1091
	public static function file_system_write_access() {
1092
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1093
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1094
		}
1095
1096
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1097
1098
		$filesystem_method = get_filesystem_method();
1099
		if ( $filesystem_method === 'direct' ) {
1100
			return 1;
1101
		}
1102
1103
		ob_start();
1104
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1105
		ob_end_clean();
1106
		if ( $filesystem_credentials_are_stored ) {
1107
			return 1;
1108
		}
1109
		return 0;
1110
	}
1111
1112
	/**
1113
	 * Finds out if a site is using a version control system.
1114
	 * @return string ( '1' | '0' )
1115
	 **/
1116
	public static function is_version_controlled() {
1117
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1118
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1119
	}
1120
1121
	/**
1122
	 * Determines whether the current theme supports featured images or not.
1123
	 * @return string ( '1' | '0' )
1124
	 */
1125
	public static function featured_images_enabled() {
1126
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1127
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1128
	}
1129
1130
	/**
1131
	 * jetpack_updates is saved in the following schema:
1132
	 *
1133
	 * array (
1134
	 *      'plugins'                       => (int) Number of plugin updates available.
1135
	 *      'themes'                        => (int) Number of theme updates available.
1136
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1137
	 *      'translations'                  => (int) Number of translation updates available.
1138
	 *      'total'                         => (int) Total of all available updates.
1139
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1140
	 * )
1141
	 * @return array
1142
	 */
1143
	public static function get_updates() {
1144
		$update_data = wp_get_update_data();
1145
1146
		// Stores the individual update counts as well as the total count.
1147
		if ( isset( $update_data['counts'] ) ) {
1148
			$updates = $update_data['counts'];
1149
		}
1150
1151
		// If we need to update WordPress core, let's find the latest version number.
1152 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1153
			$cur = get_preferred_from_update_core();
1154
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1155
				$updates['wp_update_version'] = $cur->current;
1156
			}
1157
		}
1158
		return isset( $updates ) ? $updates : array();
1159
	}
1160
1161
	public static function get_update_details() {
1162
		$update_details = array(
1163
			'update_core' => get_site_transient( 'update_core' ),
1164
			'update_plugins' => get_site_transient( 'update_plugins' ),
1165
			'update_themes' => get_site_transient( 'update_themes' ),
1166
		);
1167
		return $update_details;
1168
	}
1169
1170
	public static function refresh_update_data() {
1171
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1172
1173
	}
1174
1175
	public static function refresh_theme_data() {
1176
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1177
	}
1178
1179
	/**
1180
	 * Is Jetpack active?
1181
	 */
1182
	public static function is_active() {
1183
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1184
	}
1185
1186
	/**
1187
	 * Make an API call to WordPress.com for plan status
1188
	 *
1189
	 * @uses Jetpack_Options::get_option()
1190
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1191
	 * @uses update_option()
1192
	 *
1193
	 * @access public
1194
	 * @static
1195
	 *
1196
	 * @return bool True if plan is updated, false if no update
1197
	 */
1198
	public static function refresh_active_plan_from_wpcom() {
1199
		// Make the API request
1200
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1201
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1202
1203
		// Bail if there was an error or malformed response
1204
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1205
			return false;
1206
		}
1207
1208
		// Decode the results
1209
		$results = json_decode( $response['body'], true );
1210
1211
		// Bail if there were no results or plan details returned
1212
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1213
			return false;
1214
		}
1215
1216
		// Store the option and return true if updated
1217
		return update_option( 'jetpack_active_plan', $results['plan'] );
1218
	}
1219
1220
	/**
1221
	 * Get the plan that this Jetpack site is currently using
1222
	 *
1223
	 * @uses get_option()
1224
	 *
1225
	 * @access public
1226
	 * @static
1227
	 *
1228
	 * @return array Active Jetpack plan details
1229
	 */
1230
	public static function get_active_plan() {
1231
		$plan = get_option( 'jetpack_active_plan' );
1232
1233
		// Set the default options
1234
		if ( ! $plan ) {
1235
			$plan = array(
1236
				'product_slug' => 'jetpack_free',
1237
				'supports'     => array(),
1238
				'class'        => 'free',
1239
			);
1240
		}
1241
1242
		// Define what paid modules are supported by personal plans
1243
		$personal_plans = array(
1244
			'jetpack_personal',
1245
			'jetpack_personal_monthly',
1246
		);
1247
1248
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1249
			$plan['supports'] = array(
1250
				'akismet',
1251
			);
1252
			$plan['class'] = 'personal';
1253
		}
1254
1255
		// Define what paid modules are supported by premium plans
1256
		$premium_plans = array(
1257
			'jetpack_premium',
1258
			'jetpack_premium_monthly',
1259
		);
1260
1261 View Code Duplication
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1262
			$plan['supports'] = array(
1263
				'videopress',
1264
				'akismet',
1265
				'vaultpress',
1266
				'wordads',
1267
			);
1268
			$plan['class'] = 'premium';
1269
		}
1270
1271
		// Define what paid modules are supported by professional plans
1272
		$business_plans = array(
1273
			'jetpack_business',
1274
			'jetpack_business_monthly',
1275
		);
1276
1277 View Code Duplication
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1278
			$plan['supports'] = array(
1279
				'videopress',
1280
				'akismet',
1281
				'vaultpress',
1282
				'seo-tools',
1283
				'google-analytics',
1284
				'wordads',
1285
			);
1286
			$plan['class'] = 'business';
1287
		}
1288
1289
		// Make sure we have an array here in the event database data is stale
1290
		if ( ! isset( $plan['supports'] ) ) {
1291
			$plan['supports'] = array();
1292
		}
1293
1294
		return $plan;
1295
	}
1296
1297
	/**
1298
	 * Determine whether the active plan supports a particular feature
1299
	 *
1300
	 * @uses Jetpack::get_active_plan()
1301
	 *
1302
	 * @access public
1303
	 * @static
1304
	 *
1305
	 * @return bool True if plan supports feature, false if not
1306
	 */
1307
	public static function active_plan_supports( $feature ) {
1308
		$plan = Jetpack::get_active_plan();
1309
1310
		if ( in_array( $feature, $plan['supports'] ) ) {
1311
			return true;
1312
		}
1313
1314
		return false;
1315
	}
1316
1317
	/**
1318
	 * Is Jetpack in development (offline) mode?
1319
	 */
1320
	public static function is_development_mode() {
1321
		$development_mode = false;
1322
1323
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1324
			$development_mode = JETPACK_DEV_DEBUG;
1325
		} elseif ( $site_url = site_url() ) {
1326
			$development_mode = false === strpos( $site_url, '.' );
1327
		}
1328
1329
		/**
1330
		 * Filters Jetpack's development mode.
1331
		 *
1332
		 * @see https://jetpack.com/support/development-mode/
1333
		 *
1334
		 * @since 2.2.1
1335
		 *
1336
		 * @param bool $development_mode Is Jetpack's development mode active.
1337
		 */
1338
		return apply_filters( 'jetpack_development_mode', $development_mode );
1339
	}
1340
1341
	/**
1342
	* Get Jetpack development mode notice text and notice class.
1343
	*
1344
	* Mirrors the checks made in Jetpack::is_development_mode
1345
	*
1346
	*/
1347
	public static function show_development_mode_notice() {
1348
		if ( Jetpack::is_development_mode() ) {
1349
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1350
				$notice = sprintf(
1351
					/* translators: %s is a URL */
1352
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1353
					'https://jetpack.com/support/development-mode/'
1354
				);
1355
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1356
				$notice = sprintf(
1357
					/* translators: %s is a URL */
1358
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1359
					'https://jetpack.com/support/development-mode/'
1360
				);
1361
			} else {
1362
				$notice = sprintf(
1363
					/* translators: %s is a URL */
1364
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1365
					'https://jetpack.com/support/development-mode/'
1366
				);
1367
			}
1368
1369
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1370
		}
1371
1372
		// Throw up a notice if using a development version and as for feedback.
1373
		if ( Jetpack::is_development_version() ) {
1374
			/* translators: %s is a URL */
1375
			$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/' );
1376
1377
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1378
		}
1379
		// Throw up a notice if using staging mode
1380
		if ( Jetpack::is_staging_site() ) {
1381
			/* translators: %s is a URL */
1382
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1383
1384
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1385
		}
1386
	}
1387
1388
	/**
1389
	 * Whether Jetpack's version maps to a public release, or a development version.
1390
	 */
1391
	public static function is_development_version() {
1392
		/**
1393
		 * Allows filtering whether this is a development version of Jetpack.
1394
		 *
1395
		 * This filter is especially useful for tests.
1396
		 *
1397
		 * @since 4.3.0
1398
		 *
1399
		 * @param bool $development_version Is this a develoment version of Jetpack?
1400
		 */
1401
		return (bool) apply_filters(
1402
			'jetpack_development_version',
1403
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1404
		);
1405
	}
1406
1407
	/**
1408
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1409
	 */
1410
	public static function is_user_connected( $user_id = false ) {
1411
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1412
		if ( ! $user_id ) {
1413
			return false;
1414
		}
1415
1416
		return (bool) Jetpack_Data::get_access_token( $user_id );
1417
	}
1418
1419
	/**
1420
	 * Get the wpcom user data of the current|specified connected user.
1421
	 */
1422
	public static function get_connected_user_data( $user_id = null ) {
1423
		if ( ! $user_id ) {
1424
			$user_id = get_current_user_id();
1425
		}
1426
1427
		$transient_key = "jetpack_connected_user_data_$user_id";
1428
1429
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1430
			return $cached_user_data;
1431
		}
1432
1433
		Jetpack::load_xml_rpc_client();
1434
		$xml = new Jetpack_IXR_Client( array(
1435
			'user_id' => $user_id,
1436
		) );
1437
		$xml->query( 'wpcom.getUser' );
1438
		if ( ! $xml->isError() ) {
1439
			$user_data = $xml->getResponse();
1440
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1441
			return $user_data;
1442
		}
1443
1444
		return false;
1445
	}
1446
1447
	/**
1448
	 * Get the wpcom email of the current|specified connected user.
1449
	 */
1450 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1451
		if ( ! $user_id ) {
1452
			$user_id = get_current_user_id();
1453
		}
1454
		Jetpack::load_xml_rpc_client();
1455
		$xml = new Jetpack_IXR_Client( array(
1456
			'user_id' => $user_id,
1457
		) );
1458
		$xml->query( 'wpcom.getUserEmail' );
1459
		if ( ! $xml->isError() ) {
1460
			return $xml->getResponse();
1461
		}
1462
		return false;
1463
	}
1464
1465
	/**
1466
	 * Get the wpcom email of the master user.
1467
	 */
1468
	public static function get_master_user_email() {
1469
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1470
		if ( $master_user_id ) {
1471
			return self::get_connected_user_email( $master_user_id );
1472
		}
1473
		return '';
1474
	}
1475
1476
	function current_user_is_connection_owner() {
1477
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1478
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1479
	}
1480
1481
	/**
1482
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1483
	 */
1484
	function extra_oembed_providers() {
1485
		// Cloudup: https://dev.cloudup.com/#oembed
1486
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1487
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1488
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1489
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1490
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1491
	}
1492
1493
	/**
1494
	 * Synchronize connected user role changes
1495
	 */
1496
	function user_role_change( $user_id ) {
1497
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1498
		Jetpack_Sync_Users::user_role_change( $user_id );
1499
	}
1500
1501
	/**
1502
	 * Loads the currently active modules.
1503
	 */
1504
	public static function load_modules() {
1505
		if ( ! self::is_active() && !self::is_development_mode() ) {
1506
			if ( ! is_multisite() || ! get_site_option( 'jetpack_protect_active' ) ) {
1507
				return;
1508
			}
1509
		}
1510
1511
		$version = Jetpack_Options::get_option( 'version' );
1512 View Code Duplication
		if ( ! $version ) {
1513
			$version = $old_version = JETPACK__VERSION . ':' . time();
1514
			/** This action is documented in class.jetpack.php */
1515
			do_action( 'updating_jetpack_version', $version, false );
1516
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1517
		}
1518
		list( $version ) = explode( ':', $version );
1519
1520
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1521
1522
		$modules_data = array();
1523
1524
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1525
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1526
			$updated_modules = array();
1527
			foreach ( $modules as $module ) {
1528
				$modules_data[ $module ] = Jetpack::get_module( $module );
1529
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1530
					continue;
1531
				}
1532
1533
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1534
					continue;
1535
				}
1536
1537
				$updated_modules[] = $module;
1538
			}
1539
1540
			$modules = array_diff( $modules, $updated_modules );
1541
		}
1542
1543
		$is_development_mode = Jetpack::is_development_mode();
1544
1545
		foreach ( $modules as $index => $module ) {
1546
			// If we're in dev mode, disable modules requiring a connection
1547
			if ( $is_development_mode ) {
1548
				// Prime the pump if we need to
1549
				if ( empty( $modules_data[ $module ] ) ) {
1550
					$modules_data[ $module ] = Jetpack::get_module( $module );
1551
				}
1552
				// If the module requires a connection, but we're in local mode, don't include it.
1553
				if ( $modules_data[ $module ]['requires_connection'] ) {
1554
					continue;
1555
				}
1556
			}
1557
1558
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1559
				continue;
1560
			}
1561
1562
			if ( ! @include( Jetpack::get_module_path( $module ) ) ) {
1563
				unset( $modules[ $index ] );
1564
				self::update_active_modules( array_values( $modules ) );
1565
				continue;
1566
			}
1567
1568
			/**
1569
			 * Fires when a specific module is loaded.
1570
			 * The dynamic part of the hook, $module, is the module slug.
1571
			 *
1572
			 * @since 1.1.0
1573
			 */
1574
			do_action( 'jetpack_module_loaded_' . $module );
1575
		}
1576
1577
		/**
1578
		 * Fires when all the modules are loaded.
1579
		 *
1580
		 * @since 1.1.0
1581
		 */
1582
		do_action( 'jetpack_modules_loaded' );
1583
1584
		// 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.
1585
		if ( Jetpack::is_active() || Jetpack::is_development_mode() )
1586
			require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1587
	}
1588
1589
	/**
1590
	 * Check if Jetpack's REST API compat file should be included
1591
	 * @action plugins_loaded
1592
	 * @return null
1593
	 */
1594
	public function check_rest_api_compat() {
1595
		/**
1596
		 * Filters the list of REST API compat files to be included.
1597
		 *
1598
		 * @since 2.2.5
1599
		 *
1600
		 * @param array $args Array of REST API compat files to include.
1601
		 */
1602
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1603
1604
		if ( function_exists( 'bbpress' ) )
1605
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1606
1607
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1608
			require_once $_jetpack_rest_api_compat_include;
1609
	}
1610
1611
	/**
1612
	 * Gets all plugins currently active in values, regardless of whether they're
1613
	 * traditionally activated or network activated.
1614
	 *
1615
	 * @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...
1616
	 */
1617
	public static function get_active_plugins() {
1618
		$active_plugins = (array) get_option( 'active_plugins', array() );
1619
1620
		if ( is_multisite() ) {
1621
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1622
			// whereas active_plugins stores them in the values.
1623
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1624
			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...
1625
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1626
			}
1627
		}
1628
1629
		sort( $active_plugins );
1630
1631
		return array_unique( $active_plugins );
1632
	}
1633
1634
	/**
1635
	 * Gets and parses additional plugin data to send with the heartbeat data
1636
	 *
1637
	 * @since 3.8.1
1638
	 *
1639
	 * @return array Array of plugin data
1640
	 */
1641
	public static function get_parsed_plugin_data() {
1642
		if ( ! function_exists( 'get_plugins' ) ) {
1643
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1644
		}
1645
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1646
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1647
		$active_plugins = Jetpack::get_active_plugins();
1648
1649
		$plugins = array();
1650
		foreach ( $all_plugins as $path => $plugin_data ) {
1651
			$plugins[ $path ] = array(
1652
					'is_active' => in_array( $path, $active_plugins ),
1653
					'file'      => $path,
1654
					'name'      => $plugin_data['Name'],
1655
					'version'   => $plugin_data['Version'],
1656
					'author'    => $plugin_data['Author'],
1657
			);
1658
		}
1659
1660
		return $plugins;
1661
	}
1662
1663
	/**
1664
	 * Gets and parses theme data to send with the heartbeat data
1665
	 *
1666
	 * @since 3.8.1
1667
	 *
1668
	 * @return array Array of theme data
1669
	 */
1670
	public static function get_parsed_theme_data() {
1671
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1672
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1673
1674
		$themes = array();
1675
		foreach ( $all_themes as $slug => $theme_data ) {
1676
			$theme_headers = array();
1677
			foreach ( $header_keys as $header_key ) {
1678
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1679
			}
1680
1681
			$themes[ $slug ] = array(
1682
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1683
					'slug' => $slug,
1684
					'theme_root' => $theme_data->get_theme_root_uri(),
1685
					'parent' => $theme_data->parent(),
1686
					'headers' => $theme_headers
1687
			);
1688
		}
1689
1690
		return $themes;
1691
	}
1692
1693
	/**
1694
	 * Checks whether a specific plugin is active.
1695
	 *
1696
	 * We don't want to store these in a static variable, in case
1697
	 * there are switch_to_blog() calls involved.
1698
	 */
1699
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1700
		return in_array( $plugin, self::get_active_plugins() );
1701
	}
1702
1703
	/**
1704
	 * Check if Jetpack's Open Graph tags should be used.
1705
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1706
	 *
1707
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1708
	 * @action plugins_loaded
1709
	 * @return null
1710
	 */
1711
	public function check_open_graph() {
1712
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1713
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1714
		}
1715
1716
		$active_plugins = self::get_active_plugins();
1717
1718
		if ( ! empty( $active_plugins ) ) {
1719
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1720
				if ( in_array( $plugin, $active_plugins ) ) {
1721
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1722
					break;
1723
				}
1724
			}
1725
		}
1726
1727
		/**
1728
		 * Allow the addition of Open Graph Meta Tags to all pages.
1729
		 *
1730
		 * @since 2.0.3
1731
		 *
1732
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1733
		 */
1734
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1735
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1736
		}
1737
	}
1738
1739
	/**
1740
	 * Check if Jetpack's Twitter tags should be used.
1741
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1742
	 *
1743
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1744
	 * @action plugins_loaded
1745
	 * @return null
1746
	 */
1747
	public function check_twitter_tags() {
1748
1749
		$active_plugins = self::get_active_plugins();
1750
1751
		if ( ! empty( $active_plugins ) ) {
1752
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1753
				if ( in_array( $plugin, $active_plugins ) ) {
1754
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1755
					break;
1756
				}
1757
			}
1758
		}
1759
1760
		/**
1761
		 * Allow Twitter Card Meta tags to be disabled.
1762
		 *
1763
		 * @since 2.6.0
1764
		 *
1765
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1766
		 */
1767
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1768
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1769
		}
1770
	}
1771
1772
	/**
1773
	 * Allows plugins to submit security reports.
1774
 	 *
1775
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
1776
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
1777
	 * @param array   $args         See definitions above
1778
	 */
1779
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
0 ignored issues
show
Unused Code introduced by
The parameter $type is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $plugin_file is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $args is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1780
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
1781
	}
1782
1783
/* Jetpack Options API */
1784
1785
	public static function get_option_names( $type = 'compact' ) {
1786
		return Jetpack_Options::get_option_names( $type );
1787
	}
1788
1789
	/**
1790
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
1791
 	 *
1792
	 * @param string $name    Option name
1793
	 * @param mixed  $default (optional)
1794
	 */
1795
	public static function get_option( $name, $default = false ) {
1796
		return Jetpack_Options::get_option( $name, $default );
1797
	}
1798
1799
	/**
1800
	* Stores two secrets and a timestamp so WordPress.com can make a request back and verify an action
1801
	* Does some extra verification so urls (such as those to public-api, register, etc) can't just be crafted
1802
	* $name must be a registered option name.
1803
	*/
1804
	public static function create_nonce( $name ) {
1805
		$secret = wp_generate_password( 32, false ) . ':' . wp_generate_password( 32, false ) . ':' . ( time() + 600 );
1806
1807
		Jetpack_Options::update_option( $name, $secret );
1808
		@list( $secret_1, $secret_2, $eol ) = explode( ':', Jetpack_Options::get_option( $name ) );
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...
1809
		if ( empty( $secret_1 ) || empty( $secret_2 ) || $eol < time() )
1810
			return new Jetpack_Error( 'missing_secrets' );
1811
1812
		return array(
1813
			'secret_1' => $secret_1,
1814
			'secret_2' => $secret_2,
1815
			'eol'      => $eol,
1816
		);
1817
	}
1818
1819
	/**
1820
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
1821
 	 *
1822
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
1823
	 * @param string $name  Option name
1824
	 * @param mixed  $value Option value
1825
	 */
1826
	public static function update_option( $name, $value ) {
1827
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
1828
		return Jetpack_Options::update_option( $name, $value );
1829
	}
1830
1831
	/**
1832
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
1833
 	 *
1834
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
1835
	 * @param array $array array( option name => option value, ... )
1836
	 */
1837
	public static function update_options( $array ) {
1838
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
1839
		return Jetpack_Options::update_options( $array );
1840
	}
1841
1842
	/**
1843
	 * Deletes the given option.  May be passed multiple option names as an array.
1844
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
1845
	 *
1846
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
1847
	 * @param string|array $names
1848
	 */
1849
	public static function delete_option( $names ) {
1850
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
1851
		return Jetpack_Options::delete_option( $names );
1852
	}
1853
1854
	/**
1855
	 * Enters a user token into the user_tokens option
1856
	 *
1857
	 * @param int $user_id
1858
	 * @param string $token
1859
	 * return bool
1860
	 */
1861
	public static function update_user_token( $user_id, $token, $is_master_user ) {
1862
		// not designed for concurrent updates
1863
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
1864
		if ( ! is_array( $user_tokens ) )
1865
			$user_tokens = array();
1866
		$user_tokens[$user_id] = $token;
1867
		if ( $is_master_user ) {
1868
			$master_user = $user_id;
1869
			$options     = compact( 'user_tokens', 'master_user' );
1870
		} else {
1871
			$options = compact( 'user_tokens' );
1872
		}
1873
		return Jetpack_Options::update_options( $options );
1874
	}
1875
1876
	/**
1877
	 * Returns an array of all PHP files in the specified absolute path.
1878
	 * Equivalent to glob( "$absolute_path/*.php" ).
1879
	 *
1880
	 * @param string $absolute_path The absolute path of the directory to search.
1881
	 * @return array Array of absolute paths to the PHP files.
1882
	 */
1883
	public static function glob_php( $absolute_path ) {
1884
		if ( function_exists( 'glob' ) ) {
1885
			return glob( "$absolute_path/*.php" );
1886
		}
1887
1888
		$absolute_path = untrailingslashit( $absolute_path );
1889
		$files = array();
1890
		if ( ! $dir = @opendir( $absolute_path ) ) {
1891
			return $files;
1892
		}
1893
1894
		while ( false !== $file = readdir( $dir ) ) {
1895
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
1896
				continue;
1897
			}
1898
1899
			$file = "$absolute_path/$file";
1900
1901
			if ( ! is_file( $file ) ) {
1902
				continue;
1903
			}
1904
1905
			$files[] = $file;
1906
		}
1907
1908
		closedir( $dir );
1909
1910
		return $files;
1911
	}
1912
1913
	public static function activate_new_modules( $redirect = false ) {
1914
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
1915
			return;
1916
		}
1917
1918
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
1919 View Code Duplication
		if ( ! $jetpack_old_version ) {
1920
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
1921
			/** This action is documented in class.jetpack.php */
1922
			do_action( 'updating_jetpack_version', $version, false );
1923
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1924
		}
1925
1926
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
1927
1928
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
1929
			return;
1930
		}
1931
1932
		$active_modules     = Jetpack::get_active_modules();
1933
		$reactivate_modules = array();
1934
		foreach ( $active_modules as $active_module ) {
1935
			$module = Jetpack::get_module( $active_module );
1936
			if ( ! isset( $module['changed'] ) ) {
1937
				continue;
1938
			}
1939
1940
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
1941
				continue;
1942
			}
1943
1944
			$reactivate_modules[] = $active_module;
1945
			Jetpack::deactivate_module( $active_module );
1946
		}
1947
1948
		$new_version = JETPACK__VERSION . ':' . time();
1949
		/** This action is documented in class.jetpack.php */
1950
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
1951
		Jetpack_Options::update_options(
1952
			array(
1953
				'version'     => $new_version,
1954
				'old_version' => $jetpack_old_version,
1955
			)
1956
		);
1957
1958
		Jetpack::state( 'message', 'modules_activated' );
1959
		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...
1960
1961
		if ( $redirect ) {
1962
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
1963
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
1964
				$page = $_GET['page'];
1965
			}
1966
1967
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
1968
			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...
1969
		}
1970
	}
1971
1972
	/**
1973
	 * List available Jetpack modules. Simply lists .php files in /modules/.
1974
	 * Make sure to tuck away module "library" files in a sub-directory.
1975
	 */
1976
	public static function get_available_modules( $min_version = false, $max_version = false ) {
1977
		static $modules = null;
1978
1979
		if ( ! isset( $modules ) ) {
1980
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
1981
			// Use the cache if we're on the front-end and it's available...
1982
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
1983
				$modules = $available_modules_option[ JETPACK__VERSION ];
1984
			} else {
1985
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
1986
1987
				$modules = array();
1988
1989
				foreach ( $files as $file ) {
1990
					if ( ! $headers = Jetpack::get_module( $file ) ) {
1991
						continue;
1992
					}
1993
1994
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
1995
				}
1996
1997
				Jetpack_Options::update_option( 'available_modules', array(
1998
					JETPACK__VERSION => $modules,
1999
				) );
2000
			}
2001
		}
2002
2003
		/**
2004
		 * Filters the array of modules available to be activated.
2005
		 *
2006
		 * @since 2.4.0
2007
		 *
2008
		 * @param array $modules Array of available modules.
2009
		 * @param string $min_version Minimum version number required to use modules.
2010
		 * @param string $max_version Maximum version number required to use modules.
2011
		 */
2012
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2013
2014
		if ( ! $min_version && ! $max_version ) {
2015
			return array_keys( $mods );
2016
		}
2017
2018
		$r = array();
2019
		foreach ( $mods as $slug => $introduced ) {
2020
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2021
				continue;
2022
			}
2023
2024
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2025
				continue;
2026
			}
2027
2028
			$r[] = $slug;
2029
		}
2030
2031
		return $r;
2032
	}
2033
2034
	/**
2035
	 * Default modules loaded on activation.
2036
	 */
2037
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2038
		$return = array();
2039
2040
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2041
			$module_data = Jetpack::get_module( $module );
2042
2043
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2044
				case 'yes' :
2045
					$return[] = $module;
2046
					break;
2047
				case 'public' :
2048
					if ( Jetpack_Options::get_option( 'public' ) ) {
2049
						$return[] = $module;
2050
					}
2051
					break;
2052
				case 'no' :
2053
				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...
2054
					break;
2055
			}
2056
		}
2057
		/**
2058
		 * Filters the array of default modules.
2059
		 *
2060
		 * @since 2.5.0
2061
		 *
2062
		 * @param array $return Array of default modules.
2063
		 * @param string $min_version Minimum version number required to use modules.
2064
		 * @param string $max_version Maximum version number required to use modules.
2065
		 */
2066
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2067
	}
2068
2069
	/**
2070
	 * Checks activated modules during auto-activation to determine
2071
	 * if any of those modules are being deprecated.  If so, close
2072
	 * them out, and add any replacement modules.
2073
	 *
2074
	 * Runs at priority 99 by default.
2075
	 *
2076
	 * This is run late, so that it can still activate a module if
2077
	 * the new module is a replacement for another that the user
2078
	 * currently has active, even if something at the normal priority
2079
	 * would kibosh everything.
2080
	 *
2081
	 * @since 2.6
2082
	 * @uses jetpack_get_default_modules filter
2083
	 * @param array $modules
2084
	 * @return array
2085
	 */
2086
	function handle_deprecated_modules( $modules ) {
2087
		$deprecated_modules = array(
2088
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2089
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2090
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2091
		);
2092
2093
		// Don't activate SSO if they never completed activating WPCC.
2094
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2095
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2096
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2097
				$deprecated_modules['wpcc'] = null;
2098
			}
2099
		}
2100
2101
		foreach ( $deprecated_modules as $module => $replacement ) {
2102
			if ( Jetpack::is_module_active( $module ) ) {
2103
				self::deactivate_module( $module );
2104
				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...
2105
					$modules[] = $replacement;
2106
				}
2107
			}
2108
		}
2109
2110
		return array_unique( $modules );
2111
	}
2112
2113
	/**
2114
	 * Checks activated plugins during auto-activation to determine
2115
	 * if any of those plugins are in the list with a corresponding module
2116
	 * that is not compatible with the plugin. The module will not be allowed
2117
	 * to auto-activate.
2118
	 *
2119
	 * @since 2.6
2120
	 * @uses jetpack_get_default_modules filter
2121
	 * @param array $modules
2122
	 * @return array
2123
	 */
2124
	function filter_default_modules( $modules ) {
2125
2126
		$active_plugins = self::get_active_plugins();
2127
2128
		if ( ! empty( $active_plugins ) ) {
2129
2130
			// For each module we'd like to auto-activate...
2131
			foreach ( $modules as $key => $module ) {
2132
				// If there are potential conflicts for it...
2133
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2134
					// For each potential conflict...
2135
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2136
						// If that conflicting plugin is active...
2137
						if ( in_array( $plugin, $active_plugins ) ) {
2138
							// Remove that item from being auto-activated.
2139
							unset( $modules[ $key ] );
2140
						}
2141
					}
2142
				}
2143
			}
2144
		}
2145
2146
		return $modules;
2147
	}
2148
2149
	/**
2150
	 * Extract a module's slug from its full path.
2151
	 */
2152
	public static function get_module_slug( $file ) {
2153
		return str_replace( '.php', '', basename( $file ) );
2154
	}
2155
2156
	/**
2157
	 * Generate a module's path from its slug.
2158
	 */
2159
	public static function get_module_path( $slug ) {
2160
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2161
	}
2162
2163
	/**
2164
	 * Load module data from module file. Headers differ from WordPress
2165
	 * plugin headers to avoid them being identified as standalone
2166
	 * plugins on the WordPress plugins page.
2167
	 */
2168
	public static function get_module( $module ) {
2169
		$headers = array(
2170
			'name'                      => 'Module Name',
2171
			'description'               => 'Module Description',
2172
			'jumpstart_desc'            => 'Jumpstart Description',
2173
			'sort'                      => 'Sort Order',
2174
			'recommendation_order'      => 'Recommendation Order',
2175
			'introduced'                => 'First Introduced',
2176
			'changed'                   => 'Major Changes In',
2177
			'deactivate'                => 'Deactivate',
2178
			'free'                      => 'Free',
2179
			'requires_connection'       => 'Requires Connection',
2180
			'auto_activate'             => 'Auto Activate',
2181
			'module_tags'               => 'Module Tags',
2182
			'feature'                   => 'Feature',
2183
			'additional_search_queries' => 'Additional Search Queries',
2184
		);
2185
2186
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2187
2188
		$mod = Jetpack::get_file_data( $file, $headers );
2189
		if ( empty( $mod['name'] ) ) {
2190
			return false;
2191
		}
2192
2193
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2194
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2195
		$mod['deactivate']              = empty( $mod['deactivate'] );
2196
		$mod['free']                    = empty( $mod['free'] );
2197
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2198
2199
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2200
			$mod['auto_activate'] = 'No';
2201
		} else {
2202
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2203
		}
2204
2205
		if ( $mod['module_tags'] ) {
2206
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2207
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2208
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2209
		} else {
2210
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2211
		}
2212
2213
		if ( $mod['feature'] ) {
2214
			$mod['feature'] = explode( ',', $mod['feature'] );
2215
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2216
		} else {
2217
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2218
		}
2219
2220
		/**
2221
		 * Filters the feature array on a module.
2222
		 *
2223
		 * This filter allows you to control where each module is filtered: Recommended,
2224
		 * Jumpstart, and the default "Other" listing.
2225
		 *
2226
		 * @since 3.5.0
2227
		 *
2228
		 * @param array   $mod['feature'] The areas to feature this module:
2229
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2230
		 *     'Recommended' shows on the main Jetpack admin screen.
2231
		 *     'Other' should be the default if no other value is in the array.
2232
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2233
		 * @param array   $mod All the currently assembled module data.
2234
		 */
2235
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2236
2237
		/**
2238
		 * Filter the returned data about a module.
2239
		 *
2240
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2241
		 * so please be careful.
2242
		 *
2243
		 * @since 3.6.0
2244
		 *
2245
		 * @param array   $mod    The details of the requested module.
2246
		 * @param string  $module The slug of the module, e.g. sharedaddy
2247
		 * @param string  $file   The path to the module source file.
2248
		 */
2249
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2250
	}
2251
2252
	/**
2253
	 * Like core's get_file_data implementation, but caches the result.
2254
	 */
2255
	public static function get_file_data( $file, $headers ) {
2256
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2257
		$file_name = basename( $file );
2258
		$file_data_option = Jetpack_Options::get_option( 'file_data', array() );
2259
		$key              = md5( $file_name . serialize( $headers ) );
2260
		$refresh_cache    = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2261
2262
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2263
		if ( ! $refresh_cache && isset( $file_data_option[ JETPACK__VERSION ][ $key ] ) ) {
2264
			return $file_data_option[ JETPACK__VERSION ][ $key ];
2265
		}
2266
2267
		$data = get_file_data( $file, $headers );
2268
2269
		// Strip out any old Jetpack versions that are cluttering the option.
2270
		$file_data_option = array_intersect_key( (array) $file_data_option, array( JETPACK__VERSION => null ) );
2271
		$file_data_option[ JETPACK__VERSION ][ $key ] = $data;
2272
		Jetpack_Options::update_option( 'file_data', $file_data_option );
2273
2274
		return $data;
2275
	}
2276
2277
	/**
2278
	 * Return translated module tag.
2279
	 *
2280
	 * @param string $tag Tag as it appears in each module heading.
2281
	 *
2282
	 * @return mixed
2283
	 */
2284
	public static function translate_module_tag( $tag ) {
2285
		return jetpack_get_module_i18n_tag( $tag );
2286
	}
2287
2288
	/**
2289
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2290
	 *
2291
	 * @since 3.9.2
2292
	 *
2293
	 * @param array $modules
2294
	 *
2295
	 * @return string|void
2296
	 */
2297
	public static function get_translated_modules( $modules ) {
2298
		foreach ( $modules as $index => $module ) {
2299
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2300
			if ( isset( $module['name'] ) ) {
2301
				$modules[ $index ]['name'] = $i18n_module['name'];
2302
			}
2303
			if ( isset( $module['description'] ) ) {
2304
				$modules[ $index ]['description'] = $i18n_module['description'];
2305
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2306
			}
2307
		}
2308
		return $modules;
2309
	}
2310
2311
	/**
2312
	 * Get a list of activated modules as an array of module slugs.
2313
	 */
2314
	public static function get_active_modules() {
2315
		$active = Jetpack_Options::get_option( 'active_modules' );
2316
2317
		if ( ! is_array( $active ) ) {
2318
			$active = array();
2319
		}
2320
2321
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2322
			$active[] = 'vaultpress';
2323
		} else {
2324
			$active = array_diff( $active, array( 'vaultpress' ) );
2325
		}
2326
2327
		//If protect is active on the main site of a multisite, it should be active on all sites.
2328
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2329
			$active[] = 'protect';
2330
		}
2331
2332
		return array_unique( $active );
2333
	}
2334
2335
	/**
2336
	 * Check whether or not a Jetpack module is active.
2337
	 *
2338
	 * @param string $module The slug of a Jetpack module.
2339
	 * @return bool
2340
	 *
2341
	 * @static
2342
	 */
2343
	public static function is_module_active( $module ) {
2344
		return in_array( $module, self::get_active_modules() );
2345
	}
2346
2347
	public static function is_module( $module ) {
2348
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2349
	}
2350
2351
	/**
2352
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2353
	 *
2354
	 * @param bool $catch True to start catching, False to stop.
2355
	 *
2356
	 * @static
2357
	 */
2358
	public static function catch_errors( $catch ) {
2359
		static $display_errors, $error_reporting;
2360
2361
		if ( $catch ) {
2362
			$display_errors  = @ini_set( 'display_errors', 1 );
2363
			$error_reporting = @error_reporting( E_ALL );
2364
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2365
		} else {
2366
			@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...
2367
			@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...
2368
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2369
		}
2370
	}
2371
2372
	/**
2373
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2374
	 */
2375
	public static function catch_errors_on_shutdown() {
2376
		Jetpack::state( 'php_errors', ob_get_clean() );
2377
	}
2378
2379
	public static function activate_default_modules( $min_version = false, $max_version = false, $other_modules = array(), $redirect = true ) {
2380
		$jetpack = Jetpack::init();
2381
2382
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2383
		$modules = array_merge( $other_modules, $modules );
2384
2385
		// Look for standalone plugins and disable if active.
2386
2387
		$to_deactivate = array();
2388
		foreach ( $modules as $module ) {
2389
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2390
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2391
			}
2392
		}
2393
2394
		$deactivated = array();
2395
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2396
			list( $probable_file, $probable_title ) = $deactivate_me;
2397
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2398
				$deactivated[] = $module;
2399
			}
2400
		}
2401
2402
		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...
2403
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2404
2405
			$url = add_query_arg(
2406
				array(
2407
					'action'   => 'activate_default_modules',
2408
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2409
				),
2410
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2411
			);
2412
			wp_safe_redirect( $url );
2413
			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...
2414
		}
2415
2416
		/**
2417
		 * Fires before default modules are activated.
2418
		 *
2419
		 * @since 1.9.0
2420
		 *
2421
		 * @param string $min_version Minimum version number required to use modules.
2422
		 * @param string $max_version Maximum version number required to use modules.
2423
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2424
		 */
2425
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2426
2427
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2428
		Jetpack::restate();
2429
		Jetpack::catch_errors( true );
2430
2431
		$active = Jetpack::get_active_modules();
2432
2433
		foreach ( $modules as $module ) {
2434
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2435
				$active[] = $module;
2436
				self::update_active_modules( $active );
2437
				continue;
2438
			}
2439
2440
			if ( in_array( $module, $active ) ) {
2441
				$module_info = Jetpack::get_module( $module );
2442
				if ( ! $module_info['deactivate'] ) {
2443
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2444 View Code Duplication
					if ( $active_state = Jetpack::state( $state ) ) {
2445
						$active_state = explode( ',', $active_state );
2446
					} else {
2447
						$active_state = array();
2448
					}
2449
					$active_state[] = $module;
2450
					Jetpack::state( $state, implode( ',', $active_state ) );
2451
				}
2452
				continue;
2453
			}
2454
2455
			$file = Jetpack::get_module_path( $module );
2456
			if ( ! file_exists( $file ) ) {
2457
				continue;
2458
			}
2459
2460
			// we'll override this later if the plugin can be included without fatal error
2461
			if ( $redirect ) {
2462
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2463
			}
2464
			Jetpack::state( 'error', 'module_activation_failed' );
2465
			Jetpack::state( 'module', $module );
2466
			ob_start();
2467
			require $file;
2468
2469
			$active[] = $module;
2470
			$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2471 View Code Duplication
			if ( $active_state = Jetpack::state( $state ) ) {
2472
				$active_state = explode( ',', $active_state );
2473
			} else {
2474
				$active_state = array();
2475
			}
2476
			$active_state[] = $module;
2477
			Jetpack::state( $state, implode( ',', $active_state ) );
2478
			Jetpack::update_active_modules( $active );
2479
2480
			ob_end_clean();
2481
		}
2482
		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...
2483
		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...
2484
		Jetpack::catch_errors( false );
2485
		/**
2486
		 * Fires when default modules are activated.
2487
		 *
2488
		 * @since 1.9.0
2489
		 *
2490
		 * @param string $min_version Minimum version number required to use modules.
2491
		 * @param string $max_version Maximum version number required to use modules.
2492
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2493
		 */
2494
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2495
	}
2496
2497
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2498
		/**
2499
		 * Fires before a module is activated.
2500
		 *
2501
		 * @since 2.6.0
2502
		 *
2503
		 * @param string $module Module slug.
2504
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2505
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2506
		 */
2507
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2508
2509
		$jetpack = Jetpack::init();
2510
2511
		if ( ! strlen( $module ) )
2512
			return false;
2513
2514
		if ( ! Jetpack::is_module( $module ) )
2515
			return false;
2516
2517
		// If it's already active, then don't do it again
2518
		$active = Jetpack::get_active_modules();
2519
		foreach ( $active as $act ) {
2520
			if ( $act == $module )
2521
				return true;
2522
		}
2523
2524
		$module_data = Jetpack::get_module( $module );
2525
2526
		if ( ! Jetpack::is_active() ) {
2527
			if ( !Jetpack::is_development_mode() )
2528
				return false;
2529
2530
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2531
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2532
				return false;
2533
		}
2534
2535
		// Check and see if the old plugin is active
2536
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2537
			// Deactivate the old plugin
2538
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2539
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2540
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2541
				Jetpack::state( 'deactivated_plugins', $module );
2542
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2543
				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...
2544
			}
2545
		}
2546
2547
		// Protect won't work with mis-configured IPs
2548
		if ( 'protect' === $module ) {
2549
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2550
			if ( ! jetpack_protect_get_ip() ) {
2551
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2552
				return false;
2553
			}
2554
		}
2555
2556
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2557
		Jetpack::state( 'module', $module );
2558
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2559
2560
		Jetpack::catch_errors( true );
2561
		ob_start();
2562
		require Jetpack::get_module_path( $module );
2563
		/** This action is documented in class.jetpack.php */
2564
		do_action( 'jetpack_activate_module', $module );
2565
		$active[] = $module;
2566
		Jetpack::update_active_modules( $active );
2567
2568
		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...
2569
		ob_end_clean();
2570
		Jetpack::catch_errors( false );
2571
2572
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2573 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2574
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2575
2576
			//Jump start is being dismissed send data to MC Stats
2577
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2578
2579
			$jetpack->do_stats( 'server_side' );
2580
		}
2581
2582
		if ( $redirect ) {
2583
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2584
		}
2585
		if ( $exit ) {
2586
			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...
2587
		}
2588
		return true;
2589
	}
2590
2591
	function activate_module_actions( $module ) {
0 ignored issues
show
Unused Code introduced by
The parameter $module is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2592
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2593
	}
2594
2595
	public static function deactivate_module( $module ) {
2596
		/**
2597
		 * Fires when a module is deactivated.
2598
		 *
2599
		 * @since 1.9.0
2600
		 *
2601
		 * @param string $module Module slug.
2602
		 */
2603
		do_action( 'jetpack_pre_deactivate_module', $module );
2604
2605
		$jetpack = Jetpack::init();
2606
2607
		$active = Jetpack::get_active_modules();
2608
		$new    = array_filter( array_diff( $active, (array) $module ) );
2609
2610
		// A flag for Jump Start so it's not shown again.
2611 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2612
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2613
2614
			//Jump start is being dismissed send data to MC Stats
2615
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2616
2617
			$jetpack->do_stats( 'server_side' );
2618
		}
2619
2620
		return self::update_active_modules( $new );
2621
	}
2622
2623
	public static function enable_module_configurable( $module ) {
2624
		$module = Jetpack::get_module_slug( $module );
2625
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2626
	}
2627
2628
	public static function module_configuration_url( $module ) {
2629
		$module = Jetpack::get_module_slug( $module );
2630
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2631
	}
2632
2633
	public static function module_configuration_load( $module, $method ) {
2634
		$module = Jetpack::get_module_slug( $module );
2635
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2636
	}
2637
2638
	public static function module_configuration_head( $module, $method ) {
2639
		$module = Jetpack::get_module_slug( $module );
2640
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2641
	}
2642
2643
	public static function module_configuration_screen( $module, $method ) {
2644
		$module = Jetpack::get_module_slug( $module );
2645
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2646
	}
2647
2648
	public static function module_configuration_activation_screen( $module, $method ) {
2649
		$module = Jetpack::get_module_slug( $module );
2650
		add_action( 'display_activate_module_setting_' . $module, $method );
2651
	}
2652
2653
/* Installation */
2654
2655
	public static function bail_on_activation( $message, $deactivate = true ) {
2656
?>
2657
<!doctype html>
2658
<html>
2659
<head>
2660
<meta charset="<?php bloginfo( 'charset' ); ?>">
2661
<style>
2662
* {
2663
	text-align: center;
2664
	margin: 0;
2665
	padding: 0;
2666
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2667
}
2668
p {
2669
	margin-top: 1em;
2670
	font-size: 18px;
2671
}
2672
</style>
2673
<body>
2674
<p><?php echo esc_html( $message ); ?></p>
2675
</body>
2676
</html>
2677
<?php
2678
		if ( $deactivate ) {
2679
			$plugins = get_option( 'active_plugins' );
2680
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2681
			$update  = false;
2682
			foreach ( $plugins as $i => $plugin ) {
2683
				if ( $plugin === $jetpack ) {
2684
					$plugins[$i] = false;
2685
					$update = true;
2686
				}
2687
			}
2688
2689
			if ( $update ) {
2690
				update_option( 'active_plugins', array_filter( $plugins ) );
2691
			}
2692
		}
2693
		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...
2694
	}
2695
2696
	/**
2697
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2698
	 * @static
2699
	 */
2700
	public static function plugin_activation( $network_wide ) {
2701
		Jetpack_Options::update_option( 'activated', 1 );
2702
2703
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2704
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2705
		}
2706
2707
		if ( $network_wide )
2708
			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...
2709
2710
		Jetpack::plugin_initialize();
2711
	}
2712
	/**
2713
	 * Runs before bumping version numbers up to a new version
2714
	 * @param  (string) $version    Version:timestamp
2715
	 * @param  (string) $old_version Old Version:timestamp or false if not set yet.
2716
	 * @return null              [description]
2717
	 */
2718
	public static function do_version_bump( $version, $old_version ) {
2719
2720
		if ( ! $old_version ) { // For new sites
2721
			// Setting up jetpack manage
2722
			Jetpack::activate_manage();
2723
		}
2724
	}
2725
2726
	/**
2727
	 * Sets the internal version number and activation state.
2728
	 * @static
2729
	 */
2730
	public static function plugin_initialize() {
2731
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
2732
			Jetpack_Options::update_option( 'activated', 2 );
2733
		}
2734
2735 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
2736
			$version = $old_version = JETPACK__VERSION . ':' . time();
2737
			/** This action is documented in class.jetpack.php */
2738
			do_action( 'updating_jetpack_version', $version, false );
2739
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2740
		}
2741
2742
		Jetpack::load_modules();
2743
2744
		Jetpack_Options::delete_option( 'do_activate' );
2745
	}
2746
2747
	/**
2748
	 * Removes all connection options
2749
	 * @static
2750
	 */
2751
	public static function plugin_deactivation( ) {
2752
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
2753
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
2754
			Jetpack_Network::init()->deactivate();
2755
		} else {
2756
			Jetpack::disconnect( false );
2757
			//Jetpack_Heartbeat::init()->deactivate();
2758
		}
2759
	}
2760
2761
	/**
2762
	 * Disconnects from the Jetpack servers.
2763
	 * Forgets all connection details and tells the Jetpack servers to do the same.
2764
	 * @static
2765
	 */
2766
	public static function disconnect( $update_activated_state = true ) {
2767
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
2768
		Jetpack::clean_nonces( true );
2769
2770
		// If the site is in an IDC because sync is not allowed,
2771
		// let's make sure to not disconnect the production site.
2772
		if ( ! self::validate_sync_error_idc_option() ) {
2773
			JetpackTracking::record_user_event( 'disconnect_site', array() );
2774
			Jetpack::load_xml_rpc_client();
2775
			$xml = new Jetpack_IXR_Client();
2776
			$xml->query( 'jetpack.deregister' );
2777
		}
2778
2779
		Jetpack_Options::delete_option(
2780
			array(
2781
				'register',
2782
				'blog_token',
2783
				'user_token',
2784
				'user_tokens',
2785
				'master_user',
2786
				'time_diff',
2787
				'fallback_no_verify_ssl_certs',
2788
			)
2789
		);
2790
2791
		Jetpack_IDC::clear_all_idc_options();
2792
2793
		if ( $update_activated_state ) {
2794
			Jetpack_Options::update_option( 'activated', 4 );
2795
		}
2796
2797
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
2798
			// Check then record unique disconnection if site has never been disconnected previously
2799
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
2800
				$jetpack_unique_connection['disconnected'] = 1;
2801
			} else {
2802
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
2803
					//track unique disconnect
2804
					$jetpack = Jetpack::init();
2805
2806
					$jetpack->stat( 'connections', 'unique-disconnect' );
2807
					$jetpack->do_stats( 'server_side' );
2808
				}
2809
				// increment number of times disconnected
2810
				$jetpack_unique_connection['disconnected'] += 1;
2811
			}
2812
2813
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
2814
		}
2815
2816
		// Delete cached connected user data
2817
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
2818
		delete_transient( $transient_key );
2819
2820
		// Delete all the sync related data. Since it could be taking up space.
2821
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
2822
		Jetpack_Sync_Sender::get_instance()->uninstall();
2823
2824
		// Disable the Heartbeat cron
2825
		Jetpack_Heartbeat::init()->deactivate();
2826
	}
2827
2828
	/**
2829
	 * Unlinks the current user from the linked WordPress.com user
2830
	 */
2831
	public static function unlink_user( $user_id = null ) {
2832
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
2833
			return false;
2834
2835
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
2836
2837
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
2838
			return false;
2839
2840
		if ( ! isset( $tokens[ $user_id ] ) )
2841
			return false;
2842
2843
		Jetpack::load_xml_rpc_client();
2844
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
2845
		$xml->query( 'jetpack.unlink_user', $user_id );
2846
2847
		unset( $tokens[ $user_id ] );
2848
2849
		Jetpack_Options::update_option( 'user_tokens', $tokens );
2850
2851
		/**
2852
		 * Fires after the current user has been unlinked from WordPress.com.
2853
		 *
2854
		 * @since 4.1.0
2855
		 *
2856
		 * @param int $user_id The current user's ID.
2857
		 */
2858
		do_action( 'jetpack_unlinked_user', $user_id );
2859
2860
		return true;
2861
	}
2862
2863
	/**
2864
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
2865
	 */
2866
	public static function try_registration() {
2867
		// Let's get some testing in beta versions and such.
2868
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
2869
			// Before attempting to connect, let's make sure that the domains are viable.
2870
			$domains_to_check = array_unique( array(
2871
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
2872
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
2873
			) );
2874
			foreach ( $domains_to_check as $domain ) {
2875
				$result = Jetpack_Data::is_usable_domain( $domain );
2876
				if ( is_wp_error( $result ) ) {
2877
					return $result;
2878
				}
2879
			}
2880
		}
2881
2882
		$result = Jetpack::register();
2883
2884
		// If there was an error with registration and the site was not registered, record this so we can show a message.
2885
		if ( ! $result || is_wp_error( $result ) ) {
2886
			return $result;
2887
		} else {
2888
			return true;
2889
		}
2890
	}
2891
2892
	/**
2893
	 * Tracking an internal event log. Try not to put too much chaff in here.
2894
	 *
2895
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
2896
	 */
2897
	public static function log( $code, $data = null ) {
2898
		// only grab the latest 200 entries
2899
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
2900
2901
		// Append our event to the log
2902
		$log_entry = array(
2903
			'time'    => time(),
2904
			'user_id' => get_current_user_id(),
2905
			'blog_id' => Jetpack_Options::get_option( 'id' ),
2906
			'code'    => $code,
2907
		);
2908
		// Don't bother storing it unless we've got some.
2909
		if ( ! is_null( $data ) ) {
2910
			$log_entry['data'] = $data;
2911
		}
2912
		$log[] = $log_entry;
2913
2914
		// Try add_option first, to make sure it's not autoloaded.
2915
		// @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...
2916
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
2917
			Jetpack_Options::update_option( 'log', $log );
2918
		}
2919
2920
		/**
2921
		 * Fires when Jetpack logs an internal event.
2922
		 *
2923
		 * @since 3.0.0
2924
		 *
2925
		 * @param array $log_entry {
2926
		 *	Array of details about the log entry.
2927
		 *
2928
		 *	@param string time Time of the event.
2929
		 *	@param int user_id ID of the user who trigerred the event.
2930
		 *	@param int blog_id Jetpack Blog ID.
2931
		 *	@param string code Unique name for the event.
2932
		 *	@param string data Data about the event.
2933
		 * }
2934
		 */
2935
		do_action( 'jetpack_log_entry', $log_entry );
2936
	}
2937
2938
	/**
2939
	 * Get the internal event log.
2940
	 *
2941
	 * @param $event (string) - only return the specific log events
2942
	 * @param $num   (int)    - get specific number of latest results, limited to 200
2943
	 *
2944
	 * @return array of log events || WP_Error for invalid params
2945
	 */
2946
	public static function get_log( $event = false, $num = false ) {
2947
		if ( $event && ! is_string( $event ) ) {
2948
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
2949
		}
2950
2951
		if ( $num && ! is_numeric( $num ) ) {
2952
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
2953
		}
2954
2955
		$entire_log = Jetpack_Options::get_option( 'log', array() );
2956
2957
		// If nothing set - act as it did before, otherwise let's start customizing the output
2958
		if ( ! $num && ! $event ) {
2959
			return $entire_log;
2960
		} else {
2961
			$entire_log = array_reverse( $entire_log );
2962
		}
2963
2964
		$custom_log_output = array();
2965
2966
		if ( $event ) {
2967
			foreach ( $entire_log as $log_event ) {
2968
				if ( $event == $log_event[ 'code' ] ) {
2969
					$custom_log_output[] = $log_event;
2970
				}
2971
			}
2972
		} else {
2973
			$custom_log_output = $entire_log;
2974
		}
2975
2976
		if ( $num ) {
2977
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
2978
		}
2979
2980
		return $custom_log_output;
2981
	}
2982
2983
	/**
2984
	 * Log modification of important settings.
2985
	 */
2986
	public static function log_settings_change( $option, $old_value, $value ) {
0 ignored issues
show
Unused Code introduced by
The parameter $old_value is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
2987
		switch( $option ) {
2988
			case 'jetpack_sync_non_public_post_stati':
2989
				self::log( $option, $value );
2990
				break;
2991
		}
2992
	}
2993
2994
	/**
2995
	 * Return stat data for WPCOM sync
2996
	 */
2997
	public static function get_stat_data( $encode = true, $extended = true ) {
2998
		$data = Jetpack_Heartbeat::generate_stats_array();
2999
3000
		if ( $extended ) {
3001
			$additional_data = self::get_additional_stat_data();
3002
			$data = array_merge( $data, $additional_data );
3003
		}
3004
3005
		if ( $encode ) {
3006
			return json_encode( $data );
3007
		}
3008
3009
		return $data;
3010
	}
3011
3012
	/**
3013
	 * Get additional stat data to sync to WPCOM
3014
	 */
3015
	public static function get_additional_stat_data( $prefix = '' ) {
3016
		$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...
3017
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3018
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3019
		$return["{$prefix}site-count"]     = 0;
3020
3021
		if ( function_exists( 'get_blog_count' ) ) {
3022
			$return["{$prefix}site-count"] = get_blog_count();
3023
		}
3024
		return $return;
3025
	}
3026
3027
	private static function get_site_user_count() {
3028
		global $wpdb;
3029
3030
		if ( function_exists( 'wp_is_large_network' ) ) {
3031
			if ( wp_is_large_network( 'users' ) ) {
3032
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3033
			}
3034
		}
3035 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3036
			// It wasn't there, so regenerate the data and save the transient
3037
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3038
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3039
		}
3040
		return $user_count;
3041
	}
3042
3043
	/* Admin Pages */
3044
3045
	function admin_init() {
3046
		// If the plugin is not connected, display a connect message.
3047
		if (
3048
			// the plugin was auto-activated and needs its candy
3049
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3050
		||
3051
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3052
			! Jetpack_Options::get_option( 'activated' )
3053
		) {
3054
			Jetpack::plugin_initialize();
3055
		}
3056
3057
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3058
			Jetpack_Connection_Banner::init();
3059
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3060
			// Upgrade: 1.1 -> 1.1.1
3061
			// Check and see if host can verify the Jetpack servers' SSL certificate
3062
			$args = array();
3063
			Jetpack_Client::_wp_remote_request(
3064
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3065
				$args,
3066
				true
3067
			);
3068
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3069
			// Show the notice on the Dashboard only for now
3070
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3071
		}
3072
3073
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3074
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3075
		}
3076
3077
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3078
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3079
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3080
3081
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3082
			// Artificially throw errors in certain whitelisted cases during plugin activation
3083
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3084
		}
3085
3086
		// Jetpack Manage Activation Screen from .com
3087
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3088
3089
		// Add custom column in wp-admin/users.php to show whether user is linked.
3090
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3091
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3092
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3093
	}
3094
3095
	function admin_body_class( $admin_body_class = '' ) {
3096
		$classes = explode( ' ', trim( $admin_body_class ) );
3097
3098
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3099
3100
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3101
		return " $admin_body_class ";
3102
	}
3103
3104
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3105
		return $admin_body_class . ' jetpack-pagestyles ';
3106
	}
3107
3108
	/**
3109
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3110
	 *
3111
	 * @return null
3112
	 */
3113
	function prepare_manage_jetpack_notice() {
3114
3115
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3116
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3117
	}
3118
3119
	function manage_activate_screen() {
3120
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3121
	}
3122
	/**
3123
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3124
	 * This function artificially throws errors for such cases (whitelisted).
3125
	 *
3126
	 * @param string $plugin The activated plugin.
3127
	 */
3128
	function throw_error_on_activate_plugin( $plugin ) {
3129
		$active_modules = Jetpack::get_active_modules();
3130
3131
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3132
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3133
			$throw = false;
3134
3135
			// Try and make sure it really was the stats plugin
3136
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3137
				if ( 'stats.php' == basename( $plugin ) ) {
3138
					$throw = true;
3139
				}
3140
			} else {
3141
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3142
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3143
					$throw = true;
3144
				}
3145
			}
3146
3147
			if ( $throw ) {
3148
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3149
			}
3150
		}
3151
	}
3152
3153
	function intercept_plugin_error_scrape_init() {
3154
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3155
	}
3156
3157
	function intercept_plugin_error_scrape( $action, $result ) {
3158
		if ( ! $result ) {
3159
			return;
3160
		}
3161
3162
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3163
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3164
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3165
			}
3166
		}
3167
	}
3168
3169
	function add_remote_request_handlers() {
3170
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3171
	}
3172
3173
	function remote_request_handlers() {
3174
		switch ( current_filter() ) {
3175
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3176
			$response = $this->upload_handler();
3177
			break;
3178
		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...
3179
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3180
			break;
3181
		}
3182
3183
		if ( ! $response ) {
3184
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3185
		}
3186
3187
		if ( is_wp_error( $response ) ) {
3188
			$status_code       = $response->get_error_data();
3189
			$error             = $response->get_error_code();
3190
			$error_description = $response->get_error_message();
3191
3192
			if ( ! is_int( $status_code ) ) {
3193
				$status_code = 400;
3194
			}
3195
3196
			status_header( $status_code );
3197
			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...
3198
		}
3199
3200
		status_header( 200 );
3201
		if ( true === $response ) {
3202
			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...
3203
		}
3204
3205
		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...
3206
	}
3207
3208
	function upload_handler() {
3209
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3210
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3211
		}
3212
3213
		$user = wp_authenticate( '', '' );
3214
		if ( ! $user || is_wp_error( $user ) ) {
3215
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3216
		}
3217
3218
		wp_set_current_user( $user->ID );
3219
3220
		if ( ! current_user_can( 'upload_files' ) ) {
3221
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3222
		}
3223
3224
		if ( empty( $_FILES ) ) {
3225
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3226
		}
3227
3228
		foreach ( array_keys( $_FILES ) as $files_key ) {
3229
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3230
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3231
			}
3232
		}
3233
3234
		$media_keys = array_keys( $_FILES['media'] );
3235
3236
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3237
		if ( ! $token || is_wp_error( $token ) ) {
3238
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3239
		}
3240
3241
		$uploaded_files = array();
3242
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3243
		unset( $GLOBALS['post'] );
3244
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3245
			$file = array();
3246
			foreach ( $media_keys as $media_key ) {
3247
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3248
			}
3249
3250
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3251
3252
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3253
			if ( $hmac_provided !== $hmac_file ) {
3254
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3255
				continue;
3256
			}
3257
3258
			$_FILES['.jetpack.upload.'] = $file;
3259
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3260
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3261
				$post_id = 0;
3262
			}
3263
			$attachment_id = media_handle_upload(
3264
				'.jetpack.upload.',
3265
				$post_id,
3266
				array(),
3267
				array(
3268
					'action' => 'jetpack_upload_file',
3269
				)
3270
			);
3271
3272
			if ( ! $attachment_id ) {
3273
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3274
			} elseif ( is_wp_error( $attachment_id ) ) {
3275
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3276
			} else {
3277
				$attachment = get_post( $attachment_id );
3278
				$uploaded_files[$index] = (object) array(
3279
					'id'   => (string) $attachment_id,
3280
					'file' => $attachment->post_title,
3281
					'url'  => wp_get_attachment_url( $attachment_id ),
3282
					'type' => $attachment->post_mime_type,
3283
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3284
				);
3285
				// Zip files uploads are not supported unless they are done for installation purposed
3286
				// lets delete them in case something goes wrong in this whole process
3287
				if ( 'application/zip' === $attachment->post_mime_type ) {
3288
					// Schedule a cleanup for 2 hours from now in case of failed install.
3289
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3290
				}
3291
			}
3292
		}
3293
		if ( ! is_null( $global_post ) ) {
3294
			$GLOBALS['post'] = $global_post;
3295
		}
3296
3297
		return $uploaded_files;
3298
	}
3299
3300
	/**
3301
	 * Add help to the Jetpack page
3302
	 *
3303
	 * @since Jetpack (1.2.3)
3304
	 * @return false if not the Jetpack page
3305
	 */
3306
	function admin_help() {
3307
		$current_screen = get_current_screen();
3308
3309
		// Overview
3310
		$current_screen->add_help_tab(
3311
			array(
3312
				'id'		=> 'home',
3313
				'title'		=> __( 'Home', 'jetpack' ),
3314
				'content'	=>
3315
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3316
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3317
					'<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>',
3318
			)
3319
		);
3320
3321
		// Screen Content
3322
		if ( current_user_can( 'manage_options' ) ) {
3323
			$current_screen->add_help_tab(
3324
				array(
3325
					'id'		=> 'settings',
3326
					'title'		=> __( 'Settings', 'jetpack' ),
3327
					'content'	=>
3328
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3329
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3330
						'<ol>' .
3331
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3332
							'<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>' .
3333
						'</ol>' .
3334
						'<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>'
3335
				)
3336
			);
3337
		}
3338
3339
		// Help Sidebar
3340
		$current_screen->set_help_sidebar(
3341
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3342
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3343
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3344
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3345
		);
3346
	}
3347
3348
	function admin_menu_css() {
3349
		wp_enqueue_style( 'jetpack-icons' );
3350
	}
3351
3352
	function admin_menu_order() {
3353
		return true;
3354
	}
3355
3356 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3357
		$jp_menu_order = array();
3358
3359
		foreach ( $menu_order as $index => $item ) {
3360
			if ( $item != 'jetpack' ) {
3361
				$jp_menu_order[] = $item;
3362
			}
3363
3364
			if ( $index == 0 ) {
3365
				$jp_menu_order[] = 'jetpack';
3366
			}
3367
		}
3368
3369
		return $jp_menu_order;
3370
	}
3371
3372
	function admin_head() {
3373 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3374
			/** This action is documented in class.jetpack-admin-page.php */
3375
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3376
	}
3377
3378
	function admin_banner_styles() {
3379
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3380
3381 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3382
			wp_register_style(
3383
				'jetpack-dops-style',
3384
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3385
				array(),
3386
				JETPACK__VERSION
3387
			);
3388
		}
3389
3390
		wp_enqueue_style(
3391
			'jetpack',
3392
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3393
			array( 'jetpack-dops-style' ),
3394
			 JETPACK__VERSION . '-20121016'
3395
		);
3396
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3397
		wp_style_add_data( 'jetpack', 'suffix', $min );
3398
	}
3399
3400
	function plugin_action_links( $actions ) {
3401
3402
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3403
3404
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3405
			return array_merge(
3406
				$jetpack_home,
3407
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3408
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3409
				$actions
3410
				);
3411
			}
3412
3413
		return array_merge( $jetpack_home, $actions );
3414
	}
3415
3416
	/**
3417
	 * This is the first banner
3418
	 * It should be visible only to user that can update the option
3419
	 * Are not connected
3420
	 *
3421
	 * @return null
3422
	 */
3423
	function admin_jetpack_manage_notice() {
3424
		$screen = get_current_screen();
3425
3426
		// Don't show the connect notice on the jetpack settings page.
3427
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3428
			return;
3429
		}
3430
3431
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3432
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3433
		/**
3434
		 * I think it would be great to have different wordsing depending on where you are
3435
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3436
		 * etc..
3437
		 */
3438
3439
		?>
3440
		<div id="message" class="updated jp-banner">
3441
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3442
				<div class="jp-banner__description-container">
3443
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3444
					<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>
3445
					<p class="jp-banner__button-container">
3446
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3447
						<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>
3448
					</p>
3449
				</div>
3450
		</div>
3451
		<?php
3452
	}
3453
3454
	/**
3455
	 * Returns the url that the user clicks to remove the notice for the big banner
3456
	 * @return (string)
3457
	 */
3458
	function opt_out_jetpack_manage_url() {
3459
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3460
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3461
	}
3462
	/**
3463
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3464
	 * @return (string)
3465
	 */
3466
	function opt_in_jetpack_manage_url() {
3467
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3468
	}
3469
3470
	function opt_in_jetpack_manage_notice() {
3471
		?>
3472
		<div class="wrap">
3473
			<div id="message" class="jetpack-message is-opt-in">
3474
				<?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' ); ?>
3475
			</div>
3476
		</div>
3477
		<?php
3478
3479
	}
3480
	/**
3481
	 * Determines whether to show the notice of not true = display notice
3482
	 * @return (bool)
3483
	 */
3484
	function can_display_jetpack_manage_notice() {
3485
		// never display the notice to users that can't do anything about it anyways
3486
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3487
			return false;
3488
3489
		// don't display if we are in development more
3490
		if( Jetpack::is_development_mode() ) {
3491
			return false;
3492
		}
3493
		// don't display if the site is private
3494
		if(  ! Jetpack_Options::get_option( 'public' ) )
3495
			return false;
3496
3497
		/**
3498
		 * Should the Jetpack Remote Site Management notice be displayed.
3499
		 *
3500
		 * @since 3.3.0
3501
		 *
3502
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3503
		 */
3504
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3505
	}
3506
3507
	/*
3508
	 * Registration flow:
3509
	 * 1 - ::admin_page_load() action=register
3510
	 * 2 - ::try_registration()
3511
	 * 3 - ::register()
3512
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3513
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3514
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3515
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3516
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3517
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3518
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3519
	 *       jetpack_id, jetpack_secret, jetpack_public
3520
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3521
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3522
	 * 5 - user logs in with WP.com account
3523
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3524
	 *		- Jetpack_Client_Server::authorize()
3525
	 *		- Jetpack_Client_Server::get_token()
3526
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3527
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3528
	 *			- which responds with access_token, token_type, scope
3529
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3530
	 *		- Jetpack::activate_default_modules()
3531
	 *     		- Deactivates deprecated plugins
3532
	 *     		- Activates all default modules
3533
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3534
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3535
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3536
	 *     Done!
3537
	 */
3538
3539
	/**
3540
	 * Handles the page load events for the Jetpack admin page
3541
	 */
3542
	function admin_page_load() {
3543
		$error = false;
3544
3545
		// Make sure we have the right body class to hook stylings for subpages off of.
3546
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3547
3548
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3549
			// Should only be used in intermediate redirects to preserve state across redirects
3550
			Jetpack::restate();
3551
		}
3552
3553
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3554
			// User clicked in the iframe to link their accounts
3555
			if ( ! Jetpack::is_user_connected() ) {
3556
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3557
				if ( isset( $_GET['notes_iframe'] ) )
3558
					$connect_url .= '&notes_iframe';
3559
				wp_redirect( $connect_url );
3560
				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...
3561
			} else {
3562
				if ( ! isset( $_GET['calypso_env'] ) ) {
3563
					Jetpack::state( 'message', 'already_authorized' );
3564
					wp_safe_redirect( Jetpack::admin_url() );
3565
				} else {
3566
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3567
					$connect_url .= '&already_authorized=true';
3568
					wp_redirect( $connect_url );
3569
				}
3570
			}
3571
		}
3572
3573
3574
		if ( isset( $_GET['action'] ) ) {
3575
			switch ( $_GET['action'] ) {
3576
			case 'authorize':
3577
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3578
					Jetpack::state( 'message', 'already_authorized' );
3579
					wp_safe_redirect( Jetpack::admin_url() );
3580
					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...
3581
				}
3582
				Jetpack::log( 'authorize' );
3583
				$client_server = new Jetpack_Client_Server;
3584
				$client_server->client_authorize();
3585
				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...
3586
			case 'register' :
3587
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3588
					$error = 'cheatin';
3589
					break;
3590
				}
3591
				check_admin_referer( 'jetpack-register' );
3592
				Jetpack::log( 'register' );
3593
				Jetpack::maybe_set_version_option();
3594
				$registered = Jetpack::try_registration();
3595
				if ( is_wp_error( $registered ) ) {
3596
					$error = $registered->get_error_code();
3597
					Jetpack::state( 'error', $error );
3598
					Jetpack::state( 'error', $registered->get_error_message() );
3599
					break;
3600
				}
3601
3602
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3603
3604
				wp_redirect( $this->build_connect_url( true, false, $from ) );
3605
				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...
3606
			case 'activate' :
3607
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3608
					$error = 'cheatin';
3609
					break;
3610
				}
3611
3612
				$module = stripslashes( $_GET['module'] );
3613
				check_admin_referer( "jetpack_activate-$module" );
3614
				Jetpack::log( 'activate', $module );
3615
				Jetpack::activate_module( $module );
3616
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3617
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3618
				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...
3619
			case 'activate_default_modules' :
3620
				check_admin_referer( 'activate_default_modules' );
3621
				Jetpack::log( 'activate_default_modules' );
3622
				Jetpack::restate();
3623
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3624
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3625
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3626
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3627
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3628
				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...
3629
			case 'disconnect' :
3630
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3631
					$error = 'cheatin';
3632
					break;
3633
				}
3634
3635
				check_admin_referer( 'jetpack-disconnect' );
3636
				Jetpack::log( 'disconnect' );
3637
				Jetpack::disconnect();
3638
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
3639
				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...
3640
			case 'reconnect' :
3641
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
3642
					$error = 'cheatin';
3643
					break;
3644
				}
3645
3646
				check_admin_referer( 'jetpack-reconnect' );
3647
				Jetpack::log( 'reconnect' );
3648
				$this->disconnect();
3649
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
3650
				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...
3651 View Code Duplication
			case 'deactivate' :
3652
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
3653
					$error = 'cheatin';
3654
					break;
3655
				}
3656
3657
				$modules = stripslashes( $_GET['module'] );
3658
				check_admin_referer( "jetpack_deactivate-$modules" );
3659
				foreach ( explode( ',', $modules ) as $module ) {
3660
					Jetpack::log( 'deactivate', $module );
3661
					Jetpack::deactivate_module( $module );
3662
					Jetpack::state( 'message', 'module_deactivated' );
3663
				}
3664
				Jetpack::state( 'module', $modules );
3665
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3666
				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...
3667
			case 'unlink' :
3668
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
3669
				check_admin_referer( 'jetpack-unlink' );
3670
				Jetpack::log( 'unlink' );
3671
				$this->unlink_user();
3672
				Jetpack::state( 'message', 'unlinked' );
3673
				if ( 'sub-unlink' == $redirect ) {
3674
					wp_safe_redirect( admin_url() );
3675
				} else {
3676
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
3677
				}
3678
				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...
3679
			default:
3680
				/**
3681
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
3682
				 *
3683
				 * @since 2.6.0
3684
				 *
3685
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
3686
				 */
3687
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
3688
			}
3689
		}
3690
3691
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
3692
			self::activate_new_modules( true );
3693
		}
3694
3695
		$message_code = Jetpack::state( 'message' );
3696
		if ( Jetpack::state( 'optin-manage' ) ) {
3697
			$activated_manage = $message_code;
3698
			$message_code = 'jetpack-manage';
3699
		}
3700
3701
		switch ( $message_code ) {
3702
		case 'jetpack-manage':
3703
			$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>';
3704
			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...
3705
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
3706
			}
3707
			break;
3708
3709
		}
3710
3711
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
3712
3713
		if ( ! empty( $deactivated_plugins ) ) {
3714
			$deactivated_plugins = explode( ',', $deactivated_plugins );
3715
			$deactivated_titles  = array();
3716
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
3717
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
3718
					continue;
3719
				}
3720
3721
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
3722
			}
3723
3724
			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...
3725
				if ( $this->message ) {
3726
					$this->message .= "<br /><br />\n";
3727
				}
3728
3729
				$this->message .= wp_sprintf(
3730
					_n(
3731
						'Jetpack contains the most recent version of the old %l plugin.',
3732
						'Jetpack contains the most recent versions of the old %l plugins.',
3733
						count( $deactivated_titles ),
3734
						'jetpack'
3735
					),
3736
					$deactivated_titles
3737
				);
3738
3739
				$this->message .= "<br />\n";
3740
3741
				$this->message .= _n(
3742
					'The old version has been deactivated and can be removed from your site.',
3743
					'The old versions have been deactivated and can be removed from your site.',
3744
					count( $deactivated_titles ),
3745
					'jetpack'
3746
				);
3747
			}
3748
		}
3749
3750
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
3751
3752
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
3753
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
3754
		}
3755
3756 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
3757
			/**
3758
			 * Fires when a module configuration page is loaded.
3759
			 * The dynamic part of the hook is the configure parameter from the URL.
3760
			 *
3761
			 * @since 1.1.0
3762
			 */
3763
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
3764
		}
3765
3766
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
3767
	}
3768
3769
	function admin_notices() {
3770
3771
		if ( $this->error ) {
3772
?>
3773
<div id="message" class="jetpack-message jetpack-err">
3774
	<div class="squeezer">
3775
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
3776
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
3777
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
3778
<?php	endif; ?>
3779
	</div>
3780
</div>
3781
<?php
3782
		}
3783
3784
		if ( $this->message ) {
3785
?>
3786
<div id="message" class="jetpack-message">
3787
	<div class="squeezer">
3788
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
3789
	</div>
3790
</div>
3791
<?php
3792
		}
3793
3794
		if ( $this->privacy_checks ) :
3795
			$module_names = $module_slugs = array();
3796
3797
			$privacy_checks = explode( ',', $this->privacy_checks );
3798
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
3799
			foreach ( $privacy_checks as $module_slug ) {
3800
				$module = Jetpack::get_module( $module_slug );
3801
				if ( ! $module ) {
3802
					continue;
3803
				}
3804
3805
				$module_slugs[] = $module_slug;
3806
				$module_names[] = "<strong>{$module['name']}</strong>";
3807
			}
3808
3809
			$module_slugs = join( ',', $module_slugs );
3810
?>
3811
<div id="message" class="jetpack-message jetpack-err">
3812
	<div class="squeezer">
3813
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
3814
		<p><?php
3815
			echo wp_kses(
3816
				wptexturize(
3817
					wp_sprintf(
3818
						_nx(
3819
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
3820
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
3821
							count( $privacy_checks ),
3822
							'%l = list of Jetpack module/feature names',
3823
							'jetpack'
3824
						),
3825
						$module_names
3826
					)
3827
				),
3828
				array( 'strong' => true )
3829
			);
3830
3831
			echo "\n<br />\n";
3832
3833
			echo wp_kses(
3834
				sprintf(
3835
					_nx(
3836
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
3837
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
3838
						count( $privacy_checks ),
3839
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
3840
						'jetpack'
3841
					),
3842
					wp_nonce_url(
3843
						Jetpack::admin_url(
3844
							array(
3845
								'page'   => 'jetpack',
3846
								'action' => 'deactivate',
3847
								'module' => urlencode( $module_slugs ),
3848
							)
3849
						),
3850
						"jetpack_deactivate-$module_slugs"
3851
					),
3852
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
3853
				),
3854
				array( 'a' => array( 'href' => true, 'title' => true ) )
3855
			);
3856
		?></p>
3857
	</div>
3858
</div>
3859
<?php endif;
3860
	// only display the notice if the other stuff is not there
3861
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
3862
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
3863
			$this->opt_in_jetpack_manage_notice();
3864
		}
3865
	}
3866
3867
	/**
3868
	 * Record a stat for later output.  This will only currently output in the admin_footer.
3869
	 */
3870
	function stat( $group, $detail ) {
3871
		if ( ! isset( $this->stats[ $group ] ) )
3872
			$this->stats[ $group ] = array();
3873
		$this->stats[ $group ][] = $detail;
3874
	}
3875
3876
	/**
3877
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
3878
	 */
3879
	function do_stats( $method = '' ) {
3880
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
3881
			foreach ( $this->stats as $group => $stats ) {
3882
				if ( is_array( $stats ) && count( $stats ) ) {
3883
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
3884
					if ( 'server_side' === $method ) {
3885
						self::do_server_side_stat( $args );
3886
					} else {
3887
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
3888
					}
3889
				}
3890
				unset( $this->stats[ $group ] );
3891
			}
3892
		}
3893
	}
3894
3895
	/**
3896
	 * Runs stats code for a one-off, server-side.
3897
	 *
3898
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
3899
	 *
3900
	 * @return bool If it worked.
3901
	 */
3902
	static function do_server_side_stat( $args ) {
3903
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
3904
		if ( is_wp_error( $response ) )
3905
			return false;
3906
3907
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
3908
			return false;
3909
3910
		return true;
3911
	}
3912
3913
	/**
3914
	 * Builds the stats url.
3915
	 *
3916
	 * @param $args array|string The arguments to append to the URL.
3917
	 *
3918
	 * @return string The URL to be pinged.
3919
	 */
3920
	static function build_stats_url( $args ) {
3921
		$defaults = array(
3922
			'v'    => 'wpcom2',
3923
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
3924
		);
3925
		$args     = wp_parse_args( $args, $defaults );
3926
		/**
3927
		 * Filter the URL used as the Stats tracking pixel.
3928
		 *
3929
		 * @since 2.3.2
3930
		 *
3931
		 * @param string $url Base URL used as the Stats tracking pixel.
3932
		 */
3933
		$base_url = apply_filters(
3934
			'jetpack_stats_base_url',
3935
			'https://pixel.wp.com/g.gif'
3936
		);
3937
		$url      = add_query_arg( $args, $base_url );
3938
		return $url;
3939
	}
3940
3941
	static function translate_current_user_to_role() {
3942
		foreach ( self::$capability_translations as $role => $cap ) {
3943
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
3944
				return $role;
3945
			}
3946
		}
3947
3948
		return false;
3949
	}
3950
3951
	static function translate_role_to_cap( $role ) {
3952
		if ( ! isset( self::$capability_translations[$role] ) ) {
3953
			return false;
3954
		}
3955
3956
		return self::$capability_translations[$role];
3957
	}
3958
3959
	static function sign_role( $role ) {
3960
		if ( ! $user_id = (int) get_current_user_id() ) {
3961
			return false;
3962
		}
3963
3964
		$token = Jetpack_Data::get_access_token();
3965
		if ( ! $token || is_wp_error( $token ) ) {
3966
			return false;
3967
		}
3968
3969
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
3970
	}
3971
3972
3973
	/**
3974
	 * Builds a URL to the Jetpack connection auth page
3975
	 *
3976
	 * @since 3.9.5
3977
	 *
3978
	 * @param bool $raw If true, URL will not be escaped.
3979
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
3980
	 *                              If string, will be a custom redirect.
3981
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
3982
	 *
3983
	 * @return string Connect URL
3984
	 */
3985
	function build_connect_url( $raw = false, $redirect = false, $from = false ) {
3986
		if ( ! Jetpack_Options::get_option( 'blog_token' ) || ! Jetpack_Options::get_option( 'id' ) ) {
3987
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
3988
			if( is_network_admin() ) {
3989
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
3990
			}
3991
		} else {
3992
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
3993
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
3994
			}
3995
3996
			$role = self::translate_current_user_to_role();
3997
			$signed_role = self::sign_role( $role );
3998
3999
			$user = wp_get_current_user();
4000
4001
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4002
			$redirect = $redirect
4003
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4004
				: $jetpack_admin_page;
4005
4006
			if( isset( $_REQUEST['is_multisite'] ) ) {
4007
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4008
			}
4009
4010
			$secrets = Jetpack::init()->generate_secrets( 'authorize' );
4011
			@list( $secret ) = explode( ':', $secrets );
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...
4012
4013
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4014
				? get_site_icon_url()
4015
				: false;
4016
4017
			/**
4018
			 * Filter the type of authorization.
4019
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4020
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4021
			 *
4022
			 * @since 4.3.3
4023
			 *
4024
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4025
			 */
4026
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4027
4028
			$args = urlencode_deep(
4029
				array(
4030
					'response_type' => 'code',
4031
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4032
					'redirect_uri'  => add_query_arg(
4033
						array(
4034
							'action'   => 'authorize',
4035
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4036
							'redirect' => urlencode( $redirect ),
4037
						),
4038
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4039
					),
4040
					'state'         => $user->ID,
4041
					'scope'         => $signed_role,
4042
					'user_email'    => $user->user_email,
4043
					'user_login'    => $user->user_login,
4044
					'is_active'     => Jetpack::is_active(),
4045
					'jp_version'    => JETPACK__VERSION,
4046
					'auth_type'     => $auth_type,
4047
					'secret'        => $secret,
4048
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4049
					'blogname'      => get_option( 'blogname' ),
4050
					'site_url'      => site_url(),
4051
					'home_url'      => home_url(),
4052
					'site_icon'     => $site_icon,
4053
				)
4054
			);
4055
4056
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4057
		}
4058
4059
		if ( $from ) {
4060
			$url = add_query_arg( 'from', $from, $url );
4061
		}
4062
4063
		if ( isset( $_GET['calypso_env'] ) ) {
4064
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4065
		}
4066
4067
		return $raw ? $url : esc_url( $url );
4068
	}
4069
4070
	function build_reconnect_url( $raw = false ) {
4071
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4072
		return $raw ? $url : esc_url( $url );
4073
	}
4074
4075
	public static function admin_url( $args = null ) {
4076
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4077
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4078
		return $url;
4079
	}
4080
4081
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4082
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4083
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4084
	}
4085
4086
	function dismiss_jetpack_notice() {
4087
4088
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4089
			return;
4090
		}
4091
4092
		switch( $_GET['jetpack-notice'] ) {
4093
			case 'dismiss':
4094
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4095
4096
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4097
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4098
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4099
				}
4100
				break;
4101 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...
4102
4103
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4104
					// Don't show the banner again
4105
4106
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4107
					// redirect back to the page that had the notice
4108
					if ( wp_get_referer() ) {
4109
						wp_safe_redirect( wp_get_referer() );
4110
					} else {
4111
						// Take me to Jetpack
4112
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4113
					}
4114
				}
4115
				break;
4116 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...
4117
4118
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4119
					// Don't show the banner again
4120
4121
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4122
					// redirect back to the page that had the notice
4123
					if ( wp_get_referer() ) {
4124
						wp_safe_redirect( wp_get_referer() );
4125
					} else {
4126
						// Take me to Jetpack
4127
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4128
					}
4129
				}
4130
				break;
4131
			case 'jetpack-manage-opt-in':
4132
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4133
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4134
4135
					$redirection_url = Jetpack::admin_url();
4136
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4137
4138
					// Don't redirect form the Jetpack Setting Page
4139
					$referer_parsed = parse_url ( wp_get_referer() );
4140
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4141
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4142
						// Take the user to Jetpack home except when on the setting page
4143
						$redirection_url = wp_get_referer();
4144
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4145
					}
4146
					// Also update the JSON API FULL MANAGEMENT Option
4147
					Jetpack::activate_module( 'manage', false, false );
4148
4149
					// Special Message when option in.
4150
					Jetpack::state( 'optin-manage', 'true' );
4151
					// Activate the Module if not activated already
4152
4153
					// Redirect properly
4154
					wp_safe_redirect( $redirection_url );
4155
4156
				}
4157
				break;
4158
		}
4159
	}
4160
4161
	function debugger_page() {
4162
		nocache_headers();
4163
		if ( ! current_user_can( 'manage_options' ) ) {
4164
			die( '-1' );
0 ignored issues
show
Coding Style Compatibility introduced by
The method debugger_page() 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...
4165
		}
4166
		Jetpack_Debugger::jetpack_debug_display_handler();
4167
		exit;
0 ignored issues
show
Coding Style Compatibility introduced by
The method debugger_page() 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
	}
4169
4170
	public static function admin_screen_configure_module( $module_id ) {
4171
4172
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4173
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4174
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4175
				/**
4176
				 * Fires to diplay a custom module activation screen.
4177
				 *
4178
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4179
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4180
				 *
4181
				 * @module manage
4182
				 *
4183
				 * @since 3.8.0
4184
				 *
4185
				 * @param int $module_id Module ID.
4186
				 */
4187
				do_action( 'display_activate_module_setting_' . $module_id );
4188
			} else {
4189
				self::display_activate_module_link( $module_id );
4190
			}
4191
4192
			return false;
4193
		} ?>
4194
4195
		<div id="jp-settings-screen" style="position: relative">
4196
			<h3>
4197
			<?php
4198
				$module = Jetpack::get_module( $module_id );
4199
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4200
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4201
			?>
4202
			</h3>
4203
			<?php
4204
				/**
4205
				 * Fires within the displayed message when a feature configuation is updated.
4206
				 *
4207
				 * @since 3.4.0
4208
				 *
4209
				 * @param int $module_id Module ID.
4210
				 */
4211
				do_action( 'jetpack_notices_update_settings', $module_id );
4212
				/**
4213
				 * Fires when a feature configuation screen is loaded.
4214
				 * The dynamic part of the hook, $module_id, is the module ID.
4215
				 *
4216
				 * @since 1.1.0
4217
				 */
4218
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4219
			?>
4220
		</div><?php
4221
	}
4222
4223
	/**
4224
	 * Display link to activate the module to see the settings screen.
4225
	 * @param  string $module_id
4226
	 * @return null
4227
	 */
4228
	public static function display_activate_module_link( $module_id ) {
4229
4230
		$info =  Jetpack::get_module( $module_id );
4231
		$extra = '';
4232
		$activate_url = wp_nonce_url(
4233
				Jetpack::admin_url(
4234
					array(
4235
						'page'   => 'jetpack',
4236
						'action' => 'activate',
4237
						'module' => $module_id,
4238
					)
4239
				),
4240
				"jetpack_activate-$module_id"
4241
			);
4242
4243
		?>
4244
4245
		<div class="wrap configure-module">
4246
			<div id="jp-settings-screen">
4247
				<?php
4248
				if ( $module_id == 'json-api' ) {
4249
4250
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4251
4252
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4253
4254
					$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' );
4255
4256
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4257
				} ?>
4258
4259
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4260
				<div class="narrow">
4261
					<p><?php echo  $info['description']; ?></p>
4262
					<?php if( $extra ) { ?>
4263
					<p><?php echo esc_html( $extra ); ?></p>
4264
					<?php } ?>
4265
					<p>
4266
						<?php
4267
						if( wp_get_referer() ) {
4268
							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() );
4269
						} else {
4270
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4271
						} ?>
4272
					</p>
4273
				</div>
4274
4275
			</div>
4276
		</div>
4277
4278
		<?php
4279
	}
4280
4281
	public static function sort_modules( $a, $b ) {
4282
		if ( $a['sort'] == $b['sort'] )
4283
			return 0;
4284
4285
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4286
	}
4287
4288
	function ajax_recheck_ssl() {
4289
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4290
		$result = Jetpack::permit_ssl( true );
4291
		wp_send_json( array(
4292
			'enabled' => $result,
4293
			'message' => get_transient( 'jetpack_https_test_message' )
4294
		) );
4295
	}
4296
4297
/* Client API */
4298
4299
	/**
4300
	 * Returns the requested Jetpack API URL
4301
	 *
4302
	 * @return string
4303
	 */
4304
	public static function api_url( $relative_url ) {
4305
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4306
	}
4307
4308
	/**
4309
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4310
	 */
4311
	public static function fix_url_for_bad_hosts( $url ) {
4312
		if ( 0 !== strpos( $url, 'https://' ) ) {
4313
			return $url;
4314
		}
4315
4316
		switch ( JETPACK_CLIENT__HTTPS ) {
4317
			case 'ALWAYS' :
4318
				return $url;
4319
			case 'NEVER' :
4320
				return set_url_scheme( $url, 'http' );
4321
			// default : case 'AUTO' :
4322
		}
4323
4324
		// we now return the unmodified SSL URL by default, as a security precaution
4325
		return $url;
4326
	}
4327
4328
	/**
4329
	 * Checks to see if the URL is using SSL to connect with Jetpack
4330
	 *
4331
	 * @since 2.3.3
4332
	 * @return boolean
4333
	 */
4334
	public static function permit_ssl( $force_recheck = false ) {
4335
		// Do some fancy tests to see if ssl is being supported
4336
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4337
			$message = '';
4338
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4339
				$ssl = 0;
4340
			} else {
4341
				switch ( JETPACK_CLIENT__HTTPS ) {
4342
					case 'NEVER':
4343
						$ssl = 0;
4344
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4345
						break;
4346
					case 'ALWAYS':
4347
					case 'AUTO':
4348
					default:
4349
						$ssl = 1;
4350
						break;
4351
				}
4352
4353
				// If it's not 'NEVER', test to see
4354
				if ( $ssl ) {
4355
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4356
						$ssl = 0;
4357
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4358
					} else {
4359
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4360
						if ( is_wp_error( $response ) ) {
4361
							$ssl = 0;
4362
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4363
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4364
							$ssl = 0;
4365
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4366
						}
4367
					}
4368
				}
4369
			}
4370
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4371
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4372
		}
4373
4374
		return (bool) $ssl;
4375
	}
4376
4377
	/*
4378
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4379
	 */
4380
	public function alert_auto_ssl_fail() {
4381
		if ( ! current_user_can( 'manage_options' ) )
4382
			return;
4383
4384
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4385
		?>
4386
4387
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4388
			<div class="jp-banner__content">
4389
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4390
				<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>
4391
				<p>
4392
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4393
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4394
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4395
				</p>
4396
				<p>
4397
					<?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' ),
4398
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4399
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4400
				</p>
4401
			</div>
4402
		</div>
4403
		<style>
4404
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4405
		</style>
4406
		<script type="text/javascript">
4407
			jQuery( document ).ready( function( $ ) {
4408
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4409
					var $this = $( this );
4410
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4411
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4412
					e.preventDefault();
4413
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4414
					$.post( ajaxurl, data )
4415
					  .done( function( response ) {
4416
					  	if ( response.enabled ) {
4417
					  		$( '#jetpack-ssl-warning' ).hide();
4418
					  	} else {
4419
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4420
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4421
					  	}
4422
					  }.bind( $this ) );
4423
				} );
4424
			} );
4425
		</script>
4426
4427
		<?php
4428
	}
4429
4430
	/**
4431
	 * Returns the Jetpack XML-RPC API
4432
	 *
4433
	 * @return string
4434
	 */
4435
	public static function xmlrpc_api_url() {
4436
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4437
		return untrailingslashit( $base ) . '/xmlrpc.php';
4438
	}
4439
4440
	/**
4441
	 * Creates two secret tokens and the end of life timestamp for them.
4442
	 *
4443
	 * Note these tokens are unique per call, NOT static per site for connecting.
4444
	 *
4445
	 * @since 2.6
4446
	 * @return array
4447
	 */
4448
	public function generate_secrets( $action, $exp = 600 ) {
4449
	    $secret = wp_generate_password( 32, false ) // secret_1
4450
	    		. ':' . wp_generate_password( 32, false ) // secret_2
4451
	    		. ':' . ( time() + $exp ) // eol ( End of Life )
4452
	    		. ':' . get_current_user_id(); // ties the secrets to the current user
4453
		Jetpack_Options::update_option( $action, $secret );
4454
	    return Jetpack_Options::get_option( $action );
4455
	}
4456
4457
	/**
4458
	 * Builds the timeout limit for queries talking with the wpcom servers.
4459
	 *
4460
	 * Based on local php max_execution_time in php.ini
4461
	 *
4462
	 * @since 2.6
4463
	 * @return int
4464
	 **/
4465
	public function get_remote_query_timeout_limit() {
4466
	    $timeout = (int) ini_get( 'max_execution_time' );
4467
	    if ( ! $timeout ) // Ensure exec time set in php.ini
4468
				$timeout = 30;
4469
	    return intval( $timeout / 2 );
4470
	}
4471
4472
4473
	/**
4474
	 * Takes the response from the Jetpack register new site endpoint and
4475
	 * verifies it worked properly.
4476
	 *
4477
	 * @since 2.6
4478
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
4479
	 **/
4480
	public function validate_remote_register_response( $response ) {
4481
	  if ( is_wp_error( $response ) ) {
4482
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
4483
		}
4484
4485
		$code   = wp_remote_retrieve_response_code( $response );
4486
		$entity = wp_remote_retrieve_body( $response );
4487
		if ( $entity )
4488
			$registration_response = json_decode( $entity );
4489
		else
4490
			$registration_response = false;
4491
4492
		$code_type = intval( $code / 100 );
4493
		if ( 5 == $code_type ) {
4494
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4495
		} elseif ( 408 == $code ) {
4496
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4497
		} elseif ( ! empty( $registration_response->error ) ) {
4498
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
4499
				$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' );
4500
			} else {
4501
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
4502
			}
4503
4504
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
4505
		} elseif ( 200 != $code ) {
4506
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
4507
		}
4508
4509
		// Jetpack ID error block
4510
		if ( empty( $registration_response->jetpack_id ) ) {
4511
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
4512
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
4513
			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 );
4514
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
4515
			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 );
4516
		}
4517
4518
	    return $registration_response;
4519
	}
4520
	/**
4521
	 * @return bool|WP_Error
4522
	 */
4523
	public static function register() {
4524
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
4525
		$secrets = Jetpack::init()->generate_secrets( 'register' );
4526
4527
		@list( $secret_1, $secret_2, $secret_eol ) = explode( ':', $secrets );
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...
4528 View Code Duplication
		if ( empty( $secret_1 ) || empty( $secret_2 ) || empty( $secret_eol ) || $secret_eol < time() ) {
4529
			return new Jetpack_Error( 'missing_secrets' );
4530
		}
4531
4532
		$timeout = Jetpack::init()->get_remote_query_timeout_limit();
4533
4534
		$gmt_offset = get_option( 'gmt_offset' );
4535
		if ( ! $gmt_offset ) {
4536
			$gmt_offset = 0;
4537
		}
4538
4539
		$stats_options = get_option( 'stats_options' );
4540
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
4541
4542
		$args = array(
4543
			'method'  => 'POST',
4544
			'body'    => array(
4545
				'siteurl'         => site_url(),
4546
				'home'            => home_url(),
4547
				'gmt_offset'      => $gmt_offset,
4548
				'timezone_string' => (string) get_option( 'timezone_string' ),
4549
				'site_name'       => (string) get_option( 'blogname' ),
4550
				'secret_1'        => $secret_1,
4551
				'secret_2'        => $secret_2,
4552
				'site_lang'       => get_locale(),
4553
				'timeout'         => $timeout,
4554
				'stats_id'        => $stats_id,
4555
				'state'           => get_current_user_id(),
4556
			),
4557
			'headers' => array(
4558
				'Accept' => 'application/json',
4559
			),
4560
			'timeout' => $timeout,
4561
		);
4562
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
4563
4564
		// Make sure the response is valid and does not contain any Jetpack errors
4565
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
4566
		if ( is_wp_error( $registration_details ) ) {
4567
		    return $registration_details;
4568
		} elseif ( ! $registration_details ) {
4569
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
4570
		}
4571
4572 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
4573
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
4574
		}
4575
4576
		if ( isset( $registration_details->jetpack_public ) ) {
4577
			$jetpack_public = (int) $registration_details->jetpack_public;
4578
		} else {
4579
			$jetpack_public = false;
4580
		}
4581
4582
		Jetpack_Options::update_options(
4583
			array(
4584
				'id'         => (int)    $registration_details->jetpack_id,
4585
				'blog_token' => (string) $registration_details->jetpack_secret,
4586
				'public'     => $jetpack_public,
4587
			)
4588
		);
4589
4590
		/**
4591
		 * Fires when a site is registered on WordPress.com.
4592
		 *
4593
		 * @since 3.7.0
4594
		 *
4595
		 * @param int $json->jetpack_id Jetpack Blog ID.
4596
		 * @param string $json->jetpack_secret Jetpack Blog Token.
4597
		 * @param int|bool $jetpack_public Is the site public.
4598
		 */
4599
		do_action( 'jetpack_site_registered', $json->jetpack_id, $json->jetpack_secret, $jetpack_public );
0 ignored issues
show
Bug introduced by
The variable $json 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...
4600
4601
		// Initialize Jump Start for the first and only time.
4602
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
4603
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
4604
4605
			$jetpack = Jetpack::init();
4606
4607
			$jetpack->stat( 'jumpstart', 'unique-views' );
4608
			$jetpack->do_stats( 'server_side' );
4609
		};
4610
4611
		return true;
4612
	}
4613
4614
	/**
4615
	 * If the db version is showing something other that what we've got now, bump it to current.
4616
	 *
4617
	 * @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...
4618
	 */
4619
	public static function maybe_set_version_option() {
4620
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
4621
		if ( JETPACK__VERSION != $version ) {
4622
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
4623
4624
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
4625
				/** This action is documented in class.jetpack.php */
4626
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
4627
			}
4628
4629
			return true;
4630
		}
4631
		return false;
4632
	}
4633
4634
/* Client Server API */
4635
4636
	/**
4637
	 * Loads the Jetpack XML-RPC client
4638
	 */
4639
	public static function load_xml_rpc_client() {
4640
		require_once ABSPATH . WPINC . '/class-IXR.php';
4641
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
4642
	}
4643
4644
	/**
4645
	 * Resets the saved authentication state in between testing requests.
4646
	 */
4647
	public function reset_saved_auth_state() {
4648
		$this->xmlrpc_verification = null;
4649
		$this->rest_authentication_status = null;
4650
	}
4651
4652
	function verify_xml_rpc_signature() {
4653
		if ( $this->xmlrpc_verification ) {
4654
			return $this->xmlrpc_verification;
4655
		}
4656
4657
		// It's not for us
4658
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
4659
			return false;
4660
		}
4661
4662
		@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...
4663
		if (
4664
			empty( $token_key )
4665
		||
4666
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
4667
		) {
4668
			return false;
4669
		}
4670
4671
		if ( '0' === $user_id ) {
4672
			$token_type = 'blog';
4673
			$user_id = 0;
4674
		} else {
4675
			$token_type = 'user';
4676
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
4677
				return false;
4678
			}
4679
			$user_id = (int) $user_id;
4680
4681
			$user = new WP_User( $user_id );
4682
			if ( ! $user || ! $user->exists() ) {
4683
				return false;
4684
			}
4685
		}
4686
4687
		$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...
4688
		if ( ! $token ) {
4689
			return false;
4690
		}
4691
4692
		$token_check = "$token_key.";
4693
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
4694
			return false;
4695
		}
4696
4697
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
4698
4699
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
4700
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
4701
			$post_data   = $_POST;
4702
			$file_hashes = array();
4703
			foreach ( $post_data as $post_data_key => $post_data_value ) {
4704
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
4705
					continue;
4706
				}
4707
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
4708
				$file_hashes[$post_data_key] = $post_data_value;
4709
			}
4710
4711
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
4712
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
4713
				$post_data[$post_data_key] = $post_data_value;
4714
			}
4715
4716
			ksort( $post_data );
4717
4718
			$body = http_build_query( stripslashes_deep( $post_data ) );
4719
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
4720
			$body = file_get_contents( 'php://input' );
4721
		} else {
4722
			$body = null;
4723
		}
4724
4725
		$signature = $jetpack_signature->sign_current_request(
4726
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
4727
		);
4728
4729
		if ( ! $signature ) {
4730
			return false;
4731
		} else if ( is_wp_error( $signature ) ) {
4732
			return $signature;
4733
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
4734
			return false;
4735
		}
4736
4737
		$timestamp = (int) $_GET['timestamp'];
4738
		$nonce     = stripslashes( (string) $_GET['nonce'] );
4739
4740
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
4741
			return false;
4742
		}
4743
4744
		$this->xmlrpc_verification = array(
4745
			'type'    => $token_type,
4746
			'user_id' => $token->external_user_id,
4747
		);
4748
4749
		return $this->xmlrpc_verification;
4750
	}
4751
4752
	/**
4753
	 * Authenticates XML-RPC and other requests from the Jetpack Server
4754
	 */
4755
	function authenticate_jetpack( $user, $username, $password ) {
0 ignored issues
show
Unused Code introduced by
The parameter $username is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $password is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
4756
		if ( is_a( $user, 'WP_User' ) ) {
4757
			return $user;
4758
		}
4759
4760
		$token_details = $this->verify_xml_rpc_signature();
4761
4762
		if ( ! $token_details || is_wp_error( $token_details ) ) {
4763
			return $user;
4764
		}
4765
4766
		if ( 'user' !== $token_details['type'] ) {
4767
			return $user;
4768
		}
4769
4770
		if ( ! $token_details['user_id'] ) {
4771
			return $user;
4772
		}
4773
4774
		nocache_headers();
4775
4776
		return new WP_User( $token_details['user_id'] );
4777
	}
4778
4779
	// Authenticates requests from Jetpack server to WP REST API endpoints.
4780
	// Uses the existing XMLRPC request signing implementation.
4781
	function wp_rest_authenticate( $user ) {
4782
		if ( ! empty( $user ) ) {
4783
			// Another authentication method is in effect.
4784
			return $user;
4785
		}
4786
4787
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
4788
			// Nothing to do for this authentication method.
4789
			return null;
4790
		}
4791
4792
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
4793
			// Nothing to do for this authentication method.
4794
			return null;
4795
		}
4796
4797
		// Ensure that we always have the request body available.  At this
4798
		// point, the WP REST API code to determine the request body has not
4799
		// run yet.  That code may try to read from 'php://input' later, but
4800
		// this can only be done once per request in PHP versions prior to 5.6.
4801
		// So we will go ahead and perform this read now if needed, and save
4802
		// the request body where both the Jetpack signature verification code
4803
		// and the WP REST API code can see it.
4804
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
4805
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
4806
		}
4807
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4808
4809
		// Only support specific request parameters that have been tested and
4810
		// are known to work with signature verification.  A different method
4811
		// can be passed to the WP REST API via the '?_method=' parameter if
4812
		// needed.
4813
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
4814
			$this->rest_authentication_status = new WP_Error(
4815
				'rest_invalid_request',
4816
				__( 'This request method is not supported.', 'jetpack' ),
4817
				array( 'status' => 400 )
4818
			);
4819
			return null;
4820
		}
4821
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
4822
			$this->rest_authentication_status = new WP_Error(
4823
				'rest_invalid_request',
4824
				__( 'This request method does not support body parameters.', 'jetpack' ),
4825
				array( 'status' => 400 )
4826
			);
4827
			return null;
4828
		}
4829
4830
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
4831
			$content_type = $_SERVER['CONTENT_TYPE'];
4832
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
4833
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
4834
		}
4835
4836
		if (
4837
			isset( $content_type ) &&
4838
			$content_type !== 'application/x-www-form-urlencoded' &&
4839
			$content_type !== 'application/json'
4840
		) {
4841
			$this->rest_authentication_status = new WP_Error(
4842
				'rest_invalid_request',
4843
				__( 'This Content-Type is not supported.', 'jetpack' ),
4844
				array( 'status' => 400 )
4845
			);
4846
			return null;
4847
		}
4848
4849
		$verified = $this->verify_xml_rpc_signature();
4850
4851
		if ( is_wp_error( $verified ) ) {
4852
			$this->rest_authentication_status = $verified;
4853
			return null;
4854
		}
4855
4856
		if (
4857
			$verified &&
4858
			isset( $verified['type'] ) &&
4859
			'user' === $verified['type'] &&
4860
			! empty( $verified['user_id'] )
4861
		) {
4862
			// Authentication successful.
4863
			$this->rest_authentication_status = true;
4864
			return $verified['user_id'];
4865
		}
4866
4867
		// Something else went wrong.  Probably a signature error.
4868
		$this->rest_authentication_status = new WP_Error(
4869
			'rest_invalid_signature',
4870
			__( 'The request is not signed correctly.', 'jetpack' ),
4871
			array( 'status' => 400 )
4872
		);
4873
		return null;
4874
	}
4875
4876
	/**
4877
	 * Report authentication status to the WP REST API.
4878
	 *
4879
	 * @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...
4880
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
4881
	 */
4882
	public function wp_rest_authentication_errors( $value ) {
4883
		if ( $value !== null ) {
4884
			return $value;
4885
		}
4886
		return $this->rest_authentication_status;
4887
	}
4888
4889
	function add_nonce( $timestamp, $nonce ) {
4890
		global $wpdb;
4891
		static $nonces_used_this_request = array();
4892
4893
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
4894
			return $nonces_used_this_request["$timestamp:$nonce"];
4895
		}
4896
4897
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
4898
		$timestamp = (int) $timestamp;
4899
		$nonce     = esc_sql( $nonce );
4900
4901
		// Raw query so we can avoid races: add_option will also update
4902
		$show_errors = $wpdb->show_errors( false );
4903
4904
		$old_nonce = $wpdb->get_row(
4905
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
4906
		);
4907
4908
		if ( is_null( $old_nonce ) ) {
4909
			$return = $wpdb->query(
4910
				$wpdb->prepare(
4911
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
4912
					"jetpack_nonce_{$timestamp}_{$nonce}",
4913
					time(),
4914
					'no'
4915
				)
4916
			);
4917
		} else {
4918
			$return = false;
4919
		}
4920
4921
		$wpdb->show_errors( $show_errors );
4922
4923
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
4924
4925
		return $return;
4926
	}
4927
4928
	/**
4929
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
4930
	 * Capture it here so we can verify the signature later.
4931
	 */
4932
	function xmlrpc_methods( $methods ) {
4933
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
4934
		return $methods;
4935
	}
4936
4937
	function public_xmlrpc_methods( $methods ) {
4938
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
4939
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
4940
		}
4941
		return $methods;
4942
	}
4943
4944
	function jetpack_getOptions( $args ) {
4945
		global $wp_xmlrpc_server;
4946
4947
		$wp_xmlrpc_server->escape( $args );
4948
4949
		$username	= $args[1];
4950
		$password	= $args[2];
4951
4952
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
4953
			return $wp_xmlrpc_server->error;
4954
		}
4955
4956
		$options = array();
4957
		$user_data = $this->get_connected_user_data();
4958
		if ( is_array( $user_data ) ) {
4959
			$options['jetpack_user_id'] = array(
4960
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
4961
				'readonly'      => true,
4962
				'value'         => $user_data['ID'],
4963
			);
4964
			$options['jetpack_user_login'] = array(
4965
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
4966
				'readonly'      => true,
4967
				'value'         => $user_data['login'],
4968
			);
4969
			$options['jetpack_user_email'] = array(
4970
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
4971
				'readonly'      => true,
4972
				'value'         => $user_data['email'],
4973
			);
4974
			$options['jetpack_user_site_count'] = array(
4975
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
4976
				'readonly'      => true,
4977
				'value'         => $user_data['site_count'],
4978
			);
4979
		}
4980
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
4981
		$args = stripslashes_deep( $args );
4982
		return $wp_xmlrpc_server->wp_getOptions( $args );
4983
	}
4984
4985
	function xmlrpc_options( $options ) {
4986
		$jetpack_client_id = false;
4987
		if ( self::is_active() ) {
4988
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
4989
		}
4990
		$options['jetpack_version'] = array(
4991
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
4992
				'readonly'      => true,
4993
				'value'         => JETPACK__VERSION,
4994
		);
4995
4996
		$options['jetpack_client_id'] = array(
4997
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
4998
				'readonly'      => true,
4999
				'value'         => $jetpack_client_id,
5000
		);
5001
		return $options;
5002
	}
5003
5004
	public static function clean_nonces( $all = false ) {
5005
		global $wpdb;
5006
5007
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5008
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5009
5010
		if ( true !== $all ) {
5011
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5012
			$sql_args[] = time() - 3600;
5013
		}
5014
5015
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5016
5017
		$sql = $wpdb->prepare( $sql, $sql_args );
5018
5019
		for ( $i = 0; $i < 1000; $i++ ) {
5020
			if ( ! $wpdb->query( $sql ) ) {
5021
				break;
5022
			}
5023
		}
5024
	}
5025
5026
	/**
5027
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5028
	 * SET: state( $key, $value );
5029
	 * GET: $value = state( $key );
5030
	 *
5031
	 * @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...
5032
	 * @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...
5033
	 * @param bool $restate private
5034
	 */
5035
	public static function state( $key = null, $value = null, $restate = false ) {
5036
		static $state = array();
5037
		static $path, $domain;
5038
		if ( ! isset( $path ) ) {
5039
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5040
			$admin_url = Jetpack::admin_url();
5041
			$bits      = parse_url( $admin_url );
5042
5043
			if ( is_array( $bits ) ) {
5044
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5045
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5046
			} else {
5047
				$path = $domain = null;
5048
			}
5049
		}
5050
5051
		// Extract state from cookies and delete cookies
5052
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5053
			$yum = $_COOKIE[ 'jetpackState' ];
5054
			unset( $_COOKIE[ 'jetpackState' ] );
5055
			foreach ( $yum as $k => $v ) {
5056
				if ( strlen( $v ) )
5057
					$state[ $k ] = $v;
5058
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5059
			}
5060
		}
5061
5062
		if ( $restate ) {
5063
			foreach ( $state as $k => $v ) {
5064
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5065
			}
5066
			return;
5067
		}
5068
5069
		// Get a state variable
5070
		if ( isset( $key ) && ! isset( $value ) ) {
5071
			if ( array_key_exists( $key, $state ) )
5072
				return $state[ $key ];
5073
			return null;
5074
		}
5075
5076
		// Set a state variable
5077
		if ( isset ( $key ) && isset( $value ) ) {
5078
			if( is_array( $value ) && isset( $value[0] ) ) {
5079
				$value = $value[0];
5080
			}
5081
			$state[ $key ] = $value;
5082
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5083
		}
5084
	}
5085
5086
	public static function restate() {
5087
		Jetpack::state( null, null, true );
5088
	}
5089
5090
	public static function check_privacy( $file ) {
5091
		static $is_site_publicly_accessible = null;
5092
5093
		if ( is_null( $is_site_publicly_accessible ) ) {
5094
			$is_site_publicly_accessible = false;
5095
5096
			Jetpack::load_xml_rpc_client();
5097
			$rpc = new Jetpack_IXR_Client();
5098
5099
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5100
			if ( $success ) {
5101
				$response = $rpc->getResponse();
5102
				if ( $response ) {
5103
					$is_site_publicly_accessible = true;
5104
				}
5105
			}
5106
5107
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5108
		}
5109
5110
		if ( $is_site_publicly_accessible ) {
5111
			return;
5112
		}
5113
5114
		$module_slug = self::get_module_slug( $file );
5115
5116
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5117
		if ( ! $privacy_checks ) {
5118
			$privacy_checks = $module_slug;
5119
		} else {
5120
			$privacy_checks .= ",$module_slug";
5121
		}
5122
5123
		Jetpack::state( 'privacy_checks', $privacy_checks );
5124
	}
5125
5126
	/**
5127
	 * Helper method for multicall XMLRPC.
5128
	 */
5129
	public static function xmlrpc_async_call() {
5130
		global $blog_id;
5131
		static $clients = array();
5132
5133
		$client_blog_id = is_multisite() ? $blog_id : 0;
5134
5135
		if ( ! isset( $clients[$client_blog_id] ) ) {
5136
			Jetpack::load_xml_rpc_client();
5137
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5138
			if ( function_exists( 'ignore_user_abort' ) ) {
5139
				ignore_user_abort( true );
5140
			}
5141
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5142
		}
5143
5144
		$args = func_get_args();
5145
5146
		if ( ! empty( $args[0] ) ) {
5147
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5148
		} elseif ( is_multisite() ) {
5149
			foreach ( $clients as $client_blog_id => $client ) {
5150
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5151
					continue;
5152
				}
5153
5154
				$switch_success = switch_to_blog( $client_blog_id, true );
5155
				if ( ! $switch_success ) {
5156
					continue;
5157
				}
5158
5159
				flush();
5160
				$client->query();
5161
5162
				restore_current_blog();
5163
			}
5164
		} else {
5165
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5166
				flush();
5167
				$clients[0]->query();
5168
			}
5169
		}
5170
	}
5171
5172
	public static function staticize_subdomain( $url ) {
5173
5174
		// Extract hostname from URL
5175
		$host = parse_url( $url, PHP_URL_HOST );
5176
5177
		// Explode hostname on '.'
5178
		$exploded_host = explode( '.', $host );
5179
5180
		// Retrieve the name and TLD
5181
		if ( count( $exploded_host ) > 1 ) {
5182
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5183
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5184
			// Rebuild domain excluding subdomains
5185
			$domain = $name . '.' . $tld;
5186
		} else {
5187
			$domain = $host;
5188
		}
5189
		// Array of Automattic domains
5190
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5191
5192
		// Return $url if not an Automattic domain
5193
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5194
			return $url;
5195
		}
5196
5197
		if ( is_ssl() ) {
5198
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5199
		}
5200
5201
		srand( crc32( basename( $url ) ) );
5202
		$static_counter = rand( 0, 2 );
5203
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5204
5205
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5206
	}
5207
5208
/* JSON API Authorization */
5209
5210
	/**
5211
	 * Handles the login action for Authorizing the JSON API
5212
	 */
5213
	function login_form_json_api_authorization() {
5214
		$this->verify_json_api_authorization_request();
5215
5216
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5217
5218
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5219
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5220
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5221
	}
5222
5223
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5224
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5225
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5226
			return $url;
5227
		}
5228
5229
		$parsed_url = parse_url( $url );
5230
		$url = strtok( $url, '?' );
5231
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5232
		if ( ! empty( $parsed_url['query'] ) )
5233
			$url .= "&{$parsed_url['query']}";
5234
5235
		return $url;
5236
	}
5237
5238
	// Make sure the POSTed request is handled by the same action
5239
	function preserve_action_in_login_form_for_json_api_authorization() {
5240
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5241
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5242
	}
5243
5244
	// If someone logs in to approve API access, store the Access Code in usermeta
5245
	function store_json_api_authorization_token( $user_login, $user ) {
5246
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5247
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5248
		$token = wp_generate_password( 32, false );
5249
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5250
	}
5251
5252
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5253
	function allow_wpcom_public_api_domain( $domains ) {
5254
		$domains[] = 'public-api.wordpress.com';
5255
		return $domains;
5256
	}
5257
5258
	// Add the Access Code details to the public-api.wordpress.com redirect
5259
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5260
		return add_query_arg(
5261
			urlencode_deep(
5262
				array(
5263
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5264
					'jetpack-user-id' => (int) $user->ID,
5265
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5266
				)
5267
			),
5268
			$redirect_to
5269
		);
5270
	}
5271
5272
5273
	/**
5274
	 * Verifies the request by checking the signature
5275
	 *
5276
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5277
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5278
	 *
5279
	 * @param null|array $environment
5280
	 */
5281
	function verify_json_api_authorization_request( $environment = null ) {
5282
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5283
5284
		$environment = is_null( $environment )
5285
			? $_REQUEST
5286
			: $environment;
5287
5288
		$token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
5289
		if ( ! $token || empty( $token->secret ) ) {
5290
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5291
		}
5292
5293
		$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' );
5294
5295
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5296
5297
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5298
			$signature = $jetpack_signature->sign_request(
5299
				$environment['token'],
5300
				$environment['timestamp'],
5301
				$environment['nonce'],
5302
				'',
5303
				'GET',
5304
				$environment['jetpack_json_api_original_query'],
5305
				null,
5306
				true
5307
			);
5308
		} else {
5309
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5310
		}
5311
5312
		if ( ! $signature ) {
5313
			wp_die( $die_error );
5314
		} else if ( is_wp_error( $signature ) ) {
5315
			wp_die( $die_error );
5316
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5317
			if ( is_ssl() ) {
5318
				// 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
5319
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5320
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5321
					wp_die( $die_error );
5322
				}
5323
			} else {
5324
				wp_die( $die_error );
5325
			}
5326
		}
5327
5328
		$timestamp = (int) $environment['timestamp'];
5329
		$nonce     = stripslashes( (string) $environment['nonce'] );
5330
5331
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5332
			// De-nonce the nonce, at least for 5 minutes.
5333
			// 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)
5334
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5335
			if ( $old_nonce_time < time() - 300 ) {
5336
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5337
			}
5338
		}
5339
5340
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5341
		$data_filters = array(
5342
			'state'        => 'opaque',
5343
			'client_id'    => 'int',
5344
			'client_title' => 'string',
5345
			'client_image' => 'url',
5346
		);
5347
5348
		foreach ( $data_filters as $key => $sanitation ) {
5349
			if ( ! isset( $data->$key ) ) {
5350
				wp_die( $die_error );
5351
			}
5352
5353
			switch ( $sanitation ) {
5354
			case 'int' :
5355
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5356
				break;
5357
			case 'opaque' :
5358
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5359
				break;
5360
			case 'string' :
5361
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5362
				break;
5363
			case 'url' :
5364
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5365
				break;
5366
			}
5367
		}
5368
5369
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5370
			wp_die( $die_error );
5371
		}
5372
	}
5373
5374
	function login_message_json_api_authorization( $message ) {
0 ignored issues
show
Unused Code introduced by
The parameter $message is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
5375
		return '<p class="message">' . sprintf(
5376
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5377
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5378
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5379
	}
5380
5381
	/**
5382
	 * Get $content_width, but with a <s>twist</s> filter.
5383
	 */
5384
	public static function get_content_width() {
5385
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5386
		/**
5387
		 * Filter the Content Width value.
5388
		 *
5389
		 * @since 2.2.3
5390
		 *
5391
		 * @param string $content_width Content Width value.
5392
		 */
5393
		return apply_filters( 'jetpack_content_width', $content_width );
5394
	}
5395
5396
	/**
5397
	 * Centralize the function here until it gets added to core.
5398
	 *
5399
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
5400
	 * @param int $size Size of the avatar image
5401
	 * @param string $default URL to a default image to use if no avatar is available
5402
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
5403
	 *
5404
	 * @return array First element is the URL, second is the class.
5405
	 */
5406
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
5407
		// Don't bother adding the __return_true filter if it's already there.
5408
		$has_filter = has_filter( 'pre_option_show_avatars', '__return_true' );
5409
5410
		if ( $force_display && ! $has_filter )
5411
			add_filter( 'pre_option_show_avatars', '__return_true' );
5412
5413
		$avatar = get_avatar( $id_or_email, $size, $default );
5414
5415
		if ( $force_display && ! $has_filter )
5416
			remove_filter( 'pre_option_show_avatars', '__return_true' );
5417
5418
		// If no data, fail out.
5419
		if ( is_wp_error( $avatar ) || ! $avatar )
5420
			return array( null, null );
5421
5422
		// Pull out the URL.  If it's not there, fail out.
5423
		if ( ! preg_match( '/src=["\']([^"\']+)["\']/', $avatar, $url_matches ) )
5424
			return array( null, null );
5425
		$url = wp_specialchars_decode( $url_matches[1], ENT_QUOTES );
5426
5427
		// Pull out the class, but it's not a big deal if it's missing.
5428
		$class = '';
5429
		if ( preg_match( '/class=["\']([^"\']+)["\']/', $avatar, $class_matches ) )
5430
			$class = wp_specialchars_decode( $class_matches[1], ENT_QUOTES );
5431
5432
		return array( $url, $class );
5433
	}
5434
5435
	/**
5436
	 * Pings the WordPress.com Mirror Site for the specified options.
5437
	 *
5438
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5439
	 *
5440
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5441
	 */
5442
	public function get_cloud_site_options( $option_names ) {
5443
		$option_names = array_filter( (array) $option_names, 'is_string' );
5444
5445
		Jetpack::load_xml_rpc_client();
5446
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
5447
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5448
		if ( $xml->isError() ) {
5449
			return array(
5450
				'error_code' => $xml->getErrorCode(),
5451
				'error_msg'  => $xml->getErrorMessage(),
5452
			);
5453
		}
5454
		$cloud_site_options = $xml->getResponse();
5455
5456
		return $cloud_site_options;
5457
	}
5458
5459
	/**
5460
	 * Checks if the site is currently in an identity crisis.
5461
	 *
5462
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5463
	 */
5464
	public static function check_identity_crisis() {
5465
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
5466
			return false;
5467
		}
5468
5469
		return Jetpack_Options::get_option( 'sync_error_idc' );
5470
	}
5471
5472
	/**
5473
	 * Checks whether the home and siteurl specifically are whitelisted
5474
	 * Written so that we don't have re-check $key and $value params every time
5475
	 * we want to check if this site is whitelisted, for example in footer.php
5476
	 *
5477
	 * @since  3.8.0
5478
	 * @return bool True = already whitelisted False = not whitelisted
5479
	 */
5480
	public static function is_staging_site() {
5481
		$is_staging = false;
5482
5483
		$known_staging = array(
5484
			'urls' => array(
5485
				'#\.staging\.wpengine\.com$#i', // WP Engine
5486
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
5487
				),
5488
			'constants' => array(
5489
				'IS_WPE_SNAPSHOT',      // WP Engine
5490
				'KINSTA_DEV_ENV',       // Kinsta.com
5491
				'WPSTAGECOACH_STAGING', // WP Stagecoach
5492
				'JETPACK_STAGING_MODE', // Generic
5493
				)
5494
			);
5495
		/**
5496
		 * Filters the flags of known staging sites.
5497
		 *
5498
		 * @since 3.9.0
5499
		 *
5500
		 * @param array $known_staging {
5501
		 *     An array of arrays that each are used to check if the current site is staging.
5502
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
5503
		 *     @type array $constants PHP constants of known staging/developement environments.
5504
		 *  }
5505
		 */
5506
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
5507
5508
		if ( isset( $known_staging['urls'] ) ) {
5509
			foreach ( $known_staging['urls'] as $url ){
5510
				if ( preg_match( $url, site_url() ) ) {
5511
					$is_staging = true;
5512
					break;
5513
				}
5514
			}
5515
		}
5516
5517
		if ( isset( $known_staging['constants'] ) ) {
5518
			foreach ( $known_staging['constants'] as $constant ) {
5519
				if ( defined( $constant ) && constant( $constant ) ) {
5520
					$is_staging = true;
5521
				}
5522
			}
5523
		}
5524
5525
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
5526
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
5527
			$is_staging = true;
5528
		}
5529
5530
		/**
5531
		 * Filters is_staging_site check.
5532
		 *
5533
		 * @since 3.9.0
5534
		 *
5535
		 * @param bool $is_staging If the current site is a staging site.
5536
		 */
5537
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
5538
	}
5539
5540
	/**
5541
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
5542
	 *
5543
	 * @return bool
5544
	 */
5545
	public static function validate_sync_error_idc_option() {
5546
		$is_valid = false;
5547
5548
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
5549
		if ( false === $idc_allowed ) {
5550
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
5551
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
5552
				$json = json_decode( wp_remote_retrieve_body( $response ) );
5553
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
5554
				$transient_duration = HOUR_IN_SECONDS;
5555
			} else {
5556
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
5557
				$idc_allowed = '1';
5558
				$transient_duration = 5 * MINUTE_IN_SECONDS;
5559
			}
5560
5561
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
5562
		}
5563
5564
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
5565
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
5566
		$local_options = self::get_sync_error_idc_option();
5567
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
5568
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
5569
				$is_valid = true;
5570
			}
5571
		}
5572
5573
		/**
5574
		 * Filters whether the sync_error_idc option is valid.
5575
		 *
5576
		 * @since 4.4.0
5577
		 *
5578
		 * @param bool $is_valid If the sync_error_idc is valid or not.
5579
		 */
5580
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
5581
5582
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
5583
			// Since the option exists, and did not validate, delete it
5584
			Jetpack_Options::delete_option( 'sync_error_idc' );
5585
		}
5586
5587
		return $is_valid;
5588
	}
5589
5590
	/**
5591
	 * Normalizes a url by doing three things:
5592
	 *  - Strips protocol
5593
	 *  - Strips www
5594
	 *  - Adds a trailing slash
5595
	 *
5596
	 * @since 4.4.0
5597
	 * @param string $url
5598
	 * @return WP_Error|string
5599
	 */
5600
	public static function normalize_url_protocol_agnostic( $url ) {
5601
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
5602
		if ( ! $parsed_url ) {
5603
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
5604
		}
5605
5606
		// Strip www and protocols
5607
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
5608
		return $url;
5609
	}
5610
5611
	/**
5612
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
5613
	 *
5614
	 * @since 4.4.0
5615
	 *
5616
	 * @param array $response
5617
	 * @return array Array of the local urls, wpcom urls, and error code
5618
	 */
5619
	public static function get_sync_error_idc_option( $response = array() ) {
5620
		$local_options = array(
5621
			'home' => get_home_url(),
5622
			'siteurl' => get_site_url(),
5623
		);
5624
5625
		$options = array_merge( $local_options, $response );
5626
5627
		$returned_values = array();
5628
		foreach( $options as $key => $option ) {
5629
			if ( 'error_code' === $key ) {
5630
				$returned_values[ $key ] = $option;
5631
				continue;
5632
			}
5633
5634
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
5635
				continue;
5636
			}
5637
5638
			$returned_values[ $key ] = $normalized_url;
5639
		}
5640
5641
		return $returned_values;
5642
	}
5643
5644
	/**
5645
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
5646
	 * If set to true, the site will be put into staging mode.
5647
	 *
5648
	 * @since 4.3.2
5649
	 * @return bool
5650
	 */
5651
	public static function sync_idc_optin() {
5652
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
5653
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
5654
		} else {
5655
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
5656
		}
5657
5658
		/**
5659
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
5660
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
5661
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
5662
		 *
5663
		 * @since 4.3.2
5664
		 *
5665
		 * @param bool $default Whether the site is opted in to IDC mitigation.
5666
		 */
5667
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
5668
	}
5669
5670
	/**
5671
	 * Maybe Use a .min.css stylesheet, maybe not.
5672
	 *
5673
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
5674
	 */
5675
	public static function maybe_min_asset( $url, $path, $plugin ) {
5676
		// Short out on things trying to find actual paths.
5677
		if ( ! $path || empty( $plugin ) ) {
5678
			return $url;
5679
		}
5680
5681
		// Strip out the abspath.
5682
		$base = dirname( plugin_basename( $plugin ) );
5683
5684
		// Short out on non-Jetpack assets.
5685
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
5686
			return $url;
5687
		}
5688
5689
		// File name parsing.
5690
		$file              = "{$base}/{$path}";
5691
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
5692
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
5693
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
5694
		$extension         = array_shift( $file_name_parts_r );
5695
5696
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
5697
			// Already pointing at the minified version.
5698
			if ( 'min' === $file_name_parts_r[0] ) {
5699
				return $url;
5700
			}
5701
5702
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
5703
			if ( file_exists( $min_full_path ) ) {
5704
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
5705
			}
5706
		}
5707
5708
		return $url;
5709
	}
5710
5711
	/**
5712
	 * Maybe inlines a stylesheet.
5713
	 *
5714
	 * If you'd like to inline a stylesheet instead of printing a link to it,
5715
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
5716
	 *
5717
	 * Attached to `style_loader_tag` filter.
5718
	 *
5719
	 * @param string $tag The tag that would link to the external asset.
5720
	 * @param string $handle The registered handle of the script in question.
5721
	 *
5722
	 * @return string
5723
	 */
5724
	public static function maybe_inline_style( $tag, $handle ) {
5725
		global $wp_styles;
5726
		$item = $wp_styles->registered[ $handle ];
5727
5728
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
5729
			return $tag;
5730
		}
5731
5732
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
5733
			$href = $matches[1];
5734
			// Strip off query string
5735
			if ( $pos = strpos( $href, '?' ) ) {
5736
				$href = substr( $href, 0, $pos );
5737
			}
5738
			// Strip off fragment
5739
			if ( $pos = strpos( $href, '#' ) ) {
5740
				$href = substr( $href, 0, $pos );
5741
			}
5742
		} else {
5743
			return $tag;
5744
		}
5745
5746
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
5747
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
5748
			return $tag;
5749
		}
5750
5751
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
5752
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
5753
			// And this isn't the pass that actually deals with the RTL version...
5754
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
5755
				// Short out, as the RTL version will deal with it in a moment.
5756
				return $tag;
5757
			}
5758
		}
5759
5760
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
5761
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
5762
		if ( $css ) {
5763
			$tag = "<!-- Inline {$item->handle} -->\r\n";
5764
			if ( empty( $item->extra['after'] ) ) {
5765
				wp_add_inline_style( $handle, $css );
5766
			} else {
5767
				array_unshift( $item->extra['after'], $css );
5768
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
5769
			}
5770
		}
5771
5772
		return $tag;
5773
	}
5774
5775
	/**
5776
	 * Loads a view file from the views
5777
	 *
5778
	 * Data passed in with the $data parameter will be available in the
5779
	 * template file as $data['value']
5780
	 *
5781
	 * @param string $template - Template file to load
5782
	 * @param array $data - Any data to pass along to the template
5783
	 * @return boolean - If template file was found
5784
	 **/
5785
	public function load_view( $template, $data = array() ) {
5786
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
5787
5788
		if( file_exists( $views_dir . $template ) ) {
5789
			require_once( $views_dir . $template );
5790
			return true;
5791
		}
5792
5793
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
5794
		return false;
5795
	}
5796
5797
	/**
5798
	 * Throws warnings for deprecated hooks to be removed from Jetpack
5799
	 */
5800
	public function deprecated_hooks() {
5801
		global $wp_filter;
5802
5803
		/*
5804
		 * Format:
5805
		 * deprecated_filter_name => replacement_name
5806
		 *
5807
		 * If there is no replacement, use null for replacement_name
5808
		 */
5809
		$deprecated_list = array(
5810
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
5811
			'wpl_sharing_2014_1'                                     => null,
5812
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
5813
			'jetpack_identity_crisis_options_to_check'               => null,
5814
			'update_option_jetpack_single_user_site'                 => null,
5815
			'audio_player_default_colors'                            => null,
5816
			'add_option_jetpack_featured_images_enabled'             => null,
5817
			'add_option_jetpack_update_details'                      => null,
5818
			'add_option_jetpack_updates'                             => null,
5819
			'add_option_jetpack_network_name'                        => null,
5820
			'add_option_jetpack_network_allow_new_registrations'     => null,
5821
			'add_option_jetpack_network_add_new_users'               => null,
5822
			'add_option_jetpack_network_site_upload_space'           => null,
5823
			'add_option_jetpack_network_upload_file_types'           => null,
5824
			'add_option_jetpack_network_enable_administration_menus' => null,
5825
			'add_option_jetpack_is_multi_site'                       => null,
5826
			'add_option_jetpack_is_main_network'                     => null,
5827
			'add_option_jetpack_main_network_site'                   => null,
5828
			'jetpack_sync_all_registered_options'                    => null,
5829
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
5830
			'jetpack_is_post_mailable'                               => null,
5831
		);
5832
5833
		// This is a silly loop depth. Better way?
5834
		foreach( $deprecated_list AS $hook => $hook_alt ) {
5835
			if ( has_action( $hook ) ) {
5836
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
5837
					foreach( $values AS $hooked ) {
5838
						if ( is_callable( $hooked['function'] ) ) {
5839
							$function_name = 'an anonymous function';
5840
						} else {
5841
							$function_name = $hooked['function'];
5842
						}
5843
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
5844
					}
5845
				}
5846
			}
5847
		}
5848
	}
5849
5850
	/**
5851
	 * Converts any url in a stylesheet, to the correct absolute url.
5852
	 *
5853
	 * Considerations:
5854
	 *  - Normal, relative URLs     `feh.png`
5855
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
5856
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
5857
	 *  - Absolute URLs             `http://domain.com/feh.png`
5858
	 *  - Domain root relative URLs `/feh.png`
5859
	 *
5860
	 * @param $css string: The raw CSS -- should be read in directly from the file.
5861
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
5862
	 *
5863
	 * @return mixed|string
5864
	 */
5865
	public static function absolutize_css_urls( $css, $css_file_url ) {
5866
		$pattern = '#url\((?P<path>[^)]*)\)#i';
5867
		$css_dir = dirname( $css_file_url );
5868
		$p       = parse_url( $css_dir );
5869
		$domain  = sprintf(
5870
					'%1$s//%2$s%3$s%4$s',
5871
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
5872
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
5873
					$p['host'],
5874
					isset( $p['port'] )             ? ":{$p['port']}" : ''
5875
				);
5876
5877
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
5878
			$find = $replace = array();
5879
			foreach ( $matches as $match ) {
5880
				$url = trim( $match['path'], "'\" \t" );
5881
5882
				// If this is a data url, we don't want to mess with it.
5883
				if ( 'data:' === substr( $url, 0, 5 ) ) {
5884
					continue;
5885
				}
5886
5887
				// If this is an absolute or protocol-agnostic url,
5888
				// we don't want to mess with it.
5889
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
5890
					continue;
5891
				}
5892
5893
				switch ( substr( $url, 0, 1 ) ) {
5894
					case '/':
5895
						$absolute = $domain . $url;
5896
						break;
5897
					default:
5898
						$absolute = $css_dir . '/' . $url;
5899
				}
5900
5901
				$find[]    = $match[0];
5902
				$replace[] = sprintf( 'url("%s")', $absolute );
5903
			}
5904
			$css = str_replace( $find, $replace, $css );
5905
		}
5906
5907
		return $css;
5908
	}
5909
5910
	/**
5911
	 * This methods removes all of the registered css files on the front end
5912
	 * from Jetpack in favor of using a single file. In effect "imploding"
5913
	 * all the files into one file.
5914
	 *
5915
	 * Pros:
5916
	 * - Uses only ONE css asset connection instead of 15
5917
	 * - Saves a minimum of 56k
5918
	 * - Reduces server load
5919
	 * - Reduces time to first painted byte
5920
	 *
5921
	 * Cons:
5922
	 * - Loads css for ALL modules. However all selectors are prefixed so it
5923
	 *		should not cause any issues with themes.
5924
	 * - Plugins/themes dequeuing styles no longer do anything. See
5925
	 *		jetpack_implode_frontend_css filter for a workaround
5926
	 *
5927
	 * For some situations developers may wish to disable css imploding and
5928
	 * instead operate in legacy mode where each file loads seperately and
5929
	 * can be edited individually or dequeued. This can be accomplished with
5930
	 * the following line:
5931
	 *
5932
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
5933
	 *
5934
	 * @since 3.2
5935
	 **/
5936
	public function implode_frontend_css( $travis_test = false ) {
5937
		$do_implode = true;
5938
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
5939
			$do_implode = false;
5940
		}
5941
5942
		/**
5943
		 * Allow CSS to be concatenated into a single jetpack.css file.
5944
		 *
5945
		 * @since 3.2.0
5946
		 *
5947
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
5948
		 */
5949
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
5950
5951
		// Do not use the imploded file when default behaviour was altered through the filter
5952
		if ( ! $do_implode ) {
5953
			return;
5954
		}
5955
5956
		// We do not want to use the imploded file in dev mode, or if not connected
5957
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
5958
			if ( ! $travis_test ) {
5959
				return;
5960
			}
5961
		}
5962
5963
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
5964
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
5965
			return;
5966
		}
5967
5968
		/*
5969
		 * Now we assume Jetpack is connected and able to serve the single
5970
		 * file.
5971
		 *
5972
		 * In the future there will be a check here to serve the file locally
5973
		 * or potentially from the Jetpack CDN
5974
		 *
5975
		 * For now:
5976
		 * - Enqueue a single imploded css file
5977
		 * - Zero out the style_loader_tag for the bundled ones
5978
		 * - Be happy, drink scotch
5979
		 */
5980
5981
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
5982
5983
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
5984
5985
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
5986
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
5987
	}
5988
5989
	function concat_remove_style_loader_tag( $tag, $handle ) {
5990
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
5991
			$tag = '';
5992
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
5993
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
5994
			}
5995
		}
5996
5997
		return $tag;
5998
	}
5999
6000
	/*
6001
	 * Check the heartbeat data
6002
	 *
6003
	 * Organizes the heartbeat data by severity.  For example, if the site
6004
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6005
	 *
6006
	 * Data will be added to "caution" array, if it either:
6007
	 *  - Out of date Jetpack version
6008
	 *  - Out of date WP version
6009
	 *  - Out of date PHP version
6010
	 *
6011
	 * $return array $filtered_data
6012
	 */
6013
	public static function jetpack_check_heartbeat_data() {
6014
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6015
6016
		$good    = array();
6017
		$caution = array();
6018
		$bad     = array();
6019
6020
		foreach ( $raw_data as $stat => $value ) {
6021
6022
			// Check jetpack version
6023
			if ( 'version' == $stat ) {
6024
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6025
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6026
					continue;
6027
				}
6028
			}
6029
6030
			// Check WP version
6031
			if ( 'wp-version' == $stat ) {
6032
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6033
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6034
					continue;
6035
				}
6036
			}
6037
6038
			// Check PHP version
6039
			if ( 'php-version' == $stat ) {
6040
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6041
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6042
					continue;
6043
				}
6044
			}
6045
6046
			// Check ID crisis
6047
			if ( 'identitycrisis' == $stat ) {
6048
				if ( 'yes' == $value ) {
6049
					$bad[ $stat ] = $value;
6050
					continue;
6051
				}
6052
			}
6053
6054
			// The rest are good :)
6055
			$good[ $stat ] = $value;
6056
		}
6057
6058
		$filtered_data = array(
6059
			'good'    => $good,
6060
			'caution' => $caution,
6061
			'bad'     => $bad
6062
		);
6063
6064
		return $filtered_data;
6065
	}
6066
6067
6068
	/*
6069
	 * This method is used to organize all options that can be reset
6070
	 * without disconnecting Jetpack.
6071
	 *
6072
	 * It is used in class.jetpack-cli.php to reset options
6073
	 *
6074
	 * @return array of options to delete.
6075
	 */
6076
	public static function get_jetpack_options_for_reset() {
6077
		$jetpack_options            = Jetpack_Options::get_option_names();
6078
		$jetpack_options_non_compat = Jetpack_Options::get_option_names( 'non_compact' );
6079
		$jetpack_options_private    = Jetpack_Options::get_option_names( 'private' );
6080
6081
		$all_jp_options = array_merge( $jetpack_options, $jetpack_options_non_compat, $jetpack_options_private );
6082
6083
		// A manual build of the wp options
6084
		$wp_options = array(
6085
			'sharing-options',
6086
			'disabled_likes',
6087
			'disabled_reblogs',
6088
			'jetpack_comments_likes_enabled',
6089
			'wp_mobile_excerpt',
6090
			'wp_mobile_featured_images',
6091
			'wp_mobile_app_promos',
6092
			'stats_options',
6093
			'stats_dashboard_widget',
6094
			'safecss_preview_rev',
6095
			'safecss_rev',
6096
			'safecss_revision_migrated',
6097
			'nova_menu_order',
6098
			'jetpack_portfolio',
6099
			'jetpack_portfolio_posts_per_page',
6100
			'jetpack_testimonial',
6101
			'jetpack_testimonial_posts_per_page',
6102
			'wp_mobile_custom_css',
6103
			'sharedaddy_disable_resources',
6104
			'sharing-options',
6105
			'sharing-services',
6106
			'site_icon_temp_data',
6107
			'featured-content',
6108
			'site_logo',
6109
			'jetpack_dismissed_notices',
6110
		);
6111
6112
		// Flag some Jetpack options as unsafe
6113
		$unsafe_options = array(
6114
			'id',                           // (int)    The Client ID/WP.com Blog ID of this site.
6115
			'master_user',                  // (int)    The local User ID of the user who connected this site to jetpack.wordpress.com.
6116
			'version',                      // (string) Used during upgrade procedure to auto-activate new modules. version:time
6117
			'jumpstart',                    // (string) A flag for whether or not to show the Jump Start.  Accepts: new_connection, jumpstart_activated, jetpack_action_taken, jumpstart_dismissed.
6118
6119
			// non_compact
6120
			'activated',
6121
6122
			// private
6123
			'register',
6124
			'blog_token',                  // (string) The Client Secret/Blog Token of this site.
6125
			'user_token',                  // (string) The User Token of this site. (deprecated)
6126
			'user_tokens'
6127
		);
6128
6129
		// Remove the unsafe Jetpack options
6130
		foreach ( $unsafe_options as $unsafe_option ) {
6131
			if ( false !== ( $key = array_search( $unsafe_option, $all_jp_options ) ) ) {
6132
				unset( $all_jp_options[ $key ] );
6133
			}
6134
		}
6135
6136
		$options = array(
6137
			'jp_options' => $all_jp_options,
6138
			'wp_options' => $wp_options
6139
		);
6140
6141
		return $options;
6142
	}
6143
6144
	/**
6145
	 * Check if an option of a Jetpack module has been updated.
6146
	 *
6147
	 * If any module option has been updated before Jump Start has been dismissed,
6148
	 * update the 'jumpstart' option so we can hide Jump Start.
6149
	 *
6150
	 * @param string $option_name
6151
	 *
6152
	 * @return bool
6153
	 */
6154
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6155
		// Bail if Jump Start has already been dismissed
6156
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6157
			return false;
6158
		}
6159
6160
		$jetpack = Jetpack::init();
6161
6162
		// Manual build of module options
6163
		$option_names = self::get_jetpack_options_for_reset();
6164
6165
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6166
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6167
6168
			//Jump start is being dismissed send data to MC Stats
6169
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6170
6171
			$jetpack->do_stats( 'server_side' );
6172
		}
6173
6174
	}
6175
6176
	/*
6177
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6178
	 * so we can bring them directly to their site in calypso.
6179
	 *
6180
	 * @param string | url
6181
	 * @return string | url without the guff
6182
	 */
6183
	public static function build_raw_urls( $url ) {
6184
		$strip_http = '/.*?:\/\//i';
6185
		$url = preg_replace( $strip_http, '', $url  );
6186
		$url = str_replace( '/', '::', $url );
6187
		return $url;
6188
	}
6189
6190
	/**
6191
	 * Stores and prints out domains to prefetch for page speed optimization.
6192
	 *
6193
	 * @param mixed $new_urls
6194
	 */
6195
	public static function dns_prefetch( $new_urls = null ) {
6196
		static $prefetch_urls = array();
6197
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6198
			echo "\r\n";
6199
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6200
				printf( "<link rel='dns-prefetch' href='%s'>\r\n", esc_attr( $this_prefetch_url ) );
6201
			}
6202
		} elseif ( ! empty( $new_urls ) ) {
6203
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6204
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6205
			}
6206
			foreach ( (array) $new_urls as $this_new_url ) {
6207
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6208
			}
6209
			$prefetch_urls = array_unique( $prefetch_urls );
6210
		}
6211
	}
6212
6213
	public function wp_dashboard_setup() {
6214
		if ( self::is_active() ) {
6215
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6216
			$widget_title = __( 'Site Stats', 'jetpack' );
6217
		} elseif ( ! self::is_development_mode() && current_user_can( 'jetpack_connect' ) ) {
6218
			add_action( 'jetpack_dashboard_widget', array( $this, 'dashboard_widget_connect_to_wpcom' ) );
6219
			$widget_title = __( 'Please Connect Jetpack', 'jetpack' );
6220
		}
6221
6222
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6223
			wp_add_dashboard_widget(
6224
				'jetpack_summary_widget',
6225
				$widget_title,
0 ignored issues
show
Bug introduced by
The variable $widget_title 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...
6226
				array( __CLASS__, 'dashboard_widget' )
6227
			);
6228
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6229
6230
			// If we're inactive and not in development mode, sort our box to the top.
6231
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6232
				global $wp_meta_boxes;
6233
6234
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6235
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6236
6237
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6238
			}
6239
		}
6240
	}
6241
6242
	/**
6243
	 * @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...
6244
	 * @return mixed
6245
	 */
6246
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6247
		if ( ! is_array( $sorted ) ) {
6248
			return $sorted;
6249
		}
6250
6251
		foreach ( $sorted as $box_context => $ids ) {
6252
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6253
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6254
				continue;
6255
			}
6256
6257
			$ids_array = explode( ',', $ids );
6258
			$key = array_search( 'dashboard_stats', $ids_array );
6259
6260
			if ( false !== $key ) {
6261
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6262
				$ids_array[ $key ] = 'jetpack_summary_widget';
6263
				$sorted[ $box_context ] = implode( ',', $ids_array );
6264
				// We've found it, stop searching, and just return.
6265
				break;
6266
			}
6267
		}
6268
6269
		return $sorted;
6270
	}
6271
6272
	public static function dashboard_widget() {
6273
		/**
6274
		 * Fires when the dashboard is loaded.
6275
		 *
6276
		 * @since 3.4.0
6277
		 */
6278
		do_action( 'jetpack_dashboard_widget' );
6279
	}
6280
6281
	public static function dashboard_widget_footer() {
6282
		?>
6283
		<footer>
6284
6285
		<div class="protect">
6286
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6287
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6288
				<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>
6289
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6290
				<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' ); ?>">
6291
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6292
				</a>
6293
			<?php else : ?>
6294
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6295
			<?php endif; ?>
6296
		</div>
6297
6298
		<div class="akismet">
6299
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6300
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6301
				<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>
6302
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6303
				<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">
6304
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6305
				</a>
6306
			<?php else : ?>
6307
				<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>
6308
			<?php endif; ?>
6309
		</div>
6310
6311
		</footer>
6312
		<?php
6313
	}
6314
6315
	public function dashboard_widget_connect_to_wpcom() {
6316
		if ( Jetpack::is_active() || Jetpack::is_development_mode() || ! current_user_can( 'jetpack_connect' ) ) {
6317
			return;
6318
		}
6319
		?>
6320
		<div class="wpcom-connect">
6321
			<div class="jp-emblem">
6322
			<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0" y="0" viewBox="0 0 172.9 172.9" enable-background="new 0 0 172.9 172.9" xml:space="preserve">
6323
				<path d="M86.4 0C38.7 0 0 38.7 0 86.4c0 47.7 38.7 86.4 86.4 86.4s86.4-38.7 86.4-86.4C172.9 38.7 134.2 0 86.4 0zM83.1 106.6l-27.1-6.9C49 98 45.7 90.1 49.3 84l33.8-58.5V106.6zM124.9 88.9l-33.8 58.5V66.3l27.1 6.9C125.1 74.9 128.4 82.8 124.9 88.9z"/>
6324
			</svg>
6325
			</div>
6326
			<h3><?php esc_html_e( 'Please Connect Jetpack', 'jetpack' ); ?></h3>
6327
			<p><?php echo wp_kses( __( 'Connecting Jetpack will show you <strong>stats</strong> about your traffic, <strong>protect</strong> you from brute force attacks, <strong>speed up</strong> your images and photos, and enable other <strong>traffic and security</strong> features.', 'jetpack' ), 'jetpack' ) ?></p>
6328
6329
			<div class="actions">
6330
				<a href="<?php echo $this->build_connect_url( false, false, 'widget-btn' ); ?>" class="button button-primary">
6331
					<?php esc_html_e( 'Connect Jetpack', 'jetpack' ); ?>
6332
				</a>
6333
			</div>
6334
		</div>
6335
		<?php
6336
	}
6337
6338
	/**
6339
	 * Return string containing the Jetpack logo.
6340
	 *
6341
	 * @since 3.9.0
6342
	 *
6343
	 * @return string
6344
	 */
6345
	public static function get_jp_emblem() {
6346
		return '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" id="Layer_1" x="0" y="0" viewBox="0 0 172.9 172.9" enable-background="new 0 0 172.9 172.9" xml:space="preserve">	<path d="M86.4 0C38.7 0 0 38.7 0 86.4c0 47.7 38.7 86.4 86.4 86.4s86.4-38.7 86.4-86.4C172.9 38.7 134.2 0 86.4 0zM83.1 106.6l-27.1-6.9C49 98 45.7 90.1 49.3 84l33.8-58.5V106.6zM124.9 88.9l-33.8 58.5V66.3l27.1 6.9C125.1 74.9 128.4 82.8 124.9 88.9z" /></svg>';
6347
	}
6348
6349
	/*
6350
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6351
	 */
6352
	function jetpack_icon_user_connected( $columns ) {
6353
		$columns['user_jetpack'] = '';
6354
		return $columns;
6355
	}
6356
6357
	/*
6358
	 * Show Jetpack icon if the user is linked.
6359
	 */
6360
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6361
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6362
			$emblem_html = sprintf(
6363
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6364
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6365
				Jetpack::get_jp_emblem()
6366
			);
6367
			return $emblem_html;
6368
		}
6369
6370
		return $val;
6371
	}
6372
6373
	/*
6374
	 * Style the Jetpack user column
6375
	 */
6376
	function jetpack_user_col_style() {
6377
		global $current_screen;
6378
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6379
			<style>
6380
				.fixed .column-user_jetpack {
6381
					width: 21px;
6382
				}
6383
				.jp-emblem-user-admin svg {
6384
					width: 20px;
6385
					height: 20px;
6386
				}
6387
				.jp-emblem-user-admin path {
6388
					fill: #8cc258;
6389
				}
6390
			</style>
6391
		<?php }
6392
	}
6393
}
6394