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

class.jetpack.php (64 issues)

Upgrade to new PHP Analysis Engine

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

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