Completed
Push — update/add_grunion_after_feedb... ( 614f06...9f6c1a )
by
unknown
07:04
created

class.jetpack.php (10 issues)

Upgrade to new PHP Analysis Engine

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

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\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
use Automattic\Jetpack\Redirect;
20
21
/*
22
Options:
23
jetpack_options (array)
24
	An array of options.
25
	@see Jetpack_Options::get_option_names()
26
27
jetpack_register (string)
28
	Temporary verification secrets.
29
30
jetpack_activated (int)
31
	1: the plugin was activated normally
32
	2: the plugin was activated on this site because of a network-wide activation
33
	3: the plugin was auto-installed
34
	4: the plugin was manually disconnected (but is still installed)
35
36
jetpack_active_modules (array)
37
	Array of active module slugs.
38
39
jetpack_do_activate (bool)
40
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
41
*/
42
43
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
44
45
class Jetpack {
46
	public $xmlrpc_server = null;
47
48
	private $rest_authentication_status = null;
49
50
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
51
52
	/**
53
	 * @var array The handles of styles that are concatenated into jetpack.css.
54
	 *
55
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
56
	 */
57
	public $concatenated_style_handles = array(
58
		'jetpack-carousel',
59
		'grunion.css',
60
		'the-neverending-homepage',
61
		'jetpack_likes',
62
		'jetpack_related-posts',
63
		'sharedaddy',
64
		'jetpack-slideshow',
65
		'presentations',
66
		'quiz',
67
		'jetpack-subscriptions',
68
		'jetpack-responsive-videos-style',
69
		'jetpack-social-menu',
70
		'tiled-gallery',
71
		'jetpack_display_posts_widget',
72
		'gravatar-profile-widget',
73
		'goodreads-widget',
74
		'jetpack_social_media_icons_widget',
75
		'jetpack-top-posts-widget',
76
		'jetpack_image_widget',
77
		'jetpack-my-community-widget',
78
		'jetpack-authors-widget',
79
		'wordads',
80
		'eu-cookie-law-style',
81
		'flickr-widget-style',
82
		'jetpack-search-widget',
83
		'jetpack-simple-payments-widget-style',
84
		'jetpack-widget-social-icons-styles',
85
	);
86
87
	/**
88
	 * The handles of scripts that can be loaded asynchronously.
89
	 *
90
	 * @var array
91
	 */
92
	public $async_script_handles = array(
93
		'woocommerce-analytics',
94
	);
95
96
	/**
97
	 * Contains all assets that have had their URL rewritten to minified versions.
98
	 *
99
	 * @var array
100
	 */
101
	static $min_assets = array();
102
103
	public $plugins_to_deactivate = array(
104
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
105
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
106
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
107
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
108
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
109
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
110
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
111
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
112
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
113
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
114
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
115
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
116
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
117
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
118
	);
119
120
	/**
121
	 * Map of roles we care about, and their corresponding minimum capabilities.
122
	 *
123
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
124
	 *
125
	 * @access public
126
	 * @static
127
	 *
128
	 * @var array
129
	 */
130
	public static $capability_translations = array(
131
		'administrator' => 'manage_options',
132
		'editor'        => 'edit_others_posts',
133
		'author'        => 'publish_posts',
134
		'contributor'   => 'edit_posts',
135
		'subscriber'    => 'read',
136
	);
137
138
	/**
139
	 * Map of modules that have conflicts with plugins and should not be auto-activated
140
	 * if the plugins are active.  Used by filter_default_modules
141
	 *
142
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
143
	 * change `module-slug` and add this to your plugin:
144
	 *
145
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
146
	 * function my_jetpack_get_default_modules( $modules ) {
147
	 *     return array_diff( $modules, array( 'module-slug' ) );
148
	 * }
149
	 *
150
	 * @var array
151
	 */
152
	private $conflicting_plugins = array(
153
		'comments'           => array(
154
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
155
			'Disqus'                         => 'disqus-comment-system/disqus.php',
156
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
157
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
158
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
159
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
160
		),
161
		'comment-likes'      => array(
162
			'Epoch' => 'epoch/plugincore.php',
163
		),
164
		'contact-form'       => array(
165
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
166
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
167
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
168
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
169
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
170
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
171
		),
172
		'latex'              => array(
173
			'LaTeX for WordPress'     => 'latex/latex.php',
174
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
175
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
176
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
177
			'Enable Latex'            => 'enable-latex/enable-latex.php',
178
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
179
		),
180
		'protect'            => array(
181
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
182
			'Captcha'                           => 'captcha/captcha.php',
183
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
184
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
185
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
186
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
187
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
188
			'Security-protection'               => 'security-protection/security-protection.php',
189
			'Login Security'                    => 'login-security/login-security.php',
190
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
191
			'Wordfence Security'                => 'wordfence/wordfence.php',
192
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
193
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
194
		),
195
		'random-redirect'    => array(
196
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
197
		),
198
		'related-posts'      => array(
199
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
200
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
201
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
202
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
203
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
204
			'outbrain'                    => 'outbrain/outbrain.php',
205
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
206
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
207
		),
208
		'sharedaddy'         => array(
209
			'AddThis'     => 'addthis/addthis_social_widget.php',
210
			'Add To Any'  => 'add-to-any/add-to-any.php',
211
			'ShareThis'   => 'share-this/sharethis.php',
212
			'Shareaholic' => 'shareaholic/shareaholic.php',
213
		),
214
		'seo-tools'          => array(
215
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
216
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
217
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
218
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
219
			'The SEO Framework'              => 'autodescription/autodescription.php',
220
		),
221
		'verification-tools' => array(
222
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
223
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
224
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
225
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
226
			'The SEO Framework'              => 'autodescription/autodescription.php',
227
		),
228
		'widget-visibility'  => array(
229
			'Widget Logic'    => 'widget-logic/widget_logic.php',
230
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
231
		),
232
		'sitemaps'           => array(
233
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
234
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
235
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
236
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
237
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
238
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
239
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
240
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
241
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
242
			'The SEO Framework'                    => 'autodescription/autodescription.php',
243
			'Sitemap'                              => 'sitemap/sitemap.php',
244
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
245
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
246
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
247
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
248
		),
249
		'lazy-images'        => array(
250
			'Lazy Load'              => 'lazy-load/lazy-load.php',
251
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
252
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
253
		),
254
	);
255
256
	/**
257
	 * Plugins for which we turn off our Facebook OG Tags implementation.
258
	 *
259
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
260
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
261
	 *
262
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
263
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
264
	 */
265
	private $open_graph_conflicting_plugins = array(
266
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
267
		// 2 Click Social Media Buttons
268
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
269
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
270
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
271
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
272
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
273
		// Open Graph Meta Tags by Heateor
274
		'facebook/facebook.php',                                 // Facebook (official plugin)
275
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
276
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
277
		// Facebook Featured Image & OG Meta Tags
278
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
279
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
280
		// Facebook Open Graph Meta Tags for WordPress
281
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
282
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
283
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
284
		// Fedmich's Facebook Open Graph Meta
285
		'network-publisher/networkpub.php',                      // Network Publisher
286
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
287
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
288
		// NextScripts SNAP
289
		'og-tags/og-tags.php',                                   // OG Tags
290
		'opengraph/opengraph.php',                               // Open Graph
291
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
292
		// Open Graph Protocol Framework
293
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
294
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
295
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
296
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
297
		'sharepress/sharepress.php',                             // SharePress
298
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
299
		'social-discussions/social-discussions.php',             // Social Discussions
300
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
301
		'socialize/socialize.php',                               // Socialize
302
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
303
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
304
		// Tweet, Like, Google +1 and Share
305
		'wordbooker/wordbooker.php',                             // Wordbooker
306
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
307
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
308
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
309
		// WP Facebook Like Send & Open Graph Meta
310
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
311
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
312
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
313
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
314
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
315
	);
316
317
	/**
318
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
319
	 */
320
	private $twitter_cards_conflicting_plugins = array(
321
		// 'twitter/twitter.php',                       // The official one handles this on its own.
322
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
323
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
324
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
325
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
326
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
327
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
328
		'twitter-cards/twitter-cards.php',           // Twitter Cards
329
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
330
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
331
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
332
	);
333
334
	/**
335
	 * Message to display in admin_notice
336
	 *
337
	 * @var string
338
	 */
339
	public $message = '';
340
341
	/**
342
	 * Error to display in admin_notice
343
	 *
344
	 * @var string
345
	 */
346
	public $error = '';
347
348
	/**
349
	 * Modules that need more privacy description.
350
	 *
351
	 * @var string
352
	 */
353
	public $privacy_checks = '';
354
355
	/**
356
	 * Stats to record once the page loads
357
	 *
358
	 * @var array
359
	 */
360
	public $stats = array();
361
362
	/**
363
	 * Jetpack_Sync object
364
	 */
365
	public $sync;
366
367
	/**
368
	 * Verified data for JSON authorization request
369
	 */
370
	public $json_api_authorization_request = array();
371
372
	/**
373
	 * @var Automattic\Jetpack\Connection\Manager
374
	 */
375
	protected $connection_manager;
376
377
	/**
378
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
379
	 */
380
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
381
382
	/**
383
	 * Constant for login redirect key.
384
	 *
385
	 * @var string
386
	 * @since 8.4.0
387
	 */
388
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
389
390
	/**
391
	 * Holds the singleton instance of this class
392
	 *
393
	 * @since 2.3.3
394
	 * @var Jetpack
395
	 */
396
	static $instance = false;
397
398
	/**
399
	 * Singleton
400
	 *
401
	 * @static
402
	 */
403
	public static function init() {
404
		if ( ! self::$instance ) {
405
			self::$instance = new Jetpack();
406
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
407
		}
408
409
		return self::$instance;
410
	}
411
412
	/**
413
	 * Must never be called statically
414
	 */
415
	function plugin_upgrade() {
416
		if ( self::is_active() ) {
417
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
418
			if ( JETPACK__VERSION != $version ) {
419
				// Prevent multiple upgrades at once - only a single process should trigger
420
				// an upgrade to avoid stampedes
421
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
422
					return;
423
				}
424
425
				// Set a short lock to prevent multiple instances of the upgrade
426
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
427
428
				// check which active modules actually exist and remove others from active_modules list
429
				$unfiltered_modules = self::get_active_modules();
430
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
431
				if ( array_diff( $unfiltered_modules, $modules ) ) {
432
					self::update_active_modules( $modules );
433
				}
434
435
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
436
437
				// Upgrade to 4.3.0
438
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
439
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
440
				}
441
442
				// Make sure Markdown for posts gets turned back on
443
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
444
					update_option( 'wpcom_publish_posts_with_markdown', true );
445
				}
446
447
				/*
448
				 * Minileven deprecation. 8.3.0.
449
				 * Only delete options if not using
450
				 * the replacement standalone Minileven plugin.
451
				 */
452
				if (
453
					! self::is_plugin_active( 'minileven-master/minileven.php' )
454
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
455
				) {
456
					if ( get_option( 'wp_mobile_custom_css' ) ) {
457
						delete_option( 'wp_mobile_custom_css' );
458
					}
459
					if ( get_option( 'wp_mobile_excerpt' ) ) {
460
						delete_option( 'wp_mobile_excerpt' );
461
					}
462
					if ( get_option( 'wp_mobile_featured_images' ) ) {
463
						delete_option( 'wp_mobile_featured_images' );
464
					}
465
					if ( get_option( 'wp_mobile_app_promos' ) ) {
466
						delete_option( 'wp_mobile_app_promos' );
467
					}
468
				}
469
470
				// Upgrade to 8.4.0.
471
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
472
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
473
				}
474
475
				if ( did_action( 'wp_loaded' ) ) {
476
					self::upgrade_on_load();
477
				} else {
478
					add_action(
479
						'wp_loaded',
480
						array( __CLASS__, 'upgrade_on_load' )
481
					);
482
				}
483
			}
484
		}
485
	}
486
487
	/**
488
	 * Runs upgrade routines that need to have modules loaded.
489
	 */
490
	static function upgrade_on_load() {
491
492
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
493
		// This can happen in case Jetpack has been just upgraded and is
494
		// being initialized late during the page load. In this case we wait
495
		// until the next proper admin page load with Jetpack active.
496
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
497
			delete_transient( self::$plugin_upgrade_lock_key );
498
499
			return;
500
		}
501
502
		self::maybe_set_version_option();
503
504
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
505
			Jetpack_Widget_Conditions::migrate_post_type_rules();
506
		}
507
508
		if (
509
			class_exists( 'Jetpack_Sitemap_Manager' )
510
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
511
		) {
512
			do_action( 'jetpack_sitemaps_purge_data' );
513
		}
514
515
		// Delete old stats cache
516
		delete_option( 'jetpack_restapi_stats_cache' );
517
518
		delete_transient( self::$plugin_upgrade_lock_key );
519
	}
520
521
	/**
522
	 * Saves all the currently active modules to options.
523
	 * Also fires Action hooks for each newly activated and deactivated module.
524
	 *
525
	 * @param $modules Array Array of active modules to be saved in options.
526
	 *
527
	 * @return $success bool true for success, false for failure.
528
	 */
529
	static function update_active_modules( $modules ) {
530
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
531
		$active_modules       = self::get_active_modules();
532
		$new_active_modules   = array_diff( $modules, $current_modules );
533
		$new_inactive_modules = array_diff( $active_modules, $modules );
534
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
535
		$reindexed_modules    = array_values( $new_current_modules );
536
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
537
538
		foreach ( $new_active_modules as $module ) {
539
			/**
540
			 * Fires when a specific module is activated.
541
			 *
542
			 * @since 1.9.0
543
			 *
544
			 * @param string $module Module slug.
545
			 * @param boolean $success whether the module was activated. @since 4.2
546
			 */
547
			do_action( 'jetpack_activate_module', $module, $success );
548
			/**
549
			 * Fires when a module is activated.
550
			 * The dynamic part of the filter, $module, is the module slug.
551
			 *
552
			 * @since 1.9.0
553
			 *
554
			 * @param string $module Module slug.
555
			 */
556
			do_action( "jetpack_activate_module_$module", $module );
557
		}
558
559
		foreach ( $new_inactive_modules as $module ) {
560
			/**
561
			 * Fired after a module has been deactivated.
562
			 *
563
			 * @since 4.2.0
564
			 *
565
			 * @param string $module Module slug.
566
			 * @param boolean $success whether the module was deactivated.
567
			 */
568
			do_action( 'jetpack_deactivate_module', $module, $success );
569
			/**
570
			 * Fires when a module is deactivated.
571
			 * The dynamic part of the filter, $module, is the module slug.
572
			 *
573
			 * @since 1.9.0
574
			 *
575
			 * @param string $module Module slug.
576
			 */
577
			do_action( "jetpack_deactivate_module_$module", $module );
578
		}
579
580
		return $success;
581
	}
582
583
	static function delete_active_modules() {
584
		self::update_active_modules( array() );
585
	}
586
587
	/**
588
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
589
	 * available.
590
	 */
591
	public function add_configure_hook() {
592
		global $wp_filter;
593
594
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
595
		if ( false !== $current_priority ) {
596
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
597
		}
598
599
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
600
		sort( $taken_priorities );
601
602
		$first_priority = array_shift( $taken_priorities );
603
604
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
605
			$new_priority = - PHP_INT_MAX;
606
		} else {
607
			$new_priority = $first_priority - 1;
608
		}
609
610
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
611
	}
612
613
	/**
614
	 * Constructor.  Initializes WordPress hooks
615
	 */
616
	private function __construct() {
617
		/*
618
		 * Check for and alert any deprecated hooks
619
		 */
620
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
621
622
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
623
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
624
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
625
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
626
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
627
628
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
629
630
		add_filter(
631
			'jetpack_signature_check_token',
632
			array( __CLASS__, 'verify_onboarding_token' ),
633
			10,
634
			3
635
		);
636
637
		/**
638
		 * Prepare Gutenberg Editor functionality
639
		 */
640
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
641
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
642
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
643
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
644
645
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
646
647
		// Unlink user before deleting the user from WP.com.
648
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
649
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
650
651
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
652
653
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
654
		add_action( 'login_init', array( $this, 'login_init' ) );
655
656
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
657
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
658
659
		add_action( 'admin_init', array( $this, 'admin_init' ) );
660
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
661
662
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
663
664
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
665
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
666
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
667
668
		// returns HTTPS support status
669
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
670
671
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
672
673
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
674
675
		/**
676
		 * These actions run checks to load additional files.
677
		 * They check for external files or plugins, so they need to run as late as possible.
678
		 */
679
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
680
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
681
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
682
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
683
684
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
685
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
686
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
687
688
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
689
690
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
691
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
692
693
		// A filter to control all just in time messages
694
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
695
696
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
697
698
		/*
699
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
700
		 * We should make sure to only do this for front end links.
701
		 */
702
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
703
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
704
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
705
706
			/*
707
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
708
			 * so they point moderation links on emails to Calypso.
709
			 */
710
			jetpack_require_lib( 'functions.wp-notify' );
711
		}
712
713
		// Hide edit post link if mobile app.
714
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
715
			add_filter( 'get_edit_post_link', '__return_empty_string' );
716
		}
717
718
		// Update the Jetpack plan from API on heartbeats.
719
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
720
721
		/**
722
		 * This is the hack to concatenate all css files into one.
723
		 * For description and reasoning see the implode_frontend_css method.
724
		 *
725
		 * Super late priority so we catch all the registered styles.
726
		 */
727
		if ( ! is_admin() ) {
728
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
729
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
730
		}
731
732
		/**
733
		 * These are sync actions that we need to keep track of for jitms
734
		 */
735
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
736
737
		// Actually push the stats on shutdown.
738
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
739
			add_action( 'shutdown', array( $this, 'push_stats' ) );
740
		}
741
742
		/*
743
		 * Load some scripts asynchronously.
744
		 */
745
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
746
747
		// Actions for Manager::authorize().
748
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
749
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
750
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
751
752
		// Filters for the Manager::get_token() urls and request body.
753
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
754
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
755
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
756
	}
757
758
	/**
759
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
760
	 * Config object.
761
	 */
762
	public function configure() {
763
		$config = new Config();
764
765
		foreach (
766
			array(
767
				'sync',
768
				'tracking',
769
				'tos',
770
			)
771
			as $feature
772
		) {
773
			$config->ensure( $feature );
774
		}
775
776
		$config->ensure(
777
			'connection',
778
			array(
779
				'slug' => 'jetpack',
780
				'name' => 'Jetpack',
781
			)
782
		);
783
784
		if ( is_admin() ) {
785
			$config->ensure( 'jitm' );
786
		}
787
788
		if ( ! $this->connection_manager ) {
789
			$this->connection_manager = new Connection_Manager( 'jetpack' );
790
		}
791
792
		/*
793
		 * Load things that should only be in Network Admin.
794
		 *
795
		 * For now blow away everything else until a more full
796
		 * understanding of what is needed at the network level is
797
		 * available
798
		 */
799
		if ( is_multisite() ) {
800
			$network = Jetpack_Network::init();
801
			$network->set_connection( $this->connection_manager );
802
		}
803
804
		if ( $this->connection_manager->is_active() ) {
805
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
806
807
			Jetpack_Heartbeat::init();
808
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
809
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
810
				Jetpack_Search_Performance_Logger::init();
811
			}
812
		}
813
814
		// Initialize remote file upload request handlers.
815
		$this->add_remote_request_handlers();
816
817
		/*
818
		 * Enable enhanced handling of previewing sites in Calypso
819
		 */
820
		if ( self::is_active() ) {
821
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
822
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
823
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
824
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
825
		}
826
	}
827
828
	/**
829
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
830
	 * initialization code.
831
	 *
832
	 * @action plugins_loaded
833
	 */
834
	public function late_initialization() {
835
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
836
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
837
838
		Partner::init();
839
840
		/**
841
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
842
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
843
		 *
844
		 * @since 8.1.0
845
		 *
846
		 * @param Jetpack $jetpack the main plugin class object.
847
		 */
848
		do_action( 'jetpack_loaded', $this );
849
850
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
851
	}
852
853
	/**
854
	 * Sets up the XMLRPC request handlers.
855
	 *
856
	 * @deprecated since 7.7.0
857
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
858
	 *
859
	 * @param array                 $request_params Incoming request parameters.
860
	 * @param Boolean               $is_active      Whether the connection is currently active.
861
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
862
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
863
	 */
864 View Code Duplication
	public function setup_xmlrpc_handlers(
865
		$request_params,
866
		$is_active,
867
		$is_signed,
868
		Jetpack_XMLRPC_Server $xmlrpc_server = null
869
	) {
870
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
871
872
		if ( ! $this->connection_manager ) {
873
			$this->connection_manager = new Connection_Manager();
874
		}
875
876
		return $this->connection_manager->setup_xmlrpc_handlers(
877
			$request_params,
878
			$is_active,
879
			$is_signed,
880
			$xmlrpc_server
881
		);
882
	}
883
884
	/**
885
	 * Initialize REST API registration connector.
886
	 *
887
	 * @deprecated since 7.7.0
888
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
889
	 */
890 View Code Duplication
	public function initialize_rest_api_registration_connector() {
891
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
892
893
		if ( ! $this->connection_manager ) {
894
			$this->connection_manager = new Connection_Manager();
895
		}
896
897
		$this->connection_manager->initialize_rest_api_registration_connector();
898
	}
899
900
	/**
901
	 * This is ported over from the manage module, which has been deprecated and baked in here.
902
	 *
903
	 * @param $domains
904
	 */
905
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
906
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
907
	}
908
909
	/**
910
	 * Return $domains, with 'wordpress.com' appended.
911
	 * This is ported over from the manage module, which has been deprecated and baked in here.
912
	 *
913
	 * @param $domains
914
	 * @return array
915
	 */
916
	function allow_wpcom_domain( $domains ) {
917
		if ( empty( $domains ) ) {
918
			$domains = array();
919
		}
920
		$domains[] = 'wordpress.com';
921
		return array_unique( $domains );
922
	}
923
924
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
925
		$post = get_post( $post_id );
926
927
		if ( empty( $post ) ) {
928
			return $default_url;
929
		}
930
931
		$post_type = $post->post_type;
932
933
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
934
		// https://en.support.wordpress.com/custom-post-types/
935
		$allowed_post_types = array(
936
			'post',
937
			'page',
938
			'jetpack-portfolio',
939
			'jetpack-testimonial',
940
		);
941
942
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
943
			return $default_url;
944
		}
945
946
		return esc_url(
947
			Redirect::get_url(
948
				'calypso-edit-' . $post_type,
949
				array(
950
					'path' => $post_id,
951
				)
952
			)
953
		);
954
	}
955
956
	function point_edit_comment_links_to_calypso( $url ) {
957
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
958
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
959
960
		return esc_url(
961
			Redirect::get_url(
962
				'calypso-edit-comment',
963
				array(
964
					'path' => $query_args['amp;c'],
965
				)
966
			)
967
		);
968
969
	}
970
971
	function jetpack_track_last_sync_callback( $params ) {
972
		/**
973
		 * Filter to turn off jitm caching
974
		 *
975
		 * @since 5.4.0
976
		 *
977
		 * @param bool false Whether to cache just in time messages
978
		 */
979
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
980
			return $params;
981
		}
982
983
		if ( is_array( $params ) && isset( $params[0] ) ) {
984
			$option = $params[0];
985
			if ( 'active_plugins' === $option ) {
986
				// use the cache if we can, but not terribly important if it gets evicted
987
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
988
			}
989
		}
990
991
		return $params;
992
	}
993
994
	function jetpack_connection_banner_callback() {
995
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
996
997
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
998
		if (
999
			isset( $_REQUEST['dismissBanner'] ) &&
1000
			! Jetpack_Connection_Banner::force_display()
1001
		) {
1002
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1003
			wp_send_json_success();
1004
		}
1005
1006
		wp_die();
1007
	}
1008
1009
	/**
1010
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1011
	 * Only used in our alternate XML-RPC endpoint, where we want to
1012
	 * ensure that Core and other plugins' methods are not exposed.
1013
	 *
1014
	 * @deprecated since 7.7.0
1015
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1016
	 *
1017
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1018
	 * @return array Filtered $methods
1019
	 */
1020 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1021
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1022
1023
		if ( ! $this->connection_manager ) {
1024
			$this->connection_manager = new Connection_Manager();
1025
		}
1026
1027
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1028
	}
1029
1030
	/**
1031
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1032
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1033
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1034
	 * which is accessible via a different URI. Most of the below is copied directly
1035
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1036
	 *
1037
	 * @deprecated since 7.7.0
1038
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1039
	 */
1040 View Code Duplication
	public function alternate_xmlrpc() {
1041
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1042
1043
		if ( ! $this->connection_manager ) {
1044
			$this->connection_manager = new Connection_Manager();
1045
		}
1046
1047
		$this->connection_manager->alternate_xmlrpc();
1048
	}
1049
1050
	/**
1051
	 * The callback for the JITM ajax requests.
1052
	 *
1053
	 * @deprecated since 7.9.0
1054
	 */
1055
	function jetpack_jitm_ajax_callback() {
1056
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1057
	}
1058
1059
	/**
1060
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1061
	 */
1062
	function push_stats() {
1063
		if ( ! empty( $this->stats ) ) {
1064
			$this->do_stats( 'server_side' );
1065
		}
1066
	}
1067
1068
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1069
		$is_development_mode = ( new Status() )->is_development_mode();
1070
		switch ( $cap ) {
1071
			case 'jetpack_connect':
1072
			case 'jetpack_reconnect':
1073
				if ( $is_development_mode ) {
1074
					$caps = array( 'do_not_allow' );
1075
					break;
1076
				}
1077
				/**
1078
				 * Pass through. If it's not development mode, these should match disconnect.
1079
				 * Let users disconnect if it's development mode, just in case things glitch.
1080
				 */
1081
			case 'jetpack_disconnect':
1082
				/**
1083
				 * In multisite, can individual site admins manage their own connection?
1084
				 *
1085
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1086
				 */
1087
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1088
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1089
						/**
1090
						 * We need to update the option name -- it's terribly unclear which
1091
						 * direction the override goes.
1092
						 *
1093
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1094
						 */
1095
						$caps = array( 'do_not_allow' );
1096
						break;
1097
					}
1098
				}
1099
1100
				$caps = array( 'manage_options' );
1101
				break;
1102
			case 'jetpack_manage_modules':
1103
			case 'jetpack_activate_modules':
1104
			case 'jetpack_deactivate_modules':
1105
				$caps = array( 'manage_options' );
1106
				break;
1107
			case 'jetpack_configure_modules':
1108
				$caps = array( 'manage_options' );
1109
				break;
1110
			case 'jetpack_manage_autoupdates':
1111
				$caps = array(
1112
					'manage_options',
1113
					'update_plugins',
1114
				);
1115
				break;
1116
			case 'jetpack_network_admin_page':
1117
			case 'jetpack_network_settings_page':
1118
				$caps = array( 'manage_network_plugins' );
1119
				break;
1120
			case 'jetpack_network_sites_page':
1121
				$caps = array( 'manage_sites' );
1122
				break;
1123
			case 'jetpack_admin_page':
1124
				if ( $is_development_mode ) {
1125
					$caps = array( 'manage_options' );
1126
					break;
1127
				} else {
1128
					$caps = array( 'read' );
1129
				}
1130
				break;
1131
			case 'jetpack_connect_user':
1132
				if ( $is_development_mode ) {
1133
					$caps = array( 'do_not_allow' );
1134
					break;
1135
				}
1136
				$caps = array( 'read' );
1137
				break;
1138
		}
1139
		return $caps;
1140
	}
1141
1142
	/**
1143
	 * Require a Jetpack authentication.
1144
	 *
1145
	 * @deprecated since 7.7.0
1146
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1147
	 */
1148 View Code Duplication
	public function require_jetpack_authentication() {
1149
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1150
1151
		if ( ! $this->connection_manager ) {
1152
			$this->connection_manager = new Connection_Manager();
1153
		}
1154
1155
		$this->connection_manager->require_jetpack_authentication();
1156
	}
1157
1158
	/**
1159
	 * Load language files
1160
	 *
1161
	 * @action plugins_loaded
1162
	 */
1163
	public static function plugin_textdomain() {
1164
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1165
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1166
	}
1167
1168
	/**
1169
	 * Register assets for use in various modules and the Jetpack admin page.
1170
	 *
1171
	 * @uses wp_script_is, wp_register_script, plugins_url
1172
	 * @action wp_loaded
1173
	 * @return null
1174
	 */
1175
	public function register_assets() {
1176
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1177
			wp_register_script(
1178
				'spin',
1179
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1180
				false,
1181
				'1.3'
1182
			);
1183
		}
1184
1185 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1186
			wp_register_script(
1187
				'jquery.spin',
1188
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1189
				array( 'jquery', 'spin' ),
1190
				'1.3'
1191
			);
1192
		}
1193
1194 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1195
			wp_register_script(
1196
				'jetpack-gallery-settings',
1197
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1198
				array( 'media-views' ),
1199
				'20121225'
1200
			);
1201
		}
1202
1203 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1204
			wp_register_script(
1205
				'jetpack-twitter-timeline',
1206
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1207
				array( 'jquery' ),
1208
				'4.0.0',
1209
				true
1210
			);
1211
		}
1212
1213
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1214
			wp_register_script(
1215
				'jetpack-facebook-embed',
1216
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1217
				array(),
1218
				null,
1219
				true
1220
			);
1221
1222
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1223
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1224
			if ( ! is_numeric( $fb_app_id ) ) {
1225
				$fb_app_id = '';
1226
			}
1227
			wp_localize_script(
1228
				'jetpack-facebook-embed',
1229
				'jpfbembed',
1230
				array(
1231
					'appid'  => $fb_app_id,
1232
					'locale' => $this->get_locale(),
1233
				)
1234
			);
1235
		}
1236
1237
		/**
1238
		 * As jetpack_register_genericons is by default fired off a hook,
1239
		 * the hook may have already fired by this point.
1240
		 * So, let's just trigger it manually.
1241
		 */
1242
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1243
		jetpack_register_genericons();
1244
1245
		/**
1246
		 * Register the social logos
1247
		 */
1248
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1249
		jetpack_register_social_logos();
1250
1251 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1252
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1253
		}
1254
	}
1255
1256
	/**
1257
	 * Guess locale from language code.
1258
	 *
1259
	 * @param string $lang Language code.
1260
	 * @return string|bool
1261
	 */
1262 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1263
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1264
			return 'en_US';
1265
		}
1266
1267
		if ( ! class_exists( 'GP_Locales' ) ) {
1268
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1269
				return false;
1270
			}
1271
1272
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1273
		}
1274
1275
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1276
			// WP.com: get_locale() returns 'it'
1277
			$locale = GP_Locales::by_slug( $lang );
1278
		} else {
1279
			// Jetpack: get_locale() returns 'it_IT';
1280
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1281
		}
1282
1283
		if ( ! $locale ) {
1284
			return false;
1285
		}
1286
1287
		if ( empty( $locale->facebook_locale ) ) {
1288
			if ( empty( $locale->wp_locale ) ) {
1289
				return false;
1290
			} else {
1291
				// Facebook SDK is smart enough to fall back to en_US if a
1292
				// locale isn't supported. Since supported Facebook locales
1293
				// can fall out of sync, we'll attempt to use the known
1294
				// wp_locale value and rely on said fallback.
1295
				return $locale->wp_locale;
1296
			}
1297
		}
1298
1299
		return $locale->facebook_locale;
1300
	}
1301
1302
	/**
1303
	 * Get the locale.
1304
	 *
1305
	 * @return string|bool
1306
	 */
1307
	function get_locale() {
1308
		$locale = $this->guess_locale_from_lang( get_locale() );
1309
1310
		if ( ! $locale ) {
1311
			$locale = 'en_US';
1312
		}
1313
1314
		return $locale;
1315
	}
1316
1317
	/**
1318
	 * Return the network_site_url so that .com knows what network this site is a part of.
1319
	 *
1320
	 * @param  bool $option
1321
	 * @return string
1322
	 */
1323
	public function jetpack_main_network_site_option( $option ) {
1324
		return network_site_url();
1325
	}
1326
	/**
1327
	 * Network Name.
1328
	 */
1329
	static function network_name( $option = null ) {
1330
		global $current_site;
1331
		return $current_site->site_name;
1332
	}
1333
	/**
1334
	 * Does the network allow new user and site registrations.
1335
	 *
1336
	 * @return string
1337
	 */
1338
	static function network_allow_new_registrations( $option = null ) {
1339
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1340
	}
1341
	/**
1342
	 * Does the network allow admins to add new users.
1343
	 *
1344
	 * @return boolian
1345
	 */
1346
	static function network_add_new_users( $option = null ) {
1347
		return (bool) get_site_option( 'add_new_users' );
1348
	}
1349
	/**
1350
	 * File upload psace left per site in MB.
1351
	 *  -1 means NO LIMIT.
1352
	 *
1353
	 * @return number
1354
	 */
1355
	static function network_site_upload_space( $option = null ) {
1356
		// value in MB
1357
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1358
	}
1359
1360
	/**
1361
	 * Network allowed file types.
1362
	 *
1363
	 * @return string
1364
	 */
1365
	static function network_upload_file_types( $option = null ) {
1366
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1367
	}
1368
1369
	/**
1370
	 * Maximum file upload size set by the network.
1371
	 *
1372
	 * @return number
1373
	 */
1374
	static function network_max_upload_file_size( $option = null ) {
1375
		// value in KB
1376
		return get_site_option( 'fileupload_maxk', 300 );
1377
	}
1378
1379
	/**
1380
	 * Lets us know if a site allows admins to manage the network.
1381
	 *
1382
	 * @return array
1383
	 */
1384
	static function network_enable_administration_menus( $option = null ) {
1385
		return get_site_option( 'menu_items' );
1386
	}
1387
1388
	/**
1389
	 * If a user has been promoted to or demoted from admin, we need to clear the
1390
	 * jetpack_other_linked_admins transient.
1391
	 *
1392
	 * @since 4.3.2
1393
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1394
	 *
1395
	 * @param int    $user_id   The user ID whose role changed.
1396
	 * @param string $role      The new role.
1397
	 * @param array  $old_roles An array of the user's previous roles.
1398
	 */
1399
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1400
		if ( 'administrator' == $role
1401
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1402
			|| is_null( $old_roles )
1403
		) {
1404
			delete_transient( 'jetpack_other_linked_admins' );
1405
		}
1406
	}
1407
1408
	/**
1409
	 * Checks to see if there are any other users available to become primary
1410
	 * Users must both:
1411
	 * - Be linked to wpcom
1412
	 * - Be an admin
1413
	 *
1414
	 * @return mixed False if no other users are linked, Int if there are.
1415
	 */
1416
	static function get_other_linked_admins() {
1417
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1418
1419
		if ( false === $other_linked_users ) {
1420
			$admins = get_users( array( 'role' => 'administrator' ) );
1421
			if ( count( $admins ) > 1 ) {
1422
				$available = array();
1423
				foreach ( $admins as $admin ) {
1424
					if ( self::is_user_connected( $admin->ID ) ) {
1425
						$available[] = $admin->ID;
1426
					}
1427
				}
1428
1429
				$count_connected_admins = count( $available );
1430
				if ( count( $available ) > 1 ) {
1431
					$other_linked_users = $count_connected_admins;
1432
				} else {
1433
					$other_linked_users = 0;
1434
				}
1435
			} else {
1436
				$other_linked_users = 0;
1437
			}
1438
1439
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1440
		}
1441
1442
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1443
	}
1444
1445
	/**
1446
	 * Return whether we are dealing with a multi network setup or not.
1447
	 * The reason we are type casting this is because we want to avoid the situation where
1448
	 * the result is false since when is_main_network_option return false it cases
1449
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1450
	 * database which could be set to anything as opposed to what this function returns.
1451
	 *
1452
	 * @param  bool $option
1453
	 *
1454
	 * @return boolean
1455
	 */
1456
	public function is_main_network_option( $option ) {
1457
		// return '1' or ''
1458
		return (string) (bool) self::is_multi_network();
1459
	}
1460
1461
	/**
1462
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1463
	 *
1464
	 * @param  string $option
1465
	 * @return boolean
1466
	 */
1467
	public function is_multisite( $option ) {
1468
		return (string) (bool) is_multisite();
1469
	}
1470
1471
	/**
1472
	 * Implemented since there is no core is multi network function
1473
	 * Right now there is no way to tell if we which network is the dominant network on the system
1474
	 *
1475
	 * @since  3.3
1476
	 * @return boolean
1477
	 */
1478 View Code Duplication
	public static function is_multi_network() {
1479
		global  $wpdb;
1480
1481
		// if we don't have a multi site setup no need to do any more
1482
		if ( ! is_multisite() ) {
1483
			return false;
1484
		}
1485
1486
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1487
		if ( $num_sites > 1 ) {
1488
			return true;
1489
		} else {
1490
			return false;
1491
		}
1492
	}
1493
1494
	/**
1495
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1496
	 *
1497
	 * @return null
1498
	 */
1499
	function update_jetpack_main_network_site_option() {
1500
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1501
	}
1502
	/**
1503
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1504
	 */
1505
	function update_jetpack_network_settings() {
1506
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1507
		// Only sync this info for the main network site.
1508
	}
1509
1510
	/**
1511
	 * Get back if the current site is single user site.
1512
	 *
1513
	 * @return bool
1514
	 */
1515 View Code Duplication
	public static function is_single_user_site() {
1516
		global $wpdb;
1517
1518
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1519
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1520
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1521
		}
1522
		return 1 === (int) $some_users;
1523
	}
1524
1525
	/**
1526
	 * Returns true if the site has file write access false otherwise.
1527
	 *
1528
	 * @return string ( '1' | '0' )
1529
	 **/
1530
	public static function file_system_write_access() {
1531
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1532
			require_once ABSPATH . 'wp-admin/includes/file.php';
1533
		}
1534
1535
		require_once ABSPATH . 'wp-admin/includes/template.php';
1536
1537
		$filesystem_method = get_filesystem_method();
1538
		if ( $filesystem_method === 'direct' ) {
1539
			return 1;
1540
		}
1541
1542
		ob_start();
1543
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1544
		ob_end_clean();
1545
		if ( $filesystem_credentials_are_stored ) {
1546
			return 1;
1547
		}
1548
		return 0;
1549
	}
1550
1551
	/**
1552
	 * Finds out if a site is using a version control system.
1553
	 *
1554
	 * @return string ( '1' | '0' )
1555
	 **/
1556
	public static function is_version_controlled() {
1557
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1558
		return (string) (int) Functions::is_version_controlled();
1559
	}
1560
1561
	/**
1562
	 * Determines whether the current theme supports featured images or not.
1563
	 *
1564
	 * @return string ( '1' | '0' )
1565
	 */
1566
	public static function featured_images_enabled() {
1567
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1568
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1569
	}
1570
1571
	/**
1572
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1573
	 *
1574
	 * @deprecated 4.7 use get_avatar_url instead.
1575
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1576
	 * @param int               $size Size of the avatar image
1577
	 * @param string            $default URL to a default image to use if no avatar is available
1578
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1579
	 *
1580
	 * @return array
1581
	 */
1582
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1583
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1584
		return get_avatar_url(
1585
			$id_or_email,
1586
			array(
1587
				'size'          => $size,
1588
				'default'       => $default,
1589
				'force_default' => $force_display,
1590
			)
1591
		);
1592
	}
1593
1594
	/**
1595
	 * jetpack_updates is saved in the following schema:
1596
	 *
1597
	 * array (
1598
	 *      'plugins'                       => (int) Number of plugin updates available.
1599
	 *      'themes'                        => (int) Number of theme updates available.
1600
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1601
	 *      'translations'                  => (int) Number of translation updates available.
1602
	 *      'total'                         => (int) Total of all available updates.
1603
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1604
	 * )
1605
	 *
1606
	 * @return array
1607
	 */
1608
	public static function get_updates() {
1609
		$update_data = wp_get_update_data();
1610
1611
		// Stores the individual update counts as well as the total count.
1612
		if ( isset( $update_data['counts'] ) ) {
1613
			$updates = $update_data['counts'];
1614
		}
1615
1616
		// If we need to update WordPress core, let's find the latest version number.
1617 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1618
			$cur = get_preferred_from_update_core();
1619
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1620
				$updates['wp_update_version'] = $cur->current;
1621
			}
1622
		}
1623
		return isset( $updates ) ? $updates : array();
1624
	}
1625
1626
	public static function get_update_details() {
1627
		$update_details = array(
1628
			'update_core'    => get_site_transient( 'update_core' ),
1629
			'update_plugins' => get_site_transient( 'update_plugins' ),
1630
			'update_themes'  => get_site_transient( 'update_themes' ),
1631
		);
1632
		return $update_details;
1633
	}
1634
1635
	public static function refresh_update_data() {
1636
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1637
1638
	}
1639
1640
	public static function refresh_theme_data() {
1641
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1642
	}
1643
1644
	/**
1645
	 * Is Jetpack active?
1646
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1647
	 *
1648
	 * @return bool
1649
	 */
1650
	public static function is_active() {
1651
		return self::connection()->is_active();
1652
	}
1653
1654
	/**
1655
	 * Make an API call to WordPress.com for plan status
1656
	 *
1657
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1658
	 *
1659
	 * @return bool True if plan is updated, false if no update
1660
	 */
1661
	public static function refresh_active_plan_from_wpcom() {
1662
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1663
		return Jetpack_Plan::refresh_from_wpcom();
1664
	}
1665
1666
	/**
1667
	 * Get the plan that this Jetpack site is currently using
1668
	 *
1669
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1670
	 * @return array Active Jetpack plan details.
1671
	 */
1672
	public static function get_active_plan() {
1673
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1674
		return Jetpack_Plan::get();
1675
	}
1676
1677
	/**
1678
	 * Determine whether the active plan supports a particular feature
1679
	 *
1680
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1681
	 * @return bool True if plan supports feature, false if not.
1682
	 */
1683
	public static function active_plan_supports( $feature ) {
1684
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1685
		return Jetpack_Plan::supports( $feature );
1686
	}
1687
1688
	/**
1689
	 * Deprecated: Is Jetpack in development (offline) mode?
1690
	 *
1691
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1692
	 * and themes still use it, and we do not want to flood them with notices.
1693
	 *
1694
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1695
	 *
1696
	 * @deprecated since 8.0.
1697
	 */
1698
	public static function is_development_mode() {
1699
		return ( new Status() )->is_development_mode();
1700
	}
1701
1702
	/**
1703
	 * Whether the site is currently onboarding or not.
1704
	 * A site is considered as being onboarded if it currently has an onboarding token.
1705
	 *
1706
	 * @since 5.8
1707
	 *
1708
	 * @access public
1709
	 * @static
1710
	 *
1711
	 * @return bool True if the site is currently onboarding, false otherwise
1712
	 */
1713
	public static function is_onboarding() {
1714
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1715
	}
1716
1717
	/**
1718
	 * Determines reason for Jetpack development mode.
1719
	 */
1720
	public static function development_mode_trigger_text() {
1721
		if ( ! ( new Status() )->is_development_mode() ) {
1722
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1723
		}
1724
1725
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1726
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1727
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1728
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1729
		} else {
1730
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1731
		}
1732
1733
		return $notice;
1734
1735
	}
1736
	/**
1737
	 * Get Jetpack development mode notice text and notice class.
1738
	 *
1739
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1740
	 */
1741
	public static function show_development_mode_notice() {
1742 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1743
			$notice = sprintf(
1744
				/* translators: %s is a URL */
1745
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1746
				Redirect::get_url( 'jetpack-support-development-mode' )
1747
			);
1748
1749
			$notice .= ' ' . self::development_mode_trigger_text();
1750
1751
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1752
		}
1753
1754
		// Throw up a notice if using a development version and as for feedback.
1755
		if ( self::is_development_version() ) {
1756
			/* translators: %s is a URL */
1757
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), Redirect::get_url( 'jetpack-contact-support-beta-group' ) );
1758
1759
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1760
		}
1761
		// Throw up a notice if using staging mode
1762 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1763
			/* translators: %s is a URL */
1764
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1765
1766
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1767
		}
1768
	}
1769
1770
	/**
1771
	 * Whether Jetpack's version maps to a public release, or a development version.
1772
	 */
1773
	public static function is_development_version() {
1774
		/**
1775
		 * Allows filtering whether this is a development version of Jetpack.
1776
		 *
1777
		 * This filter is especially useful for tests.
1778
		 *
1779
		 * @since 4.3.0
1780
		 *
1781
		 * @param bool $development_version Is this a develoment version of Jetpack?
1782
		 */
1783
		return (bool) apply_filters(
1784
			'jetpack_development_version',
1785
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1786
		);
1787
	}
1788
1789
	/**
1790
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1791
	 */
1792
	public static function is_user_connected( $user_id = false ) {
1793
		return self::connection()->is_user_connected( $user_id );
1794
	}
1795
1796
	/**
1797
	 * Get the wpcom user data of the current|specified connected user.
1798
	 */
1799 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1800
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1801
		if ( ! $user_id ) {
1802
			$user_id = get_current_user_id();
1803
		}
1804
1805
		$transient_key = "jetpack_connected_user_data_$user_id";
1806
1807
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1808
			return $cached_user_data;
1809
		}
1810
1811
		$xml = new Jetpack_IXR_Client(
1812
			array(
1813
				'user_id' => $user_id,
1814
			)
1815
		);
1816
		$xml->query( 'wpcom.getUser' );
1817
		if ( ! $xml->isError() ) {
1818
			$user_data = $xml->getResponse();
1819
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1820
			return $user_data;
1821
		}
1822
1823
		return false;
1824
	}
1825
1826
	/**
1827
	 * Get the wpcom email of the current|specified connected user.
1828
	 */
1829
	public static function get_connected_user_email( $user_id = null ) {
1830
		if ( ! $user_id ) {
1831
			$user_id = get_current_user_id();
1832
		}
1833
1834
		$xml = new Jetpack_IXR_Client(
1835
			array(
1836
				'user_id' => $user_id,
1837
			)
1838
		);
1839
		$xml->query( 'wpcom.getUserEmail' );
1840
		if ( ! $xml->isError() ) {
1841
			return $xml->getResponse();
1842
		}
1843
		return false;
1844
	}
1845
1846
	/**
1847
	 * Get the wpcom email of the master user.
1848
	 */
1849
	public static function get_master_user_email() {
1850
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1851
		if ( $master_user_id ) {
1852
			return self::get_connected_user_email( $master_user_id );
1853
		}
1854
		return '';
1855
	}
1856
1857
	/**
1858
	 * Whether the current user is the connection owner.
1859
	 *
1860
	 * @deprecated since 7.7
1861
	 *
1862
	 * @return bool Whether the current user is the connection owner.
1863
	 */
1864
	public function current_user_is_connection_owner() {
1865
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1866
		return self::connection()->is_connection_owner();
1867
	}
1868
1869
	/**
1870
	 * Gets current user IP address.
1871
	 *
1872
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1873
	 *
1874
	 * @return string                  Current user IP address.
1875
	 */
1876
	public static function current_user_ip( $check_all_headers = false ) {
1877
		if ( $check_all_headers ) {
1878
			foreach ( array(
1879
				'HTTP_CF_CONNECTING_IP',
1880
				'HTTP_CLIENT_IP',
1881
				'HTTP_X_FORWARDED_FOR',
1882
				'HTTP_X_FORWARDED',
1883
				'HTTP_X_CLUSTER_CLIENT_IP',
1884
				'HTTP_FORWARDED_FOR',
1885
				'HTTP_FORWARDED',
1886
				'HTTP_VIA',
1887
			) as $key ) {
1888
				if ( ! empty( $_SERVER[ $key ] ) ) {
1889
					return $_SERVER[ $key ];
1890
				}
1891
			}
1892
		}
1893
1894
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1895
	}
1896
1897
	/**
1898
	 * Synchronize connected user role changes
1899
	 */
1900
	function user_role_change( $user_id ) {
1901
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1902
		Users::user_role_change( $user_id );
1903
	}
1904
1905
	/**
1906
	 * Loads the currently active modules.
1907
	 */
1908
	public static function load_modules() {
1909
		$is_development_mode = ( new Status() )->is_development_mode();
1910
		if (
1911
			! self::is_active()
1912
			&& ! $is_development_mode
1913
			&& ! self::is_onboarding()
1914
			&& (
1915
				! is_multisite()
1916
				|| ! get_site_option( 'jetpack_protect_active' )
1917
			)
1918
		) {
1919
			return;
1920
		}
1921
1922
		$version = Jetpack_Options::get_option( 'version' );
1923 View Code Duplication
		if ( ! $version ) {
1924
			$version = $old_version = JETPACK__VERSION . ':' . time();
1925
			/** This action is documented in class.jetpack.php */
1926
			do_action( 'updating_jetpack_version', $version, false );
1927
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1928
		}
1929
		list( $version ) = explode( ':', $version );
1930
1931
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1932
1933
		$modules_data = array();
1934
1935
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1936
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1937
			$updated_modules = array();
1938
			foreach ( $modules as $module ) {
1939
				$modules_data[ $module ] = self::get_module( $module );
1940
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1941
					continue;
1942
				}
1943
1944
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1945
					continue;
1946
				}
1947
1948
				$updated_modules[] = $module;
1949
			}
1950
1951
			$modules = array_diff( $modules, $updated_modules );
1952
		}
1953
1954
		foreach ( $modules as $index => $module ) {
1955
			// If we're in dev mode, disable modules requiring a connection
1956
			if ( $is_development_mode ) {
1957
				// Prime the pump if we need to
1958
				if ( empty( $modules_data[ $module ] ) ) {
1959
					$modules_data[ $module ] = self::get_module( $module );
1960
				}
1961
				// If the module requires a connection, but we're in local mode, don't include it.
1962
				if ( $modules_data[ $module ]['requires_connection'] ) {
1963
					continue;
1964
				}
1965
			}
1966
1967
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1968
				continue;
1969
			}
1970
1971
			if ( ! include_once self::get_module_path( $module ) ) {
1972
				unset( $modules[ $index ] );
1973
				self::update_active_modules( array_values( $modules ) );
1974
				continue;
1975
			}
1976
1977
			/**
1978
			 * Fires when a specific module is loaded.
1979
			 * The dynamic part of the hook, $module, is the module slug.
1980
			 *
1981
			 * @since 1.1.0
1982
			 */
1983
			do_action( 'jetpack_module_loaded_' . $module );
1984
		}
1985
1986
		/**
1987
		 * Fires when all the modules are loaded.
1988
		 *
1989
		 * @since 1.1.0
1990
		 */
1991
		do_action( 'jetpack_modules_loaded' );
1992
1993
		// 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.
1994
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1995
	}
1996
1997
	/**
1998
	 * Check if Jetpack's REST API compat file should be included
1999
	 *
2000
	 * @action plugins_loaded
2001
	 * @return null
2002
	 */
2003
	public function check_rest_api_compat() {
2004
		/**
2005
		 * Filters the list of REST API compat files to be included.
2006
		 *
2007
		 * @since 2.2.5
2008
		 *
2009
		 * @param array $args Array of REST API compat files to include.
2010
		 */
2011
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2012
2013
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2014
			require_once $_jetpack_rest_api_compat_include;
2015
		}
2016
	}
2017
2018
	/**
2019
	 * Gets all plugins currently active in values, regardless of whether they're
2020
	 * traditionally activated or network activated.
2021
	 *
2022
	 * @todo Store the result in core's object cache maybe?
2023
	 */
2024
	public static function get_active_plugins() {
2025
		$active_plugins = (array) get_option( 'active_plugins', array() );
2026
2027
		if ( is_multisite() ) {
2028
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2029
			// whereas active_plugins stores them in the values.
2030
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2031
			if ( $network_plugins ) {
2032
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2033
			}
2034
		}
2035
2036
		sort( $active_plugins );
2037
2038
		return array_unique( $active_plugins );
2039
	}
2040
2041
	/**
2042
	 * Gets and parses additional plugin data to send with the heartbeat data
2043
	 *
2044
	 * @since 3.8.1
2045
	 *
2046
	 * @return array Array of plugin data
2047
	 */
2048
	public static function get_parsed_plugin_data() {
2049
		if ( ! function_exists( 'get_plugins' ) ) {
2050
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2051
		}
2052
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2053
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2054
		$active_plugins = self::get_active_plugins();
2055
2056
		$plugins = array();
2057
		foreach ( $all_plugins as $path => $plugin_data ) {
2058
			$plugins[ $path ] = array(
2059
				'is_active' => in_array( $path, $active_plugins ),
2060
				'file'      => $path,
2061
				'name'      => $plugin_data['Name'],
2062
				'version'   => $plugin_data['Version'],
2063
				'author'    => $plugin_data['Author'],
2064
			);
2065
		}
2066
2067
		return $plugins;
2068
	}
2069
2070
	/**
2071
	 * Gets and parses theme data to send with the heartbeat data
2072
	 *
2073
	 * @since 3.8.1
2074
	 *
2075
	 * @return array Array of theme data
2076
	 */
2077
	public static function get_parsed_theme_data() {
2078
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2079
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2080
2081
		$themes = array();
2082
		foreach ( $all_themes as $slug => $theme_data ) {
2083
			$theme_headers = array();
2084
			foreach ( $header_keys as $header_key ) {
2085
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2086
			}
2087
2088
			$themes[ $slug ] = array(
2089
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2090
				'slug'            => $slug,
2091
				'theme_root'      => $theme_data->get_theme_root_uri(),
2092
				'parent'          => $theme_data->parent(),
2093
				'headers'         => $theme_headers,
2094
			);
2095
		}
2096
2097
		return $themes;
2098
	}
2099
2100
	/**
2101
	 * Checks whether a specific plugin is active.
2102
	 *
2103
	 * We don't want to store these in a static variable, in case
2104
	 * there are switch_to_blog() calls involved.
2105
	 */
2106
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2107
		return in_array( $plugin, self::get_active_plugins() );
2108
	}
2109
2110
	/**
2111
	 * Check if Jetpack's Open Graph tags should be used.
2112
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2113
	 *
2114
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2115
	 * @action plugins_loaded
2116
	 * @return null
2117
	 */
2118
	public function check_open_graph() {
2119
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2120
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2121
		}
2122
2123
		$active_plugins = self::get_active_plugins();
2124
2125
		if ( ! empty( $active_plugins ) ) {
2126
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2127
				if ( in_array( $plugin, $active_plugins ) ) {
2128
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2129
					break;
2130
				}
2131
			}
2132
		}
2133
2134
		/**
2135
		 * Allow the addition of Open Graph Meta Tags to all pages.
2136
		 *
2137
		 * @since 2.0.3
2138
		 *
2139
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2140
		 */
2141
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2142
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2143
		}
2144
	}
2145
2146
	/**
2147
	 * Check if Jetpack's Twitter tags should be used.
2148
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2149
	 *
2150
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2151
	 * @action plugins_loaded
2152
	 * @return null
2153
	 */
2154
	public function check_twitter_tags() {
2155
2156
		$active_plugins = self::get_active_plugins();
2157
2158
		if ( ! empty( $active_plugins ) ) {
2159
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2160
				if ( in_array( $plugin, $active_plugins ) ) {
2161
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2162
					break;
2163
				}
2164
			}
2165
		}
2166
2167
		/**
2168
		 * Allow Twitter Card Meta tags to be disabled.
2169
		 *
2170
		 * @since 2.6.0
2171
		 *
2172
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2173
		 */
2174
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2175
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2176
		}
2177
	}
2178
2179
	/**
2180
	 * Allows plugins to submit security reports.
2181
	 *
2182
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2183
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2184
	 * @param array  $args         See definitions above
2185
	 */
2186
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2187
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2188
	}
2189
2190
	/* Jetpack Options API */
2191
2192
	public static function get_option_names( $type = 'compact' ) {
2193
		return Jetpack_Options::get_option_names( $type );
2194
	}
2195
2196
	/**
2197
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2198
	 *
2199
	 * @param string $name    Option name
2200
	 * @param mixed  $default (optional)
2201
	 */
2202
	public static function get_option( $name, $default = false ) {
2203
		return Jetpack_Options::get_option( $name, $default );
2204
	}
2205
2206
	/**
2207
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2208
	 *
2209
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2210
	 * @param string $name  Option name
2211
	 * @param mixed  $value Option value
2212
	 */
2213
	public static function update_option( $name, $value ) {
2214
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2215
		return Jetpack_Options::update_option( $name, $value );
2216
	}
2217
2218
	/**
2219
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2220
	 *
2221
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2222
	 * @param array $array array( option name => option value, ... )
2223
	 */
2224
	public static function update_options( $array ) {
2225
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2226
		return Jetpack_Options::update_options( $array );
2227
	}
2228
2229
	/**
2230
	 * Deletes the given option.  May be passed multiple option names as an array.
2231
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2232
	 *
2233
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2234
	 * @param string|array $names
2235
	 */
2236
	public static function delete_option( $names ) {
2237
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2238
		return Jetpack_Options::delete_option( $names );
2239
	}
2240
2241
	/**
2242
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2243
	 *
2244
	 * Enters a user token into the user_tokens option
2245
	 *
2246
	 * @param int    $user_id The user id.
2247
	 * @param string $token The user token.
2248
	 * @param bool   $is_master_user Whether the user is the master user.
2249
	 * @return bool
2250
	 */
2251
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2252
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2253
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2254
	}
2255
2256
	/**
2257
	 * Returns an array of all PHP files in the specified absolute path.
2258
	 * Equivalent to glob( "$absolute_path/*.php" ).
2259
	 *
2260
	 * @param string $absolute_path The absolute path of the directory to search.
2261
	 * @return array Array of absolute paths to the PHP files.
2262
	 */
2263
	public static function glob_php( $absolute_path ) {
2264
		if ( function_exists( 'glob' ) ) {
2265
			return glob( "$absolute_path/*.php" );
2266
		}
2267
2268
		$absolute_path = untrailingslashit( $absolute_path );
2269
		$files         = array();
2270
		if ( ! $dir = @opendir( $absolute_path ) ) {
2271
			return $files;
2272
		}
2273
2274
		while ( false !== $file = readdir( $dir ) ) {
2275
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2276
				continue;
2277
			}
2278
2279
			$file = "$absolute_path/$file";
2280
2281
			if ( ! is_file( $file ) ) {
2282
				continue;
2283
			}
2284
2285
			$files[] = $file;
2286
		}
2287
2288
		closedir( $dir );
2289
2290
		return $files;
2291
	}
2292
2293
	public static function activate_new_modules( $redirect = false ) {
2294
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2295
			return;
2296
		}
2297
2298
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2299 View Code Duplication
		if ( ! $jetpack_old_version ) {
2300
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2301
			/** This action is documented in class.jetpack.php */
2302
			do_action( 'updating_jetpack_version', $version, false );
2303
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2304
		}
2305
2306
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2307
2308
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2309
			return;
2310
		}
2311
2312
		$active_modules     = self::get_active_modules();
2313
		$reactivate_modules = array();
2314
		foreach ( $active_modules as $active_module ) {
2315
			$module = self::get_module( $active_module );
2316
			if ( ! isset( $module['changed'] ) ) {
2317
				continue;
2318
			}
2319
2320
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2321
				continue;
2322
			}
2323
2324
			$reactivate_modules[] = $active_module;
2325
			self::deactivate_module( $active_module );
2326
		}
2327
2328
		$new_version = JETPACK__VERSION . ':' . time();
2329
		/** This action is documented in class.jetpack.php */
2330
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2331
		Jetpack_Options::update_options(
2332
			array(
2333
				'version'     => $new_version,
2334
				'old_version' => $jetpack_old_version,
2335
			)
2336
		);
2337
2338
		self::state( 'message', 'modules_activated' );
2339
2340
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
2341
2342
		if ( $redirect ) {
2343
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2344
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2345
				$page = $_GET['page'];
2346
			}
2347
2348
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2349
			exit;
2350
		}
2351
	}
2352
2353
	/**
2354
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2355
	 * Make sure to tuck away module "library" files in a sub-directory.
2356
	 */
2357
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2358
		static $modules = null;
2359
2360
		if ( ! isset( $modules ) ) {
2361
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2362
			// Use the cache if we're on the front-end and it's available...
2363
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2364
				$modules = $available_modules_option[ JETPACK__VERSION ];
2365
			} else {
2366
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2367
2368
				$modules = array();
2369
2370
				foreach ( $files as $file ) {
2371
					if ( ! $headers = self::get_module( $file ) ) {
2372
						continue;
2373
					}
2374
2375
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2376
				}
2377
2378
				Jetpack_Options::update_option(
2379
					'available_modules',
2380
					array(
2381
						JETPACK__VERSION => $modules,
2382
					)
2383
				);
2384
			}
2385
		}
2386
2387
		/**
2388
		 * Filters the array of modules available to be activated.
2389
		 *
2390
		 * @since 2.4.0
2391
		 *
2392
		 * @param array $modules Array of available modules.
2393
		 * @param string $min_version Minimum version number required to use modules.
2394
		 * @param string $max_version Maximum version number required to use modules.
2395
		 */
2396
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2397
2398
		if ( ! $min_version && ! $max_version ) {
2399
			return array_keys( $mods );
2400
		}
2401
2402
		$r = array();
2403
		foreach ( $mods as $slug => $introduced ) {
2404
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2405
				continue;
2406
			}
2407
2408
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2409
				continue;
2410
			}
2411
2412
			$r[] = $slug;
2413
		}
2414
2415
		return $r;
2416
	}
2417
2418
	/**
2419
	 * Default modules loaded on activation.
2420
	 */
2421
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2422
		$return = array();
2423
2424
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2425
			$module_data = self::get_module( $module );
2426
2427
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2428
				case 'yes':
2429
					$return[] = $module;
2430
					break;
2431
				case 'public':
2432
					if ( Jetpack_Options::get_option( 'public' ) ) {
2433
						$return[] = $module;
2434
					}
2435
					break;
2436
				case 'no':
2437
				default:
2438
					break;
2439
			}
2440
		}
2441
		/**
2442
		 * Filters the array of default modules.
2443
		 *
2444
		 * @since 2.5.0
2445
		 *
2446
		 * @param array $return Array of default modules.
2447
		 * @param string $min_version Minimum version number required to use modules.
2448
		 * @param string $max_version Maximum version number required to use modules.
2449
		 */
2450
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2451
	}
2452
2453
	/**
2454
	 * Checks activated modules during auto-activation to determine
2455
	 * if any of those modules are being deprecated.  If so, close
2456
	 * them out, and add any replacement modules.
2457
	 *
2458
	 * Runs at priority 99 by default.
2459
	 *
2460
	 * This is run late, so that it can still activate a module if
2461
	 * the new module is a replacement for another that the user
2462
	 * currently has active, even if something at the normal priority
2463
	 * would kibosh everything.
2464
	 *
2465
	 * @since 2.6
2466
	 * @uses jetpack_get_default_modules filter
2467
	 * @param array $modules
2468
	 * @return array
2469
	 */
2470
	function handle_deprecated_modules( $modules ) {
2471
		$deprecated_modules = array(
2472
			'debug'            => null,  // Closed out and moved to the debugger library.
2473
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2474
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2475
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2476
		);
2477
2478
		// Don't activate SSO if they never completed activating WPCC.
2479
		if ( self::is_module_active( 'wpcc' ) ) {
2480
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2481
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2482
				$deprecated_modules['wpcc'] = null;
2483
			}
2484
		}
2485
2486
		foreach ( $deprecated_modules as $module => $replacement ) {
2487
			if ( self::is_module_active( $module ) ) {
2488
				self::deactivate_module( $module );
2489
				if ( $replacement ) {
2490
					$modules[] = $replacement;
2491
				}
2492
			}
2493
		}
2494
2495
		return array_unique( $modules );
2496
	}
2497
2498
	/**
2499
	 * Checks activated plugins during auto-activation to determine
2500
	 * if any of those plugins are in the list with a corresponding module
2501
	 * that is not compatible with the plugin. The module will not be allowed
2502
	 * to auto-activate.
2503
	 *
2504
	 * @since 2.6
2505
	 * @uses jetpack_get_default_modules filter
2506
	 * @param array $modules
2507
	 * @return array
2508
	 */
2509
	function filter_default_modules( $modules ) {
2510
2511
		$active_plugins = self::get_active_plugins();
2512
2513
		if ( ! empty( $active_plugins ) ) {
2514
2515
			// For each module we'd like to auto-activate...
2516
			foreach ( $modules as $key => $module ) {
2517
				// If there are potential conflicts for it...
2518
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2519
					// For each potential conflict...
2520
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2521
						// If that conflicting plugin is active...
2522
						if ( in_array( $plugin, $active_plugins ) ) {
2523
							// Remove that item from being auto-activated.
2524
							unset( $modules[ $key ] );
2525
						}
2526
					}
2527
				}
2528
			}
2529
		}
2530
2531
		return $modules;
2532
	}
2533
2534
	/**
2535
	 * Extract a module's slug from its full path.
2536
	 */
2537
	public static function get_module_slug( $file ) {
2538
		return str_replace( '.php', '', basename( $file ) );
2539
	}
2540
2541
	/**
2542
	 * Generate a module's path from its slug.
2543
	 */
2544
	public static function get_module_path( $slug ) {
2545
		/**
2546
		 * Filters the path of a modules.
2547
		 *
2548
		 * @since 7.4.0
2549
		 *
2550
		 * @param array $return The absolute path to a module's root php file
2551
		 * @param string $slug The module slug
2552
		 */
2553
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2554
	}
2555
2556
	/**
2557
	 * Load module data from module file. Headers differ from WordPress
2558
	 * plugin headers to avoid them being identified as standalone
2559
	 * plugins on the WordPress plugins page.
2560
	 */
2561
	public static function get_module( $module ) {
2562
		$headers = array(
2563
			'name'                      => 'Module Name',
2564
			'description'               => 'Module Description',
2565
			'sort'                      => 'Sort Order',
2566
			'recommendation_order'      => 'Recommendation Order',
2567
			'introduced'                => 'First Introduced',
2568
			'changed'                   => 'Major Changes In',
2569
			'deactivate'                => 'Deactivate',
2570
			'free'                      => 'Free',
2571
			'requires_connection'       => 'Requires Connection',
2572
			'auto_activate'             => 'Auto Activate',
2573
			'module_tags'               => 'Module Tags',
2574
			'feature'                   => 'Feature',
2575
			'additional_search_queries' => 'Additional Search Queries',
2576
			'plan_classes'              => 'Plans',
2577
		);
2578
2579
		$file = self::get_module_path( self::get_module_slug( $module ) );
2580
2581
		$mod = self::get_file_data( $file, $headers );
2582
		if ( empty( $mod['name'] ) ) {
2583
			return false;
2584
		}
2585
2586
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2587
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2588
		$mod['deactivate']           = empty( $mod['deactivate'] );
2589
		$mod['free']                 = empty( $mod['free'] );
2590
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2591
2592
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2593
			$mod['auto_activate'] = 'No';
2594
		} else {
2595
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2596
		}
2597
2598
		if ( $mod['module_tags'] ) {
2599
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2600
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2601
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2602
		} else {
2603
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2604
		}
2605
2606 View Code Duplication
		if ( $mod['plan_classes'] ) {
2607
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2608
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2609
		} else {
2610
			$mod['plan_classes'] = array( 'free' );
2611
		}
2612
2613 View Code Duplication
		if ( $mod['feature'] ) {
2614
			$mod['feature'] = explode( ',', $mod['feature'] );
2615
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2616
		} else {
2617
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2618
		}
2619
2620
		/**
2621
		 * Filters the feature array on a module.
2622
		 *
2623
		 * This filter allows you to control where each module is filtered: Recommended,
2624
		 * and the default "Other" listing.
2625
		 *
2626
		 * @since 3.5.0
2627
		 *
2628
		 * @param array   $mod['feature'] The areas to feature this module:
2629
		 *     'Recommended' shows on the main Jetpack admin screen.
2630
		 *     'Other' should be the default if no other value is in the array.
2631
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2632
		 * @param array   $mod All the currently assembled module data.
2633
		 */
2634
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2635
2636
		/**
2637
		 * Filter the returned data about a module.
2638
		 *
2639
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2640
		 * so please be careful.
2641
		 *
2642
		 * @since 3.6.0
2643
		 *
2644
		 * @param array   $mod    The details of the requested module.
2645
		 * @param string  $module The slug of the module, e.g. sharedaddy
2646
		 * @param string  $file   The path to the module source file.
2647
		 */
2648
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2649
	}
2650
2651
	/**
2652
	 * Like core's get_file_data implementation, but caches the result.
2653
	 */
2654
	public static function get_file_data( $file, $headers ) {
2655
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2656
		$file_name = basename( $file );
2657
2658
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2659
2660
		$file_data_option = get_transient( $cache_key );
2661
2662
		if ( ! is_array( $file_data_option ) ) {
2663
			delete_transient( $cache_key );
2664
			$file_data_option = false;
2665
		}
2666
2667
		if ( false === $file_data_option ) {
2668
			$file_data_option = array();
2669
		}
2670
2671
		$key           = md5( $file_name . serialize( $headers ) );
2672
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2673
2674
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2675
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2676
			return $file_data_option[ $key ];
2677
		}
2678
2679
		$data = get_file_data( $file, $headers );
2680
2681
		$file_data_option[ $key ] = $data;
2682
2683
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2684
2685
		return $data;
2686
	}
2687
2688
2689
	/**
2690
	 * Return translated module tag.
2691
	 *
2692
	 * @param string $tag Tag as it appears in each module heading.
2693
	 *
2694
	 * @return mixed
2695
	 */
2696
	public static function translate_module_tag( $tag ) {
2697
		return jetpack_get_module_i18n_tag( $tag );
2698
	}
2699
2700
	/**
2701
	 * Get i18n strings as a JSON-encoded string
2702
	 *
2703
	 * @return string The locale as JSON
2704
	 */
2705
	public static function get_i18n_data_json() {
2706
2707
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2708
		// JSON files with the file they should be included for. This is an md5
2709
		// of '_inc/build/admin.js'.
2710
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2711
2712
		$i18n_json =
2713
				   JETPACK__PLUGIN_DIR
2714
				   . 'languages/json/jetpack-'
2715
				   . get_user_locale()
2716
				   . '-'
2717
				   . $path_md5
2718
				   . '.json';
2719
2720
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2721
			$locale_data = @file_get_contents( $i18n_json );
2722
			if ( $locale_data ) {
2723
				return $locale_data;
2724
			}
2725
		}
2726
2727
		// Return valid empty Jed locale
2728
		return '{ "locale_data": { "messages": { "": {} } } }';
2729
	}
2730
2731
	/**
2732
	 * Add locale data setup to wp-i18n
2733
	 *
2734
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2735
	 *
2736
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2737
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2738
	 *
2739
	 * This method provides a safe way to request the setup multiple times but add the script at
2740
	 * most once.
2741
	 *
2742
	 * @since 6.7.0
2743
	 *
2744
	 * @return void
2745
	 */
2746
	public static function setup_wp_i18n_locale_data() {
2747
		static $script_added = false;
2748
		if ( ! $script_added ) {
2749
			$script_added = true;
2750
			wp_add_inline_script(
2751
				'wp-i18n',
2752
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2753
			);
2754
		}
2755
	}
2756
2757
	/**
2758
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2759
	 *
2760
	 * @since 3.9.2
2761
	 *
2762
	 * @param array $modules
2763
	 *
2764
	 * @return string|void
2765
	 */
2766
	public static function get_translated_modules( $modules ) {
2767
		foreach ( $modules as $index => $module ) {
2768
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2769
			if ( isset( $module['name'] ) ) {
2770
				$modules[ $index ]['name'] = $i18n_module['name'];
2771
			}
2772
			if ( isset( $module['description'] ) ) {
2773
				$modules[ $index ]['description']       = $i18n_module['description'];
2774
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2775
			}
2776
		}
2777
		return $modules;
2778
	}
2779
2780
	/**
2781
	 * Get a list of activated modules as an array of module slugs.
2782
	 */
2783
	public static function get_active_modules() {
2784
		$active = Jetpack_Options::get_option( 'active_modules' );
2785
2786
		if ( ! is_array( $active ) ) {
2787
			$active = array();
2788
		}
2789
2790
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2791
			$active[] = 'vaultpress';
2792
		} else {
2793
			$active = array_diff( $active, array( 'vaultpress' ) );
2794
		}
2795
2796
		// If protect is active on the main site of a multisite, it should be active on all sites.
2797
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2798
			$active[] = 'protect';
2799
		}
2800
2801
		/**
2802
		 * Allow filtering of the active modules.
2803
		 *
2804
		 * Gives theme and plugin developers the power to alter the modules that
2805
		 * are activated on the fly.
2806
		 *
2807
		 * @since 5.8.0
2808
		 *
2809
		 * @param array $active Array of active module slugs.
2810
		 */
2811
		$active = apply_filters( 'jetpack_active_modules', $active );
2812
2813
		return array_unique( $active );
2814
	}
2815
2816
	/**
2817
	 * Check whether or not a Jetpack module is active.
2818
	 *
2819
	 * @param string $module The slug of a Jetpack module.
2820
	 * @return bool
2821
	 *
2822
	 * @static
2823
	 */
2824
	public static function is_module_active( $module ) {
2825
		return in_array( $module, self::get_active_modules() );
2826
	}
2827
2828
	public static function is_module( $module ) {
2829
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2830
	}
2831
2832
	/**
2833
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2834
	 *
2835
	 * @param bool $catch True to start catching, False to stop.
2836
	 *
2837
	 * @static
2838
	 */
2839
	public static function catch_errors( $catch ) {
2840
		static $display_errors, $error_reporting;
2841
2842
		if ( $catch ) {
2843
			$display_errors  = @ini_set( 'display_errors', 1 );
2844
			$error_reporting = @error_reporting( E_ALL );
2845
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2846
		} else {
2847
			@ini_set( 'display_errors', $display_errors );
2848
			@error_reporting( $error_reporting );
2849
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2850
		}
2851
	}
2852
2853
	/**
2854
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2855
	 */
2856
	public static function catch_errors_on_shutdown() {
2857
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2858
	}
2859
2860
	/**
2861
	 * Rewrite any string to make paths easier to read.
2862
	 *
2863
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2864
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2865
	 *
2866
	 * @param $string
2867
	 * @return mixed
2868
	 */
2869
	public static function alias_directories( $string ) {
2870
		// ABSPATH has a trailing slash.
2871
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2872
		// WP_CONTENT_DIR does not have a trailing slash.
2873
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2874
2875
		return $string;
2876
	}
2877
2878
	public static function activate_default_modules(
2879
		$min_version = false,
2880
		$max_version = false,
2881
		$other_modules = array(),
2882
		$redirect = null,
2883
		$send_state_messages = null
2884
	) {
2885
		$jetpack = self::init();
2886
2887
		if ( is_null( $redirect ) ) {
2888
			if (
2889
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2890
			||
2891
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2892
			||
2893
				( defined( 'WP_CLI' ) && WP_CLI )
2894
			||
2895
				( defined( 'DOING_CRON' ) && DOING_CRON )
2896
			||
2897
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2898
			) {
2899
				$redirect = false;
2900
			} elseif ( is_admin() ) {
2901
				$redirect = true;
2902
			} else {
2903
				$redirect = false;
2904
			}
2905
		}
2906
2907
		if ( is_null( $send_state_messages ) ) {
2908
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2909
		}
2910
2911
		$modules = self::get_default_modules( $min_version, $max_version );
2912
		$modules = array_merge( $other_modules, $modules );
2913
2914
		// Look for standalone plugins and disable if active.
2915
2916
		$to_deactivate = array();
2917
		foreach ( $modules as $module ) {
2918
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2919
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2920
			}
2921
		}
2922
2923
		$deactivated = array();
2924
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2925
			list( $probable_file, $probable_title ) = $deactivate_me;
2926
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2927
				$deactivated[] = $module;
2928
			}
2929
		}
2930
2931
		if ( $deactivated ) {
2932
			if ( $send_state_messages ) {
2933
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2934
			}
2935
2936
			if ( $redirect ) {
2937
				$url = add_query_arg(
2938
					array(
2939
						'action'   => 'activate_default_modules',
2940
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2941
					),
2942
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2943
				);
2944
				wp_safe_redirect( $url );
2945
				exit;
2946
			}
2947
		}
2948
2949
		/**
2950
		 * Fires before default modules are activated.
2951
		 *
2952
		 * @since 1.9.0
2953
		 *
2954
		 * @param string $min_version Minimum version number required to use modules.
2955
		 * @param string $max_version Maximum version number required to use modules.
2956
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2957
		 */
2958
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2959
2960
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2961
		if ( $send_state_messages ) {
2962
			self::restate();
2963
			self::catch_errors( true );
2964
		}
2965
2966
		$active = self::get_active_modules();
2967
2968
		foreach ( $modules as $module ) {
2969
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2970
				$active[] = $module;
2971
				self::update_active_modules( $active );
2972
				continue;
2973
			}
2974
2975
			if ( $send_state_messages && in_array( $module, $active ) ) {
2976
				$module_info = self::get_module( $module );
2977 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2978
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2979
					if ( $active_state = self::state( $state ) ) {
2980
						$active_state = explode( ',', $active_state );
2981
					} else {
2982
						$active_state = array();
2983
					}
2984
					$active_state[] = $module;
2985
					self::state( $state, implode( ',', $active_state ) );
2986
				}
2987
				continue;
2988
			}
2989
2990
			$file = self::get_module_path( $module );
2991
			if ( ! file_exists( $file ) ) {
2992
				continue;
2993
			}
2994
2995
			// we'll override this later if the plugin can be included without fatal error
2996
			if ( $redirect ) {
2997
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2998
			}
2999
3000
			if ( $send_state_messages ) {
3001
				self::state( 'error', 'module_activation_failed' );
3002
				self::state( 'module', $module );
3003
			}
3004
3005
			ob_start();
3006
			require_once $file;
3007
3008
			$active[] = $module;
3009
3010 View Code Duplication
			if ( $send_state_messages ) {
3011
3012
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3013
				if ( $active_state = self::state( $state ) ) {
3014
					$active_state = explode( ',', $active_state );
3015
				} else {
3016
					$active_state = array();
3017
				}
3018
				$active_state[] = $module;
3019
				self::state( $state, implode( ',', $active_state ) );
3020
			}
3021
3022
			self::update_active_modules( $active );
3023
3024
			ob_end_clean();
3025
		}
3026
3027
		if ( $send_state_messages ) {
3028
			self::state( 'error', false );
3029
			self::state( 'module', false );
3030
		}
3031
3032
		self::catch_errors( false );
3033
		/**
3034
		 * Fires when default modules are activated.
3035
		 *
3036
		 * @since 1.9.0
3037
		 *
3038
		 * @param string $min_version Minimum version number required to use modules.
3039
		 * @param string $max_version Maximum version number required to use modules.
3040
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3041
		 */
3042
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3043
	}
3044
3045
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3046
		/**
3047
		 * Fires before a module is activated.
3048
		 *
3049
		 * @since 2.6.0
3050
		 *
3051
		 * @param string $module Module slug.
3052
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3053
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3054
		 */
3055
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3056
3057
		$jetpack = self::init();
3058
3059
		if ( ! strlen( $module ) ) {
3060
			return false;
3061
		}
3062
3063
		if ( ! self::is_module( $module ) ) {
3064
			return false;
3065
		}
3066
3067
		// If it's already active, then don't do it again
3068
		$active = self::get_active_modules();
3069
		foreach ( $active as $act ) {
3070
			if ( $act == $module ) {
3071
				return true;
3072
			}
3073
		}
3074
3075
		$module_data = self::get_module( $module );
3076
3077
		$is_development_mode = ( new Status() )->is_development_mode();
3078
		if ( ! self::is_active() ) {
3079
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3080
				return false;
3081
			}
3082
3083
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3084
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3085
				return false;
3086
			}
3087
		}
3088
3089
		// Check and see if the old plugin is active
3090
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3091
			// Deactivate the old plugin
3092
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3093
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3094
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3095
				self::state( 'deactivated_plugins', $module );
3096
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3097
				exit;
3098
			}
3099
		}
3100
3101
		// Protect won't work with mis-configured IPs
3102
		if ( 'protect' === $module ) {
3103
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3104
			if ( ! jetpack_protect_get_ip() ) {
3105
				self::state( 'message', 'protect_misconfigured_ip' );
3106
				return false;
3107
			}
3108
		}
3109
3110
		if ( ! Jetpack_Plan::supports( $module ) ) {
3111
			return false;
3112
		}
3113
3114
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3115
		self::state( 'module', $module );
3116
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3117
3118
		self::catch_errors( true );
3119
		ob_start();
3120
		require self::get_module_path( $module );
3121
		/** This action is documented in class.jetpack.php */
3122
		do_action( 'jetpack_activate_module', $module );
3123
		$active[] = $module;
3124
		self::update_active_modules( $active );
3125
3126
		self::state( 'error', false ); // the override
3127
		ob_end_clean();
3128
		self::catch_errors( false );
3129
3130
		if ( $redirect ) {
3131
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3132
		}
3133
		if ( $exit ) {
3134
			exit;
3135
		}
3136
		return true;
3137
	}
3138
3139
	function activate_module_actions( $module ) {
3140
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3141
	}
3142
3143
	public static function deactivate_module( $module ) {
3144
		/**
3145
		 * Fires when a module is deactivated.
3146
		 *
3147
		 * @since 1.9.0
3148
		 *
3149
		 * @param string $module Module slug.
3150
		 */
3151
		do_action( 'jetpack_pre_deactivate_module', $module );
3152
3153
		$jetpack = self::init();
3154
3155
		$active = self::get_active_modules();
3156
		$new    = array_filter( array_diff( $active, (array) $module ) );
3157
3158
		return self::update_active_modules( $new );
3159
	}
3160
3161
	public static function enable_module_configurable( $module ) {
3162
		$module = self::get_module_slug( $module );
3163
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3164
	}
3165
3166
	/**
3167
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3168
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3169
	 *
3170
	 * @param string $module Module slug
3171
	 * @return string $url module configuration URL
3172
	 */
3173
	public static function module_configuration_url( $module ) {
3174
		$module      = self::get_module_slug( $module );
3175
		$default_url = self::admin_url() . "#/settings?term=$module";
3176
		/**
3177
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3178
		 *
3179
		 * @since 6.9.0
3180
		 *
3181
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3182
		 */
3183
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3184
3185
		return $url;
3186
	}
3187
3188
	/* Installation */
3189
	public static function bail_on_activation( $message, $deactivate = true ) {
3190
		?>
3191
<!doctype html>
3192
<html>
3193
<head>
3194
<meta charset="<?php bloginfo( 'charset' ); ?>">
3195
<style>
3196
* {
3197
	text-align: center;
3198
	margin: 0;
3199
	padding: 0;
3200
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3201
}
3202
p {
3203
	margin-top: 1em;
3204
	font-size: 18px;
3205
}
3206
</style>
3207
<body>
3208
<p><?php echo esc_html( $message ); ?></p>
3209
</body>
3210
</html>
3211
		<?php
3212
		if ( $deactivate ) {
3213
			$plugins = get_option( 'active_plugins' );
3214
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3215
			$update  = false;
3216
			foreach ( $plugins as $i => $plugin ) {
3217
				if ( $plugin === $jetpack ) {
3218
					$plugins[ $i ] = false;
3219
					$update        = true;
3220
				}
3221
			}
3222
3223
			if ( $update ) {
3224
				update_option( 'active_plugins', array_filter( $plugins ) );
3225
			}
3226
		}
3227
		exit;
3228
	}
3229
3230
	/**
3231
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3232
	 *
3233
	 * @static
3234
	 */
3235
	public static function plugin_activation( $network_wide ) {
3236
		Jetpack_Options::update_option( 'activated', 1 );
3237
3238
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3239
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3240
		}
3241
3242
		if ( $network_wide ) {
3243
			self::state( 'network_nag', true );
3244
		}
3245
3246
		// For firing one-off events (notices) immediately after activation
3247
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3248
3249
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3250
3251
		Health::on_jetpack_activated();
3252
3253
		self::plugin_initialize();
3254
	}
3255
3256
	public static function get_activation_source( $referer_url ) {
3257
3258
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3259
			return array( 'wp-cli', null );
3260
		}
3261
3262
		$referer = wp_parse_url( $referer_url );
3263
3264
		$source_type  = 'unknown';
3265
		$source_query = null;
3266
3267
		if ( ! is_array( $referer ) ) {
3268
			return array( $source_type, $source_query );
3269
		}
3270
3271
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_PATH.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3272
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_PATH.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3273
3274
		if ( isset( $referer['query'] ) ) {
3275
			parse_str( $referer['query'], $query_parts );
3276
		} else {
3277
			$query_parts = array();
3278
		}
3279
3280
		if ( $plugins_path === $referer['path'] ) {
3281
			$source_type = 'list';
3282
		} elseif ( $plugins_install_path === $referer['path'] ) {
3283
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3284
			switch ( $tab ) {
3285
				case 'popular':
3286
					$source_type = 'popular';
3287
					break;
3288
				case 'recommended':
3289
					$source_type = 'recommended';
3290
					break;
3291
				case 'favorites':
3292
					$source_type = 'favorites';
3293
					break;
3294
				case 'search':
3295
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3296
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3297
					break;
3298
				default:
3299
					$source_type = 'featured';
3300
			}
3301
		}
3302
3303
		return array( $source_type, $source_query );
3304
	}
3305
3306
	/**
3307
	 * Runs before bumping version numbers up to a new version
3308
	 *
3309
	 * @param string $version    Version:timestamp.
3310
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3311
	 */
3312
	public static function do_version_bump( $version, $old_version ) {
3313
		if ( $old_version ) { // For existing Jetpack installations.
3314
			self::send_update_modal_data();
3315
		}
3316
	}
3317
3318
	/**
3319
	 * Prepares the release post content and image data and saves it in the
3320
	 * state array. This data is used to create the update modal.
3321
	 */
3322
	public static function send_update_modal_data() {
3323
		$post_data = self::get_release_post_data();
3324
3325
		if ( ! isset( $post_data['posts'][0] ) ) {
3326
			return;
3327
		}
3328
3329
		$post = $post_data['posts'][0];
3330
3331
		$post_content = isset( $post['content'] ) ? $post['content'] : null;
3332
		if ( empty( $post_content ) ) {
3333
			return;
3334
		}
3335
3336
		// This allows us to embed videopress videos into the release post.
3337
		add_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3338
		$content = wp_kses_post( $post_content );
3339
		remove_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3340
3341
		$post_title = isset( $post['title'] ) ? $post['title'] : null;
3342
		$title      = wp_kses( $post_title, array() );
3343
3344
		$post_thumbnail = isset( $post['post_thumbnail'] ) ? $post['post_thumbnail'] : null;
3345
		if ( ! empty( $post_thumbnail ) ) {
3346
			jetpack_require_lib( 'class.jetpack-photon-image' );
3347
			$photon_image = new Jetpack_Photon_Image(
3348
				array(
3349
					'file'   => jetpack_photon_url( $post_thumbnail['URL'] ),
3350
					'width'  => $post_thumbnail['width'],
3351
					'height' => $post_thumbnail['height'],
3352
				),
3353
				$post_thumbnail['mime_type']
3354
			);
3355
			$photon_image->resize(
3356
				array(
3357
					'width'  => 600,
3358
					'height' => null,
3359
					'crop'   => false,
3360
				)
3361
			);
3362
			$post_thumbnail_url = $photon_image->get_raw_filename();
3363
		} else {
3364
			$post_thumbnail_url = null;
3365
		}
3366
3367
		$post_array = array(
3368
			'release_post_content'        => $content,
3369
			'release_post_featured_image' => $post_thumbnail_url,
3370
			'release_post_title'          => $title,
3371
		);
3372
3373
		self::state( 'message_content', $post_array );
0 ignored issues
show
$post_array is of type array<string,?,{"release...lease_post_title":"?"}>, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3374
	}
3375
3376
	/**
3377
	 * Temporarily allow post content to contain iframes, e.g. for videopress.
3378
	 *
3379
	 * @param string $tags    The tags.
3380
	 * @param string $context The context.
3381
	 */
3382
	public static function allow_post_embed_iframe( $tags, $context ) {
3383
		if ( 'post' === $context ) {
3384
			$tags['iframe'] = array(
3385
				'src'             => true,
3386
				'height'          => true,
3387
				'width'           => true,
3388
				'frameborder'     => true,
3389
				'allowfullscreen' => true,
3390
			);
3391
		}
3392
3393
		return $tags;
3394
	}
3395
3396
	/**
3397
	 * Obtains the release post from the Jetpack release post blog. A release post will be displayed in the
3398
	 * update modal when a post has a tag equal to the Jetpack version number.
3399
	 *
3400
	 * The response parameters for the post array can be found here:
3401
	 * https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/posts/%24post_ID/#apidoc-response
3402
	 *
3403
	 * @return array|null Returns an associative array containing the release post data at index ['posts'][0].
3404
	 *                    Returns null if the release post data is not available.
3405
	 */
3406
	private static function get_release_post_data() {
3407
		if ( Constants::is_defined( 'TESTING_IN_JETPACK' ) && Constants::get_constant( 'TESTING_IN_JETPACK' ) ) {
3408
			return null;
3409
		}
3410
3411
		$release_post_src = add_query_arg(
3412
			array(
3413
				'order_by' => 'date',
3414
				'tag'      => JETPACK__VERSION,
3415
				'number'   => '1',
3416
			),
3417
			'https://public-api.wordpress.com/rest/v1/sites/' . JETPACK__RELEASE_POST_BLOG_SLUG . '/posts'
3418
		);
3419
3420
		$response = wp_remote_get( $release_post_src );
3421
3422
		if ( ! is_array( $response ) ) {
3423
			return null;
3424
		}
3425
3426
		return json_decode( wp_remote_retrieve_body( $response ), true );
3427
	}
3428
3429
	/**
3430
	 * Sets the internal version number and activation state.
3431
	 *
3432
	 * @static
3433
	 */
3434
	public static function plugin_initialize() {
3435
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3436
			Jetpack_Options::update_option( 'activated', 2 );
3437
		}
3438
3439 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3440
			$version = $old_version = JETPACK__VERSION . ':' . time();
3441
			/** This action is documented in class.jetpack.php */
3442
			do_action( 'updating_jetpack_version', $version, false );
3443
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3444
		}
3445
3446
		self::load_modules();
3447
3448
		Jetpack_Options::delete_option( 'do_activate' );
3449
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3450
	}
3451
3452
	/**
3453
	 * Removes all connection options
3454
	 *
3455
	 * @static
3456
	 */
3457
	public static function plugin_deactivation() {
3458
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3459
		$tracking = new Tracking();
3460
		$tracking->record_user_event( 'deactivate_plugin', array() );
3461
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3462
			Jetpack_Network::init()->deactivate();
3463
		} else {
3464
			self::disconnect( false );
3465
			// Jetpack_Heartbeat::init()->deactivate();
3466
		}
3467
	}
3468
3469
	/**
3470
	 * Disconnects from the Jetpack servers.
3471
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3472
	 *
3473
	 * @static
3474
	 */
3475
	public static function disconnect( $update_activated_state = true ) {
3476
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3477
		$connection = self::connection();
3478
		$connection->clean_nonces( true );
3479
3480
		// If the site is in an IDC because sync is not allowed,
3481
		// let's make sure to not disconnect the production site.
3482
		if ( ! self::validate_sync_error_idc_option() ) {
3483
			$tracking = new Tracking();
3484
			$tracking->record_user_event( 'disconnect_site', array() );
3485
3486
			$connection->disconnect_site_wpcom();
3487
		}
3488
3489
		$connection->delete_all_connection_tokens();
3490
		Jetpack_IDC::clear_all_idc_options();
3491
3492
		if ( $update_activated_state ) {
3493
			Jetpack_Options::update_option( 'activated', 4 );
3494
		}
3495
3496
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3497
			// Check then record unique disconnection if site has never been disconnected previously
3498
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3499
				$jetpack_unique_connection['disconnected'] = 1;
3500
			} else {
3501
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3502
					// track unique disconnect
3503
					$jetpack = self::init();
3504
3505
					$jetpack->stat( 'connections', 'unique-disconnect' );
3506
					$jetpack->do_stats( 'server_side' );
3507
				}
3508
				// increment number of times disconnected
3509
				$jetpack_unique_connection['disconnected'] += 1;
3510
			}
3511
3512
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3513
		}
3514
3515
		// Delete all the sync related data. Since it could be taking up space.
3516
		Sender::get_instance()->uninstall();
3517
3518
		// Disable the Heartbeat cron
3519
		Jetpack_Heartbeat::init()->deactivate();
3520
	}
3521
3522
	/**
3523
	 * Unlinks the current user from the linked WordPress.com user.
3524
	 *
3525
	 * @deprecated since 7.7
3526
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3527
	 *
3528
	 * @param Integer $user_id the user identifier.
3529
	 * @return Boolean Whether the disconnection of the user was successful.
3530
	 */
3531
	public static function unlink_user( $user_id = null ) {
3532
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3533
		return Connection_Manager::disconnect_user( $user_id );
3534
	}
3535
3536
	/**
3537
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3538
	 */
3539
	public static function try_registration() {
3540
		$terms_of_service = new Terms_Of_Service();
3541
		// The user has agreed to the TOS at some point by now.
3542
		$terms_of_service->agree();
3543
3544
		// Let's get some testing in beta versions and such.
3545
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3546
			// Before attempting to connect, let's make sure that the domains are viable.
3547
			$domains_to_check = array_unique(
3548
				array(
3549
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3550
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
3551
				)
3552
			);
3553
			foreach ( $domains_to_check as $domain ) {
3554
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
$domain is of type array<string,string>|false, but the function expects a string.

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...
3555
				if ( is_wp_error( $result ) ) {
3556
					return $result;
3557
				}
3558
			}
3559
		}
3560
3561
		$result = self::register();
3562
3563
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3564
		if ( ! $result || is_wp_error( $result ) ) {
3565
			return $result;
3566
		} else {
3567
			return true;
3568
		}
3569
	}
3570
3571
	/**
3572
	 * Tracking an internal event log. Try not to put too much chaff in here.
3573
	 *
3574
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3575
	 */
3576
	public static function log( $code, $data = null ) {
3577
		// only grab the latest 200 entries
3578
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3579
3580
		// Append our event to the log
3581
		$log_entry = array(
3582
			'time'    => time(),
3583
			'user_id' => get_current_user_id(),
3584
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3585
			'code'    => $code,
3586
		);
3587
		// Don't bother storing it unless we've got some.
3588
		if ( ! is_null( $data ) ) {
3589
			$log_entry['data'] = $data;
3590
		}
3591
		$log[] = $log_entry;
3592
3593
		// Try add_option first, to make sure it's not autoloaded.
3594
		// @todo: Add an add_option method to Jetpack_Options
3595
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3596
			Jetpack_Options::update_option( 'log', $log );
3597
		}
3598
3599
		/**
3600
		 * Fires when Jetpack logs an internal event.
3601
		 *
3602
		 * @since 3.0.0
3603
		 *
3604
		 * @param array $log_entry {
3605
		 *  Array of details about the log entry.
3606
		 *
3607
		 *  @param string time Time of the event.
3608
		 *  @param int user_id ID of the user who trigerred the event.
3609
		 *  @param int blog_id Jetpack Blog ID.
3610
		 *  @param string code Unique name for the event.
3611
		 *  @param string data Data about the event.
3612
		 * }
3613
		 */
3614
		do_action( 'jetpack_log_entry', $log_entry );
3615
	}
3616
3617
	/**
3618
	 * Get the internal event log.
3619
	 *
3620
	 * @param $event (string) - only return the specific log events
3621
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3622
	 *
3623
	 * @return array of log events || WP_Error for invalid params
3624
	 */
3625
	public static function get_log( $event = false, $num = false ) {
3626
		if ( $event && ! is_string( $event ) ) {
3627
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
3628
		}
3629
3630
		if ( $num && ! is_numeric( $num ) ) {
3631
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
3632
		}
3633
3634
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3635
3636
		// If nothing set - act as it did before, otherwise let's start customizing the output
3637
		if ( ! $num && ! $event ) {
3638
			return $entire_log;
3639
		} else {
3640
			$entire_log = array_reverse( $entire_log );
3641
		}
3642
3643
		$custom_log_output = array();
3644
3645
		if ( $event ) {
3646
			foreach ( $entire_log as $log_event ) {
3647
				if ( $event == $log_event['code'] ) {
3648
					$custom_log_output[] = $log_event;
3649
				}
3650
			}
3651
		} else {
3652
			$custom_log_output = $entire_log;
3653
		}
3654
3655
		if ( $num ) {
3656
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3657
		}
3658
3659
		return $custom_log_output;
3660
	}
3661
3662
	/**
3663
	 * Log modification of important settings.
3664
	 */
3665
	public static function log_settings_change( $option, $old_value, $value ) {
3666
		switch ( $option ) {
3667
			case 'jetpack_sync_non_public_post_stati':
3668
				self::log( $option, $value );
3669
				break;
3670
		}
3671
	}
3672
3673
	/**
3674
	 * Return stat data for WPCOM sync
3675
	 */
3676
	public static function get_stat_data( $encode = true, $extended = true ) {
3677
		$data = Jetpack_Heartbeat::generate_stats_array();
3678
3679
		if ( $extended ) {
3680
			$additional_data = self::get_additional_stat_data();
3681
			$data            = array_merge( $data, $additional_data );
3682
		}
3683
3684
		if ( $encode ) {
3685
			return json_encode( $data );
3686
		}
3687
3688
		return $data;
3689
	}
3690
3691
	/**
3692
	 * Get additional stat data to sync to WPCOM
3693
	 */
3694
	public static function get_additional_stat_data( $prefix = '' ) {
3695
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
3696
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3697
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3698
		$return[ "{$prefix}site-count" ]    = 0;
3699
3700
		if ( function_exists( 'get_blog_count' ) ) {
3701
			$return[ "{$prefix}site-count" ] = get_blog_count();
3702
		}
3703
		return $return;
3704
	}
3705
3706
	private static function get_site_user_count() {
3707
		global $wpdb;
3708
3709
		if ( function_exists( 'wp_is_large_network' ) ) {
3710
			if ( wp_is_large_network( 'users' ) ) {
3711
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3712
			}
3713
		}
3714
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3715
			// It wasn't there, so regenerate the data and save the transient
3716
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3717
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3718
		}
3719
		return $user_count;
3720
	}
3721
3722
	/* Admin Pages */
3723
3724
	function admin_init() {
3725
		// If the plugin is not connected, display a connect message.
3726
		if (
3727
			// the plugin was auto-activated and needs its candy
3728
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3729
		||
3730
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3731
			! Jetpack_Options::get_option( 'activated' )
3732
		) {
3733
			self::plugin_initialize();
3734
		}
3735
3736
		$is_development_mode = ( new Status() )->is_development_mode();
3737
		if ( ! self::is_active() && ! $is_development_mode ) {
3738
			Jetpack_Connection_Banner::init();
3739
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3740
			// Upgrade: 1.1 -> 1.1.1
3741
			// Check and see if host can verify the Jetpack servers' SSL certificate
3742
			$args       = array();
3743
			$connection = self::connection();
3744
			Client::_wp_remote_request(
3745
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3746
				$args,
3747
				true
3748
			);
3749
		}
3750
3751
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3752
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3753
		}
3754
3755
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3756
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3757
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3758
3759
		if ( self::is_active() || $is_development_mode ) {
3760
			// Artificially throw errors in certain whitelisted cases during plugin activation
3761
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3762
		}
3763
3764
		// Add custom column in wp-admin/users.php to show whether user is linked.
3765
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3766
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3767
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3768
	}
3769
3770
	function admin_body_class( $admin_body_class = '' ) {
3771
		$classes = explode( ' ', trim( $admin_body_class ) );
3772
3773
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3774
3775
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3776
		return " $admin_body_class ";
3777
	}
3778
3779
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3780
		return $admin_body_class . ' jetpack-pagestyles ';
3781
	}
3782
3783
	/**
3784
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3785
	 * This function artificially throws errors for such cases (whitelisted).
3786
	 *
3787
	 * @param string $plugin The activated plugin.
3788
	 */
3789
	function throw_error_on_activate_plugin( $plugin ) {
3790
		$active_modules = self::get_active_modules();
3791
3792
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3793
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3794
			$throw = false;
3795
3796
			// Try and make sure it really was the stats plugin
3797
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3798
				if ( 'stats.php' == basename( $plugin ) ) {
3799
					$throw = true;
3800
				}
3801
			} else {
3802
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3803
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3804
					$throw = true;
3805
				}
3806
			}
3807
3808
			if ( $throw ) {
3809
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3810
			}
3811
		}
3812
	}
3813
3814
	function intercept_plugin_error_scrape_init() {
3815
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3816
	}
3817
3818
	function intercept_plugin_error_scrape( $action, $result ) {
3819
		if ( ! $result ) {
3820
			return;
3821
		}
3822
3823
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3824
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3825
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3826
			}
3827
		}
3828
	}
3829
3830
	/**
3831
	 * Register the remote file upload request handlers, if needed.
3832
	 *
3833
	 * @access public
3834
	 */
3835
	public function add_remote_request_handlers() {
3836
		// Remote file uploads are allowed only via AJAX requests.
3837
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3838
			return;
3839
		}
3840
3841
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3842
		$remote_request_actions = array(
3843
			'jetpack_upload_file',
3844
			'jetpack_update_file',
3845
		);
3846
3847
		// phpcs:ignore WordPress.Security.NonceVerification
3848
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3849
			return;
3850
		}
3851
3852
		// Require Jetpack authentication for the remote file upload AJAX requests.
3853
		if ( ! $this->connection_manager ) {
3854
			$this->connection_manager = new Connection_Manager();
3855
		}
3856
3857
		$this->connection_manager->require_jetpack_authentication();
3858
3859
		// Register the remote file upload AJAX handlers.
3860
		foreach ( $remote_request_actions as $action ) {
3861
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3862
		}
3863
	}
3864
3865
	/**
3866
	 * Handler for Jetpack remote file uploads.
3867
	 *
3868
	 * @access public
3869
	 */
3870
	public function remote_request_handlers() {
3871
		$action = current_filter();
3872
3873
		switch ( current_filter() ) {
3874
			case 'wp_ajax_nopriv_jetpack_upload_file':
3875
				$response = $this->upload_handler();
3876
				break;
3877
3878
			case 'wp_ajax_nopriv_jetpack_update_file':
3879
				$response = $this->upload_handler( true );
3880
				break;
3881
			default:
3882
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
3883
				break;
3884
		}
3885
3886
		if ( ! $response ) {
3887
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
3888
		}
3889
3890
		if ( is_wp_error( $response ) ) {
3891
			$status_code       = $response->get_error_data();
3892
			$error             = $response->get_error_code();
3893
			$error_description = $response->get_error_message();
3894
3895
			if ( ! is_int( $status_code ) ) {
3896
				$status_code = 400;
3897
			}
3898
3899
			status_header( $status_code );
3900
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3901
		}
3902
3903
		status_header( 200 );
3904
		if ( true === $response ) {
3905
			exit;
3906
		}
3907
3908
		die( json_encode( (object) $response ) );
3909
	}
3910
3911
	/**
3912
	 * Uploads a file gotten from the global $_FILES.
3913
	 * If `$update_media_item` is true and `post_id` is defined
3914
	 * the attachment file of the media item (gotten through of the post_id)
3915
	 * will be updated instead of add a new one.
3916
	 *
3917
	 * @param  boolean $update_media_item - update media attachment
3918
	 * @return array - An array describing the uploadind files process
3919
	 */
3920
	function upload_handler( $update_media_item = false ) {
3921
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3922
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
3923
		}
3924
3925
		$user = wp_authenticate( '', '' );
3926
		if ( ! $user || is_wp_error( $user ) ) {
3927
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
3928
		}
3929
3930
		wp_set_current_user( $user->ID );
3931
3932
		if ( ! current_user_can( 'upload_files' ) ) {
3933
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
3934
		}
3935
3936
		if ( empty( $_FILES ) ) {
3937
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
3938
		}
3939
3940
		foreach ( array_keys( $_FILES ) as $files_key ) {
3941
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3942
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
3943
			}
3944
		}
3945
3946
		$media_keys = array_keys( $_FILES['media'] );
3947
3948
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
3949
		if ( ! $token || is_wp_error( $token ) ) {
3950
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
3951
		}
3952
3953
		$uploaded_files = array();
3954
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3955
		unset( $GLOBALS['post'] );
3956
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3957
			$file = array();
3958
			foreach ( $media_keys as $media_key ) {
3959
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3960
			}
3961
3962
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3963
3964
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3965
			if ( $hmac_provided !== $hmac_file ) {
3966
				$uploaded_files[ $index ] = (object) array(
3967
					'error'             => 'invalid_hmac',
3968
					'error_description' => 'The corresponding HMAC for this file does not match',
3969
				);
3970
				continue;
3971
			}
3972
3973
			$_FILES['.jetpack.upload.'] = $file;
3974
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3975
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3976
				$post_id = 0;
3977
			}
3978
3979
			if ( $update_media_item ) {
3980
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3981
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
3982
				}
3983
3984
				$media_array = $_FILES['media'];
3985
3986
				$file_array['name']     = $media_array['name'][0];
3987
				$file_array['type']     = $media_array['type'][0];
3988
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3989
				$file_array['error']    = $media_array['error'][0];
3990
				$file_array['size']     = $media_array['size'][0];
3991
3992
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3993
3994
				if ( is_wp_error( $edited_media_item ) ) {
3995
					return $edited_media_item;
3996
				}
3997
3998
				$response = (object) array(
3999
					'id'   => (string) $post_id,
4000
					'file' => (string) $edited_media_item->post_title,
4001
					'url'  => (string) wp_get_attachment_url( $post_id ),
4002
					'type' => (string) $edited_media_item->post_mime_type,
4003
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
4004
				);
4005
4006
				return (array) array( $response );
4007
			}
4008
4009
			$attachment_id = media_handle_upload(
4010
				'.jetpack.upload.',
4011
				$post_id,
4012
				array(),
4013
				array(
4014
					'action' => 'jetpack_upload_file',
4015
				)
4016
			);
4017
4018
			if ( ! $attachment_id ) {
4019
				$uploaded_files[ $index ] = (object) array(
4020
					'error'             => 'unknown',
4021
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
4022
				);
4023
			} elseif ( is_wp_error( $attachment_id ) ) {
4024
				$uploaded_files[ $index ] = (object) array(
4025
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
4026
					'error_description' => $attachment_id->get_error_message(),
4027
				);
4028
			} else {
4029
				$attachment               = get_post( $attachment_id );
4030
				$uploaded_files[ $index ] = (object) array(
4031
					'id'   => (string) $attachment_id,
4032
					'file' => $attachment->post_title,
4033
					'url'  => wp_get_attachment_url( $attachment_id ),
4034
					'type' => $attachment->post_mime_type,
4035
					'meta' => wp_get_attachment_metadata( $attachment_id ),
4036
				);
4037
				// Zip files uploads are not supported unless they are done for installation purposed
4038
				// lets delete them in case something goes wrong in this whole process
4039
				if ( 'application/zip' === $attachment->post_mime_type ) {
4040
					// Schedule a cleanup for 2 hours from now in case of failed install.
4041
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
4042
				}
4043
			}
4044
		}
4045
		if ( ! is_null( $global_post ) ) {
4046
			$GLOBALS['post'] = $global_post;
4047
		}
4048
4049
		return $uploaded_files;
4050
	}
4051
4052
	/**
4053
	 * Add help to the Jetpack page
4054
	 *
4055
	 * @since Jetpack (1.2.3)
4056
	 * @return false if not the Jetpack page
4057
	 */
4058
	function admin_help() {
4059
		$current_screen = get_current_screen();
4060
4061
		// Overview
4062
		$current_screen->add_help_tab(
4063
			array(
4064
				'id'      => 'home',
4065
				'title'   => __( 'Home', 'jetpack' ),
4066
				'content' =>
4067
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4068
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
4069
					'<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>',
4070
			)
4071
		);
4072
4073
		// Screen Content
4074
		if ( current_user_can( 'manage_options' ) ) {
4075
			$current_screen->add_help_tab(
4076
				array(
4077
					'id'      => 'settings',
4078
					'title'   => __( 'Settings', 'jetpack' ),
4079
					'content' =>
4080
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4081
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
4082
						'<ol>' .
4083
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
4084
							'<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>' .
4085
						'</ol>' .
4086
						'<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>',
4087
				)
4088
			);
4089
		}
4090
4091
		// Help Sidebar
4092
		$support_url = Redirect::get_url( 'jetpack-support' );
4093
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
4094
		$current_screen->set_help_sidebar(
4095
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
4096
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
4097
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
4098
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
4099
		);
4100
	}
4101
4102
	function admin_menu_css() {
4103
		wp_enqueue_style( 'jetpack-icons' );
4104
	}
4105
4106
	function admin_menu_order() {
4107
		return true;
4108
	}
4109
4110 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
4111
		$jp_menu_order = array();
4112
4113
		foreach ( $menu_order as $index => $item ) {
4114
			if ( $item != 'jetpack' ) {
4115
				$jp_menu_order[] = $item;
4116
			}
4117
4118
			if ( $index == 0 ) {
4119
				$jp_menu_order[] = 'jetpack';
4120
			}
4121
		}
4122
4123
		return $jp_menu_order;
4124
	}
4125
4126
	function admin_banner_styles() {
4127
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4128
4129 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4130
			wp_register_style(
4131
				'jetpack-dops-style',
4132
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4133
				array(),
4134
				JETPACK__VERSION
4135
			);
4136
		}
4137
4138
		wp_enqueue_style(
4139
			'jetpack',
4140
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4141
			array( 'jetpack-dops-style' ),
4142
			JETPACK__VERSION . '-20121016'
4143
		);
4144
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4145
		wp_style_add_data( 'jetpack', 'suffix', $min );
4146
	}
4147
4148
	function plugin_action_links( $actions ) {
4149
4150
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4151
4152
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4153
			return array_merge(
4154
				$jetpack_home,
4155
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4156
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4157
				$actions
4158
			);
4159
		}
4160
4161
		return array_merge( $jetpack_home, $actions );
4162
	}
4163
4164
	/**
4165
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4166
	 *
4167
	 * @param string $login_url The wp-login URL.
4168
	 * @param string $redirect  URL to redirect users after logging in.
4169
	 * @since Jetpack 8.4
4170
	 * @return string
4171
	 */
4172
	public function login_url( $login_url, $redirect ) {
4173
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
4174
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4175
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4176
		}
4177
		return $login_url;
4178
	}
4179
4180
	/**
4181
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4182
	 *
4183
	 * @since Jetpack 8.4
4184
	 */
4185
	public function login_init() {
4186
		// phpcs:ignore WordPress.Security.NonceVerification
4187
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4188
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4189
			wp_safe_redirect(
4190
				add_query_arg(
4191
					array(
4192
						'forceInstall' => 1,
4193
						'url'          => rawurlencode( get_site_url() ),
4194
					),
4195
					// @todo provide way to go to specific calypso env.
4196
					self::get_calypso_host() . 'jetpack/connect'
4197
				)
4198
			);
4199
			exit;
4200
		}
4201
	}
4202
4203
	/*
4204
	 * Registration flow:
4205
	 * 1 - ::admin_page_load() action=register
4206
	 * 2 - ::try_registration()
4207
	 * 3 - ::register()
4208
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4209
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4210
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4211
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4212
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4213
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4214
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4215
	 *       jetpack_id, jetpack_secret, jetpack_public
4216
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4217
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4218
	 * 5 - user logs in with WP.com account
4219
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4220
	 *		- Manager::authorize()
4221
	 *		- Manager::get_token()
4222
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4223
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4224
	 *			- which responds with access_token, token_type, scope
4225
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4226
	 *		- Jetpack::activate_default_modules()
4227
	 *     		- Deactivates deprecated plugins
4228
	 *     		- Activates all default modules
4229
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4230
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4231
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4232
	 *     Done!
4233
	 */
4234
4235
	/**
4236
	 * Handles the page load events for the Jetpack admin page
4237
	 */
4238
	function admin_page_load() {
4239
		$error = false;
4240
4241
		// Make sure we have the right body class to hook stylings for subpages off of.
4242
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4243
4244
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4245
			// Should only be used in intermediate redirects to preserve state across redirects
4246
			self::restate();
4247
		}
4248
4249
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4250
			// @todo: Add validation against a known whitelist
4251
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4252
			// User clicked in the iframe to link their accounts
4253
			if ( ! self::is_user_connected() ) {
4254
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4255
4256
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4257
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4258
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4259
4260
				if ( isset( $_GET['notes_iframe'] ) ) {
4261
					$connect_url .= '&notes_iframe';
4262
				}
4263
				wp_redirect( $connect_url );
4264
				exit;
4265
			} else {
4266
				if ( ! isset( $_GET['calypso_env'] ) ) {
4267
					self::state( 'message', 'already_authorized' );
4268
					wp_safe_redirect( self::admin_url() );
4269
					exit;
4270
				} else {
4271
					$connect_url  = $this->build_connect_url( true, false, $from );
4272
					$connect_url .= '&already_authorized=true';
4273
					wp_redirect( $connect_url );
4274
					exit;
4275
				}
4276
			}
4277
		}
4278
4279
		if ( isset( $_GET['action'] ) ) {
4280
			switch ( $_GET['action'] ) {
4281
				case 'authorize':
4282
					if ( self::is_active() && self::is_user_connected() ) {
4283
						self::state( 'message', 'already_authorized' );
4284
						wp_safe_redirect( self::admin_url() );
4285
						exit;
4286
					}
4287
					self::log( 'authorize' );
4288
					$client_server = new Jetpack_Client_Server();
4289
					$client_server->client_authorize();
4290
					exit;
4291
				case 'register':
4292
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4293
						$error = 'cheatin';
4294
						break;
4295
					}
4296
					check_admin_referer( 'jetpack-register' );
4297
					self::log( 'register' );
4298
					self::maybe_set_version_option();
4299
					$registered = self::try_registration();
4300 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4301
						$error = $registered->get_error_code();
4302
						self::state( 'error', $error );
4303
						self::state( 'error', $registered->get_error_message() );
4304
4305
						/**
4306
						 * Jetpack registration Error.
4307
						 *
4308
						 * @since 7.5.0
4309
						 *
4310
						 * @param string|int $error The error code.
4311
						 * @param \WP_Error $registered The error object.
4312
						 */
4313
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4314
						break;
4315
					}
4316
4317
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4318
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4319
4320
					/**
4321
					 * Jetpack registration Success.
4322
					 *
4323
					 * @since 7.5.0
4324
					 *
4325
					 * @param string $from 'from' GET parameter;
4326
					 */
4327
					do_action( 'jetpack_connection_register_success', $from );
4328
4329
					$url = $this->build_connect_url( true, $redirect, $from );
4330
4331
					if ( ! empty( $_GET['onboarding'] ) ) {
4332
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4333
					}
4334
4335
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4336
						$url = add_query_arg( 'auth_approved', 'true', $url );
4337
					}
4338
4339
					wp_redirect( $url );
4340
					exit;
4341
				case 'activate':
4342
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4343
						$error = 'cheatin';
4344
						break;
4345
					}
4346
4347
					$module = stripslashes( $_GET['module'] );
4348
					check_admin_referer( "jetpack_activate-$module" );
4349
					self::log( 'activate', $module );
4350
					if ( ! self::activate_module( $module ) ) {
4351
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4352
					}
4353
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4354
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4355
					exit;
4356
				case 'activate_default_modules':
4357
					check_admin_referer( 'activate_default_modules' );
4358
					self::log( 'activate_default_modules' );
4359
					self::restate();
4360
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4361
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4362
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4363
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4364
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4365
					exit;
4366
				case 'disconnect':
4367
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4368
						$error = 'cheatin';
4369
						break;
4370
					}
4371
4372
					check_admin_referer( 'jetpack-disconnect' );
4373
					self::log( 'disconnect' );
4374
					self::disconnect();
4375
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4376
					exit;
4377
				case 'reconnect':
4378
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4379
						$error = 'cheatin';
4380
						break;
4381
					}
4382
4383
					check_admin_referer( 'jetpack-reconnect' );
4384
					self::log( 'reconnect' );
4385
					$this->disconnect();
4386
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4387
					exit;
4388 View Code Duplication
				case 'deactivate':
4389
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4390
						$error = 'cheatin';
4391
						break;
4392
					}
4393
4394
					$modules = stripslashes( $_GET['module'] );
4395
					check_admin_referer( "jetpack_deactivate-$modules" );
4396
					foreach ( explode( ',', $modules ) as $module ) {
4397
						self::log( 'deactivate', $module );
4398
						self::deactivate_module( $module );
4399
						self::state( 'message', 'module_deactivated' );
4400
					}
4401
					self::state( 'module', $modules );
4402
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4403
					exit;
4404
				case 'unlink':
4405
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4406
					check_admin_referer( 'jetpack-unlink' );
4407
					self::log( 'unlink' );
4408
					Connection_Manager::disconnect_user();
4409
					self::state( 'message', 'unlinked' );
4410
					if ( 'sub-unlink' == $redirect ) {
4411
						wp_safe_redirect( admin_url() );
4412
					} else {
4413
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4414
					}
4415
					exit;
4416
				case 'onboard':
4417
					if ( ! current_user_can( 'manage_options' ) ) {
4418
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4419
					} else {
4420
						self::create_onboarding_token();
4421
						$url = $this->build_connect_url( true );
4422
4423
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4424
							$url = add_query_arg( 'onboarding', $token, $url );
4425
						}
4426
4427
						$calypso_env = $this->get_calypso_env();
4428
						if ( ! empty( $calypso_env ) ) {
4429
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4430
						}
4431
4432
						wp_redirect( $url );
4433
						exit;
4434
					}
4435
					exit;
4436
				default:
4437
					/**
4438
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4439
					 *
4440
					 * @since 2.6.0
4441
					 *
4442
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4443
					 */
4444
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4445
			}
4446
		}
4447
4448
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4449
			self::activate_new_modules( true );
4450
		}
4451
4452
		$message_code = self::state( 'message' );
4453
		if ( self::state( 'optin-manage' ) ) {
4454
			$activated_manage = $message_code;
4455
			$message_code     = 'jetpack-manage';
4456
		}
4457
4458
		switch ( $message_code ) {
4459
			case 'jetpack-manage':
4460
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4461
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4462
				$this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), $sites_url ) . '</strong>';
4463
				if ( $activated_manage ) {
4464
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4465
				}
4466
				break;
4467
4468
		}
4469
4470
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4471
4472
		if ( ! empty( $deactivated_plugins ) ) {
4473
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4474
			$deactivated_titles  = array();
4475
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4476
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4477
					continue;
4478
				}
4479
4480
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4481
			}
4482
4483
			if ( $deactivated_titles ) {
4484
				if ( $this->message ) {
4485
					$this->message .= "<br /><br />\n";
4486
				}
4487
4488
				$this->message .= wp_sprintf(
4489
					_n(
4490
						'Jetpack contains the most recent version of the old %l plugin.',
4491
						'Jetpack contains the most recent versions of the old %l plugins.',
4492
						count( $deactivated_titles ),
4493
						'jetpack'
4494
					),
4495
					$deactivated_titles
4496
				);
4497
4498
				$this->message .= "<br />\n";
4499
4500
				$this->message .= _n(
4501
					'The old version has been deactivated and can be removed from your site.',
4502
					'The old versions have been deactivated and can be removed from your site.',
4503
					count( $deactivated_titles ),
4504
					'jetpack'
4505
				);
4506
			}
4507
		}
4508
4509
		$this->privacy_checks = self::state( 'privacy_checks' );
4510
4511
		if ( $this->message || $this->error || $this->privacy_checks ) {
4512
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4513
		}
4514
4515
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4516
	}
4517
4518
	function admin_notices() {
4519
4520
		if ( $this->error ) {
4521
			?>
4522
<div id="message" class="jetpack-message jetpack-err">
4523
	<div class="squeezer">
4524
		<h2>
4525
			<?php
4526
			echo wp_kses(
4527
				$this->error,
4528
				array(
4529
					'a'      => array( 'href' => array() ),
4530
					'small'  => true,
4531
					'code'   => true,
4532
					'strong' => true,
4533
					'br'     => true,
4534
					'b'      => true,
4535
				)
4536
			);
4537
			?>
4538
			</h2>
4539
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4540
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4541
<?php	endif; ?>
4542
	</div>
4543
</div>
4544
			<?php
4545
		}
4546
4547
		if ( $this->message ) {
4548
			?>
4549
<div id="message" class="jetpack-message">
4550
	<div class="squeezer">
4551
		<h2>
4552
			<?php
4553
			echo wp_kses(
4554
				$this->message,
4555
				array(
4556
					'strong' => array(),
4557
					'a'      => array( 'href' => true ),
4558
					'br'     => true,
4559
				)
4560
			);
4561
			?>
4562
			</h2>
4563
	</div>
4564
</div>
4565
			<?php
4566
		}
4567
4568
		if ( $this->privacy_checks ) :
4569
			$module_names = $module_slugs = array();
4570
4571
			$privacy_checks = explode( ',', $this->privacy_checks );
4572
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4573
			foreach ( $privacy_checks as $module_slug ) {
4574
				$module = self::get_module( $module_slug );
4575
				if ( ! $module ) {
4576
					continue;
4577
				}
4578
4579
				$module_slugs[] = $module_slug;
4580
				$module_names[] = "<strong>{$module['name']}</strong>";
4581
			}
4582
4583
			$module_slugs = join( ',', $module_slugs );
4584
			?>
4585
<div id="message" class="jetpack-message jetpack-err">
4586
	<div class="squeezer">
4587
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4588
		<p>
4589
			<?php
4590
			echo wp_kses(
4591
				wptexturize(
4592
					wp_sprintf(
4593
						_nx(
4594
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4595
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4596
							count( $privacy_checks ),
4597
							'%l = list of Jetpack module/feature names',
4598
							'jetpack'
4599
						),
4600
						$module_names
4601
					)
4602
				),
4603
				array( 'strong' => true )
4604
			);
4605
4606
			echo "\n<br />\n";
4607
4608
			echo wp_kses(
4609
				sprintf(
4610
					_nx(
4611
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4612
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4613
						count( $privacy_checks ),
4614
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4615
						'jetpack'
4616
					),
4617
					wp_nonce_url(
4618
						self::admin_url(
4619
							array(
4620
								'page'   => 'jetpack',
4621
								'action' => 'deactivate',
4622
								'module' => urlencode( $module_slugs ),
4623
							)
4624
						),
4625
						"jetpack_deactivate-$module_slugs"
4626
					),
4627
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4628
				),
4629
				array(
4630
					'a' => array(
4631
						'href'  => true,
4632
						'title' => true,
4633
					),
4634
				)
4635
			);
4636
			?>
4637
		</p>
4638
	</div>
4639
</div>
4640
			<?php
4641
endif;
4642
	}
4643
4644
	/**
4645
	 * We can't always respond to a signed XML-RPC request with a
4646
	 * helpful error message. In some circumstances, doing so could
4647
	 * leak information.
4648
	 *
4649
	 * Instead, track that the error occurred via a Jetpack_Option,
4650
	 * and send that data back in the heartbeat.
4651
	 * All this does is increment a number, but it's enough to find
4652
	 * trends.
4653
	 *
4654
	 * @param WP_Error $xmlrpc_error The error produced during
4655
	 *                               signature validation.
4656
	 */
4657
	function track_xmlrpc_error( $xmlrpc_error ) {
4658
		$code = is_wp_error( $xmlrpc_error )
4659
			? $xmlrpc_error->get_error_code()
4660
			: 'should-not-happen';
4661
4662
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4663
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4664
			// No need to update the option if we already have
4665
			// this code stored.
4666
			return;
4667
		}
4668
		$xmlrpc_errors[ $code ] = true;
4669
4670
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
4671
	}
4672
4673
	/**
4674
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4675
	 */
4676
	function stat( $group, $detail ) {
4677
		if ( ! isset( $this->stats[ $group ] ) ) {
4678
			$this->stats[ $group ] = array();
4679
		}
4680
		$this->stats[ $group ][] = $detail;
4681
	}
4682
4683
	/**
4684
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4685
	 */
4686
	function do_stats( $method = '' ) {
4687
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4688
			foreach ( $this->stats as $group => $stats ) {
4689
				if ( is_array( $stats ) && count( $stats ) ) {
4690
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4691
					if ( 'server_side' === $method ) {
4692
						self::do_server_side_stat( $args );
4693
					} else {
4694
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4695
					}
4696
				}
4697
				unset( $this->stats[ $group ] );
4698
			}
4699
		}
4700
	}
4701
4702
	/**
4703
	 * Runs stats code for a one-off, server-side.
4704
	 *
4705
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4706
	 *
4707
	 * @return bool If it worked.
4708
	 */
4709
	static function do_server_side_stat( $args ) {
4710
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4711
		if ( is_wp_error( $response ) ) {
4712
			return false;
4713
		}
4714
4715
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4716
			return false;
4717
		}
4718
4719
		return true;
4720
	}
4721
4722
	/**
4723
	 * Builds the stats url.
4724
	 *
4725
	 * @param $args array|string The arguments to append to the URL.
4726
	 *
4727
	 * @return string The URL to be pinged.
4728
	 */
4729
	static function build_stats_url( $args ) {
4730
		$defaults = array(
4731
			'v'    => 'wpcom2',
4732
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4733
		);
4734
		$args     = wp_parse_args( $args, $defaults );
4735
		/**
4736
		 * Filter the URL used as the Stats tracking pixel.
4737
		 *
4738
		 * @since 2.3.2
4739
		 *
4740
		 * @param string $url Base URL used as the Stats tracking pixel.
4741
		 */
4742
		$base_url = apply_filters(
4743
			'jetpack_stats_base_url',
4744
			'https://pixel.wp.com/g.gif'
4745
		);
4746
		$url      = add_query_arg( $args, $base_url );
4747
		return $url;
4748
	}
4749
4750
	/**
4751
	 * Get the role of the current user.
4752
	 *
4753
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4754
	 *
4755
	 * @access public
4756
	 * @static
4757
	 *
4758
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4759
	 */
4760
	public static function translate_current_user_to_role() {
4761
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4762
4763
		$roles = new Roles();
4764
		return $roles->translate_current_user_to_role();
4765
	}
4766
4767
	/**
4768
	 * Get the role of a particular user.
4769
	 *
4770
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4771
	 *
4772
	 * @access public
4773
	 * @static
4774
	 *
4775
	 * @param \WP_User $user User object.
4776
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4777
	 */
4778
	public static function translate_user_to_role( $user ) {
4779
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4780
4781
		$roles = new Roles();
4782
		return $roles->translate_user_to_role( $user );
4783
	}
4784
4785
	/**
4786
	 * Get the minimum capability for a role.
4787
	 *
4788
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4789
	 *
4790
	 * @access public
4791
	 * @static
4792
	 *
4793
	 * @param string $role Role name.
4794
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4795
	 */
4796
	public static function translate_role_to_cap( $role ) {
4797
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4798
4799
		$roles = new Roles();
4800
		return $roles->translate_role_to_cap( $role );
4801
	}
4802
4803
	/**
4804
	 * Sign a user role with the master access token.
4805
	 * If not specified, will default to the current user.
4806
	 *
4807
	 * @deprecated since 7.7
4808
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4809
	 *
4810
	 * @access public
4811
	 * @static
4812
	 *
4813
	 * @param string $role    User role.
4814
	 * @param int    $user_id ID of the user.
4815
	 * @return string Signed user role.
4816
	 */
4817
	public static function sign_role( $role, $user_id = null ) {
4818
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4819
		return self::connection()->sign_role( $role, $user_id );
4820
	}
4821
4822
	/**
4823
	 * Builds a URL to the Jetpack connection auth page
4824
	 *
4825
	 * @since 3.9.5
4826
	 *
4827
	 * @param bool        $raw If true, URL will not be escaped.
4828
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4829
	 *                              If string, will be a custom redirect.
4830
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4831
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4832
	 *
4833
	 * @return string Connect URL
4834
	 */
4835
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4836
		$site_id    = Jetpack_Options::get_option( 'id' );
4837
		$blog_token = Jetpack_Data::get_access_token();
4838
4839
		if ( $register || ! $blog_token || ! $site_id ) {
4840
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4841
4842
			if ( ! empty( $redirect ) ) {
4843
				$url = add_query_arg(
4844
					'redirect',
4845
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4846
					$url
4847
				);
4848
			}
4849
4850
			if ( is_network_admin() ) {
4851
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4852
			}
4853
4854
			$calypso_env = self::get_calypso_env();
4855
4856
			if ( ! empty( $calypso_env ) ) {
4857
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4858
			}
4859
		} else {
4860
4861
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4862
			// because otherwise this logic can get us in to a loop.
4863
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4864
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4865
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4866
4867
				$response = Client::wpcom_json_api_request_as_blog(
4868
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4869
					'1.1'
4870
				);
4871
4872
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4873
4874
					// Generating a register URL instead to refresh the existing token
4875
					return $this->build_connect_url( $raw, $redirect, $from, true );
4876
				}
4877
			}
4878
4879
			$url = $this->build_authorize_url( $redirect );
4880
		}
4881
4882
		if ( $from ) {
4883
			$url = add_query_arg( 'from', $from, $url );
4884
		}
4885
4886
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4887
		/**
4888
		 * Filter the URL used when connecting a user to a WordPress.com account.
4889
		 *
4890
		 * @since 8.1.0
4891
		 *
4892
		 * @param string $url Connection URL.
4893
		 * @param bool   $raw If true, URL will not be escaped.
4894
		 */
4895
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4896
	}
4897
4898
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4899
4900
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4901
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4902
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4903
4904
		if ( $iframe ) {
4905
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4906
		}
4907
4908
		$c8n = self::connection();
4909
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
4910
4911
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4912
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4913
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4914
4915
		if ( $iframe ) {
4916
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4917
		}
4918
4919
		return $url;
4920
	}
4921
4922
	/**
4923
	 * Filters the connection URL parameter array.
4924
	 *
4925
	 * @param array $args default URL parameters used by the package.
4926
	 * @return array the modified URL arguments array.
4927
	 */
4928
	public static function filter_connect_request_body( $args ) {
4929
		if (
4930
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4931
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4932
		) {
4933
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4934
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4935
				? $gp_locale->slug
4936
				: '';
4937
		}
4938
4939
		$tracking        = new Tracking();
4940
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4941
4942
		$args = array_merge(
4943
			$args,
4944
			array(
4945
				'_ui' => $tracks_identity['_ui'],
4946
				'_ut' => $tracks_identity['_ut'],
4947
			)
4948
		);
4949
4950
		$calypso_env = self::get_calypso_env();
4951
4952
		if ( ! empty( $calypso_env ) ) {
4953
			$args['calypso_env'] = $calypso_env;
4954
		}
4955
4956
		return $args;
4957
	}
4958
4959
	/**
4960
	 * Filters the URL that will process the connection data. It can be different from the URL
4961
	 * that we send the user to after everything is done.
4962
	 *
4963
	 * @param String $processing_url the default redirect URL used by the package.
4964
	 * @return String the modified URL.
4965
	 */
4966
	public static function filter_connect_processing_url( $processing_url ) {
4967
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4968
		return $processing_url;
4969
	}
4970
4971
	/**
4972
	 * Filters the redirection URL that is used for connect requests. The redirect
4973
	 * URL should return the user back to the Jetpack console.
4974
	 *
4975
	 * @param String $redirect the default redirect URL used by the package.
4976
	 * @return String the modified URL.
4977
	 */
4978
	public static function filter_connect_redirect_url( $redirect ) {
4979
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4980
		$redirect           = $redirect
4981
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4982
			: $jetpack_admin_page;
4983
4984
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4985
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4986
		}
4987
4988
		return $redirect;
4989
	}
4990
4991
	/**
4992
	 * This action fires at the beginning of the Manager::authorize method.
4993
	 */
4994
	public static function authorize_starting() {
4995
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4996
		// Checking if site has been active/connected previously before recording unique connection.
4997
		if ( ! $jetpack_unique_connection ) {
4998
			// jetpack_unique_connection option has never been set.
4999
			$jetpack_unique_connection = array(
5000
				'connected'    => 0,
5001
				'disconnected' => 0,
5002
				'version'      => '3.6.1',
5003
			);
5004
5005
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
5006
5007
			// Track unique connection.
5008
			$jetpack = self::init();
5009
5010
			$jetpack->stat( 'connections', 'unique-connection' );
5011
			$jetpack->do_stats( 'server_side' );
5012
		}
5013
5014
		// Increment number of times connected.
5015
		$jetpack_unique_connection['connected'] += 1;
5016
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
5017
	}
5018
5019
	/**
5020
	 * This action fires at the end of the Manager::authorize method when a secondary user is
5021
	 * linked.
5022
	 */
5023
	public static function authorize_ending_linked() {
5024
		// Don't activate anything since we are just connecting a user.
5025
		self::state( 'message', 'linked' );
5026
	}
5027
5028
	/**
5029
	 * This action fires at the end of the Manager::authorize method when the master user is
5030
	 * authorized.
5031
	 *
5032
	 * @param array $data The request data.
5033
	 */
5034
	public static function authorize_ending_authorized( $data ) {
5035
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
5036
		self::invalidate_onboarding_token();
5037
5038
		// If redirect_uri is SSO, ensure SSO module is enabled.
5039
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5040
5041
		/** This filter is documented in class.jetpack-cli.php */
5042
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
5043
5044
		$activate_sso = (
5045
			isset( $redirect_options['action'] ) &&
5046
			'jetpack-sso' === $redirect_options['action'] &&
5047
			$jetpack_start_enable_sso
5048
		);
5049
5050
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
5051
5052
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
5053
	}
5054
5055
	/**
5056
	 * Get our assumed site creation date.
5057
	 * Calculated based on the earlier date of either:
5058
	 * - Earliest admin user registration date.
5059
	 * - Earliest date of post of any post type.
5060
	 *
5061
	 * @since 7.2.0
5062
	 * @deprecated since 7.8.0
5063
	 *
5064
	 * @return string Assumed site creation date and time.
5065
	 */
5066
	public static function get_assumed_site_creation_date() {
5067
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
5068
		return self::connection()->get_assumed_site_creation_date();
5069
	}
5070
5071 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
5072
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
5073
5074
		if ( $activation_source_name ) {
5075
			$args['_as'] = urlencode( $activation_source_name );
5076
		}
5077
5078
		if ( $activation_source_keyword ) {
5079
			$args['_ak'] = urlencode( $activation_source_keyword );
5080
		}
5081
	}
5082
5083
	function build_reconnect_url( $raw = false ) {
5084
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
5085
		return $raw ? $url : esc_url( $url );
5086
	}
5087
5088
	public static function admin_url( $args = null ) {
5089
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
5090
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5091
		return $url;
5092
	}
5093
5094
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5095
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5096
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5097
	}
5098
5099
	function dismiss_jetpack_notice() {
5100
5101
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5102
			return;
5103
		}
5104
5105
		switch ( $_GET['jetpack-notice'] ) {
5106
			case 'dismiss':
5107
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5108
5109
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5110
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5111
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5112
				}
5113
				break;
5114
		}
5115
	}
5116
5117
	public static function sort_modules( $a, $b ) {
5118
		if ( $a['sort'] == $b['sort'] ) {
5119
			return 0;
5120
		}
5121
5122
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5123
	}
5124
5125
	function ajax_recheck_ssl() {
5126
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5127
		$result = self::permit_ssl( true );
5128
		wp_send_json(
5129
			array(
5130
				'enabled' => $result,
5131
				'message' => get_transient( 'jetpack_https_test_message' ),
5132
			)
5133
		);
5134
	}
5135
5136
	/* Client API */
5137
5138
	/**
5139
	 * Returns the requested Jetpack API URL
5140
	 *
5141
	 * @deprecated since 7.7
5142
	 * @return string
5143
	 */
5144
	public static function api_url( $relative_url ) {
5145
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5146
		$connection = self::connection();
5147
		return $connection->api_url( $relative_url );
5148
	}
5149
5150
	/**
5151
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5152
	 *
5153
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5154
	 */
5155
	public static function fix_url_for_bad_hosts( $url ) {
5156
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5157
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5158
	}
5159
5160
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5161
		// Default to a blog token.
5162
		$token_type = 'blog';
5163
5164
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5165
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5166
			if ( ! empty( $_GET['onboarding'] ) ) {
5167
				$jpo = $_GET;
5168
			} else {
5169
				$jpo = json_decode( $request_data, true );
5170
			}
5171
5172
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5173
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5174
5175
			if (
5176
				isset( $jpo_user )
5177
				&& isset( $jpo_token )
5178
				&& is_email( $jpo_user )
5179
				&& ctype_alnum( $jpo_token )
5180
				&& isset( $_GET['rest_route'] )
5181
				&& self::validate_onboarding_token_action(
5182
					$jpo_token,
5183
					$_GET['rest_route']
5184
				)
5185
			) {
5186
				$jp_user = get_user_by( 'email', $jpo_user );
5187
				if ( is_a( $jp_user, 'WP_User' ) ) {
5188
					wp_set_current_user( $jp_user->ID );
5189
					$user_can = is_multisite()
5190
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5191
						: current_user_can( 'manage_options' );
5192
					if ( $user_can ) {
5193
						$token_type              = 'user';
5194
						$token->external_user_id = $jp_user->ID;
5195
					}
5196
				}
5197
			}
5198
5199
			$token_data['type']    = $token_type;
5200
			$token_data['user_id'] = $token->external_user_id;
5201
		}
5202
5203
		return $token_data;
5204
	}
5205
5206
	/**
5207
	 * Create a random secret for validating onboarding payload
5208
	 *
5209
	 * @return string Secret token
5210
	 */
5211
	public static function create_onboarding_token() {
5212
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5213
			$token = wp_generate_password( 32, false );
5214
			Jetpack_Options::update_option( 'onboarding', $token );
5215
		}
5216
5217
		return $token;
5218
	}
5219
5220
	/**
5221
	 * Remove the onboarding token
5222
	 *
5223
	 * @return bool True on success, false on failure
5224
	 */
5225
	public static function invalidate_onboarding_token() {
5226
		return Jetpack_Options::delete_option( 'onboarding' );
5227
	}
5228
5229
	/**
5230
	 * Validate an onboarding token for a specific action
5231
	 *
5232
	 * @return boolean True if token/action pair is accepted, false if not
5233
	 */
5234
	public static function validate_onboarding_token_action( $token, $action ) {
5235
		// Compare tokens, bail if tokens do not match
5236
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5237
			return false;
5238
		}
5239
5240
		// List of valid actions we can take
5241
		$valid_actions = array(
5242
			'/jetpack/v4/settings',
5243
		);
5244
5245
		// Whitelist the action
5246
		if ( ! in_array( $action, $valid_actions ) ) {
5247
			return false;
5248
		}
5249
5250
		return true;
5251
	}
5252
5253
	/**
5254
	 * Checks to see if the URL is using SSL to connect with Jetpack
5255
	 *
5256
	 * @since 2.3.3
5257
	 * @return boolean
5258
	 */
5259
	public static function permit_ssl( $force_recheck = false ) {
5260
		// Do some fancy tests to see if ssl is being supported
5261
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5262
			$message = '';
5263
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5264
				$ssl = 0;
5265
			} else {
5266
				switch ( JETPACK_CLIENT__HTTPS ) {
5267
					case 'NEVER':
5268
						$ssl     = 0;
5269
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5270
						break;
5271
					case 'ALWAYS':
5272
					case 'AUTO':
5273
					default:
5274
						$ssl = 1;
5275
						break;
5276
				}
5277
5278
				// If it's not 'NEVER', test to see
5279
				if ( $ssl ) {
5280
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5281
						$ssl     = 0;
5282
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5283
					} else {
5284
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5285
						if ( is_wp_error( $response ) ) {
5286
							$ssl     = 0;
5287
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5288
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5289
							$ssl     = 0;
5290
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5291
						}
5292
					}
5293
				}
5294
			}
5295
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5296
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5297
		}
5298
5299
		return (bool) $ssl;
5300
	}
5301
5302
	/*
5303
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5304
	 */
5305
	public function alert_auto_ssl_fail() {
5306
		if ( ! current_user_can( 'manage_options' ) ) {
5307
			return;
5308
		}
5309
5310
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5311
		?>
5312
5313
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5314
			<div class="jp-banner__content">
5315
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5316
				<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>
5317
				<p>
5318
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5319
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5320
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5321
				</p>
5322
				<p>
5323
					<?php
5324
					printf(
5325
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5326
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5327
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5328
					);
5329
					?>
5330
				</p>
5331
			</div>
5332
		</div>
5333
		<style>
5334
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5335
		</style>
5336
		<script type="text/javascript">
5337
			jQuery( document ).ready( function( $ ) {
5338
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5339
					var $this = $( this );
5340
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5341
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5342
					e.preventDefault();
5343
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5344
					$.post( ajaxurl, data )
5345
					  .done( function( response ) {
5346
						  if ( response.enabled ) {
5347
							  $( '#jetpack-ssl-warning' ).hide();
5348
						  } else {
5349
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5350
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5351
						  }
5352
					  }.bind( $this ) );
5353
				} );
5354
			} );
5355
		</script>
5356
5357
		<?php
5358
	}
5359
5360
	/**
5361
	 * Returns the Jetpack XML-RPC API
5362
	 *
5363
	 * @deprecated 8.0 Use Connection_Manager instead.
5364
	 * @return string
5365
	 */
5366
	public static function xmlrpc_api_url() {
5367
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5368
		return self::connection()->xmlrpc_api_url();
5369
	}
5370
5371
	/**
5372
	 * Returns the connection manager object.
5373
	 *
5374
	 * @return Automattic\Jetpack\Connection\Manager
5375
	 */
5376
	public static function connection() {
5377
		$jetpack = static::init();
5378
5379
		// If the connection manager hasn't been instantiated, do that now.
5380
		if ( ! $jetpack->connection_manager ) {
5381
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5382
		}
5383
5384
		return $jetpack->connection_manager;
5385
	}
5386
5387
	/**
5388
	 * Creates two secret tokens and the end of life timestamp for them.
5389
	 *
5390
	 * Note these tokens are unique per call, NOT static per site for connecting.
5391
	 *
5392
	 * @since 2.6
5393
	 * @param String  $action  The action name.
5394
	 * @param Integer $user_id The user identifier.
5395
	 * @param Integer $exp     Expiration time in seconds.
5396
	 * @return array
5397
	 */
5398
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5399
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5400
	}
5401
5402
	public static function get_secrets( $action, $user_id ) {
5403
		$secrets = self::connection()->get_secrets( $action, $user_id );
5404
5405
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5406
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
5407
		}
5408
5409
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5410
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
5411
		}
5412
5413
		return $secrets;
5414
	}
5415
5416
	/**
5417
	 * @deprecated 7.5 Use Connection_Manager instead.
5418
	 *
5419
	 * @param $action
5420
	 * @param $user_id
5421
	 */
5422
	public static function delete_secrets( $action, $user_id ) {
5423
		return self::connection()->delete_secrets( $action, $user_id );
5424
	}
5425
5426
	/**
5427
	 * Builds the timeout limit for queries talking with the wpcom servers.
5428
	 *
5429
	 * Based on local php max_execution_time in php.ini
5430
	 *
5431
	 * @since 2.6
5432
	 * @return int
5433
	 * @deprecated
5434
	 **/
5435
	public function get_remote_query_timeout_limit() {
5436
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5437
		return self::get_max_execution_time();
5438
	}
5439
5440
	/**
5441
	 * Builds the timeout limit for queries talking with the wpcom servers.
5442
	 *
5443
	 * Based on local php max_execution_time in php.ini
5444
	 *
5445
	 * @since 5.4
5446
	 * @return int
5447
	 **/
5448
	public static function get_max_execution_time() {
5449
		$timeout = (int) ini_get( 'max_execution_time' );
5450
5451
		// Ensure exec time set in php.ini
5452
		if ( ! $timeout ) {
5453
			$timeout = 30;
5454
		}
5455
		return $timeout;
5456
	}
5457
5458
	/**
5459
	 * Sets a minimum request timeout, and returns the current timeout
5460
	 *
5461
	 * @since 5.4
5462
	 **/
5463 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5464
		$timeout = self::get_max_execution_time();
5465
		if ( $timeout < $min_timeout ) {
5466
			$timeout = $min_timeout;
5467
			set_time_limit( $timeout );
5468
		}
5469
		return $timeout;
5470
	}
5471
5472
	/**
5473
	 * Takes the response from the Jetpack register new site endpoint and
5474
	 * verifies it worked properly.
5475
	 *
5476
	 * @since 2.6
5477
	 * @deprecated since 7.7.0
5478
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5479
	 **/
5480
	public function validate_remote_register_response() {
5481
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5482
	}
5483
5484
	/**
5485
	 * @return bool|WP_Error
5486
	 */
5487
	public static function register() {
5488
		$tracking = new Tracking();
5489
		$tracking->record_user_event( 'jpc_register_begin' );
5490
5491
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5492
5493
		$connection   = self::connection();
5494
		$registration = $connection->register();
5495
5496
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5497
5498
		if ( ! $registration || is_wp_error( $registration ) ) {
5499
			return $registration;
5500
		}
5501
5502
		return true;
5503
	}
5504
5505
	/**
5506
	 * Filters the registration request body to include tracking properties.
5507
	 *
5508
	 * @param array $properties
5509
	 * @return array amended properties.
5510
	 */
5511 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5512
		$tracking        = new Tracking();
5513
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5514
5515
		return array_merge(
5516
			$properties,
5517
			array(
5518
				'_ui' => $tracks_identity['_ui'],
5519
				'_ut' => $tracks_identity['_ut'],
5520
			)
5521
		);
5522
	}
5523
5524
	/**
5525
	 * Filters the token request body to include tracking properties.
5526
	 *
5527
	 * @param array $properties
5528
	 * @return array amended properties.
5529
	 */
5530 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5531
		$tracking        = new Tracking();
5532
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5533
5534
		return array_merge(
5535
			$properties,
5536
			array(
5537
				'_ui' => $tracks_identity['_ui'],
5538
				'_ut' => $tracks_identity['_ut'],
5539
			)
5540
		);
5541
	}
5542
5543
	/**
5544
	 * If the db version is showing something other that what we've got now, bump it to current.
5545
	 *
5546
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
5547
	 */
5548
	public static function maybe_set_version_option() {
5549
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5550
		if ( JETPACK__VERSION != $version ) {
5551
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5552
5553
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5554
				/** This action is documented in class.jetpack.php */
5555
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5556
			}
5557
5558
			return true;
5559
		}
5560
		return false;
5561
	}
5562
5563
	/* Client Server API */
5564
5565
	/**
5566
	 * Loads the Jetpack XML-RPC client.
5567
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5568
	 *
5569
	 * @deprecated since 7.7.0
5570
	 */
5571
	public static function load_xml_rpc_client() {
5572
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5573
	}
5574
5575
	/**
5576
	 * Resets the saved authentication state in between testing requests.
5577
	 */
5578
	public function reset_saved_auth_state() {
5579
		$this->rest_authentication_status = null;
5580
5581
		if ( ! $this->connection_manager ) {
5582
			$this->connection_manager = new Connection_Manager();
5583
		}
5584
5585
		$this->connection_manager->reset_saved_auth_state();
5586
	}
5587
5588
	/**
5589
	 * Verifies the signature of the current request.
5590
	 *
5591
	 * @deprecated since 7.7.0
5592
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5593
	 *
5594
	 * @return false|array
5595
	 */
5596
	public function verify_xml_rpc_signature() {
5597
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5598
		return self::connection()->verify_xml_rpc_signature();
5599
	}
5600
5601
	/**
5602
	 * Verifies the signature of the current request.
5603
	 *
5604
	 * This function has side effects and should not be used. Instead,
5605
	 * use the memoized version `->verify_xml_rpc_signature()`.
5606
	 *
5607
	 * @deprecated since 7.7.0
5608
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5609
	 * @internal
5610
	 */
5611
	private function internal_verify_xml_rpc_signature() {
5612
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5613
	}
5614
5615
	/**
5616
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5617
	 *
5618
	 * @deprecated since 7.7.0
5619
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5620
	 *
5621
	 * @param \WP_User|mixed $user     User object if authenticated.
5622
	 * @param string         $username Username.
5623
	 * @param string         $password Password string.
5624
	 * @return \WP_User|mixed Authenticated user or error.
5625
	 */
5626 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5627
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5628
5629
		if ( ! $this->connection_manager ) {
5630
			$this->connection_manager = new Connection_Manager();
5631
		}
5632
5633
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5634
	}
5635
5636
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5637
	// Uses the existing XMLRPC request signing implementation.
5638
	function wp_rest_authenticate( $user ) {
5639
		if ( ! empty( $user ) ) {
5640
			// Another authentication method is in effect.
5641
			return $user;
5642
		}
5643
5644
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5645
			// Nothing to do for this authentication method.
5646
			return null;
5647
		}
5648
5649
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5650
			// Nothing to do for this authentication method.
5651
			return null;
5652
		}
5653
5654
		// Ensure that we always have the request body available.  At this
5655
		// point, the WP REST API code to determine the request body has not
5656
		// run yet.  That code may try to read from 'php://input' later, but
5657
		// this can only be done once per request in PHP versions prior to 5.6.
5658
		// So we will go ahead and perform this read now if needed, and save
5659
		// the request body where both the Jetpack signature verification code
5660
		// and the WP REST API code can see it.
5661
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5662
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5663
		}
5664
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5665
5666
		// Only support specific request parameters that have been tested and
5667
		// are known to work with signature verification.  A different method
5668
		// can be passed to the WP REST API via the '?_method=' parameter if
5669
		// needed.
5670
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5671
			$this->rest_authentication_status = new WP_Error(
5672
				'rest_invalid_request',
5673
				__( 'This request method is not supported.', 'jetpack' ),
5674
				array( 'status' => 400 )
5675
			);
5676
			return null;
5677
		}
5678
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5679
			$this->rest_authentication_status = new WP_Error(
5680
				'rest_invalid_request',
5681
				__( 'This request method does not support body parameters.', 'jetpack' ),
5682
				array( 'status' => 400 )
5683
			);
5684
			return null;
5685
		}
5686
5687
		if ( ! $this->connection_manager ) {
5688
			$this->connection_manager = new Connection_Manager();
5689
		}
5690
5691
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5692
5693
		if (
5694
			$verified &&
5695
			isset( $verified['type'] ) &&
5696
			'user' === $verified['type'] &&
5697
			! empty( $verified['user_id'] )
5698
		) {
5699
			// Authentication successful.
5700
			$this->rest_authentication_status = true;
5701
			return $verified['user_id'];
5702
		}
5703
5704
		// Something else went wrong.  Probably a signature error.
5705
		$this->rest_authentication_status = new WP_Error(
5706
			'rest_invalid_signature',
5707
			__( 'The request is not signed correctly.', 'jetpack' ),
5708
			array( 'status' => 400 )
5709
		);
5710
		return null;
5711
	}
5712
5713
	/**
5714
	 * Report authentication status to the WP REST API.
5715
	 *
5716
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
5717
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5718
	 */
5719
	public function wp_rest_authentication_errors( $value ) {
5720
		if ( $value !== null ) {
5721
			return $value;
5722
		}
5723
		return $this->rest_authentication_status;
5724
	}
5725
5726
	/**
5727
	 * Add our nonce to this request.
5728
	 *
5729
	 * @deprecated since 7.7.0
5730
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5731
	 *
5732
	 * @param int    $timestamp Timestamp of the request.
5733
	 * @param string $nonce     Nonce string.
5734
	 */
5735 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5736
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5737
5738
		if ( ! $this->connection_manager ) {
5739
			$this->connection_manager = new Connection_Manager();
5740
		}
5741
5742
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5743
	}
5744
5745
	/**
5746
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5747
	 * Capture it here so we can verify the signature later.
5748
	 *
5749
	 * @deprecated since 7.7.0
5750
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5751
	 *
5752
	 * @param array $methods XMLRPC methods.
5753
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5754
	 */
5755 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5756
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5757
5758
		if ( ! $this->connection_manager ) {
5759
			$this->connection_manager = new Connection_Manager();
5760
		}
5761
5762
		return $this->connection_manager->xmlrpc_methods( $methods );
5763
	}
5764
5765
	/**
5766
	 * Register additional public XMLRPC methods.
5767
	 *
5768
	 * @deprecated since 7.7.0
5769
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5770
	 *
5771
	 * @param array $methods Public XMLRPC methods.
5772
	 * @return array Public XMLRPC methods, with the getOptions one.
5773
	 */
5774 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5775
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5776
5777
		if ( ! $this->connection_manager ) {
5778
			$this->connection_manager = new Connection_Manager();
5779
		}
5780
5781
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5782
	}
5783
5784
	/**
5785
	 * Handles a getOptions XMLRPC method call.
5786
	 *
5787
	 * @deprecated since 7.7.0
5788
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5789
	 *
5790
	 * @param array $args method call arguments.
5791
	 * @return array an amended XMLRPC server options array.
5792
	 */
5793 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5794
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5795
5796
		if ( ! $this->connection_manager ) {
5797
			$this->connection_manager = new Connection_Manager();
5798
		}
5799
5800
		return $this->connection_manager->jetpack_getOptions( $args );
5801
	}
5802
5803
	/**
5804
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5805
	 *
5806
	 * @deprecated since 7.7.0
5807
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5808
	 *
5809
	 * @param array $options Standard Core options.
5810
	 * @return array Amended options.
5811
	 */
5812 View Code Duplication
	public function xmlrpc_options( $options ) {
5813
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5814
5815
		if ( ! $this->connection_manager ) {
5816
			$this->connection_manager = new Connection_Manager();
5817
		}
5818
5819
		return $this->connection_manager->xmlrpc_options( $options );
5820
	}
5821
5822
	/**
5823
	 * Cleans nonces that were saved when calling ::add_nonce.
5824
	 *
5825
	 * @deprecated since 7.7.0
5826
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5827
	 *
5828
	 * @param bool $all whether to clean even non-expired nonces.
5829
	 */
5830
	public static function clean_nonces( $all = false ) {
5831
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5832
		return self::connection()->clean_nonces( $all );
5833
	}
5834
5835
	/**
5836
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5837
	 * SET: state( $key, $value );
5838
	 * GET: $value = state( $key );
5839
	 *
5840
	 * @param string $key
5841
	 * @param string $value
5842
	 * @param bool   $restate private
5843
	 */
5844
	public static function state( $key = null, $value = null, $restate = false ) {
5845
		static $state = array();
5846
		static $path, $domain;
5847
		if ( ! isset( $path ) ) {
5848
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5849
			$admin_url = self::admin_url();
5850
			$bits      = wp_parse_url( $admin_url );
5851
5852
			if ( is_array( $bits ) ) {
5853
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5854
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5855
			} else {
5856
				$path = $domain = null;
5857
			}
5858
		}
5859
5860
		// Extract state from cookies and delete cookies
5861
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5862
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5863
			unset( $_COOKIE['jetpackState'] );
5864
			foreach ( $yum as $k => $v ) {
5865
				if ( strlen( $v ) ) {
5866
					$state[ $k ] = $v;
5867
				}
5868
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5869
			}
5870
		}
5871
5872
		if ( $restate ) {
5873
			foreach ( $state as $k => $v ) {
5874
				if ( 'message_content' !== $k ) {
5875
					setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5876
				}
5877
			}
5878
			return;
5879
		}
5880
5881
		// Get a state variable.
5882
		if ( isset( $key ) && ! isset( $value ) ) {
5883
			if ( array_key_exists( $key, $state ) ) {
5884
				return $state[ $key ];
5885
			}
5886
			return null;
5887
		}
5888
5889
		// Set a state variable.
5890
		if ( isset( $key ) && isset( $value ) ) {
5891
			if ( is_array( $value ) && isset( $value[0] ) ) {
5892
				$value = $value[0];
5893
			}
5894
			$state[ $key ] = $value;
5895
			if ( 'message_content' !== $key && ! headers_sent() ) {
5896
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5897
			}
5898
		}
5899
	}
5900
5901
	public static function restate() {
5902
		self::state( null, null, true );
5903
	}
5904
5905
	public static function check_privacy( $file ) {
5906
		static $is_site_publicly_accessible = null;
5907
5908
		if ( is_null( $is_site_publicly_accessible ) ) {
5909
			$is_site_publicly_accessible = false;
5910
5911
			$rpc = new Jetpack_IXR_Client();
5912
5913
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5914
			if ( $success ) {
5915
				$response = $rpc->getResponse();
5916
				if ( $response ) {
5917
					$is_site_publicly_accessible = true;
5918
				}
5919
			}
5920
5921
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5922
		}
5923
5924
		if ( $is_site_publicly_accessible ) {
5925
			return;
5926
		}
5927
5928
		$module_slug = self::get_module_slug( $file );
5929
5930
		$privacy_checks = self::state( 'privacy_checks' );
5931
		if ( ! $privacy_checks ) {
5932
			$privacy_checks = $module_slug;
5933
		} else {
5934
			$privacy_checks .= ",$module_slug";
5935
		}
5936
5937
		self::state( 'privacy_checks', $privacy_checks );
5938
	}
5939
5940
	/**
5941
	 * Helper method for multicall XMLRPC.
5942
	 *
5943
	 * @param ...$args Args for the async_call.
5944
	 */
5945
	public static function xmlrpc_async_call( ...$args ) {
5946
		global $blog_id;
5947
		static $clients = array();
5948
5949
		$client_blog_id = is_multisite() ? $blog_id : 0;
5950
5951
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5952
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5953
			if ( function_exists( 'ignore_user_abort' ) ) {
5954
				ignore_user_abort( true );
5955
			}
5956
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5957
		}
5958
5959
		if ( ! empty( $args[0] ) ) {
5960
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5961
		} elseif ( is_multisite() ) {
5962
			foreach ( $clients as $client_blog_id => $client ) {
5963
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5964
					continue;
5965
				}
5966
5967
				$switch_success = switch_to_blog( $client_blog_id, true );
5968
				if ( ! $switch_success ) {
5969
					continue;
5970
				}
5971
5972
				flush();
5973
				$client->query();
5974
5975
				restore_current_blog();
5976
			}
5977
		} else {
5978
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5979
				flush();
5980
				$clients[0]->query();
5981
			}
5982
		}
5983
	}
5984
5985
	public static function staticize_subdomain( $url ) {
5986
5987
		// Extract hostname from URL
5988
		$host = wp_parse_url( $url, PHP_URL_HOST );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
5989
5990
		// Explode hostname on '.'
5991
		$exploded_host = explode( '.', $host );
5992
5993
		// Retrieve the name and TLD
5994
		if ( count( $exploded_host ) > 1 ) {
5995
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5996
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5997
			// Rebuild domain excluding subdomains
5998
			$domain = $name . '.' . $tld;
5999
		} else {
6000
			$domain = $host;
6001
		}
6002
		// Array of Automattic domains
6003
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
6004
6005
		// Return $url if not an Automattic domain
6006
		if ( ! in_array( $domain, $domain_whitelist ) ) {
6007
			return $url;
6008
		}
6009
6010
		if ( is_ssl() ) {
6011
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
6012
		}
6013
6014
		srand( crc32( basename( $url ) ) );
6015
		$static_counter = rand( 0, 2 );
6016
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
6017
6018
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
6019
	}
6020
6021
	/* JSON API Authorization */
6022
6023
	/**
6024
	 * Handles the login action for Authorizing the JSON API
6025
	 */
6026
	function login_form_json_api_authorization() {
6027
		$this->verify_json_api_authorization_request();
6028
6029
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
6030
6031
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
6032
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6033
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6034
	}
6035
6036
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6037
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6038
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6039
			return $url;
6040
		}
6041
6042
		$parsed_url = wp_parse_url( $url );
6043
		$url        = strtok( $url, '?' );
6044
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
6045
		if ( ! empty( $parsed_url['query'] ) ) {
6046
			$url .= "&{$parsed_url['query']}";
6047
		}
6048
6049
		return $url;
6050
	}
6051
6052
	// Make sure the POSTed request is handled by the same action
6053
	function preserve_action_in_login_form_for_json_api_authorization() {
6054
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6055
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6056
	}
6057
6058
	// If someone logs in to approve API access, store the Access Code in usermeta
6059
	function store_json_api_authorization_token( $user_login, $user ) {
6060
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6061
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6062
		$token = wp_generate_password( 32, false );
6063
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6064
	}
6065
6066
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6067
	function allow_wpcom_public_api_domain( $domains ) {
6068
		$domains[] = 'public-api.wordpress.com';
6069
		return $domains;
6070
	}
6071
6072
	static function is_redirect_encoded( $redirect_url ) {
6073
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
6074
	}
6075
6076
	// Add all wordpress.com environments to the safe redirect whitelist
6077
	function allow_wpcom_environments( $domains ) {
6078
		$domains[] = 'wordpress.com';
6079
		$domains[] = 'wpcalypso.wordpress.com';
6080
		$domains[] = 'horizon.wordpress.com';
6081
		$domains[] = 'calypso.localhost';
6082
		return $domains;
6083
	}
6084
6085
	// Add the Access Code details to the public-api.wordpress.com redirect
6086
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6087
		return add_query_arg(
6088
			urlencode_deep(
6089
				array(
6090
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6091
					'jetpack-user-id' => (int) $user->ID,
6092
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6093
				)
6094
			),
6095
			$redirect_to
6096
		);
6097
	}
6098
6099
6100
	/**
6101
	 * Verifies the request by checking the signature
6102
	 *
6103
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6104
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6105
	 *
6106
	 * @param null|array $environment
6107
	 */
6108
	function verify_json_api_authorization_request( $environment = null ) {
6109
		$environment = is_null( $environment )
6110
			? $_REQUEST
6111
			: $environment;
6112
6113
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
6114
		$token                                     = Jetpack_Data::get_access_token( $envUserId, $envToken );
6115
		if ( ! $token || empty( $token->secret ) ) {
6116
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6117
		}
6118
6119
		$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' );
6120
6121
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6122
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6123
			/**
6124
			 * Jetpack authorisation request Error.
6125
			 *
6126
			 * @since 7.5.0
6127
			 */
6128
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6129
			$die_error = sprintf(
6130
				/* translators: %s is a URL */
6131
				__( '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' ),
6132
				Redirect::get_url( 'jetpack-support-double-encoding' )
6133
			);
6134
		}
6135
6136
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6137
6138
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6139
			$signature = $jetpack_signature->sign_request(
6140
				$environment['token'],
6141
				$environment['timestamp'],
6142
				$environment['nonce'],
6143
				'',
6144
				'GET',
6145
				$environment['jetpack_json_api_original_query'],
6146
				null,
6147
				true
6148
			);
6149
		} else {
6150
			$signature = $jetpack_signature->sign_current_request(
6151
				array(
6152
					'body'   => null,
6153
					'method' => 'GET',
6154
				)
6155
			);
6156
		}
6157
6158
		if ( ! $signature ) {
6159
			wp_die( $die_error );
6160
		} elseif ( is_wp_error( $signature ) ) {
6161
			wp_die( $die_error );
6162
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6163
			if ( is_ssl() ) {
6164
				// 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
6165
				$signature = $jetpack_signature->sign_current_request(
6166
					array(
6167
						'scheme' => 'http',
6168
						'body'   => null,
6169
						'method' => 'GET',
6170
					)
6171
				);
6172
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6173
					wp_die( $die_error );
6174
				}
6175
			} else {
6176
				wp_die( $die_error );
6177
			}
6178
		}
6179
6180
		$timestamp = (int) $environment['timestamp'];
6181
		$nonce     = stripslashes( (string) $environment['nonce'] );
6182
6183
		if ( ! $this->connection_manager ) {
6184
			$this->connection_manager = new Connection_Manager();
6185
		}
6186
6187
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6188
			// De-nonce the nonce, at least for 5 minutes.
6189
			// 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)
6190
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6191
			if ( $old_nonce_time < time() - 300 ) {
6192
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6193
			}
6194
		}
6195
6196
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6197
		$data_filters = array(
6198
			'state'        => 'opaque',
6199
			'client_id'    => 'int',
6200
			'client_title' => 'string',
6201
			'client_image' => 'url',
6202
		);
6203
6204
		foreach ( $data_filters as $key => $sanitation ) {
6205
			if ( ! isset( $data->$key ) ) {
6206
				wp_die( $die_error );
6207
			}
6208
6209
			switch ( $sanitation ) {
6210
				case 'int':
6211
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6212
					break;
6213
				case 'opaque':
6214
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6215
					break;
6216
				case 'string':
6217
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6218
					break;
6219
				case 'url':
6220
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6221
					break;
6222
			}
6223
		}
6224
6225
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6226
			wp_die( $die_error );
6227
		}
6228
	}
6229
6230
	function login_message_json_api_authorization( $message ) {
6231
		return '<p class="message">' . sprintf(
6232
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6233
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6234
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6235
	}
6236
6237
	/**
6238
	 * Get $content_width, but with a <s>twist</s> filter.
6239
	 */
6240
	public static function get_content_width() {
6241
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6242
			? $GLOBALS['content_width']
6243
			: false;
6244
		/**
6245
		 * Filter the Content Width value.
6246
		 *
6247
		 * @since 2.2.3
6248
		 *
6249
		 * @param string $content_width Content Width value.
6250
		 */
6251
		return apply_filters( 'jetpack_content_width', $content_width );
6252
	}
6253
6254
	/**
6255
	 * Pings the WordPress.com Mirror Site for the specified options.
6256
	 *
6257
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6258
	 *
6259
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6260
	 */
6261
	public function get_cloud_site_options( $option_names ) {
6262
		$option_names = array_filter( (array) $option_names, 'is_string' );
6263
6264
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6265
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6266
		if ( $xml->isError() ) {
6267
			return array(
6268
				'error_code' => $xml->getErrorCode(),
6269
				'error_msg'  => $xml->getErrorMessage(),
6270
			);
6271
		}
6272
		$cloud_site_options = $xml->getResponse();
6273
6274
		return $cloud_site_options;
6275
	}
6276
6277
	/**
6278
	 * Checks if the site is currently in an identity crisis.
6279
	 *
6280
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6281
	 */
6282
	public static function check_identity_crisis() {
6283
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6284
			return false;
6285
		}
6286
6287
		return Jetpack_Options::get_option( 'sync_error_idc' );
6288
	}
6289
6290
	/**
6291
	 * Checks whether the home and siteurl specifically are whitelisted
6292
	 * Written so that we don't have re-check $key and $value params every time
6293
	 * we want to check if this site is whitelisted, for example in footer.php
6294
	 *
6295
	 * @since  3.8.0
6296
	 * @return bool True = already whitelisted False = not whitelisted
6297
	 */
6298
	public static function is_staging_site() {
6299
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6300
		return ( new Status() )->is_staging_site();
6301
	}
6302
6303
	/**
6304
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6305
	 *
6306
	 * @since 4.4.0
6307
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6308
	 *
6309
	 * @return bool
6310
	 */
6311
	public static function validate_sync_error_idc_option() {
6312
		$is_valid = false;
6313
6314
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6315
		if ( false === $idc_allowed ) {
6316
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6317
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6318
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6319
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6320
				$transient_duration = HOUR_IN_SECONDS;
6321
			} else {
6322
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6323
				$idc_allowed        = '1';
6324
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6325
			}
6326
6327
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6328
		}
6329
6330
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6331
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6332
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6333
			$local_options = self::get_sync_error_idc_option();
6334
			// Ensure all values are set.
6335
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6336
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6337
					$is_valid = true;
6338
				}
6339
			}
6340
		}
6341
6342
		/**
6343
		 * Filters whether the sync_error_idc option is valid.
6344
		 *
6345
		 * @since 4.4.0
6346
		 *
6347
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6348
		 */
6349
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6350
6351
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6352
			// Since the option exists, and did not validate, delete it
6353
			Jetpack_Options::delete_option( 'sync_error_idc' );
6354
		}
6355
6356
		return $is_valid;
6357
	}
6358
6359
	/**
6360
	 * Normalizes a url by doing three things:
6361
	 *  - Strips protocol
6362
	 *  - Strips www
6363
	 *  - Adds a trailing slash
6364
	 *
6365
	 * @since 4.4.0
6366
	 * @param string $url
6367
	 * @return WP_Error|string
6368
	 */
6369
	public static function normalize_url_protocol_agnostic( $url ) {
6370
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6371
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6372
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
6373
		}
6374
6375
		// Strip www and protocols
6376
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6377
		return $url;
6378
	}
6379
6380
	/**
6381
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6382
	 *
6383
	 * @since 4.4.0
6384
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6385
	 *
6386
	 * @param array $response
6387
	 * @return array Array of the local urls, wpcom urls, and error code
6388
	 */
6389
	public static function get_sync_error_idc_option( $response = array() ) {
6390
		// Since the local options will hit the database directly, store the values
6391
		// in a transient to allow for autoloading and caching on subsequent views.
6392
		$local_options = get_transient( 'jetpack_idc_local' );
6393
		if ( false === $local_options ) {
6394
			$local_options = array(
6395
				'home'    => Functions::home_url(),
6396
				'siteurl' => Functions::site_url(),
6397
			);
6398
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6399
		}
6400
6401
		$options = array_merge( $local_options, $response );
6402
6403
		$returned_values = array();
6404
		foreach ( $options as $key => $option ) {
6405
			if ( 'error_code' === $key ) {
6406
				$returned_values[ $key ] = $option;
6407
				continue;
6408
			}
6409
6410
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6411
				continue;
6412
			}
6413
6414
			$returned_values[ $key ] = $normalized_url;
6415
		}
6416
6417
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6418
6419
		return $returned_values;
6420
	}
6421
6422
	/**
6423
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6424
	 * If set to true, the site will be put into staging mode.
6425
	 *
6426
	 * @since 4.3.2
6427
	 * @return bool
6428
	 */
6429
	public static function sync_idc_optin() {
6430
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6431
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6432
		} else {
6433
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6434
		}
6435
6436
		/**
6437
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6438
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6439
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6440
		 *
6441
		 * @since 4.3.2
6442
		 *
6443
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6444
		 */
6445
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6446
	}
6447
6448
	/**
6449
	 * Maybe Use a .min.css stylesheet, maybe not.
6450
	 *
6451
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6452
	 */
6453
	public static function maybe_min_asset( $url, $path, $plugin ) {
6454
		// Short out on things trying to find actual paths.
6455
		if ( ! $path || empty( $plugin ) ) {
6456
			return $url;
6457
		}
6458
6459
		$path = ltrim( $path, '/' );
6460
6461
		// Strip out the abspath.
6462
		$base = dirname( plugin_basename( $plugin ) );
6463
6464
		// Short out on non-Jetpack assets.
6465
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6466
			return $url;
6467
		}
6468
6469
		// File name parsing.
6470
		$file              = "{$base}/{$path}";
6471
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6472
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6473
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6474
		$extension         = array_shift( $file_name_parts_r );
6475
6476
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6477
			// Already pointing at the minified version.
6478
			if ( 'min' === $file_name_parts_r[0] ) {
6479
				return $url;
6480
			}
6481
6482
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6483
			if ( file_exists( $min_full_path ) ) {
6484
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6485
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6486
				if ( 'css' === $extension ) {
6487
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6488
					self::$min_assets[ $key ] = $path;
6489
				}
6490
			}
6491
		}
6492
6493
		return $url;
6494
	}
6495
6496
	/**
6497
	 * If the asset is minified, let's flag .min as the suffix.
6498
	 *
6499
	 * Attached to `style_loader_src` filter.
6500
	 *
6501
	 * @param string $tag The tag that would link to the external asset.
6502
	 * @param string $handle The registered handle of the script in question.
6503
	 * @param string $href The url of the asset in question.
6504
	 */
6505
	public static function set_suffix_on_min( $src, $handle ) {
6506
		if ( false === strpos( $src, '.min.css' ) ) {
6507
			return $src;
6508
		}
6509
6510
		if ( ! empty( self::$min_assets ) ) {
6511
			foreach ( self::$min_assets as $file => $path ) {
6512
				if ( false !== strpos( $src, $file ) ) {
6513
					wp_style_add_data( $handle, 'suffix', '.min' );
6514
					return $src;
6515
				}
6516
			}
6517
		}
6518
6519
		return $src;
6520
	}
6521
6522
	/**
6523
	 * Maybe inlines a stylesheet.
6524
	 *
6525
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6526
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6527
	 *
6528
	 * Attached to `style_loader_tag` filter.
6529
	 *
6530
	 * @param string $tag The tag that would link to the external asset.
6531
	 * @param string $handle The registered handle of the script in question.
6532
	 *
6533
	 * @return string
6534
	 */
6535
	public static function maybe_inline_style( $tag, $handle ) {
6536
		global $wp_styles;
6537
		$item = $wp_styles->registered[ $handle ];
6538
6539
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6540
			return $tag;
6541
		}
6542
6543
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6544
			$href = $matches[1];
6545
			// Strip off query string
6546
			if ( $pos = strpos( $href, '?' ) ) {
6547
				$href = substr( $href, 0, $pos );
6548
			}
6549
			// Strip off fragment
6550
			if ( $pos = strpos( $href, '#' ) ) {
6551
				$href = substr( $href, 0, $pos );
6552
			}
6553
		} else {
6554
			return $tag;
6555
		}
6556
6557
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6558
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6559
			return $tag;
6560
		}
6561
6562
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6563
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6564
			// And this isn't the pass that actually deals with the RTL version...
6565
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6566
				// Short out, as the RTL version will deal with it in a moment.
6567
				return $tag;
6568
			}
6569
		}
6570
6571
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6572
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6573
		if ( $css ) {
6574
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6575
			if ( empty( $item->extra['after'] ) ) {
6576
				wp_add_inline_style( $handle, $css );
6577
			} else {
6578
				array_unshift( $item->extra['after'], $css );
6579
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6580
			}
6581
		}
6582
6583
		return $tag;
6584
	}
6585
6586
	/**
6587
	 * Loads a view file from the views
6588
	 *
6589
	 * Data passed in with the $data parameter will be available in the
6590
	 * template file as $data['value']
6591
	 *
6592
	 * @param string $template - Template file to load
6593
	 * @param array  $data - Any data to pass along to the template
6594
	 * @return boolean - If template file was found
6595
	 **/
6596
	public function load_view( $template, $data = array() ) {
6597
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6598
6599
		if ( file_exists( $views_dir . $template ) ) {
6600
			require_once $views_dir . $template;
6601
			return true;
6602
		}
6603
6604
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6605
		return false;
6606
	}
6607
6608
	/**
6609
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6610
	 */
6611
	public function deprecated_hooks() {
6612
		global $wp_filter;
6613
6614
		/*
6615
		 * Format:
6616
		 * deprecated_filter_name => replacement_name
6617
		 *
6618
		 * If there is no replacement, use null for replacement_name
6619
		 */
6620
		$deprecated_list = array(
6621
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6622
			'wpl_sharing_2014_1'                           => null,
6623
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6624
			'jetpack_identity_crisis_options_to_check'     => null,
6625
			'update_option_jetpack_single_user_site'       => null,
6626
			'audio_player_default_colors'                  => null,
6627
			'add_option_jetpack_featured_images_enabled'   => null,
6628
			'add_option_jetpack_update_details'            => null,
6629
			'add_option_jetpack_updates'                   => null,
6630
			'add_option_jetpack_network_name'              => null,
6631
			'add_option_jetpack_network_allow_new_registrations' => null,
6632
			'add_option_jetpack_network_add_new_users'     => null,
6633
			'add_option_jetpack_network_site_upload_space' => null,
6634
			'add_option_jetpack_network_upload_file_types' => null,
6635
			'add_option_jetpack_network_enable_administration_menus' => null,
6636
			'add_option_jetpack_is_multi_site'             => null,
6637
			'add_option_jetpack_is_main_network'           => null,
6638
			'add_option_jetpack_main_network_site'         => null,
6639
			'jetpack_sync_all_registered_options'          => null,
6640
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6641
			'jetpack_is_post_mailable'                     => null,
6642
			'jetpack_seo_site_host'                        => null,
6643
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6644
			'jetpack_holiday_snow_option_name'             => null,
6645
			'jetpack_holiday_chance_of_snow'               => null,
6646
			'jetpack_holiday_snow_js_url'                  => null,
6647
			'jetpack_is_holiday_snow_season'               => null,
6648
			'jetpack_holiday_snow_option_updated'          => null,
6649
			'jetpack_holiday_snowing'                      => null,
6650
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6651
			'jetpack_cache_plans'                          => null,
6652
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6653
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6654
			'jetpack_enable_site_verification'             => null,
6655
			'can_display_jetpack_manage_notice'            => null,
6656
			// Removed in Jetpack 7.3.0
6657
			'atd_load_scripts'                             => null,
6658
			'atd_http_post_timeout'                        => null,
6659
			'atd_http_post_error'                          => null,
6660
			'atd_service_domain'                           => null,
6661
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6662
			// Removed in Jetpack 7.9.0
6663
			'jetpack_pwa_manifest'                         => null,
6664
			'jetpack_pwa_background_color'                 => null,
6665
			// Removed in Jetpack 8.3.0.
6666
			'jetpack_check_mobile'                         => null,
6667
			'jetpack_mobile_stylesheet'                    => null,
6668
			'jetpack_mobile_template'                      => null,
6669
			'mobile_reject_mobile'                         => null,
6670
			'mobile_force_mobile'                          => null,
6671
			'mobile_app_promo_download'                    => null,
6672
			'mobile_setup'                                 => null,
6673
			'jetpack_mobile_footer_before'                 => null,
6674
			'wp_mobile_theme_footer'                       => null,
6675
			'minileven_credits'                            => null,
6676
			'jetpack_mobile_header_before'                 => null,
6677
			'jetpack_mobile_header_after'                  => null,
6678
			'jetpack_mobile_theme_menu'                    => null,
6679
			'minileven_show_featured_images'               => null,
6680
			'minileven_attachment_size'                    => null,
6681
		);
6682
6683
		// This is a silly loop depth. Better way?
6684
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6685
			if ( has_action( $hook ) ) {
6686
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6687
					foreach ( $values as $hooked ) {
6688
						if ( is_callable( $hooked['function'] ) ) {
6689
							$function_name = $hooked['function'];
6690
						} else {
6691
							$function_name = 'an anonymous function';
6692
						}
6693
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6694
					}
6695
				}
6696
			}
6697
		}
6698
	}
6699
6700
	/**
6701
	 * Converts any url in a stylesheet, to the correct absolute url.
6702
	 *
6703
	 * Considerations:
6704
	 *  - Normal, relative URLs     `feh.png`
6705
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6706
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6707
	 *  - Absolute URLs             `http://domain.com/feh.png`
6708
	 *  - Domain root relative URLs `/feh.png`
6709
	 *
6710
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6711
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6712
	 *
6713
	 * @return mixed|string
6714
	 */
6715
	public static function absolutize_css_urls( $css, $css_file_url ) {
6716
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6717
		$css_dir = dirname( $css_file_url );
6718
		$p       = wp_parse_url( $css_dir );
6719
		$domain  = sprintf(
6720
			'%1$s//%2$s%3$s%4$s',
6721
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6722
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6723
			$p['host'],
6724
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6725
		);
6726
6727
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6728
			$find = $replace = array();
6729
			foreach ( $matches as $match ) {
6730
				$url = trim( $match['path'], "'\" \t" );
6731
6732
				// If this is a data url, we don't want to mess with it.
6733
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6734
					continue;
6735
				}
6736
6737
				// If this is an absolute or protocol-agnostic url,
6738
				// we don't want to mess with it.
6739
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6740
					continue;
6741
				}
6742
6743
				switch ( substr( $url, 0, 1 ) ) {
6744
					case '/':
6745
						$absolute = $domain . $url;
6746
						break;
6747
					default:
6748
						$absolute = $css_dir . '/' . $url;
6749
				}
6750
6751
				$find[]    = $match[0];
6752
				$replace[] = sprintf( 'url("%s")', $absolute );
6753
			}
6754
			$css = str_replace( $find, $replace, $css );
6755
		}
6756
6757
		return $css;
6758
	}
6759
6760
	/**
6761
	 * This methods removes all of the registered css files on the front end
6762
	 * from Jetpack in favor of using a single file. In effect "imploding"
6763
	 * all the files into one file.
6764
	 *
6765
	 * Pros:
6766
	 * - Uses only ONE css asset connection instead of 15
6767
	 * - Saves a minimum of 56k
6768
	 * - Reduces server load
6769
	 * - Reduces time to first painted byte
6770
	 *
6771
	 * Cons:
6772
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6773
	 *      should not cause any issues with themes.
6774
	 * - Plugins/themes dequeuing styles no longer do anything. See
6775
	 *      jetpack_implode_frontend_css filter for a workaround
6776
	 *
6777
	 * For some situations developers may wish to disable css imploding and
6778
	 * instead operate in legacy mode where each file loads seperately and
6779
	 * can be edited individually or dequeued. This can be accomplished with
6780
	 * the following line:
6781
	 *
6782
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6783
	 *
6784
	 * @since 3.2
6785
	 **/
6786
	public function implode_frontend_css( $travis_test = false ) {
6787
		$do_implode = true;
6788
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6789
			$do_implode = false;
6790
		}
6791
6792
		// Do not implode CSS when the page loads via the AMP plugin.
6793
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6794
			$do_implode = false;
6795
		}
6796
6797
		/**
6798
		 * Allow CSS to be concatenated into a single jetpack.css file.
6799
		 *
6800
		 * @since 3.2.0
6801
		 *
6802
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6803
		 */
6804
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6805
6806
		// Do not use the imploded file when default behavior was altered through the filter
6807
		if ( ! $do_implode ) {
6808
			return;
6809
		}
6810
6811
		// We do not want to use the imploded file in dev mode, or if not connected
6812
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6813
			if ( ! $travis_test ) {
6814
				return;
6815
			}
6816
		}
6817
6818
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6819
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6820
			return;
6821
		}
6822
6823
		/*
6824
		 * Now we assume Jetpack is connected and able to serve the single
6825
		 * file.
6826
		 *
6827
		 * In the future there will be a check here to serve the file locally
6828
		 * or potentially from the Jetpack CDN
6829
		 *
6830
		 * For now:
6831
		 * - Enqueue a single imploded css file
6832
		 * - Zero out the style_loader_tag for the bundled ones
6833
		 * - Be happy, drink scotch
6834
		 */
6835
6836
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6837
6838
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6839
6840
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6841
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6842
	}
6843
6844
	function concat_remove_style_loader_tag( $tag, $handle ) {
6845
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6846
			$tag = '';
6847
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6848
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6849
			}
6850
		}
6851
6852
		return $tag;
6853
	}
6854
6855
	/**
6856
	 * Add an async attribute to scripts that can be loaded asynchronously.
6857
	 * https://www.w3schools.com/tags/att_script_async.asp
6858
	 *
6859
	 * @since 7.7.0
6860
	 *
6861
	 * @param string $tag    The <script> tag for the enqueued script.
6862
	 * @param string $handle The script's registered handle.
6863
	 * @param string $src    The script's source URL.
6864
	 */
6865
	public function script_add_async( $tag, $handle, $src ) {
6866
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6867
			return preg_replace( '/^<script /i', '<script async ', $tag );
6868
		}
6869
6870
		return $tag;
6871
	}
6872
6873
	/*
6874
	 * Check the heartbeat data
6875
	 *
6876
	 * Organizes the heartbeat data by severity.  For example, if the site
6877
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6878
	 *
6879
	 * Data will be added to "caution" array, if it either:
6880
	 *  - Out of date Jetpack version
6881
	 *  - Out of date WP version
6882
	 *  - Out of date PHP version
6883
	 *
6884
	 * $return array $filtered_data
6885
	 */
6886
	public static function jetpack_check_heartbeat_data() {
6887
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6888
6889
		$good    = array();
6890
		$caution = array();
6891
		$bad     = array();
6892
6893
		foreach ( $raw_data as $stat => $value ) {
6894
6895
			// Check jetpack version
6896
			if ( 'version' == $stat ) {
6897
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6898
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6899
					continue;
6900
				}
6901
			}
6902
6903
			// Check WP version
6904
			if ( 'wp-version' == $stat ) {
6905
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6906
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6907
					continue;
6908
				}
6909
			}
6910
6911
			// Check PHP version
6912
			if ( 'php-version' == $stat ) {
6913
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6914
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6915
					continue;
6916
				}
6917
			}
6918
6919
			// Check ID crisis
6920
			if ( 'identitycrisis' == $stat ) {
6921
				if ( 'yes' == $value ) {
6922
					$bad[ $stat ] = $value;
6923
					continue;
6924
				}
6925
			}
6926
6927
			// The rest are good :)
6928
			$good[ $stat ] = $value;
6929
		}
6930
6931
		$filtered_data = array(
6932
			'good'    => $good,
6933
			'caution' => $caution,
6934
			'bad'     => $bad,
6935
		);
6936
6937
		return $filtered_data;
6938
	}
6939
6940
6941
	/*
6942
	 * This method is used to organize all options that can be reset
6943
	 * without disconnecting Jetpack.
6944
	 *
6945
	 * It is used in class.jetpack-cli.php to reset options
6946
	 *
6947
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6948
	 *
6949
	 * @return array of options to delete.
6950
	 */
6951
	public static function get_jetpack_options_for_reset() {
6952
		return Jetpack_Options::get_options_for_reset();
6953
	}
6954
6955
	/*
6956
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6957
	 * so we can bring them directly to their site in calypso.
6958
	 *
6959
	 * @param string | url
6960
	 * @return string | url without the guff
6961
	 */
6962 View Code Duplication
	public static function build_raw_urls( $url ) {
6963
		$strip_http = '/.*?:\/\//i';
6964
		$url        = preg_replace( $strip_http, '', $url );
6965
		$url        = str_replace( '/', '::', $url );
6966
		return $url;
6967
	}
6968
6969
	/**
6970
	 * Stores and prints out domains to prefetch for page speed optimization.
6971
	 *
6972
	 * @param mixed $new_urls
6973
	 */
6974
	public static function dns_prefetch( $new_urls = null ) {
6975
		static $prefetch_urls = array();
6976
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6977
			echo "\r\n";
6978
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6979
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6980
			}
6981
		} elseif ( ! empty( $new_urls ) ) {
6982
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6983
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6984
			}
6985
			foreach ( (array) $new_urls as $this_new_url ) {
6986
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6987
			}
6988
			$prefetch_urls = array_unique( $prefetch_urls );
6989
		}
6990
	}
6991
6992
	public function wp_dashboard_setup() {
6993
		if ( self::is_active() ) {
6994
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6995
		}
6996
6997
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6998
			$jetpack_logo = new Jetpack_Logo();
6999
			$widget_title = sprintf(
7000
				wp_kses(
7001
					/* translators: Placeholder is a Jetpack logo. */
7002
					__( 'Stats <span>by %s</span>', 'jetpack' ),
7003
					array( 'span' => array() )
7004
				),
7005
				$jetpack_logo->get_jp_emblem( true )
7006
			);
7007
7008
			wp_add_dashboard_widget(
7009
				'jetpack_summary_widget',
7010
				$widget_title,
7011
				array( __CLASS__, 'dashboard_widget' )
7012
			);
7013
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
7014
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
7015
7016
			// If we're inactive and not in development mode, sort our box to the top.
7017
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
7018
				global $wp_meta_boxes;
7019
7020
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
7021
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
7022
7023
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7024
			}
7025
		}
7026
	}
7027
7028
	/**
7029
	 * @param mixed $result Value for the user's option
7030
	 * @return mixed
7031
	 */
7032
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7033
		if ( ! is_array( $sorted ) ) {
7034
			return $sorted;
7035
		}
7036
7037
		foreach ( $sorted as $box_context => $ids ) {
7038
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7039
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7040
				continue;
7041
			}
7042
7043
			$ids_array = explode( ',', $ids );
7044
			$key       = array_search( 'dashboard_stats', $ids_array );
7045
7046
			if ( false !== $key ) {
7047
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7048
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7049
				$sorted[ $box_context ] = implode( ',', $ids_array );
7050
				// We've found it, stop searching, and just return.
7051
				break;
7052
			}
7053
		}
7054
7055
		return $sorted;
7056
	}
7057
7058
	public static function dashboard_widget() {
7059
		/**
7060
		 * Fires when the dashboard is loaded.
7061
		 *
7062
		 * @since 3.4.0
7063
		 */
7064
		do_action( 'jetpack_dashboard_widget' );
7065
	}
7066
7067
	public static function dashboard_widget_footer() {
7068
		?>
7069
		<footer>
7070
7071
		<div class="protect">
7072
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7073
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7074
				<p class="blocked-count">
7075
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7076
				</p>
7077
				<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>
7078
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
7079
				<a href="
7080
				<?php
7081
				echo esc_url(
7082
					wp_nonce_url(
7083
						self::admin_url(
7084
							array(
7085
								'action' => 'activate',
7086
								'module' => 'protect',
7087
							)
7088
						),
7089
						'jetpack_activate-protect'
7090
					)
7091
				);
7092
				?>
7093
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7094
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7095
				</a>
7096
			<?php else : ?>
7097
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7098
			<?php endif; ?>
7099
		</div>
7100
7101
		<div class="akismet">
7102
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7103
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7104
				<p class="blocked-count">
7105
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7106
				</p>
7107
				<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>
7108
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7109
				<a href="
7110
				<?php
7111
				echo esc_url(
7112
					wp_nonce_url(
7113
						add_query_arg(
7114
							array(
7115
								'action' => 'activate',
7116
								'plugin' => 'akismet/akismet.php',
7117
							),
7118
							admin_url( 'plugins.php' )
7119
						),
7120
						'activate-plugin_akismet/akismet.php'
7121
					)
7122
				);
7123
				?>
7124
							" class="button button-jetpack">
7125
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7126
				</a>
7127
			<?php else : ?>
7128
				<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>
7129
			<?php endif; ?>
7130
		</div>
7131
7132
		</footer>
7133
		<?php
7134
	}
7135
7136
	/*
7137
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7138
	 */
7139
	function jetpack_icon_user_connected( $columns ) {
7140
		$columns['user_jetpack'] = '';
7141
		return $columns;
7142
	}
7143
7144
	/*
7145
	 * Show Jetpack icon if the user is linked.
7146
	 */
7147
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7148
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7149
			$jetpack_logo = new Jetpack_Logo();
7150
			$emblem_html  = sprintf(
7151
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7152
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7153
				$jetpack_logo->get_jp_emblem()
7154
			);
7155
			return $emblem_html;
7156
		}
7157
7158
		return $val;
7159
	}
7160
7161
	/*
7162
	 * Style the Jetpack user column
7163
	 */
7164
	function jetpack_user_col_style() {
7165
		global $current_screen;
7166
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7167
			?>
7168
			<style>
7169
				.fixed .column-user_jetpack {
7170
					width: 21px;
7171
				}
7172
				.jp-emblem-user-admin svg {
7173
					width: 20px;
7174
					height: 20px;
7175
				}
7176
				.jp-emblem-user-admin path {
7177
					fill: #00BE28;
7178
				}
7179
			</style>
7180
			<?php
7181
		}
7182
	}
7183
7184
	/**
7185
	 * Checks if Akismet is active and working.
7186
	 *
7187
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7188
	 * that implied usage of methods present since more recent version.
7189
	 * See https://github.com/Automattic/jetpack/pull/9585
7190
	 *
7191
	 * @since  5.1.0
7192
	 *
7193
	 * @return bool True = Akismet available. False = Aksimet not available.
7194
	 */
7195
	public static function is_akismet_active() {
7196
		static $status = null;
7197
7198
		if ( ! is_null( $status ) ) {
7199
			return $status;
7200
		}
7201
7202
		// Check if a modern version of Akismet is active.
7203
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7204
			$status = false;
7205
			return $status;
7206
		}
7207
7208
		// Make sure there is a key known to Akismet at all before verifying key.
7209
		$akismet_key = Akismet::get_api_key();
7210
		if ( ! $akismet_key ) {
7211
			$status = false;
7212
			return $status;
7213
		}
7214
7215
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7216
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7217
7218
		// 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.
7219
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7220
		// We cache the result of the Akismet key verification for ten minutes.
7221
		if ( ! $akismet_key_state || $recheck ) {
7222
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7223
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7224
		}
7225
7226
		$status = 'valid' === $akismet_key_state;
7227
7228
		return $status;
7229
	}
7230
7231
	/**
7232
	 * @deprecated
7233
	 *
7234
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7235
	 */
7236
	public static function is_function_in_backtrace() {
7237
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7238
	}
7239
7240
	/**
7241
	 * Given a minified path, and a non-minified path, will return
7242
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7243
	 *
7244
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7245
	 * root Jetpack directory.
7246
	 *
7247
	 * @since 5.6.0
7248
	 *
7249
	 * @param string $min_path
7250
	 * @param string $non_min_path
7251
	 * @return string The URL to the file
7252
	 */
7253
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7254
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7255
	}
7256
7257
	/**
7258
	 * Checks for whether Jetpack Backup & Scan is enabled.
7259
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7260
	 *
7261
	 * @return bool|int|mixed
7262
	 */
7263
	public static function is_rewind_enabled() {
7264
		if ( ! self::is_active() ) {
7265
			return false;
7266
		}
7267
7268
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7269
		if ( false === $rewind_enabled ) {
7270
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7271
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7272
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7273
				&& ! empty( $rewind_data['state'] )
7274
				&& 'active' === $rewind_data['state'] )
7275
				? 1
7276
				: 0;
7277
7278
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7279
		}
7280
		return $rewind_enabled;
7281
	}
7282
7283
	/**
7284
	 * Return Calypso environment value; used for developing Jetpack and pairing
7285
	 * it with different Calypso enrionments, such as localhost.
7286
	 *
7287
	 * @since 7.4.0
7288
	 *
7289
	 * @return string Calypso environment
7290
	 */
7291
	public static function get_calypso_env() {
7292
		if ( isset( $_GET['calypso_env'] ) ) {
7293
			return sanitize_key( $_GET['calypso_env'] );
7294
		}
7295
7296
		if ( getenv( 'CALYPSO_ENV' ) ) {
7297
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7298
		}
7299
7300
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7301
			return sanitize_key( CALYPSO_ENV );
7302
		}
7303
7304
		return '';
7305
	}
7306
7307
	/**
7308
	 * Returns the hostname with protocol for Calypso.
7309
	 * Used for developing Jetpack with Calypso.
7310
	 *
7311
	 * @since 8.4.0
7312
	 *
7313
	 * @return string Calypso host.
7314
	 */
7315
	public static function get_calypso_host() {
7316
		$calypso_env = self::get_calypso_env();
7317
		switch ( $calypso_env ) {
7318
			case 'development':
7319
				return 'http://calypso.localhost:3000/';
7320
			case 'wpcalypso':
7321
				return 'https://wpcalypso.wordpress.com/';
7322
			case 'horizon':
7323
				return 'https://horizon.wordpress.com/';
7324
			default:
7325
				return 'https://wordpress.com/';
7326
		}
7327
	}
7328
7329
	/**
7330
	 * Checks whether or not TOS has been agreed upon.
7331
	 * Will return true if a user has clicked to register, or is already connected.
7332
	 */
7333
	public static function jetpack_tos_agreed() {
7334
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7335
7336
		$terms_of_service = new Terms_Of_Service();
7337
		return $terms_of_service->has_agreed();
7338
7339
	}
7340
7341
	/**
7342
	 * Handles activating default modules as well general cleanup for the new connection.
7343
	 *
7344
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7345
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7346
	 * @param boolean $send_state_messages          Whether to send state messages.
7347
	 * @return void
7348
	 */
7349
	public static function handle_post_authorization_actions(
7350
		$activate_sso = false,
7351
		$redirect_on_activation_error = false,
7352
		$send_state_messages = true
7353
	) {
7354
		$other_modules = $activate_sso
7355
			? array( 'sso' )
7356
			: array();
7357
7358
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7359
			self::delete_active_modules();
7360
7361
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
7362
		} else {
7363
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7364
		}
7365
7366
		// Since this is a fresh connection, be sure to clear out IDC options
7367
		Jetpack_IDC::clear_all_idc_options();
7368
7369
		if ( $send_state_messages ) {
7370
			self::state( 'message', 'authorized' );
7371
		}
7372
	}
7373
7374
	/**
7375
	 * Returns a boolean for whether backups UI should be displayed or not.
7376
	 *
7377
	 * @return bool Should backups UI be displayed?
7378
	 */
7379
	public static function show_backups_ui() {
7380
		/**
7381
		 * Whether UI for backups should be displayed.
7382
		 *
7383
		 * @since 6.5.0
7384
		 *
7385
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7386
		 */
7387
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7388
	}
7389
7390
	/*
7391
	 * Deprecated manage functions
7392
	 */
7393
	function prepare_manage_jetpack_notice() {
7394
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7395
	}
7396
	function manage_activate_screen() {
7397
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7398
	}
7399
	function admin_jetpack_manage_notice() {
7400
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7401
	}
7402
	function opt_out_jetpack_manage_url() {
7403
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7404
	}
7405
	function opt_in_jetpack_manage_url() {
7406
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7407
	}
7408
	function opt_in_jetpack_manage_notice() {
7409
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7410
	}
7411
	function can_display_jetpack_manage_notice() {
7412
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7413
	}
7414
7415
	/**
7416
	 * Clean leftoveruser meta.
7417
	 *
7418
	 * Delete Jetpack-related user meta when it is no longer needed.
7419
	 *
7420
	 * @since 7.3.0
7421
	 *
7422
	 * @param int $user_id User ID being updated.
7423
	 */
7424
	public static function user_meta_cleanup( $user_id ) {
7425
		$meta_keys = array(
7426
			// AtD removed from Jetpack 7.3
7427
			'AtD_options',
7428
			'AtD_check_when',
7429
			'AtD_guess_lang',
7430
			'AtD_ignored_phrases',
7431
		);
7432
7433
		foreach ( $meta_keys as $meta_key ) {
7434
			if ( get_user_meta( $user_id, $meta_key ) ) {
7435
				delete_user_meta( $user_id, $meta_key );
7436
			}
7437
		}
7438
	}
7439
7440
	/**
7441
	 * Checks if a Jetpack site is both active and not in development.
7442
	 *
7443
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7444
	 *
7445
	 * @return bool True if Jetpack is active and not in development.
7446
	 */
7447
	public static function is_active_and_not_development_mode() {
7448
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7449
			return false;
7450
		}
7451
		return true;
7452
	}
7453
7454
	/**
7455
	 * Returns the list of products that we have available for purchase.
7456
	 */
7457
	public static function get_products_for_purchase() {
7458
		$products = array();
7459
		if ( ! is_multisite() ) {
7460
			$products[] = array(
7461
				'key'               => 'backup',
7462
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7463
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7464
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7465
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7466
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7467
				'options'           => array(
7468
					array(
7469
						'type'        => 'daily',
7470
						'slug'        => 'jetpack-backup-daily',
7471
						'key'         => 'jetpack_backup_daily',
7472
						'name'        => __( 'Daily Backups', 'jetpack' ),
7473
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7474
					),
7475
					array(
7476
						'type'        => 'realtime',
7477
						'slug'        => 'jetpack-backup-realtime',
7478
						'key'         => 'jetpack_backup_realtime',
7479
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7480
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7481
					),
7482
				),
7483
				'default_option'    => 'realtime',
7484
				'show_promotion'    => true,
7485
				'discount_percent'  => 70,
7486
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7487
			);
7488
7489
			$products[] = array(
7490
				'key'               => 'scan',
7491
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7492
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7493
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7494
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7495
				'show_promotion'    => true,
7496
				'discount_percent'  => 30,
7497
				'options'           => array(
7498
					array(
7499
						'type'      => 'scan',
7500
						'slug'      => 'jetpack-scan',
7501
						'key'       => 'jetpack_scan',
7502
						'name'      => __( 'Scan', 'jetpack' ),
7503
					),
7504
				),
7505
				'default_option'    => 'scan',
7506
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7507
			);
7508
		}
7509
7510
		$products[] = array(
7511
			'key'               => 'search',
7512
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7513
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7514
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7515
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7516
			'label_popup'  		=> __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.' ),
7517
			'options'           => array(
7518
				array(
7519
					'type'      => 'search',
7520
					'slug'      => 'jetpack-search',
7521
					'key'       => 'jetpack_search',
7522
					'name'      => __( 'Search', 'jetpack' ),
7523
				),
7524
			),
7525
			'tears'             => array(),
7526
			'default_option'    => 'search',
7527
			'show_promotion'    => false,
7528
			'included_in_plans' => array( 'search-plan' ),
7529
		);
7530
7531
		return $products;
7532
	}
7533
}
7534