Completed
Push — add/redirect-everything ( 87e326...259430 )
by
unknown
302:19 queued 295:11
created

class.jetpack.php (4 issues)

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

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

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

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

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

Loading history...
6860
	 * 		@param string $path Additional path to be appended to the URL
0 ignored issues
show
There is no parameter named $path. Was it maybe removed?

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

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

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

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

Loading history...
6861
	 * 		@param string $query Query parameters to be added to the URL
0 ignored issues
show
There is no parameter named $query. Was it maybe removed?

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

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

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

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

Loading history...
6862
	 * 		@param string $anchor Anchor to be added to the URL
0 ignored issues
show
There is no parameter named $anchor. Was it maybe removed?

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

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

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

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

Loading history...
6863
6864
	 * }
6865
	 *
6866
	 *
6867
	 * @return string The built URL
6868
	 */
6869
	public static function build_redirect_url( $source, $args = array() ) {
6870
6871
		$url           = 'https://jetpack.com/redirect';
6872
		$args          = wp_parse_args( $args );
6873
		$accepted_args = array( 'site', 'path', 'query', 'anchor' );
6874
6875
		$to_be_added = array(
6876
			'source' => rawurlencode( $source ),
6877
		);
6878
6879
		foreach ( $args as $arg_name => $arg_value ) {
6880
6881
			if ( ! in_array( $arg_name, $accepted_args, true ) || empty( $arg_value ) ) {
6882
				continue;
6883
			}
6884
6885
			$to_be_added[ $arg_name ] = rawurlencode( $arg_value );
6886
6887
		}
6888
6889
		if ( ! empty( $to_be_added ) ) {
6890
			$url = add_query_arg( $to_be_added, $url );
6891
		}
6892
6893
		return $url;
6894
	}
6895
6896
	/**
6897
	 * Stores and prints out domains to prefetch for page speed optimization.
6898
	 *
6899
	 * @param mixed $new_urls
6900
	 */
6901
	public static function dns_prefetch( $new_urls = null ) {
6902
		static $prefetch_urls = array();
6903
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6904
			echo "\r\n";
6905
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6906
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6907
			}
6908
		} elseif ( ! empty( $new_urls ) ) {
6909
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6910
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6911
			}
6912
			foreach ( (array) $new_urls as $this_new_url ) {
6913
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6914
			}
6915
			$prefetch_urls = array_unique( $prefetch_urls );
6916
		}
6917
	}
6918
6919
	public function wp_dashboard_setup() {
6920
		if ( self::is_active() ) {
6921
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6922
		}
6923
6924
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6925
			$jetpack_logo = new Jetpack_Logo();
6926
			$widget_title = sprintf(
6927
				wp_kses(
6928
					/* translators: Placeholder is a Jetpack logo. */
6929
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6930
					array( 'span' => array() )
6931
				),
6932
				$jetpack_logo->get_jp_emblem( true )
6933
			);
6934
6935
			wp_add_dashboard_widget(
6936
				'jetpack_summary_widget',
6937
				$widget_title,
6938
				array( __CLASS__, 'dashboard_widget' )
6939
			);
6940
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6941
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6942
6943
			// If we're inactive and not in development mode, sort our box to the top.
6944
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6945
				global $wp_meta_boxes;
6946
6947
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6948
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6949
6950
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6951
			}
6952
		}
6953
	}
6954
6955
	/**
6956
	 * @param mixed $result Value for the user's option
6957
	 * @return mixed
6958
	 */
6959
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6960
		if ( ! is_array( $sorted ) ) {
6961
			return $sorted;
6962
		}
6963
6964
		foreach ( $sorted as $box_context => $ids ) {
6965
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6966
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6967
				continue;
6968
			}
6969
6970
			$ids_array = explode( ',', $ids );
6971
			$key       = array_search( 'dashboard_stats', $ids_array );
6972
6973
			if ( false !== $key ) {
6974
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6975
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6976
				$sorted[ $box_context ] = implode( ',', $ids_array );
6977
				// We've found it, stop searching, and just return.
6978
				break;
6979
			}
6980
		}
6981
6982
		return $sorted;
6983
	}
6984
6985
	public static function dashboard_widget() {
6986
		/**
6987
		 * Fires when the dashboard is loaded.
6988
		 *
6989
		 * @since 3.4.0
6990
		 */
6991
		do_action( 'jetpack_dashboard_widget' );
6992
	}
6993
6994
	public static function dashboard_widget_footer() {
6995
		?>
6996
		<footer>
6997
6998
		<div class="protect">
6999
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7000
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7001
				<p class="blocked-count">
7002
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7003
				</p>
7004
				<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>
7005
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
7006
				<a href="
7007
				<?php
7008
				echo esc_url(
7009
					wp_nonce_url(
7010
						self::admin_url(
7011
							array(
7012
								'action' => 'activate',
7013
								'module' => 'protect',
7014
							)
7015
						),
7016
						'jetpack_activate-protect'
7017
					)
7018
				);
7019
				?>
7020
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7021
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7022
				</a>
7023
			<?php else : ?>
7024
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7025
			<?php endif; ?>
7026
		</div>
7027
7028
		<div class="akismet">
7029
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7030
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7031
				<p class="blocked-count">
7032
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7033
				</p>
7034
				<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>
7035
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7036
				<a href="
7037
				<?php
7038
				echo esc_url(
7039
					wp_nonce_url(
7040
						add_query_arg(
7041
							array(
7042
								'action' => 'activate',
7043
								'plugin' => 'akismet/akismet.php',
7044
							),
7045
							admin_url( 'plugins.php' )
7046
						),
7047
						'activate-plugin_akismet/akismet.php'
7048
					)
7049
				);
7050
				?>
7051
							" class="button button-jetpack">
7052
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7053
				</a>
7054
			<?php else : ?>
7055
				<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>
7056
			<?php endif; ?>
7057
		</div>
7058
7059
		</footer>
7060
		<?php
7061
	}
7062
7063
	/*
7064
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7065
	 */
7066
	function jetpack_icon_user_connected( $columns ) {
7067
		$columns['user_jetpack'] = '';
7068
		return $columns;
7069
	}
7070
7071
	/*
7072
	 * Show Jetpack icon if the user is linked.
7073
	 */
7074
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7075
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7076
			$jetpack_logo = new Jetpack_Logo();
7077
			$emblem_html  = sprintf(
7078
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7079
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7080
				$jetpack_logo->get_jp_emblem()
7081
			);
7082
			return $emblem_html;
7083
		}
7084
7085
		return $val;
7086
	}
7087
7088
	/*
7089
	 * Style the Jetpack user column
7090
	 */
7091
	function jetpack_user_col_style() {
7092
		global $current_screen;
7093
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7094
			?>
7095
			<style>
7096
				.fixed .column-user_jetpack {
7097
					width: 21px;
7098
				}
7099
				.jp-emblem-user-admin svg {
7100
					width: 20px;
7101
					height: 20px;
7102
				}
7103
				.jp-emblem-user-admin path {
7104
					fill: #00BE28;
7105
				}
7106
			</style>
7107
			<?php
7108
		}
7109
	}
7110
7111
	/**
7112
	 * Checks if Akismet is active and working.
7113
	 *
7114
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7115
	 * that implied usage of methods present since more recent version.
7116
	 * See https://github.com/Automattic/jetpack/pull/9585
7117
	 *
7118
	 * @since  5.1.0
7119
	 *
7120
	 * @return bool True = Akismet available. False = Aksimet not available.
7121
	 */
7122
	public static function is_akismet_active() {
7123
		static $status = null;
7124
7125
		if ( ! is_null( $status ) ) {
7126
			return $status;
7127
		}
7128
7129
		// Check if a modern version of Akismet is active.
7130
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7131
			$status = false;
7132
			return $status;
7133
		}
7134
7135
		// Make sure there is a key known to Akismet at all before verifying key.
7136
		$akismet_key = Akismet::get_api_key();
7137
		if ( ! $akismet_key ) {
7138
			$status = false;
7139
			return $status;
7140
		}
7141
7142
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7143
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7144
7145
		// 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.
7146
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7147
		// We cache the result of the Akismet key verification for ten minutes.
7148
		if ( ! $akismet_key_state || $recheck ) {
7149
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7150
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7151
		}
7152
7153
		$status = 'valid' === $akismet_key_state;
7154
7155
		return $status;
7156
	}
7157
7158
	/**
7159
	 * @deprecated
7160
	 *
7161
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7162
	 */
7163
	public static function is_function_in_backtrace() {
7164
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7165
	}
7166
7167
	/**
7168
	 * Given a minified path, and a non-minified path, will return
7169
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7170
	 *
7171
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7172
	 * root Jetpack directory.
7173
	 *
7174
	 * @since 5.6.0
7175
	 *
7176
	 * @param string $min_path
7177
	 * @param string $non_min_path
7178
	 * @return string The URL to the file
7179
	 */
7180
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7181
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7182
	}
7183
7184
	/**
7185
	 * Checks for whether Jetpack Backup & Scan is enabled.
7186
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7187
	 *
7188
	 * @return bool|int|mixed
7189
	 */
7190
	public static function is_rewind_enabled() {
7191
		if ( ! self::is_active() ) {
7192
			return false;
7193
		}
7194
7195
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7196
		if ( false === $rewind_enabled ) {
7197
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7198
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7199
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7200
				&& ! empty( $rewind_data['state'] )
7201
				&& 'active' === $rewind_data['state'] )
7202
				? 1
7203
				: 0;
7204
7205
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7206
		}
7207
		return $rewind_enabled;
7208
	}
7209
7210
	/**
7211
	 * Return Calypso environment value; used for developing Jetpack and pairing
7212
	 * it with different Calypso enrionments, such as localhost.
7213
	 *
7214
	 * @since 7.4.0
7215
	 *
7216
	 * @return string Calypso environment
7217
	 */
7218
	public static function get_calypso_env() {
7219
		if ( isset( $_GET['calypso_env'] ) ) {
7220
			return sanitize_key( $_GET['calypso_env'] );
7221
		}
7222
7223
		if ( getenv( 'CALYPSO_ENV' ) ) {
7224
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7225
		}
7226
7227
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7228
			return sanitize_key( CALYPSO_ENV );
7229
		}
7230
7231
		return '';
7232
	}
7233
7234
	/**
7235
	 * Returns the hostname with protocol for Calypso.
7236
	 * Used for developing Jetpack with Calypso.
7237
	 *
7238
	 * @since 8.4.0
7239
	 *
7240
	 * @return string Calypso host.
7241
	 */
7242
	public static function get_calypso_host() {
7243
		$calypso_env = self::get_calypso_env();
7244
		switch ( $calypso_env ) {
7245
			case 'development':
7246
				return 'http://calypso.localhost:3000/';
7247
			case 'wpcalypso':
7248
				return 'https://wpcalypso.wordpress.com/';
7249
			case 'horizon':
7250
				return 'https://horizon.wordpress.com/';
7251
			default:
7252
				return 'https://wordpress.com/';
7253
		}
7254
	}
7255
7256
	/**
7257
	 * Checks whether or not TOS has been agreed upon.
7258
	 * Will return true if a user has clicked to register, or is already connected.
7259
	 */
7260
	public static function jetpack_tos_agreed() {
7261
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7262
7263
		$terms_of_service = new Terms_Of_Service();
7264
		return $terms_of_service->has_agreed();
7265
7266
	}
7267
7268
	/**
7269
	 * Handles activating default modules as well general cleanup for the new connection.
7270
	 *
7271
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7272
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7273
	 * @param boolean $send_state_messages          Whether to send state messages.
7274
	 * @return void
7275
	 */
7276
	public static function handle_post_authorization_actions(
7277
		$activate_sso = false,
7278
		$redirect_on_activation_error = false,
7279
		$send_state_messages = true
7280
	) {
7281
		$other_modules = $activate_sso
7282
			? array( 'sso' )
7283
			: array();
7284
7285
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7286
			self::delete_active_modules();
7287
7288
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
7289
		} else {
7290
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7291
		}
7292
7293
		// Since this is a fresh connection, be sure to clear out IDC options
7294
		Jetpack_IDC::clear_all_idc_options();
7295
7296
		if ( $send_state_messages ) {
7297
			self::state( 'message', 'authorized' );
7298
		}
7299
	}
7300
7301
	/**
7302
	 * Returns a boolean for whether backups UI should be displayed or not.
7303
	 *
7304
	 * @return bool Should backups UI be displayed?
7305
	 */
7306
	public static function show_backups_ui() {
7307
		/**
7308
		 * Whether UI for backups should be displayed.
7309
		 *
7310
		 * @since 6.5.0
7311
		 *
7312
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7313
		 */
7314
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7315
	}
7316
7317
	/*
7318
	 * Deprecated manage functions
7319
	 */
7320
	function prepare_manage_jetpack_notice() {
7321
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7322
	}
7323
	function manage_activate_screen() {
7324
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7325
	}
7326
	function admin_jetpack_manage_notice() {
7327
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7328
	}
7329
	function opt_out_jetpack_manage_url() {
7330
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7331
	}
7332
	function opt_in_jetpack_manage_url() {
7333
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7334
	}
7335
	function opt_in_jetpack_manage_notice() {
7336
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7337
	}
7338
	function can_display_jetpack_manage_notice() {
7339
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7340
	}
7341
7342
	/**
7343
	 * Clean leftoveruser meta.
7344
	 *
7345
	 * Delete Jetpack-related user meta when it is no longer needed.
7346
	 *
7347
	 * @since 7.3.0
7348
	 *
7349
	 * @param int $user_id User ID being updated.
7350
	 */
7351
	public static function user_meta_cleanup( $user_id ) {
7352
		$meta_keys = array(
7353
			// AtD removed from Jetpack 7.3
7354
			'AtD_options',
7355
			'AtD_check_when',
7356
			'AtD_guess_lang',
7357
			'AtD_ignored_phrases',
7358
		);
7359
7360
		foreach ( $meta_keys as $meta_key ) {
7361
			if ( get_user_meta( $user_id, $meta_key ) ) {
7362
				delete_user_meta( $user_id, $meta_key );
7363
			}
7364
		}
7365
	}
7366
7367
	/**
7368
	 * Checks if a Jetpack site is both active and not in development.
7369
	 *
7370
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7371
	 *
7372
	 * @return bool True if Jetpack is active and not in development.
7373
	 */
7374
	public static function is_active_and_not_development_mode() {
7375
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7376
			return false;
7377
		}
7378
		return true;
7379
	}
7380
}
7381