Completed
Push — add/instant-search-results-in-... ( 446f2a...fd7f98 )
by
unknown
30:42 queued 22:12
created

Jetpack::get_module()   D

Complexity

Conditions 11
Paths 257

Size

Total Lines 89

Duplication

Lines 12
Ratio 13.48 %

Importance

Changes 0
Metric Value
cc 11
nc 257
nop 1
dl 12
loc 89
rs 4.8566
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
8
use Automattic\Jetpack\Connection\Plugin_Storage as Connection_Plugin_Storage;
9
use Automattic\Jetpack\Constants;
10
use Automattic\Jetpack\Partner;
11
use Automattic\Jetpack\Roles;
12
use Automattic\Jetpack\Status;
13
use Automattic\Jetpack\Sync\Functions;
14
use Automattic\Jetpack\Sync\Health;
15
use Automattic\Jetpack\Sync\Sender;
16
use Automattic\Jetpack\Sync\Users;
17
use Automattic\Jetpack\Terms_Of_Service;
18
use Automattic\Jetpack\Tracking;
19
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
20
use Automattic\Jetpack\Redirect;
21
use Automattic\Jetpack\Device_Detection\User_Agent_Info;
22
23
/*
24
Options:
25
jetpack_options (array)
26
	An array of options.
27
	@see Jetpack_Options::get_option_names()
28
29
jetpack_register (string)
30
	Temporary verification secrets.
31
32
jetpack_activated (int)
33
	1: the plugin was activated normally
34
	2: the plugin was activated on this site because of a network-wide activation
35
	3: the plugin was auto-installed
36
	4: the plugin was manually disconnected (but is still installed)
37
38
jetpack_active_modules (array)
39
	Array of active module slugs.
40
41
jetpack_do_activate (bool)
42
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
43
*/
44
45
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
46
47
class Jetpack {
48
	public $xmlrpc_server = null;
49
50
	private $rest_authentication_status = null;
51
52
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
53
54
	/**
55
	 * @var array The handles of styles that are concatenated into jetpack.css.
56
	 *
57
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
58
	 */
59
	public $concatenated_style_handles = array(
60
		'jetpack-carousel',
61
		'grunion.css',
62
		'the-neverending-homepage',
63
		'jetpack_likes',
64
		'jetpack_related-posts',
65
		'sharedaddy',
66
		'jetpack-slideshow',
67
		'presentations',
68
		'quiz',
69
		'jetpack-subscriptions',
70
		'jetpack-responsive-videos-style',
71
		'jetpack-social-menu',
72
		'tiled-gallery',
73
		'jetpack_display_posts_widget',
74
		'gravatar-profile-widget',
75
		'goodreads-widget',
76
		'jetpack_social_media_icons_widget',
77
		'jetpack-top-posts-widget',
78
		'jetpack_image_widget',
79
		'jetpack-my-community-widget',
80
		'jetpack-authors-widget',
81
		'wordads',
82
		'eu-cookie-law-style',
83
		'flickr-widget-style',
84
		'jetpack-search-widget',
85
		'jetpack-simple-payments-widget-style',
86
		'jetpack-widget-social-icons-styles',
87
		'wpcom_instagram_widget',
88
	);
89
90
	/**
91
	 * Contains all assets that have had their URL rewritten to minified versions.
92
	 *
93
	 * @var array
94
	 */
95
	static $min_assets = array();
96
97
	public $plugins_to_deactivate = array(
98
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
99
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
100
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
101
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
102
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
103
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
104
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
105
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
106
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
107
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
108
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
109
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
110
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
111
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
112
	);
113
114
	/**
115
	 * Map of roles we care about, and their corresponding minimum capabilities.
116
	 *
117
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
118
	 *
119
	 * @access public
120
	 * @static
121
	 *
122
	 * @var array
123
	 */
124
	public static $capability_translations = array(
125
		'administrator' => 'manage_options',
126
		'editor'        => 'edit_others_posts',
127
		'author'        => 'publish_posts',
128
		'contributor'   => 'edit_posts',
129
		'subscriber'    => 'read',
130
	);
131
132
	/**
133
	 * Map of modules that have conflicts with plugins and should not be auto-activated
134
	 * if the plugins are active.  Used by filter_default_modules
135
	 *
136
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
137
	 * change `module-slug` and add this to your plugin:
138
	 *
139
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
140
	 * function my_jetpack_get_default_modules( $modules ) {
141
	 *     return array_diff( $modules, array( 'module-slug' ) );
142
	 * }
143
	 *
144
	 * @var array
145
	 */
146
	private $conflicting_plugins = array(
147
		'comments'           => array(
148
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
149
			'Disqus'                         => 'disqus-comment-system/disqus.php',
150
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
151
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
152
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
153
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
154
		),
155
		'comment-likes'      => array(
156
			'Epoch' => 'epoch/plugincore.php',
157
		),
158
		'contact-form'       => array(
159
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
160
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
161
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
162
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
163
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
164
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
165
		),
166
		'latex'              => array(
167
			'LaTeX for WordPress'     => 'latex/latex.php',
168
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
169
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
170
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
171
			'Enable Latex'            => 'enable-latex/enable-latex.php',
172
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
173
		),
174
		'protect'            => array(
175
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
176
			'Captcha'                           => 'captcha/captcha.php',
177
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
178
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
179
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
180
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
181
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
182
			'Security-protection'               => 'security-protection/security-protection.php',
183
			'Login Security'                    => 'login-security/login-security.php',
184
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
185
			'Wordfence Security'                => 'wordfence/wordfence.php',
186
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
187
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
188
		),
189
		'random-redirect'    => array(
190
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
191
		),
192
		'related-posts'      => array(
193
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
194
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
195
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
196
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
197
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
198
			'outbrain'                    => 'outbrain/outbrain.php',
199
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
200
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
201
		),
202
		'sharedaddy'         => array(
203
			'AddThis'     => 'addthis/addthis_social_widget.php',
204
			'Add To Any'  => 'add-to-any/add-to-any.php',
205
			'ShareThis'   => 'share-this/sharethis.php',
206
			'Shareaholic' => 'shareaholic/shareaholic.php',
207
		),
208
		'seo-tools'          => array(
209
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
210
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
211
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
212
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
213
			'The SEO Framework'              => 'autodescription/autodescription.php',
214
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
215
		),
216
		'verification-tools' => array(
217
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
218
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
219
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
220
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
221
			'The SEO Framework'              => 'autodescription/autodescription.php',
222
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
223
		),
224
		'widget-visibility'  => array(
225
			'Widget Logic'    => 'widget-logic/widget_logic.php',
226
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
227
		),
228
		'sitemaps'           => array(
229
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
230
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
231
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
232
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
233
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
234
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
235
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
236
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
237
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
238
			'The SEO Framework'                    => 'autodescription/autodescription.php',
239
			'Sitemap'                              => 'sitemap/sitemap.php',
240
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
241
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
242
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
243
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
244
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
245
		),
246
		'lazy-images'        => array(
247
			'Lazy Load'              => 'lazy-load/lazy-load.php',
248
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
249
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
250
		),
251
	);
252
253
	/**
254
	 * Plugins for which we turn off our Facebook OG Tags implementation.
255
	 *
256
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
257
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
258
	 *
259
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
260
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
261
	 */
262
	private $open_graph_conflicting_plugins = array(
263
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
264
		// 2 Click Social Media Buttons
265
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
266
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
267
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
268
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
269
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
270
		// Open Graph Meta Tags by Heateor
271
		'facebook/facebook.php',                                 // Facebook (official plugin)
272
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
273
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
274
		// Facebook Featured Image & OG Meta Tags
275
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
276
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
277
		// Facebook Open Graph Meta Tags for WordPress
278
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
279
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
280
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
281
		// Fedmich's Facebook Open Graph Meta
282
		'network-publisher/networkpub.php',                      // Network Publisher
283
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
284
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
285
		// NextScripts SNAP
286
		'og-tags/og-tags.php',                                   // OG Tags
287
		'opengraph/opengraph.php',                               // Open Graph
288
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
289
		// Open Graph Protocol Framework
290
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
291
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
292
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
293
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
294
		'sharepress/sharepress.php',                             // SharePress
295
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
296
		'social-discussions/social-discussions.php',             // Social Discussions
297
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
298
		'socialize/socialize.php',                               // Socialize
299
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
300
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
301
		// Tweet, Like, Google +1 and Share
302
		'wordbooker/wordbooker.php',                             // Wordbooker
303
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
304
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
305
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
306
		// WP Facebook Like Send & Open Graph Meta
307
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
308
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
309
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
310
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
311
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
312
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
313
	);
314
315
	/**
316
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
317
	 */
318
	private $twitter_cards_conflicting_plugins = array(
319
		// 'twitter/twitter.php',                       // The official one handles this on its own.
320
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
321
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
322
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
323
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
324
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
325
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
326
		'twitter-cards/twitter-cards.php',           // Twitter Cards
327
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
328
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
329
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
330
		'seo-by-rank-math/rank-math.php',            // Rank Math.
331
	);
332
333
	/**
334
	 * Message to display in admin_notice
335
	 *
336
	 * @var string
337
	 */
338
	public $message = '';
339
340
	/**
341
	 * Error to display in admin_notice
342
	 *
343
	 * @var string
344
	 */
345
	public $error = '';
346
347
	/**
348
	 * Modules that need more privacy description.
349
	 *
350
	 * @var string
351
	 */
352
	public $privacy_checks = '';
353
354
	/**
355
	 * Stats to record once the page loads
356
	 *
357
	 * @var array
358
	 */
359
	public $stats = array();
360
361
	/**
362
	 * Jetpack_Sync object
363
	 */
364
	public $sync;
365
366
	/**
367
	 * Verified data for JSON authorization request
368
	 */
369
	public $json_api_authorization_request = array();
370
371
	/**
372
	 * @var Automattic\Jetpack\Connection\Manager
373
	 */
374
	protected $connection_manager;
375
376
	/**
377
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
378
	 */
379
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
380
381
	/**
382
	 * Holds an instance of Automattic\Jetpack\A8c_Mc_Stats
383
	 *
384
	 * @var Automattic\Jetpack\A8c_Mc_Stats
385
	 */
386
	public $a8c_mc_stats_instance;
387
388
	/**
389
	 * Constant for login redirect key.
390
	 *
391
	 * @var string
392
	 * @since 8.4.0
393
	 */
394
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
395
396
	/**
397
	 * Holds the singleton instance of this class
398
	 *
399
	 * @since 2.3.3
400
	 * @var Jetpack
401
	 */
402
	static $instance = false;
403
404
	/**
405
	 * Singleton
406
	 *
407
	 * @static
408
	 */
409
	public static function init() {
410
		if ( ! self::$instance ) {
411
			self::$instance = new Jetpack();
412
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
413
		}
414
415
		return self::$instance;
416
	}
417
418
	/**
419
	 * Must never be called statically
420
	 */
421
	function plugin_upgrade() {
422
		if ( self::is_active() ) {
423
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
424
			if ( JETPACK__VERSION != $version ) {
425
				// Prevent multiple upgrades at once - only a single process should trigger
426
				// an upgrade to avoid stampedes
427
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
428
					return;
429
				}
430
431
				// Set a short lock to prevent multiple instances of the upgrade
432
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
433
434
				// check which active modules actually exist and remove others from active_modules list
435
				$unfiltered_modules = self::get_active_modules();
436
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
437
				if ( array_diff( $unfiltered_modules, $modules ) ) {
438
					self::update_active_modules( $modules );
439
				}
440
441
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
442
443
				// Upgrade to 4.3.0
444
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
445
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
446
				}
447
448
				// Make sure Markdown for posts gets turned back on
449
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
450
					update_option( 'wpcom_publish_posts_with_markdown', true );
451
				}
452
453
				/*
454
				 * Minileven deprecation. 8.3.0.
455
				 * Only delete options if not using
456
				 * the replacement standalone Minileven plugin.
457
				 */
458
				if (
459
					! self::is_plugin_active( 'minileven-master/minileven.php' )
460
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
461
				) {
462
					if ( get_option( 'wp_mobile_custom_css' ) ) {
463
						delete_option( 'wp_mobile_custom_css' );
464
					}
465
					if ( get_option( 'wp_mobile_excerpt' ) ) {
466
						delete_option( 'wp_mobile_excerpt' );
467
					}
468
					if ( get_option( 'wp_mobile_featured_images' ) ) {
469
						delete_option( 'wp_mobile_featured_images' );
470
					}
471
					if ( get_option( 'wp_mobile_app_promos' ) ) {
472
						delete_option( 'wp_mobile_app_promos' );
473
					}
474
				}
475
476
				// Upgrade to 8.4.0.
477
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
478
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
479
				}
480
481
				if ( did_action( 'wp_loaded' ) ) {
482
					self::upgrade_on_load();
483
				} else {
484
					add_action(
485
						'wp_loaded',
486
						array( __CLASS__, 'upgrade_on_load' )
487
					);
488
				}
489
			}
490
		}
491
	}
492
493
	/**
494
	 * Runs upgrade routines that need to have modules loaded.
495
	 */
496
	static function upgrade_on_load() {
497
498
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
499
		// This can happen in case Jetpack has been just upgraded and is
500
		// being initialized late during the page load. In this case we wait
501
		// until the next proper admin page load with Jetpack active.
502
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
503
			delete_transient( self::$plugin_upgrade_lock_key );
504
505
			return;
506
		}
507
508
		self::maybe_set_version_option();
509
510
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
511
			Jetpack_Widget_Conditions::migrate_post_type_rules();
512
		}
513
514
		if (
515
			class_exists( 'Jetpack_Sitemap_Manager' )
516
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
517
		) {
518
			do_action( 'jetpack_sitemaps_purge_data' );
519
		}
520
521
		// Delete old stats cache
522
		delete_option( 'jetpack_restapi_stats_cache' );
523
524
		delete_transient( self::$plugin_upgrade_lock_key );
525
	}
526
527
	/**
528
	 * Saves all the currently active modules to options.
529
	 * Also fires Action hooks for each newly activated and deactivated module.
530
	 *
531
	 * @param $modules Array Array of active modules to be saved in options.
532
	 *
533
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
Documentation introduced by
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...
534
	 */
535
	static function update_active_modules( $modules ) {
536
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
537
		$active_modules       = self::get_active_modules();
538
		$new_active_modules   = array_diff( $modules, $current_modules );
539
		$new_inactive_modules = array_diff( $active_modules, $modules );
540
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
541
		$reindexed_modules    = array_values( $new_current_modules );
542
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
543
544
		foreach ( $new_active_modules as $module ) {
545
			/**
546
			 * Fires when a specific module is activated.
547
			 *
548
			 * @since 1.9.0
549
			 *
550
			 * @param string $module Module slug.
551
			 * @param boolean $success whether the module was activated. @since 4.2
552
			 */
553
			do_action( 'jetpack_activate_module', $module, $success );
554
			/**
555
			 * Fires when a module is activated.
556
			 * The dynamic part of the filter, $module, is the module slug.
557
			 *
558
			 * @since 1.9.0
559
			 *
560
			 * @param string $module Module slug.
561
			 */
562
			do_action( "jetpack_activate_module_$module", $module );
563
		}
564
565
		foreach ( $new_inactive_modules as $module ) {
566
			/**
567
			 * Fired after a module has been deactivated.
568
			 *
569
			 * @since 4.2.0
570
			 *
571
			 * @param string $module Module slug.
572
			 * @param boolean $success whether the module was deactivated.
573
			 */
574
			do_action( 'jetpack_deactivate_module', $module, $success );
575
			/**
576
			 * Fires when a module is deactivated.
577
			 * The dynamic part of the filter, $module, is the module slug.
578
			 *
579
			 * @since 1.9.0
580
			 *
581
			 * @param string $module Module slug.
582
			 */
583
			do_action( "jetpack_deactivate_module_$module", $module );
584
		}
585
586
		return $success;
587
	}
588
589
	static function delete_active_modules() {
590
		self::update_active_modules( array() );
591
	}
592
593
	/**
594
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
595
	 * available.
596
	 */
597
	public function add_configure_hook() {
598
		global $wp_filter;
599
600
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
601
		if ( false !== $current_priority ) {
602
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
603
		}
604
605
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
606
		sort( $taken_priorities );
607
608
		$first_priority = array_shift( $taken_priorities );
609
610
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
611
			$new_priority = - PHP_INT_MAX;
612
		} else {
613
			$new_priority = $first_priority - 1;
614
		}
615
616
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
617
	}
618
619
	/**
620
	 * Constructor.  Initializes WordPress hooks
621
	 */
622
	private function __construct() {
623
		/*
624
		 * Check for and alert any deprecated hooks
625
		 */
626
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
627
628
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
629
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
630
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
631
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
632
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
633
634
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
635
636
		add_filter(
637
			'jetpack_signature_check_token',
638
			array( __CLASS__, 'verify_onboarding_token' ),
639
			10,
640
			3
641
		);
642
643
		/**
644
		 * Prepare Gutenberg Editor functionality
645
		 */
646
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
647
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
648
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
649
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
650
651
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
652
653
		// Unlink user before deleting the user from WP.com.
654
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
655
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
656
657
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
658
659
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
660
		add_action( 'login_init', array( $this, 'login_init' ) );
661
662
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
663
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
664
665
		add_action( 'admin_init', array( $this, 'admin_init' ) );
666
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
667
668
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
669
670
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
671
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
672
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
673
674
		// returns HTTPS support status
675
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
676
677
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
678
679
		add_action( 'wp_ajax_jetpack_wizard_banner', array( 'Jetpack_Wizard_Banner', 'ajax_callback' ) );
680
681
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
682
683
		/**
684
		 * These actions run checks to load additional files.
685
		 * They check for external files or plugins, so they need to run as late as possible.
686
		 */
687
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
688
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
689
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
690
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
691
692
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
693
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
694
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
695
696
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
697
698
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
699
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
700
701
		// A filter to control all just in time messages
702
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
703
704
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
705
706
		/*
707
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
708
		 * We should make sure to only do this for front end links.
709
		 */
710
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
711
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
712
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
713
714
			/*
715
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
716
			 * so they point moderation links on emails to Calypso.
717
			 */
718
			jetpack_require_lib( 'functions.wp-notify' );
719
		}
720
721
		add_action(
722
			'plugins_loaded',
723
			function() {
724
				if ( User_Agent_Info::is_mobile_app() ) {
725
					add_filter( 'get_edit_post_link', '__return_empty_string' );
726
				}
727
			}
728
		);
729
730
		// Update the Jetpack plan from API on heartbeats.
731
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
732
733
		/**
734
		 * This is the hack to concatenate all css files into one.
735
		 * For description and reasoning see the implode_frontend_css method.
736
		 *
737
		 * Super late priority so we catch all the registered styles.
738
		 */
739
		if ( ! is_admin() ) {
740
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
741
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
742
		}
743
744
		/**
745
		 * These are sync actions that we need to keep track of for jitms
746
		 */
747
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
748
749
		// Actually push the stats on shutdown.
750
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
751
			add_action( 'shutdown', array( $this, 'push_stats' ) );
752
		}
753
754
		// Actions for Manager::authorize().
755
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
756
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
757
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
758
759
		// Filters for the Manager::get_token() urls and request body.
760
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
761
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
762
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
763
	}
764
765
	/**
766
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
767
	 * Config object.
768
	 */
769
	public function configure() {
770
		$config = new Config();
771
772
		foreach (
773
			array(
774
				'sync',
775
				'tracking',
776
				'tos',
777
			)
778
			as $feature
779
		) {
780
			$config->ensure( $feature );
781
		}
782
783
		$config->ensure(
784
			'connection',
785
			array(
786
				'slug' => 'jetpack',
787
				'name' => 'Jetpack',
788
			)
789
		);
790
791
		if ( is_admin() ) {
792
			$config->ensure( 'jitm' );
793
		}
794
795
		if ( ! $this->connection_manager ) {
796
			$this->connection_manager = new Connection_Manager( 'jetpack' );
797
		}
798
799
		/*
800
		 * Load things that should only be in Network Admin.
801
		 *
802
		 * For now blow away everything else until a more full
803
		 * understanding of what is needed at the network level is
804
		 * available
805
		 */
806
		if ( is_multisite() ) {
807
			$network = Jetpack_Network::init();
808
			$network->set_connection( $this->connection_manager );
809
		}
810
811
		if ( $this->connection_manager->is_active() ) {
812
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
813
814
			Jetpack_Heartbeat::init();
815
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
816
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
817
				Jetpack_Search_Performance_Logger::init();
818
			}
819
		}
820
821
		// Initialize remote file upload request handlers.
822
		$this->add_remote_request_handlers();
823
824
		/*
825
		 * Enable enhanced handling of previewing sites in Calypso
826
		 */
827
		if ( self::is_active() ) {
828
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
829
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
830
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
831
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
832
		}
833
	}
834
835
	/**
836
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
837
	 * initialization code.
838
	 *
839
	 * @action plugins_loaded
840
	 */
841
	public function late_initialization() {
842
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
843
844
		Partner::init();
845
846
		/**
847
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
848
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
849
		 *
850
		 * @since 8.1.0
851
		 *
852
		 * @param Jetpack $jetpack the main plugin class object.
853
		 */
854
		do_action( 'jetpack_loaded', $this );
855
856
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
857
	}
858
859
	/**
860
	 * Sets up the XMLRPC request handlers.
861
	 *
862
	 * @deprecated since 7.7.0
863
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
864
	 *
865
	 * @param array                 $request_params Incoming request parameters.
866
	 * @param Boolean               $is_active      Whether the connection is currently active.
867
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
868
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
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...
869
	 */
870 View Code Duplication
	public function setup_xmlrpc_handlers(
871
		$request_params,
872
		$is_active,
873
		$is_signed,
874
		Jetpack_XMLRPC_Server $xmlrpc_server = null
875
	) {
876
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
877
878
		if ( ! $this->connection_manager ) {
879
			$this->connection_manager = new Connection_Manager();
880
		}
881
882
		return $this->connection_manager->setup_xmlrpc_handlers(
883
			$request_params,
884
			$is_active,
885
			$is_signed,
886
			$xmlrpc_server
887
		);
888
	}
889
890
	/**
891
	 * Initialize REST API registration connector.
892
	 *
893
	 * @deprecated since 7.7.0
894
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
895
	 */
896 View Code Duplication
	public function initialize_rest_api_registration_connector() {
897
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
898
899
		if ( ! $this->connection_manager ) {
900
			$this->connection_manager = new Connection_Manager();
901
		}
902
903
		$this->connection_manager->initialize_rest_api_registration_connector();
904
	}
905
906
	/**
907
	 * This is ported over from the manage module, which has been deprecated and baked in here.
908
	 *
909
	 * @param $domains
910
	 */
911
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
912
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
913
	}
914
915
	/**
916
	 * Return $domains, with 'wordpress.com' appended.
917
	 * This is ported over from the manage module, which has been deprecated and baked in here.
918
	 *
919
	 * @param $domains
920
	 * @return array
921
	 */
922
	function allow_wpcom_domain( $domains ) {
923
		if ( empty( $domains ) ) {
924
			$domains = array();
925
		}
926
		$domains[] = 'wordpress.com';
927
		return array_unique( $domains );
928
	}
929
930
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
931
		$post = get_post( $post_id );
932
933
		if ( empty( $post ) ) {
934
			return $default_url;
935
		}
936
937
		$post_type = $post->post_type;
938
939
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
940
		// https://en.support.wordpress.com/custom-post-types/
941
		$allowed_post_types = array(
942
			'post',
943
			'page',
944
			'jetpack-portfolio',
945
			'jetpack-testimonial',
946
		);
947
948
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
949
			return $default_url;
950
		}
951
952
		return esc_url(
953
			Redirect::get_url(
954
				'calypso-edit-' . $post_type,
955
				array(
956
					'path' => $post_id,
957
				)
958
			)
959
		);
960
	}
961
962
	function point_edit_comment_links_to_calypso( $url ) {
963
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
964
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
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...
Unused Code introduced by
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3343
				)
3344
			);
3345
			foreach ( $domains_to_check as $domain ) {
3346
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
Documentation introduced by
$domain is of type array<string,string>|false, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
3347
				if ( is_wp_error( $result ) ) {
3348
					return $result;
3349
				}
3350
			}
3351
		}
3352
3353
		$result = self::register();
3354
3355
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3356
		if ( ! $result || is_wp_error( $result ) ) {
3357
			return $result;
3358
		} else {
3359
			return true;
3360
		}
3361
	}
3362
3363
	/**
3364
	 * Tracking an internal event log. Try not to put too much chaff in here.
3365
	 *
3366
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3367
	 */
3368
	public static function log( $code, $data = null ) {
3369
		// only grab the latest 200 entries
3370
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3371
3372
		// Append our event to the log
3373
		$log_entry = array(
3374
			'time'    => time(),
3375
			'user_id' => get_current_user_id(),
3376
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3377
			'code'    => $code,
3378
		);
3379
		// Don't bother storing it unless we've got some.
3380
		if ( ! is_null( $data ) ) {
3381
			$log_entry['data'] = $data;
3382
		}
3383
		$log[] = $log_entry;
3384
3385
		// Try add_option first, to make sure it's not autoloaded.
3386
		// @todo: Add an add_option method to Jetpack_Options
3387
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3388
			Jetpack_Options::update_option( 'log', $log );
3389
		}
3390
3391
		/**
3392
		 * Fires when Jetpack logs an internal event.
3393
		 *
3394
		 * @since 3.0.0
3395
		 *
3396
		 * @param array $log_entry {
3397
		 *  Array of details about the log entry.
3398
		 *
3399
		 *  @param string time Time of the event.
3400
		 *  @param int user_id ID of the user who trigerred the event.
3401
		 *  @param int blog_id Jetpack Blog ID.
3402
		 *  @param string code Unique name for the event.
3403
		 *  @param string data Data about the event.
3404
		 * }
3405
		 */
3406
		do_action( 'jetpack_log_entry', $log_entry );
3407
	}
3408
3409
	/**
3410
	 * Get the internal event log.
3411
	 *
3412
	 * @param $event (string) - only return the specific log events
3413
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3414
	 *
3415
	 * @return array of log events || WP_Error for invalid params
3416
	 */
3417
	public static function get_log( $event = false, $num = false ) {
3418
		if ( $event && ! is_string( $event ) ) {
3419
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
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...
3420
		}
3421
3422
		if ( $num && ! is_numeric( $num ) ) {
3423
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
Unused Code introduced by
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...
3424
		}
3425
3426
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3427
3428
		// If nothing set - act as it did before, otherwise let's start customizing the output
3429
		if ( ! $num && ! $event ) {
3430
			return $entire_log;
3431
		} else {
3432
			$entire_log = array_reverse( $entire_log );
3433
		}
3434
3435
		$custom_log_output = array();
3436
3437
		if ( $event ) {
3438
			foreach ( $entire_log as $log_event ) {
3439
				if ( $event == $log_event['code'] ) {
3440
					$custom_log_output[] = $log_event;
3441
				}
3442
			}
3443
		} else {
3444
			$custom_log_output = $entire_log;
3445
		}
3446
3447
		if ( $num ) {
3448
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3449
		}
3450
3451
		return $custom_log_output;
3452
	}
3453
3454
	/**
3455
	 * Log modification of important settings.
3456
	 */
3457
	public static function log_settings_change( $option, $old_value, $value ) {
3458
		switch ( $option ) {
3459
			case 'jetpack_sync_non_public_post_stati':
3460
				self::log( $option, $value );
3461
				break;
3462
		}
3463
	}
3464
3465
	/**
3466
	 * Return stat data for WPCOM sync
3467
	 */
3468
	public static function get_stat_data( $encode = true, $extended = true ) {
3469
		$data = Jetpack_Heartbeat::generate_stats_array();
3470
3471
		if ( $extended ) {
3472
			$additional_data = self::get_additional_stat_data();
3473
			$data            = array_merge( $data, $additional_data );
3474
		}
3475
3476
		if ( $encode ) {
3477
			return json_encode( $data );
3478
		}
3479
3480
		return $data;
3481
	}
3482
3483
	/**
3484
	 * Get additional stat data to sync to WPCOM
3485
	 */
3486
	public static function get_additional_stat_data( $prefix = '' ) {
3487
		$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...
3488
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3489
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3490
		$return[ "{$prefix}site-count" ]    = 0;
3491
3492
		if ( function_exists( 'get_blog_count' ) ) {
3493
			$return[ "{$prefix}site-count" ] = get_blog_count();
3494
		}
3495
		return $return;
3496
	}
3497
3498
	private static function get_site_user_count() {
3499
		global $wpdb;
3500
3501
		if ( function_exists( 'wp_is_large_network' ) ) {
3502
			if ( wp_is_large_network( 'users' ) ) {
3503
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3504
			}
3505
		}
3506
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3507
			// It wasn't there, so regenerate the data and save the transient
3508
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3509
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3510
		}
3511
		return $user_count;
3512
	}
3513
3514
	/* Admin Pages */
3515
3516
	function admin_init() {
3517
		// If the plugin is not connected, display a connect message.
3518
		if (
3519
			// the plugin was auto-activated and needs its candy
3520
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3521
		||
3522
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3523
			! Jetpack_Options::get_option( 'activated' )
3524
		) {
3525
			self::plugin_initialize();
3526
		}
3527
3528
		$is_development_mode = ( new Status() )->is_development_mode();
3529
		if ( ! self::is_active() && ! $is_development_mode ) {
3530
			Jetpack_Connection_Banner::init();
3531
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3532
			// Upgrade: 1.1 -> 1.1.1
3533
			// Check and see if host can verify the Jetpack servers' SSL certificate
3534
			$args       = array();
3535
			$connection = self::connection();
3536
			Client::_wp_remote_request(
3537
				Connection_Utils::fix_url_for_bad_hosts( $connection->api_url( 'test' ) ),
3538
				$args,
3539
				true
3540
			);
3541
		}
3542
3543
		Jetpack_Wizard_Banner::init();
3544
3545
		if ( current_user_can( 'manage_options' ) && 'AUTO' == JETPACK_CLIENT__HTTPS && ! self::permit_ssl() ) {
3546
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3547
		}
3548
3549
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3550
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3551
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3552
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3553
3554
		if ( self::is_active() || $is_development_mode ) {
3555
			// Artificially throw errors in certain specific cases during plugin activation.
3556
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3557
		}
3558
3559
		// Add custom column in wp-admin/users.php to show whether user is linked.
3560
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3561
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3562
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3563
	}
3564
3565
	function admin_body_class( $admin_body_class = '' ) {
3566
		$classes = explode( ' ', trim( $admin_body_class ) );
3567
3568
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3569
3570
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3571
		return " $admin_body_class ";
3572
	}
3573
3574
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3575
		return $admin_body_class . ' jetpack-pagestyles ';
3576
	}
3577
3578
	/**
3579
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3580
	 * This function artificially throws errors for such cases (per a specific list).
3581
	 *
3582
	 * @param string $plugin The activated plugin.
3583
	 */
3584
	function throw_error_on_activate_plugin( $plugin ) {
3585
		$active_modules = self::get_active_modules();
3586
3587
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3588
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3589
			$throw = false;
3590
3591
			// Try and make sure it really was the stats plugin
3592
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3593
				if ( 'stats.php' == basename( $plugin ) ) {
3594
					$throw = true;
3595
				}
3596
			} else {
3597
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3598
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3599
					$throw = true;
3600
				}
3601
			}
3602
3603
			if ( $throw ) {
3604
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3605
			}
3606
		}
3607
	}
3608
3609
	function intercept_plugin_error_scrape_init() {
3610
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3611
	}
3612
3613
	function intercept_plugin_error_scrape( $action, $result ) {
3614
		if ( ! $result ) {
3615
			return;
3616
		}
3617
3618
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3619
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3620
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3621
			}
3622
		}
3623
	}
3624
3625
	/**
3626
	 * Register the remote file upload request handlers, if needed.
3627
	 *
3628
	 * @access public
3629
	 */
3630
	public function add_remote_request_handlers() {
3631
		// Remote file uploads are allowed only via AJAX requests.
3632
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3633
			return;
3634
		}
3635
3636
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3637
		$remote_request_actions = array(
3638
			'jetpack_upload_file',
3639
			'jetpack_update_file',
3640
		);
3641
3642
		// phpcs:ignore WordPress.Security.NonceVerification
3643
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3644
			return;
3645
		}
3646
3647
		// Require Jetpack authentication for the remote file upload AJAX requests.
3648
		if ( ! $this->connection_manager ) {
3649
			$this->connection_manager = new Connection_Manager();
3650
		}
3651
3652
		$this->connection_manager->require_jetpack_authentication();
3653
3654
		// Register the remote file upload AJAX handlers.
3655
		foreach ( $remote_request_actions as $action ) {
3656
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3657
		}
3658
	}
3659
3660
	/**
3661
	 * Handler for Jetpack remote file uploads.
3662
	 *
3663
	 * @access public
3664
	 */
3665
	public function remote_request_handlers() {
3666
		$action = current_filter();
0 ignored issues
show
Unused Code introduced by
$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...
3667
3668
		switch ( current_filter() ) {
3669
			case 'wp_ajax_nopriv_jetpack_upload_file':
3670
				$response = $this->upload_handler();
3671
				break;
3672
3673
			case 'wp_ajax_nopriv_jetpack_update_file':
3674
				$response = $this->upload_handler( true );
3675
				break;
3676
			default:
3677
				$response = new WP_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_handler'.

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

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

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

Loading history...
3678
				break;
3679
		}
3680
3681
		if ( ! $response ) {
3682
			$response = new WP_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_error'.

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

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

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

Loading history...
3683
		}
3684
3685
		if ( is_wp_error( $response ) ) {
3686
			$status_code       = $response->get_error_data();
0 ignored issues
show
Bug introduced by
The method get_error_data() does not seem to exist on object<WP_Error>.

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

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

Loading history...
3687
			$error             = $response->get_error_code();
0 ignored issues
show
Bug introduced by
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...
3688
			$error_description = $response->get_error_message();
0 ignored issues
show
Bug introduced by
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...
3689
3690
			if ( ! is_int( $status_code ) ) {
3691
				$status_code = 400;
3692
			}
3693
3694
			status_header( $status_code );
3695
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3696
		}
3697
3698
		status_header( 200 );
3699
		if ( true === $response ) {
3700
			exit;
3701
		}
3702
3703
		die( json_encode( (object) $response ) );
3704
	}
3705
3706
	/**
3707
	 * Uploads a file gotten from the global $_FILES.
3708
	 * If `$update_media_item` is true and `post_id` is defined
3709
	 * the attachment file of the media item (gotten through of the post_id)
3710
	 * will be updated instead of add a new one.
3711
	 *
3712
	 * @param  boolean $update_media_item - update media attachment
3713
	 * @return array - An array describing the uploadind files process
3714
	 */
3715
	function upload_handler( $update_media_item = false ) {
3716
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3717
			return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 405.

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

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

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

Loading history...
3718
		}
3719
3720
		$user = wp_authenticate( '', '' );
3721
		if ( ! $user || is_wp_error( $user ) ) {
3722
			return new WP_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 403.

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

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

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

Loading history...
3723
		}
3724
3725
		wp_set_current_user( $user->ID );
3726
3727
		if ( ! current_user_can( 'upload_files' ) ) {
3728
			return new WP_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

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

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

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

Loading history...
3729
		}
3730
3731
		if ( empty( $_FILES ) ) {
3732
			return new WP_Error( 'no_files_uploaded', 'No files were uploaded: nothing to process', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'no_files_uploaded'.

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

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

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

Loading history...
3733
		}
3734
3735
		foreach ( array_keys( $_FILES ) as $files_key ) {
3736
			if ( ! isset( $_POST[ "_jetpack_file_hmac_{$files_key}" ] ) ) {
3737
				return new WP_Error( 'missing_hmac', 'An HMAC for one or more files is missing', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'missing_hmac'.

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

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

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

Loading history...
3738
			}
3739
		}
3740
3741
		$media_keys = array_keys( $_FILES['media'] );
3742
3743
		$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...
3744
		if ( ! $token || is_wp_error( $token ) ) {
3745
			return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_token'.

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

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

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

Loading history...
3746
		}
3747
3748
		$uploaded_files = array();
3749
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3750
		unset( $GLOBALS['post'] );
3751
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3752
			$file = array();
3753
			foreach ( $media_keys as $media_key ) {
3754
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3755
			}
3756
3757
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3758
3759
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3760
			if ( $hmac_provided !== $hmac_file ) {
3761
				$uploaded_files[ $index ] = (object) array(
3762
					'error'             => 'invalid_hmac',
3763
					'error_description' => 'The corresponding HMAC for this file does not match',
3764
				);
3765
				continue;
3766
			}
3767
3768
			$_FILES['.jetpack.upload.'] = $file;
3769
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3770
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3771
				$post_id = 0;
3772
			}
3773
3774
			if ( $update_media_item ) {
3775
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3776
					return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'invalid_input'.

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

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

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

Loading history...
3777
				}
3778
3779
				$media_array = $_FILES['media'];
3780
3781
				$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...
3782
				$file_array['type']     = $media_array['type'][0];
3783
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3784
				$file_array['error']    = $media_array['error'][0];
3785
				$file_array['size']     = $media_array['size'][0];
3786
3787
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3788
3789
				if ( is_wp_error( $edited_media_item ) ) {
3790
					return $edited_media_item;
3791
				}
3792
3793
				$response = (object) array(
3794
					'id'   => (string) $post_id,
3795
					'file' => (string) $edited_media_item->post_title,
3796
					'url'  => (string) wp_get_attachment_url( $post_id ),
3797
					'type' => (string) $edited_media_item->post_mime_type,
3798
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3799
				);
3800
3801
				return (array) array( $response );
3802
			}
3803
3804
			$attachment_id = media_handle_upload(
3805
				'.jetpack.upload.',
3806
				$post_id,
3807
				array(),
3808
				array(
3809
					'action' => 'jetpack_upload_file',
3810
				)
3811
			);
3812
3813
			if ( ! $attachment_id ) {
3814
				$uploaded_files[ $index ] = (object) array(
3815
					'error'             => 'unknown',
3816
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3817
				);
3818
			} elseif ( is_wp_error( $attachment_id ) ) {
3819
				$uploaded_files[ $index ] = (object) array(
3820
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3821
					'error_description' => $attachment_id->get_error_message(),
3822
				);
3823
			} else {
3824
				$attachment               = get_post( $attachment_id );
3825
				$uploaded_files[ $index ] = (object) array(
3826
					'id'   => (string) $attachment_id,
3827
					'file' => $attachment->post_title,
3828
					'url'  => wp_get_attachment_url( $attachment_id ),
3829
					'type' => $attachment->post_mime_type,
3830
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3831
				);
3832
				// Zip files uploads are not supported unless they are done for installation purposed
3833
				// lets delete them in case something goes wrong in this whole process
3834
				if ( 'application/zip' === $attachment->post_mime_type ) {
3835
					// Schedule a cleanup for 2 hours from now in case of failed install.
3836
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3837
				}
3838
			}
3839
		}
3840
		if ( ! is_null( $global_post ) ) {
3841
			$GLOBALS['post'] = $global_post;
3842
		}
3843
3844
		return $uploaded_files;
3845
	}
3846
3847
	/**
3848
	 * Add help to the Jetpack page
3849
	 *
3850
	 * @since Jetpack (1.2.3)
3851
	 * @return false if not the Jetpack page
3852
	 */
3853
	function admin_help() {
3854
		$current_screen = get_current_screen();
3855
3856
		// Overview
3857
		$current_screen->add_help_tab(
3858
			array(
3859
				'id'      => 'home',
3860
				'title'   => __( 'Home', 'jetpack' ),
3861
				'content' =>
3862
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3863
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3864
					'<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>',
3865
			)
3866
		);
3867
3868
		// Screen Content
3869
		if ( current_user_can( 'manage_options' ) ) {
3870
			$current_screen->add_help_tab(
3871
				array(
3872
					'id'      => 'settings',
3873
					'title'   => __( 'Settings', 'jetpack' ),
3874
					'content' =>
3875
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3876
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3877
						'<ol>' .
3878
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3879
							'<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>' .
3880
						'</ol>' .
3881
						'<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>',
3882
				)
3883
			);
3884
		}
3885
3886
		// Help Sidebar
3887
		$support_url = Redirect::get_url( 'jetpack-support' );
3888
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
3889
		$current_screen->set_help_sidebar(
3890
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3891
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3892
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3893
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3894
		);
3895
	}
3896
3897
	function admin_menu_css() {
3898
		wp_enqueue_style( 'jetpack-icons' );
3899
	}
3900
3901
	function admin_menu_order() {
3902
		return true;
3903
	}
3904
3905 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
3906
		$jp_menu_order = array();
3907
3908
		foreach ( $menu_order as $index => $item ) {
3909
			if ( $item != 'jetpack' ) {
3910
				$jp_menu_order[] = $item;
3911
			}
3912
3913
			if ( $index == 0 ) {
3914
				$jp_menu_order[] = 'jetpack';
3915
			}
3916
		}
3917
3918
		return $jp_menu_order;
3919
	}
3920
3921
	function admin_banner_styles() {
3922
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3923
3924 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3925
			wp_register_style(
3926
				'jetpack-dops-style',
3927
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3928
				array(),
3929
				JETPACK__VERSION
3930
			);
3931
		}
3932
3933
		wp_enqueue_style(
3934
			'jetpack',
3935
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3936
			array( 'jetpack-dops-style' ),
3937
			JETPACK__VERSION . '-20121016'
3938
		);
3939
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3940
		wp_style_add_data( 'jetpack', 'suffix', $min );
3941
	}
3942
3943
	function plugin_action_links( $actions ) {
3944
3945
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3946
3947
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
3948
			return array_merge(
3949
				$jetpack_home,
3950
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3951
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3952
				$actions
3953
			);
3954
		}
3955
3956
		return array_merge( $jetpack_home, $actions );
3957
	}
3958
3959
	/**
3960
	 * Adds the deactivation warning modal if there are other active plugins using the connection
3961
	 *
3962
	 * @param string $hook The current admin page.
3963
	 *
3964
	 * @return void
3965
	 */
3966
	public function deactivate_dialog( $hook ) {
3967
		if (
3968
			'plugins.php' === $hook
3969
			&& self::is_active()
3970
		) {
3971
3972
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
3973
3974
			if ( count( $active_plugins_using_connection ) > 1 ) {
3975
3976
				add_thickbox();
3977
3978
				wp_register_script(
3979
					'jp-tracks',
3980
					'//stats.wp.com/w.js',
3981
					array(),
3982
					gmdate( 'YW' ),
3983
					true
3984
				);
3985
3986
				wp_register_script(
3987
					'jp-tracks-functions',
3988
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
3989
					array( 'jp-tracks' ),
3990
					JETPACK__VERSION,
3991
					false
3992
				);
3993
3994
				wp_enqueue_script(
3995
					'jetpack-deactivate-dialog-js',
3996
					Assets::get_file_url_for_environment(
3997
						'_inc/build/jetpack-deactivate-dialog.min.js',
3998
						'_inc/jetpack-deactivate-dialog.js'
3999
					),
4000
					array( 'jquery', 'jp-tracks-functions' ),
4001
					JETPACK__VERSION,
4002
					true
4003
				);
4004
4005
				wp_localize_script(
4006
					'jetpack-deactivate-dialog-js',
4007
					'deactivate_dialog',
4008
					array(
4009
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4010
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4011
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4012
					)
4013
				);
4014
4015
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4016
4017
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4018
			}
4019
		}
4020
	}
4021
4022
	/**
4023
	 * Outputs the content of the deactivation modal
4024
	 *
4025
	 * @return void
4026
	 */
4027
	public function deactivate_dialog_content() {
4028
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4029
		unset( $active_plugins_using_connection['jetpack'] );
4030
		$this->load_view( 'admin/deactivation-dialog.php', $active_plugins_using_connection );
0 ignored issues
show
Bug introduced by
It seems like $active_plugins_using_connection defined by \Automattic\Jetpack\Conn...ugin_Storage::get_all() on line 4028 can also be of type object<WP_Error>; however, Jetpack::load_view() does only seem to accept array, maybe add an additional type check?

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

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

    return array();
}

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

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

Loading history...
4031
	}
4032
4033
	/**
4034
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4035
	 *
4036
	 * @param string $login_url The wp-login URL.
4037
	 * @param string $redirect  URL to redirect users after logging in.
4038
	 * @since Jetpack 8.4
4039
	 * @return string
4040
	 */
4041
	public function login_url( $login_url, $redirect ) {
4042
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
0 ignored issues
show
Unused Code introduced by
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

Loading history...
4043
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4044
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4045
		}
4046
		return $login_url;
4047
	}
4048
4049
	/**
4050
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4051
	 *
4052
	 * @since Jetpack 8.4
4053
	 */
4054
	public function login_init() {
4055
		// phpcs:ignore WordPress.Security.NonceVerification
4056
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4057
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4058
			wp_safe_redirect(
4059
				add_query_arg(
4060
					array(
4061
						'forceInstall' => 1,
4062
						'url'          => rawurlencode( get_site_url() ),
4063
					),
4064
					// @todo provide way to go to specific calypso env.
4065
					self::get_calypso_host() . 'jetpack/connect'
4066
				)
4067
			);
4068
			exit;
4069
		}
4070
	}
4071
4072
	/*
4073
	 * Registration flow:
4074
	 * 1 - ::admin_page_load() action=register
4075
	 * 2 - ::try_registration()
4076
	 * 3 - ::register()
4077
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4078
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4079
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4080
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4081
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4082
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4083
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4084
	 *       jetpack_id, jetpack_secret, jetpack_public
4085
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4086
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4087
	 * 5 - user logs in with WP.com account
4088
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4089
	 *		- Manager::authorize()
4090
	 *		- Manager::get_token()
4091
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4092
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4093
	 *			- which responds with access_token, token_type, scope
4094
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4095
	 *		- Jetpack::activate_default_modules()
4096
	 *     		- Deactivates deprecated plugins
4097
	 *     		- Activates all default modules
4098
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4099
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4100
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4101
	 *     Done!
4102
	 */
4103
4104
	/**
4105
	 * Handles the page load events for the Jetpack admin page
4106
	 */
4107
	function admin_page_load() {
4108
		$error = false;
4109
4110
		// Make sure we have the right body class to hook stylings for subpages off of.
4111
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4112
4113
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4114
			// Should only be used in intermediate redirects to preserve state across redirects
4115
			self::restate();
4116
		}
4117
4118
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4119
			// @todo: Add validation against a known allowed list.
4120
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4121
			// User clicked in the iframe to link their accounts
4122
			if ( ! self::is_user_connected() ) {
4123
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4124
4125
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4126
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4127
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4128
4129
				if ( isset( $_GET['notes_iframe'] ) ) {
4130
					$connect_url .= '&notes_iframe';
4131
				}
4132
				wp_redirect( $connect_url );
4133
				exit;
4134
			} else {
4135
				if ( ! isset( $_GET['calypso_env'] ) ) {
4136
					self::state( 'message', 'already_authorized' );
4137
					wp_safe_redirect( self::admin_url() );
4138
					exit;
4139
				} else {
4140
					$connect_url  = $this->build_connect_url( true, false, $from );
4141
					$connect_url .= '&already_authorized=true';
4142
					wp_redirect( $connect_url );
4143
					exit;
4144
				}
4145
			}
4146
		}
4147
4148
		if ( isset( $_GET['action'] ) ) {
4149
			switch ( $_GET['action'] ) {
4150
				case 'authorize':
4151
					if ( self::is_active() && self::is_user_connected() ) {
4152
						self::state( 'message', 'already_authorized' );
4153
						wp_safe_redirect( self::admin_url() );
4154
						exit;
4155
					}
4156
					self::log( 'authorize' );
4157
					$client_server = new Jetpack_Client_Server();
4158
					$client_server->client_authorize();
4159
					exit;
4160
				case 'register':
4161
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4162
						$error = 'cheatin';
4163
						break;
4164
					}
4165
					check_admin_referer( 'jetpack-register' );
4166
					self::log( 'register' );
4167
					self::maybe_set_version_option();
4168
					$registered = self::try_registration();
4169 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4170
						$error = $registered->get_error_code();
0 ignored issues
show
Bug introduced by
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...
4171
						self::state( 'error', $error );
4172
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
Bug introduced by
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...
4173
4174
						/**
4175
						 * Jetpack registration Error.
4176
						 *
4177
						 * @since 7.5.0
4178
						 *
4179
						 * @param string|int $error The error code.
4180
						 * @param \WP_Error $registered The error object.
4181
						 */
4182
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4183
						break;
4184
					}
4185
4186
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4187
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4188
4189
					/**
4190
					 * Jetpack registration Success.
4191
					 *
4192
					 * @since 7.5.0
4193
					 *
4194
					 * @param string $from 'from' GET parameter;
4195
					 */
4196
					do_action( 'jetpack_connection_register_success', $from );
4197
4198
					$url = $this->build_connect_url( true, $redirect, $from );
4199
4200
					if ( ! empty( $_GET['onboarding'] ) ) {
4201
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4202
					}
4203
4204
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4205
						$url = add_query_arg( 'auth_approved', 'true', $url );
4206
					}
4207
4208
					wp_redirect( $url );
4209
					exit;
4210
				case 'activate':
4211
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4212
						$error = 'cheatin';
4213
						break;
4214
					}
4215
4216
					$module = stripslashes( $_GET['module'] );
4217
					check_admin_referer( "jetpack_activate-$module" );
4218
					self::log( 'activate', $module );
4219
					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...
4220
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4221
					}
4222
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4223
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4224
					exit;
4225
				case 'activate_default_modules':
4226
					check_admin_referer( 'activate_default_modules' );
4227
					self::log( 'activate_default_modules' );
4228
					self::restate();
4229
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4230
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4231
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4232
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4233
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4234
					exit;
4235
				case 'disconnect':
4236
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4237
						$error = 'cheatin';
4238
						break;
4239
					}
4240
4241
					check_admin_referer( 'jetpack-disconnect' );
4242
					self::log( 'disconnect' );
4243
					self::disconnect();
4244
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4245
					exit;
4246
				case 'reconnect':
4247
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4248
						$error = 'cheatin';
4249
						break;
4250
					}
4251
4252
					check_admin_referer( 'jetpack-reconnect' );
4253
					self::log( 'reconnect' );
4254
					$this->disconnect();
4255
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4256
					exit;
4257 View Code Duplication
				case 'deactivate':
4258
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4259
						$error = 'cheatin';
4260
						break;
4261
					}
4262
4263
					$modules = stripslashes( $_GET['module'] );
4264
					check_admin_referer( "jetpack_deactivate-$modules" );
4265
					foreach ( explode( ',', $modules ) as $module ) {
4266
						self::log( 'deactivate', $module );
4267
						self::deactivate_module( $module );
4268
						self::state( 'message', 'module_deactivated' );
4269
					}
4270
					self::state( 'module', $modules );
4271
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4272
					exit;
4273
				case 'unlink':
4274
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4275
					check_admin_referer( 'jetpack-unlink' );
4276
					self::log( 'unlink' );
4277
					Connection_Manager::disconnect_user();
4278
					self::state( 'message', 'unlinked' );
4279
					if ( 'sub-unlink' == $redirect ) {
4280
						wp_safe_redirect( admin_url() );
4281
					} else {
4282
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4283
					}
4284
					exit;
4285
				case 'onboard':
4286
					if ( ! current_user_can( 'manage_options' ) ) {
4287
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4288
					} else {
4289
						self::create_onboarding_token();
4290
						$url = $this->build_connect_url( true );
4291
4292
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4293
							$url = add_query_arg( 'onboarding', $token, $url );
4294
						}
4295
4296
						$calypso_env = $this->get_calypso_env();
4297
						if ( ! empty( $calypso_env ) ) {
4298
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4299
						}
4300
4301
						wp_redirect( $url );
4302
						exit;
4303
					}
4304
					exit;
4305
				default:
4306
					/**
4307
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4308
					 *
4309
					 * @since 2.6.0
4310
					 *
4311
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4312
					 */
4313
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4314
			}
4315
		}
4316
4317
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4318
			self::activate_new_modules( true );
4319
		}
4320
4321
		$message_code = self::state( 'message' );
4322
		if ( self::state( 'optin-manage' ) ) {
4323
			$activated_manage = $message_code;
4324
			$message_code     = 'jetpack-manage';
4325
		}
4326
4327
		switch ( $message_code ) {
4328
			case 'jetpack-manage':
4329
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4330
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4331
				$this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), $sites_url ) . '</strong>';
4332
				if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
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...
4333
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4334
				}
4335
				break;
4336
4337
		}
4338
4339
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4340
4341
		if ( ! empty( $deactivated_plugins ) ) {
4342
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4343
			$deactivated_titles  = array();
4344
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4345
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4346
					continue;
4347
				}
4348
4349
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4350
			}
4351
4352
			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...
4353
				if ( $this->message ) {
4354
					$this->message .= "<br /><br />\n";
4355
				}
4356
4357
				$this->message .= wp_sprintf(
4358
					_n(
4359
						'Jetpack contains the most recent version of the old %l plugin.',
4360
						'Jetpack contains the most recent versions of the old %l plugins.',
4361
						count( $deactivated_titles ),
4362
						'jetpack'
4363
					),
4364
					$deactivated_titles
4365
				);
4366
4367
				$this->message .= "<br />\n";
4368
4369
				$this->message .= _n(
4370
					'The old version has been deactivated and can be removed from your site.',
4371
					'The old versions have been deactivated and can be removed from your site.',
4372
					count( $deactivated_titles ),
4373
					'jetpack'
4374
				);
4375
			}
4376
		}
4377
4378
		$this->privacy_checks = self::state( 'privacy_checks' );
4379
4380
		if ( $this->message || $this->error || $this->privacy_checks ) {
4381
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4382
		}
4383
4384
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4385
	}
4386
4387
	function admin_notices() {
4388
4389
		if ( $this->error ) {
4390
			?>
4391
<div id="message" class="jetpack-message jetpack-err">
4392
	<div class="squeezer">
4393
		<h2>
4394
			<?php
4395
			echo wp_kses(
4396
				$this->error,
4397
				array(
4398
					'a'      => array( 'href' => array() ),
4399
					'small'  => true,
4400
					'code'   => true,
4401
					'strong' => true,
4402
					'br'     => true,
4403
					'b'      => true,
4404
				)
4405
			);
4406
			?>
4407
			</h2>
4408
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4409
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4410
<?php	endif; ?>
4411
	</div>
4412
</div>
4413
			<?php
4414
		}
4415
4416
		if ( $this->message ) {
4417
			?>
4418
<div id="message" class="jetpack-message">
4419
	<div class="squeezer">
4420
		<h2>
4421
			<?php
4422
			echo wp_kses(
4423
				$this->message,
4424
				array(
4425
					'strong' => array(),
4426
					'a'      => array( 'href' => true ),
4427
					'br'     => true,
4428
				)
4429
			);
4430
			?>
4431
			</h2>
4432
	</div>
4433
</div>
4434
			<?php
4435
		}
4436
4437
		if ( $this->privacy_checks ) :
4438
			$module_names = $module_slugs = array();
4439
4440
			$privacy_checks = explode( ',', $this->privacy_checks );
4441
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4442
			foreach ( $privacy_checks as $module_slug ) {
4443
				$module = self::get_module( $module_slug );
4444
				if ( ! $module ) {
4445
					continue;
4446
				}
4447
4448
				$module_slugs[] = $module_slug;
4449
				$module_names[] = "<strong>{$module['name']}</strong>";
4450
			}
4451
4452
			$module_slugs = join( ',', $module_slugs );
4453
			?>
4454
<div id="message" class="jetpack-message jetpack-err">
4455
	<div class="squeezer">
4456
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4457
		<p>
4458
			<?php
4459
			echo wp_kses(
4460
				wptexturize(
4461
					wp_sprintf(
4462
						_nx(
4463
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4464
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4465
							count( $privacy_checks ),
4466
							'%l = list of Jetpack module/feature names',
4467
							'jetpack'
4468
						),
4469
						$module_names
4470
					)
4471
				),
4472
				array( 'strong' => true )
4473
			);
4474
4475
			echo "\n<br />\n";
4476
4477
			echo wp_kses(
4478
				sprintf(
4479
					_nx(
4480
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4481
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4482
						count( $privacy_checks ),
4483
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4484
						'jetpack'
4485
					),
4486
					wp_nonce_url(
4487
						self::admin_url(
4488
							array(
4489
								'page'   => 'jetpack',
4490
								'action' => 'deactivate',
4491
								'module' => urlencode( $module_slugs ),
4492
							)
4493
						),
4494
						"jetpack_deactivate-$module_slugs"
4495
					),
4496
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4497
				),
4498
				array(
4499
					'a' => array(
4500
						'href'  => true,
4501
						'title' => true,
4502
					),
4503
				)
4504
			);
4505
			?>
4506
		</p>
4507
	</div>
4508
</div>
4509
			<?php
4510
endif;
4511
	}
4512
4513
	/**
4514
	 * We can't always respond to a signed XML-RPC request with a
4515
	 * helpful error message. In some circumstances, doing so could
4516
	 * leak information.
4517
	 *
4518
	 * Instead, track that the error occurred via a Jetpack_Option,
4519
	 * and send that data back in the heartbeat.
4520
	 * All this does is increment a number, but it's enough to find
4521
	 * trends.
4522
	 *
4523
	 * @param WP_Error $xmlrpc_error The error produced during
4524
	 *                               signature validation.
4525
	 */
4526
	function track_xmlrpc_error( $xmlrpc_error ) {
4527
		$code = is_wp_error( $xmlrpc_error )
4528
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
Bug introduced by
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...
4529
			: 'should-not-happen';
4530
4531
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4532
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4533
			// No need to update the option if we already have
4534
			// this code stored.
4535
			return;
4536
		}
4537
		$xmlrpc_errors[ $code ] = true;
4538
4539
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
Documentation introduced by
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...
4540
	}
4541
4542
	/**
4543
	 * Initialize the jetpack stats instance only when needed
4544
	 *
4545
	 * @return void
4546
	 */
4547
	private function initialize_stats() {
4548
		if ( is_null( $this->a8c_mc_stats_instance ) ) {
4549
			$this->a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4550
		}
4551
	}
4552
4553
	/**
4554
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4555
	 */
4556
	function stat( $group, $detail ) {
4557
		$this->initialize_stats();
4558
		$this->a8c_mc_stats_instance->add( $group, $detail );
4559
4560
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4561
		$this->stats = $this->a8c_mc_stats_instance->get_current_stats();
4562
	}
4563
4564
	/**
4565
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4566
	 */
4567
	function do_stats( $method = '' ) {
4568
		$this->initialize_stats();
4569
		if ( 'server_side' === $method ) {
4570
			$this->a8c_mc_stats_instance->do_server_side_stats();
4571
		} else {
4572
			$this->a8c_mc_stats_instance->do_stats();
4573
		}
4574
4575
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4576
		$this->stats = array();
4577
	}
4578
4579
	/**
4580
	 * Runs stats code for a one-off, server-side.
4581
	 *
4582
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4583
	 *
4584
	 * @return bool If it worked.
4585
	 */
4586
	static function do_server_side_stat( $args ) {
4587
		$url                   = self::build_stats_url( $args );
4588
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4589
		return $a8c_mc_stats_instance->do_server_side_stat( $url );
4590
	}
4591
4592
	/**
4593
	 * Builds the stats url.
4594
	 *
4595
	 * @param $args array|string The arguments to append to the URL.
4596
	 *
4597
	 * @return string The URL to be pinged.
4598
	 */
4599
	static function build_stats_url( $args ) {
4600
4601
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4602
		return $a8c_mc_stats_instance->build_stats_url( $args );
4603
4604
	}
4605
4606
	/**
4607
	 * Get the role of the current user.
4608
	 *
4609
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4610
	 *
4611
	 * @access public
4612
	 * @static
4613
	 *
4614
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4615
	 */
4616
	public static function translate_current_user_to_role() {
4617
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4618
4619
		$roles = new Roles();
4620
		return $roles->translate_current_user_to_role();
4621
	}
4622
4623
	/**
4624
	 * Get the role of a particular user.
4625
	 *
4626
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4627
	 *
4628
	 * @access public
4629
	 * @static
4630
	 *
4631
	 * @param \WP_User $user User object.
4632
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4633
	 */
4634
	public static function translate_user_to_role( $user ) {
4635
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4636
4637
		$roles = new Roles();
4638
		return $roles->translate_user_to_role( $user );
4639
	}
4640
4641
	/**
4642
	 * Get the minimum capability for a role.
4643
	 *
4644
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4645
	 *
4646
	 * @access public
4647
	 * @static
4648
	 *
4649
	 * @param string $role Role name.
4650
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4651
	 */
4652
	public static function translate_role_to_cap( $role ) {
4653
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4654
4655
		$roles = new Roles();
4656
		return $roles->translate_role_to_cap( $role );
4657
	}
4658
4659
	/**
4660
	 * Sign a user role with the master access token.
4661
	 * If not specified, will default to the current user.
4662
	 *
4663
	 * @deprecated since 7.7
4664
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4665
	 *
4666
	 * @access public
4667
	 * @static
4668
	 *
4669
	 * @param string $role    User role.
4670
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
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...
4671
	 * @return string Signed user role.
4672
	 */
4673
	public static function sign_role( $role, $user_id = null ) {
4674
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4675
		return self::connection()->sign_role( $role, $user_id );
4676
	}
4677
4678
	/**
4679
	 * Builds a URL to the Jetpack connection auth page
4680
	 *
4681
	 * @since 3.9.5
4682
	 *
4683
	 * @param bool        $raw If true, URL will not be escaped.
4684
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4685
	 *                              If string, will be a custom redirect.
4686
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4687
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4688
	 *
4689
	 * @return string Connect URL
4690
	 */
4691
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4692
		$site_id    = Jetpack_Options::get_option( 'id' );
4693
		$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...
4694
4695
		if ( $register || ! $blog_token || ! $site_id ) {
4696
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4697
4698
			if ( ! empty( $redirect ) ) {
4699
				$url = add_query_arg(
4700
					'redirect',
4701
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4702
					$url
4703
				);
4704
			}
4705
4706
			if ( is_network_admin() ) {
4707
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4708
			}
4709
4710
			$calypso_env = self::get_calypso_env();
4711
4712
			if ( ! empty( $calypso_env ) ) {
4713
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4714
			}
4715
		} else {
4716
4717
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4718
			// because otherwise this logic can get us in to a loop.
4719
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4720
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4721
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4722
4723
				$response = Client::wpcom_json_api_request_as_blog(
4724
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4725
					'1.1'
4726
				);
4727
4728
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4729
4730
					// Generating a register URL instead to refresh the existing token
4731
					return $this->build_connect_url( $raw, $redirect, $from, true );
4732
				}
4733
			}
4734
4735
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4691 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...
4736
		}
4737
4738
		if ( $from ) {
4739
			$url = add_query_arg( 'from', $from, $url );
4740
		}
4741
4742
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4743
		/**
4744
		 * Filter the URL used when connecting a user to a WordPress.com account.
4745
		 *
4746
		 * @since 8.1.0
4747
		 *
4748
		 * @param string $url Connection URL.
4749
		 * @param bool   $raw If true, URL will not be escaped.
4750
		 */
4751
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $raw.

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

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

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

Loading history...
4752
	}
4753
4754
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4755
4756
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4757
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4758
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4759
4760
		if ( $iframe ) {
4761
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4762
		}
4763
4764
		$c8n = self::connection();
4765
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
Documentation introduced by
$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...
4766
4767
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4768
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4769
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4770
4771
		if ( $iframe ) {
4772
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4773
		}
4774
4775
		return $url;
4776
	}
4777
4778
	/**
4779
	 * Filters the connection URL parameter array.
4780
	 *
4781
	 * @param array $args default URL parameters used by the package.
4782
	 * @return array the modified URL arguments array.
4783
	 */
4784
	public static function filter_connect_request_body( $args ) {
4785
		if (
4786
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4787
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4788
		) {
4789
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4790
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4791
				? $gp_locale->slug
4792
				: '';
4793
		}
4794
4795
		$tracking        = new Tracking();
4796
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4797
4798
		$args = array_merge(
4799
			$args,
4800
			array(
4801
				'_ui' => $tracks_identity['_ui'],
4802
				'_ut' => $tracks_identity['_ut'],
4803
			)
4804
		);
4805
4806
		$calypso_env = self::get_calypso_env();
4807
4808
		if ( ! empty( $calypso_env ) ) {
4809
			$args['calypso_env'] = $calypso_env;
4810
		}
4811
4812
		return $args;
4813
	}
4814
4815
	/**
4816
	 * Filters the URL that will process the connection data. It can be different from the URL
4817
	 * that we send the user to after everything is done.
4818
	 *
4819
	 * @param String $processing_url the default redirect URL used by the package.
4820
	 * @return String the modified URL.
4821
	 */
4822
	public static function filter_connect_processing_url( $processing_url ) {
4823
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4824
		return $processing_url;
4825
	}
4826
4827
	/**
4828
	 * Filters the redirection URL that is used for connect requests. The redirect
4829
	 * URL should return the user back to the Jetpack console.
4830
	 *
4831
	 * @param String $redirect the default redirect URL used by the package.
4832
	 * @return String the modified URL.
4833
	 */
4834
	public static function filter_connect_redirect_url( $redirect ) {
4835
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4836
		$redirect           = $redirect
4837
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4838
			: $jetpack_admin_page;
4839
4840
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4841
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4842
		}
4843
4844
		return $redirect;
4845
	}
4846
4847
	/**
4848
	 * This action fires at the beginning of the Manager::authorize method.
4849
	 */
4850
	public static function authorize_starting() {
4851
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4852
		// Checking if site has been active/connected previously before recording unique connection.
4853
		if ( ! $jetpack_unique_connection ) {
4854
			// jetpack_unique_connection option has never been set.
4855
			$jetpack_unique_connection = array(
4856
				'connected'    => 0,
4857
				'disconnected' => 0,
4858
				'version'      => '3.6.1',
4859
			);
4860
4861
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4862
4863
			// Track unique connection.
4864
			$jetpack = self::init();
4865
4866
			$jetpack->stat( 'connections', 'unique-connection' );
4867
			$jetpack->do_stats( 'server_side' );
4868
		}
4869
4870
		// Increment number of times connected.
4871
		$jetpack_unique_connection['connected'] += 1;
4872
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4873
	}
4874
4875
	/**
4876
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4877
	 * linked.
4878
	 */
4879
	public static function authorize_ending_linked() {
4880
		// Don't activate anything since we are just connecting a user.
4881
		self::state( 'message', 'linked' );
4882
	}
4883
4884
	/**
4885
	 * This action fires at the end of the Manager::authorize method when the master user is
4886
	 * authorized.
4887
	 *
4888
	 * @param array $data The request data.
4889
	 */
4890
	public static function authorize_ending_authorized( $data ) {
4891
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4892
		self::invalidate_onboarding_token();
4893
4894
		// If redirect_uri is SSO, ensure SSO module is enabled.
4895
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
0 ignored issues
show
Unused Code introduced by
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

Loading history...
4896
4897
		/** This filter is documented in class.jetpack-cli.php */
4898
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4899
4900
		$activate_sso = (
4901
			isset( $redirect_options['action'] ) &&
4902
			'jetpack-sso' === $redirect_options['action'] &&
4903
			$jetpack_start_enable_sso
4904
		);
4905
4906
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4907
4908
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4909
	}
4910
4911
	/**
4912
	 * Get our assumed site creation date.
4913
	 * Calculated based on the earlier date of either:
4914
	 * - Earliest admin user registration date.
4915
	 * - Earliest date of post of any post type.
4916
	 *
4917
	 * @since 7.2.0
4918
	 * @deprecated since 7.8.0
4919
	 *
4920
	 * @return string Assumed site creation date and time.
4921
	 */
4922
	public static function get_assumed_site_creation_date() {
4923
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4924
		return self::connection()->get_assumed_site_creation_date();
4925
	}
4926
4927 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4928
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4929
4930
		if ( $activation_source_name ) {
4931
			$args['_as'] = urlencode( $activation_source_name );
4932
		}
4933
4934
		if ( $activation_source_keyword ) {
4935
			$args['_ak'] = urlencode( $activation_source_keyword );
4936
		}
4937
	}
4938
4939
	function build_reconnect_url( $raw = false ) {
4940
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4941
		return $raw ? $url : esc_url( $url );
4942
	}
4943
4944
	public static function admin_url( $args = null ) {
4945
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
0 ignored issues
show
Documentation introduced by
array('page' => 'jetpack') is of type array<string,string,{"page":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

There are different options of fixing this problem.

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

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

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

Loading history...
5721
				if ( strlen( $v ) ) {
5722
					$state[ $k ] = $v;
5723
				}
5724
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5725
			}
5726
		}
5727
5728
		if ( $restate ) {
5729
			foreach ( $state as $k => $v ) {
5730
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5731
			}
5732
			return;
5733
		}
5734
5735
		// Get a state variable.
5736
		if ( isset( $key ) && ! isset( $value ) ) {
5737
			if ( array_key_exists( $key, $state ) ) {
5738
				return $state[ $key ];
5739
			}
5740
			return null;
5741
		}
5742
5743
		// Set a state variable.
5744
		if ( isset( $key ) && isset( $value ) ) {
5745
			if ( is_array( $value ) && isset( $value[0] ) ) {
5746
				$value = $value[0];
5747
			}
5748
			$state[ $key ] = $value;
5749
			if ( ! headers_sent() ) {
5750
				if ( self::should_set_cookie( $key ) ) {
5751
					setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5752
				}
5753
			}
5754
		}
5755
	}
5756
5757
	public static function restate() {
5758
		self::state( null, null, true );
5759
	}
5760
5761
	/**
5762
	 * Determines whether the jetpackState[$key] value should be added to the
5763
	 * cookie.
5764
	 *
5765
	 * @param string $key The state key.
5766
	 *
5767
	 * @return boolean Whether the value should be added to the cookie.
5768
	 */
5769
	public static function should_set_cookie( $key ) {
5770
		global $current_screen;
5771
		$page = isset( $current_screen->base ) ? $current_screen->base : null;
5772
5773
		if ( 'toplevel_page_jetpack' === $page && 'display_update_modal' === $key ) {
5774
			return false;
5775
		}
5776
5777
		return true;
5778
	}
5779
5780
	public static function check_privacy( $file ) {
5781
		static $is_site_publicly_accessible = null;
5782
5783
		if ( is_null( $is_site_publicly_accessible ) ) {
5784
			$is_site_publicly_accessible = false;
5785
5786
			$rpc = new Jetpack_IXR_Client();
5787
5788
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5789
			if ( $success ) {
5790
				$response = $rpc->getResponse();
5791
				if ( $response ) {
5792
					$is_site_publicly_accessible = true;
5793
				}
5794
			}
5795
5796
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5797
		}
5798
5799
		if ( $is_site_publicly_accessible ) {
5800
			return;
5801
		}
5802
5803
		$module_slug = self::get_module_slug( $file );
5804
5805
		$privacy_checks = self::state( 'privacy_checks' );
5806
		if ( ! $privacy_checks ) {
5807
			$privacy_checks = $module_slug;
5808
		} else {
5809
			$privacy_checks .= ",$module_slug";
5810
		}
5811
5812
		self::state( 'privacy_checks', $privacy_checks );
5813
	}
5814
5815
	/**
5816
	 * Helper method for multicall XMLRPC.
5817
	 *
5818
	 * @param ...$args Args for the async_call.
5819
	 */
5820
	public static function xmlrpc_async_call( ...$args ) {
5821
		global $blog_id;
5822
		static $clients = array();
5823
5824
		$client_blog_id = is_multisite() ? $blog_id : 0;
5825
5826
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5827
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5828
			if ( function_exists( 'ignore_user_abort' ) ) {
5829
				ignore_user_abort( true );
5830
			}
5831
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5832
		}
5833
5834
		if ( ! empty( $args[0] ) ) {
5835
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5836
		} elseif ( is_multisite() ) {
5837
			foreach ( $clients as $client_blog_id => $client ) {
5838
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5839
					continue;
5840
				}
5841
5842
				$switch_success = switch_to_blog( $client_blog_id, true );
5843
				if ( ! $switch_success ) {
5844
					continue;
5845
				}
5846
5847
				flush();
5848
				$client->query();
5849
5850
				restore_current_blog();
5851
			}
5852
		} else {
5853
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5854
				flush();
5855
				$clients[0]->query();
5856
			}
5857
		}
5858
	}
5859
5860
	public static function staticize_subdomain( $url ) {
5861
5862
		// Extract hostname from URL
5863
		$host = wp_parse_url( $url, PHP_URL_HOST );
0 ignored issues
show
Unused Code introduced by
The call to wp_parse_url() has too many arguments starting with PHP_URL_HOST.

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

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

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

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

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
6859
	 */
6860
	public static function dns_prefetch( $urls = null ) {
6861
		_deprecated_function( __FUNCTION__, 'jetpack-8.8.0', 'Automattic\Jetpack\Assets::add_resource_hint' );
6862
		if ( $urls ) {
6863
			Assets::add_resource_hint( $urls );
6864
		}
6865
	}
6866
6867
	public function wp_dashboard_setup() {
6868
		if ( self::is_active() ) {
6869
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6870
		}
6871
6872
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6873
			$jetpack_logo = new Jetpack_Logo();
6874
			$widget_title = sprintf(
6875
				wp_kses(
6876
					/* translators: Placeholder is a Jetpack logo. */
6877
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6878
					array( 'span' => array() )
6879
				),
6880
				$jetpack_logo->get_jp_emblem( true )
6881
			);
6882
6883
			wp_add_dashboard_widget(
6884
				'jetpack_summary_widget',
6885
				$widget_title,
6886
				array( __CLASS__, 'dashboard_widget' )
6887
			);
6888
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6889
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6890
6891
			// If we're inactive and not in development mode, sort our box to the top.
6892
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6893
				global $wp_meta_boxes;
6894
6895
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
6896
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
6897
6898
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
6899
			}
6900
		}
6901
	}
6902
6903
	/**
6904
	 * @param mixed $result Value for the user's option
0 ignored issues
show
Bug introduced by
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...
6905
	 * @return mixed
6906
	 */
6907
	function get_user_option_meta_box_order_dashboard( $sorted ) {
6908
		if ( ! is_array( $sorted ) ) {
6909
			return $sorted;
6910
		}
6911
6912
		foreach ( $sorted as $box_context => $ids ) {
6913
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
6914
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
6915
				continue;
6916
			}
6917
6918
			$ids_array = explode( ',', $ids );
6919
			$key       = array_search( 'dashboard_stats', $ids_array );
6920
6921
			if ( false !== $key ) {
6922
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
6923
				$ids_array[ $key ]      = 'jetpack_summary_widget';
6924
				$sorted[ $box_context ] = implode( ',', $ids_array );
6925
				// We've found it, stop searching, and just return.
6926
				break;
6927
			}
6928
		}
6929
6930
		return $sorted;
6931
	}
6932
6933
	public static function dashboard_widget() {
6934
		/**
6935
		 * Fires when the dashboard is loaded.
6936
		 *
6937
		 * @since 3.4.0
6938
		 */
6939
		do_action( 'jetpack_dashboard_widget' );
6940
	}
6941
6942
	public static function dashboard_widget_footer() {
6943
		?>
6944
		<footer>
6945
6946
		<div class="protect">
6947
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
6948
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
6949
				<p class="blocked-count">
6950
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
6951
				</p>
6952
				<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>
6953
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
6954
				<a href="
6955
				<?php
6956
				echo esc_url(
6957
					wp_nonce_url(
6958
						self::admin_url(
6959
							array(
6960
								'action' => 'activate',
6961
								'module' => 'protect',
6962
							)
6963
						),
6964
						'jetpack_activate-protect'
6965
					)
6966
				);
6967
				?>
6968
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
6969
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
6970
				</a>
6971
			<?php else : ?>
6972
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
6973
			<?php endif; ?>
6974
		</div>
6975
6976
		<div class="akismet">
6977
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
6978
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
6979
				<p class="blocked-count">
6980
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
6981
				</p>
6982
				<p><?php echo esc_html_x( 'Blocked spam comments.', '{#} Spam comments blocked by Akismet -- number is on a prior line, text is a caption.', 'jetpack' ); ?></p>
6983
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
6984
				<a href="
6985
				<?php
6986
				echo esc_url(
6987
					wp_nonce_url(
6988
						add_query_arg(
6989
							array(
6990
								'action' => 'activate',
6991
								'plugin' => 'akismet/akismet.php',
6992
							),
6993
							admin_url( 'plugins.php' )
6994
						),
6995
						'activate-plugin_akismet/akismet.php'
6996
					)
6997
				);
6998
				?>
6999
							" class="button button-jetpack">
7000
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7001
				</a>
7002
			<?php else : ?>
7003
				<p><a href="<?php echo esc_url( 'https://akismet.com/?utm_source=jetpack&utm_medium=link&utm_campaign=Jetpack%20Dashboard%20Widget%20Footer%20Link' ); ?>"><?php esc_html_e( 'Anti-spam can help to keep your blog safe from spam!', 'jetpack' ); ?></a></p>
7004
			<?php endif; ?>
7005
		</div>
7006
7007
		</footer>
7008
		<?php
7009
	}
7010
7011
	/*
7012
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7013
	 */
7014
	function jetpack_icon_user_connected( $columns ) {
7015
		$columns['user_jetpack'] = '';
7016
		return $columns;
7017
	}
7018
7019
	/*
7020
	 * Show Jetpack icon if the user is linked.
7021
	 */
7022
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7023
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7024
			$jetpack_logo = new Jetpack_Logo();
7025
			$emblem_html  = sprintf(
7026
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7027
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7028
				$jetpack_logo->get_jp_emblem()
7029
			);
7030
			return $emblem_html;
7031
		}
7032
7033
		return $val;
7034
	}
7035
7036
	/*
7037
	 * Style the Jetpack user column
7038
	 */
7039
	function jetpack_user_col_style() {
7040
		global $current_screen;
7041
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7042
			?>
7043
			<style>
7044
				.fixed .column-user_jetpack {
7045
					width: 21px;
7046
				}
7047
				.jp-emblem-user-admin svg {
7048
					width: 20px;
7049
					height: 20px;
7050
				}
7051
				.jp-emblem-user-admin path {
7052
					fill: #00BE28;
7053
				}
7054
			</style>
7055
			<?php
7056
		}
7057
	}
7058
7059
	/**
7060
	 * Checks if Akismet is active and working.
7061
	 *
7062
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7063
	 * that implied usage of methods present since more recent version.
7064
	 * See https://github.com/Automattic/jetpack/pull/9585
7065
	 *
7066
	 * @since  5.1.0
7067
	 *
7068
	 * @return bool True = Akismet available. False = Aksimet not available.
7069
	 */
7070
	public static function is_akismet_active() {
7071
		static $status = null;
7072
7073
		if ( ! is_null( $status ) ) {
7074
			return $status;
7075
		}
7076
7077
		// Check if a modern version of Akismet is active.
7078
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7079
			$status = false;
7080
			return $status;
7081
		}
7082
7083
		// Make sure there is a key known to Akismet at all before verifying key.
7084
		$akismet_key = Akismet::get_api_key();
7085
		if ( ! $akismet_key ) {
7086
			$status = false;
7087
			return $status;
7088
		}
7089
7090
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7091
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7092
7093
		// 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.
7094
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7095
		// We cache the result of the Akismet key verification for ten minutes.
7096
		if ( ! $akismet_key_state || $recheck ) {
7097
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7098
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7099
		}
7100
7101
		$status = 'valid' === $akismet_key_state;
7102
7103
		return $status;
7104
	}
7105
7106
	/**
7107
	 * @deprecated
7108
	 *
7109
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7110
	 */
7111
	public static function is_function_in_backtrace() {
7112
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7113
	}
7114
7115
	/**
7116
	 * Given a minified path, and a non-minified path, will return
7117
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7118
	 *
7119
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7120
	 * root Jetpack directory.
7121
	 *
7122
	 * @since 5.6.0
7123
	 *
7124
	 * @param string $min_path
7125
	 * @param string $non_min_path
7126
	 * @return string The URL to the file
7127
	 */
7128
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7129
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7130
	}
7131
7132
	/**
7133
	 * Checks for whether Jetpack Backup is enabled.
7134
	 * Will return true if the state of Backup is anything except "unavailable".
7135
	 *
7136
	 * @return bool|int|mixed
7137
	 */
7138
	public static function is_rewind_enabled() {
7139
		if ( ! self::is_active() ) {
7140
			return false;
7141
		}
7142
7143
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7144
		if ( false === $rewind_enabled ) {
7145
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7146
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7147
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7148
				&& ! empty( $rewind_data['state'] )
7149
				&& 'active' === $rewind_data['state'] )
7150
				? 1
7151
				: 0;
7152
7153
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7154
		}
7155
		return $rewind_enabled;
7156
	}
7157
7158
	/**
7159
	 * Return Calypso environment value; used for developing Jetpack and pairing
7160
	 * it with different Calypso enrionments, such as localhost.
7161
	 *
7162
	 * @since 7.4.0
7163
	 *
7164
	 * @return string Calypso environment
7165
	 */
7166
	public static function get_calypso_env() {
7167
		if ( isset( $_GET['calypso_env'] ) ) {
7168
			return sanitize_key( $_GET['calypso_env'] );
7169
		}
7170
7171
		if ( getenv( 'CALYPSO_ENV' ) ) {
7172
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7173
		}
7174
7175
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7176
			return sanitize_key( CALYPSO_ENV );
7177
		}
7178
7179
		return '';
7180
	}
7181
7182
	/**
7183
	 * Returns the hostname with protocol for Calypso.
7184
	 * Used for developing Jetpack with Calypso.
7185
	 *
7186
	 * @since 8.4.0
7187
	 *
7188
	 * @return string Calypso host.
7189
	 */
7190
	public static function get_calypso_host() {
7191
		$calypso_env = self::get_calypso_env();
7192
		switch ( $calypso_env ) {
7193
			case 'development':
7194
				return 'http://calypso.localhost:3000/';
7195
			case 'wpcalypso':
7196
				return 'https://wpcalypso.wordpress.com/';
7197
			case 'horizon':
7198
				return 'https://horizon.wordpress.com/';
7199
			default:
7200
				return 'https://wordpress.com/';
7201
		}
7202
	}
7203
7204
	/**
7205
	 * Checks whether or not TOS has been agreed upon.
7206
	 * Will return true if a user has clicked to register, or is already connected.
7207
	 */
7208
	public static function jetpack_tos_agreed() {
7209
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7210
7211
		$terms_of_service = new Terms_Of_Service();
7212
		return $terms_of_service->has_agreed();
7213
7214
	}
7215
7216
	/**
7217
	 * Handles activating default modules as well general cleanup for the new connection.
7218
	 *
7219
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7220
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7221
	 * @param boolean $send_state_messages          Whether to send state messages.
7222
	 * @return void
7223
	 */
7224
	public static function handle_post_authorization_actions(
7225
		$activate_sso = false,
7226
		$redirect_on_activation_error = false,
7227
		$send_state_messages = true
7228
	) {
7229
		$other_modules = $activate_sso
7230
			? array( 'sso' )
7231
			: array();
7232
7233
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7234
			self::delete_active_modules();
7235
7236
			self::activate_default_modules( 999, 1, array_merge( $active_modules, $other_modules ), $redirect_on_activation_error, $send_state_messages );
0 ignored issues
show
Documentation introduced by
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...
7237
		} else {
7238
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7239
		}
7240
7241
		// Since this is a fresh connection, be sure to clear out IDC options
7242
		Jetpack_IDC::clear_all_idc_options();
7243
7244
		if ( $send_state_messages ) {
7245
			self::state( 'message', 'authorized' );
7246
		}
7247
	}
7248
7249
	/**
7250
	 * Returns a boolean for whether backups UI should be displayed or not.
7251
	 *
7252
	 * @return bool Should backups UI be displayed?
7253
	 */
7254
	public static function show_backups_ui() {
7255
		/**
7256
		 * Whether UI for backups should be displayed.
7257
		 *
7258
		 * @since 6.5.0
7259
		 *
7260
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7261
		 */
7262
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7263
	}
7264
7265
	/*
7266
	 * Deprecated manage functions
7267
	 */
7268
	function prepare_manage_jetpack_notice() {
7269
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7270
	}
7271
	function manage_activate_screen() {
7272
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7273
	}
7274
	function admin_jetpack_manage_notice() {
7275
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7276
	}
7277
	function opt_out_jetpack_manage_url() {
7278
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7279
	}
7280
	function opt_in_jetpack_manage_url() {
7281
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7282
	}
7283
	function opt_in_jetpack_manage_notice() {
7284
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7285
	}
7286
	function can_display_jetpack_manage_notice() {
7287
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7288
	}
7289
7290
	/**
7291
	 * Clean leftoveruser meta.
7292
	 *
7293
	 * Delete Jetpack-related user meta when it is no longer needed.
7294
	 *
7295
	 * @since 7.3.0
7296
	 *
7297
	 * @param int $user_id User ID being updated.
7298
	 */
7299
	public static function user_meta_cleanup( $user_id ) {
7300
		$meta_keys = array(
7301
			// AtD removed from Jetpack 7.3
7302
			'AtD_options',
7303
			'AtD_check_when',
7304
			'AtD_guess_lang',
7305
			'AtD_ignored_phrases',
7306
		);
7307
7308
		foreach ( $meta_keys as $meta_key ) {
7309
			if ( get_user_meta( $user_id, $meta_key ) ) {
7310
				delete_user_meta( $user_id, $meta_key );
7311
			}
7312
		}
7313
	}
7314
7315
	/**
7316
	 * Checks if a Jetpack site is both active and not in development.
7317
	 *
7318
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7319
	 *
7320
	 * @return bool True if Jetpack is active and not in development.
7321
	 */
7322
	public static function is_active_and_not_development_mode() {
7323
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7324
			return false;
7325
		}
7326
		return true;
7327
	}
7328
7329
	/**
7330
	 * Returns the list of products that we have available for purchase.
7331
	 */
7332
	public static function get_products_for_purchase() {
7333
		$products = array();
7334
		if ( ! is_multisite() ) {
7335
			$products[] = array(
7336
				'key'               => 'backup',
7337
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7338
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7339
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7340
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7341
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7342
				'options'           => array(
7343
					array(
7344
						'type'        => 'daily',
7345
						'slug'        => 'jetpack-backup-daily',
7346
						'key'         => 'jetpack_backup_daily',
7347
						'name'        => __( 'Daily Backups', 'jetpack' ),
7348
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7349
					),
7350
					array(
7351
						'type'        => 'realtime',
7352
						'slug'        => 'jetpack-backup-realtime',
7353
						'key'         => 'jetpack_backup_realtime',
7354
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7355
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7356
					),
7357
				),
7358
				'default_option'    => 'realtime',
7359
				'show_promotion'    => true,
7360
				'discount_percent'  => 70,
7361
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7362
			);
7363
7364
			$products[] = array(
7365
				'key'               => 'scan',
7366
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7367
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7368
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7369
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7370
				'show_promotion'    => true,
7371
				'discount_percent'  => 30,
7372
				'options'           => array(
7373
					array(
7374
						'type'      => 'scan',
7375
						'slug'      => 'jetpack-scan',
7376
						'key'       => 'jetpack_scan',
7377
						'name'      => __( 'Daily Scan', 'jetpack' ),
7378
					),
7379
				),
7380
				'default_option'    => 'scan',
7381
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7382
			);
7383
		}
7384
7385
		$products[] = array(
7386
			'key'               => 'search',
7387
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7388
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7389
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7390
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7391
			'label_popup'  		=> __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.' ),
7392
			'options'           => array(
7393
				array(
7394
					'type'      => 'search',
7395
					'slug'      => 'jetpack-search',
7396
					'key'       => 'jetpack_search',
7397
					'name'      => __( 'Search', 'jetpack' ),
7398
				),
7399
			),
7400
			'tears'             => array(),
7401
			'default_option'    => 'search',
7402
			'show_promotion'    => false,
7403
			'included_in_plans' => array( 'search-plan' ),
7404
		);
7405
7406
		$products[] = array(
7407
			'key'               => 'anti-spam',
7408
			'title'             => __( 'Jetpack Anti-Spam', 'jetpack' ),
7409
			'short_description' => __( 'Automatically clear spam from comments and forms. Save time, get more responses, give your visitors a better experience – all without lifting a finger.', 'jetpack' ),
7410
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7411
			'description'       => __( 'Automatically clear spam from comments and forms. Save time, get more responses, give your visitors a better experience – all without lifting a finger.', 'jetpack' ),
7412
			'options'           => array(
7413
				array(
7414
					'type'      => 'anti-spam',
7415
					'slug'      => 'jetpack-anti-spam',
7416
					'key'       => 'jetpack_anti_spam',
7417
					'name'      => __( 'Anti-Spam', 'jetpack' ),
7418
				),
7419
			),
7420
			'default_option'    => 'anti-spam',
7421
			'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'anti-spam-plan' ),
7422
		);
7423
7424
		return $products;
7425
	}
7426
}
7427