Completed
Push — try/package-button-block ( 32c482...9d9e85 )
by
unknown
145:04 queued 137:25
created

class.jetpack.php (84 issues)

Upgrade to new PHP Analysis Engine

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

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

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

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

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

Loading history...
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

Loading history...
956
957
		return esc_url(
958
			Redirect::get_url(
959
				'calypso-edit-comment',
960
				array(
961
					'path' => $query_args['amp;c'],
962
				)
963
			)
964
		);
965
966
	}
967
968
	function jetpack_track_last_sync_callback( $params ) {
969
		/**
970
		 * Filter to turn off jitm caching
971
		 *
972
		 * @since 5.4.0
973
		 *
974
		 * @param bool false Whether to cache just in time messages
975
		 */
976
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
977
			return $params;
978
		}
979
980
		if ( is_array( $params ) && isset( $params[0] ) ) {
981
			$option = $params[0];
982
			if ( 'active_plugins' === $option ) {
983
				// use the cache if we can, but not terribly important if it gets evicted
984
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
985
			}
986
		}
987
988
		return $params;
989
	}
990
991
	function jetpack_connection_banner_callback() {
992
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
993
994
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
995
		if (
996
			isset( $_REQUEST['dismissBanner'] ) &&
997
			! Jetpack_Connection_Banner::force_display()
998
		) {
999
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1000
			wp_send_json_success();
1001
		}
1002
1003
		wp_die();
1004
	}
1005
1006
	/**
1007
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1008
	 * Only used in our alternate XML-RPC endpoint, where we want to
1009
	 * ensure that Core and other plugins' methods are not exposed.
1010
	 *
1011
	 * @deprecated since 7.7.0
1012
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1013
	 *
1014
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1015
	 * @return array Filtered $methods
1016
	 */
1017 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1018
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1019
1020
		if ( ! $this->connection_manager ) {
1021
			$this->connection_manager = new Connection_Manager();
1022
		}
1023
1024
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1025
	}
1026
1027
	/**
1028
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1029
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1030
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1031
	 * which is accessible via a different URI. Most of the below is copied directly
1032
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1033
	 *
1034
	 * @deprecated since 7.7.0
1035
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1036
	 */
1037 View Code Duplication
	public function alternate_xmlrpc() {
1038
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1039
1040
		if ( ! $this->connection_manager ) {
1041
			$this->connection_manager = new Connection_Manager();
1042
		}
1043
1044
		$this->connection_manager->alternate_xmlrpc();
1045
	}
1046
1047
	/**
1048
	 * The callback for the JITM ajax requests.
1049
	 *
1050
	 * @deprecated since 7.9.0
1051
	 */
1052
	function jetpack_jitm_ajax_callback() {
1053
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1054
	}
1055
1056
	/**
1057
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1058
	 */
1059
	function push_stats() {
1060
		if ( ! empty( $this->stats ) ) {
1061
			$this->do_stats( 'server_side' );
1062
		}
1063
	}
1064
1065
	/**
1066
	 * Sets the Jetpack custom capabilities.
1067
	 *
1068
	 * @param string[] $caps    Array of the user's capabilities.
1069
	 * @param string   $cap     Capability name.
1070
	 * @param int      $user_id The user ID.
1071
	 * @param array    $args    Adds the context to the cap. Typically the object ID.
1072
	 */
1073
	public function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1074
		$is_development_mode = ( new Status() )->is_development_mode();
1075
		switch ( $cap ) {
1076
			case 'jetpack_manage_modules':
1077
			case 'jetpack_activate_modules':
1078
			case 'jetpack_deactivate_modules':
1079
				$caps = array( 'manage_options' );
1080
				break;
1081
			case 'jetpack_configure_modules':
1082
				$caps = array( 'manage_options' );
1083
				break;
1084
			case 'jetpack_manage_autoupdates':
1085
				$caps = array(
1086
					'manage_options',
1087
					'update_plugins',
1088
				);
1089
				break;
1090
			case 'jetpack_network_admin_page':
1091
			case 'jetpack_network_settings_page':
1092
				$caps = array( 'manage_network_plugins' );
1093
				break;
1094
			case 'jetpack_network_sites_page':
1095
				$caps = array( 'manage_sites' );
1096
				break;
1097
			case 'jetpack_admin_page':
1098
				if ( $is_development_mode ) {
1099
					$caps = array( 'manage_options' );
1100
					break;
1101
				} else {
1102
					$caps = array( 'read' );
1103
				}
1104
				break;
1105
		}
1106
		return $caps;
1107
	}
1108
1109
	/**
1110
	 * Require a Jetpack authentication.
1111
	 *
1112
	 * @deprecated since 7.7.0
1113
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1114
	 */
1115 View Code Duplication
	public function require_jetpack_authentication() {
1116
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1117
1118
		if ( ! $this->connection_manager ) {
1119
			$this->connection_manager = new Connection_Manager();
1120
		}
1121
1122
		$this->connection_manager->require_jetpack_authentication();
1123
	}
1124
1125
	/**
1126
	 * Load language files
1127
	 *
1128
	 * @action plugins_loaded
1129
	 */
1130
	public static function plugin_textdomain() {
1131
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1132
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1133
	}
1134
1135
	/**
1136
	 * Register assets for use in various modules and the Jetpack admin page.
1137
	 *
1138
	 * @uses wp_script_is, wp_register_script, plugins_url
1139
	 * @action wp_loaded
1140
	 * @return null
1141
	 */
1142
	public function register_assets() {
1143 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1144
			wp_register_script(
1145
				'jetpack-gallery-settings',
1146
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1147
				array( 'media-views' ),
1148
				'20121225'
1149
			);
1150
		}
1151
1152
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1153
			wp_register_script(
1154
				'jetpack-twitter-timeline',
1155
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1156
				array( 'jquery' ),
1157
				'4.0.0',
1158
				true
1159
			);
1160
		}
1161
1162
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1163
			wp_register_script(
1164
				'jetpack-facebook-embed',
1165
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1166
				array(),
1167
				null,
1168
				true
1169
			);
1170
1171
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1172
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1173
			if ( ! is_numeric( $fb_app_id ) ) {
1174
				$fb_app_id = '';
1175
			}
1176
			wp_localize_script(
1177
				'jetpack-facebook-embed',
1178
				'jpfbembed',
1179
				array(
1180
					'appid'  => $fb_app_id,
1181
					'locale' => $this->get_locale(),
1182
				)
1183
			);
1184
		}
1185
1186
		/**
1187
		 * As jetpack_register_genericons is by default fired off a hook,
1188
		 * the hook may have already fired by this point.
1189
		 * So, let's just trigger it manually.
1190
		 */
1191
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1192
		jetpack_register_genericons();
1193
1194
		/**
1195
		 * Register the social logos
1196
		 */
1197
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1198
		jetpack_register_social_logos();
1199
1200 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1201
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1202
		}
1203
	}
1204
1205
	/**
1206
	 * Guess locale from language code.
1207
	 *
1208
	 * @param string $lang Language code.
1209
	 * @return string|bool
1210
	 */
1211 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1212
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1213
			return 'en_US';
1214
		}
1215
1216
		if ( ! class_exists( 'GP_Locales' ) ) {
1217
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1218
				return false;
1219
			}
1220
1221
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1222
		}
1223
1224
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1225
			// WP.com: get_locale() returns 'it'
1226
			$locale = GP_Locales::by_slug( $lang );
1227
		} else {
1228
			// Jetpack: get_locale() returns 'it_IT';
1229
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1230
		}
1231
1232
		if ( ! $locale ) {
1233
			return false;
1234
		}
1235
1236
		if ( empty( $locale->facebook_locale ) ) {
1237
			if ( empty( $locale->wp_locale ) ) {
1238
				return false;
1239
			} else {
1240
				// Facebook SDK is smart enough to fall back to en_US if a
1241
				// locale isn't supported. Since supported Facebook locales
1242
				// can fall out of sync, we'll attempt to use the known
1243
				// wp_locale value and rely on said fallback.
1244
				return $locale->wp_locale;
1245
			}
1246
		}
1247
1248
		return $locale->facebook_locale;
1249
	}
1250
1251
	/**
1252
	 * Get the locale.
1253
	 *
1254
	 * @return string|bool
1255
	 */
1256
	function get_locale() {
1257
		$locale = $this->guess_locale_from_lang( get_locale() );
1258
1259
		if ( ! $locale ) {
1260
			$locale = 'en_US';
1261
		}
1262
1263
		return $locale;
1264
	}
1265
1266
	/**
1267
	 * Return the network_site_url so that .com knows what network this site is a part of.
1268
	 *
1269
	 * @param  bool $option
1270
	 * @return string
1271
	 */
1272
	public function jetpack_main_network_site_option( $option ) {
1273
		return network_site_url();
1274
	}
1275
	/**
1276
	 * Network Name.
1277
	 */
1278
	static function network_name( $option = null ) {
1279
		global $current_site;
1280
		return $current_site->site_name;
1281
	}
1282
	/**
1283
	 * Does the network allow new user and site registrations.
1284
	 *
1285
	 * @return string
1286
	 */
1287
	static function network_allow_new_registrations( $option = null ) {
1288
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1289
	}
1290
	/**
1291
	 * Does the network allow admins to add new users.
1292
	 *
1293
	 * @return boolian
1294
	 */
1295
	static function network_add_new_users( $option = null ) {
1296
		return (bool) get_site_option( 'add_new_users' );
1297
	}
1298
	/**
1299
	 * File upload psace left per site in MB.
1300
	 *  -1 means NO LIMIT.
1301
	 *
1302
	 * @return number
1303
	 */
1304
	static function network_site_upload_space( $option = null ) {
1305
		// value in MB
1306
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1307
	}
1308
1309
	/**
1310
	 * Network allowed file types.
1311
	 *
1312
	 * @return string
1313
	 */
1314
	static function network_upload_file_types( $option = null ) {
1315
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1316
	}
1317
1318
	/**
1319
	 * Maximum file upload size set by the network.
1320
	 *
1321
	 * @return number
1322
	 */
1323
	static function network_max_upload_file_size( $option = null ) {
1324
		// value in KB
1325
		return get_site_option( 'fileupload_maxk', 300 );
1326
	}
1327
1328
	/**
1329
	 * Lets us know if a site allows admins to manage the network.
1330
	 *
1331
	 * @return array
1332
	 */
1333
	static function network_enable_administration_menus( $option = null ) {
1334
		return get_site_option( 'menu_items' );
1335
	}
1336
1337
	/**
1338
	 * If a user has been promoted to or demoted from admin, we need to clear the
1339
	 * jetpack_other_linked_admins transient.
1340
	 *
1341
	 * @since 4.3.2
1342
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1343
	 *
1344
	 * @param int    $user_id   The user ID whose role changed.
1345
	 * @param string $role      The new role.
1346
	 * @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...
1347
	 */
1348
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1349
		if ( 'administrator' == $role
1350
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1351
			|| is_null( $old_roles )
1352
		) {
1353
			delete_transient( 'jetpack_other_linked_admins' );
1354
		}
1355
	}
1356
1357
	/**
1358
	 * Checks to see if there are any other users available to become primary
1359
	 * Users must both:
1360
	 * - Be linked to wpcom
1361
	 * - Be an admin
1362
	 *
1363
	 * @return mixed False if no other users are linked, Int if there are.
1364
	 */
1365
	static function get_other_linked_admins() {
1366
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1367
1368
		if ( false === $other_linked_users ) {
1369
			$admins = get_users( array( 'role' => 'administrator' ) );
1370
			if ( count( $admins ) > 1 ) {
1371
				$available = array();
1372
				foreach ( $admins as $admin ) {
1373
					if ( self::is_user_connected( $admin->ID ) ) {
1374
						$available[] = $admin->ID;
1375
					}
1376
				}
1377
1378
				$count_connected_admins = count( $available );
1379
				if ( count( $available ) > 1 ) {
1380
					$other_linked_users = $count_connected_admins;
1381
				} else {
1382
					$other_linked_users = 0;
1383
				}
1384
			} else {
1385
				$other_linked_users = 0;
1386
			}
1387
1388
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1389
		}
1390
1391
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1392
	}
1393
1394
	/**
1395
	 * Return whether we are dealing with a multi network setup or not.
1396
	 * The reason we are type casting this is because we want to avoid the situation where
1397
	 * the result is false since when is_main_network_option return false it cases
1398
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1399
	 * database which could be set to anything as opposed to what this function returns.
1400
	 *
1401
	 * @param  bool $option
1402
	 *
1403
	 * @return boolean
1404
	 */
1405
	public function is_main_network_option( $option ) {
1406
		// return '1' or ''
1407
		return (string) (bool) self::is_multi_network();
1408
	}
1409
1410
	/**
1411
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1412
	 *
1413
	 * @param  string $option
1414
	 * @return boolean
1415
	 */
1416
	public function is_multisite( $option ) {
1417
		return (string) (bool) is_multisite();
1418
	}
1419
1420
	/**
1421
	 * Implemented since there is no core is multi network function
1422
	 * Right now there is no way to tell if we which network is the dominant network on the system
1423
	 *
1424
	 * @since  3.3
1425
	 * @return boolean
1426
	 */
1427 View Code Duplication
	public static function is_multi_network() {
1428
		global  $wpdb;
1429
1430
		// if we don't have a multi site setup no need to do any more
1431
		if ( ! is_multisite() ) {
1432
			return false;
1433
		}
1434
1435
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1436
		if ( $num_sites > 1 ) {
1437
			return true;
1438
		} else {
1439
			return false;
1440
		}
1441
	}
1442
1443
	/**
1444
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1445
	 *
1446
	 * @return null
1447
	 */
1448
	function update_jetpack_main_network_site_option() {
1449
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1450
	}
1451
	/**
1452
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1453
	 */
1454
	function update_jetpack_network_settings() {
1455
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1456
		// Only sync this info for the main network site.
1457
	}
1458
1459
	/**
1460
	 * Get back if the current site is single user site.
1461
	 *
1462
	 * @return bool
1463
	 */
1464 View Code Duplication
	public static function is_single_user_site() {
1465
		global $wpdb;
1466
1467
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1468
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1469
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1470
		}
1471
		return 1 === (int) $some_users;
1472
	}
1473
1474
	/**
1475
	 * Returns true if the site has file write access false otherwise.
1476
	 *
1477
	 * @return string ( '1' | '0' )
1478
	 **/
1479
	public static function file_system_write_access() {
1480
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1481
			require_once ABSPATH . 'wp-admin/includes/file.php';
1482
		}
1483
1484
		require_once ABSPATH . 'wp-admin/includes/template.php';
1485
1486
		$filesystem_method = get_filesystem_method();
1487
		if ( $filesystem_method === 'direct' ) {
1488
			return 1;
1489
		}
1490
1491
		ob_start();
1492
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1493
		ob_end_clean();
1494
		if ( $filesystem_credentials_are_stored ) {
1495
			return 1;
1496
		}
1497
		return 0;
1498
	}
1499
1500
	/**
1501
	 * Finds out if a site is using a version control system.
1502
	 *
1503
	 * @return string ( '1' | '0' )
1504
	 **/
1505
	public static function is_version_controlled() {
1506
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1507
		return (string) (int) Functions::is_version_controlled();
1508
	}
1509
1510
	/**
1511
	 * Determines whether the current theme supports featured images or not.
1512
	 *
1513
	 * @return string ( '1' | '0' )
1514
	 */
1515
	public static function featured_images_enabled() {
1516
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1517
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1518
	}
1519
1520
	/**
1521
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1522
	 *
1523
	 * @deprecated 4.7 use get_avatar_url instead.
1524
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1525
	 * @param int               $size Size of the avatar image
1526
	 * @param string            $default URL to a default image to use if no avatar is available
1527
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1528
	 *
1529
	 * @return array
1530
	 */
1531
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1532
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1533
		return get_avatar_url(
1534
			$id_or_email,
1535
			array(
1536
				'size'          => $size,
1537
				'default'       => $default,
1538
				'force_default' => $force_display,
1539
			)
1540
		);
1541
	}
1542
1543
	/**
1544
	 * jetpack_updates is saved in the following schema:
1545
	 *
1546
	 * array (
1547
	 *      'plugins'                       => (int) Number of plugin updates available.
1548
	 *      'themes'                        => (int) Number of theme updates available.
1549
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1550
	 *      'translations'                  => (int) Number of translation updates available.
1551
	 *      'total'                         => (int) Total of all available updates.
1552
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1553
	 * )
1554
	 *
1555
	 * @return array
1556
	 */
1557
	public static function get_updates() {
1558
		$update_data = wp_get_update_data();
1559
1560
		// Stores the individual update counts as well as the total count.
1561
		if ( isset( $update_data['counts'] ) ) {
1562
			$updates = $update_data['counts'];
1563
		}
1564
1565
		// If we need to update WordPress core, let's find the latest version number.
1566 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1567
			$cur = get_preferred_from_update_core();
1568
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1569
				$updates['wp_update_version'] = $cur->current;
1570
			}
1571
		}
1572
		return isset( $updates ) ? $updates : array();
1573
	}
1574
1575
	public static function get_update_details() {
1576
		$update_details = array(
1577
			'update_core'    => get_site_transient( 'update_core' ),
1578
			'update_plugins' => get_site_transient( 'update_plugins' ),
1579
			'update_themes'  => get_site_transient( 'update_themes' ),
1580
		);
1581
		return $update_details;
1582
	}
1583
1584
	public static function refresh_update_data() {
1585
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1586
1587
	}
1588
1589
	public static function refresh_theme_data() {
1590
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1591
	}
1592
1593
	/**
1594
	 * Is Jetpack active?
1595
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1596
	 *
1597
	 * @return bool
1598
	 */
1599
	public static function is_active() {
1600
		return self::connection()->is_active();
1601
	}
1602
1603
	/**
1604
	 * Make an API call to WordPress.com for plan status
1605
	 *
1606
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1607
	 *
1608
	 * @return bool True if plan is updated, false if no update
1609
	 */
1610
	public static function refresh_active_plan_from_wpcom() {
1611
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1612
		return Jetpack_Plan::refresh_from_wpcom();
1613
	}
1614
1615
	/**
1616
	 * Get the plan that this Jetpack site is currently using
1617
	 *
1618
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1619
	 * @return array Active Jetpack plan details.
1620
	 */
1621
	public static function get_active_plan() {
1622
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1623
		return Jetpack_Plan::get();
1624
	}
1625
1626
	/**
1627
	 * Determine whether the active plan supports a particular feature
1628
	 *
1629
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1630
	 * @return bool True if plan supports feature, false if not.
1631
	 */
1632
	public static function active_plan_supports( $feature ) {
1633
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1634
		return Jetpack_Plan::supports( $feature );
1635
	}
1636
1637
	/**
1638
	 * Deprecated: Is Jetpack in development (offline) mode?
1639
	 *
1640
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1641
	 * and themes still use it, and we do not want to flood them with notices.
1642
	 *
1643
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1644
	 *
1645
	 * @deprecated since 8.0.
1646
	 */
1647
	public static function is_development_mode() {
1648
		return ( new Status() )->is_development_mode();
1649
	}
1650
1651
	/**
1652
	 * Whether the site is currently onboarding or not.
1653
	 * A site is considered as being onboarded if it currently has an onboarding token.
1654
	 *
1655
	 * @since 5.8
1656
	 *
1657
	 * @access public
1658
	 * @static
1659
	 *
1660
	 * @return bool True if the site is currently onboarding, false otherwise
1661
	 */
1662
	public static function is_onboarding() {
1663
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1664
	}
1665
1666
	/**
1667
	 * Determines reason for Jetpack development mode.
1668
	 */
1669
	public static function development_mode_trigger_text() {
1670
		if ( ! ( new Status() )->is_development_mode() ) {
1671
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1672
		}
1673
1674
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1675
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1676
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1677
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1678
		} else {
1679
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1680
		}
1681
1682
		return $notice;
1683
1684
	}
1685
	/**
1686
	 * Get Jetpack development mode notice text and notice class.
1687
	 *
1688
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1689
	 */
1690
	public static function show_development_mode_notice() {
1691 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1692
			$notice = sprintf(
1693
				/* translators: %s is a URL */
1694
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1695
				Redirect::get_url( 'jetpack-support-development-mode' )
1696
			);
1697
1698
			$notice .= ' ' . self::development_mode_trigger_text();
1699
1700
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1701
		}
1702
1703
		// Throw up a notice if using a development version and as for feedback.
1704
		if ( self::is_development_version() ) {
1705
			/* translators: %s is a URL */
1706
			$notice = sprintf( __( 'You are currently running a development version of Jetpack. <a href="%s" target="_blank">Submit your feedback</a>', 'jetpack' ), Redirect::get_url( 'jetpack-contact-support-beta-group' ) );
1707
1708
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1709
		}
1710
		// Throw up a notice if using staging mode
1711 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1712
			/* translators: %s is a URL */
1713
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1714
1715
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1716
		}
1717
	}
1718
1719
	/**
1720
	 * Whether Jetpack's version maps to a public release, or a development version.
1721
	 */
1722
	public static function is_development_version() {
1723
		/**
1724
		 * Allows filtering whether this is a development version of Jetpack.
1725
		 *
1726
		 * This filter is especially useful for tests.
1727
		 *
1728
		 * @since 4.3.0
1729
		 *
1730
		 * @param bool $development_version Is this a develoment version of Jetpack?
1731
		 */
1732
		return (bool) apply_filters(
1733
			'jetpack_development_version',
1734
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1735
		);
1736
	}
1737
1738
	/**
1739
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1740
	 */
1741
	public static function is_user_connected( $user_id = false ) {
1742
		return self::connection()->is_user_connected( $user_id );
1743
	}
1744
1745
	/**
1746
	 * Get the wpcom user data of the current|specified connected user.
1747
	 */
1748 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1749
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1750
		if ( ! $user_id ) {
1751
			$user_id = get_current_user_id();
1752
		}
1753
1754
		$transient_key = "jetpack_connected_user_data_$user_id";
1755
1756
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1757
			return $cached_user_data;
1758
		}
1759
1760
		$xml = new Jetpack_IXR_Client(
1761
			array(
1762
				'user_id' => $user_id,
1763
			)
1764
		);
1765
		$xml->query( 'wpcom.getUser' );
1766
		if ( ! $xml->isError() ) {
1767
			$user_data = $xml->getResponse();
1768
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1769
			return $user_data;
1770
		}
1771
1772
		return false;
1773
	}
1774
1775
	/**
1776
	 * Get the wpcom email of the current|specified connected user.
1777
	 */
1778
	public static function get_connected_user_email( $user_id = null ) {
1779
		if ( ! $user_id ) {
1780
			$user_id = get_current_user_id();
1781
		}
1782
1783
		$xml = new Jetpack_IXR_Client(
1784
			array(
1785
				'user_id' => $user_id,
1786
			)
1787
		);
1788
		$xml->query( 'wpcom.getUserEmail' );
1789
		if ( ! $xml->isError() ) {
1790
			return $xml->getResponse();
1791
		}
1792
		return false;
1793
	}
1794
1795
	/**
1796
	 * Get the wpcom email of the master user.
1797
	 */
1798
	public static function get_master_user_email() {
1799
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1800
		if ( $master_user_id ) {
1801
			return self::get_connected_user_email( $master_user_id );
1802
		}
1803
		return '';
1804
	}
1805
1806
	/**
1807
	 * Whether the current user is the connection owner.
1808
	 *
1809
	 * @deprecated since 7.7
1810
	 *
1811
	 * @return bool Whether the current user is the connection owner.
1812
	 */
1813
	public function current_user_is_connection_owner() {
1814
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1815
		return self::connection()->is_connection_owner();
1816
	}
1817
1818
	/**
1819
	 * Gets current user IP address.
1820
	 *
1821
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1822
	 *
1823
	 * @return string                  Current user IP address.
1824
	 */
1825
	public static function current_user_ip( $check_all_headers = false ) {
1826
		if ( $check_all_headers ) {
1827
			foreach ( array(
1828
				'HTTP_CF_CONNECTING_IP',
1829
				'HTTP_CLIENT_IP',
1830
				'HTTP_X_FORWARDED_FOR',
1831
				'HTTP_X_FORWARDED',
1832
				'HTTP_X_CLUSTER_CLIENT_IP',
1833
				'HTTP_FORWARDED_FOR',
1834
				'HTTP_FORWARDED',
1835
				'HTTP_VIA',
1836
			) as $key ) {
1837
				if ( ! empty( $_SERVER[ $key ] ) ) {
1838
					return $_SERVER[ $key ];
1839
				}
1840
			}
1841
		}
1842
1843
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1844
	}
1845
1846
	/**
1847
	 * Synchronize connected user role changes
1848
	 */
1849
	function user_role_change( $user_id ) {
1850
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1851
		Users::user_role_change( $user_id );
1852
	}
1853
1854
	/**
1855
	 * Loads the currently active modules.
1856
	 */
1857
	public static function load_modules() {
1858
		$is_development_mode = ( new Status() )->is_development_mode();
1859
		if (
1860
			! self::is_active()
1861
			&& ! $is_development_mode
1862
			&& ! self::is_onboarding()
1863
			&& (
1864
				! is_multisite()
1865
				|| ! get_site_option( 'jetpack_protect_active' )
1866
			)
1867
		) {
1868
			return;
1869
		}
1870
1871
		$version = Jetpack_Options::get_option( 'version' );
1872 View Code Duplication
		if ( ! $version ) {
1873
			$version = $old_version = JETPACK__VERSION . ':' . time();
1874
			/** This action is documented in class.jetpack.php */
1875
			do_action( 'updating_jetpack_version', $version, false );
1876
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1877
		}
1878
		list( $version ) = explode( ':', $version );
1879
1880
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1881
1882
		$modules_data = array();
1883
1884
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1885
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1886
			$updated_modules = array();
1887
			foreach ( $modules as $module ) {
1888
				$modules_data[ $module ] = self::get_module( $module );
1889
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1890
					continue;
1891
				}
1892
1893
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1894
					continue;
1895
				}
1896
1897
				$updated_modules[] = $module;
1898
			}
1899
1900
			$modules = array_diff( $modules, $updated_modules );
1901
		}
1902
1903
		foreach ( $modules as $index => $module ) {
1904
			// If we're in dev mode, disable modules requiring a connection
1905
			if ( $is_development_mode ) {
1906
				// Prime the pump if we need to
1907
				if ( empty( $modules_data[ $module ] ) ) {
1908
					$modules_data[ $module ] = self::get_module( $module );
1909
				}
1910
				// If the module requires a connection, but we're in local mode, don't include it.
1911
				if ( $modules_data[ $module ]['requires_connection'] ) {
1912
					continue;
1913
				}
1914
			}
1915
1916
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1917
				continue;
1918
			}
1919
1920
			if ( ! include_once self::get_module_path( $module ) ) {
1921
				unset( $modules[ $index ] );
1922
				self::update_active_modules( array_values( $modules ) );
1923
				continue;
1924
			}
1925
1926
			/**
1927
			 * Fires when a specific module is loaded.
1928
			 * The dynamic part of the hook, $module, is the module slug.
1929
			 *
1930
			 * @since 1.1.0
1931
			 */
1932
			do_action( 'jetpack_module_loaded_' . $module );
1933
		}
1934
1935
		/**
1936
		 * Fires when all the modules are loaded.
1937
		 *
1938
		 * @since 1.1.0
1939
		 */
1940
		do_action( 'jetpack_modules_loaded' );
1941
1942
		// 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.
1943
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1944
	}
1945
1946
	/**
1947
	 * Check if Jetpack's REST API compat file should be included
1948
	 *
1949
	 * @action plugins_loaded
1950
	 * @return null
1951
	 */
1952
	public function check_rest_api_compat() {
1953
		/**
1954
		 * Filters the list of REST API compat files to be included.
1955
		 *
1956
		 * @since 2.2.5
1957
		 *
1958
		 * @param array $args Array of REST API compat files to include.
1959
		 */
1960
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1961
1962
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1963
			require_once $_jetpack_rest_api_compat_include;
1964
		}
1965
	}
1966
1967
	/**
1968
	 * Gets all plugins currently active in values, regardless of whether they're
1969
	 * traditionally activated or network activated.
1970
	 *
1971
	 * @todo Store the result in core's object cache maybe?
1972
	 */
1973
	public static function get_active_plugins() {
1974
		$active_plugins = (array) get_option( 'active_plugins', array() );
1975
1976
		if ( is_multisite() ) {
1977
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
1978
			// whereas active_plugins stores them in the values.
1979
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
1980
			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...
1981
				$active_plugins = array_merge( $active_plugins, $network_plugins );
1982
			}
1983
		}
1984
1985
		sort( $active_plugins );
1986
1987
		return array_unique( $active_plugins );
1988
	}
1989
1990
	/**
1991
	 * Gets and parses additional plugin data to send with the heartbeat data
1992
	 *
1993
	 * @since 3.8.1
1994
	 *
1995
	 * @return array Array of plugin data
1996
	 */
1997
	public static function get_parsed_plugin_data() {
1998
		if ( ! function_exists( 'get_plugins' ) ) {
1999
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2000
		}
2001
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2002
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2003
		$active_plugins = self::get_active_plugins();
2004
2005
		$plugins = array();
2006
		foreach ( $all_plugins as $path => $plugin_data ) {
2007
			$plugins[ $path ] = array(
2008
				'is_active' => in_array( $path, $active_plugins ),
2009
				'file'      => $path,
2010
				'name'      => $plugin_data['Name'],
2011
				'version'   => $plugin_data['Version'],
2012
				'author'    => $plugin_data['Author'],
2013
			);
2014
		}
2015
2016
		return $plugins;
2017
	}
2018
2019
	/**
2020
	 * Gets and parses theme data to send with the heartbeat data
2021
	 *
2022
	 * @since 3.8.1
2023
	 *
2024
	 * @return array Array of theme data
2025
	 */
2026
	public static function get_parsed_theme_data() {
2027
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2028
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2029
2030
		$themes = array();
2031
		foreach ( $all_themes as $slug => $theme_data ) {
2032
			$theme_headers = array();
2033
			foreach ( $header_keys as $header_key ) {
2034
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2035
			}
2036
2037
			$themes[ $slug ] = array(
2038
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2039
				'slug'            => $slug,
2040
				'theme_root'      => $theme_data->get_theme_root_uri(),
2041
				'parent'          => $theme_data->parent(),
2042
				'headers'         => $theme_headers,
2043
			);
2044
		}
2045
2046
		return $themes;
2047
	}
2048
2049
	/**
2050
	 * Checks whether a specific plugin is active.
2051
	 *
2052
	 * We don't want to store these in a static variable, in case
2053
	 * there are switch_to_blog() calls involved.
2054
	 */
2055
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2056
		return in_array( $plugin, self::get_active_plugins() );
2057
	}
2058
2059
	/**
2060
	 * Check if Jetpack's Open Graph tags should be used.
2061
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2062
	 *
2063
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2064
	 * @action plugins_loaded
2065
	 * @return null
2066
	 */
2067
	public function check_open_graph() {
2068
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2069
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2070
		}
2071
2072
		$active_plugins = self::get_active_plugins();
2073
2074
		if ( ! empty( $active_plugins ) ) {
2075
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2076
				if ( in_array( $plugin, $active_plugins ) ) {
2077
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2078
					break;
2079
				}
2080
			}
2081
		}
2082
2083
		/**
2084
		 * Allow the addition of Open Graph Meta Tags to all pages.
2085
		 *
2086
		 * @since 2.0.3
2087
		 *
2088
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2089
		 */
2090
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2091
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2092
		}
2093
	}
2094
2095
	/**
2096
	 * Check if Jetpack's Twitter tags should be used.
2097
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2098
	 *
2099
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2100
	 * @action plugins_loaded
2101
	 * @return null
2102
	 */
2103
	public function check_twitter_tags() {
2104
2105
		$active_plugins = self::get_active_plugins();
2106
2107
		if ( ! empty( $active_plugins ) ) {
2108
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2109
				if ( in_array( $plugin, $active_plugins ) ) {
2110
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2111
					break;
2112
				}
2113
			}
2114
		}
2115
2116
		/**
2117
		 * Allow Twitter Card Meta tags to be disabled.
2118
		 *
2119
		 * @since 2.6.0
2120
		 *
2121
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2122
		 */
2123
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2124
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2125
		}
2126
	}
2127
2128
	/**
2129
	 * Allows plugins to submit security reports.
2130
	 *
2131
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2132
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2133
	 * @param array  $args         See definitions above
2134
	 */
2135
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2136
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2137
	}
2138
2139
	/* Jetpack Options API */
2140
2141
	public static function get_option_names( $type = 'compact' ) {
2142
		return Jetpack_Options::get_option_names( $type );
2143
	}
2144
2145
	/**
2146
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2147
	 *
2148
	 * @param string $name    Option name
2149
	 * @param mixed  $default (optional)
2150
	 */
2151
	public static function get_option( $name, $default = false ) {
2152
		return Jetpack_Options::get_option( $name, $default );
2153
	}
2154
2155
	/**
2156
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2157
	 *
2158
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2159
	 * @param string $name  Option name
2160
	 * @param mixed  $value Option value
2161
	 */
2162
	public static function update_option( $name, $value ) {
2163
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2164
		return Jetpack_Options::update_option( $name, $value );
2165
	}
2166
2167
	/**
2168
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2169
	 *
2170
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2171
	 * @param array $array array( option name => option value, ... )
2172
	 */
2173
	public static function update_options( $array ) {
2174
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2175
		return Jetpack_Options::update_options( $array );
2176
	}
2177
2178
	/**
2179
	 * Deletes the given option.  May be passed multiple option names as an array.
2180
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2181
	 *
2182
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2183
	 * @param string|array $names
2184
	 */
2185
	public static function delete_option( $names ) {
2186
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2187
		return Jetpack_Options::delete_option( $names );
2188
	}
2189
2190
	/**
2191
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2192
	 *
2193
	 * Enters a user token into the user_tokens option
2194
	 *
2195
	 * @param int    $user_id The user id.
2196
	 * @param string $token The user token.
2197
	 * @param bool   $is_master_user Whether the user is the master user.
2198
	 * @return bool
2199
	 */
2200
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2201
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2202
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2203
	}
2204
2205
	/**
2206
	 * Returns an array of all PHP files in the specified absolute path.
2207
	 * Equivalent to glob( "$absolute_path/*.php" ).
2208
	 *
2209
	 * @param string $absolute_path The absolute path of the directory to search.
2210
	 * @return array Array of absolute paths to the PHP files.
2211
	 */
2212
	public static function glob_php( $absolute_path ) {
2213
		if ( function_exists( 'glob' ) ) {
2214
			return glob( "$absolute_path/*.php" );
2215
		}
2216
2217
		$absolute_path = untrailingslashit( $absolute_path );
2218
		$files         = array();
2219
		if ( ! $dir = @opendir( $absolute_path ) ) {
2220
			return $files;
2221
		}
2222
2223
		while ( false !== $file = readdir( $dir ) ) {
2224
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2225
				continue;
2226
			}
2227
2228
			$file = "$absolute_path/$file";
2229
2230
			if ( ! is_file( $file ) ) {
2231
				continue;
2232
			}
2233
2234
			$files[] = $file;
2235
		}
2236
2237
		closedir( $dir );
2238
2239
		return $files;
2240
	}
2241
2242
	public static function activate_new_modules( $redirect = false ) {
2243
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2244
			return;
2245
		}
2246
2247
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2248 View Code Duplication
		if ( ! $jetpack_old_version ) {
2249
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2250
			/** This action is documented in class.jetpack.php */
2251
			do_action( 'updating_jetpack_version', $version, false );
2252
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2253
		}
2254
2255
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2256
2257
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2258
			return;
2259
		}
2260
2261
		$active_modules     = self::get_active_modules();
2262
		$reactivate_modules = array();
2263
		foreach ( $active_modules as $active_module ) {
2264
			$module = self::get_module( $active_module );
2265
			if ( ! isset( $module['changed'] ) ) {
2266
				continue;
2267
			}
2268
2269
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2270
				continue;
2271
			}
2272
2273
			$reactivate_modules[] = $active_module;
2274
			self::deactivate_module( $active_module );
2275
		}
2276
2277
		$new_version = JETPACK__VERSION . ':' . time();
2278
		/** This action is documented in class.jetpack.php */
2279
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2280
		Jetpack_Options::update_options(
2281
			array(
2282
				'version'     => $new_version,
2283
				'old_version' => $jetpack_old_version,
2284
			)
2285
		);
2286
2287
		self::state( 'message', 'modules_activated' );
2288
2289
		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...
2290
2291
		if ( $redirect ) {
2292
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2293
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2294
				$page = $_GET['page'];
2295
			}
2296
2297
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2298
			exit;
2299
		}
2300
	}
2301
2302
	/**
2303
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2304
	 * Make sure to tuck away module "library" files in a sub-directory.
2305
	 */
2306
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2307
		static $modules = null;
2308
2309
		if ( ! isset( $modules ) ) {
2310
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2311
			// Use the cache if we're on the front-end and it's available...
2312
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2313
				$modules = $available_modules_option[ JETPACK__VERSION ];
2314
			} else {
2315
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2316
2317
				$modules = array();
2318
2319
				foreach ( $files as $file ) {
2320
					if ( ! $headers = self::get_module( $file ) ) {
2321
						continue;
2322
					}
2323
2324
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2325
				}
2326
2327
				Jetpack_Options::update_option(
2328
					'available_modules',
2329
					array(
2330
						JETPACK__VERSION => $modules,
2331
					)
2332
				);
2333
			}
2334
		}
2335
2336
		/**
2337
		 * Filters the array of modules available to be activated.
2338
		 *
2339
		 * @since 2.4.0
2340
		 *
2341
		 * @param array $modules Array of available modules.
2342
		 * @param string $min_version Minimum version number required to use modules.
2343
		 * @param string $max_version Maximum version number required to use modules.
2344
		 */
2345
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $min_version.

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...
2346
2347
		if ( ! $min_version && ! $max_version ) {
2348
			return array_keys( $mods );
2349
		}
2350
2351
		$r = array();
2352
		foreach ( $mods as $slug => $introduced ) {
2353
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2354
				continue;
2355
			}
2356
2357
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2358
				continue;
2359
			}
2360
2361
			$r[] = $slug;
2362
		}
2363
2364
		return $r;
2365
	}
2366
2367
	/**
2368
	 * Default modules loaded on activation.
2369
	 */
2370
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2371
		$return = array();
2372
2373
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2374
			$module_data = self::get_module( $module );
2375
2376
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2377
				case 'yes':
2378
					$return[] = $module;
2379
					break;
2380
				case 'public':
2381
					if ( Jetpack_Options::get_option( 'public' ) ) {
2382
						$return[] = $module;
2383
					}
2384
					break;
2385
				case 'no':
2386
				default:
2387
					break;
2388
			}
2389
		}
2390
		/**
2391
		 * Filters the array of default modules.
2392
		 *
2393
		 * @since 2.5.0
2394
		 *
2395
		 * @param array $return Array of default modules.
2396
		 * @param string $min_version Minimum version number required to use modules.
2397
		 * @param string $max_version Maximum version number required to use modules.
2398
		 */
2399
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $min_version.

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...
2400
	}
2401
2402
	/**
2403
	 * Checks activated modules during auto-activation to determine
2404
	 * if any of those modules are being deprecated.  If so, close
2405
	 * them out, and add any replacement modules.
2406
	 *
2407
	 * Runs at priority 99 by default.
2408
	 *
2409
	 * This is run late, so that it can still activate a module if
2410
	 * the new module is a replacement for another that the user
2411
	 * currently has active, even if something at the normal priority
2412
	 * would kibosh everything.
2413
	 *
2414
	 * @since 2.6
2415
	 * @uses jetpack_get_default_modules filter
2416
	 * @param array $modules
2417
	 * @return array
2418
	 */
2419
	function handle_deprecated_modules( $modules ) {
2420
		$deprecated_modules = array(
2421
			'debug'            => null,  // Closed out and moved to the debugger library.
2422
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2423
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2424
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2425
		);
2426
2427
		// Don't activate SSO if they never completed activating WPCC.
2428
		if ( self::is_module_active( 'wpcc' ) ) {
2429
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2430
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2431
				$deprecated_modules['wpcc'] = null;
2432
			}
2433
		}
2434
2435
		foreach ( $deprecated_modules as $module => $replacement ) {
2436
			if ( self::is_module_active( $module ) ) {
2437
				self::deactivate_module( $module );
2438
				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...
2439
					$modules[] = $replacement;
2440
				}
2441
			}
2442
		}
2443
2444
		return array_unique( $modules );
2445
	}
2446
2447
	/**
2448
	 * Checks activated plugins during auto-activation to determine
2449
	 * if any of those plugins are in the list with a corresponding module
2450
	 * that is not compatible with the plugin. The module will not be allowed
2451
	 * to auto-activate.
2452
	 *
2453
	 * @since 2.6
2454
	 * @uses jetpack_get_default_modules filter
2455
	 * @param array $modules
2456
	 * @return array
2457
	 */
2458
	function filter_default_modules( $modules ) {
2459
2460
		$active_plugins = self::get_active_plugins();
2461
2462
		if ( ! empty( $active_plugins ) ) {
2463
2464
			// For each module we'd like to auto-activate...
2465
			foreach ( $modules as $key => $module ) {
2466
				// If there are potential conflicts for it...
2467
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2468
					// For each potential conflict...
2469
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2470
						// If that conflicting plugin is active...
2471
						if ( in_array( $plugin, $active_plugins ) ) {
2472
							// Remove that item from being auto-activated.
2473
							unset( $modules[ $key ] );
2474
						}
2475
					}
2476
				}
2477
			}
2478
		}
2479
2480
		return $modules;
2481
	}
2482
2483
	/**
2484
	 * Extract a module's slug from its full path.
2485
	 */
2486
	public static function get_module_slug( $file ) {
2487
		return str_replace( '.php', '', basename( $file ) );
2488
	}
2489
2490
	/**
2491
	 * Generate a module's path from its slug.
2492
	 */
2493
	public static function get_module_path( $slug ) {
2494
		/**
2495
		 * Filters the path of a modules.
2496
		 *
2497
		 * @since 7.4.0
2498
		 *
2499
		 * @param array $return The absolute path to a module's root php file
2500
		 * @param string $slug The module slug
2501
		 */
2502
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $slug.

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...
2503
	}
2504
2505
	/**
2506
	 * Load module data from module file. Headers differ from WordPress
2507
	 * plugin headers to avoid them being identified as standalone
2508
	 * plugins on the WordPress plugins page.
2509
	 */
2510
	public static function get_module( $module ) {
2511
		$headers = array(
2512
			'name'                      => 'Module Name',
2513
			'description'               => 'Module Description',
2514
			'sort'                      => 'Sort Order',
2515
			'recommendation_order'      => 'Recommendation Order',
2516
			'introduced'                => 'First Introduced',
2517
			'changed'                   => 'Major Changes In',
2518
			'deactivate'                => 'Deactivate',
2519
			'free'                      => 'Free',
2520
			'requires_connection'       => 'Requires Connection',
2521
			'auto_activate'             => 'Auto Activate',
2522
			'module_tags'               => 'Module Tags',
2523
			'feature'                   => 'Feature',
2524
			'additional_search_queries' => 'Additional Search Queries',
2525
			'plan_classes'              => 'Plans',
2526
		);
2527
2528
		$file = self::get_module_path( self::get_module_slug( $module ) );
2529
2530
		$mod = self::get_file_data( $file, $headers );
2531
		if ( empty( $mod['name'] ) ) {
2532
			return false;
2533
		}
2534
2535
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2536
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2537
		$mod['deactivate']           = empty( $mod['deactivate'] );
2538
		$mod['free']                 = empty( $mod['free'] );
2539
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2540
2541
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2542
			$mod['auto_activate'] = 'No';
2543
		} else {
2544
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2545
		}
2546
2547
		if ( $mod['module_tags'] ) {
2548
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2549
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2550
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2551
		} else {
2552
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2553
		}
2554
2555 View Code Duplication
		if ( $mod['plan_classes'] ) {
2556
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2557
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2558
		} else {
2559
			$mod['plan_classes'] = array( 'free' );
2560
		}
2561
2562 View Code Duplication
		if ( $mod['feature'] ) {
2563
			$mod['feature'] = explode( ',', $mod['feature'] );
2564
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2565
		} else {
2566
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2567
		}
2568
2569
		/**
2570
		 * Filters the feature array on a module.
2571
		 *
2572
		 * This filter allows you to control where each module is filtered: Recommended,
2573
		 * and the default "Other" listing.
2574
		 *
2575
		 * @since 3.5.0
2576
		 *
2577
		 * @param array   $mod['feature'] The areas to feature this module:
2578
		 *     'Recommended' shows on the main Jetpack admin screen.
2579
		 *     'Other' should be the default if no other value is in the array.
2580
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2581
		 * @param array   $mod All the currently assembled module data.
2582
		 */
2583
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $module.

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...
2584
2585
		/**
2586
		 * Filter the returned data about a module.
2587
		 *
2588
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2589
		 * so please be careful.
2590
		 *
2591
		 * @since 3.6.0
2592
		 *
2593
		 * @param array   $mod    The details of the requested module.
2594
		 * @param string  $module The slug of the module, e.g. sharedaddy
2595
		 * @param string  $file   The path to the module source file.
2596
		 */
2597
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $module.

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...
2598
	}
2599
2600
	/**
2601
	 * Like core's get_file_data implementation, but caches the result.
2602
	 */
2603
	public static function get_file_data( $file, $headers ) {
2604
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2605
		$file_name = basename( $file );
2606
2607
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2608
2609
		$file_data_option = get_transient( $cache_key );
2610
2611
		if ( ! is_array( $file_data_option ) ) {
2612
			delete_transient( $cache_key );
2613
			$file_data_option = false;
2614
		}
2615
2616
		if ( false === $file_data_option ) {
2617
			$file_data_option = array();
2618
		}
2619
2620
		$key           = md5( $file_name . serialize( $headers ) );
2621
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2622
2623
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2624
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2625
			return $file_data_option[ $key ];
2626
		}
2627
2628
		$data = get_file_data( $file, $headers );
2629
2630
		$file_data_option[ $key ] = $data;
2631
2632
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2633
2634
		return $data;
2635
	}
2636
2637
2638
	/**
2639
	 * Return translated module tag.
2640
	 *
2641
	 * @param string $tag Tag as it appears in each module heading.
2642
	 *
2643
	 * @return mixed
2644
	 */
2645
	public static function translate_module_tag( $tag ) {
2646
		return jetpack_get_module_i18n_tag( $tag );
2647
	}
2648
2649
	/**
2650
	 * Get i18n strings as a JSON-encoded string
2651
	 *
2652
	 * @return string The locale as JSON
2653
	 */
2654
	public static function get_i18n_data_json() {
2655
2656
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2657
		// JSON files with the file they should be included for. This is an md5
2658
		// of '_inc/build/admin.js'.
2659
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2660
2661
		$i18n_json =
2662
				   JETPACK__PLUGIN_DIR
2663
				   . 'languages/json/jetpack-'
2664
				   . get_user_locale()
2665
				   . '-'
2666
				   . $path_md5
2667
				   . '.json';
2668
2669
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2670
			$locale_data = @file_get_contents( $i18n_json );
2671
			if ( $locale_data ) {
2672
				return $locale_data;
2673
			}
2674
		}
2675
2676
		// Return valid empty Jed locale
2677
		return '{ "locale_data": { "messages": { "": {} } } }';
2678
	}
2679
2680
	/**
2681
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2682
	 *
2683
	 * @since 3.9.2
2684
	 *
2685
	 * @param array $modules
2686
	 *
2687
	 * @return string|void
2688
	 */
2689
	public static function get_translated_modules( $modules ) {
2690
		foreach ( $modules as $index => $module ) {
2691
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2692
			if ( isset( $module['name'] ) ) {
2693
				$modules[ $index ]['name'] = $i18n_module['name'];
2694
			}
2695
			if ( isset( $module['description'] ) ) {
2696
				$modules[ $index ]['description']       = $i18n_module['description'];
2697
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2698
			}
2699
		}
2700
		return $modules;
2701
	}
2702
2703
	/**
2704
	 * Get a list of activated modules as an array of module slugs.
2705
	 */
2706
	public static function get_active_modules() {
2707
		$active = Jetpack_Options::get_option( 'active_modules' );
2708
2709
		if ( ! is_array( $active ) ) {
2710
			$active = array();
2711
		}
2712
2713
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2714
			$active[] = 'vaultpress';
2715
		} else {
2716
			$active = array_diff( $active, array( 'vaultpress' ) );
2717
		}
2718
2719
		// If protect is active on the main site of a multisite, it should be active on all sites.
2720
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2721
			$active[] = 'protect';
2722
		}
2723
2724
		/**
2725
		 * Allow filtering of the active modules.
2726
		 *
2727
		 * Gives theme and plugin developers the power to alter the modules that
2728
		 * are activated on the fly.
2729
		 *
2730
		 * @since 5.8.0
2731
		 *
2732
		 * @param array $active Array of active module slugs.
2733
		 */
2734
		$active = apply_filters( 'jetpack_active_modules', $active );
2735
2736
		return array_unique( $active );
2737
	}
2738
2739
	/**
2740
	 * Check whether or not a Jetpack module is active.
2741
	 *
2742
	 * @param string $module The slug of a Jetpack module.
2743
	 * @return bool
2744
	 *
2745
	 * @static
2746
	 */
2747
	public static function is_module_active( $module ) {
2748
		return in_array( $module, self::get_active_modules() );
2749
	}
2750
2751
	public static function is_module( $module ) {
2752
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2753
	}
2754
2755
	/**
2756
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2757
	 *
2758
	 * @param bool $catch True to start catching, False to stop.
2759
	 *
2760
	 * @static
2761
	 */
2762
	public static function catch_errors( $catch ) {
2763
		static $display_errors, $error_reporting;
2764
2765
		if ( $catch ) {
2766
			$display_errors  = @ini_set( 'display_errors', 1 );
2767
			$error_reporting = @error_reporting( E_ALL );
2768
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2769
		} else {
2770
			@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...
2771
			@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...
2772
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2773
		}
2774
	}
2775
2776
	/**
2777
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2778
	 */
2779
	public static function catch_errors_on_shutdown() {
2780
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2781
	}
2782
2783
	/**
2784
	 * Rewrite any string to make paths easier to read.
2785
	 *
2786
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2787
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2788
	 *
2789
	 * @param $string
2790
	 * @return mixed
2791
	 */
2792
	public static function alias_directories( $string ) {
2793
		// ABSPATH has a trailing slash.
2794
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2795
		// WP_CONTENT_DIR does not have a trailing slash.
2796
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2797
2798
		return $string;
2799
	}
2800
2801
	public static function activate_default_modules(
2802
		$min_version = false,
2803
		$max_version = false,
2804
		$other_modules = array(),
2805
		$redirect = null,
2806
		$send_state_messages = null
2807
	) {
2808
		$jetpack = self::init();
2809
2810
		if ( is_null( $redirect ) ) {
2811
			if (
2812
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2813
			||
2814
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2815
			||
2816
				( defined( 'WP_CLI' ) && WP_CLI )
2817
			||
2818
				( defined( 'DOING_CRON' ) && DOING_CRON )
2819
			||
2820
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2821
			) {
2822
				$redirect = false;
2823
			} elseif ( is_admin() ) {
2824
				$redirect = true;
2825
			} else {
2826
				$redirect = false;
2827
			}
2828
		}
2829
2830
		if ( is_null( $send_state_messages ) ) {
2831
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2832
		}
2833
2834
		$modules = self::get_default_modules( $min_version, $max_version );
2835
		$modules = array_merge( $other_modules, $modules );
2836
2837
		// Look for standalone plugins and disable if active.
2838
2839
		$to_deactivate = array();
2840
		foreach ( $modules as $module ) {
2841
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2842
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2843
			}
2844
		}
2845
2846
		$deactivated = array();
2847
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2848
			list( $probable_file, $probable_title ) = $deactivate_me;
2849
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2850
				$deactivated[] = $module;
2851
			}
2852
		}
2853
2854
		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...
2855
			if ( $send_state_messages ) {
2856
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2857
			}
2858
2859
			if ( $redirect ) {
2860
				$url = add_query_arg(
2861
					array(
2862
						'action'   => 'activate_default_modules',
2863
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2864
					),
2865
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2866
				);
2867
				wp_safe_redirect( $url );
2868
				exit;
2869
			}
2870
		}
2871
2872
		/**
2873
		 * Fires before default modules are activated.
2874
		 *
2875
		 * @since 1.9.0
2876
		 *
2877
		 * @param string $min_version Minimum version number required to use modules.
2878
		 * @param string $max_version Maximum version number required to use modules.
2879
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2880
		 */
2881
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2882
2883
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2884
		if ( $send_state_messages ) {
2885
			self::restate();
2886
			self::catch_errors( true );
2887
		}
2888
2889
		$active = self::get_active_modules();
2890
2891
		foreach ( $modules as $module ) {
2892
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2893
				$active[] = $module;
2894
				self::update_active_modules( $active );
2895
				continue;
2896
			}
2897
2898
			if ( $send_state_messages && in_array( $module, $active ) ) {
2899
				$module_info = self::get_module( $module );
2900 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2901
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2902
					if ( $active_state = self::state( $state ) ) {
2903
						$active_state = explode( ',', $active_state );
2904
					} else {
2905
						$active_state = array();
2906
					}
2907
					$active_state[] = $module;
2908
					self::state( $state, implode( ',', $active_state ) );
2909
				}
2910
				continue;
2911
			}
2912
2913
			$file = self::get_module_path( $module );
2914
			if ( ! file_exists( $file ) ) {
2915
				continue;
2916
			}
2917
2918
			// we'll override this later if the plugin can be included without fatal error
2919
			if ( $redirect ) {
2920
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2921
			}
2922
2923
			if ( $send_state_messages ) {
2924
				self::state( 'error', 'module_activation_failed' );
2925
				self::state( 'module', $module );
2926
			}
2927
2928
			ob_start();
2929
			require_once $file;
2930
2931
			$active[] = $module;
2932
2933 View Code Duplication
			if ( $send_state_messages ) {
2934
2935
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2936
				if ( $active_state = self::state( $state ) ) {
2937
					$active_state = explode( ',', $active_state );
2938
				} else {
2939
					$active_state = array();
2940
				}
2941
				$active_state[] = $module;
2942
				self::state( $state, implode( ',', $active_state ) );
2943
			}
2944
2945
			self::update_active_modules( $active );
2946
2947
			ob_end_clean();
2948
		}
2949
2950
		if ( $send_state_messages ) {
2951
			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...
2952
			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...
2953
		}
2954
2955
		self::catch_errors( false );
2956
		/**
2957
		 * Fires when default modules are activated.
2958
		 *
2959
		 * @since 1.9.0
2960
		 *
2961
		 * @param string $min_version Minimum version number required to use modules.
2962
		 * @param string $max_version Maximum version number required to use modules.
2963
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2964
		 */
2965
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2966
	}
2967
2968
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2969
		/**
2970
		 * Fires before a module is activated.
2971
		 *
2972
		 * @since 2.6.0
2973
		 *
2974
		 * @param string $module Module slug.
2975
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2976
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2977
		 */
2978
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2979
2980
		$jetpack = self::init();
2981
2982
		if ( ! strlen( $module ) ) {
2983
			return false;
2984
		}
2985
2986
		if ( ! self::is_module( $module ) ) {
2987
			return false;
2988
		}
2989
2990
		// If it's already active, then don't do it again
2991
		$active = self::get_active_modules();
2992
		foreach ( $active as $act ) {
2993
			if ( $act == $module ) {
2994
				return true;
2995
			}
2996
		}
2997
2998
		$module_data = self::get_module( $module );
2999
3000
		$is_development_mode = ( new Status() )->is_development_mode();
3001
		if ( ! self::is_active() ) {
3002
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3003
				return false;
3004
			}
3005
3006
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3007
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3008
				return false;
3009
			}
3010
		}
3011
3012
		// Check and see if the old plugin is active
3013
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3014
			// Deactivate the old plugin
3015
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3016
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3017
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3018
				self::state( 'deactivated_plugins', $module );
3019
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3020
				exit;
3021
			}
3022
		}
3023
3024
		// Protect won't work with mis-configured IPs
3025
		if ( 'protect' === $module ) {
3026
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3027
			if ( ! jetpack_protect_get_ip() ) {
3028
				self::state( 'message', 'protect_misconfigured_ip' );
3029
				return false;
3030
			}
3031
		}
3032
3033
		if ( ! Jetpack_Plan::supports( $module ) ) {
3034
			return false;
3035
		}
3036
3037
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3038
		self::state( 'module', $module );
3039
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3040
3041
		self::catch_errors( true );
3042
		ob_start();
3043
		require self::get_module_path( $module );
3044
		/** This action is documented in class.jetpack.php */
3045
		do_action( 'jetpack_activate_module', $module );
3046
		$active[] = $module;
3047
		self::update_active_modules( $active );
3048
3049
		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...
3050
		ob_end_clean();
3051
		self::catch_errors( false );
3052
3053
		if ( $redirect ) {
3054
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3055
		}
3056
		if ( $exit ) {
3057
			exit;
3058
		}
3059
		return true;
3060
	}
3061
3062
	function activate_module_actions( $module ) {
3063
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3064
	}
3065
3066
	public static function deactivate_module( $module ) {
3067
		/**
3068
		 * Fires when a module is deactivated.
3069
		 *
3070
		 * @since 1.9.0
3071
		 *
3072
		 * @param string $module Module slug.
3073
		 */
3074
		do_action( 'jetpack_pre_deactivate_module', $module );
3075
3076
		$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...
3077
3078
		$active = self::get_active_modules();
3079
		$new    = array_filter( array_diff( $active, (array) $module ) );
3080
3081
		return self::update_active_modules( $new );
3082
	}
3083
3084
	public static function enable_module_configurable( $module ) {
3085
		$module = self::get_module_slug( $module );
3086
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3087
	}
3088
3089
	/**
3090
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3091
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3092
	 *
3093
	 * @param string $module Module slug
3094
	 * @return string $url module configuration URL
3095
	 */
3096
	public static function module_configuration_url( $module ) {
3097
		$module      = self::get_module_slug( $module );
3098
		$default_url = self::admin_url() . "#/settings?term=$module";
3099
		/**
3100
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3101
		 *
3102
		 * @since 6.9.0
3103
		 *
3104
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3105
		 */
3106
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3107
3108
		return $url;
3109
	}
3110
3111
	/* Installation */
3112
	public static function bail_on_activation( $message, $deactivate = true ) {
3113
		?>
3114
<!doctype html>
3115
<html>
3116
<head>
3117
<meta charset="<?php bloginfo( 'charset' ); ?>">
3118
<style>
3119
* {
3120
	text-align: center;
3121
	margin: 0;
3122
	padding: 0;
3123
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3124
}
3125
p {
3126
	margin-top: 1em;
3127
	font-size: 18px;
3128
}
3129
</style>
3130
<body>
3131
<p><?php echo esc_html( $message ); ?></p>
3132
</body>
3133
</html>
3134
		<?php
3135
		if ( $deactivate ) {
3136
			$plugins = get_option( 'active_plugins' );
3137
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3138
			$update  = false;
3139
			foreach ( $plugins as $i => $plugin ) {
3140
				if ( $plugin === $jetpack ) {
3141
					$plugins[ $i ] = false;
3142
					$update        = true;
3143
				}
3144
			}
3145
3146
			if ( $update ) {
3147
				update_option( 'active_plugins', array_filter( $plugins ) );
3148
			}
3149
		}
3150
		exit;
3151
	}
3152
3153
	/**
3154
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3155
	 *
3156
	 * @static
3157
	 */
3158
	public static function plugin_activation( $network_wide ) {
3159
		Jetpack_Options::update_option( 'activated', 1 );
3160
3161
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3162
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3163
		}
3164
3165
		if ( $network_wide ) {
3166
			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...
3167
		}
3168
3169
		// For firing one-off events (notices) immediately after activation
3170
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3171
3172
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3173
3174
		Health::on_jetpack_activated();
3175
3176
		self::plugin_initialize();
3177
	}
3178
3179
	public static function get_activation_source( $referer_url ) {
3180
3181
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3182
			return array( 'wp-cli', null );
3183
		}
3184
3185
		$referer = wp_parse_url( $referer_url );
3186
3187
		$source_type  = 'unknown';
3188
		$source_query = null;
3189
3190
		if ( ! is_array( $referer ) ) {
3191
			return array( $source_type, $source_query );
3192
		}
3193
3194
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_PATH.

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

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

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

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

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

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

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

Loading history...
3196
3197
		if ( isset( $referer['query'] ) ) {
3198
			parse_str( $referer['query'], $query_parts );
3199
		} else {
3200
			$query_parts = array();
3201
		}
3202
3203
		if ( $plugins_path === $referer['path'] ) {
3204
			$source_type = 'list';
3205
		} elseif ( $plugins_install_path === $referer['path'] ) {
3206
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3207
			switch ( $tab ) {
3208
				case 'popular':
3209
					$source_type = 'popular';
3210
					break;
3211
				case 'recommended':
3212
					$source_type = 'recommended';
3213
					break;
3214
				case 'favorites':
3215
					$source_type = 'favorites';
3216
					break;
3217
				case 'search':
3218
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3219
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3220
					break;
3221
				default:
3222
					$source_type = 'featured';
3223
			}
3224
		}
3225
3226
		return array( $source_type, $source_query );
3227
	}
3228
3229
	/**
3230
	 * Runs before bumping version numbers up to a new version
3231
	 *
3232
	 * @param string $version    Version:timestamp.
3233
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3234
	 */
3235
	public static function do_version_bump( $version, $old_version ) {
3236
		if ( $old_version ) { // For existing Jetpack installations.
3237
3238
			// If a front end page is visited after the update, the 'wp' action will fire.
3239
			add_action( 'wp', 'Jetpack::set_update_modal_display' );
3240
3241
			// If an admin page is visited after the update, the 'current_screen' action will fire.
3242
			add_action( 'current_screen', 'Jetpack::set_update_modal_display' );
3243
		}
3244
	}
3245
3246
	/**
3247
	 * Sets the display_update_modal state.
3248
	 */
3249
	public static function set_update_modal_display() {
3250
		self::state( 'display_update_modal', 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...
3251
	}
3252
3253
	/**
3254
	 * Sets the internal version number and activation state.
3255
	 *
3256
	 * @static
3257
	 */
3258
	public static function plugin_initialize() {
3259
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3260
			Jetpack_Options::update_option( 'activated', 2 );
3261
		}
3262
3263 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3264
			$version = $old_version = JETPACK__VERSION . ':' . time();
3265
			/** This action is documented in class.jetpack.php */
3266
			do_action( 'updating_jetpack_version', $version, false );
3267
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3268
		}
3269
3270
		self::load_modules();
3271
3272
		Jetpack_Options::delete_option( 'do_activate' );
3273
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3274
	}
3275
3276
	/**
3277
	 * Removes all connection options
3278
	 *
3279
	 * @static
3280
	 */
3281
	public static function plugin_deactivation() {
3282
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3283
		$tracking = new Tracking();
3284
		$tracking->record_user_event( 'deactivate_plugin', array() );
3285
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3286
			Jetpack_Network::init()->deactivate();
3287
		} else {
3288
			self::disconnect( false );
3289
			// Jetpack_Heartbeat::init()->deactivate();
3290
		}
3291
	}
3292
3293
	/**
3294
	 * Disconnects from the Jetpack servers.
3295
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3296
	 *
3297
	 * @static
3298
	 */
3299
	public static function disconnect( $update_activated_state = true ) {
3300
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3301
		$connection = self::connection();
3302
		$connection->clean_nonces( true );
3303
3304
		// If the site is in an IDC because sync is not allowed,
3305
		// let's make sure to not disconnect the production site.
3306
		if ( ! self::validate_sync_error_idc_option() ) {
3307
			$tracking = new Tracking();
3308
			$tracking->record_user_event( 'disconnect_site', array() );
3309
3310
			$connection->disconnect_site_wpcom( true );
3311
		}
3312
3313
		$connection->delete_all_connection_tokens( true );
3314
		Jetpack_IDC::clear_all_idc_options();
3315
3316
		if ( $update_activated_state ) {
3317
			Jetpack_Options::update_option( 'activated', 4 );
3318
		}
3319
3320
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3321
			// Check then record unique disconnection if site has never been disconnected previously
3322
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3323
				$jetpack_unique_connection['disconnected'] = 1;
3324
			} else {
3325
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3326
					// track unique disconnect
3327
					$jetpack = self::init();
3328
3329
					$jetpack->stat( 'connections', 'unique-disconnect' );
3330
					$jetpack->do_stats( 'server_side' );
3331
				}
3332
				// increment number of times disconnected
3333
				$jetpack_unique_connection['disconnected'] += 1;
3334
			}
3335
3336
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3337
		}
3338
3339
		// Delete all the sync related data. Since it could be taking up space.
3340
		Sender::get_instance()->uninstall();
3341
3342
		// Disable the Heartbeat cron
3343
		Jetpack_Heartbeat::init()->deactivate();
3344
	}
3345
3346
	/**
3347
	 * Unlinks the current user from the linked WordPress.com user.
3348
	 *
3349
	 * @deprecated since 7.7
3350
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3351
	 *
3352
	 * @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...
3353
	 * @return Boolean Whether the disconnection of the user was successful.
3354
	 */
3355
	public static function unlink_user( $user_id = null ) {
3356
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3357
		return Connection_Manager::disconnect_user( $user_id );
3358
	}
3359
3360
	/**
3361
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3362
	 */
3363
	public static function try_registration() {
3364
		$terms_of_service = new Terms_Of_Service();
3365
		// The user has agreed to the TOS at some point by now.
3366
		$terms_of_service->agree();
3367
3368
		// Let's get some testing in beta versions and such.
3369
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3370
			// Before attempting to connect, let's make sure that the domains are viable.
3371
			$domains_to_check = array_unique(
3372
				array(
3373
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

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

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

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

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

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3379
				if ( is_wp_error( $result ) ) {
3380
					return $result;
3381
				}
3382
			}
3383
		}
3384
3385
		$result = self::register();
3386
3387
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3388
		if ( ! $result || is_wp_error( $result ) ) {
3389
			return $result;
3390
		} else {
3391
			return true;
3392
		}
3393
	}
3394
3395
	/**
3396
	 * Tracking an internal event log. Try not to put too much chaff in here.
3397
	 *
3398
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3399
	 */
3400
	public static function log( $code, $data = null ) {
3401
		// only grab the latest 200 entries
3402
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3403
3404
		// Append our event to the log
3405
		$log_entry = array(
3406
			'time'    => time(),
3407
			'user_id' => get_current_user_id(),
3408
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3409
			'code'    => $code,
3410
		);
3411
		// Don't bother storing it unless we've got some.
3412
		if ( ! is_null( $data ) ) {
3413
			$log_entry['data'] = $data;
3414
		}
3415
		$log[] = $log_entry;
3416
3417
		// Try add_option first, to make sure it's not autoloaded.
3418
		// @todo: Add an add_option method to Jetpack_Options
3419
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3420
			Jetpack_Options::update_option( 'log', $log );
3421
		}
3422
3423
		/**
3424
		 * Fires when Jetpack logs an internal event.
3425
		 *
3426
		 * @since 3.0.0
3427
		 *
3428
		 * @param array $log_entry {
3429
		 *  Array of details about the log entry.
3430
		 *
3431
		 *  @param string time Time of the event.
3432
		 *  @param int user_id ID of the user who trigerred the event.
3433
		 *  @param int blog_id Jetpack Blog ID.
3434
		 *  @param string code Unique name for the event.
3435
		 *  @param string data Data about the event.
3436
		 * }
3437
		 */
3438
		do_action( 'jetpack_log_entry', $log_entry );
3439
	}
3440
3441
	/**
3442
	 * Get the internal event log.
3443
	 *
3444
	 * @param $event (string) - only return the specific log events
3445
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3446
	 *
3447
	 * @return array of log events || WP_Error for invalid params
3448
	 */
3449
	public static function get_log( $event = false, $num = false ) {
3450
		if ( $event && ! is_string( $event ) ) {
3451
			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...
3452
		}
3453
3454
		if ( $num && ! is_numeric( $num ) ) {
3455
			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...
3456
		}
3457
3458
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3459
3460
		// If nothing set - act as it did before, otherwise let's start customizing the output
3461
		if ( ! $num && ! $event ) {
3462
			return $entire_log;
3463
		} else {
3464
			$entire_log = array_reverse( $entire_log );
3465
		}
3466
3467
		$custom_log_output = array();
3468
3469
		if ( $event ) {
3470
			foreach ( $entire_log as $log_event ) {
3471
				if ( $event == $log_event['code'] ) {
3472
					$custom_log_output[] = $log_event;
3473
				}
3474
			}
3475
		} else {
3476
			$custom_log_output = $entire_log;
3477
		}
3478
3479
		if ( $num ) {
3480
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3481
		}
3482
3483
		return $custom_log_output;
3484
	}
3485
3486
	/**
3487
	 * Log modification of important settings.
3488
	 */
3489
	public static function log_settings_change( $option, $old_value, $value ) {
3490
		switch ( $option ) {
3491
			case 'jetpack_sync_non_public_post_stati':
3492
				self::log( $option, $value );
3493
				break;
3494
		}
3495
	}
3496
3497
	/**
3498
	 * Return stat data for WPCOM sync
3499
	 */
3500
	public static function get_stat_data( $encode = true, $extended = true ) {
3501
		$data = Jetpack_Heartbeat::generate_stats_array();
3502
3503
		if ( $extended ) {
3504
			$additional_data = self::get_additional_stat_data();
3505
			$data            = array_merge( $data, $additional_data );
3506
		}
3507
3508
		if ( $encode ) {
3509
			return json_encode( $data );
3510
		}
3511
3512
		return $data;
3513
	}
3514
3515
	/**
3516
	 * Get additional stat data to sync to WPCOM
3517
	 */
3518
	public static function get_additional_stat_data( $prefix = '' ) {
3519
		$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...
3520
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3521
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3522
		$return[ "{$prefix}site-count" ]    = 0;
3523
3524
		if ( function_exists( 'get_blog_count' ) ) {
3525
			$return[ "{$prefix}site-count" ] = get_blog_count();
3526
		}
3527
		return $return;
3528
	}
3529
3530
	private static function get_site_user_count() {
3531
		global $wpdb;
3532
3533
		if ( function_exists( 'wp_is_large_network' ) ) {
3534
			if ( wp_is_large_network( 'users' ) ) {
3535
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3536
			}
3537
		}
3538
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3539
			// It wasn't there, so regenerate the data and save the transient
3540
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3541
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3542
		}
3543
		return $user_count;
3544
	}
3545
3546
	/* Admin Pages */
3547
3548
	function admin_init() {
3549
		// If the plugin is not connected, display a connect message.
3550
		if (
3551
			// the plugin was auto-activated and needs its candy
3552
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3553
		||
3554
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3555
			! Jetpack_Options::get_option( 'activated' )
3556
		) {
3557
			self::plugin_initialize();
3558
		}
3559
3560
		$is_development_mode = ( new Status() )->is_development_mode();
3561
		if ( ! self::is_active() && ! $is_development_mode ) {
3562
			Jetpack_Connection_Banner::init();
3563
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3564
			// Upgrade: 1.1 -> 1.1.1
3565
			// Check and see if host can verify the Jetpack servers' SSL certificate
3566
			$args       = array();
3567
			$connection = self::connection();
3568
			Client::_wp_remote_request(
3569
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3570
				$args,
3571
				true
3572
			);
3573
		}
3574
3575
		Jetpack_Wizard_Banner::init();
3576
3577
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3578
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3579
		}
3580
3581
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3582
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3583
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3584
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3585
3586
		if ( self::is_active() || $is_development_mode ) {
3587
			// Artificially throw errors in certain specific cases during plugin activation.
3588
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3589
		}
3590
3591
		// Add custom column in wp-admin/users.php to show whether user is linked.
3592
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3593
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3594
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3595
	}
3596
3597
	function admin_body_class( $admin_body_class = '' ) {
3598
		$classes = explode( ' ', trim( $admin_body_class ) );
3599
3600
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3601
3602
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3603
		return " $admin_body_class ";
3604
	}
3605
3606
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3607
		return $admin_body_class . ' jetpack-pagestyles ';
3608
	}
3609
3610
	/**
3611
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3612
	 * This function artificially throws errors for such cases (per a specific list).
3613
	 *
3614
	 * @param string $plugin The activated plugin.
3615
	 */
3616
	function throw_error_on_activate_plugin( $plugin ) {
3617
		$active_modules = self::get_active_modules();
3618
3619
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3620
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3621
			$throw = false;
3622
3623
			// Try and make sure it really was the stats plugin
3624
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3625
				if ( 'stats.php' == basename( $plugin ) ) {
3626
					$throw = true;
3627
				}
3628
			} else {
3629
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3630
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3631
					$throw = true;
3632
				}
3633
			}
3634
3635
			if ( $throw ) {
3636
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3637
			}
3638
		}
3639
	}
3640
3641
	function intercept_plugin_error_scrape_init() {
3642
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3643
	}
3644
3645
	function intercept_plugin_error_scrape( $action, $result ) {
3646
		if ( ! $result ) {
3647
			return;
3648
		}
3649
3650
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3651
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3652
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3653
			}
3654
		}
3655
	}
3656
3657
	/**
3658
	 * Register the remote file upload request handlers, if needed.
3659
	 *
3660
	 * @access public
3661
	 */
3662
	public function add_remote_request_handlers() {
3663
		// Remote file uploads are allowed only via AJAX requests.
3664
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3665
			return;
3666
		}
3667
3668
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3669
		$remote_request_actions = array(
3670
			'jetpack_upload_file',
3671
			'jetpack_update_file',
3672
		);
3673
3674
		// phpcs:ignore WordPress.Security.NonceVerification
3675
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3676
			return;
3677
		}
3678
3679
		// Require Jetpack authentication for the remote file upload AJAX requests.
3680
		if ( ! $this->connection_manager ) {
3681
			$this->connection_manager = new Connection_Manager();
3682
		}
3683
3684
		$this->connection_manager->require_jetpack_authentication();
3685
3686
		// Register the remote file upload AJAX handlers.
3687
		foreach ( $remote_request_actions as $action ) {
3688
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3689
		}
3690
	}
3691
3692
	/**
3693
	 * Handler for Jetpack remote file uploads.
3694
	 *
3695
	 * @access public
3696
	 */
3697
	public function remote_request_handlers() {
3698
		$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...
3699
3700
		switch ( current_filter() ) {
3701
			case 'wp_ajax_nopriv_jetpack_upload_file':
3702
				$response = $this->upload_handler();
3703
				break;
3704
3705
			case 'wp_ajax_nopriv_jetpack_update_file':
3706
				$response = $this->upload_handler( true );
3707
				break;
3708
			default:
3709
				$response = new WP_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
The call to WP_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...
3710
				break;
3711
		}
3712
3713
		if ( ! $response ) {
3714
			$response = new WP_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
The call to WP_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...
3715
		}
3716
3717
		if ( is_wp_error( $response ) ) {
3718
			$status_code       = $response->get_error_data();
0 ignored issues
show
The method get_error_data() 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...
3719
			$error             = $response->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...
3720
			$error_description = $response->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...
3721
3722
			if ( ! is_int( $status_code ) ) {
3723
				$status_code = 400;
3724
			}
3725
3726
			status_header( $status_code );
3727
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3728
		}
3729
3730
		status_header( 200 );
3731
		if ( true === $response ) {
3732
			exit;
3733
		}
3734
3735
		die( json_encode( (object) $response ) );
3736
	}
3737
3738
	/**
3739
	 * Uploads a file gotten from the global $_FILES.
3740
	 * If `$update_media_item` is true and `post_id` is defined
3741
	 * the attachment file of the media item (gotten through of the post_id)
3742
	 * will be updated instead of add a new one.
3743
	 *
3744
	 * @param  boolean $update_media_item - update media attachment
3745
	 * @return array - An array describing the uploadind files process
3746
	 */
3747
	function upload_handler( $update_media_item = false ) {
3748
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3749
			return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
The call to WP_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...
3750
		}
3751
3752
		$user = wp_authenticate( '', '' );
3753
		if ( ! $user || is_wp_error( $user ) ) {
3754
			return new WP_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
The call to WP_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...
3755
		}
3756
3757
		wp_set_current_user( $user->ID );
3758
3759
		if ( ! current_user_can( 'upload_files' ) ) {
3760
			return new WP_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
The call to WP_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...
3761
		}
3762
3763
		if ( empty( $_FILES ) ) {
3764
			return new WP_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
The call to WP_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...
3765
		}
3766
3767
		foreach ( array_keys( $_FILES ) as $files_key ) {
3768
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3769
				return new WP_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
The call to WP_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...
3770
			}
3771
		}
3772
3773
		$media_keys = array_keys( $_FILES['media'] );
3774
3775
		$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...
3776
		if ( ! $token || is_wp_error( $token ) ) {
3777
			return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
The call to WP_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...
3778
		}
3779
3780
		$uploaded_files = array();
3781
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3782
		unset( $GLOBALS['post'] );
3783
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3784
			$file = array();
3785
			foreach ( $media_keys as $media_key ) {
3786
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3787
			}
3788
3789
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3790
3791
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3792
			if ( $hmac_provided !== $hmac_file ) {
3793
				$uploaded_files[ $index ] = (object) array(
3794
					'error'             => 'invalid_hmac',
3795
					'error_description' => 'The corresponding HMAC for this file does not match',
3796
				);
3797
				continue;
3798
			}
3799
3800
			$_FILES['.jetpack.upload.'] = $file;
3801
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3802
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3803
				$post_id = 0;
3804
			}
3805
3806
			if ( $update_media_item ) {
3807
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3808
					return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
The call to WP_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...
3809
				}
3810
3811
				$media_array = $_FILES['media'];
3812
3813
				$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...
3814
				$file_array['type']     = $media_array['type'][0];
3815
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3816
				$file_array['error']    = $media_array['error'][0];
3817
				$file_array['size']     = $media_array['size'][0];
3818
3819
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3820
3821
				if ( is_wp_error( $edited_media_item ) ) {
3822
					return $edited_media_item;
3823
				}
3824
3825
				$response = (object) array(
3826
					'id'   => (string) $post_id,
3827
					'file' => (string) $edited_media_item->post_title,
3828
					'url'  => (string) wp_get_attachment_url( $post_id ),
3829
					'type' => (string) $edited_media_item->post_mime_type,
3830
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3831
				);
3832
3833
				return (array) array( $response );
3834
			}
3835
3836
			$attachment_id = media_handle_upload(
3837
				'.jetpack.upload.',
3838
				$post_id,
3839
				array(),
3840
				array(
3841
					'action' => 'jetpack_upload_file',
3842
				)
3843
			);
3844
3845
			if ( ! $attachment_id ) {
3846
				$uploaded_files[ $index ] = (object) array(
3847
					'error'             => 'unknown',
3848
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3849
				);
3850
			} elseif ( is_wp_error( $attachment_id ) ) {
3851
				$uploaded_files[ $index ] = (object) array(
3852
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3853
					'error_description' => $attachment_id->get_error_message(),
3854
				);
3855
			} else {
3856
				$attachment               = get_post( $attachment_id );
3857
				$uploaded_files[ $index ] = (object) array(
3858
					'id'   => (string) $attachment_id,
3859
					'file' => $attachment->post_title,
3860
					'url'  => wp_get_attachment_url( $attachment_id ),
3861
					'type' => $attachment->post_mime_type,
3862
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3863
				);
3864
				// Zip files uploads are not supported unless they are done for installation purposed
3865
				// lets delete them in case something goes wrong in this whole process
3866
				if ( 'application/zip' === $attachment->post_mime_type ) {
3867
					// Schedule a cleanup for 2 hours from now in case of failed install.
3868
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3869
				}
3870
			}
3871
		}
3872
		if ( ! is_null( $global_post ) ) {
3873
			$GLOBALS['post'] = $global_post;
3874
		}
3875
3876
		return $uploaded_files;
3877
	}
3878
3879
	/**
3880
	 * Add help to the Jetpack page
3881
	 *
3882
	 * @since Jetpack (1.2.3)
3883
	 * @return false if not the Jetpack page
3884
	 */
3885
	function admin_help() {
3886
		$current_screen = get_current_screen();
3887
3888
		// Overview
3889
		$current_screen->add_help_tab(
3890
			array(
3891
				'id'      => 'home',
3892
				'title'   => __( 'Home', 'jetpack' ),
3893
				'content' =>
3894
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3895
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3896
					'<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>',
3897
			)
3898
		);
3899
3900
		// Screen Content
3901
		if ( current_user_can( 'manage_options' ) ) {
3902
			$current_screen->add_help_tab(
3903
				array(
3904
					'id'      => 'settings',
3905
					'title'   => __( 'Settings', 'jetpack' ),
3906
					'content' =>
3907
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3908
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3909
						'<ol>' .
3910
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3911
							'<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>' .
3912
						'</ol>' .
3913
						'<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>',
3914
				)
3915
			);
3916
		}
3917
3918
		// Help Sidebar
3919
		$support_url = Redirect::get_url( 'jetpack-support' );
3920
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
3921
		$current_screen->set_help_sidebar(
3922
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3923
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3924
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3925
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3926
		);
3927
	}
3928
3929
	function admin_menu_css() {
3930
		wp_enqueue_style( 'jetpack-icons' );
3931
	}
3932
3933
	function admin_menu_order() {
3934
		return true;
3935
	}
3936
3937 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3938
		$jp_menu_order = array();
3939
3940
		foreach ( $menu_order as $index => $item ) {
3941
			if ( $item != 'jetpack' ) {
3942
				$jp_menu_order[] = $item;
3943
			}
3944
3945
			if ( $index == 0 ) {
3946
				$jp_menu_order[] = 'jetpack';
3947
			}
3948
		}
3949
3950
		return $jp_menu_order;
3951
	}
3952
3953
	function admin_banner_styles() {
3954
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3955
3956 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3957
			wp_register_style(
3958
				'jetpack-dops-style',
3959
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3960
				array(),
3961
				JETPACK__VERSION
3962
			);
3963
		}
3964
3965
		wp_enqueue_style(
3966
			'jetpack',
3967
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3968
			array( 'jetpack-dops-style' ),
3969
			JETPACK__VERSION . '-20121016'
3970
		);
3971
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3972
		wp_style_add_data( 'jetpack', 'suffix', $min );
3973
	}
3974
3975
	function plugin_action_links( $actions ) {
3976
3977
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3978
3979
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3980
			return array_merge(
3981
				$jetpack_home,
3982
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3983
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3984
				$actions
3985
			);
3986
		}
3987
3988
		return array_merge( $jetpack_home, $actions );
3989
	}
3990
3991
	/**
3992
	 * Adds the deactivation warning modal if there are other active plugins using the connection
3993
	 *
3994
	 * @param string $hook The current admin page.
3995
	 *
3996
	 * @return void
3997
	 */
3998
	public function deactivate_dialog( $hook ) {
3999
		if (
4000
			'plugins.php' === $hook
4001
			&& self::is_active()
4002
		) {
4003
4004
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4005
4006
			if ( count( $active_plugins_using_connection ) > 1 ) {
4007
4008
				add_thickbox();
4009
4010
				wp_register_script(
4011
					'jp-tracks',
4012
					'//stats.wp.com/w.js',
4013
					array(),
4014
					gmdate( 'YW' ),
4015
					true
4016
				);
4017
4018
				wp_register_script(
4019
					'jp-tracks-functions',
4020
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
4021
					array( 'jp-tracks' ),
4022
					JETPACK__VERSION,
4023
					false
4024
				);
4025
4026
				wp_enqueue_script(
4027
					'jetpack-deactivate-dialog-js',
4028
					Assets::get_file_url_for_environment(
4029
						'_inc/build/jetpack-deactivate-dialog.min.js',
4030
						'_inc/jetpack-deactivate-dialog.js'
4031
					),
4032
					array( 'jquery', 'jp-tracks-functions' ),
4033
					JETPACK__VERSION,
4034
					true
4035
				);
4036
4037
				wp_localize_script(
4038
					'jetpack-deactivate-dialog-js',
4039
					'deactivate_dialog',
4040
					array(
4041
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4042
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4043
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4044
					)
4045
				);
4046
4047
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4048
4049
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4050
			}
4051
		}
4052
	}
4053
4054
	/**
4055
	 * Outputs the content of the deactivation modal
4056
	 *
4057
	 * @return void
4058
	 */
4059
	public function deactivate_dialog_content() {
4060
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4061
		unset( $active_plugins_using_connection['jetpack'] );
4062
		$this->load_view( 'admin/deactivation-dialog.php', $active_plugins_using_connection );
0 ignored issues
show
It seems like $active_plugins_using_connection defined by \Automattic\Jetpack\Conn...ugin_Storage::get_all() on line 4060 can also be of type object<WP_Error>; however, Jetpack::load_view() does only seem to accept array, maybe add an additional type check?

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

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

    return array();
}

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

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

Loading history...
4063
	}
4064
4065
	/**
4066
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4067
	 *
4068
	 * @param string $login_url The wp-login URL.
4069
	 * @param string $redirect  URL to redirect users after logging in.
4070
	 * @since Jetpack 8.4
4071
	 * @return string
4072
	 */
4073
	public function login_url( $login_url, $redirect ) {
4074
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

Loading history...
4075
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4076
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4077
		}
4078
		return $login_url;
4079
	}
4080
4081
	/**
4082
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4083
	 *
4084
	 * @since Jetpack 8.4
4085
	 */
4086
	public function login_init() {
4087
		// phpcs:ignore WordPress.Security.NonceVerification
4088
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4089
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4090
			wp_safe_redirect(
4091
				add_query_arg(
4092
					array(
4093
						'forceInstall' => 1,
4094
						'url'          => rawurlencode( get_site_url() ),
4095
					),
4096
					// @todo provide way to go to specific calypso env.
4097
					self::get_calypso_host() . 'jetpack/connect'
4098
				)
4099
			);
4100
			exit;
4101
		}
4102
	}
4103
4104
	/*
4105
	 * Registration flow:
4106
	 * 1 - ::admin_page_load() action=register
4107
	 * 2 - ::try_registration()
4108
	 * 3 - ::register()
4109
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4110
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4111
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4112
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4113
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4114
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4115
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4116
	 *       jetpack_id, jetpack_secret, jetpack_public
4117
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4118
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4119
	 * 5 - user logs in with WP.com account
4120
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4121
	 *		- Manager::authorize()
4122
	 *		- Manager::get_token()
4123
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4124
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4125
	 *			- which responds with access_token, token_type, scope
4126
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4127
	 *		- Jetpack::activate_default_modules()
4128
	 *     		- Deactivates deprecated plugins
4129
	 *     		- Activates all default modules
4130
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4131
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4132
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4133
	 *     Done!
4134
	 */
4135
4136
	/**
4137
	 * Handles the page load events for the Jetpack admin page
4138
	 */
4139
	function admin_page_load() {
4140
		$error = false;
4141
4142
		// Make sure we have the right body class to hook stylings for subpages off of.
4143
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4144
4145
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4146
			// Should only be used in intermediate redirects to preserve state across redirects
4147
			self::restate();
4148
		}
4149
4150
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4151
			// @todo: Add validation against a known allowed list.
4152
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4153
			// User clicked in the iframe to link their accounts
4154
			if ( ! self::is_user_connected() ) {
4155
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4156
4157
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4158
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4159
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4160
4161
				if ( isset( $_GET['notes_iframe'] ) ) {
4162
					$connect_url .= '&notes_iframe';
4163
				}
4164
				wp_redirect( $connect_url );
4165
				exit;
4166
			} else {
4167
				if ( ! isset( $_GET['calypso_env'] ) ) {
4168
					self::state( 'message', 'already_authorized' );
4169
					wp_safe_redirect( self::admin_url() );
4170
					exit;
4171
				} else {
4172
					$connect_url  = $this->build_connect_url( true, false, $from );
4173
					$connect_url .= '&already_authorized=true';
4174
					wp_redirect( $connect_url );
4175
					exit;
4176
				}
4177
			}
4178
		}
4179
4180
		if ( isset( $_GET['action'] ) ) {
4181
			switch ( $_GET['action'] ) {
4182
				case 'authorize':
4183
					if ( self::is_active() && self::is_user_connected() ) {
4184
						self::state( 'message', 'already_authorized' );
4185
						wp_safe_redirect( self::admin_url() );
4186
						exit;
4187
					}
4188
					self::log( 'authorize' );
4189
					$client_server = new Jetpack_Client_Server();
4190
					$client_server->client_authorize();
4191
					exit;
4192
				case 'register':
4193
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4194
						$error = 'cheatin';
4195
						break;
4196
					}
4197
					check_admin_referer( 'jetpack-register' );
4198
					self::log( 'register' );
4199
					self::maybe_set_version_option();
4200
					$registered = self::try_registration();
4201 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4202
						$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...
4203
						self::state( 'error', $error );
4204
						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...
4205
4206
						/**
4207
						 * Jetpack registration Error.
4208
						 *
4209
						 * @since 7.5.0
4210
						 *
4211
						 * @param string|int $error The error code.
4212
						 * @param \WP_Error $registered The error object.
4213
						 */
4214
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4215
						break;
4216
					}
4217
4218
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4219
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4220
4221
					/**
4222
					 * Jetpack registration Success.
4223
					 *
4224
					 * @since 7.5.0
4225
					 *
4226
					 * @param string $from 'from' GET parameter;
4227
					 */
4228
					do_action( 'jetpack_connection_register_success', $from );
4229
4230
					$url = $this->build_connect_url( true, $redirect, $from );
4231
4232
					if ( ! empty( $_GET['onboarding'] ) ) {
4233
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4234
					}
4235
4236
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4237
						$url = add_query_arg( 'auth_approved', 'true', $url );
4238
					}
4239
4240
					wp_redirect( $url );
4241
					exit;
4242
				case 'activate':
4243
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4244
						$error = 'cheatin';
4245
						break;
4246
					}
4247
4248
					$module = stripslashes( $_GET['module'] );
4249
					check_admin_referer( "jetpack_activate-$module" );
4250
					self::log( 'activate', $module );
4251
					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...
4252
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4253
					}
4254
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4255
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4256
					exit;
4257
				case 'activate_default_modules':
4258
					check_admin_referer( 'activate_default_modules' );
4259
					self::log( 'activate_default_modules' );
4260
					self::restate();
4261
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4262
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4263
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4264
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4265
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4266
					exit;
4267
				case 'disconnect':
4268
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4269
						$error = 'cheatin';
4270
						break;
4271
					}
4272
4273
					check_admin_referer( 'jetpack-disconnect' );
4274
					self::log( 'disconnect' );
4275
					self::disconnect();
4276
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4277
					exit;
4278
				case 'reconnect':
4279
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4280
						$error = 'cheatin';
4281
						break;
4282
					}
4283
4284
					check_admin_referer( 'jetpack-reconnect' );
4285
					self::log( 'reconnect' );
4286
					$this->disconnect();
4287
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4288
					exit;
4289 View Code Duplication
				case 'deactivate':
4290
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4291
						$error = 'cheatin';
4292
						break;
4293
					}
4294
4295
					$modules = stripslashes( $_GET['module'] );
4296
					check_admin_referer( "jetpack_deactivate-$modules" );
4297
					foreach ( explode( ',', $modules ) as $module ) {
4298
						self::log( 'deactivate', $module );
4299
						self::deactivate_module( $module );
4300
						self::state( 'message', 'module_deactivated' );
4301
					}
4302
					self::state( 'module', $modules );
4303
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4304
					exit;
4305
				case 'unlink':
4306
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4307
					check_admin_referer( 'jetpack-unlink' );
4308
					self::log( 'unlink' );
4309
					Connection_Manager::disconnect_user();
4310
					self::state( 'message', 'unlinked' );
4311
					if ( 'sub-unlink' == $redirect ) {
4312
						wp_safe_redirect( admin_url() );
4313
					} else {
4314
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4315
					}
4316
					exit;
4317
				case 'onboard':
4318
					if ( ! current_user_can( 'manage_options' ) ) {
4319
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4320
					} else {
4321
						self::create_onboarding_token();
4322
						$url = $this->build_connect_url( true );
4323
4324
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4325
							$url = add_query_arg( 'onboarding', $token, $url );
4326
						}
4327
4328
						$calypso_env = $this->get_calypso_env();
4329
						if ( ! empty( $calypso_env ) ) {
4330
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4331
						}
4332
4333
						wp_redirect( $url );
4334
						exit;
4335
					}
4336
					exit;
4337
				default:
4338
					/**
4339
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4340
					 *
4341
					 * @since 2.6.0
4342
					 *
4343
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4344
					 */
4345
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4346
			}
4347
		}
4348
4349
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4350
			self::activate_new_modules( true );
4351
		}
4352
4353
		$message_code = self::state( 'message' );
4354
		if ( self::state( 'optin-manage' ) ) {
4355
			$activated_manage = $message_code;
4356
			$message_code     = 'jetpack-manage';
4357
		}
4358
4359
		switch ( $message_code ) {
4360
			case 'jetpack-manage':
4361
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4362
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4363
				$this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), $sites_url ) . '</strong>';
4364
				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...
4365
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4366
				}
4367
				break;
4368
4369
		}
4370
4371
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4372
4373
		if ( ! empty( $deactivated_plugins ) ) {
4374
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4375
			$deactivated_titles  = array();
4376
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4377
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4378
					continue;
4379
				}
4380
4381
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4382
			}
4383
4384
			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...
4385
				if ( $this->message ) {
4386
					$this->message .= "<br /><br />\n";
4387
				}
4388
4389
				$this->message .= wp_sprintf(
4390
					_n(
4391
						'Jetpack contains the most recent version of the old %l plugin.',
4392
						'Jetpack contains the most recent versions of the old %l plugins.',
4393
						count( $deactivated_titles ),
4394
						'jetpack'
4395
					),
4396
					$deactivated_titles
4397
				);
4398
4399
				$this->message .= "<br />\n";
4400
4401
				$this->message .= _n(
4402
					'The old version has been deactivated and can be removed from your site.',
4403
					'The old versions have been deactivated and can be removed from your site.',
4404
					count( $deactivated_titles ),
4405
					'jetpack'
4406
				);
4407
			}
4408
		}
4409
4410
		$this->privacy_checks = self::state( 'privacy_checks' );
4411
4412
		if ( $this->message || $this->error || $this->privacy_checks ) {
4413
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4414
		}
4415
4416
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4417
	}
4418
4419
	function admin_notices() {
4420
4421
		if ( $this->error ) {
4422
			?>
4423
<div id="message" class="jetpack-message jetpack-err">
4424
	<div class="squeezer">
4425
		<h2>
4426
			<?php
4427
			echo wp_kses(
4428
				$this->error,
4429
				array(
4430
					'a'      => array( 'href' => array() ),
4431
					'small'  => true,
4432
					'code'   => true,
4433
					'strong' => true,
4434
					'br'     => true,
4435
					'b'      => true,
4436
				)
4437
			);
4438
			?>
4439
			</h2>
4440
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4441
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4442
<?php	endif; ?>
4443
	</div>
4444
</div>
4445
			<?php
4446
		}
4447
4448
		if ( $this->message ) {
4449
			?>
4450
<div id="message" class="jetpack-message">
4451
	<div class="squeezer">
4452
		<h2>
4453
			<?php
4454
			echo wp_kses(
4455
				$this->message,
4456
				array(
4457
					'strong' => array(),
4458
					'a'      => array( 'href' => true ),
4459
					'br'     => true,
4460
				)
4461
			);
4462
			?>
4463
			</h2>
4464
	</div>
4465
</div>
4466
			<?php
4467
		}
4468
4469
		if ( $this->privacy_checks ) :
4470
			$module_names = $module_slugs = array();
4471
4472
			$privacy_checks = explode( ',', $this->privacy_checks );
4473
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4474
			foreach ( $privacy_checks as $module_slug ) {
4475
				$module = self::get_module( $module_slug );
4476
				if ( ! $module ) {
4477
					continue;
4478
				}
4479
4480
				$module_slugs[] = $module_slug;
4481
				$module_names[] = "<strong>{$module['name']}</strong>";
4482
			}
4483
4484
			$module_slugs = join( ',', $module_slugs );
4485
			?>
4486
<div id="message" class="jetpack-message jetpack-err">
4487
	<div class="squeezer">
4488
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4489
		<p>
4490
			<?php
4491
			echo wp_kses(
4492
				wptexturize(
4493
					wp_sprintf(
4494
						_nx(
4495
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4496
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4497
							count( $privacy_checks ),
4498
							'%l = list of Jetpack module/feature names',
4499
							'jetpack'
4500
						),
4501
						$module_names
4502
					)
4503
				),
4504
				array( 'strong' => true )
4505
			);
4506
4507
			echo "\n<br />\n";
4508
4509
			echo wp_kses(
4510
				sprintf(
4511
					_nx(
4512
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4513
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4514
						count( $privacy_checks ),
4515
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4516
						'jetpack'
4517
					),
4518
					wp_nonce_url(
4519
						self::admin_url(
4520
							array(
4521
								'page'   => 'jetpack',
4522
								'action' => 'deactivate',
4523
								'module' => urlencode( $module_slugs ),
4524
							)
4525
						),
4526
						"jetpack_deactivate-$module_slugs"
4527
					),
4528
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4529
				),
4530
				array(
4531
					'a' => array(
4532
						'href'  => true,
4533
						'title' => true,
4534
					),
4535
				)
4536
			);
4537
			?>
4538
		</p>
4539
	</div>
4540
</div>
4541
			<?php
4542
endif;
4543
	}
4544
4545
	/**
4546
	 * We can't always respond to a signed XML-RPC request with a
4547
	 * helpful error message. In some circumstances, doing so could
4548
	 * leak information.
4549
	 *
4550
	 * Instead, track that the error occurred via a Jetpack_Option,
4551
	 * and send that data back in the heartbeat.
4552
	 * All this does is increment a number, but it's enough to find
4553
	 * trends.
4554
	 *
4555
	 * @param WP_Error $xmlrpc_error The error produced during
4556
	 *                               signature validation.
4557
	 */
4558
	function track_xmlrpc_error( $xmlrpc_error ) {
4559
		$code = is_wp_error( $xmlrpc_error )
4560
			? $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...
4561
			: 'should-not-happen';
4562
4563
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4564
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4565
			// No need to update the option if we already have
4566
			// this code stored.
4567
			return;
4568
		}
4569
		$xmlrpc_errors[ $code ] = true;
4570
4571
		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...
4572
	}
4573
4574
	/**
4575
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4576
	 */
4577
	function stat( $group, $detail ) {
4578
		if ( ! isset( $this->stats[ $group ] ) ) {
4579
			$this->stats[ $group ] = array();
4580
		}
4581
		$this->stats[ $group ][] = $detail;
4582
	}
4583
4584
	/**
4585
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4586
	 */
4587
	function do_stats( $method = '' ) {
4588
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4589
			foreach ( $this->stats as $group => $stats ) {
4590
				if ( is_array( $stats ) && count( $stats ) ) {
4591
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4592
					if ( 'server_side' === $method ) {
4593
						self::do_server_side_stat( $args );
4594
					} else {
4595
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4596
					}
4597
				}
4598
				unset( $this->stats[ $group ] );
4599
			}
4600
		}
4601
	}
4602
4603
	/**
4604
	 * Runs stats code for a one-off, server-side.
4605
	 *
4606
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4607
	 *
4608
	 * @return bool If it worked.
4609
	 */
4610
	static function do_server_side_stat( $args ) {
4611
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4612
		if ( is_wp_error( $response ) ) {
4613
			return false;
4614
		}
4615
4616
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4617
			return false;
4618
		}
4619
4620
		return true;
4621
	}
4622
4623
	/**
4624
	 * Builds the stats url.
4625
	 *
4626
	 * @param $args array|string The arguments to append to the URL.
4627
	 *
4628
	 * @return string The URL to be pinged.
4629
	 */
4630
	static function build_stats_url( $args ) {
4631
		$defaults = array(
4632
			'v'    => 'wpcom2',
4633
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4634
		);
4635
		$args     = wp_parse_args( $args, $defaults );
0 ignored issues
show
$defaults is of type array<string,string,{"v"...ring","rand":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4636
		/**
4637
		 * Filter the URL used as the Stats tracking pixel.
4638
		 *
4639
		 * @since 2.3.2
4640
		 *
4641
		 * @param string $url Base URL used as the Stats tracking pixel.
4642
		 */
4643
		$base_url = apply_filters(
4644
			'jetpack_stats_base_url',
4645
			'https://pixel.wp.com/g.gif'
4646
		);
4647
		$url      = add_query_arg( $args, $base_url );
4648
		return $url;
4649
	}
4650
4651
	/**
4652
	 * Get the role of the current user.
4653
	 *
4654
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4655
	 *
4656
	 * @access public
4657
	 * @static
4658
	 *
4659
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4660
	 */
4661
	public static function translate_current_user_to_role() {
4662
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4663
4664
		$roles = new Roles();
4665
		return $roles->translate_current_user_to_role();
4666
	}
4667
4668
	/**
4669
	 * Get the role of a particular user.
4670
	 *
4671
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4672
	 *
4673
	 * @access public
4674
	 * @static
4675
	 *
4676
	 * @param \WP_User $user User object.
4677
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4678
	 */
4679
	public static function translate_user_to_role( $user ) {
4680
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4681
4682
		$roles = new Roles();
4683
		return $roles->translate_user_to_role( $user );
4684
	}
4685
4686
	/**
4687
	 * Get the minimum capability for a role.
4688
	 *
4689
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4690
	 *
4691
	 * @access public
4692
	 * @static
4693
	 *
4694
	 * @param string $role Role name.
4695
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4696
	 */
4697
	public static function translate_role_to_cap( $role ) {
4698
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4699
4700
		$roles = new Roles();
4701
		return $roles->translate_role_to_cap( $role );
4702
	}
4703
4704
	/**
4705
	 * Sign a user role with the master access token.
4706
	 * If not specified, will default to the current user.
4707
	 *
4708
	 * @deprecated since 7.7
4709
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4710
	 *
4711
	 * @access public
4712
	 * @static
4713
	 *
4714
	 * @param string $role    User role.
4715
	 * @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...
4716
	 * @return string Signed user role.
4717
	 */
4718
	public static function sign_role( $role, $user_id = null ) {
4719
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4720
		return self::connection()->sign_role( $role, $user_id );
4721
	}
4722
4723
	/**
4724
	 * Builds a URL to the Jetpack connection auth page
4725
	 *
4726
	 * @since 3.9.5
4727
	 *
4728
	 * @param bool        $raw If true, URL will not be escaped.
4729
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4730
	 *                              If string, will be a custom redirect.
4731
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4732
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4733
	 *
4734
	 * @return string Connect URL
4735
	 */
4736
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4737
		$site_id    = Jetpack_Options::get_option( 'id' );
4738
		$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...
4739
4740
		if ( $register || ! $blog_token || ! $site_id ) {
4741
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4742
4743
			if ( ! empty( $redirect ) ) {
4744
				$url = add_query_arg(
4745
					'redirect',
4746
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4747
					$url
4748
				);
4749
			}
4750
4751
			if ( is_network_admin() ) {
4752
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4753
			}
4754
4755
			$calypso_env = self::get_calypso_env();
4756
4757
			if ( ! empty( $calypso_env ) ) {
4758
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4759
			}
4760
		} else {
4761
4762
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4763
			// because otherwise this logic can get us in to a loop.
4764
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4765
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4766
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4767
4768
				$response = Client::wpcom_json_api_request_as_blog(
4769
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4770
					'1.1'
4771
				);
4772
4773
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4774
4775
					// Generating a register URL instead to refresh the existing token
4776
					return $this->build_connect_url( $raw, $redirect, $from, true );
4777
				}
4778
			}
4779
4780
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
It seems like $redirect defined by parameter $redirect on line 4736 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...
4781
		}
4782
4783
		if ( $from ) {
4784
			$url = add_query_arg( 'from', $from, $url );
4785
		}
4786
4787
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4788
		/**
4789
		 * Filter the URL used when connecting a user to a WordPress.com account.
4790
		 *
4791
		 * @since 8.1.0
4792
		 *
4793
		 * @param string $url Connection URL.
4794
		 * @param bool   $raw If true, URL will not be escaped.
4795
		 */
4796
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
0 ignored issues
show
The call to apply_filters() has too many arguments starting with $raw.

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...
4797
	}
4798
4799
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4800
4801
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4802
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4803
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4804
4805
		if ( $iframe ) {
4806
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4807
		}
4808
4809
		$c8n = self::connection();
4810
		$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...
4811
4812
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4813
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4814
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4815
4816
		if ( $iframe ) {
4817
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4818
		}
4819
4820
		return $url;
4821
	}
4822
4823
	/**
4824
	 * Filters the connection URL parameter array.
4825
	 *
4826
	 * @param array $args default URL parameters used by the package.
4827
	 * @return array the modified URL arguments array.
4828
	 */
4829
	public static function filter_connect_request_body( $args ) {
4830
		if (
4831
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4832
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4833
		) {
4834
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4835
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4836
				? $gp_locale->slug
4837
				: '';
4838
		}
4839
4840
		$tracking        = new Tracking();
4841
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4842
4843
		$args = array_merge(
4844
			$args,
4845
			array(
4846
				'_ui' => $tracks_identity['_ui'],
4847
				'_ut' => $tracks_identity['_ut'],
4848
			)
4849
		);
4850
4851
		$calypso_env = self::get_calypso_env();
4852
4853
		if ( ! empty( $calypso_env ) ) {
4854
			$args['calypso_env'] = $calypso_env;
4855
		}
4856
4857
		return $args;
4858
	}
4859
4860
	/**
4861
	 * Filters the URL that will process the connection data. It can be different from the URL
4862
	 * that we send the user to after everything is done.
4863
	 *
4864
	 * @param String $processing_url the default redirect URL used by the package.
4865
	 * @return String the modified URL.
4866
	 */
4867
	public static function filter_connect_processing_url( $processing_url ) {
4868
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4869
		return $processing_url;
4870
	}
4871
4872
	/**
4873
	 * Filters the redirection URL that is used for connect requests. The redirect
4874
	 * URL should return the user back to the Jetpack console.
4875
	 *
4876
	 * @param String $redirect the default redirect URL used by the package.
4877
	 * @return String the modified URL.
4878
	 */
4879
	public static function filter_connect_redirect_url( $redirect ) {
4880
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4881
		$redirect           = $redirect
4882
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4883
			: $jetpack_admin_page;
4884
4885
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4886
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4887
		}
4888
4889
		return $redirect;
4890
	}
4891
4892
	/**
4893
	 * This action fires at the beginning of the Manager::authorize method.
4894
	 */
4895
	public static function authorize_starting() {
4896
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4897
		// Checking if site has been active/connected previously before recording unique connection.
4898
		if ( ! $jetpack_unique_connection ) {
4899
			// jetpack_unique_connection option has never been set.
4900
			$jetpack_unique_connection = array(
4901
				'connected'    => 0,
4902
				'disconnected' => 0,
4903
				'version'      => '3.6.1',
4904
			);
4905
4906
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4907
4908
			// Track unique connection.
4909
			$jetpack = self::init();
4910
4911
			$jetpack->stat( 'connections', 'unique-connection' );
4912
			$jetpack->do_stats( 'server_side' );
4913
		}
4914
4915
		// Increment number of times connected.
4916
		$jetpack_unique_connection['connected'] += 1;
4917
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4918
	}
4919
4920
	/**
4921
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4922
	 * linked.
4923
	 */
4924
	public static function authorize_ending_linked() {
4925
		// Don't activate anything since we are just connecting a user.
4926
		self::state( 'message', 'linked' );
4927
	}
4928
4929
	/**
4930
	 * This action fires at the end of the Manager::authorize method when the master user is
4931
	 * authorized.
4932
	 *
4933
	 * @param array $data The request data.
4934
	 */
4935
	public static function authorize_ending_authorized( $data ) {
4936
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4937
		self::invalidate_onboarding_token();
4938
4939
		// If redirect_uri is SSO, ensure SSO module is enabled.
4940
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

Loading history...
4941
4942
		/** This filter is documented in class.jetpack-cli.php */
4943
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4944
4945
		$activate_sso = (
4946
			isset( $redirect_options['action'] ) &&
4947
			'jetpack-sso' === $redirect_options['action'] &&
4948
			$jetpack_start_enable_sso
4949
		);
4950
4951
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4952
4953
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4954
	}
4955
4956
	/**
4957
	 * Get our assumed site creation date.
4958
	 * Calculated based on the earlier date of either:
4959
	 * - Earliest admin user registration date.
4960
	 * - Earliest date of post of any post type.
4961
	 *
4962
	 * @since 7.2.0
4963
	 * @deprecated since 7.8.0
4964
	 *
4965
	 * @return string Assumed site creation date and time.
4966
	 */
4967
	public static function get_assumed_site_creation_date() {
4968
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4969
		return self::connection()->get_assumed_site_creation_date();
4970
	}
4971
4972 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4973
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4974
4975
		if ( $activation_source_name ) {
4976
			$args['_as'] = urlencode( $activation_source_name );
4977
		}
4978
4979
		if ( $activation_source_keyword ) {
4980
			$args['_ak'] = urlencode( $activation_source_keyword );
4981
		}
4982
	}
4983
4984
	function build_reconnect_url( $raw = false ) {
4985
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4986
		return $raw ? $url : esc_url( $url );
4987
	}
4988
4989
	public static function admin_url( $args = null ) {
4990
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
0 ignored issues
show
array('page' => 'jetpack') is of type array<string,string,{"page":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4991
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
4992
		return $url;
4993
	}
4994
4995
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
4996
		$actionurl = str_replace( '&amp;', '&', $actionurl );
4997
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
4998
	}
4999
5000
	function dismiss_jetpack_notice() {
5001
5002
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5003
			return;
5004
		}
5005
5006
		switch ( $_GET['jetpack-notice'] ) {
5007
			case 'dismiss':
5008
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5009
5010
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5011
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5012
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5013
				}
5014
				break;
5015
		}
5016
	}
5017
5018
	public static function sort_modules( $a, $b ) {
5019
		if ( $a['sort'] == $b['sort'] ) {
5020
			return 0;
5021
		}
5022
5023
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5024
	}
5025
5026
	function ajax_recheck_ssl() {
5027
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5028
		$result = self::permit_ssl( true );
5029
		wp_send_json(
5030
			array(
5031
				'enabled' => $result,
5032
				'message' => get_transient( 'jetpack_https_test_message' ),
5033
			)
5034
		);
5035
	}
5036
5037
	/* Client API */
5038
5039
	/**
5040
	 * Returns the requested Jetpack API URL
5041
	 *
5042
	 * @deprecated since 7.7
5043
	 * @return string
5044
	 */
5045
	public static function api_url( $relative_url ) {
5046
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5047
		$connection = self::connection();
5048
		return $connection->api_url( $relative_url );
5049
	}
5050
5051
	/**
5052
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5053
	 *
5054
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5055
	 */
5056
	public static function fix_url_for_bad_hosts( $url ) {
5057
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5058
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5059
	}
5060
5061
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5062
		// Default to a blog token.
5063
		$token_type = 'blog';
5064
5065
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5066
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5067
			if ( ! empty( $_GET['onboarding'] ) ) {
5068
				$jpo = $_GET;
5069
			} else {
5070
				$jpo = json_decode( $request_data, true );
5071
			}
5072
5073
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5074
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5075
5076
			if (
5077
				isset( $jpo_user )
5078
				&& isset( $jpo_token )
5079
				&& is_email( $jpo_user )
5080
				&& ctype_alnum( $jpo_token )
5081
				&& isset( $_GET['rest_route'] )
5082
				&& self::validate_onboarding_token_action(
5083
					$jpo_token,
5084
					$_GET['rest_route']
5085
				)
5086
			) {
5087
				$jp_user = get_user_by( 'email', $jpo_user );
5088
				if ( is_a( $jp_user, 'WP_User' ) ) {
5089
					wp_set_current_user( $jp_user->ID );
5090
					$user_can = is_multisite()
5091
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5092
						: current_user_can( 'manage_options' );
5093
					if ( $user_can ) {
5094
						$token_type              = 'user';
5095
						$token->external_user_id = $jp_user->ID;
5096
					}
5097
				}
5098
			}
5099
5100
			$token_data['type']    = $token_type;
5101
			$token_data['user_id'] = $token->external_user_id;
5102
		}
5103
5104
		return $token_data;
5105
	}
5106
5107
	/**
5108
	 * Create a random secret for validating onboarding payload
5109
	 *
5110
	 * @return string Secret token
5111
	 */
5112
	public static function create_onboarding_token() {
5113
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5114
			$token = wp_generate_password( 32, false );
5115
			Jetpack_Options::update_option( 'onboarding', $token );
5116
		}
5117
5118
		return $token;
5119
	}
5120
5121
	/**
5122
	 * Remove the onboarding token
5123
	 *
5124
	 * @return bool True on success, false on failure
5125
	 */
5126
	public static function invalidate_onboarding_token() {
5127
		return Jetpack_Options::delete_option( 'onboarding' );
5128
	}
5129
5130
	/**
5131
	 * Validate an onboarding token for a specific action
5132
	 *
5133
	 * @return boolean True if token/action pair is accepted, false if not
5134
	 */
5135
	public static function validate_onboarding_token_action( $token, $action ) {
5136
		// Compare tokens, bail if tokens do not match
5137
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5138
			return false;
5139
		}
5140
5141
		// List of valid actions we can take
5142
		$valid_actions = array(
5143
			'/jetpack/v4/settings',
5144
		);
5145
5146
		// Only allow valid actions.
5147
		if ( ! in_array( $action, $valid_actions ) ) {
5148
			return false;
5149
		}
5150
5151
		return true;
5152
	}
5153
5154
	/**
5155
	 * Checks to see if the URL is using SSL to connect with Jetpack
5156
	 *
5157
	 * @since 2.3.3
5158
	 * @return boolean
5159
	 */
5160
	public static function permit_ssl( $force_recheck = false ) {
5161
		// Do some fancy tests to see if ssl is being supported
5162
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5163
			$message = '';
5164
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5165
				$ssl = 0;
5166
			} else {
5167
				switch ( JETPACK_CLIENT__HTTPS ) {
5168
					case 'NEVER':
5169
						$ssl     = 0;
5170
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5171
						break;
5172
					case 'ALWAYS':
5173
					case 'AUTO':
5174
					default:
5175
						$ssl = 1;
5176
						break;
5177
				}
5178
5179
				// If it's not 'NEVER', test to see
5180
				if ( $ssl ) {
5181
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5182
						$ssl     = 0;
5183
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5184
					} else {
5185
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5186
						if ( is_wp_error( $response ) ) {
5187
							$ssl     = 0;
5188
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5189
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5190
							$ssl     = 0;
5191
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5192
						}
5193
					}
5194
				}
5195
			}
5196
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5197
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5198
		}
5199
5200
		return (bool) $ssl;
5201
	}
5202
5203
	/*
5204
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5205
	 */
5206
	public function alert_auto_ssl_fail() {
5207
		if ( ! current_user_can( 'manage_options' ) ) {
5208
			return;
5209
		}
5210
5211
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5212
		?>
5213
5214
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5215
			<div class="jp-banner__content">
5216
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5217
				<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>
5218
				<p>
5219
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5220
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5221
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5222
				</p>
5223
				<p>
5224
					<?php
5225
					printf(
5226
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5227
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5228
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5229
					);
5230
					?>
5231
				</p>
5232
			</div>
5233
		</div>
5234
		<style>
5235
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5236
		</style>
5237
		<script type="text/javascript">
5238
			jQuery( document ).ready( function( $ ) {
5239
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5240
					var $this = $( this );
5241
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5242
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5243
					e.preventDefault();
5244
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5245
					$.post( ajaxurl, data )
5246
					  .done( function( response ) {
5247
						  if ( response.enabled ) {
5248
							  $( '#jetpack-ssl-warning' ).hide();
5249
						  } else {
5250
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5251
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5252
						  }
5253
					  }.bind( $this ) );
5254
				} );
5255
			} );
5256
		</script>
5257
5258
		<?php
5259
	}
5260
5261
	/**
5262
	 * Returns the Jetpack XML-RPC API
5263
	 *
5264
	 * @deprecated 8.0 Use Connection_Manager instead.
5265
	 * @return string
5266
	 */
5267
	public static function xmlrpc_api_url() {
5268
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5269
		return self::connection()->xmlrpc_api_url();
5270
	}
5271
5272
	/**
5273
	 * Returns the connection manager object.
5274
	 *
5275
	 * @return Automattic\Jetpack\Connection\Manager
5276
	 */
5277
	public static function connection() {
5278
		$jetpack = static::init();
5279
5280
		// If the connection manager hasn't been instantiated, do that now.
5281
		if ( ! $jetpack->connection_manager ) {
5282
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5283
		}
5284
5285
		return $jetpack->connection_manager;
5286
	}
5287
5288
	/**
5289
	 * Creates two secret tokens and the end of life timestamp for them.
5290
	 *
5291
	 * Note these tokens are unique per call, NOT static per site for connecting.
5292
	 *
5293
	 * @since 2.6
5294
	 * @param String  $action  The action name.
5295
	 * @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...
5296
	 * @param Integer $exp     Expiration time in seconds.
5297
	 * @return array
5298
	 */
5299
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5300
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5301
	}
5302
5303
	public static function get_secrets( $action, $user_id ) {
5304
		$secrets = self::connection()->get_secrets( $action, $user_id );
5305
5306
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5307
			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...
5308
		}
5309
5310
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5311
			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...
5312
		}
5313
5314
		return $secrets;
5315
	}
5316
5317
	/**
5318
	 * @deprecated 7.5 Use Connection_Manager instead.
5319
	 *
5320
	 * @param $action
5321
	 * @param $user_id
5322
	 */
5323
	public static function delete_secrets( $action, $user_id ) {
5324
		return self::connection()->delete_secrets( $action, $user_id );
5325
	}
5326
5327
	/**
5328
	 * Builds the timeout limit for queries talking with the wpcom servers.
5329
	 *
5330
	 * Based on local php max_execution_time in php.ini
5331
	 *
5332
	 * @since 2.6
5333
	 * @return int
5334
	 * @deprecated
5335
	 **/
5336
	public function get_remote_query_timeout_limit() {
5337
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5338
		return self::get_max_execution_time();
5339
	}
5340
5341
	/**
5342
	 * Builds the timeout limit for queries talking with the wpcom servers.
5343
	 *
5344
	 * Based on local php max_execution_time in php.ini
5345
	 *
5346
	 * @since 5.4
5347
	 * @return int
5348
	 **/
5349
	public static function get_max_execution_time() {
5350
		$timeout = (int) ini_get( 'max_execution_time' );
5351
5352
		// Ensure exec time set in php.ini
5353
		if ( ! $timeout ) {
5354
			$timeout = 30;
5355
		}
5356
		return $timeout;
5357
	}
5358
5359
	/**
5360
	 * Sets a minimum request timeout, and returns the current timeout
5361
	 *
5362
	 * @since 5.4
5363
	 **/
5364 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5365
		$timeout = self::get_max_execution_time();
5366
		if ( $timeout < $min_timeout ) {
5367
			$timeout = $min_timeout;
5368
			set_time_limit( $timeout );
5369
		}
5370
		return $timeout;
5371
	}
5372
5373
	/**
5374
	 * Takes the response from the Jetpack register new site endpoint and
5375
	 * verifies it worked properly.
5376
	 *
5377
	 * @since 2.6
5378
	 * @deprecated since 7.7.0
5379
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5380
	 **/
5381
	public function validate_remote_register_response() {
5382
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5383
	}
5384
5385
	/**
5386
	 * @return bool|WP_Error
5387
	 */
5388
	public static function register() {
5389
		$tracking = new Tracking();
5390
		$tracking->record_user_event( 'jpc_register_begin' );
5391
5392
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5393
5394
		$connection   = self::connection();
5395
		$registration = $connection->register();
5396
5397
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5398
5399
		if ( ! $registration || is_wp_error( $registration ) ) {
5400
			return $registration;
5401
		}
5402
5403
		return true;
5404
	}
5405
5406
	/**
5407
	 * Filters the registration request body to include tracking properties.
5408
	 *
5409
	 * @param array $properties
5410
	 * @return array amended properties.
5411
	 */
5412 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5413
		$tracking        = new Tracking();
5414
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5415
5416
		return array_merge(
5417
			$properties,
5418
			array(
5419
				'_ui' => $tracks_identity['_ui'],
5420
				'_ut' => $tracks_identity['_ut'],
5421
			)
5422
		);
5423
	}
5424
5425
	/**
5426
	 * Filters the token request body to include tracking properties.
5427
	 *
5428
	 * @param array $properties
5429
	 * @return array amended properties.
5430
	 */
5431 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5432
		$tracking        = new Tracking();
5433
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5434
5435
		return array_merge(
5436
			$properties,
5437
			array(
5438
				'_ui' => $tracks_identity['_ui'],
5439
				'_ut' => $tracks_identity['_ut'],
5440
			)
5441
		);
5442
	}
5443
5444
	/**
5445
	 * If the db version is showing something other that what we've got now, bump it to current.
5446
	 *
5447
	 * @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...
5448
	 */
5449
	public static function maybe_set_version_option() {
5450
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5451
		if ( JETPACK__VERSION != $version ) {
5452
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5453
5454
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5455
				/** This action is documented in class.jetpack.php */
5456
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5457
			}
5458
5459
			return true;
5460
		}
5461
		return false;
5462
	}
5463
5464
	/* Client Server API */
5465
5466
	/**
5467
	 * Loads the Jetpack XML-RPC client.
5468
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5469
	 *
5470
	 * @deprecated since 7.7.0
5471
	 */
5472
	public static function load_xml_rpc_client() {
5473
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5474
	}
5475
5476
	/**
5477
	 * Resets the saved authentication state in between testing requests.
5478
	 */
5479
	public function reset_saved_auth_state() {
5480
		$this->rest_authentication_status = null;
5481
5482
		if ( ! $this->connection_manager ) {
5483
			$this->connection_manager = new Connection_Manager();
5484
		}
5485
5486
		$this->connection_manager->reset_saved_auth_state();
5487
	}
5488
5489
	/**
5490
	 * Verifies the signature of the current request.
5491
	 *
5492
	 * @deprecated since 7.7.0
5493
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5494
	 *
5495
	 * @return false|array
5496
	 */
5497
	public function verify_xml_rpc_signature() {
5498
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5499
		return self::connection()->verify_xml_rpc_signature();
5500
	}
5501
5502
	/**
5503
	 * Verifies the signature of the current request.
5504
	 *
5505
	 * This function has side effects and should not be used. Instead,
5506
	 * use the memoized version `->verify_xml_rpc_signature()`.
5507
	 *
5508
	 * @deprecated since 7.7.0
5509
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5510
	 * @internal
5511
	 */
5512
	private function internal_verify_xml_rpc_signature() {
5513
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5514
	}
5515
5516
	/**
5517
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5518
	 *
5519
	 * @deprecated since 7.7.0
5520
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5521
	 *
5522
	 * @param \WP_User|mixed $user     User object if authenticated.
5523
	 * @param string         $username Username.
5524
	 * @param string         $password Password string.
5525
	 * @return \WP_User|mixed Authenticated user or error.
5526
	 */
5527 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5528
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5529
5530
		if ( ! $this->connection_manager ) {
5531
			$this->connection_manager = new Connection_Manager();
5532
		}
5533
5534
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5535
	}
5536
5537
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5538
	// Uses the existing XMLRPC request signing implementation.
5539
	function wp_rest_authenticate( $user ) {
5540
		if ( ! empty( $user ) ) {
5541
			// Another authentication method is in effect.
5542
			return $user;
5543
		}
5544
5545
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5546
			// Nothing to do for this authentication method.
5547
			return null;
5548
		}
5549
5550
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5551
			// Nothing to do for this authentication method.
5552
			return null;
5553
		}
5554
5555
		// Ensure that we always have the request body available.  At this
5556
		// point, the WP REST API code to determine the request body has not
5557
		// run yet.  That code may try to read from 'php://input' later, but
5558
		// this can only be done once per request in PHP versions prior to 5.6.
5559
		// So we will go ahead and perform this read now if needed, and save
5560
		// the request body where both the Jetpack signature verification code
5561
		// and the WP REST API code can see it.
5562
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5563
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5564
		}
5565
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5566
5567
		// Only support specific request parameters that have been tested and
5568
		// are known to work with signature verification.  A different method
5569
		// can be passed to the WP REST API via the '?_method=' parameter if
5570
		// needed.
5571
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5572
			$this->rest_authentication_status = new WP_Error(
5573
				'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...
5574
				__( 'This request method is not supported.', 'jetpack' ),
5575
				array( 'status' => 400 )
5576
			);
5577
			return null;
5578
		}
5579
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5580
			$this->rest_authentication_status = new WP_Error(
5581
				'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...
5582
				__( 'This request method does not support body parameters.', 'jetpack' ),
5583
				array( 'status' => 400 )
5584
			);
5585
			return null;
5586
		}
5587
5588
		if ( ! $this->connection_manager ) {
5589
			$this->connection_manager = new Connection_Manager();
5590
		}
5591
5592
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5593
5594
		if (
5595
			$verified &&
5596
			isset( $verified['type'] ) &&
5597
			'user' === $verified['type'] &&
5598
			! empty( $verified['user_id'] )
5599
		) {
5600
			// Authentication successful.
5601
			$this->rest_authentication_status = true;
5602
			return $verified['user_id'];
5603
		}
5604
5605
		// Something else went wrong.  Probably a signature error.
5606
		$this->rest_authentication_status = new WP_Error(
5607
			'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...
5608
			__( 'The request is not signed correctly.', 'jetpack' ),
5609
			array( 'status' => 400 )
5610
		);
5611
		return null;
5612
	}
5613
5614
	/**
5615
	 * Report authentication status to the WP REST API.
5616
	 *
5617
	 * @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...
5618
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5619
	 */
5620
	public function wp_rest_authentication_errors( $value ) {
5621
		if ( $value !== null ) {
5622
			return $value;
5623
		}
5624
		return $this->rest_authentication_status;
5625
	}
5626
5627
	/**
5628
	 * Add our nonce to this request.
5629
	 *
5630
	 * @deprecated since 7.7.0
5631
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5632
	 *
5633
	 * @param int    $timestamp Timestamp of the request.
5634
	 * @param string $nonce     Nonce string.
5635
	 */
5636 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5637
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5638
5639
		if ( ! $this->connection_manager ) {
5640
			$this->connection_manager = new Connection_Manager();
5641
		}
5642
5643
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5644
	}
5645
5646
	/**
5647
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5648
	 * Capture it here so we can verify the signature later.
5649
	 *
5650
	 * @deprecated since 7.7.0
5651
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5652
	 *
5653
	 * @param array $methods XMLRPC methods.
5654
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5655
	 */
5656 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5657
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5658
5659
		if ( ! $this->connection_manager ) {
5660
			$this->connection_manager = new Connection_Manager();
5661
		}
5662
5663
		return $this->connection_manager->xmlrpc_methods( $methods );
5664
	}
5665
5666
	/**
5667
	 * Register additional public XMLRPC methods.
5668
	 *
5669
	 * @deprecated since 7.7.0
5670
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5671
	 *
5672
	 * @param array $methods Public XMLRPC methods.
5673
	 * @return array Public XMLRPC methods, with the getOptions one.
5674
	 */
5675 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5676
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5677
5678
		if ( ! $this->connection_manager ) {
5679
			$this->connection_manager = new Connection_Manager();
5680
		}
5681
5682
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5683
	}
5684
5685
	/**
5686
	 * Handles a getOptions XMLRPC method call.
5687
	 *
5688
	 * @deprecated since 7.7.0
5689
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5690
	 *
5691
	 * @param array $args method call arguments.
5692
	 * @return array an amended XMLRPC server options array.
5693
	 */
5694 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5695
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5696
5697
		if ( ! $this->connection_manager ) {
5698
			$this->connection_manager = new Connection_Manager();
5699
		}
5700
5701
		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...
5702
	}
5703
5704
	/**
5705
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5706
	 *
5707
	 * @deprecated since 7.7.0
5708
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5709
	 *
5710
	 * @param array $options Standard Core options.
5711
	 * @return array Amended options.
5712
	 */
5713 View Code Duplication
	public function xmlrpc_options( $options ) {
5714
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5715
5716
		if ( ! $this->connection_manager ) {
5717
			$this->connection_manager = new Connection_Manager();
5718
		}
5719
5720
		return $this->connection_manager->xmlrpc_options( $options );
5721
	}
5722
5723
	/**
5724
	 * Cleans nonces that were saved when calling ::add_nonce.
5725
	 *
5726
	 * @deprecated since 7.7.0
5727
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5728
	 *
5729
	 * @param bool $all whether to clean even non-expired nonces.
5730
	 */
5731
	public static function clean_nonces( $all = false ) {
5732
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5733
		return self::connection()->clean_nonces( $all );
5734
	}
5735
5736
	/**
5737
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5738
	 * SET: state( $key, $value );
5739
	 * GET: $value = state( $key );
5740
	 *
5741
	 * @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...
5742
	 * @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...
5743
	 * @param bool   $restate private
5744
	 */
5745
	public static function state( $key = null, $value = null, $restate = false ) {
5746
		static $state = array();
5747
		static $path, $domain;
5748
		if ( ! isset( $path ) ) {
5749
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5750
			$admin_url = self::admin_url();
5751
			$bits      = wp_parse_url( $admin_url );
5752
5753
			if ( is_array( $bits ) ) {
5754
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5755
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5756
			} else {
5757
				$path = $domain = null;
5758
			}
5759
		}
5760
5761
		// Extract state from cookies and delete cookies
5762
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5763
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5764
			unset( $_COOKIE['jetpackState'] );
5765
			foreach ( $yum as $k => $v ) {
0 ignored issues
show
The expression $yum of type string|array<integer,string> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
5766
				if ( strlen( $v ) ) {
5767
					$state[ $k ] = $v;
5768
				}
5769
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5770
			}
5771
		}
5772
5773
		if ( $restate ) {
5774
			foreach ( $state as $k => $v ) {
5775
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5776
			}
5777
			return;
5778
		}
5779
5780
		// Get a state variable.
5781
		if ( isset( $key ) && ! isset( $value ) ) {
5782
			if ( array_key_exists( $key, $state ) ) {
5783
				return $state[ $key ];
5784
			}
5785
			return null;
5786
		}
5787
5788
		// Set a state variable.
5789
		if ( isset( $key ) && isset( $value ) ) {
5790
			if ( is_array( $value ) && isset( $value[0] ) ) {
5791
				$value = $value[0];
5792
			}
5793
			$state[ $key ] = $value;
5794
			if ( ! headers_sent() ) {
5795
				if ( self::should_set_cookie( $key ) ) {
5796
					setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5797
				}
5798
			}
5799
		}
5800
	}
5801
5802
	public static function restate() {
5803
		self::state( null, null, true );
5804
	}
5805
5806
	/**
5807
	 * Determines whether the jetpackState[$key] value should be added to the
5808
	 * cookie.
5809
	 *
5810
	 * @param string $key The state key.
5811
	 *
5812
	 * @return boolean Whether the value should be added to the cookie.
5813
	 */
5814
	public static function should_set_cookie( $key ) {
5815
		global $current_screen;
5816
		$page = isset( $current_screen->base ) ? $current_screen->base : null;
5817
5818
		if ( 'toplevel_page_jetpack' === $page && 'display_update_modal' === $key ) {
5819
			return false;
5820
		}
5821
5822
		return true;
5823
	}
5824
5825
	public static function check_privacy( $file ) {
5826
		static $is_site_publicly_accessible = null;
5827
5828
		if ( is_null( $is_site_publicly_accessible ) ) {
5829
			$is_site_publicly_accessible = false;
5830
5831
			$rpc = new Jetpack_IXR_Client();
5832
5833
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5834
			if ( $success ) {
5835
				$response = $rpc->getResponse();
5836
				if ( $response ) {
5837
					$is_site_publicly_accessible = true;
5838
				}
5839
			}
5840
5841
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5842
		}
5843
5844
		if ( $is_site_publicly_accessible ) {
5845
			return;
5846
		}
5847
5848
		$module_slug = self::get_module_slug( $file );
5849
5850
		$privacy_checks = self::state( 'privacy_checks' );
5851
		if ( ! $privacy_checks ) {
5852
			$privacy_checks = $module_slug;
5853
		} else {
5854
			$privacy_checks .= ",$module_slug";
5855
		}
5856
5857
		self::state( 'privacy_checks', $privacy_checks );
5858
	}
5859
5860
	/**
5861
	 * Helper method for multicall XMLRPC.
5862
	 *
5863
	 * @param ...$args Args for the async_call.
5864
	 */
5865
	public static function xmlrpc_async_call( ...$args ) {
5866
		global $blog_id;
5867
		static $clients = array();
5868
5869
		$client_blog_id = is_multisite() ? $blog_id : 0;
5870
5871
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5872
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5873
			if ( function_exists( 'ignore_user_abort' ) ) {
5874
				ignore_user_abort( true );
5875
			}
5876
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5877
		}
5878
5879
		if ( ! empty( $args[0] ) ) {
5880
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5881
		} elseif ( is_multisite() ) {
5882
			foreach ( $clients as $client_blog_id => $client ) {
5883
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5884
					continue;
5885
				}
5886
5887
				$switch_success = switch_to_blog( $client_blog_id, true );
5888
				if ( ! $switch_success ) {
5889
					continue;
5890
				}
5891
5892
				flush();
5893
				$client->query();
5894
5895
				restore_current_blog();
5896
			}
5897
		} else {
5898
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5899
				flush();
5900
				$clients[0]->query();
5901
			}
5902
		}
5903
	}
5904
5905
	public static function staticize_subdomain( $url ) {
5906
5907
		// Extract hostname from URL
5908
		$host = wp_parse_url( $url, PHP_URL_HOST );
0 ignored issues
show
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

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

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

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

Loading history...
5909
5910
		// Explode hostname on '.'
5911
		$exploded_host = explode( '.', $host );
5912
5913
		// Retrieve the name and TLD
5914
		if ( count( $exploded_host ) > 1 ) {
5915
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5916
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5917
			// Rebuild domain excluding subdomains
5918
			$domain = $name . '.' . $tld;
5919
		} else {
5920
			$domain = $host;
5921
		}
5922
		// Array of Automattic domains.
5923
		$domains_allowed = array( 'wordpress.com', 'wp.com' );
5924
5925
		// Return $url if not an Automattic domain.
5926
		if ( ! in_array( $domain, $domains_allowed, true ) ) {
5927
			return $url;
5928
		}
5929
5930
		if ( is_ssl() ) {
5931
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
5932
		}
5933
5934
		srand( crc32( basename( $url ) ) );
5935
		$static_counter = rand( 0, 2 );
5936
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
5937
5938
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
5939
	}
5940
5941
	/* JSON API Authorization */
5942
5943
	/**
5944
	 * Handles the login action for Authorizing the JSON API
5945
	 */
5946
	function login_form_json_api_authorization() {
5947
		$this->verify_json_api_authorization_request();
5948
5949
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
5950
5951
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
5952
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
5953
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
5954
	}
5955
5956
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
5957
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
5958
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
5959
			return $url;
5960
		}
5961
5962
		$parsed_url = wp_parse_url( $url );
5963
		$url        = strtok( $url, '?' );
5964
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
5965
		if ( ! empty( $parsed_url['query'] ) ) {
5966
			$url .= "&{$parsed_url['query']}";
5967
		}
5968
5969
		return $url;
5970
	}
5971
5972
	// Make sure the POSTed request is handled by the same action
5973
	function preserve_action_in_login_form_for_json_api_authorization() {
5974
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
5975
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
5976
	}
5977
5978
	// If someone logs in to approve API access, store the Access Code in usermeta
5979
	function store_json_api_authorization_token( $user_login, $user ) {
5980
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
5981
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
5982
		$token = wp_generate_password( 32, false );
5983
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
5984
	}
5985
5986
	// Add public-api.wordpress.com to the safe redirect allowed list - only added when someone allows API access.
5987
	function allow_wpcom_public_api_domain( $domains ) {
5988
		$domains[] = 'public-api.wordpress.com';
5989
		return $domains;
5990
	}
5991
5992
	static function is_redirect_encoded( $redirect_url ) {
5993
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
5994
	}
5995
5996
	// Add all wordpress.com environments to the safe redirect allowed list.
5997
	function allow_wpcom_environments( $domains ) {
5998
		$domains[] = 'wordpress.com';
5999
		$domains[] = 'wpcalypso.wordpress.com';
6000
		$domains[] = 'horizon.wordpress.com';
6001
		$domains[] = 'calypso.localhost';
6002
		return $domains;
6003
	}
6004
6005
	// Add the Access Code details to the public-api.wordpress.com redirect
6006
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6007
		return add_query_arg(
6008
			urlencode_deep(
6009
				array(
6010
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6011
					'jetpack-user-id' => (int) $user->ID,
6012
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6013
				)
6014
			),
6015
			$redirect_to
6016
		);
6017
	}
6018
6019
6020
	/**
6021
	 * Verifies the request by checking the signature
6022
	 *
6023
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6024
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6025
	 *
6026
	 * @param null|array $environment
6027
	 */
6028
	function verify_json_api_authorization_request( $environment = null ) {
6029
		$environment = is_null( $environment )
6030
			? $_REQUEST
6031
			: $environment;
6032
6033
		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...
6034
		$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...
6035
		if ( ! $token || empty( $token->secret ) ) {
6036
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6037
		}
6038
6039
		$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' );
6040
6041
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6042
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6043
			/**
6044
			 * Jetpack authorisation request Error.
6045
			 *
6046
			 * @since 7.5.0
6047
			 */
6048
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6049
			$die_error = sprintf(
6050
				/* translators: %s is a URL */
6051
				__( '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' ),
6052
				Redirect::get_url( 'jetpack-support-double-encoding' )
6053
			);
6054
		}
6055
6056
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6057
6058
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6059
			$signature = $jetpack_signature->sign_request(
6060
				$environment['token'],
6061
				$environment['timestamp'],
6062
				$environment['nonce'],
6063
				'',
6064
				'GET',
6065
				$environment['jetpack_json_api_original_query'],
6066
				null,
6067
				true
6068
			);
6069
		} else {
6070
			$signature = $jetpack_signature->sign_current_request(
6071
				array(
6072
					'body'   => null,
6073
					'method' => 'GET',
6074
				)
6075
			);
6076
		}
6077
6078
		if ( ! $signature ) {
6079
			wp_die( $die_error );
6080
		} elseif ( is_wp_error( $signature ) ) {
6081
			wp_die( $die_error );
6082
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6083
			if ( is_ssl() ) {
6084
				// 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
6085
				$signature = $jetpack_signature->sign_current_request(
6086
					array(
6087
						'scheme' => 'http',
6088
						'body'   => null,
6089
						'method' => 'GET',
6090
					)
6091
				);
6092
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6093
					wp_die( $die_error );
6094
				}
6095
			} else {
6096
				wp_die( $die_error );
6097
			}
6098
		}
6099
6100
		$timestamp = (int) $environment['timestamp'];
6101
		$nonce     = stripslashes( (string) $environment['nonce'] );
6102
6103
		if ( ! $this->connection_manager ) {
6104
			$this->connection_manager = new Connection_Manager();
6105
		}
6106
6107
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6108
			// De-nonce the nonce, at least for 5 minutes.
6109
			// 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)
6110
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6111
			if ( $old_nonce_time < time() - 300 ) {
6112
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6113
			}
6114
		}
6115
6116
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6117
		$data_filters = array(
6118
			'state'        => 'opaque',
6119
			'client_id'    => 'int',
6120
			'client_title' => 'string',
6121
			'client_image' => 'url',
6122
		);
6123
6124
		foreach ( $data_filters as $key => $sanitation ) {
6125
			if ( ! isset( $data->$key ) ) {
6126
				wp_die( $die_error );
6127
			}
6128
6129
			switch ( $sanitation ) {
6130
				case 'int':
6131
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6132
					break;
6133
				case 'opaque':
6134
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6135
					break;
6136
				case 'string':
6137
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6138
					break;
6139
				case 'url':
6140
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6141
					break;
6142
			}
6143
		}
6144
6145
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6146
			wp_die( $die_error );
6147
		}
6148
	}
6149
6150
	function login_message_json_api_authorization( $message ) {
6151
		return '<p class="message">' . sprintf(
6152
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6153
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6154
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6155
	}
6156
6157
	/**
6158
	 * Get $content_width, but with a <s>twist</s> filter.
6159
	 */
6160
	public static function get_content_width() {
6161
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6162
			? $GLOBALS['content_width']
6163
			: false;
6164
		/**
6165
		 * Filter the Content Width value.
6166
		 *
6167
		 * @since 2.2.3
6168
		 *
6169
		 * @param string $content_width Content Width value.
6170
		 */
6171
		return apply_filters( 'jetpack_content_width', $content_width );
6172
	}
6173
6174
	/**
6175
	 * Pings the WordPress.com Mirror Site for the specified options.
6176
	 *
6177
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6178
	 *
6179
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6180
	 */
6181
	public function get_cloud_site_options( $option_names ) {
6182
		$option_names = array_filter( (array) $option_names, 'is_string' );
6183
6184
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6185
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6186
		if ( $xml->isError() ) {
6187
			return array(
6188
				'error_code' => $xml->getErrorCode(),
6189
				'error_msg'  => $xml->getErrorMessage(),
6190
			);
6191
		}
6192
		$cloud_site_options = $xml->getResponse();
6193
6194
		return $cloud_site_options;
6195
	}
6196
6197
	/**
6198
	 * Checks if the site is currently in an identity crisis.
6199
	 *
6200
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6201
	 */
6202
	public static function check_identity_crisis() {
6203
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6204
			return false;
6205
		}
6206
6207
		return Jetpack_Options::get_option( 'sync_error_idc' );
6208
	}
6209
6210
	/**
6211
	 * Checks whether the home and siteurl specifically are allowed.
6212
	 * Written so that we don't have re-check $key and $value params every time
6213
	 * we want to check if this site is allowed, for example in footer.php
6214
	 *
6215
	 * @since  3.8.0
6216
	 * @return bool True = already allowed False = not on the allowed list.
6217
	 */
6218
	public static function is_staging_site() {
6219
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6220
		return ( new Status() )->is_staging_site();
6221
	}
6222
6223
	/**
6224
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6225
	 *
6226
	 * @since 4.4.0
6227
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6228
	 *
6229
	 * @return bool
6230
	 */
6231
	public static function validate_sync_error_idc_option() {
6232
		$is_valid = false;
6233
6234
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6235
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6236
		if ( $sync_error && self::sync_idc_optin() ) {
6237
			$local_options = self::get_sync_error_idc_option();
6238
			// Ensure all values are set.
6239
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6240
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6241
					$is_valid = true;
6242
				}
6243
			}
6244
		}
6245
6246
		/**
6247
		 * Filters whether the sync_error_idc option is valid.
6248
		 *
6249
		 * @since 4.4.0
6250
		 *
6251
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6252
		 */
6253
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6254
6255
		if ( ! $is_valid && $sync_error ) {
6256
			// Since the option exists, and did not validate, delete it
6257
			Jetpack_Options::delete_option( 'sync_error_idc' );
6258
		}
6259
6260
		return $is_valid;
6261
	}
6262
6263
	/**
6264
	 * Normalizes a url by doing three things:
6265
	 *  - Strips protocol
6266
	 *  - Strips www
6267
	 *  - Adds a trailing slash
6268
	 *
6269
	 * @since 4.4.0
6270
	 * @param string $url
6271
	 * @return WP_Error|string
6272
	 */
6273
	public static function normalize_url_protocol_agnostic( $url ) {
6274
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6275
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6276
			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...
6277
		}
6278
6279
		// Strip www and protocols
6280
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6281
		return $url;
6282
	}
6283
6284
	/**
6285
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6286
	 *
6287
	 * @since 4.4.0
6288
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6289
	 *
6290
	 * @param array $response
6291
	 * @return array Array of the local urls, wpcom urls, and error code
6292
	 */
6293
	public static function get_sync_error_idc_option( $response = array() ) {
6294
		// Since the local options will hit the database directly, store the values
6295
		// in a transient to allow for autoloading and caching on subsequent views.
6296
		$local_options = get_transient( 'jetpack_idc_local' );
6297
		if ( false === $local_options ) {
6298
			$local_options = array(
6299
				'home'    => Functions::home_url(),
6300
				'siteurl' => Functions::site_url(),
6301
			);
6302
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6303
		}
6304
6305
		$options = array_merge( $local_options, $response );
6306
6307
		$returned_values = array();
6308
		foreach ( $options as $key => $option ) {
6309
			if ( 'error_code' === $key ) {
6310
				$returned_values[ $key ] = $option;
6311
				continue;
6312
			}
6313
6314
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6315
				continue;
6316
			}
6317
6318
			$returned_values[ $key ] = $normalized_url;
6319
		}
6320
6321
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6322
6323
		return $returned_values;
6324
	}
6325
6326
	/**
6327
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6328
	 * If set to true, the site will be put into staging mode.
6329
	 *
6330
	 * @since 4.3.2
6331
	 * @return bool
6332
	 */
6333
	public static function sync_idc_optin() {
6334
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6335
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6336
		} else {
6337
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6338
		}
6339
6340
		/**
6341
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6342
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6343
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6344
		 *
6345
		 * @since 4.3.2
6346
		 *
6347
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6348
		 */
6349
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6350
	}
6351
6352
	/**
6353
	 * Maybe Use a .min.css stylesheet, maybe not.
6354
	 *
6355
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6356
	 */
6357
	public static function maybe_min_asset( $url, $path, $plugin ) {
6358
		// Short out on things trying to find actual paths.
6359
		if ( ! $path || empty( $plugin ) ) {
6360
			return $url;
6361
		}
6362
6363
		$path = ltrim( $path, '/' );
6364
6365
		// Strip out the abspath.
6366
		$base = dirname( plugin_basename( $plugin ) );
6367
6368
		// Short out on non-Jetpack assets.
6369
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6370
			return $url;
6371
		}
6372
6373
		// File name parsing.
6374
		$file              = "{$base}/{$path}";
6375
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6376
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6377
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6378
		$extension         = array_shift( $file_name_parts_r );
6379
6380
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6381
			// Already pointing at the minified version.
6382
			if ( 'min' === $file_name_parts_r[0] ) {
6383
				return $url;
6384
			}
6385
6386
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6387
			if ( file_exists( $min_full_path ) ) {
6388
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6389
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6390
				if ( 'css' === $extension ) {
6391
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6392
					self::$min_assets[ $key ] = $path;
6393
				}
6394
			}
6395
		}
6396
6397
		return $url;
6398
	}
6399
6400
	/**
6401
	 * If the asset is minified, let's flag .min as the suffix.
6402
	 *
6403
	 * Attached to `style_loader_src` filter.
6404
	 *
6405
	 * @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...
6406
	 * @param string $handle The registered handle of the script in question.
6407
	 * @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...
6408
	 */
6409
	public static function set_suffix_on_min( $src, $handle ) {
6410
		if ( false === strpos( $src, '.min.css' ) ) {
6411
			return $src;
6412
		}
6413
6414
		if ( ! empty( self::$min_assets ) ) {
6415
			foreach ( self::$min_assets as $file => $path ) {
6416
				if ( false !== strpos( $src, $file ) ) {
6417
					wp_style_add_data( $handle, 'suffix', '.min' );
6418
					return $src;
6419
				}
6420
			}
6421
		}
6422
6423
		return $src;
6424
	}
6425
6426
	/**
6427
	 * Maybe inlines a stylesheet.
6428
	 *
6429
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6430
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6431
	 *
6432
	 * Attached to `style_loader_tag` filter.
6433
	 *
6434
	 * @param string $tag The tag that would link to the external asset.
6435
	 * @param string $handle The registered handle of the script in question.
6436
	 *
6437
	 * @return string
6438
	 */
6439
	public static function maybe_inline_style( $tag, $handle ) {
6440
		global $wp_styles;
6441
		$item = $wp_styles->registered[ $handle ];
6442
6443
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6444
			return $tag;
6445
		}
6446
6447
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6448
			$href = $matches[1];
6449
			// Strip off query string
6450
			if ( $pos = strpos( $href, '?' ) ) {
6451
				$href = substr( $href, 0, $pos );
6452
			}
6453
			// Strip off fragment
6454
			if ( $pos = strpos( $href, '#' ) ) {
6455
				$href = substr( $href, 0, $pos );
6456
			}
6457
		} else {
6458
			return $tag;
6459
		}
6460
6461
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6462
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6463
			return $tag;
6464
		}
6465
6466
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6467
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6468
			// And this isn't the pass that actually deals with the RTL version...
6469
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6470
				// Short out, as the RTL version will deal with it in a moment.
6471
				return $tag;
6472
			}
6473
		}
6474
6475
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6476
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6477
		if ( $css ) {
6478
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6479
			if ( empty( $item->extra['after'] ) ) {
6480
				wp_add_inline_style( $handle, $css );
6481
			} else {
6482
				array_unshift( $item->extra['after'], $css );
6483
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6484
			}
6485
		}
6486
6487
		return $tag;
6488
	}
6489
6490
	/**
6491
	 * Loads a view file from the views
6492
	 *
6493
	 * Data passed in with the $data parameter will be available in the
6494
	 * template file as $data['value']
6495
	 *
6496
	 * @param string $template - Template file to load
6497
	 * @param array  $data - Any data to pass along to the template
6498
	 * @return boolean - If template file was found
6499
	 **/
6500
	public function load_view( $template, $data = array() ) {
6501
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6502
6503
		if ( file_exists( $views_dir . $template ) ) {
6504
			require_once $views_dir . $template;
6505
			return true;
6506
		}
6507
6508
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6509
		return false;
6510
	}
6511
6512
	/**
6513
	 * Throws warnings for deprecated hooks to be removed from Jetpack that cannot remain in the original place in the code.
6514
	 *
6515
	 * @todo Convert these to use apply_filters_deprecated and do_action_deprecated and remove custom code.
6516
	 */
6517
	public function deprecated_hooks() {
6518
		global $wp_filter;
6519
6520
		/*
6521
		 * Format:
6522
		 * deprecated_filter_name => replacement_name
6523
		 *
6524
		 * If there is no replacement, use null for replacement_name
6525
		 */
6526
		$deprecated_list = array(
6527
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6528
			'wpl_sharing_2014_1'                           => null,
6529
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6530
			'jetpack_identity_crisis_options_to_check'     => null,
6531
			'update_option_jetpack_single_user_site'       => null,
6532
			'audio_player_default_colors'                  => null,
6533
			'add_option_jetpack_featured_images_enabled'   => null,
6534
			'add_option_jetpack_update_details'            => null,
6535
			'add_option_jetpack_updates'                   => null,
6536
			'add_option_jetpack_network_name'              => null,
6537
			'add_option_jetpack_network_allow_new_registrations' => null,
6538
			'add_option_jetpack_network_add_new_users'     => null,
6539
			'add_option_jetpack_network_site_upload_space' => null,
6540
			'add_option_jetpack_network_upload_file_types' => null,
6541
			'add_option_jetpack_network_enable_administration_menus' => null,
6542
			'add_option_jetpack_is_multi_site'             => null,
6543
			'add_option_jetpack_is_main_network'           => null,
6544
			'add_option_jetpack_main_network_site'         => null,
6545
			'jetpack_sync_all_registered_options'          => null,
6546
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6547
			'jetpack_is_post_mailable'                     => null,
6548
			'jetpack_seo_site_host'                        => null,
6549
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6550
			'jetpack_holiday_snow_option_name'             => null,
6551
			'jetpack_holiday_chance_of_snow'               => null,
6552
			'jetpack_holiday_snow_js_url'                  => null,
6553
			'jetpack_is_holiday_snow_season'               => null,
6554
			'jetpack_holiday_snow_option_updated'          => null,
6555
			'jetpack_holiday_snowing'                      => null,
6556
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6557
			'jetpack_cache_plans'                          => null,
6558
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6559
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6560
			'jetpack_enable_site_verification'             => null,
6561
			// Removed in Jetpack 7.3.0
6562
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6563
			// Removed in Jetpack 7.9.0
6564
			'jetpack_pwa_manifest'                         => null,
6565
			'jetpack_pwa_background_color'                 => null,
6566
			// Removed in Jetpack 8.3.0.
6567
			'jetpack_check_mobile'                         => null,
6568
			'jetpack_mobile_stylesheet'                    => null,
6569
			'jetpack_mobile_template'                      => null,
6570
			'mobile_reject_mobile'                         => null,
6571
			'mobile_force_mobile'                          => null,
6572
			'mobile_app_promo_download'                    => null,
6573
			'mobile_setup'                                 => null,
6574
			'jetpack_mobile_footer_before'                 => null,
6575
			'wp_mobile_theme_footer'                       => null,
6576
			'minileven_credits'                            => null,
6577
			'jetpack_mobile_header_before'                 => null,
6578
			'jetpack_mobile_header_after'                  => null,
6579
			'jetpack_mobile_theme_menu'                    => null,
6580
			'minileven_show_featured_images'               => null,
6581
			'minileven_attachment_size'                    => null,
6582
		);
6583
6584
		// This is a silly loop depth. Better way?
6585
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6586
			if ( has_action( $hook ) ) {
6587
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6588
					foreach ( $values as $hooked ) {
6589
						if ( is_callable( $hooked['function'] ) ) {
6590
							$function_name = $hooked['function'];
6591
						} else {
6592
							$function_name = 'an anonymous function';
6593
						}
6594
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6595
					}
6596
				}
6597
			}
6598
		}
6599
6600
		$filter_deprecated_list = array(
6601
			'can_display_jetpack_manage_notice' => array(
6602
				'replacement' => null,
6603
				'version'     => 'jetpack-7.3.0',
6604
			),
6605
			'atd_http_post_timeout'             => array(
6606
				'replacement' => null,
6607
				'version'     => 'jetpack-7.3.0',
6608
			),
6609
			'atd_service_domain'                => array(
6610
				'replacement' => null,
6611
				'version'     => 'jetpack-7.3.0',
6612
			),
6613
			'atd_load_scripts'                  => array(
6614
				'replacement' => null,
6615
				'version'     => 'jetpack-7.3.0',
6616
			),
6617
		);
6618
6619
		foreach ( $filter_deprecated_list as $tag => $args ) {
6620
			if ( has_filter( $tag ) ) {
6621
				apply_filters_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6622
			}
6623
		}
6624
6625
		$action_deprecated_list = array(
6626
			'atd_http_post_error' => array(
6627
				'replacement' => null,
6628
				'version'     => 'jetpack-7.3.0',
6629
			),
6630
		);
6631
6632
		foreach ( $action_deprecated_list as $tag => $args ) {
6633
			if ( has_action( $tag ) ) {
6634
				do_action_deprecated( $tag, array(), $args['version'], $args['replacement'] );
6635
			}
6636
		}
6637
	}
6638
6639
	/**
6640
	 * Converts any url in a stylesheet, to the correct absolute url.
6641
	 *
6642
	 * Considerations:
6643
	 *  - Normal, relative URLs     `feh.png`
6644
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6645
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6646
	 *  - Absolute URLs             `http://domain.com/feh.png`
6647
	 *  - Domain root relative URLs `/feh.png`
6648
	 *
6649
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6650
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6651
	 *
6652
	 * @return mixed|string
6653
	 */
6654
	public static function absolutize_css_urls( $css, $css_file_url ) {
6655
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6656
		$css_dir = dirname( $css_file_url );
6657
		$p       = wp_parse_url( $css_dir );
6658
		$domain  = sprintf(
6659
			'%1$s//%2$s%3$s%4$s',
6660
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6661
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6662
			$p['host'],
6663
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6664
		);
6665
6666
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6667
			$find = $replace = array();
6668
			foreach ( $matches as $match ) {
6669
				$url = trim( $match['path'], "'\" \t" );
6670
6671
				// If this is a data url, we don't want to mess with it.
6672
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6673
					continue;
6674
				}
6675
6676
				// If this is an absolute or protocol-agnostic url,
6677
				// we don't want to mess with it.
6678
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6679
					continue;
6680
				}
6681
6682
				switch ( substr( $url, 0, 1 ) ) {
6683
					case '/':
6684
						$absolute = $domain . $url;
6685
						break;
6686
					default:
6687
						$absolute = $css_dir . '/' . $url;
6688
				}
6689
6690
				$find[]    = $match[0];
6691
				$replace[] = sprintf( 'url("%s")', $absolute );
6692
			}
6693
			$css = str_replace( $find, $replace, $css );
6694
		}
6695
6696
		return $css;
6697
	}
6698
6699
	/**
6700
	 * This methods removes all of the registered css files on the front end
6701
	 * from Jetpack in favor of using a single file. In effect "imploding"
6702
	 * all the files into one file.
6703
	 *
6704
	 * Pros:
6705
	 * - Uses only ONE css asset connection instead of 15
6706
	 * - Saves a minimum of 56k
6707
	 * - Reduces server load
6708
	 * - Reduces time to first painted byte
6709
	 *
6710
	 * Cons:
6711
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6712
	 *      should not cause any issues with themes.
6713
	 * - Plugins/themes dequeuing styles no longer do anything. See
6714
	 *      jetpack_implode_frontend_css filter for a workaround
6715
	 *
6716
	 * For some situations developers may wish to disable css imploding and
6717
	 * instead operate in legacy mode where each file loads seperately and
6718
	 * can be edited individually or dequeued. This can be accomplished with
6719
	 * the following line:
6720
	 *
6721
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6722
	 *
6723
	 * @since 3.2
6724
	 **/
6725
	public function implode_frontend_css( $travis_test = false ) {
6726
		$do_implode = true;
6727
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6728
			$do_implode = false;
6729
		}
6730
6731
		// Do not implode CSS when the page loads via the AMP plugin.
6732
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6733
			$do_implode = false;
6734
		}
6735
6736
		/**
6737
		 * Allow CSS to be concatenated into a single jetpack.css file.
6738
		 *
6739
		 * @since 3.2.0
6740
		 *
6741
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6742
		 */
6743
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6744
6745
		// Do not use the imploded file when default behavior was altered through the filter
6746
		if ( ! $do_implode ) {
6747
			return;
6748
		}
6749
6750
		// We do not want to use the imploded file in dev mode, or if not connected
6751
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6752
			if ( ! $travis_test ) {
6753
				return;
6754
			}
6755
		}
6756
6757
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6758
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6759
			return;
6760
		}
6761
6762
		/*
6763
		 * Now we assume Jetpack is connected and able to serve the single
6764
		 * file.
6765
		 *
6766
		 * In the future there will be a check here to serve the file locally
6767
		 * or potentially from the Jetpack CDN
6768
		 *
6769
		 * For now:
6770
		 * - Enqueue a single imploded css file
6771
		 * - Zero out the style_loader_tag for the bundled ones
6772
		 * - Be happy, drink scotch
6773
		 */
6774
6775
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6776
6777
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6778
6779
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6780
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6781
	}
6782
6783
	function concat_remove_style_loader_tag( $tag, $handle ) {
6784
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6785
			$tag = '';
6786
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6787
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6788
			}
6789
		}
6790
6791
		return $tag;
6792
	}
6793
6794
	/**
6795
	 * @deprecated
6796
	 * @see Automattic\Jetpack\Assets\add_aync_script
6797
	 */
6798
	public function script_add_async( $tag, $handle, $src ) {
6799
		_deprecated_function( __METHOD__, 'jetpack-8.6.0' );
6800
	}
6801
6802
	/*
6803
	 * Check the heartbeat data
6804
	 *
6805
	 * Organizes the heartbeat data by severity.  For example, if the site
6806
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6807
	 *
6808
	 * Data will be added to "caution" array, if it either:
6809
	 *  - Out of date Jetpack version
6810
	 *  - Out of date WP version
6811
	 *  - Out of date PHP version
6812
	 *
6813
	 * $return array $filtered_data
6814
	 */
6815
	public static function jetpack_check_heartbeat_data() {
6816
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6817
6818
		$good    = array();
6819
		$caution = array();
6820
		$bad     = array();
6821
6822
		foreach ( $raw_data as $stat => $value ) {
6823
6824
			// Check jetpack version
6825
			if ( 'version' == $stat ) {
6826
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6827
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6828
					continue;
6829
				}
6830
			}
6831
6832
			// Check WP version
6833
			if ( 'wp-version' == $stat ) {
6834
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6835
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6836
					continue;
6837
				}
6838
			}
6839
6840
			// Check PHP version
6841
			if ( 'php-version' == $stat ) {
6842
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6843
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6844
					continue;
6845
				}
6846
			}
6847
6848
			// Check ID crisis
6849
			if ( 'identitycrisis' == $stat ) {
6850
				if ( 'yes' == $value ) {
6851
					$bad[ $stat ] = $value;
6852
					continue;
6853
				}
6854
			}
6855
6856
			// The rest are good :)
6857
			$good[ $stat ] = $value;
6858
		}
6859
6860
		$filtered_data = array(
6861
			'good'    => $good,
6862
			'caution' => $caution,
6863
			'bad'     => $bad,
6864
		);
6865
6866
		return $filtered_data;
6867
	}
6868
6869
6870
	/*
6871
	 * This method is used to organize all options that can be reset
6872
	 * without disconnecting Jetpack.
6873
	 *
6874
	 * It is used in class.jetpack-cli.php to reset options
6875
	 *
6876
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6877
	 *
6878
	 * @return array of options to delete.
6879
	 */
6880
	public static function get_jetpack_options_for_reset() {
6881
		return Jetpack_Options::get_options_for_reset();
6882
	}
6883
6884
	/*
6885
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6886
	 * so we can bring them directly to their site in calypso.
6887
	 *
6888
	 * @param string | url
6889
	 * @return string | url without the guff
6890
	 */
6891 View Code Duplication
	public static function build_raw_urls( $url ) {
6892
		$strip_http = '/.*?:\/\//i';
6893
		$url        = preg_replace( $strip_http, '', $url );
6894
		$url        = str_replace( '/', '::', $url );
6895
		return $url;
6896
	}
6897
6898
	/**
6899
	 * Stores and prints out domains to prefetch for page speed optimization.
6900
	 *
6901
	 * @deprecated 8.8.0 Use Jetpack::add_resource_hints.
6902
	 *
6903
	 * @param string|array $urls URLs to hint.
0 ignored issues
show
Should the type for parameter $urls not be string|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...
6904
	 */
6905
	public static function dns_prefetch( $urls = null ) {
6906
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Automattic\Jetpack\Assets::add_resource_hint' );
6907
		if ( $urls ) {
6908
			Assets::add_resource_hint( $urls );
6909
		}
6910
	}
6911
6912
	public function wp_dashboard_setup() {
6913
		if ( self::is_active() ) {
6914
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6915
		}
6916
6917
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6918
			$jetpack_logo = new Jetpack_Logo();
6919
			$widget_title = sprintf(
6920
				wp_kses(
6921
					/* translators: Placeholder is a Jetpack logo. */
6922
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6923
					array( 'span' => array() )
6924
				),
6925
				$jetpack_logo->get_jp_emblem( true )
6926
			);
6927
6928
			wp_add_dashboard_widget(
6929
				'jetpack_summary_widget',
6930
				$widget_title,
6931
				array( __CLASS__, 'dashboard_widget' )
6932
			);
6933
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6934
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6935
6936
			// If we're inactive and not in development mode, sort our box to the top.
6937
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6938
				global $wp_meta_boxes;
6939
6940
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6941
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6942
6943
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6944
			}
6945
		}
6946
	}
6947
6948
	/**
6949
	 * @param mixed $result Value for the user's option
0 ignored issues
show
There is no parameter named $result. Was it maybe removed?

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

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

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

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

Loading history...
6950
	 * @return mixed
6951
	 */
6952
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6953
		if ( ! is_array( $sorted ) ) {
6954
			return $sorted;
6955
		}
6956
6957
		foreach ( $sorted as $box_context => $ids ) {
6958
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6959
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6960
				continue;
6961
			}
6962
6963
			$ids_array = explode( ',', $ids );
6964
			$key       = array_search( 'dashboard_stats', $ids_array );
6965
6966
			if ( false !== $key ) {
6967
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6968
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6969
				$sorted[ $box_context ] = implode( ',', $ids_array );
6970
				// We've found it, stop searching, and just return.
6971
				break;
6972
			}
6973
		}
6974
6975
		return $sorted;
6976
	}
6977
6978
	public static function dashboard_widget() {
6979
		/**
6980
		 * Fires when the dashboard is loaded.
6981
		 *
6982
		 * @since 3.4.0
6983
		 */
6984
		do_action( 'jetpack_dashboard_widget' );
6985
	}
6986
6987
	public static function dashboard_widget_footer() {
6988
		?>
6989
		<footer>
6990
6991
		<div class="protect">
6992
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
6993
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6994
				<p class="blocked-count">
6995
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
6996
				</p>
6997
				<p><?php echo esc_html_x( 'Blocked malicious login attempts', '{#} Blocked malicious login attempts -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6998
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6999
				<a href="
7000
				<?php
7001
				echo esc_url(
7002
					wp_nonce_url(
7003
						self::admin_url(
7004
							array(
7005
								'action' => 'activate',
7006
								'module' => 'protect',
7007
							)
7008
						),
7009
						'jetpack_activate-protect'
7010
					)
7011
				);
7012
				?>
7013
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7014
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7015
				</a>
7016
			<?php else : ?>
7017
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7018
			<?php endif; ?>
7019
		</div>
7020
7021
		<div class="akismet">
7022
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7023
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7024
				<p class="blocked-count">
7025
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7026
				</p>
7027
				<p><?php echo esc_html_x( 'Blocked spam comments.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
7028
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7029
				<a href="
7030
				<?php
7031
				echo esc_url(
7032
					wp_nonce_url(
7033
						add_query_arg(
7034
							array(
7035
								'action' => 'activate',
7036
								'plugin' => 'akismet/akismet.php',
7037
							),
7038
							admin_url( 'plugins.php' )
7039
						),
7040
						'activate-plugin_akismet/akismet.php'
7041
					)
7042
				);
7043
				?>
7044
							" class="button button-jetpack">
7045
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7046
				</a>
7047
			<?php else : ?>
7048
				<p><a href="<?php echo esc_url( 'https://akismet.com/?utm_source=jetpack&utm_medium=link&utm_campaign=Jetpack%20Dashboard%20Widget%20Footer%20Link' ); ?>"><?php esc_html_e( 'Anti-spam can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
7049
			<?php endif; ?>
7050
		</div>
7051
7052
		</footer>
7053
		<?php
7054
	}
7055
7056
	/*
7057
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7058
	 */
7059
	function jetpack_icon_user_connected( $columns ) {
7060
		$columns['user_jetpack'] = '';
7061
		return $columns;
7062
	}
7063
7064
	/*
7065
	 * Show Jetpack icon if the user is linked.
7066
	 */
7067
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7068
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7069
			$jetpack_logo = new Jetpack_Logo();
7070
			$emblem_html  = sprintf(
7071
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7072
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7073
				$jetpack_logo->get_jp_emblem()
7074
			);
7075
			return $emblem_html;
7076
		}
7077
7078
		return $val;
7079
	}
7080
7081
	/*
7082
	 * Style the Jetpack user column
7083
	 */
7084
	function jetpack_user_col_style() {
7085
		global $current_screen;
7086
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7087
			?>
7088
			<style>
7089
				.fixed .column-user_jetpack {
7090
					width: 21px;
7091
				}
7092
				.jp-emblem-user-admin svg {
7093
					width: 20px;
7094
					height: 20px;
7095
				}
7096
				.jp-emblem-user-admin path {
7097
					fill: #00BE28;
7098
				}
7099
			</style>
7100
			<?php
7101
		}
7102
	}
7103
7104
	/**
7105
	 * Checks if Akismet is active and working.
7106
	 *
7107
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7108
	 * that implied usage of methods present since more recent version.
7109
	 * See https://github.com/Automattic/jetpack/pull/9585
7110
	 *
7111
	 * @since  5.1.0
7112
	 *
7113
	 * @return bool True = Akismet available. False = Aksimet not available.
7114
	 */
7115
	public static function is_akismet_active() {
7116
		static $status = null;
7117
7118
		if ( ! is_null( $status ) ) {
7119
			return $status;
7120
		}
7121
7122
		// Check if a modern version of Akismet is active.
7123
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7124
			$status = false;
7125
			return $status;
7126
		}
7127
7128
		// Make sure there is a key known to Akismet at all before verifying key.
7129
		$akismet_key = Akismet::get_api_key();
7130
		if ( ! $akismet_key ) {
7131
			$status = false;
7132
			return $status;
7133
		}
7134
7135
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7136
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7137
7138
		// Do not used the cache result in wp-admin or REST API requests if the key isn't valid, in case someone is actively renewing, etc.
7139
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7140
		// We cache the result of the Akismet key verification for ten minutes.
7141
		if ( ! $akismet_key_state || $recheck ) {
7142
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7143
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7144
		}
7145
7146
		$status = 'valid' === $akismet_key_state;
7147
7148
		return $status;
7149
	}
7150
7151
	/**
7152
	 * @deprecated
7153
	 *
7154
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7155
	 */
7156
	public static function is_function_in_backtrace() {
7157
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7158
	}
7159
7160
	/**
7161
	 * Given a minified path, and a non-minified path, will return
7162
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7163
	 *
7164
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7165
	 * root Jetpack directory.
7166
	 *
7167
	 * @since 5.6.0
7168
	 *
7169
	 * @param string $min_path
7170
	 * @param string $non_min_path
7171
	 * @return string The URL to the file
7172
	 */
7173
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7174
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7175
	}
7176
7177
	/**
7178
	 * Checks for whether Jetpack Backup is enabled.
7179
	 * Will return true if the state of Backup is anything except "unavailable".
7180
	 *
7181
	 * @return bool|int|mixed
7182
	 */
7183
	public static function is_rewind_enabled() {
7184
		if ( ! self::is_active() ) {
7185
			return false;
7186
		}
7187
7188
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7189
		if ( false === $rewind_enabled ) {
7190
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7191
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7192
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7193
				&& ! empty( $rewind_data['state'] )
7194
				&& 'active' === $rewind_data['state'] )
7195
				? 1
7196
				: 0;
7197
7198
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7199
		}
7200
		return $rewind_enabled;
7201
	}
7202
7203
	/**
7204
	 * Return Calypso environment value; used for developing Jetpack and pairing
7205
	 * it with different Calypso enrionments, such as localhost.
7206
	 *
7207
	 * @since 7.4.0
7208
	 *
7209
	 * @return string Calypso environment
7210
	 */
7211
	public static function get_calypso_env() {
7212
		if ( isset( $_GET['calypso_env'] ) ) {
7213
			return sanitize_key( $_GET['calypso_env'] );
7214
		}
7215
7216
		if ( getenv( 'CALYPSO_ENV' ) ) {
7217
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7218
		}
7219
7220
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7221
			return sanitize_key( CALYPSO_ENV );
7222
		}
7223
7224
		return '';
7225
	}
7226
7227
	/**
7228
	 * Returns the hostname with protocol for Calypso.
7229
	 * Used for developing Jetpack with Calypso.
7230
	 *
7231
	 * @since 8.4.0
7232
	 *
7233
	 * @return string Calypso host.
7234
	 */
7235
	public static function get_calypso_host() {
7236
		$calypso_env = self::get_calypso_env();
7237
		switch ( $calypso_env ) {
7238
			case 'development':
7239
				return 'http://calypso.localhost:3000/';
7240
			case 'wpcalypso':
7241
				return 'https://wpcalypso.wordpress.com/';
7242
			case 'horizon':
7243
				return 'https://horizon.wordpress.com/';
7244
			default:
7245
				return 'https://wordpress.com/';
7246
		}
7247
	}
7248
7249
	/**
7250
	 * Checks whether or not TOS has been agreed upon.
7251
	 * Will return true if a user has clicked to register, or is already connected.
7252
	 */
7253
	public static function jetpack_tos_agreed() {
7254
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7255
7256
		$terms_of_service = new Terms_Of_Service();
7257
		return $terms_of_service->has_agreed();
7258
7259
	}
7260
7261
	/**
7262
	 * Handles activating default modules as well general cleanup for the new connection.
7263
	 *
7264
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7265
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7266
	 * @param boolean $send_state_messages          Whether to send state messages.
7267
	 * @return void
7268
	 */
7269
	public static function handle_post_authorization_actions(
7270
		$activate_sso = false,
7271
		$redirect_on_activation_error = false,
7272
		$send_state_messages = true
7273
	) {
7274
		$other_modules = $activate_sso
7275
			? array( 'sso' )
7276
			: array();
7277
7278
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7279
			self::delete_active_modules();
7280
7281
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
999 is of type integer, but the function expects a boolean.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
7282
		} else {
7283
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7284
		}
7285
7286
		// Since this is a fresh connection, be sure to clear out IDC options
7287
		Jetpack_IDC::clear_all_idc_options();
7288
7289
		if ( $send_state_messages ) {
7290
			self::state( 'message', 'authorized' );
7291
		}
7292
	}
7293
7294
	/**
7295
	 * Returns a boolean for whether backups UI should be displayed or not.
7296
	 *
7297
	 * @return bool Should backups UI be displayed?
7298
	 */
7299
	public static function show_backups_ui() {
7300
		/**
7301
		 * Whether UI for backups should be displayed.
7302
		 *
7303
		 * @since 6.5.0
7304
		 *
7305
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7306
		 */
7307
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7308
	}
7309
7310
	/*
7311
	 * Deprecated manage functions
7312
	 */
7313
	function prepare_manage_jetpack_notice() {
7314
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7315
	}
7316
	function manage_activate_screen() {
7317
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7318
	}
7319
	function admin_jetpack_manage_notice() {
7320
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7321
	}
7322
	function opt_out_jetpack_manage_url() {
7323
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7324
	}
7325
	function opt_in_jetpack_manage_url() {
7326
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7327
	}
7328
	function opt_in_jetpack_manage_notice() {
7329
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7330
	}
7331
	function can_display_jetpack_manage_notice() {
7332
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7333
	}
7334
7335
	/**
7336
	 * Clean leftoveruser meta.
7337
	 *
7338
	 * Delete Jetpack-related user meta when it is no longer needed.
7339
	 *
7340
	 * @since 7.3.0
7341
	 *
7342
	 * @param int $user_id User ID being updated.
7343
	 */
7344
	public static function user_meta_cleanup( $user_id ) {
7345
		$meta_keys = array(
7346
			// AtD removed from Jetpack 7.3
7347
			'AtD_options',
7348
			'AtD_check_when',
7349
			'AtD_guess_lang',
7350
			'AtD_ignored_phrases',
7351
		);
7352
7353
		foreach ( $meta_keys as $meta_key ) {
7354
			if ( get_user_meta( $user_id, $meta_key ) ) {
7355
				delete_user_meta( $user_id, $meta_key );
7356
			}
7357
		}
7358
	}
7359
7360
	/**
7361
	 * Checks if a Jetpack site is both active and not in development.
7362
	 *
7363
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7364
	 *
7365
	 * @return bool True if Jetpack is active and not in development.
7366
	 */
7367
	public static function is_active_and_not_development_mode() {
7368
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7369
			return false;
7370
		}
7371
		return true;
7372
	}
7373
7374
	/**
7375
	 * Returns the list of products that we have available for purchase.
7376
	 */
7377
	public static function get_products_for_purchase() {
7378
		$products = array();
7379
		if ( ! is_multisite() ) {
7380
			$products[] = array(
7381
				'key'               => 'backup',
7382
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7383
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7384
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7385
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7386
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7387
				'options'           => array(
7388
					array(
7389
						'type'        => 'daily',
7390
						'slug'        => 'jetpack-backup-daily',
7391
						'key'         => 'jetpack_backup_daily',
7392
						'name'        => __( 'Daily Backups', 'jetpack' ),
7393
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7394
					),
7395
					array(
7396
						'type'        => 'realtime',
7397
						'slug'        => 'jetpack-backup-realtime',
7398
						'key'         => 'jetpack_backup_realtime',
7399
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7400
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7401
					),
7402
				),
7403
				'default_option'    => 'realtime',
7404
				'show_promotion'    => true,
7405
				'discount_percent'  => 70,
7406
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7407
			);
7408
7409
			$products[] = array(
7410
				'key'               => 'scan',
7411
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7412
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7413
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7414
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7415
				'show_promotion'    => true,
7416
				'discount_percent'  => 30,
7417
				'options'           => array(
7418
					array(
7419
						'type' => 'scan',
7420
						'slug' => 'jetpack-scan',
7421
						'key'  => 'jetpack_scan',
7422
						'name' => __( 'Daily Scan', 'jetpack' ),
7423
					),
7424
				),
7425
				'default_option'    => 'scan',
7426
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7427
			);
7428
		}
7429
7430
		$products[] = array(
7431
			'key'               => 'search',
7432
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7433
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7434
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7435
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7436
			'label_popup'       => __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.', 'jetpack' ),
7437
			'options'           => array(
7438
				array(
7439
					'type' => 'search',
7440
					'slug' => 'jetpack-search',
7441
					'key'  => 'jetpack_search',
7442
					'name' => __( 'Search', 'jetpack' ),
7443
				),
7444
			),
7445
			'tears'             => array(),
7446
			'default_option'    => 'search',
7447
			'show_promotion'    => false,
7448
			'included_in_plans' => array( 'search-plan' ),
7449
		);
7450
7451
		return $products;
7452
	}
7453
}
7454