Completed
Push — update/add_release_post_to_upd... ( d904f4...468b87 )
by
unknown
20:57 queued 13:20
created

class.jetpack.php (1 issue)

Severity

Upgrade to new PHP Analysis Engine

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

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

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3358
	}
3359
3360
	/**
3361
	 * Temporarily allow post content to contain iframes, e.g. for videopress.
3362
	 *
3363
	 * @param string $tags    The tags.
3364
	 * @param string $context The context.
3365
	 */
3366
	public static function allow_post_embed_iframe( $tags, $context ) {
3367
		if ( 'post' === $context ) {
3368
			$tags['iframe'] = array(
3369
				'src'             => true,
3370
				'height'          => true,
3371
				'width'           => true,
3372
				'frameborder'     => true,
3373
				'allowfullscreen' => true,
3374
			);
3375
		}
3376
3377
		return $tags;
3378
	}
3379
3380
	/**
3381
	 * Obtains the release post from the Jetpack release post blog. A release post will be displayed in the
3382
	 * update modal when a post has a tag equal to the Jetpack version number.
3383
	 *
3384
	 * The response parameters for the post array can be found here:
3385
	 * https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/posts/%24post_ID/#apidoc-response
3386
	 *
3387
	 * @return array|null Returns an associative array containing the release post data at index ['posts'][0].
3388
	 *                    Returns null if the release post data is not available.
3389
	 */
3390
	private static function get_release_post_data() {
3391
		if ( Constants::is_defined( 'TESTING_IN_JETPACK' ) && Constants::get_constant( 'TESTING_IN_JETPACK' ) ) {
3392
			return null;
3393
		}
3394
3395
		$release_post_src = add_query_arg(
3396
			array(
3397
				'order_by' => 'date',
3398
				'tag'      => JETPACK__VERSION,
3399
				'number'   => '1',
3400
			),
3401
			'https://public-api.wordpress.com/rest/v1/sites/' . JETPACK__RELEASE_POST_BLOG_SLUG . '/posts'
3402
		);
3403
3404
		$response = wp_remote_get( $release_post_src );
3405
3406
		if ( ! is_array( $response ) ) {
3407
			return null;
3408
		}
3409
3410
		return json_decode( wp_remote_retrieve_body( $response ), true );
3411
	}
3412
3413
	/**
3414
	 * Sets the internal version number and activation state.
3415
	 *
3416
	 * @static
3417
	 */
3418
	public static function plugin_initialize() {
3419
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3420
			Jetpack_Options::update_option( 'activated', 2 );
3421
		}
3422
3423 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3424
			$version = $old_version = JETPACK__VERSION . ':' . time();
3425
			/** This action is documented in class.jetpack.php */
3426
			do_action( 'updating_jetpack_version', $version, false );
3427
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3428
		}
3429
3430
		self::load_modules();
3431
3432
		Jetpack_Options::delete_option( 'do_activate' );
3433
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3434
	}
3435
3436
	/**
3437
	 * Removes all connection options
3438
	 *
3439
	 * @static
3440
	 */
3441
	public static function plugin_deactivation() {
3442
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3443
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3444
			Jetpack_Network::init()->deactivate();
3445
		} else {
3446
			self::disconnect( false );
3447
			// Jetpack_Heartbeat::init()->deactivate();
3448
		}
3449
	}
3450
3451
	/**
3452
	 * Disconnects from the Jetpack servers.
3453
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3454
	 *
3455
	 * @static
3456
	 */
3457
	public static function disconnect( $update_activated_state = true ) {
3458
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3459
		$connection = self::connection();
3460
		$connection->clean_nonces( true );
3461
3462
		// If the site is in an IDC because sync is not allowed,
3463
		// let's make sure to not disconnect the production site.
3464
		if ( ! self::validate_sync_error_idc_option() ) {
3465
			$tracking = new Tracking();
3466
			$tracking->record_user_event( 'disconnect_site', array() );
3467
3468
			$connection->disconnect_site_wpcom();
3469
		}
3470
3471
		$connection->delete_all_connection_tokens();
3472
		Jetpack_IDC::clear_all_idc_options();
3473
3474
		if ( $update_activated_state ) {
3475
			Jetpack_Options::update_option( 'activated', 4 );
3476
		}
3477
3478
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3479
			// Check then record unique disconnection if site has never been disconnected previously
3480
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3481
				$jetpack_unique_connection['disconnected'] = 1;
3482
			} else {
3483
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3484
					// track unique disconnect
3485
					$jetpack = self::init();
3486
3487
					$jetpack->stat( 'connections', 'unique-disconnect' );
3488
					$jetpack->do_stats( 'server_side' );
3489
				}
3490
				// increment number of times disconnected
3491
				$jetpack_unique_connection['disconnected'] += 1;
3492
			}
3493
3494
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3495
		}
3496
3497
		// Delete all the sync related data. Since it could be taking up space.
3498
		Sender::get_instance()->uninstall();
3499
3500
		// Disable the Heartbeat cron
3501
		Jetpack_Heartbeat::init()->deactivate();
3502
	}
3503
3504
	/**
3505
	 * Unlinks the current user from the linked WordPress.com user.
3506
	 *
3507
	 * @deprecated since 7.7
3508
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3509
	 *
3510
	 * @param Integer $user_id the user identifier.
3511
	 * @return Boolean Whether the disconnection of the user was successful.
3512
	 */
3513
	public static function unlink_user( $user_id = null ) {
3514
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3515
		return Connection_Manager::disconnect_user( $user_id );
3516
	}
3517
3518
	/**
3519
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3520
	 */
3521
	public static function try_registration() {
3522
		$terms_of_service = new Terms_Of_Service();
3523
		// The user has agreed to the TOS at some point by now.
3524
		$terms_of_service->agree();
3525
3526
		// Let's get some testing in beta versions and such.
3527
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3528
			// Before attempting to connect, let's make sure that the domains are viable.
3529
			$domains_to_check = array_unique(
3530
				array(
3531
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3532
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3533
				)
3534
			);
3535
			foreach ( $domains_to_check as $domain ) {
3536
				$result = self::connection()->is_usable_domain( $domain );
3537
				if ( is_wp_error( $result ) ) {
3538
					return $result;
3539
				}
3540
			}
3541
		}
3542
3543
		$result = self::register();
3544
3545
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3546
		if ( ! $result || is_wp_error( $result ) ) {
3547
			return $result;
3548
		} else {
3549
			return true;
3550
		}
3551
	}
3552
3553
	/**
3554
	 * Tracking an internal event log. Try not to put too much chaff in here.
3555
	 *
3556
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3557
	 */
3558
	public static function log( $code, $data = null ) {
3559
		// only grab the latest 200 entries
3560
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3561
3562
		// Append our event to the log
3563
		$log_entry = array(
3564
			'time'    => time(),
3565
			'user_id' => get_current_user_id(),
3566
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3567
			'code'    => $code,
3568
		);
3569
		// Don't bother storing it unless we've got some.
3570
		if ( ! is_null( $data ) ) {
3571
			$log_entry['data'] = $data;
3572
		}
3573
		$log[] = $log_entry;
3574
3575
		// Try add_option first, to make sure it's not autoloaded.
3576
		// @todo: Add an add_option method to Jetpack_Options
3577
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3578
			Jetpack_Options::update_option( 'log', $log );
3579
		}
3580
3581
		/**
3582
		 * Fires when Jetpack logs an internal event.
3583
		 *
3584
		 * @since 3.0.0
3585
		 *
3586
		 * @param array $log_entry {
3587
		 *  Array of details about the log entry.
3588
		 *
3589
		 *  @param string time Time of the event.
3590
		 *  @param int user_id ID of the user who trigerred the event.
3591
		 *  @param int blog_id Jetpack Blog ID.
3592
		 *  @param string code Unique name for the event.
3593
		 *  @param string data Data about the event.
3594
		 * }
3595
		 */
3596
		do_action( 'jetpack_log_entry', $log_entry );
3597
	}
3598
3599
	/**
3600
	 * Get the internal event log.
3601
	 *
3602
	 * @param $event (string) - only return the specific log events
3603
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3604
	 *
3605
	 * @return array of log events || WP_Error for invalid params
3606
	 */
3607
	public static function get_log( $event = false, $num = false ) {
3608
		if ( $event && ! is_string( $event ) ) {
3609
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3610
		}
3611
3612
		if ( $num && ! is_numeric( $num ) ) {
3613
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3614
		}
3615
3616
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3617
3618
		// If nothing set - act as it did before, otherwise let's start customizing the output
3619
		if ( ! $num && ! $event ) {
3620
			return $entire_log;
3621
		} else {
3622
			$entire_log = array_reverse( $entire_log );
3623
		}
3624
3625
		$custom_log_output = array();
3626
3627
		if ( $event ) {
3628
			foreach ( $entire_log as $log_event ) {
3629
				if ( $event == $log_event['code'] ) {
3630
					$custom_log_output[] = $log_event;
3631
				}
3632
			}
3633
		} else {
3634
			$custom_log_output = $entire_log;
3635
		}
3636
3637
		if ( $num ) {
3638
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3639
		}
3640
3641
		return $custom_log_output;
3642
	}
3643
3644
	/**
3645
	 * Log modification of important settings.
3646
	 */
3647
	public static function log_settings_change( $option, $old_value, $value ) {
3648
		switch ( $option ) {
3649
			case 'jetpack_sync_non_public_post_stati':
3650
				self::log( $option, $value );
3651
				break;
3652
		}
3653
	}
3654
3655
	/**
3656
	 * Return stat data for WPCOM sync
3657
	 */
3658
	public static function get_stat_data( $encode = true, $extended = true ) {
3659
		$data = Jetpack_Heartbeat::generate_stats_array();
3660
3661
		if ( $extended ) {
3662
			$additional_data = self::get_additional_stat_data();
3663
			$data            = array_merge( $data, $additional_data );
3664
		}
3665
3666
		if ( $encode ) {
3667
			return json_encode( $data );
3668
		}
3669
3670
		return $data;
3671
	}
3672
3673
	/**
3674
	 * Get additional stat data to sync to WPCOM
3675
	 */
3676
	public static function get_additional_stat_data( $prefix = '' ) {
3677
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
3678
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3679
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3680
		$return[ "{$prefix}site-count" ]    = 0;
3681
3682
		if ( function_exists( 'get_blog_count' ) ) {
3683
			$return[ "{$prefix}site-count" ] = get_blog_count();
3684
		}
3685
		return $return;
3686
	}
3687
3688
	private static function get_site_user_count() {
3689
		global $wpdb;
3690
3691
		if ( function_exists( 'wp_is_large_network' ) ) {
3692
			if ( wp_is_large_network( 'users' ) ) {
3693
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3694
			}
3695
		}
3696
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3697
			// It wasn't there, so regenerate the data and save the transient
3698
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3699
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3700
		}
3701
		return $user_count;
3702
	}
3703
3704
	/* Admin Pages */
3705
3706
	function admin_init() {
3707
		// If the plugin is not connected, display a connect message.
3708
		if (
3709
			// the plugin was auto-activated and needs its candy
3710
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3711
		||
3712
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3713
			! Jetpack_Options::get_option( 'activated' )
3714
		) {
3715
			self::plugin_initialize();
3716
		}
3717
3718
		$is_development_mode = ( new Status() )->is_development_mode();
3719
		if ( ! self::is_active() && ! $is_development_mode ) {
3720
			Jetpack_Connection_Banner::init();
3721
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3722
			// Upgrade: 1.1 -> 1.1.1
3723
			// Check and see if host can verify the Jetpack servers' SSL certificate
3724
			$args       = array();
3725
			$connection = self::connection();
3726
			Client::_wp_remote_request(
3727
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3728
				$args,
3729
				true
3730
			);
3731
		}
3732
3733
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3734
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3735
		}
3736
3737
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3738
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3739
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3740
3741
		if ( self::is_active() || $is_development_mode ) {
3742
			// Artificially throw errors in certain whitelisted cases during plugin activation
3743
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3744
		}
3745
3746
		// Add custom column in wp-admin/users.php to show whether user is linked.
3747
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3748
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3749
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3750
	}
3751
3752
	function admin_body_class( $admin_body_class = '' ) {
3753
		$classes = explode( ' ', trim( $admin_body_class ) );
3754
3755
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3756
3757
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3758
		return " $admin_body_class ";
3759
	}
3760
3761
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3762
		return $admin_body_class . ' jetpack-pagestyles ';
3763
	}
3764
3765
	/**
3766
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3767
	 * This function artificially throws errors for such cases (whitelisted).
3768
	 *
3769
	 * @param string $plugin The activated plugin.
3770
	 */
3771
	function throw_error_on_activate_plugin( $plugin ) {
3772
		$active_modules = self::get_active_modules();
3773
3774
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3775
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3776
			$throw = false;
3777
3778
			// Try and make sure it really was the stats plugin
3779
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3780
				if ( 'stats.php' == basename( $plugin ) ) {
3781
					$throw = true;
3782
				}
3783
			} else {
3784
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3785
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3786
					$throw = true;
3787
				}
3788
			}
3789
3790
			if ( $throw ) {
3791
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3792
			}
3793
		}
3794
	}
3795
3796
	function intercept_plugin_error_scrape_init() {
3797
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3798
	}
3799
3800
	function intercept_plugin_error_scrape( $action, $result ) {
3801
		if ( ! $result ) {
3802
			return;
3803
		}
3804
3805
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3806
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3807
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3808
			}
3809
		}
3810
	}
3811
3812
	/**
3813
	 * Register the remote file upload request handlers, if needed.
3814
	 *
3815
	 * @access public
3816
	 */
3817
	public function add_remote_request_handlers() {
3818
		// Remote file uploads are allowed only via AJAX requests.
3819
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3820
			return;
3821
		}
3822
3823
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3824
		$remote_request_actions = array(
3825
			'jetpack_upload_file',
3826
			'jetpack_update_file',
3827
		);
3828
3829
		// phpcs:ignore WordPress.Security.NonceVerification
3830
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3831
			return;
3832
		}
3833
3834
		// Require Jetpack authentication for the remote file upload AJAX requests.
3835
		if ( ! $this->connection_manager ) {
3836
			$this->connection_manager = new Connection_Manager();
3837
		}
3838
3839
		$this->connection_manager->require_jetpack_authentication();
3840
3841
		// Register the remote file upload AJAX handlers.
3842
		foreach ( $remote_request_actions as $action ) {
3843
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3844
		}
3845
	}
3846
3847
	/**
3848
	 * Handler for Jetpack remote file uploads.
3849
	 *
3850
	 * @access public
3851
	 */
3852
	public function remote_request_handlers() {
3853
		$action = current_filter();
3854
3855
		switch ( current_filter() ) {
3856
			case 'wp_ajax_nopriv_jetpack_upload_file':
3857
				$response = $this->upload_handler();
3858
				break;
3859
3860
			case 'wp_ajax_nopriv_jetpack_update_file':
3861
				$response = $this->upload_handler( true );
3862
				break;
3863
			default:
3864
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3865
				break;
3866
		}
3867
3868
		if ( ! $response ) {
3869
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3870
		}
3871
3872
		if ( is_wp_error( $response ) ) {
3873
			$status_code       = $response->get_error_data();
3874
			$error             = $response->get_error_code();
3875
			$error_description = $response->get_error_message();
3876
3877
			if ( ! is_int( $status_code ) ) {
3878
				$status_code = 400;
3879
			}
3880
3881
			status_header( $status_code );
3882
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3883
		}
3884
3885
		status_header( 200 );
3886
		if ( true === $response ) {
3887
			exit;
3888
		}
3889
3890
		die( json_encode( (object) $response ) );
3891
	}
3892
3893
	/**
3894
	 * Uploads a file gotten from the global $_FILES.
3895
	 * If `$update_media_item` is true and `post_id` is defined
3896
	 * the attachment file of the media item (gotten through of the post_id)
3897
	 * will be updated instead of add a new one.
3898
	 *
3899
	 * @param  boolean $update_media_item - update media attachment
3900
	 * @return array - An array describing the uploadind files process
3901
	 */
3902
	function upload_handler( $update_media_item = false ) {
3903
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3904
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3905
		}
3906
3907
		$user = wp_authenticate( '', '' );
3908
		if ( ! $user || is_wp_error( $user ) ) {
3909
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3910
		}
3911
3912
		wp_set_current_user( $user->ID );
3913
3914
		if ( ! current_user_can( 'upload_files' ) ) {
3915
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3916
		}
3917
3918
		if ( empty( $_FILES ) ) {
3919
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3920
		}
3921
3922
		foreach ( array_keys( $_FILES ) as $files_key ) {
3923
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3924
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3925
			}
3926
		}
3927
3928
		$media_keys = array_keys( $_FILES['media'] );
3929
3930
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3931
		if ( ! $token || is_wp_error( $token ) ) {
3932
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3933
		}
3934
3935
		$uploaded_files = array();
3936
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3937
		unset( $GLOBALS['post'] );
3938
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3939
			$file = array();
3940
			foreach ( $media_keys as $media_key ) {
3941
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3942
			}
3943
3944
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3945
3946
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3947
			if ( $hmac_provided !== $hmac_file ) {
3948
				$uploaded_files[ $index ] = (object) array(
3949
					'error'             => 'invalid_hmac',
3950
					'error_description' => 'The corresponding HMAC for this file does not match',
3951
				);
3952
				continue;
3953
			}
3954
3955
			$_FILES['.jetpack.upload.'] = $file;
3956
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3957
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3958
				$post_id = 0;
3959
			}
3960
3961
			if ( $update_media_item ) {
3962
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3963
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3964
				}
3965
3966
				$media_array = $_FILES['media'];
3967
3968
				$file_array['name']     = $media_array['name'][0];
3969
				$file_array['type']     = $media_array['type'][0];
3970
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3971
				$file_array['error']    = $media_array['error'][0];
3972
				$file_array['size']     = $media_array['size'][0];
3973
3974
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3975
3976
				if ( is_wp_error( $edited_media_item ) ) {
3977
					return $edited_media_item;
3978
				}
3979
3980
				$response = (object) array(
3981
					'id'   => (string) $post_id,
3982
					'file' => (string) $edited_media_item->post_title,
3983
					'url'  => (string) wp_get_attachment_url( $post_id ),
3984
					'type' => (string) $edited_media_item->post_mime_type,
3985
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3986
				);
3987
3988
				return (array) array( $response );
3989
			}
3990
3991
			$attachment_id = media_handle_upload(
3992
				'.jetpack.upload.',
3993
				$post_id,
3994
				array(),
3995
				array(
3996
					'action' => 'jetpack_upload_file',
3997
				)
3998
			);
3999
4000
			if ( ! $attachment_id ) {
4001
				$uploaded_files[ $index ] = (object) array(
4002
					'error'             => 'unknown',
4003
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
4004
				);
4005
			} elseif ( is_wp_error( $attachment_id ) ) {
4006
				$uploaded_files[ $index ] = (object) array(
4007
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
4008
					'error_description' => $attachment_id->get_error_message(),
4009
				);
4010
			} else {
4011
				$attachment               = get_post( $attachment_id );
4012
				$uploaded_files[ $index ] = (object) array(
4013
					'id'   => (string) $attachment_id,
4014
					'file' => $attachment->post_title,
4015
					'url'  => wp_get_attachment_url( $attachment_id ),
4016
					'type' => $attachment->post_mime_type,
4017
					'meta' => wp_get_attachment_metadata( $attachment_id ),
4018
				);
4019
				// Zip files uploads are not supported unless they are done for installation purposed
4020
				// lets delete them in case something goes wrong in this whole process
4021
				if ( 'application/zip' === $attachment->post_mime_type ) {
4022
					// Schedule a cleanup for 2 hours from now in case of failed install.
4023
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
4024
				}
4025
			}
4026
		}
4027
		if ( ! is_null( $global_post ) ) {
4028
			$GLOBALS['post'] = $global_post;
4029
		}
4030
4031
		return $uploaded_files;
4032
	}
4033
4034
	/**
4035
	 * Add help to the Jetpack page
4036
	 *
4037
	 * @since Jetpack (1.2.3)
4038
	 * @return false if not the Jetpack page
4039
	 */
4040
	function admin_help() {
4041
		$current_screen = get_current_screen();
4042
4043
		// Overview
4044
		$current_screen->add_help_tab(
4045
			array(
4046
				'id'      => 'home',
4047
				'title'   => __( 'Home', 'jetpack' ),
4048
				'content' =>
4049
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4050
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
4051
					'<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>',
4052
			)
4053
		);
4054
4055
		// Screen Content
4056
		if ( current_user_can( 'manage_options' ) ) {
4057
			$current_screen->add_help_tab(
4058
				array(
4059
					'id'      => 'settings',
4060
					'title'   => __( 'Settings', 'jetpack' ),
4061
					'content' =>
4062
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4063
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
4064
						'<ol>' .
4065
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
4066
							'<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>' .
4067
						'</ol>' .
4068
						'<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>',
4069
				)
4070
			);
4071
		}
4072
4073
		// Help Sidebar
4074
		$current_screen->set_help_sidebar(
4075
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
4076
			'<p><a href="https://jetpack.com/faq/" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
4077
			'<p><a href="https://jetpack.com/support/" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
4078
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
4079
		);
4080
	}
4081
4082
	function admin_menu_css() {
4083
		wp_enqueue_style( 'jetpack-icons' );
4084
	}
4085
4086
	function admin_menu_order() {
4087
		return true;
4088
	}
4089
4090 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
4091
		$jp_menu_order = array();
4092
4093
		foreach ( $menu_order as $index => $item ) {
4094
			if ( $item != 'jetpack' ) {
4095
				$jp_menu_order[] = $item;
4096
			}
4097
4098
			if ( $index == 0 ) {
4099
				$jp_menu_order[] = 'jetpack';
4100
			}
4101
		}
4102
4103
		return $jp_menu_order;
4104
	}
4105
4106
	function admin_banner_styles() {
4107
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4108
4109 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4110
			wp_register_style(
4111
				'jetpack-dops-style',
4112
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4113
				array(),
4114
				JETPACK__VERSION
4115
			);
4116
		}
4117
4118
		wp_enqueue_style(
4119
			'jetpack',
4120
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4121
			array( 'jetpack-dops-style' ),
4122
			JETPACK__VERSION . '-20121016'
4123
		);
4124
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4125
		wp_style_add_data( 'jetpack', 'suffix', $min );
4126
	}
4127
4128
	function plugin_action_links( $actions ) {
4129
4130
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4131
4132
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4133
			return array_merge(
4134
				$jetpack_home,
4135
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4136
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4137
				$actions
4138
			);
4139
		}
4140
4141
		return array_merge( $jetpack_home, $actions );
4142
	}
4143
4144
	/**
4145
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4146
	 *
4147
	 * @param string $login_url The wp-login URL.
4148
	 * @param string $redirect  URL to redirect users after logging in.
4149
	 * @since Jetpack 8.4
4150
	 * @return string
4151
	 */
4152
	public function login_url( $login_url, $redirect ) {
4153
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4154
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4155
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4156
		}
4157
		return $login_url;
4158
	}
4159
4160
	/**
4161
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4162
	 *
4163
	 * @since Jetpack 8.4
4164
	 */
4165
	public function login_init() {
4166
		// phpcs:ignore WordPress.Security.NonceVerification
4167
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4168
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4169
			wp_safe_redirect(
4170
				add_query_arg(
4171
					array(
4172
						'forceInstall' => 1,
4173
						'url'          => rawurlencode( get_site_url() ),
4174
					),
4175
					// @todo provide way to go to specific calypso env.
4176
					self::get_calypso_host() . 'jetpack/connect'
4177
				)
4178
			);
4179
			exit;
4180
		}
4181
	}
4182
4183
	/*
4184
	 * Registration flow:
4185
	 * 1 - ::admin_page_load() action=register
4186
	 * 2 - ::try_registration()
4187
	 * 3 - ::register()
4188
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4189
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4190
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4191
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4192
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4193
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4194
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4195
	 *       jetpack_id, jetpack_secret, jetpack_public
4196
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4197
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4198
	 * 5 - user logs in with WP.com account
4199
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4200
	 *		- Manager::authorize()
4201
	 *		- Manager::get_token()
4202
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4203
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4204
	 *			- which responds with access_token, token_type, scope
4205
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4206
	 *		- Jetpack::activate_default_modules()
4207
	 *     		- Deactivates deprecated plugins
4208
	 *     		- Activates all default modules
4209
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4210
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4211
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4212
	 *     Done!
4213
	 */
4214
4215
	/**
4216
	 * Handles the page load events for the Jetpack admin page
4217
	 */
4218
	function admin_page_load() {
4219
		$error = false;
4220
4221
		// Make sure we have the right body class to hook stylings for subpages off of.
4222
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4223
4224
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4225
			// Should only be used in intermediate redirects to preserve state across redirects
4226
			self::restate();
4227
		}
4228
4229
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4230
			// @todo: Add validation against a known whitelist
4231
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4232
			// User clicked in the iframe to link their accounts
4233
			if ( ! self::is_user_connected() ) {
4234
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4235
4236
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4237
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4238
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4239
4240
				if ( isset( $_GET['notes_iframe'] ) ) {
4241
					$connect_url .= '&notes_iframe';
4242
				}
4243
				wp_redirect( $connect_url );
4244
				exit;
4245
			} else {
4246
				if ( ! isset( $_GET['calypso_env'] ) ) {
4247
					self::state( 'message', 'already_authorized' );
4248
					wp_safe_redirect( self::admin_url() );
4249
					exit;
4250
				} else {
4251
					$connect_url  = $this->build_connect_url( true, false, $from );
4252
					$connect_url .= '&already_authorized=true';
4253
					wp_redirect( $connect_url );
4254
					exit;
4255
				}
4256
			}
4257
		}
4258
4259
		if ( isset( $_GET['action'] ) ) {
4260
			switch ( $_GET['action'] ) {
4261
				case 'authorize':
4262
					if ( self::is_active() && self::is_user_connected() ) {
4263
						self::state( 'message', 'already_authorized' );
4264
						wp_safe_redirect( self::admin_url() );
4265
						exit;
4266
					}
4267
					self::log( 'authorize' );
4268
					$client_server = new Jetpack_Client_Server();
4269
					$client_server->client_authorize();
4270
					exit;
4271
				case 'register':
4272
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4273
						$error = 'cheatin';
4274
						break;
4275
					}
4276
					check_admin_referer( 'jetpack-register' );
4277
					self::log( 'register' );
4278
					self::maybe_set_version_option();
4279
					$registered = self::try_registration();
4280 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4281
						$error = $registered->get_error_code();
4282
						self::state( 'error', $error );
4283
						self::state( 'error', $registered->get_error_message() );
4284
4285
						/**
4286
						 * Jetpack registration Error.
4287
						 *
4288
						 * @since 7.5.0
4289
						 *
4290
						 * @param string|int $error The error code.
4291
						 * @param \WP_Error $registered The error object.
4292
						 */
4293
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4294
						break;
4295
					}
4296
4297
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4298
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4299
4300
					/**
4301
					 * Jetpack registration Success.
4302
					 *
4303
					 * @since 7.5.0
4304
					 *
4305
					 * @param string $from 'from' GET parameter;
4306
					 */
4307
					do_action( 'jetpack_connection_register_success', $from );
4308
4309
					$url = $this->build_connect_url( true, $redirect, $from );
4310
4311
					if ( ! empty( $_GET['onboarding'] ) ) {
4312
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4313
					}
4314
4315
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4316
						$url = add_query_arg( 'auth_approved', 'true', $url );
4317
					}
4318
4319
					wp_redirect( $url );
4320
					exit;
4321
				case 'activate':
4322
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4323
						$error = 'cheatin';
4324
						break;
4325
					}
4326
4327
					$module = stripslashes( $_GET['module'] );
4328
					check_admin_referer( "jetpack_activate-$module" );
4329
					self::log( 'activate', $module );
4330
					if ( ! self::activate_module( $module ) ) {
4331
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4332
					}
4333
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4334
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4335
					exit;
4336
				case 'activate_default_modules':
4337
					check_admin_referer( 'activate_default_modules' );
4338
					self::log( 'activate_default_modules' );
4339
					self::restate();
4340
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4341
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4342
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4343
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4344
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4345
					exit;
4346
				case 'disconnect':
4347
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4348
						$error = 'cheatin';
4349
						break;
4350
					}
4351
4352
					check_admin_referer( 'jetpack-disconnect' );
4353
					self::log( 'disconnect' );
4354
					self::disconnect();
4355
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4356
					exit;
4357
				case 'reconnect':
4358
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4359
						$error = 'cheatin';
4360
						break;
4361
					}
4362
4363
					check_admin_referer( 'jetpack-reconnect' );
4364
					self::log( 'reconnect' );
4365
					$this->disconnect();
4366
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4367
					exit;
4368 View Code Duplication
				case 'deactivate':
4369
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4370
						$error = 'cheatin';
4371
						break;
4372
					}
4373
4374
					$modules = stripslashes( $_GET['module'] );
4375
					check_admin_referer( "jetpack_deactivate-$modules" );
4376
					foreach ( explode( ',', $modules ) as $module ) {
4377
						self::log( 'deactivate', $module );
4378
						self::deactivate_module( $module );
4379
						self::state( 'message', 'module_deactivated' );
4380
					}
4381
					self::state( 'module', $modules );
4382
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4383
					exit;
4384
				case 'unlink':
4385
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4386
					check_admin_referer( 'jetpack-unlink' );
4387
					self::log( 'unlink' );
4388
					Connection_Manager::disconnect_user();
4389
					self::state( 'message', 'unlinked' );
4390
					if ( 'sub-unlink' == $redirect ) {
4391
						wp_safe_redirect( admin_url() );
4392
					} else {
4393
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4394
					}
4395
					exit;
4396
				case 'onboard':
4397
					if ( ! current_user_can( 'manage_options' ) ) {
4398
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4399
					} else {
4400
						self::create_onboarding_token();
4401
						$url = $this->build_connect_url( true );
4402
4403
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4404
							$url = add_query_arg( 'onboarding', $token, $url );
4405
						}
4406
4407
						$calypso_env = $this->get_calypso_env();
4408
						if ( ! empty( $calypso_env ) ) {
4409
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4410
						}
4411
4412
						wp_redirect( $url );
4413
						exit;
4414
					}
4415
					exit;
4416
				default:
4417
					/**
4418
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4419
					 *
4420
					 * @since 2.6.0
4421
					 *
4422
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4423
					 */
4424
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4425
			}
4426
		}
4427
4428
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4429
			self::activate_new_modules( true );
4430
		}
4431
4432
		$message_code = self::state( 'message' );
4433
		if ( self::state( 'optin-manage' ) ) {
4434
			$activated_manage = $message_code;
4435
			$message_code     = 'jetpack-manage';
4436
		}
4437
4438
		switch ( $message_code ) {
4439
			case 'jetpack-manage':
4440
				$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>';
4441
				if ( $activated_manage ) {
4442
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4443
				}
4444
				break;
4445
4446
		}
4447
4448
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4449
4450
		if ( ! empty( $deactivated_plugins ) ) {
4451
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4452
			$deactivated_titles  = array();
4453
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4454
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4455
					continue;
4456
				}
4457
4458
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4459
			}
4460
4461
			if ( $deactivated_titles ) {
4462
				if ( $this->message ) {
4463
					$this->message .= "<br /><br />\n";
4464
				}
4465
4466
				$this->message .= wp_sprintf(
4467
					_n(
4468
						'Jetpack contains the most recent version of the old %l plugin.',
4469
						'Jetpack contains the most recent versions of the old %l plugins.',
4470
						count( $deactivated_titles ),
4471
						'jetpack'
4472
					),
4473
					$deactivated_titles
4474
				);
4475
4476
				$this->message .= "<br />\n";
4477
4478
				$this->message .= _n(
4479
					'The old version has been deactivated and can be removed from your site.',
4480
					'The old versions have been deactivated and can be removed from your site.',
4481
					count( $deactivated_titles ),
4482
					'jetpack'
4483
				);
4484
			}
4485
		}
4486
4487
		$this->privacy_checks = self::state( 'privacy_checks' );
4488
4489
		if ( $this->message || $this->error || $this->privacy_checks ) {
4490
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4491
		}
4492
4493
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4494
	}
4495
4496
	function admin_notices() {
4497
4498
		if ( $this->error ) {
4499
			?>
4500
<div id="message" class="jetpack-message jetpack-err">
4501
	<div class="squeezer">
4502
		<h2>
4503
			<?php
4504
			echo wp_kses(
4505
				$this->error,
4506
				array(
4507
					'a'      => array( 'href' => array() ),
4508
					'small'  => true,
4509
					'code'   => true,
4510
					'strong' => true,
4511
					'br'     => true,
4512
					'b'      => true,
4513
				)
4514
			);
4515
			?>
4516
			</h2>
4517
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4518
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4519
<?php	endif; ?>
4520
	</div>
4521
</div>
4522
			<?php
4523
		}
4524
4525
		if ( $this->message ) {
4526
			?>
4527
<div id="message" class="jetpack-message">
4528
	<div class="squeezer">
4529
		<h2>
4530
			<?php
4531
			echo wp_kses(
4532
				$this->message,
4533
				array(
4534
					'strong' => array(),
4535
					'a'      => array( 'href' => true ),
4536
					'br'     => true,
4537
				)
4538
			);
4539
			?>
4540
			</h2>
4541
	</div>
4542
</div>
4543
			<?php
4544
		}
4545
4546
		if ( $this->privacy_checks ) :
4547
			$module_names = $module_slugs = array();
4548
4549
			$privacy_checks = explode( ',', $this->privacy_checks );
4550
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4551
			foreach ( $privacy_checks as $module_slug ) {
4552
				$module = self::get_module( $module_slug );
4553
				if ( ! $module ) {
4554
					continue;
4555
				}
4556
4557
				$module_slugs[] = $module_slug;
4558
				$module_names[] = "<strong>{$module['name']}</strong>";
4559
			}
4560
4561
			$module_slugs = join( ',', $module_slugs );
4562
			?>
4563
<div id="message" class="jetpack-message jetpack-err">
4564
	<div class="squeezer">
4565
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4566
		<p>
4567
			<?php
4568
			echo wp_kses(
4569
				wptexturize(
4570
					wp_sprintf(
4571
						_nx(
4572
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4573
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4574
							count( $privacy_checks ),
4575
							'%l = list of Jetpack module/feature names',
4576
							'jetpack'
4577
						),
4578
						$module_names
4579
					)
4580
				),
4581
				array( 'strong' => true )
4582
			);
4583
4584
			echo "\n<br />\n";
4585
4586
			echo wp_kses(
4587
				sprintf(
4588
					_nx(
4589
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4590
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4591
						count( $privacy_checks ),
4592
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4593
						'jetpack'
4594
					),
4595
					wp_nonce_url(
4596
						self::admin_url(
4597
							array(
4598
								'page'   => 'jetpack',
4599
								'action' => 'deactivate',
4600
								'module' => urlencode( $module_slugs ),
4601
							)
4602
						),
4603
						"jetpack_deactivate-$module_slugs"
4604
					),
4605
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4606
				),
4607
				array(
4608
					'a' => array(
4609
						'href'  => true,
4610
						'title' => true,
4611
					),
4612
				)
4613
			);
4614
			?>
4615
		</p>
4616
	</div>
4617
</div>
4618
			<?php
4619
endif;
4620
	}
4621
4622
	/**
4623
	 * We can't always respond to a signed XML-RPC request with a
4624
	 * helpful error message. In some circumstances, doing so could
4625
	 * leak information.
4626
	 *
4627
	 * Instead, track that the error occurred via a Jetpack_Option,
4628
	 * and send that data back in the heartbeat.
4629
	 * All this does is increment a number, but it's enough to find
4630
	 * trends.
4631
	 *
4632
	 * @param WP_Error $xmlrpc_error The error produced during
4633
	 *                               signature validation.
4634
	 */
4635
	function track_xmlrpc_error( $xmlrpc_error ) {
4636
		$code = is_wp_error( $xmlrpc_error )
4637
			? $xmlrpc_error->get_error_code()
4638
			: 'should-not-happen';
4639
4640
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4641
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4642
			// No need to update the option if we already have
4643
			// this code stored.
4644
			return;
4645
		}
4646
		$xmlrpc_errors[ $code ] = true;
4647
4648
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
4649
	}
4650
4651
	/**
4652
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4653
	 */
4654
	function stat( $group, $detail ) {
4655
		if ( ! isset( $this->stats[ $group ] ) ) {
4656
			$this->stats[ $group ] = array();
4657
		}
4658
		$this->stats[ $group ][] = $detail;
4659
	}
4660
4661
	/**
4662
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4663
	 */
4664
	function do_stats( $method = '' ) {
4665
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4666
			foreach ( $this->stats as $group => $stats ) {
4667
				if ( is_array( $stats ) && count( $stats ) ) {
4668
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4669
					if ( 'server_side' === $method ) {
4670
						self::do_server_side_stat( $args );
4671
					} else {
4672
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4673
					}
4674
				}
4675
				unset( $this->stats[ $group ] );
4676
			}
4677
		}
4678
	}
4679
4680
	/**
4681
	 * Runs stats code for a one-off, server-side.
4682
	 *
4683
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4684
	 *
4685
	 * @return bool If it worked.
4686
	 */
4687
	static function do_server_side_stat( $args ) {
4688
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4689
		if ( is_wp_error( $response ) ) {
4690
			return false;
4691
		}
4692
4693
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4694
			return false;
4695
		}
4696
4697
		return true;
4698
	}
4699
4700
	/**
4701
	 * Builds the stats url.
4702
	 *
4703
	 * @param $args array|string The arguments to append to the URL.
4704
	 *
4705
	 * @return string The URL to be pinged.
4706
	 */
4707
	static function build_stats_url( $args ) {
4708
		$defaults = array(
4709
			'v'    => 'wpcom2',
4710
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4711
		);
4712
		$args     = wp_parse_args( $args, $defaults );
4713
		/**
4714
		 * Filter the URL used as the Stats tracking pixel.
4715
		 *
4716
		 * @since 2.3.2
4717
		 *
4718
		 * @param string $url Base URL used as the Stats tracking pixel.
4719
		 */
4720
		$base_url = apply_filters(
4721
			'jetpack_stats_base_url',
4722
			'https://pixel.wp.com/g.gif'
4723
		);
4724
		$url      = add_query_arg( $args, $base_url );
4725
		return $url;
4726
	}
4727
4728
	/**
4729
	 * Get the role of the current user.
4730
	 *
4731
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4732
	 *
4733
	 * @access public
4734
	 * @static
4735
	 *
4736
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4737
	 */
4738
	public static function translate_current_user_to_role() {
4739
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4740
4741
		$roles = new Roles();
4742
		return $roles->translate_current_user_to_role();
4743
	}
4744
4745
	/**
4746
	 * Get the role of a particular user.
4747
	 *
4748
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4749
	 *
4750
	 * @access public
4751
	 * @static
4752
	 *
4753
	 * @param \WP_User $user User object.
4754
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4755
	 */
4756
	public static function translate_user_to_role( $user ) {
4757
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4758
4759
		$roles = new Roles();
4760
		return $roles->translate_user_to_role( $user );
4761
	}
4762
4763
	/**
4764
	 * Get the minimum capability for a role.
4765
	 *
4766
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4767
	 *
4768
	 * @access public
4769
	 * @static
4770
	 *
4771
	 * @param string $role Role name.
4772
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4773
	 */
4774
	public static function translate_role_to_cap( $role ) {
4775
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4776
4777
		$roles = new Roles();
4778
		return $roles->translate_role_to_cap( $role );
4779
	}
4780
4781
	/**
4782
	 * Sign a user role with the master access token.
4783
	 * If not specified, will default to the current user.
4784
	 *
4785
	 * @deprecated since 7.7
4786
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4787
	 *
4788
	 * @access public
4789
	 * @static
4790
	 *
4791
	 * @param string $role    User role.
4792
	 * @param int    $user_id ID of the user.
4793
	 * @return string Signed user role.
4794
	 */
4795
	public static function sign_role( $role, $user_id = null ) {
4796
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4797
		return self::connection()->sign_role( $role, $user_id );
4798
	}
4799
4800
	/**
4801
	 * Builds a URL to the Jetpack connection auth page
4802
	 *
4803
	 * @since 3.9.5
4804
	 *
4805
	 * @param bool        $raw If true, URL will not be escaped.
4806
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4807
	 *                              If string, will be a custom redirect.
4808
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4809
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4810
	 *
4811
	 * @return string Connect URL
4812
	 */
4813
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4814
		$site_id    = Jetpack_Options::get_option( 'id' );
4815
		$blog_token = Jetpack_Data::get_access_token();
4816
4817
		if ( $register || ! $blog_token || ! $site_id ) {
4818
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4819
4820
			if ( ! empty( $redirect ) ) {
4821
				$url = add_query_arg(
4822
					'redirect',
4823
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4824
					$url
4825
				);
4826
			}
4827
4828
			if ( is_network_admin() ) {
4829
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4830
			}
4831
4832
			$calypso_env = self::get_calypso_env();
4833
4834
			if ( ! empty( $calypso_env ) ) {
4835
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4836
			}
4837
		} else {
4838
4839
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4840
			// because otherwise this logic can get us in to a loop.
4841
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4842
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4843
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4844
4845
				$response = Client::wpcom_json_api_request_as_blog(
4846
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4847
					'1.1'
4848
				);
4849
4850
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4851
4852
					// Generating a register URL instead to refresh the existing token
4853
					return $this->build_connect_url( $raw, $redirect, $from, true );
4854
				}
4855
			}
4856
4857
			$url = $this->build_authorize_url( $redirect );
4858
		}
4859
4860
		if ( $from ) {
4861
			$url = add_query_arg( 'from', $from, $url );
4862
		}
4863
4864
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4865
		/**
4866
		 * Filter the URL used when connecting a user to a WordPress.com account.
4867
		 *
4868
		 * @since 8.1.0
4869
		 *
4870
		 * @param string $url Connection URL.
4871
		 * @param bool   $raw If true, URL will not be escaped.
4872
		 */
4873
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4874
	}
4875
4876
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4877
4878
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4879
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4880
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4881
4882
		if ( $iframe ) {
4883
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4884
		}
4885
4886
		$c8n = self::connection();
4887
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
4888
4889
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4890
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4891
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4892
4893
		if ( $iframe ) {
4894
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4895
		}
4896
4897
		return $url;
4898
	}
4899
4900
	/**
4901
	 * Filters the connection URL parameter array.
4902
	 *
4903
	 * @param Array $args default URL parameters used by the package.
4904
	 * @return Array the modified URL arguments array.
4905
	 */
4906
	public static function filter_connect_request_body( $args ) {
4907
		if (
4908
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4909
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4910
		) {
4911
			$gp_locale = GP_Locales::by_field( 'wp_locale', get_locale() );
4912
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4913
				? $gp_locale->slug
4914
				: '';
4915
		}
4916
4917
		$tracking        = new Tracking();
4918
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4919
4920
		$args = array_merge(
4921
			$args,
4922
			array(
4923
				'_ui' => $tracks_identity['_ui'],
4924
				'_ut' => $tracks_identity['_ut'],
4925
			)
4926
		);
4927
4928
		$calypso_env = self::get_calypso_env();
4929
4930
		if ( ! empty( $calypso_env ) ) {
4931
			$args['calypso_env'] = $calypso_env;
4932
		}
4933
4934
		return $args;
4935
	}
4936
4937
	/**
4938
	 * Filters the URL that will process the connection data. It can be different from the URL
4939
	 * that we send the user to after everything is done.
4940
	 *
4941
	 * @param String $processing_url the default redirect URL used by the package.
4942
	 * @return String the modified URL.
4943
	 */
4944
	public static function filter_connect_processing_url( $processing_url ) {
4945
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4946
		return $processing_url;
4947
	}
4948
4949
	/**
4950
	 * Filters the redirection URL that is used for connect requests. The redirect
4951
	 * URL should return the user back to the Jetpack console.
4952
	 *
4953
	 * @param String $redirect the default redirect URL used by the package.
4954
	 * @return String the modified URL.
4955
	 */
4956
	public static function filter_connect_redirect_url( $redirect ) {
4957
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4958
		$redirect           = $redirect
4959
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4960
			: $jetpack_admin_page;
4961
4962
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4963
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4964
		}
4965
4966
		return $redirect;
4967
	}
4968
4969
	/**
4970
	 * This action fires at the beginning of the Manager::authorize method.
4971
	 */
4972
	public static function authorize_starting() {
4973
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4974
		// Checking if site has been active/connected previously before recording unique connection.
4975
		if ( ! $jetpack_unique_connection ) {
4976
			// jetpack_unique_connection option has never been set.
4977
			$jetpack_unique_connection = array(
4978
				'connected'    => 0,
4979
				'disconnected' => 0,
4980
				'version'      => '3.6.1',
4981
			);
4982
4983
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4984
4985
			// Track unique connection.
4986
			$jetpack = self::init();
4987
4988
			$jetpack->stat( 'connections', 'unique-connection' );
4989
			$jetpack->do_stats( 'server_side' );
4990
		}
4991
4992
		// Increment number of times connected.
4993
		$jetpack_unique_connection['connected'] += 1;
4994
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4995
	}
4996
4997
	/**
4998
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4999
	 * linked.
5000
	 */
5001
	public static function authorize_ending_linked() {
5002
		// Don't activate anything since we are just connecting a user.
5003
		self::state( 'message', 'linked' );
5004
	}
5005
5006
	/**
5007
	 * This action fires at the end of the Manager::authorize method when the master user is
5008
	 * authorized.
5009
	 *
5010
	 * @param array $data The request data.
5011
	 */
5012
	public static function authorize_ending_authorized( $data ) {
5013
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
5014
		self::invalidate_onboarding_token();
5015
5016
		// If redirect_uri is SSO, ensure SSO module is enabled.
5017
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
5018
5019
		/** This filter is documented in class.jetpack-cli.php */
5020
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
5021
5022
		$activate_sso = (
5023
			isset( $redirect_options['action'] ) &&
5024
			'jetpack-sso' === $redirect_options['action'] &&
5025
			$jetpack_start_enable_sso
5026
		);
5027
5028
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
5029
5030
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
5031
	}
5032
5033
	/**
5034
	 * Get our assumed site creation date.
5035
	 * Calculated based on the earlier date of either:
5036
	 * - Earliest admin user registration date.
5037
	 * - Earliest date of post of any post type.
5038
	 *
5039
	 * @since 7.2.0
5040
	 * @deprecated since 7.8.0
5041
	 *
5042
	 * @return string Assumed site creation date and time.
5043
	 */
5044
	public static function get_assumed_site_creation_date() {
5045
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
5046
		return self::connection()->get_assumed_site_creation_date();
5047
	}
5048
5049 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
5050
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
5051
5052
		if ( $activation_source_name ) {
5053
			$args['_as'] = urlencode( $activation_source_name );
5054
		}
5055
5056
		if ( $activation_source_keyword ) {
5057
			$args['_ak'] = urlencode( $activation_source_keyword );
5058
		}
5059
	}
5060
5061
	function build_reconnect_url( $raw = false ) {
5062
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
5063
		return $raw ? $url : esc_url( $url );
5064
	}
5065
5066
	public static function admin_url( $args = null ) {
5067
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
5068
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5069
		return $url;
5070
	}
5071
5072
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5073
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5074
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5075
	}
5076
5077
	function dismiss_jetpack_notice() {
5078
5079
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5080
			return;
5081
		}
5082
5083
		switch ( $_GET['jetpack-notice'] ) {
5084
			case 'dismiss':
5085
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5086
5087
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5088
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5089
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5090
				}
5091
				break;
5092
		}
5093
	}
5094
5095
	public static function sort_modules( $a, $b ) {
5096
		if ( $a['sort'] == $b['sort'] ) {
5097
			return 0;
5098
		}
5099
5100
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5101
	}
5102
5103
	function ajax_recheck_ssl() {
5104
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5105
		$result = self::permit_ssl( true );
5106
		wp_send_json(
5107
			array(
5108
				'enabled' => $result,
5109
				'message' => get_transient( 'jetpack_https_test_message' ),
5110
			)
5111
		);
5112
	}
5113
5114
	/* Client API */
5115
5116
	/**
5117
	 * Returns the requested Jetpack API URL
5118
	 *
5119
	 * @deprecated since 7.7
5120
	 * @return string
5121
	 */
5122
	public static function api_url( $relative_url ) {
5123
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5124
		$connection = self::connection();
5125
		return $connection->api_url( $relative_url );
5126
	}
5127
5128
	/**
5129
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5130
	 *
5131
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5132
	 */
5133
	public static function fix_url_for_bad_hosts( $url ) {
5134
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5135
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5136
	}
5137
5138
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5139
		// Default to a blog token.
5140
		$token_type = 'blog';
5141
5142
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5143
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5144
			if ( ! empty( $_GET['onboarding'] ) ) {
5145
				$jpo = $_GET;
5146
			} else {
5147
				$jpo = json_decode( $request_data, true );
5148
			}
5149
5150
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5151
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5152
5153
			if (
5154
				isset( $jpo_user )
5155
				&& isset( $jpo_token )
5156
				&& is_email( $jpo_user )
5157
				&& ctype_alnum( $jpo_token )
5158
				&& isset( $_GET['rest_route'] )
5159
				&& self::validate_onboarding_token_action(
5160
					$jpo_token,
5161
					$_GET['rest_route']
5162
				)
5163
			) {
5164
				$jp_user = get_user_by( 'email', $jpo_user );
5165
				if ( is_a( $jp_user, 'WP_User' ) ) {
5166
					wp_set_current_user( $jp_user->ID );
5167
					$user_can = is_multisite()
5168
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5169
						: current_user_can( 'manage_options' );
5170
					if ( $user_can ) {
5171
						$token_type              = 'user';
5172
						$token->external_user_id = $jp_user->ID;
5173
					}
5174
				}
5175
			}
5176
5177
			$token_data['type']    = $token_type;
5178
			$token_data['user_id'] = $token->external_user_id;
5179
		}
5180
5181
		return $token_data;
5182
	}
5183
5184
	/**
5185
	 * Create a random secret for validating onboarding payload
5186
	 *
5187
	 * @return string Secret token
5188
	 */
5189
	public static function create_onboarding_token() {
5190
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5191
			$token = wp_generate_password( 32, false );
5192
			Jetpack_Options::update_option( 'onboarding', $token );
5193
		}
5194
5195
		return $token;
5196
	}
5197
5198
	/**
5199
	 * Remove the onboarding token
5200
	 *
5201
	 * @return bool True on success, false on failure
5202
	 */
5203
	public static function invalidate_onboarding_token() {
5204
		return Jetpack_Options::delete_option( 'onboarding' );
5205
	}
5206
5207
	/**
5208
	 * Validate an onboarding token for a specific action
5209
	 *
5210
	 * @return boolean True if token/action pair is accepted, false if not
5211
	 */
5212
	public static function validate_onboarding_token_action( $token, $action ) {
5213
		// Compare tokens, bail if tokens do not match
5214
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5215
			return false;
5216
		}
5217
5218
		// List of valid actions we can take
5219
		$valid_actions = array(
5220
			'/jetpack/v4/settings',
5221
		);
5222
5223
		// Whitelist the action
5224
		if ( ! in_array( $action, $valid_actions ) ) {
5225
			return false;
5226
		}
5227
5228
		return true;
5229
	}
5230
5231
	/**
5232
	 * Checks to see if the URL is using SSL to connect with Jetpack
5233
	 *
5234
	 * @since 2.3.3
5235
	 * @return boolean
5236
	 */
5237
	public static function permit_ssl( $force_recheck = false ) {
5238
		// Do some fancy tests to see if ssl is being supported
5239
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5240
			$message = '';
5241
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5242
				$ssl = 0;
5243
			} else {
5244
				switch ( JETPACK_CLIENT__HTTPS ) {
5245
					case 'NEVER':
5246
						$ssl     = 0;
5247
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5248
						break;
5249
					case 'ALWAYS':
5250
					case 'AUTO':
5251
					default:
5252
						$ssl = 1;
5253
						break;
5254
				}
5255
5256
				// If it's not 'NEVER', test to see
5257
				if ( $ssl ) {
5258
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5259
						$ssl     = 0;
5260
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5261
					} else {
5262
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5263
						if ( is_wp_error( $response ) ) {
5264
							$ssl     = 0;
5265
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5266
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5267
							$ssl     = 0;
5268
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5269
						}
5270
					}
5271
				}
5272
			}
5273
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5274
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5275
		}
5276
5277
		return (bool) $ssl;
5278
	}
5279
5280
	/*
5281
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5282
	 */
5283
	public function alert_auto_ssl_fail() {
5284
		if ( ! current_user_can( 'manage_options' ) ) {
5285
			return;
5286
		}
5287
5288
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5289
		?>
5290
5291
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5292
			<div class="jp-banner__content">
5293
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5294
				<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>
5295
				<p>
5296
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5297
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5298
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5299
				</p>
5300
				<p>
5301
					<?php
5302
					printf(
5303
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5304
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5305
						esc_url( 'https://jetpack.com/support/getting-started-with-jetpack/troubleshooting-tips/' )
5306
					);
5307
					?>
5308
				</p>
5309
			</div>
5310
		</div>
5311
		<style>
5312
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5313
		</style>
5314
		<script type="text/javascript">
5315
			jQuery( document ).ready( function( $ ) {
5316
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5317
					var $this = $( this );
5318
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5319
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5320
					e.preventDefault();
5321
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5322
					$.post( ajaxurl, data )
5323
					  .done( function( response ) {
5324
						  if ( response.enabled ) {
5325
							  $( '#jetpack-ssl-warning' ).hide();
5326
						  } else {
5327
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5328
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5329
						  }
5330
					  }.bind( $this ) );
5331
				} );
5332
			} );
5333
		</script>
5334
5335
		<?php
5336
	}
5337
5338
	/**
5339
	 * Returns the Jetpack XML-RPC API
5340
	 *
5341
	 * @deprecated 8.0 Use Connection_Manager instead.
5342
	 * @return string
5343
	 */
5344
	public static function xmlrpc_api_url() {
5345
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5346
		return self::connection()->xmlrpc_api_url();
5347
	}
5348
5349
	/**
5350
	 * Returns the connection manager object.
5351
	 *
5352
	 * @return Automattic\Jetpack\Connection\Manager
5353
	 */
5354
	public static function connection() {
5355
		$jetpack = static::init();
5356
5357
		// If the connection manager hasn't been instantiated, do that now.
5358
		if ( ! $jetpack->connection_manager ) {
5359
			$jetpack->connection_manager = new Connection_Manager();
5360
		}
5361
5362
		return $jetpack->connection_manager;
5363
	}
5364
5365
	/**
5366
	 * Creates two secret tokens and the end of life timestamp for them.
5367
	 *
5368
	 * Note these tokens are unique per call, NOT static per site for connecting.
5369
	 *
5370
	 * @since 2.6
5371
	 * @param String  $action  The action name.
5372
	 * @param Integer $user_id The user identifier.
5373
	 * @param Integer $exp     Expiration time in seconds.
5374
	 * @return array
5375
	 */
5376
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5377
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5378
	}
5379
5380
	public static function get_secrets( $action, $user_id ) {
5381
		$secrets = self::connection()->get_secrets( $action, $user_id );
5382
5383
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5384
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5385
		}
5386
5387
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5388
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5389
		}
5390
5391
		return $secrets;
5392
	}
5393
5394
	/**
5395
	 * @deprecated 7.5 Use Connection_Manager instead.
5396
	 *
5397
	 * @param $action
5398
	 * @param $user_id
5399
	 */
5400
	public static function delete_secrets( $action, $user_id ) {
5401
		return self::connection()->delete_secrets( $action, $user_id );
5402
	}
5403
5404
	/**
5405
	 * Builds the timeout limit for queries talking with the wpcom servers.
5406
	 *
5407
	 * Based on local php max_execution_time in php.ini
5408
	 *
5409
	 * @since 2.6
5410
	 * @return int
5411
	 * @deprecated
5412
	 **/
5413
	public function get_remote_query_timeout_limit() {
5414
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5415
		return self::get_max_execution_time();
5416
	}
5417
5418
	/**
5419
	 * Builds the timeout limit for queries talking with the wpcom servers.
5420
	 *
5421
	 * Based on local php max_execution_time in php.ini
5422
	 *
5423
	 * @since 5.4
5424
	 * @return int
5425
	 **/
5426
	public static function get_max_execution_time() {
5427
		$timeout = (int) ini_get( 'max_execution_time' );
5428
5429
		// Ensure exec time set in php.ini
5430
		if ( ! $timeout ) {
5431
			$timeout = 30;
5432
		}
5433
		return $timeout;
5434
	}
5435
5436
	/**
5437
	 * Sets a minimum request timeout, and returns the current timeout
5438
	 *
5439
	 * @since 5.4
5440
	 **/
5441 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5442
		$timeout = self::get_max_execution_time();
5443
		if ( $timeout < $min_timeout ) {
5444
			$timeout = $min_timeout;
5445
			set_time_limit( $timeout );
5446
		}
5447
		return $timeout;
5448
	}
5449
5450
	/**
5451
	 * Takes the response from the Jetpack register new site endpoint and
5452
	 * verifies it worked properly.
5453
	 *
5454
	 * @since 2.6
5455
	 * @deprecated since 7.7.0
5456
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5457
	 **/
5458
	public function validate_remote_register_response() {
5459
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5460
	}
5461
5462
	/**
5463
	 * @return bool|WP_Error
5464
	 */
5465
	public static function register() {
5466
		$tracking = new Tracking();
5467
		$tracking->record_user_event( 'jpc_register_begin' );
5468
5469
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5470
5471
		$connection   = self::connection();
5472
		$registration = $connection->register();
5473
5474
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5475
5476
		if ( ! $registration || is_wp_error( $registration ) ) {
5477
			return $registration;
5478
		}
5479
5480
		return true;
5481
	}
5482
5483
	/**
5484
	 * Filters the registration request body to include tracking properties.
5485
	 *
5486
	 * @param Array $properties
5487
	 * @return Array amended properties.
5488
	 */
5489 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5490
		$tracking        = new Tracking();
5491
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5492
5493
		return array_merge(
5494
			$properties,
5495
			array(
5496
				'_ui' => $tracks_identity['_ui'],
5497
				'_ut' => $tracks_identity['_ut'],
5498
			)
5499
		);
5500
	}
5501
5502
	/**
5503
	 * Filters the token request body to include tracking properties.
5504
	 *
5505
	 * @param Array $properties
5506
	 * @return Array amended properties.
5507
	 */
5508 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5509
		$tracking        = new Tracking();
5510
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5511
5512
		return array_merge(
5513
			$properties,
5514
			array(
5515
				'_ui' => $tracks_identity['_ui'],
5516
				'_ut' => $tracks_identity['_ut'],
5517
			)
5518
		);
5519
	}
5520
5521
	/**
5522
	 * If the db version is showing something other that what we've got now, bump it to current.
5523
	 *
5524
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
5525
	 */
5526
	public static function maybe_set_version_option() {
5527
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5528
		if ( JETPACK__VERSION != $version ) {
5529
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5530
5531
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5532
				/** This action is documented in class.jetpack.php */
5533
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5534
			}
5535
5536
			return true;
5537
		}
5538
		return false;
5539
	}
5540
5541
	/* Client Server API */
5542
5543
	/**
5544
	 * Loads the Jetpack XML-RPC client.
5545
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5546
	 *
5547
	 * @deprecated since 7.7.0
5548
	 */
5549
	public static function load_xml_rpc_client() {
5550
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5551
	}
5552
5553
	/**
5554
	 * Resets the saved authentication state in between testing requests.
5555
	 */
5556
	public function reset_saved_auth_state() {
5557
		$this->rest_authentication_status = null;
5558
5559
		if ( ! $this->connection_manager ) {
5560
			$this->connection_manager = new Connection_Manager();
5561
		}
5562
5563
		$this->connection_manager->reset_saved_auth_state();
5564
	}
5565
5566
	/**
5567
	 * Verifies the signature of the current request.
5568
	 *
5569
	 * @deprecated since 7.7.0
5570
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5571
	 *
5572
	 * @return false|array
5573
	 */
5574
	public function verify_xml_rpc_signature() {
5575
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5576
		return self::connection()->verify_xml_rpc_signature();
5577
	}
5578
5579
	/**
5580
	 * Verifies the signature of the current request.
5581
	 *
5582
	 * This function has side effects and should not be used. Instead,
5583
	 * use the memoized version `->verify_xml_rpc_signature()`.
5584
	 *
5585
	 * @deprecated since 7.7.0
5586
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5587
	 * @internal
5588
	 */
5589
	private function internal_verify_xml_rpc_signature() {
5590
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5591
	}
5592
5593
	/**
5594
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5595
	 *
5596
	 * @deprecated since 7.7.0
5597
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5598
	 *
5599
	 * @param \WP_User|mixed $user     User object if authenticated.
5600
	 * @param string         $username Username.
5601
	 * @param string         $password Password string.
5602
	 * @return \WP_User|mixed Authenticated user or error.
5603
	 */
5604 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5605
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5606
5607
		if ( ! $this->connection_manager ) {
5608
			$this->connection_manager = new Connection_Manager();
5609
		}
5610
5611
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5612
	}
5613
5614
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5615
	// Uses the existing XMLRPC request signing implementation.
5616
	function wp_rest_authenticate( $user ) {
5617
		if ( ! empty( $user ) ) {
5618
			// Another authentication method is in effect.
5619
			return $user;
5620
		}
5621
5622
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5623
			// Nothing to do for this authentication method.
5624
			return null;
5625
		}
5626
5627
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5628
			// Nothing to do for this authentication method.
5629
			return null;
5630
		}
5631
5632
		// Ensure that we always have the request body available.  At this
5633
		// point, the WP REST API code to determine the request body has not
5634
		// run yet.  That code may try to read from 'php://input' later, but
5635
		// this can only be done once per request in PHP versions prior to 5.6.
5636
		// So we will go ahead and perform this read now if needed, and save
5637
		// the request body where both the Jetpack signature verification code
5638
		// and the WP REST API code can see it.
5639
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5640
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5641
		}
5642
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5643
5644
		// Only support specific request parameters that have been tested and
5645
		// are known to work with signature verification.  A different method
5646
		// can be passed to the WP REST API via the '?_method=' parameter if
5647
		// needed.
5648
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5649
			$this->rest_authentication_status = new WP_Error(
5650
				'rest_invalid_request',
5651
				__( 'This request method is not supported.', 'jetpack' ),
5652
				array( 'status' => 400 )
5653
			);
5654
			return null;
5655
		}
5656
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5657
			$this->rest_authentication_status = new WP_Error(
5658
				'rest_invalid_request',
5659
				__( 'This request method does not support body parameters.', 'jetpack' ),
5660
				array( 'status' => 400 )
5661
			);
5662
			return null;
5663
		}
5664
5665
		if ( ! $this->connection_manager ) {
5666
			$this->connection_manager = new Connection_Manager();
5667
		}
5668
5669
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5670
5671
		if (
5672
			$verified &&
5673
			isset( $verified['type'] ) &&
5674
			'user' === $verified['type'] &&
5675
			! empty( $verified['user_id'] )
5676
		) {
5677
			// Authentication successful.
5678
			$this->rest_authentication_status = true;
5679
			return $verified['user_id'];
5680
		}
5681
5682
		// Something else went wrong.  Probably a signature error.
5683
		$this->rest_authentication_status = new WP_Error(
5684
			'rest_invalid_signature',
5685
			__( 'The request is not signed correctly.', 'jetpack' ),
5686
			array( 'status' => 400 )
5687
		);
5688
		return null;
5689
	}
5690
5691
	/**
5692
	 * Report authentication status to the WP REST API.
5693
	 *
5694
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5695
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5696
	 */
5697
	public function wp_rest_authentication_errors( $value ) {
5698
		if ( $value !== null ) {
5699
			return $value;
5700
		}
5701
		return $this->rest_authentication_status;
5702
	}
5703
5704
	/**
5705
	 * Add our nonce to this request.
5706
	 *
5707
	 * @deprecated since 7.7.0
5708
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5709
	 *
5710
	 * @param int    $timestamp Timestamp of the request.
5711
	 * @param string $nonce     Nonce string.
5712
	 */
5713 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5714
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5715
5716
		if ( ! $this->connection_manager ) {
5717
			$this->connection_manager = new Connection_Manager();
5718
		}
5719
5720
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5721
	}
5722
5723
	/**
5724
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5725
	 * Capture it here so we can verify the signature later.
5726
	 *
5727
	 * @deprecated since 7.7.0
5728
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5729
	 *
5730
	 * @param array $methods XMLRPC methods.
5731
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5732
	 */
5733 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5734
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5735
5736
		if ( ! $this->connection_manager ) {
5737
			$this->connection_manager = new Connection_Manager();
5738
		}
5739
5740
		return $this->connection_manager->xmlrpc_methods( $methods );
5741
	}
5742
5743
	/**
5744
	 * Register additional public XMLRPC methods.
5745
	 *
5746
	 * @deprecated since 7.7.0
5747
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5748
	 *
5749
	 * @param array $methods Public XMLRPC methods.
5750
	 * @return array Public XMLRPC methods, with the getOptions one.
5751
	 */
5752 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5753
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5754
5755
		if ( ! $this->connection_manager ) {
5756
			$this->connection_manager = new Connection_Manager();
5757
		}
5758
5759
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5760
	}
5761
5762
	/**
5763
	 * Handles a getOptions XMLRPC method call.
5764
	 *
5765
	 * @deprecated since 7.7.0
5766
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5767
	 *
5768
	 * @param array $args method call arguments.
5769
	 * @return array an amended XMLRPC server options array.
5770
	 */
5771 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5772
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5773
5774
		if ( ! $this->connection_manager ) {
5775
			$this->connection_manager = new Connection_Manager();
5776
		}
5777
5778
		return $this->connection_manager->jetpack_getOptions( $args );
5779
	}
5780
5781
	/**
5782
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5783
	 *
5784
	 * @deprecated since 7.7.0
5785
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5786
	 *
5787
	 * @param array $options Standard Core options.
5788
	 * @return array Amended options.
5789
	 */
5790 View Code Duplication
	public function xmlrpc_options( $options ) {
5791
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5792
5793
		if ( ! $this->connection_manager ) {
5794
			$this->connection_manager = new Connection_Manager();
5795
		}
5796
5797
		return $this->connection_manager->xmlrpc_options( $options );
5798
	}
5799
5800
	/**
5801
	 * Cleans nonces that were saved when calling ::add_nonce.
5802
	 *
5803
	 * @deprecated since 7.7.0
5804
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5805
	 *
5806
	 * @param bool $all whether to clean even non-expired nonces.
5807
	 */
5808
	public static function clean_nonces( $all = false ) {
5809
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5810
		return self::connection()->clean_nonces( $all );
5811
	}
5812
5813
	/**
5814
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5815
	 * SET: state( $key, $value );
5816
	 * GET: $value = state( $key );
5817
	 *
5818
	 * @param string $key
5819
	 * @param string $value
5820
	 * @param bool   $restate private
5821
	 */
5822
	public static function state( $key = null, $value = null, $restate = false ) {
5823
		static $state = array();
5824
		static $path, $domain;
5825
		if ( ! isset( $path ) ) {
5826
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5827
			$admin_url = self::admin_url();
5828
			$bits      = wp_parse_url( $admin_url );
5829
5830
			if ( is_array( $bits ) ) {
5831
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5832
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5833
			} else {
5834
				$path = $domain = null;
5835
			}
5836
		}
5837
5838
		// Extract state from cookies and delete cookies
5839
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5840
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5841
			unset( $_COOKIE['jetpackState'] );
5842
			foreach ( $yum as $k => $v ) {
5843
				if ( strlen( $v ) ) {
5844
					$state[ $k ] = $v;
5845
				}
5846
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5847
			}
5848
		}
5849
5850
		if ( $restate ) {
5851
			foreach ( $state as $k => $v ) {
5852
				if ( 'message_content' !== $k ) {
5853
					setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5854
				}
5855
			}
5856
			return;
5857
		}
5858
5859
		// Get a state variable.
5860
		if ( isset( $key ) && ! isset( $value ) ) {
5861
			if ( array_key_exists( $key, $state ) ) {
5862
				return $state[ $key ];
5863
			}
5864
			return null;
5865
		}
5866
5867
		// Set a state variable.
5868
		if ( isset( $key ) && isset( $value ) ) {
5869
			if ( is_array( $value ) && isset( $value[0] ) ) {
5870
				$value = $value[0];
5871
			}
5872
			$state[ $key ] = $value;
5873
			if ( 'message_content' !== $key && ! headers_sent() ) {
5874
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5875
			}
5876
		}
5877
	}
5878
5879
	public static function restate() {
5880
		self::state( null, null, true );
5881
	}
5882
5883
	public static function check_privacy( $file ) {
5884
		static $is_site_publicly_accessible = null;
5885
5886
		if ( is_null( $is_site_publicly_accessible ) ) {
5887
			$is_site_publicly_accessible = false;
5888
5889
			$rpc = new Jetpack_IXR_Client();
5890
5891
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5892
			if ( $success ) {
5893
				$response = $rpc->getResponse();
5894
				if ( $response ) {
5895
					$is_site_publicly_accessible = true;
5896
				}
5897
			}
5898
5899
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5900
		}
5901
5902
		if ( $is_site_publicly_accessible ) {
5903
			return;
5904
		}
5905
5906
		$module_slug = self::get_module_slug( $file );
5907
5908
		$privacy_checks = self::state( 'privacy_checks' );
5909
		if ( ! $privacy_checks ) {
5910
			$privacy_checks = $module_slug;
5911
		} else {
5912
			$privacy_checks .= ",$module_slug";
5913
		}
5914
5915
		self::state( 'privacy_checks', $privacy_checks );
5916
	}
5917
5918
	/**
5919
	 * Helper method for multicall XMLRPC.
5920
	 *
5921
	 * @param ...$args Args for the async_call.
5922
	 */
5923
	public static function xmlrpc_async_call( ...$args ) {
5924
		global $blog_id;
5925
		static $clients = array();
5926
5927
		$client_blog_id = is_multisite() ? $blog_id : 0;
5928
5929
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5930
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5931
			if ( function_exists( 'ignore_user_abort' ) ) {
5932
				ignore_user_abort( true );
5933
			}
5934
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5935
		}
5936
5937
		if ( ! empty( $args[0] ) ) {
5938
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5939
		} elseif ( is_multisite() ) {
5940
			foreach ( $clients as $client_blog_id => $client ) {
5941
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5942
					continue;
5943
				}
5944
5945
				$switch_success = switch_to_blog( $client_blog_id, true );
5946
				if ( ! $switch_success ) {
5947
					continue;
5948
				}
5949
5950
				flush();
5951
				$client->query();
5952
5953
				restore_current_blog();
5954
			}
5955
		} else {
5956
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5957
				flush();
5958
				$clients[0]->query();
5959
			}
5960
		}
5961
	}
5962
5963
	public static function staticize_subdomain( $url ) {
5964
5965
		// Extract hostname from URL
5966
		$host = wp_parse_url( $url, PHP_URL_HOST );
5967
5968
		// Explode hostname on '.'
5969
		$exploded_host = explode( '.', $host );
5970
5971
		// Retrieve the name and TLD
5972
		if ( count( $exploded_host ) > 1 ) {
5973
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5974
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5975
			// Rebuild domain excluding subdomains
5976
			$domain = $name . '.' . $tld;
5977
		} else {
5978
			$domain = $host;
5979
		}
5980
		// Array of Automattic domains
5981
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5982
5983
		// Return $url if not an Automattic domain
5984
		if ( ! in_array( $domain, $domain_whitelist ) ) {
5985
			return $url;
5986
		}
5987
5988
		if ( is_ssl() ) {
5989
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5990
		}
5991
5992
		srand( crc32( basename( $url ) ) );
5993
		$static_counter = rand( 0, 2 );
5994
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5995
5996
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5997
	}
5998
5999
	/* JSON API Authorization */
6000
6001
	/**
6002
	 * Handles the login action for Authorizing the JSON API
6003
	 */
6004
	function login_form_json_api_authorization() {
6005
		$this->verify_json_api_authorization_request();
6006
6007
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
6008
6009
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
6010
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6011
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6012
	}
6013
6014
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6015
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6016
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6017
			return $url;
6018
		}
6019
6020
		$parsed_url = wp_parse_url( $url );
6021
		$url        = strtok( $url, '?' );
6022
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
6023
		if ( ! empty( $parsed_url['query'] ) ) {
6024
			$url .= "&{$parsed_url['query']}";
6025
		}
6026
6027
		return $url;
6028
	}
6029
6030
	// Make sure the POSTed request is handled by the same action
6031
	function preserve_action_in_login_form_for_json_api_authorization() {
6032
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6033
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6034
	}
6035
6036
	// If someone logs in to approve API access, store the Access Code in usermeta
6037
	function store_json_api_authorization_token( $user_login, $user ) {
6038
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6039
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6040
		$token = wp_generate_password( 32, false );
6041
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6042
	}
6043
6044
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6045
	function allow_wpcom_public_api_domain( $domains ) {
6046
		$domains[] = 'public-api.wordpress.com';
6047
		return $domains;
6048
	}
6049
6050
	static function is_redirect_encoded( $redirect_url ) {
6051
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
6052
	}
6053
6054
	// Add all wordpress.com environments to the safe redirect whitelist
6055
	function allow_wpcom_environments( $domains ) {
6056
		$domains[] = 'wordpress.com';
6057
		$domains[] = 'wpcalypso.wordpress.com';
6058
		$domains[] = 'horizon.wordpress.com';
6059
		$domains[] = 'calypso.localhost';
6060
		return $domains;
6061
	}
6062
6063
	// Add the Access Code details to the public-api.wordpress.com redirect
6064
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6065
		return add_query_arg(
6066
			urlencode_deep(
6067
				array(
6068
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6069
					'jetpack-user-id' => (int) $user->ID,
6070
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6071
				)
6072
			),
6073
			$redirect_to
6074
		);
6075
	}
6076
6077
6078
	/**
6079
	 * Verifies the request by checking the signature
6080
	 *
6081
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6082
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6083
	 *
6084
	 * @param null|array $environment
6085
	 */
6086
	function verify_json_api_authorization_request( $environment = null ) {
6087
		$environment = is_null( $environment )
6088
			? $_REQUEST
6089
			: $environment;
6090
6091
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
6092
		$token                                     = Jetpack_Data::get_access_token( $envUserId, $envToken );
6093
		if ( ! $token || empty( $token->secret ) ) {
6094
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6095
		}
6096
6097
		$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' );
6098
6099
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6100
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6101
			/**
6102
			 * Jetpack authorisation request Error.
6103
			 *
6104
			 * @since 7.5.0
6105
			 */
6106
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6107
			$die_error = sprintf(
6108
				/* translators: %s is a URL */
6109
				__( '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' ),
6110
				'https://jetpack.com/support/double-encoding/'
6111
			);
6112
		}
6113
6114
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6115
6116
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6117
			$signature = $jetpack_signature->sign_request(
6118
				$environment['token'],
6119
				$environment['timestamp'],
6120
				$environment['nonce'],
6121
				'',
6122
				'GET',
6123
				$environment['jetpack_json_api_original_query'],
6124
				null,
6125
				true
6126
			);
6127
		} else {
6128
			$signature = $jetpack_signature->sign_current_request(
6129
				array(
6130
					'body'   => null,
6131
					'method' => 'GET',
6132
				)
6133
			);
6134
		}
6135
6136
		if ( ! $signature ) {
6137
			wp_die( $die_error );
6138
		} elseif ( is_wp_error( $signature ) ) {
6139
			wp_die( $die_error );
6140
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6141
			if ( is_ssl() ) {
6142
				// 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
6143
				$signature = $jetpack_signature->sign_current_request(
6144
					array(
6145
						'scheme' => 'http',
6146
						'body'   => null,
6147
						'method' => 'GET',
6148
					)
6149
				);
6150
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6151
					wp_die( $die_error );
6152
				}
6153
			} else {
6154
				wp_die( $die_error );
6155
			}
6156
		}
6157
6158
		$timestamp = (int) $environment['timestamp'];
6159
		$nonce     = stripslashes( (string) $environment['nonce'] );
6160
6161
		if ( ! $this->connection_manager ) {
6162
			$this->connection_manager = new Connection_Manager();
6163
		}
6164
6165
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6166
			// De-nonce the nonce, at least for 5 minutes.
6167
			// 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)
6168
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6169
			if ( $old_nonce_time < time() - 300 ) {
6170
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6171
			}
6172
		}
6173
6174
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6175
		$data_filters = array(
6176
			'state'        => 'opaque',
6177
			'client_id'    => 'int',
6178
			'client_title' => 'string',
6179
			'client_image' => 'url',
6180
		);
6181
6182
		foreach ( $data_filters as $key => $sanitation ) {
6183
			if ( ! isset( $data->$key ) ) {
6184
				wp_die( $die_error );
6185
			}
6186
6187
			switch ( $sanitation ) {
6188
				case 'int':
6189
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6190
					break;
6191
				case 'opaque':
6192
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6193
					break;
6194
				case 'string':
6195
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6196
					break;
6197
				case 'url':
6198
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6199
					break;
6200
			}
6201
		}
6202
6203
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6204
			wp_die( $die_error );
6205
		}
6206
	}
6207
6208
	function login_message_json_api_authorization( $message ) {
6209
		return '<p class="message">' . sprintf(
6210
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6211
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6212
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6213
	}
6214
6215
	/**
6216
	 * Get $content_width, but with a <s>twist</s> filter.
6217
	 */
6218
	public static function get_content_width() {
6219
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6220
			? $GLOBALS['content_width']
6221
			: false;
6222
		/**
6223
		 * Filter the Content Width value.
6224
		 *
6225
		 * @since 2.2.3
6226
		 *
6227
		 * @param string $content_width Content Width value.
6228
		 */
6229
		return apply_filters( 'jetpack_content_width', $content_width );
6230
	}
6231
6232
	/**
6233
	 * Pings the WordPress.com Mirror Site for the specified options.
6234
	 *
6235
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6236
	 *
6237
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6238
	 */
6239
	public function get_cloud_site_options( $option_names ) {
6240
		$option_names = array_filter( (array) $option_names, 'is_string' );
6241
6242
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6243
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6244
		if ( $xml->isError() ) {
6245
			return array(
6246
				'error_code' => $xml->getErrorCode(),
6247
				'error_msg'  => $xml->getErrorMessage(),
6248
			);
6249
		}
6250
		$cloud_site_options = $xml->getResponse();
6251
6252
		return $cloud_site_options;
6253
	}
6254
6255
	/**
6256
	 * Checks if the site is currently in an identity crisis.
6257
	 *
6258
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6259
	 */
6260
	public static function check_identity_crisis() {
6261
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6262
			return false;
6263
		}
6264
6265
		return Jetpack_Options::get_option( 'sync_error_idc' );
6266
	}
6267
6268
	/**
6269
	 * Checks whether the home and siteurl specifically are whitelisted
6270
	 * Written so that we don't have re-check $key and $value params every time
6271
	 * we want to check if this site is whitelisted, for example in footer.php
6272
	 *
6273
	 * @since  3.8.0
6274
	 * @return bool True = already whitelisted False = not whitelisted
6275
	 */
6276
	public static function is_staging_site() {
6277
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6278
		return ( new Status() )->is_staging_site();
6279
	}
6280
6281
	/**
6282
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6283
	 *
6284
	 * @since 4.4.0
6285
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6286
	 *
6287
	 * @return bool
6288
	 */
6289
	public static function validate_sync_error_idc_option() {
6290
		$is_valid = false;
6291
6292
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6293
		if ( false === $idc_allowed ) {
6294
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6295
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6296
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6297
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6298
				$transient_duration = HOUR_IN_SECONDS;
6299
			} else {
6300
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6301
				$idc_allowed        = '1';
6302
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6303
			}
6304
6305
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6306
		}
6307
6308
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6309
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6310
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6311
			$local_options = self::get_sync_error_idc_option();
6312
			// Ensure all values are set.
6313
			if ( isset( $sync_error['home'] ) && isset ( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6314
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6315
					$is_valid = true;
6316
				}
6317
			}
6318
6319
		}
6320
6321
		/**
6322
		 * Filters whether the sync_error_idc option is valid.
6323
		 *
6324
		 * @since 4.4.0
6325
		 *
6326
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6327
		 */
6328
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6329
6330
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6331
			// Since the option exists, and did not validate, delete it
6332
			Jetpack_Options::delete_option( 'sync_error_idc' );
6333
		}
6334
6335
		return $is_valid;
6336
	}
6337
6338
	/**
6339
	 * Normalizes a url by doing three things:
6340
	 *  - Strips protocol
6341
	 *  - Strips www
6342
	 *  - Adds a trailing slash
6343
	 *
6344
	 * @since 4.4.0
6345
	 * @param string $url
6346
	 * @return WP_Error|string
6347
	 */
6348
	public static function normalize_url_protocol_agnostic( $url ) {
6349
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6350
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6351
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6352
		}
6353
6354
		// Strip www and protocols
6355
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6356
		return $url;
6357
	}
6358
6359
	/**
6360
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6361
	 *
6362
	 * @since 4.4.0
6363
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6364
	 *
6365
	 * @param array $response
6366
	 * @return array Array of the local urls, wpcom urls, and error code
6367
	 */
6368
	public static function get_sync_error_idc_option( $response = array() ) {
6369
		// Since the local options will hit the database directly, store the values
6370
		// in a transient to allow for autoloading and caching on subsequent views.
6371
		$local_options = get_transient( 'jetpack_idc_local' );
6372
		if ( false === $local_options ) {
6373
			$local_options = array(
6374
				'home'    => Functions::home_url(),
6375
				'siteurl' => Functions::site_url(),
6376
			);
6377
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6378
		}
6379
6380
		$options = array_merge( $local_options, $response );
6381
6382
		$returned_values = array();
6383
		foreach ( $options as $key => $option ) {
6384
			if ( 'error_code' === $key ) {
6385
				$returned_values[ $key ] = $option;
6386
				continue;
6387
			}
6388
6389
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6390
				continue;
6391
			}
6392
6393
			$returned_values[ $key ] = $normalized_url;
6394
		}
6395
6396
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6397
6398
		return $returned_values;
6399
	}
6400
6401
	/**
6402
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6403
	 * If set to true, the site will be put into staging mode.
6404
	 *
6405
	 * @since 4.3.2
6406
	 * @return bool
6407
	 */
6408
	public static function sync_idc_optin() {
6409
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6410
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6411
		} else {
6412
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6413
		}
6414
6415
		/**
6416
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6417
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6418
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6419
		 *
6420
		 * @since 4.3.2
6421
		 *
6422
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6423
		 */
6424
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6425
	}
6426
6427
	/**
6428
	 * Maybe Use a .min.css stylesheet, maybe not.
6429
	 *
6430
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6431
	 */
6432
	public static function maybe_min_asset( $url, $path, $plugin ) {
6433
		// Short out on things trying to find actual paths.
6434
		if ( ! $path || empty( $plugin ) ) {
6435
			return $url;
6436
		}
6437
6438
		$path = ltrim( $path, '/' );
6439
6440
		// Strip out the abspath.
6441
		$base = dirname( plugin_basename( $plugin ) );
6442
6443
		// Short out on non-Jetpack assets.
6444
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6445
			return $url;
6446
		}
6447
6448
		// File name parsing.
6449
		$file              = "{$base}/{$path}";
6450
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6451
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6452
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6453
		$extension         = array_shift( $file_name_parts_r );
6454
6455
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6456
			// Already pointing at the minified version.
6457
			if ( 'min' === $file_name_parts_r[0] ) {
6458
				return $url;
6459
			}
6460
6461
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6462
			if ( file_exists( $min_full_path ) ) {
6463
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6464
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6465
				if ( 'css' === $extension ) {
6466
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6467
					self::$min_assets[ $key ] = $path;
6468
				}
6469
			}
6470
		}
6471
6472
		return $url;
6473
	}
6474
6475
	/**
6476
	 * If the asset is minified, let's flag .min as the suffix.
6477
	 *
6478
	 * Attached to `style_loader_src` filter.
6479
	 *
6480
	 * @param string $tag The tag that would link to the external asset.
6481
	 * @param string $handle The registered handle of the script in question.
6482
	 * @param string $href The url of the asset in question.
6483
	 */
6484
	public static function set_suffix_on_min( $src, $handle ) {
6485
		if ( false === strpos( $src, '.min.css' ) ) {
6486
			return $src;
6487
		}
6488
6489
		if ( ! empty( self::$min_assets ) ) {
6490
			foreach ( self::$min_assets as $file => $path ) {
6491
				if ( false !== strpos( $src, $file ) ) {
6492
					wp_style_add_data( $handle, 'suffix', '.min' );
6493
					return $src;
6494
				}
6495
			}
6496
		}
6497
6498
		return $src;
6499
	}
6500
6501
	/**
6502
	 * Maybe inlines a stylesheet.
6503
	 *
6504
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6505
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6506
	 *
6507
	 * Attached to `style_loader_tag` filter.
6508
	 *
6509
	 * @param string $tag The tag that would link to the external asset.
6510
	 * @param string $handle The registered handle of the script in question.
6511
	 *
6512
	 * @return string
6513
	 */
6514
	public static function maybe_inline_style( $tag, $handle ) {
6515
		global $wp_styles;
6516
		$item = $wp_styles->registered[ $handle ];
6517
6518
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6519
			return $tag;
6520
		}
6521
6522
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6523
			$href = $matches[1];
6524
			// Strip off query string
6525
			if ( $pos = strpos( $href, '?' ) ) {
6526
				$href = substr( $href, 0, $pos );
6527
			}
6528
			// Strip off fragment
6529
			if ( $pos = strpos( $href, '#' ) ) {
6530
				$href = substr( $href, 0, $pos );
6531
			}
6532
		} else {
6533
			return $tag;
6534
		}
6535
6536
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6537
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6538
			return $tag;
6539
		}
6540
6541
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6542
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6543
			// And this isn't the pass that actually deals with the RTL version...
6544
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6545
				// Short out, as the RTL version will deal with it in a moment.
6546
				return $tag;
6547
			}
6548
		}
6549
6550
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6551
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6552
		if ( $css ) {
6553
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6554
			if ( empty( $item->extra['after'] ) ) {
6555
				wp_add_inline_style( $handle, $css );
6556
			} else {
6557
				array_unshift( $item->extra['after'], $css );
6558
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6559
			}
6560
		}
6561
6562
		return $tag;
6563
	}
6564
6565
	/**
6566
	 * Loads a view file from the views
6567
	 *
6568
	 * Data passed in with the $data parameter will be available in the
6569
	 * template file as $data['value']
6570
	 *
6571
	 * @param string $template - Template file to load
6572
	 * @param array  $data - Any data to pass along to the template
6573
	 * @return boolean - If template file was found
6574
	 **/
6575
	public function load_view( $template, $data = array() ) {
6576
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6577
6578
		if ( file_exists( $views_dir . $template ) ) {
6579
			require_once $views_dir . $template;
6580
			return true;
6581
		}
6582
6583
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6584
		return false;
6585
	}
6586
6587
	/**
6588
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6589
	 */
6590
	public function deprecated_hooks() {
6591
		global $wp_filter;
6592
6593
		/*
6594
		 * Format:
6595
		 * deprecated_filter_name => replacement_name
6596
		 *
6597
		 * If there is no replacement, use null for replacement_name
6598
		 */
6599
		$deprecated_list = array(
6600
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6601
			'wpl_sharing_2014_1'                           => null,
6602
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6603
			'jetpack_identity_crisis_options_to_check'     => null,
6604
			'update_option_jetpack_single_user_site'       => null,
6605
			'audio_player_default_colors'                  => null,
6606
			'add_option_jetpack_featured_images_enabled'   => null,
6607
			'add_option_jetpack_update_details'            => null,
6608
			'add_option_jetpack_updates'                   => null,
6609
			'add_option_jetpack_network_name'              => null,
6610
			'add_option_jetpack_network_allow_new_registrations' => null,
6611
			'add_option_jetpack_network_add_new_users'     => null,
6612
			'add_option_jetpack_network_site_upload_space' => null,
6613
			'add_option_jetpack_network_upload_file_types' => null,
6614
			'add_option_jetpack_network_enable_administration_menus' => null,
6615
			'add_option_jetpack_is_multi_site'             => null,
6616
			'add_option_jetpack_is_main_network'           => null,
6617
			'add_option_jetpack_main_network_site'         => null,
6618
			'jetpack_sync_all_registered_options'          => null,
6619
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6620
			'jetpack_is_post_mailable'                     => null,
6621
			'jetpack_seo_site_host'                        => null,
6622
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6623
			'jetpack_holiday_snow_option_name'             => null,
6624
			'jetpack_holiday_chance_of_snow'               => null,
6625
			'jetpack_holiday_snow_js_url'                  => null,
6626
			'jetpack_is_holiday_snow_season'               => null,
6627
			'jetpack_holiday_snow_option_updated'          => null,
6628
			'jetpack_holiday_snowing'                      => null,
6629
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6630
			'jetpack_cache_plans'                          => null,
6631
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6632
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6633
			'jetpack_enable_site_verification'             => null,
6634
			'can_display_jetpack_manage_notice'            => null,
6635
			// Removed in Jetpack 7.3.0
6636
			'atd_load_scripts'                             => null,
6637
			'atd_http_post_timeout'                        => null,
6638
			'atd_http_post_error'                          => null,
6639
			'atd_service_domain'                           => null,
6640
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6641
			// Removed in Jetpack 7.9.0
6642
			'jetpack_pwa_manifest'                         => null,
6643
			'jetpack_pwa_background_color'                 => null,
6644
			// Removed in Jetpack 8.3.0.
6645
			'jetpack_check_mobile'                         => null,
6646
			'jetpack_mobile_stylesheet'                    => null,
6647
			'jetpack_mobile_template'                      => null,
6648
			'mobile_reject_mobile'                         => null,
6649
			'mobile_force_mobile'                          => null,
6650
			'mobile_app_promo_download'                    => null,
6651
			'mobile_setup'                                 => null,
6652
			'jetpack_mobile_footer_before'                 => null,
6653
			'wp_mobile_theme_footer'                       => null,
6654
			'minileven_credits'                            => null,
6655
			'jetpack_mobile_header_before'                 => null,
6656
			'jetpack_mobile_header_after'                  => null,
6657
			'jetpack_mobile_theme_menu'                    => null,
6658
			'minileven_show_featured_images'               => null,
6659
			'minileven_attachment_size'                    => null,
6660
		);
6661
6662
		// This is a silly loop depth. Better way?
6663
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6664
			if ( has_action( $hook ) ) {
6665
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6666
					foreach ( $values as $hooked ) {
6667
						if ( is_callable( $hooked['function'] ) ) {
6668
							$function_name = 'an anonymous function';
6669
						} else {
6670
							$function_name = $hooked['function'];
6671
						}
6672
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6673
					}
6674
				}
6675
			}
6676
		}
6677
	}
6678
6679
	/**
6680
	 * Converts any url in a stylesheet, to the correct absolute url.
6681
	 *
6682
	 * Considerations:
6683
	 *  - Normal, relative URLs     `feh.png`
6684
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6685
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6686
	 *  - Absolute URLs             `http://domain.com/feh.png`
6687
	 *  - Domain root relative URLs `/feh.png`
6688
	 *
6689
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6690
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6691
	 *
6692
	 * @return mixed|string
6693
	 */
6694
	public static function absolutize_css_urls( $css, $css_file_url ) {
6695
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6696
		$css_dir = dirname( $css_file_url );
6697
		$p       = wp_parse_url( $css_dir );
6698
		$domain  = sprintf(
6699
			'%1$s//%2$s%3$s%4$s',
6700
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6701
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6702
			$p['host'],
6703
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6704
		);
6705
6706
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6707
			$find = $replace = array();
6708
			foreach ( $matches as $match ) {
6709
				$url = trim( $match['path'], "'\" \t" );
6710
6711
				// If this is a data url, we don't want to mess with it.
6712
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6713
					continue;
6714
				}
6715
6716
				// If this is an absolute or protocol-agnostic url,
6717
				// we don't want to mess with it.
6718
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6719
					continue;
6720
				}
6721
6722
				switch ( substr( $url, 0, 1 ) ) {
6723
					case '/':
6724
						$absolute = $domain . $url;
6725
						break;
6726
					default:
6727
						$absolute = $css_dir . '/' . $url;
6728
				}
6729
6730
				$find[]    = $match[0];
6731
				$replace[] = sprintf( 'url("%s")', $absolute );
6732
			}
6733
			$css = str_replace( $find, $replace, $css );
6734
		}
6735
6736
		return $css;
6737
	}
6738
6739
	/**
6740
	 * This methods removes all of the registered css files on the front end
6741
	 * from Jetpack in favor of using a single file. In effect "imploding"
6742
	 * all the files into one file.
6743
	 *
6744
	 * Pros:
6745
	 * - Uses only ONE css asset connection instead of 15
6746
	 * - Saves a minimum of 56k
6747
	 * - Reduces server load
6748
	 * - Reduces time to first painted byte
6749
	 *
6750
	 * Cons:
6751
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6752
	 *      should not cause any issues with themes.
6753
	 * - Plugins/themes dequeuing styles no longer do anything. See
6754
	 *      jetpack_implode_frontend_css filter for a workaround
6755
	 *
6756
	 * For some situations developers may wish to disable css imploding and
6757
	 * instead operate in legacy mode where each file loads seperately and
6758
	 * can be edited individually or dequeued. This can be accomplished with
6759
	 * the following line:
6760
	 *
6761
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6762
	 *
6763
	 * @since 3.2
6764
	 **/
6765
	public function implode_frontend_css( $travis_test = false ) {
6766
		$do_implode = true;
6767
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6768
			$do_implode = false;
6769
		}
6770
6771
		// Do not implode CSS when the page loads via the AMP plugin.
6772
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6773
			$do_implode = false;
6774
		}
6775
6776
		/**
6777
		 * Allow CSS to be concatenated into a single jetpack.css file.
6778
		 *
6779
		 * @since 3.2.0
6780
		 *
6781
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6782
		 */
6783
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6784
6785
		// Do not use the imploded file when default behavior was altered through the filter
6786
		if ( ! $do_implode ) {
6787
			return;
6788
		}
6789
6790
		// We do not want to use the imploded file in dev mode, or if not connected
6791
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6792
			if ( ! $travis_test ) {
6793
				return;
6794
			}
6795
		}
6796
6797
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6798
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6799
			return;
6800
		}
6801
6802
		/*
6803
		 * Now we assume Jetpack is connected and able to serve the single
6804
		 * file.
6805
		 *
6806
		 * In the future there will be a check here to serve the file locally
6807
		 * or potentially from the Jetpack CDN
6808
		 *
6809
		 * For now:
6810
		 * - Enqueue a single imploded css file
6811
		 * - Zero out the style_loader_tag for the bundled ones
6812
		 * - Be happy, drink scotch
6813
		 */
6814
6815
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6816
6817
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6818
6819
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6820
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6821
	}
6822
6823
	function concat_remove_style_loader_tag( $tag, $handle ) {
6824
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6825
			$tag = '';
6826
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6827
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6828
			}
6829
		}
6830
6831
		return $tag;
6832
	}
6833
6834
	/**
6835
	 * Add an async attribute to scripts that can be loaded asynchronously.
6836
	 * https://www.w3schools.com/tags/att_script_async.asp
6837
	 *
6838
	 * @since 7.7.0
6839
	 *
6840
	 * @param string $tag    The <script> tag for the enqueued script.
6841
	 * @param string $handle The script's registered handle.
6842
	 * @param string $src    The script's source URL.
6843
	 */
6844
	public function script_add_async( $tag, $handle, $src ) {
6845
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6846
			return preg_replace( '/^<script /i', '<script async ', $tag );
6847
		}
6848
6849
		return $tag;
6850
	}
6851
6852
	/*
6853
	 * Check the heartbeat data
6854
	 *
6855
	 * Organizes the heartbeat data by severity.  For example, if the site
6856
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6857
	 *
6858
	 * Data will be added to "caution" array, if it either:
6859
	 *  - Out of date Jetpack version
6860
	 *  - Out of date WP version
6861
	 *  - Out of date PHP version
6862
	 *
6863
	 * $return array $filtered_data
6864
	 */
6865
	public static function jetpack_check_heartbeat_data() {
6866
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6867
6868
		$good    = array();
6869
		$caution = array();
6870
		$bad     = array();
6871
6872
		foreach ( $raw_data as $stat => $value ) {
6873
6874
			// Check jetpack version
6875
			if ( 'version' == $stat ) {
6876
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6877
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6878
					continue;
6879
				}
6880
			}
6881
6882
			// Check WP version
6883
			if ( 'wp-version' == $stat ) {
6884
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6885
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6886
					continue;
6887
				}
6888
			}
6889
6890
			// Check PHP version
6891
			if ( 'php-version' == $stat ) {
6892
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6893
					$caution[ $stat ] = $value . " - min supported is " . JETPACK__MINIMUM_PHP_VERSION;
6894
					continue;
6895
				}
6896
			}
6897
6898
			// Check ID crisis
6899
			if ( 'identitycrisis' == $stat ) {
6900
				if ( 'yes' == $value ) {
6901
					$bad[ $stat ] = $value;
6902
					continue;
6903
				}
6904
			}
6905
6906
			// The rest are good :)
6907
			$good[ $stat ] = $value;
6908
		}
6909
6910
		$filtered_data = array(
6911
			'good'    => $good,
6912
			'caution' => $caution,
6913
			'bad'     => $bad,
6914
		);
6915
6916
		return $filtered_data;
6917
	}
6918
6919
6920
	/*
6921
	 * This method is used to organize all options that can be reset
6922
	 * without disconnecting Jetpack.
6923
	 *
6924
	 * It is used in class.jetpack-cli.php to reset options
6925
	 *
6926
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6927
	 *
6928
	 * @return array of options to delete.
6929
	 */
6930
	public static function get_jetpack_options_for_reset() {
6931
		return Jetpack_Options::get_options_for_reset();
6932
	}
6933
6934
	/*
6935
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6936
	 * so we can bring them directly to their site in calypso.
6937
	 *
6938
	 * @param string | url
6939
	 * @return string | url without the guff
6940
	 */
6941
	public static function build_raw_urls( $url ) {
6942
		$strip_http = '/.*?:\/\//i';
6943
		$url        = preg_replace( $strip_http, '', $url );
6944
		$url        = str_replace( '/', '::', $url );
6945
		return $url;
6946
	}
6947
6948
	/**
6949
	 * Stores and prints out domains to prefetch for page speed optimization.
6950
	 *
6951
	 * @param mixed $new_urls
6952
	 */
6953
	public static function dns_prefetch( $new_urls = null ) {
6954
		static $prefetch_urls = array();
6955
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6956
			echo "\r\n";
6957
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6958
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6959
			}
6960
		} elseif ( ! empty( $new_urls ) ) {
6961
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6962
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6963
			}
6964
			foreach ( (array) $new_urls as $this_new_url ) {
6965
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6966
			}
6967
			$prefetch_urls = array_unique( $prefetch_urls );
6968
		}
6969
	}
6970
6971
	public function wp_dashboard_setup() {
6972
		if ( self::is_active() ) {
6973
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6974
		}
6975
6976
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6977
			$jetpack_logo = new Jetpack_Logo();
6978
			$widget_title = sprintf(
6979
				wp_kses(
6980
					/* translators: Placeholder is a Jetpack logo. */
6981
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6982
					array( 'span' => array() )
6983
				),
6984
				$jetpack_logo->get_jp_emblem( true )
6985
			);
6986
6987
			wp_add_dashboard_widget(
6988
				'jetpack_summary_widget',
6989
				$widget_title,
6990
				array( __CLASS__, 'dashboard_widget' )
6991
			);
6992
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6993
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6994
6995
			// If we're inactive and not in development mode, sort our box to the top.
6996
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6997
				global $wp_meta_boxes;
6998
6999
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
7000
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
7001
7002
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7003
			}
7004
		}
7005
	}
7006
7007
	/**
7008
	 * @param mixed $result Value for the user's option
7009
	 * @return mixed
7010
	 */
7011
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7012
		if ( ! is_array( $sorted ) ) {
7013
			return $sorted;
7014
		}
7015
7016
		foreach ( $sorted as $box_context => $ids ) {
7017
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7018
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7019
				continue;
7020
			}
7021
7022
			$ids_array = explode( ',', $ids );
7023
			$key       = array_search( 'dashboard_stats', $ids_array );
7024
7025
			if ( false !== $key ) {
7026
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7027
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7028
				$sorted[ $box_context ] = implode( ',', $ids_array );
7029
				// We've found it, stop searching, and just return.
7030
				break;
7031
			}
7032
		}
7033
7034
		return $sorted;
7035
	}
7036
7037
	public static function dashboard_widget() {
7038
		/**
7039
		 * Fires when the dashboard is loaded.
7040
		 *
7041
		 * @since 3.4.0
7042
		 */
7043
		do_action( 'jetpack_dashboard_widget' );
7044
	}
7045
7046
	public static function dashboard_widget_footer() {
7047
		?>
7048
		<footer>
7049
7050
		<div class="protect">
7051
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7052
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7053
				<p class="blocked-count">
7054
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7055
				</p>
7056
				<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>
7057
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
7058
				<a href="
7059
				<?php
7060
				echo esc_url(
7061
					wp_nonce_url(
7062
						self::admin_url(
7063
							array(
7064
								'action' => 'activate',
7065
								'module' => 'protect',
7066
							)
7067
						),
7068
						'jetpack_activate-protect'
7069
					)
7070
				);
7071
				?>
7072
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7073
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7074
				</a>
7075
			<?php else : ?>
7076
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7077
			<?php endif; ?>
7078
		</div>
7079
7080
		<div class="akismet">
7081
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7082
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7083
				<p class="blocked-count">
7084
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7085
				</p>
7086
				<p><?php echo esc_html_x( 'Blocked spam comments.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
7087
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7088
				<a href="
7089
				<?php
7090
				echo esc_url(
7091
					wp_nonce_url(
7092
						add_query_arg(
7093
							array(
7094
								'action' => 'activate',
7095
								'plugin' => 'akismet/akismet.php',
7096
							),
7097
							admin_url( 'plugins.php' )
7098
						),
7099
						'activate-plugin_akismet/akismet.php'
7100
					)
7101
				);
7102
				?>
7103
							" class="button button-jetpack">
7104
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7105
				</a>
7106
			<?php else : ?>
7107
				<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( 'Anti-spam can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
7108
			<?php endif; ?>
7109
		</div>
7110
7111
		</footer>
7112
		<?php
7113
	}
7114
7115
	/*
7116
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7117
	 */
7118
	function jetpack_icon_user_connected( $columns ) {
7119
		$columns['user_jetpack'] = '';
7120
		return $columns;
7121
	}
7122
7123
	/*
7124
	 * Show Jetpack icon if the user is linked.
7125
	 */
7126
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7127
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7128
			$jetpack_logo = new Jetpack_Logo();
7129
			$emblem_html  = sprintf(
7130
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7131
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7132
				$jetpack_logo->get_jp_emblem()
7133
			);
7134
			return $emblem_html;
7135
		}
7136
7137
		return $val;
7138
	}
7139
7140
	/*
7141
	 * Style the Jetpack user column
7142
	 */
7143
	function jetpack_user_col_style() {
7144
		global $current_screen;
7145
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7146
			?>
7147
			<style>
7148
				.fixed .column-user_jetpack {
7149
					width: 21px;
7150
				}
7151
				.jp-emblem-user-admin svg {
7152
					width: 20px;
7153
					height: 20px;
7154
				}
7155
				.jp-emblem-user-admin path {
7156
					fill: #00BE28;
7157
				}
7158
			</style>
7159
			<?php
7160
		}
7161
	}
7162
7163
	/**
7164
	 * Checks if Akismet is active and working.
7165
	 *
7166
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7167
	 * that implied usage of methods present since more recent version.
7168
	 * See https://github.com/Automattic/jetpack/pull/9585
7169
	 *
7170
	 * @since  5.1.0
7171
	 *
7172
	 * @return bool True = Akismet available. False = Aksimet not available.
7173
	 */
7174
	public static function is_akismet_active() {
7175
		static $status = null;
7176
7177
		if ( ! is_null( $status ) ) {
7178
			return $status;
7179
		}
7180
7181
		// Check if a modern version of Akismet is active.
7182
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7183
			$status = false;
7184
			return $status;
7185
		}
7186
7187
		// Make sure there is a key known to Akismet at all before verifying key.
7188
		$akismet_key = Akismet::get_api_key();
7189
		if ( ! $akismet_key ) {
7190
			$status = false;
7191
			return $status;
7192
		}
7193
7194
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7195
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7196
7197
		// 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.
7198
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7199
		// We cache the result of the Akismet key verification for ten minutes.
7200
		if ( ! $akismet_key_state || $recheck ) {
7201
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7202
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7203
		}
7204
7205
		$status = 'valid' === $akismet_key_state;
7206
7207
		return $status;
7208
	}
7209
7210
	/**
7211
	 * @deprecated
7212
	 *
7213
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7214
	 */
7215
	public static function is_function_in_backtrace() {
7216
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7217
	}
7218
7219
	/**
7220
	 * Given a minified path, and a non-minified path, will return
7221
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7222
	 *
7223
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7224
	 * root Jetpack directory.
7225
	 *
7226
	 * @since 5.6.0
7227
	 *
7228
	 * @param string $min_path
7229
	 * @param string $non_min_path
7230
	 * @return string The URL to the file
7231
	 */
7232
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7233
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7234
	}
7235
7236
	/**
7237
	 * Checks for whether Jetpack Backup & Scan is enabled.
7238
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7239
	 *
7240
	 * @return bool|int|mixed
7241
	 */
7242
	public static function is_rewind_enabled() {
7243
		if ( ! self::is_active() ) {
7244
			return false;
7245
		}
7246
7247
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7248
		if ( false === $rewind_enabled ) {
7249
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7250
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7251
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7252
				&& ! empty( $rewind_data['state'] )
7253
				&& 'active' === $rewind_data['state'] )
7254
				? 1
7255
				: 0;
7256
7257
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7258
		}
7259
		return $rewind_enabled;
7260
	}
7261
7262
	/**
7263
	 * Return Calypso environment value; used for developing Jetpack and pairing
7264
	 * it with different Calypso enrionments, such as localhost.
7265
	 *
7266
	 * @since 7.4.0
7267
	 *
7268
	 * @return string Calypso environment
7269
	 */
7270
	public static function get_calypso_env() {
7271
		if ( isset( $_GET['calypso_env'] ) ) {
7272
			return sanitize_key( $_GET['calypso_env'] );
7273
		}
7274
7275
		if ( getenv( 'CALYPSO_ENV' ) ) {
7276
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7277
		}
7278
7279
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7280
			return sanitize_key( CALYPSO_ENV );
7281
		}
7282
7283
		return '';
7284
	}
7285
7286
	/**
7287
	 * Returns the hostname with protocol for Calypso.
7288
	 * Used for developing Jetpack with Calypso.
7289
	 *
7290
	 * @since 8.4.0
7291
	 *
7292
	 * @return string Calypso host.
7293
	 */
7294
	public static function get_calypso_host() {
7295
		$calypso_env = self::get_calypso_env();
7296
		switch ( $calypso_env ) {
7297
			case 'development':
7298
				return 'http://calypso.localhost:3000/';
7299
			case 'wpcalypso':
7300
				return 'https://wpcalypso.wordpress.com/';
7301
			case 'horizon':
7302
				return 'https://horizon.wordpress.com/';
7303
			default:
7304
				return 'https://wordpress.com/';
7305
		}
7306
	}
7307
7308
	/**
7309
	 * Checks whether or not TOS has been agreed upon.
7310
	 * Will return true if a user has clicked to register, or is already connected.
7311
	 */
7312
	public static function jetpack_tos_agreed() {
7313
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7314
7315
		$terms_of_service = new Terms_Of_Service();
7316
		return $terms_of_service->has_agreed();
7317
7318
	}
7319
7320
	/**
7321
	 * Handles activating default modules as well general cleanup for the new connection.
7322
	 *
7323
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7324
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7325
	 * @param boolean $send_state_messages          Whether to send state messages.
7326
	 * @return void
7327
	 */
7328
	public static function handle_post_authorization_actions(
7329
		$activate_sso = false,
7330
		$redirect_on_activation_error = false,
7331
		$send_state_messages = true
7332
	) {
7333
		$other_modules = $activate_sso
7334
			? array( 'sso' )
7335
			: array();
7336
7337
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7338
			self::delete_active_modules();
7339
7340
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
7341
		} else {
7342
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7343
		}
7344
7345
		// Since this is a fresh connection, be sure to clear out IDC options
7346
		Jetpack_IDC::clear_all_idc_options();
7347
7348
		if ( $send_state_messages ) {
7349
			self::state( 'message', 'authorized' );
7350
		}
7351
	}
7352
7353
	/**
7354
	 * Returns a boolean for whether backups UI should be displayed or not.
7355
	 *
7356
	 * @return bool Should backups UI be displayed?
7357
	 */
7358
	public static function show_backups_ui() {
7359
		/**
7360
		 * Whether UI for backups should be displayed.
7361
		 *
7362
		 * @since 6.5.0
7363
		 *
7364
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7365
		 */
7366
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7367
	}
7368
7369
	/*
7370
	 * Deprecated manage functions
7371
	 */
7372
	function prepare_manage_jetpack_notice() {
7373
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7374
	}
7375
	function manage_activate_screen() {
7376
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7377
	}
7378
	function admin_jetpack_manage_notice() {
7379
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7380
	}
7381
	function opt_out_jetpack_manage_url() {
7382
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7383
	}
7384
	function opt_in_jetpack_manage_url() {
7385
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7386
	}
7387
	function opt_in_jetpack_manage_notice() {
7388
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7389
	}
7390
	function can_display_jetpack_manage_notice() {
7391
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7392
	}
7393
7394
	/**
7395
	 * Clean leftoveruser meta.
7396
	 *
7397
	 * Delete Jetpack-related user meta when it is no longer needed.
7398
	 *
7399
	 * @since 7.3.0
7400
	 *
7401
	 * @param int $user_id User ID being updated.
7402
	 */
7403
	public static function user_meta_cleanup( $user_id ) {
7404
		$meta_keys = array(
7405
			// AtD removed from Jetpack 7.3
7406
			'AtD_options',
7407
			'AtD_check_when',
7408
			'AtD_guess_lang',
7409
			'AtD_ignored_phrases',
7410
		);
7411
7412
		foreach ( $meta_keys as $meta_key ) {
7413
			if ( get_user_meta( $user_id, $meta_key ) ) {
7414
				delete_user_meta( $user_id, $meta_key );
7415
			}
7416
		}
7417
	}
7418
7419
	/**
7420
	 * Checks if a Jetpack site is both active and not in development.
7421
	 *
7422
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7423
	 *
7424
	 * @return bool True if Jetpack is active and not in development.
7425
	 */
7426
	public static function is_active_and_not_development_mode() {
7427
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7428
			return false;
7429
		}
7430
		return true;
7431
	}
7432
}
7433