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