Completed
Push — update/allow-enabling-modules-... ( bb2f33 )
by Marin
09:30
created

Jetpack   F

Complexity

Total Complexity 1105

Size/Duplication

Total Lines 6978
Duplicated Lines 3 %

Coupling/Cohesion

Components 5
Dependencies 23

Importance

Changes 0
Metric Value
dl 209
loc 6978
rs 0.6197
c 0
b 0
f 0
wmc 1105
lcom 5
cbo 23

235 Methods

Rating   Name   Duplication   Size   Complexity  
A init() 0 9 2
C plugin_upgrade() 0 43 8
B upgrade_on_load() 0 27 5
A activate_manage() 0 7 4
B update_active_modules() 0 54 5
A delete_active_modules() 0 3 1
F __construct() 0 171 21
B point_edit_post_links_to_calypso() 0 28 3
A point_edit_comment_links_to_calypso() 0 8 1
B jetpack_track_last_sync_callback() 0 22 5
A jetpack_connection_banner_callback() 0 10 2
C jetpack_admin_ajax_tracks_callback() 0 23 8
C jetpack_jitm_ajax_callback() 18 57 12
A push_stats() 0 5 2
C jetpack_custom_caps() 0 66 20
A require_jetpack_authentication() 0 11 2
A plugin_textdomain() 0 4 1
C register_assets() 10 79 8
C guess_locale_from_lang() 7 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
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
A get_avatar_url() 0 8 1
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
C get_active_plan() 0 71 8
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 9 1
A user_role_change() 0 4 1
D load_modules() 6 88 16
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 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 28 6
A translate_module_tag() 0 3 1
A get_translated_modules() 0 13 4
B get_active_modules() 0 20 7
A is_module_active() 0 3 1
A is_module() 0 3 2
A catch_errors() 0 13 2
A catch_errors_on_shutdown() 0 3 1
A alias_directories() 0 8 1
F activate_default_modules() 21 136 21
D activate_module() 8 94 17
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 17 3
C get_activation_source() 0 49 14
A do_version_bump() 0 7 2
A plugin_initialize() 6 17 3
A plugin_deactivation() 0 9 2
B disconnect() 0 61 6
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 admin_body_class() 0 8 2
A add_jetpack_pagestyles() 0 3 1
A prepare_manage_jetpack_notice() 0 5 1
A manage_activate_screen() 0 3 1
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 4 1
C remote_request_handlers() 0 40 7
F upload_handler() 0 122 24
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 257 54
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_user_to_role() 0 9 4
A translate_role_to_cap() 0 7 2
B sign_role() 0 16 5
F build_connect_url() 0 121 20
A apply_activation_source_to_args() 0 11 3
A build_reconnect_url() 0 4 2
A admin_url() 0 5 1
A nonce_url_no_esc() 0 4 1
C dismiss_jetpack_notice() 30 74 15
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
A create_onboarding_token() 0 8 2
A invalidate_onboarding_token() 0 3 1
A validate_onboarding_token_action() 0 18 3
C permit_ssl() 0 42 11
A alert_auto_ssl_fail() 0 49 2
A xmlrpc_api_url() 0 4 1
B generate_secrets() 0 26 4
A get_secrets() 0 15 3
A delete_secrets() 0 8 2
A get_remote_query_timeout_limit() 0 4 1
A get_max_execution_time() 0 9 2
A set_min_time_limit() 0 8 2
C validate_remote_register_response() 0 40 13
C register() 9 104 12
A maybe_set_version_option() 0 14 3
A load_xml_rpc_client() 0 4 1
A reset_saved_auth_state() 0 4 1
D verify_xml_rpc_signature() 0 123 35
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 93 21
A login_message_json_api_authorization() 0 6 1
A get_content_width() 0 11 2
A get_cloud_site_options() 0 16 2
A check_identity_crisis() 0 7 4
C is_staging_site() 0 59 10
C validate_sync_error_idc_option() 0 44 13
A normalize_url_protocol_agnostic() 0 10 4
B get_sync_error_idc_option() 0 33 5
A sync_idc_optin() 0 18 3
C maybe_min_asset() 0 42 8
B set_suffix_on_min() 0 16 5
C maybe_inline_style() 0 50 13
A load_view() 0 11 2
B deprecated_hooks() 0 50 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 3 1
A jumpstart_has_updated_module_option() 0 21 3
A build_raw_urls() 0 6 1
B dns_prefetch() 0 17 7
B wp_dashboard_setup() 0 24 5
B get_user_option_meta_box_order_dashboard() 0 25 5
A dashboard_widget() 0 8 1
C dashboard_widget_footer() 0 33 7
A get_jp_emblem() 0 3 1
A jetpack_icon_user_connected() 0 4 1
A jetpack_show_user_connected_icon() 0 12 3
A jetpack_user_col_style() 0 17 3
A is_akismet_active() 0 6 3
B is_function_in_backtrace() 0 23 5
A get_file_url_for_environment() 0 7 3
B is_rewind_enabled() 0 19 6

How to fix   Duplicated Code    Complexity   

Duplicated Code

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

Common duplication problems, and corresponding solutions are:

Complex Class

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

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

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

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

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

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

class A {
    var $property;
}

the property is implicitly global.

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

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

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
696
697
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
698
	}
699
700
	function point_edit_comment_links_to_calypso( $url ) {
701
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
702
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

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

Loading history...
703
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d?action=edit',
704
			Jetpack::build_raw_urls( get_home_url() ),
705
			$query_args['amp;c']
706
		) );
707
	}
708
709
	function jetpack_track_last_sync_callback( $params ) {
710
		/**
711
		 * Filter to turn off jitm caching
712
		 *
713
		 * @since 5.4.0
714
		 *
715
		 * @param bool false Whether to cache just in time messages
716
		 */
717
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
718
			return $params;
719
		}
720
721
		if ( is_array( $params ) && isset( $params[0] ) ) {
722
			$option = $params[0];
723
			if ( 'active_plugins' === $option ) {
724
				// use the cache if we can, but not terribly important if it gets evicted
725
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
726
			}
727
		}
728
729
		return $params;
730
	}
731
732
	function jetpack_connection_banner_callback() {
733
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
734
735
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
736
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
737
			wp_send_json_success();
738
		}
739
740
		wp_die();
741
	}
742
743
	function jetpack_admin_ajax_tracks_callback() {
744
		// Check for nonce
745
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
746
			wp_die( 'Permissions check failed.' );
747
		}
748
749
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
750
			wp_die( 'No valid event name or type.' );
751
		}
752
753
		$tracks_data = array();
754
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
755
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
756
				$tracks_data = $_REQUEST['tracksEventProp'];
757
			} else {
758
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
759
			}
760
		}
761
762
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
763
		wp_send_json_success();
764
		wp_die();
765
	}
766
767
	/**
768
	 * The callback for the JITM ajax requests.
769
	 */
770
	function jetpack_jitm_ajax_callback() {
771
		// Check for nonce
772
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
773
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
774
		}
775
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
776
			$module_slug = $_REQUEST['jitmModule'];
777
			Jetpack::log( 'activate', $module_slug );
778
			Jetpack::activate_module( $module_slug, false, false );
779
			Jetpack::state( 'message', 'no_message' );
780
781
			//A Jetpack module is being activated through a JITM, track it
782
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
783
			$this->do_stats( 'server_side' );
784
785
			wp_send_json_success();
786
		}
787
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
788
			// get the hide_jitm options array
789
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
790
			$module_slug = $_REQUEST['jitmModule'];
791
792
			if( ! $jetpack_hide_jitm ) {
793
				$jetpack_hide_jitm = array(
794
					$module_slug => 'hide'
795
				);
796
			} else {
797
				$jetpack_hide_jitm[$module_slug] = 'hide';
798
			}
799
800
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
801
802
			//jitm is being dismissed forever, track it
803
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
804
			$this->do_stats( 'server_side' );
805
806
			wp_send_json_success();
807
		}
808 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
809
			$module_slug = $_REQUEST['jitmModule'];
810
811
			// User went to WordPress.com, track this
812
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
813
			$this->do_stats( 'server_side' );
814
815
			wp_send_json_success();
816
		}
817 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
818
			$track = $_REQUEST['jitmModule'];
819
820
			// User is viewing JITM, track it.
821
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
822
			$this->do_stats( 'server_side' );
823
824
			wp_send_json_success();
825
		}
826
	}
827
828
	/**
829
	 * If there are any stats that need to be pushed, but haven't been, push them now.
830
	 */
831
	function push_stats() {
832
		if ( ! empty( $this->stats ) ) {
833
			$this->do_stats( 'server_side' );
834
		}
835
	}
836
837
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
838
		switch( $cap ) {
839
			case 'jetpack_connect' :
840
			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...
841
				if ( Jetpack::is_development_mode() ) {
842
					$caps = array( 'do_not_allow' );
843
					break;
844
				}
845
				/**
846
				 * Pass through. If it's not development mode, these should match disconnect.
847
				 * Let users disconnect if it's development mode, just in case things glitch.
848
				 */
849
			case 'jetpack_disconnect' :
850
				/**
851
				 * In multisite, can individual site admins manage their own connection?
852
				 *
853
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
854
				 */
855
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
856
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
857
						/**
858
						 * We need to update the option name -- it's terribly unclear which
859
						 * direction the override goes.
860
						 *
861
						 * @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...
862
						 */
863
						$caps = array( 'do_not_allow' );
864
						break;
865
					}
866
				}
867
868
				$caps = array( 'manage_options' );
869
				break;
870
			case 'jetpack_manage_modules' :
871
			case 'jetpack_activate_modules' :
872
			case 'jetpack_deactivate_modules' :
873
				$caps = array( 'manage_options' );
874
				break;
875
			case 'jetpack_configure_modules' :
876
				$caps = array( 'manage_options' );
877
				break;
878
			case 'jetpack_network_admin_page':
879
			case 'jetpack_network_settings_page':
880
				$caps = array( 'manage_network_plugins' );
881
				break;
882
			case 'jetpack_network_sites_page':
883
				$caps = array( 'manage_sites' );
884
				break;
885
			case 'jetpack_admin_page' :
886
				if ( Jetpack::is_development_mode() ) {
887
					$caps = array( 'manage_options' );
888
					break;
889
				} else {
890
					$caps = array( 'read' );
891
				}
892
				break;
893
			case 'jetpack_connect_user' :
894
				if ( Jetpack::is_development_mode() ) {
895
					$caps = array( 'do_not_allow' );
896
					break;
897
				}
898
				$caps = array( 'read' );
899
				break;
900
		}
901
		return $caps;
902
	}
903
904
	function require_jetpack_authentication() {
905
		// Don't let anyone authenticate
906
		$_COOKIE = array();
907
		remove_all_filters( 'authenticate' );
908
		remove_all_actions( 'wp_login_failed' );
909
910
		if ( Jetpack::is_active() ) {
911
			// Allow Jetpack authentication
912
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
913
		}
914
	}
915
916
	/**
917
	 * Load language files
918
	 * @action plugins_loaded
919
	 */
920
	public static function plugin_textdomain() {
921
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
922
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
923
	}
924
925
	/**
926
	 * Register assets for use in various modules and the Jetpack admin page.
927
	 *
928
	 * @uses wp_script_is, wp_register_script, plugins_url
929
	 * @action wp_loaded
930
	 * @return null
931
	 */
932
	public function register_assets() {
933
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
934
			wp_register_script(
935
				'spin',
936
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
937
				false,
938
				'1.3'
939
			);
940
		}
941
942
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
943
			wp_register_script(
944
				'jquery.spin',
945
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
946
				array( 'jquery', 'spin' ),
947
				'1.3'
948
			);
949
		}
950
951 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
952
			wp_register_script(
953
				'jetpack-gallery-settings',
954
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
955
				array( 'media-views' ),
956
				'20121225'
957
			);
958
		}
959
960
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
961
			wp_register_script(
962
				'jetpack-twitter-timeline',
963
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
964
				array( 'jquery' ),
965
				'4.0.0',
966
				true
967
			);
968
		}
969
970
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
971
			wp_register_script(
972
				'jetpack-facebook-embed',
973
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
974
				array( 'jquery' ),
975
				null,
976
				true
977
			);
978
979
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
980
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
981
			if ( ! is_numeric( $fb_app_id ) ) {
982
				$fb_app_id = '';
983
			}
984
			wp_localize_script(
985
				'jetpack-facebook-embed',
986
				'jpfbembed',
987
				array(
988
					'appid' => $fb_app_id,
989
					'locale' => $this->get_locale(),
990
				)
991
			);
992
		}
993
994
		/**
995
		 * As jetpack_register_genericons is by default fired off a hook,
996
		 * the hook may have already fired by this point.
997
		 * So, let's just trigger it manually.
998
		 */
999
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1000
		jetpack_register_genericons();
1001
1002
		/**
1003
		 * Register the social logos
1004
		 */
1005
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1006
		jetpack_register_social_logos();
1007
1008 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1009
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1010
	}
1011
1012
	/**
1013
	 * Guess locale from language code.
1014
	 *
1015
	 * @param string $lang Language code.
1016
	 * @return string|bool
1017
	 */
1018
	function guess_locale_from_lang( $lang ) {
1019
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1020
			return 'en_US';
1021
		}
1022
1023 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
1024
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1025
				return false;
1026
			}
1027
1028
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1029
		}
1030
1031
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1032
			// WP.com: get_locale() returns 'it'
1033
			$locale = GP_Locales::by_slug( $lang );
1034
		} else {
1035
			// Jetpack: get_locale() returns 'it_IT';
1036
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1037
		}
1038
1039
		if ( ! $locale ) {
1040
			return false;
1041
		}
1042
1043
		if ( empty( $locale->facebook_locale ) ) {
1044
			if ( empty( $locale->wp_locale ) ) {
1045
				return false;
1046
			} else {
1047
				// Facebook SDK is smart enough to fall back to en_US if a
1048
				// locale isn't supported. Since supported Facebook locales
1049
				// can fall out of sync, we'll attempt to use the known
1050
				// wp_locale value and rely on said fallback.
1051
				return $locale->wp_locale;
1052
			}
1053
		}
1054
1055
		return $locale->facebook_locale;
1056
	}
1057
1058
	/**
1059
	 * Get the locale.
1060
	 *
1061
	 * @return string|bool
1062
	 */
1063
	function get_locale() {
1064
		$locale = $this->guess_locale_from_lang( get_locale() );
1065
1066
		if ( ! $locale ) {
1067
			$locale = 'en_US';
1068
		}
1069
1070
		return $locale;
1071
	}
1072
1073
	/**
1074
	 * Device Pixels support
1075
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1076
	 */
1077
	function devicepx() {
1078
		if ( Jetpack::is_active() ) {
1079
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1080
		}
1081
	}
1082
1083
	/**
1084
	 * Return the network_site_url so that .com knows what network this site is a part of.
1085
	 * @param  bool $option
1086
	 * @return string
1087
	 */
1088
	public function jetpack_main_network_site_option( $option ) {
1089
		return network_site_url();
1090
	}
1091
	/**
1092
	 * Network Name.
1093
	 */
1094
	static function network_name( $option = null ) {
1095
		global $current_site;
1096
		return $current_site->site_name;
1097
	}
1098
	/**
1099
	 * Does the network allow new user and site registrations.
1100
	 * @return string
1101
	 */
1102
	static function network_allow_new_registrations( $option = null ) {
1103
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1104
	}
1105
	/**
1106
	 * Does the network allow admins to add new users.
1107
	 * @return boolian
1108
	 */
1109
	static function network_add_new_users( $option = null ) {
1110
		return (bool) get_site_option( 'add_new_users' );
1111
	}
1112
	/**
1113
	 * File upload psace left per site in MB.
1114
	 *  -1 means NO LIMIT.
1115
	 * @return number
1116
	 */
1117
	static function network_site_upload_space( $option = null ) {
1118
		// value in MB
1119
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1120
	}
1121
1122
	/**
1123
	 * Network allowed file types.
1124
	 * @return string
1125
	 */
1126
	static function network_upload_file_types( $option = null ) {
1127
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1128
	}
1129
1130
	/**
1131
	 * Maximum file upload size set by the network.
1132
	 * @return number
1133
	 */
1134
	static function network_max_upload_file_size( $option = null ) {
1135
		// value in KB
1136
		return get_site_option( 'fileupload_maxk', 300 );
1137
	}
1138
1139
	/**
1140
	 * Lets us know if a site allows admins to manage the network.
1141
	 * @return array
1142
	 */
1143
	static function network_enable_administration_menus( $option = null ) {
1144
		return get_site_option( 'menu_items' );
1145
	}
1146
1147
	/**
1148
	 * If a user has been promoted to or demoted from admin, we need to clear the
1149
	 * jetpack_other_linked_admins transient.
1150
	 *
1151
	 * @since 4.3.2
1152
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1153
	 *
1154
	 * @param int    $user_id   The user ID whose role changed.
1155
	 * @param string $role      The new role.
1156
	 * @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...
1157
	 */
1158
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1159
		if ( 'administrator' == $role
1160
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1161
			|| is_null( $old_roles )
1162
		) {
1163
			delete_transient( 'jetpack_other_linked_admins' );
1164
		}
1165
	}
1166
1167
	/**
1168
	 * Checks to see if there are any other users available to become primary
1169
	 * Users must both:
1170
	 * - Be linked to wpcom
1171
	 * - Be an admin
1172
	 *
1173
	 * @return mixed False if no other users are linked, Int if there are.
1174
	 */
1175
	static function get_other_linked_admins() {
1176
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1177
1178
		if ( false === $other_linked_users ) {
1179
			$admins = get_users( array( 'role' => 'administrator' ) );
1180
			if ( count( $admins ) > 1 ) {
1181
				$available = array();
1182
				foreach ( $admins as $admin ) {
1183
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1184
						$available[] = $admin->ID;
1185
					}
1186
				}
1187
1188
				$count_connected_admins = count( $available );
1189
				if ( count( $available ) > 1 ) {
1190
					$other_linked_users = $count_connected_admins;
1191
				} else {
1192
					$other_linked_users = 0;
1193
				}
1194
			} else {
1195
				$other_linked_users = 0;
1196
			}
1197
1198
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1199
		}
1200
1201
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1202
	}
1203
1204
	/**
1205
	 * Return whether we are dealing with a multi network setup or not.
1206
	 * The reason we are type casting this is because we want to avoid the situation where
1207
	 * the result is false since when is_main_network_option return false it cases
1208
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1209
	 * database which could be set to anything as opposed to what this function returns.
1210
	 * @param  bool  $option
1211
	 *
1212
	 * @return boolean
1213
	 */
1214
	public function is_main_network_option( $option ) {
1215
		// return '1' or ''
1216
		return (string) (bool) Jetpack::is_multi_network();
1217
	}
1218
1219
	/**
1220
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1221
	 *
1222
	 * @param  string  $option
1223
	 * @return boolean
1224
	 */
1225
	public function is_multisite( $option ) {
1226
		return (string) (bool) is_multisite();
1227
	}
1228
1229
	/**
1230
	 * Implemented since there is no core is multi network function
1231
	 * Right now there is no way to tell if we which network is the dominant network on the system
1232
	 *
1233
	 * @since  3.3
1234
	 * @return boolean
1235
	 */
1236
	public static function is_multi_network() {
1237
		global  $wpdb;
1238
1239
		// if we don't have a multi site setup no need to do any more
1240
		if ( ! is_multisite() ) {
1241
			return false;
1242
		}
1243
1244
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1245
		if ( $num_sites > 1 ) {
1246
			return true;
1247
		} else {
1248
			return false;
1249
		}
1250
	}
1251
1252
	/**
1253
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1254
	 * @return null
1255
	 */
1256
	function update_jetpack_main_network_site_option() {
1257
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1258
	}
1259
	/**
1260
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1261
	 *
1262
	 */
1263
	function update_jetpack_network_settings() {
1264
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1265
		// Only sync this info for the main network site.
1266
	}
1267
1268
	/**
1269
	 * Get back if the current site is single user site.
1270
	 *
1271
	 * @return bool
1272
	 */
1273
	public static function is_single_user_site() {
1274
		global $wpdb;
1275
1276 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1277
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1278
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1279
		}
1280
		return 1 === (int) $some_users;
1281
	}
1282
1283
	/**
1284
	 * Returns true if the site has file write access false otherwise.
1285
	 * @return string ( '1' | '0' )
1286
	 **/
1287
	public static function file_system_write_access() {
1288
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1289
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1290
		}
1291
1292
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1293
1294
		$filesystem_method = get_filesystem_method();
1295
		if ( $filesystem_method === 'direct' ) {
1296
			return 1;
1297
		}
1298
1299
		ob_start();
1300
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1301
		ob_end_clean();
1302
		if ( $filesystem_credentials_are_stored ) {
1303
			return 1;
1304
		}
1305
		return 0;
1306
	}
1307
1308
	/**
1309
	 * Finds out if a site is using a version control system.
1310
	 * @return string ( '1' | '0' )
1311
	 **/
1312
	public static function is_version_controlled() {
1313
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1314
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1315
	}
1316
1317
	/**
1318
	 * Determines whether the current theme supports featured images or not.
1319
	 * @return string ( '1' | '0' )
1320
	 */
1321
	public static function featured_images_enabled() {
1322
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1323
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1324
	}
1325
1326
	/**
1327
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1328
	 *
1329
	 * @deprecated 4.7 use get_avatar_url instead.
1330
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1331
	 * @param int $size Size of the avatar image
1332
	 * @param string $default URL to a default image to use if no avatar is available
1333
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1334
	 *
1335
	 * @return array
1336
	 */
1337
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1338
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1339
		return get_avatar_url( $id_or_email, array(
1340
			'size' => $size,
1341
			'default' => $default,
1342
			'force_default' => $force_display,
1343
		) );
1344
	}
1345
1346
	/**
1347
	 * jetpack_updates is saved in the following schema:
1348
	 *
1349
	 * array (
1350
	 *      'plugins'                       => (int) Number of plugin updates available.
1351
	 *      'themes'                        => (int) Number of theme updates available.
1352
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1353
	 *      'translations'                  => (int) Number of translation updates available.
1354
	 *      'total'                         => (int) Total of all available updates.
1355
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1356
	 * )
1357
	 * @return array
1358
	 */
1359
	public static function get_updates() {
1360
		$update_data = wp_get_update_data();
1361
1362
		// Stores the individual update counts as well as the total count.
1363
		if ( isset( $update_data['counts'] ) ) {
1364
			$updates = $update_data['counts'];
1365
		}
1366
1367
		// If we need to update WordPress core, let's find the latest version number.
1368 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1369
			$cur = get_preferred_from_update_core();
1370
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1371
				$updates['wp_update_version'] = $cur->current;
1372
			}
1373
		}
1374
		return isset( $updates ) ? $updates : array();
1375
	}
1376
1377
	public static function get_update_details() {
1378
		$update_details = array(
1379
			'update_core' => get_site_transient( 'update_core' ),
1380
			'update_plugins' => get_site_transient( 'update_plugins' ),
1381
			'update_themes' => get_site_transient( 'update_themes' ),
1382
		);
1383
		return $update_details;
1384
	}
1385
1386
	public static function refresh_update_data() {
1387
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1388
1389
	}
1390
1391
	public static function refresh_theme_data() {
1392
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1393
	}
1394
1395
	/**
1396
	 * Is Jetpack active?
1397
	 */
1398
	public static function is_active() {
1399
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1400
	}
1401
1402
	/**
1403
	 * Make an API call to WordPress.com for plan status
1404
	 *
1405
	 * @uses Jetpack_Options::get_option()
1406
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1407
	 * @uses update_option()
1408
	 *
1409
	 * @access public
1410
	 * @static
1411
	 *
1412
	 * @return bool True if plan is updated, false if no update
1413
	 */
1414
	public static function refresh_active_plan_from_wpcom() {
1415
		// Make the API request
1416
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1417
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1418
1419
		// Bail if there was an error or malformed response
1420
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1421
			return false;
1422
		}
1423
1424
		// Decode the results
1425
		$results = json_decode( $response['body'], true );
1426
1427
		// Bail if there were no results or plan details returned
1428
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1429
			return false;
1430
		}
1431
1432
		// Store the option and return true if updated
1433
		return update_option( 'jetpack_active_plan', $results['plan'] );
1434
	}
1435
1436
	/**
1437
	 * Get the plan that this Jetpack site is currently using
1438
	 *
1439
	 * @uses get_option()
1440
	 *
1441
	 * @access public
1442
	 * @static
1443
	 *
1444
	 * @return array Active Jetpack plan details
1445
	 */
1446
	public static function get_active_plan() {
1447
		$plan = get_option( 'jetpack_active_plan', array() );
1448
1449
		// Set the default options
1450
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1451
			$plan = wp_parse_args( $plan, array(
1452
				'product_slug' => 'jetpack_free',
1453
				'supports'     => array(),
1454
				'class'        => 'free',
1455
			) );
1456
		}
1457
1458
		// Define what paid modules are supported by personal plans
1459
		$personal_plans = array(
1460
			'jetpack_personal',
1461
			'jetpack_personal_monthly',
1462
			'personal-bundle',
1463
		);
1464
1465
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1466
			$plan['supports'] = array(
1467
				'akismet',
1468
			);
1469
			$plan['class'] = 'personal';
1470
		}
1471
1472
		// Define what paid modules are supported by premium plans
1473
		$premium_plans = array(
1474
			'jetpack_premium',
1475
			'jetpack_premium_monthly',
1476
			'value_bundle',
1477
		);
1478
1479
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1480
			$plan['supports'] = array(
1481
				'videopress',
1482
				'akismet',
1483
				'vaultpress',
1484
				'wordads',
1485
			);
1486
			$plan['class'] = 'premium';
1487
		}
1488
1489
		// Define what paid modules are supported by professional plans
1490
		$business_plans = array(
1491
			'jetpack_business',
1492
			'jetpack_business_monthly',
1493
			'business-bundle',
1494
			'vip',
1495
		);
1496
1497
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1498
			$plan['supports'] = array(
1499
				'videopress',
1500
				'akismet',
1501
				'vaultpress',
1502
				'seo-tools',
1503
				'google-analytics',
1504
				'wordads',
1505
				'search',
1506
			);
1507
			$plan['class'] = 'business';
1508
		}
1509
1510
		// Make sure we have an array here in the event database data is stale
1511
		if ( ! isset( $plan['supports'] ) ) {
1512
			$plan['supports'] = array();
1513
		}
1514
1515
		return $plan;
1516
	}
1517
1518
	/**
1519
	 * Determine whether the active plan supports a particular feature
1520
	 *
1521
	 * @uses Jetpack::get_active_plan()
1522
	 *
1523
	 * @access public
1524
	 * @static
1525
	 *
1526
	 * @return bool True if plan supports feature, false if not
1527
	 */
1528
	public static function active_plan_supports( $feature ) {
1529
		$plan = Jetpack::get_active_plan();
1530
1531
		if ( in_array( $feature, $plan['supports'] ) ) {
1532
			return true;
1533
		}
1534
1535
		return false;
1536
	}
1537
1538
	/**
1539
	 * Is Jetpack in development (offline) mode?
1540
	 */
1541
	public static function is_development_mode() {
1542
		$development_mode = false;
1543
1544
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1545
			$development_mode = JETPACK_DEV_DEBUG;
1546
		} elseif ( $site_url = site_url() ) {
1547
			$development_mode = false === strpos( $site_url, '.' );
1548
		}
1549
1550
		/**
1551
		 * Filters Jetpack's development mode.
1552
		 *
1553
		 * @see https://jetpack.com/support/development-mode/
1554
		 *
1555
		 * @since 2.2.1
1556
		 *
1557
		 * @param bool $development_mode Is Jetpack's development mode active.
1558
		 */
1559
		return apply_filters( 'jetpack_development_mode', $development_mode );
1560
	}
1561
1562
	/**
1563
	* Get Jetpack development mode notice text and notice class.
1564
	*
1565
	* Mirrors the checks made in Jetpack::is_development_mode
1566
	*
1567
	*/
1568
	public static function show_development_mode_notice() {
1569
		if ( Jetpack::is_development_mode() ) {
1570
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1571
				$notice = sprintf(
1572
					/* translators: %s is a URL */
1573
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1574
					'https://jetpack.com/support/development-mode/'
1575
				);
1576
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1577
				$notice = sprintf(
1578
					/* translators: %s is a URL */
1579
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1580
					'https://jetpack.com/support/development-mode/'
1581
				);
1582
			} else {
1583
				$notice = sprintf(
1584
					/* translators: %s is a URL */
1585
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1586
					'https://jetpack.com/support/development-mode/'
1587
				);
1588
			}
1589
1590
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1591
		}
1592
1593
		// Throw up a notice if using a development version and as for feedback.
1594
		if ( Jetpack::is_development_version() ) {
1595
			/* translators: %s is a URL */
1596
			$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/' );
1597
1598
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1599
		}
1600
		// Throw up a notice if using staging mode
1601
		if ( Jetpack::is_staging_site() ) {
1602
			/* translators: %s is a URL */
1603
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1604
1605
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1606
		}
1607
	}
1608
1609
	/**
1610
	 * Whether Jetpack's version maps to a public release, or a development version.
1611
	 */
1612
	public static function is_development_version() {
1613
		/**
1614
		 * Allows filtering whether this is a development version of Jetpack.
1615
		 *
1616
		 * This filter is especially useful for tests.
1617
		 *
1618
		 * @since 4.3.0
1619
		 *
1620
		 * @param bool $development_version Is this a develoment version of Jetpack?
1621
		 */
1622
		return (bool) apply_filters(
1623
			'jetpack_development_version',
1624
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1625
		);
1626
	}
1627
1628
	/**
1629
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1630
	 */
1631
	public static function is_user_connected( $user_id = false ) {
1632
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1633
		if ( ! $user_id ) {
1634
			return false;
1635
		}
1636
1637
		return (bool) Jetpack_Data::get_access_token( $user_id );
1638
	}
1639
1640
	/**
1641
	 * Get the wpcom user data of the current|specified connected user.
1642
	 */
1643
	public static function get_connected_user_data( $user_id = null ) {
1644
		if ( ! $user_id ) {
1645
			$user_id = get_current_user_id();
1646
		}
1647
1648
		$transient_key = "jetpack_connected_user_data_$user_id";
1649
1650
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1651
			return $cached_user_data;
1652
		}
1653
1654
		Jetpack::load_xml_rpc_client();
1655
		$xml = new Jetpack_IXR_Client( array(
1656
			'user_id' => $user_id,
1657
		) );
1658
		$xml->query( 'wpcom.getUser' );
1659
		if ( ! $xml->isError() ) {
1660
			$user_data = $xml->getResponse();
1661
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1662
			return $user_data;
1663
		}
1664
1665
		return false;
1666
	}
1667
1668
	/**
1669
	 * Get the wpcom email of the current|specified connected user.
1670
	 */
1671 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1672
		if ( ! $user_id ) {
1673
			$user_id = get_current_user_id();
1674
		}
1675
		Jetpack::load_xml_rpc_client();
1676
		$xml = new Jetpack_IXR_Client( array(
1677
			'user_id' => $user_id,
1678
		) );
1679
		$xml->query( 'wpcom.getUserEmail' );
1680
		if ( ! $xml->isError() ) {
1681
			return $xml->getResponse();
1682
		}
1683
		return false;
1684
	}
1685
1686
	/**
1687
	 * Get the wpcom email of the master user.
1688
	 */
1689
	public static function get_master_user_email() {
1690
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1691
		if ( $master_user_id ) {
1692
			return self::get_connected_user_email( $master_user_id );
1693
		}
1694
		return '';
1695
	}
1696
1697
	function current_user_is_connection_owner() {
1698
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1699
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1700
	}
1701
1702
	/**
1703
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1704
	 */
1705
	function extra_oembed_providers() {
1706
		// Cloudup: https://dev.cloudup.com/#oembed
1707
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1708
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1709
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1710
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1711
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1712
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1713
	}
1714
1715
	/**
1716
	 * Synchronize connected user role changes
1717
	 */
1718
	function user_role_change( $user_id ) {
1719
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1720
		Jetpack_Sync_Users::user_role_change( $user_id );
1721
	}
1722
1723
	/**
1724
	 * Loads the currently active modules.
1725
	 */
1726
	public static function load_modules() {
1727
		if (
1728
			! self::is_active()
1729
			&& ! self::is_development_mode()
1730
			&& (
1731
				! is_multisite()
1732
				|| ! get_site_option( 'jetpack_protect_active' )
1733
			)
1734
		) {
1735
			return;
1736
		}
1737
1738
		$version = Jetpack_Options::get_option( 'version' );
1739 View Code Duplication
		if ( ! $version ) {
1740
			$version = $old_version = JETPACK__VERSION . ':' . time();
1741
			/** This action is documented in class.jetpack.php */
1742
			do_action( 'updating_jetpack_version', $version, false );
1743
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1744
		}
1745
		list( $version ) = explode( ':', $version );
1746
1747
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1748
1749
		$modules_data = array();
1750
1751
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1752
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1753
			$updated_modules = array();
1754
			foreach ( $modules as $module ) {
1755
				$modules_data[ $module ] = Jetpack::get_module( $module );
1756
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1757
					continue;
1758
				}
1759
1760
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1761
					continue;
1762
				}
1763
1764
				$updated_modules[] = $module;
1765
			}
1766
1767
			$modules = array_diff( $modules, $updated_modules );
1768
		}
1769
1770
		$is_development_mode = Jetpack::is_development_mode();
1771
1772
		foreach ( $modules as $index => $module ) {
1773
			// If we're in dev mode, disable modules requiring a connection
1774
			if ( $is_development_mode ) {
1775
				// Prime the pump if we need to
1776
				if ( empty( $modules_data[ $module ] ) ) {
1777
					$modules_data[ $module ] = Jetpack::get_module( $module );
1778
				}
1779
				// If the module requires a connection, but we're in local mode, don't include it.
1780
				if ( $modules_data[ $module ]['requires_connection'] ) {
1781
					continue;
1782
				}
1783
			}
1784
1785
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1786
				continue;
1787
			}
1788
1789
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1790
				unset( $modules[ $index ] );
1791
				self::update_active_modules( array_values( $modules ) );
1792
				continue;
1793
			}
1794
1795
			/**
1796
			 * Fires when a specific module is loaded.
1797
			 * The dynamic part of the hook, $module, is the module slug.
1798
			 *
1799
			 * @since 1.1.0
1800
			 */
1801
			do_action( 'jetpack_module_loaded_' . $module );
1802
		}
1803
1804
		/**
1805
		 * Fires when all the modules are loaded.
1806
		 *
1807
		 * @since 1.1.0
1808
		 */
1809
		do_action( 'jetpack_modules_loaded' );
1810
1811
		// 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.
1812
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1813
	}
1814
1815
	/**
1816
	 * Check if Jetpack's REST API compat file should be included
1817
	 * @action plugins_loaded
1818
	 * @return null
1819
	 */
1820
	public function check_rest_api_compat() {
1821
		/**
1822
		 * Filters the list of REST API compat files to be included.
1823
		 *
1824
		 * @since 2.2.5
1825
		 *
1826
		 * @param array $args Array of REST API compat files to include.
1827
		 */
1828
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1829
1830
		if ( function_exists( 'bbpress' ) )
1831
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1832
1833
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1834
			require_once $_jetpack_rest_api_compat_include;
1835
	}
1836
1837
	/**
1838
	 * Gets all plugins currently active in values, regardless of whether they're
1839
	 * traditionally activated or network activated.
1840
	 *
1841
	 * @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...
1842
	 */
1843
	public static function get_active_plugins() {
1844
		$active_plugins = (array) get_option( 'active_plugins', array() );
1845
1846
		if ( is_multisite() ) {
1847
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1848
			// whereas active_plugins stores them in the values.
1849
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1850
			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...
1851
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1852
			}
1853
		}
1854
1855
		sort( $active_plugins );
1856
1857
		return array_unique( $active_plugins );
1858
	}
1859
1860
	/**
1861
	 * Gets and parses additional plugin data to send with the heartbeat data
1862
	 *
1863
	 * @since 3.8.1
1864
	 *
1865
	 * @return array Array of plugin data
1866
	 */
1867
	public static function get_parsed_plugin_data() {
1868
		if ( ! function_exists( 'get_plugins' ) ) {
1869
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1870
		}
1871
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1872
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1873
		$active_plugins = Jetpack::get_active_plugins();
1874
1875
		$plugins = array();
1876
		foreach ( $all_plugins as $path => $plugin_data ) {
1877
			$plugins[ $path ] = array(
1878
					'is_active' => in_array( $path, $active_plugins ),
1879
					'file'      => $path,
1880
					'name'      => $plugin_data['Name'],
1881
					'version'   => $plugin_data['Version'],
1882
					'author'    => $plugin_data['Author'],
1883
			);
1884
		}
1885
1886
		return $plugins;
1887
	}
1888
1889
	/**
1890
	 * Gets and parses theme data to send with the heartbeat data
1891
	 *
1892
	 * @since 3.8.1
1893
	 *
1894
	 * @return array Array of theme data
1895
	 */
1896
	public static function get_parsed_theme_data() {
1897
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1898
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1899
1900
		$themes = array();
1901
		foreach ( $all_themes as $slug => $theme_data ) {
1902
			$theme_headers = array();
1903
			foreach ( $header_keys as $header_key ) {
1904
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1905
			}
1906
1907
			$themes[ $slug ] = array(
1908
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1909
					'slug' => $slug,
1910
					'theme_root' => $theme_data->get_theme_root_uri(),
1911
					'parent' => $theme_data->parent(),
1912
					'headers' => $theme_headers
1913
			);
1914
		}
1915
1916
		return $themes;
1917
	}
1918
1919
	/**
1920
	 * Checks whether a specific plugin is active.
1921
	 *
1922
	 * We don't want to store these in a static variable, in case
1923
	 * there are switch_to_blog() calls involved.
1924
	 */
1925
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1926
		return in_array( $plugin, self::get_active_plugins() );
1927
	}
1928
1929
	/**
1930
	 * Check if Jetpack's Open Graph tags should be used.
1931
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1932
	 *
1933
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1934
	 * @action plugins_loaded
1935
	 * @return null
1936
	 */
1937
	public function check_open_graph() {
1938
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1939
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1940
		}
1941
1942
		$active_plugins = self::get_active_plugins();
1943
1944
		if ( ! empty( $active_plugins ) ) {
1945
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1946
				if ( in_array( $plugin, $active_plugins ) ) {
1947
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1948
					break;
1949
				}
1950
			}
1951
		}
1952
1953
		/**
1954
		 * Allow the addition of Open Graph Meta Tags to all pages.
1955
		 *
1956
		 * @since 2.0.3
1957
		 *
1958
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1959
		 */
1960
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1961
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1962
		}
1963
	}
1964
1965
	/**
1966
	 * Check if Jetpack's Twitter tags should be used.
1967
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1968
	 *
1969
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1970
	 * @action plugins_loaded
1971
	 * @return null
1972
	 */
1973
	public function check_twitter_tags() {
1974
1975
		$active_plugins = self::get_active_plugins();
1976
1977
		if ( ! empty( $active_plugins ) ) {
1978
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1979
				if ( in_array( $plugin, $active_plugins ) ) {
1980
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1981
					break;
1982
				}
1983
			}
1984
		}
1985
1986
		/**
1987
		 * Allow Twitter Card Meta tags to be disabled.
1988
		 *
1989
		 * @since 2.6.0
1990
		 *
1991
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
1992
		 */
1993
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
1994
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
1995
		}
1996
	}
1997
1998
	/**
1999
	 * Allows plugins to submit security reports.
2000
 	 *
2001
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2002
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2003
	 * @param array   $args         See definitions above
2004
	 */
2005
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2006
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2007
	}
2008
2009
/* Jetpack Options API */
2010
2011
	public static function get_option_names( $type = 'compact' ) {
2012
		return Jetpack_Options::get_option_names( $type );
2013
	}
2014
2015
	/**
2016
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2017
 	 *
2018
	 * @param string $name    Option name
2019
	 * @param mixed  $default (optional)
2020
	 */
2021
	public static function get_option( $name, $default = false ) {
2022
		return Jetpack_Options::get_option( $name, $default );
2023
	}
2024
2025
	/**
2026
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2027
 	 *
2028
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2029
	 * @param string $name  Option name
2030
	 * @param mixed  $value Option value
2031
	 */
2032
	public static function update_option( $name, $value ) {
2033
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2034
		return Jetpack_Options::update_option( $name, $value );
2035
	}
2036
2037
	/**
2038
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2039
 	 *
2040
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2041
	 * @param array $array array( option name => option value, ... )
2042
	 */
2043
	public static function update_options( $array ) {
2044
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2045
		return Jetpack_Options::update_options( $array );
2046
	}
2047
2048
	/**
2049
	 * Deletes the given option.  May be passed multiple option names as an array.
2050
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2051
	 *
2052
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2053
	 * @param string|array $names
2054
	 */
2055
	public static function delete_option( $names ) {
2056
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2057
		return Jetpack_Options::delete_option( $names );
2058
	}
2059
2060
	/**
2061
	 * Enters a user token into the user_tokens option
2062
	 *
2063
	 * @param int $user_id
2064
	 * @param string $token
2065
	 * return bool
2066
	 */
2067
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2068
		// not designed for concurrent updates
2069
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2070
		if ( ! is_array( $user_tokens ) )
2071
			$user_tokens = array();
2072
		$user_tokens[$user_id] = $token;
2073
		if ( $is_master_user ) {
2074
			$master_user = $user_id;
2075
			$options     = compact( 'user_tokens', 'master_user' );
2076
		} else {
2077
			$options = compact( 'user_tokens' );
2078
		}
2079
		return Jetpack_Options::update_options( $options );
2080
	}
2081
2082
	/**
2083
	 * Returns an array of all PHP files in the specified absolute path.
2084
	 * Equivalent to glob( "$absolute_path/*.php" ).
2085
	 *
2086
	 * @param string $absolute_path The absolute path of the directory to search.
2087
	 * @return array Array of absolute paths to the PHP files.
2088
	 */
2089
	public static function glob_php( $absolute_path ) {
2090
		if ( function_exists( 'glob' ) ) {
2091
			return glob( "$absolute_path/*.php" );
2092
		}
2093
2094
		$absolute_path = untrailingslashit( $absolute_path );
2095
		$files = array();
2096
		if ( ! $dir = @opendir( $absolute_path ) ) {
2097
			return $files;
2098
		}
2099
2100
		while ( false !== $file = readdir( $dir ) ) {
2101
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2102
				continue;
2103
			}
2104
2105
			$file = "$absolute_path/$file";
2106
2107
			if ( ! is_file( $file ) ) {
2108
				continue;
2109
			}
2110
2111
			$files[] = $file;
2112
		}
2113
2114
		closedir( $dir );
2115
2116
		return $files;
2117
	}
2118
2119
	public static function activate_new_modules( $redirect = false ) {
2120
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2121
			return;
2122
		}
2123
2124
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2125 View Code Duplication
		if ( ! $jetpack_old_version ) {
2126
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2127
			/** This action is documented in class.jetpack.php */
2128
			do_action( 'updating_jetpack_version', $version, false );
2129
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2130
		}
2131
2132
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2133
2134
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2135
			return;
2136
		}
2137
2138
		$active_modules     = Jetpack::get_active_modules();
2139
		$reactivate_modules = array();
2140
		foreach ( $active_modules as $active_module ) {
2141
			$module = Jetpack::get_module( $active_module );
2142
			if ( ! isset( $module['changed'] ) ) {
2143
				continue;
2144
			}
2145
2146
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2147
				continue;
2148
			}
2149
2150
			$reactivate_modules[] = $active_module;
2151
			Jetpack::deactivate_module( $active_module );
2152
		}
2153
2154
		$new_version = JETPACK__VERSION . ':' . time();
2155
		/** This action is documented in class.jetpack.php */
2156
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2157
		Jetpack_Options::update_options(
2158
			array(
2159
				'version'     => $new_version,
2160
				'old_version' => $jetpack_old_version,
2161
			)
2162
		);
2163
2164
		Jetpack::state( 'message', 'modules_activated' );
2165
		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...
2166
2167
		if ( $redirect ) {
2168
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2169
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2170
				$page = $_GET['page'];
2171
			}
2172
2173
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2174
			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...
2175
		}
2176
	}
2177
2178
	/**
2179
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2180
	 * Make sure to tuck away module "library" files in a sub-directory.
2181
	 */
2182
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2183
		static $modules = null;
2184
2185
		if ( ! isset( $modules ) ) {
2186
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2187
			// Use the cache if we're on the front-end and it's available...
2188
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2189
				$modules = $available_modules_option[ JETPACK__VERSION ];
2190
			} else {
2191
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2192
2193
				$modules = array();
2194
2195
				foreach ( $files as $file ) {
2196
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2197
						continue;
2198
					}
2199
2200
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2201
				}
2202
2203
				Jetpack_Options::update_option( 'available_modules', array(
2204
					JETPACK__VERSION => $modules,
2205
				) );
2206
			}
2207
		}
2208
2209
		/**
2210
		 * Filters the array of modules available to be activated.
2211
		 *
2212
		 * @since 2.4.0
2213
		 *
2214
		 * @param array $modules Array of available modules.
2215
		 * @param string $min_version Minimum version number required to use modules.
2216
		 * @param string $max_version Maximum version number required to use modules.
2217
		 */
2218
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2219
2220
		if ( ! $min_version && ! $max_version ) {
2221
			return array_keys( $mods );
2222
		}
2223
2224
		$r = array();
2225
		foreach ( $mods as $slug => $introduced ) {
2226
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2227
				continue;
2228
			}
2229
2230
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2231
				continue;
2232
			}
2233
2234
			$r[] = $slug;
2235
		}
2236
2237
		return $r;
2238
	}
2239
2240
	/**
2241
	 * Default modules loaded on activation.
2242
	 */
2243
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2244
		$return = array();
2245
2246
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2247
			$module_data = Jetpack::get_module( $module );
2248
2249
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2250
				case 'yes' :
2251
					$return[] = $module;
2252
					break;
2253
				case 'public' :
2254
					if ( Jetpack_Options::get_option( 'public' ) ) {
2255
						$return[] = $module;
2256
					}
2257
					break;
2258
				case 'no' :
2259
				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...
2260
					break;
2261
			}
2262
		}
2263
		/**
2264
		 * Filters the array of default modules.
2265
		 *
2266
		 * @since 2.5.0
2267
		 *
2268
		 * @param array $return Array of default modules.
2269
		 * @param string $min_version Minimum version number required to use modules.
2270
		 * @param string $max_version Maximum version number required to use modules.
2271
		 */
2272
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2273
	}
2274
2275
	/**
2276
	 * Checks activated modules during auto-activation to determine
2277
	 * if any of those modules are being deprecated.  If so, close
2278
	 * them out, and add any replacement modules.
2279
	 *
2280
	 * Runs at priority 99 by default.
2281
	 *
2282
	 * This is run late, so that it can still activate a module if
2283
	 * the new module is a replacement for another that the user
2284
	 * currently has active, even if something at the normal priority
2285
	 * would kibosh everything.
2286
	 *
2287
	 * @since 2.6
2288
	 * @uses jetpack_get_default_modules filter
2289
	 * @param array $modules
2290
	 * @return array
2291
	 */
2292
	function handle_deprecated_modules( $modules ) {
2293
		$deprecated_modules = array(
2294
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2295
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2296
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2297
		);
2298
2299
		// Don't activate SSO if they never completed activating WPCC.
2300
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2301
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2302
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2303
				$deprecated_modules['wpcc'] = null;
2304
			}
2305
		}
2306
2307
		foreach ( $deprecated_modules as $module => $replacement ) {
2308
			if ( Jetpack::is_module_active( $module ) ) {
2309
				self::deactivate_module( $module );
2310
				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...
2311
					$modules[] = $replacement;
2312
				}
2313
			}
2314
		}
2315
2316
		return array_unique( $modules );
2317
	}
2318
2319
	/**
2320
	 * Checks activated plugins during auto-activation to determine
2321
	 * if any of those plugins are in the list with a corresponding module
2322
	 * that is not compatible with the plugin. The module will not be allowed
2323
	 * to auto-activate.
2324
	 *
2325
	 * @since 2.6
2326
	 * @uses jetpack_get_default_modules filter
2327
	 * @param array $modules
2328
	 * @return array
2329
	 */
2330
	function filter_default_modules( $modules ) {
2331
2332
		$active_plugins = self::get_active_plugins();
2333
2334
		if ( ! empty( $active_plugins ) ) {
2335
2336
			// For each module we'd like to auto-activate...
2337
			foreach ( $modules as $key => $module ) {
2338
				// If there are potential conflicts for it...
2339
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2340
					// For each potential conflict...
2341
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2342
						// If that conflicting plugin is active...
2343
						if ( in_array( $plugin, $active_plugins ) ) {
2344
							// Remove that item from being auto-activated.
2345
							unset( $modules[ $key ] );
2346
						}
2347
					}
2348
				}
2349
			}
2350
		}
2351
2352
		return $modules;
2353
	}
2354
2355
	/**
2356
	 * Extract a module's slug from its full path.
2357
	 */
2358
	public static function get_module_slug( $file ) {
2359
		return str_replace( '.php', '', basename( $file ) );
2360
	}
2361
2362
	/**
2363
	 * Generate a module's path from its slug.
2364
	 */
2365
	public static function get_module_path( $slug ) {
2366
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2367
	}
2368
2369
	/**
2370
	 * Load module data from module file. Headers differ from WordPress
2371
	 * plugin headers to avoid them being identified as standalone
2372
	 * plugins on the WordPress plugins page.
2373
	 */
2374
	public static function get_module( $module ) {
2375
		$headers = array(
2376
			'name'                      => 'Module Name',
2377
			'description'               => 'Module Description',
2378
			'jumpstart_desc'            => 'Jumpstart Description',
2379
			'sort'                      => 'Sort Order',
2380
			'recommendation_order'      => 'Recommendation Order',
2381
			'introduced'                => 'First Introduced',
2382
			'changed'                   => 'Major Changes In',
2383
			'deactivate'                => 'Deactivate',
2384
			'free'                      => 'Free',
2385
			'requires_connection'       => 'Requires Connection',
2386
			'auto_activate'             => 'Auto Activate',
2387
			'module_tags'               => 'Module Tags',
2388
			'feature'                   => 'Feature',
2389
			'additional_search_queries' => 'Additional Search Queries',
2390
		);
2391
2392
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2393
2394
		$mod = Jetpack::get_file_data( $file, $headers );
2395
		if ( empty( $mod['name'] ) ) {
2396
			return false;
2397
		}
2398
2399
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2400
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2401
		$mod['deactivate']              = empty( $mod['deactivate'] );
2402
		$mod['free']                    = empty( $mod['free'] );
2403
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2404
2405
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2406
			$mod['auto_activate'] = 'No';
2407
		} else {
2408
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2409
		}
2410
2411
		if ( $mod['module_tags'] ) {
2412
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2413
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2414
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2415
		} else {
2416
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2417
		}
2418
2419
		if ( $mod['feature'] ) {
2420
			$mod['feature'] = explode( ',', $mod['feature'] );
2421
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2422
		} else {
2423
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2424
		}
2425
2426
		/**
2427
		 * Filters the feature array on a module.
2428
		 *
2429
		 * This filter allows you to control where each module is filtered: Recommended,
2430
		 * Jumpstart, and the default "Other" listing.
2431
		 *
2432
		 * @since 3.5.0
2433
		 *
2434
		 * @param array   $mod['feature'] The areas to feature this module:
2435
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2436
		 *     'Recommended' shows on the main Jetpack admin screen.
2437
		 *     'Other' should be the default if no other value is in the array.
2438
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2439
		 * @param array   $mod All the currently assembled module data.
2440
		 */
2441
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2442
2443
		/**
2444
		 * Filter the returned data about a module.
2445
		 *
2446
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2447
		 * so please be careful.
2448
		 *
2449
		 * @since 3.6.0
2450
		 *
2451
		 * @param array   $mod    The details of the requested module.
2452
		 * @param string  $module The slug of the module, e.g. sharedaddy
2453
		 * @param string  $file   The path to the module source file.
2454
		 */
2455
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2456
	}
2457
2458
	/**
2459
	 * Like core's get_file_data implementation, but caches the result.
2460
	 */
2461
	public static function get_file_data( $file, $headers ) {
2462
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2463
		$file_name = basename( $file );
2464
2465
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2466
2467
		$file_data_option = get_transient( $cache_key );
2468
2469
		if ( false === $file_data_option ) {
2470
			$file_data_option = array();
2471
		}
2472
2473
		$key           = md5( $file_name . serialize( $headers ) );
2474
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2475
2476
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2477
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2478
			return $file_data_option[ $key ];
2479
		}
2480
2481
		$data = get_file_data( $file, $headers );
2482
2483
		$file_data_option[ $key ] = $data;
2484
2485
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2486
2487
		return $data;
2488
	}
2489
2490
2491
	/**
2492
	 * Return translated module tag.
2493
	 *
2494
	 * @param string $tag Tag as it appears in each module heading.
2495
	 *
2496
	 * @return mixed
2497
	 */
2498
	public static function translate_module_tag( $tag ) {
2499
		return jetpack_get_module_i18n_tag( $tag );
2500
	}
2501
2502
	/**
2503
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2504
	 *
2505
	 * @since 3.9.2
2506
	 *
2507
	 * @param array $modules
2508
	 *
2509
	 * @return string|void
2510
	 */
2511
	public static function get_translated_modules( $modules ) {
2512
		foreach ( $modules as $index => $module ) {
2513
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2514
			if ( isset( $module['name'] ) ) {
2515
				$modules[ $index ]['name'] = $i18n_module['name'];
2516
			}
2517
			if ( isset( $module['description'] ) ) {
2518
				$modules[ $index ]['description'] = $i18n_module['description'];
2519
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2520
			}
2521
		}
2522
		return $modules;
2523
	}
2524
2525
	/**
2526
	 * Get a list of activated modules as an array of module slugs.
2527
	 */
2528
	public static function get_active_modules() {
2529
		$active = Jetpack_Options::get_option( 'active_modules' );
2530
2531
		if ( ! is_array( $active ) ) {
2532
			$active = array();
2533
		}
2534
2535
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2536
			$active[] = 'vaultpress';
2537
		} else {
2538
			$active = array_diff( $active, array( 'vaultpress' ) );
2539
		}
2540
2541
		//If protect is active on the main site of a multisite, it should be active on all sites.
2542
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2543
			$active[] = 'protect';
2544
		}
2545
2546
		return array_unique( $active );
2547
	}
2548
2549
	/**
2550
	 * Check whether or not a Jetpack module is active.
2551
	 *
2552
	 * @param string $module The slug of a Jetpack module.
2553
	 * @return bool
2554
	 *
2555
	 * @static
2556
	 */
2557
	public static function is_module_active( $module ) {
2558
		return in_array( $module, self::get_active_modules() );
2559
	}
2560
2561
	public static function is_module( $module ) {
2562
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2563
	}
2564
2565
	/**
2566
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2567
	 *
2568
	 * @param bool $catch True to start catching, False to stop.
2569
	 *
2570
	 * @static
2571
	 */
2572
	public static function catch_errors( $catch ) {
2573
		static $display_errors, $error_reporting;
2574
2575
		if ( $catch ) {
2576
			$display_errors  = @ini_set( 'display_errors', 1 );
2577
			$error_reporting = @error_reporting( E_ALL );
2578
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2579
		} else {
2580
			@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...
2581
			@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...
2582
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2583
		}
2584
	}
2585
2586
	/**
2587
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2588
	 */
2589
	public static function catch_errors_on_shutdown() {
2590
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2591
	}
2592
2593
	/**
2594
	 * Rewrite any string to make paths easier to read.
2595
	 *
2596
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2597
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2598
	 *
2599
	 * @param $string
2600
	 * @return mixed
2601
	 */
2602
	public static function alias_directories( $string ) {
2603
		// ABSPATH has a trailing slash.
2604
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2605
		// WP_CONTENT_DIR does not have a trailing slash.
2606
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2607
2608
		return $string;
2609
	}
2610
2611
	public static function activate_default_modules(
2612
		$min_version = false,
2613
		$max_version = false,
2614
		$other_modules = array(),
2615
		$redirect = true,
2616
		$send_state_messages = true
2617
	) {
2618
		$jetpack = Jetpack::init();
2619
2620
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2621
		$modules = array_merge( $other_modules, $modules );
2622
2623
		// Look for standalone plugins and disable if active.
2624
2625
		$to_deactivate = array();
2626
		foreach ( $modules as $module ) {
2627
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2628
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2629
			}
2630
		}
2631
2632
		$deactivated = array();
2633
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2634
			list( $probable_file, $probable_title ) = $deactivate_me;
2635
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2636
				$deactivated[] = $module;
2637
			}
2638
		}
2639
2640
		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...
2641
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2642
2643
			$url = add_query_arg(
2644
				array(
2645
					'action'   => 'activate_default_modules',
2646
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2647
				),
2648
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2649
			);
2650
			wp_safe_redirect( $url );
2651
			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...
2652
		}
2653
2654
		/**
2655
		 * Fires before default modules are activated.
2656
		 *
2657
		 * @since 1.9.0
2658
		 *
2659
		 * @param string $min_version Minimum version number required to use modules.
2660
		 * @param string $max_version Maximum version number required to use modules.
2661
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2662
		 */
2663
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2664
2665
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2666
		Jetpack::restate();
2667
		Jetpack::catch_errors( true );
2668
2669
		$active = Jetpack::get_active_modules();
2670
2671
		foreach ( $modules as $module ) {
2672
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2673
				$active[] = $module;
2674
				self::update_active_modules( $active );
2675
				continue;
2676
			}
2677
2678
			if ( $send_state_messages && in_array( $module, $active ) ) {
2679
				$module_info = Jetpack::get_module( $module );
2680 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2681
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2682
					if ( $active_state = Jetpack::state( $state ) ) {
2683
						$active_state = explode( ',', $active_state );
2684
					} else {
2685
						$active_state = array();
2686
					}
2687
					$active_state[] = $module;
2688
					Jetpack::state( $state, implode( ',', $active_state ) );
2689
				}
2690
				continue;
2691
			}
2692
2693
			$file = Jetpack::get_module_path( $module );
2694
			if ( ! file_exists( $file ) ) {
2695
				continue;
2696
			}
2697
2698
			// we'll override this later if the plugin can be included without fatal error
2699
			if ( $redirect ) {
2700
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2701
			}
2702
2703
			if ( $send_state_messages ) {
2704
				Jetpack::state( 'error', 'module_activation_failed' );
2705
				Jetpack::state( 'module', $module );
2706
			}
2707
2708
			ob_start();
2709
			require $file;
2710
2711
			$active[] = $module;
2712
2713 View Code Duplication
			if ( $send_state_messages ) {
2714
2715
				$state    = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
0 ignored issues
show
Coding Style introduced by
Equals sign not aligned correctly; expected 1 space but found 4 spaces

This check looks for improperly formatted assignments.

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

To illustrate:

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

will have no issues, while

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

will report issues in lines 1 and 2.

Loading history...
2716
				if ( $active_state = Jetpack::state( $state ) ) {
2717
					$active_state = explode( ',', $active_state );
2718
				} else {
2719
					$active_state = array();
2720
				}
2721
				$active_state[] = $module;
2722
				Jetpack::state( $state, implode( ',', $active_state ) );
2723
			}
2724
2725
			Jetpack::update_active_modules( $active );
2726
2727
			ob_end_clean();
2728
		}
2729
2730
		if ( $send_state_messages ) {
2731
			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...
2732
			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...
2733
		}
2734
2735
		Jetpack::catch_errors( false );
2736
		/**
2737
		 * Fires when default modules are activated.
2738
		 *
2739
		 * @since 1.9.0
2740
		 *
2741
		 * @param string $min_version Minimum version number required to use modules.
2742
		 * @param string $max_version Maximum version number required to use modules.
2743
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2744
		 */
2745
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2746
	}
2747
2748
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2749
		/**
2750
		 * Fires before a module is activated.
2751
		 *
2752
		 * @since 2.6.0
2753
		 *
2754
		 * @param string $module Module slug.
2755
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2756
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2757
		 */
2758
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2759
2760
		$jetpack = Jetpack::init();
2761
2762
		if ( ! strlen( $module ) )
2763
			return false;
2764
2765
		if ( ! Jetpack::is_module( $module ) )
2766
			return false;
2767
2768
		// If it's already active, then don't do it again
2769
		$active = Jetpack::get_active_modules();
2770
		foreach ( $active as $act ) {
2771
			if ( $act == $module )
2772
				return true;
2773
		}
2774
2775
		$module_data = Jetpack::get_module( $module );
2776
2777
		if ( ! Jetpack::is_active() ) {
2778
			$is_onboarding = Jetpack_Options::get_option( 'onboarding' ) !== false;
2779
			if ( ! Jetpack::is_development_mode() && ! $is_onboarding )
2780
				return false;
2781
2782
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2783
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2784
				return false;
2785
		}
2786
2787
		// Check and see if the old plugin is active
2788
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2789
			// Deactivate the old plugin
2790
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2791
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2792
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2793
				Jetpack::state( 'deactivated_plugins', $module );
2794
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2795
				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...
2796
			}
2797
		}
2798
2799
		// Protect won't work with mis-configured IPs
2800
		if ( 'protect' === $module ) {
2801
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2802
			if ( ! jetpack_protect_get_ip() ) {
2803
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2804
				return false;
2805
			}
2806
		}
2807
2808
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2809
		Jetpack::state( 'module', $module );
2810
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2811
2812
		Jetpack::catch_errors( true );
2813
		ob_start();
2814
		require Jetpack::get_module_path( $module );
2815
		/** This action is documented in class.jetpack.php */
2816
		do_action( 'jetpack_activate_module', $module );
2817
		$active[] = $module;
2818
		Jetpack::update_active_modules( $active );
2819
2820
		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...
2821
		ob_end_clean();
2822
		Jetpack::catch_errors( false );
2823
2824
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2825 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2826
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2827
2828
			//Jump start is being dismissed send data to MC Stats
2829
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2830
2831
			$jetpack->do_stats( 'server_side' );
2832
		}
2833
2834
		if ( $redirect ) {
2835
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2836
		}
2837
		if ( $exit ) {
2838
			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...
2839
		}
2840
		return true;
2841
	}
2842
2843
	function activate_module_actions( $module ) {
2844
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2845
	}
2846
2847
	public static function deactivate_module( $module ) {
2848
		/**
2849
		 * Fires when a module is deactivated.
2850
		 *
2851
		 * @since 1.9.0
2852
		 *
2853
		 * @param string $module Module slug.
2854
		 */
2855
		do_action( 'jetpack_pre_deactivate_module', $module );
2856
2857
		$jetpack = Jetpack::init();
2858
2859
		$active = Jetpack::get_active_modules();
2860
		$new    = array_filter( array_diff( $active, (array) $module ) );
2861
2862
		// A flag for Jump Start so it's not shown again.
2863 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2864
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2865
2866
			//Jump start is being dismissed send data to MC Stats
2867
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2868
2869
			$jetpack->do_stats( 'server_side' );
2870
		}
2871
2872
		return self::update_active_modules( $new );
2873
	}
2874
2875
	public static function enable_module_configurable( $module ) {
2876
		$module = Jetpack::get_module_slug( $module );
2877
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2878
	}
2879
2880
	public static function module_configuration_url( $module ) {
2881
		$module = Jetpack::get_module_slug( $module );
2882
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2883
	}
2884
2885
	public static function module_configuration_load( $module, $method ) {
2886
		$module = Jetpack::get_module_slug( $module );
2887
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2888
	}
2889
2890
	public static function module_configuration_head( $module, $method ) {
2891
		$module = Jetpack::get_module_slug( $module );
2892
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2893
	}
2894
2895
	public static function module_configuration_screen( $module, $method ) {
2896
		$module = Jetpack::get_module_slug( $module );
2897
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2898
	}
2899
2900
	public static function module_configuration_activation_screen( $module, $method ) {
2901
		$module = Jetpack::get_module_slug( $module );
2902
		add_action( 'display_activate_module_setting_' . $module, $method );
2903
	}
2904
2905
/* Installation */
2906
2907
	public static function bail_on_activation( $message, $deactivate = true ) {
2908
?>
2909
<!doctype html>
2910
<html>
2911
<head>
2912
<meta charset="<?php bloginfo( 'charset' ); ?>">
2913
<style>
2914
* {
2915
	text-align: center;
2916
	margin: 0;
2917
	padding: 0;
2918
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2919
}
2920
p {
2921
	margin-top: 1em;
2922
	font-size: 18px;
2923
}
2924
</style>
2925
<body>
2926
<p><?php echo esc_html( $message ); ?></p>
2927
</body>
2928
</html>
2929
<?php
2930
		if ( $deactivate ) {
2931
			$plugins = get_option( 'active_plugins' );
2932
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2933
			$update  = false;
2934
			foreach ( $plugins as $i => $plugin ) {
2935
				if ( $plugin === $jetpack ) {
2936
					$plugins[$i] = false;
2937
					$update = true;
2938
				}
2939
			}
2940
2941
			if ( $update ) {
2942
				update_option( 'active_plugins', array_filter( $plugins ) );
2943
			}
2944
		}
2945
		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...
2946
	}
2947
2948
	/**
2949
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2950
	 * @static
2951
	 */
2952
	public static function plugin_activation( $network_wide ) {
2953
		Jetpack_Options::update_option( 'activated', 1 );
2954
2955
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2956
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2957
		}
2958
2959
		if ( $network_wide )
2960
			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...
2961
2962
		// For firing one-off events (notices) immediately after activation
2963
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2964
2965
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2966
2967
		Jetpack::plugin_initialize();
2968
	}
2969
2970
	public static function get_activation_source( $referer_url ) {
2971
2972
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2973
			return array( 'wp-cli', null );
2974
		}
2975
2976
		$referer = parse_url( $referer_url );
2977
2978
		$source_type = 'unknown';
2979
		$source_query = null;
2980
2981
		if ( ! is_array( $referer ) ) {
2982
			return array( $source_type, $source_query );
2983
		}
2984
2985
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
2986
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
2987
2988
		if ( isset( $referer['query'] ) ) {
2989
			parse_str( $referer['query'], $query_parts );
2990
		} else {
2991
			$query_parts = array();
2992
		}
2993
2994
		if ( $plugins_path === $referer['path'] ) {
2995
			$source_type = 'list';
2996
		} elseif ( $plugins_install_path === $referer['path'] ) {
2997
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
2998
			switch( $tab ) {
2999
				case 'popular':
3000
					$source_type = 'popular';
3001
					break;
3002
				case 'recommended':
3003
					$source_type = 'recommended';
3004
					break;
3005
				case 'favorites':
3006
					$source_type = 'favorites';
3007
					break;
3008
				case 'search':
3009
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3010
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3011
					break;
3012
				default:
3013
					$source_type = 'featured';
3014
			}
3015
		}
3016
3017
		return array( $source_type, $source_query );
3018
	}
3019
3020
	/**
3021
	 * Runs before bumping version numbers up to a new version
3022
	 * @param  string $version    Version:timestamp
3023
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3024
	 * @return null              [description]
3025
	 */
3026
	public static function do_version_bump( $version, $old_version ) {
3027
3028
		if ( ! $old_version ) { // For new sites
3029
			// Setting up jetpack manage
3030
			Jetpack::activate_manage();
3031
		}
3032
	}
3033
3034
	/**
3035
	 * Sets the internal version number and activation state.
3036
	 * @static
3037
	 */
3038
	public static function plugin_initialize() {
3039
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3040
			Jetpack_Options::update_option( 'activated', 2 );
3041
		}
3042
3043 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3044
			$version = $old_version = JETPACK__VERSION . ':' . time();
3045
			/** This action is documented in class.jetpack.php */
3046
			do_action( 'updating_jetpack_version', $version, false );
3047
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3048
		}
3049
3050
		Jetpack::load_modules();
3051
3052
		Jetpack_Options::delete_option( 'do_activate' );
3053
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3054
	}
3055
3056
	/**
3057
	 * Removes all connection options
3058
	 * @static
3059
	 */
3060
	public static function plugin_deactivation( ) {
3061
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3062
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3063
			Jetpack_Network::init()->deactivate();
3064
		} else {
3065
			Jetpack::disconnect( false );
3066
			//Jetpack_Heartbeat::init()->deactivate();
3067
		}
3068
	}
3069
3070
	/**
3071
	 * Disconnects from the Jetpack servers.
3072
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3073
	 * @static
3074
	 */
3075
	public static function disconnect( $update_activated_state = true ) {
3076
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3077
		Jetpack::clean_nonces( true );
3078
3079
		// If the site is in an IDC because sync is not allowed,
3080
		// let's make sure to not disconnect the production site.
3081
		if ( ! self::validate_sync_error_idc_option() ) {
3082
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3083
			Jetpack::load_xml_rpc_client();
3084
			$xml = new Jetpack_IXR_Client();
3085
			$xml->query( 'jetpack.deregister' );
3086
		}
3087
3088
		Jetpack_Options::delete_option(
3089
			array(
3090
				'blog_token',
3091
				'user_token',
3092
				'user_tokens',
3093
				'master_user',
3094
				'time_diff',
3095
				'fallback_no_verify_ssl_certs',
3096
			)
3097
		);
3098
3099
		Jetpack_IDC::clear_all_idc_options();
3100
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3101
3102
		if ( $update_activated_state ) {
3103
			Jetpack_Options::update_option( 'activated', 4 );
3104
		}
3105
3106
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3107
			// Check then record unique disconnection if site has never been disconnected previously
3108
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3109
				$jetpack_unique_connection['disconnected'] = 1;
3110
			} else {
3111
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3112
					//track unique disconnect
3113
					$jetpack = Jetpack::init();
3114
3115
					$jetpack->stat( 'connections', 'unique-disconnect' );
3116
					$jetpack->do_stats( 'server_side' );
3117
				}
3118
				// increment number of times disconnected
3119
				$jetpack_unique_connection['disconnected'] += 1;
3120
			}
3121
3122
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3123
		}
3124
3125
		// Delete cached connected user data
3126
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3127
		delete_transient( $transient_key );
3128
3129
		// Delete all the sync related data. Since it could be taking up space.
3130
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3131
		Jetpack_Sync_Sender::get_instance()->uninstall();
3132
3133
		// Disable the Heartbeat cron
3134
		Jetpack_Heartbeat::init()->deactivate();
3135
	}
3136
3137
	/**
3138
	 * Unlinks the current user from the linked WordPress.com user
3139
	 */
3140
	public static function unlink_user( $user_id = null ) {
3141
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3142
			return false;
3143
3144
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3145
3146
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3147
			return false;
3148
3149
		if ( ! isset( $tokens[ $user_id ] ) )
3150
			return false;
3151
3152
		Jetpack::load_xml_rpc_client();
3153
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3154
		$xml->query( 'jetpack.unlink_user', $user_id );
3155
3156
		unset( $tokens[ $user_id ] );
3157
3158
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3159
3160
		/**
3161
		 * Fires after the current user has been unlinked from WordPress.com.
3162
		 *
3163
		 * @since 4.1.0
3164
		 *
3165
		 * @param int $user_id The current user's ID.
3166
		 */
3167
		do_action( 'jetpack_unlinked_user', $user_id );
3168
3169
		return true;
3170
	}
3171
3172
	/**
3173
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3174
	 */
3175
	public static function try_registration() {
3176
		// Let's get some testing in beta versions and such.
3177
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3178
			// Before attempting to connect, let's make sure that the domains are viable.
3179
			$domains_to_check = array_unique( array(
3180
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3181
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3182
			) );
3183
			foreach ( $domains_to_check as $domain ) {
3184
				$result = Jetpack_Data::is_usable_domain( $domain );
3185
				if ( is_wp_error( $result ) ) {
3186
					return $result;
3187
				}
3188
			}
3189
		}
3190
3191
		$result = Jetpack::register();
3192
3193
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3194
		if ( ! $result || is_wp_error( $result ) ) {
3195
			return $result;
3196
		} else {
3197
			return true;
3198
		}
3199
	}
3200
3201
	/**
3202
	 * Tracking an internal event log. Try not to put too much chaff in here.
3203
	 *
3204
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3205
	 */
3206
	public static function log( $code, $data = null ) {
3207
		// only grab the latest 200 entries
3208
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3209
3210
		// Append our event to the log
3211
		$log_entry = array(
3212
			'time'    => time(),
3213
			'user_id' => get_current_user_id(),
3214
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3215
			'code'    => $code,
3216
		);
3217
		// Don't bother storing it unless we've got some.
3218
		if ( ! is_null( $data ) ) {
3219
			$log_entry['data'] = $data;
3220
		}
3221
		$log[] = $log_entry;
3222
3223
		// Try add_option first, to make sure it's not autoloaded.
3224
		// @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...
3225
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3226
			Jetpack_Options::update_option( 'log', $log );
3227
		}
3228
3229
		/**
3230
		 * Fires when Jetpack logs an internal event.
3231
		 *
3232
		 * @since 3.0.0
3233
		 *
3234
		 * @param array $log_entry {
3235
		 *	Array of details about the log entry.
3236
		 *
3237
		 *	@param string time Time of the event.
3238
		 *	@param int user_id ID of the user who trigerred the event.
3239
		 *	@param int blog_id Jetpack Blog ID.
3240
		 *	@param string code Unique name for the event.
3241
		 *	@param string data Data about the event.
3242
		 * }
3243
		 */
3244
		do_action( 'jetpack_log_entry', $log_entry );
3245
	}
3246
3247
	/**
3248
	 * Get the internal event log.
3249
	 *
3250
	 * @param $event (string) - only return the specific log events
3251
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3252
	 *
3253
	 * @return array of log events || WP_Error for invalid params
3254
	 */
3255
	public static function get_log( $event = false, $num = false ) {
3256
		if ( $event && ! is_string( $event ) ) {
3257
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3258
		}
3259
3260
		if ( $num && ! is_numeric( $num ) ) {
3261
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3262
		}
3263
3264
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3265
3266
		// If nothing set - act as it did before, otherwise let's start customizing the output
3267
		if ( ! $num && ! $event ) {
3268
			return $entire_log;
3269
		} else {
3270
			$entire_log = array_reverse( $entire_log );
3271
		}
3272
3273
		$custom_log_output = array();
3274
3275
		if ( $event ) {
3276
			foreach ( $entire_log as $log_event ) {
3277
				if ( $event == $log_event[ 'code' ] ) {
3278
					$custom_log_output[] = $log_event;
3279
				}
3280
			}
3281
		} else {
3282
			$custom_log_output = $entire_log;
3283
		}
3284
3285
		if ( $num ) {
3286
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3287
		}
3288
3289
		return $custom_log_output;
3290
	}
3291
3292
	/**
3293
	 * Log modification of important settings.
3294
	 */
3295
	public static function log_settings_change( $option, $old_value, $value ) {
3296
		switch( $option ) {
3297
			case 'jetpack_sync_non_public_post_stati':
3298
				self::log( $option, $value );
3299
				break;
3300
		}
3301
	}
3302
3303
	/**
3304
	 * Return stat data for WPCOM sync
3305
	 */
3306
	public static function get_stat_data( $encode = true, $extended = true ) {
3307
		$data = Jetpack_Heartbeat::generate_stats_array();
3308
3309
		if ( $extended ) {
3310
			$additional_data = self::get_additional_stat_data();
3311
			$data = array_merge( $data, $additional_data );
3312
		}
3313
3314
		if ( $encode ) {
3315
			return json_encode( $data );
3316
		}
3317
3318
		return $data;
3319
	}
3320
3321
	/**
3322
	 * Get additional stat data to sync to WPCOM
3323
	 */
3324
	public static function get_additional_stat_data( $prefix = '' ) {
3325
		$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...
3326
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3327
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3328
		$return["{$prefix}site-count"]     = 0;
3329
3330
		if ( function_exists( 'get_blog_count' ) ) {
3331
			$return["{$prefix}site-count"] = get_blog_count();
3332
		}
3333
		return $return;
3334
	}
3335
3336
	private static function get_site_user_count() {
3337
		global $wpdb;
3338
3339
		if ( function_exists( 'wp_is_large_network' ) ) {
3340
			if ( wp_is_large_network( 'users' ) ) {
3341
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3342
			}
3343
		}
3344 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3345
			// It wasn't there, so regenerate the data and save the transient
3346
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3347
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3348
		}
3349
		return $user_count;
3350
	}
3351
3352
	/* Admin Pages */
3353
3354
	function admin_init() {
3355
		// If the plugin is not connected, display a connect message.
3356
		if (
3357
			// the plugin was auto-activated and needs its candy
3358
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3359
		||
3360
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3361
			! Jetpack_Options::get_option( 'activated' )
3362
		) {
3363
			Jetpack::plugin_initialize();
3364
		}
3365
3366
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3367
			Jetpack_Connection_Banner::init();
3368
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3369
			// Upgrade: 1.1 -> 1.1.1
3370
			// Check and see if host can verify the Jetpack servers' SSL certificate
3371
			$args = array();
3372
			Jetpack_Client::_wp_remote_request(
3373
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3374
				$args,
3375
				true
3376
			);
3377
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3378
			// Show the notice on the Dashboard only for now
3379
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3380
		}
3381
3382
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3383
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3384
		}
3385
3386
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3387
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3388
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3389
3390
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3391
			// Artificially throw errors in certain whitelisted cases during plugin activation
3392
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3393
		}
3394
3395
		// Jetpack Manage Activation Screen from .com
3396
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3397
3398
		// Add custom column in wp-admin/users.php to show whether user is linked.
3399
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3400
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3401
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3402
	}
3403
3404
	function admin_body_class( $admin_body_class = '' ) {
3405
		$classes = explode( ' ', trim( $admin_body_class ) );
3406
3407
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3408
3409
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3410
		return " $admin_body_class ";
3411
	}
3412
3413
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3414
		return $admin_body_class . ' jetpack-pagestyles ';
3415
	}
3416
3417
	/**
3418
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3419
	 *
3420
	 * @return null
3421
	 */
3422
	function prepare_manage_jetpack_notice() {
3423
3424
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3425
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3426
	}
3427
3428
	function manage_activate_screen() {
3429
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3430
	}
3431
	/**
3432
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3433
	 * This function artificially throws errors for such cases (whitelisted).
3434
	 *
3435
	 * @param string $plugin The activated plugin.
3436
	 */
3437
	function throw_error_on_activate_plugin( $plugin ) {
3438
		$active_modules = Jetpack::get_active_modules();
3439
3440
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3441
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3442
			$throw = false;
3443
3444
			// Try and make sure it really was the stats plugin
3445
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3446
				if ( 'stats.php' == basename( $plugin ) ) {
3447
					$throw = true;
3448
				}
3449
			} else {
3450
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3451
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3452
					$throw = true;
3453
				}
3454
			}
3455
3456
			if ( $throw ) {
3457
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3458
			}
3459
		}
3460
	}
3461
3462
	function intercept_plugin_error_scrape_init() {
3463
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3464
	}
3465
3466
	function intercept_plugin_error_scrape( $action, $result ) {
3467
		if ( ! $result ) {
3468
			return;
3469
		}
3470
3471
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3472
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3473
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3474
			}
3475
		}
3476
	}
3477
3478
	function add_remote_request_handlers() {
3479
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3480
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3481
	}
3482
3483
	function remote_request_handlers() {
3484
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$action is not used, you could remove the assignment.

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

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

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

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

Loading history...
3485
3486
		switch ( current_filter() ) {
3487
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3488
			$response = $this->upload_handler();
3489
			break;
3490
3491
		case 'wp_ajax_nopriv_jetpack_update_file' :
3492
			$response = $this->upload_handler( true );
3493
			break;
3494
		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...
3495
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3496
			break;
3497
		}
3498
3499
		if ( ! $response ) {
3500
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3501
		}
3502
3503
		if ( is_wp_error( $response ) ) {
3504
			$status_code       = $response->get_error_data();
3505
			$error             = $response->get_error_code();
3506
			$error_description = $response->get_error_message();
3507
3508
			if ( ! is_int( $status_code ) ) {
3509
				$status_code = 400;
3510
			}
3511
3512
			status_header( $status_code );
3513
			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...
3514
		}
3515
3516
		status_header( 200 );
3517
		if ( true === $response ) {
3518
			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...
3519
		}
3520
3521
		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...
3522
	}
3523
3524
	/**
3525
	 * Uploads a file gotten from the global $_FILES.
3526
	 * If `$update_media_item` is true and `post_id` is defined
3527
	 * the attachment file of the media item (gotten through of the post_id)
3528
	 * will be updated instead of add a new one.
3529
	 *
3530
	 * @param  boolean $update_media_item - update media attachment
3531
	 * @return array - An array describing the uploadind files process
3532
	 */
3533
	function upload_handler( $update_media_item = false ) {
3534
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3535
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3536
		}
3537
3538
		$user = wp_authenticate( '', '' );
3539
		if ( ! $user || is_wp_error( $user ) ) {
3540
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3541
		}
3542
3543
		wp_set_current_user( $user->ID );
3544
3545
		if ( ! current_user_can( 'upload_files' ) ) {
3546
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3547
		}
3548
3549
		if ( empty( $_FILES ) ) {
3550
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3551
		}
3552
3553
		foreach ( array_keys( $_FILES ) as $files_key ) {
3554
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3555
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3556
			}
3557
		}
3558
3559
		$media_keys = array_keys( $_FILES['media'] );
3560
3561
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3562
		if ( ! $token || is_wp_error( $token ) ) {
3563
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3564
		}
3565
3566
		$uploaded_files = array();
3567
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3568
		unset( $GLOBALS['post'] );
3569
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3570
			$file = array();
3571
			foreach ( $media_keys as $media_key ) {
3572
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3573
			}
3574
3575
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3576
3577
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3578
			if ( $hmac_provided !== $hmac_file ) {
3579
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3580
				continue;
3581
			}
3582
3583
			$_FILES['.jetpack.upload.'] = $file;
3584
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3585
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3586
				$post_id = 0;
3587
			}
3588
3589
			if ( $update_media_item ) {
3590
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3591
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3592
				}
3593
3594
				$media_array = $_FILES['media'];
3595
3596
				$file_array['name'] = $media_array['name'][0];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$file_array was never initialized. Although not strictly required by PHP, it is generally a good practice to add $file_array = array(); before regardless.

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

Let’s take a look at an example:

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

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

    // do something with $myArray
}

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

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

Loading history...
3597
				$file_array['type'] = $media_array['type'][0];
3598
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3599
				$file_array['error'] = $media_array['error'][0];
3600
				$file_array['size'] = $media_array['size'][0];
3601
3602
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3603
3604
				if ( is_wp_error( $edited_media_item ) ) {
3605
					return $edited_media_item;
3606
				}
3607
3608
				$response = (object) array(
3609
					'id'   => (string) $post_id,
3610
					'file' => (string) $edited_media_item->post_title,
3611
					'url'  => (string) wp_get_attachment_url( $post_id ),
3612
					'type' => (string) $edited_media_item->post_mime_type,
3613
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3614
				);
3615
3616
				return (array) array( $response );
3617
			}
3618
3619
			$attachment_id = media_handle_upload(
3620
				'.jetpack.upload.',
3621
				$post_id,
3622
				array(),
3623
				array(
3624
					'action' => 'jetpack_upload_file',
3625
				)
3626
			);
3627
3628
			if ( ! $attachment_id ) {
3629
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3630
			} elseif ( is_wp_error( $attachment_id ) ) {
3631
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3632
			} else {
3633
				$attachment = get_post( $attachment_id );
3634
				$uploaded_files[$index] = (object) array(
3635
					'id'   => (string) $attachment_id,
3636
					'file' => $attachment->post_title,
3637
					'url'  => wp_get_attachment_url( $attachment_id ),
3638
					'type' => $attachment->post_mime_type,
3639
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3640
				);
3641
				// Zip files uploads are not supported unless they are done for installation purposed
3642
				// lets delete them in case something goes wrong in this whole process
3643
				if ( 'application/zip' === $attachment->post_mime_type ) {
3644
					// Schedule a cleanup for 2 hours from now in case of failed install.
3645
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3646
				}
3647
			}
3648
		}
3649
		if ( ! is_null( $global_post ) ) {
3650
			$GLOBALS['post'] = $global_post;
3651
		}
3652
3653
		return $uploaded_files;
3654
	}
3655
3656
	/**
3657
	 * Add help to the Jetpack page
3658
	 *
3659
	 * @since Jetpack (1.2.3)
3660
	 * @return false if not the Jetpack page
3661
	 */
3662
	function admin_help() {
3663
		$current_screen = get_current_screen();
3664
3665
		// Overview
3666
		$current_screen->add_help_tab(
3667
			array(
3668
				'id'		=> 'home',
3669
				'title'		=> __( 'Home', 'jetpack' ),
3670
				'content'	=>
3671
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3672
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3673
					'<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>',
3674
			)
3675
		);
3676
3677
		// Screen Content
3678
		if ( current_user_can( 'manage_options' ) ) {
3679
			$current_screen->add_help_tab(
3680
				array(
3681
					'id'		=> 'settings',
3682
					'title'		=> __( 'Settings', 'jetpack' ),
3683
					'content'	=>
3684
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3685
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3686
						'<ol>' .
3687
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3688
							'<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>' .
3689
						'</ol>' .
3690
						'<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>'
3691
				)
3692
			);
3693
		}
3694
3695
		// Help Sidebar
3696
		$current_screen->set_help_sidebar(
3697
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3698
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3699
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3700
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3701
		);
3702
	}
3703
3704
	function admin_menu_css() {
3705
		wp_enqueue_style( 'jetpack-icons' );
3706
	}
3707
3708
	function admin_menu_order() {
3709
		return true;
3710
	}
3711
3712 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3713
		$jp_menu_order = array();
3714
3715
		foreach ( $menu_order as $index => $item ) {
3716
			if ( $item != 'jetpack' ) {
3717
				$jp_menu_order[] = $item;
3718
			}
3719
3720
			if ( $index == 0 ) {
3721
				$jp_menu_order[] = 'jetpack';
3722
			}
3723
		}
3724
3725
		return $jp_menu_order;
3726
	}
3727
3728
	function admin_head() {
3729 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3730
			/** This action is documented in class.jetpack-admin-page.php */
3731
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3732
	}
3733
3734
	function admin_banner_styles() {
3735
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3736
3737 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3738
			wp_register_style(
3739
				'jetpack-dops-style',
3740
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3741
				array(),
3742
				JETPACK__VERSION
3743
			);
3744
		}
3745
3746
		wp_enqueue_style(
3747
			'jetpack',
3748
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3749
			array( 'jetpack-dops-style' ),
3750
			 JETPACK__VERSION . '-20121016'
3751
		);
3752
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3753
		wp_style_add_data( 'jetpack', 'suffix', $min );
3754
	}
3755
3756
	function plugin_action_links( $actions ) {
3757
3758
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3759
3760
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3761
			return array_merge(
3762
				$jetpack_home,
3763
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3764
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3765
				$actions
3766
				);
3767
			}
3768
3769
		return array_merge( $jetpack_home, $actions );
3770
	}
3771
3772
	/**
3773
	 * This is the first banner
3774
	 * It should be visible only to user that can update the option
3775
	 * Are not connected
3776
	 *
3777
	 * @return null
3778
	 */
3779
	function admin_jetpack_manage_notice() {
3780
		$screen = get_current_screen();
3781
3782
		// Don't show the connect notice on the jetpack settings page.
3783
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3784
			return;
3785
		}
3786
3787
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3788
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3789
		/**
3790
		 * I think it would be great to have different wordsing depending on where you are
3791
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3792
		 * etc..
3793
		 */
3794
3795
		?>
3796
		<div id="message" class="updated jp-banner">
3797
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3798
				<div class="jp-banner__description-container">
3799
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3800
					<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>
3801
					<p class="jp-banner__button-container">
3802
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3803
						<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>
3804
					</p>
3805
				</div>
3806
		</div>
3807
		<?php
3808
	}
3809
3810
	/**
3811
	 * Returns the url that the user clicks to remove the notice for the big banner
3812
	 * @return string
3813
	 */
3814
	function opt_out_jetpack_manage_url() {
3815
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3816
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3817
	}
3818
	/**
3819
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3820
	 * @return string
3821
	 */
3822
	function opt_in_jetpack_manage_url() {
3823
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3824
	}
3825
3826
	function opt_in_jetpack_manage_notice() {
3827
		?>
3828
		<div class="wrap">
3829
			<div id="message" class="jetpack-message is-opt-in">
3830
				<?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' ); ?>
3831
			</div>
3832
		</div>
3833
		<?php
3834
3835
	}
3836
	/**
3837
	 * Determines whether to show the notice of not true = display notice
3838
	 * @return bool
3839
	 */
3840
	function can_display_jetpack_manage_notice() {
3841
		// never display the notice to users that can't do anything about it anyways
3842
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3843
			return false;
3844
3845
		// don't display if we are in development more
3846
		if( Jetpack::is_development_mode() ) {
3847
			return false;
3848
		}
3849
		// don't display if the site is private
3850
		if(  ! Jetpack_Options::get_option( 'public' ) )
3851
			return false;
3852
3853
		/**
3854
		 * Should the Jetpack Remote Site Management notice be displayed.
3855
		 *
3856
		 * @since 3.3.0
3857
		 *
3858
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3859
		 */
3860
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3861
	}
3862
3863
	/*
3864
	 * Registration flow:
3865
	 * 1 - ::admin_page_load() action=register
3866
	 * 2 - ::try_registration()
3867
	 * 3 - ::register()
3868
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3869
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3870
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3871
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3872
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3873
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3874
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3875
	 *       jetpack_id, jetpack_secret, jetpack_public
3876
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3877
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3878
	 * 5 - user logs in with WP.com account
3879
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3880
	 *		- Jetpack_Client_Server::authorize()
3881
	 *		- Jetpack_Client_Server::get_token()
3882
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3883
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3884
	 *			- which responds with access_token, token_type, scope
3885
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3886
	 *		- Jetpack::activate_default_modules()
3887
	 *     		- Deactivates deprecated plugins
3888
	 *     		- Activates all default modules
3889
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3890
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3891
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3892
	 *     Done!
3893
	 */
3894
3895
	/**
3896
	 * Handles the page load events for the Jetpack admin page
3897
	 */
3898
	function admin_page_load() {
3899
		$error = false;
3900
3901
		// Make sure we have the right body class to hook stylings for subpages off of.
3902
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3903
3904
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3905
			// Should only be used in intermediate redirects to preserve state across redirects
3906
			Jetpack::restate();
3907
		}
3908
3909
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3910
			// User clicked in the iframe to link their accounts
3911
			if ( ! Jetpack::is_user_connected() ) {
3912
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3913
				if ( isset( $_GET['notes_iframe'] ) )
3914
					$connect_url .= '&notes_iframe';
3915
				wp_redirect( $connect_url );
3916
				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...
3917
			} else {
3918
				if ( ! isset( $_GET['calypso_env'] ) ) {
3919
					Jetpack::state( 'message', 'already_authorized' );
3920
					wp_safe_redirect( Jetpack::admin_url() );
3921
					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...
3922
				} else {
3923
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3924
					$connect_url .= '&already_authorized=true';
3925
					wp_redirect( $connect_url );
3926
					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...
3927
				}
3928
			}
3929
		}
3930
3931
3932
		if ( isset( $_GET['action'] ) ) {
3933
			switch ( $_GET['action'] ) {
3934
			case 'authorize':
3935
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3936
					Jetpack::state( 'message', 'already_authorized' );
3937
					wp_safe_redirect( Jetpack::admin_url() );
3938
					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...
3939
				}
3940
				Jetpack::log( 'authorize' );
3941
				$client_server = new Jetpack_Client_Server;
3942
				$client_server->client_authorize();
3943
				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...
3944
			case 'register' :
3945
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3946
					$error = 'cheatin';
3947
					break;
3948
				}
3949
				check_admin_referer( 'jetpack-register' );
3950
				Jetpack::log( 'register' );
3951
				Jetpack::maybe_set_version_option();
3952
				$registered = Jetpack::try_registration();
3953
				if ( is_wp_error( $registered ) ) {
3954
					$error = $registered->get_error_code();
3955
					Jetpack::state( 'error', $error );
3956
					Jetpack::state( 'error', $registered->get_error_message() );
3957
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3958
						'error_code' => $error,
3959
						'error_message' => $registered->get_error_message()
3960
					) );
3961
					break;
3962
				}
3963
3964
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3965
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3966
3967
				JetpackTracking::record_user_event( 'jpc_register_success', array(
3968
					'from' => $from
3969
				) );
3970
3971
				wp_redirect( $this->build_connect_url( true, $redirect, $from ) );
3972
				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...
3973
			case 'activate' :
3974
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3975
					$error = 'cheatin';
3976
					break;
3977
				}
3978
3979
				$module = stripslashes( $_GET['module'] );
3980
				check_admin_referer( "jetpack_activate-$module" );
3981
				Jetpack::log( 'activate', $module );
3982
				Jetpack::activate_module( $module );
3983
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
3984
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3985
				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...
3986
			case 'activate_default_modules' :
3987
				check_admin_referer( 'activate_default_modules' );
3988
				Jetpack::log( 'activate_default_modules' );
3989
				Jetpack::restate();
3990
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
3991
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
3992
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
3993
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
3994
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
3995
				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...
3996
			case 'disconnect' :
3997
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
3998
					$error = 'cheatin';
3999
					break;
4000
				}
4001
4002
				check_admin_referer( 'jetpack-disconnect' );
4003
				Jetpack::log( 'disconnect' );
4004
				Jetpack::disconnect();
4005
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4006
				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...
4007
			case 'reconnect' :
4008
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4009
					$error = 'cheatin';
4010
					break;
4011
				}
4012
4013
				check_admin_referer( 'jetpack-reconnect' );
4014
				Jetpack::log( 'reconnect' );
4015
				$this->disconnect();
4016
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4017
				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...
4018 View Code Duplication
			case 'deactivate' :
4019
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4020
					$error = 'cheatin';
4021
					break;
4022
				}
4023
4024
				$modules = stripslashes( $_GET['module'] );
4025
				check_admin_referer( "jetpack_deactivate-$modules" );
4026
				foreach ( explode( ',', $modules ) as $module ) {
4027
					Jetpack::log( 'deactivate', $module );
4028
					Jetpack::deactivate_module( $module );
4029
					Jetpack::state( 'message', 'module_deactivated' );
4030
				}
4031
				Jetpack::state( 'module', $modules );
4032
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4033
				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...
4034
			case 'unlink' :
4035
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4036
				check_admin_referer( 'jetpack-unlink' );
4037
				Jetpack::log( 'unlink' );
4038
				$this->unlink_user();
4039
				Jetpack::state( 'message', 'unlinked' );
4040
				if ( 'sub-unlink' == $redirect ) {
4041
					wp_safe_redirect( admin_url() );
4042
				} else {
4043
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4044
				}
4045
				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...
4046
			case 'onboard' :
4047
				if ( ! current_user_can( 'manage_options' ) ) {
4048
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4049
				} else {
4050
					Jetpack::create_onboarding_token();
4051
					$url = $this->build_connect_url( true );
4052
4053
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4054
						$url = add_query_arg( 'onboarding', $token, $url );
4055
					}
4056
4057
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4058
					if ( $calypso_env ) {
4059
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4060
					}
4061
4062
					wp_redirect( $url );
4063
					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...
4064
				}
4065
				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...
4066
			default:
4067
				/**
4068
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4069
				 *
4070
				 * @since 2.6.0
4071
				 *
4072
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4073
				 */
4074
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4075
			}
4076
		}
4077
4078
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4079
			self::activate_new_modules( true );
4080
		}
4081
4082
		$message_code = Jetpack::state( 'message' );
4083
		if ( Jetpack::state( 'optin-manage' ) ) {
4084
			$activated_manage = $message_code;
4085
			$message_code = 'jetpack-manage';
4086
		}
4087
4088
		switch ( $message_code ) {
4089
		case 'jetpack-manage':
4090
			$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>';
4091
			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...
4092
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4093
			}
4094
			break;
4095
4096
		}
4097
4098
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4099
4100
		if ( ! empty( $deactivated_plugins ) ) {
4101
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4102
			$deactivated_titles  = array();
4103
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4104
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4105
					continue;
4106
				}
4107
4108
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4109
			}
4110
4111
			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...
4112
				if ( $this->message ) {
4113
					$this->message .= "<br /><br />\n";
4114
				}
4115
4116
				$this->message .= wp_sprintf(
4117
					_n(
4118
						'Jetpack contains the most recent version of the old %l plugin.',
4119
						'Jetpack contains the most recent versions of the old %l plugins.',
4120
						count( $deactivated_titles ),
4121
						'jetpack'
4122
					),
4123
					$deactivated_titles
4124
				);
4125
4126
				$this->message .= "<br />\n";
4127
4128
				$this->message .= _n(
4129
					'The old version has been deactivated and can be removed from your site.',
4130
					'The old versions have been deactivated and can be removed from your site.',
4131
					count( $deactivated_titles ),
4132
					'jetpack'
4133
				);
4134
			}
4135
		}
4136
4137
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4138
4139
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4140
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4141
		}
4142
4143 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4144
			/**
4145
			 * Fires when a module configuration page is loaded.
4146
			 * The dynamic part of the hook is the configure parameter from the URL.
4147
			 *
4148
			 * @since 1.1.0
4149
			 */
4150
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4151
		}
4152
4153
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4154
	}
4155
4156
	function admin_notices() {
4157
4158
		if ( $this->error ) {
4159
?>
4160
<div id="message" class="jetpack-message jetpack-err">
4161
	<div class="squeezer">
4162
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4163
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4164
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4165
<?php	endif; ?>
4166
	</div>
4167
</div>
4168
<?php
4169
		}
4170
4171
		if ( $this->message ) {
4172
?>
4173
<div id="message" class="jetpack-message">
4174
	<div class="squeezer">
4175
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4176
	</div>
4177
</div>
4178
<?php
4179
		}
4180
4181
		if ( $this->privacy_checks ) :
4182
			$module_names = $module_slugs = array();
4183
4184
			$privacy_checks = explode( ',', $this->privacy_checks );
4185
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4186
			foreach ( $privacy_checks as $module_slug ) {
4187
				$module = Jetpack::get_module( $module_slug );
4188
				if ( ! $module ) {
4189
					continue;
4190
				}
4191
4192
				$module_slugs[] = $module_slug;
4193
				$module_names[] = "<strong>{$module['name']}</strong>";
4194
			}
4195
4196
			$module_slugs = join( ',', $module_slugs );
4197
?>
4198
<div id="message" class="jetpack-message jetpack-err">
4199
	<div class="squeezer">
4200
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4201
		<p><?php
4202
			echo wp_kses(
4203
				wptexturize(
4204
					wp_sprintf(
4205
						_nx(
4206
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4207
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4208
							count( $privacy_checks ),
4209
							'%l = list of Jetpack module/feature names',
4210
							'jetpack'
4211
						),
4212
						$module_names
4213
					)
4214
				),
4215
				array( 'strong' => true )
4216
			);
4217
4218
			echo "\n<br />\n";
4219
4220
			echo wp_kses(
4221
				sprintf(
4222
					_nx(
4223
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4224
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4225
						count( $privacy_checks ),
4226
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4227
						'jetpack'
4228
					),
4229
					wp_nonce_url(
4230
						Jetpack::admin_url(
4231
							array(
4232
								'page'   => 'jetpack',
4233
								'action' => 'deactivate',
4234
								'module' => urlencode( $module_slugs ),
4235
							)
4236
						),
4237
						"jetpack_deactivate-$module_slugs"
4238
					),
4239
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4240
				),
4241
				array( 'a' => array( 'href' => true, 'title' => true ) )
4242
			);
4243
		?></p>
4244
	</div>
4245
</div>
4246
<?php endif;
4247
	// only display the notice if the other stuff is not there
4248
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4249
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4250
			$this->opt_in_jetpack_manage_notice();
4251
		}
4252
	}
4253
4254
	/**
4255
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4256
	 */
4257
	function stat( $group, $detail ) {
4258
		if ( ! isset( $this->stats[ $group ] ) )
4259
			$this->stats[ $group ] = array();
4260
		$this->stats[ $group ][] = $detail;
4261
	}
4262
4263
	/**
4264
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4265
	 */
4266
	function do_stats( $method = '' ) {
4267
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4268
			foreach ( $this->stats as $group => $stats ) {
4269
				if ( is_array( $stats ) && count( $stats ) ) {
4270
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4271
					if ( 'server_side' === $method ) {
4272
						self::do_server_side_stat( $args );
4273
					} else {
4274
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4275
					}
4276
				}
4277
				unset( $this->stats[ $group ] );
4278
			}
4279
		}
4280
	}
4281
4282
	/**
4283
	 * Runs stats code for a one-off, server-side.
4284
	 *
4285
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4286
	 *
4287
	 * @return bool If it worked.
4288
	 */
4289
	static function do_server_side_stat( $args ) {
4290
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4291
		if ( is_wp_error( $response ) )
4292
			return false;
4293
4294
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4295
			return false;
4296
4297
		return true;
4298
	}
4299
4300
	/**
4301
	 * Builds the stats url.
4302
	 *
4303
	 * @param $args array|string The arguments to append to the URL.
4304
	 *
4305
	 * @return string The URL to be pinged.
4306
	 */
4307
	static function build_stats_url( $args ) {
4308
		$defaults = array(
4309
			'v'    => 'wpcom2',
4310
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4311
		);
4312
		$args     = wp_parse_args( $args, $defaults );
4313
		/**
4314
		 * Filter the URL used as the Stats tracking pixel.
4315
		 *
4316
		 * @since 2.3.2
4317
		 *
4318
		 * @param string $url Base URL used as the Stats tracking pixel.
4319
		 */
4320
		$base_url = apply_filters(
4321
			'jetpack_stats_base_url',
4322
			'https://pixel.wp.com/g.gif'
4323
		);
4324
		$url      = add_query_arg( $args, $base_url );
4325
		return $url;
4326
	}
4327
4328
	static function translate_current_user_to_role() {
4329
		foreach ( self::$capability_translations as $role => $cap ) {
4330
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4331
				return $role;
4332
			}
4333
		}
4334
4335
		return false;
4336
	}
4337
4338
	static function translate_user_to_role( $user ) {
4339
		foreach ( self::$capability_translations as $role => $cap ) {
4340
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4341
				return $role;
4342
			}
4343
		}
4344
4345
		return false;
4346
    }
4347
4348
	static function translate_role_to_cap( $role ) {
4349
		if ( ! isset( self::$capability_translations[$role] ) ) {
4350
			return false;
4351
		}
4352
4353
		return self::$capability_translations[$role];
4354
	}
4355
4356
	static function sign_role( $role, $user_id = null ) {
4357
		if ( empty( $user_id ) ) {
4358
			$user_id = (int) get_current_user_id();
4359
		}
4360
4361
		if ( ! $user_id  ) {
4362
			return false;
4363
		}
4364
4365
		$token = Jetpack_Data::get_access_token();
4366
		if ( ! $token || is_wp_error( $token ) ) {
4367
			return false;
4368
		}
4369
4370
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4371
	}
4372
4373
4374
	/**
4375
	 * Builds a URL to the Jetpack connection auth page
4376
	 *
4377
	 * @since 3.9.5
4378
	 *
4379
	 * @param bool $raw If true, URL will not be escaped.
4380
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4381
	 *                              If string, will be a custom redirect.
4382
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4383
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4384
	 *
4385
	 * @return string Connect URL
4386
	 */
4387
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4388
		$site_id = Jetpack_Options::get_option( 'id' );
4389
		$token = Jetpack_Options::get_option( 'blog_token' );
4390
4391
		if ( $register || ! $token || ! $site_id ) {
4392
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4393
4394
			if ( ! empty( $redirect ) ) {
4395
				$url = add_query_arg(
4396
					'redirect',
4397
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4398
					$url
4399
				);
4400
			}
4401
4402
			if( is_network_admin() ) {
4403
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4404
			}
4405
		} else {
4406
4407
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4408
			// because otherwise this logic can get us in to a loop.
4409
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4410
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4411
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4412
4413
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4414
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4415
					'1.1'
4416
				);
4417
4418
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4419
					// Generating a register URL instead to refresh the existing token
4420
					return $this->build_connect_url( $raw, $redirect, $from, true );
4421
				}
4422
			}
4423
4424
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4425
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4426
			}
4427
4428
			$role = self::translate_current_user_to_role();
4429
			$signed_role = self::sign_role( $role );
4430
4431
			$user = wp_get_current_user();
4432
4433
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4434
			$redirect = $redirect
4435
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4436
				: $jetpack_admin_page;
4437
4438
			if( isset( $_REQUEST['is_multisite'] ) ) {
4439
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4440
			}
4441
4442
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4443
4444
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4445
				? get_site_icon_url()
4446
				: false;
4447
4448
			/**
4449
			 * Filter the type of authorization.
4450
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4451
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4452
			 *
4453
			 * @since 4.3.3
4454
			 *
4455
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4456
			 */
4457
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4458
4459
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4460
4461
			$args = urlencode_deep(
4462
				array(
4463
					'response_type' => 'code',
4464
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4465
					'redirect_uri'  => add_query_arg(
4466
						array(
4467
							'action'   => 'authorize',
4468
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4469
							'redirect' => urlencode( $redirect ),
4470
						),
4471
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4472
					),
4473
					'state'         => $user->ID,
4474
					'scope'         => $signed_role,
4475
					'user_email'    => $user->user_email,
4476
					'user_login'    => $user->user_login,
4477
					'is_active'     => Jetpack::is_active(),
4478
					'jp_version'    => JETPACK__VERSION,
4479
					'auth_type'     => $auth_type,
4480
					'secret'        => $secrets['secret_1'],
4481
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4482
					'blogname'      => get_option( 'blogname' ),
4483
					'site_url'      => site_url(),
4484
					'home_url'      => home_url(),
4485
					'site_icon'     => $site_icon,
4486
					'site_lang'     => get_locale(),
4487
					'_ui'           => $tracks_identity['_ui'],
4488
					'_ut'           => $tracks_identity['_ut']
4489
				)
4490
			);
4491
4492
			self::apply_activation_source_to_args( $args );
4493
4494
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4495
		}
4496
4497
		if ( $from ) {
4498
			$url = add_query_arg( 'from', $from, $url );
4499
		}
4500
4501
4502
		if ( isset( $_GET['calypso_env'] ) ) {
4503
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4504
		}
4505
4506
		return $raw ? $url : esc_url( $url );
4507
	}
4508
4509
	public static function apply_activation_source_to_args( &$args ) {
4510
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4511
4512
		if ( $activation_source_name ) {
4513
			$args['_as'] = urlencode( $activation_source_name );
4514
		}
4515
4516
		if ( $activation_source_keyword ) {
4517
			$args['_ak'] = urlencode( $activation_source_keyword );
4518
		}
4519
	}
4520
4521
	function build_reconnect_url( $raw = false ) {
4522
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4523
		return $raw ? $url : esc_url( $url );
4524
	}
4525
4526
	public static function admin_url( $args = null ) {
4527
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4528
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4529
		return $url;
4530
	}
4531
4532
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4533
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4534
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4535
	}
4536
4537
	function dismiss_jetpack_notice() {
4538
4539
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4540
			return;
4541
		}
4542
4543
		switch( $_GET['jetpack-notice'] ) {
4544
			case 'dismiss':
4545
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4546
4547
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4548
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4549
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4550
				}
4551
				break;
4552 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...
4553
4554
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4555
					// Don't show the banner again
4556
4557
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4558
					// redirect back to the page that had the notice
4559
					if ( wp_get_referer() ) {
4560
						wp_safe_redirect( wp_get_referer() );
4561
					} else {
4562
						// Take me to Jetpack
4563
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4564
					}
4565
				}
4566
				break;
4567 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...
4568
4569
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4570
					// Don't show the banner again
4571
4572
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4573
					// redirect back to the page that had the notice
4574
					if ( wp_get_referer() ) {
4575
						wp_safe_redirect( wp_get_referer() );
4576
					} else {
4577
						// Take me to Jetpack
4578
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4579
					}
4580
				}
4581
				break;
4582
			case 'jetpack-manage-opt-in':
4583
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4584
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4585
4586
					$redirection_url = Jetpack::admin_url();
4587
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4588
4589
					// Don't redirect form the Jetpack Setting Page
4590
					$referer_parsed = parse_url ( wp_get_referer() );
4591
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4592
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4593
						// Take the user to Jetpack home except when on the setting page
4594
						$redirection_url = wp_get_referer();
4595
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4596
					}
4597
					// Also update the JSON API FULL MANAGEMENT Option
4598
					Jetpack::activate_module( 'manage', false, false );
4599
4600
					// Special Message when option in.
4601
					Jetpack::state( 'optin-manage', 'true' );
4602
					// Activate the Module if not activated already
4603
4604
					// Redirect properly
4605
					wp_safe_redirect( $redirection_url );
4606
4607
				}
4608
				break;
4609
		}
4610
	}
4611
4612
	public static function admin_screen_configure_module( $module_id ) {
4613
4614
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4615
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4616
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4617
				/**
4618
				 * Fires to diplay a custom module activation screen.
4619
				 *
4620
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4621
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4622
				 *
4623
				 * @module manage
4624
				 *
4625
				 * @since 3.8.0
4626
				 *
4627
				 * @param int $module_id Module ID.
4628
				 */
4629
				do_action( 'display_activate_module_setting_' . $module_id );
4630
			} else {
4631
				self::display_activate_module_link( $module_id );
4632
			}
4633
4634
			return false;
4635
		} ?>
4636
4637
		<div id="jp-settings-screen" style="position: relative">
4638
			<h3>
4639
			<?php
4640
				$module = Jetpack::get_module( $module_id );
4641
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4642
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4643
			?>
4644
			</h3>
4645
			<?php
4646
				/**
4647
				 * Fires within the displayed message when a feature configuation is updated.
4648
				 *
4649
				 * @since 3.4.0
4650
				 *
4651
				 * @param int $module_id Module ID.
4652
				 */
4653
				do_action( 'jetpack_notices_update_settings', $module_id );
4654
				/**
4655
				 * Fires when a feature configuation screen is loaded.
4656
				 * The dynamic part of the hook, $module_id, is the module ID.
4657
				 *
4658
				 * @since 1.1.0
4659
				 */
4660
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4661
			?>
4662
		</div><?php
4663
	}
4664
4665
	/**
4666
	 * Display link to activate the module to see the settings screen.
4667
	 * @param  string $module_id
4668
	 * @return null
4669
	 */
4670
	public static function display_activate_module_link( $module_id ) {
4671
4672
		$info =  Jetpack::get_module( $module_id );
4673
		$extra = '';
4674
		$activate_url = wp_nonce_url(
4675
				Jetpack::admin_url(
4676
					array(
4677
						'page'   => 'jetpack',
4678
						'action' => 'activate',
4679
						'module' => $module_id,
4680
					)
4681
				),
4682
				"jetpack_activate-$module_id"
4683
			);
4684
4685
		?>
4686
4687
		<div class="wrap configure-module">
4688
			<div id="jp-settings-screen">
4689
				<?php
4690
				if ( $module_id == 'json-api' ) {
4691
4692
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4693
4694
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4695
4696
					$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' );
4697
4698
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4699
				} ?>
4700
4701
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4702
				<div class="narrow">
4703
					<p><?php echo  $info['description']; ?></p>
4704
					<?php if( $extra ) { ?>
4705
					<p><?php echo esc_html( $extra ); ?></p>
4706
					<?php } ?>
4707
					<p>
4708
						<?php
4709
						if( wp_get_referer() ) {
4710
							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() );
4711
						} else {
4712
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4713
						} ?>
4714
					</p>
4715
				</div>
4716
4717
			</div>
4718
		</div>
4719
4720
		<?php
4721
	}
4722
4723
	public static function sort_modules( $a, $b ) {
4724
		if ( $a['sort'] == $b['sort'] )
4725
			return 0;
4726
4727
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4728
	}
4729
4730
	function ajax_recheck_ssl() {
4731
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4732
		$result = Jetpack::permit_ssl( true );
4733
		wp_send_json( array(
4734
			'enabled' => $result,
4735
			'message' => get_transient( 'jetpack_https_test_message' )
4736
		) );
4737
	}
4738
4739
/* Client API */
4740
4741
	/**
4742
	 * Returns the requested Jetpack API URL
4743
	 *
4744
	 * @return string
4745
	 */
4746
	public static function api_url( $relative_url ) {
4747
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4748
	}
4749
4750
	/**
4751
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4752
	 */
4753
	public static function fix_url_for_bad_hosts( $url ) {
4754
		if ( 0 !== strpos( $url, 'https://' ) ) {
4755
			return $url;
4756
		}
4757
4758
		switch ( JETPACK_CLIENT__HTTPS ) {
4759
			case 'ALWAYS' :
4760
				return $url;
4761
			case 'NEVER' :
4762
				return set_url_scheme( $url, 'http' );
4763
			// default : case 'AUTO' :
4764
		}
4765
4766
		// we now return the unmodified SSL URL by default, as a security precaution
4767
		return $url;
4768
	}
4769
4770
	/**
4771
	 * Create a random secret for validating onboarding payload
4772
	 *
4773
	 * @return string Secret token
4774
	 */
4775
	public static function create_onboarding_token() {
4776
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4777
			$token = wp_generate_password( 32, false );
4778
			Jetpack_Options::update_option( 'onboarding', $token );
4779
		}
4780
4781
		return $token;
4782
	}
4783
4784
	/**
4785
	 * Remove the onboarding token
4786
	 *
4787
	 * @return bool True on success, false on failure
4788
	 */
4789
	public static function invalidate_onboarding_token() {
4790
		return Jetpack_Options::delete_option( 'onboarding' );
4791
	}
4792
4793
	/**
4794
	 * Validate an onboarding token for a specific action
4795
	 *
4796
	 * @return boolean True if token/action pair is accepted, false if not
4797
	 */
4798
	public static function validate_onboarding_token_action( $token, $action ) {
4799
		// Compare tokens, bail if tokens do not match
4800
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4801
			return false;
4802
		}
4803
4804
		// List of valid actions we can take
4805
		$valid_actions = array(
4806
			'/jetpack/v4/settings',
4807
		);
4808
4809
		// Whitelist the action
4810
		if ( ! in_array( $action, $valid_actions ) ) {
4811
			return false;
4812
		}
4813
4814
		return true;
4815
	}
4816
4817
	/**
4818
	 * Checks to see if the URL is using SSL to connect with Jetpack
4819
	 *
4820
	 * @since 2.3.3
4821
	 * @return boolean
4822
	 */
4823
	public static function permit_ssl( $force_recheck = false ) {
4824
		// Do some fancy tests to see if ssl is being supported
4825
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4826
			$message = '';
4827
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4828
				$ssl = 0;
4829
			} else {
4830
				switch ( JETPACK_CLIENT__HTTPS ) {
4831
					case 'NEVER':
4832
						$ssl = 0;
4833
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4834
						break;
4835
					case 'ALWAYS':
4836
					case 'AUTO':
4837
					default:
4838
						$ssl = 1;
4839
						break;
4840
				}
4841
4842
				// If it's not 'NEVER', test to see
4843
				if ( $ssl ) {
4844
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4845
						$ssl = 0;
4846
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4847
					} else {
4848
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4849
						if ( is_wp_error( $response ) ) {
4850
							$ssl = 0;
4851
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4852
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4853
							$ssl = 0;
4854
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4855
						}
4856
					}
4857
				}
4858
			}
4859
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4860
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4861
		}
4862
4863
		return (bool) $ssl;
4864
	}
4865
4866
	/*
4867
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4868
	 */
4869
	public function alert_auto_ssl_fail() {
4870
		if ( ! current_user_can( 'manage_options' ) )
4871
			return;
4872
4873
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4874
		?>
4875
4876
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4877
			<div class="jp-banner__content">
4878
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4879
				<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>
4880
				<p>
4881
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4882
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4883
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4884
				</p>
4885
				<p>
4886
					<?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' ),
4887
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4888
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4889
				</p>
4890
			</div>
4891
		</div>
4892
		<style>
4893
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4894
		</style>
4895
		<script type="text/javascript">
4896
			jQuery( document ).ready( function( $ ) {
4897
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4898
					var $this = $( this );
4899
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4900
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4901
					e.preventDefault();
4902
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4903
					$.post( ajaxurl, data )
4904
					  .done( function( response ) {
4905
					  	if ( response.enabled ) {
4906
					  		$( '#jetpack-ssl-warning' ).hide();
4907
					  	} else {
4908
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4909
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4910
					  	}
4911
					  }.bind( $this ) );
4912
				} );
4913
			} );
4914
		</script>
4915
4916
		<?php
4917
	}
4918
4919
	/**
4920
	 * Returns the Jetpack XML-RPC API
4921
	 *
4922
	 * @return string
4923
	 */
4924
	public static function xmlrpc_api_url() {
4925
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4926
		return untrailingslashit( $base ) . '/xmlrpc.php';
4927
	}
4928
4929
	/**
4930
	 * Creates two secret tokens and the end of life timestamp for them.
4931
	 *
4932
	 * Note these tokens are unique per call, NOT static per site for connecting.
4933
	 *
4934
	 * @since 2.6
4935
	 * @return array
4936
	 */
4937
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4938
		if ( ! $user_id ) {
4939
			$user_id = get_current_user_id();
4940
		}
4941
4942
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4943
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4944
4945
		if (
4946
			isset( $secrets[ $secret_name ] ) &&
4947
			$secrets[ $secret_name ]['exp'] > time()
4948
		) {
4949
			return $secrets[ $secret_name ];
4950
		}
4951
4952
		$secret_value = array(
4953
			'secret_1'  => wp_generate_password( 32, false ),
4954
			'secret_2'  => wp_generate_password( 32, false ),
4955
			'exp'       => time() + $exp,
4956
		);
4957
4958
		$secrets[ $secret_name ] = $secret_value;
4959
4960
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4961
		return $secrets[ $secret_name ];
4962
	}
4963
4964
	public static function get_secrets( $action, $user_id ) {
4965
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4966
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4967
4968
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4969
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4970
		}
4971
4972
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4973
			self::delete_secrets( $action, $user_id );
4974
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4975
		}
4976
4977
		return $secrets[ $secret_name ];
4978
	}
4979
4980
	public static function delete_secrets( $action, $user_id ) {
4981
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4982
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4983
		if ( isset( $secrets[ $secret_name ] ) ) {
4984
			unset( $secrets[ $secret_name ] );
4985
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4986
		}
4987
	}
4988
4989
	/**
4990
	 * Builds the timeout limit for queries talking with the wpcom servers.
4991
	 *
4992
	 * Based on local php max_execution_time in php.ini
4993
	 *
4994
	 * @since 2.6
4995
	 * @return int
4996
	 * @deprecated
4997
	 **/
4998
	public function get_remote_query_timeout_limit() {
4999
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5000
		return Jetpack::get_max_execution_time();
5001
	}
5002
5003
	/**
5004
	 * Builds the timeout limit for queries talking with the wpcom servers.
5005
	 *
5006
	 * Based on local php max_execution_time in php.ini
5007
	 *
5008
	 * @since 5.4
5009
	 * @return int
5010
	 **/
5011
	public static function get_max_execution_time() {
5012
		$timeout = (int) ini_get( 'max_execution_time' );
5013
5014
		// Ensure exec time set in php.ini
5015
		if ( ! $timeout ) {
5016
			$timeout = 30;
5017
		}
5018
		return $timeout;
5019
	}
5020
5021
	/**
5022
	 * Sets a minimum request timeout, and returns the current timeout
5023
	 *
5024
	 * @since 5.4
5025
	 **/
5026
	public static function set_min_time_limit( $min_timeout ) {
5027
		$timeout = self::get_max_execution_time();
5028
		if ( $timeout < $min_timeout ) {
5029
			$timeout = $min_timeout;
5030
			set_time_limit( $timeout );
5031
		}
5032
		return $timeout;
5033
	}
5034
5035
5036
	/**
5037
	 * Takes the response from the Jetpack register new site endpoint and
5038
	 * verifies it worked properly.
5039
	 *
5040
	 * @since 2.6
5041
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5042
	 **/
5043
	public function validate_remote_register_response( $response ) {
5044
	  if ( is_wp_error( $response ) ) {
5045
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5046
		}
5047
5048
		$code   = wp_remote_retrieve_response_code( $response );
5049
		$entity = wp_remote_retrieve_body( $response );
5050
		if ( $entity )
5051
			$registration_response = json_decode( $entity );
5052
		else
5053
			$registration_response = false;
5054
5055
		$code_type = intval( $code / 100 );
5056
		if ( 5 == $code_type ) {
5057
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5058
		} elseif ( 408 == $code ) {
5059
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5060
		} elseif ( ! empty( $registration_response->error ) ) {
5061
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5062
				$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' );
5063
			} else {
5064
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5065
			}
5066
5067
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5068
		} elseif ( 200 != $code ) {
5069
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5070
		}
5071
5072
		// Jetpack ID error block
5073
		if ( empty( $registration_response->jetpack_id ) ) {
5074
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5075
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5076
			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 );
5077
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5078
			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 );
5079
		}
5080
5081
	    return $registration_response;
5082
	}
5083
	/**
5084
	 * @return bool|WP_Error
5085
	 */
5086
	public static function register() {
5087
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5088
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5089
		$secrets = Jetpack::generate_secrets( 'register' );
5090
5091 View Code Duplication
		if (
5092
			empty( $secrets['secret_1'] ) ||
5093
			empty( $secrets['secret_2'] ) ||
5094
			empty( $secrets['exp'] )
5095
		) {
5096
			return new Jetpack_Error( 'missing_secrets' );
5097
		}
5098
5099
		// better to try (and fail) to set a higher timeout than this system
5100
		// supports than to have register fail for more users than it should
5101
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5102
5103
		$gmt_offset = get_option( 'gmt_offset' );
5104
		if ( ! $gmt_offset ) {
5105
			$gmt_offset = 0;
5106
		}
5107
5108
		$stats_options = get_option( 'stats_options' );
5109
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5110
5111
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5112
5113
		$args = array(
5114
			'method'  => 'POST',
5115
			'body'    => array(
5116
				'siteurl'         => site_url(),
5117
				'home'            => home_url(),
5118
				'gmt_offset'      => $gmt_offset,
5119
				'timezone_string' => (string) get_option( 'timezone_string' ),
5120
				'site_name'       => (string) get_option( 'blogname' ),
5121
				'secret_1'        => $secrets['secret_1'],
5122
				'secret_2'        => $secrets['secret_2'],
5123
				'site_lang'       => get_locale(),
5124
				'timeout'         => $timeout,
5125
				'stats_id'        => $stats_id,
5126
				'state'           => get_current_user_id(),
5127
				'_ui'             => $tracks_identity['_ui'],
5128
				'_ut'             => $tracks_identity['_ut'],
5129
				'jetpack_version' => JETPACK__VERSION
5130
			),
5131
			'headers' => array(
5132
				'Accept' => 'application/json',
5133
			),
5134
			'timeout' => $timeout,
5135
		);
5136
5137
		self::apply_activation_source_to_args( $args['body'] );
5138
5139
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5140
5141
		// Make sure the response is valid and does not contain any Jetpack errors
5142
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5143
		if ( is_wp_error( $registration_details ) ) {
5144
			return $registration_details;
5145
		} elseif ( ! $registration_details ) {
5146
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5147
		}
5148
5149 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5150
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5151
		}
5152
5153
		if ( isset( $registration_details->jetpack_public ) ) {
5154
			$jetpack_public = (int) $registration_details->jetpack_public;
5155
		} else {
5156
			$jetpack_public = false;
5157
		}
5158
5159
		Jetpack_Options::update_options(
5160
			array(
5161
				'id'         => (int)    $registration_details->jetpack_id,
5162
				'blog_token' => (string) $registration_details->jetpack_secret,
5163
				'public'     => $jetpack_public,
5164
			)
5165
		);
5166
5167
		/**
5168
		 * Fires when a site is registered on WordPress.com.
5169
		 *
5170
		 * @since 3.7.0
5171
		 *
5172
		 * @param int $json->jetpack_id Jetpack Blog ID.
5173
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5174
		 * @param int|bool $jetpack_public Is the site public.
5175
		 */
5176
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5177
5178
		// Initialize Jump Start for the first and only time.
5179
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5180
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5181
5182
			$jetpack = Jetpack::init();
5183
5184
			$jetpack->stat( 'jumpstart', 'unique-views' );
5185
			$jetpack->do_stats( 'server_side' );
5186
		};
5187
5188
		return true;
5189
	}
5190
5191
	/**
5192
	 * If the db version is showing something other that what we've got now, bump it to current.
5193
	 *
5194
	 * @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...
5195
	 */
5196
	public static function maybe_set_version_option() {
5197
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5198
		if ( JETPACK__VERSION != $version ) {
5199
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5200
5201
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5202
				/** This action is documented in class.jetpack.php */
5203
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5204
			}
5205
5206
			return true;
5207
		}
5208
		return false;
5209
	}
5210
5211
/* Client Server API */
5212
5213
	/**
5214
	 * Loads the Jetpack XML-RPC client
5215
	 */
5216
	public static function load_xml_rpc_client() {
5217
		require_once ABSPATH . WPINC . '/class-IXR.php';
5218
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5219
	}
5220
5221
	/**
5222
	 * Resets the saved authentication state in between testing requests.
5223
	 */
5224
	public function reset_saved_auth_state() {
5225
		$this->xmlrpc_verification = null;
5226
		$this->rest_authentication_status = null;
5227
	}
5228
5229
	function verify_xml_rpc_signature() {
5230
		if ( $this->xmlrpc_verification ) {
5231
			return $this->xmlrpc_verification;
5232
		}
5233
5234
		// It's not for us
5235
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5236
			return false;
5237
		}
5238
5239
		@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...
5240
		if (
5241
			empty( $token_key )
5242
		||
5243
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5244
		) {
5245
			return false;
5246
		}
5247
5248
		if ( '0' === $user_id ) {
5249
			$token_type = 'blog';
5250
			$user_id = 0;
5251
		} else {
5252
			$token_type = 'user';
5253
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5254
				return false;
5255
			}
5256
			$user_id = (int) $user_id;
5257
5258
			$user = new WP_User( $user_id );
5259
			if ( ! $user || ! $user->exists() ) {
5260
				return false;
5261
			}
5262
		}
5263
5264
		$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...
5265
		if ( ! $token ) {
5266
			return false;
5267
		}
5268
5269
		$token_check = "$token_key.";
5270
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5271
			return false;
5272
		}
5273
5274
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5275
5276
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5277
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5278
			$post_data   = $_POST;
5279
			$file_hashes = array();
5280
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5281
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5282
					continue;
5283
				}
5284
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5285
				$file_hashes[$post_data_key] = $post_data_value;
5286
			}
5287
5288
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5289
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5290
				$post_data[$post_data_key] = $post_data_value;
5291
			}
5292
5293
			ksort( $post_data );
5294
5295
			$body = http_build_query( stripslashes_deep( $post_data ) );
5296
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5297
			$body = file_get_contents( 'php://input' );
5298
		} else {
5299
			$body = null;
5300
		}
5301
5302
		$signature = $jetpack_signature->sign_current_request(
5303
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5304
		);
5305
5306
		if ( ! $signature ) {
5307
			return false;
5308
		} else if ( is_wp_error( $signature ) ) {
5309
			return $signature;
5310
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5311
			return false;
5312
		}
5313
5314
		$timestamp = (int) $_GET['timestamp'];
5315
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5316
5317
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5318
			return false;
5319
		}
5320
5321
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5322
		if ( isset( $this->HTTP_RAW_POST_DATA ) ) {
5323
			$jpo = json_decode( $this->HTTP_RAW_POST_DATA );
5324
			if (
5325
				isset( $jpo->onboarding ) &&
5326
				isset( $jpo->onboarding->jpUser ) && isset( $jpo->onboarding->token ) &&
5327
				is_email( $jpo->onboarding->jpUser ) && ctype_alnum( $jpo->onboarding->token ) &&
5328
				isset( $_GET['rest_route'] ) &&
5329
				self::validate_onboarding_token_action( $jpo->onboarding->token, $_GET['rest_route'] )
5330
			) {
5331
				$jpUser = get_user_by( 'email', $jpo->onboarding->jpUser );
5332
				if ( is_a( $jpUser, 'WP_User' ) ) {
5333
					wp_set_current_user( $jpUser->ID );
5334
					$user_can = is_multisite()
5335
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5336
						: current_user_can( 'manage_options' );
5337
					if ( $user_can ) {
5338
						$token_type = 'user';
5339
						$token->external_user_id = $jpUser->ID;
5340
					}
5341
				}
5342
			}
5343
		}
5344
5345
		$this->xmlrpc_verification = array(
5346
			'type'    => $token_type,
5347
			'user_id' => $token->external_user_id,
5348
		);
5349
5350
		return $this->xmlrpc_verification;
5351
	}
5352
5353
	/**
5354
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5355
	 */
5356
	function authenticate_jetpack( $user, $username, $password ) {
5357
		if ( is_a( $user, 'WP_User' ) ) {
5358
			return $user;
5359
		}
5360
5361
		$token_details = $this->verify_xml_rpc_signature();
5362
5363
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5364
			return $user;
5365
		}
5366
5367
		if ( 'user' !== $token_details['type'] ) {
5368
			return $user;
5369
		}
5370
5371
		if ( ! $token_details['user_id'] ) {
5372
			return $user;
5373
		}
5374
5375
		nocache_headers();
5376
5377
		return new WP_User( $token_details['user_id'] );
5378
	}
5379
5380
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5381
	// Uses the existing XMLRPC request signing implementation.
5382
	function wp_rest_authenticate( $user ) {
5383
		if ( ! empty( $user ) ) {
5384
			// Another authentication method is in effect.
5385
			return $user;
5386
		}
5387
5388
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5389
			// Nothing to do for this authentication method.
5390
			return null;
5391
		}
5392
5393
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5394
			// Nothing to do for this authentication method.
5395
			return null;
5396
		}
5397
5398
		// Ensure that we always have the request body available.  At this
5399
		// point, the WP REST API code to determine the request body has not
5400
		// run yet.  That code may try to read from 'php://input' later, but
5401
		// this can only be done once per request in PHP versions prior to 5.6.
5402
		// So we will go ahead and perform this read now if needed, and save
5403
		// the request body where both the Jetpack signature verification code
5404
		// and the WP REST API code can see it.
5405
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5406
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5407
		}
5408
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5409
5410
		// Only support specific request parameters that have been tested and
5411
		// are known to work with signature verification.  A different method
5412
		// can be passed to the WP REST API via the '?_method=' parameter if
5413
		// needed.
5414
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5415
			$this->rest_authentication_status = new WP_Error(
5416
				'rest_invalid_request',
5417
				__( 'This request method is not supported.', 'jetpack' ),
5418
				array( 'status' => 400 )
5419
			);
5420
			return null;
5421
		}
5422
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5423
			$this->rest_authentication_status = new WP_Error(
5424
				'rest_invalid_request',
5425
				__( 'This request method does not support body parameters.', 'jetpack' ),
5426
				array( 'status' => 400 )
5427
			);
5428
			return null;
5429
		}
5430
5431
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5432
			$content_type = $_SERVER['CONTENT_TYPE'];
5433
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5434
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5435
		}
5436
5437
		if (
5438
			isset( $content_type ) &&
5439
			$content_type !== 'application/x-www-form-urlencoded' &&
5440
			$content_type !== 'application/json'
5441
		) {
5442
			$this->rest_authentication_status = new WP_Error(
5443
				'rest_invalid_request',
5444
				__( 'This Content-Type is not supported.', 'jetpack' ),
5445
				array( 'status' => 400 )
5446
			);
5447
			return null;
5448
		}
5449
5450
		$verified = $this->verify_xml_rpc_signature();
5451
5452
		if ( is_wp_error( $verified ) ) {
5453
			$this->rest_authentication_status = $verified;
5454
			return null;
5455
		}
5456
5457
		if (
5458
			$verified &&
5459
			isset( $verified['type'] ) &&
5460
			'user' === $verified['type'] &&
5461
			! empty( $verified['user_id'] )
5462
		) {
5463
			// Authentication successful.
5464
			$this->rest_authentication_status = true;
5465
			return $verified['user_id'];
5466
		}
5467
5468
		// Something else went wrong.  Probably a signature error.
5469
		$this->rest_authentication_status = new WP_Error(
5470
			'rest_invalid_signature',
5471
			__( 'The request is not signed correctly.', 'jetpack' ),
5472
			array( 'status' => 400 )
5473
		);
5474
		return null;
5475
	}
5476
5477
	/**
5478
	 * Report authentication status to the WP REST API.
5479
	 *
5480
	 * @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...
5481
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5482
	 */
5483
	public function wp_rest_authentication_errors( $value ) {
5484
		if ( $value !== null ) {
5485
			return $value;
5486
		}
5487
		return $this->rest_authentication_status;
5488
	}
5489
5490
	function add_nonce( $timestamp, $nonce ) {
5491
		global $wpdb;
5492
		static $nonces_used_this_request = array();
5493
5494
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5495
			return $nonces_used_this_request["$timestamp:$nonce"];
5496
		}
5497
5498
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5499
		$timestamp = (int) $timestamp;
5500
		$nonce     = esc_sql( $nonce );
5501
5502
		// Raw query so we can avoid races: add_option will also update
5503
		$show_errors = $wpdb->show_errors( false );
5504
5505
		$old_nonce = $wpdb->get_row(
5506
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5507
		);
5508
5509
		if ( is_null( $old_nonce ) ) {
5510
			$return = $wpdb->query(
5511
				$wpdb->prepare(
5512
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5513
					"jetpack_nonce_{$timestamp}_{$nonce}",
5514
					time(),
5515
					'no'
5516
				)
5517
			);
5518
		} else {
5519
			$return = false;
5520
		}
5521
5522
		$wpdb->show_errors( $show_errors );
5523
5524
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5525
5526
		return $return;
5527
	}
5528
5529
	/**
5530
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5531
	 * Capture it here so we can verify the signature later.
5532
	 */
5533
	function xmlrpc_methods( $methods ) {
5534
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5535
		return $methods;
5536
	}
5537
5538
	function public_xmlrpc_methods( $methods ) {
5539
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5540
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5541
		}
5542
		return $methods;
5543
	}
5544
5545
	function jetpack_getOptions( $args ) {
5546
		global $wp_xmlrpc_server;
5547
5548
		$wp_xmlrpc_server->escape( $args );
5549
5550
		$username	= $args[1];
5551
		$password	= $args[2];
5552
5553
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5554
			return $wp_xmlrpc_server->error;
5555
		}
5556
5557
		$options = array();
5558
		$user_data = $this->get_connected_user_data();
5559
		if ( is_array( $user_data ) ) {
5560
			$options['jetpack_user_id'] = array(
5561
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5562
				'readonly'      => true,
5563
				'value'         => $user_data['ID'],
5564
			);
5565
			$options['jetpack_user_login'] = array(
5566
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5567
				'readonly'      => true,
5568
				'value'         => $user_data['login'],
5569
			);
5570
			$options['jetpack_user_email'] = array(
5571
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5572
				'readonly'      => true,
5573
				'value'         => $user_data['email'],
5574
			);
5575
			$options['jetpack_user_site_count'] = array(
5576
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5577
				'readonly'      => true,
5578
				'value'         => $user_data['site_count'],
5579
			);
5580
		}
5581
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5582
		$args = stripslashes_deep( $args );
5583
		return $wp_xmlrpc_server->wp_getOptions( $args );
5584
	}
5585
5586
	function xmlrpc_options( $options ) {
5587
		$jetpack_client_id = false;
5588
		if ( self::is_active() ) {
5589
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5590
		}
5591
		$options['jetpack_version'] = array(
5592
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5593
				'readonly'      => true,
5594
				'value'         => JETPACK__VERSION,
5595
		);
5596
5597
		$options['jetpack_client_id'] = array(
5598
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5599
				'readonly'      => true,
5600
				'value'         => $jetpack_client_id,
5601
		);
5602
		return $options;
5603
	}
5604
5605
	public static function clean_nonces( $all = false ) {
5606
		global $wpdb;
5607
5608
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5609
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5610
5611
		if ( true !== $all ) {
5612
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5613
			$sql_args[] = time() - 3600;
5614
		}
5615
5616
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5617
5618
		$sql = $wpdb->prepare( $sql, $sql_args );
5619
5620
		for ( $i = 0; $i < 1000; $i++ ) {
5621
			if ( ! $wpdb->query( $sql ) ) {
5622
				break;
5623
			}
5624
		}
5625
	}
5626
5627
	/**
5628
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5629
	 * SET: state( $key, $value );
5630
	 * GET: $value = state( $key );
5631
	 *
5632
	 * @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...
5633
	 * @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...
5634
	 * @param bool $restate private
5635
	 */
5636
	public static function state( $key = null, $value = null, $restate = false ) {
5637
		static $state = array();
5638
		static $path, $domain;
5639
		if ( ! isset( $path ) ) {
5640
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5641
			$admin_url = Jetpack::admin_url();
5642
			$bits      = parse_url( $admin_url );
5643
5644
			if ( is_array( $bits ) ) {
5645
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5646
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5647
			} else {
5648
				$path = $domain = null;
5649
			}
5650
		}
5651
5652
		// Extract state from cookies and delete cookies
5653
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5654
			$yum = $_COOKIE[ 'jetpackState' ];
5655
			unset( $_COOKIE[ 'jetpackState' ] );
5656
			foreach ( $yum as $k => $v ) {
5657
				if ( strlen( $v ) )
5658
					$state[ $k ] = $v;
5659
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5660
			}
5661
		}
5662
5663
		if ( $restate ) {
5664
			foreach ( $state as $k => $v ) {
5665
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5666
			}
5667
			return;
5668
		}
5669
5670
		// Get a state variable
5671
		if ( isset( $key ) && ! isset( $value ) ) {
5672
			if ( array_key_exists( $key, $state ) )
5673
				return $state[ $key ];
5674
			return null;
5675
		}
5676
5677
		// Set a state variable
5678
		if ( isset ( $key ) && isset( $value ) ) {
5679
			if( is_array( $value ) && isset( $value[0] ) ) {
5680
				$value = $value[0];
5681
			}
5682
			$state[ $key ] = $value;
5683
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5684
		}
5685
	}
5686
5687
	public static function restate() {
5688
		Jetpack::state( null, null, true );
5689
	}
5690
5691
	public static function check_privacy( $file ) {
5692
		static $is_site_publicly_accessible = null;
5693
5694
		if ( is_null( $is_site_publicly_accessible ) ) {
5695
			$is_site_publicly_accessible = false;
5696
5697
			Jetpack::load_xml_rpc_client();
5698
			$rpc = new Jetpack_IXR_Client();
5699
5700
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5701
			if ( $success ) {
5702
				$response = $rpc->getResponse();
5703
				if ( $response ) {
5704
					$is_site_publicly_accessible = true;
5705
				}
5706
			}
5707
5708
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5709
		}
5710
5711
		if ( $is_site_publicly_accessible ) {
5712
			return;
5713
		}
5714
5715
		$module_slug = self::get_module_slug( $file );
5716
5717
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5718
		if ( ! $privacy_checks ) {
5719
			$privacy_checks = $module_slug;
5720
		} else {
5721
			$privacy_checks .= ",$module_slug";
5722
		}
5723
5724
		Jetpack::state( 'privacy_checks', $privacy_checks );
5725
	}
5726
5727
	/**
5728
	 * Helper method for multicall XMLRPC.
5729
	 */
5730
	public static function xmlrpc_async_call() {
5731
		global $blog_id;
5732
		static $clients = array();
5733
5734
		$client_blog_id = is_multisite() ? $blog_id : 0;
5735
5736
		if ( ! isset( $clients[$client_blog_id] ) ) {
5737
			Jetpack::load_xml_rpc_client();
5738
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5739
			if ( function_exists( 'ignore_user_abort' ) ) {
5740
				ignore_user_abort( true );
5741
			}
5742
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5743
		}
5744
5745
		$args = func_get_args();
5746
5747
		if ( ! empty( $args[0] ) ) {
5748
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5749
		} elseif ( is_multisite() ) {
5750
			foreach ( $clients as $client_blog_id => $client ) {
5751
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5752
					continue;
5753
				}
5754
5755
				$switch_success = switch_to_blog( $client_blog_id, true );
5756
				if ( ! $switch_success ) {
5757
					continue;
5758
				}
5759
5760
				flush();
5761
				$client->query();
5762
5763
				restore_current_blog();
5764
			}
5765
		} else {
5766
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5767
				flush();
5768
				$clients[0]->query();
5769
			}
5770
		}
5771
	}
5772
5773
	public static function staticize_subdomain( $url ) {
5774
5775
		// Extract hostname from URL
5776
		$host = parse_url( $url, PHP_URL_HOST );
5777
5778
		// Explode hostname on '.'
5779
		$exploded_host = explode( '.', $host );
5780
5781
		// Retrieve the name and TLD
5782
		if ( count( $exploded_host ) > 1 ) {
5783
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5784
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5785
			// Rebuild domain excluding subdomains
5786
			$domain = $name . '.' . $tld;
5787
		} else {
5788
			$domain = $host;
5789
		}
5790
		// Array of Automattic domains
5791
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5792
5793
		// Return $url if not an Automattic domain
5794
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5795
			return $url;
5796
		}
5797
5798
		if ( is_ssl() ) {
5799
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5800
		}
5801
5802
		srand( crc32( basename( $url ) ) );
5803
		$static_counter = rand( 0, 2 );
5804
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5805
5806
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5807
	}
5808
5809
/* JSON API Authorization */
5810
5811
	/**
5812
	 * Handles the login action for Authorizing the JSON API
5813
	 */
5814
	function login_form_json_api_authorization() {
5815
		$this->verify_json_api_authorization_request();
5816
5817
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5818
5819
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5820
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5821
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5822
	}
5823
5824
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5825
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5826
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5827
			return $url;
5828
		}
5829
5830
		$parsed_url = parse_url( $url );
5831
		$url = strtok( $url, '?' );
5832
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5833
		if ( ! empty( $parsed_url['query'] ) )
5834
			$url .= "&{$parsed_url['query']}";
5835
5836
		return $url;
5837
	}
5838
5839
	// Make sure the POSTed request is handled by the same action
5840
	function preserve_action_in_login_form_for_json_api_authorization() {
5841
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5842
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5843
	}
5844
5845
	// If someone logs in to approve API access, store the Access Code in usermeta
5846
	function store_json_api_authorization_token( $user_login, $user ) {
5847
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5848
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5849
		$token = wp_generate_password( 32, false );
5850
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5851
	}
5852
5853
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5854
	function allow_wpcom_public_api_domain( $domains ) {
5855
		$domains[] = 'public-api.wordpress.com';
5856
		return $domains;
5857
	}
5858
5859
	// Add the Access Code details to the public-api.wordpress.com redirect
5860
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5861
		return add_query_arg(
5862
			urlencode_deep(
5863
				array(
5864
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5865
					'jetpack-user-id' => (int) $user->ID,
5866
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5867
				)
5868
			),
5869
			$redirect_to
5870
		);
5871
	}
5872
5873
5874
	/**
5875
	 * Verifies the request by checking the signature
5876
	 *
5877
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5878
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5879
	 *
5880
	 * @param null|array $environment
5881
	 */
5882
	function verify_json_api_authorization_request( $environment = null ) {
5883
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5884
5885
		$environment = is_null( $environment )
5886
			? $_REQUEST
5887
			: $environment;
5888
5889
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
Unused Code introduced by
The assignment to $envToken is unused. Consider omitting it like so list($first,,$third).

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
Unused Code introduced by
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

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

Consider the following code example.

<?php

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

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

print $a . " - " . $c;

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

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
5890
		$token = Jetpack_Data::get_access_token( $envUserId );
5891
		if ( ! $token || empty( $token->secret ) ) {
5892
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5893
		}
5894
5895
		$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' );
5896
5897
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5898
5899
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5900
			$signature = $jetpack_signature->sign_request(
5901
				$environment['token'],
5902
				$environment['timestamp'],
5903
				$environment['nonce'],
5904
				'',
5905
				'GET',
5906
				$environment['jetpack_json_api_original_query'],
5907
				null,
5908
				true
5909
			);
5910
		} else {
5911
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5912
		}
5913
5914
		if ( ! $signature ) {
5915
			wp_die( $die_error );
5916
		} else if ( is_wp_error( $signature ) ) {
5917
			wp_die( $die_error );
5918
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5919
			if ( is_ssl() ) {
5920
				// 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
5921
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5922
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5923
					wp_die( $die_error );
5924
				}
5925
			} else {
5926
				wp_die( $die_error );
5927
			}
5928
		}
5929
5930
		$timestamp = (int) $environment['timestamp'];
5931
		$nonce     = stripslashes( (string) $environment['nonce'] );
5932
5933
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5934
			// De-nonce the nonce, at least for 5 minutes.
5935
			// 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)
5936
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5937
			if ( $old_nonce_time < time() - 300 ) {
5938
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5939
			}
5940
		}
5941
5942
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5943
		$data_filters = array(
5944
			'state'        => 'opaque',
5945
			'client_id'    => 'int',
5946
			'client_title' => 'string',
5947
			'client_image' => 'url',
5948
		);
5949
5950
		foreach ( $data_filters as $key => $sanitation ) {
5951
			if ( ! isset( $data->$key ) ) {
5952
				wp_die( $die_error );
5953
			}
5954
5955
			switch ( $sanitation ) {
5956
			case 'int' :
5957
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5958
				break;
5959
			case 'opaque' :
5960
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5961
				break;
5962
			case 'string' :
5963
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5964
				break;
5965
			case 'url' :
5966
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5967
				break;
5968
			}
5969
		}
5970
5971
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5972
			wp_die( $die_error );
5973
		}
5974
	}
5975
5976
	function login_message_json_api_authorization( $message ) {
5977
		return '<p class="message">' . sprintf(
5978
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
5979
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5980
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5981
	}
5982
5983
	/**
5984
	 * Get $content_width, but with a <s>twist</s> filter.
5985
	 */
5986
	public static function get_content_width() {
5987
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
5988
		/**
5989
		 * Filter the Content Width value.
5990
		 *
5991
		 * @since 2.2.3
5992
		 *
5993
		 * @param string $content_width Content Width value.
5994
		 */
5995
		return apply_filters( 'jetpack_content_width', $content_width );
5996
	}
5997
5998
	/**
5999
	 * Pings the WordPress.com Mirror Site for the specified options.
6000
	 *
6001
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6002
	 *
6003
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6004
	 */
6005
	public function get_cloud_site_options( $option_names ) {
6006
		$option_names = array_filter( (array) $option_names, 'is_string' );
6007
6008
		Jetpack::load_xml_rpc_client();
6009
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6010
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6011
		if ( $xml->isError() ) {
6012
			return array(
6013
				'error_code' => $xml->getErrorCode(),
6014
				'error_msg'  => $xml->getErrorMessage(),
6015
			);
6016
		}
6017
		$cloud_site_options = $xml->getResponse();
6018
6019
		return $cloud_site_options;
6020
	}
6021
6022
	/**
6023
	 * Checks if the site is currently in an identity crisis.
6024
	 *
6025
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6026
	 */
6027
	public static function check_identity_crisis() {
6028
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6029
			return false;
6030
		}
6031
6032
		return Jetpack_Options::get_option( 'sync_error_idc' );
6033
	}
6034
6035
	/**
6036
	 * Checks whether the home and siteurl specifically are whitelisted
6037
	 * Written so that we don't have re-check $key and $value params every time
6038
	 * we want to check if this site is whitelisted, for example in footer.php
6039
	 *
6040
	 * @since  3.8.0
6041
	 * @return bool True = already whitelisted False = not whitelisted
6042
	 */
6043
	public static function is_staging_site() {
6044
		$is_staging = false;
6045
6046
		$known_staging = array(
6047
			'urls' => array(
6048
				'#\.staging\.wpengine\.com$#i', // WP Engine
6049
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6050
				),
6051
			'constants' => array(
6052
				'IS_WPE_SNAPSHOT',      // WP Engine
6053
				'KINSTA_DEV_ENV',       // Kinsta.com
6054
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6055
				'JETPACK_STAGING_MODE', // Generic
6056
				)
6057
			);
6058
		/**
6059
		 * Filters the flags of known staging sites.
6060
		 *
6061
		 * @since 3.9.0
6062
		 *
6063
		 * @param array $known_staging {
6064
		 *     An array of arrays that each are used to check if the current site is staging.
6065
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6066
		 *     @type array $constants PHP constants of known staging/developement environments.
6067
		 *  }
6068
		 */
6069
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6070
6071
		if ( isset( $known_staging['urls'] ) ) {
6072
			foreach ( $known_staging['urls'] as $url ){
6073
				if ( preg_match( $url, site_url() ) ) {
6074
					$is_staging = true;
6075
					break;
6076
				}
6077
			}
6078
		}
6079
6080
		if ( isset( $known_staging['constants'] ) ) {
6081
			foreach ( $known_staging['constants'] as $constant ) {
6082
				if ( defined( $constant ) && constant( $constant ) ) {
6083
					$is_staging = true;
6084
				}
6085
			}
6086
		}
6087
6088
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6089
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6090
			$is_staging = true;
6091
		}
6092
6093
		/**
6094
		 * Filters is_staging_site check.
6095
		 *
6096
		 * @since 3.9.0
6097
		 *
6098
		 * @param bool $is_staging If the current site is a staging site.
6099
		 */
6100
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6101
	}
6102
6103
	/**
6104
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6105
	 *
6106
	 * @since 4.4.0
6107
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6108
	 *
6109
	 * @return bool
6110
	 */
6111
	public static function validate_sync_error_idc_option() {
6112
		$is_valid = false;
6113
6114
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6115
		if ( false === $idc_allowed ) {
6116
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6117
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6118
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6119
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6120
				$transient_duration = HOUR_IN_SECONDS;
6121
			} else {
6122
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6123
				$idc_allowed = '1';
6124
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6125
			}
6126
6127
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6128
		}
6129
6130
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6131
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6132
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6133
			$local_options = self::get_sync_error_idc_option();
6134
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6135
				$is_valid = true;
6136
			}
6137
		}
6138
6139
		/**
6140
		 * Filters whether the sync_error_idc option is valid.
6141
		 *
6142
		 * @since 4.4.0
6143
		 *
6144
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6145
		 */
6146
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6147
6148
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6149
			// Since the option exists, and did not validate, delete it
6150
			Jetpack_Options::delete_option( 'sync_error_idc' );
6151
		}
6152
6153
		return $is_valid;
6154
	}
6155
6156
	/**
6157
	 * Normalizes a url by doing three things:
6158
	 *  - Strips protocol
6159
	 *  - Strips www
6160
	 *  - Adds a trailing slash
6161
	 *
6162
	 * @since 4.4.0
6163
	 * @param string $url
6164
	 * @return WP_Error|string
6165
	 */
6166
	public static function normalize_url_protocol_agnostic( $url ) {
6167
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6168
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6169
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6170
		}
6171
6172
		// Strip www and protocols
6173
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6174
		return $url;
6175
	}
6176
6177
	/**
6178
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6179
	 *
6180
	 * @since 4.4.0
6181
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6182
	 *
6183
	 * @param array $response
6184
	 * @return array Array of the local urls, wpcom urls, and error code
6185
	 */
6186
	public static function get_sync_error_idc_option( $response = array() ) {
6187
		// Since the local options will hit the database directly, store the values
6188
		// in a transient to allow for autoloading and caching on subsequent views.
6189
		$local_options = get_transient( 'jetpack_idc_local' );
6190
		if ( false === $local_options ) {
6191
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6192
			$local_options = array(
6193
				'home'    => Jetpack_Sync_Functions::home_url(),
6194
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6195
			);
6196
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6197
		}
6198
6199
		$options = array_merge( $local_options, $response );
6200
6201
		$returned_values = array();
6202
		foreach( $options as $key => $option ) {
6203
			if ( 'error_code' === $key ) {
6204
				$returned_values[ $key ] = $option;
6205
				continue;
6206
			}
6207
6208
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6209
				continue;
6210
			}
6211
6212
			$returned_values[ $key ] = $normalized_url;
6213
		}
6214
6215
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6216
6217
		return $returned_values;
6218
	}
6219
6220
	/**
6221
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6222
	 * If set to true, the site will be put into staging mode.
6223
	 *
6224
	 * @since 4.3.2
6225
	 * @return bool
6226
	 */
6227
	public static function sync_idc_optin() {
6228
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6229
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6230
		} else {
6231
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6232
		}
6233
6234
		/**
6235
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6236
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6237
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6238
		 *
6239
		 * @since 4.3.2
6240
		 *
6241
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6242
		 */
6243
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6244
	}
6245
6246
	/**
6247
	 * Maybe Use a .min.css stylesheet, maybe not.
6248
	 *
6249
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6250
	 */
6251
	public static function maybe_min_asset( $url, $path, $plugin ) {
6252
		// Short out on things trying to find actual paths.
6253
		if ( ! $path || empty( $plugin ) ) {
6254
			return $url;
6255
		}
6256
6257
		$path = ltrim( $path, '/' );
6258
6259
		// Strip out the abspath.
6260
		$base = dirname( plugin_basename( $plugin ) );
6261
6262
		// Short out on non-Jetpack assets.
6263
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6264
			return $url;
6265
		}
6266
6267
		// File name parsing.
6268
		$file              = "{$base}/{$path}";
6269
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6270
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6271
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6272
		$extension         = array_shift( $file_name_parts_r );
6273
6274
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6275
			// Already pointing at the minified version.
6276
			if ( 'min' === $file_name_parts_r[0] ) {
6277
				return $url;
6278
			}
6279
6280
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6281
			if ( file_exists( $min_full_path ) ) {
6282
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6283
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6284
				if ( 'css' === $extension ) {
6285
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6286
					self::$min_assets[ $key ] = $path;
6287
				}
6288
			}
6289
		}
6290
6291
		return $url;
6292
	}
6293
6294
	/**
6295
	 * If the asset is minified, let's flag .min as the suffix.
6296
	 *
6297
	 * Attached to `style_loader_src` filter.
6298
	 *
6299
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
Bug introduced by
There is no parameter named $tag. Was it maybe removed?

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

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

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

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

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

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

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

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

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

Loading history...
6302
	 */
6303
	public static function set_suffix_on_min( $src, $handle ) {
6304
		if ( false === strpos( $src, '.min.css' ) ) {
6305
			return $src;
6306
		}
6307
6308
		if ( ! empty( self::$min_assets ) ) {
6309
			foreach ( self::$min_assets as $file => $path ) {
6310
				if ( false !== strpos( $src, $file ) ) {
6311
					wp_style_add_data( $handle, 'suffix', '.min' );
6312
					return $src;
6313
				}
6314
			}
6315
		}
6316
6317
		return $src;
6318
	}
6319
6320
	/**
6321
	 * Maybe inlines a stylesheet.
6322
	 *
6323
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6324
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6325
	 *
6326
	 * Attached to `style_loader_tag` filter.
6327
	 *
6328
	 * @param string $tag The tag that would link to the external asset.
6329
	 * @param string $handle The registered handle of the script in question.
6330
	 *
6331
	 * @return string
6332
	 */
6333
	public static function maybe_inline_style( $tag, $handle ) {
6334
		global $wp_styles;
6335
		$item = $wp_styles->registered[ $handle ];
6336
6337
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6338
			return $tag;
6339
		}
6340
6341
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6342
			$href = $matches[1];
6343
			// Strip off query string
6344
			if ( $pos = strpos( $href, '?' ) ) {
6345
				$href = substr( $href, 0, $pos );
6346
			}
6347
			// Strip off fragment
6348
			if ( $pos = strpos( $href, '#' ) ) {
6349
				$href = substr( $href, 0, $pos );
6350
			}
6351
		} else {
6352
			return $tag;
6353
		}
6354
6355
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6356
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6357
			return $tag;
6358
		}
6359
6360
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6361
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6362
			// And this isn't the pass that actually deals with the RTL version...
6363
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6364
				// Short out, as the RTL version will deal with it in a moment.
6365
				return $tag;
6366
			}
6367
		}
6368
6369
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6370
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6371
		if ( $css ) {
6372
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6373
			if ( empty( $item->extra['after'] ) ) {
6374
				wp_add_inline_style( $handle, $css );
6375
			} else {
6376
				array_unshift( $item->extra['after'], $css );
6377
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6378
			}
6379
		}
6380
6381
		return $tag;
6382
	}
6383
6384
	/**
6385
	 * Loads a view file from the views
6386
	 *
6387
	 * Data passed in with the $data parameter will be available in the
6388
	 * template file as $data['value']
6389
	 *
6390
	 * @param string $template - Template file to load
6391
	 * @param array $data - Any data to pass along to the template
6392
	 * @return boolean - If template file was found
6393
	 **/
6394
	public function load_view( $template, $data = array() ) {
6395
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6396
6397
		if( file_exists( $views_dir . $template ) ) {
6398
			require_once( $views_dir . $template );
6399
			return true;
6400
		}
6401
6402
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6403
		return false;
6404
	}
6405
6406
	/**
6407
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6408
	 */
6409
	public function deprecated_hooks() {
6410
		global $wp_filter;
6411
6412
		/*
6413
		 * Format:
6414
		 * deprecated_filter_name => replacement_name
6415
		 *
6416
		 * If there is no replacement, use null for replacement_name
6417
		 */
6418
		$deprecated_list = array(
6419
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6420
			'wpl_sharing_2014_1'                                     => null,
6421
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6422
			'jetpack_identity_crisis_options_to_check'               => null,
6423
			'update_option_jetpack_single_user_site'                 => null,
6424
			'audio_player_default_colors'                            => null,
6425
			'add_option_jetpack_featured_images_enabled'             => null,
6426
			'add_option_jetpack_update_details'                      => null,
6427
			'add_option_jetpack_updates'                             => null,
6428
			'add_option_jetpack_network_name'                        => null,
6429
			'add_option_jetpack_network_allow_new_registrations'     => null,
6430
			'add_option_jetpack_network_add_new_users'               => null,
6431
			'add_option_jetpack_network_site_upload_space'           => null,
6432
			'add_option_jetpack_network_upload_file_types'           => null,
6433
			'add_option_jetpack_network_enable_administration_menus' => null,
6434
			'add_option_jetpack_is_multi_site'                       => null,
6435
			'add_option_jetpack_is_main_network'                     => null,
6436
			'add_option_jetpack_main_network_site'                   => null,
6437
			'jetpack_sync_all_registered_options'                    => null,
6438
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6439
			'jetpack_is_post_mailable'                               => null,
6440
			'jetpack_seo_site_host'                                  => null,
6441
		);
6442
6443
		// This is a silly loop depth. Better way?
6444
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6445
			if ( has_action( $hook ) ) {
6446
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6447
					foreach( $values AS $hooked ) {
6448
						if ( is_callable( $hooked['function'] ) ) {
6449
							$function_name = 'an anonymous function';
6450
						} else {
6451
							$function_name = $hooked['function'];
6452
						}
6453
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6454
					}
6455
				}
6456
			}
6457
		}
6458
	}
6459
6460
	/**
6461
	 * Converts any url in a stylesheet, to the correct absolute url.
6462
	 *
6463
	 * Considerations:
6464
	 *  - Normal, relative URLs     `feh.png`
6465
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6466
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6467
	 *  - Absolute URLs             `http://domain.com/feh.png`
6468
	 *  - Domain root relative URLs `/feh.png`
6469
	 *
6470
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6471
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6472
	 *
6473
	 * @return mixed|string
6474
	 */
6475
	public static function absolutize_css_urls( $css, $css_file_url ) {
6476
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6477
		$css_dir = dirname( $css_file_url );
6478
		$p       = parse_url( $css_dir );
6479
		$domain  = sprintf(
6480
					'%1$s//%2$s%3$s%4$s',
6481
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6482
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6483
					$p['host'],
6484
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6485
				);
6486
6487
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6488
			$find = $replace = array();
6489
			foreach ( $matches as $match ) {
6490
				$url = trim( $match['path'], "'\" \t" );
6491
6492
				// If this is a data url, we don't want to mess with it.
6493
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6494
					continue;
6495
				}
6496
6497
				// If this is an absolute or protocol-agnostic url,
6498
				// we don't want to mess with it.
6499
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6500
					continue;
6501
				}
6502
6503
				switch ( substr( $url, 0, 1 ) ) {
6504
					case '/':
6505
						$absolute = $domain . $url;
6506
						break;
6507
					default:
6508
						$absolute = $css_dir . '/' . $url;
6509
				}
6510
6511
				$find[]    = $match[0];
6512
				$replace[] = sprintf( 'url("%s")', $absolute );
6513
			}
6514
			$css = str_replace( $find, $replace, $css );
6515
		}
6516
6517
		return $css;
6518
	}
6519
6520
	/**
6521
	 * This methods removes all of the registered css files on the front end
6522
	 * from Jetpack in favor of using a single file. In effect "imploding"
6523
	 * all the files into one file.
6524
	 *
6525
	 * Pros:
6526
	 * - Uses only ONE css asset connection instead of 15
6527
	 * - Saves a minimum of 56k
6528
	 * - Reduces server load
6529
	 * - Reduces time to first painted byte
6530
	 *
6531
	 * Cons:
6532
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6533
	 *		should not cause any issues with themes.
6534
	 * - Plugins/themes dequeuing styles no longer do anything. See
6535
	 *		jetpack_implode_frontend_css filter for a workaround
6536
	 *
6537
	 * For some situations developers may wish to disable css imploding and
6538
	 * instead operate in legacy mode where each file loads seperately and
6539
	 * can be edited individually or dequeued. This can be accomplished with
6540
	 * the following line:
6541
	 *
6542
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6543
	 *
6544
	 * @since 3.2
6545
	 **/
6546
	public function implode_frontend_css( $travis_test = false ) {
6547
		$do_implode = true;
6548
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6549
			$do_implode = false;
6550
		}
6551
6552
		/**
6553
		 * Allow CSS to be concatenated into a single jetpack.css file.
6554
		 *
6555
		 * @since 3.2.0
6556
		 *
6557
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6558
		 */
6559
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6560
6561
		// Do not use the imploded file when default behaviour was altered through the filter
6562
		if ( ! $do_implode ) {
6563
			return;
6564
		}
6565
6566
		// We do not want to use the imploded file in dev mode, or if not connected
6567
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6568
			if ( ! $travis_test ) {
6569
				return;
6570
			}
6571
		}
6572
6573
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6574
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6575
			return;
6576
		}
6577
6578
		/*
6579
		 * Now we assume Jetpack is connected and able to serve the single
6580
		 * file.
6581
		 *
6582
		 * In the future there will be a check here to serve the file locally
6583
		 * or potentially from the Jetpack CDN
6584
		 *
6585
		 * For now:
6586
		 * - Enqueue a single imploded css file
6587
		 * - Zero out the style_loader_tag for the bundled ones
6588
		 * - Be happy, drink scotch
6589
		 */
6590
6591
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6592
6593
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6594
6595
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6596
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6597
	}
6598
6599
	function concat_remove_style_loader_tag( $tag, $handle ) {
6600
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6601
			$tag = '';
6602
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6603
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6604
			}
6605
		}
6606
6607
		return $tag;
6608
	}
6609
6610
	/*
6611
	 * Check the heartbeat data
6612
	 *
6613
	 * Organizes the heartbeat data by severity.  For example, if the site
6614
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6615
	 *
6616
	 * Data will be added to "caution" array, if it either:
6617
	 *  - Out of date Jetpack version
6618
	 *  - Out of date WP version
6619
	 *  - Out of date PHP version
6620
	 *
6621
	 * $return array $filtered_data
6622
	 */
6623
	public static function jetpack_check_heartbeat_data() {
6624
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6625
6626
		$good    = array();
6627
		$caution = array();
6628
		$bad     = array();
6629
6630
		foreach ( $raw_data as $stat => $value ) {
6631
6632
			// Check jetpack version
6633
			if ( 'version' == $stat ) {
6634
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6635
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6636
					continue;
6637
				}
6638
			}
6639
6640
			// Check WP version
6641
			if ( 'wp-version' == $stat ) {
6642
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6643
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6644
					continue;
6645
				}
6646
			}
6647
6648
			// Check PHP version
6649
			if ( 'php-version' == $stat ) {
6650
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6651
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6652
					continue;
6653
				}
6654
			}
6655
6656
			// Check ID crisis
6657
			if ( 'identitycrisis' == $stat ) {
6658
				if ( 'yes' == $value ) {
6659
					$bad[ $stat ] = $value;
6660
					continue;
6661
				}
6662
			}
6663
6664
			// The rest are good :)
6665
			$good[ $stat ] = $value;
6666
		}
6667
6668
		$filtered_data = array(
6669
			'good'    => $good,
6670
			'caution' => $caution,
6671
			'bad'     => $bad
6672
		);
6673
6674
		return $filtered_data;
6675
	}
6676
6677
6678
	/*
6679
	 * This method is used to organize all options that can be reset
6680
	 * without disconnecting Jetpack.
6681
	 *
6682
	 * It is used in class.jetpack-cli.php to reset options
6683
	 *
6684
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6685
	 *
6686
	 * @return array of options to delete.
6687
	 */
6688
	public static function get_jetpack_options_for_reset() {
6689
		return Jetpack_Options::get_options_for_reset();
6690
	}
6691
6692
	/**
6693
	 * Check if an option of a Jetpack module has been updated.
6694
	 *
6695
	 * If any module option has been updated before Jump Start has been dismissed,
6696
	 * update the 'jumpstart' option so we can hide Jump Start.
6697
	 *
6698
	 * @param string $option_name
6699
	 *
6700
	 * @return bool
6701
	 */
6702
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6703
		// Bail if Jump Start has already been dismissed
6704
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6705
			return false;
6706
		}
6707
6708
		$jetpack = Jetpack::init();
6709
6710
		// Manual build of module options
6711
		$option_names = self::get_jetpack_options_for_reset();
6712
6713
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6714
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6715
6716
			//Jump start is being dismissed send data to MC Stats
6717
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6718
6719
			$jetpack->do_stats( 'server_side' );
6720
		}
6721
6722
	}
6723
6724
	/*
6725
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6726
	 * so we can bring them directly to their site in calypso.
6727
	 *
6728
	 * @param string | url
6729
	 * @return string | url without the guff
6730
	 */
6731
	public static function build_raw_urls( $url ) {
6732
		$strip_http = '/.*?:\/\//i';
6733
		$url = preg_replace( $strip_http, '', $url  );
6734
		$url = str_replace( '/', '::', $url );
6735
		return $url;
6736
	}
6737
6738
	/**
6739
	 * Stores and prints out domains to prefetch for page speed optimization.
6740
	 *
6741
	 * @param mixed $new_urls
6742
	 */
6743
	public static function dns_prefetch( $new_urls = null ) {
6744
		static $prefetch_urls = array();
6745
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6746
			echo "\r\n";
6747
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6748
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6749
			}
6750
		} elseif ( ! empty( $new_urls ) ) {
6751
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6752
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6753
			}
6754
			foreach ( (array) $new_urls as $this_new_url ) {
6755
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6756
			}
6757
			$prefetch_urls = array_unique( $prefetch_urls );
6758
		}
6759
	}
6760
6761
	public function wp_dashboard_setup() {
6762
		if ( self::is_active() ) {
6763
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6764
		}
6765
6766
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6767
			wp_add_dashboard_widget(
6768
				'jetpack_summary_widget',
6769
				esc_html__( 'Site Stats', 'jetpack' ),
6770
				array( __CLASS__, 'dashboard_widget' )
6771
			);
6772
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6773
6774
			// If we're inactive and not in development mode, sort our box to the top.
6775
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6776
				global $wp_meta_boxes;
6777
6778
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6779
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6780
6781
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6782
			}
6783
		}
6784
	}
6785
6786
	/**
6787
	 * @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...
6788
	 * @return mixed
6789
	 */
6790
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6791
		if ( ! is_array( $sorted ) ) {
6792
			return $sorted;
6793
		}
6794
6795
		foreach ( $sorted as $box_context => $ids ) {
6796
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6797
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6798
				continue;
6799
			}
6800
6801
			$ids_array = explode( ',', $ids );
6802
			$key = array_search( 'dashboard_stats', $ids_array );
6803
6804
			if ( false !== $key ) {
6805
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6806
				$ids_array[ $key ] = 'jetpack_summary_widget';
6807
				$sorted[ $box_context ] = implode( ',', $ids_array );
6808
				// We've found it, stop searching, and just return.
6809
				break;
6810
			}
6811
		}
6812
6813
		return $sorted;
6814
	}
6815
6816
	public static function dashboard_widget() {
6817
		/**
6818
		 * Fires when the dashboard is loaded.
6819
		 *
6820
		 * @since 3.4.0
6821
		 */
6822
		do_action( 'jetpack_dashboard_widget' );
6823
	}
6824
6825
	public static function dashboard_widget_footer() {
6826
		?>
6827
		<footer>
6828
6829
		<div class="protect">
6830
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6831
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6832
				<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>
6833
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6834
				<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' ); ?>">
6835
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6836
				</a>
6837
			<?php else : ?>
6838
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6839
			<?php endif; ?>
6840
		</div>
6841
6842
		<div class="akismet">
6843
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6844
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6845
				<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>
6846
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6847
				<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">
6848
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6849
				</a>
6850
			<?php else : ?>
6851
				<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>
6852
			<?php endif; ?>
6853
		</div>
6854
6855
		</footer>
6856
		<?php
6857
	}
6858
6859
	/**
6860
	 * Return string containing the Jetpack logo.
6861
	 *
6862
	 * @since 3.9.0
6863
	 *
6864
	 * @return string
6865
	 */
6866
	public static function get_jp_emblem() {
6867
		return '<svg id="jetpack-logo__icon" xmlns="http://www.w3.org/2000/svg" x="0px" y="0px" viewBox="0 0 32 32"><path fill="#00BE28" d="M16,0C7.2,0,0,7.2,0,16s7.2,16,16,16c8.8,0,16-7.2,16-16S24.8,0,16,0z M15.2,18.7h-8l8-15.5V18.7z M16.8,28.8 V13.3h8L16.8,28.8z"/></svg>';
6868
	}
6869
6870
	/*
6871
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6872
	 */
6873
	function jetpack_icon_user_connected( $columns ) {
6874
		$columns['user_jetpack'] = '';
6875
		return $columns;
6876
	}
6877
6878
	/*
6879
	 * Show Jetpack icon if the user is linked.
6880
	 */
6881
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6882
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6883
			$emblem_html = sprintf(
6884
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6885
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6886
				Jetpack::get_jp_emblem()
6887
			);
6888
			return $emblem_html;
6889
		}
6890
6891
		return $val;
6892
	}
6893
6894
	/*
6895
	 * Style the Jetpack user column
6896
	 */
6897
	function jetpack_user_col_style() {
6898
		global $current_screen;
6899
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6900
			<style>
6901
				.fixed .column-user_jetpack {
6902
					width: 21px;
6903
				}
6904
				.jp-emblem-user-admin svg {
6905
					width: 20px;
6906
					height: 20px;
6907
				}
6908
				.jp-emblem-user-admin path {
6909
					fill: #00BE28;
6910
				}
6911
			</style>
6912
		<?php }
6913
	}
6914
6915
	/**
6916
	 * Checks if Akismet is active and working.
6917
	 *
6918
	 * @since  5.1.0
6919
	 * @return bool True = Akismet available. False = Aksimet not available.
6920
	 */
6921
	public static function is_akismet_active() {
6922
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6923
			return true;
6924
		}
6925
		return false;
6926
	}
6927
6928
	/**
6929
	 * Checks if one or more function names is in debug_backtrace
6930
	 *
6931
	 * @param $names Mixed string name of function or array of string names of functions
6932
	 *
6933
	 * @return bool
6934
	 */
6935
	public static function is_function_in_backtrace( $names ) {
6936
		$backtrace = debug_backtrace( false );
6937
		if ( ! is_array( $names ) ) {
6938
			$names = array( $names );
6939
		}
6940
		$names_as_keys = array_flip( $names );
6941
6942
		//Do check in constant O(1) time for PHP5.5+
6943
		if ( function_exists( 'array_column' ) ) {
6944
			$backtrace_functions = array_column( $backtrace, 'function' );
6945
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6946
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6947
			return ! empty ( $intersection );
6948
		}
6949
6950
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6951
		foreach ( $backtrace as $call ) {
6952
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6953
				return true;
6954
			}
6955
		}
6956
		return false;
6957
	}
6958
6959
	/**
6960
	 * Given a minified path, and a non-minified path, will return
6961
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6962
	 *
6963
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6964
	 * root Jetpack directory.
6965
	 *
6966
	 * @since 5.6.0
6967
	 *
6968
	 * @param string $min_path
6969
	 * @param string $non_min_path
6970
	 * @return string The URL to the file
6971
	 */
6972
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
6973
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
6974
			? $non_min_path
6975
			: $min_path;
6976
6977
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
6978
	}
6979
6980
	/**
6981
	 * Checks for whether Jetpack Rewind is enabled.
6982
	 * Will return true if the state of Rewind is anything except "unavailable".
6983
	 * @return bool|int|mixed
6984
	 */
6985
	public static function is_rewind_enabled() {
6986
		if ( ! Jetpack::is_active() ) {
6987
			return false;
6988
		}
6989
6990
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
6991
		if ( false === $rewind_enabled ) {
6992
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
6993
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
6994
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
6995
				&& ! empty( $rewind_data['state'] )
6996
				&& 'unavailable' !== $rewind_data['state'] )
6997
				? 1
6998
				: 0;
6999
7000
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7001
		}
7002
		return $rewind_enabled;
7003
	}
7004
}
7005