Completed
Push — fix/display-connection-errors ( 8173c0...d95e4c )
by
unknown
07:21
created

class.jetpack.php (1 issue)

Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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