Completed
Push — update/add_release_post_to_upd... ( 01614a...c26b31 )
by
unknown
324:03 queued 316:32
created

class.jetpack.php (1 issue)

Severity

Upgrade to new PHP Analysis Engine

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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