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