Completed
Push — instant-search-master ( 95535d...2c1eb1 )
by
unknown
22:37 queued 16:04
created

class.jetpack.php (2 issues)

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\Connection\Client;
5
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
6
use Automattic\Jetpack\Connection\REST_Connector as REST_Connector;
7
use Automattic\Jetpack\Connection\XMLRPC_Connector as XMLRPC_Connector;
8
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
9
use Automattic\Jetpack\Constants;
10
use Automattic\Jetpack\Partner;
11
use Automattic\Jetpack\Roles;
12
use Automattic\Jetpack\Status;
13
use Automattic\Jetpack\Sync\Functions;
14
use Automattic\Jetpack\Sync\Sender;
15
use Automattic\Jetpack\Sync\Users;
16
use Automattic\Jetpack\Terms_Of_Service;
17
use Automattic\Jetpack\Tracking;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
20
/*
21
Options:
22
jetpack_options (array)
23
	An array of options.
24
	@see Jetpack_Options::get_option_names()
25
26
jetpack_register (string)
27
	Temporary verification secrets.
28
29
jetpack_activated (int)
30
	1: the plugin was activated normally
31
	2: the plugin was activated on this site because of a network-wide activation
32
	3: the plugin was auto-installed
33
	4: the plugin was manually disconnected (but is still installed)
34
35
jetpack_active_modules (array)
36
	Array of active module slugs.
37
38
jetpack_do_activate (bool)
39
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
40
*/
41
42
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
43
44
class Jetpack {
45
	public $xmlrpc_server = null;
46
47
	private $rest_authentication_status = null;
48
49
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
50
51
	private $tracking;
52
53
	/**
54
	 * @var array The handles of styles that are concatenated into jetpack.css.
55
	 *
56
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
57
	 */
58
	public $concatenated_style_handles = array(
59
		'jetpack-carousel',
60
		'grunion.css',
61
		'the-neverending-homepage',
62
		'jetpack_likes',
63
		'jetpack_related-posts',
64
		'sharedaddy',
65
		'jetpack-slideshow',
66
		'presentations',
67
		'quiz',
68
		'jetpack-subscriptions',
69
		'jetpack-responsive-videos-style',
70
		'jetpack-social-menu',
71
		'tiled-gallery',
72
		'jetpack_display_posts_widget',
73
		'gravatar-profile-widget',
74
		'goodreads-widget',
75
		'jetpack_social_media_icons_widget',
76
		'jetpack-top-posts-widget',
77
		'jetpack_image_widget',
78
		'jetpack-my-community-widget',
79
		'jetpack-authors-widget',
80
		'wordads',
81
		'eu-cookie-law-style',
82
		'flickr-widget-style',
83
		'jetpack-search-widget',
84
		'jetpack-simple-payments-widget-style',
85
		'jetpack-widget-social-icons-styles',
86
	);
87
88
	/**
89
	 * The handles of scripts that can be loaded asynchronously.
90
	 *
91
	 * @var array
92
	 */
93
	public $async_script_handles = array(
94
		'woocommerce-analytics',
95
	);
96
97
	/**
98
	 * Contains all assets that have had their URL rewritten to minified versions.
99
	 *
100
	 * @var array
101
	 */
102
	static $min_assets = array();
103
104
	public $plugins_to_deactivate = array(
105
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
106
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
107
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
108
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
109
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
110
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
111
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
112
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
113
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
114
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
115
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
116
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
117
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
118
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
119
	);
120
121
	/**
122
	 * Map of roles we care about, and their corresponding minimum capabilities.
123
	 *
124
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
125
	 *
126
	 * @access public
127
	 * @static
128
	 *
129
	 * @var array
130
	 */
131
	public static $capability_translations = array(
132
		'administrator' => 'manage_options',
133
		'editor'        => 'edit_others_posts',
134
		'author'        => 'publish_posts',
135
		'contributor'   => 'edit_posts',
136
		'subscriber'    => 'read',
137
	);
138
139
	/**
140
	 * Map of modules that have conflicts with plugins and should not be auto-activated
141
	 * if the plugins are active.  Used by filter_default_modules
142
	 *
143
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
144
	 * change `module-slug` and add this to your plugin:
145
	 *
146
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
147
	 * function my_jetpack_get_default_modules( $modules ) {
148
	 *     return array_diff( $modules, array( 'module-slug' ) );
149
	 * }
150
	 *
151
	 * @var array
152
	 */
153
	private $conflicting_plugins = array(
154
		'comments'           => array(
155
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
156
			'Disqus'                         => 'disqus-comment-system/disqus.php',
157
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
158
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
159
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
160
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
161
		),
162
		'comment-likes'      => array(
163
			'Epoch' => 'epoch/plugincore.php',
164
		),
165
		'contact-form'       => array(
166
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
167
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
168
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
169
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
170
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
171
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
172
		),
173
		'minileven'          => array(
174
			'WPtouch' => 'wptouch/wptouch.php',
175
		),
176
		'latex'              => array(
177
			'LaTeX for WordPress'     => 'latex/latex.php',
178
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
179
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
180
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
181
			'Enable Latex'            => 'enable-latex/enable-latex.php',
182
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
183
		),
184
		'protect'            => array(
185
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
186
			'Captcha'                           => 'captcha/captcha.php',
187
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
188
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
189
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
190
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
191
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
192
			'Security-protection'               => 'security-protection/security-protection.php',
193
			'Login Security'                    => 'login-security/login-security.php',
194
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
195
			'Wordfence Security'                => 'wordfence/wordfence.php',
196
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
197
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
198
		),
199
		'random-redirect'    => array(
200
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
201
		),
202
		'related-posts'      => array(
203
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
204
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
205
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
206
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
207
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
208
			'outbrain'                    => 'outbrain/outbrain.php',
209
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
210
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
211
		),
212
		'sharedaddy'         => array(
213
			'AddThis'     => 'addthis/addthis_social_widget.php',
214
			'Add To Any'  => 'add-to-any/add-to-any.php',
215
			'ShareThis'   => 'share-this/sharethis.php',
216
			'Shareaholic' => 'shareaholic/shareaholic.php',
217
		),
218
		'seo-tools'          => array(
219
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
220
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
221
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
222
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
223
			'The SEO Framework'              => 'autodescription/autodescription.php',
224
		),
225
		'verification-tools' => array(
226
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
227
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
228
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
229
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
230
			'The SEO Framework'              => 'autodescription/autodescription.php',
231
		),
232
		'widget-visibility'  => array(
233
			'Widget Logic'    => 'widget-logic/widget_logic.php',
234
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
235
		),
236
		'sitemaps'           => array(
237
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
238
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
239
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
240
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
241
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
242
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
243
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
244
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
245
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
246
			'The SEO Framework'                    => 'autodescription/autodescription.php',
247
			'Sitemap'                              => 'sitemap/sitemap.php',
248
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
249
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
250
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
251
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
252
		),
253
		'lazy-images'        => array(
254
			'Lazy Load'              => 'lazy-load/lazy-load.php',
255
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
256
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
257
		),
258
	);
259
260
	/**
261
	 * Plugins for which we turn off our Facebook OG Tags implementation.
262
	 *
263
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
264
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
265
	 *
266
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
267
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
268
	 */
269
	private $open_graph_conflicting_plugins = array(
270
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
271
		// 2 Click Social Media Buttons
272
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
273
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
274
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
275
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
276
		// Open Graph Meta Tags by Heateor
277
		'facebook/facebook.php',                                 // Facebook (official plugin)
278
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
279
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
280
		// Facebook Featured Image & OG Meta Tags
281
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
282
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
283
		// Facebook Open Graph Meta Tags for WordPress
284
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
285
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
286
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
287
		// Fedmich's Facebook Open Graph Meta
288
		'network-publisher/networkpub.php',                      // Network Publisher
289
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
290
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
291
		// NextScripts SNAP
292
		'og-tags/og-tags.php',                                   // OG Tags
293
		'opengraph/opengraph.php',                               // Open Graph
294
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
295
		// Open Graph Protocol Framework
296
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
297
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
298
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
299
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
300
		'sharepress/sharepress.php',                             // SharePress
301
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
302
		'social-discussions/social-discussions.php',             // Social Discussions
303
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
304
		'socialize/socialize.php',                               // Socialize
305
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
306
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
307
		// Tweet, Like, Google +1 and Share
308
		'wordbooker/wordbooker.php',                             // Wordbooker
309
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
310
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
311
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
312
		// WP Facebook Like Send & Open Graph Meta
313
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
314
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
315
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
316
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
317
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
318
	);
319
320
	/**
321
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
322
	 */
323
	private $twitter_cards_conflicting_plugins = array(
324
		// 'twitter/twitter.php',                       // The official one handles this on its own.
325
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
326
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
327
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
328
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
329
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
330
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
331
		'twitter-cards/twitter-cards.php',           // Twitter Cards
332
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
333
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
334
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
335
	);
336
337
	/**
338
	 * Message to display in admin_notice
339
	 *
340
	 * @var string
341
	 */
342
	public $message = '';
343
344
	/**
345
	 * Error to display in admin_notice
346
	 *
347
	 * @var string
348
	 */
349
	public $error = '';
350
351
	/**
352
	 * Modules that need more privacy description.
353
	 *
354
	 * @var string
355
	 */
356
	public $privacy_checks = '';
357
358
	/**
359
	 * Stats to record once the page loads
360
	 *
361
	 * @var array
362
	 */
363
	public $stats = array();
364
365
	/**
366
	 * Jetpack_Sync object
367
	 */
368
	public $sync;
369
370
	/**
371
	 * Verified data for JSON authorization request
372
	 */
373
	public $json_api_authorization_request = array();
374
375
	/**
376
	 * @var Automattic\Jetpack\Connection\Manager
377
	 */
378
	protected $connection_manager;
379
380
	/**
381
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
382
	 */
383
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
384
385
	/**
386
	 * Holds the singleton instance of this class
387
	 *
388
	 * @since 2.3.3
389
	 * @var Jetpack
390
	 */
391
	static $instance = false;
392
393
	/**
394
	 * Singleton
395
	 *
396
	 * @static
397
	 */
398
	public static function init() {
399
		if ( ! self::$instance ) {
400
			self::$instance = new Jetpack();
401
402
			self::$instance->plugin_upgrade();
403
		}
404
405
		return self::$instance;
406
	}
407
408
	/**
409
	 * Must never be called statically
410
	 */
411
	function plugin_upgrade() {
412
		if ( self::is_active() ) {
413
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
414
			if ( JETPACK__VERSION != $version ) {
415
				// Prevent multiple upgrades at once - only a single process should trigger
416
				// an upgrade to avoid stampedes
417
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
418
					return;
419
				}
420
421
				// Set a short lock to prevent multiple instances of the upgrade
422
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
423
424
				// check which active modules actually exist and remove others from active_modules list
425
				$unfiltered_modules = self::get_active_modules();
426
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
427
				if ( array_diff( $unfiltered_modules, $modules ) ) {
428
					self::update_active_modules( $modules );
429
				}
430
431
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
432
433
				// Upgrade to 4.3.0
434
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
435
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
436
				}
437
438
				// Make sure Markdown for posts gets turned back on
439
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
440
					update_option( 'wpcom_publish_posts_with_markdown', true );
441
				}
442
443
				if ( did_action( 'wp_loaded' ) ) {
444
					self::upgrade_on_load();
445
				} else {
446
					add_action(
447
						'wp_loaded',
448
						array( __CLASS__, 'upgrade_on_load' )
449
					);
450
				}
451
			}
452
		}
453
	}
454
455
	/**
456
	 * Runs upgrade routines that need to have modules loaded.
457
	 */
458
	static function upgrade_on_load() {
459
460
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
461
		// This can happen in case Jetpack has been just upgraded and is
462
		// being initialized late during the page load. In this case we wait
463
		// until the next proper admin page load with Jetpack active.
464
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
465
			delete_transient( self::$plugin_upgrade_lock_key );
466
467
			return;
468
		}
469
470
		self::maybe_set_version_option();
471
472
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
473
			Jetpack_Widget_Conditions::migrate_post_type_rules();
474
		}
475
476
		if (
477
			class_exists( 'Jetpack_Sitemap_Manager' )
478
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
479
		) {
480
			do_action( 'jetpack_sitemaps_purge_data' );
481
		}
482
483
		// Delete old stats cache
484
		delete_option( 'jetpack_restapi_stats_cache' );
485
486
		delete_transient( self::$plugin_upgrade_lock_key );
487
	}
488
489
	/**
490
	 * Saves all the currently active modules to options.
491
	 * Also fires Action hooks for each newly activated and deactivated module.
492
	 *
493
	 * @param $modules Array Array of active modules to be saved in options.
494
	 *
495
	 * @return $success bool true for success, false for failure.
496
	 */
497
	static function update_active_modules( $modules ) {
498
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
499
		$active_modules       = self::get_active_modules();
500
		$new_active_modules   = array_diff( $modules, $current_modules );
501
		$new_inactive_modules = array_diff( $active_modules, $modules );
502
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
503
		$reindexed_modules    = array_values( $new_current_modules );
504
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
505
506
		foreach ( $new_active_modules as $module ) {
507
			/**
508
			 * Fires when a specific module is activated.
509
			 *
510
			 * @since 1.9.0
511
			 *
512
			 * @param string $module Module slug.
513
			 * @param boolean $success whether the module was activated. @since 4.2
514
			 */
515
			do_action( 'jetpack_activate_module', $module, $success );
516
			/**
517
			 * Fires when a module is activated.
518
			 * The dynamic part of the filter, $module, is the module slug.
519
			 *
520
			 * @since 1.9.0
521
			 *
522
			 * @param string $module Module slug.
523
			 */
524
			do_action( "jetpack_activate_module_$module", $module );
525
		}
526
527
		foreach ( $new_inactive_modules as $module ) {
528
			/**
529
			 * Fired after a module has been deactivated.
530
			 *
531
			 * @since 4.2.0
532
			 *
533
			 * @param string $module Module slug.
534
			 * @param boolean $success whether the module was deactivated.
535
			 */
536
			do_action( 'jetpack_deactivate_module', $module, $success );
537
			/**
538
			 * Fires when a module is deactivated.
539
			 * The dynamic part of the filter, $module, is the module slug.
540
			 *
541
			 * @since 1.9.0
542
			 *
543
			 * @param string $module Module slug.
544
			 */
545
			do_action( "jetpack_deactivate_module_$module", $module );
546
		}
547
548
		return $success;
549
	}
550
551
	static function delete_active_modules() {
552
		self::update_active_modules( array() );
553
	}
554
555
	/**
556
	 * Constructor.  Initializes WordPress hooks
557
	 */
558
	private function __construct() {
559
		/*
560
		 * Check for and alert any deprecated hooks
561
		 */
562
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
563
564
		/*
565
		 * Enable enhanced handling of previewing sites in Calypso
566
		 */
567
		if ( self::is_active() ) {
568
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
569
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
570
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
571
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
572
		}
573
574
		add_action( 'plugins_loaded', array( $this, 'after_plugins_loaded' ) );
575
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
576
577
		add_filter(
578
			'jetpack_connection_secret_generator',
579
			function( $callable ) {
580
				return function() {
581
					return wp_generate_password( 32, false );
582
				};
583
			}
584
		);
585
586
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
587
588
		$this->connection_manager = new Connection_Manager();
589
		$this->connection_manager->init();
590
591
		/*
592
		 * Load things that should only be in Network Admin.
593
		 *
594
		 * For now blow away everything else until a more full
595
		 * understanding of what is needed at the network level is
596
		 * available
597
		 */
598
		if ( is_multisite() ) {
599
			$network = Jetpack_Network::init();
600
			$network->set_connection( $this->connection_manager );
601
		}
602
603
		add_filter(
604
			'jetpack_signature_check_token',
605
			array( __CLASS__, 'verify_onboarding_token' ),
606
			10,
607
			3
608
		);
609
610
		/**
611
		 * Prepare Gutenberg Editor functionality
612
		 */
613
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
614
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
615
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
616
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
617
618
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
619
620
		// Unlink user before deleting the user from WP.com.
621
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
622
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
623
624
		// Initialize remote file upload request handlers.
625
		$this->add_remote_request_handlers();
626
627
		if ( self::is_active() ) {
628
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
629
630
			Jetpack_Heartbeat::init();
631
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
632
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
633
				Jetpack_Search_Performance_Logger::init();
634
			}
635
		}
636
637
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
638
639
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
640
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
641
642
		add_action( 'admin_init', array( $this, 'admin_init' ) );
643
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
644
645
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
646
647
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
648
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
649
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
650
651
		// returns HTTPS support status
652
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
653
654
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
655
656
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
657
		add_action( 'wp_enqueue_scripts', array( $this, 'devicepx' ) );
658
		add_action( 'customize_controls_enqueue_scripts', array( $this, 'devicepx' ) );
659
		add_action( 'admin_enqueue_scripts', array( $this, 'devicepx' ) );
660
661
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
662
663
		/**
664
		 * These actions run checks to load additional files.
665
		 * They check for external files or plugins, so they need to run as late as possible.
666
		 */
667
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
668
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
669
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
670
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
671
672
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
673
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
674
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
675
676
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
677
678
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
679
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
680
681
		// A filter to control all just in time messages
682
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
683
684
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
685
686
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
687
		// We should make sure to only do this for front end links.
688
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
689
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
690
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
691
692
			// we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
693
			// so they point moderation links on emails to Calypso
694
			jetpack_require_lib( 'functions.wp-notify' );
695
		}
696
697
		// Hide edit post link if mobile app.
698
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
699
			add_filter( 'edit_post_link', '__return_empty_string' );
700
		}
701
702
		// Update the Jetpack plan from API on heartbeats
703
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
704
705
		/**
706
		 * This is the hack to concatenate all css files into one.
707
		 * For description and reasoning see the implode_frontend_css method
708
		 *
709
		 * Super late priority so we catch all the registered styles
710
		 */
711
		if ( ! is_admin() ) {
712
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
713
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
714
		}
715
716
		/**
717
		 * These are sync actions that we need to keep track of for jitms
718
		 */
719
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
720
721
		// Actually push the stats on shutdown.
722
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
723
			add_action( 'shutdown', array( $this, 'push_stats' ) );
724
		}
725
726
		/*
727
		 * Load some scripts asynchronously.
728
		 */
729
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
730
731
		// Actions for Manager::authorize().
732
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
733
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
734
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
735
736
		// Filters for the Manager::get_token() urls and request body.
737
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
738
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
739
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
740
	}
741
742
	/**
743
	 * Runs after all the plugins have loaded but before init.
744
	 */
745
	function after_plugins_loaded() {
746
747
		Partner::init();
748
		$terms_of_service = new Terms_Of_Service();
749
		$tracking = new Plugin_Tracking();
750
		if ( $terms_of_service->has_agreed() ) {
751
			add_action( 'init', array( $tracking, 'init' ) );
752
		} else {
753
			/**
754
			 * Initialize tracking right after the user agrees to the terms of service.
755
			 */
756
			add_action( 'jetpack_agreed_to_terms_of_service', array( $tracking, 'init' ) );
757
		}
758
759
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
760
	}
761
762
	/**
763
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
764
	 * initialization code.
765
	 *
766
	 * @action plugins_loaded
767
	 */
768
	public function late_initialization() {
769
		/**
770
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
771
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
772
		 *
773
		 * @since 8.1.0
774
		 *
775
		 * @param Jetpack $jetpack the main plugin class object.
776
		 */
777
		do_action( 'jetpack_loaded', $this );
778
	}
779
780
	/**
781
	 * Sets up the XMLRPC request handlers.
782
	 *
783
	 * @deprecated since 7.7.0
784
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
785
	 *
786
	 * @param Array                 $request_params Incoming request parameters.
787
	 * @param Boolean               $is_active      Whether the connection is currently active.
788
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
789
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
790
	 */
791
	public function setup_xmlrpc_handlers(
792
		$request_params,
793
		$is_active,
794
		$is_signed,
795
		Jetpack_XMLRPC_Server $xmlrpc_server = null
796
	) {
797
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
798
		return $this->connection_manager->setup_xmlrpc_handlers(
799
			$request_params,
800
			$is_active,
801
			$is_signed,
802
			$xmlrpc_server
803
		);
804
	}
805
806
	/**
807
	 * Initialize REST API registration connector.
808
	 *
809
	 * @deprecated since 7.7.0
810
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
811
	 */
812
	public function initialize_rest_api_registration_connector() {
813
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
814
		$this->connection_manager->initialize_rest_api_registration_connector();
815
	}
816
817
	/**
818
	 * This is ported over from the manage module, which has been deprecated and baked in here.
819
	 *
820
	 * @param $domains
821
	 */
822
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
823
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
824
	}
825
826
	/**
827
	 * Return $domains, with 'wordpress.com' appended.
828
	 * This is ported over from the manage module, which has been deprecated and baked in here.
829
	 *
830
	 * @param $domains
831
	 * @return array
832
	 */
833
	function allow_wpcom_domain( $domains ) {
834
		if ( empty( $domains ) ) {
835
			$domains = array();
836
		}
837
		$domains[] = 'wordpress.com';
838
		return array_unique( $domains );
839
	}
840
841
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
842
		$post = get_post( $post_id );
843
844
		if ( empty( $post ) ) {
845
			return $default_url;
846
		}
847
848
		$post_type = $post->post_type;
849
850
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
851
		// https://en.support.wordpress.com/custom-post-types/
852
		$allowed_post_types = array(
853
			'post'                => 'post',
854
			'page'                => 'page',
855
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
856
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
857
		);
858
859
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
860
			return $default_url;
861
		}
862
863
		$path_prefix = $allowed_post_types[ $post_type ];
864
865
		$site_slug = self::build_raw_urls( get_home_url() );
866
867
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
868
	}
869
870
	function point_edit_comment_links_to_calypso( $url ) {
871
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
872
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
873
		return esc_url(
874
			sprintf(
875
				'https://wordpress.com/comment/%s/%d',
876
				self::build_raw_urls( get_home_url() ),
877
				$query_args['amp;c']
878
			)
879
		);
880
	}
881
882
	function jetpack_track_last_sync_callback( $params ) {
883
		/**
884
		 * Filter to turn off jitm caching
885
		 *
886
		 * @since 5.4.0
887
		 *
888
		 * @param bool false Whether to cache just in time messages
889
		 */
890
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
891
			return $params;
892
		}
893
894
		if ( is_array( $params ) && isset( $params[0] ) ) {
895
			$option = $params[0];
896
			if ( 'active_plugins' === $option ) {
897
				// use the cache if we can, but not terribly important if it gets evicted
898
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
899
			}
900
		}
901
902
		return $params;
903
	}
904
905
	function jetpack_connection_banner_callback() {
906
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
907
908
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
909
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
910
			wp_send_json_success();
911
		}
912
913
		wp_die();
914
	}
915
916
	/**
917
	 * Removes all XML-RPC methods that are not `jetpack.*`.
918
	 * Only used in our alternate XML-RPC endpoint, where we want to
919
	 * ensure that Core and other plugins' methods are not exposed.
920
	 *
921
	 * @deprecated since 7.7.0
922
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
923
	 *
924
	 * @param array $methods A list of registered WordPress XMLRPC methods.
925
	 * @return array Filtered $methods
926
	 */
927
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
928
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
929
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
930
	}
931
932
	/**
933
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
934
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
935
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
936
	 * which is accessible via a different URI. Most of the below is copied directly
937
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
938
	 *
939
	 * @deprecated since 7.7.0
940
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
941
	 */
942
	public function alternate_xmlrpc() {
943
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
944
		$this->connection_manager->alternate_xmlrpc();
945
	}
946
947
	/**
948
	 * The callback for the JITM ajax requests.
949
	 *
950
	 * @deprecated since 7.9.0
951
	 */
952
	function jetpack_jitm_ajax_callback() {
953
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
954
	}
955
956
	/**
957
	 * If there are any stats that need to be pushed, but haven't been, push them now.
958
	 */
959
	function push_stats() {
960
		if ( ! empty( $this->stats ) ) {
961
			$this->do_stats( 'server_side' );
962
		}
963
	}
964
965
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
966
		$is_development_mode = ( new Status() )->is_development_mode();
967
		switch ( $cap ) {
968
			case 'jetpack_connect':
969
			case 'jetpack_reconnect':
970
				if ( $is_development_mode ) {
971
					$caps = array( 'do_not_allow' );
972
					break;
973
				}
974
				/**
975
				 * Pass through. If it's not development mode, these should match disconnect.
976
				 * Let users disconnect if it's development mode, just in case things glitch.
977
				 */
978
			case 'jetpack_disconnect':
979
				/**
980
				 * In multisite, can individual site admins manage their own connection?
981
				 *
982
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
983
				 */
984
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
985
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
986
						/**
987
						 * We need to update the option name -- it's terribly unclear which
988
						 * direction the override goes.
989
						 *
990
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
991
						 */
992
						$caps = array( 'do_not_allow' );
993
						break;
994
					}
995
				}
996
997
				$caps = array( 'manage_options' );
998
				break;
999
			case 'jetpack_manage_modules':
1000
			case 'jetpack_activate_modules':
1001
			case 'jetpack_deactivate_modules':
1002
				$caps = array( 'manage_options' );
1003
				break;
1004
			case 'jetpack_configure_modules':
1005
				$caps = array( 'manage_options' );
1006
				break;
1007
			case 'jetpack_manage_autoupdates':
1008
				$caps = array(
1009
					'manage_options',
1010
					'update_plugins',
1011
				);
1012
				break;
1013
			case 'jetpack_network_admin_page':
1014
			case 'jetpack_network_settings_page':
1015
				$caps = array( 'manage_network_plugins' );
1016
				break;
1017
			case 'jetpack_network_sites_page':
1018
				$caps = array( 'manage_sites' );
1019
				break;
1020
			case 'jetpack_admin_page':
1021
				if ( $is_development_mode ) {
1022
					$caps = array( 'manage_options' );
1023
					break;
1024
				} else {
1025
					$caps = array( 'read' );
1026
				}
1027
				break;
1028
			case 'jetpack_connect_user':
1029
				if ( $is_development_mode ) {
1030
					$caps = array( 'do_not_allow' );
1031
					break;
1032
				}
1033
				$caps = array( 'read' );
1034
				break;
1035
		}
1036
		return $caps;
1037
	}
1038
1039
	/**
1040
	 * Require a Jetpack authentication.
1041
	 *
1042
	 * @deprecated since 7.7.0
1043
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1044
	 */
1045
	public function require_jetpack_authentication() {
1046
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1047
		$this->connection_manager->require_jetpack_authentication();
1048
	}
1049
1050
	/**
1051
	 * Load language files
1052
	 *
1053
	 * @action plugins_loaded
1054
	 */
1055
	public static function plugin_textdomain() {
1056
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1057
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1058
	}
1059
1060
	/**
1061
	 * Register assets for use in various modules and the Jetpack admin page.
1062
	 *
1063
	 * @uses wp_script_is, wp_register_script, plugins_url
1064
	 * @action wp_loaded
1065
	 * @return null
1066
	 */
1067
	public function register_assets() {
1068
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1069
			wp_register_script(
1070
				'spin',
1071
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1072
				false,
1073
				'1.3'
1074
			);
1075
		}
1076
1077 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1078
			wp_register_script(
1079
				'jquery.spin',
1080
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1081
				array( 'jquery', 'spin' ),
1082
				'1.3'
1083
			);
1084
		}
1085
1086 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1087
			wp_register_script(
1088
				'jetpack-gallery-settings',
1089
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1090
				array( 'media-views' ),
1091
				'20121225'
1092
			);
1093
		}
1094
1095 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1096
			wp_register_script(
1097
				'jetpack-twitter-timeline',
1098
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1099
				array( 'jquery' ),
1100
				'4.0.0',
1101
				true
1102
			);
1103
		}
1104
1105
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1106
			wp_register_script(
1107
				'jetpack-facebook-embed',
1108
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1109
				array( 'jquery' ),
1110
				null,
1111
				true
1112
			);
1113
1114
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1115
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1116
			if ( ! is_numeric( $fb_app_id ) ) {
1117
				$fb_app_id = '';
1118
			}
1119
			wp_localize_script(
1120
				'jetpack-facebook-embed',
1121
				'jpfbembed',
1122
				array(
1123
					'appid'  => $fb_app_id,
1124
					'locale' => $this->get_locale(),
1125
				)
1126
			);
1127
		}
1128
1129
		/**
1130
		 * As jetpack_register_genericons is by default fired off a hook,
1131
		 * the hook may have already fired by this point.
1132
		 * So, let's just trigger it manually.
1133
		 */
1134
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1135
		jetpack_register_genericons();
1136
1137
		/**
1138
		 * Register the social logos
1139
		 */
1140
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1141
		jetpack_register_social_logos();
1142
1143 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1144
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1145
		}
1146
	}
1147
1148
	/**
1149
	 * Guess locale from language code.
1150
	 *
1151
	 * @param string $lang Language code.
1152
	 * @return string|bool
1153
	 */
1154 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1155
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1156
			return 'en_US';
1157
		}
1158
1159
		if ( ! class_exists( 'GP_Locales' ) ) {
1160
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1161
				return false;
1162
			}
1163
1164
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1165
		}
1166
1167
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1168
			// WP.com: get_locale() returns 'it'
1169
			$locale = GP_Locales::by_slug( $lang );
1170
		} else {
1171
			// Jetpack: get_locale() returns 'it_IT';
1172
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1173
		}
1174
1175
		if ( ! $locale ) {
1176
			return false;
1177
		}
1178
1179
		if ( empty( $locale->facebook_locale ) ) {
1180
			if ( empty( $locale->wp_locale ) ) {
1181
				return false;
1182
			} else {
1183
				// Facebook SDK is smart enough to fall back to en_US if a
1184
				// locale isn't supported. Since supported Facebook locales
1185
				// can fall out of sync, we'll attempt to use the known
1186
				// wp_locale value and rely on said fallback.
1187
				return $locale->wp_locale;
1188
			}
1189
		}
1190
1191
		return $locale->facebook_locale;
1192
	}
1193
1194
	/**
1195
	 * Get the locale.
1196
	 *
1197
	 * @return string|bool
1198
	 */
1199
	function get_locale() {
1200
		$locale = $this->guess_locale_from_lang( get_locale() );
1201
1202
		if ( ! $locale ) {
1203
			$locale = 'en_US';
1204
		}
1205
1206
		return $locale;
1207
	}
1208
1209
	/**
1210
	 * Device Pixels support
1211
	 * This improves the resolution of gravatars and wordpress.com uploads on hi-res and zoomed browsers.
1212
	 */
1213
	function devicepx() {
1214
		if ( self::is_active() && ! Jetpack_AMP_Support::is_amp_request() ) {
1215
			wp_enqueue_script( 'devicepx', 'https://s0.wp.com/wp-content/js/devicepx-jetpack.js', array(), gmdate( 'oW' ), true );
1216
		}
1217
	}
1218
1219
	/**
1220
	 * Return the network_site_url so that .com knows what network this site is a part of.
1221
	 *
1222
	 * @param  bool $option
1223
	 * @return string
1224
	 */
1225
	public function jetpack_main_network_site_option( $option ) {
1226
		return network_site_url();
1227
	}
1228
	/**
1229
	 * Network Name.
1230
	 */
1231
	static function network_name( $option = null ) {
1232
		global $current_site;
1233
		return $current_site->site_name;
1234
	}
1235
	/**
1236
	 * Does the network allow new user and site registrations.
1237
	 *
1238
	 * @return string
1239
	 */
1240
	static function network_allow_new_registrations( $option = null ) {
1241
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1242
	}
1243
	/**
1244
	 * Does the network allow admins to add new users.
1245
	 *
1246
	 * @return boolian
1247
	 */
1248
	static function network_add_new_users( $option = null ) {
1249
		return (bool) get_site_option( 'add_new_users' );
1250
	}
1251
	/**
1252
	 * File upload psace left per site in MB.
1253
	 *  -1 means NO LIMIT.
1254
	 *
1255
	 * @return number
1256
	 */
1257
	static function network_site_upload_space( $option = null ) {
1258
		// value in MB
1259
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1260
	}
1261
1262
	/**
1263
	 * Network allowed file types.
1264
	 *
1265
	 * @return string
1266
	 */
1267
	static function network_upload_file_types( $option = null ) {
1268
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1269
	}
1270
1271
	/**
1272
	 * Maximum file upload size set by the network.
1273
	 *
1274
	 * @return number
1275
	 */
1276
	static function network_max_upload_file_size( $option = null ) {
1277
		// value in KB
1278
		return get_site_option( 'fileupload_maxk', 300 );
1279
	}
1280
1281
	/**
1282
	 * Lets us know if a site allows admins to manage the network.
1283
	 *
1284
	 * @return array
1285
	 */
1286
	static function network_enable_administration_menus( $option = null ) {
1287
		return get_site_option( 'menu_items' );
1288
	}
1289
1290
	/**
1291
	 * If a user has been promoted to or demoted from admin, we need to clear the
1292
	 * jetpack_other_linked_admins transient.
1293
	 *
1294
	 * @since 4.3.2
1295
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1296
	 *
1297
	 * @param int    $user_id   The user ID whose role changed.
1298
	 * @param string $role      The new role.
1299
	 * @param array  $old_roles An array of the user's previous roles.
1300
	 */
1301
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1302
		if ( 'administrator' == $role
1303
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1304
			|| is_null( $old_roles )
1305
		) {
1306
			delete_transient( 'jetpack_other_linked_admins' );
1307
		}
1308
	}
1309
1310
	/**
1311
	 * Checks to see if there are any other users available to become primary
1312
	 * Users must both:
1313
	 * - Be linked to wpcom
1314
	 * - Be an admin
1315
	 *
1316
	 * @return mixed False if no other users are linked, Int if there are.
1317
	 */
1318
	static function get_other_linked_admins() {
1319
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1320
1321
		if ( false === $other_linked_users ) {
1322
			$admins = get_users( array( 'role' => 'administrator' ) );
1323
			if ( count( $admins ) > 1 ) {
1324
				$available = array();
1325
				foreach ( $admins as $admin ) {
1326
					if ( self::is_user_connected( $admin->ID ) ) {
1327
						$available[] = $admin->ID;
1328
					}
1329
				}
1330
1331
				$count_connected_admins = count( $available );
1332
				if ( count( $available ) > 1 ) {
1333
					$other_linked_users = $count_connected_admins;
1334
				} else {
1335
					$other_linked_users = 0;
1336
				}
1337
			} else {
1338
				$other_linked_users = 0;
1339
			}
1340
1341
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1342
		}
1343
1344
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1345
	}
1346
1347
	/**
1348
	 * Return whether we are dealing with a multi network setup or not.
1349
	 * The reason we are type casting this is because we want to avoid the situation where
1350
	 * the result is false since when is_main_network_option return false it cases
1351
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1352
	 * database which could be set to anything as opposed to what this function returns.
1353
	 *
1354
	 * @param  bool $option
1355
	 *
1356
	 * @return boolean
1357
	 */
1358
	public function is_main_network_option( $option ) {
1359
		// return '1' or ''
1360
		return (string) (bool) self::is_multi_network();
1361
	}
1362
1363
	/**
1364
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1365
	 *
1366
	 * @param  string $option
1367
	 * @return boolean
1368
	 */
1369
	public function is_multisite( $option ) {
1370
		return (string) (bool) is_multisite();
1371
	}
1372
1373
	/**
1374
	 * Implemented since there is no core is multi network function
1375
	 * Right now there is no way to tell if we which network is the dominant network on the system
1376
	 *
1377
	 * @since  3.3
1378
	 * @return boolean
1379
	 */
1380 View Code Duplication
	public static function is_multi_network() {
1381
		global  $wpdb;
1382
1383
		// if we don't have a multi site setup no need to do any more
1384
		if ( ! is_multisite() ) {
1385
			return false;
1386
		}
1387
1388
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1389
		if ( $num_sites > 1 ) {
1390
			return true;
1391
		} else {
1392
			return false;
1393
		}
1394
	}
1395
1396
	/**
1397
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1398
	 *
1399
	 * @return null
1400
	 */
1401
	function update_jetpack_main_network_site_option() {
1402
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1403
	}
1404
	/**
1405
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1406
	 */
1407
	function update_jetpack_network_settings() {
1408
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1409
		// Only sync this info for the main network site.
1410
	}
1411
1412
	/**
1413
	 * Get back if the current site is single user site.
1414
	 *
1415
	 * @return bool
1416
	 */
1417 View Code Duplication
	public static function is_single_user_site() {
1418
		global $wpdb;
1419
1420
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1421
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1422
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1423
		}
1424
		return 1 === (int) $some_users;
1425
	}
1426
1427
	/**
1428
	 * Returns true if the site has file write access false otherwise.
1429
	 *
1430
	 * @return string ( '1' | '0' )
1431
	 **/
1432
	public static function file_system_write_access() {
1433
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1434
			require_once ABSPATH . 'wp-admin/includes/file.php';
1435
		}
1436
1437
		require_once ABSPATH . 'wp-admin/includes/template.php';
1438
1439
		$filesystem_method = get_filesystem_method();
1440
		if ( $filesystem_method === 'direct' ) {
1441
			return 1;
1442
		}
1443
1444
		ob_start();
1445
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1446
		ob_end_clean();
1447
		if ( $filesystem_credentials_are_stored ) {
1448
			return 1;
1449
		}
1450
		return 0;
1451
	}
1452
1453
	/**
1454
	 * Finds out if a site is using a version control system.
1455
	 *
1456
	 * @return string ( '1' | '0' )
1457
	 **/
1458
	public static function is_version_controlled() {
1459
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1460
		return (string) (int) Functions::is_version_controlled();
1461
	}
1462
1463
	/**
1464
	 * Determines whether the current theme supports featured images or not.
1465
	 *
1466
	 * @return string ( '1' | '0' )
1467
	 */
1468
	public static function featured_images_enabled() {
1469
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1470
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1471
	}
1472
1473
	/**
1474
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1475
	 *
1476
	 * @deprecated 4.7 use get_avatar_url instead.
1477
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1478
	 * @param int               $size Size of the avatar image
1479
	 * @param string            $default URL to a default image to use if no avatar is available
1480
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1481
	 *
1482
	 * @return array
1483
	 */
1484
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1485
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1486
		return get_avatar_url(
1487
			$id_or_email,
1488
			array(
1489
				'size'          => $size,
1490
				'default'       => $default,
1491
				'force_default' => $force_display,
1492
			)
1493
		);
1494
	}
1495
1496
	/**
1497
	 * jetpack_updates is saved in the following schema:
1498
	 *
1499
	 * array (
1500
	 *      'plugins'                       => (int) Number of plugin updates available.
1501
	 *      'themes'                        => (int) Number of theme updates available.
1502
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1503
	 *      'translations'                  => (int) Number of translation updates available.
1504
	 *      'total'                         => (int) Total of all available updates.
1505
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1506
	 * )
1507
	 *
1508
	 * @return array
1509
	 */
1510
	public static function get_updates() {
1511
		$update_data = wp_get_update_data();
1512
1513
		// Stores the individual update counts as well as the total count.
1514
		if ( isset( $update_data['counts'] ) ) {
1515
			$updates = $update_data['counts'];
1516
		}
1517
1518
		// If we need to update WordPress core, let's find the latest version number.
1519 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1520
			$cur = get_preferred_from_update_core();
1521
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1522
				$updates['wp_update_version'] = $cur->current;
1523
			}
1524
		}
1525
		return isset( $updates ) ? $updates : array();
1526
	}
1527
1528
	public static function get_update_details() {
1529
		$update_details = array(
1530
			'update_core'    => get_site_transient( 'update_core' ),
1531
			'update_plugins' => get_site_transient( 'update_plugins' ),
1532
			'update_themes'  => get_site_transient( 'update_themes' ),
1533
		);
1534
		return $update_details;
1535
	}
1536
1537
	public static function refresh_update_data() {
1538
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1539
1540
	}
1541
1542
	public static function refresh_theme_data() {
1543
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1544
	}
1545
1546
	/**
1547
	 * Is Jetpack active?
1548
	 */
1549
	public static function is_active() {
1550
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
1551
	}
1552
1553
	/**
1554
	 * Make an API call to WordPress.com for plan status
1555
	 *
1556
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1557
	 *
1558
	 * @return bool True if plan is updated, false if no update
1559
	 */
1560
	public static function refresh_active_plan_from_wpcom() {
1561
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1562
		return Jetpack_Plan::refresh_from_wpcom();
1563
	}
1564
1565
	/**
1566
	 * Get the plan that this Jetpack site is currently using
1567
	 *
1568
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1569
	 * @return array Active Jetpack plan details.
1570
	 */
1571
	public static function get_active_plan() {
1572
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1573
		return Jetpack_Plan::get();
1574
	}
1575
1576
	/**
1577
	 * Determine whether the active plan supports a particular feature
1578
	 *
1579
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1580
	 * @return bool True if plan supports feature, false if not.
1581
	 */
1582
	public static function active_plan_supports( $feature ) {
1583
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1584
		return Jetpack_Plan::supports( $feature );
1585
	}
1586
1587
	/**
1588
	 * Deprecated: Is Jetpack in development (offline) mode?
1589
	 *
1590
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1591
	 * and themes still use it, and we do not want to flood them with notices.
1592
	 *
1593
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1594
	 *
1595
	 * @deprecated since 8.0.
1596
	 */
1597
	public static function is_development_mode() {
1598
		return ( new Status() )->is_development_mode();
1599
	}
1600
1601
	/**
1602
	 * Whether the site is currently onboarding or not.
1603
	 * A site is considered as being onboarded if it currently has an onboarding token.
1604
	 *
1605
	 * @since 5.8
1606
	 *
1607
	 * @access public
1608
	 * @static
1609
	 *
1610
	 * @return bool True if the site is currently onboarding, false otherwise
1611
	 */
1612
	public static function is_onboarding() {
1613
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1614
	}
1615
1616
	/**
1617
	 * Determines reason for Jetpack development mode.
1618
	 */
1619
	public static function development_mode_trigger_text() {
1620
		if ( ! ( new Status() )->is_development_mode() ) {
1621
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1622
		}
1623
1624
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1625
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1626
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1627
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1628
		} else {
1629
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1630
		}
1631
1632
		return $notice;
1633
1634
	}
1635
	/**
1636
	 * Get Jetpack development mode notice text and notice class.
1637
	 *
1638
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1639
	 */
1640
	public static function show_development_mode_notice() {
1641 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1642
			$notice = sprintf(
1643
				/* translators: %s is a URL */
1644
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1645
				'https://jetpack.com/support/development-mode/'
1646
			);
1647
1648
			$notice .= ' ' . self::development_mode_trigger_text();
1649
1650
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1651
		}
1652
1653
		// Throw up a notice if using a development version and as for feedback.
1654
		if ( self::is_development_version() ) {
1655
			/* translators: %s is a URL */
1656
			$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/' );
1657
1658
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1659
		}
1660
		// Throw up a notice if using staging mode
1661
		if ( self::is_staging_site() ) {
1662
			/* translators: %s is a URL */
1663
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), 'https://jetpack.com/support/staging-sites/' );
1664
1665
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1666
		}
1667
	}
1668
1669
	/**
1670
	 * Whether Jetpack's version maps to a public release, or a development version.
1671
	 */
1672
	public static function is_development_version() {
1673
		/**
1674
		 * Allows filtering whether this is a development version of Jetpack.
1675
		 *
1676
		 * This filter is especially useful for tests.
1677
		 *
1678
		 * @since 4.3.0
1679
		 *
1680
		 * @param bool $development_version Is this a develoment version of Jetpack?
1681
		 */
1682
		return (bool) apply_filters(
1683
			'jetpack_development_version',
1684
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1685
		);
1686
	}
1687
1688
	/**
1689
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1690
	 */
1691
	public static function is_user_connected( $user_id = false ) {
1692
		return self::connection()->is_user_connected( $user_id );
1693
	}
1694
1695
	/**
1696
	 * Get the wpcom user data of the current|specified connected user.
1697
	 */
1698 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1699
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1700
		if ( ! $user_id ) {
1701
			$user_id = get_current_user_id();
1702
		}
1703
1704
		$transient_key = "jetpack_connected_user_data_$user_id";
1705
1706
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1707
			return $cached_user_data;
1708
		}
1709
1710
		$xml = new Jetpack_IXR_Client(
1711
			array(
1712
				'user_id' => $user_id,
1713
			)
1714
		);
1715
		$xml->query( 'wpcom.getUser' );
1716
		if ( ! $xml->isError() ) {
1717
			$user_data = $xml->getResponse();
1718
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1719
			return $user_data;
1720
		}
1721
1722
		return false;
1723
	}
1724
1725
	/**
1726
	 * Get the wpcom email of the current|specified connected user.
1727
	 */
1728 View Code Duplication
	public static function get_connected_user_email( $user_id = null ) {
1729
		if ( ! $user_id ) {
1730
			$user_id = get_current_user_id();
1731
		}
1732
1733
		$xml = new Jetpack_IXR_Client(
1734
			array(
1735
				'user_id' => $user_id,
1736
			)
1737
		);
1738
		$xml->query( 'wpcom.getUserEmail' );
1739
		if ( ! $xml->isError() ) {
1740
			return $xml->getResponse();
1741
		}
1742
		return false;
1743
	}
1744
1745
	/**
1746
	 * Get the wpcom email of the master user.
1747
	 */
1748
	public static function get_master_user_email() {
1749
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1750
		if ( $master_user_id ) {
1751
			return self::get_connected_user_email( $master_user_id );
1752
		}
1753
		return '';
1754
	}
1755
1756
	/**
1757
	 * Whether the current user is the connection owner.
1758
	 *
1759
	 * @deprecated since 7.7
1760
	 *
1761
	 * @return bool Whether the current user is the connection owner.
1762
	 */
1763
	public function current_user_is_connection_owner() {
1764
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1765
		return self::connection()->is_connection_owner();
1766
	}
1767
1768
	/**
1769
	 * Gets current user IP address.
1770
	 *
1771
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1772
	 *
1773
	 * @return string                  Current user IP address.
1774
	 */
1775
	public static function current_user_ip( $check_all_headers = false ) {
1776
		if ( $check_all_headers ) {
1777
			foreach ( array(
1778
				'HTTP_CF_CONNECTING_IP',
1779
				'HTTP_CLIENT_IP',
1780
				'HTTP_X_FORWARDED_FOR',
1781
				'HTTP_X_FORWARDED',
1782
				'HTTP_X_CLUSTER_CLIENT_IP',
1783
				'HTTP_FORWARDED_FOR',
1784
				'HTTP_FORWARDED',
1785
				'HTTP_VIA',
1786
			) as $key ) {
1787
				if ( ! empty( $_SERVER[ $key ] ) ) {
1788
					return $_SERVER[ $key ];
1789
				}
1790
			}
1791
		}
1792
1793
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1794
	}
1795
1796
	/**
1797
	 * Add any extra oEmbed providers that we know about and use on wpcom for feature parity.
1798
	 */
1799
	function extra_oembed_providers() {
1800
		// Cloudup: https://dev.cloudup.com/#oembed
1801
		wp_oembed_add_provider( 'https://cloudup.com/*', 'https://cloudup.com/oembed' );
1802
		wp_oembed_add_provider( 'https://me.sh/*', 'https://me.sh/oembed?format=json' );
1803
		wp_oembed_add_provider( '#https?://(www\.)?gfycat\.com/.*#i', 'https://api.gfycat.com/v1/oembed', true );
1804
		wp_oembed_add_provider( '#https?://[^.]+\.(wistia\.com|wi\.st)/(medias|embed)/.*#', 'https://fast.wistia.com/oembed', true );
1805
		wp_oembed_add_provider( '#https?://sketchfab\.com/.*#i', 'https://sketchfab.com/oembed', true );
1806
		wp_oembed_add_provider( '#https?://(www\.)?icloud\.com/keynote/.*#i', 'https://iwmb.icloud.com/iwmb/oembed', true );
1807
		wp_oembed_add_provider( 'https://song.link/*', 'https://song.link/oembed', false );
1808
	}
1809
1810
	/**
1811
	 * Synchronize connected user role changes
1812
	 */
1813
	function user_role_change( $user_id ) {
1814
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1815
		Users::user_role_change( $user_id );
1816
	}
1817
1818
	/**
1819
	 * Loads the currently active modules.
1820
	 */
1821
	public static function load_modules() {
1822
		$is_development_mode = ( new Status() )->is_development_mode();
1823
		if (
1824
			! self::is_active()
1825
			&& ! $is_development_mode
1826
			&& ! self::is_onboarding()
1827
			&& (
1828
				! is_multisite()
1829
				|| ! get_site_option( 'jetpack_protect_active' )
1830
			)
1831
		) {
1832
			return;
1833
		}
1834
1835
		$version = Jetpack_Options::get_option( 'version' );
1836 View Code Duplication
		if ( ! $version ) {
1837
			$version = $old_version = JETPACK__VERSION . ':' . time();
1838
			/** This action is documented in class.jetpack.php */
1839
			do_action( 'updating_jetpack_version', $version, false );
1840
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1841
		}
1842
		list( $version ) = explode( ':', $version );
1843
1844
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1845
1846
		$modules_data = array();
1847
1848
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1849
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1850
			$updated_modules = array();
1851
			foreach ( $modules as $module ) {
1852
				$modules_data[ $module ] = self::get_module( $module );
1853
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1854
					continue;
1855
				}
1856
1857
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1858
					continue;
1859
				}
1860
1861
				$updated_modules[] = $module;
1862
			}
1863
1864
			$modules = array_diff( $modules, $updated_modules );
1865
		}
1866
1867
		foreach ( $modules as $index => $module ) {
1868
			// If we're in dev mode, disable modules requiring a connection
1869
			if ( $is_development_mode ) {
1870
				// Prime the pump if we need to
1871
				if ( empty( $modules_data[ $module ] ) ) {
1872
					$modules_data[ $module ] = self::get_module( $module );
1873
				}
1874
				// If the module requires a connection, but we're in local mode, don't include it.
1875
				if ( $modules_data[ $module ]['requires_connection'] ) {
1876
					continue;
1877
				}
1878
			}
1879
1880
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1881
				continue;
1882
			}
1883
1884
			if ( ! include_once self::get_module_path( $module ) ) {
1885
				unset( $modules[ $index ] );
1886
				self::update_active_modules( array_values( $modules ) );
1887
				continue;
1888
			}
1889
1890
			/**
1891
			 * Fires when a specific module is loaded.
1892
			 * The dynamic part of the hook, $module, is the module slug.
1893
			 *
1894
			 * @since 1.1.0
1895
			 */
1896
			do_action( 'jetpack_module_loaded_' . $module );
1897
		}
1898
1899
		/**
1900
		 * Fires when all the modules are loaded.
1901
		 *
1902
		 * @since 1.1.0
1903
		 */
1904
		do_action( 'jetpack_modules_loaded' );
1905
1906
		// 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.
1907
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1908
	}
1909
1910
	/**
1911
	 * Check if Jetpack's REST API compat file should be included
1912
	 *
1913
	 * @action plugins_loaded
1914
	 * @return null
1915
	 */
1916
	public function check_rest_api_compat() {
1917
		/**
1918
		 * Filters the list of REST API compat files to be included.
1919
		 *
1920
		 * @since 2.2.5
1921
		 *
1922
		 * @param array $args Array of REST API compat files to include.
1923
		 */
1924
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1925
1926
		if ( function_exists( 'bbpress' ) ) {
1927
			$_jetpack_rest_api_compat_includes[] = JETPACK__PLUGIN_DIR . 'class.jetpack-bbpress-json-api-compat.php';
1928
		}
1929
1930
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1931
			require_once $_jetpack_rest_api_compat_include;
1932
		}
1933
	}
1934
1935
	/**
1936
	 * Gets all plugins currently active in values, regardless of whether they're
1937
	 * traditionally activated or network activated.
1938
	 *
1939
	 * @todo Store the result in core's object cache maybe?
1940
	 */
1941
	public static function get_active_plugins() {
1942
		$active_plugins = (array) get_option( 'active_plugins', array() );
1943
1944
		if ( is_multisite() ) {
1945
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1946
			// whereas active_plugins stores them in the values.
1947
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1948
			if ( $network_plugins ) {
1949
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1950
			}
1951
		}
1952
1953
		sort( $active_plugins );
1954
1955
		return array_unique( $active_plugins );
1956
	}
1957
1958
	/**
1959
	 * Gets and parses additional plugin data to send with the heartbeat data
1960
	 *
1961
	 * @since 3.8.1
1962
	 *
1963
	 * @return array Array of plugin data
1964
	 */
1965
	public static function get_parsed_plugin_data() {
1966
		if ( ! function_exists( 'get_plugins' ) ) {
1967
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
1968
		}
1969
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
1970
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
1971
		$active_plugins = self::get_active_plugins();
1972
1973
		$plugins = array();
1974
		foreach ( $all_plugins as $path => $plugin_data ) {
1975
			$plugins[ $path ] = array(
1976
				'is_active' => in_array( $path, $active_plugins ),
1977
				'file'      => $path,
1978
				'name'      => $plugin_data['Name'],
1979
				'version'   => $plugin_data['Version'],
1980
				'author'    => $plugin_data['Author'],
1981
			);
1982
		}
1983
1984
		return $plugins;
1985
	}
1986
1987
	/**
1988
	 * Gets and parses theme data to send with the heartbeat data
1989
	 *
1990
	 * @since 3.8.1
1991
	 *
1992
	 * @return array Array of theme data
1993
	 */
1994
	public static function get_parsed_theme_data() {
1995
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
1996
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
1997
1998
		$themes = array();
1999
		foreach ( $all_themes as $slug => $theme_data ) {
2000
			$theme_headers = array();
2001
			foreach ( $header_keys as $header_key ) {
2002
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2003
			}
2004
2005
			$themes[ $slug ] = array(
2006
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2007
				'slug'            => $slug,
2008
				'theme_root'      => $theme_data->get_theme_root_uri(),
2009
				'parent'          => $theme_data->parent(),
2010
				'headers'         => $theme_headers,
2011
			);
2012
		}
2013
2014
		return $themes;
2015
	}
2016
2017
	/**
2018
	 * Checks whether a specific plugin is active.
2019
	 *
2020
	 * We don't want to store these in a static variable, in case
2021
	 * there are switch_to_blog() calls involved.
2022
	 */
2023
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2024
		return in_array( $plugin, self::get_active_plugins() );
2025
	}
2026
2027
	/**
2028
	 * Check if Jetpack's Open Graph tags should be used.
2029
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2030
	 *
2031
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2032
	 * @action plugins_loaded
2033
	 * @return null
2034
	 */
2035
	public function check_open_graph() {
2036
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2037
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2038
		}
2039
2040
		$active_plugins = self::get_active_plugins();
2041
2042
		if ( ! empty( $active_plugins ) ) {
2043
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2044
				if ( in_array( $plugin, $active_plugins ) ) {
2045
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2046
					break;
2047
				}
2048
			}
2049
		}
2050
2051
		/**
2052
		 * Allow the addition of Open Graph Meta Tags to all pages.
2053
		 *
2054
		 * @since 2.0.3
2055
		 *
2056
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2057
		 */
2058
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2059
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2060
		}
2061
	}
2062
2063
	/**
2064
	 * Check if Jetpack's Twitter tags should be used.
2065
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2066
	 *
2067
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2068
	 * @action plugins_loaded
2069
	 * @return null
2070
	 */
2071
	public function check_twitter_tags() {
2072
2073
		$active_plugins = self::get_active_plugins();
2074
2075
		if ( ! empty( $active_plugins ) ) {
2076
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2077
				if ( in_array( $plugin, $active_plugins ) ) {
2078
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2079
					break;
2080
				}
2081
			}
2082
		}
2083
2084
		/**
2085
		 * Allow Twitter Card Meta tags to be disabled.
2086
		 *
2087
		 * @since 2.6.0
2088
		 *
2089
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2090
		 */
2091
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2092
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2093
		}
2094
	}
2095
2096
	/**
2097
	 * Allows plugins to submit security reports.
2098
	 *
2099
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2100
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2101
	 * @param array  $args         See definitions above
2102
	 */
2103
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2104
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2105
	}
2106
2107
	/* Jetpack Options API */
2108
2109
	public static function get_option_names( $type = 'compact' ) {
2110
		return Jetpack_Options::get_option_names( $type );
2111
	}
2112
2113
	/**
2114
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2115
	 *
2116
	 * @param string $name    Option name
2117
	 * @param mixed  $default (optional)
2118
	 */
2119
	public static function get_option( $name, $default = false ) {
2120
		return Jetpack_Options::get_option( $name, $default );
2121
	}
2122
2123
	/**
2124
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2125
	 *
2126
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2127
	 * @param string $name  Option name
2128
	 * @param mixed  $value Option value
2129
	 */
2130
	public static function update_option( $name, $value ) {
2131
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2132
		return Jetpack_Options::update_option( $name, $value );
2133
	}
2134
2135
	/**
2136
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2137
	 *
2138
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2139
	 * @param array $array array( option name => option value, ... )
2140
	 */
2141
	public static function update_options( $array ) {
2142
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2143
		return Jetpack_Options::update_options( $array );
2144
	}
2145
2146
	/**
2147
	 * Deletes the given option.  May be passed multiple option names as an array.
2148
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2149
	 *
2150
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2151
	 * @param string|array $names
2152
	 */
2153
	public static function delete_option( $names ) {
2154
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2155
		return Jetpack_Options::delete_option( $names );
2156
	}
2157
2158
	/**
2159
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2160
	 *
2161
	 * Enters a user token into the user_tokens option
2162
	 *
2163
	 * @param int    $user_id The user id.
2164
	 * @param string $token The user token.
2165
	 * @param bool   $is_master_user Whether the user is the master user.
2166
	 * @return bool
2167
	 */
2168
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2169
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2170
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2171
	}
2172
2173
	/**
2174
	 * Returns an array of all PHP files in the specified absolute path.
2175
	 * Equivalent to glob( "$absolute_path/*.php" ).
2176
	 *
2177
	 * @param string $absolute_path The absolute path of the directory to search.
2178
	 * @return array Array of absolute paths to the PHP files.
2179
	 */
2180
	public static function glob_php( $absolute_path ) {
2181
		if ( function_exists( 'glob' ) ) {
2182
			return glob( "$absolute_path/*.php" );
2183
		}
2184
2185
		$absolute_path = untrailingslashit( $absolute_path );
2186
		$files         = array();
2187
		if ( ! $dir = @opendir( $absolute_path ) ) {
2188
			return $files;
2189
		}
2190
2191
		while ( false !== $file = readdir( $dir ) ) {
2192
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2193
				continue;
2194
			}
2195
2196
			$file = "$absolute_path/$file";
2197
2198
			if ( ! is_file( $file ) ) {
2199
				continue;
2200
			}
2201
2202
			$files[] = $file;
2203
		}
2204
2205
		closedir( $dir );
2206
2207
		return $files;
2208
	}
2209
2210
	public static function activate_new_modules( $redirect = false ) {
2211
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2212
			return;
2213
		}
2214
2215
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2216 View Code Duplication
		if ( ! $jetpack_old_version ) {
2217
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2218
			/** This action is documented in class.jetpack.php */
2219
			do_action( 'updating_jetpack_version', $version, false );
2220
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2221
		}
2222
2223
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2224
2225
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2226
			return;
2227
		}
2228
2229
		$active_modules     = self::get_active_modules();
2230
		$reactivate_modules = array();
2231
		foreach ( $active_modules as $active_module ) {
2232
			$module = self::get_module( $active_module );
2233
			if ( ! isset( $module['changed'] ) ) {
2234
				continue;
2235
			}
2236
2237
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2238
				continue;
2239
			}
2240
2241
			$reactivate_modules[] = $active_module;
2242
			self::deactivate_module( $active_module );
2243
		}
2244
2245
		$new_version = JETPACK__VERSION . ':' . time();
2246
		/** This action is documented in class.jetpack.php */
2247
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2248
		Jetpack_Options::update_options(
2249
			array(
2250
				'version'     => $new_version,
2251
				'old_version' => $jetpack_old_version,
2252
			)
2253
		);
2254
2255
		self::state( 'message', 'modules_activated' );
2256
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
2257
2258
		if ( $redirect ) {
2259
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2260
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2261
				$page = $_GET['page'];
2262
			}
2263
2264
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2265
			exit;
2266
		}
2267
	}
2268
2269
	/**
2270
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2271
	 * Make sure to tuck away module "library" files in a sub-directory.
2272
	 */
2273
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2274
		static $modules = null;
2275
2276
		if ( ! isset( $modules ) ) {
2277
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2278
			// Use the cache if we're on the front-end and it's available...
2279
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2280
				$modules = $available_modules_option[ JETPACK__VERSION ];
2281
			} else {
2282
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2283
2284
				$modules = array();
2285
2286
				foreach ( $files as $file ) {
2287
					if ( ! $headers = self::get_module( $file ) ) {
2288
						continue;
2289
					}
2290
2291
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2292
				}
2293
2294
				Jetpack_Options::update_option(
2295
					'available_modules',
2296
					array(
2297
						JETPACK__VERSION => $modules,
2298
					)
2299
				);
2300
			}
2301
		}
2302
2303
		/**
2304
		 * Filters the array of modules available to be activated.
2305
		 *
2306
		 * @since 2.4.0
2307
		 *
2308
		 * @param array $modules Array of available modules.
2309
		 * @param string $min_version Minimum version number required to use modules.
2310
		 * @param string $max_version Maximum version number required to use modules.
2311
		 */
2312
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2313
2314
		if ( ! $min_version && ! $max_version ) {
2315
			return array_keys( $mods );
2316
		}
2317
2318
		$r = array();
2319
		foreach ( $mods as $slug => $introduced ) {
2320
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2321
				continue;
2322
			}
2323
2324
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2325
				continue;
2326
			}
2327
2328
			$r[] = $slug;
2329
		}
2330
2331
		return $r;
2332
	}
2333
2334
	/**
2335
	 * Default modules loaded on activation.
2336
	 */
2337
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2338
		$return = array();
2339
2340
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2341
			$module_data = self::get_module( $module );
2342
2343
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2344
				case 'yes':
2345
					$return[] = $module;
2346
					break;
2347
				case 'public':
2348
					if ( Jetpack_Options::get_option( 'public' ) ) {
2349
						$return[] = $module;
2350
					}
2351
					break;
2352
				case 'no':
2353
				default:
2354
					break;
2355
			}
2356
		}
2357
		/**
2358
		 * Filters the array of default modules.
2359
		 *
2360
		 * @since 2.5.0
2361
		 *
2362
		 * @param array $return Array of default modules.
2363
		 * @param string $min_version Minimum version number required to use modules.
2364
		 * @param string $max_version Maximum version number required to use modules.
2365
		 */
2366
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2367
	}
2368
2369
	/**
2370
	 * Checks activated modules during auto-activation to determine
2371
	 * if any of those modules are being deprecated.  If so, close
2372
	 * them out, and add any replacement modules.
2373
	 *
2374
	 * Runs at priority 99 by default.
2375
	 *
2376
	 * This is run late, so that it can still activate a module if
2377
	 * the new module is a replacement for another that the user
2378
	 * currently has active, even if something at the normal priority
2379
	 * would kibosh everything.
2380
	 *
2381
	 * @since 2.6
2382
	 * @uses jetpack_get_default_modules filter
2383
	 * @param array $modules
2384
	 * @return array
2385
	 */
2386
	function handle_deprecated_modules( $modules ) {
2387
		$deprecated_modules = array(
2388
			'debug'            => null,  // Closed out and moved to the debugger library.
2389
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2390
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2391
		);
2392
2393
		// Don't activate SSO if they never completed activating WPCC.
2394
		if ( self::is_module_active( 'wpcc' ) ) {
2395
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2396
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2397
				$deprecated_modules['wpcc'] = null;
2398
			}
2399
		}
2400
2401
		foreach ( $deprecated_modules as $module => $replacement ) {
2402
			if ( self::is_module_active( $module ) ) {
2403
				self::deactivate_module( $module );
2404
				if ( $replacement ) {
2405
					$modules[] = $replacement;
2406
				}
2407
			}
2408
		}
2409
2410
		return array_unique( $modules );
2411
	}
2412
2413
	/**
2414
	 * Checks activated plugins during auto-activation to determine
2415
	 * if any of those plugins are in the list with a corresponding module
2416
	 * that is not compatible with the plugin. The module will not be allowed
2417
	 * to auto-activate.
2418
	 *
2419
	 * @since 2.6
2420
	 * @uses jetpack_get_default_modules filter
2421
	 * @param array $modules
2422
	 * @return array
2423
	 */
2424
	function filter_default_modules( $modules ) {
2425
2426
		$active_plugins = self::get_active_plugins();
2427
2428
		if ( ! empty( $active_plugins ) ) {
2429
2430
			// For each module we'd like to auto-activate...
2431
			foreach ( $modules as $key => $module ) {
2432
				// If there are potential conflicts for it...
2433
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2434
					// For each potential conflict...
2435
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2436
						// If that conflicting plugin is active...
2437
						if ( in_array( $plugin, $active_plugins ) ) {
2438
							// Remove that item from being auto-activated.
2439
							unset( $modules[ $key ] );
2440
						}
2441
					}
2442
				}
2443
			}
2444
		}
2445
2446
		return $modules;
2447
	}
2448
2449
	/**
2450
	 * Extract a module's slug from its full path.
2451
	 */
2452
	public static function get_module_slug( $file ) {
2453
		return str_replace( '.php', '', basename( $file ) );
2454
	}
2455
2456
	/**
2457
	 * Generate a module's path from its slug.
2458
	 */
2459
	public static function get_module_path( $slug ) {
2460
		/**
2461
		 * Filters the path of a modules.
2462
		 *
2463
		 * @since 7.4.0
2464
		 *
2465
		 * @param array $return The absolute path to a module's root php file
2466
		 * @param string $slug The module slug
2467
		 */
2468
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2469
	}
2470
2471
	/**
2472
	 * Load module data from module file. Headers differ from WordPress
2473
	 * plugin headers to avoid them being identified as standalone
2474
	 * plugins on the WordPress plugins page.
2475
	 */
2476
	public static function get_module( $module ) {
2477
		$headers = array(
2478
			'name'                      => 'Module Name',
2479
			'description'               => 'Module Description',
2480
			'sort'                      => 'Sort Order',
2481
			'recommendation_order'      => 'Recommendation Order',
2482
			'introduced'                => 'First Introduced',
2483
			'changed'                   => 'Major Changes In',
2484
			'deactivate'                => 'Deactivate',
2485
			'free'                      => 'Free',
2486
			'requires_connection'       => 'Requires Connection',
2487
			'auto_activate'             => 'Auto Activate',
2488
			'module_tags'               => 'Module Tags',
2489
			'feature'                   => 'Feature',
2490
			'additional_search_queries' => 'Additional Search Queries',
2491
			'plan_classes'              => 'Plans',
2492
		);
2493
2494
		$file = self::get_module_path( self::get_module_slug( $module ) );
2495
2496
		$mod = self::get_file_data( $file, $headers );
2497
		if ( empty( $mod['name'] ) ) {
2498
			return false;
2499
		}
2500
2501
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2502
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2503
		$mod['deactivate']           = empty( $mod['deactivate'] );
2504
		$mod['free']                 = empty( $mod['free'] );
2505
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2506
2507
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2508
			$mod['auto_activate'] = 'No';
2509
		} else {
2510
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2511
		}
2512
2513
		if ( $mod['module_tags'] ) {
2514
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2515
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2516
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2517
		} else {
2518
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2519
		}
2520
2521 View Code Duplication
		if ( $mod['plan_classes'] ) {
2522
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2523
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2524
		} else {
2525
			$mod['plan_classes'] = array( 'free' );
2526
		}
2527
2528 View Code Duplication
		if ( $mod['feature'] ) {
2529
			$mod['feature'] = explode( ',', $mod['feature'] );
2530
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2531
		} else {
2532
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2533
		}
2534
2535
		/**
2536
		 * Filters the feature array on a module.
2537
		 *
2538
		 * This filter allows you to control where each module is filtered: Recommended,
2539
		 * and the default "Other" listing.
2540
		 *
2541
		 * @since 3.5.0
2542
		 *
2543
		 * @param array   $mod['feature'] The areas to feature this module:
2544
		 *     'Recommended' shows on the main Jetpack admin screen.
2545
		 *     'Other' should be the default if no other value is in the array.
2546
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2547
		 * @param array   $mod All the currently assembled module data.
2548
		 */
2549
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2550
2551
		/**
2552
		 * Filter the returned data about a module.
2553
		 *
2554
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2555
		 * so please be careful.
2556
		 *
2557
		 * @since 3.6.0
2558
		 *
2559
		 * @param array   $mod    The details of the requested module.
2560
		 * @param string  $module The slug of the module, e.g. sharedaddy
2561
		 * @param string  $file   The path to the module source file.
2562
		 */
2563
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2564
	}
2565
2566
	/**
2567
	 * Like core's get_file_data implementation, but caches the result.
2568
	 */
2569
	public static function get_file_data( $file, $headers ) {
2570
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2571
		$file_name = basename( $file );
2572
2573
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2574
2575
		$file_data_option = get_transient( $cache_key );
2576
2577
		if ( ! is_array( $file_data_option ) ) {
2578
			delete_transient( $cache_key );
2579
			$file_data_option = false;
2580
		}
2581
2582
		if ( false === $file_data_option ) {
2583
			$file_data_option = array();
2584
		}
2585
2586
		$key           = md5( $file_name . serialize( $headers ) );
2587
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2588
2589
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2590
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2591
			return $file_data_option[ $key ];
2592
		}
2593
2594
		$data = get_file_data( $file, $headers );
2595
2596
		$file_data_option[ $key ] = $data;
2597
2598
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2599
2600
		return $data;
2601
	}
2602
2603
2604
	/**
2605
	 * Return translated module tag.
2606
	 *
2607
	 * @param string $tag Tag as it appears in each module heading.
2608
	 *
2609
	 * @return mixed
2610
	 */
2611
	public static function translate_module_tag( $tag ) {
2612
		return jetpack_get_module_i18n_tag( $tag );
2613
	}
2614
2615
	/**
2616
	 * Get i18n strings as a JSON-encoded string
2617
	 *
2618
	 * @return string The locale as JSON
2619
	 */
2620
	public static function get_i18n_data_json() {
2621
2622
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2623
		// JSON files with the file they should be included for. This is an md5
2624
		// of '_inc/build/admin.js'.
2625
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2626
2627
		$i18n_json =
2628
				   JETPACK__PLUGIN_DIR
2629
				   . 'languages/json/jetpack-'
2630
				   . get_user_locale()
2631
				   . '-'
2632
				   . $path_md5
2633
				   . '.json';
2634
2635
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2636
			$locale_data = @file_get_contents( $i18n_json );
2637
			if ( $locale_data ) {
2638
				return $locale_data;
2639
			}
2640
		}
2641
2642
		// Return valid empty Jed locale
2643
		return '{ "locale_data": { "messages": { "": {} } } }';
2644
	}
2645
2646
	/**
2647
	 * Add locale data setup to wp-i18n
2648
	 *
2649
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2650
	 *
2651
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2652
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2653
	 *
2654
	 * This method provides a safe way to request the setup multiple times but add the script at
2655
	 * most once.
2656
	 *
2657
	 * @since 6.7.0
2658
	 *
2659
	 * @return void
2660
	 */
2661
	public static function setup_wp_i18n_locale_data() {
2662
		static $script_added = false;
2663
		if ( ! $script_added ) {
2664
			$script_added = true;
2665
			wp_add_inline_script(
2666
				'wp-i18n',
2667
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2668
			);
2669
		}
2670
	}
2671
2672
	/**
2673
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2674
	 *
2675
	 * @since 3.9.2
2676
	 *
2677
	 * @param array $modules
2678
	 *
2679
	 * @return string|void
2680
	 */
2681
	public static function get_translated_modules( $modules ) {
2682
		foreach ( $modules as $index => $module ) {
2683
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2684
			if ( isset( $module['name'] ) ) {
2685
				$modules[ $index ]['name'] = $i18n_module['name'];
2686
			}
2687
			if ( isset( $module['description'] ) ) {
2688
				$modules[ $index ]['description']       = $i18n_module['description'];
2689
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2690
			}
2691
		}
2692
		return $modules;
2693
	}
2694
2695
	/**
2696
	 * Get a list of activated modules as an array of module slugs.
2697
	 */
2698
	public static function get_active_modules() {
2699
		$active = Jetpack_Options::get_option( 'active_modules' );
2700
2701
		if ( ! is_array( $active ) ) {
2702
			$active = array();
2703
		}
2704
2705
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2706
			$active[] = 'vaultpress';
2707
		} else {
2708
			$active = array_diff( $active, array( 'vaultpress' ) );
2709
		}
2710
2711
		// If protect is active on the main site of a multisite, it should be active on all sites.
2712
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2713
			$active[] = 'protect';
2714
		}
2715
2716
		/**
2717
		 * Allow filtering of the active modules.
2718
		 *
2719
		 * Gives theme and plugin developers the power to alter the modules that
2720
		 * are activated on the fly.
2721
		 *
2722
		 * @since 5.8.0
2723
		 *
2724
		 * @param array $active Array of active module slugs.
2725
		 */
2726
		$active = apply_filters( 'jetpack_active_modules', $active );
2727
2728
		return array_unique( $active );
2729
	}
2730
2731
	/**
2732
	 * Check whether or not a Jetpack module is active.
2733
	 *
2734
	 * @param string $module The slug of a Jetpack module.
2735
	 * @return bool
2736
	 *
2737
	 * @static
2738
	 */
2739
	public static function is_module_active( $module ) {
2740
		return in_array( $module, self::get_active_modules() );
2741
	}
2742
2743
	public static function is_module( $module ) {
2744
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2745
	}
2746
2747
	/**
2748
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2749
	 *
2750
	 * @param bool $catch True to start catching, False to stop.
2751
	 *
2752
	 * @static
2753
	 */
2754
	public static function catch_errors( $catch ) {
2755
		static $display_errors, $error_reporting;
2756
2757
		if ( $catch ) {
2758
			$display_errors  = @ini_set( 'display_errors', 1 );
2759
			$error_reporting = @error_reporting( E_ALL );
2760
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2761
		} else {
2762
			@ini_set( 'display_errors', $display_errors );
2763
			@error_reporting( $error_reporting );
2764
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2765
		}
2766
	}
2767
2768
	/**
2769
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2770
	 */
2771
	public static function catch_errors_on_shutdown() {
2772
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2773
	}
2774
2775
	/**
2776
	 * Rewrite any string to make paths easier to read.
2777
	 *
2778
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2779
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2780
	 *
2781
	 * @param $string
2782
	 * @return mixed
2783
	 */
2784
	public static function alias_directories( $string ) {
2785
		// ABSPATH has a trailing slash.
2786
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2787
		// WP_CONTENT_DIR does not have a trailing slash.
2788
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2789
2790
		return $string;
2791
	}
2792
2793
	public static function activate_default_modules(
2794
		$min_version = false,
2795
		$max_version = false,
2796
		$other_modules = array(),
2797
		$redirect = null,
2798
		$send_state_messages = null
2799
	) {
2800
		$jetpack = self::init();
2801
2802
		if ( is_null( $redirect ) ) {
2803
			if (
2804
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2805
			||
2806
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2807
			||
2808
				( defined( 'WP_CLI' ) && WP_CLI )
2809
			||
2810
				( defined( 'DOING_CRON' ) && DOING_CRON )
2811
			||
2812
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2813
			) {
2814
				$redirect = false;
2815
			} elseif ( is_admin() ) {
2816
				$redirect = true;
2817
			} else {
2818
				$redirect = false;
2819
			}
2820
		}
2821
2822
		if ( is_null( $send_state_messages ) ) {
2823
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2824
		}
2825
2826
		$modules = self::get_default_modules( $min_version, $max_version );
2827
		$modules = array_merge( $other_modules, $modules );
2828
2829
		// Look for standalone plugins and disable if active.
2830
2831
		$to_deactivate = array();
2832
		foreach ( $modules as $module ) {
2833
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2834
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2835
			}
2836
		}
2837
2838
		$deactivated = array();
2839
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2840
			list( $probable_file, $probable_title ) = $deactivate_me;
2841
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2842
				$deactivated[] = $module;
2843
			}
2844
		}
2845
2846
		if ( $deactivated ) {
2847
			if ( $send_state_messages ) {
2848
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2849
			}
2850
2851
			if ( $redirect ) {
2852
				$url = add_query_arg(
2853
					array(
2854
						'action'   => 'activate_default_modules',
2855
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2856
					),
2857
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2858
				);
2859
				wp_safe_redirect( $url );
2860
				exit;
2861
			}
2862
		}
2863
2864
		/**
2865
		 * Fires before default modules are activated.
2866
		 *
2867
		 * @since 1.9.0
2868
		 *
2869
		 * @param string $min_version Minimum version number required to use modules.
2870
		 * @param string $max_version Maximum version number required to use modules.
2871
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2872
		 */
2873
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2874
2875
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2876
		if ( $send_state_messages ) {
2877
			self::restate();
2878
			self::catch_errors( true );
2879
		}
2880
2881
		$active = self::get_active_modules();
2882
2883
		foreach ( $modules as $module ) {
2884
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2885
				$active[] = $module;
2886
				self::update_active_modules( $active );
2887
				continue;
2888
			}
2889
2890
			if ( $send_state_messages && in_array( $module, $active ) ) {
2891
				$module_info = self::get_module( $module );
2892 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2893
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2894
					if ( $active_state = self::state( $state ) ) {
2895
						$active_state = explode( ',', $active_state );
2896
					} else {
2897
						$active_state = array();
2898
					}
2899
					$active_state[] = $module;
2900
					self::state( $state, implode( ',', $active_state ) );
2901
				}
2902
				continue;
2903
			}
2904
2905
			$file = self::get_module_path( $module );
2906
			if ( ! file_exists( $file ) ) {
2907
				continue;
2908
			}
2909
2910
			// we'll override this later if the plugin can be included without fatal error
2911
			if ( $redirect ) {
2912
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2913
			}
2914
2915
			if ( $send_state_messages ) {
2916
				self::state( 'error', 'module_activation_failed' );
2917
				self::state( 'module', $module );
2918
			}
2919
2920
			ob_start();
2921
			require_once $file;
2922
2923
			$active[] = $module;
2924
2925 View Code Duplication
			if ( $send_state_messages ) {
2926
2927
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2928
				if ( $active_state = self::state( $state ) ) {
2929
					$active_state = explode( ',', $active_state );
2930
				} else {
2931
					$active_state = array();
2932
				}
2933
				$active_state[] = $module;
2934
				self::state( $state, implode( ',', $active_state ) );
2935
			}
2936
2937
			self::update_active_modules( $active );
2938
2939
			ob_end_clean();
2940
		}
2941
2942
		if ( $send_state_messages ) {
2943
			self::state( 'error', false );
2944
			self::state( 'module', false );
2945
		}
2946
2947
		self::catch_errors( false );
2948
		/**
2949
		 * Fires when default modules are activated.
2950
		 *
2951
		 * @since 1.9.0
2952
		 *
2953
		 * @param string $min_version Minimum version number required to use modules.
2954
		 * @param string $max_version Maximum version number required to use modules.
2955
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2956
		 */
2957
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2958
	}
2959
2960
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2961
		/**
2962
		 * Fires before a module is activated.
2963
		 *
2964
		 * @since 2.6.0
2965
		 *
2966
		 * @param string $module Module slug.
2967
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2968
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2969
		 */
2970
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2971
2972
		$jetpack = self::init();
2973
2974
		if ( ! strlen( $module ) ) {
2975
			return false;
2976
		}
2977
2978
		if ( ! self::is_module( $module ) ) {
2979
			return false;
2980
		}
2981
2982
		// If it's already active, then don't do it again
2983
		$active = self::get_active_modules();
2984
		foreach ( $active as $act ) {
2985
			if ( $act == $module ) {
2986
				return true;
2987
			}
2988
		}
2989
2990
		$module_data = self::get_module( $module );
2991
2992
		$is_development_mode = ( new Status() )->is_development_mode();
2993
		if ( ! self::is_active() ) {
2994
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
2995
				return false;
2996
			}
2997
2998
			// If we're not connected but in development mode, make sure the module doesn't require a connection
2999
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3000
				return false;
3001
			}
3002
		}
3003
3004
		// Check and see if the old plugin is active
3005
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3006
			// Deactivate the old plugin
3007
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3008
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3009
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3010
				self::state( 'deactivated_plugins', $module );
3011
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3012
				exit;
3013
			}
3014
		}
3015
3016
		// Protect won't work with mis-configured IPs
3017
		if ( 'protect' === $module ) {
3018
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3019
			if ( ! jetpack_protect_get_ip() ) {
3020
				self::state( 'message', 'protect_misconfigured_ip' );
3021
				return false;
3022
			}
3023
		}
3024
3025
		if ( ! Jetpack_Plan::supports( $module ) ) {
3026
			return false;
3027
		}
3028
3029
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3030
		self::state( 'module', $module );
3031
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3032
3033
		self::catch_errors( true );
3034
		ob_start();
3035
		require self::get_module_path( $module );
3036
		/** This action is documented in class.jetpack.php */
3037
		do_action( 'jetpack_activate_module', $module );
3038
		$active[] = $module;
3039
		self::update_active_modules( $active );
3040
3041
		self::state( 'error', false ); // the override
3042
		ob_end_clean();
3043
		self::catch_errors( false );
3044
3045
		if ( $redirect ) {
3046
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3047
		}
3048
		if ( $exit ) {
3049
			exit;
3050
		}
3051
		return true;
3052
	}
3053
3054
	function activate_module_actions( $module ) {
3055
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3056
	}
3057
3058
	public static function deactivate_module( $module ) {
3059
		/**
3060
		 * Fires when a module is deactivated.
3061
		 *
3062
		 * @since 1.9.0
3063
		 *
3064
		 * @param string $module Module slug.
3065
		 */
3066
		do_action( 'jetpack_pre_deactivate_module', $module );
3067
3068
		$jetpack = self::init();
3069
3070
		$active = self::get_active_modules();
3071
		$new    = array_filter( array_diff( $active, (array) $module ) );
3072
3073
		return self::update_active_modules( $new );
3074
	}
3075
3076
	public static function enable_module_configurable( $module ) {
3077
		$module = self::get_module_slug( $module );
3078
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3079
	}
3080
3081
	/**
3082
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3083
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3084
	 *
3085
	 * @param string $module Module slug
3086
	 * @return string $url module configuration URL
3087
	 */
3088
	public static function module_configuration_url( $module ) {
3089
		$module      = self::get_module_slug( $module );
3090
		$default_url = self::admin_url() . "#/settings?term=$module";
3091
		/**
3092
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3093
		 *
3094
		 * @since 6.9.0
3095
		 *
3096
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3097
		 */
3098
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3099
3100
		return $url;
3101
	}
3102
3103
	/* Installation */
3104
	public static function bail_on_activation( $message, $deactivate = true ) {
3105
		?>
3106
<!doctype html>
3107
<html>
3108
<head>
3109
<meta charset="<?php bloginfo( 'charset' ); ?>">
3110
<style>
3111
* {
3112
	text-align: center;
3113
	margin: 0;
3114
	padding: 0;
3115
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3116
}
3117
p {
3118
	margin-top: 1em;
3119
	font-size: 18px;
3120
}
3121
</style>
3122
<body>
3123
<p><?php echo esc_html( $message ); ?></p>
3124
</body>
3125
</html>
3126
		<?php
3127
		if ( $deactivate ) {
3128
			$plugins = get_option( 'active_plugins' );
3129
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3130
			$update  = false;
3131
			foreach ( $plugins as $i => $plugin ) {
3132
				if ( $plugin === $jetpack ) {
3133
					$plugins[ $i ] = false;
3134
					$update        = true;
3135
				}
3136
			}
3137
3138
			if ( $update ) {
3139
				update_option( 'active_plugins', array_filter( $plugins ) );
3140
			}
3141
		}
3142
		exit;
3143
	}
3144
3145
	/**
3146
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3147
	 *
3148
	 * @static
3149
	 */
3150
	public static function plugin_activation( $network_wide ) {
3151
		Jetpack_Options::update_option( 'activated', 1 );
3152
3153
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3154
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3155
		}
3156
3157
		if ( $network_wide ) {
3158
			self::state( 'network_nag', true );
3159
		}
3160
3161
		// For firing one-off events (notices) immediately after activation
3162
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3163
3164
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3165
3166
		self::plugin_initialize();
3167
	}
3168
3169
	public static function get_activation_source( $referer_url ) {
3170
3171
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3172
			return array( 'wp-cli', null );
3173
		}
3174
3175
		$referer = wp_parse_url( $referer_url );
3176
3177
		$source_type  = 'unknown';
3178
		$source_query = null;
3179
3180
		if ( ! is_array( $referer ) ) {
3181
			return array( $source_type, $source_query );
3182
		}
3183
3184
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3185
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3186
3187
		if ( isset( $referer['query'] ) ) {
3188
			parse_str( $referer['query'], $query_parts );
3189
		} else {
3190
			$query_parts = array();
3191
		}
3192
3193
		if ( $plugins_path === $referer['path'] ) {
3194
			$source_type = 'list';
3195
		} elseif ( $plugins_install_path === $referer['path'] ) {
3196
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3197
			switch ( $tab ) {
3198
				case 'popular':
3199
					$source_type = 'popular';
3200
					break;
3201
				case 'recommended':
3202
					$source_type = 'recommended';
3203
					break;
3204
				case 'favorites':
3205
					$source_type = 'favorites';
3206
					break;
3207
				case 'search':
3208
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3209
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3210
					break;
3211
				default:
3212
					$source_type = 'featured';
3213
			}
3214
		}
3215
3216
		return array( $source_type, $source_query );
3217
	}
3218
3219
	/**
3220
	 * Runs before bumping version numbers up to a new version
3221
	 *
3222
	 * @param  string $version    Version:timestamp
3223
	 * @param  string $old_version Old Version:timestamp or false if not set yet.
3224
	 * @return null              [description]
3225
	 */
3226
	public static function do_version_bump( $version, $old_version ) {
3227
		if ( ! $old_version ) { // For new sites
3228
			// There used to be stuff here, but this seems like it might  be useful to someone in the future...
3229
		}
3230
	}
3231
3232
	/**
3233
	 * Sets the internal version number and activation state.
3234
	 *
3235
	 * @static
3236
	 */
3237
	public static function plugin_initialize() {
3238
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3239
			Jetpack_Options::update_option( 'activated', 2 );
3240
		}
3241
3242 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3243
			$version = $old_version = JETPACK__VERSION . ':' . time();
3244
			/** This action is documented in class.jetpack.php */
3245
			do_action( 'updating_jetpack_version', $version, false );
3246
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3247
		}
3248
3249
		self::load_modules();
3250
3251
		Jetpack_Options::delete_option( 'do_activate' );
3252
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3253
	}
3254
3255
	/**
3256
	 * Removes all connection options
3257
	 *
3258
	 * @static
3259
	 */
3260
	public static function plugin_deactivation() {
3261
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3262
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3263
			Jetpack_Network::init()->deactivate();
3264
		} else {
3265
			self::disconnect( false );
3266
			// Jetpack_Heartbeat::init()->deactivate();
3267
		}
3268
	}
3269
3270
	/**
3271
	 * Disconnects from the Jetpack servers.
3272
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3273
	 *
3274
	 * @static
3275
	 */
3276
	public static function disconnect( $update_activated_state = true ) {
3277
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3278
		$connection = self::connection();
3279
		$connection->clean_nonces( true );
3280
3281
		// If the site is in an IDC because sync is not allowed,
3282
		// let's make sure to not disconnect the production site.
3283
		if ( ! self::validate_sync_error_idc_option() ) {
3284
			$tracking = new Tracking();
3285
			$tracking->record_user_event( 'disconnect_site', array() );
3286
3287
			$connection->disconnect_site_wpcom();
3288
		}
3289
3290
		$connection->delete_all_connection_tokens();
3291
		Jetpack_IDC::clear_all_idc_options();
3292
3293
		if ( $update_activated_state ) {
3294
			Jetpack_Options::update_option( 'activated', 4 );
3295
		}
3296
3297
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3298
			// Check then record unique disconnection if site has never been disconnected previously
3299
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3300
				$jetpack_unique_connection['disconnected'] = 1;
3301
			} else {
3302
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3303
					// track unique disconnect
3304
					$jetpack = self::init();
3305
3306
					$jetpack->stat( 'connections', 'unique-disconnect' );
3307
					$jetpack->do_stats( 'server_side' );
3308
				}
3309
				// increment number of times disconnected
3310
				$jetpack_unique_connection['disconnected'] += 1;
3311
			}
3312
3313
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3314
		}
3315
3316
		// Delete all the sync related data. Since it could be taking up space.
3317
		Sender::get_instance()->uninstall();
3318
3319
		// Disable the Heartbeat cron
3320
		Jetpack_Heartbeat::init()->deactivate();
3321
	}
3322
3323
	/**
3324
	 * Unlinks the current user from the linked WordPress.com user.
3325
	 *
3326
	 * @deprecated since 7.7
3327
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3328
	 *
3329
	 * @param Integer $user_id the user identifier.
3330
	 * @return Boolean Whether the disconnection of the user was successful.
3331
	 */
3332
	public static function unlink_user( $user_id = null ) {
3333
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3334
		return Connection_Manager::disconnect_user( $user_id );
3335
	}
3336
3337
	/**
3338
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3339
	 */
3340
	public static function try_registration() {
3341
		$terms_of_service = new Terms_Of_Service();
3342
		// The user has agreed to the TOS at some point by now.
3343
		$terms_of_service->agree();
3344
3345
		// Let's get some testing in beta versions and such.
3346
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3347
			// Before attempting to connect, let's make sure that the domains are viable.
3348
			$domains_to_check = array_unique(
3349
				array(
3350
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3351
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3352
				)
3353
			);
3354
			foreach ( $domains_to_check as $domain ) {
3355
				$result = self::connection()->is_usable_domain( $domain );
3356
				if ( is_wp_error( $result ) ) {
3357
					return $result;
3358
				}
3359
			}
3360
		}
3361
3362
		$result = self::register();
3363
3364
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3365
		if ( ! $result || is_wp_error( $result ) ) {
3366
			return $result;
3367
		} else {
3368
			return true;
3369
		}
3370
	}
3371
3372
	/**
3373
	 * Tracking an internal event log. Try not to put too much chaff in here.
3374
	 *
3375
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3376
	 */
3377
	public static function log( $code, $data = null ) {
3378
		// only grab the latest 200 entries
3379
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3380
3381
		// Append our event to the log
3382
		$log_entry = array(
3383
			'time'    => time(),
3384
			'user_id' => get_current_user_id(),
3385
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3386
			'code'    => $code,
3387
		);
3388
		// Don't bother storing it unless we've got some.
3389
		if ( ! is_null( $data ) ) {
3390
			$log_entry['data'] = $data;
3391
		}
3392
		$log[] = $log_entry;
3393
3394
		// Try add_option first, to make sure it's not autoloaded.
3395
		// @todo: Add an add_option method to Jetpack_Options
3396
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3397
			Jetpack_Options::update_option( 'log', $log );
3398
		}
3399
3400
		/**
3401
		 * Fires when Jetpack logs an internal event.
3402
		 *
3403
		 * @since 3.0.0
3404
		 *
3405
		 * @param array $log_entry {
3406
		 *  Array of details about the log entry.
3407
		 *
3408
		 *  @param string time Time of the event.
3409
		 *  @param int user_id ID of the user who trigerred the event.
3410
		 *  @param int blog_id Jetpack Blog ID.
3411
		 *  @param string code Unique name for the event.
3412
		 *  @param string data Data about the event.
3413
		 * }
3414
		 */
3415
		do_action( 'jetpack_log_entry', $log_entry );
3416
	}
3417
3418
	/**
3419
	 * Get the internal event log.
3420
	 *
3421
	 * @param $event (string) - only return the specific log events
3422
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3423
	 *
3424
	 * @return array of log events || WP_Error for invalid params
3425
	 */
3426
	public static function get_log( $event = false, $num = false ) {
3427
		if ( $event && ! is_string( $event ) ) {
3428
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3429
		}
3430
3431
		if ( $num && ! is_numeric( $num ) ) {
3432
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3433
		}
3434
3435
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3436
3437
		// If nothing set - act as it did before, otherwise let's start customizing the output
3438
		if ( ! $num && ! $event ) {
3439
			return $entire_log;
3440
		} else {
3441
			$entire_log = array_reverse( $entire_log );
3442
		}
3443
3444
		$custom_log_output = array();
3445
3446
		if ( $event ) {
3447
			foreach ( $entire_log as $log_event ) {
3448
				if ( $event == $log_event['code'] ) {
3449
					$custom_log_output[] = $log_event;
3450
				}
3451
			}
3452
		} else {
3453
			$custom_log_output = $entire_log;
3454
		}
3455
3456
		if ( $num ) {
3457
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3458
		}
3459
3460
		return $custom_log_output;
3461
	}
3462
3463
	/**
3464
	 * Log modification of important settings.
3465
	 */
3466
	public static function log_settings_change( $option, $old_value, $value ) {
3467
		switch ( $option ) {
3468
			case 'jetpack_sync_non_public_post_stati':
3469
				self::log( $option, $value );
3470
				break;
3471
		}
3472
	}
3473
3474
	/**
3475
	 * Return stat data for WPCOM sync
3476
	 */
3477
	public static function get_stat_data( $encode = true, $extended = true ) {
3478
		$data = Jetpack_Heartbeat::generate_stats_array();
3479
3480
		if ( $extended ) {
3481
			$additional_data = self::get_additional_stat_data();
3482
			$data            = array_merge( $data, $additional_data );
3483
		}
3484
3485
		if ( $encode ) {
3486
			return json_encode( $data );
3487
		}
3488
3489
		return $data;
3490
	}
3491
3492
	/**
3493
	 * Get additional stat data to sync to WPCOM
3494
	 */
3495
	public static function get_additional_stat_data( $prefix = '' ) {
3496
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

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

Let’s take a look at an example:

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

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

    // do something with $myArray
}

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

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

Loading history...
3497
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3498
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3499
		$return[ "{$prefix}site-count" ]    = 0;
3500
3501
		if ( function_exists( 'get_blog_count' ) ) {
3502
			$return[ "{$prefix}site-count" ] = get_blog_count();
3503
		}
3504
		return $return;
3505
	}
3506
3507
	private static function get_site_user_count() {
3508
		global $wpdb;
3509
3510
		if ( function_exists( 'wp_is_large_network' ) ) {
3511
			if ( wp_is_large_network( 'users' ) ) {
3512
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3513
			}
3514
		}
3515
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3516
			// It wasn't there, so regenerate the data and save the transient
3517
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3518
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3519
		}
3520
		return $user_count;
3521
	}
3522
3523
	/* Admin Pages */
3524
3525
	function admin_init() {
3526
		// If the plugin is not connected, display a connect message.
3527
		if (
3528
			// the plugin was auto-activated and needs its candy
3529
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3530
		||
3531
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3532
			! Jetpack_Options::get_option( 'activated' )
3533
		) {
3534
			self::plugin_initialize();
3535
		}
3536
3537
		$is_development_mode = ( new Status() )->is_development_mode();
3538
		if ( ! self::is_active() && ! $is_development_mode ) {
3539
			Jetpack_Connection_Banner::init();
3540
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3541
			// Upgrade: 1.1 -> 1.1.1
3542
			// Check and see if host can verify the Jetpack servers' SSL certificate
3543
			$args       = array();
3544
			$connection = self::connection();
3545
			Client::_wp_remote_request(
3546
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3547
				$args,
3548
				true
3549
			);
3550
		}
3551
3552
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3553
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3554
		}
3555
3556
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3557
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3558
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3559
3560
		if ( self::is_active() || $is_development_mode ) {
3561
			// Artificially throw errors in certain whitelisted cases during plugin activation
3562
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3563
		}
3564
3565
		// Add custom column in wp-admin/users.php to show whether user is linked.
3566
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3567
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3568
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3569
	}
3570
3571
	function admin_body_class( $admin_body_class = '' ) {
3572
		$classes = explode( ' ', trim( $admin_body_class ) );
3573
3574
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3575
3576
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3577
		return " $admin_body_class ";
3578
	}
3579
3580
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3581
		return $admin_body_class . ' jetpack-pagestyles ';
3582
	}
3583
3584
	/**
3585
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3586
	 * This function artificially throws errors for such cases (whitelisted).
3587
	 *
3588
	 * @param string $plugin The activated plugin.
3589
	 */
3590
	function throw_error_on_activate_plugin( $plugin ) {
3591
		$active_modules = self::get_active_modules();
3592
3593
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3594
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3595
			$throw = false;
3596
3597
			// Try and make sure it really was the stats plugin
3598
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3599
				if ( 'stats.php' == basename( $plugin ) ) {
3600
					$throw = true;
3601
				}
3602
			} else {
3603
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3604
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3605
					$throw = true;
3606
				}
3607
			}
3608
3609
			if ( $throw ) {
3610
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3611
			}
3612
		}
3613
	}
3614
3615
	function intercept_plugin_error_scrape_init() {
3616
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3617
	}
3618
3619
	function intercept_plugin_error_scrape( $action, $result ) {
3620
		if ( ! $result ) {
3621
			return;
3622
		}
3623
3624
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3625
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3626
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3627
			}
3628
		}
3629
	}
3630
3631
	/**
3632
	 * Register the remote file upload request handlers, if needed.
3633
	 *
3634
	 * @access public
3635
	 */
3636
	public function add_remote_request_handlers() {
3637
		// Remote file uploads are allowed only via AJAX requests.
3638
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3639
			return;
3640
		}
3641
3642
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3643
		$remote_request_actions = array(
3644
			'jetpack_upload_file',
3645
			'jetpack_update_file',
3646
		);
3647
3648
		// phpcs:ignore WordPress.Security.NonceVerification
3649
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3650
			return;
3651
		}
3652
3653
		// Require Jetpack authentication for the remote file upload AJAX requests.
3654
		$this->connection_manager->require_jetpack_authentication();
3655
3656
		// Register the remote file upload AJAX handlers.
3657
		foreach ( $remote_request_actions as $action ) {
3658
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3659
		}
3660
	}
3661
3662
	/**
3663
	 * Handler for Jetpack remote file uploads.
3664
	 *
3665
	 * @access public
3666
	 */
3667
	public function remote_request_handlers() {
3668
		$action = current_filter();
3669
3670
		switch ( current_filter() ) {
3671
			case 'wp_ajax_nopriv_jetpack_upload_file':
3672
				$response = $this->upload_handler();
3673
				break;
3674
3675
			case 'wp_ajax_nopriv_jetpack_update_file':
3676
				$response = $this->upload_handler( true );
3677
				break;
3678
			default:
3679
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3680
				break;
3681
		}
3682
3683
		if ( ! $response ) {
3684
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3685
		}
3686
3687
		if ( is_wp_error( $response ) ) {
3688
			$status_code       = $response->get_error_data();
3689
			$error             = $response->get_error_code();
3690
			$error_description = $response->get_error_message();
3691
3692
			if ( ! is_int( $status_code ) ) {
3693
				$status_code = 400;
3694
			}
3695
3696
			status_header( $status_code );
3697
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3698
		}
3699
3700
		status_header( 200 );
3701
		if ( true === $response ) {
3702
			exit;
3703
		}
3704
3705
		die( json_encode( (object) $response ) );
3706
	}
3707
3708
	/**
3709
	 * Uploads a file gotten from the global $_FILES.
3710
	 * If `$update_media_item` is true and `post_id` is defined
3711
	 * the attachment file of the media item (gotten through of the post_id)
3712
	 * will be updated instead of add a new one.
3713
	 *
3714
	 * @param  boolean $update_media_item - update media attachment
3715
	 * @return array - An array describing the uploadind files process
3716
	 */
3717
	function upload_handler( $update_media_item = false ) {
3718
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3719
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3720
		}
3721
3722
		$user = wp_authenticate( '', '' );
3723
		if ( ! $user || is_wp_error( $user ) ) {
3724
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3725
		}
3726
3727
		wp_set_current_user( $user->ID );
3728
3729
		if ( ! current_user_can( 'upload_files' ) ) {
3730
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3731
		}
3732
3733
		if ( empty( $_FILES ) ) {
3734
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3735
		}
3736
3737
		foreach ( array_keys( $_FILES ) as $files_key ) {
3738
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3739
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3740
			}
3741
		}
3742
3743
		$media_keys = array_keys( $_FILES['media'] );
3744
3745
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3746
		if ( ! $token || is_wp_error( $token ) ) {
3747
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3748
		}
3749
3750
		$uploaded_files = array();
3751
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3752
		unset( $GLOBALS['post'] );
3753
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3754
			$file = array();
3755
			foreach ( $media_keys as $media_key ) {
3756
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3757
			}
3758
3759
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3760
3761
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3762
			if ( $hmac_provided !== $hmac_file ) {
3763
				$uploaded_files[ $index ] = (object) array(
3764
					'error'             => 'invalid_hmac',
3765
					'error_description' => 'The corresponding HMAC for this file does not match',
3766
				);
3767
				continue;
3768
			}
3769
3770
			$_FILES['.jetpack.upload.'] = $file;
3771
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3772
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3773
				$post_id = 0;
3774
			}
3775
3776
			if ( $update_media_item ) {
3777
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3778
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3779
				}
3780
3781
				$media_array = $_FILES['media'];
3782
3783
				$file_array['name']     = $media_array['name'][0];
3784
				$file_array['type']     = $media_array['type'][0];
3785
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3786
				$file_array['error']    = $media_array['error'][0];
3787
				$file_array['size']     = $media_array['size'][0];
3788
3789
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3790
3791
				if ( is_wp_error( $edited_media_item ) ) {
3792
					return $edited_media_item;
3793
				}
3794
3795
				$response = (object) array(
3796
					'id'   => (string) $post_id,
3797
					'file' => (string) $edited_media_item->post_title,
3798
					'url'  => (string) wp_get_attachment_url( $post_id ),
3799
					'type' => (string) $edited_media_item->post_mime_type,
3800
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3801
				);
3802
3803
				return (array) array( $response );
3804
			}
3805
3806
			$attachment_id = media_handle_upload(
3807
				'.jetpack.upload.',
3808
				$post_id,
3809
				array(),
3810
				array(
3811
					'action' => 'jetpack_upload_file',
3812
				)
3813
			);
3814
3815
			if ( ! $attachment_id ) {
3816
				$uploaded_files[ $index ] = (object) array(
3817
					'error'             => 'unknown',
3818
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3819
				);
3820
			} elseif ( is_wp_error( $attachment_id ) ) {
3821
				$uploaded_files[ $index ] = (object) array(
3822
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3823
					'error_description' => $attachment_id->get_error_message(),
3824
				);
3825
			} else {
3826
				$attachment               = get_post( $attachment_id );
3827
				$uploaded_files[ $index ] = (object) array(
3828
					'id'   => (string) $attachment_id,
3829
					'file' => $attachment->post_title,
3830
					'url'  => wp_get_attachment_url( $attachment_id ),
3831
					'type' => $attachment->post_mime_type,
3832
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3833
				);
3834
				// Zip files uploads are not supported unless they are done for installation purposed
3835
				// lets delete them in case something goes wrong in this whole process
3836
				if ( 'application/zip' === $attachment->post_mime_type ) {
3837
					// Schedule a cleanup for 2 hours from now in case of failed install.
3838
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3839
				}
3840
			}
3841
		}
3842
		if ( ! is_null( $global_post ) ) {
3843
			$GLOBALS['post'] = $global_post;
3844
		}
3845
3846
		return $uploaded_files;
3847
	}
3848
3849
	/**
3850
	 * Add help to the Jetpack page
3851
	 *
3852
	 * @since Jetpack (1.2.3)
3853
	 * @return false if not the Jetpack page
3854
	 */
3855
	function admin_help() {
3856
		$current_screen = get_current_screen();
3857
3858
		// Overview
3859
		$current_screen->add_help_tab(
3860
			array(
3861
				'id'      => 'home',
3862
				'title'   => __( 'Home', 'jetpack' ),
3863
				'content' =>
3864
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3865
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3866
					'<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>',
3867
			)
3868
		);
3869
3870
		// Screen Content
3871
		if ( current_user_can( 'manage_options' ) ) {
3872
			$current_screen->add_help_tab(
3873
				array(
3874
					'id'      => 'settings',
3875
					'title'   => __( 'Settings', 'jetpack' ),
3876
					'content' =>
3877
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3878
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3879
						'<ol>' .
3880
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3881
							'<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>' .
3882
						'</ol>' .
3883
						'<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>',
3884
				)
3885
			);
3886
		}
3887
3888
		// Help Sidebar
3889
		$current_screen->set_help_sidebar(
3890
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3891
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3892
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3893
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3894
		);
3895
	}
3896
3897
	function admin_menu_css() {
3898
		wp_enqueue_style( 'jetpack-icons' );
3899
	}
3900
3901
	function admin_menu_order() {
3902
		return true;
3903
	}
3904
3905 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3906
		$jp_menu_order = array();
3907
3908
		foreach ( $menu_order as $index => $item ) {
3909
			if ( $item != 'jetpack' ) {
3910
				$jp_menu_order[] = $item;
3911
			}
3912
3913
			if ( $index == 0 ) {
3914
				$jp_menu_order[] = 'jetpack';
3915
			}
3916
		}
3917
3918
		return $jp_menu_order;
3919
	}
3920
3921
	function admin_banner_styles() {
3922
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3923
3924 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3925
			wp_register_style(
3926
				'jetpack-dops-style',
3927
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3928
				array(),
3929
				JETPACK__VERSION
3930
			);
3931
		}
3932
3933
		wp_enqueue_style(
3934
			'jetpack',
3935
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3936
			array( 'jetpack-dops-style' ),
3937
			JETPACK__VERSION . '-20121016'
3938
		);
3939
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3940
		wp_style_add_data( 'jetpack', 'suffix', $min );
3941
	}
3942
3943
	function plugin_action_links( $actions ) {
3944
3945
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3946
3947
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3948
			return array_merge(
3949
				$jetpack_home,
3950
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3951
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3952
				$actions
3953
			);
3954
		}
3955
3956
		return array_merge( $jetpack_home, $actions );
3957
	}
3958
3959
	/*
3960
	 * Registration flow:
3961
	 * 1 - ::admin_page_load() action=register
3962
	 * 2 - ::try_registration()
3963
	 * 3 - ::register()
3964
	 *     - Creates jetpack_register option containing two secrets and a timestamp
3965
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
3966
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
3967
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
3968
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
3969
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
3970
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
3971
	 *       jetpack_id, jetpack_secret, jetpack_public
3972
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
3973
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
3974
	 * 5 - user logs in with WP.com account
3975
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
3976
	 *		- Manager::authorize()
3977
	 *		- Manager::get_token()
3978
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
3979
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
3980
	 *			- which responds with access_token, token_type, scope
3981
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
3982
	 *		- Jetpack::activate_default_modules()
3983
	 *     		- Deactivates deprecated plugins
3984
	 *     		- Activates all default modules
3985
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
3986
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
3987
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
3988
	 *     Done!
3989
	 */
3990
3991
	/**
3992
	 * Handles the page load events for the Jetpack admin page
3993
	 */
3994
	function admin_page_load() {
3995
		$error = false;
3996
3997
		// Make sure we have the right body class to hook stylings for subpages off of.
3998
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
3999
4000
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4001
			// Should only be used in intermediate redirects to preserve state across redirects
4002
			self::restate();
4003
		}
4004
4005
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4006
			// @todo: Add validation against a known whitelist
4007
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4008
			// User clicked in the iframe to link their accounts
4009
			if ( ! self::is_user_connected() ) {
4010
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4011
4012
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4013
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4014
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4015
4016
				if ( isset( $_GET['notes_iframe'] ) ) {
4017
					$connect_url .= '&notes_iframe';
4018
				}
4019
				wp_redirect( $connect_url );
4020
				exit;
4021
			} else {
4022
				if ( ! isset( $_GET['calypso_env'] ) ) {
4023
					self::state( 'message', 'already_authorized' );
4024
					wp_safe_redirect( self::admin_url() );
4025
					exit;
4026
				} else {
4027
					$connect_url  = $this->build_connect_url( true, false, $from );
4028
					$connect_url .= '&already_authorized=true';
4029
					wp_redirect( $connect_url );
4030
					exit;
4031
				}
4032
			}
4033
		}
4034
4035
		if ( isset( $_GET['action'] ) ) {
4036
			switch ( $_GET['action'] ) {
4037
				case 'authorize':
4038
					if ( self::is_active() && self::is_user_connected() ) {
4039
						self::state( 'message', 'already_authorized' );
4040
						wp_safe_redirect( self::admin_url() );
4041
						exit;
4042
					}
4043
					self::log( 'authorize' );
4044
					$client_server = new Jetpack_Client_Server();
4045
					$client_server->client_authorize();
4046
					exit;
4047
				case 'register':
4048
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4049
						$error = 'cheatin';
4050
						break;
4051
					}
4052
					check_admin_referer( 'jetpack-register' );
4053
					self::log( 'register' );
4054
					self::maybe_set_version_option();
4055
					$registered = self::try_registration();
4056 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4057
						$error = $registered->get_error_code();
0 ignored issues
show
The method get_error_code() does not seem to exist on object<WP_Error>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
4058
						self::state( 'error', $error );
4059
						self::state( 'error', $registered->get_error_message() );
4060
4061
						/**
4062
						 * Jetpack registration Error.
4063
						 *
4064
						 * @since 7.5.0
4065
						 *
4066
						 * @param string|int $error The error code.
4067
						 * @param \WP_Error $registered The error object.
4068
						 */
4069
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4070
						break;
4071
					}
4072
4073
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4074
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4075
4076
					/**
4077
					 * Jetpack registration Success.
4078
					 *
4079
					 * @since 7.5.0
4080
					 *
4081
					 * @param string $from 'from' GET parameter;
4082
					 */
4083
					do_action( 'jetpack_connection_register_success', $from );
4084
4085
					$url = $this->build_connect_url( true, $redirect, $from );
4086
4087
					if ( ! empty( $_GET['onboarding'] ) ) {
4088
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4089
					}
4090
4091
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4092
						$url = add_query_arg( 'auth_approved', 'true', $url );
4093
					}
4094
4095
					wp_redirect( $url );
4096
					exit;
4097
				case 'activate':
4098
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4099
						$error = 'cheatin';
4100
						break;
4101
					}
4102
4103
					$module = stripslashes( $_GET['module'] );
4104
					check_admin_referer( "jetpack_activate-$module" );
4105
					self::log( 'activate', $module );
4106
					if ( ! self::activate_module( $module ) ) {
4107
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4108
					}
4109
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4110
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4111
					exit;
4112
				case 'activate_default_modules':
4113
					check_admin_referer( 'activate_default_modules' );
4114
					self::log( 'activate_default_modules' );
4115
					self::restate();
4116
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4117
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4118
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4119
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4120
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4121
					exit;
4122
				case 'disconnect':
4123
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4124
						$error = 'cheatin';
4125
						break;
4126
					}
4127
4128
					check_admin_referer( 'jetpack-disconnect' );
4129
					self::log( 'disconnect' );
4130
					self::disconnect();
4131
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4132
					exit;
4133
				case 'reconnect':
4134
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4135
						$error = 'cheatin';
4136
						break;
4137
					}
4138
4139
					check_admin_referer( 'jetpack-reconnect' );
4140
					self::log( 'reconnect' );
4141
					$this->disconnect();
4142
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4143
					exit;
4144 View Code Duplication
				case 'deactivate':
4145
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4146
						$error = 'cheatin';
4147
						break;
4148
					}
4149
4150
					$modules = stripslashes( $_GET['module'] );
4151
					check_admin_referer( "jetpack_deactivate-$modules" );
4152
					foreach ( explode( ',', $modules ) as $module ) {
4153
						self::log( 'deactivate', $module );
4154
						self::deactivate_module( $module );
4155
						self::state( 'message', 'module_deactivated' );
4156
					}
4157
					self::state( 'module', $modules );
4158
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4159
					exit;
4160
				case 'unlink':
4161
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4162
					check_admin_referer( 'jetpack-unlink' );
4163
					self::log( 'unlink' );
4164
					Connection_Manager::disconnect_user();
4165
					self::state( 'message', 'unlinked' );
4166
					if ( 'sub-unlink' == $redirect ) {
4167
						wp_safe_redirect( admin_url() );
4168
					} else {
4169
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4170
					}
4171
					exit;
4172
				case 'onboard':
4173
					if ( ! current_user_can( 'manage_options' ) ) {
4174
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4175
					} else {
4176
						self::create_onboarding_token();
4177
						$url = $this->build_connect_url( true );
4178
4179
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4180
							$url = add_query_arg( 'onboarding', $token, $url );
4181
						}
4182
4183
						$calypso_env = $this->get_calypso_env();
4184
						if ( ! empty( $calypso_env ) ) {
4185
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4186
						}
4187
4188
						wp_redirect( $url );
4189
						exit;
4190
					}
4191
					exit;
4192
				default:
4193
					/**
4194
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4195
					 *
4196
					 * @since 2.6.0
4197
					 *
4198
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4199
					 */
4200
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4201
			}
4202
		}
4203
4204
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4205
			self::activate_new_modules( true );
4206
		}
4207
4208
		$message_code = self::state( 'message' );
4209
		if ( self::state( 'optin-manage' ) ) {
4210
			$activated_manage = $message_code;
4211
			$message_code     = 'jetpack-manage';
4212
		}
4213
4214
		switch ( $message_code ) {
4215
			case 'jetpack-manage':
4216
				$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>';
4217
				if ( $activated_manage ) {
4218
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4219
				}
4220
				break;
4221
4222
		}
4223
4224
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4225
4226
		if ( ! empty( $deactivated_plugins ) ) {
4227
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4228
			$deactivated_titles  = array();
4229
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4230
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4231
					continue;
4232
				}
4233
4234
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4235
			}
4236
4237
			if ( $deactivated_titles ) {
4238
				if ( $this->message ) {
4239
					$this->message .= "<br /><br />\n";
4240
				}
4241
4242
				$this->message .= wp_sprintf(
4243
					_n(
4244
						'Jetpack contains the most recent version of the old %l plugin.',
4245
						'Jetpack contains the most recent versions of the old %l plugins.',
4246
						count( $deactivated_titles ),
4247
						'jetpack'
4248
					),
4249
					$deactivated_titles
4250
				);
4251
4252
				$this->message .= "<br />\n";
4253
4254
				$this->message .= _n(
4255
					'The old version has been deactivated and can be removed from your site.',
4256
					'The old versions have been deactivated and can be removed from your site.',
4257
					count( $deactivated_titles ),
4258
					'jetpack'
4259
				);
4260
			}
4261
		}
4262
4263
		$this->privacy_checks = self::state( 'privacy_checks' );
4264
4265
		if ( $this->message || $this->error || $this->privacy_checks ) {
4266
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4267
		}
4268
4269
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4270
	}
4271
4272
	function admin_notices() {
4273
4274
		if ( $this->error ) {
4275
			?>
4276
<div id="message" class="jetpack-message jetpack-err">
4277
	<div class="squeezer">
4278
		<h2>
4279
			<?php
4280
			echo wp_kses(
4281
				$this->error,
4282
				array(
4283
					'a'      => array( 'href' => array() ),
4284
					'small'  => true,
4285
					'code'   => true,
4286
					'strong' => true,
4287
					'br'     => true,
4288
					'b'      => true,
4289
				)
4290
			);
4291
			?>
4292
			</h2>
4293
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4294
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4295
<?php	endif; ?>
4296
	</div>
4297
</div>
4298
			<?php
4299
		}
4300
4301
		if ( $this->message ) {
4302
			?>
4303
<div id="message" class="jetpack-message">
4304
	<div class="squeezer">
4305
		<h2>
4306
			<?php
4307
			echo wp_kses(
4308
				$this->message,
4309
				array(
4310
					'strong' => array(),
4311
					'a'      => array( 'href' => true ),
4312
					'br'     => true,
4313
				)
4314
			);
4315
			?>
4316
			</h2>
4317
	</div>
4318
</div>
4319
			<?php
4320
		}
4321
4322
		if ( $this->privacy_checks ) :
4323
			$module_names = $module_slugs = array();
4324
4325
			$privacy_checks = explode( ',', $this->privacy_checks );
4326
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4327
			foreach ( $privacy_checks as $module_slug ) {
4328
				$module = self::get_module( $module_slug );
4329
				if ( ! $module ) {
4330
					continue;
4331
				}
4332
4333
				$module_slugs[] = $module_slug;
4334
				$module_names[] = "<strong>{$module['name']}</strong>";
4335
			}
4336
4337
			$module_slugs = join( ',', $module_slugs );
4338
			?>
4339
<div id="message" class="jetpack-message jetpack-err">
4340
	<div class="squeezer">
4341
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4342
		<p>
4343
			<?php
4344
			echo wp_kses(
4345
				wptexturize(
4346
					wp_sprintf(
4347
						_nx(
4348
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4349
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4350
							count( $privacy_checks ),
4351
							'%l = list of Jetpack module/feature names',
4352
							'jetpack'
4353
						),
4354
						$module_names
4355
					)
4356
				),
4357
				array( 'strong' => true )
4358
			);
4359
4360
			echo "\n<br />\n";
4361
4362
			echo wp_kses(
4363
				sprintf(
4364
					_nx(
4365
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4366
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4367
						count( $privacy_checks ),
4368
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4369
						'jetpack'
4370
					),
4371
					wp_nonce_url(
4372
						self::admin_url(
4373
							array(
4374
								'page'   => 'jetpack',
4375
								'action' => 'deactivate',
4376
								'module' => urlencode( $module_slugs ),
4377
							)
4378
						),
4379
						"jetpack_deactivate-$module_slugs"
4380
					),
4381
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4382
				),
4383
				array(
4384
					'a' => array(
4385
						'href'  => true,
4386
						'title' => true,
4387
					),
4388
				)
4389
			);
4390
			?>
4391
		</p>
4392
	</div>
4393
</div>
4394
			<?php
4395
endif;
4396
	}
4397
4398
	/**
4399
	 * We can't always respond to a signed XML-RPC request with a
4400
	 * helpful error message. In some circumstances, doing so could
4401
	 * leak information.
4402
	 *
4403
	 * Instead, track that the error occurred via a Jetpack_Option,
4404
	 * and send that data back in the heartbeat.
4405
	 * All this does is increment a number, but it's enough to find
4406
	 * trends.
4407
	 *
4408
	 * @param WP_Error $xmlrpc_error The error produced during
4409
	 *                               signature validation.
4410
	 */
4411
	function track_xmlrpc_error( $xmlrpc_error ) {
4412
		$code = is_wp_error( $xmlrpc_error )
4413
			? $xmlrpc_error->get_error_code()
4414
			: 'should-not-happen';
4415
4416
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4417
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4418
			// No need to update the option if we already have
4419
			// this code stored.
4420
			return;
4421
		}
4422
		$xmlrpc_errors[ $code ] = true;
4423
4424
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
4425
	}
4426
4427
	/**
4428
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4429
	 */
4430
	function stat( $group, $detail ) {
4431
		if ( ! isset( $this->stats[ $group ] ) ) {
4432
			$this->stats[ $group ] = array();
4433
		}
4434
		$this->stats[ $group ][] = $detail;
4435
	}
4436
4437
	/**
4438
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4439
	 */
4440
	function do_stats( $method = '' ) {
4441
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4442
			foreach ( $this->stats as $group => $stats ) {
4443
				if ( is_array( $stats ) && count( $stats ) ) {
4444
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4445
					if ( 'server_side' === $method ) {
4446
						self::do_server_side_stat( $args );
4447
					} else {
4448
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4449
					}
4450
				}
4451
				unset( $this->stats[ $group ] );
4452
			}
4453
		}
4454
	}
4455
4456
	/**
4457
	 * Runs stats code for a one-off, server-side.
4458
	 *
4459
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4460
	 *
4461
	 * @return bool If it worked.
4462
	 */
4463
	static function do_server_side_stat( $args ) {
4464
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4465
		if ( is_wp_error( $response ) ) {
4466
			return false;
4467
		}
4468
4469
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4470
			return false;
4471
		}
4472
4473
		return true;
4474
	}
4475
4476
	/**
4477
	 * Builds the stats url.
4478
	 *
4479
	 * @param $args array|string The arguments to append to the URL.
4480
	 *
4481
	 * @return string The URL to be pinged.
4482
	 */
4483
	static function build_stats_url( $args ) {
4484
		$defaults = array(
4485
			'v'    => 'wpcom2',
4486
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4487
		);
4488
		$args     = wp_parse_args( $args, $defaults );
4489
		/**
4490
		 * Filter the URL used as the Stats tracking pixel.
4491
		 *
4492
		 * @since 2.3.2
4493
		 *
4494
		 * @param string $url Base URL used as the Stats tracking pixel.
4495
		 */
4496
		$base_url = apply_filters(
4497
			'jetpack_stats_base_url',
4498
			'https://pixel.wp.com/g.gif'
4499
		);
4500
		$url      = add_query_arg( $args, $base_url );
4501
		return $url;
4502
	}
4503
4504
	/**
4505
	 * Get the role of the current user.
4506
	 *
4507
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4508
	 *
4509
	 * @access public
4510
	 * @static
4511
	 *
4512
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4513
	 */
4514
	public static function translate_current_user_to_role() {
4515
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4516
4517
		$roles = new Roles();
4518
		return $roles->translate_current_user_to_role();
4519
	}
4520
4521
	/**
4522
	 * Get the role of a particular user.
4523
	 *
4524
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4525
	 *
4526
	 * @access public
4527
	 * @static
4528
	 *
4529
	 * @param \WP_User $user User object.
4530
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4531
	 */
4532
	public static function translate_user_to_role( $user ) {
4533
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4534
4535
		$roles = new Roles();
4536
		return $roles->translate_user_to_role( $user );
4537
	}
4538
4539
	/**
4540
	 * Get the minimum capability for a role.
4541
	 *
4542
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4543
	 *
4544
	 * @access public
4545
	 * @static
4546
	 *
4547
	 * @param string $role Role name.
4548
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4549
	 */
4550
	public static function translate_role_to_cap( $role ) {
4551
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4552
4553
		$roles = new Roles();
4554
		return $roles->translate_role_to_cap( $role );
4555
	}
4556
4557
	/**
4558
	 * Sign a user role with the master access token.
4559
	 * If not specified, will default to the current user.
4560
	 *
4561
	 * @deprecated since 7.7
4562
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4563
	 *
4564
	 * @access public
4565
	 * @static
4566
	 *
4567
	 * @param string $role    User role.
4568
	 * @param int    $user_id ID of the user.
4569
	 * @return string Signed user role.
4570
	 */
4571
	public static function sign_role( $role, $user_id = null ) {
4572
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4573
		return self::connection()->sign_role( $role, $user_id );
4574
	}
4575
4576
	/**
4577
	 * Builds a URL to the Jetpack connection auth page
4578
	 *
4579
	 * @since 3.9.5
4580
	 *
4581
	 * @param bool        $raw If true, URL will not be escaped.
4582
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4583
	 *                              If string, will be a custom redirect.
4584
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4585
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4586
	 *
4587
	 * @return string Connect URL
4588
	 */
4589
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4590
		$site_id    = Jetpack_Options::get_option( 'id' );
4591
		$blog_token = Jetpack_Data::get_access_token();
4592
4593
		if ( $register || ! $blog_token || ! $site_id ) {
4594
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4595
4596
			if ( ! empty( $redirect ) ) {
4597
				$url = add_query_arg(
4598
					'redirect',
4599
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4600
					$url
4601
				);
4602
			}
4603
4604
			if ( is_network_admin() ) {
4605
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4606
			}
4607
4608
			$calypso_env = self::get_calypso_env();
4609
4610
			if ( ! empty( $calypso_env ) ) {
4611
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4612
			}
4613
		} else {
4614
4615
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4616
			// because otherwise this logic can get us in to a loop.
4617
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4618
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4619
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4620
4621
				$response = Client::wpcom_json_api_request_as_blog(
4622
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4623
					'1.1'
4624
				);
4625
4626
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4627
4628
					// Generating a register URL instead to refresh the existing token
4629
					return $this->build_connect_url( $raw, $redirect, $from, true );
4630
				}
4631
			}
4632
4633
			$url = $this->build_authorize_url( $redirect );
4634
		}
4635
4636
		if ( $from ) {
4637
			$url = add_query_arg( 'from', $from, $url );
4638
		}
4639
4640
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4641
		/**
4642
		 * Filter the URL used when connecting a user to a WordPress.com account.
4643
		 *
4644
		 * @since 8.1.0
4645
		 *
4646
		 * @param string $url Connection URL.
4647
		 * @param bool   $raw If true, URL will not be escaped.
4648
		 */
4649
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4650
	}
4651
4652
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4653
4654
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4655
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4656
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4657
4658
		if ( $iframe ) {
4659
			add_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ), 10, 2 );
4660
		}
4661
4662
		$c8n = self::connection();
4663
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
4664
4665
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4666
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4667
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4668
4669
		if ( $iframe ) {
4670
			remove_filter( 'jetpack_api_url', array( __CLASS__, 'filter_connect_api_iframe_url' ) );
4671
		}
4672
4673
		return $url;
4674
	}
4675
4676
	/**
4677
	 * Filters the connection URL parameter array.
4678
	 *
4679
	 * @param Array $args default URL parameters used by the package.
4680
	 * @return Array the modified URL arguments array.
4681
	 */
4682
	public static function filter_connect_request_body( $args ) {
4683
		if (
4684
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4685
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4686
		) {
4687
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4688
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4689
				? $gp_locale->slug
4690
				: '';
4691
		}
4692
4693
		$tracking        = new Tracking();
4694
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4695
4696
		$args = array_merge(
4697
			$args,
4698
			array(
4699
				'_ui' => $tracks_identity['_ui'],
4700
				'_ut' => $tracks_identity['_ut'],
4701
			)
4702
		);
4703
4704
		$calypso_env = self::get_calypso_env();
4705
4706
		if ( ! empty( $calypso_env ) ) {
4707
			$args['calypso_env'] = $calypso_env;
4708
		}
4709
4710
		return $args;
4711
	}
4712
4713
	/**
4714
	 * Filters the URL that will process the connection data. It can be different from the URL
4715
	 * that we send the user to after everything is done.
4716
	 *
4717
	 * @param String $processing_url the default redirect URL used by the package.
4718
	 * @return String the modified URL.
4719
	 */
4720
	public static function filter_connect_processing_url( $processing_url ) {
4721
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4722
		return $processing_url;
4723
	}
4724
4725
	/**
4726
	 * Filters the redirection URL that is used for connect requests. The redirect
4727
	 * URL should return the user back to the Jetpack console.
4728
	 *
4729
	 * @param String $redirect the default redirect URL used by the package.
4730
	 * @return String the modified URL.
4731
	 */
4732
	public static function filter_connect_redirect_url( $redirect ) {
4733
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4734
		$redirect           = $redirect
4735
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4736
			: $jetpack_admin_page;
4737
4738
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4739
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4740
		}
4741
4742
		return $redirect;
4743
	}
4744
4745
	/**
4746
	 * Filters the API URL that is used for connect requests. The method
4747
	 * intercepts only the authorize URL and replaces it with another if needed.
4748
	 *
4749
	 * @param String $api_url the default redirect API URL used by the package.
4750
	 * @param String $relative_url the path of the URL that's being used.
4751
	 * @return String the modified URL.
4752
	 */
4753
	public static function filter_connect_api_iframe_url( $api_url, $relative_url ) {
4754
4755
		// Short-circuit on anything that is not related to connect requests.
4756
		if ( 'authorize' !== $relative_url ) {
4757
			return $api_url;
4758
		}
4759
4760
		$c8n = self::connection();
4761
4762
		return $c8n->api_url( 'authorize_iframe' );
4763
	}
4764
4765
	/**
4766
	 * This action fires at the beginning of the Manager::authorize method.
4767
	 */
4768
	public static function authorize_starting() {
4769
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4770
		// Checking if site has been active/connected previously before recording unique connection.
4771
		if ( ! $jetpack_unique_connection ) {
4772
			// jetpack_unique_connection option has never been set.
4773
			$jetpack_unique_connection = array(
4774
				'connected'    => 0,
4775
				'disconnected' => 0,
4776
				'version'      => '3.6.1',
4777
			);
4778
4779
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4780
4781
			// Track unique connection.
4782
			$jetpack = self::init();
4783
4784
			$jetpack->stat( 'connections', 'unique-connection' );
4785
			$jetpack->do_stats( 'server_side' );
4786
		}
4787
4788
		// Increment number of times connected.
4789
		$jetpack_unique_connection['connected'] += 1;
4790
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4791
	}
4792
4793
	/**
4794
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4795
	 * linked.
4796
	 */
4797
	public static function authorize_ending_linked() {
4798
		// Don't activate anything since we are just connecting a user.
4799
		self::state( 'message', 'linked' );
4800
	}
4801
4802
	/**
4803
	 * This action fires at the end of the Manager::authorize method when the master user is
4804
	 * authorized.
4805
	 *
4806
	 * @param array $data The request data.
4807
	 */
4808
	public static function authorize_ending_authorized( $data ) {
4809
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4810
		self::invalidate_onboarding_token();
4811
4812
		// If redirect_uri is SSO, ensure SSO module is enabled.
4813
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4814
4815
		/** This filter is documented in class.jetpack-cli.php */
4816
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4817
4818
		$activate_sso = (
4819
			isset( $redirect_options['action'] ) &&
4820
			'jetpack-sso' === $redirect_options['action'] &&
4821
			$jetpack_start_enable_sso
4822
		);
4823
4824
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4825
4826
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4827
	}
4828
4829
	/**
4830
	 * Get our assumed site creation date.
4831
	 * Calculated based on the earlier date of either:
4832
	 * - Earliest admin user registration date.
4833
	 * - Earliest date of post of any post type.
4834
	 *
4835
	 * @since 7.2.0
4836
	 * @deprecated since 7.8.0
4837
	 *
4838
	 * @return string Assumed site creation date and time.
4839
	 */
4840
	public static function get_assumed_site_creation_date() {
4841
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4842
		return self::connection()->get_assumed_site_creation_date();
4843
	}
4844
4845 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4846
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4847
4848
		if ( $activation_source_name ) {
4849
			$args['_as'] = urlencode( $activation_source_name );
4850
		}
4851
4852
		if ( $activation_source_keyword ) {
4853
			$args['_ak'] = urlencode( $activation_source_keyword );
4854
		}
4855
	}
4856
4857
	function build_reconnect_url( $raw = false ) {
4858
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4859
		return $raw ? $url : esc_url( $url );
4860
	}
4861
4862
	public static function admin_url( $args = null ) {
4863
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
4864
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4865
		return $url;
4866
	}
4867
4868
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4869
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4870
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4871
	}
4872
4873
	function dismiss_jetpack_notice() {
4874
4875
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
4876
			return;
4877
		}
4878
4879
		switch ( $_GET['jetpack-notice'] ) {
4880
			case 'dismiss':
4881
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
4882
4883
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
4884
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
4885
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
4886
				}
4887
				break;
4888
		}
4889
	}
4890
4891
	public static function sort_modules( $a, $b ) {
4892
		if ( $a['sort'] == $b['sort'] ) {
4893
			return 0;
4894
		}
4895
4896
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
4897
	}
4898
4899
	function ajax_recheck_ssl() {
4900
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
4901
		$result = self::permit_ssl( true );
4902
		wp_send_json(
4903
			array(
4904
				'enabled' => $result,
4905
				'message' => get_transient( 'jetpack_https_test_message' ),
4906
			)
4907
		);
4908
	}
4909
4910
	/* Client API */
4911
4912
	/**
4913
	 * Returns the requested Jetpack API URL
4914
	 *
4915
	 * @deprecated since 7.7
4916
	 * @return string
4917
	 */
4918
	public static function api_url( $relative_url ) {
4919
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
4920
		$connection = self::connection();
4921
		return $connection->api_url( $relative_url );
4922
	}
4923
4924
	/**
4925
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
4926
	 *
4927
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
4928
	 */
4929
	public static function fix_url_for_bad_hosts( $url ) {
4930
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
4931
		return Connection_Utils::fix_url_for_bad_hosts( $url );
4932
	}
4933
4934
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
4935
		// Default to a blog token.
4936
		$token_type = 'blog';
4937
4938
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
4939
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
4940
			if ( ! empty( $_GET['onboarding'] ) ) {
4941
				$jpo = $_GET;
4942
			} else {
4943
				$jpo = json_decode( $request_data, true );
4944
			}
4945
4946
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
4947
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
4948
4949
			if (
4950
				isset( $jpo_user )
4951
				&& isset( $jpo_token )
4952
				&& is_email( $jpo_user )
4953
				&& ctype_alnum( $jpo_token )
4954
				&& isset( $_GET['rest_route'] )
4955
				&& self::validate_onboarding_token_action(
4956
					$jpo_token,
4957
					$_GET['rest_route']
4958
				)
4959
			) {
4960
				$jp_user = get_user_by( 'email', $jpo_user );
4961
				if ( is_a( $jp_user, 'WP_User' ) ) {
4962
					wp_set_current_user( $jp_user->ID );
4963
					$user_can = is_multisite()
4964
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
4965
						: current_user_can( 'manage_options' );
4966
					if ( $user_can ) {
4967
						$token_type              = 'user';
4968
						$token->external_user_id = $jp_user->ID;
4969
					}
4970
				}
4971
			}
4972
4973
			$token_data['type']    = $token_type;
4974
			$token_data['user_id'] = $token->external_user_id;
4975
		}
4976
4977
		return $token_data;
4978
	}
4979
4980
	/**
4981
	 * Create a random secret for validating onboarding payload
4982
	 *
4983
	 * @return string Secret token
4984
	 */
4985
	public static function create_onboarding_token() {
4986
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4987
			$token = wp_generate_password( 32, false );
4988
			Jetpack_Options::update_option( 'onboarding', $token );
4989
		}
4990
4991
		return $token;
4992
	}
4993
4994
	/**
4995
	 * Remove the onboarding token
4996
	 *
4997
	 * @return bool True on success, false on failure
4998
	 */
4999
	public static function invalidate_onboarding_token() {
5000
		return Jetpack_Options::delete_option( 'onboarding' );
5001
	}
5002
5003
	/**
5004
	 * Validate an onboarding token for a specific action
5005
	 *
5006
	 * @return boolean True if token/action pair is accepted, false if not
5007
	 */
5008
	public static function validate_onboarding_token_action( $token, $action ) {
5009
		// Compare tokens, bail if tokens do not match
5010
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5011
			return false;
5012
		}
5013
5014
		// List of valid actions we can take
5015
		$valid_actions = array(
5016
			'/jetpack/v4/settings',
5017
		);
5018
5019
		// Whitelist the action
5020
		if ( ! in_array( $action, $valid_actions ) ) {
5021
			return false;
5022
		}
5023
5024
		return true;
5025
	}
5026
5027
	/**
5028
	 * Checks to see if the URL is using SSL to connect with Jetpack
5029
	 *
5030
	 * @since 2.3.3
5031
	 * @return boolean
5032
	 */
5033
	public static function permit_ssl( $force_recheck = false ) {
5034
		// Do some fancy tests to see if ssl is being supported
5035
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5036
			$message = '';
5037
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5038
				$ssl = 0;
5039
			} else {
5040
				switch ( JETPACK_CLIENT__HTTPS ) {
5041
					case 'NEVER':
5042
						$ssl     = 0;
5043
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5044
						break;
5045
					case 'ALWAYS':
5046
					case 'AUTO':
5047
					default:
5048
						$ssl = 1;
5049
						break;
5050
				}
5051
5052
				// If it's not 'NEVER', test to see
5053
				if ( $ssl ) {
5054
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5055
						$ssl     = 0;
5056
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5057
					} else {
5058
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5059
						if ( is_wp_error( $response ) ) {
5060
							$ssl     = 0;
5061
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5062
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5063
							$ssl     = 0;
5064
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5065
						}
5066
					}
5067
				}
5068
			}
5069
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5070
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5071
		}
5072
5073
		return (bool) $ssl;
5074
	}
5075
5076
	/*
5077
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5078
	 */
5079
	public function alert_auto_ssl_fail() {
5080
		if ( ! current_user_can( 'manage_options' ) ) {
5081
			return;
5082
		}
5083
5084
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5085
		?>
5086
5087
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5088
			<div class="jp-banner__content">
5089
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5090
				<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>
5091
				<p>
5092
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5093
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5094
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5095
				</p>
5096
				<p>
5097
					<?php
5098
					printf(
5099
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5100
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5101
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5102
					);
5103
					?>
5104
				</p>
5105
			</div>
5106
		</div>
5107
		<style>
5108
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5109
		</style>
5110
		<script type="text/javascript">
5111
			jQuery( document ).ready( function( $ ) {
5112
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5113
					var $this = $( this );
5114
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5115
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5116
					e.preventDefault();
5117
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5118
					$.post( ajaxurl, data )
5119
					  .done( function( response ) {
5120
						  if ( response.enabled ) {
5121
							  $( '#jetpack-ssl-warning' ).hide();
5122
						  } else {
5123
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5124
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5125
						  }
5126
					  }.bind( $this ) );
5127
				} );
5128
			} );
5129
		</script>
5130
5131
		<?php
5132
	}
5133
5134
	/**
5135
	 * Returns the Jetpack XML-RPC API
5136
	 *
5137
	 * @deprecated 8.0 Use Connection_Manager instead.
5138
	 * @return string
5139
	 */
5140
	public static function xmlrpc_api_url() {
5141
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5142
		return self::connection()->xmlrpc_api_url();
5143
	}
5144
5145
	public static function connection() {
5146
		return self::init()->connection_manager;
5147
	}
5148
5149
	/**
5150
	 * Creates two secret tokens and the end of life timestamp for them.
5151
	 *
5152
	 * Note these tokens are unique per call, NOT static per site for connecting.
5153
	 *
5154
	 * @since 2.6
5155
	 * @param String  $action  The action name.
5156
	 * @param Integer $user_id The user identifier.
5157
	 * @param Integer $exp     Expiration time in seconds.
5158
	 * @return array
5159
	 */
5160
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5161
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5162
	}
5163
5164
	public static function get_secrets( $action, $user_id ) {
5165
		$secrets = self::connection()->get_secrets( $action, $user_id );
5166
5167
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5168
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5169
		}
5170
5171
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5172
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5173
		}
5174
5175
		return $secrets;
5176
	}
5177
5178
	/**
5179
	 * @deprecated 7.5 Use Connection_Manager instead.
5180
	 *
5181
	 * @param $action
5182
	 * @param $user_id
5183
	 */
5184
	public static function delete_secrets( $action, $user_id ) {
5185
		return self::connection()->delete_secrets( $action, $user_id );
5186
	}
5187
5188
	/**
5189
	 * Builds the timeout limit for queries talking with the wpcom servers.
5190
	 *
5191
	 * Based on local php max_execution_time in php.ini
5192
	 *
5193
	 * @since 2.6
5194
	 * @return int
5195
	 * @deprecated
5196
	 **/
5197
	public function get_remote_query_timeout_limit() {
5198
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5199
		return self::get_max_execution_time();
5200
	}
5201
5202
	/**
5203
	 * Builds the timeout limit for queries talking with the wpcom servers.
5204
	 *
5205
	 * Based on local php max_execution_time in php.ini
5206
	 *
5207
	 * @since 5.4
5208
	 * @return int
5209
	 **/
5210
	public static function get_max_execution_time() {
5211
		$timeout = (int) ini_get( 'max_execution_time' );
5212
5213
		// Ensure exec time set in php.ini
5214
		if ( ! $timeout ) {
5215
			$timeout = 30;
5216
		}
5217
		return $timeout;
5218
	}
5219
5220
	/**
5221
	 * Sets a minimum request timeout, and returns the current timeout
5222
	 *
5223
	 * @since 5.4
5224
	 **/
5225 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5226
		$timeout = self::get_max_execution_time();
5227
		if ( $timeout < $min_timeout ) {
5228
			$timeout = $min_timeout;
5229
			set_time_limit( $timeout );
5230
		}
5231
		return $timeout;
5232
	}
5233
5234
	/**
5235
	 * Takes the response from the Jetpack register new site endpoint and
5236
	 * verifies it worked properly.
5237
	 *
5238
	 * @since 2.6
5239
	 * @deprecated since 7.7.0
5240
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5241
	 **/
5242
	public function validate_remote_register_response() {
5243
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5244
	}
5245
5246
	/**
5247
	 * @return bool|WP_Error
5248
	 */
5249
	public static function register() {
5250
		$tracking = new Tracking();
5251
		$tracking->record_user_event( 'jpc_register_begin' );
5252
5253
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5254
5255
		$connection   = self::connection();
5256
		$registration = $connection->register();
5257
5258
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5259
5260
		if ( ! $registration || is_wp_error( $registration ) ) {
5261
			return $registration;
5262
		}
5263
5264
		return true;
5265
	}
5266
5267
	/**
5268
	 * Filters the registration request body to include tracking properties.
5269
	 *
5270
	 * @param Array $properties
5271
	 * @return Array amended properties.
5272
	 */
5273 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5274
		$tracking        = new Tracking();
5275
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5276
5277
		return array_merge(
5278
			$properties,
5279
			array(
5280
				'_ui' => $tracks_identity['_ui'],
5281
				'_ut' => $tracks_identity['_ut'],
5282
			)
5283
		);
5284
	}
5285
5286
	/**
5287
	 * Filters the token request body to include tracking properties.
5288
	 *
5289
	 * @param Array $properties
5290
	 * @return Array amended properties.
5291
	 */
5292 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5293
		$tracking        = new Tracking();
5294
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5295
5296
		return array_merge(
5297
			$properties,
5298
			array(
5299
				'_ui' => $tracks_identity['_ui'],
5300
				'_ut' => $tracks_identity['_ut'],
5301
			)
5302
		);
5303
	}
5304
5305
	/**
5306
	 * If the db version is showing something other that what we've got now, bump it to current.
5307
	 *
5308
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
5309
	 */
5310
	public static function maybe_set_version_option() {
5311
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5312
		if ( JETPACK__VERSION != $version ) {
5313
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5314
5315
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5316
				/** This action is documented in class.jetpack.php */
5317
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5318
			}
5319
5320
			return true;
5321
		}
5322
		return false;
5323
	}
5324
5325
	/* Client Server API */
5326
5327
	/**
5328
	 * Loads the Jetpack XML-RPC client.
5329
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5330
	 *
5331
	 * @deprecated since 7.7.0
5332
	 */
5333
	public static function load_xml_rpc_client() {
5334
		// Removed the php notice that shows up in order to give time to Akismet and VaultPress time to update.
5335
		// _deprecated_function( __METHOD__, 'jetpack-7.7' );
5336
	}
5337
5338
	/**
5339
	 * Resets the saved authentication state in between testing requests.
5340
	 */
5341
	public function reset_saved_auth_state() {
5342
		$this->rest_authentication_status = null;
5343
		$this->connection_manager->reset_saved_auth_state();
5344
	}
5345
5346
	/**
5347
	 * Verifies the signature of the current request.
5348
	 *
5349
	 * @deprecated since 7.7.0
5350
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5351
	 *
5352
	 * @return false|array
5353
	 */
5354
	public function verify_xml_rpc_signature() {
5355
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5356
		return self::connection()->verify_xml_rpc_signature();
5357
	}
5358
5359
	/**
5360
	 * Verifies the signature of the current request.
5361
	 *
5362
	 * This function has side effects and should not be used. Instead,
5363
	 * use the memoized version `->verify_xml_rpc_signature()`.
5364
	 *
5365
	 * @deprecated since 7.7.0
5366
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5367
	 * @internal
5368
	 */
5369
	private function internal_verify_xml_rpc_signature() {
5370
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5371
	}
5372
5373
	/**
5374
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5375
	 *
5376
	 * @deprecated since 7.7.0
5377
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5378
	 *
5379
	 * @param \WP_User|mixed $user     User object if authenticated.
5380
	 * @param string         $username Username.
5381
	 * @param string         $password Password string.
5382
	 * @return \WP_User|mixed Authenticated user or error.
5383
	 */
5384
	public function authenticate_jetpack( $user, $username, $password ) {
5385
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5386
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5387
	}
5388
5389
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5390
	// Uses the existing XMLRPC request signing implementation.
5391
	function wp_rest_authenticate( $user ) {
5392
		if ( ! empty( $user ) ) {
5393
			// Another authentication method is in effect.
5394
			return $user;
5395
		}
5396
5397
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5398
			// Nothing to do for this authentication method.
5399
			return null;
5400
		}
5401
5402
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5403
			// Nothing to do for this authentication method.
5404
			return null;
5405
		}
5406
5407
		// Ensure that we always have the request body available.  At this
5408
		// point, the WP REST API code to determine the request body has not
5409
		// run yet.  That code may try to read from 'php://input' later, but
5410
		// this can only be done once per request in PHP versions prior to 5.6.
5411
		// So we will go ahead and perform this read now if needed, and save
5412
		// the request body where both the Jetpack signature verification code
5413
		// and the WP REST API code can see it.
5414
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5415
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5416
		}
5417
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5418
5419
		// Only support specific request parameters that have been tested and
5420
		// are known to work with signature verification.  A different method
5421
		// can be passed to the WP REST API via the '?_method=' parameter if
5422
		// needed.
5423
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5424
			$this->rest_authentication_status = new WP_Error(
5425
				'rest_invalid_request',
5426
				__( 'This request method is not supported.', 'jetpack' ),
5427
				array( 'status' => 400 )
5428
			);
5429
			return null;
5430
		}
5431
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5432
			$this->rest_authentication_status = new WP_Error(
5433
				'rest_invalid_request',
5434
				__( 'This request method does not support body parameters.', 'jetpack' ),
5435
				array( 'status' => 400 )
5436
			);
5437
			return null;
5438
		}
5439
5440
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5441
5442
		if (
5443
			$verified &&
5444
			isset( $verified['type'] ) &&
5445
			'user' === $verified['type'] &&
5446
			! empty( $verified['user_id'] )
5447
		) {
5448
			// Authentication successful.
5449
			$this->rest_authentication_status = true;
5450
			return $verified['user_id'];
5451
		}
5452
5453
		// Something else went wrong.  Probably a signature error.
5454
		$this->rest_authentication_status = new WP_Error(
5455
			'rest_invalid_signature',
5456
			__( 'The request is not signed correctly.', 'jetpack' ),
5457
			array( 'status' => 400 )
5458
		);
5459
		return null;
5460
	}
5461
5462
	/**
5463
	 * Report authentication status to the WP REST API.
5464
	 *
5465
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5466
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5467
	 */
5468
	public function wp_rest_authentication_errors( $value ) {
5469
		if ( $value !== null ) {
5470
			return $value;
5471
		}
5472
		return $this->rest_authentication_status;
5473
	}
5474
5475
	/**
5476
	 * Add our nonce to this request.
5477
	 *
5478
	 * @deprecated since 7.7.0
5479
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5480
	 *
5481
	 * @param int    $timestamp Timestamp of the request.
5482
	 * @param string $nonce     Nonce string.
5483
	 */
5484
	public function add_nonce( $timestamp, $nonce ) {
5485
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5486
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5487
	}
5488
5489
	/**
5490
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5491
	 * Capture it here so we can verify the signature later.
5492
	 *
5493
	 * @deprecated since 7.7.0
5494
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5495
	 *
5496
	 * @param array $methods XMLRPC methods.
5497
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5498
	 */
5499
	public function xmlrpc_methods( $methods ) {
5500
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5501
		return $this->connection_manager->xmlrpc_methods( $methods );
5502
	}
5503
5504
	/**
5505
	 * Register additional public XMLRPC methods.
5506
	 *
5507
	 * @deprecated since 7.7.0
5508
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5509
	 *
5510
	 * @param array $methods Public XMLRPC methods.
5511
	 * @return array Public XMLRPC methods, with the getOptions one.
5512
	 */
5513
	public function public_xmlrpc_methods( $methods ) {
5514
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5515
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5516
	}
5517
5518
	/**
5519
	 * Handles a getOptions XMLRPC method call.
5520
	 *
5521
	 * @deprecated since 7.7.0
5522
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5523
	 *
5524
	 * @param array $args method call arguments.
5525
	 * @return array an amended XMLRPC server options array.
5526
	 */
5527
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5528
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5529
		return $this->connection_manager->jetpack_getOptions( $args );
5530
	}
5531
5532
	/**
5533
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5534
	 *
5535
	 * @deprecated since 7.7.0
5536
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5537
	 *
5538
	 * @param array $options Standard Core options.
5539
	 * @return array Amended options.
5540
	 */
5541
	public function xmlrpc_options( $options ) {
5542
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5543
		return $this->connection_manager->xmlrpc_options( $options );
5544
	}
5545
5546
	/**
5547
	 * Cleans nonces that were saved when calling ::add_nonce.
5548
	 *
5549
	 * @deprecated since 7.7.0
5550
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5551
	 *
5552
	 * @param bool $all whether to clean even non-expired nonces.
5553
	 */
5554
	public static function clean_nonces( $all = false ) {
5555
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5556
		return self::connection()->clean_nonces( $all );
5557
	}
5558
5559
	/**
5560
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5561
	 * SET: state( $key, $value );
5562
	 * GET: $value = state( $key );
5563
	 *
5564
	 * @param string $key
5565
	 * @param string $value
5566
	 * @param bool   $restate private
5567
	 */
5568
	public static function state( $key = null, $value = null, $restate = false ) {
5569
		static $state = array();
5570
		static $path, $domain;
5571
		if ( ! isset( $path ) ) {
5572
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5573
			$admin_url = self::admin_url();
5574
			$bits      = wp_parse_url( $admin_url );
5575
5576
			if ( is_array( $bits ) ) {
5577
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5578
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5579
			} else {
5580
				$path = $domain = null;
5581
			}
5582
		}
5583
5584
		// Extract state from cookies and delete cookies
5585
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5586
			$yum = $_COOKIE['jetpackState'];
5587
			unset( $_COOKIE['jetpackState'] );
5588
			foreach ( $yum as $k => $v ) {
5589
				if ( strlen( $v ) ) {
5590
					$state[ $k ] = $v;
5591
				}
5592
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5593
			}
5594
		}
5595
5596
		if ( $restate ) {
5597
			foreach ( $state as $k => $v ) {
5598
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5599
			}
5600
			return;
5601
		}
5602
5603
		// Get a state variable
5604
		if ( isset( $key ) && ! isset( $value ) ) {
5605
			if ( array_key_exists( $key, $state ) ) {
5606
				return $state[ $key ];
5607
			}
5608
			return null;
5609
		}
5610
5611
		// Set a state variable
5612
		if ( isset( $key ) && isset( $value ) ) {
5613
			if ( is_array( $value ) && isset( $value[0] ) ) {
5614
				$value = $value[0];
5615
			}
5616
			$state[ $key ] = $value;
5617
			setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5618
		}
5619
	}
5620
5621
	public static function restate() {
5622
		self::state( null, null, true );
5623
	}
5624
5625
	public static function check_privacy( $file ) {
5626
		static $is_site_publicly_accessible = null;
5627
5628
		if ( is_null( $is_site_publicly_accessible ) ) {
5629
			$is_site_publicly_accessible = false;
5630
5631
			$rpc = new Jetpack_IXR_Client();
5632
5633
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5634
			if ( $success ) {
5635
				$response = $rpc->getResponse();
5636
				if ( $response ) {
5637
					$is_site_publicly_accessible = true;
5638
				}
5639
			}
5640
5641
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5642
		}
5643
5644
		if ( $is_site_publicly_accessible ) {
5645
			return;
5646
		}
5647
5648
		$module_slug = self::get_module_slug( $file );
5649
5650
		$privacy_checks = self::state( 'privacy_checks' );
5651
		if ( ! $privacy_checks ) {
5652
			$privacy_checks = $module_slug;
5653
		} else {
5654
			$privacy_checks .= ",$module_slug";
5655
		}
5656
5657
		self::state( 'privacy_checks', $privacy_checks );
5658
	}
5659
5660
	/**
5661
	 * Helper method for multicall XMLRPC.
5662
	 *
5663
	 * @param ...$args Args for the async_call.
5664
	 */
5665
	public static function xmlrpc_async_call( ...$args ) {
5666
		global $blog_id;
5667
		static $clients = array();
5668
5669
		$client_blog_id = is_multisite() ? $blog_id : 0;
5670
5671
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5672
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5673
			if ( function_exists( 'ignore_user_abort' ) ) {
5674
				ignore_user_abort( true );
5675
			}
5676
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5677
		}
5678
5679
		if ( ! empty( $args[0] ) ) {
5680
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5681
		} elseif ( is_multisite() ) {
5682
			foreach ( $clients as $client_blog_id => $client ) {
5683
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5684
					continue;
5685
				}
5686
5687
				$switch_success = switch_to_blog( $client_blog_id, true );
5688
				if ( ! $switch_success ) {
5689
					continue;
5690
				}
5691
5692
				flush();
5693
				$client->query();
5694
5695
				restore_current_blog();
5696
			}
5697
		} else {
5698
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5699
				flush();
5700
				$clients[0]->query();
5701
			}
5702
		}
5703
	}
5704
5705
	public static function staticize_subdomain( $url ) {
5706
5707
		// Extract hostname from URL
5708
		$host = wp_parse_url( $url, PHP_URL_HOST );
5709
5710
		// Explode hostname on '.'
5711
		$exploded_host = explode( '.', $host );
5712
5713
		// Retrieve the name and TLD
5714
		if ( count( $exploded_host ) > 1 ) {
5715
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5716
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5717
			// Rebuild domain excluding subdomains
5718
			$domain = $name . '.' . $tld;
5719
		} else {
5720
			$domain = $host;
5721
		}
5722
		// Array of Automattic domains
5723
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5724
5725
		// Return $url if not an Automattic domain
5726
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5727
			return $url;
5728
		}
5729
5730
		if ( is_ssl() ) {
5731
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5732
		}
5733
5734
		srand( crc32( basename( $url ) ) );
5735
		$static_counter = rand( 0, 2 );
5736
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5737
5738
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5739
	}
5740
5741
	/* JSON API Authorization */
5742
5743
	/**
5744
	 * Handles the login action for Authorizing the JSON API
5745
	 */
5746
	function login_form_json_api_authorization() {
5747
		$this->verify_json_api_authorization_request();
5748
5749
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5750
5751
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5752
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5753
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5754
	}
5755
5756
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5757
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5758
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5759
			return $url;
5760
		}
5761
5762
		$parsed_url = wp_parse_url( $url );
5763
		$url        = strtok( $url, '?' );
5764
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5765
		if ( ! empty( $parsed_url['query'] ) ) {
5766
			$url .= "&{$parsed_url['query']}";
5767
		}
5768
5769
		return $url;
5770
	}
5771
5772
	// Make sure the POSTed request is handled by the same action
5773
	function preserve_action_in_login_form_for_json_api_authorization() {
5774
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5775
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5776
	}
5777
5778
	// If someone logs in to approve API access, store the Access Code in usermeta
5779
	function store_json_api_authorization_token( $user_login, $user ) {
5780
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5781
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5782
		$token = wp_generate_password( 32, false );
5783
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5784
	}
5785
5786
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
5787
	function allow_wpcom_public_api_domain( $domains ) {
5788
		$domains[] = 'public-api.wordpress.com';
5789
		return $domains;
5790
	}
5791
5792
	static function is_redirect_encoded( $redirect_url ) {
5793
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5794
	}
5795
5796
	// Add all wordpress.com environments to the safe redirect whitelist
5797
	function allow_wpcom_environments( $domains ) {
5798
		$domains[] = 'wordpress.com';
5799
		$domains[] = 'wpcalypso.wordpress.com';
5800
		$domains[] = 'horizon.wordpress.com';
5801
		$domains[] = 'calypso.localhost';
5802
		return $domains;
5803
	}
5804
5805
	// Add the Access Code details to the public-api.wordpress.com redirect
5806
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
5807
		return add_query_arg(
5808
			urlencode_deep(
5809
				array(
5810
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
5811
					'jetpack-user-id' => (int) $user->ID,
5812
					'jetpack-state'   => $this->json_api_authorization_request['state'],
5813
				)
5814
			),
5815
			$redirect_to
5816
		);
5817
	}
5818
5819
5820
	/**
5821
	 * Verifies the request by checking the signature
5822
	 *
5823
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
5824
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
5825
	 *
5826
	 * @param null|array $environment
5827
	 */
5828
	function verify_json_api_authorization_request( $environment = null ) {
5829
		$environment = is_null( $environment )
5830
			? $_REQUEST
5831
			: $environment;
5832
5833
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
5834
		$token                                     = Jetpack_Data::get_access_token( $envUserId, $envToken );
5835
		if ( ! $token || empty( $token->secret ) ) {
5836
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
5837
		}
5838
5839
		$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' );
5840
5841
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
5842
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
5843
			/**
5844
			 * Jetpack authorisation request Error.
5845
			 *
5846
			 * @since 7.5.0
5847
			 */
5848
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
5849
			$die_error = sprintf(
5850
				/* translators: %s is a URL */
5851
				__( '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' ),
5852
				'https://jetpack.com/support/double-encoding/'
5853
			);
5854
		}
5855
5856
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
5857
5858
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
5859
			$signature = $jetpack_signature->sign_request(
5860
				$environment['token'],
5861
				$environment['timestamp'],
5862
				$environment['nonce'],
5863
				'',
5864
				'GET',
5865
				$environment['jetpack_json_api_original_query'],
5866
				null,
5867
				true
5868
			);
5869
		} else {
5870
			$signature = $jetpack_signature->sign_current_request(
5871
				array(
5872
					'body'   => null,
5873
					'method' => 'GET',
5874
				)
5875
			);
5876
		}
5877
5878
		if ( ! $signature ) {
5879
			wp_die( $die_error );
5880
		} elseif ( is_wp_error( $signature ) ) {
5881
			wp_die( $die_error );
5882
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
5883
			if ( is_ssl() ) {
5884
				// 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
5885
				$signature = $jetpack_signature->sign_current_request(
5886
					array(
5887
						'scheme' => 'http',
5888
						'body'   => null,
5889
						'method' => 'GET',
5890
					)
5891
				);
5892
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
5893
					wp_die( $die_error );
5894
				}
5895
			} else {
5896
				wp_die( $die_error );
5897
			}
5898
		}
5899
5900
		$timestamp = (int) $environment['timestamp'];
5901
		$nonce     = stripslashes( (string) $environment['nonce'] );
5902
5903
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
5904
			// De-nonce the nonce, at least for 5 minutes.
5905
			// 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)
5906
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
5907
			if ( $old_nonce_time < time() - 300 ) {
5908
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
5909
			}
5910
		}
5911
5912
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
5913
		$data_filters = array(
5914
			'state'        => 'opaque',
5915
			'client_id'    => 'int',
5916
			'client_title' => 'string',
5917
			'client_image' => 'url',
5918
		);
5919
5920
		foreach ( $data_filters as $key => $sanitation ) {
5921
			if ( ! isset( $data->$key ) ) {
5922
				wp_die( $die_error );
5923
			}
5924
5925
			switch ( $sanitation ) {
5926
				case 'int':
5927
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
5928
					break;
5929
				case 'opaque':
5930
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
5931
					break;
5932
				case 'string':
5933
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
5934
					break;
5935
				case 'url':
5936
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
5937
					break;
5938
			}
5939
		}
5940
5941
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
5942
			wp_die( $die_error );
5943
		}
5944
	}
5945
5946
	function login_message_json_api_authorization( $message ) {
5947
		return '<p class="message">' . sprintf(
5948
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
5949
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
5950
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
5951
	}
5952
5953
	/**
5954
	 * Get $content_width, but with a <s>twist</s> filter.
5955
	 */
5956
	public static function get_content_width() {
5957
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
5958
			? $GLOBALS['content_width']
5959
			: false;
5960
		/**
5961
		 * Filter the Content Width value.
5962
		 *
5963
		 * @since 2.2.3
5964
		 *
5965
		 * @param string $content_width Content Width value.
5966
		 */
5967
		return apply_filters( 'jetpack_content_width', $content_width );
5968
	}
5969
5970
	/**
5971
	 * Pings the WordPress.com Mirror Site for the specified options.
5972
	 *
5973
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
5974
	 *
5975
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
5976
	 */
5977
	public function get_cloud_site_options( $option_names ) {
5978
		$option_names = array_filter( (array) $option_names, 'is_string' );
5979
5980
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
5981
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
5982
		if ( $xml->isError() ) {
5983
			return array(
5984
				'error_code' => $xml->getErrorCode(),
5985
				'error_msg'  => $xml->getErrorMessage(),
5986
			);
5987
		}
5988
		$cloud_site_options = $xml->getResponse();
5989
5990
		return $cloud_site_options;
5991
	}
5992
5993
	/**
5994
	 * Checks if the site is currently in an identity crisis.
5995
	 *
5996
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
5997
	 */
5998
	public static function check_identity_crisis() {
5999
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6000
			return false;
6001
		}
6002
6003
		return Jetpack_Options::get_option( 'sync_error_idc' );
6004
	}
6005
6006
	/**
6007
	 * Checks whether the home and siteurl specifically are whitelisted
6008
	 * Written so that we don't have re-check $key and $value params every time
6009
	 * we want to check if this site is whitelisted, for example in footer.php
6010
	 *
6011
	 * @since  3.8.0
6012
	 * @return bool True = already whitelisted False = not whitelisted
6013
	 */
6014
	public static function is_staging_site() {
6015
		$is_staging = false;
6016
6017
		$known_staging = array(
6018
			'urls'      => array(
6019
				'#\.staging\.wpengine\.com$#i', // WP Engine
6020
				'#\.staging\.kinsta\.com$#i',   // Kinsta.com
6021
				'#\.stage\.site$#i',            // DreamPress
6022
			),
6023
			'constants' => array(
6024
				'IS_WPE_SNAPSHOT',      // WP Engine
6025
				'KINSTA_DEV_ENV',       // Kinsta.com
6026
				'WPSTAGECOACH_STAGING', // WP Stagecoach
6027
				'JETPACK_STAGING_MODE', // Generic
6028
			),
6029
		);
6030
		/**
6031
		 * Filters the flags of known staging sites.
6032
		 *
6033
		 * @since 3.9.0
6034
		 *
6035
		 * @param array $known_staging {
6036
		 *     An array of arrays that each are used to check if the current site is staging.
6037
		 *     @type array $urls      URLs of staging sites in regex to check against site_url.
6038
		 *     @type array $constants PHP constants of known staging/developement environments.
6039
		 *  }
6040
		 */
6041
		$known_staging = apply_filters( 'jetpack_known_staging', $known_staging );
6042
6043
		if ( isset( $known_staging['urls'] ) ) {
6044
			foreach ( $known_staging['urls'] as $url ) {
6045
				if ( preg_match( $url, site_url() ) ) {
6046
					$is_staging = true;
6047
					break;
6048
				}
6049
			}
6050
		}
6051
6052
		if ( isset( $known_staging['constants'] ) ) {
6053
			foreach ( $known_staging['constants'] as $constant ) {
6054
				if ( defined( $constant ) && constant( $constant ) ) {
6055
					$is_staging = true;
6056
				}
6057
			}
6058
		}
6059
6060
		// Last, let's check if sync is erroring due to an IDC. If so, set the site to staging mode.
6061
		if ( ! $is_staging && self::validate_sync_error_idc_option() ) {
6062
			$is_staging = true;
6063
		}
6064
6065
		/**
6066
		 * Filters is_staging_site check.
6067
		 *
6068
		 * @since 3.9.0
6069
		 *
6070
		 * @param bool $is_staging If the current site is a staging site.
6071
		 */
6072
		return apply_filters( 'jetpack_is_staging_site', $is_staging );
6073
	}
6074
6075
	/**
6076
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6077
	 *
6078
	 * @since 4.4.0
6079
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6080
	 *
6081
	 * @return bool
6082
	 */
6083
	public static function validate_sync_error_idc_option() {
6084
		$is_valid = false;
6085
6086
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6087
		if ( false === $idc_allowed ) {
6088
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6089
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6090
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6091
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6092
				$transient_duration = HOUR_IN_SECONDS;
6093
			} else {
6094
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6095
				$idc_allowed        = '1';
6096
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6097
			}
6098
6099
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6100
		}
6101
6102
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6103
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6104
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6105
			$local_options = self::get_sync_error_idc_option();
6106
			// Ensure all values are set.
6107
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6108
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6109
					$is_valid = true;
6110
				}
6111
			}
6112
6113
		}
6114
6115
		/**
6116
		 * Filters whether the sync_error_idc option is valid.
6117
		 *
6118
		 * @since 4.4.0
6119
		 *
6120
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6121
		 */
6122
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6123
6124
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6125
			// Since the option exists, and did not validate, delete it
6126
			Jetpack_Options::delete_option( 'sync_error_idc' );
6127
		}
6128
6129
		return $is_valid;
6130
	}
6131
6132
	/**
6133
	 * Normalizes a url by doing three things:
6134
	 *  - Strips protocol
6135
	 *  - Strips www
6136
	 *  - Adds a trailing slash
6137
	 *
6138
	 * @since 4.4.0
6139
	 * @param string $url
6140
	 * @return WP_Error|string
6141
	 */
6142
	public static function normalize_url_protocol_agnostic( $url ) {
6143
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6144
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6145
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6146
		}
6147
6148
		// Strip www and protocols
6149
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6150
		return $url;
6151
	}
6152
6153
	/**
6154
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6155
	 *
6156
	 * @since 4.4.0
6157
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6158
	 *
6159
	 * @param array $response
6160
	 * @return array Array of the local urls, wpcom urls, and error code
6161
	 */
6162
	public static function get_sync_error_idc_option( $response = array() ) {
6163
		// Since the local options will hit the database directly, store the values
6164
		// in a transient to allow for autoloading and caching on subsequent views.
6165
		$local_options = get_transient( 'jetpack_idc_local' );
6166
		if ( false === $local_options ) {
6167
			$local_options = array(
6168
				'home'    => Functions::home_url(),
6169
				'siteurl' => Functions::site_url(),
6170
			);
6171
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6172
		}
6173
6174
		$options = array_merge( $local_options, $response );
6175
6176
		$returned_values = array();
6177
		foreach ( $options as $key => $option ) {
6178
			if ( 'error_code' === $key ) {
6179
				$returned_values[ $key ] = $option;
6180
				continue;
6181
			}
6182
6183
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6184
				continue;
6185
			}
6186
6187
			$returned_values[ $key ] = $normalized_url;
6188
		}
6189
6190
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6191
6192
		return $returned_values;
6193
	}
6194
6195
	/**
6196
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6197
	 * If set to true, the site will be put into staging mode.
6198
	 *
6199
	 * @since 4.3.2
6200
	 * @return bool
6201
	 */
6202
	public static function sync_idc_optin() {
6203
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6204
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6205
		} else {
6206
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6207
		}
6208
6209
		/**
6210
		 * Allows sites to optin to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6211
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6212
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6213
		 *
6214
		 * @since 4.3.2
6215
		 *
6216
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6217
		 */
6218
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6219
	}
6220
6221
	/**
6222
	 * Maybe Use a .min.css stylesheet, maybe not.
6223
	 *
6224
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6225
	 */
6226
	public static function maybe_min_asset( $url, $path, $plugin ) {
6227
		// Short out on things trying to find actual paths.
6228
		if ( ! $path || empty( $plugin ) ) {
6229
			return $url;
6230
		}
6231
6232
		$path = ltrim( $path, '/' );
6233
6234
		// Strip out the abspath.
6235
		$base = dirname( plugin_basename( $plugin ) );
6236
6237
		// Short out on non-Jetpack assets.
6238
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6239
			return $url;
6240
		}
6241
6242
		// File name parsing.
6243
		$file              = "{$base}/{$path}";
6244
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6245
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6246
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6247
		$extension         = array_shift( $file_name_parts_r );
6248
6249
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6250
			// Already pointing at the minified version.
6251
			if ( 'min' === $file_name_parts_r[0] ) {
6252
				return $url;
6253
			}
6254
6255
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6256
			if ( file_exists( $min_full_path ) ) {
6257
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6258
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6259
				if ( 'css' === $extension ) {
6260
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6261
					self::$min_assets[ $key ] = $path;
6262
				}
6263
			}
6264
		}
6265
6266
		return $url;
6267
	}
6268
6269
	/**
6270
	 * If the asset is minified, let's flag .min as the suffix.
6271
	 *
6272
	 * Attached to `style_loader_src` filter.
6273
	 *
6274
	 * @param string $tag The tag that would link to the external asset.
6275
	 * @param string $handle The registered handle of the script in question.
6276
	 * @param string $href The url of the asset in question.
6277
	 */
6278
	public static function set_suffix_on_min( $src, $handle ) {
6279
		if ( false === strpos( $src, '.min.css' ) ) {
6280
			return $src;
6281
		}
6282
6283
		if ( ! empty( self::$min_assets ) ) {
6284
			foreach ( self::$min_assets as $file => $path ) {
6285
				if ( false !== strpos( $src, $file ) ) {
6286
					wp_style_add_data( $handle, 'suffix', '.min' );
6287
					return $src;
6288
				}
6289
			}
6290
		}
6291
6292
		return $src;
6293
	}
6294
6295
	/**
6296
	 * Maybe inlines a stylesheet.
6297
	 *
6298
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6299
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6300
	 *
6301
	 * Attached to `style_loader_tag` filter.
6302
	 *
6303
	 * @param string $tag The tag that would link to the external asset.
6304
	 * @param string $handle The registered handle of the script in question.
6305
	 *
6306
	 * @return string
6307
	 */
6308
	public static function maybe_inline_style( $tag, $handle ) {
6309
		global $wp_styles;
6310
		$item = $wp_styles->registered[ $handle ];
6311
6312
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6313
			return $tag;
6314
		}
6315
6316
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6317
			$href = $matches[1];
6318
			// Strip off query string
6319
			if ( $pos = strpos( $href, '?' ) ) {
6320
				$href = substr( $href, 0, $pos );
6321
			}
6322
			// Strip off fragment
6323
			if ( $pos = strpos( $href, '#' ) ) {
6324
				$href = substr( $href, 0, $pos );
6325
			}
6326
		} else {
6327
			return $tag;
6328
		}
6329
6330
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6331
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6332
			return $tag;
6333
		}
6334
6335
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6336
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6337
			// And this isn't the pass that actually deals with the RTL version...
6338
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6339
				// Short out, as the RTL version will deal with it in a moment.
6340
				return $tag;
6341
			}
6342
		}
6343
6344
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6345
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6346
		if ( $css ) {
6347
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6348
			if ( empty( $item->extra['after'] ) ) {
6349
				wp_add_inline_style( $handle, $css );
6350
			} else {
6351
				array_unshift( $item->extra['after'], $css );
6352
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6353
			}
6354
		}
6355
6356
		return $tag;
6357
	}
6358
6359
	/**
6360
	 * Loads a view file from the views
6361
	 *
6362
	 * Data passed in with the $data parameter will be available in the
6363
	 * template file as $data['value']
6364
	 *
6365
	 * @param string $template - Template file to load
6366
	 * @param array  $data - Any data to pass along to the template
6367
	 * @return boolean - If template file was found
6368
	 **/
6369
	public function load_view( $template, $data = array() ) {
6370
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6371
6372
		if ( file_exists( $views_dir . $template ) ) {
6373
			require_once $views_dir . $template;
6374
			return true;
6375
		}
6376
6377
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6378
		return false;
6379
	}
6380
6381
	/**
6382
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6383
	 */
6384
	public function deprecated_hooks() {
6385
		global $wp_filter;
6386
6387
		/*
6388
		 * Format:
6389
		 * deprecated_filter_name => replacement_name
6390
		 *
6391
		 * If there is no replacement, use null for replacement_name
6392
		 */
6393
		$deprecated_list = array(
6394
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6395
			'wpl_sharing_2014_1'                           => null,
6396
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6397
			'jetpack_identity_crisis_options_to_check'     => null,
6398
			'update_option_jetpack_single_user_site'       => null,
6399
			'audio_player_default_colors'                  => null,
6400
			'add_option_jetpack_featured_images_enabled'   => null,
6401
			'add_option_jetpack_update_details'            => null,
6402
			'add_option_jetpack_updates'                   => null,
6403
			'add_option_jetpack_network_name'              => null,
6404
			'add_option_jetpack_network_allow_new_registrations' => null,
6405
			'add_option_jetpack_network_add_new_users'     => null,
6406
			'add_option_jetpack_network_site_upload_space' => null,
6407
			'add_option_jetpack_network_upload_file_types' => null,
6408
			'add_option_jetpack_network_enable_administration_menus' => null,
6409
			'add_option_jetpack_is_multi_site'             => null,
6410
			'add_option_jetpack_is_main_network'           => null,
6411
			'add_option_jetpack_main_network_site'         => null,
6412
			'jetpack_sync_all_registered_options'          => null,
6413
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6414
			'jetpack_is_post_mailable'                     => null,
6415
			'jetpack_seo_site_host'                        => null,
6416
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6417
			'jetpack_holiday_snow_option_name'             => null,
6418
			'jetpack_holiday_chance_of_snow'               => null,
6419
			'jetpack_holiday_snow_js_url'                  => null,
6420
			'jetpack_is_holiday_snow_season'               => null,
6421
			'jetpack_holiday_snow_option_updated'          => null,
6422
			'jetpack_holiday_snowing'                      => null,
6423
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6424
			'jetpack_cache_plans'                          => null,
6425
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6426
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6427
			'jetpack_enable_site_verification'             => null,
6428
			'can_display_jetpack_manage_notice'            => null,
6429
			// Removed in Jetpack 7.3.0
6430
			'atd_load_scripts'                             => null,
6431
			'atd_http_post_timeout'                        => null,
6432
			'atd_http_post_error'                          => null,
6433
			'atd_service_domain'                           => null,
6434
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6435
			// Removed in Jetpack 7.9.0
6436
			'jetpack_pwa_manifest'                         => null,
6437
			'jetpack_pwa_background_color'                 => null,
6438
		);
6439
6440
		// This is a silly loop depth. Better way?
6441
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6442
			if ( has_action( $hook ) ) {
6443
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6444
					foreach ( $values as $hooked ) {
6445
						if ( is_callable( $hooked['function'] ) ) {
6446
							$function_name = 'an anonymous function';
6447
						} else {
6448
							$function_name = $hooked['function'];
6449
						}
6450
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6451
					}
6452
				}
6453
			}
6454
		}
6455
	}
6456
6457
	/**
6458
	 * Converts any url in a stylesheet, to the correct absolute url.
6459
	 *
6460
	 * Considerations:
6461
	 *  - Normal, relative URLs     `feh.png`
6462
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6463
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6464
	 *  - Absolute URLs             `http://domain.com/feh.png`
6465
	 *  - Domain root relative URLs `/feh.png`
6466
	 *
6467
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6468
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6469
	 *
6470
	 * @return mixed|string
6471
	 */
6472
	public static function absolutize_css_urls( $css, $css_file_url ) {
6473
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6474
		$css_dir = dirname( $css_file_url );
6475
		$p       = wp_parse_url( $css_dir );
6476
		$domain  = sprintf(
6477
			'%1$s//%2$s%3$s%4$s',
6478
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6479
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6480
			$p['host'],
6481
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6482
		);
6483
6484
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6485
			$find = $replace = array();
6486
			foreach ( $matches as $match ) {
6487
				$url = trim( $match['path'], "'\" \t" );
6488
6489
				// If this is a data url, we don't want to mess with it.
6490
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6491
					continue;
6492
				}
6493
6494
				// If this is an absolute or protocol-agnostic url,
6495
				// we don't want to mess with it.
6496
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6497
					continue;
6498
				}
6499
6500
				switch ( substr( $url, 0, 1 ) ) {
6501
					case '/':
6502
						$absolute = $domain . $url;
6503
						break;
6504
					default:
6505
						$absolute = $css_dir . '/' . $url;
6506
				}
6507
6508
				$find[]    = $match[0];
6509
				$replace[] = sprintf( 'url("%s")', $absolute );
6510
			}
6511
			$css = str_replace( $find, $replace, $css );
6512
		}
6513
6514
		return $css;
6515
	}
6516
6517
	/**
6518
	 * This methods removes all of the registered css files on the front end
6519
	 * from Jetpack in favor of using a single file. In effect "imploding"
6520
	 * all the files into one file.
6521
	 *
6522
	 * Pros:
6523
	 * - Uses only ONE css asset connection instead of 15
6524
	 * - Saves a minimum of 56k
6525
	 * - Reduces server load
6526
	 * - Reduces time to first painted byte
6527
	 *
6528
	 * Cons:
6529
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6530
	 *      should not cause any issues with themes.
6531
	 * - Plugins/themes dequeuing styles no longer do anything. See
6532
	 *      jetpack_implode_frontend_css filter for a workaround
6533
	 *
6534
	 * For some situations developers may wish to disable css imploding and
6535
	 * instead operate in legacy mode where each file loads seperately and
6536
	 * can be edited individually or dequeued. This can be accomplished with
6537
	 * the following line:
6538
	 *
6539
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6540
	 *
6541
	 * @since 3.2
6542
	 **/
6543
	public function implode_frontend_css( $travis_test = false ) {
6544
		$do_implode = true;
6545
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6546
			$do_implode = false;
6547
		}
6548
6549
		// Do not implode CSS when the page loads via the AMP plugin.
6550
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6551
			$do_implode = false;
6552
		}
6553
6554
		/**
6555
		 * Allow CSS to be concatenated into a single jetpack.css file.
6556
		 *
6557
		 * @since 3.2.0
6558
		 *
6559
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6560
		 */
6561
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6562
6563
		// Do not use the imploded file when default behavior was altered through the filter
6564
		if ( ! $do_implode ) {
6565
			return;
6566
		}
6567
6568
		// We do not want to use the imploded file in dev mode, or if not connected
6569
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6570
			if ( ! $travis_test ) {
6571
				return;
6572
			}
6573
		}
6574
6575
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6576
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6577
			return;
6578
		}
6579
6580
		/*
6581
		 * Now we assume Jetpack is connected and able to serve the single
6582
		 * file.
6583
		 *
6584
		 * In the future there will be a check here to serve the file locally
6585
		 * or potentially from the Jetpack CDN
6586
		 *
6587
		 * For now:
6588
		 * - Enqueue a single imploded css file
6589
		 * - Zero out the style_loader_tag for the bundled ones
6590
		 * - Be happy, drink scotch
6591
		 */
6592
6593
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6594
6595
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6596
6597
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6598
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6599
	}
6600
6601
	function concat_remove_style_loader_tag( $tag, $handle ) {
6602
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6603
			$tag = '';
6604
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6605
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6606
			}
6607
		}
6608
6609
		return $tag;
6610
	}
6611
6612
	/**
6613
	 * Add an async attribute to scripts that can be loaded asynchronously.
6614
	 * https://www.w3schools.com/tags/att_script_async.asp
6615
	 *
6616
	 * @since 7.7.0
6617
	 *
6618
	 * @param string $tag    The <script> tag for the enqueued script.
6619
	 * @param string $handle The script's registered handle.
6620
	 * @param string $src    The script's source URL.
6621
	 */
6622
	public function script_add_async( $tag, $handle, $src ) {
6623
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6624
			return preg_replace( '/^<script /i', '<script async ', $tag );
6625
		}
6626
6627
		return $tag;
6628
	}
6629
6630
	/*
6631
	 * Check the heartbeat data
6632
	 *
6633
	 * Organizes the heartbeat data by severity.  For example, if the site
6634
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6635
	 *
6636
	 * Data will be added to "caution" array, if it either:
6637
	 *  - Out of date Jetpack version
6638
	 *  - Out of date WP version
6639
	 *  - Out of date PHP version
6640
	 *
6641
	 * $return array $filtered_data
6642
	 */
6643
	public static function jetpack_check_heartbeat_data() {
6644
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6645
6646
		$good    = array();
6647
		$caution = array();
6648
		$bad     = array();
6649
6650
		foreach ( $raw_data as $stat => $value ) {
6651
6652
			// Check jetpack version
6653
			if ( 'version' == $stat ) {
6654
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6655
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6656
					continue;
6657
				}
6658
			}
6659
6660
			// Check WP version
6661
			if ( 'wp-version' == $stat ) {
6662
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6663
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6664
					continue;
6665
				}
6666
			}
6667
6668
			// Check PHP version
6669
			if ( 'php-version' == $stat ) {
6670
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6671
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6672
					continue;
6673
				}
6674
			}
6675
6676
			// Check ID crisis
6677
			if ( 'identitycrisis' == $stat ) {
6678
				if ( 'yes' == $value ) {
6679
					$bad[ $stat ] = $value;
6680
					continue;
6681
				}
6682
			}
6683
6684
			// The rest are good :)
6685
			$good[ $stat ] = $value;
6686
		}
6687
6688
		$filtered_data = array(
6689
			'good'    => $good,
6690
			'caution' => $caution,
6691
			'bad'     => $bad,
6692
		);
6693
6694
		return $filtered_data;
6695
	}
6696
6697
6698
	/*
6699
	 * This method is used to organize all options that can be reset
6700
	 * without disconnecting Jetpack.
6701
	 *
6702
	 * It is used in class.jetpack-cli.php to reset options
6703
	 *
6704
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6705
	 *
6706
	 * @return array of options to delete.
6707
	 */
6708
	public static function get_jetpack_options_for_reset() {
6709
		return Jetpack_Options::get_options_for_reset();
6710
	}
6711
6712
	/*
6713
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6714
	 * so we can bring them directly to their site in calypso.
6715
	 *
6716
	 * @param string | url
6717
	 * @return string | url without the guff
6718
	 */
6719
	public static function build_raw_urls( $url ) {
6720
		$strip_http = '/.*?:\/\//i';
6721
		$url        = preg_replace( $strip_http, '', $url );
6722
		$url        = str_replace( '/', '::', $url );
6723
		return $url;
6724
	}
6725
6726
	/**
6727
	 * Stores and prints out domains to prefetch for page speed optimization.
6728
	 *
6729
	 * @param mixed $new_urls
6730
	 */
6731
	public static function dns_prefetch( $new_urls = null ) {
6732
		static $prefetch_urls = array();
6733
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6734
			echo "\r\n";
6735
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6736
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6737
			}
6738
		} elseif ( ! empty( $new_urls ) ) {
6739
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6740
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6741
			}
6742
			foreach ( (array) $new_urls as $this_new_url ) {
6743
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6744
			}
6745
			$prefetch_urls = array_unique( $prefetch_urls );
6746
		}
6747
	}
6748
6749
	public function wp_dashboard_setup() {
6750
		if ( self::is_active() ) {
6751
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6752
		}
6753
6754
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6755
			$jetpack_logo = new Jetpack_Logo();
6756
			$widget_title = sprintf(
6757
				wp_kses(
6758
					/* translators: Placeholder is a Jetpack logo. */
6759
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6760
					array( 'span' => array() )
6761
				),
6762
				$jetpack_logo->get_jp_emblem( true )
6763
			);
6764
6765
			wp_add_dashboard_widget(
6766
				'jetpack_summary_widget',
6767
				$widget_title,
6768
				array( __CLASS__, 'dashboard_widget' )
6769
			);
6770
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6771
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6772
6773
			// If we're inactive and not in development mode, sort our box to the top.
6774
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6775
				global $wp_meta_boxes;
6776
6777
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6778
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6779
6780
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6781
			}
6782
		}
6783
	}
6784
6785
	/**
6786
	 * @param mixed $result Value for the user's option
6787
	 * @return mixed
6788
	 */
6789
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6790
		if ( ! is_array( $sorted ) ) {
6791
			return $sorted;
6792
		}
6793
6794
		foreach ( $sorted as $box_context => $ids ) {
6795
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6796
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6797
				continue;
6798
			}
6799
6800
			$ids_array = explode( ',', $ids );
6801
			$key       = array_search( 'dashboard_stats', $ids_array );
6802
6803
			if ( false !== $key ) {
6804
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6805
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6806
				$sorted[ $box_context ] = implode( ',', $ids_array );
6807
				// We've found it, stop searching, and just return.
6808
				break;
6809
			}
6810
		}
6811
6812
		return $sorted;
6813
	}
6814
6815
	public static function dashboard_widget() {
6816
		/**
6817
		 * Fires when the dashboard is loaded.
6818
		 *
6819
		 * @since 3.4.0
6820
		 */
6821
		do_action( 'jetpack_dashboard_widget' );
6822
	}
6823
6824
	public static function dashboard_widget_footer() {
6825
		?>
6826
		<footer>
6827
6828
		<div class="protect">
6829
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6830
				<h3><?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?></h3>
6831
				<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>
6832
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6833
				<a href="
6834
				<?php
6835
				echo esc_url(
6836
					wp_nonce_url(
6837
						self::admin_url(
6838
							array(
6839
								'action' => 'activate',
6840
								'module' => 'protect',
6841
							)
6842
						),
6843
						'jetpack_activate-protect'
6844
					)
6845
				);
6846
				?>
6847
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6848
					<?php esc_html_e( 'Activate Protect', 'jetpack' ); ?>
6849
				</a>
6850
			<?php else : ?>
6851
				<?php esc_html_e( 'Protect is inactive.', 'jetpack' ); ?>
6852
			<?php endif; ?>
6853
		</div>
6854
6855
		<div class="akismet">
6856
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6857
				<h3><?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?></h3>
6858
				<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>
6859
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6860
				<a href="
6861
				<?php
6862
				echo esc_url(
6863
					wp_nonce_url(
6864
						add_query_arg(
6865
							array(
6866
								'action' => 'activate',
6867
								'plugin' => 'akismet/akismet.php',
6868
							),
6869
							admin_url( 'plugins.php' )
6870
						),
6871
						'activate-plugin_akismet/akismet.php'
6872
					)
6873
				);
6874
				?>
6875
							" class="button button-jetpack">
6876
					<?php esc_html_e( 'Activate Akismet', 'jetpack' ); ?>
6877
				</a>
6878
			<?php else : ?>
6879
				<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>
6880
			<?php endif; ?>
6881
		</div>
6882
6883
		</footer>
6884
		<?php
6885
	}
6886
6887
	/*
6888
	 * Adds a "blank" column in the user admin table to display indication of user connection.
6889
	 */
6890
	function jetpack_icon_user_connected( $columns ) {
6891
		$columns['user_jetpack'] = '';
6892
		return $columns;
6893
	}
6894
6895
	/*
6896
	 * Show Jetpack icon if the user is linked.
6897
	 */
6898
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
6899
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
6900
			$jetpack_logo = new Jetpack_Logo();
6901
			$emblem_html  = sprintf(
6902
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
6903
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
6904
				$jetpack_logo->get_jp_emblem()
6905
			);
6906
			return $emblem_html;
6907
		}
6908
6909
		return $val;
6910
	}
6911
6912
	/*
6913
	 * Style the Jetpack user column
6914
	 */
6915
	function jetpack_user_col_style() {
6916
		global $current_screen;
6917
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
6918
			?>
6919
			<style>
6920
				.fixed .column-user_jetpack {
6921
					width: 21px;
6922
				}
6923
				.jp-emblem-user-admin svg {
6924
					width: 20px;
6925
					height: 20px;
6926
				}
6927
				.jp-emblem-user-admin path {
6928
					fill: #00BE28;
6929
				}
6930
			</style>
6931
			<?php
6932
		}
6933
	}
6934
6935
	/**
6936
	 * Checks if Akismet is active and working.
6937
	 *
6938
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
6939
	 * that implied usage of methods present since more recent version.
6940
	 * See https://github.com/Automattic/jetpack/pull/9585
6941
	 *
6942
	 * @since  5.1.0
6943
	 *
6944
	 * @return bool True = Akismet available. False = Aksimet not available.
6945
	 */
6946
	public static function is_akismet_active() {
6947
		static $status = null;
6948
6949
		if ( ! is_null( $status ) ) {
6950
			return $status;
6951
		}
6952
6953
		// Check if a modern version of Akismet is active.
6954
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
6955
			$status = false;
6956
			return $status;
6957
		}
6958
6959
		// Make sure there is a key known to Akismet at all before verifying key.
6960
		$akismet_key = Akismet::get_api_key();
6961
		if ( ! $akismet_key ) {
6962
			$status = false;
6963
			return $status;
6964
		}
6965
6966
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
6967
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
6968
6969
		// 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.
6970
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
6971
		// We cache the result of the Akismet key verification for ten minutes.
6972
		if ( ! $akismet_key_state || $recheck ) {
6973
			$akismet_key_state = Akismet::verify_key( $akismet_key );
6974
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
6975
		}
6976
6977
		$status = 'valid' === $akismet_key_state;
6978
6979
		return $status;
6980
	}
6981
6982
	/**
6983
	 * @deprecated
6984
	 *
6985
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
6986
	 */
6987
	public static function is_function_in_backtrace() {
6988
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
6989
	}
6990
6991
	/**
6992
	 * Given a minified path, and a non-minified path, will return
6993
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
6994
	 *
6995
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
6996
	 * root Jetpack directory.
6997
	 *
6998
	 * @since 5.6.0
6999
	 *
7000
	 * @param string $min_path
7001
	 * @param string $non_min_path
7002
	 * @return string The URL to the file
7003
	 */
7004
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7005
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7006
	}
7007
7008
	/**
7009
	 * Checks for whether Jetpack Backup & Scan is enabled.
7010
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7011
	 *
7012
	 * @return bool|int|mixed
7013
	 */
7014
	public static function is_rewind_enabled() {
7015
		if ( ! self::is_active() ) {
7016
			return false;
7017
		}
7018
7019
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7020
		if ( false === $rewind_enabled ) {
7021
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7022
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7023
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7024
				&& ! empty( $rewind_data['state'] )
7025
				&& 'active' === $rewind_data['state'] )
7026
				? 1
7027
				: 0;
7028
7029
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7030
		}
7031
		return $rewind_enabled;
7032
	}
7033
7034
	/**
7035
	 * Return Calypso environment value; used for developing Jetpack and pairing
7036
	 * it with different Calypso enrionments, such as localhost.
7037
	 *
7038
	 * @since 7.4.0
7039
	 *
7040
	 * @return string Calypso environment
7041
	 */
7042
	public static function get_calypso_env() {
7043
		if ( isset( $_GET['calypso_env'] ) ) {
7044
			return sanitize_key( $_GET['calypso_env'] );
7045
		}
7046
7047
		if ( getenv( 'CALYPSO_ENV' ) ) {
7048
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7049
		}
7050
7051
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7052
			return sanitize_key( CALYPSO_ENV );
7053
		}
7054
7055
		return '';
7056
	}
7057
7058
	/**
7059
	 * Checks whether or not TOS has been agreed upon.
7060
	 * Will return true if a user has clicked to register, or is already connected.
7061
	 */
7062
	public static function jetpack_tos_agreed() {
7063
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7064
7065
		$terms_of_service = new Terms_Of_Service();
7066
		return $terms_of_service->has_agreed();
7067
7068
	}
7069
7070
	/**
7071
	 * Handles activating default modules as well general cleanup for the new connection.
7072
	 *
7073
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7074
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7075
	 * @param boolean $send_state_messages          Whether to send state messages.
7076
	 * @return void
7077
	 */
7078
	public static function handle_post_authorization_actions(
7079
		$activate_sso = false,
7080
		$redirect_on_activation_error = false,
7081
		$send_state_messages = true
7082
	) {
7083
		$other_modules = $activate_sso
7084
			? array( 'sso' )
7085
			: array();
7086
7087
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7088
			self::delete_active_modules();
7089
7090
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
7091
		} else {
7092
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7093
		}
7094
7095
		// Since this is a fresh connection, be sure to clear out IDC options
7096
		Jetpack_IDC::clear_all_idc_options();
7097
		Jetpack_Options::delete_raw_option( 'jetpack_last_connect_url_check' );
7098
7099
		// Start nonce cleaner
7100
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
7101
		wp_schedule_event( time(), 'hourly', 'jetpack_clean_nonces' );
7102
7103
		if ( $send_state_messages ) {
7104
			self::state( 'message', 'authorized' );
7105
		}
7106
	}
7107
7108
	/**
7109
	 * Returns a boolean for whether backups UI should be displayed or not.
7110
	 *
7111
	 * @return bool Should backups UI be displayed?
7112
	 */
7113
	public static function show_backups_ui() {
7114
		/**
7115
		 * Whether UI for backups should be displayed.
7116
		 *
7117
		 * @since 6.5.0
7118
		 *
7119
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7120
		 */
7121
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7122
	}
7123
7124
	/*
7125
	 * Deprecated manage functions
7126
	 */
7127
	function prepare_manage_jetpack_notice() {
7128
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7129
	}
7130
	function manage_activate_screen() {
7131
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7132
	}
7133
	function admin_jetpack_manage_notice() {
7134
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7135
	}
7136
	function opt_out_jetpack_manage_url() {
7137
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7138
	}
7139
	function opt_in_jetpack_manage_url() {
7140
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7141
	}
7142
	function opt_in_jetpack_manage_notice() {
7143
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7144
	}
7145
	function can_display_jetpack_manage_notice() {
7146
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7147
	}
7148
7149
	/**
7150
	 * Clean leftoveruser meta.
7151
	 *
7152
	 * Delete Jetpack-related user meta when it is no longer needed.
7153
	 *
7154
	 * @since 7.3.0
7155
	 *
7156
	 * @param int $user_id User ID being updated.
7157
	 */
7158
	public static function user_meta_cleanup( $user_id ) {
7159
		$meta_keys = array(
7160
			// AtD removed from Jetpack 7.3
7161
			'AtD_options',
7162
			'AtD_check_when',
7163
			'AtD_guess_lang',
7164
			'AtD_ignored_phrases',
7165
		);
7166
7167
		foreach ( $meta_keys as $meta_key ) {
7168
			if ( get_user_meta( $user_id, $meta_key ) ) {
7169
				delete_user_meta( $user_id, $meta_key );
7170
			}
7171
		}
7172
	}
7173
7174
	/**
7175
	 * Checks if a Jetpack site is both active and not in development.
7176
	 *
7177
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7178
	 *
7179
	 * @return bool True if Jetpack is active and not in development.
7180
	 */
7181
	public static function is_active_and_not_development_mode() {
7182
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7183
			return false;
7184
		}
7185
		return true;
7186
	}
7187
}
7188