Completed
Push — explore/hook ( e999bb )
by
unknown
17:23 queued 10:37
created

class.jetpack.php (75 issues)

Upgrade to new PHP Analysis Engine

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

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
8
use Automattic\Jetpack\Constants;
9
use Automattic\Jetpack\Partner;
10
use Automattic\Jetpack\Roles;
11
use Automattic\Jetpack\Status;
12
use Automattic\Jetpack\Sync\Functions;
13
use Automattic\Jetpack\Sync\Health;
14
use Automattic\Jetpack\Sync\Sender;
15
use Automattic\Jetpack\Sync\Users;
16
use Automattic\Jetpack\Terms_Of_Service;
17
use Automattic\Jetpack\Tracking;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
use Automattic\Jetpack\Redirect;
20
21
/*
22
Options:
23
jetpack_options (array)
24
	An array of options.
25
	@see Jetpack_Options::get_option_names()
26
27
jetpack_register (string)
28
	Temporary verification secrets.
29
30
jetpack_activated (int)
31
	1: the plugin was activated normally
32
	2: the plugin was activated on this site because of a network-wide activation
33
	3: the plugin was auto-installed
34
	4: the plugin was manually disconnected (but is still installed)
35
36
jetpack_active_modules (array)
37
	Array of active module slugs.
38
39
jetpack_do_activate (bool)
40
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
41
*/
42
43
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
44
45
class Jetpack {
46
	public $xmlrpc_server = null;
47
48
	private $rest_authentication_status = null;
49
50
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
51
52
	/**
53
	 * @var array The handles of styles that are concatenated into jetpack.css.
54
	 *
55
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
56
	 */
57
	public $concatenated_style_handles = array(
58
		'jetpack-carousel',
59
		'grunion.css',
60
		'the-neverending-homepage',
61
		'jetpack_likes',
62
		'jetpack_related-posts',
63
		'sharedaddy',
64
		'jetpack-slideshow',
65
		'presentations',
66
		'quiz',
67
		'jetpack-subscriptions',
68
		'jetpack-responsive-videos-style',
69
		'jetpack-social-menu',
70
		'tiled-gallery',
71
		'jetpack_display_posts_widget',
72
		'gravatar-profile-widget',
73
		'goodreads-widget',
74
		'jetpack_social_media_icons_widget',
75
		'jetpack-top-posts-widget',
76
		'jetpack_image_widget',
77
		'jetpack-my-community-widget',
78
		'jetpack-authors-widget',
79
		'wordads',
80
		'eu-cookie-law-style',
81
		'flickr-widget-style',
82
		'jetpack-search-widget',
83
		'jetpack-simple-payments-widget-style',
84
		'jetpack-widget-social-icons-styles',
85
	);
86
87
	/**
88
	 * The handles of scripts that can be loaded asynchronously.
89
	 *
90
	 * @var array
91
	 */
92
	public $async_script_handles = array(
93
		'woocommerce-analytics',
94
	);
95
96
	/**
97
	 * Contains all assets that have had their URL rewritten to minified versions.
98
	 *
99
	 * @var array
100
	 */
101
	static $min_assets = array();
102
103
	public $plugins_to_deactivate = array(
104
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
105
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
106
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
107
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
108
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
109
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
110
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
111
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
112
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
113
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
114
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
115
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
116
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
117
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
118
	);
119
120
	/**
121
	 * Map of roles we care about, and their corresponding minimum capabilities.
122
	 *
123
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
124
	 *
125
	 * @access public
126
	 * @static
127
	 *
128
	 * @var array
129
	 */
130
	public static $capability_translations = array(
131
		'administrator' => 'manage_options',
132
		'editor'        => 'edit_others_posts',
133
		'author'        => 'publish_posts',
134
		'contributor'   => 'edit_posts',
135
		'subscriber'    => 'read',
136
	);
137
138
	/**
139
	 * Map of modules that have conflicts with plugins and should not be auto-activated
140
	 * if the plugins are active.  Used by filter_default_modules
141
	 *
142
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
143
	 * change `module-slug` and add this to your plugin:
144
	 *
145
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
146
	 * function my_jetpack_get_default_modules( $modules ) {
147
	 *     return array_diff( $modules, array( 'module-slug' ) );
148
	 * }
149
	 *
150
	 * @var array
151
	 */
152
	private $conflicting_plugins = array(
153
		'comments'           => array(
154
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
155
			'Disqus'                         => 'disqus-comment-system/disqus.php',
156
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
157
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
158
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
159
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
160
		),
161
		'comment-likes'      => array(
162
			'Epoch' => 'epoch/plugincore.php',
163
		),
164
		'contact-form'       => array(
165
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
166
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
167
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
168
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
169
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
170
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
171
		),
172
		'latex'              => array(
173
			'LaTeX for WordPress'     => 'latex/latex.php',
174
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
175
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
176
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
177
			'Enable Latex'            => 'enable-latex/enable-latex.php',
178
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
179
		),
180
		'protect'            => array(
181
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
182
			'Captcha'                           => 'captcha/captcha.php',
183
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
184
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
185
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
186
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
187
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
188
			'Security-protection'               => 'security-protection/security-protection.php',
189
			'Login Security'                    => 'login-security/login-security.php',
190
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
191
			'Wordfence Security'                => 'wordfence/wordfence.php',
192
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
193
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
194
		),
195
		'random-redirect'    => array(
196
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
197
		),
198
		'related-posts'      => array(
199
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
200
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
201
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
202
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
203
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
204
			'outbrain'                    => 'outbrain/outbrain.php',
205
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
206
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
207
		),
208
		'sharedaddy'         => array(
209
			'AddThis'     => 'addthis/addthis_social_widget.php',
210
			'Add To Any'  => 'add-to-any/add-to-any.php',
211
			'ShareThis'   => 'share-this/sharethis.php',
212
			'Shareaholic' => 'shareaholic/shareaholic.php',
213
		),
214
		'seo-tools'          => array(
215
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
216
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
217
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
218
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
219
			'The SEO Framework'              => 'autodescription/autodescription.php',
220
		),
221
		'verification-tools' => array(
222
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
223
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
224
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
225
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
226
			'The SEO Framework'              => 'autodescription/autodescription.php',
227
		),
228
		'widget-visibility'  => array(
229
			'Widget Logic'    => 'widget-logic/widget_logic.php',
230
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
231
		),
232
		'sitemaps'           => array(
233
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
234
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
235
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
236
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
237
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
238
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
239
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
240
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
241
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
242
			'The SEO Framework'                    => 'autodescription/autodescription.php',
243
			'Sitemap'                              => 'sitemap/sitemap.php',
244
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
245
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
246
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
247
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
248
		),
249
		'lazy-images'        => array(
250
			'Lazy Load'              => 'lazy-load/lazy-load.php',
251
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
252
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
253
		),
254
	);
255
256
	/**
257
	 * Plugins for which we turn off our Facebook OG Tags implementation.
258
	 *
259
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
260
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
261
	 *
262
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
263
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
264
	 */
265
	private $open_graph_conflicting_plugins = array(
266
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
267
		// 2 Click Social Media Buttons
268
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
269
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
270
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
271
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
272
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
273
		// Open Graph Meta Tags by Heateor
274
		'facebook/facebook.php',                                 // Facebook (official plugin)
275
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
276
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
277
		// Facebook Featured Image & OG Meta Tags
278
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
279
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
280
		// Facebook Open Graph Meta Tags for WordPress
281
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
282
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
283
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
284
		// Fedmich's Facebook Open Graph Meta
285
		'network-publisher/networkpub.php',                      // Network Publisher
286
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
287
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
288
		// NextScripts SNAP
289
		'og-tags/og-tags.php',                                   // OG Tags
290
		'opengraph/opengraph.php',                               // Open Graph
291
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
292
		// Open Graph Protocol Framework
293
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
294
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
295
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
296
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
297
		'sharepress/sharepress.php',                             // SharePress
298
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
299
		'social-discussions/social-discussions.php',             // Social Discussions
300
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
301
		'socialize/socialize.php',                               // Socialize
302
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
303
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
304
		// Tweet, Like, Google +1 and Share
305
		'wordbooker/wordbooker.php',                             // Wordbooker
306
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
307
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
308
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
309
		// WP Facebook Like Send & Open Graph Meta
310
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
311
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
312
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
313
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
314
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
315
	);
316
317
	/**
318
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
319
	 */
320
	private $twitter_cards_conflicting_plugins = array(
321
		// 'twitter/twitter.php',                       // The official one handles this on its own.
322
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
323
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
324
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
325
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
326
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
327
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
328
		'twitter-cards/twitter-cards.php',           // Twitter Cards
329
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
330
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
331
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
332
	);
333
334
	/**
335
	 * Message to display in admin_notice
336
	 *
337
	 * @var string
338
	 */
339
	public $message = '';
340
341
	/**
342
	 * Error to display in admin_notice
343
	 *
344
	 * @var string
345
	 */
346
	public $error = '';
347
348
	/**
349
	 * Modules that need more privacy description.
350
	 *
351
	 * @var string
352
	 */
353
	public $privacy_checks = '';
354
355
	/**
356
	 * Stats to record once the page loads
357
	 *
358
	 * @var array
359
	 */
360
	public $stats = array();
361
362
	/**
363
	 * Jetpack_Sync object
364
	 */
365
	public $sync;
366
367
	/**
368
	 * Verified data for JSON authorization request
369
	 */
370
	public $json_api_authorization_request = array();
371
372
	/**
373
	 * @var Automattic\Jetpack\Connection\Manager
374
	 */
375
	protected $connection_manager;
376
377
	/**
378
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
379
	 */
380
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
381
382
	/**
383
	 * Constant for login redirect key.
384
	 *
385
	 * @var string
386
	 * @since 8.4.0
387
	 */
388
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
389
390
	/**
391
	 * Holds the singleton instance of this class
392
	 *
393
	 * @since 2.3.3
394
	 * @var Jetpack
395
	 */
396
	static $instance = false;
397
398
	/**
399
	 * Singleton
400
	 *
401
	 * @static
402
	 */
403
	public static function init() {
404
		if ( ! self::$instance ) {
405
			self::$instance = new Jetpack();
406
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
407
		}
408
409
		return self::$instance;
410
	}
411
412
	/**
413
	 * Must never be called statically
414
	 */
415
	function plugin_upgrade() {
416
		if ( self::is_active() ) {
417
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
418
			if ( JETPACK__VERSION != $version ) {
419
				// Prevent multiple upgrades at once - only a single process should trigger
420
				// an upgrade to avoid stampedes
421
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
422
					return;
423
				}
424
425
				// Set a short lock to prevent multiple instances of the upgrade
426
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
427
428
				// check which active modules actually exist and remove others from active_modules list
429
				$unfiltered_modules = self::get_active_modules();
430
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
431
				if ( array_diff( $unfiltered_modules, $modules ) ) {
432
					self::update_active_modules( $modules );
433
				}
434
435
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
436
437
				// Upgrade to 4.3.0
438
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
439
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
440
				}
441
442
				// Make sure Markdown for posts gets turned back on
443
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
444
					update_option( 'wpcom_publish_posts_with_markdown', true );
445
				}
446
447
				/*
448
				 * Minileven deprecation. 8.3.0.
449
				 * Only delete options if not using
450
				 * the replacement standalone Minileven plugin.
451
				 */
452
				if (
453
					! self::is_plugin_active( 'minileven-master/minileven.php' )
454
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
455
				) {
456
					if ( get_option( 'wp_mobile_custom_css' ) ) {
457
						delete_option( 'wp_mobile_custom_css' );
458
					}
459
					if ( get_option( 'wp_mobile_excerpt' ) ) {
460
						delete_option( 'wp_mobile_excerpt' );
461
					}
462
					if ( get_option( 'wp_mobile_featured_images' ) ) {
463
						delete_option( 'wp_mobile_featured_images' );
464
					}
465
					if ( get_option( 'wp_mobile_app_promos' ) ) {
466
						delete_option( 'wp_mobile_app_promos' );
467
					}
468
				}
469
470
				// Upgrade to 8.4.0.
471
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
472
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
473
				}
474
475
				if ( did_action( 'wp_loaded' ) ) {
476
					self::upgrade_on_load();
477
				} else {
478
					add_action(
479
						'wp_loaded',
480
						array( __CLASS__, 'upgrade_on_load' )
481
					);
482
				}
483
			}
484
		}
485
	}
486
487
	/**
488
	 * Runs upgrade routines that need to have modules loaded.
489
	 */
490
	static function upgrade_on_load() {
491
492
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
493
		// This can happen in case Jetpack has been just upgraded and is
494
		// being initialized late during the page load. In this case we wait
495
		// until the next proper admin page load with Jetpack active.
496
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
497
			delete_transient( self::$plugin_upgrade_lock_key );
498
499
			return;
500
		}
501
502
		self::maybe_set_version_option();
503
504
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
505
			Jetpack_Widget_Conditions::migrate_post_type_rules();
506
		}
507
508
		if (
509
			class_exists( 'Jetpack_Sitemap_Manager' )
510
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
511
		) {
512
			do_action( 'jetpack_sitemaps_purge_data' );
513
		}
514
515
		// Delete old stats cache
516
		delete_option( 'jetpack_restapi_stats_cache' );
517
518
		delete_transient( self::$plugin_upgrade_lock_key );
519
	}
520
521
	/**
522
	 * Saves all the currently active modules to options.
523
	 * Also fires Action hooks for each newly activated and deactivated module.
524
	 *
525
	 * @param $modules Array Array of active modules to be saved in options.
526
	 *
527
	 * @return $success bool true for success, false for failure.
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...
528
	 */
529
	static function update_active_modules( $modules ) {
530
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
531
		$active_modules       = self::get_active_modules();
532
		$new_active_modules   = array_diff( $modules, $current_modules );
533
		$new_inactive_modules = array_diff( $active_modules, $modules );
534
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
535
		$reindexed_modules    = array_values( $new_current_modules );
536
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
537
538
		foreach ( $new_active_modules as $module ) {
539
			/**
540
			 * Fires when a specific module is activated.
541
			 *
542
			 * @since 1.9.0
543
			 *
544
			 * @param string $module Module slug.
545
			 * @param boolean $success whether the module was activated. @since 4.2
546
			 */
547
			do_action( 'jetpack_activate_module', $module, $success );
548
			/**
549
			 * Fires when a module is activated.
550
			 * The dynamic part of the filter, $module, is the module slug.
551
			 *
552
			 * @since 1.9.0
553
			 *
554
			 * @param string $module Module slug.
555
			 */
556
			do_action( "jetpack_activate_module_$module", $module );
557
		}
558
559
		foreach ( $new_inactive_modules as $module ) {
560
			/**
561
			 * Fired after a module has been deactivated.
562
			 *
563
			 * @since 4.2.0
564
			 *
565
			 * @param string $module Module slug.
566
			 * @param boolean $success whether the module was deactivated.
567
			 */
568
			do_action( 'jetpack_deactivate_module', $module, $success );
569
			/**
570
			 * Fires when a module is deactivated.
571
			 * The dynamic part of the filter, $module, is the module slug.
572
			 *
573
			 * @since 1.9.0
574
			 *
575
			 * @param string $module Module slug.
576
			 */
577
			do_action( "jetpack_deactivate_module_$module", $module );
578
		}
579
580
		return $success;
581
	}
582
583
	static function delete_active_modules() {
584
		self::update_active_modules( array() );
585
	}
586
587
	/**
588
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
589
	 * available.
590
	 */
591
	public function add_configure_hook() {
592
		global $wp_filter;
593
594
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
595
		if ( false !== $current_priority ) {
596
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
597
		}
598
599
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
600
		sort( $taken_priorities );
601
602
		$first_priority = array_shift( $taken_priorities );
603
604
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
605
			$new_priority = - PHP_INT_MAX;
606
		} else {
607
			$new_priority = $first_priority - 1;
608
		}
609
610
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
611
	}
612
613
	/**
614
	 * Constructor.  Initializes WordPress hooks
615
	 */
616
	private function __construct() {
617
		/*
618
		 * Check for and alert any deprecated hooks
619
		 */
620
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
621
622
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
623
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
624
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
625
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
626
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
627
628
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
629
630
		add_filter(
631
			'jetpack_signature_check_token',
632
			array( __CLASS__, 'verify_onboarding_token' ),
633
			10,
634
			3
635
		);
636
637
		/**
638
		 * Prepare Gutenberg Editor functionality
639
		 */
640
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
641
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
642
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
643
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
644
645
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
646
647
		// Unlink user before deleting the user from WP.com.
648
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
649
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
650
651
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
652
653
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
654
		add_action( 'login_init', array( $this, 'login_init' ) );
655
656
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
657
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
658
659
		add_action( 'admin_init', array( $this, 'admin_init' ) );
660
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
661
662
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
663
664
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
665
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
666
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
667
668
		// returns HTTPS support status
669
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
670
671
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
672
673
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
674
675
		/**
676
		 * These actions run checks to load additional files.
677
		 * They check for external files or plugins, so they need to run as late as possible.
678
		 */
679
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
680
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
681
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
682
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
683
684
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
685
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
686
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
687
688
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
689
690
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
691
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
692
693
		// A filter to control all just in time messages
694
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
695
696
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
697
698
		/*
699
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
700
		 * We should make sure to only do this for front end links.
701
		 */
702
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
703
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
704
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
705
706
			/*
707
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
708
			 * so they point moderation links on emails to Calypso.
709
			 */
710
			jetpack_require_lib( 'functions.wp-notify' );
711
		}
712
713
		// Hide edit post link if mobile app.
714
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
715
			add_filter( 'get_edit_post_link', '__return_empty_string' );
716
		}
717
718
		// Update the Jetpack plan from API on heartbeats.
719
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
720
721
		/**
722
		 * This is the hack to concatenate all css files into one.
723
		 * For description and reasoning see the implode_frontend_css method.
724
		 *
725
		 * Super late priority so we catch all the registered styles.
726
		 */
727
		if ( ! is_admin() ) {
728
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
729
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
730
		}
731
732
		/**
733
		 * These are sync actions that we need to keep track of for jitms
734
		 */
735
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
736
737
		// Actually push the stats on shutdown.
738
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
739
			add_action( 'shutdown', array( $this, 'push_stats' ) );
740
		}
741
742
		/*
743
		 * Load some scripts asynchronously.
744
		 */
745
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
746
747
		// Actions for Manager::authorize().
748
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
749
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
750
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
751
752
		// Filters for the Manager::get_token() urls and request body.
753
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
754
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
755
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
756
	}
757
758
	/**
759
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
760
	 * Config object.
761
	 */
762
	public function configure() {
763
		$config = new Config();
764
765
		foreach (
766
			array(
767
				'sync',
768
				'tracking',
769
				'tos',
770
			)
771
			as $feature
772
		) {
773
			$config->ensure( $feature );
774
		}
775
776
		$config->ensure(
777
			'connection',
778
			array(
779
				'slug' => 'jetpack',
780
				'name' => 'Jetpack',
781
			)
782
		);
783
784
		if ( is_admin() ) {
785
			$config->ensure( 'jitm' );
786
		}
787
788
		if ( ! $this->connection_manager ) {
789
			$this->connection_manager = new Connection_Manager( 'jetpack' );
790
		}
791
792
		/*
793
		 * Load things that should only be in Network Admin.
794
		 *
795
		 * For now blow away everything else until a more full
796
		 * understanding of what is needed at the network level is
797
		 * available
798
		 */
799
		if ( is_multisite() ) {
800
			$network = Jetpack_Network::init();
801
			$network->set_connection( $this->connection_manager );
802
		}
803
804
		if ( $this->connection_manager->is_active() ) {
805
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
806
807
			Jetpack_Heartbeat::init();
808
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
809
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
810
				Jetpack_Search_Performance_Logger::init();
811
			}
812
		}
813
814
		// Initialize remote file upload request handlers.
815
		$this->add_remote_request_handlers();
816
817
		/*
818
		 * Enable enhanced handling of previewing sites in Calypso
819
		 */
820
		if ( self::is_active() ) {
821
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
822
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
823
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
824
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
825
		}
826
	}
827
828
	/**
829
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
830
	 * initialization code.
831
	 *
832
	 * @action plugins_loaded
833
	 */
834
	public function late_initialization() {
835
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
836
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
837
838
		Partner::init();
839
840
		/**
841
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
842
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
843
		 *
844
		 * @since 8.1.0
845
		 *
846
		 * @param Jetpack $jetpack the main plugin class object.
847
		 */
848
		do_action( 'jetpack_loaded', $this );
849
850
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
851
	}
852
853
	/**
854
	 * Sets up the XMLRPC request handlers.
855
	 *
856
	 * @deprecated since 7.7.0
857
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
858
	 *
859
	 * @param array                 $request_params Incoming request parameters.
860
	 * @param Boolean               $is_active      Whether the connection is currently active.
861
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
862
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
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...
863
	 */
864 View Code Duplication
	public function setup_xmlrpc_handlers(
865
		$request_params,
866
		$is_active,
867
		$is_signed,
868
		Jetpack_XMLRPC_Server $xmlrpc_server = null
869
	) {
870
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
871
872
		if ( ! $this->connection_manager ) {
873
			$this->connection_manager = new Connection_Manager();
874
		}
875
876
		return $this->connection_manager->setup_xmlrpc_handlers(
877
			$request_params,
878
			$is_active,
879
			$is_signed,
880
			$xmlrpc_server
881
		);
882
	}
883
884
	/**
885
	 * Initialize REST API registration connector.
886
	 *
887
	 * @deprecated since 7.7.0
888
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
889
	 */
890 View Code Duplication
	public function initialize_rest_api_registration_connector() {
891
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
892
893
		if ( ! $this->connection_manager ) {
894
			$this->connection_manager = new Connection_Manager();
895
		}
896
897
		$this->connection_manager->initialize_rest_api_registration_connector();
898
	}
899
900
	/**
901
	 * This is ported over from the manage module, which has been deprecated and baked in here.
902
	 *
903
	 * @param $domains
904
	 */
905
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
906
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
907
	}
908
909
	/**
910
	 * Return $domains, with 'wordpress.com' appended.
911
	 * This is ported over from the manage module, which has been deprecated and baked in here.
912
	 *
913
	 * @param $domains
914
	 * @return array
915
	 */
916
	function allow_wpcom_domain( $domains ) {
917
		if ( empty( $domains ) ) {
918
			$domains = array();
919
		}
920
		$domains[] = 'wordpress.com';
921
		return array_unique( $domains );
922
	}
923
924
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
925
		$post = get_post( $post_id );
926
927
		if ( empty( $post ) ) {
928
			return $default_url;
929
		}
930
931
		$post_type = $post->post_type;
932
933
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
934
		// https://en.support.wordpress.com/custom-post-types/
935
		$allowed_post_types = array(
936
			'post',
937
			'page',
938
			'jetpack-portfolio',
939
			'jetpack-testimonial',
940
		);
941
942
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
943
			return $default_url;
944
		}
945
946
		return esc_url(
947
			Redirect::get_url(
948
				'calypso-edit-' . $post_type,
949
				array(
950
					'path' => $post_id,
951
				)
952
			)
953
		);
954
	}
955
956
	function point_edit_comment_links_to_calypso( $url ) {
957
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
958
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
The 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...
959
960
		return esc_url(
961
			Redirect::get_url(
962
				'calypso-edit-comment',
963
				array(
964
					'path' => $query_args['amp;c'],
965
				)
966
			)
967
		);
968
969
	}
970
971
	function jetpack_track_last_sync_callback( $params ) {
972
		/**
973
		 * Filter to turn off jitm caching
974
		 *
975
		 * @since 5.4.0
976
		 *
977
		 * @param bool false Whether to cache just in time messages
978
		 */
979
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
980
			return $params;
981
		}
982
983
		if ( is_array( $params ) && isset( $params[0] ) ) {
984
			$option = $params[0];
985
			if ( 'active_plugins' === $option ) {
986
				// use the cache if we can, but not terribly important if it gets evicted
987
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
988
			}
989
		}
990
991
		return $params;
992
	}
993
994
	function jetpack_connection_banner_callback() {
995
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
996
997
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
998
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
999
			wp_send_json_success();
1000
		}
1001
1002
		wp_die();
1003
	}
1004
1005
	/**
1006
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1007
	 * Only used in our alternate XML-RPC endpoint, where we want to
1008
	 * ensure that Core and other plugins' methods are not exposed.
1009
	 *
1010
	 * @deprecated since 7.7.0
1011
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1012
	 *
1013
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1014
	 * @return array Filtered $methods
1015
	 */
1016 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1017
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1018
1019
		if ( ! $this->connection_manager ) {
1020
			$this->connection_manager = new Connection_Manager();
1021
		}
1022
1023
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1024
	}
1025
1026
	/**
1027
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1028
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1029
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1030
	 * which is accessible via a different URI. Most of the below is copied directly
1031
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1032
	 *
1033
	 * @deprecated since 7.7.0
1034
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1035
	 */
1036 View Code Duplication
	public function alternate_xmlrpc() {
1037
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1038
1039
		if ( ! $this->connection_manager ) {
1040
			$this->connection_manager = new Connection_Manager();
1041
		}
1042
1043
		$this->connection_manager->alternate_xmlrpc();
1044
	}
1045
1046
	/**
1047
	 * The callback for the JITM ajax requests.
1048
	 *
1049
	 * @deprecated since 7.9.0
1050
	 */
1051
	function jetpack_jitm_ajax_callback() {
1052
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1053
	}
1054
1055
	/**
1056
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1057
	 */
1058
	function push_stats() {
1059
		if ( ! empty( $this->stats ) ) {
1060
			$this->do_stats( 'server_side' );
1061
		}
1062
	}
1063
1064
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1065
		$is_development_mode = ( new Status() )->is_development_mode();
1066
		switch ( $cap ) {
1067
			case 'jetpack_connect':
1068
			case 'jetpack_reconnect':
1069
				if ( $is_development_mode ) {
1070
					$caps = array( 'do_not_allow' );
1071
					break;
1072
				}
1073
				/**
1074
				 * Pass through. If it's not development mode, these should match disconnect.
1075
				 * Let users disconnect if it's development mode, just in case things glitch.
1076
				 */
1077
			case 'jetpack_disconnect':
1078
				/**
1079
				 * In multisite, can individual site admins manage their own connection?
1080
				 *
1081
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1082
				 */
1083
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1084
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1085
						/**
1086
						 * We need to update the option name -- it's terribly unclear which
1087
						 * direction the override goes.
1088
						 *
1089
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1090
						 */
1091
						$caps = array( 'do_not_allow' );
1092
						break;
1093
					}
1094
				}
1095
1096
				$caps = array( 'manage_options' );
1097
				break;
1098
			case 'jetpack_manage_modules':
1099
			case 'jetpack_activate_modules':
1100
			case 'jetpack_deactivate_modules':
1101
				$caps = array( 'manage_options' );
1102
				break;
1103
			case 'jetpack_configure_modules':
1104
				$caps = array( 'manage_options' );
1105
				break;
1106
			case 'jetpack_manage_autoupdates':
1107
				$caps = array(
1108
					'manage_options',
1109
					'update_plugins',
1110
				);
1111
				break;
1112
			case 'jetpack_network_admin_page':
1113
			case 'jetpack_network_settings_page':
1114
				$caps = array( 'manage_network_plugins' );
1115
				break;
1116
			case 'jetpack_network_sites_page':
1117
				$caps = array( 'manage_sites' );
1118
				break;
1119
			case 'jetpack_admin_page':
1120
				if ( $is_development_mode ) {
1121
					$caps = array( 'manage_options' );
1122
					break;
1123
				} else {
1124
					$caps = array( 'read' );
1125
				}
1126
				break;
1127
			case 'jetpack_connect_user':
1128
				if ( $is_development_mode ) {
1129
					$caps = array( 'do_not_allow' );
1130
					break;
1131
				}
1132
				$caps = array( 'read' );
1133
				break;
1134
		}
1135
		return $caps;
1136
	}
1137
1138
	/**
1139
	 * Require a Jetpack authentication.
1140
	 *
1141
	 * @deprecated since 7.7.0
1142
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1143
	 */
1144 View Code Duplication
	public function require_jetpack_authentication() {
1145
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1146
1147
		if ( ! $this->connection_manager ) {
1148
			$this->connection_manager = new Connection_Manager();
1149
		}
1150
1151
		$this->connection_manager->require_jetpack_authentication();
1152
	}
1153
1154
	/**
1155
	 * Load language files
1156
	 *
1157
	 * @action plugins_loaded
1158
	 */
1159
	public static function plugin_textdomain() {
1160
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1161
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1162
	}
1163
1164
	/**
1165
	 * Register assets for use in various modules and the Jetpack admin page.
1166
	 *
1167
	 * @uses wp_script_is, wp_register_script, plugins_url
1168
	 * @action wp_loaded
1169
	 * @return null
1170
	 */
1171
	public function register_assets() {
1172
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1173
			wp_register_script(
1174
				'spin',
1175
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1176
				false,
1177
				'1.3'
1178
			);
1179
		}
1180
1181 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1182
			wp_register_script(
1183
				'jquery.spin',
1184
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1185
				array( 'jquery', 'spin' ),
1186
				'1.3'
1187
			);
1188
		}
1189
1190 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1191
			wp_register_script(
1192
				'jetpack-gallery-settings',
1193
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1194
				array( 'media-views' ),
1195
				'20121225'
1196
			);
1197
		}
1198
1199 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1200
			wp_register_script(
1201
				'jetpack-twitter-timeline',
1202
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1203
				array( 'jquery' ),
1204
				'4.0.0',
1205
				true
1206
			);
1207
		}
1208
1209
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1210
			wp_register_script(
1211
				'jetpack-facebook-embed',
1212
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1213
				array(),
1214
				null,
1215
				true
1216
			);
1217
1218
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1219
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1220
			if ( ! is_numeric( $fb_app_id ) ) {
1221
				$fb_app_id = '';
1222
			}
1223
			wp_localize_script(
1224
				'jetpack-facebook-embed',
1225
				'jpfbembed',
1226
				array(
1227
					'appid'  => $fb_app_id,
1228
					'locale' => $this->get_locale(),
1229
				)
1230
			);
1231
		}
1232
1233
		/**
1234
		 * As jetpack_register_genericons is by default fired off a hook,
1235
		 * the hook may have already fired by this point.
1236
		 * So, let's just trigger it manually.
1237
		 */
1238
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1239
		jetpack_register_genericons();
1240
1241
		/**
1242
		 * Register the social logos
1243
		 */
1244
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1245
		jetpack_register_social_logos();
1246
1247 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1248
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1249
		}
1250
	}
1251
1252
	/**
1253
	 * Guess locale from language code.
1254
	 *
1255
	 * @param string $lang Language code.
1256
	 * @return string|bool
1257
	 */
1258 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1259
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1260
			return 'en_US';
1261
		}
1262
1263
		if ( ! class_exists( 'GP_Locales' ) ) {
1264
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1265
				return false;
1266
			}
1267
1268
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1269
		}
1270
1271
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1272
			// WP.com: get_locale() returns 'it'
1273
			$locale = GP_Locales::by_slug( $lang );
1274
		} else {
1275
			// Jetpack: get_locale() returns 'it_IT';
1276
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1277
		}
1278
1279
		if ( ! $locale ) {
1280
			return false;
1281
		}
1282
1283
		if ( empty( $locale->facebook_locale ) ) {
1284
			if ( empty( $locale->wp_locale ) ) {
1285
				return false;
1286
			} else {
1287
				// Facebook SDK is smart enough to fall back to en_US if a
1288
				// locale isn't supported. Since supported Facebook locales
1289
				// can fall out of sync, we'll attempt to use the known
1290
				// wp_locale value and rely on said fallback.
1291
				return $locale->wp_locale;
1292
			}
1293
		}
1294
1295
		return $locale->facebook_locale;
1296
	}
1297
1298
	/**
1299
	 * Get the locale.
1300
	 *
1301
	 * @return string|bool
1302
	 */
1303
	function get_locale() {
1304
		$locale = $this->guess_locale_from_lang( get_locale() );
1305
1306
		if ( ! $locale ) {
1307
			$locale = 'en_US';
1308
		}
1309
1310
		return $locale;
1311
	}
1312
1313
	/**
1314
	 * Return the network_site_url so that .com knows what network this site is a part of.
1315
	 *
1316
	 * @param  bool $option
1317
	 * @return string
1318
	 */
1319
	public function jetpack_main_network_site_option( $option ) {
1320
		return network_site_url();
1321
	}
1322
	/**
1323
	 * Network Name.
1324
	 */
1325
	static function network_name( $option = null ) {
1326
		global $current_site;
1327
		return $current_site->site_name;
1328
	}
1329
	/**
1330
	 * Does the network allow new user and site registrations.
1331
	 *
1332
	 * @return string
1333
	 */
1334
	static function network_allow_new_registrations( $option = null ) {
1335
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1336
	}
1337
	/**
1338
	 * Does the network allow admins to add new users.
1339
	 *
1340
	 * @return boolian
1341
	 */
1342
	static function network_add_new_users( $option = null ) {
1343
		return (bool) get_site_option( 'add_new_users' );
1344
	}
1345
	/**
1346
	 * File upload psace left per site in MB.
1347
	 *  -1 means NO LIMIT.
1348
	 *
1349
	 * @return number
1350
	 */
1351
	static function network_site_upload_space( $option = null ) {
1352
		// value in MB
1353
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1354
	}
1355
1356
	/**
1357
	 * Network allowed file types.
1358
	 *
1359
	 * @return string
1360
	 */
1361
	static function network_upload_file_types( $option = null ) {
1362
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1363
	}
1364
1365
	/**
1366
	 * Maximum file upload size set by the network.
1367
	 *
1368
	 * @return number
1369
	 */
1370
	static function network_max_upload_file_size( $option = null ) {
1371
		// value in KB
1372
		return get_site_option( 'fileupload_maxk', 300 );
1373
	}
1374
1375
	/**
1376
	 * Lets us know if a site allows admins to manage the network.
1377
	 *
1378
	 * @return array
1379
	 */
1380
	static function network_enable_administration_menus( $option = null ) {
1381
		return get_site_option( 'menu_items' );
1382
	}
1383
1384
	/**
1385
	 * If a user has been promoted to or demoted from admin, we need to clear the
1386
	 * jetpack_other_linked_admins transient.
1387
	 *
1388
	 * @since 4.3.2
1389
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1390
	 *
1391
	 * @param int    $user_id   The user ID whose role changed.
1392
	 * @param string $role      The new role.
1393
	 * @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...
1394
	 */
1395
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1396
		if ( 'administrator' == $role
1397
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1398
			|| is_null( $old_roles )
1399
		) {
1400
			delete_transient( 'jetpack_other_linked_admins' );
1401
		}
1402
	}
1403
1404
	/**
1405
	 * Checks to see if there are any other users available to become primary
1406
	 * Users must both:
1407
	 * - Be linked to wpcom
1408
	 * - Be an admin
1409
	 *
1410
	 * @return mixed False if no other users are linked, Int if there are.
1411
	 */
1412
	static function get_other_linked_admins() {
1413
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1414
1415
		if ( false === $other_linked_users ) {
1416
			$admins = get_users( array( 'role' => 'administrator' ) );
1417
			if ( count( $admins ) > 1 ) {
1418
				$available = array();
1419
				foreach ( $admins as $admin ) {
1420
					if ( self::is_user_connected( $admin->ID ) ) {
1421
						$available[] = $admin->ID;
1422
					}
1423
				}
1424
1425
				$count_connected_admins = count( $available );
1426
				if ( count( $available ) > 1 ) {
1427
					$other_linked_users = $count_connected_admins;
1428
				} else {
1429
					$other_linked_users = 0;
1430
				}
1431
			} else {
1432
				$other_linked_users = 0;
1433
			}
1434
1435
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1436
		}
1437
1438
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1439
	}
1440
1441
	/**
1442
	 * Return whether we are dealing with a multi network setup or not.
1443
	 * The reason we are type casting this is because we want to avoid the situation where
1444
	 * the result is false since when is_main_network_option return false it cases
1445
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1446
	 * database which could be set to anything as opposed to what this function returns.
1447
	 *
1448
	 * @param  bool $option
1449
	 *
1450
	 * @return boolean
1451
	 */
1452
	public function is_main_network_option( $option ) {
1453
		// return '1' or ''
1454
		return (string) (bool) self::is_multi_network();
1455
	}
1456
1457
	/**
1458
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1459
	 *
1460
	 * @param  string $option
1461
	 * @return boolean
1462
	 */
1463
	public function is_multisite( $option ) {
1464
		return (string) (bool) is_multisite();
1465
	}
1466
1467
	/**
1468
	 * Implemented since there is no core is multi network function
1469
	 * Right now there is no way to tell if we which network is the dominant network on the system
1470
	 *
1471
	 * @since  3.3
1472
	 * @return boolean
1473
	 */
1474 View Code Duplication
	public static function is_multi_network() {
1475
		global  $wpdb;
1476
1477
		// if we don't have a multi site setup no need to do any more
1478
		if ( ! is_multisite() ) {
1479
			return false;
1480
		}
1481
1482
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1483
		if ( $num_sites > 1 ) {
1484
			return true;
1485
		} else {
1486
			return false;
1487
		}
1488
	}
1489
1490
	/**
1491
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1492
	 *
1493
	 * @return null
1494
	 */
1495
	function update_jetpack_main_network_site_option() {
1496
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1497
	}
1498
	/**
1499
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1500
	 */
1501
	function update_jetpack_network_settings() {
1502
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1503
		// Only sync this info for the main network site.
1504
	}
1505
1506
	/**
1507
	 * Get back if the current site is single user site.
1508
	 *
1509
	 * @return bool
1510
	 */
1511 View Code Duplication
	public static function is_single_user_site() {
1512
		global $wpdb;
1513
1514
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1515
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1516
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1517
		}
1518
		return 1 === (int) $some_users;
1519
	}
1520
1521
	/**
1522
	 * Returns true if the site has file write access false otherwise.
1523
	 *
1524
	 * @return string ( '1' | '0' )
1525
	 **/
1526
	public static function file_system_write_access() {
1527
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1528
			require_once ABSPATH . 'wp-admin/includes/file.php';
1529
		}
1530
1531
		require_once ABSPATH . 'wp-admin/includes/template.php';
1532
1533
		$filesystem_method = get_filesystem_method();
1534
		if ( $filesystem_method === 'direct' ) {
1535
			return 1;
1536
		}
1537
1538
		ob_start();
1539
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1540
		ob_end_clean();
1541
		if ( $filesystem_credentials_are_stored ) {
1542
			return 1;
1543
		}
1544
		return 0;
1545
	}
1546
1547
	/**
1548
	 * Finds out if a site is using a version control system.
1549
	 *
1550
	 * @return string ( '1' | '0' )
1551
	 **/
1552
	public static function is_version_controlled() {
1553
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1554
		return (string) (int) Functions::is_version_controlled();
1555
	}
1556
1557
	/**
1558
	 * Determines whether the current theme supports featured images or not.
1559
	 *
1560
	 * @return string ( '1' | '0' )
1561
	 */
1562
	public static function featured_images_enabled() {
1563
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1564
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1565
	}
1566
1567
	/**
1568
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1569
	 *
1570
	 * @deprecated 4.7 use get_avatar_url instead.
1571
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1572
	 * @param int               $size Size of the avatar image
1573
	 * @param string            $default URL to a default image to use if no avatar is available
1574
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1575
	 *
1576
	 * @return array
1577
	 */
1578
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1579
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1580
		return get_avatar_url(
1581
			$id_or_email,
1582
			array(
1583
				'size'          => $size,
1584
				'default'       => $default,
1585
				'force_default' => $force_display,
1586
			)
1587
		);
1588
	}
1589
1590
	/**
1591
	 * jetpack_updates is saved in the following schema:
1592
	 *
1593
	 * array (
1594
	 *      'plugins'                       => (int) Number of plugin updates available.
1595
	 *      'themes'                        => (int) Number of theme updates available.
1596
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1597
	 *      'translations'                  => (int) Number of translation updates available.
1598
	 *      'total'                         => (int) Total of all available updates.
1599
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1600
	 * )
1601
	 *
1602
	 * @return array
1603
	 */
1604
	public static function get_updates() {
1605
		$update_data = wp_get_update_data();
1606
1607
		// Stores the individual update counts as well as the total count.
1608
		if ( isset( $update_data['counts'] ) ) {
1609
			$updates = $update_data['counts'];
1610
		}
1611
1612
		// If we need to update WordPress core, let's find the latest version number.
1613 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1614
			$cur = get_preferred_from_update_core();
1615
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1616
				$updates['wp_update_version'] = $cur->current;
1617
			}
1618
		}
1619
		return isset( $updates ) ? $updates : array();
1620
	}
1621
1622
	public static function get_update_details() {
1623
		$update_details = array(
1624
			'update_core'    => get_site_transient( 'update_core' ),
1625
			'update_plugins' => get_site_transient( 'update_plugins' ),
1626
			'update_themes'  => get_site_transient( 'update_themes' ),
1627
		);
1628
		return $update_details;
1629
	}
1630
1631
	public static function refresh_update_data() {
1632
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1633
1634
	}
1635
1636
	public static function refresh_theme_data() {
1637
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1638
	}
1639
1640
	/**
1641
	 * Is Jetpack active?
1642
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1643
	 *
1644
	 * @return bool
1645
	 */
1646
	public static function is_active() {
1647
		return self::connection()->is_active();
1648
	}
1649
1650
	/**
1651
	 * Make an API call to WordPress.com for plan status
1652
	 *
1653
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1654
	 *
1655
	 * @return bool True if plan is updated, false if no update
1656
	 */
1657
	public static function refresh_active_plan_from_wpcom() {
1658
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1659
		return Jetpack_Plan::refresh_from_wpcom();
1660
	}
1661
1662
	/**
1663
	 * Get the plan that this Jetpack site is currently using
1664
	 *
1665
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1666
	 * @return array Active Jetpack plan details.
1667
	 */
1668
	public static function get_active_plan() {
1669
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1670
		return Jetpack_Plan::get();
1671
	}
1672
1673
	/**
1674
	 * Determine whether the active plan supports a particular feature
1675
	 *
1676
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1677
	 * @return bool True if plan supports feature, false if not.
1678
	 */
1679
	public static function active_plan_supports( $feature ) {
1680
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1681
		return Jetpack_Plan::supports( $feature );
1682
	}
1683
1684
	/**
1685
	 * Deprecated: Is Jetpack in development (offline) mode?
1686
	 *
1687
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1688
	 * and themes still use it, and we do not want to flood them with notices.
1689
	 *
1690
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1691
	 *
1692
	 * @deprecated since 8.0.
1693
	 */
1694
	public static function is_development_mode() {
1695
		return ( new Status() )->is_development_mode();
1696
	}
1697
1698
	/**
1699
	 * Whether the site is currently onboarding or not.
1700
	 * A site is considered as being onboarded if it currently has an onboarding token.
1701
	 *
1702
	 * @since 5.8
1703
	 *
1704
	 * @access public
1705
	 * @static
1706
	 *
1707
	 * @return bool True if the site is currently onboarding, false otherwise
1708
	 */
1709
	public static function is_onboarding() {
1710
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1711
	}
1712
1713
	/**
1714
	 * Determines reason for Jetpack development mode.
1715
	 */
1716
	public static function development_mode_trigger_text() {
1717
		if ( ! ( new Status() )->is_development_mode() ) {
1718
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1719
		}
1720
1721
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1722
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1723
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1724
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1725
		} else {
1726
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1727
		}
1728
1729
		return $notice;
1730
1731
	}
1732
	/**
1733
	 * Get Jetpack development mode notice text and notice class.
1734
	 *
1735
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1736
	 */
1737
	public static function show_development_mode_notice() {
1738 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1739
			$notice = sprintf(
1740
				/* translators: %s is a URL */
1741
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1742
				Redirect::get_url( 'jetpack-support-development-mode' )
1743
			);
1744
1745
			$notice .= ' ' . self::development_mode_trigger_text();
1746
1747
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1748
		}
1749
1750
		// Throw up a notice if using a development version and as for feedback.
1751
		if ( self::is_development_version() ) {
1752
			/* translators: %s is a URL */
1753
			$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' ) );
1754
1755
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1756
		}
1757
		// Throw up a notice if using staging mode
1758 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1759
			/* translators: %s is a URL */
1760
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1761
1762
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1763
		}
1764
	}
1765
1766
	/**
1767
	 * Whether Jetpack's version maps to a public release, or a development version.
1768
	 */
1769
	public static function is_development_version() {
1770
		/**
1771
		 * Allows filtering whether this is a development version of Jetpack.
1772
		 *
1773
		 * This filter is especially useful for tests.
1774
		 *
1775
		 * @since 4.3.0
1776
		 *
1777
		 * @param bool $development_version Is this a develoment version of Jetpack?
1778
		 */
1779
		return (bool) apply_filters(
1780
			'jetpack_development_version',
1781
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1782
		);
1783
	}
1784
1785
	/**
1786
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1787
	 */
1788
	public static function is_user_connected( $user_id = false ) {
1789
		return self::connection()->is_user_connected( $user_id );
1790
	}
1791
1792
	/**
1793
	 * Get the wpcom user data of the current|specified connected user.
1794
	 */
1795 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1796
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1797
		if ( ! $user_id ) {
1798
			$user_id = get_current_user_id();
1799
		}
1800
1801
		$transient_key = "jetpack_connected_user_data_$user_id";
1802
1803
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1804
			return $cached_user_data;
1805
		}
1806
1807
		$xml = new Jetpack_IXR_Client(
1808
			array(
1809
				'user_id' => $user_id,
1810
			)
1811
		);
1812
		$xml->query( 'wpcom.getUser' );
1813
		if ( ! $xml->isError() ) {
1814
			$user_data = $xml->getResponse();
1815
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1816
			return $user_data;
1817
		}
1818
1819
		return false;
1820
	}
1821
1822
	/**
1823
	 * Get the wpcom email of the current|specified connected user.
1824
	 */
1825
	public static function get_connected_user_email( $user_id = null ) {
1826
		if ( ! $user_id ) {
1827
			$user_id = get_current_user_id();
1828
		}
1829
1830
		$xml = new Jetpack_IXR_Client(
1831
			array(
1832
				'user_id' => $user_id,
1833
			)
1834
		);
1835
		$xml->query( 'wpcom.getUserEmail' );
1836
		if ( ! $xml->isError() ) {
1837
			return $xml->getResponse();
1838
		}
1839
		return false;
1840
	}
1841
1842
	/**
1843
	 * Get the wpcom email of the master user.
1844
	 */
1845
	public static function get_master_user_email() {
1846
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1847
		if ( $master_user_id ) {
1848
			return self::get_connected_user_email( $master_user_id );
1849
		}
1850
		return '';
1851
	}
1852
1853
	/**
1854
	 * Whether the current user is the connection owner.
1855
	 *
1856
	 * @deprecated since 7.7
1857
	 *
1858
	 * @return bool Whether the current user is the connection owner.
1859
	 */
1860
	public function current_user_is_connection_owner() {
1861
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1862
		return self::connection()->is_connection_owner();
1863
	}
1864
1865
	/**
1866
	 * Gets current user IP address.
1867
	 *
1868
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1869
	 *
1870
	 * @return string                  Current user IP address.
1871
	 */
1872
	public static function current_user_ip( $check_all_headers = false ) {
1873
		if ( $check_all_headers ) {
1874
			foreach ( array(
1875
				'HTTP_CF_CONNECTING_IP',
1876
				'HTTP_CLIENT_IP',
1877
				'HTTP_X_FORWARDED_FOR',
1878
				'HTTP_X_FORWARDED',
1879
				'HTTP_X_CLUSTER_CLIENT_IP',
1880
				'HTTP_FORWARDED_FOR',
1881
				'HTTP_FORWARDED',
1882
				'HTTP_VIA',
1883
			) as $key ) {
1884
				if ( ! empty( $_SERVER[ $key ] ) ) {
1885
					return $_SERVER[ $key ];
1886
				}
1887
			}
1888
		}
1889
1890
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1891
	}
1892
1893
	/**
1894
	 * Synchronize connected user role changes
1895
	 */
1896
	function user_role_change( $user_id ) {
1897
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1898
		Users::user_role_change( $user_id );
1899
	}
1900
1901
	/**
1902
	 * Loads the currently active modules.
1903
	 */
1904
	public static function load_modules() {
1905
		$is_development_mode = ( new Status() )->is_development_mode();
1906
		if (
1907
			! self::is_active()
1908
			&& ! $is_development_mode
1909
			&& ! self::is_onboarding()
1910
			&& (
1911
				! is_multisite()
1912
				|| ! get_site_option( 'jetpack_protect_active' )
1913
			)
1914
		) {
1915
			return;
1916
		}
1917
1918
		$version = Jetpack_Options::get_option( 'version' );
1919 View Code Duplication
		if ( ! $version ) {
1920
			$version = $old_version = JETPACK__VERSION . ':' . time();
1921
			/** This action is documented in class.jetpack.php */
1922
			do_action( 'updating_jetpack_version', $version, false );
1923
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1924
		}
1925
		list( $version ) = explode( ':', $version );
1926
1927
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1928
1929
		$modules_data = array();
1930
1931
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1932
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1933
			$updated_modules = array();
1934
			foreach ( $modules as $module ) {
1935
				$modules_data[ $module ] = self::get_module( $module );
1936
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1937
					continue;
1938
				}
1939
1940
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1941
					continue;
1942
				}
1943
1944
				$updated_modules[] = $module;
1945
			}
1946
1947
			$modules = array_diff( $modules, $updated_modules );
1948
		}
1949
1950
		foreach ( $modules as $index => $module ) {
1951
			// If we're in dev mode, disable modules requiring a connection
1952
			if ( $is_development_mode ) {
1953
				// Prime the pump if we need to
1954
				if ( empty( $modules_data[ $module ] ) ) {
1955
					$modules_data[ $module ] = self::get_module( $module );
1956
				}
1957
				// If the module requires a connection, but we're in local mode, don't include it.
1958
				if ( $modules_data[ $module ]['requires_connection'] ) {
1959
					continue;
1960
				}
1961
			}
1962
1963
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1964
				continue;
1965
			}
1966
1967
			if ( ! include_once self::get_module_path( $module ) ) {
1968
				unset( $modules[ $index ] );
1969
				self::update_active_modules( array_values( $modules ) );
1970
				continue;
1971
			}
1972
1973
			/**
1974
			 * Fires when a specific module is loaded.
1975
			 * The dynamic part of the hook, $module, is the module slug.
1976
			 *
1977
			 * @since 1.1.0
1978
			 */
1979
			do_action( 'jetpack_module_loaded_' . $module );
1980
		}
1981
1982
		/**
1983
		 * Fires when all the modules are loaded.
1984
		 *
1985
		 * @since 1.1.0
1986
		 */
1987
		do_action( 'jetpack_modules_loaded' );
1988
1989
		// 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.
1990
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1991
	}
1992
1993
	/**
1994
	 * Check if Jetpack's REST API compat file should be included
1995
	 *
1996
	 * @action plugins_loaded
1997
	 * @return null
1998
	 */
1999
	public function check_rest_api_compat() {
2000
		/**
2001
		 * Filters the list of REST API compat files to be included.
2002
		 *
2003
		 * @since 2.2.5
2004
		 *
2005
		 * @param array $args Array of REST API compat files to include.
2006
		 */
2007
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2008
2009
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2010
			require_once $_jetpack_rest_api_compat_include;
2011
		}
2012
	}
2013
2014
	/**
2015
	 * Gets all plugins currently active in values, regardless of whether they're
2016
	 * traditionally activated or network activated.
2017
	 *
2018
	 * @todo Store the result in core's object cache maybe?
2019
	 */
2020
	public static function get_active_plugins() {
2021
		$active_plugins = (array) get_option( 'active_plugins', array() );
2022
2023
		if ( is_multisite() ) {
2024
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2025
			// whereas active_plugins stores them in the values.
2026
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2027
			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...
2028
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2029
			}
2030
		}
2031
2032
		sort( $active_plugins );
2033
2034
		return array_unique( $active_plugins );
2035
	}
2036
2037
	/**
2038
	 * Gets and parses additional plugin data to send with the heartbeat data
2039
	 *
2040
	 * @since 3.8.1
2041
	 *
2042
	 * @return array Array of plugin data
2043
	 */
2044
	public static function get_parsed_plugin_data() {
2045
		if ( ! function_exists( 'get_plugins' ) ) {
2046
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2047
		}
2048
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2049
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2050
		$active_plugins = self::get_active_plugins();
2051
2052
		$plugins = array();
2053
		foreach ( $all_plugins as $path => $plugin_data ) {
2054
			$plugins[ $path ] = array(
2055
				'is_active' => in_array( $path, $active_plugins ),
2056
				'file'      => $path,
2057
				'name'      => $plugin_data['Name'],
2058
				'version'   => $plugin_data['Version'],
2059
				'author'    => $plugin_data['Author'],
2060
			);
2061
		}
2062
2063
		return $plugins;
2064
	}
2065
2066
	/**
2067
	 * Gets and parses theme data to send with the heartbeat data
2068
	 *
2069
	 * @since 3.8.1
2070
	 *
2071
	 * @return array Array of theme data
2072
	 */
2073
	public static function get_parsed_theme_data() {
2074
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2075
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2076
2077
		$themes = array();
2078
		foreach ( $all_themes as $slug => $theme_data ) {
2079
			$theme_headers = array();
2080
			foreach ( $header_keys as $header_key ) {
2081
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2082
			}
2083
2084
			$themes[ $slug ] = array(
2085
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2086
				'slug'            => $slug,
2087
				'theme_root'      => $theme_data->get_theme_root_uri(),
2088
				'parent'          => $theme_data->parent(),
2089
				'headers'         => $theme_headers,
2090
			);
2091
		}
2092
2093
		return $themes;
2094
	}
2095
2096
	/**
2097
	 * Checks whether a specific plugin is active.
2098
	 *
2099
	 * We don't want to store these in a static variable, in case
2100
	 * there are switch_to_blog() calls involved.
2101
	 */
2102
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2103
		return in_array( $plugin, self::get_active_plugins() );
2104
	}
2105
2106
	/**
2107
	 * Check if Jetpack's Open Graph tags should be used.
2108
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2109
	 *
2110
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2111
	 * @action plugins_loaded
2112
	 * @return null
2113
	 */
2114
	public function check_open_graph() {
2115
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2116
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2117
		}
2118
2119
		$active_plugins = self::get_active_plugins();
2120
2121
		if ( ! empty( $active_plugins ) ) {
2122
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2123
				if ( in_array( $plugin, $active_plugins ) ) {
2124
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2125
					break;
2126
				}
2127
			}
2128
		}
2129
2130
		/**
2131
		 * Allow the addition of Open Graph Meta Tags to all pages.
2132
		 *
2133
		 * @since 2.0.3
2134
		 *
2135
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2136
		 */
2137
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2138
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2139
		}
2140
	}
2141
2142
	/**
2143
	 * Check if Jetpack's Twitter tags should be used.
2144
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2145
	 *
2146
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2147
	 * @action plugins_loaded
2148
	 * @return null
2149
	 */
2150
	public function check_twitter_tags() {
2151
2152
		$active_plugins = self::get_active_plugins();
2153
2154
		if ( ! empty( $active_plugins ) ) {
2155
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2156
				if ( in_array( $plugin, $active_plugins ) ) {
2157
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2158
					break;
2159
				}
2160
			}
2161
		}
2162
2163
		/**
2164
		 * Allow Twitter Card Meta tags to be disabled.
2165
		 *
2166
		 * @since 2.6.0
2167
		 *
2168
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2169
		 */
2170
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2171
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2172
		}
2173
	}
2174
2175
	/**
2176
	 * Allows plugins to submit security reports.
2177
	 *
2178
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2179
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2180
	 * @param array  $args         See definitions above
2181
	 */
2182
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2183
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2184
	}
2185
2186
	/* Jetpack Options API */
2187
2188
	public static function get_option_names( $type = 'compact' ) {
2189
		return Jetpack_Options::get_option_names( $type );
2190
	}
2191
2192
	/**
2193
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2194
	 *
2195
	 * @param string $name    Option name
2196
	 * @param mixed  $default (optional)
2197
	 */
2198
	public static function get_option( $name, $default = false ) {
2199
		return Jetpack_Options::get_option( $name, $default );
2200
	}
2201
2202
	/**
2203
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2204
	 *
2205
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2206
	 * @param string $name  Option name
2207
	 * @param mixed  $value Option value
2208
	 */
2209
	public static function update_option( $name, $value ) {
2210
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2211
		return Jetpack_Options::update_option( $name, $value );
2212
	}
2213
2214
	/**
2215
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2216
	 *
2217
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2218
	 * @param array $array array( option name => option value, ... )
2219
	 */
2220
	public static function update_options( $array ) {
2221
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2222
		return Jetpack_Options::update_options( $array );
2223
	}
2224
2225
	/**
2226
	 * Deletes the given option.  May be passed multiple option names as an array.
2227
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2228
	 *
2229
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2230
	 * @param string|array $names
2231
	 */
2232
	public static function delete_option( $names ) {
2233
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2234
		return Jetpack_Options::delete_option( $names );
2235
	}
2236
2237
	/**
2238
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2239
	 *
2240
	 * Enters a user token into the user_tokens option
2241
	 *
2242
	 * @param int    $user_id The user id.
2243
	 * @param string $token The user token.
2244
	 * @param bool   $is_master_user Whether the user is the master user.
2245
	 * @return bool
2246
	 */
2247
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2248
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2249
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2250
	}
2251
2252
	/**
2253
	 * Returns an array of all PHP files in the specified absolute path.
2254
	 * Equivalent to glob( "$absolute_path/*.php" ).
2255
	 *
2256
	 * @param string $absolute_path The absolute path of the directory to search.
2257
	 * @return array Array of absolute paths to the PHP files.
2258
	 */
2259
	public static function glob_php( $absolute_path ) {
2260
		if ( function_exists( 'glob' ) ) {
2261
			return glob( "$absolute_path/*.php" );
2262
		}
2263
2264
		$absolute_path = untrailingslashit( $absolute_path );
2265
		$files         = array();
2266
		if ( ! $dir = @opendir( $absolute_path ) ) {
2267
			return $files;
2268
		}
2269
2270
		while ( false !== $file = readdir( $dir ) ) {
2271
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2272
				continue;
2273
			}
2274
2275
			$file = "$absolute_path/$file";
2276
2277
			if ( ! is_file( $file ) ) {
2278
				continue;
2279
			}
2280
2281
			$files[] = $file;
2282
		}
2283
2284
		closedir( $dir );
2285
2286
		return $files;
2287
	}
2288
2289
	public static function activate_new_modules( $redirect = false ) {
2290
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2291
			return;
2292
		}
2293
2294
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2295 View Code Duplication
		if ( ! $jetpack_old_version ) {
2296
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2297
			/** This action is documented in class.jetpack.php */
2298
			do_action( 'updating_jetpack_version', $version, false );
2299
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2300
		}
2301
2302
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2303
2304
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2305
			return;
2306
		}
2307
2308
		$active_modules     = self::get_active_modules();
2309
		$reactivate_modules = array();
2310
		foreach ( $active_modules as $active_module ) {
2311
			$module = self::get_module( $active_module );
2312
			if ( ! isset( $module['changed'] ) ) {
2313
				continue;
2314
			}
2315
2316
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2317
				continue;
2318
			}
2319
2320
			$reactivate_modules[] = $active_module;
2321
			self::deactivate_module( $active_module );
2322
		}
2323
2324
		$new_version = JETPACK__VERSION . ':' . time();
2325
		/** This action is documented in class.jetpack.php */
2326
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2327
		Jetpack_Options::update_options(
2328
			array(
2329
				'version'     => $new_version,
2330
				'old_version' => $jetpack_old_version,
2331
			)
2332
		);
2333
2334
		self::state( 'message', 'modules_activated' );
2335
2336
		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...
2337
2338
		if ( $redirect ) {
2339
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2340
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2341
				$page = $_GET['page'];
2342
			}
2343
2344
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2345
			exit;
2346
		}
2347
	}
2348
2349
	/**
2350
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2351
	 * Make sure to tuck away module "library" files in a sub-directory.
2352
	 */
2353
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2354
		static $modules = null;
2355
2356
		if ( ! isset( $modules ) ) {
2357
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2358
			// Use the cache if we're on the front-end and it's available...
2359
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2360
				$modules = $available_modules_option[ JETPACK__VERSION ];
2361
			} else {
2362
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2363
2364
				$modules = array();
2365
2366
				foreach ( $files as $file ) {
2367
					if ( ! $headers = self::get_module( $file ) ) {
2368
						continue;
2369
					}
2370
2371
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2372
				}
2373
2374
				Jetpack_Options::update_option(
2375
					'available_modules',
2376
					array(
2377
						JETPACK__VERSION => $modules,
2378
					)
2379
				);
2380
			}
2381
		}
2382
2383
		/**
2384
		 * Filters the array of modules available to be activated.
2385
		 *
2386
		 * @since 2.4.0
2387
		 *
2388
		 * @param array $modules Array of available modules.
2389
		 * @param string $min_version Minimum version number required to use modules.
2390
		 * @param string $max_version Maximum version number required to use modules.
2391
		 */
2392
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2393
2394
		if ( ! $min_version && ! $max_version ) {
2395
			return array_keys( $mods );
2396
		}
2397
2398
		$r = array();
2399
		foreach ( $mods as $slug => $introduced ) {
2400
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2401
				continue;
2402
			}
2403
2404
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2405
				continue;
2406
			}
2407
2408
			$r[] = $slug;
2409
		}
2410
2411
		return $r;
2412
	}
2413
2414
	/**
2415
	 * Default modules loaded on activation.
2416
	 */
2417
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2418
		$return = array();
2419
2420
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2421
			$module_data = self::get_module( $module );
2422
2423
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2424
				case 'yes':
2425
					$return[] = $module;
2426
					break;
2427
				case 'public':
2428
					if ( Jetpack_Options::get_option( 'public' ) ) {
2429
						$return[] = $module;
2430
					}
2431
					break;
2432
				case 'no':
2433
				default:
2434
					break;
2435
			}
2436
		}
2437
		/**
2438
		 * Filters the array of default modules.
2439
		 *
2440
		 * @since 2.5.0
2441
		 *
2442
		 * @param array $return Array of default modules.
2443
		 * @param string $min_version Minimum version number required to use modules.
2444
		 * @param string $max_version Maximum version number required to use modules.
2445
		 */
2446
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2447
	}
2448
2449
	/**
2450
	 * Checks activated modules during auto-activation to determine
2451
	 * if any of those modules are being deprecated.  If so, close
2452
	 * them out, and add any replacement modules.
2453
	 *
2454
	 * Runs at priority 99 by default.
2455
	 *
2456
	 * This is run late, so that it can still activate a module if
2457
	 * the new module is a replacement for another that the user
2458
	 * currently has active, even if something at the normal priority
2459
	 * would kibosh everything.
2460
	 *
2461
	 * @since 2.6
2462
	 * @uses jetpack_get_default_modules filter
2463
	 * @param array $modules
2464
	 * @return array
2465
	 */
2466
	function handle_deprecated_modules( $modules ) {
2467
		$deprecated_modules = array(
2468
			'debug'            => null,  // Closed out and moved to the debugger library.
2469
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2470
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2471
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2472
		);
2473
2474
		// Don't activate SSO if they never completed activating WPCC.
2475
		if ( self::is_module_active( 'wpcc' ) ) {
2476
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2477
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2478
				$deprecated_modules['wpcc'] = null;
2479
			}
2480
		}
2481
2482
		foreach ( $deprecated_modules as $module => $replacement ) {
2483
			if ( self::is_module_active( $module ) ) {
2484
				self::deactivate_module( $module );
2485
				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...
2486
					$modules[] = $replacement;
2487
				}
2488
			}
2489
		}
2490
2491
		return array_unique( $modules );
2492
	}
2493
2494
	/**
2495
	 * Checks activated plugins during auto-activation to determine
2496
	 * if any of those plugins are in the list with a corresponding module
2497
	 * that is not compatible with the plugin. The module will not be allowed
2498
	 * to auto-activate.
2499
	 *
2500
	 * @since 2.6
2501
	 * @uses jetpack_get_default_modules filter
2502
	 * @param array $modules
2503
	 * @return array
2504
	 */
2505
	function filter_default_modules( $modules ) {
2506
2507
		$active_plugins = self::get_active_plugins();
2508
2509
		if ( ! empty( $active_plugins ) ) {
2510
2511
			// For each module we'd like to auto-activate...
2512
			foreach ( $modules as $key => $module ) {
2513
				// If there are potential conflicts for it...
2514
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2515
					// For each potential conflict...
2516
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2517
						// If that conflicting plugin is active...
2518
						if ( in_array( $plugin, $active_plugins ) ) {
2519
							// Remove that item from being auto-activated.
2520
							unset( $modules[ $key ] );
2521
						}
2522
					}
2523
				}
2524
			}
2525
		}
2526
2527
		return $modules;
2528
	}
2529
2530
	/**
2531
	 * Extract a module's slug from its full path.
2532
	 */
2533
	public static function get_module_slug( $file ) {
2534
		return str_replace( '.php', '', basename( $file ) );
2535
	}
2536
2537
	/**
2538
	 * Generate a module's path from its slug.
2539
	 */
2540
	public static function get_module_path( $slug ) {
2541
		/**
2542
		 * Filters the path of a modules.
2543
		 *
2544
		 * @since 7.4.0
2545
		 *
2546
		 * @param array $return The absolute path to a module's root php file
2547
		 * @param string $slug The module slug
2548
		 */
2549
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2550
	}
2551
2552
	/**
2553
	 * Load module data from module file. Headers differ from WordPress
2554
	 * plugin headers to avoid them being identified as standalone
2555
	 * plugins on the WordPress plugins page.
2556
	 */
2557
	public static function get_module( $module ) {
2558
		$headers = array(
2559
			'name'                      => 'Module Name',
2560
			'description'               => 'Module Description',
2561
			'sort'                      => 'Sort Order',
2562
			'recommendation_order'      => 'Recommendation Order',
2563
			'introduced'                => 'First Introduced',
2564
			'changed'                   => 'Major Changes In',
2565
			'deactivate'                => 'Deactivate',
2566
			'free'                      => 'Free',
2567
			'requires_connection'       => 'Requires Connection',
2568
			'auto_activate'             => 'Auto Activate',
2569
			'module_tags'               => 'Module Tags',
2570
			'feature'                   => 'Feature',
2571
			'additional_search_queries' => 'Additional Search Queries',
2572
			'plan_classes'              => 'Plans',
2573
		);
2574
2575
		$file = self::get_module_path( self::get_module_slug( $module ) );
2576
2577
		$mod = self::get_file_data( $file, $headers );
2578
		if ( empty( $mod['name'] ) ) {
2579
			return false;
2580
		}
2581
2582
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2583
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2584
		$mod['deactivate']           = empty( $mod['deactivate'] );
2585
		$mod['free']                 = empty( $mod['free'] );
2586
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2587
2588
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2589
			$mod['auto_activate'] = 'No';
2590
		} else {
2591
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2592
		}
2593
2594
		if ( $mod['module_tags'] ) {
2595
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2596
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2597
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2598
		} else {
2599
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2600
		}
2601
2602 View Code Duplication
		if ( $mod['plan_classes'] ) {
2603
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2604
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2605
		} else {
2606
			$mod['plan_classes'] = array( 'free' );
2607
		}
2608
2609 View Code Duplication
		if ( $mod['feature'] ) {
2610
			$mod['feature'] = explode( ',', $mod['feature'] );
2611
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2612
		} else {
2613
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2614
		}
2615
2616
		/**
2617
		 * Filters the feature array on a module.
2618
		 *
2619
		 * This filter allows you to control where each module is filtered: Recommended,
2620
		 * and the default "Other" listing.
2621
		 *
2622
		 * @since 3.5.0
2623
		 *
2624
		 * @param array   $mod['feature'] The areas to feature this module:
2625
		 *     'Recommended' shows on the main Jetpack admin screen.
2626
		 *     'Other' should be the default if no other value is in the array.
2627
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2628
		 * @param array   $mod All the currently assembled module data.
2629
		 */
2630
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2631
2632
		/**
2633
		 * Filter the returned data about a module.
2634
		 *
2635
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2636
		 * so please be careful.
2637
		 *
2638
		 * @since 3.6.0
2639
		 *
2640
		 * @param array   $mod    The details of the requested module.
2641
		 * @param string  $module The slug of the module, e.g. sharedaddy
2642
		 * @param string  $file   The path to the module source file.
2643
		 */
2644
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2645
	}
2646
2647
	/**
2648
	 * Like core's get_file_data implementation, but caches the result.
2649
	 */
2650
	public static function get_file_data( $file, $headers ) {
2651
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2652
		$file_name = basename( $file );
2653
2654
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2655
2656
		$file_data_option = get_transient( $cache_key );
2657
2658
		if ( ! is_array( $file_data_option ) ) {
2659
			delete_transient( $cache_key );
2660
			$file_data_option = false;
2661
		}
2662
2663
		if ( false === $file_data_option ) {
2664
			$file_data_option = array();
2665
		}
2666
2667
		$key           = md5( $file_name . serialize( $headers ) );
2668
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2669
2670
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2671
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2672
			return $file_data_option[ $key ];
2673
		}
2674
2675
		$data = get_file_data( $file, $headers );
2676
2677
		$file_data_option[ $key ] = $data;
2678
2679
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2680
2681
		return $data;
2682
	}
2683
2684
2685
	/**
2686
	 * Return translated module tag.
2687
	 *
2688
	 * @param string $tag Tag as it appears in each module heading.
2689
	 *
2690
	 * @return mixed
2691
	 */
2692
	public static function translate_module_tag( $tag ) {
2693
		return jetpack_get_module_i18n_tag( $tag );
2694
	}
2695
2696
	/**
2697
	 * Get i18n strings as a JSON-encoded string
2698
	 *
2699
	 * @return string The locale as JSON
2700
	 */
2701
	public static function get_i18n_data_json() {
2702
2703
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2704
		// JSON files with the file they should be included for. This is an md5
2705
		// of '_inc/build/admin.js'.
2706
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2707
2708
		$i18n_json =
2709
				   JETPACK__PLUGIN_DIR
2710
				   . 'languages/json/jetpack-'
2711
				   . get_user_locale()
2712
				   . '-'
2713
				   . $path_md5
2714
				   . '.json';
2715
2716
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2717
			$locale_data = @file_get_contents( $i18n_json );
2718
			if ( $locale_data ) {
2719
				return $locale_data;
2720
			}
2721
		}
2722
2723
		// Return valid empty Jed locale
2724
		return '{ "locale_data": { "messages": { "": {} } } }';
2725
	}
2726
2727
	/**
2728
	 * Add locale data setup to wp-i18n
2729
	 *
2730
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2731
	 *
2732
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2733
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2734
	 *
2735
	 * This method provides a safe way to request the setup multiple times but add the script at
2736
	 * most once.
2737
	 *
2738
	 * @since 6.7.0
2739
	 *
2740
	 * @return void
2741
	 */
2742
	public static function setup_wp_i18n_locale_data() {
2743
		static $script_added = false;
2744
		if ( ! $script_added ) {
2745
			$script_added = true;
2746
			wp_add_inline_script(
2747
				'wp-i18n',
2748
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2749
			);
2750
		}
2751
	}
2752
2753
	/**
2754
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2755
	 *
2756
	 * @since 3.9.2
2757
	 *
2758
	 * @param array $modules
2759
	 *
2760
	 * @return string|void
2761
	 */
2762
	public static function get_translated_modules( $modules ) {
2763
		foreach ( $modules as $index => $module ) {
2764
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2765
			if ( isset( $module['name'] ) ) {
2766
				$modules[ $index ]['name'] = $i18n_module['name'];
2767
			}
2768
			if ( isset( $module['description'] ) ) {
2769
				$modules[ $index ]['description']       = $i18n_module['description'];
2770
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2771
			}
2772
		}
2773
		return $modules;
2774
	}
2775
2776
	/**
2777
	 * Get a list of activated modules as an array of module slugs.
2778
	 */
2779
	public static function get_active_modules() {
2780
		$active = Jetpack_Options::get_option( 'active_modules' );
2781
2782
		if ( ! is_array( $active ) ) {
2783
			$active = array();
2784
		}
2785
2786
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2787
			$active[] = 'vaultpress';
2788
		} else {
2789
			$active = array_diff( $active, array( 'vaultpress' ) );
2790
		}
2791
2792
		// If protect is active on the main site of a multisite, it should be active on all sites.
2793
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2794
			$active[] = 'protect';
2795
		}
2796
2797
		/**
2798
		 * Allow filtering of the active modules.
2799
		 *
2800
		 * Gives theme and plugin developers the power to alter the modules that
2801
		 * are activated on the fly.
2802
		 *
2803
		 * @since 5.8.0
2804
		 *
2805
		 * @param array $active Array of active module slugs.
2806
		 */
2807
		$active = apply_filters( 'jetpack_active_modules', $active );
2808
2809
		return array_unique( $active );
2810
	}
2811
2812
	/**
2813
	 * Check whether or not a Jetpack module is active.
2814
	 *
2815
	 * @param string $module The slug of a Jetpack module.
2816
	 * @return bool
2817
	 *
2818
	 * @static
2819
	 */
2820
	public static function is_module_active( $module ) {
2821
		return in_array( $module, self::get_active_modules() );
2822
	}
2823
2824
	public static function is_module( $module ) {
2825
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2826
	}
2827
2828
	/**
2829
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2830
	 *
2831
	 * @param bool $catch True to start catching, False to stop.
2832
	 *
2833
	 * @static
2834
	 */
2835
	public static function catch_errors( $catch ) {
2836
		static $display_errors, $error_reporting;
2837
2838
		if ( $catch ) {
2839
			$display_errors  = @ini_set( 'display_errors', 1 );
2840
			$error_reporting = @error_reporting( E_ALL );
2841
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2842
		} else {
2843
			@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...
2844
			@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...
2845
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2846
		}
2847
	}
2848
2849
	/**
2850
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2851
	 */
2852
	public static function catch_errors_on_shutdown() {
2853
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2854
	}
2855
2856
	/**
2857
	 * Rewrite any string to make paths easier to read.
2858
	 *
2859
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2860
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2861
	 *
2862
	 * @param $string
2863
	 * @return mixed
2864
	 */
2865
	public static function alias_directories( $string ) {
2866
		// ABSPATH has a trailing slash.
2867
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2868
		// WP_CONTENT_DIR does not have a trailing slash.
2869
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2870
2871
		return $string;
2872
	}
2873
2874
	public static function activate_default_modules(
2875
		$min_version = false,
2876
		$max_version = false,
2877
		$other_modules = array(),
2878
		$redirect = null,
2879
		$send_state_messages = null
2880
	) {
2881
		$jetpack = self::init();
2882
2883
		if ( is_null( $redirect ) ) {
2884
			if (
2885
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2886
			||
2887
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2888
			||
2889
				( defined( 'WP_CLI' ) && WP_CLI )
2890
			||
2891
				( defined( 'DOING_CRON' ) && DOING_CRON )
2892
			||
2893
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2894
			) {
2895
				$redirect = false;
2896
			} elseif ( is_admin() ) {
2897
				$redirect = true;
2898
			} else {
2899
				$redirect = false;
2900
			}
2901
		}
2902
2903
		if ( is_null( $send_state_messages ) ) {
2904
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2905
		}
2906
2907
		$modules = self::get_default_modules( $min_version, $max_version );
2908
		$modules = array_merge( $other_modules, $modules );
2909
2910
		// Look for standalone plugins and disable if active.
2911
2912
		$to_deactivate = array();
2913
		foreach ( $modules as $module ) {
2914
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2915
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2916
			}
2917
		}
2918
2919
		$deactivated = array();
2920
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2921
			list( $probable_file, $probable_title ) = $deactivate_me;
2922
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2923
				$deactivated[] = $module;
2924
			}
2925
		}
2926
2927
		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...
2928
			if ( $send_state_messages ) {
2929
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2930
			}
2931
2932
			if ( $redirect ) {
2933
				$url = add_query_arg(
2934
					array(
2935
						'action'   => 'activate_default_modules',
2936
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2937
					),
2938
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2939
				);
2940
				wp_safe_redirect( $url );
2941
				exit;
2942
			}
2943
		}
2944
2945
		/**
2946
		 * Fires before default modules are activated.
2947
		 *
2948
		 * @since 1.9.0
2949
		 *
2950
		 * @param string $min_version Minimum version number required to use modules.
2951
		 * @param string $max_version Maximum version number required to use modules.
2952
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2953
		 */
2954
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2955
2956
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2957
		if ( $send_state_messages ) {
2958
			self::restate();
2959
			self::catch_errors( true );
2960
		}
2961
2962
		$active = self::get_active_modules();
2963
2964
		foreach ( $modules as $module ) {
2965
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2966
				$active[] = $module;
2967
				self::update_active_modules( $active );
2968
				continue;
2969
			}
2970
2971
			if ( $send_state_messages && in_array( $module, $active ) ) {
2972
				$module_info = self::get_module( $module );
2973 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2974
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2975
					if ( $active_state = self::state( $state ) ) {
2976
						$active_state = explode( ',', $active_state );
2977
					} else {
2978
						$active_state = array();
2979
					}
2980
					$active_state[] = $module;
2981
					self::state( $state, implode( ',', $active_state ) );
2982
				}
2983
				continue;
2984
			}
2985
2986
			$file = self::get_module_path( $module );
2987
			if ( ! file_exists( $file ) ) {
2988
				continue;
2989
			}
2990
2991
			// we'll override this later if the plugin can be included without fatal error
2992
			if ( $redirect ) {
2993
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2994
			}
2995
2996
			if ( $send_state_messages ) {
2997
				self::state( 'error', 'module_activation_failed' );
2998
				self::state( 'module', $module );
2999
			}
3000
3001
			ob_start();
3002
			require_once $file;
3003
3004
			$active[] = $module;
3005
3006 View Code Duplication
			if ( $send_state_messages ) {
3007
3008
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3009
				if ( $active_state = self::state( $state ) ) {
3010
					$active_state = explode( ',', $active_state );
3011
				} else {
3012
					$active_state = array();
3013
				}
3014
				$active_state[] = $module;
3015
				self::state( $state, implode( ',', $active_state ) );
3016
			}
3017
3018
			self::update_active_modules( $active );
3019
3020
			ob_end_clean();
3021
		}
3022
3023
		if ( $send_state_messages ) {
3024
			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...
3025
			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...
3026
		}
3027
3028
		self::catch_errors( false );
3029
		/**
3030
		 * Fires when default modules are activated.
3031
		 *
3032
		 * @since 1.9.0
3033
		 *
3034
		 * @param string $min_version Minimum version number required to use modules.
3035
		 * @param string $max_version Maximum version number required to use modules.
3036
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3037
		 */
3038
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3039
	}
3040
3041
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3042
		/**
3043
		 * Fires before a module is activated.
3044
		 *
3045
		 * @since 2.6.0
3046
		 *
3047
		 * @param string $module Module slug.
3048
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3049
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3050
		 */
3051
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3052
3053
		$jetpack = self::init();
3054
3055
		if ( ! strlen( $module ) ) {
3056
			return false;
3057
		}
3058
3059
		if ( ! self::is_module( $module ) ) {
3060
			return false;
3061
		}
3062
3063
		// If it's already active, then don't do it again
3064
		$active = self::get_active_modules();
3065
		foreach ( $active as $act ) {
3066
			if ( $act == $module ) {
3067
				return true;
3068
			}
3069
		}
3070
3071
		$module_data = self::get_module( $module );
3072
3073
		$is_development_mode = ( new Status() )->is_development_mode();
3074
		if ( ! self::is_active() ) {
3075
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3076
				return false;
3077
			}
3078
3079
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3080
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3081
				return false;
3082
			}
3083
		}
3084
3085
		// Check and see if the old plugin is active
3086
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3087
			// Deactivate the old plugin
3088
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3089
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3090
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3091
				self::state( 'deactivated_plugins', $module );
3092
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3093
				exit;
3094
			}
3095
		}
3096
3097
		// Protect won't work with mis-configured IPs
3098
		if ( 'protect' === $module ) {
3099
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3100
			if ( ! jetpack_protect_get_ip() ) {
3101
				self::state( 'message', 'protect_misconfigured_ip' );
3102
				return false;
3103
			}
3104
		}
3105
3106
		if ( ! Jetpack_Plan::supports( $module ) ) {
3107
			return false;
3108
		}
3109
3110
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3111
		self::state( 'module', $module );
3112
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3113
3114
		self::catch_errors( true );
3115
		ob_start();
3116
		require self::get_module_path( $module );
3117
		/** This action is documented in class.jetpack.php */
3118
		do_action( 'jetpack_activate_module', $module );
3119
		$active[] = $module;
3120
		self::update_active_modules( $active );
3121
3122
		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...
3123
		ob_end_clean();
3124
		self::catch_errors( false );
3125
3126
		if ( $redirect ) {
3127
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3128
		}
3129
		if ( $exit ) {
3130
			exit;
3131
		}
3132
		return true;
3133
	}
3134
3135
	function activate_module_actions( $module ) {
3136
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3137
	}
3138
3139
	public static function deactivate_module( $module ) {
3140
		/**
3141
		 * Fires when a module is deactivated.
3142
		 *
3143
		 * @since 1.9.0
3144
		 *
3145
		 * @param string $module Module slug.
3146
		 */
3147
		do_action( 'jetpack_pre_deactivate_module', $module );
3148
3149
		$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...
3150
3151
		$active = self::get_active_modules();
3152
		$new    = array_filter( array_diff( $active, (array) $module ) );
3153
3154
		return self::update_active_modules( $new );
3155
	}
3156
3157
	public static function enable_module_configurable( $module ) {
3158
		$module = self::get_module_slug( $module );
3159
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3160
	}
3161
3162
	/**
3163
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3164
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3165
	 *
3166
	 * @param string $module Module slug
3167
	 * @return string $url module configuration URL
3168
	 */
3169
	public static function module_configuration_url( $module ) {
3170
		$module      = self::get_module_slug( $module );
3171
		$default_url = self::admin_url() . "#/settings?term=$module";
3172
		/**
3173
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3174
		 *
3175
		 * @since 6.9.0
3176
		 *
3177
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3178
		 */
3179
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3180
3181
		return $url;
3182
	}
3183
3184
	/* Installation */
3185
	public static function bail_on_activation( $message, $deactivate = true ) {
3186
		?>
3187
<!doctype html>
3188
<html>
3189
<head>
3190
<meta charset="<?php bloginfo( 'charset' ); ?>">
3191
<style>
3192
* {
3193
	text-align: center;
3194
	margin: 0;
3195
	padding: 0;
3196
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3197
}
3198
p {
3199
	margin-top: 1em;
3200
	font-size: 18px;
3201
}
3202
</style>
3203
<body>
3204
<p><?php echo esc_html( $message ); ?></p>
3205
</body>
3206
</html>
3207
		<?php
3208
		if ( $deactivate ) {
3209
			$plugins = get_option( 'active_plugins' );
3210
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3211
			$update  = false;
3212
			foreach ( $plugins as $i => $plugin ) {
3213
				if ( $plugin === $jetpack ) {
3214
					$plugins[ $i ] = false;
3215
					$update        = true;
3216
				}
3217
			}
3218
3219
			if ( $update ) {
3220
				update_option( 'active_plugins', array_filter( $plugins ) );
3221
			}
3222
		}
3223
		exit;
3224
	}
3225
3226
	/**
3227
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3228
	 *
3229
	 * @static
3230
	 */
3231
	public static function plugin_activation( $network_wide ) {
3232
		Jetpack_Options::update_option( 'activated', 1 );
3233
3234
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3235
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3236
		}
3237
3238
		if ( $network_wide ) {
3239
			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...
3240
		}
3241
3242
		// For firing one-off events (notices) immediately after activation
3243
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3244
3245
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3246
3247
		Health::on_jetpack_activated();
3248
3249
		self::plugin_initialize();
3250
	}
3251
3252
	public static function get_activation_source( $referer_url ) {
3253
3254
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3255
			return array( 'wp-cli', null );
3256
		}
3257
3258
		$referer = wp_parse_url( $referer_url );
3259
3260
		$source_type  = 'unknown';
3261
		$source_query = null;
3262
3263
		if ( ! is_array( $referer ) ) {
3264
			return array( $source_type, $source_query );
3265
		}
3266
3267
		$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...
3268
		$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...
3269
3270
		if ( isset( $referer['query'] ) ) {
3271
			parse_str( $referer['query'], $query_parts );
3272
		} else {
3273
			$query_parts = array();
3274
		}
3275
3276
		if ( $plugins_path === $referer['path'] ) {
3277
			$source_type = 'list';
3278
		} elseif ( $plugins_install_path === $referer['path'] ) {
3279
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3280
			switch ( $tab ) {
3281
				case 'popular':
3282
					$source_type = 'popular';
3283
					break;
3284
				case 'recommended':
3285
					$source_type = 'recommended';
3286
					break;
3287
				case 'favorites':
3288
					$source_type = 'favorites';
3289
					break;
3290
				case 'search':
3291
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3292
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3293
					break;
3294
				default:
3295
					$source_type = 'featured';
3296
			}
3297
		}
3298
3299
		return array( $source_type, $source_query );
3300
	}
3301
3302
	/**
3303
	 * Runs before bumping version numbers up to a new version
3304
	 *
3305
	 * @param string $version    Version:timestamp.
3306
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3307
	 */
3308
	public static function do_version_bump( $version, $old_version ) {
3309
		if ( $old_version ) { // For existing Jetpack installations.
3310
			self::send_update_modal_data();
3311
		}
3312
	}
3313
3314
	/**
3315
	 * Prepares the release post content and image data and saves it in the
3316
	 * state array. This data is used to create the update modal.
3317
	 */
3318
	public static function send_update_modal_data() {
3319
		$post_data = self::get_release_post_data();
3320
3321
		if ( ! isset( $post_data['posts'][0] ) ) {
3322
			return;
3323
		}
3324
3325
		$post = $post_data['posts'][0];
3326
3327
		$post_content = isset( $post['content'] ) ? $post['content'] : null;
3328
		if ( empty( $post_content ) ) {
3329
			return;
3330
		}
3331
3332
		// This allows us to embed videopress videos into the release post.
3333
		add_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3334
		$content = wp_kses_post( $post_content );
3335
		remove_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3336
3337
		$post_title = isset( $post['title'] ) ? $post['title'] : null;
3338
		$title      = wp_kses( $post_title, array() );
3339
3340
		$post_thumbnail = isset( $post['post_thumbnail'] ) ? $post['post_thumbnail'] : null;
3341
		if ( ! empty( $post_thumbnail ) ) {
3342
			jetpack_require_lib( 'class.jetpack-photon-image' );
3343
			$photon_image = new Jetpack_Photon_Image(
3344
				array(
3345
					'file'   => jetpack_photon_url( $post_thumbnail['URL'] ),
3346
					'width'  => $post_thumbnail['width'],
3347
					'height' => $post_thumbnail['height'],
3348
				),
3349
				$post_thumbnail['mime_type']
3350
			);
3351
			$photon_image->resize(
3352
				array(
3353
					'width'  => 600,
3354
					'height' => null,
3355
					'crop'   => false,
3356
				)
3357
			);
3358
			$post_thumbnail_url = $photon_image->get_raw_filename();
3359
		} else {
3360
			$post_thumbnail_url = null;
3361
		}
3362
3363
		$post_array = array(
3364
			'release_post_content'        => $content,
3365
			'release_post_featured_image' => $post_thumbnail_url,
3366
			'release_post_title'          => $title,
3367
		);
3368
3369
		self::state( 'message_content', $post_array );
0 ignored issues
show
$post_array is of type array<string,?,{"release...lease_post_title":"?"}>, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3370
	}
3371
3372
	/**
3373
	 * Temporarily allow post content to contain iframes, e.g. for videopress.
3374
	 *
3375
	 * @param string $tags    The tags.
3376
	 * @param string $context The context.
3377
	 */
3378
	public static function allow_post_embed_iframe( $tags, $context ) {
3379
		if ( 'post' === $context ) {
3380
			$tags['iframe'] = array(
3381
				'src'             => true,
3382
				'height'          => true,
3383
				'width'           => true,
3384
				'frameborder'     => true,
3385
				'allowfullscreen' => true,
3386
			);
3387
		}
3388
3389
		return $tags;
3390
	}
3391
3392
	/**
3393
	 * Obtains the release post from the Jetpack release post blog. A release post will be displayed in the
3394
	 * update modal when a post has a tag equal to the Jetpack version number.
3395
	 *
3396
	 * The response parameters for the post array can be found here:
3397
	 * https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/posts/%24post_ID/#apidoc-response
3398
	 *
3399
	 * @return array|null Returns an associative array containing the release post data at index ['posts'][0].
3400
	 *                    Returns null if the release post data is not available.
3401
	 */
3402
	private static function get_release_post_data() {
3403
		if ( Constants::is_defined( 'TESTING_IN_JETPACK' ) && Constants::get_constant( 'TESTING_IN_JETPACK' ) ) {
3404
			return null;
3405
		}
3406
3407
		$release_post_src = add_query_arg(
3408
			array(
3409
				'order_by' => 'date',
3410
				'tag'      => JETPACK__VERSION,
3411
				'number'   => '1',
3412
			),
3413
			'https://public-api.wordpress.com/rest/v1/sites/' . JETPACK__RELEASE_POST_BLOG_SLUG . '/posts'
3414
		);
3415
3416
		$response = wp_remote_get( $release_post_src );
3417
3418
		if ( ! is_array( $response ) ) {
3419
			return null;
3420
		}
3421
3422
		return json_decode( wp_remote_retrieve_body( $response ), true );
3423
	}
3424
3425
	/**
3426
	 * Sets the internal version number and activation state.
3427
	 *
3428
	 * @static
3429
	 */
3430
	public static function plugin_initialize() {
3431
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3432
			Jetpack_Options::update_option( 'activated', 2 );
3433
		}
3434
3435 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3436
			$version = $old_version = JETPACK__VERSION . ':' . time();
3437
			/** This action is documented in class.jetpack.php */
3438
			do_action( 'updating_jetpack_version', $version, false );
3439
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3440
		}
3441
3442
		self::load_modules();
3443
3444
		Jetpack_Options::delete_option( 'do_activate' );
3445
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3446
	}
3447
3448
	/**
3449
	 * Removes all connection options
3450
	 *
3451
	 * @static
3452
	 */
3453
	public static function plugin_deactivation() {
3454
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3455
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3456
			Jetpack_Network::init()->deactivate();
3457
		} else {
3458
			self::disconnect( false );
3459
			// Jetpack_Heartbeat::init()->deactivate();
3460
		}
3461
	}
3462
3463
	/**
3464
	 * Disconnects from the Jetpack servers.
3465
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3466
	 *
3467
	 * @static
3468
	 */
3469
	public static function disconnect( $update_activated_state = true ) {
3470
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3471
		$connection = self::connection();
3472
		$connection->clean_nonces( true );
3473
3474
		// If the site is in an IDC because sync is not allowed,
3475
		// let's make sure to not disconnect the production site.
3476
		if ( ! self::validate_sync_error_idc_option() ) {
3477
			$tracking = new Tracking();
3478
			$tracking->record_user_event( 'disconnect_site', array() );
3479
3480
			$connection->disconnect_site_wpcom();
3481
		}
3482
3483
		$connection->delete_all_connection_tokens();
3484
		Jetpack_IDC::clear_all_idc_options();
3485
3486
		if ( $update_activated_state ) {
3487
			Jetpack_Options::update_option( 'activated', 4 );
3488
		}
3489
3490
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3491
			// Check then record unique disconnection if site has never been disconnected previously
3492
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3493
				$jetpack_unique_connection['disconnected'] = 1;
3494
			} else {
3495
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3496
					// track unique disconnect
3497
					$jetpack = self::init();
3498
3499
					$jetpack->stat( 'connections', 'unique-disconnect' );
3500
					$jetpack->do_stats( 'server_side' );
3501
				}
3502
				// increment number of times disconnected
3503
				$jetpack_unique_connection['disconnected'] += 1;
3504
			}
3505
3506
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3507
		}
3508
3509
		// Delete all the sync related data. Since it could be taking up space.
3510
		Sender::get_instance()->uninstall();
3511
3512
		// Disable the Heartbeat cron
3513
		Jetpack_Heartbeat::init()->deactivate();
3514
	}
3515
3516
	/**
3517
	 * Unlinks the current user from the linked WordPress.com user.
3518
	 *
3519
	 * @deprecated since 7.7
3520
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3521
	 *
3522
	 * @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...
3523
	 * @return Boolean Whether the disconnection of the user was successful.
3524
	 */
3525
	public static function unlink_user( $user_id = null ) {
3526
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3527
		return Connection_Manager::disconnect_user( $user_id );
3528
	}
3529
3530
	/**
3531
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3532
	 */
3533
	public static function try_registration() {
3534
		$terms_of_service = new Terms_Of_Service();
3535
		// The user has agreed to the TOS at some point by now.
3536
		$terms_of_service->agree();
3537
3538
		// Let's get some testing in beta versions and such.
3539
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3540
			// Before attempting to connect, let's make sure that the domains are viable.
3541
			$domains_to_check = array_unique(
3542
				array(
3543
					'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...
3544
					'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...
3545
				)
3546
			);
3547
			foreach ( $domains_to_check as $domain ) {
3548
				$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...
3549
				if ( is_wp_error( $result ) ) {
3550
					return $result;
3551
				}
3552
			}
3553
		}
3554
3555
		$result = self::register();
3556
3557
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3558
		if ( ! $result || is_wp_error( $result ) ) {
3559
			return $result;
3560
		} else {
3561
			return true;
3562
		}
3563
	}
3564
3565
	/**
3566
	 * Tracking an internal event log. Try not to put too much chaff in here.
3567
	 *
3568
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3569
	 */
3570
	public static function log( $code, $data = null ) {
3571
		// only grab the latest 200 entries
3572
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3573
3574
		// Append our event to the log
3575
		$log_entry = array(
3576
			'time'    => time(),
3577
			'user_id' => get_current_user_id(),
3578
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3579
			'code'    => $code,
3580
		);
3581
		// Don't bother storing it unless we've got some.
3582
		if ( ! is_null( $data ) ) {
3583
			$log_entry['data'] = $data;
3584
		}
3585
		$log[] = $log_entry;
3586
3587
		// Try add_option first, to make sure it's not autoloaded.
3588
		// @todo: Add an add_option method to Jetpack_Options
3589
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3590
			Jetpack_Options::update_option( 'log', $log );
3591
		}
3592
3593
		/**
3594
		 * Fires when Jetpack logs an internal event.
3595
		 *
3596
		 * @since 3.0.0
3597
		 *
3598
		 * @param array $log_entry {
3599
		 *  Array of details about the log entry.
3600
		 *
3601
		 *  @param string time Time of the event.
3602
		 *  @param int user_id ID of the user who trigerred the event.
3603
		 *  @param int blog_id Jetpack Blog ID.
3604
		 *  @param string code Unique name for the event.
3605
		 *  @param string data Data about the event.
3606
		 * }
3607
		 */
3608
		do_action( 'jetpack_log_entry', $log_entry );
3609
	}
3610
3611
	/**
3612
	 * Get the internal event log.
3613
	 *
3614
	 * @param $event (string) - only return the specific log events
3615
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3616
	 *
3617
	 * @return array of log events || WP_Error for invalid params
3618
	 */
3619
	public static function get_log( $event = false, $num = false ) {
3620
		if ( $event && ! is_string( $event ) ) {
3621
			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...
3622
		}
3623
3624
		if ( $num && ! is_numeric( $num ) ) {
3625
			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...
3626
		}
3627
3628
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3629
3630
		// If nothing set - act as it did before, otherwise let's start customizing the output
3631
		if ( ! $num && ! $event ) {
3632
			return $entire_log;
3633
		} else {
3634
			$entire_log = array_reverse( $entire_log );
3635
		}
3636
3637
		$custom_log_output = array();
3638
3639
		if ( $event ) {
3640
			foreach ( $entire_log as $log_event ) {
3641
				if ( $event == $log_event['code'] ) {
3642
					$custom_log_output[] = $log_event;
3643
				}
3644
			}
3645
		} else {
3646
			$custom_log_output = $entire_log;
3647
		}
3648
3649
		if ( $num ) {
3650
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3651
		}
3652
3653
		return $custom_log_output;
3654
	}
3655
3656
	/**
3657
	 * Log modification of important settings.
3658
	 */
3659
	public static function log_settings_change( $option, $old_value, $value ) {
3660
		switch ( $option ) {
3661
			case 'jetpack_sync_non_public_post_stati':
3662
				self::log( $option, $value );
3663
				break;
3664
		}
3665
	}
3666
3667
	/**
3668
	 * Return stat data for WPCOM sync
3669
	 */
3670
	public static function get_stat_data( $encode = true, $extended = true ) {
3671
		$data = Jetpack_Heartbeat::generate_stats_array();
3672
3673
		if ( $extended ) {
3674
			$additional_data = self::get_additional_stat_data();
3675
			$data            = array_merge( $data, $additional_data );
3676
		}
3677
3678
		if ( $encode ) {
3679
			return json_encode( $data );
3680
		}
3681
3682
		return $data;
3683
	}
3684
3685
	/**
3686
	 * Get additional stat data to sync to WPCOM
3687
	 */
3688
	public static function get_additional_stat_data( $prefix = '' ) {
3689
		$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...
3690
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3691
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3692
		$return[ "{$prefix}site-count" ]    = 0;
3693
3694
		if ( function_exists( 'get_blog_count' ) ) {
3695
			$return[ "{$prefix}site-count" ] = get_blog_count();
3696
		}
3697
		return $return;
3698
	}
3699
3700
	private static function get_site_user_count() {
3701
		global $wpdb;
3702
3703
		if ( function_exists( 'wp_is_large_network' ) ) {
3704
			if ( wp_is_large_network( 'users' ) ) {
3705
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3706
			}
3707
		}
3708
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3709
			// It wasn't there, so regenerate the data and save the transient
3710
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3711
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3712
		}
3713
		return $user_count;
3714
	}
3715
3716
	/* Admin Pages */
3717
3718
	function admin_init() {
3719
		// If the plugin is not connected, display a connect message.
3720
		if (
3721
			// the plugin was auto-activated and needs its candy
3722
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3723
		||
3724
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3725
			! Jetpack_Options::get_option( 'activated' )
3726
		) {
3727
			self::plugin_initialize();
3728
		}
3729
3730
		$is_development_mode = ( new Status() )->is_development_mode();
3731
		if ( ! self::is_active() && ! $is_development_mode ) {
3732
			Jetpack_Connection_Banner::init();
3733
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3734
			// Upgrade: 1.1 -> 1.1.1
3735
			// Check and see if host can verify the Jetpack servers' SSL certificate
3736
			$args       = array();
3737
			$connection = self::connection();
3738
			Client::_wp_remote_request(
3739
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3740
				$args,
3741
				true
3742
			);
3743
		}
3744
3745
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3746
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3747
		}
3748
3749
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3750
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3751
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3752
3753
		if ( self::is_active() || $is_development_mode ) {
3754
			// Artificially throw errors in certain whitelisted cases during plugin activation
3755
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3756
		}
3757
3758
		// Add custom column in wp-admin/users.php to show whether user is linked.
3759
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3760
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3761
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3762
	}
3763
3764
	function admin_body_class( $admin_body_class = '' ) {
3765
		$classes = explode( ' ', trim( $admin_body_class ) );
3766
3767
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3768
3769
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3770
		return " $admin_body_class ";
3771
	}
3772
3773
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3774
		return $admin_body_class . ' jetpack-pagestyles ';
3775
	}
3776
3777
	/**
3778
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3779
	 * This function artificially throws errors for such cases (whitelisted).
3780
	 *
3781
	 * @param string $plugin The activated plugin.
3782
	 */
3783
	function throw_error_on_activate_plugin( $plugin ) {
3784
		$active_modules = self::get_active_modules();
3785
3786
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3787
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3788
			$throw = false;
3789
3790
			// Try and make sure it really was the stats plugin
3791
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3792
				if ( 'stats.php' == basename( $plugin ) ) {
3793
					$throw = true;
3794
				}
3795
			} else {
3796
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3797
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3798
					$throw = true;
3799
				}
3800
			}
3801
3802
			if ( $throw ) {
3803
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3804
			}
3805
		}
3806
	}
3807
3808
	function intercept_plugin_error_scrape_init() {
3809
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3810
	}
3811
3812
	function intercept_plugin_error_scrape( $action, $result ) {
3813
		if ( ! $result ) {
3814
			return;
3815
		}
3816
3817
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3818
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3819
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3820
			}
3821
		}
3822
	}
3823
3824
	/**
3825
	 * Register the remote file upload request handlers, if needed.
3826
	 *
3827
	 * @access public
3828
	 */
3829
	public function add_remote_request_handlers() {
3830
		// Remote file uploads are allowed only via AJAX requests.
3831
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3832
			return;
3833
		}
3834
3835
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3836
		$remote_request_actions = array(
3837
			'jetpack_upload_file',
3838
			'jetpack_update_file',
3839
		);
3840
3841
		// phpcs:ignore WordPress.Security.NonceVerification
3842
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3843
			return;
3844
		}
3845
3846
		// Require Jetpack authentication for the remote file upload AJAX requests.
3847
		if ( ! $this->connection_manager ) {
3848
			$this->connection_manager = new Connection_Manager();
3849
		}
3850
3851
		$this->connection_manager->require_jetpack_authentication();
3852
3853
		// Register the remote file upload AJAX handlers.
3854
		foreach ( $remote_request_actions as $action ) {
3855
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3856
		}
3857
	}
3858
3859
	/**
3860
	 * Handler for Jetpack remote file uploads.
3861
	 *
3862
	 * @access public
3863
	 */
3864
	public function remote_request_handlers() {
3865
		$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...
3866
3867
		switch ( current_filter() ) {
3868
			case 'wp_ajax_nopriv_jetpack_upload_file':
3869
				$response = $this->upload_handler();
3870
				break;
3871
3872
			case 'wp_ajax_nopriv_jetpack_update_file':
3873
				$response = $this->upload_handler( true );
3874
				break;
3875
			default:
3876
				$response = new Jetpack_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_handler'.

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

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

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

Loading history...
3877
				break;
3878
		}
3879
3880
		if ( ! $response ) {
3881
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_error'.

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

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

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

Loading history...
3882
		}
3883
3884
		if ( is_wp_error( $response ) ) {
3885
			$status_code       = $response->get_error_data();
0 ignored issues
show
The method get_error_data() does not seem to exist on object<Jetpack_Error>.

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3917
		}
3918
3919
		$user = wp_authenticate( '', '' );
3920
		if ( ! $user || is_wp_error( $user ) ) {
3921
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 403.

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

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

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

Loading history...
3922
		}
3923
3924
		wp_set_current_user( $user->ID );
3925
3926
		if ( ! current_user_can( 'upload_files' ) ) {
3927
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

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

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

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

Loading history...
3928
		}
3929
3930
		if ( empty( $_FILES ) ) {
3931
			return new Jetpack_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'no_files_uploaded'.

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

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

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

Loading history...
3932
		}
3933
3934
		foreach ( array_keys( $_FILES ) as $files_key ) {
3935
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3936
				return new Jetpack_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'missing_hmac'.

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

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

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

Loading history...
3937
			}
3938
		}
3939
3940
		$media_keys = array_keys( $_FILES['media'] );
3941
3942
		$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...
3943
		if ( ! $token || is_wp_error( $token ) ) {
3944
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_token'.

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

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

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

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

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

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

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

Loading history...
3976
				}
3977
3978
				$media_array = $_FILES['media'];
3979
3980
				$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...
3981
				$file_array['type']     = $media_array['type'][0];
3982
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3983
				$file_array['error']    = $media_array['error'][0];
3984
				$file_array['size']     = $media_array['size'][0];
3985
3986
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3987
3988
				if ( is_wp_error( $edited_media_item ) ) {
3989
					return $edited_media_item;
3990
				}
3991
3992
				$response = (object) array(
3993
					'id'   => (string) $post_id,
3994
					'file' => (string) $edited_media_item->post_title,
3995
					'url'  => (string) wp_get_attachment_url( $post_id ),
3996
					'type' => (string) $edited_media_item->post_mime_type,
3997
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3998
				);
3999
4000
				return (array) array( $response );
4001
			}
4002
4003
			$attachment_id = media_handle_upload(
4004
				'.jetpack.upload.',
4005
				$post_id,
4006
				array(),
4007
				array(
4008
					'action' => 'jetpack_upload_file',
4009
				)
4010
			);
4011
4012
			if ( ! $attachment_id ) {
4013
				$uploaded_files[ $index ] = (object) array(
4014
					'error'             => 'unknown',
4015
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
4016
				);
4017
			} elseif ( is_wp_error( $attachment_id ) ) {
4018
				$uploaded_files[ $index ] = (object) array(
4019
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
4020
					'error_description' => $attachment_id->get_error_message(),
4021
				);
4022
			} else {
4023
				$attachment               = get_post( $attachment_id );
4024
				$uploaded_files[ $index ] = (object) array(
4025
					'id'   => (string) $attachment_id,
4026
					'file' => $attachment->post_title,
4027
					'url'  => wp_get_attachment_url( $attachment_id ),
4028
					'type' => $attachment->post_mime_type,
4029
					'meta' => wp_get_attachment_metadata( $attachment_id ),
4030
				);
4031
				// Zip files uploads are not supported unless they are done for installation purposed
4032
				// lets delete them in case something goes wrong in this whole process
4033
				if ( 'application/zip' === $attachment->post_mime_type ) {
4034
					// Schedule a cleanup for 2 hours from now in case of failed install.
4035
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
4036
				}
4037
			}
4038
		}
4039
		if ( ! is_null( $global_post ) ) {
4040
			$GLOBALS['post'] = $global_post;
4041
		}
4042
4043
		return $uploaded_files;
4044
	}
4045
4046
	/**
4047
	 * Add help to the Jetpack page
4048
	 *
4049
	 * @since Jetpack (1.2.3)
4050
	 * @return false if not the Jetpack page
4051
	 */
4052
	function admin_help() {
4053
		$current_screen = get_current_screen();
4054
4055
		// Overview
4056
		$current_screen->add_help_tab(
4057
			array(
4058
				'id'      => 'home',
4059
				'title'   => __( 'Home', 'jetpack' ),
4060
				'content' =>
4061
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4062
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
4063
					'<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>',
4064
			)
4065
		);
4066
4067
		// Screen Content
4068
		if ( current_user_can( 'manage_options' ) ) {
4069
			$current_screen->add_help_tab(
4070
				array(
4071
					'id'      => 'settings',
4072
					'title'   => __( 'Settings', 'jetpack' ),
4073
					'content' =>
4074
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4075
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
4076
						'<ol>' .
4077
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
4078
							'<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>' .
4079
						'</ol>' .
4080
						'<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>',
4081
				)
4082
			);
4083
		}
4084
4085
		// Help Sidebar
4086
		$support_url = Redirect::get_url( 'jetpack-support' );
4087
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
4088
		$current_screen->set_help_sidebar(
4089
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
4090
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
4091
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
4092
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
4093
		);
4094
	}
4095
4096
	function admin_menu_css() {
4097
		wp_enqueue_style( 'jetpack-icons' );
4098
	}
4099
4100
	function admin_menu_order() {
4101
		return true;
4102
	}
4103
4104 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
4105
		$jp_menu_order = array();
4106
4107
		foreach ( $menu_order as $index => $item ) {
4108
			if ( $item != 'jetpack' ) {
4109
				$jp_menu_order[] = $item;
4110
			}
4111
4112
			if ( $index == 0 ) {
4113
				$jp_menu_order[] = 'jetpack';
4114
			}
4115
		}
4116
4117
		return $jp_menu_order;
4118
	}
4119
4120
	function admin_banner_styles() {
4121
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4122
4123 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4124
			wp_register_style(
4125
				'jetpack-dops-style',
4126
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4127
				array(),
4128
				JETPACK__VERSION
4129
			);
4130
		}
4131
4132
		wp_enqueue_style(
4133
			'jetpack',
4134
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4135
			array( 'jetpack-dops-style' ),
4136
			JETPACK__VERSION . '-20121016'
4137
		);
4138
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4139
		wp_style_add_data( 'jetpack', 'suffix', $min );
4140
	}
4141
4142
	function plugin_action_links( $actions ) {
4143
4144
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4145
4146
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4147
			return array_merge(
4148
				$jetpack_home,
4149
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4150
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4151
				$actions
4152
			);
4153
		}
4154
4155
		return array_merge( $jetpack_home, $actions );
4156
	}
4157
4158
	/**
4159
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4160
	 *
4161
	 * @param string $login_url The wp-login URL.
4162
	 * @param string $redirect  URL to redirect users after logging in.
4163
	 * @since Jetpack 8.4
4164
	 * @return string
4165
	 */
4166
	public function login_url( $login_url, $redirect ) {
4167
		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...
4168
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4169
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4170
		}
4171
		return $login_url;
4172
	}
4173
4174
	/**
4175
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4176
	 *
4177
	 * @since Jetpack 8.4
4178
	 */
4179
	public function login_init() {
4180
		// phpcs:ignore WordPress.Security.NonceVerification
4181
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4182
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4183
			wp_safe_redirect(
4184
				add_query_arg(
4185
					array(
4186
						'forceInstall' => 1,
4187
						'url'          => rawurlencode( get_site_url() ),
4188
					),
4189
					// @todo provide way to go to specific calypso env.
4190
					self::get_calypso_host() . 'jetpack/connect'
4191
				)
4192
			);
4193
			exit;
4194
		}
4195
	}
4196
4197
	/*
4198
	 * Registration flow:
4199
	 * 1 - ::admin_page_load() action=register
4200
	 * 2 - ::try_registration()
4201
	 * 3 - ::register()
4202
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4203
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4204
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4205
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4206
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4207
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4208
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4209
	 *       jetpack_id, jetpack_secret, jetpack_public
4210
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4211
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4212
	 * 5 - user logs in with WP.com account
4213
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4214
	 *		- Manager::authorize()
4215
	 *		- Manager::get_token()
4216
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4217
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4218
	 *			- which responds with access_token, token_type, scope
4219
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4220
	 *		- Jetpack::activate_default_modules()
4221
	 *     		- Deactivates deprecated plugins
4222
	 *     		- Activates all default modules
4223
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4224
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4225
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4226
	 *     Done!
4227
	 */
4228
4229
	/**
4230
	 * Handles the page load events for the Jetpack admin page
4231
	 */
4232
	function admin_page_load() {
4233
		$error = false;
4234
4235
		// Make sure we have the right body class to hook stylings for subpages off of.
4236
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4237
4238
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4239
			// Should only be used in intermediate redirects to preserve state across redirects
4240
			self::restate();
4241
		}
4242
4243
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4244
			// @todo: Add validation against a known whitelist
4245
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4246
			// User clicked in the iframe to link their accounts
4247
			if ( ! self::is_user_connected() ) {
4248
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4249
4250
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4251
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4252
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4253
4254
				if ( isset( $_GET['notes_iframe'] ) ) {
4255
					$connect_url .= '&notes_iframe';
4256
				}
4257
				wp_redirect( $connect_url );
4258
				exit;
4259
			} else {
4260
				if ( ! isset( $_GET['calypso_env'] ) ) {
4261
					self::state( 'message', 'already_authorized' );
4262
					wp_safe_redirect( self::admin_url() );
4263
					exit;
4264
				} else {
4265
					$connect_url  = $this->build_connect_url( true, false, $from );
4266
					$connect_url .= '&already_authorized=true';
4267
					wp_redirect( $connect_url );
4268
					exit;
4269
				}
4270
			}
4271
		}
4272
4273
		if ( isset( $_GET['action'] ) ) {
4274
			switch ( $_GET['action'] ) {
4275
				case 'authorize':
4276
					if ( self::is_active() && self::is_user_connected() ) {
4277
						self::state( 'message', 'already_authorized' );
4278
						wp_safe_redirect( self::admin_url() );
4279
						exit;
4280
					}
4281
					self::log( 'authorize' );
4282
					$client_server = new Jetpack_Client_Server();
4283
					$client_server->client_authorize();
4284
					exit;
4285
				case 'register':
4286
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4287
						$error = 'cheatin';
4288
						break;
4289
					}
4290
					check_admin_referer( 'jetpack-register' );
4291
					self::log( 'register' );
4292
					self::maybe_set_version_option();
4293
					$registered = self::try_registration();
4294 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4295
						$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...
4296
						self::state( 'error', $error );
4297
						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...
4298
4299
						/**
4300
						 * Jetpack registration Error.
4301
						 *
4302
						 * @since 7.5.0
4303
						 *
4304
						 * @param string|int $error The error code.
4305
						 * @param \WP_Error $registered The error object.
4306
						 */
4307
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4308
						break;
4309
					}
4310
4311
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4312
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4313
4314
					/**
4315
					 * Jetpack registration Success.
4316
					 *
4317
					 * @since 7.5.0
4318
					 *
4319
					 * @param string $from 'from' GET parameter;
4320
					 */
4321
					do_action( 'jetpack_connection_register_success', $from );
4322
4323
					$url = $this->build_connect_url( true, $redirect, $from );
4324
4325
					if ( ! empty( $_GET['onboarding'] ) ) {
4326
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4327
					}
4328
4329
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4330
						$url = add_query_arg( 'auth_approved', 'true', $url );
4331
					}
4332
4333
					wp_redirect( $url );
4334
					exit;
4335
				case 'activate':
4336
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4337
						$error = 'cheatin';
4338
						break;
4339
					}
4340
4341
					$module = stripslashes( $_GET['module'] );
4342
					check_admin_referer( "jetpack_activate-$module" );
4343
					self::log( 'activate', $module );
4344
					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...
4345
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4346
					}
4347
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4348
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4349
					exit;
4350
				case 'activate_default_modules':
4351
					check_admin_referer( 'activate_default_modules' );
4352
					self::log( 'activate_default_modules' );
4353
					self::restate();
4354
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4355
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4356
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4357
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4358
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4359
					exit;
4360
				case 'disconnect':
4361
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4362
						$error = 'cheatin';
4363
						break;
4364
					}
4365
4366
					check_admin_referer( 'jetpack-disconnect' );
4367
					self::log( 'disconnect' );
4368
					self::disconnect();
4369
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4370
					exit;
4371
				case 'reconnect':
4372
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4373
						$error = 'cheatin';
4374
						break;
4375
					}
4376
4377
					check_admin_referer( 'jetpack-reconnect' );
4378
					self::log( 'reconnect' );
4379
					$this->disconnect();
4380
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4381
					exit;
4382 View Code Duplication
				case 'deactivate':
4383
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4384
						$error = 'cheatin';
4385
						break;
4386
					}
4387
4388
					$modules = stripslashes( $_GET['module'] );
4389
					check_admin_referer( "jetpack_deactivate-$modules" );
4390
					foreach ( explode( ',', $modules ) as $module ) {
4391
						self::log( 'deactivate', $module );
4392
						self::deactivate_module( $module );
4393
						self::state( 'message', 'module_deactivated' );
4394
					}
4395
					self::state( 'module', $modules );
4396
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4397
					exit;
4398
				case 'unlink':
4399
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4400
					check_admin_referer( 'jetpack-unlink' );
4401
					self::log( 'unlink' );
4402
					Connection_Manager::disconnect_user();
4403
					self::state( 'message', 'unlinked' );
4404
					if ( 'sub-unlink' == $redirect ) {
4405
						wp_safe_redirect( admin_url() );
4406
					} else {
4407
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4408
					}
4409
					exit;
4410
				case 'onboard':
4411
					if ( ! current_user_can( 'manage_options' ) ) {
4412
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4413
					} else {
4414
						self::create_onboarding_token();
4415
						$url = $this->build_connect_url( true );
4416
4417
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4418
							$url = add_query_arg( 'onboarding', $token, $url );
4419
						}
4420
4421
						$calypso_env = $this->get_calypso_env();
4422
						if ( ! empty( $calypso_env ) ) {
4423
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4424
						}
4425
4426
						wp_redirect( $url );
4427
						exit;
4428
					}
4429
					exit;
4430
				default:
4431
					/**
4432
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4433
					 *
4434
					 * @since 2.6.0
4435
					 *
4436
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4437
					 */
4438
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4439
			}
4440
		}
4441
4442
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4443
			self::activate_new_modules( true );
4444
		}
4445
4446
		$message_code = self::state( 'message' );
4447
		if ( self::state( 'optin-manage' ) ) {
4448
			$activated_manage = $message_code;
4449
			$message_code     = 'jetpack-manage';
4450
		}
4451
4452
		switch ( $message_code ) {
4453
			case 'jetpack-manage':
4454
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4455
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4456
				$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>';
4457
				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...
4458
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4459
				}
4460
				break;
4461
4462
		}
4463
4464
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4465
4466
		if ( ! empty( $deactivated_plugins ) ) {
4467
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4468
			$deactivated_titles  = array();
4469
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4470
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4471
					continue;
4472
				}
4473
4474
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4475
			}
4476
4477
			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...
4478
				if ( $this->message ) {
4479
					$this->message .= "<br /><br />\n";
4480
				}
4481
4482
				$this->message .= wp_sprintf(
4483
					_n(
4484
						'Jetpack contains the most recent version of the old %l plugin.',
4485
						'Jetpack contains the most recent versions of the old %l plugins.',
4486
						count( $deactivated_titles ),
4487
						'jetpack'
4488
					),
4489
					$deactivated_titles
4490
				);
4491
4492
				$this->message .= "<br />\n";
4493
4494
				$this->message .= _n(
4495
					'The old version has been deactivated and can be removed from your site.',
4496
					'The old versions have been deactivated and can be removed from your site.',
4497
					count( $deactivated_titles ),
4498
					'jetpack'
4499
				);
4500
			}
4501
		}
4502
4503
		$this->privacy_checks = self::state( 'privacy_checks' );
4504
4505
		if ( $this->message || $this->error || $this->privacy_checks ) {
4506
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4507
		}
4508
4509
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4510
	}
4511
4512
	function admin_notices() {
4513
4514
		if ( $this->error ) {
4515
			?>
4516
<div id="message" class="jetpack-message jetpack-err">
4517
	<div class="squeezer">
4518
		<h2>
4519
			<?php
4520
			echo wp_kses(
4521
				$this->error,
4522
				array(
4523
					'a'      => array( 'href' => array() ),
4524
					'small'  => true,
4525
					'code'   => true,
4526
					'strong' => true,
4527
					'br'     => true,
4528
					'b'      => true,
4529
				)
4530
			);
4531
			?>
4532
			</h2>
4533
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4534
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4535
<?php	endif; ?>
4536
	</div>
4537
</div>
4538
			<?php
4539
		}
4540
4541
		if ( $this->message ) {
4542
			?>
4543
<div id="message" class="jetpack-message">
4544
	<div class="squeezer">
4545
		<h2>
4546
			<?php
4547
			echo wp_kses(
4548
				$this->message,
4549
				array(
4550
					'strong' => array(),
4551
					'a'      => array( 'href' => true ),
4552
					'br'     => true,
4553
				)
4554
			);
4555
			?>
4556
			</h2>
4557
	</div>
4558
</div>
4559
			<?php
4560
		}
4561
4562
		if ( $this->privacy_checks ) :
4563
			$module_names = $module_slugs = array();
4564
4565
			$privacy_checks = explode( ',', $this->privacy_checks );
4566
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4567
			foreach ( $privacy_checks as $module_slug ) {
4568
				$module = self::get_module( $module_slug );
4569
				if ( ! $module ) {
4570
					continue;
4571
				}
4572
4573
				$module_slugs[] = $module_slug;
4574
				$module_names[] = "<strong>{$module['name']}</strong>";
4575
			}
4576
4577
			$module_slugs = join( ',', $module_slugs );
4578
			?>
4579
<div id="message" class="jetpack-message jetpack-err">
4580
	<div class="squeezer">
4581
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4582
		<p>
4583
			<?php
4584
			echo wp_kses(
4585
				wptexturize(
4586
					wp_sprintf(
4587
						_nx(
4588
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4589
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4590
							count( $privacy_checks ),
4591
							'%l = list of Jetpack module/feature names',
4592
							'jetpack'
4593
						),
4594
						$module_names
4595
					)
4596
				),
4597
				array( 'strong' => true )
4598
			);
4599
4600
			echo "\n<br />\n";
4601
4602
			echo wp_kses(
4603
				sprintf(
4604
					_nx(
4605
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4606
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4607
						count( $privacy_checks ),
4608
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4609
						'jetpack'
4610
					),
4611
					wp_nonce_url(
4612
						self::admin_url(
4613
							array(
4614
								'page'   => 'jetpack',
4615
								'action' => 'deactivate',
4616
								'module' => urlencode( $module_slugs ),
4617
							)
4618
						),
4619
						"jetpack_deactivate-$module_slugs"
4620
					),
4621
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4622
				),
4623
				array(
4624
					'a' => array(
4625
						'href'  => true,
4626
						'title' => true,
4627
					),
4628
				)
4629
			);
4630
			?>
4631
		</p>
4632
	</div>
4633
</div>
4634
			<?php
4635
endif;
4636
	}
4637
4638
	/**
4639
	 * We can't always respond to a signed XML-RPC request with a
4640
	 * helpful error message. In some circumstances, doing so could
4641
	 * leak information.
4642
	 *
4643
	 * Instead, track that the error occurred via a Jetpack_Option,
4644
	 * and send that data back in the heartbeat.
4645
	 * All this does is increment a number, but it's enough to find
4646
	 * trends.
4647
	 *
4648
	 * @param WP_Error $xmlrpc_error The error produced during
4649
	 *                               signature validation.
4650
	 */
4651
	function track_xmlrpc_error( $xmlrpc_error ) {
4652
		$code = is_wp_error( $xmlrpc_error )
4653
			? $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...
4654
			: 'should-not-happen';
4655
4656
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4657
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4658
			// No need to update the option if we already have
4659
			// this code stored.
4660
			return;
4661
		}
4662
		$xmlrpc_errors[ $code ] = true;
4663
4664
		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...
4665
	}
4666
4667
	/**
4668
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4669
	 */
4670
	function stat( $group, $detail ) {
4671
		if ( ! isset( $this->stats[ $group ] ) ) {
4672
			$this->stats[ $group ] = array();
4673
		}
4674
		$this->stats[ $group ][] = $detail;
4675
	}
4676
4677
	/**
4678
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4679
	 */
4680
	function do_stats( $method = '' ) {
4681
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4682
			foreach ( $this->stats as $group => $stats ) {
4683
				if ( is_array( $stats ) && count( $stats ) ) {
4684
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4685
					if ( 'server_side' === $method ) {
4686
						self::do_server_side_stat( $args );
4687
					} else {
4688
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4689
					}
4690
				}
4691
				unset( $this->stats[ $group ] );
4692
			}
4693
		}
4694
	}
4695
4696
	/**
4697
	 * Runs stats code for a one-off, server-side.
4698
	 *
4699
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4700
	 *
4701
	 * @return bool If it worked.
4702
	 */
4703
	static function do_server_side_stat( $args ) {
4704
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4705
		if ( is_wp_error( $response ) ) {
4706
			return false;
4707
		}
4708
4709
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4710
			return false;
4711
		}
4712
4713
		return true;
4714
	}
4715
4716
	/**
4717
	 * Builds the stats url.
4718
	 *
4719
	 * @param $args array|string The arguments to append to the URL.
4720
	 *
4721
	 * @return string The URL to be pinged.
4722
	 */
4723
	static function build_stats_url( $args ) {
4724
		$defaults = array(
4725
			'v'    => 'wpcom2',
4726
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4727
		);
4728
		$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...
4729
		/**
4730
		 * Filter the URL used as the Stats tracking pixel.
4731
		 *
4732
		 * @since 2.3.2
4733
		 *
4734
		 * @param string $url Base URL used as the Stats tracking pixel.
4735
		 */
4736
		$base_url = apply_filters(
4737
			'jetpack_stats_base_url',
4738
			'https://pixel.wp.com/g.gif'
4739
		);
4740
		$url      = add_query_arg( $args, $base_url );
4741
		return $url;
4742
	}
4743
4744
	/**
4745
	 * Get the role of the current user.
4746
	 *
4747
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4748
	 *
4749
	 * @access public
4750
	 * @static
4751
	 *
4752
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4753
	 */
4754
	public static function translate_current_user_to_role() {
4755
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4756
4757
		$roles = new Roles();
4758
		return $roles->translate_current_user_to_role();
4759
	}
4760
4761
	/**
4762
	 * Get the role of a particular user.
4763
	 *
4764
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4765
	 *
4766
	 * @access public
4767
	 * @static
4768
	 *
4769
	 * @param \WP_User $user User object.
4770
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4771
	 */
4772
	public static function translate_user_to_role( $user ) {
4773
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4774
4775
		$roles = new Roles();
4776
		return $roles->translate_user_to_role( $user );
4777
	}
4778
4779
	/**
4780
	 * Get the minimum capability for a role.
4781
	 *
4782
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4783
	 *
4784
	 * @access public
4785
	 * @static
4786
	 *
4787
	 * @param string $role Role name.
4788
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4789
	 */
4790
	public static function translate_role_to_cap( $role ) {
4791
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4792
4793
		$roles = new Roles();
4794
		return $roles->translate_role_to_cap( $role );
4795
	}
4796
4797
	/**
4798
	 * Sign a user role with the master access token.
4799
	 * If not specified, will default to the current user.
4800
	 *
4801
	 * @deprecated since 7.7
4802
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4803
	 *
4804
	 * @access public
4805
	 * @static
4806
	 *
4807
	 * @param string $role    User role.
4808
	 * @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...
4809
	 * @return string Signed user role.
4810
	 */
4811
	public static function sign_role( $role, $user_id = null ) {
4812
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4813
		return self::connection()->sign_role( $role, $user_id );
4814
	}
4815
4816
	/**
4817
	 * Builds a URL to the Jetpack connection auth page
4818
	 *
4819
	 * @since 3.9.5
4820
	 *
4821
	 * @param bool        $raw If true, URL will not be escaped.
4822
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4823
	 *                              If string, will be a custom redirect.
4824
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4825
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4826
	 *
4827
	 * @return string Connect URL
4828
	 */
4829
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4830
		$site_id    = Jetpack_Options::get_option( 'id' );
4831
		$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...
4832
4833
		if ( $register || ! $blog_token || ! $site_id ) {
4834
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4835
4836
			if ( ! empty( $redirect ) ) {
4837
				$url = add_query_arg(
4838
					'redirect',
4839
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4840
					$url
4841
				);
4842
			}
4843
4844
			if ( is_network_admin() ) {
4845
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4846
			}
4847
4848
			$calypso_env = self::get_calypso_env();
4849
4850
			if ( ! empty( $calypso_env ) ) {
4851
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4852
			}
4853
		} else {
4854
4855
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4856
			// because otherwise this logic can get us in to a loop.
4857
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4858
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4859
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4860
4861
				$response = Client::wpcom_json_api_request_as_blog(
4862
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4863
					'1.1'
4864
				);
4865
4866
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4867
4868
					// Generating a register URL instead to refresh the existing token
4869
					return $this->build_connect_url( $raw, $redirect, $from, true );
4870
				}
4871
			}
4872
4873
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
It seems like $redirect defined by parameter $redirect on line 4829 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...
4874
		}
4875
4876
		if ( $from ) {
4877
			$url = add_query_arg( 'from', $from, $url );
4878
		}
4879
4880
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4881
		/**
4882
		 * Filter the URL used when connecting a user to a WordPress.com account.
4883
		 *
4884
		 * @since 8.1.0
4885
		 *
4886
		 * @param string $url Connection URL.
4887
		 * @param bool   $raw If true, URL will not be escaped.
4888
		 */
4889
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
4890
	}
4891
4892
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4893
4894
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4895
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4896
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4897
4898
		if ( $iframe ) {
4899
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4900
		}
4901
4902
		$c8n = self::connection();
4903
		$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...
4904
4905
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4906
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4907
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4908
4909
		if ( $iframe ) {
4910
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4911
		}
4912
4913
		return $url;
4914
	}
4915
4916
	/**
4917
	 * Filters the connection URL parameter array.
4918
	 *
4919
	 * @param array $args default URL parameters used by the package.
4920
	 * @return array the modified URL arguments array.
4921
	 */
4922
	public static function filter_connect_request_body( $args ) {
4923
		if (
4924
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4925
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4926
		) {
4927
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4928
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4929
				? $gp_locale->slug
4930
				: '';
4931
		}
4932
4933
		$tracking        = new Tracking();
4934
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4935
4936
		$args = array_merge(
4937
			$args,
4938
			array(
4939
				'_ui' => $tracks_identity['_ui'],
4940
				'_ut' => $tracks_identity['_ut'],
4941
			)
4942
		);
4943
4944
		$calypso_env = self::get_calypso_env();
4945
4946
		if ( ! empty( $calypso_env ) ) {
4947
			$args['calypso_env'] = $calypso_env;
4948
		}
4949
4950
		return $args;
4951
	}
4952
4953
	/**
4954
	 * Filters the URL that will process the connection data. It can be different from the URL
4955
	 * that we send the user to after everything is done.
4956
	 *
4957
	 * @param String $processing_url the default redirect URL used by the package.
4958
	 * @return String the modified URL.
4959
	 */
4960
	public static function filter_connect_processing_url( $processing_url ) {
4961
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4962
		return $processing_url;
4963
	}
4964
4965
	/**
4966
	 * Filters the redirection URL that is used for connect requests. The redirect
4967
	 * URL should return the user back to the Jetpack console.
4968
	 *
4969
	 * @param String $redirect the default redirect URL used by the package.
4970
	 * @return String the modified URL.
4971
	 */
4972
	public static function filter_connect_redirect_url( $redirect ) {
4973
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4974
		$redirect           = $redirect
4975
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4976
			: $jetpack_admin_page;
4977
4978
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4979
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4980
		}
4981
4982
		return $redirect;
4983
	}
4984
4985
	/**
4986
	 * This action fires at the beginning of the Manager::authorize method.
4987
	 */
4988
	public static function authorize_starting() {
4989
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4990
		// Checking if site has been active/connected previously before recording unique connection.
4991
		if ( ! $jetpack_unique_connection ) {
4992
			// jetpack_unique_connection option has never been set.
4993
			$jetpack_unique_connection = array(
4994
				'connected'    => 0,
4995
				'disconnected' => 0,
4996
				'version'      => '3.6.1',
4997
			);
4998
4999
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
5000
5001
			// Track unique connection.
5002
			$jetpack = self::init();
5003
5004
			$jetpack->stat( 'connections', 'unique-connection' );
5005
			$jetpack->do_stats( 'server_side' );
5006
		}
5007
5008
		// Increment number of times connected.
5009
		$jetpack_unique_connection['connected'] += 1;
5010
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
5011
	}
5012
5013
	/**
5014
	 * This action fires at the end of the Manager::authorize method when a secondary user is
5015
	 * linked.
5016
	 */
5017
	public static function authorize_ending_linked() {
5018
		// Don't activate anything since we are just connecting a user.
5019
		self::state( 'message', 'linked' );
5020
	}
5021
5022
	/**
5023
	 * This action fires at the end of the Manager::authorize method when the master user is
5024
	 * authorized.
5025
	 *
5026
	 * @param array $data The request data.
5027
	 */
5028
	public static function authorize_ending_authorized( $data ) {
5029
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
5030
		self::invalidate_onboarding_token();
5031
5032
		// If redirect_uri is SSO, ensure SSO module is enabled.
5033
		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...
5034
5035
		/** This filter is documented in class.jetpack-cli.php */
5036
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
5037
5038
		$activate_sso = (
5039
			isset( $redirect_options['action'] ) &&
5040
			'jetpack-sso' === $redirect_options['action'] &&
5041
			$jetpack_start_enable_sso
5042
		);
5043
5044
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
5045
5046
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
5047
	}
5048
5049
	/**
5050
	 * Get our assumed site creation date.
5051
	 * Calculated based on the earlier date of either:
5052
	 * - Earliest admin user registration date.
5053
	 * - Earliest date of post of any post type.
5054
	 *
5055
	 * @since 7.2.0
5056
	 * @deprecated since 7.8.0
5057
	 *
5058
	 * @return string Assumed site creation date and time.
5059
	 */
5060
	public static function get_assumed_site_creation_date() {
5061
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
5062
		return self::connection()->get_assumed_site_creation_date();
5063
	}
5064
5065 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
5066
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
5067
5068
		if ( $activation_source_name ) {
5069
			$args['_as'] = urlencode( $activation_source_name );
5070
		}
5071
5072
		if ( $activation_source_keyword ) {
5073
			$args['_ak'] = urlencode( $activation_source_keyword );
5074
		}
5075
	}
5076
5077
	function build_reconnect_url( $raw = false ) {
5078
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
5079
		return $raw ? $url : esc_url( $url );
5080
	}
5081
5082
	public static function admin_url( $args = null ) {
5083
		$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...
5084
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5085
		return $url;
5086
	}
5087
5088
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5089
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5090
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5091
	}
5092
5093
	function dismiss_jetpack_notice() {
5094
5095
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5096
			return;
5097
		}
5098
5099
		switch ( $_GET['jetpack-notice'] ) {
5100
			case 'dismiss':
5101
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5102
5103
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5104
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5105
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5106
				}
5107
				break;
5108
		}
5109
	}
5110
5111
	public static function sort_modules( $a, $b ) {
5112
		if ( $a['sort'] == $b['sort'] ) {
5113
			return 0;
5114
		}
5115
5116
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5117
	}
5118
5119
	function ajax_recheck_ssl() {
5120
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5121
		$result = self::permit_ssl( true );
5122
		wp_send_json(
5123
			array(
5124
				'enabled' => $result,
5125
				'message' => get_transient( 'jetpack_https_test_message' ),
5126
			)
5127
		);
5128
	}
5129
5130
	/* Client API */
5131
5132
	/**
5133
	 * Returns the requested Jetpack API URL
5134
	 *
5135
	 * @deprecated since 7.7
5136
	 * @return string
5137
	 */
5138
	public static function api_url( $relative_url ) {
5139
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5140
		$connection = self::connection();
5141
		return $connection->api_url( $relative_url );
5142
	}
5143
5144
	/**
5145
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5146
	 *
5147
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5148
	 */
5149
	public static function fix_url_for_bad_hosts( $url ) {
5150
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5151
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5152
	}
5153
5154
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5155
		// Default to a blog token.
5156
		$token_type = 'blog';
5157
5158
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5159
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5160
			if ( ! empty( $_GET['onboarding'] ) ) {
5161
				$jpo = $_GET;
5162
			} else {
5163
				$jpo = json_decode( $request_data, true );
5164
			}
5165
5166
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5167
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5168
5169
			if (
5170
				isset( $jpo_user )
5171
				&& isset( $jpo_token )
5172
				&& is_email( $jpo_user )
5173
				&& ctype_alnum( $jpo_token )
5174
				&& isset( $_GET['rest_route'] )
5175
				&& self::validate_onboarding_token_action(
5176
					$jpo_token,
5177
					$_GET['rest_route']
5178
				)
5179
			) {
5180
				$jp_user = get_user_by( 'email', $jpo_user );
5181
				if ( is_a( $jp_user, 'WP_User' ) ) {
5182
					wp_set_current_user( $jp_user->ID );
5183
					$user_can = is_multisite()
5184
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5185
						: current_user_can( 'manage_options' );
5186
					if ( $user_can ) {
5187
						$token_type              = 'user';
5188
						$token->external_user_id = $jp_user->ID;
5189
					}
5190
				}
5191
			}
5192
5193
			$token_data['type']    = $token_type;
5194
			$token_data['user_id'] = $token->external_user_id;
5195
		}
5196
5197
		return $token_data;
5198
	}
5199
5200
	/**
5201
	 * Create a random secret for validating onboarding payload
5202
	 *
5203
	 * @return string Secret token
5204
	 */
5205
	public static function create_onboarding_token() {
5206
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5207
			$token = wp_generate_password( 32, false );
5208
			Jetpack_Options::update_option( 'onboarding', $token );
5209
		}
5210
5211
		return $token;
5212
	}
5213
5214
	/**
5215
	 * Remove the onboarding token
5216
	 *
5217
	 * @return bool True on success, false on failure
5218
	 */
5219
	public static function invalidate_onboarding_token() {
5220
		return Jetpack_Options::delete_option( 'onboarding' );
5221
	}
5222
5223
	/**
5224
	 * Validate an onboarding token for a specific action
5225
	 *
5226
	 * @return boolean True if token/action pair is accepted, false if not
5227
	 */
5228
	public static function validate_onboarding_token_action( $token, $action ) {
5229
		// Compare tokens, bail if tokens do not match
5230
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5231
			return false;
5232
		}
5233
5234
		// List of valid actions we can take
5235
		$valid_actions = array(
5236
			'/jetpack/v4/settings',
5237
		);
5238
5239
		// Whitelist the action
5240
		if ( ! in_array( $action, $valid_actions ) ) {
5241
			return false;
5242
		}
5243
5244
		return true;
5245
	}
5246
5247
	/**
5248
	 * Checks to see if the URL is using SSL to connect with Jetpack
5249
	 *
5250
	 * @since 2.3.3
5251
	 * @return boolean
5252
	 */
5253
	public static function permit_ssl( $force_recheck = false ) {
5254
		// Do some fancy tests to see if ssl is being supported
5255
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5256
			$message = '';
5257
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5258
				$ssl = 0;
5259
			} else {
5260
				switch ( JETPACK_CLIENT__HTTPS ) {
5261
					case 'NEVER':
5262
						$ssl     = 0;
5263
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5264
						break;
5265
					case 'ALWAYS':
5266
					case 'AUTO':
5267
					default:
5268
						$ssl = 1;
5269
						break;
5270
				}
5271
5272
				// If it's not 'NEVER', test to see
5273
				if ( $ssl ) {
5274
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5275
						$ssl     = 0;
5276
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5277
					} else {
5278
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5279
						if ( is_wp_error( $response ) ) {
5280
							$ssl     = 0;
5281
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5282
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5283
							$ssl     = 0;
5284
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5285
						}
5286
					}
5287
				}
5288
			}
5289
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5290
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5291
		}
5292
5293
		return (bool) $ssl;
5294
	}
5295
5296
	/*
5297
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5298
	 */
5299
	public function alert_auto_ssl_fail() {
5300
		if ( ! current_user_can( 'manage_options' ) ) {
5301
			return;
5302
		}
5303
5304
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5305
		?>
5306
5307
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5308
			<div class="jp-banner__content">
5309
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5310
				<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>
5311
				<p>
5312
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5313
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5314
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5315
				</p>
5316
				<p>
5317
					<?php
5318
					printf(
5319
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5320
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5321
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5322
					);
5323
					?>
5324
				</p>
5325
			</div>
5326
		</div>
5327
		<style>
5328
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5329
		</style>
5330
		<script type="text/javascript">
5331
			jQuery( document ).ready( function( $ ) {
5332
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5333
					var $this = $( this );
5334
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5335
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5336
					e.preventDefault();
5337
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5338
					$.post( ajaxurl, data )
5339
					  .done( function( response ) {
5340
						  if ( response.enabled ) {
5341
							  $( '#jetpack-ssl-warning' ).hide();
5342
						  } else {
5343
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5344
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5345
						  }
5346
					  }.bind( $this ) );
5347
				} );
5348
			} );
5349
		</script>
5350
5351
		<?php
5352
	}
5353
5354
	/**
5355
	 * Returns the Jetpack XML-RPC API
5356
	 *
5357
	 * @deprecated 8.0 Use Connection_Manager instead.
5358
	 * @return string
5359
	 */
5360
	public static function xmlrpc_api_url() {
5361
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5362
		return self::connection()->xmlrpc_api_url();
5363
	}
5364
5365
	/**
5366
	 * Returns the connection manager object.
5367
	 *
5368
	 * @return Automattic\Jetpack\Connection\Manager
5369
	 */
5370
	public static function connection() {
5371
		$jetpack = static::init();
5372
5373
		// If the connection manager hasn't been instantiated, do that now.
5374
		if ( ! $jetpack->connection_manager ) {
5375
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5376
		}
5377
5378
		return $jetpack->connection_manager;
5379
	}
5380
5381
	/**
5382
	 * Creates two secret tokens and the end of life timestamp for them.
5383
	 *
5384
	 * Note these tokens are unique per call, NOT static per site for connecting.
5385
	 *
5386
	 * @since 2.6
5387
	 * @param String  $action  The action name.
5388
	 * @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...
5389
	 * @param Integer $exp     Expiration time in seconds.
5390
	 * @return array
5391
	 */
5392
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5393
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5394
	}
5395
5396
	public static function get_secrets( $action, $user_id ) {
5397
		$secrets = self::connection()->get_secrets( $action, $user_id );
5398
5399
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5400
			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...
5401
		}
5402
5403
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5404
			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...
5405
		}
5406
5407
		return $secrets;
5408
	}
5409
5410
	/**
5411
	 * @deprecated 7.5 Use Connection_Manager instead.
5412
	 *
5413
	 * @param $action
5414
	 * @param $user_id
5415
	 */
5416
	public static function delete_secrets( $action, $user_id ) {
5417
		return self::connection()->delete_secrets( $action, $user_id );
5418
	}
5419
5420
	/**
5421
	 * Builds the timeout limit for queries talking with the wpcom servers.
5422
	 *
5423
	 * Based on local php max_execution_time in php.ini
5424
	 *
5425
	 * @since 2.6
5426
	 * @return int
5427
	 * @deprecated
5428
	 **/
5429
	public function get_remote_query_timeout_limit() {
5430
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5431
		return self::get_max_execution_time();
5432
	}
5433
5434
	/**
5435
	 * Builds the timeout limit for queries talking with the wpcom servers.
5436
	 *
5437
	 * Based on local php max_execution_time in php.ini
5438
	 *
5439
	 * @since 5.4
5440
	 * @return int
5441
	 **/
5442
	public static function get_max_execution_time() {
5443
		$timeout = (int) ini_get( 'max_execution_time' );
5444
5445
		// Ensure exec time set in php.ini
5446
		if ( ! $timeout ) {
5447
			$timeout = 30;
5448
		}
5449
		return $timeout;
5450
	}
5451
5452
	/**
5453
	 * Sets a minimum request timeout, and returns the current timeout
5454
	 *
5455
	 * @since 5.4
5456
	 **/
5457 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5458
		$timeout = self::get_max_execution_time();
5459
		if ( $timeout < $min_timeout ) {
5460
			$timeout = $min_timeout;
5461
			set_time_limit( $timeout );
5462
		}
5463
		return $timeout;
5464
	}
5465
5466
	/**
5467
	 * Takes the response from the Jetpack register new site endpoint and
5468
	 * verifies it worked properly.
5469
	 *
5470
	 * @since 2.6
5471
	 * @deprecated since 7.7.0
5472
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5473
	 **/
5474
	public function validate_remote_register_response() {
5475
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5476
	}
5477
5478
	/**
5479
	 * @return bool|WP_Error
5480
	 */
5481
	public static function register() {
5482
		$tracking = new Tracking();
5483
		$tracking->record_user_event( 'jpc_register_begin' );
5484
5485
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5486
5487
		$connection   = self::connection();
5488
		$registration = $connection->register();
5489
5490
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5491
5492
		if ( ! $registration || is_wp_error( $registration ) ) {
5493
			return $registration;
5494
		}
5495
5496
		return true;
5497
	}
5498
5499
	/**
5500
	 * Filters the registration request body to include tracking properties.
5501
	 *
5502
	 * @param array $properties
5503
	 * @return array amended properties.
5504
	 */
5505 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5506
		$tracking        = new Tracking();
5507
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5508
5509
		return array_merge(
5510
			$properties,
5511
			array(
5512
				'_ui' => $tracks_identity['_ui'],
5513
				'_ut' => $tracks_identity['_ut'],
5514
			)
5515
		);
5516
	}
5517
5518
	/**
5519
	 * Filters the token request body to include tracking properties.
5520
	 *
5521
	 * @param array $properties
5522
	 * @return array amended properties.
5523
	 */
5524 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5525
		$tracking        = new Tracking();
5526
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5527
5528
		return array_merge(
5529
			$properties,
5530
			array(
5531
				'_ui' => $tracks_identity['_ui'],
5532
				'_ut' => $tracks_identity['_ut'],
5533
			)
5534
		);
5535
	}
5536
5537
	/**
5538
	 * If the db version is showing something other that what we've got now, bump it to current.
5539
	 *
5540
	 * @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...
5541
	 */
5542
	public static function maybe_set_version_option() {
5543
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5544
		if ( JETPACK__VERSION != $version ) {
5545
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5546
5547
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5548
				/** This action is documented in class.jetpack.php */
5549
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5550
			}
5551
5552
			return true;
5553
		}
5554
		return false;
5555
	}
5556
5557
	/* Client Server API */
5558
5559
	/**
5560
	 * Loads the Jetpack XML-RPC client.
5561
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5562
	 *
5563
	 * @deprecated since 7.7.0
5564
	 */
5565
	public static function load_xml_rpc_client() {
5566
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5567
	}
5568
5569
	/**
5570
	 * Resets the saved authentication state in between testing requests.
5571
	 */
5572
	public function reset_saved_auth_state() {
5573
		$this->rest_authentication_status = null;
5574
5575
		if ( ! $this->connection_manager ) {
5576
			$this->connection_manager = new Connection_Manager();
5577
		}
5578
5579
		$this->connection_manager->reset_saved_auth_state();
5580
	}
5581
5582
	/**
5583
	 * Verifies the signature of the current request.
5584
	 *
5585
	 * @deprecated since 7.7.0
5586
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5587
	 *
5588
	 * @return false|array
5589
	 */
5590
	public function verify_xml_rpc_signature() {
5591
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5592
		return self::connection()->verify_xml_rpc_signature();
5593
	}
5594
5595
	/**
5596
	 * Verifies the signature of the current request.
5597
	 *
5598
	 * This function has side effects and should not be used. Instead,
5599
	 * use the memoized version `->verify_xml_rpc_signature()`.
5600
	 *
5601
	 * @deprecated since 7.7.0
5602
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5603
	 * @internal
5604
	 */
5605
	private function internal_verify_xml_rpc_signature() {
5606
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5607
	}
5608
5609
	/**
5610
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5611
	 *
5612
	 * @deprecated since 7.7.0
5613
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5614
	 *
5615
	 * @param \WP_User|mixed $user     User object if authenticated.
5616
	 * @param string         $username Username.
5617
	 * @param string         $password Password string.
5618
	 * @return \WP_User|mixed Authenticated user or error.
5619
	 */
5620 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5621
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5622
5623
		if ( ! $this->connection_manager ) {
5624
			$this->connection_manager = new Connection_Manager();
5625
		}
5626
5627
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5628
	}
5629
5630
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5631
	// Uses the existing XMLRPC request signing implementation.
5632
	function wp_rest_authenticate( $user ) {
5633
		if ( ! empty( $user ) ) {
5634
			// Another authentication method is in effect.
5635
			return $user;
5636
		}
5637
5638
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5639
			// Nothing to do for this authentication method.
5640
			return null;
5641
		}
5642
5643
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5644
			// Nothing to do for this authentication method.
5645
			return null;
5646
		}
5647
5648
		// Ensure that we always have the request body available.  At this
5649
		// point, the WP REST API code to determine the request body has not
5650
		// run yet.  That code may try to read from 'php://input' later, but
5651
		// this can only be done once per request in PHP versions prior to 5.6.
5652
		// So we will go ahead and perform this read now if needed, and save
5653
		// the request body where both the Jetpack signature verification code
5654
		// and the WP REST API code can see it.
5655
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5656
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5657
		}
5658
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5659
5660
		// Only support specific request parameters that have been tested and
5661
		// are known to work with signature verification.  A different method
5662
		// can be passed to the WP REST API via the '?_method=' parameter if
5663
		// needed.
5664
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5665
			$this->rest_authentication_status = new WP_Error(
5666
				'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...
5667
				__( 'This request method is not supported.', 'jetpack' ),
5668
				array( 'status' => 400 )
5669
			);
5670
			return null;
5671
		}
5672
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5673
			$this->rest_authentication_status = new WP_Error(
5674
				'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...
5675
				__( 'This request method does not support body parameters.', 'jetpack' ),
5676
				array( 'status' => 400 )
5677
			);
5678
			return null;
5679
		}
5680
5681
		if ( ! $this->connection_manager ) {
5682
			$this->connection_manager = new Connection_Manager();
5683
		}
5684
5685
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5686
5687
		if (
5688
			$verified &&
5689
			isset( $verified['type'] ) &&
5690
			'user' === $verified['type'] &&
5691
			! empty( $verified['user_id'] )
5692
		) {
5693
			// Authentication successful.
5694
			$this->rest_authentication_status = true;
5695
			return $verified['user_id'];
5696
		}
5697
5698
		// Something else went wrong.  Probably a signature error.
5699
		$this->rest_authentication_status = new WP_Error(
5700
			'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...
5701
			__( 'The request is not signed correctly.', 'jetpack' ),
5702
			array( 'status' => 400 )
5703
		);
5704
		return null;
5705
	}
5706
5707
	/**
5708
	 * Report authentication status to the WP REST API.
5709
	 *
5710
	 * @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...
5711
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5712
	 */
5713
	public function wp_rest_authentication_errors( $value ) {
5714
		if ( $value !== null ) {
5715
			return $value;
5716
		}
5717
		return $this->rest_authentication_status;
5718
	}
5719
5720
	/**
5721
	 * Add our nonce to this request.
5722
	 *
5723
	 * @deprecated since 7.7.0
5724
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5725
	 *
5726
	 * @param int    $timestamp Timestamp of the request.
5727
	 * @param string $nonce     Nonce string.
5728
	 */
5729 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5730
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5731
5732
		if ( ! $this->connection_manager ) {
5733
			$this->connection_manager = new Connection_Manager();
5734
		}
5735
5736
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5737
	}
5738
5739
	/**
5740
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5741
	 * Capture it here so we can verify the signature later.
5742
	 *
5743
	 * @deprecated since 7.7.0
5744
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5745
	 *
5746
	 * @param array $methods XMLRPC methods.
5747
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5748
	 */
5749 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5750
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5751
5752
		if ( ! $this->connection_manager ) {
5753
			$this->connection_manager = new Connection_Manager();
5754
		}
5755
5756
		return $this->connection_manager->xmlrpc_methods( $methods );
5757
	}
5758
5759
	/**
5760
	 * Register additional public XMLRPC methods.
5761
	 *
5762
	 * @deprecated since 7.7.0
5763
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5764
	 *
5765
	 * @param array $methods Public XMLRPC methods.
5766
	 * @return array Public XMLRPC methods, with the getOptions one.
5767
	 */
5768 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5769
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5770
5771
		if ( ! $this->connection_manager ) {
5772
			$this->connection_manager = new Connection_Manager();
5773
		}
5774
5775
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5776
	}
5777
5778
	/**
5779
	 * Handles a getOptions XMLRPC method call.
5780
	 *
5781
	 * @deprecated since 7.7.0
5782
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5783
	 *
5784
	 * @param array $args method call arguments.
5785
	 * @return array an amended XMLRPC server options array.
5786
	 */
5787 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5788
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5789
5790
		if ( ! $this->connection_manager ) {
5791
			$this->connection_manager = new Connection_Manager();
5792
		}
5793
5794
		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...
5795
	}
5796
5797
	/**
5798
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5799
	 *
5800
	 * @deprecated since 7.7.0
5801
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5802
	 *
5803
	 * @param array $options Standard Core options.
5804
	 * @return array Amended options.
5805
	 */
5806 View Code Duplication
	public function xmlrpc_options( $options ) {
5807
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5808
5809
		if ( ! $this->connection_manager ) {
5810
			$this->connection_manager = new Connection_Manager();
5811
		}
5812
5813
		return $this->connection_manager->xmlrpc_options( $options );
5814
	}
5815
5816
	/**
5817
	 * Cleans nonces that were saved when calling ::add_nonce.
5818
	 *
5819
	 * @deprecated since 7.7.0
5820
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5821
	 *
5822
	 * @param bool $all whether to clean even non-expired nonces.
5823
	 */
5824
	public static function clean_nonces( $all = false ) {
5825
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5826
		return self::connection()->clean_nonces( $all );
5827
	}
5828
5829
	/**
5830
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5831
	 * SET: state( $key, $value );
5832
	 * GET: $value = state( $key );
5833
	 *
5834
	 * @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...
5835
	 * @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...
5836
	 * @param bool   $restate private
5837
	 */
5838
	public static function state( $key = null, $value = null, $restate = false ) {
5839
		static $state = array();
5840
		static $path, $domain;
5841
		if ( ! isset( $path ) ) {
5842
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5843
			$admin_url = self::admin_url();
5844
			$bits      = wp_parse_url( $admin_url );
5845
5846
			if ( is_array( $bits ) ) {
5847
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5848
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5849
			} else {
5850
				$path = $domain = null;
5851
			}
5852
		}
5853
5854
		// Extract state from cookies and delete cookies
5855
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5856
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5857
			unset( $_COOKIE['jetpackState'] );
5858
			foreach ( $yum as $k => $v ) {
5859
				if ( strlen( $v ) ) {
5860
					$state[ $k ] = $v;
5861
				}
5862
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5863
			}
5864
		}
5865
5866
		if ( $restate ) {
5867
			foreach ( $state as $k => $v ) {
5868
				if ( 'message_content' !== $k ) {
5869
					setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5870
				}
5871
			}
5872
			return;
5873
		}
5874
5875
		// Get a state variable.
5876
		if ( isset( $key ) && ! isset( $value ) ) {
5877
			if ( array_key_exists( $key, $state ) ) {
5878
				return $state[ $key ];
5879
			}
5880
			return null;
5881
		}
5882
5883
		// Set a state variable.
5884
		if ( isset( $key ) && isset( $value ) ) {
5885
			if ( is_array( $value ) && isset( $value[0] ) ) {
5886
				$value = $value[0];
5887
			}
5888
			$state[ $key ] = $value;
5889
			if ( 'message_content' !== $key && ! headers_sent() ) {
5890
				setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5891
			}
5892
		}
5893
	}
5894
5895
	public static function restate() {
5896
		self::state( null, null, true );
5897
	}
5898
5899
	public static function check_privacy( $file ) {
5900
		static $is_site_publicly_accessible = null;
5901
5902
		if ( is_null( $is_site_publicly_accessible ) ) {
5903
			$is_site_publicly_accessible = false;
5904
5905
			$rpc = new Jetpack_IXR_Client();
5906
5907
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5908
			if ( $success ) {
5909
				$response = $rpc->getResponse();
5910
				if ( $response ) {
5911
					$is_site_publicly_accessible = true;
5912
				}
5913
			}
5914
5915
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5916
		}
5917
5918
		if ( $is_site_publicly_accessible ) {
5919
			return;
5920
		}
5921
5922
		$module_slug = self::get_module_slug( $file );
5923
5924
		$privacy_checks = self::state( 'privacy_checks' );
5925
		if ( ! $privacy_checks ) {
5926
			$privacy_checks = $module_slug;
5927
		} else {
5928
			$privacy_checks .= ",$module_slug";
5929
		}
5930
5931
		self::state( 'privacy_checks', $privacy_checks );
5932
	}
5933
5934
	/**
5935
	 * Helper method for multicall XMLRPC.
5936
	 *
5937
	 * @param ...$args Args for the async_call.
5938
	 */
5939
	public static function xmlrpc_async_call( ...$args ) {
5940
		global $blog_id;
5941
		static $clients = array();
5942
5943
		$client_blog_id = is_multisite() ? $blog_id : 0;
5944
5945
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5946
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5947
			if ( function_exists( 'ignore_user_abort' ) ) {
5948
				ignore_user_abort( true );
5949
			}
5950
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5951
		}
5952
5953
		if ( ! empty( $args[0] ) ) {
5954
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5955
		} elseif ( is_multisite() ) {
5956
			foreach ( $clients as $client_blog_id => $client ) {
5957
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5958
					continue;
5959
				}
5960
5961
				$switch_success = switch_to_blog( $client_blog_id, true );
5962
				if ( ! $switch_success ) {
5963
					continue;
5964
				}
5965
5966
				flush();
5967
				$client->query();
5968
5969
				restore_current_blog();
5970
			}
5971
		} else {
5972
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5973
				flush();
5974
				$clients[0]->query();
5975
			}
5976
		}
5977
	}
5978
5979
	public static function staticize_subdomain( $url ) {
5980
5981
		// Extract hostname from URL
5982
		$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...
5983
5984
		// Explode hostname on '.'
5985
		$exploded_host = explode( '.', $host );
5986
5987
		// Retrieve the name and TLD
5988
		if ( count( $exploded_host ) > 1 ) {
5989
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5990
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5991
			// Rebuild domain excluding subdomains
5992
			$domain = $name . '.' . $tld;
5993
		} else {
5994
			$domain = $host;
5995
		}
5996
		// Array of Automattic domains
5997
		$domain_whitelist = array( 'wordpress.com', 'wp.com' );
5998
5999
		// Return $url if not an Automattic domain
6000
		if ( ! in_array( $domain, $domain_whitelist ) ) {
6001
			return $url;
6002
		}
6003
6004
		if ( is_ssl() ) {
6005
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
6006
		}
6007
6008
		srand( crc32( basename( $url ) ) );
6009
		$static_counter = rand( 0, 2 );
6010
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
6011
6012
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
6013
	}
6014
6015
	/* JSON API Authorization */
6016
6017
	/**
6018
	 * Handles the login action for Authorizing the JSON API
6019
	 */
6020
	function login_form_json_api_authorization() {
6021
		$this->verify_json_api_authorization_request();
6022
6023
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
6024
6025
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
6026
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6027
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6028
	}
6029
6030
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6031
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6032
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6033
			return $url;
6034
		}
6035
6036
		$parsed_url = wp_parse_url( $url );
6037
		$url        = strtok( $url, '?' );
6038
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
6039
		if ( ! empty( $parsed_url['query'] ) ) {
6040
			$url .= "&{$parsed_url['query']}";
6041
		}
6042
6043
		return $url;
6044
	}
6045
6046
	// Make sure the POSTed request is handled by the same action
6047
	function preserve_action_in_login_form_for_json_api_authorization() {
6048
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6049
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6050
	}
6051
6052
	// If someone logs in to approve API access, store the Access Code in usermeta
6053
	function store_json_api_authorization_token( $user_login, $user ) {
6054
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6055
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6056
		$token = wp_generate_password( 32, false );
6057
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6058
	}
6059
6060
	// Add public-api.wordpress.com to the safe redirect whitelist - only added when someone allows API access
6061
	function allow_wpcom_public_api_domain( $domains ) {
6062
		$domains[] = 'public-api.wordpress.com';
6063
		return $domains;
6064
	}
6065
6066
	static function is_redirect_encoded( $redirect_url ) {
6067
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
6068
	}
6069
6070
	// Add all wordpress.com environments to the safe redirect whitelist
6071
	function allow_wpcom_environments( $domains ) {
6072
		$domains[] = 'wordpress.com';
6073
		$domains[] = 'wpcalypso.wordpress.com';
6074
		$domains[] = 'horizon.wordpress.com';
6075
		$domains[] = 'calypso.localhost';
6076
		return $domains;
6077
	}
6078
6079
	// Add the Access Code details to the public-api.wordpress.com redirect
6080
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6081
		return add_query_arg(
6082
			urlencode_deep(
6083
				array(
6084
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6085
					'jetpack-user-id' => (int) $user->ID,
6086
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6087
				)
6088
			),
6089
			$redirect_to
6090
		);
6091
	}
6092
6093
6094
	/**
6095
	 * Verifies the request by checking the signature
6096
	 *
6097
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6098
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6099
	 *
6100
	 * @param null|array $environment
6101
	 */
6102
	function verify_json_api_authorization_request( $environment = null ) {
6103
		$environment = is_null( $environment )
6104
			? $_REQUEST
6105
			: $environment;
6106
6107
		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...
6108
		$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...
6109
		if ( ! $token || empty( $token->secret ) ) {
6110
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6111
		}
6112
6113
		$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' );
6114
6115
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6116
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6117
			/**
6118
			 * Jetpack authorisation request Error.
6119
			 *
6120
			 * @since 7.5.0
6121
			 */
6122
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6123
			$die_error = sprintf(
6124
				/* translators: %s is a URL */
6125
				__( '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' ),
6126
				Redirect::get_url( 'jetpack-support-double-encoding' )
6127
			);
6128
		}
6129
6130
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6131
6132
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6133
			$signature = $jetpack_signature->sign_request(
6134
				$environment['token'],
6135
				$environment['timestamp'],
6136
				$environment['nonce'],
6137
				'',
6138
				'GET',
6139
				$environment['jetpack_json_api_original_query'],
6140
				null,
6141
				true
6142
			);
6143
		} else {
6144
			$signature = $jetpack_signature->sign_current_request(
6145
				array(
6146
					'body'   => null,
6147
					'method' => 'GET',
6148
				)
6149
			);
6150
		}
6151
6152
		if ( ! $signature ) {
6153
			wp_die( $die_error );
6154
		} elseif ( is_wp_error( $signature ) ) {
6155
			wp_die( $die_error );
6156
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6157
			if ( is_ssl() ) {
6158
				// 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
6159
				$signature = $jetpack_signature->sign_current_request(
6160
					array(
6161
						'scheme' => 'http',
6162
						'body'   => null,
6163
						'method' => 'GET',
6164
					)
6165
				);
6166
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6167
					wp_die( $die_error );
6168
				}
6169
			} else {
6170
				wp_die( $die_error );
6171
			}
6172
		}
6173
6174
		$timestamp = (int) $environment['timestamp'];
6175
		$nonce     = stripslashes( (string) $environment['nonce'] );
6176
6177
		if ( ! $this->connection_manager ) {
6178
			$this->connection_manager = new Connection_Manager();
6179
		}
6180
6181
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6182
			// De-nonce the nonce, at least for 5 minutes.
6183
			// 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)
6184
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6185
			if ( $old_nonce_time < time() - 300 ) {
6186
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6187
			}
6188
		}
6189
6190
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6191
		$data_filters = array(
6192
			'state'        => 'opaque',
6193
			'client_id'    => 'int',
6194
			'client_title' => 'string',
6195
			'client_image' => 'url',
6196
		);
6197
6198
		foreach ( $data_filters as $key => $sanitation ) {
6199
			if ( ! isset( $data->$key ) ) {
6200
				wp_die( $die_error );
6201
			}
6202
6203
			switch ( $sanitation ) {
6204
				case 'int':
6205
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6206
					break;
6207
				case 'opaque':
6208
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6209
					break;
6210
				case 'string':
6211
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6212
					break;
6213
				case 'url':
6214
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6215
					break;
6216
			}
6217
		}
6218
6219
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6220
			wp_die( $die_error );
6221
		}
6222
	}
6223
6224
	function login_message_json_api_authorization( $message ) {
6225
		return '<p class="message">' . sprintf(
6226
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6227
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6228
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6229
	}
6230
6231
	/**
6232
	 * Get $content_width, but with a <s>twist</s> filter.
6233
	 */
6234
	public static function get_content_width() {
6235
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6236
			? $GLOBALS['content_width']
6237
			: false;
6238
		/**
6239
		 * Filter the Content Width value.
6240
		 *
6241
		 * @since 2.2.3
6242
		 *
6243
		 * @param string $content_width Content Width value.
6244
		 */
6245
		return apply_filters( 'jetpack_content_width', $content_width );
6246
	}
6247
6248
	/**
6249
	 * Pings the WordPress.com Mirror Site for the specified options.
6250
	 *
6251
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6252
	 *
6253
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6254
	 */
6255
	public function get_cloud_site_options( $option_names ) {
6256
		$option_names = array_filter( (array) $option_names, 'is_string' );
6257
6258
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6259
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6260
		if ( $xml->isError() ) {
6261
			return array(
6262
				'error_code' => $xml->getErrorCode(),
6263
				'error_msg'  => $xml->getErrorMessage(),
6264
			);
6265
		}
6266
		$cloud_site_options = $xml->getResponse();
6267
6268
		return $cloud_site_options;
6269
	}
6270
6271
	/**
6272
	 * Checks if the site is currently in an identity crisis.
6273
	 *
6274
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6275
	 */
6276
	public static function check_identity_crisis() {
6277
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6278
			return false;
6279
		}
6280
6281
		return Jetpack_Options::get_option( 'sync_error_idc' );
6282
	}
6283
6284
	/**
6285
	 * Checks whether the home and siteurl specifically are whitelisted
6286
	 * Written so that we don't have re-check $key and $value params every time
6287
	 * we want to check if this site is whitelisted, for example in footer.php
6288
	 *
6289
	 * @since  3.8.0
6290
	 * @return bool True = already whitelisted False = not whitelisted
6291
	 */
6292
	public static function is_staging_site() {
6293
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6294
		return ( new Status() )->is_staging_site();
6295
	}
6296
6297
	/**
6298
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6299
	 *
6300
	 * @since 4.4.0
6301
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6302
	 *
6303
	 * @return bool
6304
	 */
6305
	public static function validate_sync_error_idc_option() {
6306
		$is_valid = false;
6307
6308
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6309
		if ( false === $idc_allowed ) {
6310
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6311
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6312
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6313
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6314
				$transient_duration = HOUR_IN_SECONDS;
6315
			} else {
6316
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6317
				$idc_allowed        = '1';
6318
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6319
			}
6320
6321
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6322
		}
6323
6324
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6325
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6326
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6327
			$local_options = self::get_sync_error_idc_option();
6328
			// Ensure all values are set.
6329
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6330
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6331
					$is_valid = true;
6332
				}
6333
			}
6334
		}
6335
6336
		/**
6337
		 * Filters whether the sync_error_idc option is valid.
6338
		 *
6339
		 * @since 4.4.0
6340
		 *
6341
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6342
		 */
6343
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6344
6345
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6346
			// Since the option exists, and did not validate, delete it
6347
			Jetpack_Options::delete_option( 'sync_error_idc' );
6348
		}
6349
6350
		return $is_valid;
6351
	}
6352
6353
	/**
6354
	 * Normalizes a url by doing three things:
6355
	 *  - Strips protocol
6356
	 *  - Strips www
6357
	 *  - Adds a trailing slash
6358
	 *
6359
	 * @since 4.4.0
6360
	 * @param string $url
6361
	 * @return WP_Error|string
6362
	 */
6363
	public static function normalize_url_protocol_agnostic( $url ) {
6364
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6365
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6366
			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...
6367
		}
6368
6369
		// Strip www and protocols
6370
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6371
		return $url;
6372
	}
6373
6374
	/**
6375
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6376
	 *
6377
	 * @since 4.4.0
6378
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6379
	 *
6380
	 * @param array $response
6381
	 * @return array Array of the local urls, wpcom urls, and error code
6382
	 */
6383
	public static function get_sync_error_idc_option( $response = array() ) {
6384
		// Since the local options will hit the database directly, store the values
6385
		// in a transient to allow for autoloading and caching on subsequent views.
6386
		$local_options = get_transient( 'jetpack_idc_local' );
6387
		if ( false === $local_options ) {
6388
			$local_options = array(
6389
				'home'    => Functions::home_url(),
6390
				'siteurl' => Functions::site_url(),
6391
			);
6392
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6393
		}
6394
6395
		$options = array_merge( $local_options, $response );
6396
6397
		$returned_values = array();
6398
		foreach ( $options as $key => $option ) {
6399
			if ( 'error_code' === $key ) {
6400
				$returned_values[ $key ] = $option;
6401
				continue;
6402
			}
6403
6404
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6405
				continue;
6406
			}
6407
6408
			$returned_values[ $key ] = $normalized_url;
6409
		}
6410
6411
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6412
6413
		return $returned_values;
6414
	}
6415
6416
	/**
6417
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6418
	 * If set to true, the site will be put into staging mode.
6419
	 *
6420
	 * @since 4.3.2
6421
	 * @return bool
6422
	 */
6423
	public static function sync_idc_optin() {
6424
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6425
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6426
		} else {
6427
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6428
		}
6429
6430
		/**
6431
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6432
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6433
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6434
		 *
6435
		 * @since 4.3.2
6436
		 *
6437
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6438
		 */
6439
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6440
	}
6441
6442
	/**
6443
	 * Maybe Use a .min.css stylesheet, maybe not.
6444
	 *
6445
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6446
	 */
6447
	public static function maybe_min_asset( $url, $path, $plugin ) {
6448
		// Short out on things trying to find actual paths.
6449
		if ( ! $path || empty( $plugin ) ) {
6450
			return $url;
6451
		}
6452
6453
		$path = ltrim( $path, '/' );
6454
6455
		// Strip out the abspath.
6456
		$base = dirname( plugin_basename( $plugin ) );
6457
6458
		// Short out on non-Jetpack assets.
6459
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6460
			return $url;
6461
		}
6462
6463
		// File name parsing.
6464
		$file              = "{$base}/{$path}";
6465
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6466
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6467
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6468
		$extension         = array_shift( $file_name_parts_r );
6469
6470
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6471
			// Already pointing at the minified version.
6472
			if ( 'min' === $file_name_parts_r[0] ) {
6473
				return $url;
6474
			}
6475
6476
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6477
			if ( file_exists( $min_full_path ) ) {
6478
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6479
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6480
				if ( 'css' === $extension ) {
6481
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6482
					self::$min_assets[ $key ] = $path;
6483
				}
6484
			}
6485
		}
6486
6487
		return $url;
6488
	}
6489
6490
	/**
6491
	 * If the asset is minified, let's flag .min as the suffix.
6492
	 *
6493
	 * Attached to `style_loader_src` filter.
6494
	 *
6495
	 * @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...
6496
	 * @param string $handle The registered handle of the script in question.
6497
	 * @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...
6498
	 */
6499
	public static function set_suffix_on_min( $src, $handle ) {
6500
		if ( false === strpos( $src, '.min.css' ) ) {
6501
			return $src;
6502
		}
6503
6504
		if ( ! empty( self::$min_assets ) ) {
6505
			foreach ( self::$min_assets as $file => $path ) {
6506
				if ( false !== strpos( $src, $file ) ) {
6507
					wp_style_add_data( $handle, 'suffix', '.min' );
6508
					return $src;
6509
				}
6510
			}
6511
		}
6512
6513
		return $src;
6514
	}
6515
6516
	/**
6517
	 * Maybe inlines a stylesheet.
6518
	 *
6519
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6520
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6521
	 *
6522
	 * Attached to `style_loader_tag` filter.
6523
	 *
6524
	 * @param string $tag The tag that would link to the external asset.
6525
	 * @param string $handle The registered handle of the script in question.
6526
	 *
6527
	 * @return string
6528
	 */
6529
	public static function maybe_inline_style( $tag, $handle ) {
6530
		global $wp_styles;
6531
		$item = $wp_styles->registered[ $handle ];
6532
6533
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6534
			return $tag;
6535
		}
6536
6537
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6538
			$href = $matches[1];
6539
			// Strip off query string
6540
			if ( $pos = strpos( $href, '?' ) ) {
6541
				$href = substr( $href, 0, $pos );
6542
			}
6543
			// Strip off fragment
6544
			if ( $pos = strpos( $href, '#' ) ) {
6545
				$href = substr( $href, 0, $pos );
6546
			}
6547
		} else {
6548
			return $tag;
6549
		}
6550
6551
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6552
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6553
			return $tag;
6554
		}
6555
6556
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6557
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6558
			// And this isn't the pass that actually deals with the RTL version...
6559
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6560
				// Short out, as the RTL version will deal with it in a moment.
6561
				return $tag;
6562
			}
6563
		}
6564
6565
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6566
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6567
		if ( $css ) {
6568
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6569
			if ( empty( $item->extra['after'] ) ) {
6570
				wp_add_inline_style( $handle, $css );
6571
			} else {
6572
				array_unshift( $item->extra['after'], $css );
6573
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6574
			}
6575
		}
6576
6577
		return $tag;
6578
	}
6579
6580
	/**
6581
	 * Loads a view file from the views
6582
	 *
6583
	 * Data passed in with the $data parameter will be available in the
6584
	 * template file as $data['value']
6585
	 *
6586
	 * @param string $template - Template file to load
6587
	 * @param array  $data - Any data to pass along to the template
6588
	 * @return boolean - If template file was found
6589
	 **/
6590
	public function load_view( $template, $data = array() ) {
6591
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6592
6593
		if ( file_exists( $views_dir . $template ) ) {
6594
			require_once $views_dir . $template;
6595
			return true;
6596
		}
6597
6598
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6599
		return false;
6600
	}
6601
6602
	/**
6603
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6604
	 */
6605
	public function deprecated_hooks() {
6606
		global $wp_filter;
6607
6608
		/*
6609
		 * Format:
6610
		 * deprecated_filter_name => replacement_name
6611
		 *
6612
		 * If there is no replacement, use null for replacement_name
6613
		 */
6614
		$deprecated_list = array(
6615
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6616
			'wpl_sharing_2014_1'                           => null,
6617
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6618
			'jetpack_identity_crisis_options_to_check'     => null,
6619
			'update_option_jetpack_single_user_site'       => null,
6620
			'audio_player_default_colors'                  => null,
6621
			'add_option_jetpack_featured_images_enabled'   => null,
6622
			'add_option_jetpack_update_details'            => null,
6623
			'add_option_jetpack_updates'                   => null,
6624
			'add_option_jetpack_network_name'              => null,
6625
			'add_option_jetpack_network_allow_new_registrations' => null,
6626
			'add_option_jetpack_network_add_new_users'     => null,
6627
			'add_option_jetpack_network_site_upload_space' => null,
6628
			'add_option_jetpack_network_upload_file_types' => null,
6629
			'add_option_jetpack_network_enable_administration_menus' => null,
6630
			'add_option_jetpack_is_multi_site'             => null,
6631
			'add_option_jetpack_is_main_network'           => null,
6632
			'add_option_jetpack_main_network_site'         => null,
6633
			'jetpack_sync_all_registered_options'          => null,
6634
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6635
			'jetpack_is_post_mailable'                     => null,
6636
			'jetpack_seo_site_host'                        => null,
6637
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6638
			'jetpack_holiday_snow_option_name'             => null,
6639
			'jetpack_holiday_chance_of_snow'               => null,
6640
			'jetpack_holiday_snow_js_url'                  => null,
6641
			'jetpack_is_holiday_snow_season'               => null,
6642
			'jetpack_holiday_snow_option_updated'          => null,
6643
			'jetpack_holiday_snowing'                      => null,
6644
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6645
			'jetpack_cache_plans'                          => null,
6646
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6647
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6648
			'jetpack_enable_site_verification'             => null,
6649
			'can_display_jetpack_manage_notice'            => null,
6650
			// Removed in Jetpack 7.3.0
6651
			'atd_load_scripts'                             => null,
6652
			'atd_http_post_timeout'                        => null,
6653
			'atd_http_post_error'                          => null,
6654
			'atd_service_domain'                           => null,
6655
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6656
			// Removed in Jetpack 7.9.0
6657
			'jetpack_pwa_manifest'                         => null,
6658
			'jetpack_pwa_background_color'                 => null,
6659
			// Removed in Jetpack 8.3.0.
6660
			'jetpack_check_mobile'                         => null,
6661
			'jetpack_mobile_stylesheet'                    => null,
6662
			'jetpack_mobile_template'                      => null,
6663
			'mobile_reject_mobile'                         => null,
6664
			'mobile_force_mobile'                          => null,
6665
			'mobile_app_promo_download'                    => null,
6666
			'mobile_setup'                                 => null,
6667
			'jetpack_mobile_footer_before'                 => null,
6668
			'wp_mobile_theme_footer'                       => null,
6669
			'minileven_credits'                            => null,
6670
			'jetpack_mobile_header_before'                 => null,
6671
			'jetpack_mobile_header_after'                  => null,
6672
			'jetpack_mobile_theme_menu'                    => null,
6673
			'minileven_show_featured_images'               => null,
6674
			'minileven_attachment_size'                    => null,
6675
		);
6676
6677
		// This is a silly loop depth. Better way?
6678
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6679
			if ( has_action( $hook ) ) {
6680
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6681
					foreach ( $values as $hooked ) {
6682
						if ( is_callable( $hooked['function'] ) ) {
6683
							$function_name = $hooked['function'];
6684
						} else {
6685
							$function_name = 'an anonymous function';
6686
						}
6687
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6688
					}
6689
				}
6690
			}
6691
		}
6692
	}
6693
6694
	/**
6695
	 * Converts any url in a stylesheet, to the correct absolute url.
6696
	 *
6697
	 * Considerations:
6698
	 *  - Normal, relative URLs     `feh.png`
6699
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6700
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6701
	 *  - Absolute URLs             `http://domain.com/feh.png`
6702
	 *  - Domain root relative URLs `/feh.png`
6703
	 *
6704
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6705
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6706
	 *
6707
	 * @return mixed|string
6708
	 */
6709
	public static function absolutize_css_urls( $css, $css_file_url ) {
6710
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6711
		$css_dir = dirname( $css_file_url );
6712
		$p       = wp_parse_url( $css_dir );
6713
		$domain  = sprintf(
6714
			'%1$s//%2$s%3$s%4$s',
6715
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6716
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6717
			$p['host'],
6718
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6719
		);
6720
6721
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6722
			$find = $replace = array();
6723
			foreach ( $matches as $match ) {
6724
				$url = trim( $match['path'], "'\" \t" );
6725
6726
				// If this is a data url, we don't want to mess with it.
6727
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6728
					continue;
6729
				}
6730
6731
				// If this is an absolute or protocol-agnostic url,
6732
				// we don't want to mess with it.
6733
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6734
					continue;
6735
				}
6736
6737
				switch ( substr( $url, 0, 1 ) ) {
6738
					case '/':
6739
						$absolute = $domain . $url;
6740
						break;
6741
					default:
6742
						$absolute = $css_dir . '/' . $url;
6743
				}
6744
6745
				$find[]    = $match[0];
6746
				$replace[] = sprintf( 'url("%s")', $absolute );
6747
			}
6748
			$css = str_replace( $find, $replace, $css );
6749
		}
6750
6751
		return $css;
6752
	}
6753
6754
	/**
6755
	 * This methods removes all of the registered css files on the front end
6756
	 * from Jetpack in favor of using a single file. In effect "imploding"
6757
	 * all the files into one file.
6758
	 *
6759
	 * Pros:
6760
	 * - Uses only ONE css asset connection instead of 15
6761
	 * - Saves a minimum of 56k
6762
	 * - Reduces server load
6763
	 * - Reduces time to first painted byte
6764
	 *
6765
	 * Cons:
6766
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6767
	 *      should not cause any issues with themes.
6768
	 * - Plugins/themes dequeuing styles no longer do anything. See
6769
	 *      jetpack_implode_frontend_css filter for a workaround
6770
	 *
6771
	 * For some situations developers may wish to disable css imploding and
6772
	 * instead operate in legacy mode where each file loads seperately and
6773
	 * can be edited individually or dequeued. This can be accomplished with
6774
	 * the following line:
6775
	 *
6776
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6777
	 *
6778
	 * @since 3.2
6779
	 **/
6780
	public function implode_frontend_css( $travis_test = false ) {
6781
		$do_implode = true;
6782
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6783
			$do_implode = false;
6784
		}
6785
6786
		// Do not implode CSS when the page loads via the AMP plugin.
6787
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6788
			$do_implode = false;
6789
		}
6790
6791
		/**
6792
		 * Allow CSS to be concatenated into a single jetpack.css file.
6793
		 *
6794
		 * @since 3.2.0
6795
		 *
6796
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6797
		 */
6798
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6799
6800
		// Do not use the imploded file when default behavior was altered through the filter
6801
		if ( ! $do_implode ) {
6802
			return;
6803
		}
6804
6805
		// We do not want to use the imploded file in dev mode, or if not connected
6806
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6807
			if ( ! $travis_test ) {
6808
				return;
6809
			}
6810
		}
6811
6812
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6813
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6814
			return;
6815
		}
6816
6817
		/*
6818
		 * Now we assume Jetpack is connected and able to serve the single
6819
		 * file.
6820
		 *
6821
		 * In the future there will be a check here to serve the file locally
6822
		 * or potentially from the Jetpack CDN
6823
		 *
6824
		 * For now:
6825
		 * - Enqueue a single imploded css file
6826
		 * - Zero out the style_loader_tag for the bundled ones
6827
		 * - Be happy, drink scotch
6828
		 */
6829
6830
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6831
6832
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6833
6834
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6835
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6836
	}
6837
6838
	function concat_remove_style_loader_tag( $tag, $handle ) {
6839
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6840
			$tag = '';
6841
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6842
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6843
			}
6844
		}
6845
6846
		return $tag;
6847
	}
6848
6849
	/**
6850
	 * Add an async attribute to scripts that can be loaded asynchronously.
6851
	 * https://www.w3schools.com/tags/att_script_async.asp
6852
	 *
6853
	 * @since 7.7.0
6854
	 *
6855
	 * @param string $tag    The <script> tag for the enqueued script.
6856
	 * @param string $handle The script's registered handle.
6857
	 * @param string $src    The script's source URL.
6858
	 */
6859
	public function script_add_async( $tag, $handle, $src ) {
6860
		if ( in_array( $handle, $this->async_script_handles, true ) ) {
6861
			return preg_replace( '/^<script /i', '<script async ', $tag );
6862
		}
6863
6864
		return $tag;
6865
	}
6866
6867
	/*
6868
	 * Check the heartbeat data
6869
	 *
6870
	 * Organizes the heartbeat data by severity.  For example, if the site
6871
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6872
	 *
6873
	 * Data will be added to "caution" array, if it either:
6874
	 *  - Out of date Jetpack version
6875
	 *  - Out of date WP version
6876
	 *  - Out of date PHP version
6877
	 *
6878
	 * $return array $filtered_data
6879
	 */
6880
	public static function jetpack_check_heartbeat_data() {
6881
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6882
6883
		$good    = array();
6884
		$caution = array();
6885
		$bad     = array();
6886
6887
		foreach ( $raw_data as $stat => $value ) {
6888
6889
			// Check jetpack version
6890
			if ( 'version' == $stat ) {
6891
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6892
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6893
					continue;
6894
				}
6895
			}
6896
6897
			// Check WP version
6898
			if ( 'wp-version' == $stat ) {
6899
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6900
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6901
					continue;
6902
				}
6903
			}
6904
6905
			// Check PHP version
6906
			if ( 'php-version' == $stat ) {
6907
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6908
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6909
					continue;
6910
				}
6911
			}
6912
6913
			// Check ID crisis
6914
			if ( 'identitycrisis' == $stat ) {
6915
				if ( 'yes' == $value ) {
6916
					$bad[ $stat ] = $value;
6917
					continue;
6918
				}
6919
			}
6920
6921
			// The rest are good :)
6922
			$good[ $stat ] = $value;
6923
		}
6924
6925
		$filtered_data = array(
6926
			'good'    => $good,
6927
			'caution' => $caution,
6928
			'bad'     => $bad,
6929
		);
6930
6931
		return $filtered_data;
6932
	}
6933
6934
6935
	/*
6936
	 * This method is used to organize all options that can be reset
6937
	 * without disconnecting Jetpack.
6938
	 *
6939
	 * It is used in class.jetpack-cli.php to reset options
6940
	 *
6941
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6942
	 *
6943
	 * @return array of options to delete.
6944
	 */
6945
	public static function get_jetpack_options_for_reset() {
6946
		return Jetpack_Options::get_options_for_reset();
6947
	}
6948
6949
	/*
6950
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6951
	 * so we can bring them directly to their site in calypso.
6952
	 *
6953
	 * @param string | url
6954
	 * @return string | url without the guff
6955
	 */
6956 View Code Duplication
	public static function build_raw_urls( $url ) {
6957
		$strip_http = '/.*?:\/\//i';
6958
		$url        = preg_replace( $strip_http, '', $url );
6959
		$url        = str_replace( '/', '::', $url );
6960
		return $url;
6961
	}
6962
6963
	/**
6964
	 * Stores and prints out domains to prefetch for page speed optimization.
6965
	 *
6966
	 * @param mixed $new_urls
6967
	 */
6968
	public static function dns_prefetch( $new_urls = null ) {
6969
		static $prefetch_urls = array();
6970
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6971
			echo "\r\n";
6972
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6973
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6974
			}
6975
		} elseif ( ! empty( $new_urls ) ) {
6976
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6977
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6978
			}
6979
			foreach ( (array) $new_urls as $this_new_url ) {
6980
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6981
			}
6982
			$prefetch_urls = array_unique( $prefetch_urls );
6983
		}
6984
	}
6985
6986
	public function wp_dashboard_setup() {
6987
		if ( self::is_active() ) {
6988
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6989
		}
6990
6991
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6992
			$jetpack_logo = new Jetpack_Logo();
6993
			$widget_title = sprintf(
6994
				wp_kses(
6995
					/* translators: Placeholder is a Jetpack logo. */
6996
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6997
					array( 'span' => array() )
6998
				),
6999
				$jetpack_logo->get_jp_emblem( true )
7000
			);
7001
7002
			wp_add_dashboard_widget(
7003
				'jetpack_summary_widget',
7004
				$widget_title,
7005
				array( __CLASS__, 'dashboard_widget' )
7006
			);
7007
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
7008
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
7009
7010
			// If we're inactive and not in development mode, sort our box to the top.
7011
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
7012
				global $wp_meta_boxes;
7013
7014
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
7015
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
7016
7017
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7018
			}
7019
		}
7020
	}
7021
7022
	/**
7023
	 * @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...
7024
	 * @return mixed
7025
	 */
7026
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7027
		if ( ! is_array( $sorted ) ) {
7028
			return $sorted;
7029
		}
7030
7031
		foreach ( $sorted as $box_context => $ids ) {
7032
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7033
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7034
				continue;
7035
			}
7036
7037
			$ids_array = explode( ',', $ids );
7038
			$key       = array_search( 'dashboard_stats', $ids_array );
7039
7040
			if ( false !== $key ) {
7041
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7042
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7043
				$sorted[ $box_context ] = implode( ',', $ids_array );
7044
				// We've found it, stop searching, and just return.
7045
				break;
7046
			}
7047
		}
7048
7049
		return $sorted;
7050
	}
7051
7052
	public static function dashboard_widget() {
7053
		/**
7054
		 * Fires when the dashboard is loaded.
7055
		 *
7056
		 * @since 3.4.0
7057
		 */
7058
		do_action( 'jetpack_dashboard_widget' );
7059
	}
7060
7061
	public static function dashboard_widget_footer() {
7062
		?>
7063
		<footer>
7064
7065
		<div class="protect">
7066
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7067
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7068
				<p class="blocked-count">
7069
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7070
				</p>
7071
				<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>
7072
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
7073
				<a href="
7074
				<?php
7075
				echo esc_url(
7076
					wp_nonce_url(
7077
						self::admin_url(
7078
							array(
7079
								'action' => 'activate',
7080
								'module' => 'protect',
7081
							)
7082
						),
7083
						'jetpack_activate-protect'
7084
					)
7085
				);
7086
				?>
7087
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7088
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7089
				</a>
7090
			<?php else : ?>
7091
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7092
			<?php endif; ?>
7093
		</div>
7094
7095
		<div class="akismet">
7096
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7097
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7098
				<p class="blocked-count">
7099
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7100
				</p>
7101
				<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>
7102
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7103
				<a href="
7104
				<?php
7105
				echo esc_url(
7106
					wp_nonce_url(
7107
						add_query_arg(
7108
							array(
7109
								'action' => 'activate',
7110
								'plugin' => 'akismet/akismet.php',
7111
							),
7112
							admin_url( 'plugins.php' )
7113
						),
7114
						'activate-plugin_akismet/akismet.php'
7115
					)
7116
				);
7117
				?>
7118
							" class="button button-jetpack">
7119
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7120
				</a>
7121
			<?php else : ?>
7122
				<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>
7123
			<?php endif; ?>
7124
		</div>
7125
7126
		</footer>
7127
		<?php
7128
	}
7129
7130
	/*
7131
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7132
	 */
7133
	function jetpack_icon_user_connected( $columns ) {
7134
		$columns['user_jetpack'] = '';
7135
		return $columns;
7136
	}
7137
7138
	/*
7139
	 * Show Jetpack icon if the user is linked.
7140
	 */
7141
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7142
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7143
			$jetpack_logo = new Jetpack_Logo();
7144
			$emblem_html  = sprintf(
7145
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7146
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7147
				$jetpack_logo->get_jp_emblem()
7148
			);
7149
			return $emblem_html;
7150
		}
7151
7152
		return $val;
7153
	}
7154
7155
	/*
7156
	 * Style the Jetpack user column
7157
	 */
7158
	function jetpack_user_col_style() {
7159
		global $current_screen;
7160
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7161
			?>
7162
			<style>
7163
				.fixed .column-user_jetpack {
7164
					width: 21px;
7165
				}
7166
				.jp-emblem-user-admin svg {
7167
					width: 20px;
7168
					height: 20px;
7169
				}
7170
				.jp-emblem-user-admin path {
7171
					fill: #00BE28;
7172
				}
7173
			</style>
7174
			<?php
7175
		}
7176
	}
7177
7178
	/**
7179
	 * Checks if Akismet is active and working.
7180
	 *
7181
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7182
	 * that implied usage of methods present since more recent version.
7183
	 * See https://github.com/Automattic/jetpack/pull/9585
7184
	 *
7185
	 * @since  5.1.0
7186
	 *
7187
	 * @return bool True = Akismet available. False = Aksimet not available.
7188
	 */
7189
	public static function is_akismet_active() {
7190
		static $status = null;
7191
7192
		if ( ! is_null( $status ) ) {
7193
			return $status;
7194
		}
7195
7196
		// Check if a modern version of Akismet is active.
7197
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7198
			$status = false;
7199
			return $status;
7200
		}
7201
7202
		// Make sure there is a key known to Akismet at all before verifying key.
7203
		$akismet_key = Akismet::get_api_key();
7204
		if ( ! $akismet_key ) {
7205
			$status = false;
7206
			return $status;
7207
		}
7208
7209
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7210
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7211
7212
		// 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.
7213
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7214
		// We cache the result of the Akismet key verification for ten minutes.
7215
		if ( ! $akismet_key_state || $recheck ) {
7216
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7217
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7218
		}
7219
7220
		$status = 'valid' === $akismet_key_state;
7221
7222
		return $status;
7223
	}
7224
7225
	/**
7226
	 * @deprecated
7227
	 *
7228
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7229
	 */
7230
	public static function is_function_in_backtrace() {
7231
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7232
	}
7233
7234
	/**
7235
	 * Given a minified path, and a non-minified path, will return
7236
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7237
	 *
7238
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7239
	 * root Jetpack directory.
7240
	 *
7241
	 * @since 5.6.0
7242
	 *
7243
	 * @param string $min_path
7244
	 * @param string $non_min_path
7245
	 * @return string The URL to the file
7246
	 */
7247
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7248
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7249
	}
7250
7251
	/**
7252
	 * Checks for whether Jetpack Backup & Scan is enabled.
7253
	 * Will return true if the state of Backup & Scan is anything except "unavailable".
7254
	 *
7255
	 * @return bool|int|mixed
7256
	 */
7257
	public static function is_rewind_enabled() {
7258
		if ( ! self::is_active() ) {
7259
			return false;
7260
		}
7261
7262
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7263
		if ( false === $rewind_enabled ) {
7264
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7265
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7266
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7267
				&& ! empty( $rewind_data['state'] )
7268
				&& 'active' === $rewind_data['state'] )
7269
				? 1
7270
				: 0;
7271
7272
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7273
		}
7274
		return $rewind_enabled;
7275
	}
7276
7277
	/**
7278
	 * Return Calypso environment value; used for developing Jetpack and pairing
7279
	 * it with different Calypso enrionments, such as localhost.
7280
	 *
7281
	 * @since 7.4.0
7282
	 *
7283
	 * @return string Calypso environment
7284
	 */
7285
	public static function get_calypso_env() {
7286
		if ( isset( $_GET['calypso_env'] ) ) {
7287
			return sanitize_key( $_GET['calypso_env'] );
7288
		}
7289
7290
		if ( getenv( 'CALYPSO_ENV' ) ) {
7291
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7292
		}
7293
7294
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7295
			return sanitize_key( CALYPSO_ENV );
7296
		}
7297
7298
		return '';
7299
	}
7300
7301
	/**
7302
	 * Returns the hostname with protocol for Calypso.
7303
	 * Used for developing Jetpack with Calypso.
7304
	 *
7305
	 * @since 8.4.0
7306
	 *
7307
	 * @return string Calypso host.
7308
	 */
7309
	public static function get_calypso_host() {
7310
		$calypso_env = self::get_calypso_env();
7311
		switch ( $calypso_env ) {
7312
			case 'development':
7313
				return 'http://calypso.localhost:3000/';
7314
			case 'wpcalypso':
7315
				return 'https://wpcalypso.wordpress.com/';
7316
			case 'horizon':
7317
				return 'https://horizon.wordpress.com/';
7318
			default:
7319
				return 'https://wordpress.com/';
7320
		}
7321
	}
7322
7323
	/**
7324
	 * Checks whether or not TOS has been agreed upon.
7325
	 * Will return true if a user has clicked to register, or is already connected.
7326
	 */
7327
	public static function jetpack_tos_agreed() {
7328
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7329
7330
		$terms_of_service = new Terms_Of_Service();
7331
		return $terms_of_service->has_agreed();
7332
7333
	}
7334
7335
	/**
7336
	 * Handles activating default modules as well general cleanup for the new connection.
7337
	 *
7338
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7339
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7340
	 * @param boolean $send_state_messages          Whether to send state messages.
7341
	 * @return void
7342
	 */
7343
	public static function handle_post_authorization_actions(
7344
		$activate_sso = false,
7345
		$redirect_on_activation_error = false,
7346
		$send_state_messages = true
7347
	) {
7348
		$other_modules = $activate_sso
7349
			? array( 'sso' )
7350
			: array();
7351
7352
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7353
			self::delete_active_modules();
7354
7355
			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...
7356
		} else {
7357
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7358
		}
7359
7360
		// Since this is a fresh connection, be sure to clear out IDC options
7361
		Jetpack_IDC::clear_all_idc_options();
7362
7363
		if ( $send_state_messages ) {
7364
			self::state( 'message', 'authorized' );
7365
		}
7366
	}
7367
7368
	/**
7369
	 * Returns a boolean for whether backups UI should be displayed or not.
7370
	 *
7371
	 * @return bool Should backups UI be displayed?
7372
	 */
7373
	public static function show_backups_ui() {
7374
		/**
7375
		 * Whether UI for backups should be displayed.
7376
		 *
7377
		 * @since 6.5.0
7378
		 *
7379
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7380
		 */
7381
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7382
	}
7383
7384
	/*
7385
	 * Deprecated manage functions
7386
	 */
7387
	function prepare_manage_jetpack_notice() {
7388
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7389
	}
7390
	function manage_activate_screen() {
7391
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7392
	}
7393
	function admin_jetpack_manage_notice() {
7394
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7395
	}
7396
	function opt_out_jetpack_manage_url() {
7397
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7398
	}
7399
	function opt_in_jetpack_manage_url() {
7400
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7401
	}
7402
	function opt_in_jetpack_manage_notice() {
7403
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7404
	}
7405
	function can_display_jetpack_manage_notice() {
7406
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7407
	}
7408
7409
	/**
7410
	 * Clean leftoveruser meta.
7411
	 *
7412
	 * Delete Jetpack-related user meta when it is no longer needed.
7413
	 *
7414
	 * @since 7.3.0
7415
	 *
7416
	 * @param int $user_id User ID being updated.
7417
	 */
7418
	public static function user_meta_cleanup( $user_id ) {
7419
		$meta_keys = array(
7420
			// AtD removed from Jetpack 7.3
7421
			'AtD_options',
7422
			'AtD_check_when',
7423
			'AtD_guess_lang',
7424
			'AtD_ignored_phrases',
7425
		);
7426
7427
		foreach ( $meta_keys as $meta_key ) {
7428
			if ( get_user_meta( $user_id, $meta_key ) ) {
7429
				delete_user_meta( $user_id, $meta_key );
7430
			}
7431
		}
7432
	}
7433
7434
	/**
7435
	 * Checks if a Jetpack site is both active and not in development.
7436
	 *
7437
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7438
	 *
7439
	 * @return bool True if Jetpack is active and not in development.
7440
	 */
7441
	public static function is_active_and_not_development_mode() {
7442
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7443
			return false;
7444
		}
7445
		return true;
7446
	}
7447
7448
	/**
7449
	 * Returns the list of products that we have available for purchase.
7450
	 */
7451
	public static function get_products_for_purchase() {
7452
		$products = array();
7453
		if ( ! is_multisite() ) {
7454
			$products[] = array(
7455
				'key'               => 'backup',
7456
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7457
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7458
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7459
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7460
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7461
				'options'           => array(
7462
					array(
7463
						'type'        => 'daily',
7464
						'slug'        => 'jetpack-backup-daily',
7465
						'key'         => 'jetpack_backup_daily',
7466
						'name'        => __( 'Daily Backups', 'jetpack' ),
7467
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7468
					),
7469
					array(
7470
						'type'        => 'realtime',
7471
						'slug'        => 'jetpack-backup-realtime',
7472
						'key'         => 'jetpack_backup_realtime',
7473
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7474
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7475
					),
7476
				),
7477
				'default_option'    => 'realtime',
7478
				'show_promotion'    => true,
7479
				'discount_percent'  => 70,
7480
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7481
			);
7482
7483
			$products[] = array(
7484
				'key'               => 'scan',
7485
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7486
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7487
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7488
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7489
				'show_promotion'    => true,
7490
				'discount_percent'  => 30,
7491
				'options'           => array(
7492
					array(
7493
						'type'      => 'scan',
7494
						'slug'      => 'jetpack-scan',
7495
						'key'       => 'jetpack_scan',
7496
						'name'      => __( 'Scan', 'jetpack' ),
7497
					),
7498
				),
7499
				'default_option'    => 'scan',
7500
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7501
			);
7502
		}
7503
7504
		$products[] = array(
7505
			'key'               => 'search',
7506
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7507
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7508
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7509
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7510
			'label_popup'  		=> __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.' ),
7511
			'options'           => array(
7512
				array(
7513
					'type'      => 'search',
7514
					'slug'      => 'jetpack-search',
7515
					'key'       => 'jetpack_search',
7516
					'name'      => __( 'Search', 'jetpack' ),
7517
				),
7518
			),
7519
			'tears'             => array(),
7520
			'default_option'    => 'search',
7521
			'show_promotion'    => false,
7522
			'included_in_plans' => array( 'search-plan' ),
7523
		);
7524
7525
		return $products;
7526
	}
7527
}
7528