Completed
Push — add/deactivate-modal ( ac5bfa...958346 )
by
unknown
84:03 queued 76:54
created

class.jetpack.php (76 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\Connection\Plugin_Storage as Connection_Plugin_Storage;
9
use Automattic\Jetpack\Constants;
10
use Automattic\Jetpack\Partner;
11
use Automattic\Jetpack\Roles;
12
use Automattic\Jetpack\Status;
13
use Automattic\Jetpack\Sync\Functions;
14
use Automattic\Jetpack\Sync\Health;
15
use Automattic\Jetpack\Sync\Sender;
16
use Automattic\Jetpack\Sync\Users;
17
use Automattic\Jetpack\Terms_Of_Service;
18
use Automattic\Jetpack\Tracking;
19
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
20
use Automattic\Jetpack\Redirect;
21
22
/*
23
Options:
24
jetpack_options (array)
25
	An array of options.
26
	@see Jetpack_Options::get_option_names()
27
28
jetpack_register (string)
29
	Temporary verification secrets.
30
31
jetpack_activated (int)
32
	1: the plugin was activated normally
33
	2: the plugin was activated on this site because of a network-wide activation
34
	3: the plugin was auto-installed
35
	4: the plugin was manually disconnected (but is still installed)
36
37
jetpack_active_modules (array)
38
	Array of active module slugs.
39
40
jetpack_do_activate (bool)
41
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
42
*/
43
44
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
45
46
class Jetpack {
47
	public $xmlrpc_server = null;
48
49
	private $rest_authentication_status = null;
50
51
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
52
53
	/**
54
	 * @var array The handles of styles that are concatenated into jetpack.css.
55
	 *
56
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
57
	 */
58
	public $concatenated_style_handles = array(
59
		'jetpack-carousel',
60
		'grunion.css',
61
		'the-neverending-homepage',
62
		'jetpack_likes',
63
		'jetpack_related-posts',
64
		'sharedaddy',
65
		'jetpack-slideshow',
66
		'presentations',
67
		'quiz',
68
		'jetpack-subscriptions',
69
		'jetpack-responsive-videos-style',
70
		'jetpack-social-menu',
71
		'tiled-gallery',
72
		'jetpack_display_posts_widget',
73
		'gravatar-profile-widget',
74
		'goodreads-widget',
75
		'jetpack_social_media_icons_widget',
76
		'jetpack-top-posts-widget',
77
		'jetpack_image_widget',
78
		'jetpack-my-community-widget',
79
		'jetpack-authors-widget',
80
		'wordads',
81
		'eu-cookie-law-style',
82
		'flickr-widget-style',
83
		'jetpack-search-widget',
84
		'jetpack-simple-payments-widget-style',
85
		'jetpack-widget-social-icons-styles',
86
	);
87
88
	/**
89
	 * The handles of scripts that can be loaded asynchronously.
90
	 *
91
	 * @var array
92
	 */
93
	public $async_script_handles = array(
94
		'woocommerce-analytics',
95
	);
96
97
	/**
98
	 * Contains all assets that have had their URL rewritten to minified versions.
99
	 *
100
	 * @var array
101
	 */
102
	static $min_assets = array();
103
104
	public $plugins_to_deactivate = array(
105
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
106
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
107
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
108
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
109
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
110
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
111
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
112
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
113
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
114
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
115
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
116
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
117
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
118
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
119
	);
120
121
	/**
122
	 * Map of roles we care about, and their corresponding minimum capabilities.
123
	 *
124
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
125
	 *
126
	 * @access public
127
	 * @static
128
	 *
129
	 * @var array
130
	 */
131
	public static $capability_translations = array(
132
		'administrator' => 'manage_options',
133
		'editor'        => 'edit_others_posts',
134
		'author'        => 'publish_posts',
135
		'contributor'   => 'edit_posts',
136
		'subscriber'    => 'read',
137
	);
138
139
	/**
140
	 * Map of modules that have conflicts with plugins and should not be auto-activated
141
	 * if the plugins are active.  Used by filter_default_modules
142
	 *
143
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
144
	 * change `module-slug` and add this to your plugin:
145
	 *
146
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
147
	 * function my_jetpack_get_default_modules( $modules ) {
148
	 *     return array_diff( $modules, array( 'module-slug' ) );
149
	 * }
150
	 *
151
	 * @var array
152
	 */
153
	private $conflicting_plugins = array(
154
		'comments'           => array(
155
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
156
			'Disqus'                         => 'disqus-comment-system/disqus.php',
157
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
158
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
159
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
160
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
161
		),
162
		'comment-likes'      => array(
163
			'Epoch' => 'epoch/plugincore.php',
164
		),
165
		'contact-form'       => array(
166
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
167
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
168
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
169
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
170
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
171
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
172
		),
173
		'latex'              => array(
174
			'LaTeX for WordPress'     => 'latex/latex.php',
175
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
176
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
177
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
178
			'Enable Latex'            => 'enable-latex/enable-latex.php',
179
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
180
		),
181
		'protect'            => array(
182
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
183
			'Captcha'                           => 'captcha/captcha.php',
184
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
185
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
186
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
187
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
188
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
189
			'Security-protection'               => 'security-protection/security-protection.php',
190
			'Login Security'                    => 'login-security/login-security.php',
191
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
192
			'Wordfence Security'                => 'wordfence/wordfence.php',
193
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
194
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
195
		),
196
		'random-redirect'    => array(
197
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
198
		),
199
		'related-posts'      => array(
200
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
201
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
202
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
203
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
204
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
205
			'outbrain'                    => 'outbrain/outbrain.php',
206
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
207
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
208
		),
209
		'sharedaddy'         => array(
210
			'AddThis'     => 'addthis/addthis_social_widget.php',
211
			'Add To Any'  => 'add-to-any/add-to-any.php',
212
			'ShareThis'   => 'share-this/sharethis.php',
213
			'Shareaholic' => 'shareaholic/shareaholic.php',
214
		),
215
		'seo-tools'          => array(
216
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
217
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
218
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
219
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
220
			'The SEO Framework'              => 'autodescription/autodescription.php',
221
		),
222
		'verification-tools' => array(
223
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
224
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
225
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
226
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
227
			'The SEO Framework'              => 'autodescription/autodescription.php',
228
		),
229
		'widget-visibility'  => array(
230
			'Widget Logic'    => 'widget-logic/widget_logic.php',
231
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
232
		),
233
		'sitemaps'           => array(
234
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
235
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
236
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
237
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
238
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
239
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
240
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
241
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
242
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
243
			'The SEO Framework'                    => 'autodescription/autodescription.php',
244
			'Sitemap'                              => 'sitemap/sitemap.php',
245
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
246
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
247
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
248
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
249
		),
250
		'lazy-images'        => array(
251
			'Lazy Load'              => 'lazy-load/lazy-load.php',
252
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
253
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
254
		),
255
	);
256
257
	/**
258
	 * Plugins for which we turn off our Facebook OG Tags implementation.
259
	 *
260
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
261
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
262
	 *
263
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
264
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
265
	 */
266
	private $open_graph_conflicting_plugins = array(
267
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
268
		// 2 Click Social Media Buttons
269
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
270
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
271
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
272
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
273
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
274
		// Open Graph Meta Tags by Heateor
275
		'facebook/facebook.php',                                 // Facebook (official plugin)
276
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
277
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
278
		// Facebook Featured Image & OG Meta Tags
279
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
280
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
281
		// Facebook Open Graph Meta Tags for WordPress
282
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
283
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
284
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
285
		// Fedmich's Facebook Open Graph Meta
286
		'network-publisher/networkpub.php',                      // Network Publisher
287
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
288
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
289
		// NextScripts SNAP
290
		'og-tags/og-tags.php',                                   // OG Tags
291
		'opengraph/opengraph.php',                               // Open Graph
292
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
293
		// Open Graph Protocol Framework
294
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
295
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
296
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
297
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
298
		'sharepress/sharepress.php',                             // SharePress
299
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
300
		'social-discussions/social-discussions.php',             // Social Discussions
301
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
302
		'socialize/socialize.php',                               // Socialize
303
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
304
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
305
		// Tweet, Like, Google +1 and Share
306
		'wordbooker/wordbooker.php',                             // Wordbooker
307
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
308
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
309
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
310
		// WP Facebook Like Send & Open Graph Meta
311
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
312
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
313
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
314
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
315
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
316
	);
317
318
	/**
319
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
320
	 */
321
	private $twitter_cards_conflicting_plugins = array(
322
		// 'twitter/twitter.php',                       // The official one handles this on its own.
323
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
324
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
325
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
326
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
327
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
328
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
329
		'twitter-cards/twitter-cards.php',           // Twitter Cards
330
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
331
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
332
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
333
	);
334
335
	/**
336
	 * Message to display in admin_notice
337
	 *
338
	 * @var string
339
	 */
340
	public $message = '';
341
342
	/**
343
	 * Error to display in admin_notice
344
	 *
345
	 * @var string
346
	 */
347
	public $error = '';
348
349
	/**
350
	 * Modules that need more privacy description.
351
	 *
352
	 * @var string
353
	 */
354
	public $privacy_checks = '';
355
356
	/**
357
	 * Stats to record once the page loads
358
	 *
359
	 * @var array
360
	 */
361
	public $stats = array();
362
363
	/**
364
	 * Jetpack_Sync object
365
	 */
366
	public $sync;
367
368
	/**
369
	 * Verified data for JSON authorization request
370
	 */
371
	public $json_api_authorization_request = array();
372
373
	/**
374
	 * @var Automattic\Jetpack\Connection\Manager
375
	 */
376
	protected $connection_manager;
377
378
	/**
379
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
380
	 */
381
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
382
383
	/**
384
	 * Constant for login redirect key.
385
	 *
386
	 * @var string
387
	 * @since 8.4.0
388
	 */
389
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
390
391
	/**
392
	 * Holds the singleton instance of this class
393
	 *
394
	 * @since 2.3.3
395
	 * @var Jetpack
396
	 */
397
	static $instance = false;
398
399
	/**
400
	 * Singleton
401
	 *
402
	 * @static
403
	 */
404
	public static function init() {
405
		if ( ! self::$instance ) {
406
			self::$instance = new Jetpack();
407
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
408
		}
409
410
		return self::$instance;
411
	}
412
413
	/**
414
	 * Must never be called statically
415
	 */
416
	function plugin_upgrade() {
417
		if ( self::is_active() ) {
418
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
419
			if ( JETPACK__VERSION != $version ) {
420
				// Prevent multiple upgrades at once - only a single process should trigger
421
				// an upgrade to avoid stampedes
422
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
423
					return;
424
				}
425
426
				// Set a short lock to prevent multiple instances of the upgrade
427
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
428
429
				// check which active modules actually exist and remove others from active_modules list
430
				$unfiltered_modules = self::get_active_modules();
431
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
432
				if ( array_diff( $unfiltered_modules, $modules ) ) {
433
					self::update_active_modules( $modules );
434
				}
435
436
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
437
438
				// Upgrade to 4.3.0
439
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
440
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
441
				}
442
443
				// Make sure Markdown for posts gets turned back on
444
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
445
					update_option( 'wpcom_publish_posts_with_markdown', true );
446
				}
447
448
				/*
449
				 * Minileven deprecation. 8.3.0.
450
				 * Only delete options if not using
451
				 * the replacement standalone Minileven plugin.
452
				 */
453
				if (
454
					! self::is_plugin_active( 'minileven-master/minileven.php' )
455
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
456
				) {
457
					if ( get_option( 'wp_mobile_custom_css' ) ) {
458
						delete_option( 'wp_mobile_custom_css' );
459
					}
460
					if ( get_option( 'wp_mobile_excerpt' ) ) {
461
						delete_option( 'wp_mobile_excerpt' );
462
					}
463
					if ( get_option( 'wp_mobile_featured_images' ) ) {
464
						delete_option( 'wp_mobile_featured_images' );
465
					}
466
					if ( get_option( 'wp_mobile_app_promos' ) ) {
467
						delete_option( 'wp_mobile_app_promos' );
468
					}
469
				}
470
471
				// Upgrade to 8.4.0.
472
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
473
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
474
				}
475
476
				if ( did_action( 'wp_loaded' ) ) {
477
					self::upgrade_on_load();
478
				} else {
479
					add_action(
480
						'wp_loaded',
481
						array( __CLASS__, 'upgrade_on_load' )
482
					);
483
				}
484
			}
485
		}
486
	}
487
488
	/**
489
	 * Runs upgrade routines that need to have modules loaded.
490
	 */
491
	static function upgrade_on_load() {
492
493
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
494
		// This can happen in case Jetpack has been just upgraded and is
495
		// being initialized late during the page load. In this case we wait
496
		// until the next proper admin page load with Jetpack active.
497
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
498
			delete_transient( self::$plugin_upgrade_lock_key );
499
500
			return;
501
		}
502
503
		self::maybe_set_version_option();
504
505
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
506
			Jetpack_Widget_Conditions::migrate_post_type_rules();
507
		}
508
509
		if (
510
			class_exists( 'Jetpack_Sitemap_Manager' )
511
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
512
		) {
513
			do_action( 'jetpack_sitemaps_purge_data' );
514
		}
515
516
		// Delete old stats cache
517
		delete_option( 'jetpack_restapi_stats_cache' );
518
519
		delete_transient( self::$plugin_upgrade_lock_key );
520
	}
521
522
	/**
523
	 * Saves all the currently active modules to options.
524
	 * Also fires Action hooks for each newly activated and deactivated module.
525
	 *
526
	 * @param $modules Array Array of active modules to be saved in options.
527
	 *
528
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
529
	 */
530
	static function update_active_modules( $modules ) {
531
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
532
		$active_modules       = self::get_active_modules();
533
		$new_active_modules   = array_diff( $modules, $current_modules );
534
		$new_inactive_modules = array_diff( $active_modules, $modules );
535
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
536
		$reindexed_modules    = array_values( $new_current_modules );
537
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
538
539
		foreach ( $new_active_modules as $module ) {
540
			/**
541
			 * Fires when a specific module is activated.
542
			 *
543
			 * @since 1.9.0
544
			 *
545
			 * @param string $module Module slug.
546
			 * @param boolean $success whether the module was activated. @since 4.2
547
			 */
548
			do_action( 'jetpack_activate_module', $module, $success );
549
			/**
550
			 * Fires when a module is activated.
551
			 * The dynamic part of the filter, $module, is the module slug.
552
			 *
553
			 * @since 1.9.0
554
			 *
555
			 * @param string $module Module slug.
556
			 */
557
			do_action( "jetpack_activate_module_$module", $module );
558
		}
559
560
		foreach ( $new_inactive_modules as $module ) {
561
			/**
562
			 * Fired after a module has been deactivated.
563
			 *
564
			 * @since 4.2.0
565
			 *
566
			 * @param string $module Module slug.
567
			 * @param boolean $success whether the module was deactivated.
568
			 */
569
			do_action( 'jetpack_deactivate_module', $module, $success );
570
			/**
571
			 * Fires when a module is deactivated.
572
			 * The dynamic part of the filter, $module, is the module slug.
573
			 *
574
			 * @since 1.9.0
575
			 *
576
			 * @param string $module Module slug.
577
			 */
578
			do_action( "jetpack_deactivate_module_$module", $module );
579
		}
580
581
		return $success;
582
	}
583
584
	static function delete_active_modules() {
585
		self::update_active_modules( array() );
586
	}
587
588
	/**
589
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
590
	 * available.
591
	 */
592
	public function add_configure_hook() {
593
		global $wp_filter;
594
595
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
596
		if ( false !== $current_priority ) {
597
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
598
		}
599
600
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
601
		sort( $taken_priorities );
602
603
		$first_priority = array_shift( $taken_priorities );
604
605
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
606
			$new_priority = - PHP_INT_MAX;
607
		} else {
608
			$new_priority = $first_priority - 1;
609
		}
610
611
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
612
	}
613
614
	/**
615
	 * Constructor.  Initializes WordPress hooks
616
	 */
617
	private function __construct() {
618
		/*
619
		 * Check for and alert any deprecated hooks
620
		 */
621
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
622
623
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
624
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
625
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
626
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
627
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
628
629
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
630
631
		add_filter(
632
			'jetpack_signature_check_token',
633
			array( __CLASS__, 'verify_onboarding_token' ),
634
			10,
635
			3
636
		);
637
638
		/**
639
		 * Prepare Gutenberg Editor functionality
640
		 */
641
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
642
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
643
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
644
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
645
646
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
647
648
		// Unlink user before deleting the user from WP.com.
649
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
650
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
651
652
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
653
654
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
655
		add_action( 'login_init', array( $this, 'login_init' ) );
656
657
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
658
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
659
660
		add_action( 'admin_init', array( $this, 'admin_init' ) );
661
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
662
663
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
664
665
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
666
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
667
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
668
669
		// returns HTTPS support status
670
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
671
672
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
673
674
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
675
676
		/**
677
		 * These actions run checks to load additional files.
678
		 * They check for external files or plugins, so they need to run as late as possible.
679
		 */
680
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
681
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
682
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
683
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
684
685
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
686
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
687
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
688
689
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
690
691
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
692
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
693
694
		// A filter to control all just in time messages
695
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
696
697
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
698
699
		/*
700
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
701
		 * We should make sure to only do this for front end links.
702
		 */
703
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
704
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
705
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
706
707
			/*
708
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
709
			 * so they point moderation links on emails to Calypso.
710
			 */
711
			jetpack_require_lib( 'functions.wp-notify' );
712
		}
713
714
		// Hide edit post link if mobile app.
715
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
716
			add_filter( 'get_edit_post_link', '__return_empty_string' );
717
		}
718
719
		// Update the Jetpack plan from API on heartbeats.
720
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
721
722
		/**
723
		 * This is the hack to concatenate all css files into one.
724
		 * For description and reasoning see the implode_frontend_css method.
725
		 *
726
		 * Super late priority so we catch all the registered styles.
727
		 */
728
		if ( ! is_admin() ) {
729
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
730
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
731
		}
732
733
		/**
734
		 * These are sync actions that we need to keep track of for jitms
735
		 */
736
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
737
738
		// Actually push the stats on shutdown.
739
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
740
			add_action( 'shutdown', array( $this, 'push_stats' ) );
741
		}
742
743
		/*
744
		 * Load some scripts asynchronously.
745
		 */
746
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
747
748
		// Actions for Manager::authorize().
749
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
750
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
751
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
752
753
		// Filters for the Manager::get_token() urls and request body.
754
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
755
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
756
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
757
	}
758
759
	/**
760
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
761
	 * Config object.
762
	 */
763
	public function configure() {
764
		$config = new Config();
765
766
		foreach (
767
			array(
768
				'sync',
769
				'tracking',
770
				'tos',
771
			)
772
			as $feature
773
		) {
774
			$config->ensure( $feature );
775
		}
776
777
		$config->ensure(
778
			'connection',
779
			array(
780
				'slug' => 'jetpack',
781
				'name' => 'Jetpack',
782
			)
783
		);
784
785
		if ( is_admin() ) {
786
			$config->ensure( 'jitm' );
787
		}
788
789
		if ( ! $this->connection_manager ) {
790
			$this->connection_manager = new Connection_Manager( 'jetpack' );
791
		}
792
793
		/*
794
		 * Load things that should only be in Network Admin.
795
		 *
796
		 * For now blow away everything else until a more full
797
		 * understanding of what is needed at the network level is
798
		 * available
799
		 */
800
		if ( is_multisite() ) {
801
			$network = Jetpack_Network::init();
802
			$network->set_connection( $this->connection_manager );
803
		}
804
805
		if ( $this->connection_manager->is_active() ) {
806
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
807
808
			Jetpack_Heartbeat::init();
809
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
810
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
811
				Jetpack_Search_Performance_Logger::init();
812
			}
813
		}
814
815
		// Initialize remote file upload request handlers.
816
		$this->add_remote_request_handlers();
817
818
		/*
819
		 * Enable enhanced handling of previewing sites in Calypso
820
		 */
821
		if ( self::is_active() ) {
822
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
823
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
824
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
825
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
826
		}
827
	}
828
829
	/**
830
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
831
	 * initialization code.
832
	 *
833
	 * @action plugins_loaded
834
	 */
835
	public function late_initialization() {
836
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
837
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
838
839
		Partner::init();
840
841
		/**
842
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
843
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
844
		 *
845
		 * @since 8.1.0
846
		 *
847
		 * @param Jetpack $jetpack the main plugin class object.
848
		 */
849
		do_action( 'jetpack_loaded', $this );
850
851
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
852
	}
853
854
	/**
855
	 * Sets up the XMLRPC request handlers.
856
	 *
857
	 * @deprecated since 7.7.0
858
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
859
	 *
860
	 * @param array                 $request_params Incoming request parameters.
861
	 * @param Boolean               $is_active      Whether the connection is currently active.
862
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
863
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
864
	 */
865 View Code Duplication
	public function setup_xmlrpc_handlers(
866
		$request_params,
867
		$is_active,
868
		$is_signed,
869
		Jetpack_XMLRPC_Server $xmlrpc_server = null
870
	) {
871
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
872
873
		if ( ! $this->connection_manager ) {
874
			$this->connection_manager = new Connection_Manager();
875
		}
876
877
		return $this->connection_manager->setup_xmlrpc_handlers(
878
			$request_params,
879
			$is_active,
880
			$is_signed,
881
			$xmlrpc_server
882
		);
883
	}
884
885
	/**
886
	 * Initialize REST API registration connector.
887
	 *
888
	 * @deprecated since 7.7.0
889
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
890
	 */
891 View Code Duplication
	public function initialize_rest_api_registration_connector() {
892
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
893
894
		if ( ! $this->connection_manager ) {
895
			$this->connection_manager = new Connection_Manager();
896
		}
897
898
		$this->connection_manager->initialize_rest_api_registration_connector();
899
	}
900
901
	/**
902
	 * This is ported over from the manage module, which has been deprecated and baked in here.
903
	 *
904
	 * @param $domains
905
	 */
906
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
907
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
908
	}
909
910
	/**
911
	 * Return $domains, with 'wordpress.com' appended.
912
	 * This is ported over from the manage module, which has been deprecated and baked in here.
913
	 *
914
	 * @param $domains
915
	 * @return array
916
	 */
917
	function allow_wpcom_domain( $domains ) {
918
		if ( empty( $domains ) ) {
919
			$domains = array();
920
		}
921
		$domains[] = 'wordpress.com';
922
		return array_unique( $domains );
923
	}
924
925
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
926
		$post = get_post( $post_id );
927
928
		if ( empty( $post ) ) {
929
			return $default_url;
930
		}
931
932
		$post_type = $post->post_type;
933
934
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
935
		// https://en.support.wordpress.com/custom-post-types/
936
		$allowed_post_types = array(
937
			'post',
938
			'page',
939
			'jetpack-portfolio',
940
			'jetpack-testimonial',
941
		);
942
943
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
944
			return $default_url;
945
		}
946
947
		return esc_url(
948
			Redirect::get_url(
949
				'calypso-edit-' . $post_type,
950
				array(
951
					'path' => $post_id,
952
				)
953
			)
954
		);
955
	}
956
957
	function point_edit_comment_links_to_calypso( $url ) {
958
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
959
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
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...
960
961
		return esc_url(
962
			Redirect::get_url(
963
				'calypso-edit-comment',
964
				array(
965
					'path' => $query_args['amp;c'],
966
				)
967
			)
968
		);
969
970
	}
971
972
	function jetpack_track_last_sync_callback( $params ) {
973
		/**
974
		 * Filter to turn off jitm caching
975
		 *
976
		 * @since 5.4.0
977
		 *
978
		 * @param bool false Whether to cache just in time messages
979
		 */
980
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
981
			return $params;
982
		}
983
984
		if ( is_array( $params ) && isset( $params[0] ) ) {
985
			$option = $params[0];
986
			if ( 'active_plugins' === $option ) {
987
				// use the cache if we can, but not terribly important if it gets evicted
988
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
989
			}
990
		}
991
992
		return $params;
993
	}
994
995
	function jetpack_connection_banner_callback() {
996
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
997
998
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
999
		if (
1000
			isset( $_REQUEST['dismissBanner'] ) &&
1001
			! Jetpack_Connection_Banner::force_display()
1002
		) {
1003
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1004
			wp_send_json_success();
1005
		}
1006
1007
		wp_die();
1008
	}
1009
1010
	/**
1011
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1012
	 * Only used in our alternate XML-RPC endpoint, where we want to
1013
	 * ensure that Core and other plugins' methods are not exposed.
1014
	 *
1015
	 * @deprecated since 7.7.0
1016
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1017
	 *
1018
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1019
	 * @return array Filtered $methods
1020
	 */
1021 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1022
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1023
1024
		if ( ! $this->connection_manager ) {
1025
			$this->connection_manager = new Connection_Manager();
1026
		}
1027
1028
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1029
	}
1030
1031
	/**
1032
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1033
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1034
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1035
	 * which is accessible via a different URI. Most of the below is copied directly
1036
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1037
	 *
1038
	 * @deprecated since 7.7.0
1039
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1040
	 */
1041 View Code Duplication
	public function alternate_xmlrpc() {
1042
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1043
1044
		if ( ! $this->connection_manager ) {
1045
			$this->connection_manager = new Connection_Manager();
1046
		}
1047
1048
		$this->connection_manager->alternate_xmlrpc();
1049
	}
1050
1051
	/**
1052
	 * The callback for the JITM ajax requests.
1053
	 *
1054
	 * @deprecated since 7.9.0
1055
	 */
1056
	function jetpack_jitm_ajax_callback() {
1057
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1058
	}
1059
1060
	/**
1061
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1062
	 */
1063
	function push_stats() {
1064
		if ( ! empty( $this->stats ) ) {
1065
			$this->do_stats( 'server_side' );
1066
		}
1067
	}
1068
1069
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1070
		$is_development_mode = ( new Status() )->is_development_mode();
1071
		switch ( $cap ) {
1072
			case 'jetpack_connect':
1073
			case 'jetpack_reconnect':
1074
				if ( $is_development_mode ) {
1075
					$caps = array( 'do_not_allow' );
1076
					break;
1077
				}
1078
				/**
1079
				 * Pass through. If it's not development mode, these should match disconnect.
1080
				 * Let users disconnect if it's development mode, just in case things glitch.
1081
				 */
1082
			case 'jetpack_disconnect':
1083
				/**
1084
				 * In multisite, can individual site admins manage their own connection?
1085
				 *
1086
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1087
				 */
1088
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1089
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1090
						/**
1091
						 * We need to update the option name -- it's terribly unclear which
1092
						 * direction the override goes.
1093
						 *
1094
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1095
						 */
1096
						$caps = array( 'do_not_allow' );
1097
						break;
1098
					}
1099
				}
1100
1101
				$caps = array( 'manage_options' );
1102
				break;
1103
			case 'jetpack_manage_modules':
1104
			case 'jetpack_activate_modules':
1105
			case 'jetpack_deactivate_modules':
1106
				$caps = array( 'manage_options' );
1107
				break;
1108
			case 'jetpack_configure_modules':
1109
				$caps = array( 'manage_options' );
1110
				break;
1111
			case 'jetpack_manage_autoupdates':
1112
				$caps = array(
1113
					'manage_options',
1114
					'update_plugins',
1115
				);
1116
				break;
1117
			case 'jetpack_network_admin_page':
1118
			case 'jetpack_network_settings_page':
1119
				$caps = array( 'manage_network_plugins' );
1120
				break;
1121
			case 'jetpack_network_sites_page':
1122
				$caps = array( 'manage_sites' );
1123
				break;
1124
			case 'jetpack_admin_page':
1125
				if ( $is_development_mode ) {
1126
					$caps = array( 'manage_options' );
1127
					break;
1128
				} else {
1129
					$caps = array( 'read' );
1130
				}
1131
				break;
1132
			case 'jetpack_connect_user':
1133
				if ( $is_development_mode ) {
1134
					$caps = array( 'do_not_allow' );
1135
					break;
1136
				}
1137
				$caps = array( 'read' );
1138
				break;
1139
		}
1140
		return $caps;
1141
	}
1142
1143
	/**
1144
	 * Require a Jetpack authentication.
1145
	 *
1146
	 * @deprecated since 7.7.0
1147
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1148
	 */
1149 View Code Duplication
	public function require_jetpack_authentication() {
1150
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1151
1152
		if ( ! $this->connection_manager ) {
1153
			$this->connection_manager = new Connection_Manager();
1154
		}
1155
1156
		$this->connection_manager->require_jetpack_authentication();
1157
	}
1158
1159
	/**
1160
	 * Load language files
1161
	 *
1162
	 * @action plugins_loaded
1163
	 */
1164
	public static function plugin_textdomain() {
1165
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1166
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1167
	}
1168
1169
	/**
1170
	 * Register assets for use in various modules and the Jetpack admin page.
1171
	 *
1172
	 * @uses wp_script_is, wp_register_script, plugins_url
1173
	 * @action wp_loaded
1174
	 * @return null
1175
	 */
1176
	public function register_assets() {
1177
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1178
			wp_register_script(
1179
				'spin',
1180
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1181
				false,
1182
				'1.3'
1183
			);
1184
		}
1185
1186 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1187
			wp_register_script(
1188
				'jquery.spin',
1189
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1190
				array( 'jquery', 'spin' ),
1191
				'1.3'
1192
			);
1193
		}
1194
1195 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1196
			wp_register_script(
1197
				'jetpack-gallery-settings',
1198
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1199
				array( 'media-views' ),
1200
				'20121225'
1201
			);
1202
		}
1203
1204 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1205
			wp_register_script(
1206
				'jetpack-twitter-timeline',
1207
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1208
				array( 'jquery' ),
1209
				'4.0.0',
1210
				true
1211
			);
1212
		}
1213
1214
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1215
			wp_register_script(
1216
				'jetpack-facebook-embed',
1217
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1218
				array(),
1219
				null,
1220
				true
1221
			);
1222
1223
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1224
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1225
			if ( ! is_numeric( $fb_app_id ) ) {
1226
				$fb_app_id = '';
1227
			}
1228
			wp_localize_script(
1229
				'jetpack-facebook-embed',
1230
				'jpfbembed',
1231
				array(
1232
					'appid'  => $fb_app_id,
1233
					'locale' => $this->get_locale(),
1234
				)
1235
			);
1236
		}
1237
1238
		/**
1239
		 * As jetpack_register_genericons is by default fired off a hook,
1240
		 * the hook may have already fired by this point.
1241
		 * So, let's just trigger it manually.
1242
		 */
1243
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1244
		jetpack_register_genericons();
1245
1246
		/**
1247
		 * Register the social logos
1248
		 */
1249
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1250
		jetpack_register_social_logos();
1251
1252 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1253
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1254
		}
1255
	}
1256
1257
	/**
1258
	 * Guess locale from language code.
1259
	 *
1260
	 * @param string $lang Language code.
1261
	 * @return string|bool
1262
	 */
1263 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1264
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1265
			return 'en_US';
1266
		}
1267
1268
		if ( ! class_exists( 'GP_Locales' ) ) {
1269
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1270
				return false;
1271
			}
1272
1273
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1274
		}
1275
1276
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1277
			// WP.com: get_locale() returns 'it'
1278
			$locale = GP_Locales::by_slug( $lang );
1279
		} else {
1280
			// Jetpack: get_locale() returns 'it_IT';
1281
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1282
		}
1283
1284
		if ( ! $locale ) {
1285
			return false;
1286
		}
1287
1288
		if ( empty( $locale->facebook_locale ) ) {
1289
			if ( empty( $locale->wp_locale ) ) {
1290
				return false;
1291
			} else {
1292
				// Facebook SDK is smart enough to fall back to en_US if a
1293
				// locale isn't supported. Since supported Facebook locales
1294
				// can fall out of sync, we'll attempt to use the known
1295
				// wp_locale value and rely on said fallback.
1296
				return $locale->wp_locale;
1297
			}
1298
		}
1299
1300
		return $locale->facebook_locale;
1301
	}
1302
1303
	/**
1304
	 * Get the locale.
1305
	 *
1306
	 * @return string|bool
1307
	 */
1308
	function get_locale() {
1309
		$locale = $this->guess_locale_from_lang( get_locale() );
1310
1311
		if ( ! $locale ) {
1312
			$locale = 'en_US';
1313
		}
1314
1315
		return $locale;
1316
	}
1317
1318
	/**
1319
	 * Return the network_site_url so that .com knows what network this site is a part of.
1320
	 *
1321
	 * @param  bool $option
1322
	 * @return string
1323
	 */
1324
	public function jetpack_main_network_site_option( $option ) {
1325
		return network_site_url();
1326
	}
1327
	/**
1328
	 * Network Name.
1329
	 */
1330
	static function network_name( $option = null ) {
1331
		global $current_site;
1332
		return $current_site->site_name;
1333
	}
1334
	/**
1335
	 * Does the network allow new user and site registrations.
1336
	 *
1337
	 * @return string
1338
	 */
1339
	static function network_allow_new_registrations( $option = null ) {
1340
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1341
	}
1342
	/**
1343
	 * Does the network allow admins to add new users.
1344
	 *
1345
	 * @return boolian
1346
	 */
1347
	static function network_add_new_users( $option = null ) {
1348
		return (bool) get_site_option( 'add_new_users' );
1349
	}
1350
	/**
1351
	 * File upload psace left per site in MB.
1352
	 *  -1 means NO LIMIT.
1353
	 *
1354
	 * @return number
1355
	 */
1356
	static function network_site_upload_space( $option = null ) {
1357
		// value in MB
1358
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1359
	}
1360
1361
	/**
1362
	 * Network allowed file types.
1363
	 *
1364
	 * @return string
1365
	 */
1366
	static function network_upload_file_types( $option = null ) {
1367
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1368
	}
1369
1370
	/**
1371
	 * Maximum file upload size set by the network.
1372
	 *
1373
	 * @return number
1374
	 */
1375
	static function network_max_upload_file_size( $option = null ) {
1376
		// value in KB
1377
		return get_site_option( 'fileupload_maxk', 300 );
1378
	}
1379
1380
	/**
1381
	 * Lets us know if a site allows admins to manage the network.
1382
	 *
1383
	 * @return array
1384
	 */
1385
	static function network_enable_administration_menus( $option = null ) {
1386
		return get_site_option( 'menu_items' );
1387
	}
1388
1389
	/**
1390
	 * If a user has been promoted to or demoted from admin, we need to clear the
1391
	 * jetpack_other_linked_admins transient.
1392
	 *
1393
	 * @since 4.3.2
1394
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1395
	 *
1396
	 * @param int    $user_id   The user ID whose role changed.
1397
	 * @param string $role      The new role.
1398
	 * @param array  $old_roles An array of the user's previous roles.
0 ignored issues
show
Should the type for parameter $old_roles not be array|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
1399
	 */
1400
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1401
		if ( 'administrator' == $role
1402
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1403
			|| is_null( $old_roles )
1404
		) {
1405
			delete_transient( 'jetpack_other_linked_admins' );
1406
		}
1407
	}
1408
1409
	/**
1410
	 * Checks to see if there are any other users available to become primary
1411
	 * Users must both:
1412
	 * - Be linked to wpcom
1413
	 * - Be an admin
1414
	 *
1415
	 * @return mixed False if no other users are linked, Int if there are.
1416
	 */
1417
	static function get_other_linked_admins() {
1418
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1419
1420
		if ( false === $other_linked_users ) {
1421
			$admins = get_users( array( 'role' => 'administrator' ) );
1422
			if ( count( $admins ) > 1 ) {
1423
				$available = array();
1424
				foreach ( $admins as $admin ) {
1425
					if ( self::is_user_connected( $admin->ID ) ) {
1426
						$available[] = $admin->ID;
1427
					}
1428
				}
1429
1430
				$count_connected_admins = count( $available );
1431
				if ( count( $available ) > 1 ) {
1432
					$other_linked_users = $count_connected_admins;
1433
				} else {
1434
					$other_linked_users = 0;
1435
				}
1436
			} else {
1437
				$other_linked_users = 0;
1438
			}
1439
1440
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1441
		}
1442
1443
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1444
	}
1445
1446
	/**
1447
	 * Return whether we are dealing with a multi network setup or not.
1448
	 * The reason we are type casting this is because we want to avoid the situation where
1449
	 * the result is false since when is_main_network_option return false it cases
1450
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1451
	 * database which could be set to anything as opposed to what this function returns.
1452
	 *
1453
	 * @param  bool $option
1454
	 *
1455
	 * @return boolean
1456
	 */
1457
	public function is_main_network_option( $option ) {
1458
		// return '1' or ''
1459
		return (string) (bool) self::is_multi_network();
1460
	}
1461
1462
	/**
1463
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1464
	 *
1465
	 * @param  string $option
1466
	 * @return boolean
1467
	 */
1468
	public function is_multisite( $option ) {
1469
		return (string) (bool) is_multisite();
1470
	}
1471
1472
	/**
1473
	 * Implemented since there is no core is multi network function
1474
	 * Right now there is no way to tell if we which network is the dominant network on the system
1475
	 *
1476
	 * @since  3.3
1477
	 * @return boolean
1478
	 */
1479 View Code Duplication
	public static function is_multi_network() {
1480
		global  $wpdb;
1481
1482
		// if we don't have a multi site setup no need to do any more
1483
		if ( ! is_multisite() ) {
1484
			return false;
1485
		}
1486
1487
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1488
		if ( $num_sites > 1 ) {
1489
			return true;
1490
		} else {
1491
			return false;
1492
		}
1493
	}
1494
1495
	/**
1496
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1497
	 *
1498
	 * @return null
1499
	 */
1500
	function update_jetpack_main_network_site_option() {
1501
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1502
	}
1503
	/**
1504
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1505
	 */
1506
	function update_jetpack_network_settings() {
1507
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1508
		// Only sync this info for the main network site.
1509
	}
1510
1511
	/**
1512
	 * Get back if the current site is single user site.
1513
	 *
1514
	 * @return bool
1515
	 */
1516 View Code Duplication
	public static function is_single_user_site() {
1517
		global $wpdb;
1518
1519
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1520
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1521
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1522
		}
1523
		return 1 === (int) $some_users;
1524
	}
1525
1526
	/**
1527
	 * Returns true if the site has file write access false otherwise.
1528
	 *
1529
	 * @return string ( '1' | '0' )
1530
	 **/
1531
	public static function file_system_write_access() {
1532
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1533
			require_once ABSPATH . 'wp-admin/includes/file.php';
1534
		}
1535
1536
		require_once ABSPATH . 'wp-admin/includes/template.php';
1537
1538
		$filesystem_method = get_filesystem_method();
1539
		if ( $filesystem_method === 'direct' ) {
1540
			return 1;
1541
		}
1542
1543
		ob_start();
1544
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1545
		ob_end_clean();
1546
		if ( $filesystem_credentials_are_stored ) {
1547
			return 1;
1548
		}
1549
		return 0;
1550
	}
1551
1552
	/**
1553
	 * Finds out if a site is using a version control system.
1554
	 *
1555
	 * @return string ( '1' | '0' )
1556
	 **/
1557
	public static function is_version_controlled() {
1558
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1559
		return (string) (int) Functions::is_version_controlled();
1560
	}
1561
1562
	/**
1563
	 * Determines whether the current theme supports featured images or not.
1564
	 *
1565
	 * @return string ( '1' | '0' )
1566
	 */
1567
	public static function featured_images_enabled() {
1568
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1569
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1570
	}
1571
1572
	/**
1573
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1574
	 *
1575
	 * @deprecated 4.7 use get_avatar_url instead.
1576
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1577
	 * @param int               $size Size of the avatar image
1578
	 * @param string            $default URL to a default image to use if no avatar is available
1579
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1580
	 *
1581
	 * @return array
1582
	 */
1583
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1584
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1585
		return get_avatar_url(
1586
			$id_or_email,
1587
			array(
1588
				'size'          => $size,
1589
				'default'       => $default,
1590
				'force_default' => $force_display,
1591
			)
1592
		);
1593
	}
1594
1595
	/**
1596
	 * jetpack_updates is saved in the following schema:
1597
	 *
1598
	 * array (
1599
	 *      'plugins'                       => (int) Number of plugin updates available.
1600
	 *      'themes'                        => (int) Number of theme updates available.
1601
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1602
	 *      'translations'                  => (int) Number of translation updates available.
1603
	 *      'total'                         => (int) Total of all available updates.
1604
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1605
	 * )
1606
	 *
1607
	 * @return array
1608
	 */
1609
	public static function get_updates() {
1610
		$update_data = wp_get_update_data();
1611
1612
		// Stores the individual update counts as well as the total count.
1613
		if ( isset( $update_data['counts'] ) ) {
1614
			$updates = $update_data['counts'];
1615
		}
1616
1617
		// If we need to update WordPress core, let's find the latest version number.
1618 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1619
			$cur = get_preferred_from_update_core();
1620
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1621
				$updates['wp_update_version'] = $cur->current;
1622
			}
1623
		}
1624
		return isset( $updates ) ? $updates : array();
1625
	}
1626
1627
	public static function get_update_details() {
1628
		$update_details = array(
1629
			'update_core'    => get_site_transient( 'update_core' ),
1630
			'update_plugins' => get_site_transient( 'update_plugins' ),
1631
			'update_themes'  => get_site_transient( 'update_themes' ),
1632
		);
1633
		return $update_details;
1634
	}
1635
1636
	public static function refresh_update_data() {
1637
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1638
1639
	}
1640
1641
	public static function refresh_theme_data() {
1642
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1643
	}
1644
1645
	/**
1646
	 * Is Jetpack active?
1647
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1648
	 *
1649
	 * @return bool
1650
	 */
1651
	public static function is_active() {
1652
		return self::connection()->is_active();
1653
	}
1654
1655
	/**
1656
	 * Make an API call to WordPress.com for plan status
1657
	 *
1658
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1659
	 *
1660
	 * @return bool True if plan is updated, false if no update
1661
	 */
1662
	public static function refresh_active_plan_from_wpcom() {
1663
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1664
		return Jetpack_Plan::refresh_from_wpcom();
1665
	}
1666
1667
	/**
1668
	 * Get the plan that this Jetpack site is currently using
1669
	 *
1670
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1671
	 * @return array Active Jetpack plan details.
1672
	 */
1673
	public static function get_active_plan() {
1674
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1675
		return Jetpack_Plan::get();
1676
	}
1677
1678
	/**
1679
	 * Determine whether the active plan supports a particular feature
1680
	 *
1681
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1682
	 * @return bool True if plan supports feature, false if not.
1683
	 */
1684
	public static function active_plan_supports( $feature ) {
1685
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1686
		return Jetpack_Plan::supports( $feature );
1687
	}
1688
1689
	/**
1690
	 * Deprecated: Is Jetpack in development (offline) mode?
1691
	 *
1692
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1693
	 * and themes still use it, and we do not want to flood them with notices.
1694
	 *
1695
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1696
	 *
1697
	 * @deprecated since 8.0.
1698
	 */
1699
	public static function is_development_mode() {
1700
		return ( new Status() )->is_development_mode();
1701
	}
1702
1703
	/**
1704
	 * Whether the site is currently onboarding or not.
1705
	 * A site is considered as being onboarded if it currently has an onboarding token.
1706
	 *
1707
	 * @since 5.8
1708
	 *
1709
	 * @access public
1710
	 * @static
1711
	 *
1712
	 * @return bool True if the site is currently onboarding, false otherwise
1713
	 */
1714
	public static function is_onboarding() {
1715
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1716
	}
1717
1718
	/**
1719
	 * Determines reason for Jetpack development mode.
1720
	 */
1721
	public static function development_mode_trigger_text() {
1722
		if ( ! ( new Status() )->is_development_mode() ) {
1723
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1724
		}
1725
1726
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1727
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1728
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1729
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1730
		} else {
1731
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1732
		}
1733
1734
		return $notice;
1735
1736
	}
1737
	/**
1738
	 * Get Jetpack development mode notice text and notice class.
1739
	 *
1740
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1741
	 */
1742
	public static function show_development_mode_notice() {
1743 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1744
			$notice = sprintf(
1745
				/* translators: %s is a URL */
1746
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1747
				Redirect::get_url( 'jetpack-support-development-mode' )
1748
			);
1749
1750
			$notice .= ' ' . self::development_mode_trigger_text();
1751
1752
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1753
		}
1754
1755
		// Throw up a notice if using a development version and as for feedback.
1756
		if ( self::is_development_version() ) {
1757
			/* translators: %s is a URL */
1758
			$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' ) );
1759
1760
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1761
		}
1762
		// Throw up a notice if using staging mode
1763 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1764
			/* translators: %s is a URL */
1765
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1766
1767
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1768
		}
1769
	}
1770
1771
	/**
1772
	 * Whether Jetpack's version maps to a public release, or a development version.
1773
	 */
1774
	public static function is_development_version() {
1775
		/**
1776
		 * Allows filtering whether this is a development version of Jetpack.
1777
		 *
1778
		 * This filter is especially useful for tests.
1779
		 *
1780
		 * @since 4.3.0
1781
		 *
1782
		 * @param bool $development_version Is this a develoment version of Jetpack?
1783
		 */
1784
		return (bool) apply_filters(
1785
			'jetpack_development_version',
1786
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1787
		);
1788
	}
1789
1790
	/**
1791
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1792
	 */
1793
	public static function is_user_connected( $user_id = false ) {
1794
		return self::connection()->is_user_connected( $user_id );
1795
	}
1796
1797
	/**
1798
	 * Get the wpcom user data of the current|specified connected user.
1799
	 */
1800 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1801
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1802
		if ( ! $user_id ) {
1803
			$user_id = get_current_user_id();
1804
		}
1805
1806
		$transient_key = "jetpack_connected_user_data_$user_id";
1807
1808
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1809
			return $cached_user_data;
1810
		}
1811
1812
		$xml = new Jetpack_IXR_Client(
1813
			array(
1814
				'user_id' => $user_id,
1815
			)
1816
		);
1817
		$xml->query( 'wpcom.getUser' );
1818
		if ( ! $xml->isError() ) {
1819
			$user_data = $xml->getResponse();
1820
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1821
			return $user_data;
1822
		}
1823
1824
		return false;
1825
	}
1826
1827
	/**
1828
	 * Get the wpcom email of the current|specified connected user.
1829
	 */
1830
	public static function get_connected_user_email( $user_id = null ) {
1831
		if ( ! $user_id ) {
1832
			$user_id = get_current_user_id();
1833
		}
1834
1835
		$xml = new Jetpack_IXR_Client(
1836
			array(
1837
				'user_id' => $user_id,
1838
			)
1839
		);
1840
		$xml->query( 'wpcom.getUserEmail' );
1841
		if ( ! $xml->isError() ) {
1842
			return $xml->getResponse();
1843
		}
1844
		return false;
1845
	}
1846
1847
	/**
1848
	 * Get the wpcom email of the master user.
1849
	 */
1850
	public static function get_master_user_email() {
1851
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1852
		if ( $master_user_id ) {
1853
			return self::get_connected_user_email( $master_user_id );
1854
		}
1855
		return '';
1856
	}
1857
1858
	/**
1859
	 * Whether the current user is the connection owner.
1860
	 *
1861
	 * @deprecated since 7.7
1862
	 *
1863
	 * @return bool Whether the current user is the connection owner.
1864
	 */
1865
	public function current_user_is_connection_owner() {
1866
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1867
		return self::connection()->is_connection_owner();
1868
	}
1869
1870
	/**
1871
	 * Gets current user IP address.
1872
	 *
1873
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1874
	 *
1875
	 * @return string                  Current user IP address.
1876
	 */
1877
	public static function current_user_ip( $check_all_headers = false ) {
1878
		if ( $check_all_headers ) {
1879
			foreach ( array(
1880
				'HTTP_CF_CONNECTING_IP',
1881
				'HTTP_CLIENT_IP',
1882
				'HTTP_X_FORWARDED_FOR',
1883
				'HTTP_X_FORWARDED',
1884
				'HTTP_X_CLUSTER_CLIENT_IP',
1885
				'HTTP_FORWARDED_FOR',
1886
				'HTTP_FORWARDED',
1887
				'HTTP_VIA',
1888
			) as $key ) {
1889
				if ( ! empty( $_SERVER[ $key ] ) ) {
1890
					return $_SERVER[ $key ];
1891
				}
1892
			}
1893
		}
1894
1895
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1896
	}
1897
1898
	/**
1899
	 * Synchronize connected user role changes
1900
	 */
1901
	function user_role_change( $user_id ) {
1902
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1903
		Users::user_role_change( $user_id );
1904
	}
1905
1906
	/**
1907
	 * Loads the currently active modules.
1908
	 */
1909
	public static function load_modules() {
1910
		$is_development_mode = ( new Status() )->is_development_mode();
1911
		if (
1912
			! self::is_active()
1913
			&& ! $is_development_mode
1914
			&& ! self::is_onboarding()
1915
			&& (
1916
				! is_multisite()
1917
				|| ! get_site_option( 'jetpack_protect_active' )
1918
			)
1919
		) {
1920
			return;
1921
		}
1922
1923
		$version = Jetpack_Options::get_option( 'version' );
1924 View Code Duplication
		if ( ! $version ) {
1925
			$version = $old_version = JETPACK__VERSION . ':' . time();
1926
			/** This action is documented in class.jetpack.php */
1927
			do_action( 'updating_jetpack_version', $version, false );
1928
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1929
		}
1930
		list( $version ) = explode( ':', $version );
1931
1932
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1933
1934
		$modules_data = array();
1935
1936
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1937
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1938
			$updated_modules = array();
1939
			foreach ( $modules as $module ) {
1940
				$modules_data[ $module ] = self::get_module( $module );
1941
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1942
					continue;
1943
				}
1944
1945
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1946
					continue;
1947
				}
1948
1949
				$updated_modules[] = $module;
1950
			}
1951
1952
			$modules = array_diff( $modules, $updated_modules );
1953
		}
1954
1955
		foreach ( $modules as $index => $module ) {
1956
			// If we're in dev mode, disable modules requiring a connection
1957
			if ( $is_development_mode ) {
1958
				// Prime the pump if we need to
1959
				if ( empty( $modules_data[ $module ] ) ) {
1960
					$modules_data[ $module ] = self::get_module( $module );
1961
				}
1962
				// If the module requires a connection, but we're in local mode, don't include it.
1963
				if ( $modules_data[ $module ]['requires_connection'] ) {
1964
					continue;
1965
				}
1966
			}
1967
1968
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1969
				continue;
1970
			}
1971
1972
			if ( ! include_once self::get_module_path( $module ) ) {
1973
				unset( $modules[ $index ] );
1974
				self::update_active_modules( array_values( $modules ) );
1975
				continue;
1976
			}
1977
1978
			/**
1979
			 * Fires when a specific module is loaded.
1980
			 * The dynamic part of the hook, $module, is the module slug.
1981
			 *
1982
			 * @since 1.1.0
1983
			 */
1984
			do_action( 'jetpack_module_loaded_' . $module );
1985
		}
1986
1987
		/**
1988
		 * Fires when all the modules are loaded.
1989
		 *
1990
		 * @since 1.1.0
1991
		 */
1992
		do_action( 'jetpack_modules_loaded' );
1993
1994
		// 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.
1995
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1996
	}
1997
1998
	/**
1999
	 * Check if Jetpack's REST API compat file should be included
2000
	 *
2001
	 * @action plugins_loaded
2002
	 * @return null
2003
	 */
2004
	public function check_rest_api_compat() {
2005
		/**
2006
		 * Filters the list of REST API compat files to be included.
2007
		 *
2008
		 * @since 2.2.5
2009
		 *
2010
		 * @param array $args Array of REST API compat files to include.
2011
		 */
2012
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2013
2014
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2015
			require_once $_jetpack_rest_api_compat_include;
2016
		}
2017
	}
2018
2019
	/**
2020
	 * Gets all plugins currently active in values, regardless of whether they're
2021
	 * traditionally activated or network activated.
2022
	 *
2023
	 * @todo Store the result in core's object cache maybe?
2024
	 */
2025
	public static function get_active_plugins() {
2026
		$active_plugins = (array) get_option( 'active_plugins', array() );
2027
2028
		if ( is_multisite() ) {
2029
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2030
			// whereas active_plugins stores them in the values.
2031
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2032
			if ( $network_plugins ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $network_plugins of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2033
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2034
			}
2035
		}
2036
2037
		sort( $active_plugins );
2038
2039
		return array_unique( $active_plugins );
2040
	}
2041
2042
	/**
2043
	 * Gets and parses additional plugin data to send with the heartbeat data
2044
	 *
2045
	 * @since 3.8.1
2046
	 *
2047
	 * @return array Array of plugin data
2048
	 */
2049
	public static function get_parsed_plugin_data() {
2050
		if ( ! function_exists( 'get_plugins' ) ) {
2051
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2052
		}
2053
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2054
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2055
		$active_plugins = self::get_active_plugins();
2056
2057
		$plugins = array();
2058
		foreach ( $all_plugins as $path => $plugin_data ) {
2059
			$plugins[ $path ] = array(
2060
				'is_active' => in_array( $path, $active_plugins ),
2061
				'file'      => $path,
2062
				'name'      => $plugin_data['Name'],
2063
				'version'   => $plugin_data['Version'],
2064
				'author'    => $plugin_data['Author'],
2065
			);
2066
		}
2067
2068
		return $plugins;
2069
	}
2070
2071
	/**
2072
	 * Gets and parses theme data to send with the heartbeat data
2073
	 *
2074
	 * @since 3.8.1
2075
	 *
2076
	 * @return array Array of theme data
2077
	 */
2078
	public static function get_parsed_theme_data() {
2079
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2080
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2081
2082
		$themes = array();
2083
		foreach ( $all_themes as $slug => $theme_data ) {
2084
			$theme_headers = array();
2085
			foreach ( $header_keys as $header_key ) {
2086
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2087
			}
2088
2089
			$themes[ $slug ] = array(
2090
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2091
				'slug'            => $slug,
2092
				'theme_root'      => $theme_data->get_theme_root_uri(),
2093
				'parent'          => $theme_data->parent(),
2094
				'headers'         => $theme_headers,
2095
			);
2096
		}
2097
2098
		return $themes;
2099
	}
2100
2101
	/**
2102
	 * Checks whether a specific plugin is active.
2103
	 *
2104
	 * We don't want to store these in a static variable, in case
2105
	 * there are switch_to_blog() calls involved.
2106
	 */
2107
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2108
		return in_array( $plugin, self::get_active_plugins() );
2109
	}
2110
2111
	/**
2112
	 * Check if Jetpack's Open Graph tags should be used.
2113
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2114
	 *
2115
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2116
	 * @action plugins_loaded
2117
	 * @return null
2118
	 */
2119
	public function check_open_graph() {
2120
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2121
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2122
		}
2123
2124
		$active_plugins = self::get_active_plugins();
2125
2126
		if ( ! empty( $active_plugins ) ) {
2127
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2128
				if ( in_array( $plugin, $active_plugins ) ) {
2129
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2130
					break;
2131
				}
2132
			}
2133
		}
2134
2135
		/**
2136
		 * Allow the addition of Open Graph Meta Tags to all pages.
2137
		 *
2138
		 * @since 2.0.3
2139
		 *
2140
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2141
		 */
2142
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2143
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2144
		}
2145
	}
2146
2147
	/**
2148
	 * Check if Jetpack's Twitter tags should be used.
2149
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2150
	 *
2151
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2152
	 * @action plugins_loaded
2153
	 * @return null
2154
	 */
2155
	public function check_twitter_tags() {
2156
2157
		$active_plugins = self::get_active_plugins();
2158
2159
		if ( ! empty( $active_plugins ) ) {
2160
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2161
				if ( in_array( $plugin, $active_plugins ) ) {
2162
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2163
					break;
2164
				}
2165
			}
2166
		}
2167
2168
		/**
2169
		 * Allow Twitter Card Meta tags to be disabled.
2170
		 *
2171
		 * @since 2.6.0
2172
		 *
2173
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2174
		 */
2175
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2176
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2177
		}
2178
	}
2179
2180
	/**
2181
	 * Allows plugins to submit security reports.
2182
	 *
2183
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2184
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2185
	 * @param array  $args         See definitions above
2186
	 */
2187
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2188
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2189
	}
2190
2191
	/* Jetpack Options API */
2192
2193
	public static function get_option_names( $type = 'compact' ) {
2194
		return Jetpack_Options::get_option_names( $type );
2195
	}
2196
2197
	/**
2198
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2199
	 *
2200
	 * @param string $name    Option name
2201
	 * @param mixed  $default (optional)
2202
	 */
2203
	public static function get_option( $name, $default = false ) {
2204
		return Jetpack_Options::get_option( $name, $default );
2205
	}
2206
2207
	/**
2208
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2209
	 *
2210
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2211
	 * @param string $name  Option name
2212
	 * @param mixed  $value Option value
2213
	 */
2214
	public static function update_option( $name, $value ) {
2215
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2216
		return Jetpack_Options::update_option( $name, $value );
2217
	}
2218
2219
	/**
2220
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2221
	 *
2222
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2223
	 * @param array $array array( option name => option value, ... )
2224
	 */
2225
	public static function update_options( $array ) {
2226
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2227
		return Jetpack_Options::update_options( $array );
2228
	}
2229
2230
	/**
2231
	 * Deletes the given option.  May be passed multiple option names as an array.
2232
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2233
	 *
2234
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2235
	 * @param string|array $names
2236
	 */
2237
	public static function delete_option( $names ) {
2238
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2239
		return Jetpack_Options::delete_option( $names );
2240
	}
2241
2242
	/**
2243
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2244
	 *
2245
	 * Enters a user token into the user_tokens option
2246
	 *
2247
	 * @param int    $user_id The user id.
2248
	 * @param string $token The user token.
2249
	 * @param bool   $is_master_user Whether the user is the master user.
2250
	 * @return bool
2251
	 */
2252
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2253
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2254
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2255
	}
2256
2257
	/**
2258
	 * Returns an array of all PHP files in the specified absolute path.
2259
	 * Equivalent to glob( "$absolute_path/*.php" ).
2260
	 *
2261
	 * @param string $absolute_path The absolute path of the directory to search.
2262
	 * @return array Array of absolute paths to the PHP files.
2263
	 */
2264
	public static function glob_php( $absolute_path ) {
2265
		if ( function_exists( 'glob' ) ) {
2266
			return glob( "$absolute_path/*.php" );
2267
		}
2268
2269
		$absolute_path = untrailingslashit( $absolute_path );
2270
		$files         = array();
2271
		if ( ! $dir = @opendir( $absolute_path ) ) {
2272
			return $files;
2273
		}
2274
2275
		while ( false !== $file = readdir( $dir ) ) {
2276
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2277
				continue;
2278
			}
2279
2280
			$file = "$absolute_path/$file";
2281
2282
			if ( ! is_file( $file ) ) {
2283
				continue;
2284
			}
2285
2286
			$files[] = $file;
2287
		}
2288
2289
		closedir( $dir );
2290
2291
		return $files;
2292
	}
2293
2294
	public static function activate_new_modules( $redirect = false ) {
2295
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2296
			return;
2297
		}
2298
2299
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2300 View Code Duplication
		if ( ! $jetpack_old_version ) {
2301
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2302
			/** This action is documented in class.jetpack.php */
2303
			do_action( 'updating_jetpack_version', $version, false );
2304
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2305
		}
2306
2307
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2308
2309
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2310
			return;
2311
		}
2312
2313
		$active_modules     = self::get_active_modules();
2314
		$reactivate_modules = array();
2315
		foreach ( $active_modules as $active_module ) {
2316
			$module = self::get_module( $active_module );
2317
			if ( ! isset( $module['changed'] ) ) {
2318
				continue;
2319
			}
2320
2321
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2322
				continue;
2323
			}
2324
2325
			$reactivate_modules[] = $active_module;
2326
			self::deactivate_module( $active_module );
2327
		}
2328
2329
		$new_version = JETPACK__VERSION . ':' . time();
2330
		/** This action is documented in class.jetpack.php */
2331
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2332
		Jetpack_Options::update_options(
2333
			array(
2334
				'version'     => $new_version,
2335
				'old_version' => $jetpack_old_version,
2336
			)
2337
		);
2338
2339
		self::state( 'message', 'modules_activated' );
2340
2341
		self::activate_default_modules( $jetpack_version, JETPACK__VERSION, $reactivate_modules, $redirect );
0 ignored issues
show
JETPACK__VERSION is of type string, but the function expects a boolean.

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...
2342
2343
		if ( $redirect ) {
2344
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2345
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2346
				$page = $_GET['page'];
2347
			}
2348
2349
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2350
			exit;
2351
		}
2352
	}
2353
2354
	/**
2355
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2356
	 * Make sure to tuck away module "library" files in a sub-directory.
2357
	 */
2358
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2359
		static $modules = null;
2360
2361
		if ( ! isset( $modules ) ) {
2362
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2363
			// Use the cache if we're on the front-end and it's available...
2364
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2365
				$modules = $available_modules_option[ JETPACK__VERSION ];
2366
			} else {
2367
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2368
2369
				$modules = array();
2370
2371
				foreach ( $files as $file ) {
2372
					if ( ! $headers = self::get_module( $file ) ) {
2373
						continue;
2374
					}
2375
2376
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2377
				}
2378
2379
				Jetpack_Options::update_option(
2380
					'available_modules',
2381
					array(
2382
						JETPACK__VERSION => $modules,
2383
					)
2384
				);
2385
			}
2386
		}
2387
2388
		/**
2389
		 * Filters the array of modules available to be activated.
2390
		 *
2391
		 * @since 2.4.0
2392
		 *
2393
		 * @param array $modules Array of available modules.
2394
		 * @param string $min_version Minimum version number required to use modules.
2395
		 * @param string $max_version Maximum version number required to use modules.
2396
		 */
2397
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2398
2399
		if ( ! $min_version && ! $max_version ) {
2400
			return array_keys( $mods );
2401
		}
2402
2403
		$r = array();
2404
		foreach ( $mods as $slug => $introduced ) {
2405
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2406
				continue;
2407
			}
2408
2409
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2410
				continue;
2411
			}
2412
2413
			$r[] = $slug;
2414
		}
2415
2416
		return $r;
2417
	}
2418
2419
	/**
2420
	 * Default modules loaded on activation.
2421
	 */
2422
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2423
		$return = array();
2424
2425
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2426
			$module_data = self::get_module( $module );
2427
2428
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2429
				case 'yes':
2430
					$return[] = $module;
2431
					break;
2432
				case 'public':
2433
					if ( Jetpack_Options::get_option( 'public' ) ) {
2434
						$return[] = $module;
2435
					}
2436
					break;
2437
				case 'no':
2438
				default:
2439
					break;
2440
			}
2441
		}
2442
		/**
2443
		 * Filters the array of default modules.
2444
		 *
2445
		 * @since 2.5.0
2446
		 *
2447
		 * @param array $return Array of default modules.
2448
		 * @param string $min_version Minimum version number required to use modules.
2449
		 * @param string $max_version Maximum version number required to use modules.
2450
		 */
2451
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2452
	}
2453
2454
	/**
2455
	 * Checks activated modules during auto-activation to determine
2456
	 * if any of those modules are being deprecated.  If so, close
2457
	 * them out, and add any replacement modules.
2458
	 *
2459
	 * Runs at priority 99 by default.
2460
	 *
2461
	 * This is run late, so that it can still activate a module if
2462
	 * the new module is a replacement for another that the user
2463
	 * currently has active, even if something at the normal priority
2464
	 * would kibosh everything.
2465
	 *
2466
	 * @since 2.6
2467
	 * @uses jetpack_get_default_modules filter
2468
	 * @param array $modules
2469
	 * @return array
2470
	 */
2471
	function handle_deprecated_modules( $modules ) {
2472
		$deprecated_modules = array(
2473
			'debug'            => null,  // Closed out and moved to the debugger library.
2474
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2475
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2476
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2477
		);
2478
2479
		// Don't activate SSO if they never completed activating WPCC.
2480
		if ( self::is_module_active( 'wpcc' ) ) {
2481
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2482
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2483
				$deprecated_modules['wpcc'] = null;
2484
			}
2485
		}
2486
2487
		foreach ( $deprecated_modules as $module => $replacement ) {
2488
			if ( self::is_module_active( $module ) ) {
2489
				self::deactivate_module( $module );
2490
				if ( $replacement ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $replacement of type null|string is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
2491
					$modules[] = $replacement;
2492
				}
2493
			}
2494
		}
2495
2496
		return array_unique( $modules );
2497
	}
2498
2499
	/**
2500
	 * Checks activated plugins during auto-activation to determine
2501
	 * if any of those plugins are in the list with a corresponding module
2502
	 * that is not compatible with the plugin. The module will not be allowed
2503
	 * to auto-activate.
2504
	 *
2505
	 * @since 2.6
2506
	 * @uses jetpack_get_default_modules filter
2507
	 * @param array $modules
2508
	 * @return array
2509
	 */
2510
	function filter_default_modules( $modules ) {
2511
2512
		$active_plugins = self::get_active_plugins();
2513
2514
		if ( ! empty( $active_plugins ) ) {
2515
2516
			// For each module we'd like to auto-activate...
2517
			foreach ( $modules as $key => $module ) {
2518
				// If there are potential conflicts for it...
2519
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2520
					// For each potential conflict...
2521
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2522
						// If that conflicting plugin is active...
2523
						if ( in_array( $plugin, $active_plugins ) ) {
2524
							// Remove that item from being auto-activated.
2525
							unset( $modules[ $key ] );
2526
						}
2527
					}
2528
				}
2529
			}
2530
		}
2531
2532
		return $modules;
2533
	}
2534
2535
	/**
2536
	 * Extract a module's slug from its full path.
2537
	 */
2538
	public static function get_module_slug( $file ) {
2539
		return str_replace( '.php', '', basename( $file ) );
2540
	}
2541
2542
	/**
2543
	 * Generate a module's path from its slug.
2544
	 */
2545
	public static function get_module_path( $slug ) {
2546
		/**
2547
		 * Filters the path of a modules.
2548
		 *
2549
		 * @since 7.4.0
2550
		 *
2551
		 * @param array $return The absolute path to a module's root php file
2552
		 * @param string $slug The module slug
2553
		 */
2554
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2555
	}
2556
2557
	/**
2558
	 * Load module data from module file. Headers differ from WordPress
2559
	 * plugin headers to avoid them being identified as standalone
2560
	 * plugins on the WordPress plugins page.
2561
	 */
2562
	public static function get_module( $module ) {
2563
		$headers = array(
2564
			'name'                      => 'Module Name',
2565
			'description'               => 'Module Description',
2566
			'sort'                      => 'Sort Order',
2567
			'recommendation_order'      => 'Recommendation Order',
2568
			'introduced'                => 'First Introduced',
2569
			'changed'                   => 'Major Changes In',
2570
			'deactivate'                => 'Deactivate',
2571
			'free'                      => 'Free',
2572
			'requires_connection'       => 'Requires Connection',
2573
			'auto_activate'             => 'Auto Activate',
2574
			'module_tags'               => 'Module Tags',
2575
			'feature'                   => 'Feature',
2576
			'additional_search_queries' => 'Additional Search Queries',
2577
			'plan_classes'              => 'Plans',
2578
		);
2579
2580
		$file = self::get_module_path( self::get_module_slug( $module ) );
2581
2582
		$mod = self::get_file_data( $file, $headers );
2583
		if ( empty( $mod['name'] ) ) {
2584
			return false;
2585
		}
2586
2587
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2588
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2589
		$mod['deactivate']           = empty( $mod['deactivate'] );
2590
		$mod['free']                 = empty( $mod['free'] );
2591
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2592
2593
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2594
			$mod['auto_activate'] = 'No';
2595
		} else {
2596
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2597
		}
2598
2599
		if ( $mod['module_tags'] ) {
2600
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2601
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2602
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2603
		} else {
2604
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2605
		}
2606
2607 View Code Duplication
		if ( $mod['plan_classes'] ) {
2608
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2609
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2610
		} else {
2611
			$mod['plan_classes'] = array( 'free' );
2612
		}
2613
2614 View Code Duplication
		if ( $mod['feature'] ) {
2615
			$mod['feature'] = explode( ',', $mod['feature'] );
2616
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2617
		} else {
2618
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2619
		}
2620
2621
		/**
2622
		 * Filters the feature array on a module.
2623
		 *
2624
		 * This filter allows you to control where each module is filtered: Recommended,
2625
		 * and the default "Other" listing.
2626
		 *
2627
		 * @since 3.5.0
2628
		 *
2629
		 * @param array   $mod['feature'] The areas to feature this module:
2630
		 *     'Recommended' shows on the main Jetpack admin screen.
2631
		 *     'Other' should be the default if no other value is in the array.
2632
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2633
		 * @param array   $mod All the currently assembled module data.
2634
		 */
2635
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2636
2637
		/**
2638
		 * Filter the returned data about a module.
2639
		 *
2640
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2641
		 * so please be careful.
2642
		 *
2643
		 * @since 3.6.0
2644
		 *
2645
		 * @param array   $mod    The details of the requested module.
2646
		 * @param string  $module The slug of the module, e.g. sharedaddy
2647
		 * @param string  $file   The path to the module source file.
2648
		 */
2649
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2650
	}
2651
2652
	/**
2653
	 * Like core's get_file_data implementation, but caches the result.
2654
	 */
2655
	public static function get_file_data( $file, $headers ) {
2656
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2657
		$file_name = basename( $file );
2658
2659
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2660
2661
		$file_data_option = get_transient( $cache_key );
2662
2663
		if ( ! is_array( $file_data_option ) ) {
2664
			delete_transient( $cache_key );
2665
			$file_data_option = false;
2666
		}
2667
2668
		if ( false === $file_data_option ) {
2669
			$file_data_option = array();
2670
		}
2671
2672
		$key           = md5( $file_name . serialize( $headers ) );
2673
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2674
2675
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2676
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2677
			return $file_data_option[ $key ];
2678
		}
2679
2680
		$data = get_file_data( $file, $headers );
2681
2682
		$file_data_option[ $key ] = $data;
2683
2684
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2685
2686
		return $data;
2687
	}
2688
2689
2690
	/**
2691
	 * Return translated module tag.
2692
	 *
2693
	 * @param string $tag Tag as it appears in each module heading.
2694
	 *
2695
	 * @return mixed
2696
	 */
2697
	public static function translate_module_tag( $tag ) {
2698
		return jetpack_get_module_i18n_tag( $tag );
2699
	}
2700
2701
	/**
2702
	 * Get i18n strings as a JSON-encoded string
2703
	 *
2704
	 * @return string The locale as JSON
2705
	 */
2706
	public static function get_i18n_data_json() {
2707
2708
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2709
		// JSON files with the file they should be included for. This is an md5
2710
		// of '_inc/build/admin.js'.
2711
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2712
2713
		$i18n_json =
2714
				   JETPACK__PLUGIN_DIR
2715
				   . 'languages/json/jetpack-'
2716
				   . get_user_locale()
2717
				   . '-'
2718
				   . $path_md5
2719
				   . '.json';
2720
2721
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2722
			$locale_data = @file_get_contents( $i18n_json );
2723
			if ( $locale_data ) {
2724
				return $locale_data;
2725
			}
2726
		}
2727
2728
		// Return valid empty Jed locale
2729
		return '{ "locale_data": { "messages": { "": {} } } }';
2730
	}
2731
2732
	/**
2733
	 * Add locale data setup to wp-i18n
2734
	 *
2735
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2736
	 *
2737
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2738
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2739
	 *
2740
	 * This method provides a safe way to request the setup multiple times but add the script at
2741
	 * most once.
2742
	 *
2743
	 * @since 6.7.0
2744
	 *
2745
	 * @return void
2746
	 */
2747
	public static function setup_wp_i18n_locale_data() {
2748
		static $script_added = false;
2749
		if ( ! $script_added ) {
2750
			$script_added = true;
2751
			wp_add_inline_script(
2752
				'wp-i18n',
2753
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2754
			);
2755
		}
2756
	}
2757
2758
	/**
2759
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2760
	 *
2761
	 * @since 3.9.2
2762
	 *
2763
	 * @param array $modules
2764
	 *
2765
	 * @return string|void
2766
	 */
2767
	public static function get_translated_modules( $modules ) {
2768
		foreach ( $modules as $index => $module ) {
2769
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2770
			if ( isset( $module['name'] ) ) {
2771
				$modules[ $index ]['name'] = $i18n_module['name'];
2772
			}
2773
			if ( isset( $module['description'] ) ) {
2774
				$modules[ $index ]['description']       = $i18n_module['description'];
2775
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2776
			}
2777
		}
2778
		return $modules;
2779
	}
2780
2781
	/**
2782
	 * Get a list of activated modules as an array of module slugs.
2783
	 */
2784
	public static function get_active_modules() {
2785
		$active = Jetpack_Options::get_option( 'active_modules' );
2786
2787
		if ( ! is_array( $active ) ) {
2788
			$active = array();
2789
		}
2790
2791
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2792
			$active[] = 'vaultpress';
2793
		} else {
2794
			$active = array_diff( $active, array( 'vaultpress' ) );
2795
		}
2796
2797
		// If protect is active on the main site of a multisite, it should be active on all sites.
2798
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2799
			$active[] = 'protect';
2800
		}
2801
2802
		/**
2803
		 * Allow filtering of the active modules.
2804
		 *
2805
		 * Gives theme and plugin developers the power to alter the modules that
2806
		 * are activated on the fly.
2807
		 *
2808
		 * @since 5.8.0
2809
		 *
2810
		 * @param array $active Array of active module slugs.
2811
		 */
2812
		$active = apply_filters( 'jetpack_active_modules', $active );
2813
2814
		return array_unique( $active );
2815
	}
2816
2817
	/**
2818
	 * Check whether or not a Jetpack module is active.
2819
	 *
2820
	 * @param string $module The slug of a Jetpack module.
2821
	 * @return bool
2822
	 *
2823
	 * @static
2824
	 */
2825
	public static function is_module_active( $module ) {
2826
		return in_array( $module, self::get_active_modules() );
2827
	}
2828
2829
	public static function is_module( $module ) {
2830
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2831
	}
2832
2833
	/**
2834
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2835
	 *
2836
	 * @param bool $catch True to start catching, False to stop.
2837
	 *
2838
	 * @static
2839
	 */
2840
	public static function catch_errors( $catch ) {
2841
		static $display_errors, $error_reporting;
2842
2843
		if ( $catch ) {
2844
			$display_errors  = @ini_set( 'display_errors', 1 );
2845
			$error_reporting = @error_reporting( E_ALL );
2846
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2847
		} else {
2848
			@ini_set( 'display_errors', $display_errors );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2849
			@error_reporting( $error_reporting );
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
2850
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2851
		}
2852
	}
2853
2854
	/**
2855
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2856
	 */
2857
	public static function catch_errors_on_shutdown() {
2858
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2859
	}
2860
2861
	/**
2862
	 * Rewrite any string to make paths easier to read.
2863
	 *
2864
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2865
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2866
	 *
2867
	 * @param $string
2868
	 * @return mixed
2869
	 */
2870
	public static function alias_directories( $string ) {
2871
		// ABSPATH has a trailing slash.
2872
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2873
		// WP_CONTENT_DIR does not have a trailing slash.
2874
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2875
2876
		return $string;
2877
	}
2878
2879
	public static function activate_default_modules(
2880
		$min_version = false,
2881
		$max_version = false,
2882
		$other_modules = array(),
2883
		$redirect = null,
2884
		$send_state_messages = null
2885
	) {
2886
		$jetpack = self::init();
2887
2888
		if ( is_null( $redirect ) ) {
2889
			if (
2890
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2891
			||
2892
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2893
			||
2894
				( defined( 'WP_CLI' ) && WP_CLI )
2895
			||
2896
				( defined( 'DOING_CRON' ) && DOING_CRON )
2897
			||
2898
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2899
			) {
2900
				$redirect = false;
2901
			} elseif ( is_admin() ) {
2902
				$redirect = true;
2903
			} else {
2904
				$redirect = false;
2905
			}
2906
		}
2907
2908
		if ( is_null( $send_state_messages ) ) {
2909
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2910
		}
2911
2912
		$modules = self::get_default_modules( $min_version, $max_version );
2913
		$modules = array_merge( $other_modules, $modules );
2914
2915
		// Look for standalone plugins and disable if active.
2916
2917
		$to_deactivate = array();
2918
		foreach ( $modules as $module ) {
2919
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2920
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2921
			}
2922
		}
2923
2924
		$deactivated = array();
2925
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2926
			list( $probable_file, $probable_title ) = $deactivate_me;
2927
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2928
				$deactivated[] = $module;
2929
			}
2930
		}
2931
2932
		if ( $deactivated ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2933
			if ( $send_state_messages ) {
2934
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2935
			}
2936
2937
			if ( $redirect ) {
2938
				$url = add_query_arg(
2939
					array(
2940
						'action'   => 'activate_default_modules',
2941
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2942
					),
2943
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2944
				);
2945
				wp_safe_redirect( $url );
2946
				exit;
2947
			}
2948
		}
2949
2950
		/**
2951
		 * Fires before default modules are activated.
2952
		 *
2953
		 * @since 1.9.0
2954
		 *
2955
		 * @param string $min_version Minimum version number required to use modules.
2956
		 * @param string $max_version Maximum version number required to use modules.
2957
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2958
		 */
2959
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2960
2961
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2962
		if ( $send_state_messages ) {
2963
			self::restate();
2964
			self::catch_errors( true );
2965
		}
2966
2967
		$active = self::get_active_modules();
2968
2969
		foreach ( $modules as $module ) {
2970
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2971
				$active[] = $module;
2972
				self::update_active_modules( $active );
2973
				continue;
2974
			}
2975
2976
			if ( $send_state_messages && in_array( $module, $active ) ) {
2977
				$module_info = self::get_module( $module );
2978 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2979
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2980
					if ( $active_state = self::state( $state ) ) {
2981
						$active_state = explode( ',', $active_state );
2982
					} else {
2983
						$active_state = array();
2984
					}
2985
					$active_state[] = $module;
2986
					self::state( $state, implode( ',', $active_state ) );
2987
				}
2988
				continue;
2989
			}
2990
2991
			$file = self::get_module_path( $module );
2992
			if ( ! file_exists( $file ) ) {
2993
				continue;
2994
			}
2995
2996
			// we'll override this later if the plugin can be included without fatal error
2997
			if ( $redirect ) {
2998
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2999
			}
3000
3001
			if ( $send_state_messages ) {
3002
				self::state( 'error', 'module_activation_failed' );
3003
				self::state( 'module', $module );
3004
			}
3005
3006
			ob_start();
3007
			require_once $file;
3008
3009
			$active[] = $module;
3010
3011 View Code Duplication
			if ( $send_state_messages ) {
3012
3013
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3014
				if ( $active_state = self::state( $state ) ) {
3015
					$active_state = explode( ',', $active_state );
3016
				} else {
3017
					$active_state = array();
3018
				}
3019
				$active_state[] = $module;
3020
				self::state( $state, implode( ',', $active_state ) );
3021
			}
3022
3023
			self::update_active_modules( $active );
3024
3025
			ob_end_clean();
3026
		}
3027
3028
		if ( $send_state_messages ) {
3029
			self::state( 'error', false );
0 ignored issues
show
false is of type boolean, 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...
3030
			self::state( 'module', false );
0 ignored issues
show
false is of type boolean, 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...
3031
		}
3032
3033
		self::catch_errors( false );
3034
		/**
3035
		 * Fires when default modules are activated.
3036
		 *
3037
		 * @since 1.9.0
3038
		 *
3039
		 * @param string $min_version Minimum version number required to use modules.
3040
		 * @param string $max_version Maximum version number required to use modules.
3041
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3042
		 */
3043
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3044
	}
3045
3046
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3047
		/**
3048
		 * Fires before a module is activated.
3049
		 *
3050
		 * @since 2.6.0
3051
		 *
3052
		 * @param string $module Module slug.
3053
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3054
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3055
		 */
3056
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3057
3058
		$jetpack = self::init();
3059
3060
		if ( ! strlen( $module ) ) {
3061
			return false;
3062
		}
3063
3064
		if ( ! self::is_module( $module ) ) {
3065
			return false;
3066
		}
3067
3068
		// If it's already active, then don't do it again
3069
		$active = self::get_active_modules();
3070
		foreach ( $active as $act ) {
3071
			if ( $act == $module ) {
3072
				return true;
3073
			}
3074
		}
3075
3076
		$module_data = self::get_module( $module );
3077
3078
		$is_development_mode = ( new Status() )->is_development_mode();
3079
		if ( ! self::is_active() ) {
3080
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3081
				return false;
3082
			}
3083
3084
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3085
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3086
				return false;
3087
			}
3088
		}
3089
3090
		// Check and see if the old plugin is active
3091
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3092
			// Deactivate the old plugin
3093
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3094
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3095
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3096
				self::state( 'deactivated_plugins', $module );
3097
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3098
				exit;
3099
			}
3100
		}
3101
3102
		// Protect won't work with mis-configured IPs
3103
		if ( 'protect' === $module ) {
3104
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3105
			if ( ! jetpack_protect_get_ip() ) {
3106
				self::state( 'message', 'protect_misconfigured_ip' );
3107
				return false;
3108
			}
3109
		}
3110
3111
		if ( ! Jetpack_Plan::supports( $module ) ) {
3112
			return false;
3113
		}
3114
3115
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3116
		self::state( 'module', $module );
3117
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3118
3119
		self::catch_errors( true );
3120
		ob_start();
3121
		require self::get_module_path( $module );
3122
		/** This action is documented in class.jetpack.php */
3123
		do_action( 'jetpack_activate_module', $module );
3124
		$active[] = $module;
3125
		self::update_active_modules( $active );
3126
3127
		self::state( 'error', false ); // the override
0 ignored issues
show
false is of type boolean, 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...
3128
		ob_end_clean();
3129
		self::catch_errors( false );
3130
3131
		if ( $redirect ) {
3132
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3133
		}
3134
		if ( $exit ) {
3135
			exit;
3136
		}
3137
		return true;
3138
	}
3139
3140
	function activate_module_actions( $module ) {
3141
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3142
	}
3143
3144
	public static function deactivate_module( $module ) {
3145
		/**
3146
		 * Fires when a module is deactivated.
3147
		 *
3148
		 * @since 1.9.0
3149
		 *
3150
		 * @param string $module Module slug.
3151
		 */
3152
		do_action( 'jetpack_pre_deactivate_module', $module );
3153
3154
		$jetpack = self::init();
0 ignored issues
show
$jetpack is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3155
3156
		$active = self::get_active_modules();
3157
		$new    = array_filter( array_diff( $active, (array) $module ) );
3158
3159
		return self::update_active_modules( $new );
3160
	}
3161
3162
	public static function enable_module_configurable( $module ) {
3163
		$module = self::get_module_slug( $module );
3164
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3165
	}
3166
3167
	/**
3168
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3169
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3170
	 *
3171
	 * @param string $module Module slug
3172
	 * @return string $url module configuration URL
3173
	 */
3174
	public static function module_configuration_url( $module ) {
3175
		$module      = self::get_module_slug( $module );
3176
		$default_url = self::admin_url() . "#/settings?term=$module";
3177
		/**
3178
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3179
		 *
3180
		 * @since 6.9.0
3181
		 *
3182
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3183
		 */
3184
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3185
3186
		return $url;
3187
	}
3188
3189
	/* Installation */
3190
	public static function bail_on_activation( $message, $deactivate = true ) {
3191
		?>
3192
<!doctype html>
3193
<html>
3194
<head>
3195
<meta charset="<?php bloginfo( 'charset' ); ?>">
3196
<style>
3197
* {
3198
	text-align: center;
3199
	margin: 0;
3200
	padding: 0;
3201
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3202
}
3203
p {
3204
	margin-top: 1em;
3205
	font-size: 18px;
3206
}
3207
</style>
3208
<body>
3209
<p><?php echo esc_html( $message ); ?></p>
3210
</body>
3211
</html>
3212
		<?php
3213
		if ( $deactivate ) {
3214
			$plugins = get_option( 'active_plugins' );
3215
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3216
			$update  = false;
3217
			foreach ( $plugins as $i => $plugin ) {
3218
				if ( $plugin === $jetpack ) {
3219
					$plugins[ $i ] = false;
3220
					$update        = true;
3221
				}
3222
			}
3223
3224
			if ( $update ) {
3225
				update_option( 'active_plugins', array_filter( $plugins ) );
3226
			}
3227
		}
3228
		exit;
3229
	}
3230
3231
	/**
3232
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3233
	 *
3234
	 * @static
3235
	 */
3236
	public static function plugin_activation( $network_wide ) {
3237
		Jetpack_Options::update_option( 'activated', 1 );
3238
3239
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3240
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3241
		}
3242
3243
		if ( $network_wide ) {
3244
			self::state( 'network_nag', true );
0 ignored issues
show
true is of type boolean, 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...
3245
		}
3246
3247
		// For firing one-off events (notices) immediately after activation
3248
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3249
3250
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3251
3252
		Health::on_jetpack_activated();
3253
3254
		self::plugin_initialize();
3255
	}
3256
3257
	public static function get_activation_source( $referer_url ) {
3258
3259
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3260
			return array( 'wp-cli', null );
3261
		}
3262
3263
		$referer = wp_parse_url( $referer_url );
3264
3265
		$source_type  = 'unknown';
3266
		$source_query = null;
3267
3268
		if ( ! is_array( $referer ) ) {
3269
			return array( $source_type, $source_query );
3270
		}
3271
3272
		$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...
3273
		$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...
3274
3275
		if ( isset( $referer['query'] ) ) {
3276
			parse_str( $referer['query'], $query_parts );
3277
		} else {
3278
			$query_parts = array();
3279
		}
3280
3281
		if ( $plugins_path === $referer['path'] ) {
3282
			$source_type = 'list';
3283
		} elseif ( $plugins_install_path === $referer['path'] ) {
3284
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3285
			switch ( $tab ) {
3286
				case 'popular':
3287
					$source_type = 'popular';
3288
					break;
3289
				case 'recommended':
3290
					$source_type = 'recommended';
3291
					break;
3292
				case 'favorites':
3293
					$source_type = 'favorites';
3294
					break;
3295
				case 'search':
3296
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3297
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3298
					break;
3299
				default:
3300
					$source_type = 'featured';
3301
			}
3302
		}
3303
3304
		return array( $source_type, $source_query );
3305
	}
3306
3307
	/**
3308
	 * Runs before bumping version numbers up to a new version
3309
	 *
3310
	 * @param string $version    Version:timestamp.
3311
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3312
	 */
3313
	public static function do_version_bump( $version, $old_version ) {
3314
		if ( $old_version ) { // For existing Jetpack installations.
3315
			self::send_update_modal_data();
3316
		}
3317
	}
3318
3319
	/**
3320
	 * Prepares the release post content and image data and saves it in the
3321
	 * state array. This data is used to create the update modal.
3322
	 */
3323
	public static function send_update_modal_data() {
3324
		$post_data = self::get_release_post_data();
3325
3326
		if ( ! isset( $post_data['posts'][0] ) ) {
3327
			return;
3328
		}
3329
3330
		$post = $post_data['posts'][0];
3331
3332
		$post_content = isset( $post['content'] ) ? $post['content'] : null;
3333
		if ( empty( $post_content ) ) {
3334
			return;
3335
		}
3336
3337
		// This allows us to embed videopress videos into the release post.
3338
		add_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3339
		$content = wp_kses_post( $post_content );
3340
		remove_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3341
3342
		$post_title = isset( $post['title'] ) ? $post['title'] : null;
3343
		$title      = wp_kses( $post_title, array() );
3344
3345
		$post_thumbnail = isset( $post['post_thumbnail'] ) ? $post['post_thumbnail'] : null;
3346
		if ( ! empty( $post_thumbnail ) ) {
3347
			jetpack_require_lib( 'class.jetpack-photon-image' );
3348
			$photon_image = new Jetpack_Photon_Image(
3349
				array(
3350
					'file'   => jetpack_photon_url( $post_thumbnail['URL'] ),
3351
					'width'  => $post_thumbnail['width'],
3352
					'height' => $post_thumbnail['height'],
3353
				),
3354
				$post_thumbnail['mime_type']
3355
			);
3356
			$photon_image->resize(
3357
				array(
3358
					'width'  => 600,
3359
					'height' => null,
3360
					'crop'   => false,
3361
				)
3362
			);
3363
			$post_thumbnail_url = $photon_image->get_raw_filename();
3364
		} else {
3365
			$post_thumbnail_url = null;
3366
		}
3367
3368
		$post_array = array(
3369
			'release_post_content'        => $content,
3370
			'release_post_featured_image' => $post_thumbnail_url,
3371
			'release_post_title'          => $title,
3372
		);
3373
3374
		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...
3375
	}
3376
3377
	/**
3378
	 * Temporarily allow post content to contain iframes, e.g. for videopress.
3379
	 *
3380
	 * @param string $tags    The tags.
3381
	 * @param string $context The context.
3382
	 */
3383
	public static function allow_post_embed_iframe( $tags, $context ) {
3384
		if ( 'post' === $context ) {
3385
			$tags['iframe'] = array(
3386
				'src'             => true,
3387
				'height'          => true,
3388
				'width'           => true,
3389
				'frameborder'     => true,
3390
				'allowfullscreen' => true,
3391
			);
3392
		}
3393
3394
		return $tags;
3395
	}
3396
3397
	/**
3398
	 * Obtains the release post from the Jetpack release post blog. A release post will be displayed in the
3399
	 * update modal when a post has a tag equal to the Jetpack version number.
3400
	 *
3401
	 * The response parameters for the post array can be found here:
3402
	 * https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/posts/%24post_ID/#apidoc-response
3403
	 *
3404
	 * @return array|null Returns an associative array containing the release post data at index ['posts'][0].
3405
	 *                    Returns null if the release post data is not available.
3406
	 */
3407
	private static function get_release_post_data() {
3408
		if ( Constants::is_defined( 'TESTING_IN_JETPACK' ) && Constants::get_constant( 'TESTING_IN_JETPACK' ) ) {
3409
			return null;
3410
		}
3411
3412
		$release_post_src = add_query_arg(
3413
			array(
3414
				'order_by' => 'date',
3415
				'tag'      => JETPACK__VERSION,
3416
				'number'   => '1',
3417
			),
3418
			'https://public-api.wordpress.com/rest/v1/sites/' . JETPACK__RELEASE_POST_BLOG_SLUG . '/posts'
3419
		);
3420
3421
		$response = wp_remote_get( $release_post_src );
3422
3423
		if ( ! is_array( $response ) ) {
3424
			return null;
3425
		}
3426
3427
		return json_decode( wp_remote_retrieve_body( $response ), true );
3428
	}
3429
3430
	/**
3431
	 * Sets the internal version number and activation state.
3432
	 *
3433
	 * @static
3434
	 */
3435
	public static function plugin_initialize() {
3436
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3437
			Jetpack_Options::update_option( 'activated', 2 );
3438
		}
3439
3440 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3441
			$version = $old_version = JETPACK__VERSION . ':' . time();
3442
			/** This action is documented in class.jetpack.php */
3443
			do_action( 'updating_jetpack_version', $version, false );
3444
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3445
		}
3446
3447
		self::load_modules();
3448
3449
		Jetpack_Options::delete_option( 'do_activate' );
3450
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3451
	}
3452
3453
	/**
3454
	 * Removes all connection options
3455
	 *
3456
	 * @static
3457
	 */
3458
	public static function plugin_deactivation() {
3459
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3460
		$tracking = new Tracking();
3461
		$tracking->record_user_event( 'deactivate_plugin', array() );
3462
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3463
			Jetpack_Network::init()->deactivate();
3464
		} else {
3465
			self::disconnect( false );
3466
			// Jetpack_Heartbeat::init()->deactivate();
3467
		}
3468
	}
3469
3470
	/**
3471
	 * Disconnects from the Jetpack servers.
3472
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3473
	 *
3474
	 * @static
3475
	 */
3476
	public static function disconnect( $update_activated_state = true ) {
3477
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3478
		$connection = self::connection();
3479
		$connection->clean_nonces( true );
3480
3481
		// If the site is in an IDC because sync is not allowed,
3482
		// let's make sure to not disconnect the production site.
3483
		if ( ! self::validate_sync_error_idc_option() ) {
3484
			$tracking = new Tracking();
3485
			$tracking->record_user_event( 'disconnect_site', array() );
3486
3487
			$connection->disconnect_site_wpcom();
3488
		}
3489
3490
		$connection->delete_all_connection_tokens();
3491
		Jetpack_IDC::clear_all_idc_options();
3492
3493
		if ( $update_activated_state ) {
3494
			Jetpack_Options::update_option( 'activated', 4 );
3495
		}
3496
3497
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3498
			// Check then record unique disconnection if site has never been disconnected previously
3499
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3500
				$jetpack_unique_connection['disconnected'] = 1;
3501
			} else {
3502
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3503
					// track unique disconnect
3504
					$jetpack = self::init();
3505
3506
					$jetpack->stat( 'connections', 'unique-disconnect' );
3507
					$jetpack->do_stats( 'server_side' );
3508
				}
3509
				// increment number of times disconnected
3510
				$jetpack_unique_connection['disconnected'] += 1;
3511
			}
3512
3513
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3514
		}
3515
3516
		// Delete all the sync related data. Since it could be taking up space.
3517
		Sender::get_instance()->uninstall();
3518
3519
		// Disable the Heartbeat cron
3520
		Jetpack_Heartbeat::init()->deactivate();
3521
	}
3522
3523
	/**
3524
	 * Unlinks the current user from the linked WordPress.com user.
3525
	 *
3526
	 * @deprecated since 7.7
3527
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3528
	 *
3529
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
3530
	 * @return Boolean Whether the disconnection of the user was successful.
3531
	 */
3532
	public static function unlink_user( $user_id = null ) {
3533
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3534
		return Connection_Manager::disconnect_user( $user_id );
3535
	}
3536
3537
	/**
3538
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3539
	 */
3540
	public static function try_registration() {
3541
		$terms_of_service = new Terms_Of_Service();
3542
		// The user has agreed to the TOS at some point by now.
3543
		$terms_of_service->agree();
3544
3545
		// Let's get some testing in beta versions and such.
3546
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3547
			// Before attempting to connect, let's make sure that the domains are viable.
3548
			$domains_to_check = array_unique(
3549
				array(
3550
					'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...
3551
					'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...
3552
				)
3553
			);
3554
			foreach ( $domains_to_check as $domain ) {
3555
				$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...
3556
				if ( is_wp_error( $result ) ) {
3557
					return $result;
3558
				}
3559
			}
3560
		}
3561
3562
		$result = self::register();
3563
3564
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3565
		if ( ! $result || is_wp_error( $result ) ) {
3566
			return $result;
3567
		} else {
3568
			return true;
3569
		}
3570
	}
3571
3572
	/**
3573
	 * Tracking an internal event log. Try not to put too much chaff in here.
3574
	 *
3575
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3576
	 */
3577
	public static function log( $code, $data = null ) {
3578
		// only grab the latest 200 entries
3579
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3580
3581
		// Append our event to the log
3582
		$log_entry = array(
3583
			'time'    => time(),
3584
			'user_id' => get_current_user_id(),
3585
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3586
			'code'    => $code,
3587
		);
3588
		// Don't bother storing it unless we've got some.
3589
		if ( ! is_null( $data ) ) {
3590
			$log_entry['data'] = $data;
3591
		}
3592
		$log[] = $log_entry;
3593
3594
		// Try add_option first, to make sure it's not autoloaded.
3595
		// @todo: Add an add_option method to Jetpack_Options
3596
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3597
			Jetpack_Options::update_option( 'log', $log );
3598
		}
3599
3600
		/**
3601
		 * Fires when Jetpack logs an internal event.
3602
		 *
3603
		 * @since 3.0.0
3604
		 *
3605
		 * @param array $log_entry {
3606
		 *  Array of details about the log entry.
3607
		 *
3608
		 *  @param string time Time of the event.
3609
		 *  @param int user_id ID of the user who trigerred the event.
3610
		 *  @param int blog_id Jetpack Blog ID.
3611
		 *  @param string code Unique name for the event.
3612
		 *  @param string data Data about the event.
3613
		 * }
3614
		 */
3615
		do_action( 'jetpack_log_entry', $log_entry );
3616
	}
3617
3618
	/**
3619
	 * Get the internal event log.
3620
	 *
3621
	 * @param $event (string) - only return the specific log events
3622
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3623
	 *
3624
	 * @return array of log events || WP_Error for invalid params
3625
	 */
3626
	public static function get_log( $event = false, $num = false ) {
3627
		if ( $event && ! is_string( $event ) ) {
3628
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with __('First param must be ...g or empty', 'jetpack').

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...
3629
		}
3630
3631
		if ( $num && ! is_numeric( $num ) ) {
3632
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with __('Second param must be...c or empty', 'jetpack').

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...
3633
		}
3634
3635
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3636
3637
		// If nothing set - act as it did before, otherwise let's start customizing the output
3638
		if ( ! $num && ! $event ) {
3639
			return $entire_log;
3640
		} else {
3641
			$entire_log = array_reverse( $entire_log );
3642
		}
3643
3644
		$custom_log_output = array();
3645
3646
		if ( $event ) {
3647
			foreach ( $entire_log as $log_event ) {
3648
				if ( $event == $log_event['code'] ) {
3649
					$custom_log_output[] = $log_event;
3650
				}
3651
			}
3652
		} else {
3653
			$custom_log_output = $entire_log;
3654
		}
3655
3656
		if ( $num ) {
3657
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3658
		}
3659
3660
		return $custom_log_output;
3661
	}
3662
3663
	/**
3664
	 * Log modification of important settings.
3665
	 */
3666
	public static function log_settings_change( $option, $old_value, $value ) {
3667
		switch ( $option ) {
3668
			case 'jetpack_sync_non_public_post_stati':
3669
				self::log( $option, $value );
3670
				break;
3671
		}
3672
	}
3673
3674
	/**
3675
	 * Return stat data for WPCOM sync
3676
	 */
3677
	public static function get_stat_data( $encode = true, $extended = true ) {
3678
		$data = Jetpack_Heartbeat::generate_stats_array();
3679
3680
		if ( $extended ) {
3681
			$additional_data = self::get_additional_stat_data();
3682
			$data            = array_merge( $data, $additional_data );
3683
		}
3684
3685
		if ( $encode ) {
3686
			return json_encode( $data );
3687
		}
3688
3689
		return $data;
3690
	}
3691
3692
	/**
3693
	 * Get additional stat data to sync to WPCOM
3694
	 */
3695
	public static function get_additional_stat_data( $prefix = '' ) {
3696
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

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

Let’s take a look at an example:

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

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

    // do something with $myArray
}

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

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

Loading history...
3697
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3698
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3699
		$return[ "{$prefix}site-count" ]    = 0;
3700
3701
		if ( function_exists( 'get_blog_count' ) ) {
3702
			$return[ "{$prefix}site-count" ] = get_blog_count();
3703
		}
3704
		return $return;
3705
	}
3706
3707
	private static function get_site_user_count() {
3708
		global $wpdb;
3709
3710
		if ( function_exists( 'wp_is_large_network' ) ) {
3711
			if ( wp_is_large_network( 'users' ) ) {
3712
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3713
			}
3714
		}
3715
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3716
			// It wasn't there, so regenerate the data and save the transient
3717
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3718
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3719
		}
3720
		return $user_count;
3721
	}
3722
3723
	/* Admin Pages */
3724
3725
	function admin_init() {
3726
		// If the plugin is not connected, display a connect message.
3727
		if (
3728
			// the plugin was auto-activated and needs its candy
3729
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3730
		||
3731
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3732
			! Jetpack_Options::get_option( 'activated' )
3733
		) {
3734
			self::plugin_initialize();
3735
		}
3736
3737
		$is_development_mode = ( new Status() )->is_development_mode();
3738
		if ( ! self::is_active() && ! $is_development_mode ) {
3739
			Jetpack_Connection_Banner::init();
3740
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3741
			// Upgrade: 1.1 -> 1.1.1
3742
			// Check and see if host can verify the Jetpack servers' SSL certificate
3743
			$args       = array();
3744
			$connection = self::connection();
3745
			Client::_wp_remote_request(
3746
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3747
				$args,
3748
				true
3749
			);
3750
		}
3751
3752
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3753
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3754
		}
3755
3756
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3757
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3758
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3759
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3760
3761
		if ( self::is_active() || $is_development_mode ) {
3762
			// Artificially throw errors in certain whitelisted cases during plugin activation
3763
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3764
		}
3765
3766
		// Add custom column in wp-admin/users.php to show whether user is linked.
3767
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3768
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3769
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3770
	}
3771
3772
	function admin_body_class( $admin_body_class = '' ) {
3773
		$classes = explode( ' ', trim( $admin_body_class ) );
3774
3775
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3776
3777
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3778
		return " $admin_body_class ";
3779
	}
3780
3781
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3782
		return $admin_body_class . ' jetpack-pagestyles ';
3783
	}
3784
3785
	/**
3786
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3787
	 * This function artificially throws errors for such cases (whitelisted).
3788
	 *
3789
	 * @param string $plugin The activated plugin.
3790
	 */
3791
	function throw_error_on_activate_plugin( $plugin ) {
3792
		$active_modules = self::get_active_modules();
3793
3794
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3795
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3796
			$throw = false;
3797
3798
			// Try and make sure it really was the stats plugin
3799
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3800
				if ( 'stats.php' == basename( $plugin ) ) {
3801
					$throw = true;
3802
				}
3803
			} else {
3804
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3805
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3806
					$throw = true;
3807
				}
3808
			}
3809
3810
			if ( $throw ) {
3811
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3812
			}
3813
		}
3814
	}
3815
3816
	function intercept_plugin_error_scrape_init() {
3817
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3818
	}
3819
3820
	function intercept_plugin_error_scrape( $action, $result ) {
3821
		if ( ! $result ) {
3822
			return;
3823
		}
3824
3825
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3826
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3827
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3828
			}
3829
		}
3830
	}
3831
3832
	/**
3833
	 * Register the remote file upload request handlers, if needed.
3834
	 *
3835
	 * @access public
3836
	 */
3837
	public function add_remote_request_handlers() {
3838
		// Remote file uploads are allowed only via AJAX requests.
3839
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3840
			return;
3841
		}
3842
3843
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3844
		$remote_request_actions = array(
3845
			'jetpack_upload_file',
3846
			'jetpack_update_file',
3847
		);
3848
3849
		// phpcs:ignore WordPress.Security.NonceVerification
3850
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3851
			return;
3852
		}
3853
3854
		// Require Jetpack authentication for the remote file upload AJAX requests.
3855
		if ( ! $this->connection_manager ) {
3856
			$this->connection_manager = new Connection_Manager();
3857
		}
3858
3859
		$this->connection_manager->require_jetpack_authentication();
3860
3861
		// Register the remote file upload AJAX handlers.
3862
		foreach ( $remote_request_actions as $action ) {
3863
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3864
		}
3865
	}
3866
3867
	/**
3868
	 * Handler for Jetpack remote file uploads.
3869
	 *
3870
	 * @access public
3871
	 */
3872
	public function remote_request_handlers() {
3873
		$action = current_filter();
0 ignored issues
show
$action is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
3874
3875
		switch ( current_filter() ) {
3876
			case 'wp_ajax_nopriv_jetpack_upload_file':
3877
				$response = $this->upload_handler();
3878
				break;
3879
3880
			case 'wp_ajax_nopriv_jetpack_update_file':
3881
				$response = $this->upload_handler( true );
3882
				break;
3883
			default:
3884
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_handler'.

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...
3885
				break;
3886
		}
3887
3888
		if ( ! $response ) {
3889
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_error'.

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...
3890
		}
3891
3892
		if ( is_wp_error( $response ) ) {
3893
			$status_code       = $response->get_error_data();
0 ignored issues
show
The method get_error_data() does not seem to exist on object<Jetpack_Error>.

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

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

Loading history...
3894
			$error             = $response->get_error_code();
0 ignored issues
show
The method get_error_code() does not seem to exist on object<Jetpack_Error>.

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

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

Loading history...
3895
			$error_description = $response->get_error_message();
0 ignored issues
show
The method get_error_message() does not seem to exist on object<Jetpack_Error>.

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

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

Loading history...
3896
3897
			if ( ! is_int( $status_code ) ) {
3898
				$status_code = 400;
3899
			}
3900
3901
			status_header( $status_code );
3902
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3903
		}
3904
3905
		status_header( 200 );
3906
		if ( true === $response ) {
3907
			exit;
3908
		}
3909
3910
		die( json_encode( (object) $response ) );
3911
	}
3912
3913
	/**
3914
	 * Uploads a file gotten from the global $_FILES.
3915
	 * If `$update_media_item` is true and `post_id` is defined
3916
	 * the attachment file of the media item (gotten through of the post_id)
3917
	 * will be updated instead of add a new one.
3918
	 *
3919
	 * @param  boolean $update_media_item - update media attachment
3920
	 * @return array - An array describing the uploadind files process
3921
	 */
3922
	function upload_handler( $update_media_item = false ) {
3923
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3924
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 405.

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...
3925
		}
3926
3927
		$user = wp_authenticate( '', '' );
3928
		if ( ! $user || is_wp_error( $user ) ) {
3929
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 403.

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...
3930
		}
3931
3932
		wp_set_current_user( $user->ID );
3933
3934
		if ( ! current_user_can( 'upload_files' ) ) {
3935
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

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...
3936
		}
3937
3938
		if ( empty( $_FILES ) ) {
3939
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'no_files_uploaded'.

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...
3940
		}
3941
3942
		foreach ( array_keys( $_FILES ) as $files_key ) {
3943
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3944
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'missing_hmac'.

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...
3945
			}
3946
		}
3947
3948
		$media_keys = array_keys( $_FILES['media'] );
3949
3950
		$token = Jetpack_Data::get_access_token( get_current_user_id() );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
3951
		if ( ! $token || is_wp_error( $token ) ) {
3952
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_token'.

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...
3953
		}
3954
3955
		$uploaded_files = array();
3956
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3957
		unset( $GLOBALS['post'] );
3958
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3959
			$file = array();
3960
			foreach ( $media_keys as $media_key ) {
3961
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3962
			}
3963
3964
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3965
3966
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3967
			if ( $hmac_provided !== $hmac_file ) {
3968
				$uploaded_files[ $index ] = (object) array(
3969
					'error'             => 'invalid_hmac',
3970
					'error_description' => 'The corresponding HMAC for this file does not match',
3971
				);
3972
				continue;
3973
			}
3974
3975
			$_FILES['.jetpack.upload.'] = $file;
3976
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3977
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3978
				$post_id = 0;
3979
			}
3980
3981
			if ( $update_media_item ) {
3982
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3983
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'invalid_input'.

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...
3984
				}
3985
3986
				$media_array = $_FILES['media'];
3987
3988
				$file_array['name']     = $media_array['name'][0];
0 ignored issues
show
Coding Style Comprehensibility introduced by
$file_array was never initialized. Although not strictly required by PHP, it is generally a good practice to add $file_array = array(); before regardless.

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

Let’s take a look at an example:

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

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

    // do something with $myArray
}

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

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

Loading history...
3989
				$file_array['type']     = $media_array['type'][0];
3990
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3991
				$file_array['error']    = $media_array['error'][0];
3992
				$file_array['size']     = $media_array['size'][0];
3993
3994
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3995
3996
				if ( is_wp_error( $edited_media_item ) ) {
3997
					return $edited_media_item;
3998
				}
3999
4000
				$response = (object) array(
4001
					'id'   => (string) $post_id,
4002
					'file' => (string) $edited_media_item->post_title,
4003
					'url'  => (string) wp_get_attachment_url( $post_id ),
4004
					'type' => (string) $edited_media_item->post_mime_type,
4005
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
4006
				);
4007
4008
				return (array) array( $response );
4009
			}
4010
4011
			$attachment_id = media_handle_upload(
4012
				'.jetpack.upload.',
4013
				$post_id,
4014
				array(),
4015
				array(
4016
					'action' => 'jetpack_upload_file',
4017
				)
4018
			);
4019
4020
			if ( ! $attachment_id ) {
4021
				$uploaded_files[ $index ] = (object) array(
4022
					'error'             => 'unknown',
4023
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
4024
				);
4025
			} elseif ( is_wp_error( $attachment_id ) ) {
4026
				$uploaded_files[ $index ] = (object) array(
4027
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
4028
					'error_description' => $attachment_id->get_error_message(),
4029
				);
4030
			} else {
4031
				$attachment               = get_post( $attachment_id );
4032
				$uploaded_files[ $index ] = (object) array(
4033
					'id'   => (string) $attachment_id,
4034
					'file' => $attachment->post_title,
4035
					'url'  => wp_get_attachment_url( $attachment_id ),
4036
					'type' => $attachment->post_mime_type,
4037
					'meta' => wp_get_attachment_metadata( $attachment_id ),
4038
				);
4039
				// Zip files uploads are not supported unless they are done for installation purposed
4040
				// lets delete them in case something goes wrong in this whole process
4041
				if ( 'application/zip' === $attachment->post_mime_type ) {
4042
					// Schedule a cleanup for 2 hours from now in case of failed install.
4043
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
4044
				}
4045
			}
4046
		}
4047
		if ( ! is_null( $global_post ) ) {
4048
			$GLOBALS['post'] = $global_post;
4049
		}
4050
4051
		return $uploaded_files;
4052
	}
4053
4054
	/**
4055
	 * Add help to the Jetpack page
4056
	 *
4057
	 * @since Jetpack (1.2.3)
4058
	 * @return false if not the Jetpack page
4059
	 */
4060
	function admin_help() {
4061
		$current_screen = get_current_screen();
4062
4063
		// Overview
4064
		$current_screen->add_help_tab(
4065
			array(
4066
				'id'      => 'home',
4067
				'title'   => __( 'Home', 'jetpack' ),
4068
				'content' =>
4069
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4070
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
4071
					'<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>',
4072
			)
4073
		);
4074
4075
		// Screen Content
4076
		if ( current_user_can( 'manage_options' ) ) {
4077
			$current_screen->add_help_tab(
4078
				array(
4079
					'id'      => 'settings',
4080
					'title'   => __( 'Settings', 'jetpack' ),
4081
					'content' =>
4082
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4083
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
4084
						'<ol>' .
4085
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
4086
							'<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>' .
4087
						'</ol>' .
4088
						'<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>',
4089
				)
4090
			);
4091
		}
4092
4093
		// Help Sidebar
4094
		$support_url = Redirect::get_url( 'jetpack-support' );
4095
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
4096
		$current_screen->set_help_sidebar(
4097
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
4098
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
4099
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
4100
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
4101
		);
4102
	}
4103
4104
	function admin_menu_css() {
4105
		wp_enqueue_style( 'jetpack-icons' );
4106
	}
4107
4108
	function admin_menu_order() {
4109
		return true;
4110
	}
4111
4112 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
4113
		$jp_menu_order = array();
4114
4115
		foreach ( $menu_order as $index => $item ) {
4116
			if ( $item != 'jetpack' ) {
4117
				$jp_menu_order[] = $item;
4118
			}
4119
4120
			if ( $index == 0 ) {
4121
				$jp_menu_order[] = 'jetpack';
4122
			}
4123
		}
4124
4125
		return $jp_menu_order;
4126
	}
4127
4128
	function admin_banner_styles() {
4129
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4130
4131 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4132
			wp_register_style(
4133
				'jetpack-dops-style',
4134
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4135
				array(),
4136
				JETPACK__VERSION
4137
			);
4138
		}
4139
4140
		wp_enqueue_style(
4141
			'jetpack',
4142
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4143
			array( 'jetpack-dops-style' ),
4144
			JETPACK__VERSION . '-20121016'
4145
		);
4146
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4147
		wp_style_add_data( 'jetpack', 'suffix', $min );
4148
	}
4149
4150
	function plugin_action_links( $actions ) {
4151
4152
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4153
4154
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4155
			return array_merge(
4156
				$jetpack_home,
4157
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4158
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4159
				$actions
4160
			);
4161
		}
4162
4163
		return array_merge( $jetpack_home, $actions );
4164
	}
4165
4166
	/**
4167
	 * Adds the deactivation warning modal if there are other active plugins using the connection
4168
	 *
4169
	 * @return void
4170
	 */
4171
	public function deactivate_dialog() {
4172
		global $pagenow;
4173
		if ( 'plugins.php' === $pagenow && self::is_active() ) {
4174
4175
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4176
4177
			if ( count( $active_plugins_using_connection ) > 1 ) {
4178
4179
				add_thickbox();
4180
				wp_enqueue_script(
4181
					'jetpack-deactivate-dialog-js',
4182
					Assets::get_file_url_for_environment(
4183
						'_inc/build/jetpack-deactivate-dialog.min.js',
4184
						'_inc/jetpack-deactivate-dialog.js'
4185
					),
4186
					array( 'jquery' ),
4187
					JETPACK__VERSION,
4188
					true
4189
				);
4190
4191
				wp_localize_script(
4192
					'jetpack-deactivate-dialog-js',
4193
					'deactivate_dialog',
4194
					array(
4195
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4196
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4197
					)
4198
				);
4199
4200
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4201
4202
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4203
			}
4204
		}
4205
	}
4206
4207
	/**
4208
	 * Outputs the content of the deactivation modal
4209
	 *
4210
	 * @return void
4211
	 */
4212
	public function deactivate_dialog_content() {
4213
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4214
		unset( $active_plugins_using_connection['jetpack'] );
4215
		$this->load_view( 'admin/deactivation-dialog.php', $active_plugins_using_connection );
0 ignored issues
show
It seems like $active_plugins_using_connection defined by \Automattic\Jetpack\Conn...ugin_Storage::get_all() on line 4213 can also be of type object<WP_Error>; however, Jetpack::load_view() does only seem to accept array, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
4216
	}
4217
4218
	/**
4219
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4220
	 *
4221
	 * @param string $login_url The wp-login URL.
4222
	 * @param string $redirect  URL to redirect users after logging in.
4223
	 * @since Jetpack 8.4
4224
	 * @return string
4225
	 */
4226
	public function login_url( $login_url, $redirect ) {
4227
		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...
4228
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4229
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4230
		}
4231
		return $login_url;
4232
	}
4233
4234
	/**
4235
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4236
	 *
4237
	 * @since Jetpack 8.4
4238
	 */
4239
	public function login_init() {
4240
		// phpcs:ignore WordPress.Security.NonceVerification
4241
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4242
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4243
			wp_safe_redirect(
4244
				add_query_arg(
4245
					array(
4246
						'forceInstall' => 1,
4247
						'url'          => rawurlencode( get_site_url() ),
4248
					),
4249
					// @todo provide way to go to specific calypso env.
4250
					self::get_calypso_host() . 'jetpack/connect'
4251
				)
4252
			);
4253
			exit;
4254
		}
4255
	}
4256
4257
	/*
4258
	 * Registration flow:
4259
	 * 1 - ::admin_page_load() action=register
4260
	 * 2 - ::try_registration()
4261
	 * 3 - ::register()
4262
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4263
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4264
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4265
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4266
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4267
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4268
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4269
	 *       jetpack_id, jetpack_secret, jetpack_public
4270
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4271
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4272
	 * 5 - user logs in with WP.com account
4273
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4274
	 *		- Manager::authorize()
4275
	 *		- Manager::get_token()
4276
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4277
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4278
	 *			- which responds with access_token, token_type, scope
4279
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4280
	 *		- Jetpack::activate_default_modules()
4281
	 *     		- Deactivates deprecated plugins
4282
	 *     		- Activates all default modules
4283
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4284
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4285
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4286
	 *     Done!
4287
	 */
4288
4289
	/**
4290
	 * Handles the page load events for the Jetpack admin page
4291
	 */
4292
	function admin_page_load() {
4293
		$error = false;
4294
4295
		// Make sure we have the right body class to hook stylings for subpages off of.
4296
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4297
4298
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4299
			// Should only be used in intermediate redirects to preserve state across redirects
4300
			self::restate();
4301
		}
4302
4303
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4304
			// @todo: Add validation against a known whitelist
4305
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4306
			// User clicked in the iframe to link their accounts
4307
			if ( ! self::is_user_connected() ) {
4308
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4309
4310
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4311
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4312
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4313
4314
				if ( isset( $_GET['notes_iframe'] ) ) {
4315
					$connect_url .= '&notes_iframe';
4316
				}
4317
				wp_redirect( $connect_url );
4318
				exit;
4319
			} else {
4320
				if ( ! isset( $_GET['calypso_env'] ) ) {
4321
					self::state( 'message', 'already_authorized' );
4322
					wp_safe_redirect( self::admin_url() );
4323
					exit;
4324
				} else {
4325
					$connect_url  = $this->build_connect_url( true, false, $from );
4326
					$connect_url .= '&already_authorized=true';
4327
					wp_redirect( $connect_url );
4328
					exit;
4329
				}
4330
			}
4331
		}
4332
4333
		if ( isset( $_GET['action'] ) ) {
4334
			switch ( $_GET['action'] ) {
4335
				case 'authorize':
4336
					if ( self::is_active() && self::is_user_connected() ) {
4337
						self::state( 'message', 'already_authorized' );
4338
						wp_safe_redirect( self::admin_url() );
4339
						exit;
4340
					}
4341
					self::log( 'authorize' );
4342
					$client_server = new Jetpack_Client_Server();
4343
					$client_server->client_authorize();
4344
					exit;
4345
				case 'register':
4346
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4347
						$error = 'cheatin';
4348
						break;
4349
					}
4350
					check_admin_referer( 'jetpack-register' );
4351
					self::log( 'register' );
4352
					self::maybe_set_version_option();
4353
					$registered = self::try_registration();
4354 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4355
						$error = $registered->get_error_code();
0 ignored issues
show
The method get_error_code() does not seem to exist on object<WP_Error>.

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

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

Loading history...
4356
						self::state( 'error', $error );
4357
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
The method get_error_message() does not seem to exist on object<WP_Error>.

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

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

Loading history...
4358
4359
						/**
4360
						 * Jetpack registration Error.
4361
						 *
4362
						 * @since 7.5.0
4363
						 *
4364
						 * @param string|int $error The error code.
4365
						 * @param \WP_Error $registered The error object.
4366
						 */
4367
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4368
						break;
4369
					}
4370
4371
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4372
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4373
4374
					/**
4375
					 * Jetpack registration Success.
4376
					 *
4377
					 * @since 7.5.0
4378
					 *
4379
					 * @param string $from 'from' GET parameter;
4380
					 */
4381
					do_action( 'jetpack_connection_register_success', $from );
4382
4383
					$url = $this->build_connect_url( true, $redirect, $from );
4384
4385
					if ( ! empty( $_GET['onboarding'] ) ) {
4386
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4387
					}
4388
4389
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4390
						$url = add_query_arg( 'auth_approved', 'true', $url );
4391
					}
4392
4393
					wp_redirect( $url );
4394
					exit;
4395
				case 'activate':
4396
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4397
						$error = 'cheatin';
4398
						break;
4399
					}
4400
4401
					$module = stripslashes( $_GET['module'] );
4402
					check_admin_referer( "jetpack_activate-$module" );
4403
					self::log( 'activate', $module );
4404
					if ( ! self::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression self::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4405
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4406
					}
4407
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4408
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4409
					exit;
4410
				case 'activate_default_modules':
4411
					check_admin_referer( 'activate_default_modules' );
4412
					self::log( 'activate_default_modules' );
4413
					self::restate();
4414
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4415
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4416
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4417
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4418
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4419
					exit;
4420
				case 'disconnect':
4421
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4422
						$error = 'cheatin';
4423
						break;
4424
					}
4425
4426
					check_admin_referer( 'jetpack-disconnect' );
4427
					self::log( 'disconnect' );
4428
					self::disconnect();
4429
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4430
					exit;
4431
				case 'reconnect':
4432
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4433
						$error = 'cheatin';
4434
						break;
4435
					}
4436
4437
					check_admin_referer( 'jetpack-reconnect' );
4438
					self::log( 'reconnect' );
4439
					$this->disconnect();
4440
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4441
					exit;
4442 View Code Duplication
				case 'deactivate':
4443
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4444
						$error = 'cheatin';
4445
						break;
4446
					}
4447
4448
					$modules = stripslashes( $_GET['module'] );
4449
					check_admin_referer( "jetpack_deactivate-$modules" );
4450
					foreach ( explode( ',', $modules ) as $module ) {
4451
						self::log( 'deactivate', $module );
4452
						self::deactivate_module( $module );
4453
						self::state( 'message', 'module_deactivated' );
4454
					}
4455
					self::state( 'module', $modules );
4456
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4457
					exit;
4458
				case 'unlink':
4459
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4460
					check_admin_referer( 'jetpack-unlink' );
4461
					self::log( 'unlink' );
4462
					Connection_Manager::disconnect_user();
4463
					self::state( 'message', 'unlinked' );
4464
					if ( 'sub-unlink' == $redirect ) {
4465
						wp_safe_redirect( admin_url() );
4466
					} else {
4467
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4468
					}
4469
					exit;
4470
				case 'onboard':
4471
					if ( ! current_user_can( 'manage_options' ) ) {
4472
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4473
					} else {
4474
						self::create_onboarding_token();
4475
						$url = $this->build_connect_url( true );
4476
4477
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4478
							$url = add_query_arg( 'onboarding', $token, $url );
4479
						}
4480
4481
						$calypso_env = $this->get_calypso_env();
4482
						if ( ! empty( $calypso_env ) ) {
4483
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4484
						}
4485
4486
						wp_redirect( $url );
4487
						exit;
4488
					}
4489
					exit;
4490
				default:
4491
					/**
4492
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4493
					 *
4494
					 * @since 2.6.0
4495
					 *
4496
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4497
					 */
4498
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4499
			}
4500
		}
4501
4502
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4503
			self::activate_new_modules( true );
4504
		}
4505
4506
		$message_code = self::state( 'message' );
4507
		if ( self::state( 'optin-manage' ) ) {
4508
			$activated_manage = $message_code;
4509
			$message_code     = 'jetpack-manage';
4510
		}
4511
4512
		switch ( $message_code ) {
4513
			case 'jetpack-manage':
4514
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4515
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4516
				$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>';
4517
				if ( $activated_manage ) {
0 ignored issues
show
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4518
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4519
				}
4520
				break;
4521
4522
		}
4523
4524
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4525
4526
		if ( ! empty( $deactivated_plugins ) ) {
4527
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4528
			$deactivated_titles  = array();
4529
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4530
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4531
					continue;
4532
				}
4533
4534
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4535
			}
4536
4537
			if ( $deactivated_titles ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated_titles of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
4538
				if ( $this->message ) {
4539
					$this->message .= "<br /><br />\n";
4540
				}
4541
4542
				$this->message .= wp_sprintf(
4543
					_n(
4544
						'Jetpack contains the most recent version of the old %l plugin.',
4545
						'Jetpack contains the most recent versions of the old %l plugins.',
4546
						count( $deactivated_titles ),
4547
						'jetpack'
4548
					),
4549
					$deactivated_titles
4550
				);
4551
4552
				$this->message .= "<br />\n";
4553
4554
				$this->message .= _n(
4555
					'The old version has been deactivated and can be removed from your site.',
4556
					'The old versions have been deactivated and can be removed from your site.',
4557
					count( $deactivated_titles ),
4558
					'jetpack'
4559
				);
4560
			}
4561
		}
4562
4563
		$this->privacy_checks = self::state( 'privacy_checks' );
4564
4565
		if ( $this->message || $this->error || $this->privacy_checks ) {
4566
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4567
		}
4568
4569
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4570
	}
4571
4572
	function admin_notices() {
4573
4574
		if ( $this->error ) {
4575
			?>
4576
<div id="message" class="jetpack-message jetpack-err">
4577
	<div class="squeezer">
4578
		<h2>
4579
			<?php
4580
			echo wp_kses(
4581
				$this->error,
4582
				array(
4583
					'a'      => array( 'href' => array() ),
4584
					'small'  => true,
4585
					'code'   => true,
4586
					'strong' => true,
4587
					'br'     => true,
4588
					'b'      => true,
4589
				)
4590
			);
4591
			?>
4592
			</h2>
4593
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4594
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4595
<?php	endif; ?>
4596
	</div>
4597
</div>
4598
			<?php
4599
		}
4600
4601
		if ( $this->message ) {
4602
			?>
4603
<div id="message" class="jetpack-message">
4604
	<div class="squeezer">
4605
		<h2>
4606
			<?php
4607
			echo wp_kses(
4608
				$this->message,
4609
				array(
4610
					'strong' => array(),
4611
					'a'      => array( 'href' => true ),
4612
					'br'     => true,
4613
				)
4614
			);
4615
			?>
4616
			</h2>
4617
	</div>
4618
</div>
4619
			<?php
4620
		}
4621
4622
		if ( $this->privacy_checks ) :
4623
			$module_names = $module_slugs = array();
4624
4625
			$privacy_checks = explode( ',', $this->privacy_checks );
4626
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4627
			foreach ( $privacy_checks as $module_slug ) {
4628
				$module = self::get_module( $module_slug );
4629
				if ( ! $module ) {
4630
					continue;
4631
				}
4632
4633
				$module_slugs[] = $module_slug;
4634
				$module_names[] = "<strong>{$module['name']}</strong>";
4635
			}
4636
4637
			$module_slugs = join( ',', $module_slugs );
4638
			?>
4639
<div id="message" class="jetpack-message jetpack-err">
4640
	<div class="squeezer">
4641
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4642
		<p>
4643
			<?php
4644
			echo wp_kses(
4645
				wptexturize(
4646
					wp_sprintf(
4647
						_nx(
4648
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4649
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4650
							count( $privacy_checks ),
4651
							'%l = list of Jetpack module/feature names',
4652
							'jetpack'
4653
						),
4654
						$module_names
4655
					)
4656
				),
4657
				array( 'strong' => true )
4658
			);
4659
4660
			echo "\n<br />\n";
4661
4662
			echo wp_kses(
4663
				sprintf(
4664
					_nx(
4665
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4666
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4667
						count( $privacy_checks ),
4668
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4669
						'jetpack'
4670
					),
4671
					wp_nonce_url(
4672
						self::admin_url(
4673
							array(
4674
								'page'   => 'jetpack',
4675
								'action' => 'deactivate',
4676
								'module' => urlencode( $module_slugs ),
4677
							)
4678
						),
4679
						"jetpack_deactivate-$module_slugs"
4680
					),
4681
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4682
				),
4683
				array(
4684
					'a' => array(
4685
						'href'  => true,
4686
						'title' => true,
4687
					),
4688
				)
4689
			);
4690
			?>
4691
		</p>
4692
	</div>
4693
</div>
4694
			<?php
4695
endif;
4696
	}
4697
4698
	/**
4699
	 * We can't always respond to a signed XML-RPC request with a
4700
	 * helpful error message. In some circumstances, doing so could
4701
	 * leak information.
4702
	 *
4703
	 * Instead, track that the error occurred via a Jetpack_Option,
4704
	 * and send that data back in the heartbeat.
4705
	 * All this does is increment a number, but it's enough to find
4706
	 * trends.
4707
	 *
4708
	 * @param WP_Error $xmlrpc_error The error produced during
4709
	 *                               signature validation.
4710
	 */
4711
	function track_xmlrpc_error( $xmlrpc_error ) {
4712
		$code = is_wp_error( $xmlrpc_error )
4713
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
The method get_error_code() does not seem to exist on object<WP_Error>.

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

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

Loading history...
4714
			: 'should-not-happen';
4715
4716
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4717
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4718
			// No need to update the option if we already have
4719
			// this code stored.
4720
			return;
4721
		}
4722
		$xmlrpc_errors[ $code ] = true;
4723
4724
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
false is of type boolean, 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...
4725
	}
4726
4727
	/**
4728
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4729
	 */
4730
	function stat( $group, $detail ) {
4731
		if ( ! isset( $this->stats[ $group ] ) ) {
4732
			$this->stats[ $group ] = array();
4733
		}
4734
		$this->stats[ $group ][] = $detail;
4735
	}
4736
4737
	/**
4738
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4739
	 */
4740
	function do_stats( $method = '' ) {
4741
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4742
			foreach ( $this->stats as $group => $stats ) {
4743
				if ( is_array( $stats ) && count( $stats ) ) {
4744
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4745
					if ( 'server_side' === $method ) {
4746
						self::do_server_side_stat( $args );
4747
					} else {
4748
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4749
					}
4750
				}
4751
				unset( $this->stats[ $group ] );
4752
			}
4753
		}
4754
	}
4755
4756
	/**
4757
	 * Runs stats code for a one-off, server-side.
4758
	 *
4759
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4760
	 *
4761
	 * @return bool If it worked.
4762
	 */
4763
	static function do_server_side_stat( $args ) {
4764
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4765
		if ( is_wp_error( $response ) ) {
4766
			return false;
4767
		}
4768
4769
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4770
			return false;
4771
		}
4772
4773
		return true;
4774
	}
4775
4776
	/**
4777
	 * Builds the stats url.
4778
	 *
4779
	 * @param $args array|string The arguments to append to the URL.
4780
	 *
4781
	 * @return string The URL to be pinged.
4782
	 */
4783
	static function build_stats_url( $args ) {
4784
		$defaults = array(
4785
			'v'    => 'wpcom2',
4786
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4787
		);
4788
		$args     = wp_parse_args( $args, $defaults );
0 ignored issues
show
$defaults is of type array<string,string,{"v"...ring","rand":"string"}>, 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...
4789
		/**
4790
		 * Filter the URL used as the Stats tracking pixel.
4791
		 *
4792
		 * @since 2.3.2
4793
		 *
4794
		 * @param string $url Base URL used as the Stats tracking pixel.
4795
		 */
4796
		$base_url = apply_filters(
4797
			'jetpack_stats_base_url',
4798
			'https://pixel.wp.com/g.gif'
4799
		);
4800
		$url      = add_query_arg( $args, $base_url );
4801
		return $url;
4802
	}
4803
4804
	/**
4805
	 * Get the role of the current user.
4806
	 *
4807
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4808
	 *
4809
	 * @access public
4810
	 * @static
4811
	 *
4812
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4813
	 */
4814
	public static function translate_current_user_to_role() {
4815
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4816
4817
		$roles = new Roles();
4818
		return $roles->translate_current_user_to_role();
4819
	}
4820
4821
	/**
4822
	 * Get the role of a particular user.
4823
	 *
4824
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4825
	 *
4826
	 * @access public
4827
	 * @static
4828
	 *
4829
	 * @param \WP_User $user User object.
4830
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4831
	 */
4832
	public static function translate_user_to_role( $user ) {
4833
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4834
4835
		$roles = new Roles();
4836
		return $roles->translate_user_to_role( $user );
4837
	}
4838
4839
	/**
4840
	 * Get the minimum capability for a role.
4841
	 *
4842
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4843
	 *
4844
	 * @access public
4845
	 * @static
4846
	 *
4847
	 * @param string $role Role name.
4848
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4849
	 */
4850
	public static function translate_role_to_cap( $role ) {
4851
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4852
4853
		$roles = new Roles();
4854
		return $roles->translate_role_to_cap( $role );
4855
	}
4856
4857
	/**
4858
	 * Sign a user role with the master access token.
4859
	 * If not specified, will default to the current user.
4860
	 *
4861
	 * @deprecated since 7.7
4862
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4863
	 *
4864
	 * @access public
4865
	 * @static
4866
	 *
4867
	 * @param string $role    User role.
4868
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Should the type for parameter $user_id not be integer|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
4869
	 * @return string Signed user role.
4870
	 */
4871
	public static function sign_role( $role, $user_id = null ) {
4872
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4873
		return self::connection()->sign_role( $role, $user_id );
4874
	}
4875
4876
	/**
4877
	 * Builds a URL to the Jetpack connection auth page
4878
	 *
4879
	 * @since 3.9.5
4880
	 *
4881
	 * @param bool        $raw If true, URL will not be escaped.
4882
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4883
	 *                              If string, will be a custom redirect.
4884
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4885
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4886
	 *
4887
	 * @return string Connect URL
4888
	 */
4889
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4890
		$site_id    = Jetpack_Options::get_option( 'id' );
4891
		$blog_token = Jetpack_Data::get_access_token();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
4892
4893
		if ( $register || ! $blog_token || ! $site_id ) {
4894
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4895
4896
			if ( ! empty( $redirect ) ) {
4897
				$url = add_query_arg(
4898
					'redirect',
4899
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4900
					$url
4901
				);
4902
			}
4903
4904
			if ( is_network_admin() ) {
4905
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4906
			}
4907
4908
			$calypso_env = self::get_calypso_env();
4909
4910
			if ( ! empty( $calypso_env ) ) {
4911
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4912
			}
4913
		} else {
4914
4915
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4916
			// because otherwise this logic can get us in to a loop.
4917
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4918
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4919
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4920
4921
				$response = Client::wpcom_json_api_request_as_blog(
4922
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4923
					'1.1'
4924
				);
4925
4926
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4927
4928
					// Generating a register URL instead to refresh the existing token
4929
					return $this->build_connect_url( $raw, $redirect, $from, true );
4930
				}
4931
			}
4932
4933
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
It seems like $redirect defined by parameter $redirect on line 4889 can also be of type string; however, Jetpack::build_authorize_url() does only seem to accept boolean, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
4934
		}
4935
4936
		if ( $from ) {
4937
			$url = add_query_arg( 'from', $from, $url );
4938
		}
4939
4940
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4941
		/**
4942
		 * Filter the URL used when connecting a user to a WordPress.com account.
4943
		 *
4944
		 * @since 8.1.0
4945
		 *
4946
		 * @param string $url Connection URL.
4947
		 * @param bool   $raw If true, URL will not be escaped.
4948
		 */
4949
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4950
	}
4951
4952
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4953
4954
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4955
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4956
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4957
4958
		if ( $iframe ) {
4959
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4960
		}
4961
4962
		$c8n = self::connection();
4963
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
$redirect is of type boolean, 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...
4964
4965
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4966
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4967
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4968
4969
		if ( $iframe ) {
4970
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4971
		}
4972
4973
		return $url;
4974
	}
4975
4976
	/**
4977
	 * Filters the connection URL parameter array.
4978
	 *
4979
	 * @param array $args default URL parameters used by the package.
4980
	 * @return array the modified URL arguments array.
4981
	 */
4982
	public static function filter_connect_request_body( $args ) {
4983
		if (
4984
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4985
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4986
		) {
4987
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4988
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4989
				? $gp_locale->slug
4990
				: '';
4991
		}
4992
4993
		$tracking        = new Tracking();
4994
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4995
4996
		$args = array_merge(
4997
			$args,
4998
			array(
4999
				'_ui' => $tracks_identity['_ui'],
5000
				'_ut' => $tracks_identity['_ut'],
5001
			)
5002
		);
5003
5004
		$calypso_env = self::get_calypso_env();
5005
5006
		if ( ! empty( $calypso_env ) ) {
5007
			$args['calypso_env'] = $calypso_env;
5008
		}
5009
5010
		return $args;
5011
	}
5012
5013
	/**
5014
	 * Filters the URL that will process the connection data. It can be different from the URL
5015
	 * that we send the user to after everything is done.
5016
	 *
5017
	 * @param String $processing_url the default redirect URL used by the package.
5018
	 * @return String the modified URL.
5019
	 */
5020
	public static function filter_connect_processing_url( $processing_url ) {
5021
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
5022
		return $processing_url;
5023
	}
5024
5025
	/**
5026
	 * Filters the redirection URL that is used for connect requests. The redirect
5027
	 * URL should return the user back to the Jetpack console.
5028
	 *
5029
	 * @param String $redirect the default redirect URL used by the package.
5030
	 * @return String the modified URL.
5031
	 */
5032
	public static function filter_connect_redirect_url( $redirect ) {
5033
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
5034
		$redirect           = $redirect
5035
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
5036
			: $jetpack_admin_page;
5037
5038
		if ( isset( $_REQUEST['is_multisite'] ) ) {
5039
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
5040
		}
5041
5042
		return $redirect;
5043
	}
5044
5045
	/**
5046
	 * This action fires at the beginning of the Manager::authorize method.
5047
	 */
5048
	public static function authorize_starting() {
5049
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
5050
		// Checking if site has been active/connected previously before recording unique connection.
5051
		if ( ! $jetpack_unique_connection ) {
5052
			// jetpack_unique_connection option has never been set.
5053
			$jetpack_unique_connection = array(
5054
				'connected'    => 0,
5055
				'disconnected' => 0,
5056
				'version'      => '3.6.1',
5057
			);
5058
5059
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
5060
5061
			// Track unique connection.
5062
			$jetpack = self::init();
5063
5064
			$jetpack->stat( 'connections', 'unique-connection' );
5065
			$jetpack->do_stats( 'server_side' );
5066
		}
5067
5068
		// Increment number of times connected.
5069
		$jetpack_unique_connection['connected'] += 1;
5070
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
5071
	}
5072
5073
	/**
5074
	 * This action fires at the end of the Manager::authorize method when a secondary user is
5075
	 * linked.
5076
	 */
5077
	public static function authorize_ending_linked() {
5078
		// Don't activate anything since we are just connecting a user.
5079
		self::state( 'message', 'linked' );
5080
	}
5081
5082
	/**
5083
	 * This action fires at the end of the Manager::authorize method when the master user is
5084
	 * authorized.
5085
	 *
5086
	 * @param array $data The request data.
5087
	 */
5088
	public static function authorize_ending_authorized( $data ) {
5089
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
5090
		self::invalidate_onboarding_token();
5091
5092
		// If redirect_uri is SSO, ensure SSO module is enabled.
5093
		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...
5094
5095
		/** This filter is documented in class.jetpack-cli.php */
5096
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
5097
5098
		$activate_sso = (
5099
			isset( $redirect_options['action'] ) &&
5100
			'jetpack-sso' === $redirect_options['action'] &&
5101
			$jetpack_start_enable_sso
5102
		);
5103
5104
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
5105
5106
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
5107
	}
5108
5109
	/**
5110
	 * Get our assumed site creation date.
5111
	 * Calculated based on the earlier date of either:
5112
	 * - Earliest admin user registration date.
5113
	 * - Earliest date of post of any post type.
5114
	 *
5115
	 * @since 7.2.0
5116
	 * @deprecated since 7.8.0
5117
	 *
5118
	 * @return string Assumed site creation date and time.
5119
	 */
5120
	public static function get_assumed_site_creation_date() {
5121
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
5122
		return self::connection()->get_assumed_site_creation_date();
5123
	}
5124
5125 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
5126
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
5127
5128
		if ( $activation_source_name ) {
5129
			$args['_as'] = urlencode( $activation_source_name );
5130
		}
5131
5132
		if ( $activation_source_keyword ) {
5133
			$args['_ak'] = urlencode( $activation_source_keyword );
5134
		}
5135
	}
5136
5137
	function build_reconnect_url( $raw = false ) {
5138
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
5139
		return $raw ? $url : esc_url( $url );
5140
	}
5141
5142
	public static function admin_url( $args = null ) {
5143
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
0 ignored issues
show
array('page' => 'jetpack') is of type array<string,string,{"page":"string"}>, 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...
5144
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5145
		return $url;
5146
	}
5147
5148
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5149
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5150
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5151
	}
5152
5153
	function dismiss_jetpack_notice() {
5154
5155
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5156
			return;
5157
		}
5158
5159
		switch ( $_GET['jetpack-notice'] ) {
5160
			case 'dismiss':
5161
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5162
5163
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5164
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5165
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5166
				}
5167
				break;
5168
		}
5169
	}
5170
5171
	public static function sort_modules( $a, $b ) {
5172
		if ( $a['sort'] == $b['sort'] ) {
5173
			return 0;
5174
		}
5175
5176
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5177
	}
5178
5179
	function ajax_recheck_ssl() {
5180
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5181
		$result = self::permit_ssl( true );
5182
		wp_send_json(
5183
			array(
5184
				'enabled' => $result,
5185
				'message' => get_transient( 'jetpack_https_test_message' ),
5186
			)
5187
		);
5188
	}
5189
5190
	/* Client API */
5191
5192
	/**
5193
	 * Returns the requested Jetpack API URL
5194
	 *
5195
	 * @deprecated since 7.7
5196
	 * @return string
5197
	 */
5198
	public static function api_url( $relative_url ) {
5199
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5200
		$connection = self::connection();
5201
		return $connection->api_url( $relative_url );
5202
	}
5203
5204
	/**
5205
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5206
	 *
5207
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5208
	 */
5209
	public static function fix_url_for_bad_hosts( $url ) {
5210
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5211
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5212
	}
5213
5214
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5215
		// Default to a blog token.
5216
		$token_type = 'blog';
5217
5218
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5219
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5220
			if ( ! empty( $_GET['onboarding'] ) ) {
5221
				$jpo = $_GET;
5222
			} else {
5223
				$jpo = json_decode( $request_data, true );
5224
			}
5225
5226
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5227
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5228
5229
			if (
5230
				isset( $jpo_user )
5231
				&& isset( $jpo_token )
5232
				&& is_email( $jpo_user )
5233
				&& ctype_alnum( $jpo_token )
5234
				&& isset( $_GET['rest_route'] )
5235
				&& self::validate_onboarding_token_action(
5236
					$jpo_token,
5237
					$_GET['rest_route']
5238
				)
5239
			) {
5240
				$jp_user = get_user_by( 'email', $jpo_user );
5241
				if ( is_a( $jp_user, 'WP_User' ) ) {
5242
					wp_set_current_user( $jp_user->ID );
5243
					$user_can = is_multisite()
5244
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5245
						: current_user_can( 'manage_options' );
5246
					if ( $user_can ) {
5247
						$token_type              = 'user';
5248
						$token->external_user_id = $jp_user->ID;
5249
					}
5250
				}
5251
			}
5252
5253
			$token_data['type']    = $token_type;
5254
			$token_data['user_id'] = $token->external_user_id;
5255
		}
5256
5257
		return $token_data;
5258
	}
5259
5260
	/**
5261
	 * Create a random secret for validating onboarding payload
5262
	 *
5263
	 * @return string Secret token
5264
	 */
5265
	public static function create_onboarding_token() {
5266
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5267
			$token = wp_generate_password( 32, false );
5268
			Jetpack_Options::update_option( 'onboarding', $token );
5269
		}
5270
5271
		return $token;
5272
	}
5273
5274
	/**
5275
	 * Remove the onboarding token
5276
	 *
5277
	 * @return bool True on success, false on failure
5278
	 */
5279
	public static function invalidate_onboarding_token() {
5280
		return Jetpack_Options::delete_option( 'onboarding' );
5281
	}
5282
5283
	/**
5284
	 * Validate an onboarding token for a specific action
5285
	 *
5286
	 * @return boolean True if token/action pair is accepted, false if not
5287
	 */
5288
	public static function validate_onboarding_token_action( $token, $action ) {
5289
		// Compare tokens, bail if tokens do not match
5290
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5291
			return false;
5292
		}
5293
5294
		// List of valid actions we can take
5295
		$valid_actions = array(
5296
			'/jetpack/v4/settings',
5297
		);
5298
5299
		// Whitelist the action
5300
		if ( ! in_array( $action, $valid_actions ) ) {
5301
			return false;
5302
		}
5303
5304
		return true;
5305
	}
5306
5307
	/**
5308
	 * Checks to see if the URL is using SSL to connect with Jetpack
5309
	 *
5310
	 * @since 2.3.3
5311
	 * @return boolean
5312
	 */
5313
	public static function permit_ssl( $force_recheck = false ) {
5314
		// Do some fancy tests to see if ssl is being supported
5315
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5316
			$message = '';
5317
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5318
				$ssl = 0;
5319
			} else {
5320
				switch ( JETPACK_CLIENT__HTTPS ) {
5321
					case 'NEVER':
5322
						$ssl     = 0;
5323
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5324
						break;
5325
					case 'ALWAYS':
5326
					case 'AUTO':
5327
					default:
5328
						$ssl = 1;
5329
						break;
5330
				}
5331
5332
				// If it's not 'NEVER', test to see
5333
				if ( $ssl ) {
5334
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5335
						$ssl     = 0;
5336
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5337
					} else {
5338
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5339
						if ( is_wp_error( $response ) ) {
5340
							$ssl     = 0;
5341
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5342
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5343
							$ssl     = 0;
5344
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5345
						}
5346
					}
5347
				}
5348
			}
5349
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5350
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5351
		}
5352
5353
		return (bool) $ssl;
5354
	}
5355
5356
	/*
5357
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5358
	 */
5359
	public function alert_auto_ssl_fail() {
5360
		if ( ! current_user_can( 'manage_options' ) ) {
5361
			return;
5362
		}
5363
5364
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5365
		?>
5366
5367
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5368
			<div class="jp-banner__content">
5369
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5370
				<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>
5371
				<p>
5372
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5373
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5374
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5375
				</p>
5376
				<p>
5377
					<?php
5378
					printf(
5379
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5380
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5381
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5382
					);
5383
					?>
5384
				</p>
5385
			</div>
5386
		</div>
5387
		<style>
5388
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5389
		</style>
5390
		<script type="text/javascript">
5391
			jQuery( document ).ready( function( $ ) {
5392
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5393
					var $this = $( this );
5394
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5395
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5396
					e.preventDefault();
5397
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5398
					$.post( ajaxurl, data )
5399
					  .done( function( response ) {
5400
						  if ( response.enabled ) {
5401
							  $( '#jetpack-ssl-warning' ).hide();
5402
						  } else {
5403
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5404
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5405
						  }
5406
					  }.bind( $this ) );
5407
				} );
5408
			} );
5409
		</script>
5410
5411
		<?php
5412
	}
5413
5414
	/**
5415
	 * Returns the Jetpack XML-RPC API
5416
	 *
5417
	 * @deprecated 8.0 Use Connection_Manager instead.
5418
	 * @return string
5419
	 */
5420
	public static function xmlrpc_api_url() {
5421
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5422
		return self::connection()->xmlrpc_api_url();
5423
	}
5424
5425
	/**
5426
	 * Returns the connection manager object.
5427
	 *
5428
	 * @return Automattic\Jetpack\Connection\Manager
5429
	 */
5430
	public static function connection() {
5431
		$jetpack = static::init();
5432
5433
		// If the connection manager hasn't been instantiated, do that now.
5434
		if ( ! $jetpack->connection_manager ) {
5435
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5436
		}
5437
5438
		return $jetpack->connection_manager;
5439
	}
5440
5441
	/**
5442
	 * Creates two secret tokens and the end of life timestamp for them.
5443
	 *
5444
	 * Note these tokens are unique per call, NOT static per site for connecting.
5445
	 *
5446
	 * @since 2.6
5447
	 * @param String  $action  The action name.
5448
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Should the type for parameter $user_id not be false|integer?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5449
	 * @param Integer $exp     Expiration time in seconds.
5450
	 * @return array
5451
	 */
5452
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5453
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5454
	}
5455
5456
	public static function get_secrets( $action, $user_id ) {
5457
		$secrets = self::connection()->get_secrets( $action, $user_id );
5458
5459
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5460
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

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...
5461
		}
5462
5463
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5464
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

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...
5465
		}
5466
5467
		return $secrets;
5468
	}
5469
5470
	/**
5471
	 * @deprecated 7.5 Use Connection_Manager instead.
5472
	 *
5473
	 * @param $action
5474
	 * @param $user_id
5475
	 */
5476
	public static function delete_secrets( $action, $user_id ) {
5477
		return self::connection()->delete_secrets( $action, $user_id );
5478
	}
5479
5480
	/**
5481
	 * Builds the timeout limit for queries talking with the wpcom servers.
5482
	 *
5483
	 * Based on local php max_execution_time in php.ini
5484
	 *
5485
	 * @since 2.6
5486
	 * @return int
5487
	 * @deprecated
5488
	 **/
5489
	public function get_remote_query_timeout_limit() {
5490
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5491
		return self::get_max_execution_time();
5492
	}
5493
5494
	/**
5495
	 * Builds the timeout limit for queries talking with the wpcom servers.
5496
	 *
5497
	 * Based on local php max_execution_time in php.ini
5498
	 *
5499
	 * @since 5.4
5500
	 * @return int
5501
	 **/
5502
	public static function get_max_execution_time() {
5503
		$timeout = (int) ini_get( 'max_execution_time' );
5504
5505
		// Ensure exec time set in php.ini
5506
		if ( ! $timeout ) {
5507
			$timeout = 30;
5508
		}
5509
		return $timeout;
5510
	}
5511
5512
	/**
5513
	 * Sets a minimum request timeout, and returns the current timeout
5514
	 *
5515
	 * @since 5.4
5516
	 **/
5517 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5518
		$timeout = self::get_max_execution_time();
5519
		if ( $timeout < $min_timeout ) {
5520
			$timeout = $min_timeout;
5521
			set_time_limit( $timeout );
5522
		}
5523
		return $timeout;
5524
	}
5525
5526
	/**
5527
	 * Takes the response from the Jetpack register new site endpoint and
5528
	 * verifies it worked properly.
5529
	 *
5530
	 * @since 2.6
5531
	 * @deprecated since 7.7.0
5532
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5533
	 **/
5534
	public function validate_remote_register_response() {
5535
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5536
	}
5537
5538
	/**
5539
	 * @return bool|WP_Error
5540
	 */
5541
	public static function register() {
5542
		$tracking = new Tracking();
5543
		$tracking->record_user_event( 'jpc_register_begin' );
5544
5545
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5546
5547
		$connection   = self::connection();
5548
		$registration = $connection->register();
5549
5550
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5551
5552
		if ( ! $registration || is_wp_error( $registration ) ) {
5553
			return $registration;
5554
		}
5555
5556
		return true;
5557
	}
5558
5559
	/**
5560
	 * Filters the registration request body to include tracking properties.
5561
	 *
5562
	 * @param array $properties
5563
	 * @return array amended properties.
5564
	 */
5565 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5566
		$tracking        = new Tracking();
5567
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5568
5569
		return array_merge(
5570
			$properties,
5571
			array(
5572
				'_ui' => $tracks_identity['_ui'],
5573
				'_ut' => $tracks_identity['_ut'],
5574
			)
5575
		);
5576
	}
5577
5578
	/**
5579
	 * Filters the token request body to include tracking properties.
5580
	 *
5581
	 * @param array $properties
5582
	 * @return array amended properties.
5583
	 */
5584 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5585
		$tracking        = new Tracking();
5586
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5587
5588
		return array_merge(
5589
			$properties,
5590
			array(
5591
				'_ui' => $tracks_identity['_ui'],
5592
				'_ut' => $tracks_identity['_ut'],
5593
			)
5594
		);
5595
	}
5596
5597
	/**
5598
	 * If the db version is showing something other that what we've got now, bump it to current.
5599
	 *
5600
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
5601
	 */
5602
	public static function maybe_set_version_option() {
5603
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5604
		if ( JETPACK__VERSION != $version ) {
5605
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5606
5607
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5608
				/** This action is documented in class.jetpack.php */
5609
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5610
			}
5611
5612
			return true;
5613
		}
5614
		return false;
5615
	}
5616
5617
	/* Client Server API */
5618
5619
	/**
5620
	 * Loads the Jetpack XML-RPC client.
5621
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5622
	 *
5623
	 * @deprecated since 7.7.0
5624
	 */
5625
	public static function load_xml_rpc_client() {
5626
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5627
	}
5628
5629
	/**
5630
	 * Resets the saved authentication state in between testing requests.
5631
	 */
5632
	public function reset_saved_auth_state() {
5633
		$this->rest_authentication_status = null;
5634
5635
		if ( ! $this->connection_manager ) {
5636
			$this->connection_manager = new Connection_Manager();
5637
		}
5638
5639
		$this->connection_manager->reset_saved_auth_state();
5640
	}
5641
5642
	/**
5643
	 * Verifies the signature of the current request.
5644
	 *
5645
	 * @deprecated since 7.7.0
5646
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5647
	 *
5648
	 * @return false|array
5649
	 */
5650
	public function verify_xml_rpc_signature() {
5651
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5652
		return self::connection()->verify_xml_rpc_signature();
5653
	}
5654
5655
	/**
5656
	 * Verifies the signature of the current request.
5657
	 *
5658
	 * This function has side effects and should not be used. Instead,
5659
	 * use the memoized version `->verify_xml_rpc_signature()`.
5660
	 *
5661
	 * @deprecated since 7.7.0
5662
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5663
	 * @internal
5664
	 */
5665
	private function internal_verify_xml_rpc_signature() {
5666
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5667
	}
5668
5669
	/**
5670
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5671
	 *
5672
	 * @deprecated since 7.7.0
5673
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5674
	 *
5675
	 * @param \WP_User|mixed $user     User object if authenticated.
5676
	 * @param string         $username Username.
5677
	 * @param string         $password Password string.
5678
	 * @return \WP_User|mixed Authenticated user or error.
5679
	 */
5680 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5681
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5682
5683
		if ( ! $this->connection_manager ) {
5684
			$this->connection_manager = new Connection_Manager();
5685
		}
5686
5687
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5688
	}
5689
5690
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5691
	// Uses the existing XMLRPC request signing implementation.
5692
	function wp_rest_authenticate( $user ) {
5693
		if ( ! empty( $user ) ) {
5694
			// Another authentication method is in effect.
5695
			return $user;
5696
		}
5697
5698
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5699
			// Nothing to do for this authentication method.
5700
			return null;
5701
		}
5702
5703
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5704
			// Nothing to do for this authentication method.
5705
			return null;
5706
		}
5707
5708
		// Ensure that we always have the request body available.  At this
5709
		// point, the WP REST API code to determine the request body has not
5710
		// run yet.  That code may try to read from 'php://input' later, but
5711
		// this can only be done once per request in PHP versions prior to 5.6.
5712
		// So we will go ahead and perform this read now if needed, and save
5713
		// the request body where both the Jetpack signature verification code
5714
		// and the WP REST API code can see it.
5715
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5716
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5717
		}
5718
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5719
5720
		// Only support specific request parameters that have been tested and
5721
		// are known to work with signature verification.  A different method
5722
		// can be passed to the WP REST API via the '?_method=' parameter if
5723
		// needed.
5724
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5725
			$this->rest_authentication_status = new WP_Error(
5726
				'rest_invalid_request',
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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...
5727
				__( 'This request method is not supported.', 'jetpack' ),
5728
				array( 'status' => 400 )
5729
			);
5730
			return null;
5731
		}
5732
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5733
			$this->rest_authentication_status = new WP_Error(
5734
				'rest_invalid_request',
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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...
5735
				__( 'This request method does not support body parameters.', 'jetpack' ),
5736
				array( 'status' => 400 )
5737
			);
5738
			return null;
5739
		}
5740
5741
		if ( ! $this->connection_manager ) {
5742
			$this->connection_manager = new Connection_Manager();
5743
		}
5744
5745
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5746
5747
		if (
5748
			$verified &&
5749
			isset( $verified['type'] ) &&
5750
			'user' === $verified['type'] &&
5751
			! empty( $verified['user_id'] )
5752
		) {
5753
			// Authentication successful.
5754
			$this->rest_authentication_status = true;
5755
			return $verified['user_id'];
5756
		}
5757
5758
		// Something else went wrong.  Probably a signature error.
5759
		$this->rest_authentication_status = new WP_Error(
5760
			'rest_invalid_signature',
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_signature'.

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...
5761
			__( 'The request is not signed correctly.', 'jetpack' ),
5762
			array( 'status' => 400 )
5763
		);
5764
		return null;
5765
	}
5766
5767
	/**
5768
	 * Report authentication status to the WP REST API.
5769
	 *
5770
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
5771
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5772
	 */
5773
	public function wp_rest_authentication_errors( $value ) {
5774
		if ( $value !== null ) {
5775
			return $value;
5776
		}
5777
		return $this->rest_authentication_status;
5778
	}
5779
5780
	/**
5781
	 * Add our nonce to this request.
5782
	 *
5783
	 * @deprecated since 7.7.0
5784
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5785
	 *
5786
	 * @param int    $timestamp Timestamp of the request.
5787
	 * @param string $nonce     Nonce string.
5788
	 */
5789 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5790
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5791
5792
		if ( ! $this->connection_manager ) {
5793
			$this->connection_manager = new Connection_Manager();
5794
		}
5795
5796
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5797
	}
5798
5799
	/**
5800
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5801
	 * Capture it here so we can verify the signature later.
5802
	 *
5803
	 * @deprecated since 7.7.0
5804
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5805
	 *
5806
	 * @param array $methods XMLRPC methods.
5807
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5808
	 */
5809 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5810
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5811
5812
		if ( ! $this->connection_manager ) {
5813
			$this->connection_manager = new Connection_Manager();
5814
		}
5815
5816
		return $this->connection_manager->xmlrpc_methods( $methods );
5817
	}
5818
5819
	/**
5820
	 * Register additional public XMLRPC methods.
5821
	 *
5822
	 * @deprecated since 7.7.0
5823
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5824
	 *
5825
	 * @param array $methods Public XMLRPC methods.
5826
	 * @return array Public XMLRPC methods, with the getOptions one.
5827
	 */
5828 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5829
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5830
5831
		if ( ! $this->connection_manager ) {
5832
			$this->connection_manager = new Connection_Manager();
5833
		}
5834
5835
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5836
	}
5837
5838
	/**
5839
	 * Handles a getOptions XMLRPC method call.
5840
	 *
5841
	 * @deprecated since 7.7.0
5842
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5843
	 *
5844
	 * @param array $args method call arguments.
5845
	 * @return array an amended XMLRPC server options array.
5846
	 */
5847 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5848
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5849
5850
		if ( ! $this->connection_manager ) {
5851
			$this->connection_manager = new Connection_Manager();
5852
		}
5853
5854
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
The method jetpack_getOptions() does not exist on Automattic\Jetpack\Connection\Manager. Did you maybe mean jetpack_get_options()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
5855
	}
5856
5857
	/**
5858
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5859
	 *
5860
	 * @deprecated since 7.7.0
5861
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5862
	 *
5863
	 * @param array $options Standard Core options.
5864
	 * @return array Amended options.
5865
	 */
5866 View Code Duplication
	public function xmlrpc_options( $options ) {
5867
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5868
5869
		if ( ! $this->connection_manager ) {
5870
			$this->connection_manager = new Connection_Manager();
5871
		}
5872
5873
		return $this->connection_manager->xmlrpc_options( $options );
5874
	}
5875
5876
	/**
5877
	 * Cleans nonces that were saved when calling ::add_nonce.
5878
	 *
5879
	 * @deprecated since 7.7.0
5880
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5881
	 *
5882
	 * @param bool $all whether to clean even non-expired nonces.
5883
	 */
5884
	public static function clean_nonces( $all = false ) {
5885
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5886
		return self::connection()->clean_nonces( $all );
5887
	}
5888
5889
	/**
5890
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5891
	 * SET: state( $key, $value );
5892
	 * GET: $value = state( $key );
5893
	 *
5894
	 * @param string $key
0 ignored issues
show
Should the type for parameter $key not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5895
	 * @param string $value
0 ignored issues
show
Should the type for parameter $value not be string|null?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
5896
	 * @param bool   $restate private
5897
	 */
5898
	public static function state( $key = null, $value = null, $restate = false ) {
5899
		static $state = array();
5900
		static $path, $domain;
5901
		if ( ! isset( $path ) ) {
5902
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5903
			$admin_url = self::admin_url();
5904
			$bits      = wp_parse_url( $admin_url );
5905
5906
			if ( is_array( $bits ) ) {
5907
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5908
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5909
			} else {
5910
				$path = $domain = null;
5911
			}
5912
		}
5913
5914
		// Extract state from cookies and delete cookies
5915
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5916
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5917
			unset( $_COOKIE['jetpackState'] );
5918
			foreach ( $yum as $k => $v ) {
5919
				if ( strlen( $v ) ) {
5920
					$state[ $k ] = $v;
5921
				}
5922
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5923
			}
5924
		}
5925
5926
		if ( $restate ) {
5927
			foreach ( $state as $k => $v ) {
5928
				if ( 'message_content' !== $k ) {
5929
					setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5930
				}
5931
			}
5932
			return;
5933
		}
5934
5935
		// Get a state variable.
5936
		if ( isset( $key ) && ! isset( $value ) ) {
5937
			if ( array_key_exists( $key, $state ) ) {
5938
				return $state[ $key ];
5939
			}
5940
			return null;
5941
		}
5942
5943
		// Set a state variable.
5944
		if ( isset( $key ) && isset( $value ) ) {
5945
			if ( is_array( $value ) && isset( $value[0] ) ) {
5946
				$value = $value[0];
5947
			}
5948
			$state[ $key ] = $value;
5949
			if ( 'message_content' !== $key && ! headers_sent() ) {
5950
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5951
			}
5952
		}
5953
	}
5954
5955
	public static function restate() {
5956
		self::state( null, null, true );
5957
	}
5958
5959
	public static function check_privacy( $file ) {
5960
		static $is_site_publicly_accessible = null;
5961
5962
		if ( is_null( $is_site_publicly_accessible ) ) {
5963
			$is_site_publicly_accessible = false;
5964
5965
			$rpc = new Jetpack_IXR_Client();
5966
5967
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5968
			if ( $success ) {
5969
				$response = $rpc->getResponse();
5970
				if ( $response ) {
5971
					$is_site_publicly_accessible = true;
5972
				}
5973
			}
5974
5975
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5976
		}
5977
5978
		if ( $is_site_publicly_accessible ) {
5979
			return;
5980
		}
5981
5982
		$module_slug = self::get_module_slug( $file );
5983
5984
		$privacy_checks = self::state( 'privacy_checks' );
5985
		if ( ! $privacy_checks ) {
5986
			$privacy_checks = $module_slug;
5987
		} else {
5988
			$privacy_checks .= ",$module_slug";
5989
		}
5990
5991
		self::state( 'privacy_checks', $privacy_checks );
5992
	}
5993
5994
	/**
5995
	 * Helper method for multicall XMLRPC.
5996
	 *
5997
	 * @param ...$args Args for the async_call.
5998
	 */
5999
	public static function xmlrpc_async_call( ...$args ) {
6000
		global $blog_id;
6001
		static $clients = array();
6002
6003
		$client_blog_id = is_multisite() ? $blog_id : 0;
6004
6005
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
6006
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
6007
			if ( function_exists( 'ignore_user_abort' ) ) {
6008
				ignore_user_abort( true );
6009
			}
6010
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
6011
		}
6012
6013
		if ( ! empty( $args[0] ) ) {
6014
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
6015
		} elseif ( is_multisite() ) {
6016
			foreach ( $clients as $client_blog_id => $client ) {
6017
				if ( ! $client_blog_id || empty( $client->calls ) ) {
6018
					continue;
6019
				}
6020
6021
				$switch_success = switch_to_blog( $client_blog_id, true );
6022
				if ( ! $switch_success ) {
6023
					continue;
6024
				}
6025
6026
				flush();
6027
				$client->query();
6028
6029
				restore_current_blog();
6030
			}
6031
		} else {
6032
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
6033
				flush();
6034
				$clients[0]->query();
6035
			}
6036
		}
6037
	}
6038
6039
	public static function staticize_subdomain( $url ) {
6040
6041
		// Extract hostname from URL
6042
		$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...
6043
6044
		// Explode hostname on '.'
6045
		$exploded_host = explode( '.', $host );
6046
6047
		// Retrieve the name and TLD
6048
		if ( count( $exploded_host ) > 1 ) {
6049
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
6050
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
6051
			// Rebuild domain excluding subdomains
6052
			$domain = $name . '.' . $tld;
6053
		} else {
6054
			$domain = $host;
6055
		}
6056
		// Array of Automattic domains
6057
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
6058
6059
		// Return $url if not an Automattic domain
6060
		if ( ! in_array( $domain, $domain_whitelist ) ) {
6061
			return $url;
6062
		}
6063
6064
		if ( is_ssl() ) {
6065
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
6066
		}
6067
6068
		srand( crc32( basename( $url ) ) );
6069
		$static_counter = rand( 0, 2 );
6070
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
6071
6072
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
6073
	}
6074
6075
	/* JSON API Authorization */
6076
6077
	/**
6078
	 * Handles the login action for Authorizing the JSON API
6079
	 */
6080
	function login_form_json_api_authorization() {
6081
		$this->verify_json_api_authorization_request();
6082
6083
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
6084
6085
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
6086
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6087
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6088
	}
6089
6090
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6091
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6092
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6093
			return $url;
6094
		}
6095
6096
		$parsed_url = wp_parse_url( $url );
6097
		$url        = strtok( $url, '?' );
6098
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
6099
		if ( ! empty( $parsed_url['query'] ) ) {
6100
			$url .= "&{$parsed_url['query']}";
6101
		}
6102
6103
		return $url;
6104
	}
6105
6106
	// Make sure the POSTed request is handled by the same action
6107
	function preserve_action_in_login_form_for_json_api_authorization() {
6108
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6109
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6110
	}
6111
6112
	// If someone logs in to approve API access, store the Access Code in usermeta
6113
	function store_json_api_authorization_token( $user_login, $user ) {
6114
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6115
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6116
		$token = wp_generate_password( 32, false );
6117
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6118
	}
6119
6120
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6121
	function allow_wpcom_public_api_domain( $domains ) {
6122
		$domains[] = 'public-api.wordpress.com';
6123
		return $domains;
6124
	}
6125
6126
	static function is_redirect_encoded( $redirect_url ) {
6127
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
6128
	}
6129
6130
	// Add all wordpress.com environments to the safe redirect whitelist
6131
	function allow_wpcom_environments( $domains ) {
6132
		$domains[] = 'wordpress.com';
6133
		$domains[] = 'wpcalypso.wordpress.com';
6134
		$domains[] = 'horizon.wordpress.com';
6135
		$domains[] = 'calypso.localhost';
6136
		return $domains;
6137
	}
6138
6139
	// Add the Access Code details to the public-api.wordpress.com redirect
6140
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6141
		return add_query_arg(
6142
			urlencode_deep(
6143
				array(
6144
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6145
					'jetpack-user-id' => (int) $user->ID,
6146
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6147
				)
6148
			),
6149
			$redirect_to
6150
		);
6151
	}
6152
6153
6154
	/**
6155
	 * Verifies the request by checking the signature
6156
	 *
6157
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6158
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6159
	 *
6160
	 * @param null|array $environment
6161
	 */
6162
	function verify_json_api_authorization_request( $environment = null ) {
6163
		$environment = is_null( $environment )
6164
			? $_REQUEST
6165
			: $environment;
6166
6167
		list( $envToken, $envVersion, $envUserId ) = explode( ':', $environment['token'] );
0 ignored issues
show
The assignment to $envVersion is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
6168
		$token                                     = Jetpack_Data::get_access_token( $envUserId, $envToken );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

Loading history...
6169
		if ( ! $token || empty( $token->secret ) ) {
6170
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6171
		}
6172
6173
		$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' );
6174
6175
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6176
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6177
			/**
6178
			 * Jetpack authorisation request Error.
6179
			 *
6180
			 * @since 7.5.0
6181
			 */
6182
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6183
			$die_error = sprintf(
6184
				/* translators: %s is a URL */
6185
				__( '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' ),
6186
				Redirect::get_url( 'jetpack-support-double-encoding' )
6187
			);
6188
		}
6189
6190
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6191
6192
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6193
			$signature = $jetpack_signature->sign_request(
6194
				$environment['token'],
6195
				$environment['timestamp'],
6196
				$environment['nonce'],
6197
				'',
6198
				'GET',
6199
				$environment['jetpack_json_api_original_query'],
6200
				null,
6201
				true
6202
			);
6203
		} else {
6204
			$signature = $jetpack_signature->sign_current_request(
6205
				array(
6206
					'body'   => null,
6207
					'method' => 'GET',
6208
				)
6209
			);
6210
		}
6211
6212
		if ( ! $signature ) {
6213
			wp_die( $die_error );
6214
		} elseif ( is_wp_error( $signature ) ) {
6215
			wp_die( $die_error );
6216
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6217
			if ( is_ssl() ) {
6218
				// 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
6219
				$signature = $jetpack_signature->sign_current_request(
6220
					array(
6221
						'scheme' => 'http',
6222
						'body'   => null,
6223
						'method' => 'GET',
6224
					)
6225
				);
6226
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6227
					wp_die( $die_error );
6228
				}
6229
			} else {
6230
				wp_die( $die_error );
6231
			}
6232
		}
6233
6234
		$timestamp = (int) $environment['timestamp'];
6235
		$nonce     = stripslashes( (string) $environment['nonce'] );
6236
6237
		if ( ! $this->connection_manager ) {
6238
			$this->connection_manager = new Connection_Manager();
6239
		}
6240
6241
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6242
			// De-nonce the nonce, at least for 5 minutes.
6243
			// 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)
6244
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6245
			if ( $old_nonce_time < time() - 300 ) {
6246
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6247
			}
6248
		}
6249
6250
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6251
		$data_filters = array(
6252
			'state'        => 'opaque',
6253
			'client_id'    => 'int',
6254
			'client_title' => 'string',
6255
			'client_image' => 'url',
6256
		);
6257
6258
		foreach ( $data_filters as $key => $sanitation ) {
6259
			if ( ! isset( $data->$key ) ) {
6260
				wp_die( $die_error );
6261
			}
6262
6263
			switch ( $sanitation ) {
6264
				case 'int':
6265
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6266
					break;
6267
				case 'opaque':
6268
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6269
					break;
6270
				case 'string':
6271
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6272
					break;
6273
				case 'url':
6274
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6275
					break;
6276
			}
6277
		}
6278
6279
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6280
			wp_die( $die_error );
6281
		}
6282
	}
6283
6284
	function login_message_json_api_authorization( $message ) {
6285
		return '<p class="message">' . sprintf(
6286
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6287
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6288
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6289
	}
6290
6291
	/**
6292
	 * Get $content_width, but with a <s>twist</s> filter.
6293
	 */
6294
	public static function get_content_width() {
6295
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6296
			? $GLOBALS['content_width']
6297
			: false;
6298
		/**
6299
		 * Filter the Content Width value.
6300
		 *
6301
		 * @since 2.2.3
6302
		 *
6303
		 * @param string $content_width Content Width value.
6304
		 */
6305
		return apply_filters( 'jetpack_content_width', $content_width );
6306
	}
6307
6308
	/**
6309
	 * Pings the WordPress.com Mirror Site for the specified options.
6310
	 *
6311
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6312
	 *
6313
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6314
	 */
6315
	public function get_cloud_site_options( $option_names ) {
6316
		$option_names = array_filter( (array) $option_names, 'is_string' );
6317
6318
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6319
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6320
		if ( $xml->isError() ) {
6321
			return array(
6322
				'error_code' => $xml->getErrorCode(),
6323
				'error_msg'  => $xml->getErrorMessage(),
6324
			);
6325
		}
6326
		$cloud_site_options = $xml->getResponse();
6327
6328
		return $cloud_site_options;
6329
	}
6330
6331
	/**
6332
	 * Checks if the site is currently in an identity crisis.
6333
	 *
6334
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6335
	 */
6336
	public static function check_identity_crisis() {
6337
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6338
			return false;
6339
		}
6340
6341
		return Jetpack_Options::get_option( 'sync_error_idc' );
6342
	}
6343
6344
	/**
6345
	 * Checks whether the home and siteurl specifically are whitelisted
6346
	 * Written so that we don't have re-check $key and $value params every time
6347
	 * we want to check if this site is whitelisted, for example in footer.php
6348
	 *
6349
	 * @since  3.8.0
6350
	 * @return bool True = already whitelisted False = not whitelisted
6351
	 */
6352
	public static function is_staging_site() {
6353
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6354
		return ( new Status() )->is_staging_site();
6355
	}
6356
6357
	/**
6358
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6359
	 *
6360
	 * @since 4.4.0
6361
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6362
	 *
6363
	 * @return bool
6364
	 */
6365
	public static function validate_sync_error_idc_option() {
6366
		$is_valid = false;
6367
6368
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6369
		if ( false === $idc_allowed ) {
6370
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6371
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6372
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6373
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6374
				$transient_duration = HOUR_IN_SECONDS;
6375
			} else {
6376
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6377
				$idc_allowed        = '1';
6378
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6379
			}
6380
6381
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6382
		}
6383
6384
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6385
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6386
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6387
			$local_options = self::get_sync_error_idc_option();
6388
			// Ensure all values are set.
6389
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6390
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6391
					$is_valid = true;
6392
				}
6393
			}
6394
		}
6395
6396
		/**
6397
		 * Filters whether the sync_error_idc option is valid.
6398
		 *
6399
		 * @since 4.4.0
6400
		 *
6401
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6402
		 */
6403
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6404
6405
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6406
			// Since the option exists, and did not validate, delete it
6407
			Jetpack_Options::delete_option( 'sync_error_idc' );
6408
		}
6409
6410
		return $is_valid;
6411
	}
6412
6413
	/**
6414
	 * Normalizes a url by doing three things:
6415
	 *  - Strips protocol
6416
	 *  - Strips www
6417
	 *  - Adds a trailing slash
6418
	 *
6419
	 * @since 4.4.0
6420
	 * @param string $url
6421
	 * @return WP_Error|string
6422
	 */
6423
	public static function normalize_url_protocol_agnostic( $url ) {
6424
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6425
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6426
			return new WP_Error( 'cannot_parse_url', sprintf( esc_html__( 'Cannot parse URL %s', 'jetpack' ), $url ) );
0 ignored issues
show
The call to WP_Error::__construct() has too many arguments starting with 'cannot_parse_url'.

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...
6427
		}
6428
6429
		// Strip www and protocols
6430
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6431
		return $url;
6432
	}
6433
6434
	/**
6435
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6436
	 *
6437
	 * @since 4.4.0
6438
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6439
	 *
6440
	 * @param array $response
6441
	 * @return array Array of the local urls, wpcom urls, and error code
6442
	 */
6443
	public static function get_sync_error_idc_option( $response = array() ) {
6444
		// Since the local options will hit the database directly, store the values
6445
		// in a transient to allow for autoloading and caching on subsequent views.
6446
		$local_options = get_transient( 'jetpack_idc_local' );
6447
		if ( false === $local_options ) {
6448
			$local_options = array(
6449
				'home'    => Functions::home_url(),
6450
				'siteurl' => Functions::site_url(),
6451
			);
6452
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6453
		}
6454
6455
		$options = array_merge( $local_options, $response );
6456
6457
		$returned_values = array();
6458
		foreach ( $options as $key => $option ) {
6459
			if ( 'error_code' === $key ) {
6460
				$returned_values[ $key ] = $option;
6461
				continue;
6462
			}
6463
6464
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6465
				continue;
6466
			}
6467
6468
			$returned_values[ $key ] = $normalized_url;
6469
		}
6470
6471
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6472
6473
		return $returned_values;
6474
	}
6475
6476
	/**
6477
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6478
	 * If set to true, the site will be put into staging mode.
6479
	 *
6480
	 * @since 4.3.2
6481
	 * @return bool
6482
	 */
6483
	public static function sync_idc_optin() {
6484
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6485
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6486
		} else {
6487
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6488
		}
6489
6490
		/**
6491
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6492
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6493
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6494
		 *
6495
		 * @since 4.3.2
6496
		 *
6497
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6498
		 */
6499
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6500
	}
6501
6502
	/**
6503
	 * Maybe Use a .min.css stylesheet, maybe not.
6504
	 *
6505
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6506
	 */
6507
	public static function maybe_min_asset( $url, $path, $plugin ) {
6508
		// Short out on things trying to find actual paths.
6509
		if ( ! $path || empty( $plugin ) ) {
6510
			return $url;
6511
		}
6512
6513
		$path = ltrim( $path, '/' );
6514
6515
		// Strip out the abspath.
6516
		$base = dirname( plugin_basename( $plugin ) );
6517
6518
		// Short out on non-Jetpack assets.
6519
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6520
			return $url;
6521
		}
6522
6523
		// File name parsing.
6524
		$file              = "{$base}/{$path}";
6525
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6526
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6527
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6528
		$extension         = array_shift( $file_name_parts_r );
6529
6530
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6531
			// Already pointing at the minified version.
6532
			if ( 'min' === $file_name_parts_r[0] ) {
6533
				return $url;
6534
			}
6535
6536
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6537
			if ( file_exists( $min_full_path ) ) {
6538
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6539
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6540
				if ( 'css' === $extension ) {
6541
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6542
					self::$min_assets[ $key ] = $path;
6543
				}
6544
			}
6545
		}
6546
6547
		return $url;
6548
	}
6549
6550
	/**
6551
	 * If the asset is minified, let's flag .min as the suffix.
6552
	 *
6553
	 * Attached to `style_loader_src` filter.
6554
	 *
6555
	 * @param string $tag The tag that would link to the external asset.
0 ignored issues
show
There is no parameter named $tag. Was it maybe removed?

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

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

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

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

Loading history...
6556
	 * @param string $handle The registered handle of the script in question.
6557
	 * @param string $href The url of the asset in question.
0 ignored issues
show
There is no parameter named $href. Was it maybe removed?

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

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

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

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

Loading history...
6558
	 */
6559
	public static function set_suffix_on_min( $src, $handle ) {
6560
		if ( false === strpos( $src, '.min.css' ) ) {
6561
			return $src;
6562
		}
6563
6564
		if ( ! empty( self::$min_assets ) ) {
6565
			foreach ( self::$min_assets as $file => $path ) {
6566
				if ( false !== strpos( $src, $file ) ) {
6567
					wp_style_add_data( $handle, 'suffix', '.min' );
6568
					return $src;
6569
				}
6570
			}
6571
		}
6572
6573
		return $src;
6574
	}
6575
6576
	/**
6577
	 * Maybe inlines a stylesheet.
6578
	 *
6579
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6580
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6581
	 *
6582
	 * Attached to `style_loader_tag` filter.
6583
	 *
6584
	 * @param string $tag The tag that would link to the external asset.
6585
	 * @param string $handle The registered handle of the script in question.
6586
	 *
6587
	 * @return string
6588
	 */
6589
	public static function maybe_inline_style( $tag, $handle ) {
6590
		global $wp_styles;
6591
		$item = $wp_styles->registered[ $handle ];
6592
6593
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6594
			return $tag;
6595
		}
6596
6597
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6598
			$href = $matches[1];
6599
			// Strip off query string
6600
			if ( $pos = strpos( $href, '?' ) ) {
6601
				$href = substr( $href, 0, $pos );
6602
			}
6603
			// Strip off fragment
6604
			if ( $pos = strpos( $href, '#' ) ) {
6605
				$href = substr( $href, 0, $pos );
6606
			}
6607
		} else {
6608
			return $tag;
6609
		}
6610
6611
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6612
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6613
			return $tag;
6614
		}
6615
6616
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6617
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6618
			// And this isn't the pass that actually deals with the RTL version...
6619
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6620
				// Short out, as the RTL version will deal with it in a moment.
6621
				return $tag;
6622
			}
6623
		}
6624
6625
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6626
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6627
		if ( $css ) {
6628
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6629
			if ( empty( $item->extra['after'] ) ) {
6630
				wp_add_inline_style( $handle, $css );
6631
			} else {
6632
				array_unshift( $item->extra['after'], $css );
6633
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6634
			}
6635
		}
6636
6637
		return $tag;
6638
	}
6639
6640
	/**
6641
	 * Loads a view file from the views
6642
	 *
6643
	 * Data passed in with the $data parameter will be available in the
6644
	 * template file as $data['value']
6645
	 *
6646
	 * @param string $template - Template file to load
6647
	 * @param array  $data - Any data to pass along to the template
6648
	 * @return boolean - If template file was found
6649
	 **/
6650
	public function load_view( $template, $data = array() ) {
6651
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6652
6653
		if ( file_exists( $views_dir . $template ) ) {
6654
			require_once $views_dir . $template;
6655
			return true;
6656
		}
6657
6658
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6659
		return false;
6660
	}
6661
6662
	/**
6663
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6664
	 */
6665
	public function deprecated_hooks() {
6666
		global $wp_filter;
6667
6668
		/*
6669
		 * Format:
6670
		 * deprecated_filter_name => replacement_name
6671
		 *
6672
		 * If there is no replacement, use null for replacement_name
6673
		 */
6674
		$deprecated_list = array(
6675
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6676
			'wpl_sharing_2014_1'                           => null,
6677
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6678
			'jetpack_identity_crisis_options_to_check'     => null,
6679
			'update_option_jetpack_single_user_site'       => null,
6680
			'audio_player_default_colors'                  => null,
6681
			'add_option_jetpack_featured_images_enabled'   => null,
6682
			'add_option_jetpack_update_details'            => null,
6683
			'add_option_jetpack_updates'                   => null,
6684
			'add_option_jetpack_network_name'              => null,
6685
			'add_option_jetpack_network_allow_new_registrations' => null,
6686
			'add_option_jetpack_network_add_new_users'     => null,
6687
			'add_option_jetpack_network_site_upload_space' => null,
6688
			'add_option_jetpack_network_upload_file_types' => null,
6689
			'add_option_jetpack_network_enable_administration_menus' => null,
6690
			'add_option_jetpack_is_multi_site'             => null,
6691
			'add_option_jetpack_is_main_network'           => null,
6692
			'add_option_jetpack_main_network_site'         => null,
6693
			'jetpack_sync_all_registered_options'          => null,
6694
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6695
			'jetpack_is_post_mailable'                     => null,
6696
			'jetpack_seo_site_host'                        => null,
6697
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6698
			'jetpack_holiday_snow_option_name'             => null,
6699
			'jetpack_holiday_chance_of_snow'               => null,
6700
			'jetpack_holiday_snow_js_url'                  => null,
6701
			'jetpack_is_holiday_snow_season'               => null,
6702
			'jetpack_holiday_snow_option_updated'          => null,
6703
			'jetpack_holiday_snowing'                      => null,
6704
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6705
			'jetpack_cache_plans'                          => null,
6706
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6707
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6708
			'jetpack_enable_site_verification'             => null,
6709
			'can_display_jetpack_manage_notice'            => null,
6710
			// Removed in Jetpack 7.3.0
6711
			'atd_load_scripts'                             => null,
6712
			'atd_http_post_timeout'                        => null,
6713
			'atd_http_post_error'                          => null,
6714
			'atd_service_domain'                           => null,
6715
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6716
			// Removed in Jetpack 7.9.0
6717
			'jetpack_pwa_manifest'                         => null,
6718
			'jetpack_pwa_background_color'                 => null,
6719
			// Removed in Jetpack 8.3.0.
6720
			'jetpack_check_mobile'                         => null,
6721
			'jetpack_mobile_stylesheet'                    => null,
6722
			'jetpack_mobile_template'                      => null,
6723
			'mobile_reject_mobile'                         => null,
6724
			'mobile_force_mobile'                          => null,
6725
			'mobile_app_promo_download'                    => null,
6726
			'mobile_setup'                                 => null,
6727
			'jetpack_mobile_footer_before'                 => null,
6728
			'wp_mobile_theme_footer'                       => null,
6729
			'minileven_credits'                            => null,
6730
			'jetpack_mobile_header_before'                 => null,
6731
			'jetpack_mobile_header_after'                  => null,
6732
			'jetpack_mobile_theme_menu'                    => null,
6733
			'minileven_show_featured_images'               => null,
6734
			'minileven_attachment_size'                    => null,
6735
		);
6736
6737
		// This is a silly loop depth. Better way?
6738
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6739
			if ( has_action( $hook ) ) {
6740
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6741
					foreach ( $values as $hooked ) {
6742
						if ( is_callable( $hooked['function'] ) ) {
6743
							$function_name = $hooked['function'];
6744
						} else {
6745
							$function_name = 'an anonymous function';
6746
						}
6747
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6748
					}
6749
				}
6750
			}
6751
		}
6752
	}
6753
6754
	/**
6755
	 * Converts any url in a stylesheet, to the correct absolute url.
6756
	 *
6757
	 * Considerations:
6758
	 *  - Normal, relative URLs     `feh.png`
6759
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6760
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6761
	 *  - Absolute URLs             `http://domain.com/feh.png`
6762
	 *  - Domain root relative URLs `/feh.png`
6763
	 *
6764
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6765
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6766
	 *
6767
	 * @return mixed|string
6768
	 */
6769
	public static function absolutize_css_urls( $css, $css_file_url ) {
6770
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6771
		$css_dir = dirname( $css_file_url );
6772
		$p       = wp_parse_url( $css_dir );
6773
		$domain  = sprintf(
6774
			'%1$s//%2$s%3$s%4$s',
6775
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6776
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6777
			$p['host'],
6778
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6779
		);
6780
6781
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6782
			$find = $replace = array();
6783
			foreach ( $matches as $match ) {
6784
				$url = trim( $match['path'], "'\" \t" );
6785
6786
				// If this is a data url, we don't want to mess with it.
6787
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6788
					continue;
6789
				}
6790
6791
				// If this is an absolute or protocol-agnostic url,
6792
				// we don't want to mess with it.
6793
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6794
					continue;
6795
				}
6796
6797
				switch ( substr( $url, 0, 1 ) ) {
6798
					case '/':
6799
						$absolute = $domain . $url;
6800
						break;
6801
					default:
6802
						$absolute = $css_dir . '/' . $url;
6803
				}
6804
6805
				$find[]    = $match[0];
6806
				$replace[] = sprintf( 'url("%s")', $absolute );
6807
			}
6808
			$css = str_replace( $find, $replace, $css );
6809
		}
6810
6811
		return $css;
6812
	}
6813
6814
	/**
6815
	 * This methods removes all of the registered css files on the front end
6816
	 * from Jetpack in favor of using a single file. In effect "imploding"
6817
	 * all the files into one file.
6818
	 *
6819
	 * Pros:
6820
	 * - Uses only ONE css asset connection instead of 15
6821
	 * - Saves a minimum of 56k
6822
	 * - Reduces server load
6823
	 * - Reduces time to first painted byte
6824
	 *
6825
	 * Cons:
6826
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6827
	 *      should not cause any issues with themes.
6828
	 * - Plugins/themes dequeuing styles no longer do anything. See
6829
	 *      jetpack_implode_frontend_css filter for a workaround
6830
	 *
6831
	 * For some situations developers may wish to disable css imploding and
6832
	 * instead operate in legacy mode where each file loads seperately and
6833
	 * can be edited individually or dequeued. This can be accomplished with
6834
	 * the following line:
6835
	 *
6836
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6837
	 *
6838
	 * @since 3.2
6839
	 **/
6840
	public function implode_frontend_css( $travis_test = false ) {
6841
		$do_implode = true;
6842
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6843
			$do_implode = false;
6844
		}
6845
6846
		// Do not implode CSS when the page loads via the AMP plugin.
6847
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6848
			$do_implode = false;
6849
		}
6850
6851
		/**
6852
		 * Allow CSS to be concatenated into a single jetpack.css file.
6853
		 *
6854
		 * @since 3.2.0
6855
		 *
6856
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6857
		 */
6858
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6859
6860
		// Do not use the imploded file when default behavior was altered through the filter
6861
		if ( ! $do_implode ) {
6862
			return;
6863
		}
6864
6865
		// We do not want to use the imploded file in dev mode, or if not connected
6866
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6867
			if ( ! $travis_test ) {
6868
				return;
6869
			}
6870
		}
6871
6872
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6873
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6874
			return;
6875
		}
6876
6877
		/*
6878
		 * Now we assume Jetpack is connected and able to serve the single
6879
		 * file.
6880
		 *
6881
		 * In the future there will be a check here to serve the file locally
6882
		 * or potentially from the Jetpack CDN
6883
		 *
6884
		 * For now:
6885
		 * - Enqueue a single imploded css file
6886
		 * - Zero out the style_loader_tag for the bundled ones
6887
		 * - Be happy, drink scotch
6888
		 */
6889
6890
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6891
6892
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6893
6894
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6895
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6896
	}
6897
6898
	function concat_remove_style_loader_tag( $tag, $handle ) {
6899
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6900
			$tag = '';
6901
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6902
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6903
			}
6904
		}
6905
6906
		return $tag;
6907
	}
6908
6909
	/**
6910
	 * Add an async attribute to scripts that can be loaded asynchronously.
6911
	 * https://www.w3schools.com/tags/att_script_async.asp
6912
	 *
6913
	 * @since 7.7.0
6914
	 *
6915
	 * @param string $tag    The <script> tag for the enqueued script.
6916
	 * @param string $handle The script's registered handle.
6917
	 * @param string $src    The script's source URL.
6918
	 */
6919
	public function script_add_async( $tag, $handle, $src ) {
6920
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6921
			return preg_replace( '/^<script /i', '<script async ', $tag );
6922
		}
6923
6924
		return $tag;
6925
	}
6926
6927
	/*
6928
	 * Check the heartbeat data
6929
	 *
6930
	 * Organizes the heartbeat data by severity.  For example, if the site
6931
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6932
	 *
6933
	 * Data will be added to "caution" array, if it either:
6934
	 *  - Out of date Jetpack version
6935
	 *  - Out of date WP version
6936
	 *  - Out of date PHP version
6937
	 *
6938
	 * $return array $filtered_data
6939
	 */
6940
	public static function jetpack_check_heartbeat_data() {
6941
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6942
6943
		$good    = array();
6944
		$caution = array();
6945
		$bad     = array();
6946
6947
		foreach ( $raw_data as $stat => $value ) {
6948
6949
			// Check jetpack version
6950
			if ( 'version' == $stat ) {
6951
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6952
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6953
					continue;
6954
				}
6955
			}
6956
6957
			// Check WP version
6958
			if ( 'wp-version' == $stat ) {
6959
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6960
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6961
					continue;
6962
				}
6963
			}
6964
6965
			// Check PHP version
6966
			if ( 'php-version' == $stat ) {
6967
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6968
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6969
					continue;
6970
				}
6971
			}
6972
6973
			// Check ID crisis
6974
			if ( 'identitycrisis' == $stat ) {
6975
				if ( 'yes' == $value ) {
6976
					$bad[ $stat ] = $value;
6977
					continue;
6978
				}
6979
			}
6980
6981
			// The rest are good :)
6982
			$good[ $stat ] = $value;
6983
		}
6984
6985
		$filtered_data = array(
6986
			'good'    => $good,
6987
			'caution' => $caution,
6988
			'bad'     => $bad,
6989
		);
6990
6991
		return $filtered_data;
6992
	}
6993
6994
6995
	/*
6996
	 * This method is used to organize all options that can be reset
6997
	 * without disconnecting Jetpack.
6998
	 *
6999
	 * It is used in class.jetpack-cli.php to reset options
7000
	 *
7001
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
7002
	 *
7003
	 * @return array of options to delete.
7004
	 */
7005
	public static function get_jetpack_options_for_reset() {
7006
		return Jetpack_Options::get_options_for_reset();
7007
	}
7008
7009
	/*
7010
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
7011
	 * so we can bring them directly to their site in calypso.
7012
	 *
7013
	 * @param string | url
7014
	 * @return string | url without the guff
7015
	 */
7016 View Code Duplication
	public static function build_raw_urls( $url ) {
7017
		$strip_http = '/.*?:\/\//i';
7018
		$url        = preg_replace( $strip_http, '', $url );
7019
		$url        = str_replace( '/', '::', $url );
7020
		return $url;
7021
	}
7022
7023
	/**
7024
	 * Stores and prints out domains to prefetch for page speed optimization.
7025
	 *
7026
	 * @param mixed $new_urls
7027
	 */
7028
	public static function dns_prefetch( $new_urls = null ) {
7029
		static $prefetch_urls = array();
7030
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
7031
			echo "\r\n";
7032
			foreach ( $prefetch_urls as $this_prefetch_url ) {
7033
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
7034
			}
7035
		} elseif ( ! empty( $new_urls ) ) {
7036
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
7037
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
7038
			}
7039
			foreach ( (array) $new_urls as $this_new_url ) {
7040
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
7041
			}
7042
			$prefetch_urls = array_unique( $prefetch_urls );
7043
		}
7044
	}
7045
7046
	public function wp_dashboard_setup() {
7047
		if ( self::is_active() ) {
7048
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
7049
		}
7050
7051
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
7052
			$jetpack_logo = new Jetpack_Logo();
7053
			$widget_title = sprintf(
7054
				wp_kses(
7055
					/* translators: Placeholder is a Jetpack logo. */
7056
					__( 'Stats <span>by %s</span>', 'jetpack' ),
7057
					array( 'span' => array() )
7058
				),
7059
				$jetpack_logo->get_jp_emblem( true )
7060
			);
7061
7062
			wp_add_dashboard_widget(
7063
				'jetpack_summary_widget',
7064
				$widget_title,
7065
				array( __CLASS__, 'dashboard_widget' )
7066
			);
7067
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
7068
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
7069
7070
			// If we're inactive and not in development mode, sort our box to the top.
7071
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
7072
				global $wp_meta_boxes;
7073
7074
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
7075
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
7076
7077
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7078
			}
7079
		}
7080
	}
7081
7082
	/**
7083
	 * @param mixed $result Value for the user's option
0 ignored issues
show
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
7084
	 * @return mixed
7085
	 */
7086
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7087
		if ( ! is_array( $sorted ) ) {
7088
			return $sorted;
7089
		}
7090
7091
		foreach ( $sorted as $box_context => $ids ) {
7092
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7093
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7094
				continue;
7095
			}
7096
7097
			$ids_array = explode( ',', $ids );
7098
			$key       = array_search( 'dashboard_stats', $ids_array );
7099
7100
			if ( false !== $key ) {
7101
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7102
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7103
				$sorted[ $box_context ] = implode( ',', $ids_array );
7104
				// We've found it, stop searching, and just return.
7105
				break;
7106
			}
7107
		}
7108
7109
		return $sorted;
7110
	}
7111
7112
	public static function dashboard_widget() {
7113
		/**
7114
		 * Fires when the dashboard is loaded.
7115
		 *
7116
		 * @since 3.4.0
7117
		 */
7118
		do_action( 'jetpack_dashboard_widget' );
7119
	}
7120
7121
	public static function dashboard_widget_footer() {
7122
		?>
7123
		<footer>
7124
7125
		<div class="protect">
7126
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7127
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7128
				<p class="blocked-count">
7129
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7130
				</p>
7131
				<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>
7132
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
7133
				<a href="
7134
				<?php
7135
				echo esc_url(
7136
					wp_nonce_url(
7137
						self::admin_url(
7138
							array(
7139
								'action' => 'activate',
7140
								'module' => 'protect',
7141
							)
7142
						),
7143
						'jetpack_activate-protect'
7144
					)
7145
				);
7146
				?>
7147
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7148
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7149
				</a>
7150
			<?php else : ?>
7151
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7152
			<?php endif; ?>
7153
		</div>
7154
7155
		<div class="akismet">
7156
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7157
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7158
				<p class="blocked-count">
7159
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7160
				</p>
7161
				<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>
7162
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7163
				<a href="
7164
				<?php
7165
				echo esc_url(
7166
					wp_nonce_url(
7167
						add_query_arg(
7168
							array(
7169
								'action' => 'activate',
7170
								'plugin' => 'akismet/akismet.php',
7171
							),
7172
							admin_url( 'plugins.php' )
7173
						),
7174
						'activate-plugin_akismet/akismet.php'
7175
					)
7176
				);
7177
				?>
7178
							" class="button button-jetpack">
7179
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7180
				</a>
7181
			<?php else : ?>
7182
				<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>
7183
			<?php endif; ?>
7184
		</div>
7185
7186
		</footer>
7187
		<?php
7188
	}
7189
7190
	/*
7191
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7192
	 */
7193
	function jetpack_icon_user_connected( $columns ) {
7194
		$columns['user_jetpack'] = '';
7195
		return $columns;
7196
	}
7197
7198
	/*
7199
	 * Show Jetpack icon if the user is linked.
7200
	 */
7201
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7202
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7203
			$jetpack_logo = new Jetpack_Logo();
7204
			$emblem_html  = sprintf(
7205
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7206
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7207
				$jetpack_logo->get_jp_emblem()
7208
			);
7209
			return $emblem_html;
7210
		}
7211
7212
		return $val;
7213
	}
7214
7215
	/*
7216
	 * Style the Jetpack user column
7217
	 */
7218
	function jetpack_user_col_style() {
7219
		global $current_screen;
7220
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7221
			?>
7222
			<style>
7223
				.fixed .column-user_jetpack {
7224
					width: 21px;
7225
				}
7226
				.jp-emblem-user-admin svg {
7227
					width: 20px;
7228
					height: 20px;
7229
				}
7230
				.jp-emblem-user-admin path {
7231
					fill: #00BE28;
7232
				}
7233
			</style>
7234
			<?php
7235
		}
7236
	}
7237
7238
	/**
7239
	 * Checks if Akismet is active and working.
7240
	 *
7241
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7242
	 * that implied usage of methods present since more recent version.
7243
	 * See https://github.com/Automattic/jetpack/pull/9585
7244
	 *
7245
	 * @since  5.1.0
7246
	 *
7247
	 * @return bool True = Akismet available. False = Aksimet not available.
7248
	 */
7249
	public static function is_akismet_active() {
7250
		static $status = null;
7251
7252
		if ( ! is_null( $status ) ) {
7253
			return $status;
7254
		}
7255
7256
		// Check if a modern version of Akismet is active.
7257
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7258
			$status = false;
7259
			return $status;
7260
		}
7261
7262
		// Make sure there is a key known to Akismet at all before verifying key.
7263
		$akismet_key = Akismet::get_api_key();
7264
		if ( ! $akismet_key ) {
7265
			$status = false;
7266
			return $status;
7267
		}
7268
7269
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7270
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7271
7272
		// 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.
7273
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7274
		// We cache the result of the Akismet key verification for ten minutes.
7275
		if ( ! $akismet_key_state || $recheck ) {
7276
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7277
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7278
		}
7279
7280
		$status = 'valid' === $akismet_key_state;
7281
7282
		return $status;
7283
	}
7284
7285
	/**
7286
	 * @deprecated
7287
	 *
7288
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7289
	 */
7290
	public static function is_function_in_backtrace() {
7291
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7292
	}
7293
7294
	/**
7295
	 * Given a minified path, and a non-minified path, will return
7296
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7297
	 *
7298
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7299
	 * root Jetpack directory.
7300
	 *
7301
	 * @since 5.6.0
7302
	 *
7303
	 * @param string $min_path
7304
	 * @param string $non_min_path
7305
	 * @return string The URL to the file
7306
	 */
7307
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7308
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7309
	}
7310
7311
	/**
7312
	 * Checks for whether Jetpack Backup & Scan is enabled.
7313
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7314
	 *
7315
	 * @return bool|int|mixed
7316
	 */
7317
	public static function is_rewind_enabled() {
7318
		if ( ! self::is_active() ) {
7319
			return false;
7320
		}
7321
7322
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7323
		if ( false === $rewind_enabled ) {
7324
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7325
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7326
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7327
				&& ! empty( $rewind_data['state'] )
7328
				&& 'active' === $rewind_data['state'] )
7329
				? 1
7330
				: 0;
7331
7332
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7333
		}
7334
		return $rewind_enabled;
7335
	}
7336
7337
	/**
7338
	 * Return Calypso environment value; used for developing Jetpack and pairing
7339
	 * it with different Calypso enrionments, such as localhost.
7340
	 *
7341
	 * @since 7.4.0
7342
	 *
7343
	 * @return string Calypso environment
7344
	 */
7345
	public static function get_calypso_env() {
7346
		if ( isset( $_GET['calypso_env'] ) ) {
7347
			return sanitize_key( $_GET['calypso_env'] );
7348
		}
7349
7350
		if ( getenv( 'CALYPSO_ENV' ) ) {
7351
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7352
		}
7353
7354
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7355
			return sanitize_key( CALYPSO_ENV );
7356
		}
7357
7358
		return '';
7359
	}
7360
7361
	/**
7362
	 * Returns the hostname with protocol for Calypso.
7363
	 * Used for developing Jetpack with Calypso.
7364
	 *
7365
	 * @since 8.4.0
7366
	 *
7367
	 * @return string Calypso host.
7368
	 */
7369
	public static function get_calypso_host() {
7370
		$calypso_env = self::get_calypso_env();
7371
		switch ( $calypso_env ) {
7372
			case 'development':
7373
				return 'http://calypso.localhost:3000/';
7374
			case 'wpcalypso':
7375
				return 'https://wpcalypso.wordpress.com/';
7376
			case 'horizon':
7377
				return 'https://horizon.wordpress.com/';
7378
			default:
7379
				return 'https://wordpress.com/';
7380
		}
7381
	}
7382
7383
	/**
7384
	 * Checks whether or not TOS has been agreed upon.
7385
	 * Will return true if a user has clicked to register, or is already connected.
7386
	 */
7387
	public static function jetpack_tos_agreed() {
7388
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7389
7390
		$terms_of_service = new Terms_Of_Service();
7391
		return $terms_of_service->has_agreed();
7392
7393
	}
7394
7395
	/**
7396
	 * Handles activating default modules as well general cleanup for the new connection.
7397
	 *
7398
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7399
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7400
	 * @param boolean $send_state_messages          Whether to send state messages.
7401
	 * @return void
7402
	 */
7403
	public static function handle_post_authorization_actions(
7404
		$activate_sso = false,
7405
		$redirect_on_activation_error = false,
7406
		$send_state_messages = true
7407
	) {
7408
		$other_modules = $activate_sso
7409
			? array( 'sso' )
7410
			: array();
7411
7412
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7413
			self::delete_active_modules();
7414
7415
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
999 is of type integer, but the function expects a boolean.

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...
7416
		} else {
7417
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7418
		}
7419
7420
		// Since this is a fresh connection, be sure to clear out IDC options
7421
		Jetpack_IDC::clear_all_idc_options();
7422
7423
		if ( $send_state_messages ) {
7424
			self::state( 'message', 'authorized' );
7425
		}
7426
	}
7427
7428
	/**
7429
	 * Returns a boolean for whether backups UI should be displayed or not.
7430
	 *
7431
	 * @return bool Should backups UI be displayed?
7432
	 */
7433
	public static function show_backups_ui() {
7434
		/**
7435
		 * Whether UI for backups should be displayed.
7436
		 *
7437
		 * @since 6.5.0
7438
		 *
7439
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7440
		 */
7441
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7442
	}
7443
7444
	/*
7445
	 * Deprecated manage functions
7446
	 */
7447
	function prepare_manage_jetpack_notice() {
7448
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7449
	}
7450
	function manage_activate_screen() {
7451
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7452
	}
7453
	function admin_jetpack_manage_notice() {
7454
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7455
	}
7456
	function opt_out_jetpack_manage_url() {
7457
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7458
	}
7459
	function opt_in_jetpack_manage_url() {
7460
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7461
	}
7462
	function opt_in_jetpack_manage_notice() {
7463
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7464
	}
7465
	function can_display_jetpack_manage_notice() {
7466
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7467
	}
7468
7469
	/**
7470
	 * Clean leftoveruser meta.
7471
	 *
7472
	 * Delete Jetpack-related user meta when it is no longer needed.
7473
	 *
7474
	 * @since 7.3.0
7475
	 *
7476
	 * @param int $user_id User ID being updated.
7477
	 */
7478
	public static function user_meta_cleanup( $user_id ) {
7479
		$meta_keys = array(
7480
			// AtD removed from Jetpack 7.3
7481
			'AtD_options',
7482
			'AtD_check_when',
7483
			'AtD_guess_lang',
7484
			'AtD_ignored_phrases',
7485
		);
7486
7487
		foreach ( $meta_keys as $meta_key ) {
7488
			if ( get_user_meta( $user_id, $meta_key ) ) {
7489
				delete_user_meta( $user_id, $meta_key );
7490
			}
7491
		}
7492
	}
7493
7494
	/**
7495
	 * Checks if a Jetpack site is both active and not in development.
7496
	 *
7497
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7498
	 *
7499
	 * @return bool True if Jetpack is active and not in development.
7500
	 */
7501
	public static function is_active_and_not_development_mode() {
7502
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7503
			return false;
7504
		}
7505
		return true;
7506
	}
7507
7508
	/**
7509
	 * Returns the list of products that we have available for purchase.
7510
	 */
7511
	public static function get_products_for_purchase() {
7512
		$products = array();
7513
		if ( ! is_multisite() ) {
7514
			$products[] = array(
7515
				'key'               => 'backup',
7516
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7517
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7518
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7519
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7520
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7521
				'options'           => array(
7522
					array(
7523
						'type'        => 'daily',
7524
						'slug'        => 'jetpack-backup-daily',
7525
						'key'         => 'jetpack_backup_daily',
7526
						'name'        => __( 'Daily Backups', 'jetpack' ),
7527
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7528
					),
7529
					array(
7530
						'type'        => 'realtime',
7531
						'slug'        => 'jetpack-backup-realtime',
7532
						'key'         => 'jetpack_backup_realtime',
7533
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7534
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7535
					),
7536
				),
7537
				'default_option'    => 'realtime',
7538
				'show_promotion'    => true,
7539
				'discount_percent'  => 70,
7540
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7541
			);
7542
7543
			$products[] = array(
7544
				'key'               => 'scan',
7545
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7546
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7547
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7548
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7549
				'show_promotion'    => true,
7550
				'discount_percent'  => 30,
7551
				'options'           => array(
7552
					array(
7553
						'type'      => 'scan',
7554
						'slug'      => 'jetpack-scan',
7555
						'key'       => 'jetpack_scan',
7556
						'name'      => __( 'Scan', 'jetpack' ),
7557
					),
7558
				),
7559
				'default_option'    => 'scan',
7560
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7561
			);
7562
		}
7563
7564
		$products[] = array(
7565
			'key'               => 'search',
7566
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7567
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7568
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7569
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7570
			'label_popup'  		=> __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.' ),
7571
			'options'           => array(
7572
				array(
7573
					'type'      => 'search',
7574
					'slug'      => 'jetpack-search',
7575
					'key'       => 'jetpack_search',
7576
					'name'      => __( 'Search', 'jetpack' ),
7577
				),
7578
			),
7579
			'tears'             => array(),
7580
			'default_option'    => 'search',
7581
			'show_promotion'    => false,
7582
			'included_in_plans' => array( 'search-plan' ),
7583
		);
7584
7585
		return $products;
7586
	}
7587
}
7588