Completed
Push — branch-8.1 ( 5c544e...2a23d9 )
by
unknown
28:10 queued 21:16
created

class.jetpack.php (64 issues)

Upgrade to new PHP Analysis Engine

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

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Connection\Client;
5
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
6
use Automattic\Jetpack\Connection\REST_Connector as REST_Connector;
7
use Automattic\Jetpack\Connection\XMLRPC_Connector as XMLRPC_Connector;
8
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
9
use Automattic\Jetpack\Constants;
10
use Automattic\Jetpack\Partner;
11
use Automattic\Jetpack\Roles;
12
use Automattic\Jetpack\Status;
13
use Automattic\Jetpack\Sync\Functions;
14
use Automattic\Jetpack\Sync\Sender;
15
use Automattic\Jetpack\Sync\Users;
16
use Automattic\Jetpack\Terms_Of_Service;
17
use Automattic\Jetpack\Tracking;
18
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
19
20
/*
21
Options:
22
jetpack_options (array)
23
	An array of options.
24
	@see Jetpack_Options::get_option_names()
25
26
jetpack_register (string)
27
	Temporary verification secrets.
28
29
jetpack_activated (int)
30
	1: the plugin was activated normally
31
	2: the plugin was activated on this site because of a network-wide activation
32
	3: the plugin was auto-installed
33
	4: the plugin was manually disconnected (but is still installed)
34
35
jetpack_active_modules (array)
36
	Array of active module slugs.
37
38
jetpack_do_activate (bool)
39
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
40
*/
41
42
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
43
44
class Jetpack {
45
	public $xmlrpc_server = null;
46
47
	private $rest_authentication_status = null;
48
49
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
50
51
	private $tracking;
52
53
	/**
54
	 * @var array The handles of styles that are concatenated into jetpack.css.
55
	 *
56
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
57
	 */
58
	public $concatenated_style_handles = array(
59
		'jetpack-carousel',
60
		'grunion.css',
61
		'the-neverending-homepage',
62
		'jetpack_likes',
63
		'jetpack_related-posts',
64
		'sharedaddy',
65
		'jetpack-slideshow',
66
		'presentations',
67
		'quiz',
68
		'jetpack-subscriptions',
69
		'jetpack-responsive-videos-style',
70
		'jetpack-social-menu',
71
		'tiled-gallery',
72
		'jetpack_display_posts_widget',
73
		'gravatar-profile-widget',
74
		'goodreads-widget',
75
		'jetpack_social_media_icons_widget',
76
		'jetpack-top-posts-widget',
77
		'jetpack_image_widget',
78
		'jetpack-my-community-widget',
79
		'jetpack-authors-widget',
80
		'wordads',
81
		'eu-cookie-law-style',
82
		'flickr-widget-style',
83
		'jetpack-search-widget',
84
		'jetpack-simple-payments-widget-style',
85
		'jetpack-widget-social-icons-styles',
86
	);
87
88
	/**
89
	 * The handles of scripts that can be loaded asynchronously.
90
	 *
91
	 * @var array
92
	 */
93
	public $async_script_handles = array(
94
		'woocommerce-analytics',
95
	);
96
97
	/**
98
	 * Contains all assets that have had their URL rewritten to minified versions.
99
	 *
100
	 * @var array
101
	 */
102
	static $min_assets = array();
103
104
	public $plugins_to_deactivate = array(
105
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
106
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
107
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
108
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
109
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
110
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
111
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
112
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
113
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
114
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
115
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
116
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
117
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
118
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
119
	);
120
121
	/**
122
	 * Map of roles we care about, and their corresponding minimum capabilities.
123
	 *
124
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
125
	 *
126
	 * @access public
127
	 * @static
128
	 *
129
	 * @var array
130
	 */
131
	public static $capability_translations = array(
132
		'administrator' => 'manage_options',
133
		'editor'        => 'edit_others_posts',
134
		'author'        => 'publish_posts',
135
		'contributor'   => 'edit_posts',
136
		'subscriber'    => 'read',
137
	);
138
139
	/**
140
	 * Map of modules that have conflicts with plugins and should not be auto-activated
141
	 * if the plugins are active.  Used by filter_default_modules
142
	 *
143
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
144
	 * change `module-slug` and add this to your plugin:
145
	 *
146
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
147
	 * function my_jetpack_get_default_modules( $modules ) {
148
	 *     return array_diff( $modules, array( 'module-slug' ) );
149
	 * }
150
	 *
151
	 * @var array
152
	 */
153
	private $conflicting_plugins = array(
154
		'comments'           => array(
155
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
156
			'Disqus'                         => 'disqus-comment-system/disqus.php',
157
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
158
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
159
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
160
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
161
		),
162
		'comment-likes'      => array(
163
			'Epoch' => 'epoch/plugincore.php',
164
		),
165
		'contact-form'       => array(
166
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
167
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
168
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
169
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
170
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
171
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
172
		),
173
		'minileven'          => array(
174
			'WPtouch' => 'wptouch/wptouch.php',
175
		),
176
		'latex'              => array(
177
			'LaTeX for WordPress'     => 'latex/latex.php',
178
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
179
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
180
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
181
			'Enable Latex'            => 'enable-latex/enable-latex.php',
182
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
183
		),
184
		'protect'            => array(
185
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
186
			'Captcha'                           => 'captcha/captcha.php',
187
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
188
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
189
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
190
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
191
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
192
			'Security-protection'               => 'security-protection/security-protection.php',
193
			'Login Security'                    => 'login-security/login-security.php',
194
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
195
			'Wordfence Security'                => 'wordfence/wordfence.php',
196
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
197
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
198
		),
199
		'random-redirect'    => array(
200
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
201
		),
202
		'related-posts'      => array(
203
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
204
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
205
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
206
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
207
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
208
			'outbrain'                    => 'outbrain/outbrain.php',
209
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
210
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
211
		),
212
		'sharedaddy'         => array(
213
			'AddThis'     => 'addthis/addthis_social_widget.php',
214
			'Add To Any'  => 'add-to-any/add-to-any.php',
215
			'ShareThis'   => 'share-this/sharethis.php',
216
			'Shareaholic' => 'shareaholic/shareaholic.php',
217
		),
218
		'seo-tools'          => array(
219
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
220
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
221
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
222
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
223
			'The SEO Framework'              => 'autodescription/autodescription.php',
224
		),
225
		'verification-tools' => array(
226
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
227
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
228
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
229
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
230
			'The SEO Framework'              => 'autodescription/autodescription.php',
231
		),
232
		'widget-visibility'  => array(
233
			'Widget Logic'    => 'widget-logic/widget_logic.php',
234
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
235
		),
236
		'sitemaps'           => array(
237
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
238
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
239
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
240
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
241
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
242
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
243
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
244
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
245
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
246
			'The SEO Framework'                    => 'autodescription/autodescription.php',
247
			'Sitemap'                              => 'sitemap/sitemap.php',
248
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
249
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
250
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
251
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
252
		),
253
		'lazy-images'        => array(
254
			'Lazy Load'              => 'lazy-load/lazy-load.php',
255
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
256
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
257
		),
258
	);
259
260
	/**
261
	 * Plugins for which we turn off our Facebook OG Tags implementation.
262
	 *
263
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
264
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
265
	 *
266
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
267
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
268
	 */
269
	private $open_graph_conflicting_plugins = array(
270
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
271
		// 2 Click Social Media Buttons
272
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
273
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
274
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
275
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
276
		// Open Graph Meta Tags by Heateor
277
		'facebook/facebook.php',                                 // Facebook (official plugin)
278
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
279
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
280
		// Facebook Featured Image & OG Meta Tags
281
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
282
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
283
		// Facebook Open Graph Meta Tags for WordPress
284
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
285
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
286
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
287
		// Fedmich's Facebook Open Graph Meta
288
		'network-publisher/networkpub.php',                      // Network Publisher
289
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
290
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
291
		// NextScripts SNAP
292
		'og-tags/og-tags.php',                                   // OG Tags
293
		'opengraph/opengraph.php',                               // Open Graph
294
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
295
		// Open Graph Protocol Framework
296
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
297
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
298
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
299
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
300
		'sharepress/sharepress.php',                             // SharePress
301
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
302
		'social-discussions/social-discussions.php',             // Social Discussions
303
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
304
		'socialize/socialize.php',                               // Socialize
305
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
306
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
307
		// Tweet, Like, Google +1 and Share
308
		'wordbooker/wordbooker.php',                             // Wordbooker
309
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
310
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
311
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
312
		// WP Facebook Like Send & Open Graph Meta
313
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
314
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
315
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
316
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
317
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
318
	);
319
320
	/**
321
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
322
	 */
323
	private $twitter_cards_conflicting_plugins = array(
324
		// 'twitter/twitter.php',                       // The official one handles this on its own.
325
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
326
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
327
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
328
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
329
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
330
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
331
		'twitter-cards/twitter-cards.php',           // Twitter Cards
332
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
333
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
334
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
335
	);
336
337
	/**
338
	 * Message to display in admin_notice
339
	 *
340
	 * @var string
341
	 */
342
	public $message = '';
343
344
	/**
345
	 * Error to display in admin_notice
346
	 *
347
	 * @var string
348
	 */
349
	public $error = '';
350
351
	/**
352
	 * Modules that need more privacy description.
353
	 *
354
	 * @var string
355
	 */
356
	public $privacy_checks = '';
357
358
	/**
359
	 * Stats to record once the page loads
360
	 *
361
	 * @var array
362
	 */
363
	public $stats = array();
364
365
	/**
366
	 * Jetpack_Sync object
367
	 */
368
	public $sync;
369
370
	/**
371
	 * Verified data for JSON authorization request
372
	 */
373
	public $json_api_authorization_request = array();
374
375
	/**
376
	 * @var Automattic\Jetpack\Connection\Manager
377
	 */
378
	protected $connection_manager;
379
380
	/**
381
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
382
	 */
383
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
384
385
	/**
386
	 * Holds the singleton instance of this class
387
	 *
388
	 * @since 2.3.3
389
	 * @var Jetpack
390
	 */
391
	static $instance = false;
392
393
	/**
394
	 * Singleton
395
	 *
396
	 * @static
397
	 */
398
	public static function init() {
399
		if ( ! self::$instance ) {
400
			self::$instance = new Jetpack();
401
402
			self::$instance->plugin_upgrade();
403
		}
404
405
		return self::$instance;
406
	}
407
408
	/**
409
	 * Must never be called statically
410
	 */
411
	function plugin_upgrade() {
412
		if ( self::is_active() ) {
413
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
414
			if ( JETPACK__VERSION != $version ) {
415
				// Prevent multiple upgrades at once - only a single process should trigger
416
				// an upgrade to avoid stampedes
417
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
418
					return;
419
				}
420
421
				// Set a short lock to prevent multiple instances of the upgrade
422
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
423
424
				// check which active modules actually exist and remove others from active_modules list
425
				$unfiltered_modules = self::get_active_modules();
426
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
427
				if ( array_diff( $unfiltered_modules, $modules ) ) {
428
					self::update_active_modules( $modules );
429
				}
430
431
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
432
433
				// Upgrade to 4.3.0
434
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
435
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
436
				}
437
438
				// Make sure Markdown for posts gets turned back on
439
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
440
					update_option( 'wpcom_publish_posts_with_markdown', true );
441
				}
442
443
				if ( did_action( 'wp_loaded' ) ) {
444
					self::upgrade_on_load();
445
				} else {
446
					add_action(
447
						'wp_loaded',
448
						array( __CLASS__, 'upgrade_on_load' )
449
					);
450
				}
451
			}
452
		}
453
	}
454
455
	/**
456
	 * Runs upgrade routines that need to have modules loaded.
457
	 */
458
	static function upgrade_on_load() {
459
460
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
461
		// This can happen in case Jetpack has been just upgraded and is
462
		// being initialized late during the page load. In this case we wait
463
		// until the next proper admin page load with Jetpack active.
464
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
465
			delete_transient( self::$plugin_upgrade_lock_key );
466
467
			return;
468
		}
469
470
		self::maybe_set_version_option();
471
472
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
473
			Jetpack_Widget_Conditions::migrate_post_type_rules();
474
		}
475
476
		if (
477
			class_exists( 'Jetpack_Sitemap_Manager' )
478
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
479
		) {
480
			do_action( 'jetpack_sitemaps_purge_data' );
481
		}
482
483
		// Delete old stats cache
484
		delete_option( 'jetpack_restapi_stats_cache' );
485
486
		delete_transient( self::$plugin_upgrade_lock_key );
487
	}
488
489
	/**
490
	 * Saves all the currently active modules to options.
491
	 * Also fires Action hooks for each newly activated and deactivated module.
492
	 *
493
	 * @param $modules Array Array of active modules to be saved in options.
494
	 *
495
	 * @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...
496
	 */
497
	static function update_active_modules( $modules ) {
498
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
499
		$active_modules       = self::get_active_modules();
500
		$new_active_modules   = array_diff( $modules, $current_modules );
501
		$new_inactive_modules = array_diff( $active_modules, $modules );
502
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
503
		$reindexed_modules    = array_values( $new_current_modules );
504
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
505
506
		foreach ( $new_active_modules as $module ) {
507
			/**
508
			 * Fires when a specific module is activated.
509
			 *
510
			 * @since 1.9.0
511
			 *
512
			 * @param string $module Module slug.
513
			 * @param boolean $success whether the module was activated. @since 4.2
514
			 */
515
			do_action( 'jetpack_activate_module', $module, $success );
516
			/**
517
			 * Fires when a module is activated.
518
			 * The dynamic part of the filter, $module, is the module slug.
519
			 *
520
			 * @since 1.9.0
521
			 *
522
			 * @param string $module Module slug.
523
			 */
524
			do_action( "jetpack_activate_module_$module", $module );
525
		}
526
527
		foreach ( $new_inactive_modules as $module ) {
528
			/**
529
			 * Fired after a module has been deactivated.
530
			 *
531
			 * @since 4.2.0
532
			 *
533
			 * @param string $module Module slug.
534
			 * @param boolean $success whether the module was deactivated.
535
			 */
536
			do_action( 'jetpack_deactivate_module', $module, $success );
537
			/**
538
			 * Fires when a module is deactivated.
539
			 * The dynamic part of the filter, $module, is the module slug.
540
			 *
541
			 * @since 1.9.0
542
			 *
543
			 * @param string $module Module slug.
544
			 */
545
			do_action( "jetpack_deactivate_module_$module", $module );
546
		}
547
548
		return $success;
549
	}
550
551
	static function delete_active_modules() {
552
		self::update_active_modules( array() );
553
	}
554
555
	/**
556
	 * Constructor.  Initializes WordPress hooks
557
	 */
558
	private function __construct() {
559
		/*
560
		 * Check for and alert any deprecated hooks
561
		 */
562
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
563
564
		/*
565
		 * Enable enhanced handling of previewing sites in Calypso
566
		 */
567
		if ( self::is_active() ) {
568
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
569
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
570
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
571
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
572
		}
573
574
		add_action( 'plugins_loaded', array( $this, 'after_plugins_loaded' ) );
575
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
576
577
		add_filter(
578
			'jetpack_connection_secret_generator',
579
			function( $callable ) {
580
				return function() {
581
					return wp_generate_password( 32, false );
582
				};
583
			}
584
		);
585
586
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
587
588
		$this->connection_manager = new Connection_Manager();
589
		$this->connection_manager->init();
590
591
		/*
592
		 * Load things that should only be in Network Admin.
593
		 *
594
		 * For now blow away everything else until a more full
595
		 * understanding of what is needed at the network level is
596
		 * available
597
		 */
598
		if ( is_multisite() ) {
599
			$network = Jetpack_Network::init();
600
			$network->set_connection( $this->connection_manager );
601
		}
602
603
		add_filter(
604
			'jetpack_signature_check_token',
605
			array( __CLASS__, 'verify_onboarding_token' ),
606
			10,
607
			3
608
		);
609
610
		/**
611
		 * Prepare Gutenberg Editor functionality
612
		 */
613
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
614
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
615
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
616
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
617
618
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
619
620
		// Unlink user before deleting the user from WP.com.
621
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
622
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
623
624
		// Initialize remote file upload request handlers.
625
		$this->add_remote_request_handlers();
626
627
		if ( self::is_active() ) {
628
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
629
630
			Jetpack_Heartbeat::init();
631
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
632
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
633
				Jetpack_Search_Performance_Logger::init();
634
			}
635
		}
636
637
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
638
639
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
640
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
641
642
		add_action( 'admin_init', array( $this, 'admin_init' ) );
643
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
644
645
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
646
647
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
648
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
649
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
650
651
		// returns HTTPS support status
652
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
653
654
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
655
656
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
657
658
		add_action( 'plugins_loaded', array( $this, 'extra_oembed_providers' ), 100 );
659
660
		/**
661
		 * These actions run checks to load additional files.
662
		 * They check for external files or plugins, so they need to run as late as possible.
663
		 */
664
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
665
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
666
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
667
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
668
669
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
670
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
671
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
672
673
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
674
675
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
676
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
677
678
		// A filter to control all just in time messages
679
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
680
681
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
682
683
		// If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
684
		// We should make sure to only do this for front end links.
685
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
686
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
687
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
688
689
			// we'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
690
			// so they point moderation links on emails to Calypso
691
			jetpack_require_lib( 'functions.wp-notify' );
692
		}
693
694
		// Hide edit post link if mobile app.
695
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
696
			add_filter( 'edit_post_link', '__return_empty_string' );
697
		}
698
699
		// Update the Jetpack plan from API on heartbeats
700
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
701
702
		/**
703
		 * This is the hack to concatenate all css files into one.
704
		 * For description and reasoning see the implode_frontend_css method
705
		 *
706
		 * Super late priority so we catch all the registered styles
707
		 */
708
		if ( ! is_admin() ) {
709
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
710
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
711
		}
712
713
		/**
714
		 * These are sync actions that we need to keep track of for jitms
715
		 */
716
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
717
718
		// Actually push the stats on shutdown.
719
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
720
			add_action( 'shutdown', array( $this, 'push_stats' ) );
721
		}
722
723
		/*
724
		 * Load some scripts asynchronously.
725
		 */
726
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
727
728
		// Actions for Manager::authorize().
729
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
730
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
731
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
732
733
		// Filters for the Manager::get_token() urls and request body.
734
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
735
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
736
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
737
	}
738
739
	/**
740
	 * Runs after all the plugins have loaded but before init.
741
	 */
742
	function after_plugins_loaded() {
743
744
		Partner::init();
745
		$terms_of_service = new Terms_Of_Service();
746
		$tracking = new Plugin_Tracking();
747
		if ( $terms_of_service->has_agreed() ) {
748
			add_action( 'init', array( $tracking, 'init' ) );
749
		} else {
750
			/**
751
			 * Initialize tracking right after the user agrees to the terms of service.
752
			 */
753
			add_action( 'jetpack_agreed_to_terms_of_service', array( $tracking, 'init' ) );
754
		}
755
756
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
757
	}
758
759
	/**
760
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
761
	 * initialization code.
762
	 *
763
	 * @action plugins_loaded
764
	 */
765
	public function late_initialization() {
766
		/**
767
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
768
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
769
		 *
770
		 * @since 8.1.0
771
		 *
772
		 * @param Jetpack $jetpack the main plugin class object.
773
		 */
774
		do_action( 'jetpack_loaded', $this );
775
	}
776
777
	/**
778
	 * Sets up the XMLRPC request handlers.
779
	 *
780
	 * @deprecated since 7.7.0
781
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
782
	 *
783
	 * @param Array                 $request_params Incoming request parameters.
784
	 * @param Boolean               $is_active      Whether the connection is currently active.
785
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
786
	 * @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...
787
	 */
788
	public function setup_xmlrpc_handlers(
789
		$request_params,
790
		$is_active,
791
		$is_signed,
792
		Jetpack_XMLRPC_Server $xmlrpc_server = null
793
	) {
794
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
795
		return $this->connection_manager->setup_xmlrpc_handlers(
796
			$request_params,
797
			$is_active,
798
			$is_signed,
799
			$xmlrpc_server
800
		);
801
	}
802
803
	/**
804
	 * Initialize REST API registration connector.
805
	 *
806
	 * @deprecated since 7.7.0
807
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
808
	 */
809
	public function initialize_rest_api_registration_connector() {
810
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
811
		$this->connection_manager->initialize_rest_api_registration_connector();
812
	}
813
814
	/**
815
	 * This is ported over from the manage module, which has been deprecated and baked in here.
816
	 *
817
	 * @param $domains
818
	 */
819
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
820
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
821
	}
822
823
	/**
824
	 * Return $domains, with 'wordpress.com' appended.
825
	 * This is ported over from the manage module, which has been deprecated and baked in here.
826
	 *
827
	 * @param $domains
828
	 * @return array
829
	 */
830
	function allow_wpcom_domain( $domains ) {
831
		if ( empty( $domains ) ) {
832
			$domains = array();
833
		}
834
		$domains[] = 'wordpress.com';
835
		return array_unique( $domains );
836
	}
837
838
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
839
		$post = get_post( $post_id );
840
841
		if ( empty( $post ) ) {
842
			return $default_url;
843
		}
844
845
		$post_type = $post->post_type;
846
847
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
848
		// https://en.support.wordpress.com/custom-post-types/
849
		$allowed_post_types = array(
850
			'post'                => 'post',
851
			'page'                => 'page',
852
			'jetpack-portfolio'   => 'edit/jetpack-portfolio',
853
			'jetpack-testimonial' => 'edit/jetpack-testimonial',
854
		);
855
856
		if ( ! in_array( $post_type, array_keys( $allowed_post_types ) ) ) {
857
			return $default_url;
858
		}
859
860
		$path_prefix = $allowed_post_types[ $post_type ];
861
862
		$site_slug = self::build_raw_urls( get_home_url() );
863
864
		return esc_url( sprintf( 'https://wordpress.com/%s/%s/%d', $path_prefix, $site_slug, $post_id ) );
865
	}
866
867
	function point_edit_comment_links_to_calypso( $url ) {
868
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
869
		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...
870
		return esc_url(
871
			sprintf(
872
				'https://wordpress.com/comment/%s/%d',
873
				self::build_raw_urls( get_home_url() ),
874
				$query_args['amp;c']
875
			)
876
		);
877
	}
878
879
	function jetpack_track_last_sync_callback( $params ) {
880
		/**
881
		 * Filter to turn off jitm caching
882
		 *
883
		 * @since 5.4.0
884
		 *
885
		 * @param bool false Whether to cache just in time messages
886
		 */
887
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
888
			return $params;
889
		}
890
891
		if ( is_array( $params ) && isset( $params[0] ) ) {
892
			$option = $params[0];
893
			if ( 'active_plugins' === $option ) {
894
				// use the cache if we can, but not terribly important if it gets evicted
895
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
896
			}
897
		}
898
899
		return $params;
900
	}
901
902
	function jetpack_connection_banner_callback() {
903
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
904
905
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
906
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
907
			wp_send_json_success();
908
		}
909
910
		wp_die();
911
	}
912
913
	/**
914
	 * Removes all XML-RPC methods that are not `jetpack.*`.
915
	 * Only used in our alternate XML-RPC endpoint, where we want to
916
	 * ensure that Core and other plugins' methods are not exposed.
917
	 *
918
	 * @deprecated since 7.7.0
919
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
920
	 *
921
	 * @param array $methods A list of registered WordPress XMLRPC methods.
922
	 * @return array Filtered $methods
923
	 */
924
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
925
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
926
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
927
	}
928
929
	/**
930
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
931
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
932
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
933
	 * which is accessible via a different URI. Most of the below is copied directly
934
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
935
	 *
936
	 * @deprecated since 7.7.0
937
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
938
	 */
939
	public function alternate_xmlrpc() {
940
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
941
		$this->connection_manager->alternate_xmlrpc();
942
	}
943
944
	/**
945
	 * The callback for the JITM ajax requests.
946
	 *
947
	 * @deprecated since 7.9.0
948
	 */
949
	function jetpack_jitm_ajax_callback() {
950
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
951
	}
952
953
	/**
954
	 * If there are any stats that need to be pushed, but haven't been, push them now.
955
	 */
956
	function push_stats() {
957
		if ( ! empty( $this->stats ) ) {
958
			$this->do_stats( 'server_side' );
959
		}
960
	}
961
962
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
963
		$is_development_mode = ( new Status() )->is_development_mode();
964
		switch ( $cap ) {
965
			case 'jetpack_connect':
966
			case 'jetpack_reconnect':
967
				if ( $is_development_mode ) {
968
					$caps = array( 'do_not_allow' );
969
					break;
970
				}
971
				/**
972
				 * Pass through. If it's not development mode, these should match disconnect.
973
				 * Let users disconnect if it's development mode, just in case things glitch.
974
				 */
975
			case 'jetpack_disconnect':
976
				/**
977
				 * In multisite, can individual site admins manage their own connection?
978
				 *
979
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
980
				 */
981
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
982
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
983
						/**
984
						 * We need to update the option name -- it's terribly unclear which
985
						 * direction the override goes.
986
						 *
987
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
988
						 */
989
						$caps = array( 'do_not_allow' );
990
						break;
991
					}
992
				}
993
994
				$caps = array( 'manage_options' );
995
				break;
996
			case 'jetpack_manage_modules':
997
			case 'jetpack_activate_modules':
998
			case 'jetpack_deactivate_modules':
999
				$caps = array( 'manage_options' );
1000
				break;
1001
			case 'jetpack_configure_modules':
1002
				$caps = array( 'manage_options' );
1003
				break;
1004
			case 'jetpack_manage_autoupdates':
1005
				$caps = array(
1006
					'manage_options',
1007
					'update_plugins',
1008
				);
1009
				break;
1010
			case 'jetpack_network_admin_page':
1011
			case 'jetpack_network_settings_page':
1012
				$caps = array( 'manage_network_plugins' );
1013
				break;
1014
			case 'jetpack_network_sites_page':
1015
				$caps = array( 'manage_sites' );
1016
				break;
1017
			case 'jetpack_admin_page':
1018
				if ( $is_development_mode ) {
1019
					$caps = array( 'manage_options' );
1020
					break;
1021
				} else {
1022
					$caps = array( 'read' );
1023
				}
1024
				break;
1025
			case 'jetpack_connect_user':
1026
				if ( $is_development_mode ) {
1027
					$caps = array( 'do_not_allow' );
1028
					break;
1029
				}
1030
				$caps = array( 'read' );
1031
				break;
1032
		}
1033
		return $caps;
1034
	}
1035
1036
	/**
1037
	 * Require a Jetpack authentication.
1038
	 *
1039
	 * @deprecated since 7.7.0
1040
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1041
	 */
1042
	public function require_jetpack_authentication() {
1043
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1044
		$this->connection_manager->require_jetpack_authentication();
1045
	}
1046
1047
	/**
1048
	 * Load language files
1049
	 *
1050
	 * @action plugins_loaded
1051
	 */
1052
	public static function plugin_textdomain() {
1053
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1054
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1055
	}
1056
1057
	/**
1058
	 * Register assets for use in various modules and the Jetpack admin page.
1059
	 *
1060
	 * @uses wp_script_is, wp_register_script, plugins_url
1061
	 * @action wp_loaded
1062
	 * @return null
1063
	 */
1064
	public function register_assets() {
1065
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1066
			wp_register_script(
1067
				'spin',
1068
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1069
				false,
1070
				'1.3'
1071
			);
1072
		}
1073
1074 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1075
			wp_register_script(
1076
				'jquery.spin',
1077
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1078
				array( 'jquery', 'spin' ),
1079
				'1.3'
1080
			);
1081
		}
1082
1083 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1084
			wp_register_script(
1085
				'jetpack-gallery-settings',
1086
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1087
				array( 'media-views' ),
1088
				'20121225'
1089
			);
1090
		}
1091
1092 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1093
			wp_register_script(
1094
				'jetpack-twitter-timeline',
1095
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1096
				array( 'jquery' ),
1097
				'4.0.0',
1098
				true
1099
			);
1100
		}
1101
1102
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1103
			wp_register_script(
1104
				'jetpack-facebook-embed',
1105
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1106
				array( 'jquery' ),
1107
				null,
1108
				true
1109
			);
1110
1111
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1112
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1113
			if ( ! is_numeric( $fb_app_id ) ) {
1114
				$fb_app_id = '';
1115
			}
1116
			wp_localize_script(
1117
				'jetpack-facebook-embed',
1118
				'jpfbembed',
1119
				array(
1120
					'appid'  => $fb_app_id,
1121
					'locale' => $this->get_locale(),
1122
				)
1123
			);
1124
		}
1125
1126
		/**
1127
		 * As jetpack_register_genericons is by default fired off a hook,
1128
		 * the hook may have already fired by this point.
1129
		 * So, let's just trigger it manually.
1130
		 */
1131
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1132
		jetpack_register_genericons();
1133
1134
		/**
1135
		 * Register the social logos
1136
		 */
1137
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1138
		jetpack_register_social_logos();
1139
1140 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1141
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1142
		}
1143
	}
1144
1145
	/**
1146
	 * Guess locale from language code.
1147
	 *
1148
	 * @param string $lang Language code.
1149
	 * @return string|bool
1150
	 */
1151 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1152
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1153
			return 'en_US';
1154
		}
1155
1156
		if ( ! class_exists( 'GP_Locales' ) ) {
1157
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1158
				return false;
1159
			}
1160
1161
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1162
		}
1163
1164
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1165
			// WP.com: get_locale() returns 'it'
1166
			$locale = GP_Locales::by_slug( $lang );
1167
		} else {
1168
			// Jetpack: get_locale() returns 'it_IT';
1169
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1170
		}
1171
1172
		if ( ! $locale ) {
1173
			return false;
1174
		}
1175
1176
		if ( empty( $locale->facebook_locale ) ) {
1177
			if ( empty( $locale->wp_locale ) ) {
1178
				return false;
1179
			} else {
1180
				// Facebook SDK is smart enough to fall back to en_US if a
1181
				// locale isn't supported. Since supported Facebook locales
1182
				// can fall out of sync, we'll attempt to use the known
1183
				// wp_locale value and rely on said fallback.
1184
				return $locale->wp_locale;
1185
			}
1186
		}
1187
1188
		return $locale->facebook_locale;
1189
	}
1190
1191
	/**
1192
	 * Get the locale.
1193
	 *
1194
	 * @return string|bool
1195
	 */
1196
	function get_locale() {
1197
		$locale = $this->guess_locale_from_lang( get_locale() );
1198
1199
		if ( ! $locale ) {
1200
			$locale = 'en_US';
1201
		}
1202
1203
		return $locale;
1204
	}
1205
1206
	/**
1207
	 * Return the network_site_url so that .com knows what network this site is a part of.
1208
	 *
1209
	 * @param  bool $option
1210
	 * @return string
1211
	 */
1212
	public function jetpack_main_network_site_option( $option ) {
1213
		return network_site_url();
1214
	}
1215
	/**
1216
	 * Network Name.
1217
	 */
1218
	static function network_name( $option = null ) {
1219
		global $current_site;
1220
		return $current_site->site_name;
1221
	}
1222
	/**
1223
	 * Does the network allow new user and site registrations.
1224
	 *
1225
	 * @return string
1226
	 */
1227
	static function network_allow_new_registrations( $option = null ) {
1228
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1229
	}
1230
	/**
1231
	 * Does the network allow admins to add new users.
1232
	 *
1233
	 * @return boolian
1234
	 */
1235
	static function network_add_new_users( $option = null ) {
1236
		return (bool) get_site_option( 'add_new_users' );
1237
	}
1238
	/**
1239
	 * File upload psace left per site in MB.
1240
	 *  -1 means NO LIMIT.
1241
	 *
1242
	 * @return number
1243
	 */
1244
	static function network_site_upload_space( $option = null ) {
1245
		// value in MB
1246
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1247
	}
1248
1249
	/**
1250
	 * Network allowed file types.
1251
	 *
1252
	 * @return string
1253
	 */
1254
	static function network_upload_file_types( $option = null ) {
1255
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1256
	}
1257
1258
	/**
1259
	 * Maximum file upload size set by the network.
1260
	 *
1261
	 * @return number
1262
	 */
1263
	static function network_max_upload_file_size( $option = null ) {
1264
		// value in KB
1265
		return get_site_option( 'fileupload_maxk', 300 );
1266
	}
1267
1268
	/**
1269
	 * Lets us know if a site allows admins to manage the network.
1270
	 *
1271
	 * @return array
1272
	 */
1273
	static function network_enable_administration_menus( $option = null ) {
1274
		return get_site_option( 'menu_items' );
1275
	}
1276
1277
	/**
1278
	 * If a user has been promoted to or demoted from admin, we need to clear the
1279
	 * jetpack_other_linked_admins transient.
1280
	 *
1281
	 * @since 4.3.2
1282
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1283
	 *
1284
	 * @param int    $user_id   The user ID whose role changed.
1285
	 * @param string $role      The new role.
1286
	 * @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...
1287
	 */
1288
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1289
		if ( 'administrator' == $role
1290
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1291
			|| is_null( $old_roles )
1292
		) {
1293
			delete_transient( 'jetpack_other_linked_admins' );
1294
		}
1295
	}
1296
1297
	/**
1298
	 * Checks to see if there are any other users available to become primary
1299
	 * Users must both:
1300
	 * - Be linked to wpcom
1301
	 * - Be an admin
1302
	 *
1303
	 * @return mixed False if no other users are linked, Int if there are.
1304
	 */
1305
	static function get_other_linked_admins() {
1306
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1307
1308
		if ( false === $other_linked_users ) {
1309
			$admins = get_users( array( 'role' => 'administrator' ) );
1310
			if ( count( $admins ) > 1 ) {
1311
				$available = array();
1312
				foreach ( $admins as $admin ) {
1313
					if ( self::is_user_connected( $admin->ID ) ) {
1314
						$available[] = $admin->ID;
1315
					}
1316
				}
1317
1318
				$count_connected_admins = count( $available );
1319
				if ( count( $available ) > 1 ) {
1320
					$other_linked_users = $count_connected_admins;
1321
				} else {
1322
					$other_linked_users = 0;
1323
				}
1324
			} else {
1325
				$other_linked_users = 0;
1326
			}
1327
1328
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1329
		}
1330
1331
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1332
	}
1333
1334
	/**
1335
	 * Return whether we are dealing with a multi network setup or not.
1336
	 * The reason we are type casting this is because we want to avoid the situation where
1337
	 * the result is false since when is_main_network_option return false it cases
1338
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1339
	 * database which could be set to anything as opposed to what this function returns.
1340
	 *
1341
	 * @param  bool $option
1342
	 *
1343
	 * @return boolean
1344
	 */
1345
	public function is_main_network_option( $option ) {
1346
		// return '1' or ''
1347
		return (string) (bool) self::is_multi_network();
1348
	}
1349
1350
	/**
1351
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1352
	 *
1353
	 * @param  string $option
1354
	 * @return boolean
1355
	 */
1356
	public function is_multisite( $option ) {
1357
		return (string) (bool) is_multisite();
1358
	}
1359
1360
	/**
1361
	 * Implemented since there is no core is multi network function
1362
	 * Right now there is no way to tell if we which network is the dominant network on the system
1363
	 *
1364
	 * @since  3.3
1365
	 * @return boolean
1366
	 */
1367 View Code Duplication
	public static function is_multi_network() {
1368
		global  $wpdb;
1369
1370
		// if we don't have a multi site setup no need to do any more
1371
		if ( ! is_multisite() ) {
1372
			return false;
1373
		}
1374
1375
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1376
		if ( $num_sites > 1 ) {
1377
			return true;
1378
		} else {
1379
			return false;
1380
		}
1381
	}
1382
1383
	/**
1384
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1385
	 *
1386
	 * @return null
1387
	 */
1388
	function update_jetpack_main_network_site_option() {
1389
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1390
	}
1391
	/**
1392
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1393
	 */
1394
	function update_jetpack_network_settings() {
1395
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1396
		// Only sync this info for the main network site.
1397
	}
1398
1399
	/**
1400
	 * Get back if the current site is single user site.
1401
	 *
1402
	 * @return bool
1403
	 */
1404 View Code Duplication
	public static function is_single_user_site() {
1405
		global $wpdb;
1406
1407
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1408
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1409
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1410
		}
1411
		return 1 === (int) $some_users;
1412
	}
1413
1414
	/**
1415
	 * Returns true if the site has file write access false otherwise.
1416
	 *
1417
	 * @return string ( '1' | '0' )
1418
	 **/
1419
	public static function file_system_write_access() {
1420
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1421
			require_once ABSPATH . 'wp-admin/includes/file.php';
1422
		}
1423
1424
		require_once ABSPATH . 'wp-admin/includes/template.php';
1425
1426
		$filesystem_method = get_filesystem_method();
1427
		if ( $filesystem_method === 'direct' ) {
1428
			return 1;
1429
		}
1430
1431
		ob_start();
1432
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1433
		ob_end_clean();
1434
		if ( $filesystem_credentials_are_stored ) {
1435
			return 1;
1436
		}
1437
		return 0;
1438
	}
1439
1440
	/**
1441
	 * Finds out if a site is using a version control system.
1442
	 *
1443
	 * @return string ( '1' | '0' )
1444
	 **/
1445
	public static function is_version_controlled() {
1446
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1447
		return (string) (int) Functions::is_version_controlled();
1448
	}
1449
1450
	/**
1451
	 * Determines whether the current theme supports featured images or not.
1452
	 *
1453
	 * @return string ( '1' | '0' )
1454
	 */
1455
	public static function featured_images_enabled() {
1456
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1457
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1458
	}
1459
1460
	/**
1461
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1462
	 *
1463
	 * @deprecated 4.7 use get_avatar_url instead.
1464
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1465
	 * @param int               $size Size of the avatar image
1466
	 * @param string            $default URL to a default image to use if no avatar is available
1467
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1468
	 *
1469
	 * @return array
1470
	 */
1471
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1472
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1473
		return get_avatar_url(
1474
			$id_or_email,
1475
			array(
1476
				'size'          => $size,
1477
				'default'       => $default,
1478
				'force_default' => $force_display,
1479
			)
1480
		);
1481
	}
1482
1483
	/**
1484
	 * jetpack_updates is saved in the following schema:
1485
	 *
1486
	 * array (
1487
	 *      'plugins'                       => (int) Number of plugin updates available.
1488
	 *      'themes'                        => (int) Number of theme updates available.
1489
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1490
	 *      'translations'                  => (int) Number of translation updates available.
1491
	 *      'total'                         => (int) Total of all available updates.
1492
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1493
	 * )
1494
	 *
1495
	 * @return array
1496
	 */
1497
	public static function get_updates() {
1498
		$update_data = wp_get_update_data();
1499
1500
		// Stores the individual update counts as well as the total count.
1501
		if ( isset( $update_data['counts'] ) ) {
1502
			$updates = $update_data['counts'];
1503
		}
1504
1505
		// If we need to update WordPress core, let's find the latest version number.
1506 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1507
			$cur = get_preferred_from_update_core();
1508
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1509
				$updates['wp_update_version'] = $cur->current;
1510
			}
1511
		}
1512
		return isset( $updates ) ? $updates : array();
1513
	}
1514
1515
	public static function get_update_details() {
1516
		$update_details = array(
1517
			'update_core'    => get_site_transient( 'update_core' ),
1518
			'update_plugins' => get_site_transient( 'update_plugins' ),
1519
			'update_themes'  => get_site_transient( 'update_themes' ),
1520
		);
1521
		return $update_details;
1522
	}
1523
1524
	public static function refresh_update_data() {
1525
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1526
1527
	}
1528
1529
	public static function refresh_theme_data() {
1530
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1531
	}
1532
1533
	/**
1534
	 * Is Jetpack active?
1535
	 */
1536
	public static function is_active() {
1537
		return (bool) Jetpack_Data::get_access_token( JETPACK_MASTER_USER );
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead.

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