Completed
Push — add/changelog-58 ( 5598a7...9db809 )
by Jeremy
10:21
created

Jetpack   F

Complexity

Total Complexity 1110

Size/Duplication

Total Lines 7007
Duplicated Lines 2.98 %

Coupling/Cohesion

Components 5
Dependencies 23

Importance

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

236 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
A is_onboarding() 0 3 1
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 93 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 263 55
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
F verify_xml_rpc_signature() 0 130 38
B authenticate_jetpack() 0 23 6
D wp_rest_authenticate() 0 94 21
A wp_rest_authentication_errors() 0 6 2
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
		'jetpack-search-widget'
62
	);
63
64
	/**
65
	 * Contains all assets that have had their URL rewritten to minified versions.
66
	 *
67
	 * @var array
68
	 */
69
	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...
70
71
	public $plugins_to_deactivate = array(
72
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
73
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
74
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
75
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
76
		'after-the-deadline'  => array( 'after-the-deadline/after-the-deadline.php', 'After The Deadline' ),
77
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
78
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
79
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
80
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
81
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
82
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
83
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
84
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
85
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
86
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' )
87
	);
88
89
	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...
90
		'administrator' => 'manage_options',
91
		'editor'        => 'edit_others_posts',
92
		'author'        => 'publish_posts',
93
		'contributor'   => 'edit_posts',
94
		'subscriber'    => 'read',
95
	);
96
97
	/**
98
	 * Map of modules that have conflicts with plugins and should not be auto-activated
99
	 * if the plugins are active.  Used by filter_default_modules
100
	 *
101
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
102
	 * change `module-slug` and add this to your plugin:
103
	 *
104
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
105
	 * function my_jetpack_get_default_modules( $modules ) {
106
	 *     return array_diff( $modules, array( 'module-slug' ) );
107
	 * }
108
	 *
109
	 * @var array
110
	 */
111
	private $conflicting_plugins = array(
112
		'comments'          => array(
113
			'Intense Debate'                       => 'intensedebate/intensedebate.php',
114
			'Disqus'                               => 'disqus-comment-system/disqus.php',
115
			'Livefyre'                             => 'livefyre-comments/livefyre.php',
116
			'Comments Evolved for WordPress'       => 'gplus-comments/comments-evolved.php',
117
			'Google+ Comments'                     => 'google-plus-comments/google-plus-comments.php',
118
			'WP-SpamShield Anti-Spam'              => 'wp-spamshield/wp-spamshield.php',
119
		),
120
		'comment-likes' => array(
121
			'Epoch'                                => 'epoch/plugincore.php',
122
		),
123
		'contact-form'      => array(
124
			'Contact Form 7'                       => 'contact-form-7/wp-contact-form-7.php',
125
			'Gravity Forms'                        => 'gravityforms/gravityforms.php',
126
			'Contact Form Plugin'                  => 'contact-form-plugin/contact_form.php',
127
			'Easy Contact Forms'                   => 'easy-contact-forms/easy-contact-forms.php',
128
			'Fast Secure Contact Form'             => 'si-contact-form/si-contact-form.php',
129
			'Ninja Forms'                          => 'ninja-forms/ninja-forms.php',
130
		),
131
		'minileven'         => array(
132
			'WPtouch'                              => 'wptouch/wptouch.php',
133
		),
134
		'latex'             => array(
135
			'LaTeX for WordPress'                  => 'latex/latex.php',
136
			'Youngwhans Simple Latex'              => 'youngwhans-simple-latex/yw-latex.php',
137
			'Easy WP LaTeX'                        => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
138
			'MathJax-LaTeX'                        => 'mathjax-latex/mathjax-latex.php',
139
			'Enable Latex'                         => 'enable-latex/enable-latex.php',
140
			'WP QuickLaTeX'                        => 'wp-quicklatex/wp-quicklatex.php',
141
		),
142
		'protect'           => array(
143
			'Limit Login Attempts'                 => 'limit-login-attempts/limit-login-attempts.php',
144
			'Captcha'                              => 'captcha/captcha.php',
145
			'Brute Force Login Protection'         => 'brute-force-login-protection/brute-force-login-protection.php',
146
			'Login Security Solution'              => 'login-security-solution/login-security-solution.php',
147
			'WPSecureOps Brute Force Protect'      => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
148
			'BulletProof Security'                 => 'bulletproof-security/bulletproof-security.php',
149
			'SiteGuard WP Plugin'                  => 'siteguard/siteguard.php',
150
			'Security-protection'                  => 'security-protection/security-protection.php',
151
			'Login Security'                       => 'login-security/login-security.php',
152
			'Botnet Attack Blocker'                => 'botnet-attack-blocker/botnet-attack-blocker.php',
153
			'Wordfence Security'                   => 'wordfence/wordfence.php',
154
			'All In One WP Security & Firewall'    => 'all-in-one-wp-security-and-firewall/wp-security.php',
155
			'iThemes Security'                     => 'better-wp-security/better-wp-security.php',
156
		),
157
		'random-redirect'   => array(
158
			'Random Redirect 2'                    => 'random-redirect-2/random-redirect.php',
159
		),
160
		'related-posts'     => array(
161
			'YARPP'                                => 'yet-another-related-posts-plugin/yarpp.php',
162
			'WordPress Related Posts'              => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
163
			'nrelate Related Content'              => 'nrelate-related-content/nrelate-related.php',
164
			'Contextual Related Posts'             => 'contextual-related-posts/contextual-related-posts.php',
165
			'Related Posts for WordPress'          => 'microkids-related-posts/microkids-related-posts.php',
166
			'outbrain'                             => 'outbrain/outbrain.php',
167
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
168
			'Sexybookmarks'                        => 'sexybookmarks/shareaholic.php',
169
		),
170
		'sharedaddy'        => array(
171
			'AddThis'                              => 'addthis/addthis_social_widget.php',
172
			'Add To Any'                           => 'add-to-any/add-to-any.php',
173
			'ShareThis'                            => 'share-this/sharethis.php',
174
			'Shareaholic'                          => 'shareaholic/shareaholic.php',
175
		),
176
		'seo-tools' => array(
177
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
178
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
179
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
180
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
181
		),
182
		'verification-tools' => array(
183
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
184
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
185
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
186
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
187
		),
188
		'widget-visibility' => array(
189
			'Widget Logic'                         => 'widget-logic/widget_logic.php',
190
			'Dynamic Widgets'                      => 'dynamic-widgets/dynamic-widgets.php',
191
		),
192
		'sitemaps' => array(
193
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
194
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
195
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
196
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
197
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
198
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
199
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
200
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
201
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
202
			'Sitemap'                              => 'sitemap/sitemap.php',
203
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
204
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
205
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
206
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
207
		),
208
		'lazy-images' => array(
209
			'Lazy Load'              => 'lazy-load/lazy-load.php',
210
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
211
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
212
		),
213
	);
214
215
	/**
216
	 * Plugins for which we turn off our Facebook OG Tags implementation.
217
	 *
218
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
219
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
220
	 *
221
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
222
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
223
	 */
224
	private $open_graph_conflicting_plugins = array(
225
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
226
		                                                         // 2 Click Social Media Buttons
227
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
228
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
229
		'autodescription/autodescription.php',                   // The SEO Framework
230
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
231
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
232
		                                                         // Open Graph Meta Tags by Heateor
233
		'facebook/facebook.php',                                 // Facebook (official plugin)
234
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
235
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
236
		                                                         // Facebook Featured Image & OG Meta Tags
237
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
238
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
239
		                                                         // Facebook Open Graph Meta Tags for WordPress
240
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
241
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
242
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
243
		                                                         // Fedmich's Facebook Open Graph Meta
244
		'network-publisher/networkpub.php',                      // Network Publisher
245
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
246
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
247
		                                                         // NextScripts SNAP
248
		'og-tags/og-tags.php',                                   // OG Tags
249
		'opengraph/opengraph.php',                               // Open Graph
250
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
251
		                                                         // Open Graph Protocol Framework
252
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
253
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
254
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
255
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
256
		'sharepress/sharepress.php',                             // SharePress
257
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
258
		'social-discussions/social-discussions.php',             // Social Discussions
259
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
260
		'socialize/socialize.php',                               // Socialize
261
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
262
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
263
		                                                         // Tweet, Like, Google +1 and Share
264
		'wordbooker/wordbooker.php',                             // Wordbooker
265
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
266
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
267
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
268
		                                                         // WP Facebook Like Send & Open Graph Meta
269
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
270
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
271
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
272
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
273
		'open-graph-metabox/open-graph-metabox.php'              // Open Graph Metabox
274
	);
275
276
	/**
277
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
278
	 */
279
	private $twitter_cards_conflicting_plugins = array(
280
	//	'twitter/twitter.php',                       // The official one handles this on its own.
281
	//	                                             // https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
282
		'eewee-twitter-card/index.php',              // Eewee Twitter Card
283
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
284
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
285
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
286
		                                             // Pure Web Brilliant's Social Graph Twitter Cards Extension
287
		'twitter-cards/twitter-cards.php',           // Twitter Cards
288
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
289
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
290
	);
291
292
	/**
293
	 * Message to display in admin_notice
294
	 * @var string
295
	 */
296
	public $message = '';
297
298
	/**
299
	 * Error to display in admin_notice
300
	 * @var string
301
	 */
302
	public $error = '';
303
304
	/**
305
	 * Modules that need more privacy description.
306
	 * @var string
307
	 */
308
	public $privacy_checks = '';
309
310
	/**
311
	 * Stats to record once the page loads
312
	 *
313
	 * @var array
314
	 */
315
	public $stats = array();
316
317
	/**
318
	 * Jetpack_Sync object
319
	 */
320
	public $sync;
321
322
	/**
323
	 * Verified data for JSON authorization request
324
	 */
325
	public $json_api_authorization_request = array();
326
327
	/**
328
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
329
	 */
330
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
331
332
	/**
333
	 * Holds the singleton instance of this class
334
	 * @since 2.3.3
335
	 * @var Jetpack
336
	 */
337
	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...
338
339
	/**
340
	 * Singleton
341
	 * @static
342
	 */
343
	public static function init() {
344
		if ( ! self::$instance ) {
345
			self::$instance = new Jetpack;
346
347
			self::$instance->plugin_upgrade();
348
		}
349
350
		return self::$instance;
351
	}
352
353
	/**
354
	 * Must never be called statically
355
	 */
356
	function plugin_upgrade() {
357
		if ( Jetpack::is_active() ) {
358
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
359
			if ( JETPACK__VERSION != $version ) {
360
				// Prevent multiple upgrades at once - only a single process should trigger
361
				// an upgrade to avoid stampedes
362
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
363
					return;
364
				}
365
366
				// Set a short lock to prevent multiple instances of the upgrade
367
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
368
369
				// check which active modules actually exist and remove others from active_modules list
370
				$unfiltered_modules = Jetpack::get_active_modules();
371
				$modules = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
372
				if ( array_diff( $unfiltered_modules, $modules ) ) {
373
					Jetpack::update_active_modules( $modules );
374
				}
375
376
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
377
378
				// Upgrade to 4.3.0
379
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
380
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
381
				}
382
383
				// Make sure Markdown for posts gets turned back on
384
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
385
					update_option( 'wpcom_publish_posts_with_markdown', true );
386
				}
387
388
				if ( did_action( 'wp_loaded' ) ) {
389
					self::upgrade_on_load();
390
				} else {
391
					add_action(
392
						'wp_loaded',
393
						array( __CLASS__, 'upgrade_on_load' )
394
					);
395
				}
396
			}
397
		}
398
	}
399
400
	/**
401
	 * Runs upgrade routines that need to have modules loaded.
402
	 */
403
	static function upgrade_on_load() {
404
405
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
406
		// This can happen in case Jetpack has been just upgraded and is
407
		// being initialized late during the page load. In this case we wait
408
		// until the next proper admin page load with Jetpack active.
409
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
410
			delete_transient( self::$plugin_upgrade_lock_key );
411
412
			return;
413
		}
414
415
		Jetpack::maybe_set_version_option();
416
417
		if ( class_exists( 'Jetpack_Widget_Conditions' ) ) {
418
			Jetpack_Widget_Conditions::migrate_post_type_rules();
419
		}
420
421
		if (
422
			class_exists( 'Jetpack_Sitemap_Manager' )
423
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
424
		) {
425
			do_action( 'jetpack_sitemaps_purge_data' );
426
		}
427
428
		delete_transient( self::$plugin_upgrade_lock_key );
429
	}
430
431
	static function activate_manage( ) {
432
		if ( did_action( 'init' ) || current_filter() == 'init' ) {
433
			self::activate_module( 'manage', false, false );
434
		} else if ( !  has_action( 'init' , array( __CLASS__, 'activate_manage' ) ) ) {
435
			add_action( 'init', array( __CLASS__, 'activate_manage' ) );
436
		}
437
	}
438
439
	static function update_active_modules( $modules ) {
440
		$current_modules = Jetpack_Options::get_option( 'active_modules', array() );
441
442
		$success = Jetpack_Options::update_option( 'active_modules', array_unique( $modules ) );
443
444
		if ( is_array( $modules ) && is_array( $current_modules ) ) {
445
			$new_active_modules = array_diff( $modules, $current_modules );
446
			foreach( $new_active_modules as $module ) {
447
				/**
448
				 * Fires when a specific module is activated.
449
				 *
450
				 * @since 1.9.0
451
				 *
452
				 * @param string $module Module slug.
453
				 * @param boolean $success whether the module was activated. @since 4.2
454
				 */
455
				do_action( 'jetpack_activate_module', $module, $success );
456
457
				/**
458
				 * Fires when a module is activated.
459
				 * The dynamic part of the filter, $module, is the module slug.
460
				 *
461
				 * @since 1.9.0
462
				 *
463
				 * @param string $module Module slug.
464
				 */
465
				do_action( "jetpack_activate_module_$module", $module );
466
			}
467
468
			$new_deactive_modules = array_diff( $current_modules, $modules );
469
			foreach( $new_deactive_modules as $module ) {
470
				/**
471
				 * Fired after a module has been deactivated.
472
				 *
473
				 * @since 4.2.0
474
				 *
475
				 * @param string $module Module slug.
476
				 * @param boolean $success whether the module was deactivated.
477
				 */
478
				do_action( 'jetpack_deactivate_module', $module, $success );
479
				/**
480
				 * Fires when a module is deactivated.
481
				 * The dynamic part of the filter, $module, is the module slug.
482
				 *
483
				 * @since 1.9.0
484
				 *
485
				 * @param string $module Module slug.
486
				 */
487
				do_action( "jetpack_deactivate_module_$module", $module );
488
			}
489
		}
490
491
		return $success;
492
	}
493
494
	static function delete_active_modules() {
495
		self::update_active_modules( array() );
496
	}
497
498
	/**
499
	 * Constructor.  Initializes WordPress hooks
500
	 */
501
	private function __construct() {
502
		/*
503
		 * Check for and alert any deprecated hooks
504
		 */
505
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
506
507
		/*
508
		 * Enable enhanced handling of previewing sites in Calypso
509
		 */
510
		if ( Jetpack::is_active() ) {
511
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
512
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
513
		}
514
515
		/*
516
		 * Load things that should only be in Network Admin.
517
		 *
518
		 * For now blow away everything else until a more full
519
		 * understanding of what is needed at the network level is
520
		 * available
521
		 */
522
		if( is_multisite() ) {
523
			Jetpack_Network::init();
524
		}
525
526
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
527
528
		// Unlink user before deleting the user from .com
529
		add_action( 'deleted_user', array( $this, 'unlink_user' ), 10, 1 );
530
		add_action( 'remove_user_from_blog', array( $this, 'unlink_user' ), 10, 1 );
531
532
		if ( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST && isset( $_GET['for'] ) && 'jetpack' == $_GET['for'] ) {
533
			@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...
534
535
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-xmlrpc-server.php';
536
			$this->xmlrpc_server = new Jetpack_XMLRPC_Server();
537
538
			$this->require_jetpack_authentication();
539
540
			if ( Jetpack::is_active() ) {
541
				// Hack to preserve $HTTP_RAW_POST_DATA
542
				add_filter( 'xmlrpc_methods', array( $this, 'xmlrpc_methods' ) );
543
544
				$signed = $this->verify_xml_rpc_signature();
545
				if ( $signed && ! is_wp_error( $signed ) ) {
546
					// The actual API methods.
547
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'xmlrpc_methods' ) );
548
				} else {
549
					// The jetpack.authorize method should be available for unauthenticated users on a site with an
550
					// active Jetpack connection, so that additional users can link their account.
551
					add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'authorize_xmlrpc_methods' ) );
552
				}
553
			} else {
554
				// The bootstrap API methods.
555
				add_filter( 'xmlrpc_methods', array( $this->xmlrpc_server, 'bootstrap_xmlrpc_methods' ) );
556
			}
557
558
			// Now that no one can authenticate, and we're whitelisting all XML-RPC methods, force enable_xmlrpc on.
559
			add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
560
		} elseif (
561
			is_admin() &&
562
			isset( $_POST['action'] ) && (
563
				'jetpack_upload_file' == $_POST['action'] ||
564
				'jetpack_update_file' == $_POST['action']
565
			)
566
		) {
567
			$this->require_jetpack_authentication();
568
			$this->add_remote_request_handlers();
569
		} else {
570
			if ( Jetpack::is_active() ) {
571
				add_action( 'login_form_jetpack_json_api_authorization', array( &$this, 'login_form_json_api_authorization' ) );
572
				add_filter( 'xmlrpc_methods', array( $this, 'public_xmlrpc_methods' ) );
573
			}
574
		}
575
576
		if ( Jetpack::is_active() ) {
577
			Jetpack_Heartbeat::init();
578
		}
579
580
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
581
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
582
583
		add_action( 'jetpack_clean_nonces', array( 'Jetpack', 'clean_nonces' ) );
584
		if ( ! wp_next_scheduled( 'jetpack_clean_nonces' ) ) {
585
			wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
586
		}
587
588
		add_filter( 'xmlrpc_blog_options', array( $this, 'xmlrpc_options' ) );
589
590
		add_action( 'admin_init', array( $this, 'admin_init' ) );
591
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
592
593
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ) );
594
595
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
596
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
597
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
598
599
		// returns HTTPS support status
600
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
601
602
		// If any module option is updated before Jump Start is dismissed, hide Jump Start.
603
		add_action( 'update_option', array( $this, 'jumpstart_has_updated_module_option' ) );
604
605
		// JITM AJAX callback function
606
		add_action( 'wp_ajax_jitm_ajax',  array( $this, 'jetpack_jitm_ajax_callback' ) );
607
608
		// Universal ajax callback for all tracking events triggered via js
609
		add_action( 'wp_ajax_jetpack_tracks', array( $this, 'jetpack_admin_ajax_tracks_callback' ) );
610
611
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
612
613
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
614
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
615
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
616
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
617
618
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
619
620
		/**
621
		 * These actions run checks to load additional files.
622
		 * They check for external files or plugins, so they need to run as late as possible.
623
		 */
624
		add_action( 'wp_head', array( $this, 'check_open_graph' ),       1 );
625
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ),     999 );
626
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
627
628
		add_filter( 'plugins_url',      array( 'Jetpack', 'maybe_min_asset' ),     1, 3 );
629
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2  );
630
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
631
632
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
633
634
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
635
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
636
637
		// A filter to control all just in time messages
638
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
639
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9);
640
641
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
642
		// We should make sure to only do this for front end links.
643
		if ( Jetpack::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
644
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
645
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
646
		}
647
648
		// Update the Jetpack plan from API on heartbeats
649
		add_action( 'jetpack_heartbeat', array( $this, 'refresh_active_plan_from_wpcom' ) );
650
651
		/**
652
		 * This is the hack to concatinate all css files into one.
653
		 * For description and reasoning see the implode_frontend_css method
654
		 *
655
		 * Super late priority so we catch all the registered styles
656
		 */
657
		if( !is_admin() ) {
658
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
659
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
660
		}
661
662
		/**
663
		 * These are sync actions that we need to keep track of for jitms
664
		 */
665
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
666
667
		// Actually push the stats on shutdown.
668
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
669
			add_action( 'shutdown', array( $this, 'push_stats' ) );
670
		}
671
	}
672
673
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
674
		$post = get_post( $post_id );
675
676
		if ( empty( $post ) ) {
677
			return $default_url;
678
		}
679
680
		$post_type = $post->post_type;
681
682
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
683
		// https://en.support.wordpress.com/custom-post-types/
684
		$allowed_post_types = array(
685
			'post' => 'post',
686
			'page' => 'page',
687
			'jetpack-portfolio' => 'edit/jetpack-portfolio',
688
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
689
		);
690
691
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
692
			return $default_url;
693
		}
694
695
		$path_prefix = $allowed_post_types[ $post_type ];
696
697
		$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...
698
699
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
700
	}
701
702
	function point_edit_comment_links_to_calypso( $url ) {
703
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
704
		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...
705
		return esc_url( sprintf( 'https://wordpress.com/comment/%s/%d?action=edit',
706
			Jetpack::build_raw_urls( get_home_url() ),
707
			$query_args['amp;c']
708
		) );
709
	}
710
711
	function jetpack_track_last_sync_callback( $params ) {
712
		/**
713
		 * Filter to turn off jitm caching
714
		 *
715
		 * @since 5.4.0
716
		 *
717
		 * @param bool false Whether to cache just in time messages
718
		 */
719
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
720
			return $params;
721
		}
722
723
		if ( is_array( $params ) && isset( $params[0] ) ) {
724
			$option = $params[0];
725
			if ( 'active_plugins' === $option ) {
726
				// use the cache if we can, but not terribly important if it gets evicted
727
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
728
			}
729
		}
730
731
		return $params;
732
	}
733
734
	function jetpack_connection_banner_callback() {
735
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
736
737
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
738
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
739
			wp_send_json_success();
740
		}
741
742
		wp_die();
743
	}
744
745
	function jetpack_admin_ajax_tracks_callback() {
746
		// Check for nonce
747
		if ( ! isset( $_REQUEST['tracksNonce'] ) || ! wp_verify_nonce( $_REQUEST['tracksNonce'], 'jp-tracks-ajax-nonce' ) ) {
748
			wp_die( 'Permissions check failed.' );
749
		}
750
751
		if ( ! isset( $_REQUEST['tracksEventName'] ) || ! isset( $_REQUEST['tracksEventType'] )  ) {
752
			wp_die( 'No valid event name or type.' );
753
		}
754
755
		$tracks_data = array();
756
		if ( 'click' === $_REQUEST['tracksEventType'] && isset( $_REQUEST['tracksEventProp'] ) ) {
757
			if ( is_array( $_REQUEST['tracksEventProp'] ) ) {
758
				$tracks_data = $_REQUEST['tracksEventProp'];
759
			} else {
760
				$tracks_data = array( 'clicked' => $_REQUEST['tracksEventProp'] );
761
			}
762
		}
763
764
		JetpackTracking::record_user_event( $_REQUEST['tracksEventName'], $tracks_data );
765
		wp_send_json_success();
766
		wp_die();
767
	}
768
769
	/**
770
	 * The callback for the JITM ajax requests.
771
	 */
772
	function jetpack_jitm_ajax_callback() {
773
		// Check for nonce
774
		if ( ! isset( $_REQUEST['jitmNonce'] ) || ! wp_verify_nonce( $_REQUEST['jitmNonce'], 'jetpack-jitm-nonce' ) ) {
775
			wp_die( 'Module activation failed due to lack of appropriate permissions' );
776
		}
777
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'activate' == $_REQUEST['jitmActionToTake'] ) {
778
			$module_slug = $_REQUEST['jitmModule'];
779
			Jetpack::log( 'activate', $module_slug );
780
			Jetpack::activate_module( $module_slug, false, false );
781
			Jetpack::state( 'message', 'no_message' );
782
783
			//A Jetpack module is being activated through a JITM, track it
784
			$this->stat( 'jitm', $module_slug.'-activated-' . JETPACK__VERSION );
785
			$this->do_stats( 'server_side' );
786
787
			wp_send_json_success();
788
		}
789
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'dismiss' == $_REQUEST['jitmActionToTake'] ) {
790
			// get the hide_jitm options array
791
			$jetpack_hide_jitm = Jetpack_Options::get_option( 'hide_jitm' );
792
			$module_slug = $_REQUEST['jitmModule'];
793
794
			if( ! $jetpack_hide_jitm ) {
795
				$jetpack_hide_jitm = array(
796
					$module_slug => 'hide'
797
				);
798
			} else {
799
				$jetpack_hide_jitm[$module_slug] = 'hide';
800
			}
801
802
			Jetpack_Options::update_option( 'hide_jitm', $jetpack_hide_jitm );
803
804
			//jitm is being dismissed forever, track it
805
			$this->stat( 'jitm', $module_slug.'-dismissed-' . JETPACK__VERSION );
806
			$this->do_stats( 'server_side' );
807
808
			wp_send_json_success();
809
		}
810 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'launch' == $_REQUEST['jitmActionToTake'] ) {
811
			$module_slug = $_REQUEST['jitmModule'];
812
813
			// User went to WordPress.com, track this
814
			$this->stat( 'jitm', $module_slug.'-wordpress-tools-' . JETPACK__VERSION );
815
			$this->do_stats( 'server_side' );
816
817
			wp_send_json_success();
818
		}
819 View Code Duplication
		if ( isset( $_REQUEST['jitmActionToTake'] ) && 'viewed' == $_REQUEST['jitmActionToTake'] ) {
820
			$track = $_REQUEST['jitmModule'];
821
822
			// User is viewing JITM, track it.
823
			$this->stat( 'jitm', $track . '-viewed-' . JETPACK__VERSION );
824
			$this->do_stats( 'server_side' );
825
826
			wp_send_json_success();
827
		}
828
	}
829
830
	/**
831
	 * If there are any stats that need to be pushed, but haven't been, push them now.
832
	 */
833
	function push_stats() {
834
		if ( ! empty( $this->stats ) ) {
835
			$this->do_stats( 'server_side' );
836
		}
837
	}
838
839
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
840
		switch( $cap ) {
841
			case 'jetpack_connect' :
842
			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...
843
				if ( Jetpack::is_development_mode() ) {
844
					$caps = array( 'do_not_allow' );
845
					break;
846
				}
847
				/**
848
				 * Pass through. If it's not development mode, these should match disconnect.
849
				 * Let users disconnect if it's development mode, just in case things glitch.
850
				 */
851
			case 'jetpack_disconnect' :
852
				/**
853
				 * In multisite, can individual site admins manage their own connection?
854
				 *
855
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
856
				 */
857
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
858
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
859
						/**
860
						 * We need to update the option name -- it's terribly unclear which
861
						 * direction the override goes.
862
						 *
863
						 * @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...
864
						 */
865
						$caps = array( 'do_not_allow' );
866
						break;
867
					}
868
				}
869
870
				$caps = array( 'manage_options' );
871
				break;
872
			case 'jetpack_manage_modules' :
873
			case 'jetpack_activate_modules' :
874
			case 'jetpack_deactivate_modules' :
875
				$caps = array( 'manage_options' );
876
				break;
877
			case 'jetpack_configure_modules' :
878
				$caps = array( 'manage_options' );
879
				break;
880
			case 'jetpack_network_admin_page':
881
			case 'jetpack_network_settings_page':
882
				$caps = array( 'manage_network_plugins' );
883
				break;
884
			case 'jetpack_network_sites_page':
885
				$caps = array( 'manage_sites' );
886
				break;
887
			case 'jetpack_admin_page' :
888
				if ( Jetpack::is_development_mode() ) {
889
					$caps = array( 'manage_options' );
890
					break;
891
				} else {
892
					$caps = array( 'read' );
893
				}
894
				break;
895
			case 'jetpack_connect_user' :
896
				if ( Jetpack::is_development_mode() ) {
897
					$caps = array( 'do_not_allow' );
898
					break;
899
				}
900
				$caps = array( 'read' );
901
				break;
902
		}
903
		return $caps;
904
	}
905
906
	function require_jetpack_authentication() {
907
		// Don't let anyone authenticate
908
		$_COOKIE = array();
909
		remove_all_filters( 'authenticate' );
910
		remove_all_actions( 'wp_login_failed' );
911
912
		if ( Jetpack::is_active() ) {
913
			// Allow Jetpack authentication
914
			add_filter( 'authenticate', array( $this, 'authenticate_jetpack' ), 10, 3 );
915
		}
916
	}
917
918
	/**
919
	 * Load language files
920
	 * @action plugins_loaded
921
	 */
922
	public static function plugin_textdomain() {
923
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
924
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
925
	}
926
927
	/**
928
	 * Register assets for use in various modules and the Jetpack admin page.
929
	 *
930
	 * @uses wp_script_is, wp_register_script, plugins_url
931
	 * @action wp_loaded
932
	 * @return null
933
	 */
934
	public function register_assets() {
935
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
936
			wp_register_script(
937
				'spin',
938
				self::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
939
				false,
940
				'1.3'
941
			);
942
		}
943
944
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
945
			wp_register_script(
946
				'jquery.spin',
947
				self::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
948
				array( 'jquery', 'spin' ),
949
				'1.3'
950
			);
951
		}
952
953 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
954
			wp_register_script(
955
				'jetpack-gallery-settings',
956
				self::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
957
				array( 'media-views' ),
958
				'20121225'
959
			);
960
		}
961
962
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
963
			wp_register_script(
964
				'jetpack-twitter-timeline',
965
				self::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
966
				array( 'jquery' ),
967
				'4.0.0',
968
				true
969
			);
970
		}
971
972
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
973
			wp_register_script(
974
				'jetpack-facebook-embed',
975
				self::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
976
				array( 'jquery' ),
977
				null,
978
				true
979
			);
980
981
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
982
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
983
			if ( ! is_numeric( $fb_app_id ) ) {
984
				$fb_app_id = '';
985
			}
986
			wp_localize_script(
987
				'jetpack-facebook-embed',
988
				'jpfbembed',
989
				array(
990
					'appid' => $fb_app_id,
991
					'locale' => $this->get_locale(),
992
				)
993
			);
994
		}
995
996
		/**
997
		 * As jetpack_register_genericons is by default fired off a hook,
998
		 * the hook may have already fired by this point.
999
		 * So, let's just trigger it manually.
1000
		 */
1001
		require_once( JETPACK__PLUGIN_DIR . '_inc/genericons.php' );
1002
		jetpack_register_genericons();
1003
1004
		/**
1005
		 * Register the social logos
1006
		 */
1007
		require_once( JETPACK__PLUGIN_DIR . '_inc/social-logos.php' );
1008
		jetpack_register_social_logos();
1009
1010 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) )
1011
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1012
	}
1013
1014
	/**
1015
	 * Guess locale from language code.
1016
	 *
1017
	 * @param string $lang Language code.
1018
	 * @return string|bool
1019
	 */
1020
	function guess_locale_from_lang( $lang ) {
1021
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1022
			return 'en_US';
1023
		}
1024
1025 View Code Duplication
		if ( ! class_exists( 'GP_Locales' ) ) {
1026
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1027
				return false;
1028
			}
1029
1030
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1031
		}
1032
1033
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1034
			// WP.com: get_locale() returns 'it'
1035
			$locale = GP_Locales::by_slug( $lang );
1036
		} else {
1037
			// Jetpack: get_locale() returns 'it_IT';
1038
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1039
		}
1040
1041
		if ( ! $locale ) {
1042
			return false;
1043
		}
1044
1045
		if ( empty( $locale->facebook_locale ) ) {
1046
			if ( empty( $locale->wp_locale ) ) {
1047
				return false;
1048
			} else {
1049
				// Facebook SDK is smart enough to fall back to en_US if a
1050
				// locale isn't supported. Since supported Facebook locales
1051
				// can fall out of sync, we'll attempt to use the known
1052
				// wp_locale value and rely on said fallback.
1053
				return $locale->wp_locale;
1054
			}
1055
		}
1056
1057
		return $locale->facebook_locale;
1058
	}
1059
1060
	/**
1061
	 * Get the locale.
1062
	 *
1063
	 * @return string|bool
1064
	 */
1065
	function get_locale() {
1066
		$locale = $this->guess_locale_from_lang( get_locale() );
1067
1068
		if ( ! $locale ) {
1069
			$locale = 'en_US';
1070
		}
1071
1072
		return $locale;
1073
	}
1074
1075
	/**
1076
	 * Device Pixels support
1077
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1078
	 */
1079
	function devicepx() {
1080
		if ( Jetpack::is_active() ) {
1081
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1082
		}
1083
	}
1084
1085
	/**
1086
	 * Return the network_site_url so that .com knows what network this site is a part of.
1087
	 * @param  bool $option
1088
	 * @return string
1089
	 */
1090
	public function jetpack_main_network_site_option( $option ) {
1091
		return network_site_url();
1092
	}
1093
	/**
1094
	 * Network Name.
1095
	 */
1096
	static function network_name( $option = null ) {
1097
		global $current_site;
1098
		return $current_site->site_name;
1099
	}
1100
	/**
1101
	 * Does the network allow new user and site registrations.
1102
	 * @return string
1103
	 */
1104
	static function network_allow_new_registrations( $option = null ) {
1105
		return ( in_array( get_site_option( 'registration' ), array('none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration') : 'none' );
1106
	}
1107
	/**
1108
	 * Does the network allow admins to add new users.
1109
	 * @return boolian
1110
	 */
1111
	static function network_add_new_users( $option = null ) {
1112
		return (bool) get_site_option( 'add_new_users' );
1113
	}
1114
	/**
1115
	 * File upload psace left per site in MB.
1116
	 *  -1 means NO LIMIT.
1117
	 * @return number
1118
	 */
1119
	static function network_site_upload_space( $option = null ) {
1120
		// value in MB
1121
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1122
	}
1123
1124
	/**
1125
	 * Network allowed file types.
1126
	 * @return string
1127
	 */
1128
	static function network_upload_file_types( $option = null ) {
1129
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1130
	}
1131
1132
	/**
1133
	 * Maximum file upload size set by the network.
1134
	 * @return number
1135
	 */
1136
	static function network_max_upload_file_size( $option = null ) {
1137
		// value in KB
1138
		return get_site_option( 'fileupload_maxk', 300 );
1139
	}
1140
1141
	/**
1142
	 * Lets us know if a site allows admins to manage the network.
1143
	 * @return array
1144
	 */
1145
	static function network_enable_administration_menus( $option = null ) {
1146
		return get_site_option( 'menu_items' );
1147
	}
1148
1149
	/**
1150
	 * If a user has been promoted to or demoted from admin, we need to clear the
1151
	 * jetpack_other_linked_admins transient.
1152
	 *
1153
	 * @since 4.3.2
1154
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1155
	 *
1156
	 * @param int    $user_id   The user ID whose role changed.
1157
	 * @param string $role      The new role.
1158
	 * @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...
1159
	 */
1160
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1161
		if ( 'administrator' == $role
1162
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1163
			|| is_null( $old_roles )
1164
		) {
1165
			delete_transient( 'jetpack_other_linked_admins' );
1166
		}
1167
	}
1168
1169
	/**
1170
	 * Checks to see if there are any other users available to become primary
1171
	 * Users must both:
1172
	 * - Be linked to wpcom
1173
	 * - Be an admin
1174
	 *
1175
	 * @return mixed False if no other users are linked, Int if there are.
1176
	 */
1177
	static function get_other_linked_admins() {
1178
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1179
1180
		if ( false === $other_linked_users ) {
1181
			$admins = get_users( array( 'role' => 'administrator' ) );
1182
			if ( count( $admins ) > 1 ) {
1183
				$available = array();
1184
				foreach ( $admins as $admin ) {
1185
					if ( Jetpack::is_user_connected( $admin->ID ) ) {
1186
						$available[] = $admin->ID;
1187
					}
1188
				}
1189
1190
				$count_connected_admins = count( $available );
1191
				if ( count( $available ) > 1 ) {
1192
					$other_linked_users = $count_connected_admins;
1193
				} else {
1194
					$other_linked_users = 0;
1195
				}
1196
			} else {
1197
				$other_linked_users = 0;
1198
			}
1199
1200
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1201
		}
1202
1203
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1204
	}
1205
1206
	/**
1207
	 * Return whether we are dealing with a multi network setup or not.
1208
	 * The reason we are type casting this is because we want to avoid the situation where
1209
	 * the result is false since when is_main_network_option return false it cases
1210
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1211
	 * database which could be set to anything as opposed to what this function returns.
1212
	 * @param  bool  $option
1213
	 *
1214
	 * @return boolean
1215
	 */
1216
	public function is_main_network_option( $option ) {
1217
		// return '1' or ''
1218
		return (string) (bool) Jetpack::is_multi_network();
1219
	}
1220
1221
	/**
1222
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1223
	 *
1224
	 * @param  string  $option
1225
	 * @return boolean
1226
	 */
1227
	public function is_multisite( $option ) {
1228
		return (string) (bool) is_multisite();
1229
	}
1230
1231
	/**
1232
	 * Implemented since there is no core is multi network function
1233
	 * Right now there is no way to tell if we which network is the dominant network on the system
1234
	 *
1235
	 * @since  3.3
1236
	 * @return boolean
1237
	 */
1238
	public static function is_multi_network() {
1239
		global  $wpdb;
1240
1241
		// if we don't have a multi site setup no need to do any more
1242
		if ( ! is_multisite() ) {
1243
			return false;
1244
		}
1245
1246
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1247
		if ( $num_sites > 1 ) {
1248
			return true;
1249
		} else {
1250
			return false;
1251
		}
1252
	}
1253
1254
	/**
1255
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1256
	 * @return null
1257
	 */
1258
	function update_jetpack_main_network_site_option() {
1259
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1260
	}
1261
	/**
1262
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1263
	 *
1264
	 */
1265
	function update_jetpack_network_settings() {
1266
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1267
		// Only sync this info for the main network site.
1268
	}
1269
1270
	/**
1271
	 * Get back if the current site is single user site.
1272
	 *
1273
	 * @return bool
1274
	 */
1275
	public static function is_single_user_site() {
1276
		global $wpdb;
1277
1278 View Code Duplication
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1279
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1280
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1281
		}
1282
		return 1 === (int) $some_users;
1283
	}
1284
1285
	/**
1286
	 * Returns true if the site has file write access false otherwise.
1287
	 * @return string ( '1' | '0' )
1288
	 **/
1289
	public static function file_system_write_access() {
1290
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1291
			require_once( ABSPATH . 'wp-admin/includes/file.php' );
1292
		}
1293
1294
		require_once( ABSPATH . 'wp-admin/includes/template.php' );
1295
1296
		$filesystem_method = get_filesystem_method();
1297
		if ( $filesystem_method === 'direct' ) {
1298
			return 1;
1299
		}
1300
1301
		ob_start();
1302
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1303
		ob_end_clean();
1304
		if ( $filesystem_credentials_are_stored ) {
1305
			return 1;
1306
		}
1307
		return 0;
1308
	}
1309
1310
	/**
1311
	 * Finds out if a site is using a version control system.
1312
	 * @return string ( '1' | '0' )
1313
	 **/
1314
	public static function is_version_controlled() {
1315
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Functions::is_version_controlled' );
1316
		return (string) (int) Jetpack_Sync_Functions::is_version_controlled();
1317
	}
1318
1319
	/**
1320
	 * Determines whether the current theme supports featured images or not.
1321
	 * @return string ( '1' | '0' )
1322
	 */
1323
	public static function featured_images_enabled() {
1324
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1325
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1326
	}
1327
1328
	/**
1329
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1330
	 *
1331
	 * @deprecated 4.7 use get_avatar_url instead.
1332
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1333
	 * @param int $size Size of the avatar image
1334
	 * @param string $default URL to a default image to use if no avatar is available
1335
	 * @param bool $force_display Whether to force it to return an avatar even if show_avatars is disabled
1336
	 *
1337
	 * @return array
1338
	 */
1339
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1340
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1341
		return get_avatar_url( $id_or_email, array(
1342
			'size' => $size,
1343
			'default' => $default,
1344
			'force_default' => $force_display,
1345
		) );
1346
	}
1347
1348
	/**
1349
	 * jetpack_updates is saved in the following schema:
1350
	 *
1351
	 * array (
1352
	 *      'plugins'                       => (int) Number of plugin updates available.
1353
	 *      'themes'                        => (int) Number of theme updates available.
1354
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1355
	 *      'translations'                  => (int) Number of translation updates available.
1356
	 *      'total'                         => (int) Total of all available updates.
1357
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1358
	 * )
1359
	 * @return array
1360
	 */
1361
	public static function get_updates() {
1362
		$update_data = wp_get_update_data();
1363
1364
		// Stores the individual update counts as well as the total count.
1365
		if ( isset( $update_data['counts'] ) ) {
1366
			$updates = $update_data['counts'];
1367
		}
1368
1369
		// If we need to update WordPress core, let's find the latest version number.
1370 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1371
			$cur = get_preferred_from_update_core();
1372
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1373
				$updates['wp_update_version'] = $cur->current;
1374
			}
1375
		}
1376
		return isset( $updates ) ? $updates : array();
1377
	}
1378
1379
	public static function get_update_details() {
1380
		$update_details = array(
1381
			'update_core' => get_site_transient( 'update_core' ),
1382
			'update_plugins' => get_site_transient( 'update_plugins' ),
1383
			'update_themes' => get_site_transient( 'update_themes' ),
1384
		);
1385
		return $update_details;
1386
	}
1387
1388
	public static function refresh_update_data() {
1389
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1390
1391
	}
1392
1393
	public static function refresh_theme_data() {
1394
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1395
	}
1396
1397
	/**
1398
	 * Is Jetpack active?
1399
	 */
1400
	public static function is_active() {
1401
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1402
	}
1403
1404
	/**
1405
	 * Make an API call to WordPress.com for plan status
1406
	 *
1407
	 * @uses Jetpack_Options::get_option()
1408
	 * @uses Jetpack_Client::wpcom_json_api_request_as_blog()
1409
	 * @uses update_option()
1410
	 *
1411
	 * @access public
1412
	 * @static
1413
	 *
1414
	 * @return bool True if plan is updated, false if no update
1415
	 */
1416
	public static function refresh_active_plan_from_wpcom() {
1417
		// Make the API request
1418
		$request = sprintf( '/sites/%d', Jetpack_Options::get_option( 'id' ) );
1419
		$response = Jetpack_Client::wpcom_json_api_request_as_blog( $request, '1.1' );
1420
1421
		// Bail if there was an error or malformed response
1422
		if ( is_wp_error( $response ) || ! is_array( $response ) || ! isset( $response['body'] ) ) {
1423
			return false;
1424
		}
1425
1426
		// Decode the results
1427
		$results = json_decode( $response['body'], true );
1428
1429
		// Bail if there were no results or plan details returned
1430
		if ( ! is_array( $results ) || ! isset( $results['plan'] ) ) {
1431
			return false;
1432
		}
1433
1434
		// Store the option and return true if updated
1435
		return update_option( 'jetpack_active_plan', $results['plan'] );
1436
	}
1437
1438
	/**
1439
	 * Get the plan that this Jetpack site is currently using
1440
	 *
1441
	 * @uses get_option()
1442
	 *
1443
	 * @access public
1444
	 * @static
1445
	 *
1446
	 * @return array Active Jetpack plan details
1447
	 */
1448
	public static function get_active_plan() {
1449
		$plan = get_option( 'jetpack_active_plan', array() );
1450
1451
		// Set the default options
1452
		if ( empty( $plan ) || ( isset( $plan['product_slug'] ) && 'jetpack_free' === $plan['product_slug'] ) ) {
1453
			$plan = wp_parse_args( $plan, array(
1454
				'product_slug' => 'jetpack_free',
1455
				'supports'     => array(),
1456
				'class'        => 'free',
1457
			) );
1458
		}
1459
1460
		// Define what paid modules are supported by personal plans
1461
		$personal_plans = array(
1462
			'jetpack_personal',
1463
			'jetpack_personal_monthly',
1464
			'personal-bundle',
1465
		);
1466
1467
		if ( in_array( $plan['product_slug'], $personal_plans ) ) {
1468
			$plan['supports'] = array(
1469
				'akismet',
1470
			);
1471
			$plan['class'] = 'personal';
1472
		}
1473
1474
		// Define what paid modules are supported by premium plans
1475
		$premium_plans = array(
1476
			'jetpack_premium',
1477
			'jetpack_premium_monthly',
1478
			'value_bundle',
1479
		);
1480
1481
		if ( in_array( $plan['product_slug'], $premium_plans ) ) {
1482
			$plan['supports'] = array(
1483
				'videopress',
1484
				'akismet',
1485
				'vaultpress',
1486
				'wordads',
1487
			);
1488
			$plan['class'] = 'premium';
1489
		}
1490
1491
		// Define what paid modules are supported by professional plans
1492
		$business_plans = array(
1493
			'jetpack_business',
1494
			'jetpack_business_monthly',
1495
			'business-bundle',
1496
			'vip',
1497
		);
1498
1499
		if ( in_array( $plan['product_slug'], $business_plans ) ) {
1500
			$plan['supports'] = array(
1501
				'videopress',
1502
				'akismet',
1503
				'vaultpress',
1504
				'seo-tools',
1505
				'google-analytics',
1506
				'wordads',
1507
				'search',
1508
			);
1509
			$plan['class'] = 'business';
1510
		}
1511
1512
		// Make sure we have an array here in the event database data is stale
1513
		if ( ! isset( $plan['supports'] ) ) {
1514
			$plan['supports'] = array();
1515
		}
1516
1517
		return $plan;
1518
	}
1519
1520
	/**
1521
	 * Determine whether the active plan supports a particular feature
1522
	 *
1523
	 * @uses Jetpack::get_active_plan()
1524
	 *
1525
	 * @access public
1526
	 * @static
1527
	 *
1528
	 * @return bool True if plan supports feature, false if not
1529
	 */
1530
	public static function active_plan_supports( $feature ) {
1531
		$plan = Jetpack::get_active_plan();
1532
1533
		if ( in_array( $feature, $plan['supports'] ) ) {
1534
			return true;
1535
		}
1536
1537
		return false;
1538
	}
1539
1540
	/**
1541
	 * Is Jetpack in development (offline) mode?
1542
	 */
1543
	public static function is_development_mode() {
1544
		$development_mode = false;
1545
1546
		if ( defined( 'JETPACK_DEV_DEBUG' ) ) {
1547
			$development_mode = JETPACK_DEV_DEBUG;
1548
		} elseif ( $site_url = site_url() ) {
1549
			$development_mode = false === strpos( $site_url, '.' );
1550
		}
1551
1552
		/**
1553
		 * Filters Jetpack's development mode.
1554
		 *
1555
		 * @see https://jetpack.com/support/development-mode/
1556
		 *
1557
		 * @since 2.2.1
1558
		 *
1559
		 * @param bool $development_mode Is Jetpack's development mode active.
1560
		 */
1561
		return apply_filters( 'jetpack_development_mode', $development_mode );
1562
	}
1563
1564
	/**
1565
	 * Whether the site is currently onboarding or not.
1566
	 * A site is considered as being onboarded if it currently has an onboarding token.
1567
	 *
1568
	 * @since 5.8
1569
	 *
1570
	 * @access public
1571
	 * @static
1572
	 *
1573
	 * @return bool True if the site is currently onboarding, false otherwise
1574
	 */
1575
	public static function is_onboarding() {
1576
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1577
	}
1578
1579
	/**
1580
	* Get Jetpack development mode notice text and notice class.
1581
	*
1582
	* Mirrors the checks made in Jetpack::is_development_mode
1583
	*
1584
	*/
1585
	public static function show_development_mode_notice() {
1586
		if ( Jetpack::is_development_mode() ) {
1587
			if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1588
				$notice = sprintf(
1589
					/* translators: %s is a URL */
1590
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the JETPACK_DEV_DEBUG constant being defined in wp-config.php or elsewhere.', 'jetpack' ),
1591
					'https://jetpack.com/support/development-mode/'
1592
				);
1593
			} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1594
				$notice = sprintf(
1595
					/* translators: %s is a URL */
1596
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via site URL lacking a dot (e.g. http://localhost).', 'jetpack' ),
1597
					'https://jetpack.com/support/development-mode/'
1598
				);
1599
			} else {
1600
				$notice = sprintf(
1601
					/* translators: %s is a URL */
1602
					__( 'In <a href="%s" target="_blank">Development Mode</a>, via the jetpack_development_mode filter.', 'jetpack' ),
1603
					'https://jetpack.com/support/development-mode/'
1604
				);
1605
			}
1606
1607
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1608
		}
1609
1610
		// Throw up a notice if using a development version and as for feedback.
1611
		if ( Jetpack::is_development_version() ) {
1612
			/* translators: %s is a URL */
1613
			$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/' );
1614
1615
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1616
		}
1617
		// Throw up a notice if using staging mode
1618
		if ( Jetpack::is_staging_site() ) {
1619
			/* translators: %s is a URL */
1620
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1621
1622
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1623
		}
1624
	}
1625
1626
	/**
1627
	 * Whether Jetpack's version maps to a public release, or a development version.
1628
	 */
1629
	public static function is_development_version() {
1630
		/**
1631
		 * Allows filtering whether this is a development version of Jetpack.
1632
		 *
1633
		 * This filter is especially useful for tests.
1634
		 *
1635
		 * @since 4.3.0
1636
		 *
1637
		 * @param bool $development_version Is this a develoment version of Jetpack?
1638
		 */
1639
		return (bool) apply_filters(
1640
			'jetpack_development_version',
1641
			! preg_match( '/^\d+(\.\d+)+$/', Jetpack_Constants::get_constant( 'JETPACK__VERSION' ) )
1642
		);
1643
	}
1644
1645
	/**
1646
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1647
	 */
1648
	public static function is_user_connected( $user_id = false ) {
1649
		$user_id = false === $user_id ? get_current_user_id() : absint( $user_id );
1650
		if ( ! $user_id ) {
1651
			return false;
1652
		}
1653
1654
		return (bool) Jetpack_Data::get_access_token( $user_id );
1655
	}
1656
1657
	/**
1658
	 * Get the wpcom user data of the current|specified connected user.
1659
	 */
1660
	public static function get_connected_user_data( $user_id = null ) {
1661
		if ( ! $user_id ) {
1662
			$user_id = get_current_user_id();
1663
		}
1664
1665
		$transient_key = "jetpack_connected_user_data_$user_id";
1666
1667
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1668
			return $cached_user_data;
1669
		}
1670
1671
		Jetpack::load_xml_rpc_client();
1672
		$xml = new Jetpack_IXR_Client( array(
1673
			'user_id' => $user_id,
1674
		) );
1675
		$xml->query( 'wpcom.getUser' );
1676
		if ( ! $xml->isError() ) {
1677
			$user_data = $xml->getResponse();
1678
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1679
			return $user_data;
1680
		}
1681
1682
		return false;
1683
	}
1684
1685
	/**
1686
	 * Get the wpcom email of the current|specified connected user.
1687
	 */
1688 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1689
		if ( ! $user_id ) {
1690
			$user_id = get_current_user_id();
1691
		}
1692
		Jetpack::load_xml_rpc_client();
1693
		$xml = new Jetpack_IXR_Client( array(
1694
			'user_id' => $user_id,
1695
		) );
1696
		$xml->query( 'wpcom.getUserEmail' );
1697
		if ( ! $xml->isError() ) {
1698
			return $xml->getResponse();
1699
		}
1700
		return false;
1701
	}
1702
1703
	/**
1704
	 * Get the wpcom email of the master user.
1705
	 */
1706
	public static function get_master_user_email() {
1707
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1708
		if ( $master_user_id ) {
1709
			return self::get_connected_user_email( $master_user_id );
1710
		}
1711
		return '';
1712
	}
1713
1714
	function current_user_is_connection_owner() {
1715
		$user_token = Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1716
		return $user_token && is_object( $user_token ) && isset( $user_token->external_user_id ) && get_current_user_id() === $user_token->external_user_id;
1717
	}
1718
1719
	/**
1720
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1721
	 */
1722
	function extra_oembed_providers() {
1723
		// Cloudup: https://dev.cloudup.com/#oembed
1724
		wp_oembed_add_provider( 'https://cloudup.com/*' , 'https://cloudup.com/oembed' );
1725
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1726
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1727
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1728
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1729
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1730
	}
1731
1732
	/**
1733
	 * Synchronize connected user role changes
1734
	 */
1735
	function user_role_change( $user_id ) {
1736
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Jetpack_Sync_Users::user_role_change()' );
1737
		Jetpack_Sync_Users::user_role_change( $user_id );
1738
	}
1739
1740
	/**
1741
	 * Loads the currently active modules.
1742
	 */
1743
	public static function load_modules() {
1744
		if (
1745
			! self::is_active()
1746
			&& ! self::is_development_mode()
1747
			&& (
1748
				! is_multisite()
1749
				|| ! get_site_option( 'jetpack_protect_active' )
1750
			)
1751
		) {
1752
			return;
1753
		}
1754
1755
		$version = Jetpack_Options::get_option( 'version' );
1756 View Code Duplication
		if ( ! $version ) {
1757
			$version = $old_version = JETPACK__VERSION . ':' . time();
1758
			/** This action is documented in class.jetpack.php */
1759
			do_action( 'updating_jetpack_version', $version, false );
1760
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1761
		}
1762
		list( $version ) = explode( ':', $version );
1763
1764
		$modules = array_filter( Jetpack::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1765
1766
		$modules_data = array();
1767
1768
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1769
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1770
			$updated_modules = array();
1771
			foreach ( $modules as $module ) {
1772
				$modules_data[ $module ] = Jetpack::get_module( $module );
1773
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1774
					continue;
1775
				}
1776
1777
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1778
					continue;
1779
				}
1780
1781
				$updated_modules[] = $module;
1782
			}
1783
1784
			$modules = array_diff( $modules, $updated_modules );
1785
		}
1786
1787
		$is_development_mode = Jetpack::is_development_mode();
1788
1789
		foreach ( $modules as $index => $module ) {
1790
			// If we're in dev mode, disable modules requiring a connection
1791
			if ( $is_development_mode ) {
1792
				// Prime the pump if we need to
1793
				if ( empty( $modules_data[ $module ] ) ) {
1794
					$modules_data[ $module ] = Jetpack::get_module( $module );
1795
				}
1796
				// If the module requires a connection, but we're in local mode, don't include it.
1797
				if ( $modules_data[ $module ]['requires_connection'] ) {
1798
					continue;
1799
				}
1800
			}
1801
1802
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1803
				continue;
1804
			}
1805
1806
			if ( ! include_once( Jetpack::get_module_path( $module ) ) ) {
1807
				unset( $modules[ $index ] );
1808
				self::update_active_modules( array_values( $modules ) );
1809
				continue;
1810
			}
1811
1812
			/**
1813
			 * Fires when a specific module is loaded.
1814
			 * The dynamic part of the hook, $module, is the module slug.
1815
			 *
1816
			 * @since 1.1.0
1817
			 */
1818
			do_action( 'jetpack_module_loaded_' . $module );
1819
		}
1820
1821
		/**
1822
		 * Fires when all the modules are loaded.
1823
		 *
1824
		 * @since 1.1.0
1825
		 */
1826
		do_action( 'jetpack_modules_loaded' );
1827
1828
		// 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.
1829
		require_once( JETPACK__PLUGIN_DIR . 'modules/module-extras.php' );
1830
	}
1831
1832
	/**
1833
	 * Check if Jetpack's REST API compat file should be included
1834
	 * @action plugins_loaded
1835
	 * @return null
1836
	 */
1837
	public function check_rest_api_compat() {
1838
		/**
1839
		 * Filters the list of REST API compat files to be included.
1840
		 *
1841
		 * @since 2.2.5
1842
		 *
1843
		 * @param array $args Array of REST API compat files to include.
1844
		 */
1845
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1846
1847
		if ( function_exists( 'bbpress' ) )
1848
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1849
1850
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include )
1851
			require_once $_jetpack_rest_api_compat_include;
1852
	}
1853
1854
	/**
1855
	 * Gets all plugins currently active in values, regardless of whether they're
1856
	 * traditionally activated or network activated.
1857
	 *
1858
	 * @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...
1859
	 */
1860
	public static function get_active_plugins() {
1861
		$active_plugins = (array) get_option( 'active_plugins', array() );
1862
1863
		if ( is_multisite() ) {
1864
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1865
			// whereas active_plugins stores them in the values.
1866
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1867
			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...
1868
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1869
			}
1870
		}
1871
1872
		sort( $active_plugins );
1873
1874
		return array_unique( $active_plugins );
1875
	}
1876
1877
	/**
1878
	 * Gets and parses additional plugin data to send with the heartbeat data
1879
	 *
1880
	 * @since 3.8.1
1881
	 *
1882
	 * @return array Array of plugin data
1883
	 */
1884
	public static function get_parsed_plugin_data() {
1885
		if ( ! function_exists( 'get_plugins' ) ) {
1886
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
1887
		}
1888
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1889
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1890
		$active_plugins = Jetpack::get_active_plugins();
1891
1892
		$plugins = array();
1893
		foreach ( $all_plugins as $path => $plugin_data ) {
1894
			$plugins[ $path ] = array(
1895
					'is_active' => in_array( $path, $active_plugins ),
1896
					'file'      => $path,
1897
					'name'      => $plugin_data['Name'],
1898
					'version'   => $plugin_data['Version'],
1899
					'author'    => $plugin_data['Author'],
1900
			);
1901
		}
1902
1903
		return $plugins;
1904
	}
1905
1906
	/**
1907
	 * Gets and parses theme data to send with the heartbeat data
1908
	 *
1909
	 * @since 3.8.1
1910
	 *
1911
	 * @return array Array of theme data
1912
	 */
1913
	public static function get_parsed_theme_data() {
1914
		$all_themes = wp_get_themes( array( 'allowed' => true ) );
1915
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1916
1917
		$themes = array();
1918
		foreach ( $all_themes as $slug => $theme_data ) {
1919
			$theme_headers = array();
1920
			foreach ( $header_keys as $header_key ) {
1921
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
1922
			}
1923
1924
			$themes[ $slug ] = array(
1925
					'is_active_theme' => $slug == wp_get_theme()->get_template(),
1926
					'slug' => $slug,
1927
					'theme_root' => $theme_data->get_theme_root_uri(),
1928
					'parent' => $theme_data->parent(),
1929
					'headers' => $theme_headers
1930
			);
1931
		}
1932
1933
		return $themes;
1934
	}
1935
1936
	/**
1937
	 * Checks whether a specific plugin is active.
1938
	 *
1939
	 * We don't want to store these in a static variable, in case
1940
	 * there are switch_to_blog() calls involved.
1941
	 */
1942
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
1943
		return in_array( $plugin, self::get_active_plugins() );
1944
	}
1945
1946
	/**
1947
	 * Check if Jetpack's Open Graph tags should be used.
1948
	 * If certain plugins are active, Jetpack's og tags are suppressed.
1949
	 *
1950
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1951
	 * @action plugins_loaded
1952
	 * @return null
1953
	 */
1954
	public function check_open_graph() {
1955
		if ( in_array( 'publicize', Jetpack::get_active_modules() ) || in_array( 'sharedaddy', Jetpack::get_active_modules() ) ) {
1956
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
1957
		}
1958
1959
		$active_plugins = self::get_active_plugins();
1960
1961
		if ( ! empty( $active_plugins ) ) {
1962
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
1963
				if ( in_array( $plugin, $active_plugins ) ) {
1964
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
1965
					break;
1966
				}
1967
			}
1968
		}
1969
1970
		/**
1971
		 * Allow the addition of Open Graph Meta Tags to all pages.
1972
		 *
1973
		 * @since 2.0.3
1974
		 *
1975
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
1976
		 */
1977
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
1978
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
1979
		}
1980
	}
1981
1982
	/**
1983
	 * Check if Jetpack's Twitter tags should be used.
1984
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
1985
	 *
1986
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
1987
	 * @action plugins_loaded
1988
	 * @return null
1989
	 */
1990
	public function check_twitter_tags() {
1991
1992
		$active_plugins = self::get_active_plugins();
1993
1994
		if ( ! empty( $active_plugins ) ) {
1995
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
1996
				if ( in_array( $plugin, $active_plugins ) ) {
1997
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
1998
					break;
1999
				}
2000
			}
2001
		}
2002
2003
		/**
2004
		 * Allow Twitter Card Meta tags to be disabled.
2005
		 *
2006
		 * @since 2.6.0
2007
		 *
2008
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2009
		 */
2010
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2011
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2012
		}
2013
	}
2014
2015
	/**
2016
	 * Allows plugins to submit security reports.
2017
 	 *
2018
	 * @param string  $type         Report type (login_form, backup, file_scanning, spam)
2019
	 * @param string  $plugin_file  Plugin __FILE__, so that we can pull plugin data
2020
	 * @param array   $args         See definitions above
2021
	 */
2022
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2023
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2024
	}
2025
2026
/* Jetpack Options API */
2027
2028
	public static function get_option_names( $type = 'compact' ) {
2029
		return Jetpack_Options::get_option_names( $type );
2030
	}
2031
2032
	/**
2033
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2034
 	 *
2035
	 * @param string $name    Option name
2036
	 * @param mixed  $default (optional)
2037
	 */
2038
	public static function get_option( $name, $default = false ) {
2039
		return Jetpack_Options::get_option( $name, $default );
2040
	}
2041
2042
	/**
2043
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2044
 	 *
2045
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2046
	 * @param string $name  Option name
2047
	 * @param mixed  $value Option value
2048
	 */
2049
	public static function update_option( $name, $value ) {
2050
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2051
		return Jetpack_Options::update_option( $name, $value );
2052
	}
2053
2054
	/**
2055
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2056
 	 *
2057
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2058
	 * @param array $array array( option name => option value, ... )
2059
	 */
2060
	public static function update_options( $array ) {
2061
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2062
		return Jetpack_Options::update_options( $array );
2063
	}
2064
2065
	/**
2066
	 * Deletes the given option.  May be passed multiple option names as an array.
2067
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2068
	 *
2069
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2070
	 * @param string|array $names
2071
	 */
2072
	public static function delete_option( $names ) {
2073
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2074
		return Jetpack_Options::delete_option( $names );
2075
	}
2076
2077
	/**
2078
	 * Enters a user token into the user_tokens option
2079
	 *
2080
	 * @param int $user_id
2081
	 * @param string $token
2082
	 * return bool
2083
	 */
2084
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2085
		// not designed for concurrent updates
2086
		$user_tokens = Jetpack_Options::get_option( 'user_tokens' );
2087
		if ( ! is_array( $user_tokens ) )
2088
			$user_tokens = array();
2089
		$user_tokens[$user_id] = $token;
2090
		if ( $is_master_user ) {
2091
			$master_user = $user_id;
2092
			$options     = compact( 'user_tokens', 'master_user' );
2093
		} else {
2094
			$options = compact( 'user_tokens' );
2095
		}
2096
		return Jetpack_Options::update_options( $options );
2097
	}
2098
2099
	/**
2100
	 * Returns an array of all PHP files in the specified absolute path.
2101
	 * Equivalent to glob( "$absolute_path/*.php" ).
2102
	 *
2103
	 * @param string $absolute_path The absolute path of the directory to search.
2104
	 * @return array Array of absolute paths to the PHP files.
2105
	 */
2106
	public static function glob_php( $absolute_path ) {
2107
		if ( function_exists( 'glob' ) ) {
2108
			return glob( "$absolute_path/*.php" );
2109
		}
2110
2111
		$absolute_path = untrailingslashit( $absolute_path );
2112
		$files = array();
2113
		if ( ! $dir = @opendir( $absolute_path ) ) {
2114
			return $files;
2115
		}
2116
2117
		while ( false !== $file = readdir( $dir ) ) {
2118
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2119
				continue;
2120
			}
2121
2122
			$file = "$absolute_path/$file";
2123
2124
			if ( ! is_file( $file ) ) {
2125
				continue;
2126
			}
2127
2128
			$files[] = $file;
2129
		}
2130
2131
		closedir( $dir );
2132
2133
		return $files;
2134
	}
2135
2136
	public static function activate_new_modules( $redirect = false ) {
2137
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
2138
			return;
2139
		}
2140
2141
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2142 View Code Duplication
		if ( ! $jetpack_old_version ) {
2143
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2144
			/** This action is documented in class.jetpack.php */
2145
			do_action( 'updating_jetpack_version', $version, false );
2146
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2147
		}
2148
2149
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2150
2151
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2152
			return;
2153
		}
2154
2155
		$active_modules     = Jetpack::get_active_modules();
2156
		$reactivate_modules = array();
2157
		foreach ( $active_modules as $active_module ) {
2158
			$module = Jetpack::get_module( $active_module );
2159
			if ( ! isset( $module['changed'] ) ) {
2160
				continue;
2161
			}
2162
2163
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2164
				continue;
2165
			}
2166
2167
			$reactivate_modules[] = $active_module;
2168
			Jetpack::deactivate_module( $active_module );
2169
		}
2170
2171
		$new_version = JETPACK__VERSION . ':' . time();
2172
		/** This action is documented in class.jetpack.php */
2173
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2174
		Jetpack_Options::update_options(
2175
			array(
2176
				'version'     => $new_version,
2177
				'old_version' => $jetpack_old_version,
2178
			)
2179
		);
2180
2181
		Jetpack::state( 'message', 'modules_activated' );
2182
		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...
2183
2184
		if ( $redirect ) {
2185
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2186
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2187
				$page = $_GET['page'];
2188
			}
2189
2190
			wp_safe_redirect( Jetpack::admin_url( 'page=' . $page ) );
2191
			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...
2192
		}
2193
	}
2194
2195
	/**
2196
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2197
	 * Make sure to tuck away module "library" files in a sub-directory.
2198
	 */
2199
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2200
		static $modules = null;
2201
2202
		if ( ! isset( $modules ) ) {
2203
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2204
			// Use the cache if we're on the front-end and it's available...
2205
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2206
				$modules = $available_modules_option[ JETPACK__VERSION ];
2207
			} else {
2208
				$files = Jetpack::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2209
2210
				$modules = array();
2211
2212
				foreach ( $files as $file ) {
2213
					if ( ! $headers = Jetpack::get_module( $file ) ) {
2214
						continue;
2215
					}
2216
2217
					$modules[ Jetpack::get_module_slug( $file ) ] = $headers['introduced'];
2218
				}
2219
2220
				Jetpack_Options::update_option( 'available_modules', array(
2221
					JETPACK__VERSION => $modules,
2222
				) );
2223
			}
2224
		}
2225
2226
		/**
2227
		 * Filters the array of modules available to be activated.
2228
		 *
2229
		 * @since 2.4.0
2230
		 *
2231
		 * @param array $modules Array of available modules.
2232
		 * @param string $min_version Minimum version number required to use modules.
2233
		 * @param string $max_version Maximum version number required to use modules.
2234
		 */
2235
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2236
2237
		if ( ! $min_version && ! $max_version ) {
2238
			return array_keys( $mods );
2239
		}
2240
2241
		$r = array();
2242
		foreach ( $mods as $slug => $introduced ) {
2243
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2244
				continue;
2245
			}
2246
2247
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2248
				continue;
2249
			}
2250
2251
			$r[] = $slug;
2252
		}
2253
2254
		return $r;
2255
	}
2256
2257
	/**
2258
	 * Default modules loaded on activation.
2259
	 */
2260
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2261
		$return = array();
2262
2263
		foreach ( Jetpack::get_available_modules( $min_version, $max_version ) as $module ) {
2264
			$module_data = Jetpack::get_module( $module );
2265
2266
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2267
				case 'yes' :
2268
					$return[] = $module;
2269
					break;
2270
				case 'public' :
2271
					if ( Jetpack_Options::get_option( 'public' ) ) {
2272
						$return[] = $module;
2273
					}
2274
					break;
2275
				case 'no' :
2276
				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...
2277
					break;
2278
			}
2279
		}
2280
		/**
2281
		 * Filters the array of default modules.
2282
		 *
2283
		 * @since 2.5.0
2284
		 *
2285
		 * @param array $return Array of default modules.
2286
		 * @param string $min_version Minimum version number required to use modules.
2287
		 * @param string $max_version Maximum version number required to use modules.
2288
		 */
2289
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2290
	}
2291
2292
	/**
2293
	 * Checks activated modules during auto-activation to determine
2294
	 * if any of those modules are being deprecated.  If so, close
2295
	 * them out, and add any replacement modules.
2296
	 *
2297
	 * Runs at priority 99 by default.
2298
	 *
2299
	 * This is run late, so that it can still activate a module if
2300
	 * the new module is a replacement for another that the user
2301
	 * currently has active, even if something at the normal priority
2302
	 * would kibosh everything.
2303
	 *
2304
	 * @since 2.6
2305
	 * @uses jetpack_get_default_modules filter
2306
	 * @param array $modules
2307
	 * @return array
2308
	 */
2309
	function handle_deprecated_modules( $modules ) {
2310
		$deprecated_modules = array(
2311
			'debug'            => null,  // Closed out and moved to ./class.jetpack-debugger.php
2312
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2313
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2314
		);
2315
2316
		// Don't activate SSO if they never completed activating WPCC.
2317
		if ( Jetpack::is_module_active( 'wpcc' ) ) {
2318
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2319
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2320
				$deprecated_modules['wpcc'] = null;
2321
			}
2322
		}
2323
2324
		foreach ( $deprecated_modules as $module => $replacement ) {
2325
			if ( Jetpack::is_module_active( $module ) ) {
2326
				self::deactivate_module( $module );
2327
				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...
2328
					$modules[] = $replacement;
2329
				}
2330
			}
2331
		}
2332
2333
		return array_unique( $modules );
2334
	}
2335
2336
	/**
2337
	 * Checks activated plugins during auto-activation to determine
2338
	 * if any of those plugins are in the list with a corresponding module
2339
	 * that is not compatible with the plugin. The module will not be allowed
2340
	 * to auto-activate.
2341
	 *
2342
	 * @since 2.6
2343
	 * @uses jetpack_get_default_modules filter
2344
	 * @param array $modules
2345
	 * @return array
2346
	 */
2347
	function filter_default_modules( $modules ) {
2348
2349
		$active_plugins = self::get_active_plugins();
2350
2351
		if ( ! empty( $active_plugins ) ) {
2352
2353
			// For each module we'd like to auto-activate...
2354
			foreach ( $modules as $key => $module ) {
2355
				// If there are potential conflicts for it...
2356
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2357
					// For each potential conflict...
2358
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2359
						// If that conflicting plugin is active...
2360
						if ( in_array( $plugin, $active_plugins ) ) {
2361
							// Remove that item from being auto-activated.
2362
							unset( $modules[ $key ] );
2363
						}
2364
					}
2365
				}
2366
			}
2367
		}
2368
2369
		return $modules;
2370
	}
2371
2372
	/**
2373
	 * Extract a module's slug from its full path.
2374
	 */
2375
	public static function get_module_slug( $file ) {
2376
		return str_replace( '.php', '', basename( $file ) );
2377
	}
2378
2379
	/**
2380
	 * Generate a module's path from its slug.
2381
	 */
2382
	public static function get_module_path( $slug ) {
2383
		return JETPACK__PLUGIN_DIR . "modules/$slug.php";
2384
	}
2385
2386
	/**
2387
	 * Load module data from module file. Headers differ from WordPress
2388
	 * plugin headers to avoid them being identified as standalone
2389
	 * plugins on the WordPress plugins page.
2390
	 */
2391
	public static function get_module( $module ) {
2392
		$headers = array(
2393
			'name'                      => 'Module Name',
2394
			'description'               => 'Module Description',
2395
			'jumpstart_desc'            => 'Jumpstart Description',
2396
			'sort'                      => 'Sort Order',
2397
			'recommendation_order'      => 'Recommendation Order',
2398
			'introduced'                => 'First Introduced',
2399
			'changed'                   => 'Major Changes In',
2400
			'deactivate'                => 'Deactivate',
2401
			'free'                      => 'Free',
2402
			'requires_connection'       => 'Requires Connection',
2403
			'auto_activate'             => 'Auto Activate',
2404
			'module_tags'               => 'Module Tags',
2405
			'feature'                   => 'Feature',
2406
			'additional_search_queries' => 'Additional Search Queries',
2407
		);
2408
2409
		$file = Jetpack::get_module_path( Jetpack::get_module_slug( $module ) );
2410
2411
		$mod = Jetpack::get_file_data( $file, $headers );
2412
		if ( empty( $mod['name'] ) ) {
2413
			return false;
2414
		}
2415
2416
		$mod['sort']                    = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2417
		$mod['recommendation_order']    = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2418
		$mod['deactivate']              = empty( $mod['deactivate'] );
2419
		$mod['free']                    = empty( $mod['free'] );
2420
		$mod['requires_connection']     = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2421
2422
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2423
			$mod['auto_activate'] = 'No';
2424
		} else {
2425
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2426
		}
2427
2428
		if ( $mod['module_tags'] ) {
2429
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2430
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2431
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2432
		} else {
2433
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2434
		}
2435
2436
		if ( $mod['feature'] ) {
2437
			$mod['feature'] = explode( ',', $mod['feature'] );
2438
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2439
		} else {
2440
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2441
		}
2442
2443
		/**
2444
		 * Filters the feature array on a module.
2445
		 *
2446
		 * This filter allows you to control where each module is filtered: Recommended,
2447
		 * Jumpstart, and the default "Other" listing.
2448
		 *
2449
		 * @since 3.5.0
2450
		 *
2451
		 * @param array   $mod['feature'] The areas to feature this module:
2452
		 *     'Jumpstart' adds to the "Jumpstart" option to activate many modules at once.
2453
		 *     'Recommended' shows on the main Jetpack admin screen.
2454
		 *     'Other' should be the default if no other value is in the array.
2455
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2456
		 * @param array   $mod All the currently assembled module data.
2457
		 */
2458
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2459
2460
		/**
2461
		 * Filter the returned data about a module.
2462
		 *
2463
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2464
		 * so please be careful.
2465
		 *
2466
		 * @since 3.6.0
2467
		 *
2468
		 * @param array   $mod    The details of the requested module.
2469
		 * @param string  $module The slug of the module, e.g. sharedaddy
2470
		 * @param string  $file   The path to the module source file.
2471
		 */
2472
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2473
	}
2474
2475
	/**
2476
	 * Like core's get_file_data implementation, but caches the result.
2477
	 */
2478
	public static function get_file_data( $file, $headers ) {
2479
		//Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2480
		$file_name = basename( $file );
2481
2482
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2483
2484
		$file_data_option = get_transient( $cache_key );
2485
2486
		if ( false === $file_data_option ) {
2487
			$file_data_option = array();
2488
		}
2489
2490
		$key           = md5( $file_name . serialize( $headers ) );
2491
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2492
2493
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2494
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2495
			return $file_data_option[ $key ];
2496
		}
2497
2498
		$data = get_file_data( $file, $headers );
2499
2500
		$file_data_option[ $key ] = $data;
2501
2502
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2503
2504
		return $data;
2505
	}
2506
2507
2508
	/**
2509
	 * Return translated module tag.
2510
	 *
2511
	 * @param string $tag Tag as it appears in each module heading.
2512
	 *
2513
	 * @return mixed
2514
	 */
2515
	public static function translate_module_tag( $tag ) {
2516
		return jetpack_get_module_i18n_tag( $tag );
2517
	}
2518
2519
	/**
2520
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2521
	 *
2522
	 * @since 3.9.2
2523
	 *
2524
	 * @param array $modules
2525
	 *
2526
	 * @return string|void
2527
	 */
2528
	public static function get_translated_modules( $modules ) {
2529
		foreach ( $modules as $index => $module ) {
2530
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2531
			if ( isset( $module['name'] ) ) {
2532
				$modules[ $index ]['name'] = $i18n_module['name'];
2533
			}
2534
			if ( isset( $module['description'] ) ) {
2535
				$modules[ $index ]['description'] = $i18n_module['description'];
2536
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2537
			}
2538
		}
2539
		return $modules;
2540
	}
2541
2542
	/**
2543
	 * Get a list of activated modules as an array of module slugs.
2544
	 */
2545
	public static function get_active_modules() {
2546
		$active = Jetpack_Options::get_option( 'active_modules' );
2547
2548
		if ( ! is_array( $active ) ) {
2549
			$active = array();
2550
		}
2551
2552
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2553
			$active[] = 'vaultpress';
2554
		} else {
2555
			$active = array_diff( $active, array( 'vaultpress' ) );
2556
		}
2557
2558
		//If protect is active on the main site of a multisite, it should be active on all sites.
2559
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2560
			$active[] = 'protect';
2561
		}
2562
2563
		return array_unique( $active );
2564
	}
2565
2566
	/**
2567
	 * Check whether or not a Jetpack module is active.
2568
	 *
2569
	 * @param string $module The slug of a Jetpack module.
2570
	 * @return bool
2571
	 *
2572
	 * @static
2573
	 */
2574
	public static function is_module_active( $module ) {
2575
		return in_array( $module, self::get_active_modules() );
2576
	}
2577
2578
	public static function is_module( $module ) {
2579
		return ! empty( $module ) && ! validate_file( $module, Jetpack::get_available_modules() );
2580
	}
2581
2582
	/**
2583
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2584
	 *
2585
	 * @param bool $catch True to start catching, False to stop.
2586
	 *
2587
	 * @static
2588
	 */
2589
	public static function catch_errors( $catch ) {
2590
		static $display_errors, $error_reporting;
2591
2592
		if ( $catch ) {
2593
			$display_errors  = @ini_set( 'display_errors', 1 );
2594
			$error_reporting = @error_reporting( E_ALL );
2595
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2596
		} else {
2597
			@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...
2598
			@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...
2599
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2600
		}
2601
	}
2602
2603
	/**
2604
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2605
	 */
2606
	public static function catch_errors_on_shutdown() {
2607
		Jetpack::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2608
	}
2609
2610
	/**
2611
	 * Rewrite any string to make paths easier to read.
2612
	 *
2613
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2614
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2615
	 *
2616
	 * @param $string
2617
	 * @return mixed
2618
	 */
2619
	public static function alias_directories( $string ) {
2620
		// ABSPATH has a trailing slash.
2621
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2622
		// WP_CONTENT_DIR does not have a trailing slash.
2623
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2624
2625
		return $string;
2626
	}
2627
2628
	public static function activate_default_modules(
2629
		$min_version = false,
2630
		$max_version = false,
2631
		$other_modules = array(),
2632
		$redirect = true,
2633
		$send_state_messages = true
2634
	) {
2635
		$jetpack = Jetpack::init();
2636
2637
		$modules = Jetpack::get_default_modules( $min_version, $max_version );
2638
		$modules = array_merge( $other_modules, $modules );
2639
2640
		// Look for standalone plugins and disable if active.
2641
2642
		$to_deactivate = array();
2643
		foreach ( $modules as $module ) {
2644
			if ( isset( $jetpack->plugins_to_deactivate[$module] ) ) {
2645
				$to_deactivate[$module] = $jetpack->plugins_to_deactivate[$module];
2646
			}
2647
		}
2648
2649
		$deactivated = array();
2650
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2651
			list( $probable_file, $probable_title ) = $deactivate_me;
2652
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2653
				$deactivated[] = $module;
2654
			}
2655
		}
2656
2657
		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...
2658
			Jetpack::state( 'deactivated_plugins', join( ',', $deactivated ) );
2659
2660
			$url = add_query_arg(
2661
				array(
2662
					'action'   => 'activate_default_modules',
2663
					'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2664
				),
2665
				add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), Jetpack::admin_url( 'page=jetpack' ) )
2666
			);
2667
			wp_safe_redirect( $url );
2668
			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...
2669
		}
2670
2671
		/**
2672
		 * Fires before default modules are activated.
2673
		 *
2674
		 * @since 1.9.0
2675
		 *
2676
		 * @param string $min_version Minimum version number required to use modules.
2677
		 * @param string $max_version Maximum version number required to use modules.
2678
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2679
		 */
2680
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2681
2682
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2683
		Jetpack::restate();
2684
		Jetpack::catch_errors( true );
2685
2686
		$active = Jetpack::get_active_modules();
2687
2688
		foreach ( $modules as $module ) {
2689
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2690
				$active[] = $module;
2691
				self::update_active_modules( $active );
2692
				continue;
2693
			}
2694
2695
			if ( $send_state_messages && in_array( $module, $active ) ) {
2696
				$module_info = Jetpack::get_module( $module );
2697 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2698
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2699
					if ( $active_state = Jetpack::state( $state ) ) {
2700
						$active_state = explode( ',', $active_state );
2701
					} else {
2702
						$active_state = array();
2703
					}
2704
					$active_state[] = $module;
2705
					Jetpack::state( $state, implode( ',', $active_state ) );
2706
				}
2707
				continue;
2708
			}
2709
2710
			$file = Jetpack::get_module_path( $module );
2711
			if ( ! file_exists( $file ) ) {
2712
				continue;
2713
			}
2714
2715
			// we'll override this later if the plugin can be included without fatal error
2716
			if ( $redirect ) {
2717
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2718
			}
2719
2720
			if ( $send_state_messages ) {
2721
				Jetpack::state( 'error', 'module_activation_failed' );
2722
				Jetpack::state( 'module', $module );
2723
			}
2724
2725
			ob_start();
2726
			require $file;
2727
2728
			$active[] = $module;
2729
2730 View Code Duplication
			if ( $send_state_messages ) {
2731
2732
				$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...
2733
				if ( $active_state = Jetpack::state( $state ) ) {
2734
					$active_state = explode( ',', $active_state );
2735
				} else {
2736
					$active_state = array();
2737
				}
2738
				$active_state[] = $module;
2739
				Jetpack::state( $state, implode( ',', $active_state ) );
2740
			}
2741
2742
			Jetpack::update_active_modules( $active );
2743
2744
			ob_end_clean();
2745
		}
2746
2747
		if ( $send_state_messages ) {
2748
			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...
2749
			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...
2750
		}
2751
2752
		Jetpack::catch_errors( false );
2753
		/**
2754
		 * Fires when default modules are activated.
2755
		 *
2756
		 * @since 1.9.0
2757
		 *
2758
		 * @param string $min_version Minimum version number required to use modules.
2759
		 * @param string $max_version Maximum version number required to use modules.
2760
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2761
		 */
2762
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2763
	}
2764
2765
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2766
		/**
2767
		 * Fires before a module is activated.
2768
		 *
2769
		 * @since 2.6.0
2770
		 *
2771
		 * @param string $module Module slug.
2772
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2773
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2774
		 */
2775
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2776
2777
		$jetpack = Jetpack::init();
2778
2779
		if ( ! strlen( $module ) )
2780
			return false;
2781
2782
		if ( ! Jetpack::is_module( $module ) )
2783
			return false;
2784
2785
		// If it's already active, then don't do it again
2786
		$active = Jetpack::get_active_modules();
2787
		foreach ( $active as $act ) {
2788
			if ( $act == $module )
2789
				return true;
2790
		}
2791
2792
		$module_data = Jetpack::get_module( $module );
2793
2794
		if ( ! Jetpack::is_active() ) {
2795
			if ( ! Jetpack::is_development_mode() && ! Jetpack::is_onboarding() )
2796
				return false;
2797
2798
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2799
			if ( Jetpack::is_development_mode() && $module_data['requires_connection'] )
2800
				return false;
2801
		}
2802
2803
		// Check and see if the old plugin is active
2804
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2805
			// Deactivate the old plugin
2806
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
2807
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
2808
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
2809
				Jetpack::state( 'deactivated_plugins', $module );
2810
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
2811
				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...
2812
			}
2813
		}
2814
2815
		// Protect won't work with mis-configured IPs
2816
		if ( 'protect' === $module ) {
2817
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
2818
			if ( ! jetpack_protect_get_ip() ) {
2819
				Jetpack::state( 'message', 'protect_misconfigured_ip' );
2820
				return false;
2821
			}
2822
		}
2823
2824
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
2825
		Jetpack::state( 'module', $module );
2826
		Jetpack::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
2827
2828
		Jetpack::catch_errors( true );
2829
		ob_start();
2830
		require Jetpack::get_module_path( $module );
2831
		/** This action is documented in class.jetpack.php */
2832
		do_action( 'jetpack_activate_module', $module );
2833
		$active[] = $module;
2834
		Jetpack::update_active_modules( $active );
2835
2836
		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...
2837
		ob_end_clean();
2838
		Jetpack::catch_errors( false );
2839
2840
		// A flag for Jump Start so it's not shown again. Only set if it hasn't been yet.
2841 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2842
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2843
2844
			//Jump start is being dismissed send data to MC Stats
2845
			$jetpack->stat( 'jumpstart', 'manual,'.$module );
2846
2847
			$jetpack->do_stats( 'server_side' );
2848
		}
2849
2850
		if ( $redirect ) {
2851
			wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
2852
		}
2853
		if ( $exit ) {
2854
			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...
2855
		}
2856
		return true;
2857
	}
2858
2859
	function activate_module_actions( $module ) {
2860
		_deprecated_function( __METHOD__, 'jeptack-4.2' );
2861
	}
2862
2863
	public static function deactivate_module( $module ) {
2864
		/**
2865
		 * Fires when a module is deactivated.
2866
		 *
2867
		 * @since 1.9.0
2868
		 *
2869
		 * @param string $module Module slug.
2870
		 */
2871
		do_action( 'jetpack_pre_deactivate_module', $module );
2872
2873
		$jetpack = Jetpack::init();
2874
2875
		$active = Jetpack::get_active_modules();
2876
		$new    = array_filter( array_diff( $active, (array) $module ) );
2877
2878
		// A flag for Jump Start so it's not shown again.
2879 View Code Duplication
		if ( 'new_connection' === Jetpack_Options::get_option( 'jumpstart' ) ) {
2880
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
2881
2882
			//Jump start is being dismissed send data to MC Stats
2883
			$jetpack->stat( 'jumpstart', 'manual,deactivated-'.$module );
2884
2885
			$jetpack->do_stats( 'server_side' );
2886
		}
2887
2888
		return self::update_active_modules( $new );
2889
	}
2890
2891
	public static function enable_module_configurable( $module ) {
2892
		$module = Jetpack::get_module_slug( $module );
2893
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
2894
	}
2895
2896
	public static function module_configuration_url( $module ) {
2897
		$module = Jetpack::get_module_slug( $module );
2898
		return Jetpack::admin_url( array( 'page' => 'jetpack', 'configure' => $module ) );
2899
	}
2900
2901
	public static function module_configuration_load( $module, $method ) {
2902
		$module = Jetpack::get_module_slug( $module );
2903
		add_action( 'jetpack_module_configuration_load_' . $module, $method );
2904
	}
2905
2906
	public static function module_configuration_head( $module, $method ) {
2907
		$module = Jetpack::get_module_slug( $module );
2908
		add_action( 'jetpack_module_configuration_head_' . $module, $method );
2909
	}
2910
2911
	public static function module_configuration_screen( $module, $method ) {
2912
		$module = Jetpack::get_module_slug( $module );
2913
		add_action( 'jetpack_module_configuration_screen_' . $module, $method );
2914
	}
2915
2916
	public static function module_configuration_activation_screen( $module, $method ) {
2917
		$module = Jetpack::get_module_slug( $module );
2918
		add_action( 'display_activate_module_setting_' . $module, $method );
2919
	}
2920
2921
/* Installation */
2922
2923
	public static function bail_on_activation( $message, $deactivate = true ) {
2924
?>
2925
<!doctype html>
2926
<html>
2927
<head>
2928
<meta charset="<?php bloginfo( 'charset' ); ?>">
2929
<style>
2930
* {
2931
	text-align: center;
2932
	margin: 0;
2933
	padding: 0;
2934
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
2935
}
2936
p {
2937
	margin-top: 1em;
2938
	font-size: 18px;
2939
}
2940
</style>
2941
<body>
2942
<p><?php echo esc_html( $message ); ?></p>
2943
</body>
2944
</html>
2945
<?php
2946
		if ( $deactivate ) {
2947
			$plugins = get_option( 'active_plugins' );
2948
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
2949
			$update  = false;
2950
			foreach ( $plugins as $i => $plugin ) {
2951
				if ( $plugin === $jetpack ) {
2952
					$plugins[$i] = false;
2953
					$update = true;
2954
				}
2955
			}
2956
2957
			if ( $update ) {
2958
				update_option( 'active_plugins', array_filter( $plugins ) );
2959
			}
2960
		}
2961
		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...
2962
	}
2963
2964
	/**
2965
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
2966
	 * @static
2967
	 */
2968
	public static function plugin_activation( $network_wide ) {
2969
		Jetpack_Options::update_option( 'activated', 1 );
2970
2971
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
2972
			Jetpack::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
2973
		}
2974
2975
		if ( $network_wide )
2976
			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...
2977
2978
		// For firing one-off events (notices) immediately after activation
2979
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
2980
2981
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
2982
2983
		Jetpack::plugin_initialize();
2984
	}
2985
2986
	public static function get_activation_source( $referer_url ) {
2987
2988
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
2989
			return array( 'wp-cli', null );
2990
		}
2991
2992
		$referer = parse_url( $referer_url );
2993
2994
		$source_type = 'unknown';
2995
		$source_query = null;
2996
2997
		if ( ! is_array( $referer ) ) {
2998
			return array( $source_type, $source_query );
2999
		}
3000
3001
		$plugins_path = parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3002
		$plugins_install_path = parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3003
3004
		if ( isset( $referer['query'] ) ) {
3005
			parse_str( $referer['query'], $query_parts );
3006
		} else {
3007
			$query_parts = array();
3008
		}
3009
3010
		if ( $plugins_path === $referer['path'] ) {
3011
			$source_type = 'list';
3012
		} elseif ( $plugins_install_path === $referer['path'] ) {
3013
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3014
			switch( $tab ) {
3015
				case 'popular':
3016
					$source_type = 'popular';
3017
					break;
3018
				case 'recommended':
3019
					$source_type = 'recommended';
3020
					break;
3021
				case 'favorites':
3022
					$source_type = 'favorites';
3023
					break;
3024
				case 'search':
3025
					$source_type = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3026
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3027
					break;
3028
				default:
3029
					$source_type = 'featured';
3030
			}
3031
		}
3032
3033
		return array( $source_type, $source_query );
3034
	}
3035
3036
	/**
3037
	 * Runs before bumping version numbers up to a new version
3038
	 * @param  string $version    Version:timestamp
3039
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3040
	 * @return null              [description]
3041
	 */
3042
	public static function do_version_bump( $version, $old_version ) {
3043
3044
		if ( ! $old_version ) { // For new sites
3045
			// Setting up jetpack manage
3046
			Jetpack::activate_manage();
3047
		}
3048
	}
3049
3050
	/**
3051
	 * Sets the internal version number and activation state.
3052
	 * @static
3053
	 */
3054
	public static function plugin_initialize() {
3055
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3056
			Jetpack_Options::update_option( 'activated', 2 );
3057
		}
3058
3059 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3060
			$version = $old_version = JETPACK__VERSION . ':' . time();
3061
			/** This action is documented in class.jetpack.php */
3062
			do_action( 'updating_jetpack_version', $version, false );
3063
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3064
		}
3065
3066
		Jetpack::load_modules();
3067
3068
		Jetpack_Options::delete_option( 'do_activate' );
3069
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3070
	}
3071
3072
	/**
3073
	 * Removes all connection options
3074
	 * @static
3075
	 */
3076
	public static function plugin_deactivation( ) {
3077
		require_once( ABSPATH . '/wp-admin/includes/plugin.php' );
3078
		if( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3079
			Jetpack_Network::init()->deactivate();
3080
		} else {
3081
			Jetpack::disconnect( false );
3082
			//Jetpack_Heartbeat::init()->deactivate();
3083
		}
3084
	}
3085
3086
	/**
3087
	 * Disconnects from the Jetpack servers.
3088
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3089
	 * @static
3090
	 */
3091
	public static function disconnect( $update_activated_state = true ) {
3092
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3093
		Jetpack::clean_nonces( true );
3094
3095
		// If the site is in an IDC because sync is not allowed,
3096
		// let's make sure to not disconnect the production site.
3097
		if ( ! self::validate_sync_error_idc_option() ) {
3098
			JetpackTracking::record_user_event( 'disconnect_site', array() );
3099
			Jetpack::load_xml_rpc_client();
3100
			$xml = new Jetpack_IXR_Client();
3101
			$xml->query( 'jetpack.deregister' );
3102
		}
3103
3104
		Jetpack_Options::delete_option(
3105
			array(
3106
				'blog_token',
3107
				'user_token',
3108
				'user_tokens',
3109
				'master_user',
3110
				'time_diff',
3111
				'fallback_no_verify_ssl_certs',
3112
			)
3113
		);
3114
3115
		Jetpack_IDC::clear_all_idc_options();
3116
		Jetpack_Options::delete_raw_option( 'jetpack_secrets' );
3117
3118
		if ( $update_activated_state ) {
3119
			Jetpack_Options::update_option( 'activated', 4 );
3120
		}
3121
3122
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3123
			// Check then record unique disconnection if site has never been disconnected previously
3124
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3125
				$jetpack_unique_connection['disconnected'] = 1;
3126
			} else {
3127
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3128
					//track unique disconnect
3129
					$jetpack = Jetpack::init();
3130
3131
					$jetpack->stat( 'connections', 'unique-disconnect' );
3132
					$jetpack->do_stats( 'server_side' );
3133
				}
3134
				// increment number of times disconnected
3135
				$jetpack_unique_connection['disconnected'] += 1;
3136
			}
3137
3138
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3139
		}
3140
3141
		// Delete cached connected user data
3142
		$transient_key = "jetpack_connected_user_data_" . get_current_user_id();
3143
		delete_transient( $transient_key );
3144
3145
		// Delete all the sync related data. Since it could be taking up space.
3146
		require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-sender.php';
3147
		Jetpack_Sync_Sender::get_instance()->uninstall();
3148
3149
		// Disable the Heartbeat cron
3150
		Jetpack_Heartbeat::init()->deactivate();
3151
	}
3152
3153
	/**
3154
	 * Unlinks the current user from the linked WordPress.com user
3155
	 */
3156
	public static function unlink_user( $user_id = null ) {
3157
		if ( ! $tokens = Jetpack_Options::get_option( 'user_tokens' ) )
3158
			return false;
3159
3160
		$user_id = empty( $user_id ) ? get_current_user_id() : intval( $user_id );
3161
3162
		if ( Jetpack_Options::get_option( 'master_user' ) == $user_id )
3163
			return false;
3164
3165
		if ( ! isset( $tokens[ $user_id ] ) )
3166
			return false;
3167
3168
		Jetpack::load_xml_rpc_client();
3169
		$xml = new Jetpack_IXR_Client( compact( 'user_id' ) );
3170
		$xml->query( 'jetpack.unlink_user', $user_id );
3171
3172
		unset( $tokens[ $user_id ] );
3173
3174
		Jetpack_Options::update_option( 'user_tokens', $tokens );
3175
3176
		/**
3177
		 * Fires after the current user has been unlinked from WordPress.com.
3178
		 *
3179
		 * @since 4.1.0
3180
		 *
3181
		 * @param int $user_id The current user's ID.
3182
		 */
3183
		do_action( 'jetpack_unlinked_user', $user_id );
3184
3185
		return true;
3186
	}
3187
3188
	/**
3189
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3190
	 */
3191
	public static function try_registration() {
3192
		// Let's get some testing in beta versions and such.
3193
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3194
			// Before attempting to connect, let's make sure that the domains are viable.
3195
			$domains_to_check = array_unique( array(
3196
				'siteurl' => parse_url( get_site_url(), PHP_URL_HOST ),
3197
				'homeurl' => parse_url( get_home_url(), PHP_URL_HOST ),
3198
			) );
3199
			foreach ( $domains_to_check as $domain ) {
3200
				$result = Jetpack_Data::is_usable_domain( $domain );
3201
				if ( is_wp_error( $result ) ) {
3202
					return $result;
3203
				}
3204
			}
3205
		}
3206
3207
		$result = Jetpack::register();
3208
3209
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3210
		if ( ! $result || is_wp_error( $result ) ) {
3211
			return $result;
3212
		} else {
3213
			return true;
3214
		}
3215
	}
3216
3217
	/**
3218
	 * Tracking an internal event log. Try not to put too much chaff in here.
3219
	 *
3220
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3221
	 */
3222
	public static function log( $code, $data = null ) {
3223
		// only grab the latest 200 entries
3224
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3225
3226
		// Append our event to the log
3227
		$log_entry = array(
3228
			'time'    => time(),
3229
			'user_id' => get_current_user_id(),
3230
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3231
			'code'    => $code,
3232
		);
3233
		// Don't bother storing it unless we've got some.
3234
		if ( ! is_null( $data ) ) {
3235
			$log_entry['data'] = $data;
3236
		}
3237
		$log[] = $log_entry;
3238
3239
		// Try add_option first, to make sure it's not autoloaded.
3240
		// @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...
3241
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3242
			Jetpack_Options::update_option( 'log', $log );
3243
		}
3244
3245
		/**
3246
		 * Fires when Jetpack logs an internal event.
3247
		 *
3248
		 * @since 3.0.0
3249
		 *
3250
		 * @param array $log_entry {
3251
		 *	Array of details about the log entry.
3252
		 *
3253
		 *	@param string time Time of the event.
3254
		 *	@param int user_id ID of the user who trigerred the event.
3255
		 *	@param int blog_id Jetpack Blog ID.
3256
		 *	@param string code Unique name for the event.
3257
		 *	@param string data Data about the event.
3258
		 * }
3259
		 */
3260
		do_action( 'jetpack_log_entry', $log_entry );
3261
	}
3262
3263
	/**
3264
	 * Get the internal event log.
3265
	 *
3266
	 * @param $event (string) - only return the specific log events
3267
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3268
	 *
3269
	 * @return array of log events || WP_Error for invalid params
3270
	 */
3271
	public static function get_log( $event = false, $num = false ) {
3272
		if ( $event && ! is_string( $event ) ) {
3273
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3274
		}
3275
3276
		if ( $num && ! is_numeric( $num ) ) {
3277
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3278
		}
3279
3280
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3281
3282
		// If nothing set - act as it did before, otherwise let's start customizing the output
3283
		if ( ! $num && ! $event ) {
3284
			return $entire_log;
3285
		} else {
3286
			$entire_log = array_reverse( $entire_log );
3287
		}
3288
3289
		$custom_log_output = array();
3290
3291
		if ( $event ) {
3292
			foreach ( $entire_log as $log_event ) {
3293
				if ( $event == $log_event[ 'code' ] ) {
3294
					$custom_log_output[] = $log_event;
3295
				}
3296
			}
3297
		} else {
3298
			$custom_log_output = $entire_log;
3299
		}
3300
3301
		if ( $num ) {
3302
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3303
		}
3304
3305
		return $custom_log_output;
3306
	}
3307
3308
	/**
3309
	 * Log modification of important settings.
3310
	 */
3311
	public static function log_settings_change( $option, $old_value, $value ) {
3312
		switch( $option ) {
3313
			case 'jetpack_sync_non_public_post_stati':
3314
				self::log( $option, $value );
3315
				break;
3316
		}
3317
	}
3318
3319
	/**
3320
	 * Return stat data for WPCOM sync
3321
	 */
3322
	public static function get_stat_data( $encode = true, $extended = true ) {
3323
		$data = Jetpack_Heartbeat::generate_stats_array();
3324
3325
		if ( $extended ) {
3326
			$additional_data = self::get_additional_stat_data();
3327
			$data = array_merge( $data, $additional_data );
3328
		}
3329
3330
		if ( $encode ) {
3331
			return json_encode( $data );
3332
		}
3333
3334
		return $data;
3335
	}
3336
3337
	/**
3338
	 * Get additional stat data to sync to WPCOM
3339
	 */
3340
	public static function get_additional_stat_data( $prefix = '' ) {
3341
		$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...
3342
		$return["{$prefix}plugins-extra"]  = Jetpack::get_parsed_plugin_data();
3343
		$return["{$prefix}users"]          = (int) Jetpack::get_site_user_count();
3344
		$return["{$prefix}site-count"]     = 0;
3345
3346
		if ( function_exists( 'get_blog_count' ) ) {
3347
			$return["{$prefix}site-count"] = get_blog_count();
3348
		}
3349
		return $return;
3350
	}
3351
3352
	private static function get_site_user_count() {
3353
		global $wpdb;
3354
3355
		if ( function_exists( 'wp_is_large_network' ) ) {
3356
			if ( wp_is_large_network( 'users' ) ) {
3357
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3358
			}
3359
		}
3360 View Code Duplication
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3361
			// It wasn't there, so regenerate the data and save the transient
3362
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3363
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3364
		}
3365
		return $user_count;
3366
	}
3367
3368
	/* Admin Pages */
3369
3370
	function admin_init() {
3371
		// If the plugin is not connected, display a connect message.
3372
		if (
3373
			// the plugin was auto-activated and needs its candy
3374
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3375
		||
3376
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3377
			! Jetpack_Options::get_option( 'activated' )
3378
		) {
3379
			Jetpack::plugin_initialize();
3380
		}
3381
3382
		if ( ! Jetpack::is_active() && ! Jetpack::is_development_mode() ) {
3383
			Jetpack_Connection_Banner::init();
3384
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3385
			// Upgrade: 1.1 -> 1.1.1
3386
			// Check and see if host can verify the Jetpack servers' SSL certificate
3387
			$args = array();
3388
			Jetpack_Client::_wp_remote_request(
3389
				Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'test' ) ),
3390
				$args,
3391
				true
3392
			);
3393
		} else if ( $this->can_display_jetpack_manage_notice() && ! Jetpack_Options::get_option( 'dismissed_manage_banner' ) ) {
3394
			// Show the notice on the Dashboard only for now
3395
			add_action( 'load-index.php', array( $this, 'prepare_manage_jetpack_notice' ) );
3396
		}
3397
3398
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3399
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3400
		}
3401
3402
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3403
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3404
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3405
3406
		if ( Jetpack::is_active() || Jetpack::is_development_mode() ) {
3407
			// Artificially throw errors in certain whitelisted cases during plugin activation
3408
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3409
		}
3410
3411
		// Jetpack Manage Activation Screen from .com
3412
		Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
3413
3414
		// Add custom column in wp-admin/users.php to show whether user is linked.
3415
		add_filter( 'manage_users_columns',       array( $this, 'jetpack_icon_user_connected' ) );
3416
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3417
		add_action( 'admin_print_styles',         array( $this, 'jetpack_user_col_style' ) );
3418
	}
3419
3420
	function admin_body_class( $admin_body_class = '' ) {
3421
		$classes = explode( ' ', trim( $admin_body_class ) );
3422
3423
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3424
3425
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3426
		return " $admin_body_class ";
3427
	}
3428
3429
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3430
		return $admin_body_class . ' jetpack-pagestyles ';
3431
	}
3432
3433
	/**
3434
	 * Call this function if you want the Big Jetpack Manage Notice to show up.
3435
	 *
3436
	 * @return null
3437
	 */
3438
	function prepare_manage_jetpack_notice() {
3439
3440
		add_action( 'admin_print_styles', array( $this, 'admin_banner_styles' ) );
3441
		add_action( 'admin_notices', array( $this, 'admin_jetpack_manage_notice' ) );
3442
	}
3443
3444
	function manage_activate_screen() {
3445
		include ( JETPACK__PLUGIN_DIR . 'modules/manage/activate-admin.php' );
3446
	}
3447
	/**
3448
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3449
	 * This function artificially throws errors for such cases (whitelisted).
3450
	 *
3451
	 * @param string $plugin The activated plugin.
3452
	 */
3453
	function throw_error_on_activate_plugin( $plugin ) {
3454
		$active_modules = Jetpack::get_active_modules();
3455
3456
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3457
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3458
			$throw = false;
3459
3460
			// Try and make sure it really was the stats plugin
3461
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3462
				if ( 'stats.php' == basename( $plugin ) ) {
3463
					$throw = true;
3464
				}
3465
			} else {
3466
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3467
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3468
					$throw = true;
3469
				}
3470
			}
3471
3472
			if ( $throw ) {
3473
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3474
			}
3475
		}
3476
	}
3477
3478
	function intercept_plugin_error_scrape_init() {
3479
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3480
	}
3481
3482
	function intercept_plugin_error_scrape( $action, $result ) {
3483
		if ( ! $result ) {
3484
			return;
3485
		}
3486
3487
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3488
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3489
				Jetpack::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3490
			}
3491
		}
3492
	}
3493
3494
	function add_remote_request_handlers() {
3495
		add_action( 'wp_ajax_nopriv_jetpack_upload_file', array( $this, 'remote_request_handlers' ) );
3496
		add_action( 'wp_ajax_nopriv_jetpack_update_file', array( $this, 'remote_request_handlers' ) );
3497
	}
3498
3499
	function remote_request_handlers() {
3500
		$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...
3501
3502
		switch ( current_filter() ) {
3503
		case 'wp_ajax_nopriv_jetpack_upload_file' :
3504
			$response = $this->upload_handler();
3505
			break;
3506
3507
		case 'wp_ajax_nopriv_jetpack_update_file' :
3508
			$response = $this->upload_handler( true );
3509
			break;
3510
		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...
3511
			$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3512
			break;
3513
		}
3514
3515
		if ( ! $response ) {
3516
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3517
		}
3518
3519
		if ( is_wp_error( $response ) ) {
3520
			$status_code       = $response->get_error_data();
3521
			$error             = $response->get_error_code();
3522
			$error_description = $response->get_error_message();
3523
3524
			if ( ! is_int( $status_code ) ) {
3525
				$status_code = 400;
3526
			}
3527
3528
			status_header( $status_code );
3529
			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...
3530
		}
3531
3532
		status_header( 200 );
3533
		if ( true === $response ) {
3534
			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...
3535
		}
3536
3537
		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...
3538
	}
3539
3540
	/**
3541
	 * Uploads a file gotten from the global $_FILES.
3542
	 * If `$update_media_item` is true and `post_id` is defined
3543
	 * the attachment file of the media item (gotten through of the post_id)
3544
	 * will be updated instead of add a new one.
3545
	 *
3546
	 * @param  boolean $update_media_item - update media attachment
3547
	 * @return array - An array describing the uploadind files process
3548
	 */
3549
	function upload_handler( $update_media_item = false ) {
3550
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3551
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3552
		}
3553
3554
		$user = wp_authenticate( '', '' );
3555
		if ( ! $user || is_wp_error( $user ) ) {
3556
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3557
		}
3558
3559
		wp_set_current_user( $user->ID );
3560
3561
		if ( ! current_user_can( 'upload_files' ) ) {
3562
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3563
		}
3564
3565
		if ( empty( $_FILES ) ) {
3566
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3567
		}
3568
3569
		foreach ( array_keys( $_FILES ) as $files_key ) {
3570
			if ( ! isset( $_POST["_jetpack_file_hmac_{$files_key}"] ) ) {
3571
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3572
			}
3573
		}
3574
3575
		$media_keys = array_keys( $_FILES['media'] );
3576
3577
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3578
		if ( ! $token || is_wp_error( $token ) ) {
3579
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3580
		}
3581
3582
		$uploaded_files = array();
3583
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3584
		unset( $GLOBALS['post'] );
3585
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3586
			$file = array();
3587
			foreach ( $media_keys as $media_key ) {
3588
				$file[$media_key] = $_FILES['media'][$media_key][$index];
3589
			}
3590
3591
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][$index] );
3592
3593
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3594
			if ( $hmac_provided !== $hmac_file ) {
3595
				$uploaded_files[$index] = (object) array( 'error' => 'invalid_hmac', 'error_description' => 'The corresponding HMAC for this file does not match' );
3596
				continue;
3597
			}
3598
3599
			$_FILES['.jetpack.upload.'] = $file;
3600
			$post_id = isset( $_POST['post_id'][$index] ) ? absint( $_POST['post_id'][$index] ) : 0;
3601
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3602
				$post_id = 0;
3603
			}
3604
3605
			if ( $update_media_item ) {
3606
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3607
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3608
				}
3609
3610
				$media_array = $_FILES['media'];
3611
3612
				$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...
3613
				$file_array['type'] = $media_array['type'][0];
3614
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3615
				$file_array['error'] = $media_array['error'][0];
3616
				$file_array['size'] = $media_array['size'][0];
3617
3618
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3619
3620
				if ( is_wp_error( $edited_media_item ) ) {
3621
					return $edited_media_item;
3622
				}
3623
3624
				$response = (object) array(
3625
					'id'   => (string) $post_id,
3626
					'file' => (string) $edited_media_item->post_title,
3627
					'url'  => (string) wp_get_attachment_url( $post_id ),
3628
					'type' => (string) $edited_media_item->post_mime_type,
3629
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3630
				);
3631
3632
				return (array) array( $response );
3633
			}
3634
3635
			$attachment_id = media_handle_upload(
3636
				'.jetpack.upload.',
3637
				$post_id,
3638
				array(),
3639
				array(
3640
					'action' => 'jetpack_upload_file',
3641
				)
3642
			);
3643
3644
			if ( ! $attachment_id ) {
3645
				$uploaded_files[$index] = (object) array( 'error' => 'unknown', 'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site' );
3646
			} elseif ( is_wp_error( $attachment_id ) ) {
3647
				$uploaded_files[$index] = (object) array( 'error' => 'attachment_' . $attachment_id->get_error_code(), 'error_description' => $attachment_id->get_error_message() );
3648
			} else {
3649
				$attachment = get_post( $attachment_id );
3650
				$uploaded_files[$index] = (object) array(
3651
					'id'   => (string) $attachment_id,
3652
					'file' => $attachment->post_title,
3653
					'url'  => wp_get_attachment_url( $attachment_id ),
3654
					'type' => $attachment->post_mime_type,
3655
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3656
				);
3657
				// Zip files uploads are not supported unless they are done for installation purposed
3658
				// lets delete them in case something goes wrong in this whole process
3659
				if ( 'application/zip' === $attachment->post_mime_type ) {
3660
					// Schedule a cleanup for 2 hours from now in case of failed install.
3661
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3662
				}
3663
			}
3664
		}
3665
		if ( ! is_null( $global_post ) ) {
3666
			$GLOBALS['post'] = $global_post;
3667
		}
3668
3669
		return $uploaded_files;
3670
	}
3671
3672
	/**
3673
	 * Add help to the Jetpack page
3674
	 *
3675
	 * @since Jetpack (1.2.3)
3676
	 * @return false if not the Jetpack page
3677
	 */
3678
	function admin_help() {
3679
		$current_screen = get_current_screen();
3680
3681
		// Overview
3682
		$current_screen->add_help_tab(
3683
			array(
3684
				'id'		=> 'home',
3685
				'title'		=> __( 'Home', 'jetpack' ),
3686
				'content'	=>
3687
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3688
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3689
					'<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>',
3690
			)
3691
		);
3692
3693
		// Screen Content
3694
		if ( current_user_can( 'manage_options' ) ) {
3695
			$current_screen->add_help_tab(
3696
				array(
3697
					'id'		=> 'settings',
3698
					'title'		=> __( 'Settings', 'jetpack' ),
3699
					'content'	=>
3700
						'<p><strong>' . __( 'Jetpack by WordPress.com',                                              'jetpack' ) . '</strong></p>' .
3701
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3702
						'<ol>' .
3703
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.',														'jetpack' ) . '</li>' .
3704
							'<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>' .
3705
						'</ol>' .
3706
						'<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>'
3707
				)
3708
			);
3709
		}
3710
3711
		// Help Sidebar
3712
		$current_screen->set_help_sidebar(
3713
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3714
			'<p><a href="https://jetpack.com/faq/" target="_blank">'     . __( 'Jetpack FAQ',     'jetpack' ) . '</a></p>' .
3715
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3716
			'<p><a href="' . Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) .'">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3717
		);
3718
	}
3719
3720
	function admin_menu_css() {
3721
		wp_enqueue_style( 'jetpack-icons' );
3722
	}
3723
3724
	function admin_menu_order() {
3725
		return true;
3726
	}
3727
3728 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3729
		$jp_menu_order = array();
3730
3731
		foreach ( $menu_order as $index => $item ) {
3732
			if ( $item != 'jetpack' ) {
3733
				$jp_menu_order[] = $item;
3734
			}
3735
3736
			if ( $index == 0 ) {
3737
				$jp_menu_order[] = 'jetpack';
3738
			}
3739
		}
3740
3741
		return $jp_menu_order;
3742
	}
3743
3744
	function admin_head() {
3745 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) )
3746
			/** This action is documented in class.jetpack-admin-page.php */
3747
			do_action( 'jetpack_module_configuration_head_' . $_GET['configure'] );
3748
	}
3749
3750
	function admin_banner_styles() {
3751
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3752
3753 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3754
			wp_register_style(
3755
				'jetpack-dops-style',
3756
				plugins_url( '_inc/build/admin.dops-style.css', JETPACK__PLUGIN_FILE ),
3757
				array(),
3758
				JETPACK__VERSION
3759
			);
3760
		}
3761
3762
		wp_enqueue_style(
3763
			'jetpack',
3764
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3765
			array( 'jetpack-dops-style' ),
3766
			 JETPACK__VERSION . '-20121016'
3767
		);
3768
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3769
		wp_style_add_data( 'jetpack', 'suffix', $min );
3770
	}
3771
3772
	function plugin_action_links( $actions ) {
3773
3774
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack' ), __( 'Jetpack', 'jetpack' ) ) );
3775
3776
		if( current_user_can( 'jetpack_manage_modules' ) && ( Jetpack::is_active() || Jetpack::is_development_mode() ) ) {
3777
			return array_merge(
3778
				$jetpack_home,
3779
				array( 'settings' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3780
				array( 'support' => sprintf( '<a href="%s">%s</a>', Jetpack::admin_url( 'page=jetpack-debugger '), __( 'Support', 'jetpack' ) ) ),
3781
				$actions
3782
				);
3783
			}
3784
3785
		return array_merge( $jetpack_home, $actions );
3786
	}
3787
3788
	/**
3789
	 * This is the first banner
3790
	 * It should be visible only to user that can update the option
3791
	 * Are not connected
3792
	 *
3793
	 * @return null
3794
	 */
3795
	function admin_jetpack_manage_notice() {
3796
		$screen = get_current_screen();
3797
3798
		// Don't show the connect notice on the jetpack settings page.
3799
		if ( ! in_array( $screen->base, array( 'dashboard' ) ) || $screen->is_network || $screen->action ) {
3800
			return;
3801
		}
3802
3803
		$opt_out_url = $this->opt_out_jetpack_manage_url();
3804
		$opt_in_url  = $this->opt_in_jetpack_manage_url();
3805
		/**
3806
		 * I think it would be great to have different wordsing depending on where you are
3807
		 * for example if we show the notice on dashboard and a different one if we show it on Plugins screen
3808
		 * etc..
3809
		 */
3810
3811
		?>
3812
		<div id="message" class="updated jp-banner">
3813
				<a href="<?php echo esc_url( $opt_out_url ); ?>" class="notice-dismiss" title="<?php esc_attr_e( 'Dismiss this notice', 'jetpack' ); ?>"></a>
3814
				<div class="jp-banner__description-container">
3815
					<h2 class="jp-banner__header"><?php esc_html_e( 'Jetpack Centralized Site Management', 'jetpack' ); ?></h2>
3816
					<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>
3817
					<p class="jp-banner__button-container">
3818
						<a href="<?php echo esc_url( $opt_in_url ); ?>" class="button button-primary" id="wpcom-connect"><?php _e( 'Activate Jetpack Manage', 'jetpack' ); ?></a>
3819
						<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>
3820
					</p>
3821
				</div>
3822
		</div>
3823
		<?php
3824
	}
3825
3826
	/**
3827
	 * Returns the url that the user clicks to remove the notice for the big banner
3828
	 * @return string
3829
	 */
3830
	function opt_out_jetpack_manage_url() {
3831
		$referer = '&_wp_http_referer=' . add_query_arg( '_wp_http_referer', null );
3832
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-out' . $referer ), 'jetpack_manage_banner_opt_out' );
3833
	}
3834
	/**
3835
	 * Returns the url that the user clicks to opt in to Jetpack Manage
3836
	 * @return string
3837
	 */
3838
	function opt_in_jetpack_manage_url() {
3839
		return wp_nonce_url( Jetpack::admin_url( 'jetpack-notice=jetpack-manage-opt-in' ), 'jetpack_manage_banner_opt_in' );
3840
	}
3841
3842
	function opt_in_jetpack_manage_notice() {
3843
		?>
3844
		<div class="wrap">
3845
			<div id="message" class="jetpack-message is-opt-in">
3846
				<?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' ); ?>
3847
			</div>
3848
		</div>
3849
		<?php
3850
3851
	}
3852
	/**
3853
	 * Determines whether to show the notice of not true = display notice
3854
	 * @return bool
3855
	 */
3856
	function can_display_jetpack_manage_notice() {
3857
		// never display the notice to users that can't do anything about it anyways
3858
		if( ! current_user_can( 'jetpack_manage_modules' ) )
3859
			return false;
3860
3861
		// don't display if we are in development more
3862
		if( Jetpack::is_development_mode() ) {
3863
			return false;
3864
		}
3865
		// don't display if the site is private
3866
		if(  ! Jetpack_Options::get_option( 'public' ) )
3867
			return false;
3868
3869
		/**
3870
		 * Should the Jetpack Remote Site Management notice be displayed.
3871
		 *
3872
		 * @since 3.3.0
3873
		 *
3874
		 * @param bool ! self::is_module_active( 'manage' ) Is the Manage module inactive.
3875
		 */
3876
		return apply_filters( 'can_display_jetpack_manage_notice', ! self::is_module_active( 'manage' ) );
3877
	}
3878
3879
	/*
3880
	 * Registration flow:
3881
	 * 1 - ::admin_page_load() action=register
3882
	 * 2 - ::try_registration()
3883
	 * 3 - ::register()
3884
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3885
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3886
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3887
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3888
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3889
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3890
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3891
	 *       jetpack_id, jetpack_secret, jetpack_public
3892
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3893
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3894
	 * 5 - user logs in with WP.com account
3895
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3896
	 *		- Jetpack_Client_Server::authorize()
3897
	 *		- Jetpack_Client_Server::get_token()
3898
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3899
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3900
	 *			- which responds with access_token, token_type, scope
3901
	 *		- Jetpack_Client_Server::authorize() stores jetpack_options: user_token => access_token.$user_id
3902
	 *		- Jetpack::activate_default_modules()
3903
	 *     		- Deactivates deprecated plugins
3904
	 *     		- Activates all default modules
3905
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3906
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3907
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3908
	 *     Done!
3909
	 */
3910
3911
	/**
3912
	 * Handles the page load events for the Jetpack admin page
3913
	 */
3914
	function admin_page_load() {
3915
		$error = false;
3916
3917
		// Make sure we have the right body class to hook stylings for subpages off of.
3918
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ) );
3919
3920
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
3921
			// Should only be used in intermediate redirects to preserve state across redirects
3922
			Jetpack::restate();
3923
		}
3924
3925
		if ( isset( $_GET['connect_url_redirect'] ) ) {
3926
			// User clicked in the iframe to link their accounts
3927
			if ( ! Jetpack::is_user_connected() ) {
3928
				$connect_url = $this->build_connect_url( true, false, 'iframe' );
3929
				if ( isset( $_GET['notes_iframe'] ) )
3930
					$connect_url .= '&notes_iframe';
3931
				wp_redirect( $connect_url );
3932
				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...
3933
			} else {
3934
				if ( ! isset( $_GET['calypso_env'] ) ) {
3935
					Jetpack::state( 'message', 'already_authorized' );
3936
					wp_safe_redirect( Jetpack::admin_url() );
3937
					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...
3938
				} else {
3939
					$connect_url = $this->build_connect_url( true, false, 'iframe' );
3940
					$connect_url .= '&already_authorized=true';
3941
					wp_redirect( $connect_url );
3942
					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...
3943
				}
3944
			}
3945
		}
3946
3947
3948
		if ( isset( $_GET['action'] ) ) {
3949
			switch ( $_GET['action'] ) {
3950
			case 'authorize':
3951
				if ( Jetpack::is_active() && Jetpack::is_user_connected() ) {
3952
					Jetpack::state( 'message', 'already_authorized' );
3953
					wp_safe_redirect( Jetpack::admin_url() );
3954
					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...
3955
				}
3956
				Jetpack::log( 'authorize' );
3957
				$client_server = new Jetpack_Client_Server;
3958
				$client_server->client_authorize();
3959
				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...
3960
			case 'register' :
3961
				if ( ! current_user_can( 'jetpack_connect' ) ) {
3962
					$error = 'cheatin';
3963
					break;
3964
				}
3965
				check_admin_referer( 'jetpack-register' );
3966
				Jetpack::log( 'register' );
3967
				Jetpack::maybe_set_version_option();
3968
				$registered = Jetpack::try_registration();
3969
				if ( is_wp_error( $registered ) ) {
3970
					$error = $registered->get_error_code();
3971
					Jetpack::state( 'error', $error );
3972
					Jetpack::state( 'error', $registered->get_error_message() );
3973
					JetpackTracking::record_user_event( 'jpc_register_fail', array(
3974
						'error_code' => $error,
3975
						'error_message' => $registered->get_error_message()
3976
					) );
3977
					break;
3978
				}
3979
3980
				$from = isset( $_GET['from'] ) ? $_GET['from'] : false;
3981
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
3982
3983
				JetpackTracking::record_user_event( 'jpc_register_success', array(
3984
					'from' => $from
3985
				) );
3986
3987
				$url = $this->build_connect_url( true, $redirect, $from );
3988
3989
				if ( ! empty( $_GET['onboarding'] ) ) {
3990
					$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
3991
				}
3992
3993
				wp_redirect( $url );
3994
				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...
3995
			case 'activate' :
3996
				if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
3997
					$error = 'cheatin';
3998
					break;
3999
				}
4000
4001
				$module = stripslashes( $_GET['module'] );
4002
				check_admin_referer( "jetpack_activate-$module" );
4003
				Jetpack::log( 'activate', $module );
4004
				Jetpack::activate_module( $module );
4005
				// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4006
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4007
				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...
4008
			case 'activate_default_modules' :
4009
				check_admin_referer( 'activate_default_modules' );
4010
				Jetpack::log( 'activate_default_modules' );
4011
				Jetpack::restate();
4012
				$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4013
				$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4014
				$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4015
				Jetpack::activate_default_modules( $min_version, $max_version, $other_modules );
4016
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
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
			case 'disconnect' :
4019
				if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4020
					$error = 'cheatin';
4021
					break;
4022
				}
4023
4024
				check_admin_referer( 'jetpack-disconnect' );
4025
				Jetpack::log( 'disconnect' );
4026
				Jetpack::disconnect();
4027
				wp_safe_redirect( Jetpack::admin_url( 'disconnected=true' ) );
4028
				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...
4029
			case 'reconnect' :
4030
				if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4031
					$error = 'cheatin';
4032
					break;
4033
				}
4034
4035
				check_admin_referer( 'jetpack-reconnect' );
4036
				Jetpack::log( 'reconnect' );
4037
				$this->disconnect();
4038
				wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4039
				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...
4040 View Code Duplication
			case 'deactivate' :
4041
				if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4042
					$error = 'cheatin';
4043
					break;
4044
				}
4045
4046
				$modules = stripslashes( $_GET['module'] );
4047
				check_admin_referer( "jetpack_deactivate-$modules" );
4048
				foreach ( explode( ',', $modules ) as $module ) {
4049
					Jetpack::log( 'deactivate', $module );
4050
					Jetpack::deactivate_module( $module );
4051
					Jetpack::state( 'message', 'module_deactivated' );
4052
				}
4053
				Jetpack::state( 'module', $modules );
4054
				wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4055
				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...
4056
			case 'unlink' :
4057
				$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4058
				check_admin_referer( 'jetpack-unlink' );
4059
				Jetpack::log( 'unlink' );
4060
				$this->unlink_user();
4061
				Jetpack::state( 'message', 'unlinked' );
4062
				if ( 'sub-unlink' == $redirect ) {
4063
					wp_safe_redirect( admin_url() );
4064
				} else {
4065
					wp_safe_redirect( Jetpack::admin_url( array( 'page' => $redirect ) ) );
4066
				}
4067
				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...
4068
			case 'onboard' :
4069
				if ( ! current_user_can( 'manage_options' ) ) {
4070
					wp_safe_redirect( Jetpack::admin_url( 'page=jetpack' ) );
4071
				} else {
4072
					Jetpack::create_onboarding_token();
4073
					$url = $this->build_connect_url( true );
4074
4075
					if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4076
						$url = add_query_arg( 'onboarding', $token, $url );
4077
					}
4078
4079
					$calypso_env = ! empty( $_GET[ 'calypso_env' ] ) ? $_GET[ 'calypso_env' ] : false;
4080
					if ( $calypso_env ) {
4081
						$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4082
					}
4083
4084
					wp_redirect( $url );
4085
					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...
4086
				}
4087
				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...
4088
			default:
4089
				/**
4090
				 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4091
				 *
4092
				 * @since 2.6.0
4093
				 *
4094
				 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4095
				 */
4096
				do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4097
			}
4098
		}
4099
4100
		if ( ! $error = $error ? $error : Jetpack::state( 'error' ) ) {
4101
			self::activate_new_modules( true );
4102
		}
4103
4104
		$message_code = Jetpack::state( 'message' );
4105
		if ( Jetpack::state( 'optin-manage' ) ) {
4106
			$activated_manage = $message_code;
4107
			$message_code = 'jetpack-manage';
4108
		}
4109
4110
		switch ( $message_code ) {
4111
		case 'jetpack-manage':
4112
			$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>';
4113
			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...
4114
				$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack'  ) . '</strong>';
4115
			}
4116
			break;
4117
4118
		}
4119
4120
		$deactivated_plugins = Jetpack::state( 'deactivated_plugins' );
4121
4122
		if ( ! empty( $deactivated_plugins ) ) {
4123
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4124
			$deactivated_titles  = array();
4125
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4126
				if ( ! isset( $this->plugins_to_deactivate[$deactivated_plugin] ) ) {
4127
					continue;
4128
				}
4129
4130
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[$deactivated_plugin][1] ) . '</strong>';
4131
			}
4132
4133
			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...
4134
				if ( $this->message ) {
4135
					$this->message .= "<br /><br />\n";
4136
				}
4137
4138
				$this->message .= wp_sprintf(
4139
					_n(
4140
						'Jetpack contains the most recent version of the old %l plugin.',
4141
						'Jetpack contains the most recent versions of the old %l plugins.',
4142
						count( $deactivated_titles ),
4143
						'jetpack'
4144
					),
4145
					$deactivated_titles
4146
				);
4147
4148
				$this->message .= "<br />\n";
4149
4150
				$this->message .= _n(
4151
					'The old version has been deactivated and can be removed from your site.',
4152
					'The old versions have been deactivated and can be removed from your site.',
4153
					count( $deactivated_titles ),
4154
					'jetpack'
4155
				);
4156
			}
4157
		}
4158
4159
		$this->privacy_checks = Jetpack::state( 'privacy_checks' );
4160
4161
		if ( $this->message || $this->error || $this->privacy_checks || $this->can_display_jetpack_manage_notice() ) {
4162
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4163
		}
4164
4165 View Code Duplication
		if ( isset( $_GET['configure'] ) && Jetpack::is_module( $_GET['configure'] ) && current_user_can( 'manage_options' ) ) {
4166
			/**
4167
			 * Fires when a module configuration page is loaded.
4168
			 * The dynamic part of the hook is the configure parameter from the URL.
4169
			 *
4170
			 * @since 1.1.0
4171
			 */
4172
			do_action( 'jetpack_module_configuration_load_' . $_GET['configure'] );
4173
		}
4174
4175
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4176
	}
4177
4178
	function admin_notices() {
4179
4180
		if ( $this->error ) {
4181
?>
4182
<div id="message" class="jetpack-message jetpack-err">
4183
	<div class="squeezer">
4184
		<h2><?php echo wp_kses( $this->error, array( 'a' => array( 'href' => array() ), 'small' => true, 'code' => true, 'strong' => true, 'br' => true, 'b' => true ) ); ?></h2>
4185
<?php	if ( $desc = Jetpack::state( 'error_description' ) ) : ?>
4186
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4187
<?php	endif; ?>
4188
	</div>
4189
</div>
4190
<?php
4191
		}
4192
4193
		if ( $this->message ) {
4194
?>
4195
<div id="message" class="jetpack-message">
4196
	<div class="squeezer">
4197
		<h2><?php echo wp_kses( $this->message, array( 'strong' => array(), 'a' => array( 'href' => true ), 'br' => true ) ); ?></h2>
4198
	</div>
4199
</div>
4200
<?php
4201
		}
4202
4203
		if ( $this->privacy_checks ) :
4204
			$module_names = $module_slugs = array();
4205
4206
			$privacy_checks = explode( ',', $this->privacy_checks );
4207
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4208
			foreach ( $privacy_checks as $module_slug ) {
4209
				$module = Jetpack::get_module( $module_slug );
4210
				if ( ! $module ) {
4211
					continue;
4212
				}
4213
4214
				$module_slugs[] = $module_slug;
4215
				$module_names[] = "<strong>{$module['name']}</strong>";
4216
			}
4217
4218
			$module_slugs = join( ',', $module_slugs );
4219
?>
4220
<div id="message" class="jetpack-message jetpack-err">
4221
	<div class="squeezer">
4222
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4223
		<p><?php
4224
			echo wp_kses(
4225
				wptexturize(
4226
					wp_sprintf(
4227
						_nx(
4228
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4229
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4230
							count( $privacy_checks ),
4231
							'%l = list of Jetpack module/feature names',
4232
							'jetpack'
4233
						),
4234
						$module_names
4235
					)
4236
				),
4237
				array( 'strong' => true )
4238
			);
4239
4240
			echo "\n<br />\n";
4241
4242
			echo wp_kses(
4243
				sprintf(
4244
					_nx(
4245
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4246
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4247
						count( $privacy_checks ),
4248
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4249
						'jetpack'
4250
					),
4251
					wp_nonce_url(
4252
						Jetpack::admin_url(
4253
							array(
4254
								'page'   => 'jetpack',
4255
								'action' => 'deactivate',
4256
								'module' => urlencode( $module_slugs ),
4257
							)
4258
						),
4259
						"jetpack_deactivate-$module_slugs"
4260
					),
4261
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4262
				),
4263
				array( 'a' => array( 'href' => true, 'title' => true ) )
4264
			);
4265
		?></p>
4266
	</div>
4267
</div>
4268
<?php endif;
4269
	// only display the notice if the other stuff is not there
4270
	if( $this->can_display_jetpack_manage_notice() && !  $this->error && ! $this->message && ! $this->privacy_checks ) {
4271
		if( isset( $_GET['page'] ) && 'jetpack' != $_GET['page'] )
4272
			$this->opt_in_jetpack_manage_notice();
4273
		}
4274
	}
4275
4276
	/**
4277
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4278
	 */
4279
	function stat( $group, $detail ) {
4280
		if ( ! isset( $this->stats[ $group ] ) )
4281
			$this->stats[ $group ] = array();
4282
		$this->stats[ $group ][] = $detail;
4283
	}
4284
4285
	/**
4286
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4287
	 */
4288
	function do_stats( $method = '' ) {
4289
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4290
			foreach ( $this->stats as $group => $stats ) {
4291
				if ( is_array( $stats ) && count( $stats ) ) {
4292
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4293
					if ( 'server_side' === $method ) {
4294
						self::do_server_side_stat( $args );
4295
					} else {
4296
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4297
					}
4298
				}
4299
				unset( $this->stats[ $group ] );
4300
			}
4301
		}
4302
	}
4303
4304
	/**
4305
	 * Runs stats code for a one-off, server-side.
4306
	 *
4307
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4308
	 *
4309
	 * @return bool If it worked.
4310
	 */
4311
	static function do_server_side_stat( $args ) {
4312
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4313
		if ( is_wp_error( $response ) )
4314
			return false;
4315
4316
		if ( 200 !== wp_remote_retrieve_response_code( $response ) )
4317
			return false;
4318
4319
		return true;
4320
	}
4321
4322
	/**
4323
	 * Builds the stats url.
4324
	 *
4325
	 * @param $args array|string The arguments to append to the URL.
4326
	 *
4327
	 * @return string The URL to be pinged.
4328
	 */
4329
	static function build_stats_url( $args ) {
4330
		$defaults = array(
4331
			'v'    => 'wpcom2',
4332
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4333
		);
4334
		$args     = wp_parse_args( $args, $defaults );
4335
		/**
4336
		 * Filter the URL used as the Stats tracking pixel.
4337
		 *
4338
		 * @since 2.3.2
4339
		 *
4340
		 * @param string $url Base URL used as the Stats tracking pixel.
4341
		 */
4342
		$base_url = apply_filters(
4343
			'jetpack_stats_base_url',
4344
			'https://pixel.wp.com/g.gif'
4345
		);
4346
		$url      = add_query_arg( $args, $base_url );
4347
		return $url;
4348
	}
4349
4350
	static function translate_current_user_to_role() {
4351
		foreach ( self::$capability_translations as $role => $cap ) {
4352
			if ( current_user_can( $role ) || current_user_can( $cap ) ) {
4353
				return $role;
4354
			}
4355
		}
4356
4357
		return false;
4358
	}
4359
4360
	static function translate_user_to_role( $user ) {
4361
		foreach ( self::$capability_translations as $role => $cap ) {
4362
			if ( user_can( $user, $role ) || user_can( $user, $cap ) ) {
4363
				return $role;
4364
			}
4365
		}
4366
4367
		return false;
4368
    }
4369
4370
	static function translate_role_to_cap( $role ) {
4371
		if ( ! isset( self::$capability_translations[$role] ) ) {
4372
			return false;
4373
		}
4374
4375
		return self::$capability_translations[$role];
4376
	}
4377
4378
	static function sign_role( $role, $user_id = null ) {
4379
		if ( empty( $user_id ) ) {
4380
			$user_id = (int) get_current_user_id();
4381
		}
4382
4383
		if ( ! $user_id  ) {
4384
			return false;
4385
		}
4386
4387
		$token = Jetpack_Data::get_access_token();
4388
		if ( ! $token || is_wp_error( $token ) ) {
4389
			return false;
4390
		}
4391
4392
		return $role . ':' . hash_hmac( 'md5', "{$role}|{$user_id}", $token->secret );
4393
	}
4394
4395
4396
	/**
4397
	 * Builds a URL to the Jetpack connection auth page
4398
	 *
4399
	 * @since 3.9.5
4400
	 *
4401
	 * @param bool $raw If true, URL will not be escaped.
4402
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4403
	 *                              If string, will be a custom redirect.
4404
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4405
	 * @param bool $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4406
	 *
4407
	 * @return string Connect URL
4408
	 */
4409
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4410
		$site_id = Jetpack_Options::get_option( 'id' );
4411
		$token = Jetpack_Options::get_option( 'blog_token' );
4412
4413
		if ( $register || ! $token || ! $site_id ) {
4414
			$url = Jetpack::nonce_url_no_esc( Jetpack::admin_url( 'action=register' ), 'jetpack-register' );
4415
4416
			if ( ! empty( $redirect ) ) {
4417
				$url = add_query_arg(
4418
					'redirect',
4419
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4420
					$url
4421
				);
4422
			}
4423
4424
			if( is_network_admin() ) {
4425
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4426
			}
4427
		} else {
4428
4429
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4430
			// because otherwise this logic can get us in to a loop.
4431
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4432
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4433
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4434
4435
				$response = Jetpack_Client::wpcom_json_api_request_as_blog(
4436
					sprintf( '/sites/%d', $site_id ) .'?force=wpcom',
4437
					'1.1'
4438
				);
4439
4440
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4441
					// Generating a register URL instead to refresh the existing token
4442
					return $this->build_connect_url( $raw, $redirect, $from, true );
4443
				}
4444
			}
4445
4446
			if ( defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) && include_once JETPACK__GLOTPRESS_LOCALES_PATH ) {
4447
				$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4448
			}
4449
4450
			$role = self::translate_current_user_to_role();
4451
			$signed_role = self::sign_role( $role );
4452
4453
			$user = wp_get_current_user();
4454
4455
			$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4456
			$redirect = $redirect
4457
				? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4458
				: $jetpack_admin_page;
4459
4460
			if( isset( $_REQUEST['is_multisite'] ) ) {
4461
				$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4462
			}
4463
4464
			$secrets = Jetpack::generate_secrets( 'authorize', false, 2 * HOUR_IN_SECONDS );
4465
4466
			$site_icon = ( function_exists( 'has_site_icon') && has_site_icon() )
4467
				? get_site_icon_url()
4468
				: false;
4469
4470
			/**
4471
			 * Filter the type of authorization.
4472
			 * 'calypso' completes authorization on wordpress.com/jetpack/connect
4473
			 * while 'jetpack' ( or any other value ) completes the authorization at jetpack.wordpress.com.
4474
			 *
4475
			 * @since 4.3.3
4476
			 *
4477
			 * @param string $auth_type Defaults to 'calypso', can also be 'jetpack'.
4478
			 */
4479
			$auth_type = apply_filters( 'jetpack_auth_type', 'calypso' );
4480
4481
			$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
4482
4483
			$args = urlencode_deep(
4484
				array(
4485
					'response_type' => 'code',
4486
					'client_id'     => Jetpack_Options::get_option( 'id' ),
4487
					'redirect_uri'  => add_query_arg(
4488
						array(
4489
							'action'   => 'authorize',
4490
							'_wpnonce' => wp_create_nonce( "jetpack-authorize_{$role}_{$redirect}" ),
4491
							'redirect' => urlencode( $redirect ),
4492
						),
4493
						esc_url( admin_url( 'admin.php?page=jetpack' ) )
4494
					),
4495
					'state'         => $user->ID,
4496
					'scope'         => $signed_role,
4497
					'user_email'    => $user->user_email,
4498
					'user_login'    => $user->user_login,
4499
					'is_active'     => Jetpack::is_active(),
4500
					'jp_version'    => JETPACK__VERSION,
4501
					'auth_type'     => $auth_type,
4502
					'secret'        => $secrets['secret_1'],
4503
					'locale'        => ( isset( $gp_locale ) && isset( $gp_locale->slug ) ) ? $gp_locale->slug : '',
4504
					'blogname'      => get_option( 'blogname' ),
4505
					'site_url'      => site_url(),
4506
					'home_url'      => home_url(),
4507
					'site_icon'     => $site_icon,
4508
					'site_lang'     => get_locale(),
4509
					'_ui'           => $tracks_identity['_ui'],
4510
					'_ut'           => $tracks_identity['_ut']
4511
				)
4512
			);
4513
4514
			self::apply_activation_source_to_args( $args );
4515
4516
			$url = add_query_arg( $args, Jetpack::api_url( 'authorize' ) );
4517
		}
4518
4519
		if ( $from ) {
4520
			$url = add_query_arg( 'from', $from, $url );
4521
		}
4522
4523
4524
		if ( isset( $_GET['calypso_env'] ) ) {
4525
			$url = add_query_arg( 'calypso_env', sanitize_key( $_GET['calypso_env'] ), $url );
4526
		}
4527
4528
		return $raw ? $url : esc_url( $url );
4529
	}
4530
4531
	public static function apply_activation_source_to_args( &$args ) {
4532
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4533
4534
		if ( $activation_source_name ) {
4535
			$args['_as'] = urlencode( $activation_source_name );
4536
		}
4537
4538
		if ( $activation_source_keyword ) {
4539
			$args['_ak'] = urlencode( $activation_source_keyword );
4540
		}
4541
	}
4542
4543
	function build_reconnect_url( $raw = false ) {
4544
		$url = wp_nonce_url( Jetpack::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4545
		return $raw ? $url : esc_url( $url );
4546
	}
4547
4548
	public static function admin_url( $args = null ) {
4549
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4550
		$url = add_query_arg( $args, admin_url( 'admin.php' ) );
4551
		return $url;
4552
	}
4553
4554
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4555
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4556
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4557
	}
4558
4559
	function dismiss_jetpack_notice() {
4560
4561
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4562
			return;
4563
		}
4564
4565
		switch( $_GET['jetpack-notice'] ) {
4566
			case 'dismiss':
4567
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4568
4569
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4570
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4571
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4572
				}
4573
				break;
4574 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...
4575
4576
				if ( check_admin_referer( 'jetpack_manage_banner_opt_out' ) ) {
4577
					// Don't show the banner again
4578
4579
					Jetpack_Options::update_option( 'dismissed_manage_banner', true );
4580
					// redirect back to the page that had the notice
4581
					if ( wp_get_referer() ) {
4582
						wp_safe_redirect( wp_get_referer() );
4583
					} else {
4584
						// Take me to Jetpack
4585
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4586
					}
4587
				}
4588
				break;
4589 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...
4590
4591
				if ( check_admin_referer( 'jetpack_protect_multisite_banner_opt_out' ) ) {
4592
					// Don't show the banner again
4593
4594
					update_site_option( 'jetpack_dismissed_protect_multisite_banner', true );
4595
					// redirect back to the page that had the notice
4596
					if ( wp_get_referer() ) {
4597
						wp_safe_redirect( wp_get_referer() );
4598
					} else {
4599
						// Take me to Jetpack
4600
						wp_safe_redirect( admin_url( 'admin.php?page=jetpack' ) );
4601
					}
4602
				}
4603
				break;
4604
			case 'jetpack-manage-opt-in':
4605
				if ( check_admin_referer( 'jetpack_manage_banner_opt_in' ) ) {
4606
					// This makes sure that we are redirect to jetpack home so that we can see the Success Message.
4607
4608
					$redirection_url = Jetpack::admin_url();
4609
					remove_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4610
4611
					// Don't redirect form the Jetpack Setting Page
4612
					$referer_parsed = parse_url ( wp_get_referer() );
4613
					// check that we do have a wp_get_referer and the query paramater is set orderwise go to the Jetpack Home
4614
					if ( isset( $referer_parsed['query'] ) && false !== strpos( $referer_parsed['query'], 'page=jetpack_modules' ) ) {
4615
						// Take the user to Jetpack home except when on the setting page
4616
						$redirection_url = wp_get_referer();
4617
						add_action( 'jetpack_pre_activate_module',   array( Jetpack_Admin::init(), 'fix_redirect' ) );
4618
					}
4619
					// Also update the JSON API FULL MANAGEMENT Option
4620
					Jetpack::activate_module( 'manage', false, false );
4621
4622
					// Special Message when option in.
4623
					Jetpack::state( 'optin-manage', 'true' );
4624
					// Activate the Module if not activated already
4625
4626
					// Redirect properly
4627
					wp_safe_redirect( $redirection_url );
4628
4629
				}
4630
				break;
4631
		}
4632
	}
4633
4634
	public static function admin_screen_configure_module( $module_id ) {
4635
4636
		// User that doesn't have 'jetpack_configure_modules' will never end up here since Jetpack Landing Page woun't let them.
4637
		if ( ! in_array( $module_id, Jetpack::get_active_modules() ) && current_user_can( 'manage_options' ) ) {
4638
			if ( has_action( 'display_activate_module_setting_' . $module_id ) ) {
4639
				/**
4640
				 * Fires to diplay a custom module activation screen.
4641
				 *
4642
				 * To add a module actionation screen use Jetpack::module_configuration_activation_screen method.
4643
				 * Example: Jetpack::module_configuration_activation_screen( 'manage', array( $this, 'manage_activate_screen' ) );
4644
				 *
4645
				 * @module manage
4646
				 *
4647
				 * @since 3.8.0
4648
				 *
4649
				 * @param int $module_id Module ID.
4650
				 */
4651
				do_action( 'display_activate_module_setting_' . $module_id );
4652
			} else {
4653
				self::display_activate_module_link( $module_id );
4654
			}
4655
4656
			return false;
4657
		} ?>
4658
4659
		<div id="jp-settings-screen" style="position: relative">
4660
			<h3>
4661
			<?php
4662
				$module = Jetpack::get_module( $module_id );
4663
				echo '<a href="' . Jetpack::admin_url( 'page=jetpack_modules' ) . '">' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</a> &rarr; ';
4664
				printf( __( 'Configure %s', 'jetpack' ), $module['name'] );
4665
			?>
4666
			</h3>
4667
			<?php
4668
				/**
4669
				 * Fires within the displayed message when a feature configuation is updated.
4670
				 *
4671
				 * @since 3.4.0
4672
				 *
4673
				 * @param int $module_id Module ID.
4674
				 */
4675
				do_action( 'jetpack_notices_update_settings', $module_id );
4676
				/**
4677
				 * Fires when a feature configuation screen is loaded.
4678
				 * The dynamic part of the hook, $module_id, is the module ID.
4679
				 *
4680
				 * @since 1.1.0
4681
				 */
4682
				do_action( 'jetpack_module_configuration_screen_' . $module_id );
4683
			?>
4684
		</div><?php
4685
	}
4686
4687
	/**
4688
	 * Display link to activate the module to see the settings screen.
4689
	 * @param  string $module_id
4690
	 * @return null
4691
	 */
4692
	public static function display_activate_module_link( $module_id ) {
4693
4694
		$info =  Jetpack::get_module( $module_id );
4695
		$extra = '';
4696
		$activate_url = wp_nonce_url(
4697
				Jetpack::admin_url(
4698
					array(
4699
						'page'   => 'jetpack',
4700
						'action' => 'activate',
4701
						'module' => $module_id,
4702
					)
4703
				),
4704
				"jetpack_activate-$module_id"
4705
			);
4706
4707
		?>
4708
4709
		<div class="wrap configure-module">
4710
			<div id="jp-settings-screen">
4711
				<?php
4712
				if ( $module_id == 'json-api' ) {
4713
4714
					$info['name'] = esc_html__( 'Activate Site Management and JSON API', 'jetpack' );
4715
4716
					$activate_url = Jetpack::init()->opt_in_jetpack_manage_url();
4717
4718
					$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' );
4719
4720
					// $extra = __( 'To use Site Management, you need to first activate JSON API to allow remote management of your site. ', 'jetpack' );
4721
				} ?>
4722
4723
				<h3><?php echo esc_html( $info['name'] ); ?></h3>
4724
				<div class="narrow">
4725
					<p><?php echo  $info['description']; ?></p>
4726
					<?php if( $extra ) { ?>
4727
					<p><?php echo esc_html( $extra ); ?></p>
4728
					<?php } ?>
4729
					<p>
4730
						<?php
4731
						if( wp_get_referer() ) {
4732
							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() );
4733
						} else {
4734
							printf( __( '<a class="button-primary" href="%s">Activate Now</a>', 'jetpack' ) , $activate_url  );
4735
						} ?>
4736
					</p>
4737
				</div>
4738
4739
			</div>
4740
		</div>
4741
4742
		<?php
4743
	}
4744
4745
	public static function sort_modules( $a, $b ) {
4746
		if ( $a['sort'] == $b['sort'] )
4747
			return 0;
4748
4749
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4750
	}
4751
4752
	function ajax_recheck_ssl() {
4753
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4754
		$result = Jetpack::permit_ssl( true );
4755
		wp_send_json( array(
4756
			'enabled' => $result,
4757
			'message' => get_transient( 'jetpack_https_test_message' )
4758
		) );
4759
	}
4760
4761
/* Client API */
4762
4763
	/**
4764
	 * Returns the requested Jetpack API URL
4765
	 *
4766
	 * @return string
4767
	 */
4768
	public static function api_url( $relative_url ) {
4769
		return trailingslashit( JETPACK__API_BASE . $relative_url  ) . JETPACK__API_VERSION . '/';
4770
	}
4771
4772
	/**
4773
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4774
	 */
4775
	public static function fix_url_for_bad_hosts( $url ) {
4776
		if ( 0 !== strpos( $url, 'https://' ) ) {
4777
			return $url;
4778
		}
4779
4780
		switch ( JETPACK_CLIENT__HTTPS ) {
4781
			case 'ALWAYS' :
4782
				return $url;
4783
			case 'NEVER' :
4784
				return set_url_scheme( $url, 'http' );
4785
			// default : case 'AUTO' :
4786
		}
4787
4788
		// we now return the unmodified SSL URL by default, as a security precaution
4789
		return $url;
4790
	}
4791
4792
	/**
4793
	 * Create a random secret for validating onboarding payload
4794
	 *
4795
	 * @return string Secret token
4796
	 */
4797
	public static function create_onboarding_token() {
4798
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4799
			$token = wp_generate_password( 32, false );
4800
			Jetpack_Options::update_option( 'onboarding', $token );
4801
		}
4802
4803
		return $token;
4804
	}
4805
4806
	/**
4807
	 * Remove the onboarding token
4808
	 *
4809
	 * @return bool True on success, false on failure
4810
	 */
4811
	public static function invalidate_onboarding_token() {
4812
		return Jetpack_Options::delete_option( 'onboarding' );
4813
	}
4814
4815
	/**
4816
	 * Validate an onboarding token for a specific action
4817
	 *
4818
	 * @return boolean True if token/action pair is accepted, false if not
4819
	 */
4820
	public static function validate_onboarding_token_action( $token, $action ) {
4821
		// Compare tokens, bail if tokens do not match
4822
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
4823
			return false;
4824
		}
4825
4826
		// List of valid actions we can take
4827
		$valid_actions = array(
4828
			'/jetpack/v4/settings',
4829
		);
4830
4831
		// Whitelist the action
4832
		if ( ! in_array( $action, $valid_actions ) ) {
4833
			return false;
4834
		}
4835
4836
		return true;
4837
	}
4838
4839
	/**
4840
	 * Checks to see if the URL is using SSL to connect with Jetpack
4841
	 *
4842
	 * @since 2.3.3
4843
	 * @return boolean
4844
	 */
4845
	public static function permit_ssl( $force_recheck = false ) {
4846
		// Do some fancy tests to see if ssl is being supported
4847
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
4848
			$message = '';
4849
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
4850
				$ssl = 0;
4851
			} else {
4852
				switch ( JETPACK_CLIENT__HTTPS ) {
4853
					case 'NEVER':
4854
						$ssl = 0;
4855
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
4856
						break;
4857
					case 'ALWAYS':
4858
					case 'AUTO':
4859
					default:
4860
						$ssl = 1;
4861
						break;
4862
				}
4863
4864
				// If it's not 'NEVER', test to see
4865
				if ( $ssl ) {
4866
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
4867
						$ssl = 0;
4868
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
4869
					} else {
4870
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
4871
						if ( is_wp_error( $response ) ) {
4872
							$ssl = 0;
4873
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
4874
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
4875
							$ssl = 0;
4876
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
4877
						}
4878
					}
4879
				}
4880
			}
4881
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
4882
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
4883
		}
4884
4885
		return (bool) $ssl;
4886
	}
4887
4888
	/*
4889
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
4890
	 */
4891
	public function alert_auto_ssl_fail() {
4892
		if ( ! current_user_can( 'manage_options' ) )
4893
			return;
4894
4895
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
4896
		?>
4897
4898
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
4899
			<div class="jp-banner__content">
4900
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
4901
				<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>
4902
				<p>
4903
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
4904
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
4905
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
4906
				</p>
4907
				<p>
4908
					<?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' ),
4909
							esc_url( Jetpack::admin_url( array( 'page' => 'jetpack-debugger' )  ) ),
4910
							esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' ) ); ?>
4911
				</p>
4912
			</div>
4913
		</div>
4914
		<style>
4915
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
4916
		</style>
4917
		<script type="text/javascript">
4918
			jQuery( document ).ready( function( $ ) {
4919
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
4920
					var $this = $( this );
4921
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
4922
					$( '#jetpack-recheck-ssl-output' ).html( '' );
4923
					e.preventDefault();
4924
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
4925
					$.post( ajaxurl, data )
4926
					  .done( function( response ) {
4927
					  	if ( response.enabled ) {
4928
					  		$( '#jetpack-ssl-warning' ).hide();
4929
					  	} else {
4930
					  		this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
4931
					  		$( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
4932
					  	}
4933
					  }.bind( $this ) );
4934
				} );
4935
			} );
4936
		</script>
4937
4938
		<?php
4939
	}
4940
4941
	/**
4942
	 * Returns the Jetpack XML-RPC API
4943
	 *
4944
	 * @return string
4945
	 */
4946
	public static function xmlrpc_api_url() {
4947
		$base = preg_replace( '#(https?://[^?/]+)(/?.*)?$#', '\\1', JETPACK__API_BASE );
4948
		return untrailingslashit( $base ) . '/xmlrpc.php';
4949
	}
4950
4951
	/**
4952
	 * Creates two secret tokens and the end of life timestamp for them.
4953
	 *
4954
	 * Note these tokens are unique per call, NOT static per site for connecting.
4955
	 *
4956
	 * @since 2.6
4957
	 * @return array
4958
	 */
4959
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
4960
		if ( ! $user_id ) {
4961
			$user_id = get_current_user_id();
4962
		}
4963
4964
		$secret_name  = 'jetpack_' . $action . '_' . $user_id;
4965
		$secrets      = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4966
4967
		if (
4968
			isset( $secrets[ $secret_name ] ) &&
4969
			$secrets[ $secret_name ]['exp'] > time()
4970
		) {
4971
			return $secrets[ $secret_name ];
4972
		}
4973
4974
		$secret_value = array(
4975
			'secret_1'  => wp_generate_password( 32, false ),
4976
			'secret_2'  => wp_generate_password( 32, false ),
4977
			'exp'       => time() + $exp,
4978
		);
4979
4980
		$secrets[ $secret_name ] = $secret_value;
4981
4982
		Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
4983
		return $secrets[ $secret_name ];
4984
	}
4985
4986
	public static function get_secrets( $action, $user_id ) {
4987
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
4988
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
4989
4990
		if ( ! isset( $secrets[ $secret_name ] ) ) {
4991
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
4992
		}
4993
4994
		if ( $secrets[ $secret_name ]['exp'] < time() ) {
4995
			self::delete_secrets( $action, $user_id );
4996
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
4997
		}
4998
4999
		return $secrets[ $secret_name ];
5000
	}
5001
5002
	public static function delete_secrets( $action, $user_id ) {
5003
		$secret_name = 'jetpack_' . $action . '_' . $user_id;
5004
		$secrets = Jetpack_Options::get_raw_option( 'jetpack_secrets', array() );
5005
		if ( isset( $secrets[ $secret_name ] ) ) {
5006
			unset( $secrets[ $secret_name ] );
5007
			Jetpack_Options::update_raw_option( 'jetpack_secrets', $secrets );
5008
		}
5009
	}
5010
5011
	/**
5012
	 * Builds the timeout limit for queries talking with the wpcom servers.
5013
	 *
5014
	 * Based on local php max_execution_time in php.ini
5015
	 *
5016
	 * @since 2.6
5017
	 * @return int
5018
	 * @deprecated
5019
	 **/
5020
	public function get_remote_query_timeout_limit() {
5021
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5022
		return Jetpack::get_max_execution_time();
5023
	}
5024
5025
	/**
5026
	 * Builds the timeout limit for queries talking with the wpcom servers.
5027
	 *
5028
	 * Based on local php max_execution_time in php.ini
5029
	 *
5030
	 * @since 5.4
5031
	 * @return int
5032
	 **/
5033
	public static function get_max_execution_time() {
5034
		$timeout = (int) ini_get( 'max_execution_time' );
5035
5036
		// Ensure exec time set in php.ini
5037
		if ( ! $timeout ) {
5038
			$timeout = 30;
5039
		}
5040
		return $timeout;
5041
	}
5042
5043
	/**
5044
	 * Sets a minimum request timeout, and returns the current timeout
5045
	 *
5046
	 * @since 5.4
5047
	 **/
5048
	public static function set_min_time_limit( $min_timeout ) {
5049
		$timeout = self::get_max_execution_time();
5050
		if ( $timeout < $min_timeout ) {
5051
			$timeout = $min_timeout;
5052
			set_time_limit( $timeout );
5053
		}
5054
		return $timeout;
5055
	}
5056
5057
5058
	/**
5059
	 * Takes the response from the Jetpack register new site endpoint and
5060
	 * verifies it worked properly.
5061
	 *
5062
	 * @since 2.6
5063
	 * @return string|Jetpack_Error A JSON object on success or Jetpack_Error on failures
5064
	 **/
5065
	public function validate_remote_register_response( $response ) {
5066
	  if ( is_wp_error( $response ) ) {
5067
			return new Jetpack_Error( 'register_http_request_failed', $response->get_error_message() );
5068
		}
5069
5070
		$code   = wp_remote_retrieve_response_code( $response );
5071
		$entity = wp_remote_retrieve_body( $response );
5072
		if ( $entity )
5073
			$registration_response = json_decode( $entity );
5074
		else
5075
			$registration_response = false;
5076
5077
		$code_type = intval( $code / 100 );
5078
		if ( 5 == $code_type ) {
5079
			return new Jetpack_Error( 'wpcom_5??', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5080
		} elseif ( 408 == $code ) {
5081
			return new Jetpack_Error( 'wpcom_408', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5082
		} elseif ( ! empty( $registration_response->error ) ) {
5083
			if ( 'xml_rpc-32700' == $registration_response->error && ! function_exists( 'xml_parser_create' ) ) {
5084
				$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' );
5085
			} else {
5086
				$error_description = isset( $registration_response->error_description ) ? sprintf( __( 'Error Details: %s', 'jetpack' ), (string) $registration_response->error_description ) : '';
5087
			}
5088
5089
			return new Jetpack_Error( (string) $registration_response->error, $error_description, $code );
5090
		} elseif ( 200 != $code ) {
5091
			return new Jetpack_Error( 'wpcom_bad_response', sprintf( __( 'Error Details: %s', 'jetpack' ), $code ), $code );
5092
		}
5093
5094
		// Jetpack ID error block
5095
		if ( empty( $registration_response->jetpack_id ) ) {
5096
			return new Jetpack_Error( 'jetpack_id', sprintf( __( 'Error Details: Jetpack ID is empty. Do not publicly post this error message! %s', 'jetpack' ), $entity ), $entity );
5097
		} elseif ( ! is_scalar( $registration_response->jetpack_id ) ) {
5098
			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 );
5099
		} elseif ( preg_match( '/[^0-9]/', $registration_response->jetpack_id ) ) {
5100
			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 );
5101
		}
5102
5103
	    return $registration_response;
5104
	}
5105
	/**
5106
	 * @return bool|WP_Error
5107
	 */
5108
	public static function register() {
5109
		JetpackTracking::record_user_event( 'jpc_register_begin' );
5110
		add_action( 'pre_update_jetpack_option_register', array( 'Jetpack_Options', 'delete_option' ) );
5111
		$secrets = Jetpack::generate_secrets( 'register' );
5112
5113 View Code Duplication
		if (
5114
			empty( $secrets['secret_1'] ) ||
5115
			empty( $secrets['secret_2'] ) ||
5116
			empty( $secrets['exp'] )
5117
		) {
5118
			return new Jetpack_Error( 'missing_secrets' );
5119
		}
5120
5121
		// better to try (and fail) to set a higher timeout than this system
5122
		// supports than to have register fail for more users than it should
5123
		$timeout = Jetpack::set_min_time_limit( 60 ) / 2;
5124
5125
		$gmt_offset = get_option( 'gmt_offset' );
5126
		if ( ! $gmt_offset ) {
5127
			$gmt_offset = 0;
5128
		}
5129
5130
		$stats_options = get_option( 'stats_options' );
5131
		$stats_id = isset($stats_options['blog_id']) ? $stats_options['blog_id'] : null;
5132
5133
		$tracks_identity = jetpack_tracks_get_identity( get_current_user_id() );
5134
5135
		$args = array(
5136
			'method'  => 'POST',
5137
			'body'    => array(
5138
				'siteurl'         => site_url(),
5139
				'home'            => home_url(),
5140
				'gmt_offset'      => $gmt_offset,
5141
				'timezone_string' => (string) get_option( 'timezone_string' ),
5142
				'site_name'       => (string) get_option( 'blogname' ),
5143
				'secret_1'        => $secrets['secret_1'],
5144
				'secret_2'        => $secrets['secret_2'],
5145
				'site_lang'       => get_locale(),
5146
				'timeout'         => $timeout,
5147
				'stats_id'        => $stats_id,
5148
				'state'           => get_current_user_id(),
5149
				'_ui'             => $tracks_identity['_ui'],
5150
				'_ut'             => $tracks_identity['_ut'],
5151
				'jetpack_version' => JETPACK__VERSION
5152
			),
5153
			'headers' => array(
5154
				'Accept' => 'application/json',
5155
			),
5156
			'timeout' => $timeout,
5157
		);
5158
5159
		self::apply_activation_source_to_args( $args['body'] );
5160
5161
		$response = Jetpack_Client::_wp_remote_request( Jetpack::fix_url_for_bad_hosts( Jetpack::api_url( 'register' ) ), $args, true );
5162
5163
		// Make sure the response is valid and does not contain any Jetpack errors
5164
		$registration_details = Jetpack::init()->validate_remote_register_response( $response );
5165
		if ( is_wp_error( $registration_details ) ) {
5166
			return $registration_details;
5167
		} elseif ( ! $registration_details ) {
5168
			return new Jetpack_Error( 'unknown_error', __( 'Unknown error registering your Jetpack site', 'jetpack' ), wp_remote_retrieve_response_code( $response ) );
5169
		}
5170
5171 View Code Duplication
		if ( empty( $registration_details->jetpack_secret ) || ! is_string( $registration_details->jetpack_secret ) ) {
5172
			return new Jetpack_Error( 'jetpack_secret', '', wp_remote_retrieve_response_code( $response ) );
5173
		}
5174
5175
		if ( isset( $registration_details->jetpack_public ) ) {
5176
			$jetpack_public = (int) $registration_details->jetpack_public;
5177
		} else {
5178
			$jetpack_public = false;
5179
		}
5180
5181
		Jetpack_Options::update_options(
5182
			array(
5183
				'id'         => (int)    $registration_details->jetpack_id,
5184
				'blog_token' => (string) $registration_details->jetpack_secret,
5185
				'public'     => $jetpack_public,
5186
			)
5187
		);
5188
5189
		/**
5190
		 * Fires when a site is registered on WordPress.com.
5191
		 *
5192
		 * @since 3.7.0
5193
		 *
5194
		 * @param int $json->jetpack_id Jetpack Blog ID.
5195
		 * @param string $json->jetpack_secret Jetpack Blog Token.
5196
		 * @param int|bool $jetpack_public Is the site public.
5197
		 */
5198
		do_action( 'jetpack_site_registered', $registration_details->jetpack_id, $registration_details->jetpack_secret, $jetpack_public );
5199
5200
		// Initialize Jump Start for the first and only time.
5201
		if ( ! Jetpack_Options::get_option( 'jumpstart' ) ) {
5202
			Jetpack_Options::update_option( 'jumpstart', 'new_connection' );
5203
5204
			$jetpack = Jetpack::init();
5205
5206
			$jetpack->stat( 'jumpstart', 'unique-views' );
5207
			$jetpack->do_stats( 'server_side' );
5208
		};
5209
5210
		return true;
5211
	}
5212
5213
	/**
5214
	 * If the db version is showing something other that what we've got now, bump it to current.
5215
	 *
5216
	 * @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...
5217
	 */
5218
	public static function maybe_set_version_option() {
5219
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5220
		if ( JETPACK__VERSION != $version ) {
5221
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5222
5223
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5224
				/** This action is documented in class.jetpack.php */
5225
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5226
			}
5227
5228
			return true;
5229
		}
5230
		return false;
5231
	}
5232
5233
/* Client Server API */
5234
5235
	/**
5236
	 * Loads the Jetpack XML-RPC client
5237
	 */
5238
	public static function load_xml_rpc_client() {
5239
		require_once ABSPATH . WPINC . '/class-IXR.php';
5240
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-ixr-client.php';
5241
	}
5242
5243
	/**
5244
	 * Resets the saved authentication state in between testing requests.
5245
	 */
5246
	public function reset_saved_auth_state() {
5247
		$this->xmlrpc_verification = null;
5248
		$this->rest_authentication_status = null;
5249
	}
5250
5251
	function verify_xml_rpc_signature() {
5252
		if ( $this->xmlrpc_verification ) {
5253
			return $this->xmlrpc_verification;
5254
		}
5255
5256
		// It's not for us
5257
		if ( ! isset( $_GET['token'] ) || empty( $_GET['signature'] ) ) {
5258
			return false;
5259
		}
5260
5261
		@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...
5262
		if (
5263
			empty( $token_key )
5264
		||
5265
			empty( $version ) || strval( JETPACK__API_VERSION ) !== $version
5266
		) {
5267
			return false;
5268
		}
5269
5270
		if ( '0' === $user_id ) {
5271
			$token_type = 'blog';
5272
			$user_id = 0;
5273
		} else {
5274
			$token_type = 'user';
5275
			if ( empty( $user_id ) || ! ctype_digit( $user_id ) ) {
5276
				return false;
5277
			}
5278
			$user_id = (int) $user_id;
5279
5280
			$user = new WP_User( $user_id );
5281
			if ( ! $user || ! $user->exists() ) {
5282
				return false;
5283
			}
5284
		}
5285
5286
		$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...
5287
		if ( ! $token ) {
5288
			return false;
5289
		}
5290
5291
		$token_check = "$token_key.";
5292
		if ( ! hash_equals( substr( $token->secret, 0, strlen( $token_check ) ), $token_check ) ) {
5293
			return false;
5294
		}
5295
5296
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5297
5298
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5299
		if ( isset( $_POST['_jetpack_is_multipart'] ) ) {
5300
			$post_data   = $_POST;
5301
			$file_hashes = array();
5302
			foreach ( $post_data as $post_data_key => $post_data_value ) {
5303
				if ( 0 !== strpos( $post_data_key, '_jetpack_file_hmac_' ) ) {
5304
					continue;
5305
				}
5306
				$post_data_key = substr( $post_data_key, strlen( '_jetpack_file_hmac_' ) );
5307
				$file_hashes[$post_data_key] = $post_data_value;
5308
			}
5309
5310
			foreach ( $file_hashes as $post_data_key => $post_data_value ) {
5311
				unset( $post_data["_jetpack_file_hmac_{$post_data_key}"] );
5312
				$post_data[$post_data_key] = $post_data_value;
5313
			}
5314
5315
			ksort( $post_data );
5316
5317
			$body = http_build_query( stripslashes_deep( $post_data ) );
5318
		} elseif ( is_null( $this->HTTP_RAW_POST_DATA ) ) {
5319
			$body = file_get_contents( 'php://input' );
5320
		} else {
5321
			$body = null;
5322
		}
5323
5324
		$signature = $jetpack_signature->sign_current_request(
5325
			array( 'body' => is_null( $body ) ? $this->HTTP_RAW_POST_DATA : $body, )
5326
		);
5327
5328
		if ( ! $signature ) {
5329
			return false;
5330
		} else if ( is_wp_error( $signature ) ) {
5331
			return $signature;
5332
		} else if ( ! hash_equals( $signature, $_GET['signature'] ) ) {
5333
			return false;
5334
		}
5335
5336
		$timestamp = (int) $_GET['timestamp'];
5337
		$nonce     = stripslashes( (string) $_GET['nonce'] );
5338
5339
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5340
			return false;
5341
		}
5342
5343
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5344
		if ( isset( $this->HTTP_RAW_POST_DATA ) || ! empty( $_GET['onboarding'] ) ) {
5345
			if ( ! empty( $_GET['onboarding'] ) ) {
5346
				$jpo = $_GET;
5347
			} else {
5348
				$jpo = json_decode( $this->HTTP_RAW_POST_DATA, true );
5349
			}
5350
5351
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5352
			$jpo_user = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5353
5354
			if (
5355
				isset( $jpo_user ) && isset( $jpo_token ) &&
5356
				is_email( $jpo_user ) && ctype_alnum( $jpo_token ) &&
5357
				isset( $_GET['rest_route'] ) &&
5358
				self::validate_onboarding_token_action( $jpo_token, $_GET['rest_route'] )
5359
			) {
5360
				$jpUser = get_user_by( 'email', $jpo_user );
5361
				if ( is_a( $jpUser, 'WP_User' ) ) {
5362
					wp_set_current_user( $jpUser->ID );
5363
					$user_can = is_multisite()
5364
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5365
						: current_user_can( 'manage_options' );
5366
					if ( $user_can ) {
5367
						$token_type = 'user';
5368
						$token->external_user_id = $jpUser->ID;
5369
					}
5370
				}
5371
			}
5372
		}
5373
5374
		$this->xmlrpc_verification = array(
5375
			'type'    => $token_type,
5376
			'user_id' => $token->external_user_id,
5377
		);
5378
5379
		return $this->xmlrpc_verification;
5380
	}
5381
5382
	/**
5383
	 * Authenticates XML-RPC and other requests from the Jetpack Server
5384
	 */
5385
	function authenticate_jetpack( $user, $username, $password ) {
5386
		if ( is_a( $user, 'WP_User' ) ) {
5387
			return $user;
5388
		}
5389
5390
		$token_details = $this->verify_xml_rpc_signature();
5391
5392
		if ( ! $token_details || is_wp_error( $token_details ) ) {
5393
			return $user;
5394
		}
5395
5396
		if ( 'user' !== $token_details['type'] ) {
5397
			return $user;
5398
		}
5399
5400
		if ( ! $token_details['user_id'] ) {
5401
			return $user;
5402
		}
5403
5404
		nocache_headers();
5405
5406
		return new WP_User( $token_details['user_id'] );
5407
	}
5408
5409
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5410
	// Uses the existing XMLRPC request signing implementation.
5411
	function wp_rest_authenticate( $user ) {
5412
		if ( ! empty( $user ) ) {
5413
			// Another authentication method is in effect.
5414
			return $user;
5415
		}
5416
5417
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5418
			// Nothing to do for this authentication method.
5419
			return null;
5420
		}
5421
5422
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5423
			// Nothing to do for this authentication method.
5424
			return null;
5425
		}
5426
5427
		// Ensure that we always have the request body available.  At this
5428
		// point, the WP REST API code to determine the request body has not
5429
		// run yet.  That code may try to read from 'php://input' later, but
5430
		// this can only be done once per request in PHP versions prior to 5.6.
5431
		// So we will go ahead and perform this read now if needed, and save
5432
		// the request body where both the Jetpack signature verification code
5433
		// and the WP REST API code can see it.
5434
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5435
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5436
		}
5437
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5438
5439
		// Only support specific request parameters that have been tested and
5440
		// are known to work with signature verification.  A different method
5441
		// can be passed to the WP REST API via the '?_method=' parameter if
5442
		// needed.
5443
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5444
			$this->rest_authentication_status = new WP_Error(
5445
				'rest_invalid_request',
5446
				__( 'This request method is not supported.', 'jetpack' ),
5447
				array( 'status' => 400 )
5448
			);
5449
			return null;
5450
		}
5451
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5452
			$this->rest_authentication_status = new WP_Error(
5453
				'rest_invalid_request',
5454
				__( 'This request method does not support body parameters.', 'jetpack' ),
5455
				array( 'status' => 400 )
5456
			);
5457
			return null;
5458
		}
5459
5460
		if ( ! empty( $_SERVER['CONTENT_TYPE'] ) ) {
5461
			$content_type = $_SERVER['CONTENT_TYPE'];
5462
		} elseif ( ! empty( $_SERVER['HTTP_CONTENT_TYPE'] ) ) {
5463
			$content_type = $_SERVER['HTTP_CONTENT_TYPE'];
5464
		}
5465
5466
		if (
5467
			isset( $content_type ) &&
5468
			$content_type !== 'application/x-www-form-urlencoded' &&
5469
			$content_type !== 'application/json'
5470
		) {
5471
			$this->rest_authentication_status = new WP_Error(
5472
				'rest_invalid_request',
5473
				__( 'This Content-Type is not supported.', 'jetpack' ),
5474
				array( 'status' => 400 )
5475
			);
5476
			return null;
5477
		}
5478
5479
		$verified = $this->verify_xml_rpc_signature();
5480
5481
		if ( is_wp_error( $verified ) ) {
5482
			$this->rest_authentication_status = $verified;
5483
			return null;
5484
		}
5485
5486
		if (
5487
			$verified &&
5488
			isset( $verified['type'] ) &&
5489
			'user' === $verified['type'] &&
5490
			! empty( $verified['user_id'] )
5491
		) {
5492
			// Authentication successful.
5493
			$this->rest_authentication_status = true;
5494
			return $verified['user_id'];
5495
		}
5496
5497
		// Something else went wrong.  Probably a signature error.
5498
		$this->rest_authentication_status = new WP_Error(
5499
			'rest_invalid_signature',
5500
			__( 'The request is not signed correctly.', 'jetpack' ),
5501
			array( 'status' => 400 )
5502
		);
5503
		return null;
5504
	}
5505
5506
	/**
5507
	 * Report authentication status to the WP REST API.
5508
	 *
5509
	 * @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...
5510
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5511
	 */
5512
	public function wp_rest_authentication_errors( $value ) {
5513
		if ( $value !== null ) {
5514
			return $value;
5515
		}
5516
		return $this->rest_authentication_status;
5517
	}
5518
5519
	function add_nonce( $timestamp, $nonce ) {
5520
		global $wpdb;
5521
		static $nonces_used_this_request = array();
5522
5523
		if ( isset( $nonces_used_this_request["$timestamp:$nonce"] ) ) {
5524
			return $nonces_used_this_request["$timestamp:$nonce"];
5525
		}
5526
5527
		// This should always have gone through Jetpack_Signature::sign_request() first to check $timestamp an $nonce
5528
		$timestamp = (int) $timestamp;
5529
		$nonce     = esc_sql( $nonce );
5530
5531
		// Raw query so we can avoid races: add_option will also update
5532
		$show_errors = $wpdb->show_errors( false );
5533
5534
		$old_nonce = $wpdb->get_row(
5535
			$wpdb->prepare( "SELECT * FROM `$wpdb->options` WHERE option_name = %s", "jetpack_nonce_{$timestamp}_{$nonce}" )
5536
		);
5537
5538
		if ( is_null( $old_nonce ) ) {
5539
			$return = $wpdb->query(
5540
				$wpdb->prepare(
5541
					"INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s)",
5542
					"jetpack_nonce_{$timestamp}_{$nonce}",
5543
					time(),
5544
					'no'
5545
				)
5546
			);
5547
		} else {
5548
			$return = false;
5549
		}
5550
5551
		$wpdb->show_errors( $show_errors );
5552
5553
		$nonces_used_this_request["$timestamp:$nonce"] = $return;
5554
5555
		return $return;
5556
	}
5557
5558
	/**
5559
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5560
	 * Capture it here so we can verify the signature later.
5561
	 */
5562
	function xmlrpc_methods( $methods ) {
5563
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5564
		return $methods;
5565
	}
5566
5567
	function public_xmlrpc_methods( $methods ) {
5568
		if ( array_key_exists( 'wp.getOptions', $methods ) ) {
5569
			$methods['wp.getOptions'] = array( $this, 'jetpack_getOptions' );
5570
		}
5571
		return $methods;
5572
	}
5573
5574
	function jetpack_getOptions( $args ) {
5575
		global $wp_xmlrpc_server;
5576
5577
		$wp_xmlrpc_server->escape( $args );
5578
5579
		$username	= $args[1];
5580
		$password	= $args[2];
5581
5582
		if ( !$user = $wp_xmlrpc_server->login($username, $password) ) {
5583
			return $wp_xmlrpc_server->error;
5584
		}
5585
5586
		$options = array();
5587
		$user_data = $this->get_connected_user_data();
5588
		if ( is_array( $user_data ) ) {
5589
			$options['jetpack_user_id'] = array(
5590
				'desc'          => __( 'The WP.com user ID of the connected user', 'jetpack' ),
5591
				'readonly'      => true,
5592
				'value'         => $user_data['ID'],
5593
			);
5594
			$options['jetpack_user_login'] = array(
5595
				'desc'          => __( 'The WP.com username of the connected user', 'jetpack' ),
5596
				'readonly'      => true,
5597
				'value'         => $user_data['login'],
5598
			);
5599
			$options['jetpack_user_email'] = array(
5600
				'desc'          => __( 'The WP.com user email of the connected user', 'jetpack' ),
5601
				'readonly'      => true,
5602
				'value'         => $user_data['email'],
5603
			);
5604
			$options['jetpack_user_site_count'] = array(
5605
				'desc'          => __( 'The number of sites of the connected WP.com user', 'jetpack' ),
5606
				'readonly'      => true,
5607
				'value'         => $user_data['site_count'],
5608
			);
5609
		}
5610
		$wp_xmlrpc_server->blog_options = array_merge( $wp_xmlrpc_server->blog_options, $options );
5611
		$args = stripslashes_deep( $args );
5612
		return $wp_xmlrpc_server->wp_getOptions( $args );
5613
	}
5614
5615
	function xmlrpc_options( $options ) {
5616
		$jetpack_client_id = false;
5617
		if ( self::is_active() ) {
5618
			$jetpack_client_id = Jetpack_Options::get_option( 'id' );
5619
		}
5620
		$options['jetpack_version'] = array(
5621
				'desc'          => __( 'Jetpack Plugin Version', 'jetpack' ),
5622
				'readonly'      => true,
5623
				'value'         => JETPACK__VERSION,
5624
		);
5625
5626
		$options['jetpack_client_id'] = array(
5627
				'desc'          => __( 'The Client ID/WP.com Blog ID of this site', 'jetpack' ),
5628
				'readonly'      => true,
5629
				'value'         => $jetpack_client_id,
5630
		);
5631
		return $options;
5632
	}
5633
5634
	public static function clean_nonces( $all = false ) {
5635
		global $wpdb;
5636
5637
		$sql = "DELETE FROM `$wpdb->options` WHERE `option_name` LIKE %s";
5638
		$sql_args = array( $wpdb->esc_like( 'jetpack_nonce_' ) . '%' );
5639
5640
		if ( true !== $all ) {
5641
			$sql .= ' AND CAST( `option_value` AS UNSIGNED ) < %d';
5642
			$sql_args[] = time() - 3600;
5643
		}
5644
5645
		$sql .= ' ORDER BY `option_id` LIMIT 100';
5646
5647
		$sql = $wpdb->prepare( $sql, $sql_args );
5648
5649
		for ( $i = 0; $i < 1000; $i++ ) {
5650
			if ( ! $wpdb->query( $sql ) ) {
5651
				break;
5652
			}
5653
		}
5654
	}
5655
5656
	/**
5657
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5658
	 * SET: state( $key, $value );
5659
	 * GET: $value = state( $key );
5660
	 *
5661
	 * @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...
5662
	 * @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...
5663
	 * @param bool $restate private
5664
	 */
5665
	public static function state( $key = null, $value = null, $restate = false ) {
5666
		static $state = array();
5667
		static $path, $domain;
5668
		if ( ! isset( $path ) ) {
5669
			require_once( ABSPATH . 'wp-admin/includes/plugin.php' );
5670
			$admin_url = Jetpack::admin_url();
5671
			$bits      = parse_url( $admin_url );
5672
5673
			if ( is_array( $bits ) ) {
5674
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5675
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5676
			} else {
5677
				$path = $domain = null;
5678
			}
5679
		}
5680
5681
		// Extract state from cookies and delete cookies
5682
		if ( isset( $_COOKIE[ 'jetpackState' ] ) && is_array( $_COOKIE[ 'jetpackState' ] ) ) {
5683
			$yum = $_COOKIE[ 'jetpackState' ];
5684
			unset( $_COOKIE[ 'jetpackState' ] );
5685
			foreach ( $yum as $k => $v ) {
5686
				if ( strlen( $v ) )
5687
					$state[ $k ] = $v;
5688
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5689
			}
5690
		}
5691
5692
		if ( $restate ) {
5693
			foreach ( $state as $k => $v ) {
5694
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5695
			}
5696
			return;
5697
		}
5698
5699
		// Get a state variable
5700
		if ( isset( $key ) && ! isset( $value ) ) {
5701
			if ( array_key_exists( $key, $state ) )
5702
				return $state[ $key ];
5703
			return null;
5704
		}
5705
5706
		// Set a state variable
5707
		if ( isset ( $key ) && isset( $value ) ) {
5708
			if( is_array( $value ) && isset( $value[0] ) ) {
5709
				$value = $value[0];
5710
			}
5711
			$state[ $key ] = $value;
5712
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5713
		}
5714
	}
5715
5716
	public static function restate() {
5717
		Jetpack::state( null, null, true );
5718
	}
5719
5720
	public static function check_privacy( $file ) {
5721
		static $is_site_publicly_accessible = null;
5722
5723
		if ( is_null( $is_site_publicly_accessible ) ) {
5724
			$is_site_publicly_accessible = false;
5725
5726
			Jetpack::load_xml_rpc_client();
5727
			$rpc = new Jetpack_IXR_Client();
5728
5729
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5730
			if ( $success ) {
5731
				$response = $rpc->getResponse();
5732
				if ( $response ) {
5733
					$is_site_publicly_accessible = true;
5734
				}
5735
			}
5736
5737
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5738
		}
5739
5740
		if ( $is_site_publicly_accessible ) {
5741
			return;
5742
		}
5743
5744
		$module_slug = self::get_module_slug( $file );
5745
5746
		$privacy_checks = Jetpack::state( 'privacy_checks' );
5747
		if ( ! $privacy_checks ) {
5748
			$privacy_checks = $module_slug;
5749
		} else {
5750
			$privacy_checks .= ",$module_slug";
5751
		}
5752
5753
		Jetpack::state( 'privacy_checks', $privacy_checks );
5754
	}
5755
5756
	/**
5757
	 * Helper method for multicall XMLRPC.
5758
	 */
5759
	public static function xmlrpc_async_call() {
5760
		global $blog_id;
5761
		static $clients = array();
5762
5763
		$client_blog_id = is_multisite() ? $blog_id : 0;
5764
5765
		if ( ! isset( $clients[$client_blog_id] ) ) {
5766
			Jetpack::load_xml_rpc_client();
5767
			$clients[$client_blog_id] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER, ) );
5768
			if ( function_exists( 'ignore_user_abort' ) ) {
5769
				ignore_user_abort( true );
5770
			}
5771
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5772
		}
5773
5774
		$args = func_get_args();
5775
5776
		if ( ! empty( $args[0] ) ) {
5777
			call_user_func_array( array( $clients[$client_blog_id], 'addCall' ), $args );
5778
		} elseif ( is_multisite() ) {
5779
			foreach ( $clients as $client_blog_id => $client ) {
5780
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5781
					continue;
5782
				}
5783
5784
				$switch_success = switch_to_blog( $client_blog_id, true );
5785
				if ( ! $switch_success ) {
5786
					continue;
5787
				}
5788
5789
				flush();
5790
				$client->query();
5791
5792
				restore_current_blog();
5793
			}
5794
		} else {
5795
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5796
				flush();
5797
				$clients[0]->query();
5798
			}
5799
		}
5800
	}
5801
5802
	public static function staticize_subdomain( $url ) {
5803
5804
		// Extract hostname from URL
5805
		$host = parse_url( $url, PHP_URL_HOST );
5806
5807
		// Explode hostname on '.'
5808
		$exploded_host = explode( '.', $host );
5809
5810
		// Retrieve the name and TLD
5811
		if ( count( $exploded_host ) > 1 ) {
5812
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5813
			$tld = $exploded_host[ count( $exploded_host ) - 1 ];
5814
			// Rebuild domain excluding subdomains
5815
			$domain = $name . '.' . $tld;
5816
		} else {
5817
			$domain = $host;
5818
		}
5819
		// Array of Automattic domains
5820
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5821
5822
		// Return $url if not an Automattic domain
5823
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5824
			return $url;
5825
		}
5826
5827
		if ( is_ssl() ) {
5828
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5829
		}
5830
5831
		srand( crc32( basename( $url ) ) );
5832
		$static_counter = rand( 0, 2 );
5833
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5834
5835
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5836
	}
5837
5838
/* JSON API Authorization */
5839
5840
	/**
5841
	 * Handles the login action for Authorizing the JSON API
5842
	 */
5843
	function login_form_json_api_authorization() {
5844
		$this->verify_json_api_authorization_request();
5845
5846
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5847
5848
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5849
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5850
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5851
	}
5852
5853
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5854
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5855
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5856
			return $url;
5857
		}
5858
5859
		$parsed_url = parse_url( $url );
5860
		$url = strtok( $url, '?' );
5861
		$url = "$url?{$_SERVER['QUERY_STRING']}";
5862
		if ( ! empty( $parsed_url['query'] ) )
5863
			$url .= "&{$parsed_url['query']}";
5864
5865
		return $url;
5866
	}
5867
5868
	// Make sure the POSTed request is handled by the same action
5869
	function preserve_action_in_login_form_for_json_api_authorization() {
5870
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5871
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5872
	}
5873
5874
	// If someone logs in to approve API access, store the Access Code in usermeta
5875
	function store_json_api_authorization_token( $user_login, $user ) {
5876
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5877
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5878
		$token = wp_generate_password( 32, false );
5879
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5880
	}
5881
5882
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5883
	function allow_wpcom_public_api_domain( $domains ) {
5884
		$domains[] = 'public-api.wordpress.com';
5885
		return $domains;
5886
	}
5887
5888
	// Add the Access Code details to the public-api.wordpress.com redirect
5889
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5890
		return add_query_arg(
5891
			urlencode_deep(
5892
				array(
5893
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5894
					'jetpack-user-id' => (int) $user->ID,
5895
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5896
				)
5897
			),
5898
			$redirect_to
5899
		);
5900
	}
5901
5902
5903
	/**
5904
	 * Verifies the request by checking the signature
5905
	 *
5906
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5907
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5908
	 *
5909
	 * @param null|array $environment
5910
	 */
5911
	function verify_json_api_authorization_request( $environment = null ) {
5912
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-signature.php';
5913
5914
		$environment = is_null( $environment )
5915
			? $_REQUEST
5916
			: $environment;
5917
5918
		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...
5919
		$token = Jetpack_Data::get_access_token( $envUserId );
5920
		if ( ! $token || empty( $token->secret ) ) {
5921
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.' , 'jetpack' ) );
5922
		}
5923
5924
		$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' );
5925
5926
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5927
5928
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5929
			$signature = $jetpack_signature->sign_request(
5930
				$environment['token'],
5931
				$environment['timestamp'],
5932
				$environment['nonce'],
5933
				'',
5934
				'GET',
5935
				$environment['jetpack_json_api_original_query'],
5936
				null,
5937
				true
5938
			);
5939
		} else {
5940
			$signature = $jetpack_signature->sign_current_request( array( 'body' => null, 'method' => 'GET' ) );
5941
		}
5942
5943
		if ( ! $signature ) {
5944
			wp_die( $die_error );
5945
		} else if ( is_wp_error( $signature ) ) {
5946
			wp_die( $die_error );
5947
		} else if ( ! hash_equals( $signature, $environment['signature'] ) ) {
5948
			if ( is_ssl() ) {
5949
				// 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
5950
				$signature = $jetpack_signature->sign_current_request( array( 'scheme' => 'http', 'body' => null, 'method' => 'GET' ) );
5951
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5952
					wp_die( $die_error );
5953
				}
5954
			} else {
5955
				wp_die( $die_error );
5956
			}
5957
		}
5958
5959
		$timestamp = (int) $environment['timestamp'];
5960
		$nonce     = stripslashes( (string) $environment['nonce'] );
5961
5962
		if ( ! $this->add_nonce( $timestamp, $nonce ) ) {
5963
			// De-nonce the nonce, at least for 5 minutes.
5964
			// 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)
5965
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5966
			if ( $old_nonce_time < time() - 300 ) {
5967
				wp_die( __( 'The authorization process expired.  Please go back and try again.' , 'jetpack' ) );
5968
			}
5969
		}
5970
5971
		$data = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5972
		$data_filters = array(
5973
			'state'        => 'opaque',
5974
			'client_id'    => 'int',
5975
			'client_title' => 'string',
5976
			'client_image' => 'url',
5977
		);
5978
5979
		foreach ( $data_filters as $key => $sanitation ) {
5980
			if ( ! isset( $data->$key ) ) {
5981
				wp_die( $die_error );
5982
			}
5983
5984
			switch ( $sanitation ) {
5985
			case 'int' :
5986
				$this->json_api_authorization_request[$key] = (int) $data->$key;
5987
				break;
5988
			case 'opaque' :
5989
				$this->json_api_authorization_request[$key] = (string) $data->$key;
5990
				break;
5991
			case 'string' :
5992
				$this->json_api_authorization_request[$key] = wp_kses( (string) $data->$key, array() );
5993
				break;
5994
			case 'url' :
5995
				$this->json_api_authorization_request[$key] = esc_url_raw( (string) $data->$key );
5996
				break;
5997
			}
5998
		}
5999
6000
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6001
			wp_die( $die_error );
6002
		}
6003
	}
6004
6005
	function login_message_json_api_authorization( $message ) {
6006
		return '<p class="message">' . sprintf(
6007
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.' , 'jetpack' ),
6008
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6009
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6010
	}
6011
6012
	/**
6013
	 * Get $content_width, but with a <s>twist</s> filter.
6014
	 */
6015
	public static function get_content_width() {
6016
		$content_width = isset( $GLOBALS['content_width'] ) ? $GLOBALS['content_width'] : false;
6017
		/**
6018
		 * Filter the Content Width value.
6019
		 *
6020
		 * @since 2.2.3
6021
		 *
6022
		 * @param string $content_width Content Width value.
6023
		 */
6024
		return apply_filters( 'jetpack_content_width', $content_width );
6025
	}
6026
6027
	/**
6028
	 * Pings the WordPress.com Mirror Site for the specified options.
6029
	 *
6030
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6031
	 *
6032
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6033
	 */
6034
	public function get_cloud_site_options( $option_names ) {
6035
		$option_names = array_filter( (array) $option_names, 'is_string' );
6036
6037
		Jetpack::load_xml_rpc_client();
6038
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER, ) );
6039
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6040
		if ( $xml->isError() ) {
6041
			return array(
6042
				'error_code' => $xml->getErrorCode(),
6043
				'error_msg'  => $xml->getErrorMessage(),
6044
			);
6045
		}
6046
		$cloud_site_options = $xml->getResponse();
6047
6048
		return $cloud_site_options;
6049
	}
6050
6051
	/**
6052
	 * Checks if the site is currently in an identity crisis.
6053
	 *
6054
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6055
	 */
6056
	public static function check_identity_crisis() {
6057
		if ( ! Jetpack::is_active() || Jetpack::is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6058
			return false;
6059
		}
6060
6061
		return Jetpack_Options::get_option( 'sync_error_idc' );
6062
	}
6063
6064
	/**
6065
	 * Checks whether the home and siteurl specifically are whitelisted
6066
	 * Written so that we don't have re-check $key and $value params every time
6067
	 * we want to check if this site is whitelisted, for example in footer.php
6068
	 *
6069
	 * @since  3.8.0
6070
	 * @return bool True = already whitelisted False = not whitelisted
6071
	 */
6072
	public static function is_staging_site() {
6073
		$is_staging = false;
6074
6075
		$known_staging = array(
6076
			'urls' => array(
6077
				'#\.staging\.wpengine\.com$#i', // WP Engine
6078
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6079
				),
6080
			'constants' => array(
6081
				'IS_WPE_SNAPSHOT',      // WP Engine
6082
				'KINSTA_DEV_ENV',       // Kinsta.com
6083
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6084
				'JETPACK_STAGING_MODE', // Generic
6085
				)
6086
			);
6087
		/**
6088
		 * Filters the flags of known staging sites.
6089
		 *
6090
		 * @since 3.9.0
6091
		 *
6092
		 * @param array $known_staging {
6093
		 *     An array of arrays that each are used to check if the current site is staging.
6094
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6095
		 *     @type array $constants PHP constants of known staging/developement environments.
6096
		 *  }
6097
		 */
6098
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6099
6100
		if ( isset( $known_staging['urls'] ) ) {
6101
			foreach ( $known_staging['urls'] as $url ){
6102
				if ( preg_match( $url, site_url() ) ) {
6103
					$is_staging = true;
6104
					break;
6105
				}
6106
			}
6107
		}
6108
6109
		if ( isset( $known_staging['constants'] ) ) {
6110
			foreach ( $known_staging['constants'] as $constant ) {
6111
				if ( defined( $constant ) && constant( $constant ) ) {
6112
					$is_staging = true;
6113
				}
6114
			}
6115
		}
6116
6117
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6118
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6119
			$is_staging = true;
6120
		}
6121
6122
		/**
6123
		 * Filters is_staging_site check.
6124
		 *
6125
		 * @since 3.9.0
6126
		 *
6127
		 * @param bool $is_staging If the current site is a staging site.
6128
		 */
6129
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6130
	}
6131
6132
	/**
6133
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6134
	 *
6135
	 * @since 4.4.0
6136
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6137
	 *
6138
	 * @return bool
6139
	 */
6140
	public static function validate_sync_error_idc_option() {
6141
		$is_valid = false;
6142
6143
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6144
		if ( false === $idc_allowed ) {
6145
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6146
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6147
				$json = json_decode( wp_remote_retrieve_body( $response ) );
6148
				$idc_allowed = isset( $json, $json->result ) && $json->result ? '1' : '0';
6149
				$transient_duration = HOUR_IN_SECONDS;
6150
			} else {
6151
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6152
				$idc_allowed = '1';
6153
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6154
			}
6155
6156
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6157
		}
6158
6159
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6160
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6161
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6162
			$local_options = self::get_sync_error_idc_option();
6163
			if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6164
				$is_valid = true;
6165
			}
6166
		}
6167
6168
		/**
6169
		 * Filters whether the sync_error_idc option is valid.
6170
		 *
6171
		 * @since 4.4.0
6172
		 *
6173
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6174
		 */
6175
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6176
6177
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6178
			// Since the option exists, and did not validate, delete it
6179
			Jetpack_Options::delete_option( 'sync_error_idc' );
6180
		}
6181
6182
		return $is_valid;
6183
	}
6184
6185
	/**
6186
	 * Normalizes a url by doing three things:
6187
	 *  - Strips protocol
6188
	 *  - Strips www
6189
	 *  - Adds a trailing slash
6190
	 *
6191
	 * @since 4.4.0
6192
	 * @param string $url
6193
	 * @return WP_Error|string
6194
	 */
6195
	public static function normalize_url_protocol_agnostic( $url ) {
6196
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6197
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6198
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6199
		}
6200
6201
		// Strip www and protocols
6202
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6203
		return $url;
6204
	}
6205
6206
	/**
6207
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6208
	 *
6209
	 * @since 4.4.0
6210
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6211
	 *
6212
	 * @param array $response
6213
	 * @return array Array of the local urls, wpcom urls, and error code
6214
	 */
6215
	public static function get_sync_error_idc_option( $response = array() ) {
6216
		// Since the local options will hit the database directly, store the values
6217
		// in a transient to allow for autoloading and caching on subsequent views.
6218
		$local_options = get_transient( 'jetpack_idc_local' );
6219
		if ( false === $local_options ) {
6220
			require_once JETPACK__PLUGIN_DIR . 'sync/class.jetpack-sync-functions.php';
6221
			$local_options = array(
6222
				'home'    => Jetpack_Sync_Functions::home_url(),
6223
				'siteurl' => Jetpack_Sync_Functions::site_url(),
6224
			);
6225
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6226
		}
6227
6228
		$options = array_merge( $local_options, $response );
6229
6230
		$returned_values = array();
6231
		foreach( $options as $key => $option ) {
6232
			if ( 'error_code' === $key ) {
6233
				$returned_values[ $key ] = $option;
6234
				continue;
6235
			}
6236
6237
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6238
				continue;
6239
			}
6240
6241
			$returned_values[ $key ] = $normalized_url;
6242
		}
6243
6244
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6245
6246
		return $returned_values;
6247
	}
6248
6249
	/**
6250
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6251
	 * If set to true, the site will be put into staging mode.
6252
	 *
6253
	 * @since 4.3.2
6254
	 * @return bool
6255
	 */
6256
	public static function sync_idc_optin() {
6257
		if ( Jetpack_Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6258
			$default = Jetpack_Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6259
		} else {
6260
			$default = ! Jetpack_Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6261
		}
6262
6263
		/**
6264
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6265
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6266
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6267
		 *
6268
		 * @since 4.3.2
6269
		 *
6270
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6271
		 */
6272
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6273
	}
6274
6275
	/**
6276
	 * Maybe Use a .min.css stylesheet, maybe not.
6277
	 *
6278
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6279
	 */
6280
	public static function maybe_min_asset( $url, $path, $plugin ) {
6281
		// Short out on things trying to find actual paths.
6282
		if ( ! $path || empty( $plugin ) ) {
6283
			return $url;
6284
		}
6285
6286
		$path = ltrim( $path, '/' );
6287
6288
		// Strip out the abspath.
6289
		$base = dirname( plugin_basename( $plugin ) );
6290
6291
		// Short out on non-Jetpack assets.
6292
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6293
			return $url;
6294
		}
6295
6296
		// File name parsing.
6297
		$file              = "{$base}/{$path}";
6298
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6299
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6300
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6301
		$extension         = array_shift( $file_name_parts_r );
6302
6303
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6304
			// Already pointing at the minified version.
6305
			if ( 'min' === $file_name_parts_r[0] ) {
6306
				return $url;
6307
			}
6308
6309
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6310
			if ( file_exists( $min_full_path ) ) {
6311
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6312
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6313
				if ( 'css' === $extension ) {
6314
					$key = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6315
					self::$min_assets[ $key ] = $path;
6316
				}
6317
			}
6318
		}
6319
6320
		return $url;
6321
	}
6322
6323
	/**
6324
	 * If the asset is minified, let's flag .min as the suffix.
6325
	 *
6326
	 * Attached to `style_loader_src` filter.
6327
	 *
6328
	 * @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...
6329
	 * @param string $handle The registered handle of the script in question.
6330
	 * @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...
6331
	 */
6332
	public static function set_suffix_on_min( $src, $handle ) {
6333
		if ( false === strpos( $src, '.min.css' ) ) {
6334
			return $src;
6335
		}
6336
6337
		if ( ! empty( self::$min_assets ) ) {
6338
			foreach ( self::$min_assets as $file => $path ) {
6339
				if ( false !== strpos( $src, $file ) ) {
6340
					wp_style_add_data( $handle, 'suffix', '.min' );
6341
					return $src;
6342
				}
6343
			}
6344
		}
6345
6346
		return $src;
6347
	}
6348
6349
	/**
6350
	 * Maybe inlines a stylesheet.
6351
	 *
6352
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6353
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6354
	 *
6355
	 * Attached to `style_loader_tag` filter.
6356
	 *
6357
	 * @param string $tag The tag that would link to the external asset.
6358
	 * @param string $handle The registered handle of the script in question.
6359
	 *
6360
	 * @return string
6361
	 */
6362
	public static function maybe_inline_style( $tag, $handle ) {
6363
		global $wp_styles;
6364
		$item = $wp_styles->registered[ $handle ];
6365
6366
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6367
			return $tag;
6368
		}
6369
6370
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6371
			$href = $matches[1];
6372
			// Strip off query string
6373
			if ( $pos = strpos( $href, '?' ) ) {
6374
				$href = substr( $href, 0, $pos );
6375
			}
6376
			// Strip off fragment
6377
			if ( $pos = strpos( $href, '#' ) ) {
6378
				$href = substr( $href, 0, $pos );
6379
			}
6380
		} else {
6381
			return $tag;
6382
		}
6383
6384
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6385
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6386
			return $tag;
6387
		}
6388
6389
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6390
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6391
			// And this isn't the pass that actually deals with the RTL version...
6392
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6393
				// Short out, as the RTL version will deal with it in a moment.
6394
				return $tag;
6395
			}
6396
		}
6397
6398
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6399
		$css  = Jetpack::absolutize_css_urls( file_get_contents( $file ), $href );
6400
		if ( $css ) {
6401
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6402
			if ( empty( $item->extra['after'] ) ) {
6403
				wp_add_inline_style( $handle, $css );
6404
			} else {
6405
				array_unshift( $item->extra['after'], $css );
6406
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6407
			}
6408
		}
6409
6410
		return $tag;
6411
	}
6412
6413
	/**
6414
	 * Loads a view file from the views
6415
	 *
6416
	 * Data passed in with the $data parameter will be available in the
6417
	 * template file as $data['value']
6418
	 *
6419
	 * @param string $template - Template file to load
6420
	 * @param array $data - Any data to pass along to the template
6421
	 * @return boolean - If template file was found
6422
	 **/
6423
	public function load_view( $template, $data = array() ) {
6424
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6425
6426
		if( file_exists( $views_dir . $template ) ) {
6427
			require_once( $views_dir . $template );
6428
			return true;
6429
		}
6430
6431
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6432
		return false;
6433
	}
6434
6435
	/**
6436
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6437
	 */
6438
	public function deprecated_hooks() {
6439
		global $wp_filter;
6440
6441
		/*
6442
		 * Format:
6443
		 * deprecated_filter_name => replacement_name
6444
		 *
6445
		 * If there is no replacement, use null for replacement_name
6446
		 */
6447
		$deprecated_list = array(
6448
			'jetpack_bail_on_shortcode'                              => 'jetpack_shortcodes_to_include',
6449
			'wpl_sharing_2014_1'                                     => null,
6450
			'jetpack-tools-to-include'                               => 'jetpack_tools_to_include',
6451
			'jetpack_identity_crisis_options_to_check'               => null,
6452
			'update_option_jetpack_single_user_site'                 => null,
6453
			'audio_player_default_colors'                            => null,
6454
			'add_option_jetpack_featured_images_enabled'             => null,
6455
			'add_option_jetpack_update_details'                      => null,
6456
			'add_option_jetpack_updates'                             => null,
6457
			'add_option_jetpack_network_name'                        => null,
6458
			'add_option_jetpack_network_allow_new_registrations'     => null,
6459
			'add_option_jetpack_network_add_new_users'               => null,
6460
			'add_option_jetpack_network_site_upload_space'           => null,
6461
			'add_option_jetpack_network_upload_file_types'           => null,
6462
			'add_option_jetpack_network_enable_administration_menus' => null,
6463
			'add_option_jetpack_is_multi_site'                       => null,
6464
			'add_option_jetpack_is_main_network'                     => null,
6465
			'add_option_jetpack_main_network_site'                   => null,
6466
			'jetpack_sync_all_registered_options'                    => null,
6467
			'jetpack_has_identity_crisis'                            => 'jetpack_sync_error_idc_validation',
6468
			'jetpack_is_post_mailable'                               => null,
6469
			'jetpack_seo_site_host'                                  => null,
6470
		);
6471
6472
		// This is a silly loop depth. Better way?
6473
		foreach( $deprecated_list AS $hook => $hook_alt ) {
6474
			if ( has_action( $hook ) ) {
6475
				foreach( $wp_filter[ $hook ] AS $func => $values ) {
6476
					foreach( $values AS $hooked ) {
6477
						if ( is_callable( $hooked['function'] ) ) {
6478
							$function_name = 'an anonymous function';
6479
						} else {
6480
							$function_name = $hooked['function'];
6481
						}
6482
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6483
					}
6484
				}
6485
			}
6486
		}
6487
	}
6488
6489
	/**
6490
	 * Converts any url in a stylesheet, to the correct absolute url.
6491
	 *
6492
	 * Considerations:
6493
	 *  - Normal, relative URLs     `feh.png`
6494
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6495
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6496
	 *  - Absolute URLs             `http://domain.com/feh.png`
6497
	 *  - Domain root relative URLs `/feh.png`
6498
	 *
6499
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6500
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6501
	 *
6502
	 * @return mixed|string
6503
	 */
6504
	public static function absolutize_css_urls( $css, $css_file_url ) {
6505
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6506
		$css_dir = dirname( $css_file_url );
6507
		$p       = parse_url( $css_dir );
6508
		$domain  = sprintf(
6509
					'%1$s//%2$s%3$s%4$s',
6510
					isset( $p['scheme'] )           ? "{$p['scheme']}:" : '',
6511
					isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6512
					$p['host'],
6513
					isset( $p['port'] )             ? ":{$p['port']}" : ''
6514
				);
6515
6516
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6517
			$find = $replace = array();
6518
			foreach ( $matches as $match ) {
6519
				$url = trim( $match['path'], "'\" \t" );
6520
6521
				// If this is a data url, we don't want to mess with it.
6522
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6523
					continue;
6524
				}
6525
6526
				// If this is an absolute or protocol-agnostic url,
6527
				// we don't want to mess with it.
6528
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6529
					continue;
6530
				}
6531
6532
				switch ( substr( $url, 0, 1 ) ) {
6533
					case '/':
6534
						$absolute = $domain . $url;
6535
						break;
6536
					default:
6537
						$absolute = $css_dir . '/' . $url;
6538
				}
6539
6540
				$find[]    = $match[0];
6541
				$replace[] = sprintf( 'url("%s")', $absolute );
6542
			}
6543
			$css = str_replace( $find, $replace, $css );
6544
		}
6545
6546
		return $css;
6547
	}
6548
6549
	/**
6550
	 * This methods removes all of the registered css files on the front end
6551
	 * from Jetpack in favor of using a single file. In effect "imploding"
6552
	 * all the files into one file.
6553
	 *
6554
	 * Pros:
6555
	 * - Uses only ONE css asset connection instead of 15
6556
	 * - Saves a minimum of 56k
6557
	 * - Reduces server load
6558
	 * - Reduces time to first painted byte
6559
	 *
6560
	 * Cons:
6561
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6562
	 *		should not cause any issues with themes.
6563
	 * - Plugins/themes dequeuing styles no longer do anything. See
6564
	 *		jetpack_implode_frontend_css filter for a workaround
6565
	 *
6566
	 * For some situations developers may wish to disable css imploding and
6567
	 * instead operate in legacy mode where each file loads seperately and
6568
	 * can be edited individually or dequeued. This can be accomplished with
6569
	 * the following line:
6570
	 *
6571
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6572
	 *
6573
	 * @since 3.2
6574
	 **/
6575
	public function implode_frontend_css( $travis_test = false ) {
6576
		$do_implode = true;
6577
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6578
			$do_implode = false;
6579
		}
6580
6581
		/**
6582
		 * Allow CSS to be concatenated into a single jetpack.css file.
6583
		 *
6584
		 * @since 3.2.0
6585
		 *
6586
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6587
		 */
6588
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6589
6590
		// Do not use the imploded file when default behaviour was altered through the filter
6591
		if ( ! $do_implode ) {
6592
			return;
6593
		}
6594
6595
		// We do not want to use the imploded file in dev mode, or if not connected
6596
		if ( Jetpack::is_development_mode() || ! self::is_active() ) {
6597
			if ( ! $travis_test ) {
6598
				return;
6599
			}
6600
		}
6601
6602
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6603
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6604
			return;
6605
		}
6606
6607
		/*
6608
		 * Now we assume Jetpack is connected and able to serve the single
6609
		 * file.
6610
		 *
6611
		 * In the future there will be a check here to serve the file locally
6612
		 * or potentially from the Jetpack CDN
6613
		 *
6614
		 * For now:
6615
		 * - Enqueue a single imploded css file
6616
		 * - Zero out the style_loader_tag for the bundled ones
6617
		 * - Be happy, drink scotch
6618
		 */
6619
6620
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6621
6622
		$version = Jetpack::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6623
6624
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6625
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6626
	}
6627
6628
	function concat_remove_style_loader_tag( $tag, $handle ) {
6629
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6630
			$tag = '';
6631
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6632
				$tag = "<!-- `" . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6633
			}
6634
		}
6635
6636
		return $tag;
6637
	}
6638
6639
	/*
6640
	 * Check the heartbeat data
6641
	 *
6642
	 * Organizes the heartbeat data by severity.  For example, if the site
6643
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6644
	 *
6645
	 * Data will be added to "caution" array, if it either:
6646
	 *  - Out of date Jetpack version
6647
	 *  - Out of date WP version
6648
	 *  - Out of date PHP version
6649
	 *
6650
	 * $return array $filtered_data
6651
	 */
6652
	public static function jetpack_check_heartbeat_data() {
6653
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6654
6655
		$good    = array();
6656
		$caution = array();
6657
		$bad     = array();
6658
6659
		foreach ( $raw_data as $stat => $value ) {
6660
6661
			// Check jetpack version
6662
			if ( 'version' == $stat ) {
6663
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6664
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__VERSION;
6665
					continue;
6666
				}
6667
			}
6668
6669
			// Check WP version
6670
			if ( 'wp-version' == $stat ) {
6671
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6672
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_WP_VERSION;
6673
					continue;
6674
				}
6675
			}
6676
6677
			// Check PHP version
6678
			if ( 'php-version' == $stat ) {
6679
				if ( version_compare( PHP_VERSION, '5.2.4', '<' ) ) {
6680
					$caution[ $stat ] = $value . " - min supported is 5.2.4";
6681
					continue;
6682
				}
6683
			}
6684
6685
			// Check ID crisis
6686
			if ( 'identitycrisis' == $stat ) {
6687
				if ( 'yes' == $value ) {
6688
					$bad[ $stat ] = $value;
6689
					continue;
6690
				}
6691
			}
6692
6693
			// The rest are good :)
6694
			$good[ $stat ] = $value;
6695
		}
6696
6697
		$filtered_data = array(
6698
			'good'    => $good,
6699
			'caution' => $caution,
6700
			'bad'     => $bad
6701
		);
6702
6703
		return $filtered_data;
6704
	}
6705
6706
6707
	/*
6708
	 * This method is used to organize all options that can be reset
6709
	 * without disconnecting Jetpack.
6710
	 *
6711
	 * It is used in class.jetpack-cli.php to reset options
6712
	 *
6713
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6714
	 *
6715
	 * @return array of options to delete.
6716
	 */
6717
	public static function get_jetpack_options_for_reset() {
6718
		return Jetpack_Options::get_options_for_reset();
6719
	}
6720
6721
	/**
6722
	 * Check if an option of a Jetpack module has been updated.
6723
	 *
6724
	 * If any module option has been updated before Jump Start has been dismissed,
6725
	 * update the 'jumpstart' option so we can hide Jump Start.
6726
	 *
6727
	 * @param string $option_name
6728
	 *
6729
	 * @return bool
6730
	 */
6731
	public static function jumpstart_has_updated_module_option( $option_name = '' ) {
6732
		// Bail if Jump Start has already been dismissed
6733
		if ( 'new_connection' !== Jetpack_Options::get_option( 'jumpstart' ) ) {
6734
			return false;
6735
		}
6736
6737
		$jetpack = Jetpack::init();
6738
6739
		// Manual build of module options
6740
		$option_names = self::get_jetpack_options_for_reset();
6741
6742
		if ( in_array( $option_name, $option_names['wp_options'] ) ) {
6743
			Jetpack_Options::update_option( 'jumpstart', 'jetpack_action_taken' );
6744
6745
			//Jump start is being dismissed send data to MC Stats
6746
			$jetpack->stat( 'jumpstart', 'manual,'.$option_name );
6747
6748
			$jetpack->do_stats( 'server_side' );
6749
		}
6750
6751
	}
6752
6753
	/*
6754
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6755
	 * so we can bring them directly to their site in calypso.
6756
	 *
6757
	 * @param string | url
6758
	 * @return string | url without the guff
6759
	 */
6760
	public static function build_raw_urls( $url ) {
6761
		$strip_http = '/.*?:\/\//i';
6762
		$url = preg_replace( $strip_http, '', $url  );
6763
		$url = str_replace( '/', '::', $url );
6764
		return $url;
6765
	}
6766
6767
	/**
6768
	 * Stores and prints out domains to prefetch for page speed optimization.
6769
	 *
6770
	 * @param mixed $new_urls
6771
	 */
6772
	public static function dns_prefetch( $new_urls = null ) {
6773
		static $prefetch_urls = array();
6774
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6775
			echo "\r\n";
6776
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6777
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6778
			}
6779
		} elseif ( ! empty( $new_urls ) ) {
6780
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6781
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6782
			}
6783
			foreach ( (array) $new_urls as $this_new_url ) {
6784
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6785
			}
6786
			$prefetch_urls = array_unique( $prefetch_urls );
6787
		}
6788
	}
6789
6790
	public function wp_dashboard_setup() {
6791
		if ( self::is_active() ) {
6792
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6793
		}
6794
6795
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6796
			wp_add_dashboard_widget(
6797
				'jetpack_summary_widget',
6798
				esc_html__( 'Site Stats', 'jetpack' ),
6799
				array( __CLASS__, 'dashboard_widget' )
6800
			);
6801
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6802
6803
			// If we're inactive and not in development mode, sort our box to the top.
6804
			if ( ! self::is_active() && ! self::is_development_mode() ) {
6805
				global $wp_meta_boxes;
6806
6807
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6808
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6809
6810
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6811
			}
6812
		}
6813
	}
6814
6815
	/**
6816
	 * @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...
6817
	 * @return mixed
6818
	 */
6819
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6820
		if ( ! is_array( $sorted ) ) {
6821
			return $sorted;
6822
		}
6823
6824
		foreach ( $sorted as $box_context => $ids ) {
6825
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6826
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6827
				continue;
6828
			}
6829
6830
			$ids_array = explode( ',', $ids );
6831
			$key = array_search( 'dashboard_stats', $ids_array );
6832
6833
			if ( false !== $key ) {
6834
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6835
				$ids_array[ $key ] = 'jetpack_summary_widget';
6836
				$sorted[ $box_context ] = implode( ',', $ids_array );
6837
				// We've found it, stop searching, and just return.
6838
				break;
6839
			}
6840
		}
6841
6842
		return $sorted;
6843
	}
6844
6845
	public static function dashboard_widget() {
6846
		/**
6847
		 * Fires when the dashboard is loaded.
6848
		 *
6849
		 * @since 3.4.0
6850
		 */
6851
		do_action( 'jetpack_dashboard_widget' );
6852
	}
6853
6854
	public static function dashboard_widget_footer() {
6855
		?>
6856
		<footer>
6857
6858
		<div class="protect">
6859
			<?php if ( Jetpack::is_module_active( 'protect' ) ) : ?>
6860
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6861
				<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>
6862
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! self::is_development_mode() ) : ?>
6863
				<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' ); ?>">
6864
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6865
				</a>
6866
			<?php else : ?>
6867
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6868
			<?php endif; ?>
6869
		</div>
6870
6871
		<div class="akismet">
6872
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6873
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6874
				<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>
6875
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6876
				<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">
6877
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6878
				</a>
6879
			<?php else : ?>
6880
				<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>
6881
			<?php endif; ?>
6882
		</div>
6883
6884
		</footer>
6885
		<?php
6886
	}
6887
6888
	/**
6889
	 * Return string containing the Jetpack logo.
6890
	 *
6891
	 * @since 3.9.0
6892
	 *
6893
	 * @return string
6894
	 */
6895
	public static function get_jp_emblem() {
6896
		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>';
6897
	}
6898
6899
	/*
6900
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6901
	 */
6902
	function jetpack_icon_user_connected( $columns ) {
6903
		$columns['user_jetpack'] = '';
6904
		return $columns;
6905
	}
6906
6907
	/*
6908
	 * Show Jetpack icon if the user is linked.
6909
	 */
6910
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6911
		if ( 'user_jetpack' == $col && Jetpack::is_user_connected( $user_id ) ) {
6912
			$emblem_html = sprintf(
6913
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6914
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6915
				Jetpack::get_jp_emblem()
6916
			);
6917
			return $emblem_html;
6918
		}
6919
6920
		return $val;
6921
	}
6922
6923
	/*
6924
	 * Style the Jetpack user column
6925
	 */
6926
	function jetpack_user_col_style() {
6927
		global $current_screen;
6928
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) { ?>
6929
			<style>
6930
				.fixed .column-user_jetpack {
6931
					width: 21px;
6932
				}
6933
				.jp-emblem-user-admin svg {
6934
					width: 20px;
6935
					height: 20px;
6936
				}
6937
				.jp-emblem-user-admin path {
6938
					fill: #00BE28;
6939
				}
6940
			</style>
6941
		<?php }
6942
	}
6943
6944
	/**
6945
	 * Checks if Akismet is active and working.
6946
	 *
6947
	 * @since  5.1.0
6948
	 * @return bool True = Akismet available. False = Aksimet not available.
6949
	 */
6950
	public static function is_akismet_active() {
6951
		if ( method_exists( 'Akismet' , 'http_post' ) || function_exists( 'akismet_http_post' ) ) {
6952
			return true;
6953
		}
6954
		return false;
6955
	}
6956
6957
	/**
6958
	 * Checks if one or more function names is in debug_backtrace
6959
	 *
6960
	 * @param $names Mixed string name of function or array of string names of functions
6961
	 *
6962
	 * @return bool
6963
	 */
6964
	public static function is_function_in_backtrace( $names ) {
6965
		$backtrace = debug_backtrace( false );
6966
		if ( ! is_array( $names ) ) {
6967
			$names = array( $names );
6968
		}
6969
		$names_as_keys = array_flip( $names );
6970
6971
		//Do check in constant O(1) time for PHP5.5+
6972
		if ( function_exists( 'array_column' ) ) {
6973
			$backtrace_functions = array_column( $backtrace, 'function' );
6974
			$backtrace_functions_as_keys = array_flip( $backtrace_functions );
6975
			$intersection = array_intersect_key( $backtrace_functions_as_keys, $names_as_keys );
6976
			return ! empty ( $intersection );
6977
		}
6978
6979
		//Do check in linear O(n) time for < PHP5.5 ( using isset at least prevents O(n^2) )
6980
		foreach ( $backtrace as $call ) {
6981
			if ( isset( $names_as_keys[ $call['function'] ] ) ) {
6982
				return true;
6983
			}
6984
		}
6985
		return false;
6986
	}
6987
6988
	/**
6989
	 * Given a minified path, and a non-minified path, will return
6990
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6991
	 *
6992
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6993
	 * root Jetpack directory.
6994
	 *
6995
	 * @since 5.6.0
6996
	 *
6997
	 * @param string $min_path
6998
	 * @param string $non_min_path
6999
	 * @return string The URL to the file
7000
	 */
7001
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7002
		$path = ( Jetpack_Constants::is_defined( 'SCRIPT_DEBUG' ) && Jetpack_Constants::get_constant( 'SCRIPT_DEBUG' ) )
7003
			? $non_min_path
7004
			: $min_path;
7005
7006
		return plugins_url( $path, JETPACK__PLUGIN_FILE );
7007
	}
7008
7009
	/**
7010
	 * Checks for whether Jetpack Rewind is enabled.
7011
	 * Will return true if the state of Rewind is anything except "unavailable".
7012
	 * @return bool|int|mixed
7013
	 */
7014
	public static function is_rewind_enabled() {
7015
		if ( ! Jetpack::is_active() ) {
7016
			return false;
7017
		}
7018
7019
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7020
		if ( false === $rewind_enabled ) {
7021
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7022
			$rewind_data = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7023
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7024
				&& ! empty( $rewind_data['state'] )
7025
				&& 'active' === $rewind_data['state'] )
7026
				? 1
7027
				: 0;
7028
7029
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7030
		}
7031
		return $rewind_enabled;
7032
	}
7033
}
7034