Completed
Push — add/reenable_connection_banner ( 1873de )
by
unknown
06:32
created

Jetpack::public_xmlrpc_methods()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 9

Duplication

Lines 9
Ratio 100 %

Importance

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

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

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

Loading history...
1627
	}
1628
1629
	/**
1630
	 * Make an API call to WordPress.com for plan status
1631
	 *
1632
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1633
	 *
1634
	 * @return bool True if plan is updated, false if no update
1635
	 */
1636
	public static function refresh_active_plan_from_wpcom() {
1637
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1638
		return Jetpack_Plan::refresh_from_wpcom();
1639
	}
1640
1641
	/**
1642
	 * Get the plan that this Jetpack site is currently using
1643
	 *
1644
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1645
	 * @return array Active Jetpack plan details.
1646
	 */
1647
	public static function get_active_plan() {
1648
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1649
		return Jetpack_Plan::get();
1650
	}
1651
1652
	/**
1653
	 * Determine whether the active plan supports a particular feature
1654
	 *
1655
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1656
	 * @return bool True if plan supports feature, false if not.
1657
	 */
1658
	public static function active_plan_supports( $feature ) {
1659
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1660
		return Jetpack_Plan::supports( $feature );
1661
	}
1662
1663
	/**
1664
	 * Deprecated: Is Jetpack in development (offline) mode?
1665
	 *
1666
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1667
	 * and themes still use it, and we do not want to flood them with notices.
1668
	 *
1669
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1670
	 *
1671
	 * @deprecated since 8.0.
1672
	 */
1673
	public static function is_development_mode() {
1674
		return ( new Status() )->is_development_mode();
1675
	}
1676
1677
	/**
1678
	 * Whether the site is currently onboarding or not.
1679
	 * A site is considered as being onboarded if it currently has an onboarding token.
1680
	 *
1681
	 * @since 5.8
1682
	 *
1683
	 * @access public
1684
	 * @static
1685
	 *
1686
	 * @return bool True if the site is currently onboarding, false otherwise
1687
	 */
1688
	public static function is_onboarding() {
1689
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1690
	}
1691
1692
	/**
1693
	 * Determines reason for Jetpack development mode.
1694
	 */
1695
	public static function development_mode_trigger_text() {
1696
		if ( ! ( new Status() )->is_development_mode() ) {
1697
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1698
		}
1699
1700
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1701
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1702
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1703
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1704
		} else {
1705
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1706
		}
1707
1708
		return $notice;
1709
1710
	}
1711
	/**
1712
	 * Get Jetpack development mode notice text and notice class.
1713
	 *
1714
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1715
	 */
1716
	public static function show_development_mode_notice() {
1717 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1718
			$notice = sprintf(
1719
				/* translators: %s is a URL */
1720
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1721
				Redirect::get_url( 'jetpack-support-development-mode' )
1722
			);
1723
1724
			$notice .= ' ' . self::development_mode_trigger_text();
1725
1726
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1727
		}
1728
1729
		// Throw up a notice if using a development version and as for feedback.
1730
		if ( self::is_development_version() ) {
1731
			/* translators: %s is a URL */
1732
			$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' ) );
1733
1734
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1735
		}
1736
		// Throw up a notice if using staging mode
1737 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1738
			/* translators: %s is a URL */
1739
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1740
1741
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1742
		}
1743
	}
1744
1745
	/**
1746
	 * Whether Jetpack's version maps to a public release, or a development version.
1747
	 */
1748
	public static function is_development_version() {
1749
		/**
1750
		 * Allows filtering whether this is a development version of Jetpack.
1751
		 *
1752
		 * This filter is especially useful for tests.
1753
		 *
1754
		 * @since 4.3.0
1755
		 *
1756
		 * @param bool $development_version Is this a develoment version of Jetpack?
1757
		 */
1758
		return (bool) apply_filters(
1759
			'jetpack_development_version',
1760
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1761
		);
1762
	}
1763
1764
	/**
1765
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1766
	 */
1767
	public static function is_user_connected( $user_id = false ) {
1768
		return self::connection()->is_user_connected( $user_id );
1769
	}
1770
1771
	/**
1772
	 * Get the wpcom user data of the current|specified connected user.
1773
	 */
1774 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1775
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1776
		if ( ! $user_id ) {
1777
			$user_id = get_current_user_id();
1778
		}
1779
1780
		$transient_key = "jetpack_connected_user_data_$user_id";
1781
1782
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1783
			return $cached_user_data;
1784
		}
1785
1786
		$xml = new Jetpack_IXR_Client(
1787
			array(
1788
				'user_id' => $user_id,
1789
			)
1790
		);
1791
		$xml->query( 'wpcom.getUser' );
1792
		if ( ! $xml->isError() ) {
1793
			$user_data = $xml->getResponse();
1794
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1795
			return $user_data;
1796
		}
1797
1798
		return false;
1799
	}
1800
1801
	/**
1802
	 * Get the wpcom email of the current|specified connected user.
1803
	 */
1804
	public static function get_connected_user_email( $user_id = null ) {
1805
		if ( ! $user_id ) {
1806
			$user_id = get_current_user_id();
1807
		}
1808
1809
		$xml = new Jetpack_IXR_Client(
1810
			array(
1811
				'user_id' => $user_id,
1812
			)
1813
		);
1814
		$xml->query( 'wpcom.getUserEmail' );
1815
		if ( ! $xml->isError() ) {
1816
			return $xml->getResponse();
1817
		}
1818
		return false;
1819
	}
1820
1821
	/**
1822
	 * Get the wpcom email of the master user.
1823
	 */
1824
	public static function get_master_user_email() {
1825
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1826
		if ( $master_user_id ) {
1827
			return self::get_connected_user_email( $master_user_id );
1828
		}
1829
		return '';
1830
	}
1831
1832
	/**
1833
	 * Whether the current user is the connection owner.
1834
	 *
1835
	 * @deprecated since 7.7
1836
	 *
1837
	 * @return bool Whether the current user is the connection owner.
1838
	 */
1839
	public function current_user_is_connection_owner() {
1840
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1841
		return self::connection()->is_connection_owner();
1842
	}
1843
1844
	/**
1845
	 * Gets current user IP address.
1846
	 *
1847
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1848
	 *
1849
	 * @return string                  Current user IP address.
1850
	 */
1851
	public static function current_user_ip( $check_all_headers = false ) {
1852
		if ( $check_all_headers ) {
1853
			foreach ( array(
1854
				'HTTP_CF_CONNECTING_IP',
1855
				'HTTP_CLIENT_IP',
1856
				'HTTP_X_FORWARDED_FOR',
1857
				'HTTP_X_FORWARDED',
1858
				'HTTP_X_CLUSTER_CLIENT_IP',
1859
				'HTTP_FORWARDED_FOR',
1860
				'HTTP_FORWARDED',
1861
				'HTTP_VIA',
1862
			) as $key ) {
1863
				if ( ! empty( $_SERVER[ $key ] ) ) {
1864
					return $_SERVER[ $key ];
1865
				}
1866
			}
1867
		}
1868
1869
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1870
	}
1871
1872
	/**
1873
	 * Synchronize connected user role changes
1874
	 */
1875
	function user_role_change( $user_id ) {
1876
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1877
		Users::user_role_change( $user_id );
1878
	}
1879
1880
	/**
1881
	 * Loads the currently active modules.
1882
	 */
1883
	public static function load_modules() {
1884
		$is_development_mode = ( new Status() )->is_development_mode();
1885
		if (
1886
			! self::is_active()
1887
			&& ! $is_development_mode
1888
			&& ! self::is_onboarding()
1889
			&& (
1890
				! is_multisite()
1891
				|| ! get_site_option( 'jetpack_protect_active' )
1892
			)
1893
		) {
1894
			return;
1895
		}
1896
1897
		$version = Jetpack_Options::get_option( 'version' );
1898 View Code Duplication
		if ( ! $version ) {
1899
			$version = $old_version = JETPACK__VERSION . ':' . time();
1900
			/** This action is documented in class.jetpack.php */
1901
			do_action( 'updating_jetpack_version', $version, false );
1902
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1903
		}
1904
		list( $version ) = explode( ':', $version );
1905
1906
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1907
1908
		$modules_data = array();
1909
1910
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1911
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1912
			$updated_modules = array();
1913
			foreach ( $modules as $module ) {
1914
				$modules_data[ $module ] = self::get_module( $module );
1915
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1916
					continue;
1917
				}
1918
1919
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1920
					continue;
1921
				}
1922
1923
				$updated_modules[] = $module;
1924
			}
1925
1926
			$modules = array_diff( $modules, $updated_modules );
1927
		}
1928
1929
		foreach ( $modules as $index => $module ) {
1930
			// If we're in dev mode, disable modules requiring a connection
1931
			if ( $is_development_mode ) {
1932
				// Prime the pump if we need to
1933
				if ( empty( $modules_data[ $module ] ) ) {
1934
					$modules_data[ $module ] = self::get_module( $module );
1935
				}
1936
				// If the module requires a connection, but we're in local mode, don't include it.
1937
				if ( $modules_data[ $module ]['requires_connection'] ) {
1938
					continue;
1939
				}
1940
			}
1941
1942
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1943
				continue;
1944
			}
1945
1946
			if ( ! include_once self::get_module_path( $module ) ) {
1947
				unset( $modules[ $index ] );
1948
				self::update_active_modules( array_values( $modules ) );
1949
				continue;
1950
			}
1951
1952
			/**
1953
			 * Fires when a specific module is loaded.
1954
			 * The dynamic part of the hook, $module, is the module slug.
1955
			 *
1956
			 * @since 1.1.0
1957
			 */
1958
			do_action( 'jetpack_module_loaded_' . $module );
1959
		}
1960
1961
		/**
1962
		 * Fires when all the modules are loaded.
1963
		 *
1964
		 * @since 1.1.0
1965
		 */
1966
		do_action( 'jetpack_modules_loaded' );
1967
1968
		// 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.
1969
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1970
	}
1971
1972
	/**
1973
	 * Check if Jetpack's REST API compat file should be included
1974
	 *
1975
	 * @action plugins_loaded
1976
	 * @return null
1977
	 */
1978
	public function check_rest_api_compat() {
1979
		/**
1980
		 * Filters the list of REST API compat files to be included.
1981
		 *
1982
		 * @since 2.2.5
1983
		 *
1984
		 * @param array $args Array of REST API compat files to include.
1985
		 */
1986
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
1987
1988
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
1989
			require_once $_jetpack_rest_api_compat_include;
1990
		}
1991
	}
1992
1993
	/**
1994
	 * Gets all plugins currently active in values, regardless of whether they're
1995
	 * traditionally activated or network activated.
1996
	 *
1997
	 * @todo Store the result in core's object cache maybe?
1998
	 */
1999
	public static function get_active_plugins() {
2000
		$active_plugins = (array) get_option( 'active_plugins', array() );
2001
2002
		if ( is_multisite() ) {
2003
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2004
			// whereas active_plugins stores them in the values.
2005
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2006
			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...
2007
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2008
			}
2009
		}
2010
2011
		sort( $active_plugins );
2012
2013
		return array_unique( $active_plugins );
2014
	}
2015
2016
	/**
2017
	 * Gets and parses additional plugin data to send with the heartbeat data
2018
	 *
2019
	 * @since 3.8.1
2020
	 *
2021
	 * @return array Array of plugin data
2022
	 */
2023
	public static function get_parsed_plugin_data() {
2024
		if ( ! function_exists( 'get_plugins' ) ) {
2025
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2026
		}
2027
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2028
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2029
		$active_plugins = self::get_active_plugins();
2030
2031
		$plugins = array();
2032
		foreach ( $all_plugins as $path => $plugin_data ) {
2033
			$plugins[ $path ] = array(
2034
				'is_active' => in_array( $path, $active_plugins ),
2035
				'file'      => $path,
2036
				'name'      => $plugin_data['Name'],
2037
				'version'   => $plugin_data['Version'],
2038
				'author'    => $plugin_data['Author'],
2039
			);
2040
		}
2041
2042
		return $plugins;
2043
	}
2044
2045
	/**
2046
	 * Gets and parses theme data to send with the heartbeat data
2047
	 *
2048
	 * @since 3.8.1
2049
	 *
2050
	 * @return array Array of theme data
2051
	 */
2052
	public static function get_parsed_theme_data() {
2053
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2054
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2055
2056
		$themes = array();
2057
		foreach ( $all_themes as $slug => $theme_data ) {
2058
			$theme_headers = array();
2059
			foreach ( $header_keys as $header_key ) {
2060
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2061
			}
2062
2063
			$themes[ $slug ] = array(
2064
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2065
				'slug'            => $slug,
2066
				'theme_root'      => $theme_data->get_theme_root_uri(),
2067
				'parent'          => $theme_data->parent(),
2068
				'headers'         => $theme_headers,
2069
			);
2070
		}
2071
2072
		return $themes;
2073
	}
2074
2075
	/**
2076
	 * Checks whether a specific plugin is active.
2077
	 *
2078
	 * We don't want to store these in a static variable, in case
2079
	 * there are switch_to_blog() calls involved.
2080
	 */
2081
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2082
		return in_array( $plugin, self::get_active_plugins() );
2083
	}
2084
2085
	/**
2086
	 * Check if Jetpack's Open Graph tags should be used.
2087
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2088
	 *
2089
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2090
	 * @action plugins_loaded
2091
	 * @return null
2092
	 */
2093
	public function check_open_graph() {
2094
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2095
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2096
		}
2097
2098
		$active_plugins = self::get_active_plugins();
2099
2100
		if ( ! empty( $active_plugins ) ) {
2101
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2102
				if ( in_array( $plugin, $active_plugins ) ) {
2103
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2104
					break;
2105
				}
2106
			}
2107
		}
2108
2109
		/**
2110
		 * Allow the addition of Open Graph Meta Tags to all pages.
2111
		 *
2112
		 * @since 2.0.3
2113
		 *
2114
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2115
		 */
2116
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2117
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2118
		}
2119
	}
2120
2121
	/**
2122
	 * Check if Jetpack's Twitter tags should be used.
2123
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2124
	 *
2125
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2126
	 * @action plugins_loaded
2127
	 * @return null
2128
	 */
2129
	public function check_twitter_tags() {
2130
2131
		$active_plugins = self::get_active_plugins();
2132
2133
		if ( ! empty( $active_plugins ) ) {
2134
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2135
				if ( in_array( $plugin, $active_plugins ) ) {
2136
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2137
					break;
2138
				}
2139
			}
2140
		}
2141
2142
		/**
2143
		 * Allow Twitter Card Meta tags to be disabled.
2144
		 *
2145
		 * @since 2.6.0
2146
		 *
2147
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2148
		 */
2149
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2150
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2151
		}
2152
	}
2153
2154
	/**
2155
	 * Allows plugins to submit security reports.
2156
	 *
2157
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2158
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2159
	 * @param array  $args         See definitions above
2160
	 */
2161
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2162
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2163
	}
2164
2165
	/* Jetpack Options API */
2166
2167
	public static function get_option_names( $type = 'compact' ) {
2168
		return Jetpack_Options::get_option_names( $type );
2169
	}
2170
2171
	/**
2172
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2173
	 *
2174
	 * @param string $name    Option name
2175
	 * @param mixed  $default (optional)
2176
	 */
2177
	public static function get_option( $name, $default = false ) {
2178
		return Jetpack_Options::get_option( $name, $default );
2179
	}
2180
2181
	/**
2182
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2183
	 *
2184
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2185
	 * @param string $name  Option name
2186
	 * @param mixed  $value Option value
2187
	 */
2188
	public static function update_option( $name, $value ) {
2189
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2190
		return Jetpack_Options::update_option( $name, $value );
2191
	}
2192
2193
	/**
2194
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2195
	 *
2196
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2197
	 * @param array $array array( option name => option value, ... )
2198
	 */
2199
	public static function update_options( $array ) {
2200
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2201
		return Jetpack_Options::update_options( $array );
2202
	}
2203
2204
	/**
2205
	 * Deletes the given option.  May be passed multiple option names as an array.
2206
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2207
	 *
2208
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2209
	 * @param string|array $names
2210
	 */
2211
	public static function delete_option( $names ) {
2212
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2213
		return Jetpack_Options::delete_option( $names );
2214
	}
2215
2216
	/**
2217
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2218
	 *
2219
	 * Enters a user token into the user_tokens option
2220
	 *
2221
	 * @param int    $user_id The user id.
2222
	 * @param string $token The user token.
2223
	 * @param bool   $is_master_user Whether the user is the master user.
2224
	 * @return bool
2225
	 */
2226
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2227
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2228
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2229
	}
2230
2231
	/**
2232
	 * Returns an array of all PHP files in the specified absolute path.
2233
	 * Equivalent to glob( "$absolute_path/*.php" ).
2234
	 *
2235
	 * @param string $absolute_path The absolute path of the directory to search.
2236
	 * @return array Array of absolute paths to the PHP files.
2237
	 */
2238
	public static function glob_php( $absolute_path ) {
2239
		if ( function_exists( 'glob' ) ) {
2240
			return glob( "$absolute_path/*.php" );
2241
		}
2242
2243
		$absolute_path = untrailingslashit( $absolute_path );
2244
		$files         = array();
2245
		if ( ! $dir = @opendir( $absolute_path ) ) {
2246
			return $files;
2247
		}
2248
2249
		while ( false !== $file = readdir( $dir ) ) {
2250
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2251
				continue;
2252
			}
2253
2254
			$file = "$absolute_path/$file";
2255
2256
			if ( ! is_file( $file ) ) {
2257
				continue;
2258
			}
2259
2260
			$files[] = $file;
2261
		}
2262
2263
		closedir( $dir );
2264
2265
		return $files;
2266
	}
2267
2268
	public static function activate_new_modules( $redirect = false ) {
2269
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2270
			return;
2271
		}
2272
2273
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2274 View Code Duplication
		if ( ! $jetpack_old_version ) {
2275
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2276
			/** This action is documented in class.jetpack.php */
2277
			do_action( 'updating_jetpack_version', $version, false );
2278
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2279
		}
2280
2281
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2282
2283
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2284
			return;
2285
		}
2286
2287
		$active_modules     = self::get_active_modules();
2288
		$reactivate_modules = array();
2289
		foreach ( $active_modules as $active_module ) {
2290
			$module = self::get_module( $active_module );
2291
			if ( ! isset( $module['changed'] ) ) {
2292
				continue;
2293
			}
2294
2295
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2296
				continue;
2297
			}
2298
2299
			$reactivate_modules[] = $active_module;
2300
			self::deactivate_module( $active_module );
2301
		}
2302
2303
		$new_version = JETPACK__VERSION . ':' . time();
2304
		/** This action is documented in class.jetpack.php */
2305
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2306
		Jetpack_Options::update_options(
2307
			array(
2308
				'version'     => $new_version,
2309
				'old_version' => $jetpack_old_version,
2310
			)
2311
		);
2312
2313
		self::state( 'message', 'modules_activated' );
2314
2315
		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...
2316
2317
		if ( $redirect ) {
2318
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2319
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2320
				$page = $_GET['page'];
2321
			}
2322
2323
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2324
			exit;
2325
		}
2326
	}
2327
2328
	/**
2329
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2330
	 * Make sure to tuck away module "library" files in a sub-directory.
2331
	 */
2332
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2333
		static $modules = null;
2334
2335
		if ( ! isset( $modules ) ) {
2336
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2337
			// Use the cache if we're on the front-end and it's available...
2338
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2339
				$modules = $available_modules_option[ JETPACK__VERSION ];
2340
			} else {
2341
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2342
2343
				$modules = array();
2344
2345
				foreach ( $files as $file ) {
2346
					if ( ! $headers = self::get_module( $file ) ) {
2347
						continue;
2348
					}
2349
2350
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2351
				}
2352
2353
				Jetpack_Options::update_option(
2354
					'available_modules',
2355
					array(
2356
						JETPACK__VERSION => $modules,
2357
					)
2358
				);
2359
			}
2360
		}
2361
2362
		/**
2363
		 * Filters the array of modules available to be activated.
2364
		 *
2365
		 * @since 2.4.0
2366
		 *
2367
		 * @param array $modules Array of available modules.
2368
		 * @param string $min_version Minimum version number required to use modules.
2369
		 * @param string $max_version Maximum version number required to use modules.
2370
		 */
2371
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2372
2373
		if ( ! $min_version && ! $max_version ) {
2374
			return array_keys( $mods );
2375
		}
2376
2377
		$r = array();
2378
		foreach ( $mods as $slug => $introduced ) {
2379
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2380
				continue;
2381
			}
2382
2383
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2384
				continue;
2385
			}
2386
2387
			$r[] = $slug;
2388
		}
2389
2390
		return $r;
2391
	}
2392
2393
	/**
2394
	 * Default modules loaded on activation.
2395
	 */
2396
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2397
		$return = array();
2398
2399
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2400
			$module_data = self::get_module( $module );
2401
2402
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2403
				case 'yes':
2404
					$return[] = $module;
2405
					break;
2406
				case 'public':
2407
					if ( Jetpack_Options::get_option( 'public' ) ) {
2408
						$return[] = $module;
2409
					}
2410
					break;
2411
				case 'no':
2412
				default:
2413
					break;
2414
			}
2415
		}
2416
		/**
2417
		 * Filters the array of default modules.
2418
		 *
2419
		 * @since 2.5.0
2420
		 *
2421
		 * @param array $return Array of default modules.
2422
		 * @param string $min_version Minimum version number required to use modules.
2423
		 * @param string $max_version Maximum version number required to use modules.
2424
		 */
2425
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2426
	}
2427
2428
	/**
2429
	 * Checks activated modules during auto-activation to determine
2430
	 * if any of those modules are being deprecated.  If so, close
2431
	 * them out, and add any replacement modules.
2432
	 *
2433
	 * Runs at priority 99 by default.
2434
	 *
2435
	 * This is run late, so that it can still activate a module if
2436
	 * the new module is a replacement for another that the user
2437
	 * currently has active, even if something at the normal priority
2438
	 * would kibosh everything.
2439
	 *
2440
	 * @since 2.6
2441
	 * @uses jetpack_get_default_modules filter
2442
	 * @param array $modules
2443
	 * @return array
2444
	 */
2445
	function handle_deprecated_modules( $modules ) {
2446
		$deprecated_modules = array(
2447
			'debug'            => null,  // Closed out and moved to the debugger library.
2448
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2449
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2450
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2451
		);
2452
2453
		// Don't activate SSO if they never completed activating WPCC.
2454
		if ( self::is_module_active( 'wpcc' ) ) {
2455
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2456
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2457
				$deprecated_modules['wpcc'] = null;
2458
			}
2459
		}
2460
2461
		foreach ( $deprecated_modules as $module => $replacement ) {
2462
			if ( self::is_module_active( $module ) ) {
2463
				self::deactivate_module( $module );
2464
				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...
2465
					$modules[] = $replacement;
2466
				}
2467
			}
2468
		}
2469
2470
		return array_unique( $modules );
2471
	}
2472
2473
	/**
2474
	 * Checks activated plugins during auto-activation to determine
2475
	 * if any of those plugins are in the list with a corresponding module
2476
	 * that is not compatible with the plugin. The module will not be allowed
2477
	 * to auto-activate.
2478
	 *
2479
	 * @since 2.6
2480
	 * @uses jetpack_get_default_modules filter
2481
	 * @param array $modules
2482
	 * @return array
2483
	 */
2484
	function filter_default_modules( $modules ) {
2485
2486
		$active_plugins = self::get_active_plugins();
2487
2488
		if ( ! empty( $active_plugins ) ) {
2489
2490
			// For each module we'd like to auto-activate...
2491
			foreach ( $modules as $key => $module ) {
2492
				// If there are potential conflicts for it...
2493
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2494
					// For each potential conflict...
2495
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2496
						// If that conflicting plugin is active...
2497
						if ( in_array( $plugin, $active_plugins ) ) {
2498
							// Remove that item from being auto-activated.
2499
							unset( $modules[ $key ] );
2500
						}
2501
					}
2502
				}
2503
			}
2504
		}
2505
2506
		return $modules;
2507
	}
2508
2509
	/**
2510
	 * Extract a module's slug from its full path.
2511
	 */
2512
	public static function get_module_slug( $file ) {
2513
		return str_replace( '.php', '', basename( $file ) );
2514
	}
2515
2516
	/**
2517
	 * Generate a module's path from its slug.
2518
	 */
2519
	public static function get_module_path( $slug ) {
2520
		/**
2521
		 * Filters the path of a modules.
2522
		 *
2523
		 * @since 7.4.0
2524
		 *
2525
		 * @param array $return The absolute path to a module's root php file
2526
		 * @param string $slug The module slug
2527
		 */
2528
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2529
	}
2530
2531
	/**
2532
	 * Load module data from module file. Headers differ from WordPress
2533
	 * plugin headers to avoid them being identified as standalone
2534
	 * plugins on the WordPress plugins page.
2535
	 */
2536
	public static function get_module( $module ) {
2537
		$headers = array(
2538
			'name'                      => 'Module Name',
2539
			'description'               => 'Module Description',
2540
			'sort'                      => 'Sort Order',
2541
			'recommendation_order'      => 'Recommendation Order',
2542
			'introduced'                => 'First Introduced',
2543
			'changed'                   => 'Major Changes In',
2544
			'deactivate'                => 'Deactivate',
2545
			'free'                      => 'Free',
2546
			'requires_connection'       => 'Requires Connection',
2547
			'auto_activate'             => 'Auto Activate',
2548
			'module_tags'               => 'Module Tags',
2549
			'feature'                   => 'Feature',
2550
			'additional_search_queries' => 'Additional Search Queries',
2551
			'plan_classes'              => 'Plans',
2552
		);
2553
2554
		$file = self::get_module_path( self::get_module_slug( $module ) );
2555
2556
		$mod = self::get_file_data( $file, $headers );
2557
		if ( empty( $mod['name'] ) ) {
2558
			return false;
2559
		}
2560
2561
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2562
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2563
		$mod['deactivate']           = empty( $mod['deactivate'] );
2564
		$mod['free']                 = empty( $mod['free'] );
2565
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2566
2567
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2568
			$mod['auto_activate'] = 'No';
2569
		} else {
2570
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2571
		}
2572
2573
		if ( $mod['module_tags'] ) {
2574
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2575
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2576
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2577
		} else {
2578
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2579
		}
2580
2581 View Code Duplication
		if ( $mod['plan_classes'] ) {
2582
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2583
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2584
		} else {
2585
			$mod['plan_classes'] = array( 'free' );
2586
		}
2587
2588 View Code Duplication
		if ( $mod['feature'] ) {
2589
			$mod['feature'] = explode( ',', $mod['feature'] );
2590
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2591
		} else {
2592
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2593
		}
2594
2595
		/**
2596
		 * Filters the feature array on a module.
2597
		 *
2598
		 * This filter allows you to control where each module is filtered: Recommended,
2599
		 * and the default "Other" listing.
2600
		 *
2601
		 * @since 3.5.0
2602
		 *
2603
		 * @param array   $mod['feature'] The areas to feature this module:
2604
		 *     'Recommended' shows on the main Jetpack admin screen.
2605
		 *     'Other' should be the default if no other value is in the array.
2606
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2607
		 * @param array   $mod All the currently assembled module data.
2608
		 */
2609
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2610
2611
		/**
2612
		 * Filter the returned data about a module.
2613
		 *
2614
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2615
		 * so please be careful.
2616
		 *
2617
		 * @since 3.6.0
2618
		 *
2619
		 * @param array   $mod    The details of the requested module.
2620
		 * @param string  $module The slug of the module, e.g. sharedaddy
2621
		 * @param string  $file   The path to the module source file.
2622
		 */
2623
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2624
	}
2625
2626
	/**
2627
	 * Like core's get_file_data implementation, but caches the result.
2628
	 */
2629
	public static function get_file_data( $file, $headers ) {
2630
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2631
		$file_name = basename( $file );
2632
2633
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2634
2635
		$file_data_option = get_transient( $cache_key );
2636
2637
		if ( ! is_array( $file_data_option ) ) {
2638
			delete_transient( $cache_key );
2639
			$file_data_option = false;
2640
		}
2641
2642
		if ( false === $file_data_option ) {
2643
			$file_data_option = array();
2644
		}
2645
2646
		$key           = md5( $file_name . serialize( $headers ) );
2647
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2648
2649
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2650
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2651
			return $file_data_option[ $key ];
2652
		}
2653
2654
		$data = get_file_data( $file, $headers );
2655
2656
		$file_data_option[ $key ] = $data;
2657
2658
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2659
2660
		return $data;
2661
	}
2662
2663
2664
	/**
2665
	 * Return translated module tag.
2666
	 *
2667
	 * @param string $tag Tag as it appears in each module heading.
2668
	 *
2669
	 * @return mixed
2670
	 */
2671
	public static function translate_module_tag( $tag ) {
2672
		return jetpack_get_module_i18n_tag( $tag );
2673
	}
2674
2675
	/**
2676
	 * Get i18n strings as a JSON-encoded string
2677
	 *
2678
	 * @return string The locale as JSON
2679
	 */
2680
	public static function get_i18n_data_json() {
2681
2682
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2683
		// JSON files with the file they should be included for. This is an md5
2684
		// of '_inc/build/admin.js'.
2685
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2686
2687
		$i18n_json =
2688
				   JETPACK__PLUGIN_DIR
2689
				   . 'languages/json/jetpack-'
2690
				   . get_user_locale()
2691
				   . '-'
2692
				   . $path_md5
2693
				   . '.json';
2694
2695
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2696
			$locale_data = @file_get_contents( $i18n_json );
2697
			if ( $locale_data ) {
2698
				return $locale_data;
2699
			}
2700
		}
2701
2702
		// Return valid empty Jed locale
2703
		return '{ "locale_data": { "messages": { "": {} } } }';
2704
	}
2705
2706
	/**
2707
	 * Add locale data setup to wp-i18n
2708
	 *
2709
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2710
	 *
2711
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2712
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2713
	 *
2714
	 * This method provides a safe way to request the setup multiple times but add the script at
2715
	 * most once.
2716
	 *
2717
	 * @since 6.7.0
2718
	 *
2719
	 * @return void
2720
	 */
2721
	public static function setup_wp_i18n_locale_data() {
2722
		static $script_added = false;
2723
		if ( ! $script_added ) {
2724
			$script_added = true;
2725
			wp_add_inline_script(
2726
				'wp-i18n',
2727
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2728
			);
2729
		}
2730
	}
2731
2732
	/**
2733
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2734
	 *
2735
	 * @since 3.9.2
2736
	 *
2737
	 * @param array $modules
2738
	 *
2739
	 * @return string|void
2740
	 */
2741
	public static function get_translated_modules( $modules ) {
2742
		foreach ( $modules as $index => $module ) {
2743
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2744
			if ( isset( $module['name'] ) ) {
2745
				$modules[ $index ]['name'] = $i18n_module['name'];
2746
			}
2747
			if ( isset( $module['description'] ) ) {
2748
				$modules[ $index ]['description']       = $i18n_module['description'];
2749
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2750
			}
2751
		}
2752
		return $modules;
2753
	}
2754
2755
	/**
2756
	 * Get a list of activated modules as an array of module slugs.
2757
	 */
2758
	public static function get_active_modules() {
2759
		$active = Jetpack_Options::get_option( 'active_modules' );
2760
2761
		if ( ! is_array( $active ) ) {
2762
			$active = array();
2763
		}
2764
2765
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2766
			$active[] = 'vaultpress';
2767
		} else {
2768
			$active = array_diff( $active, array( 'vaultpress' ) );
2769
		}
2770
2771
		// If protect is active on the main site of a multisite, it should be active on all sites.
2772
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2773
			$active[] = 'protect';
2774
		}
2775
2776
		/**
2777
		 * Allow filtering of the active modules.
2778
		 *
2779
		 * Gives theme and plugin developers the power to alter the modules that
2780
		 * are activated on the fly.
2781
		 *
2782
		 * @since 5.8.0
2783
		 *
2784
		 * @param array $active Array of active module slugs.
2785
		 */
2786
		$active = apply_filters( 'jetpack_active_modules', $active );
2787
2788
		return array_unique( $active );
2789
	}
2790
2791
	/**
2792
	 * Check whether or not a Jetpack module is active.
2793
	 *
2794
	 * @param string $module The slug of a Jetpack module.
2795
	 * @return bool
2796
	 *
2797
	 * @static
2798
	 */
2799
	public static function is_module_active( $module ) {
2800
		return in_array( $module, self::get_active_modules() );
2801
	}
2802
2803
	public static function is_module( $module ) {
2804
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2805
	}
2806
2807
	/**
2808
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2809
	 *
2810
	 * @param bool $catch True to start catching, False to stop.
2811
	 *
2812
	 * @static
2813
	 */
2814
	public static function catch_errors( $catch ) {
2815
		static $display_errors, $error_reporting;
2816
2817
		if ( $catch ) {
2818
			$display_errors  = @ini_set( 'display_errors', 1 );
2819
			$error_reporting = @error_reporting( E_ALL );
2820
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2821
		} else {
2822
			@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...
2823
			@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...
2824
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2825
		}
2826
	}
2827
2828
	/**
2829
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2830
	 */
2831
	public static function catch_errors_on_shutdown() {
2832
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2833
	}
2834
2835
	/**
2836
	 * Rewrite any string to make paths easier to read.
2837
	 *
2838
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2839
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2840
	 *
2841
	 * @param $string
2842
	 * @return mixed
2843
	 */
2844
	public static function alias_directories( $string ) {
2845
		// ABSPATH has a trailing slash.
2846
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2847
		// WP_CONTENT_DIR does not have a trailing slash.
2848
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2849
2850
		return $string;
2851
	}
2852
2853
	public static function activate_default_modules(
2854
		$min_version = false,
2855
		$max_version = false,
2856
		$other_modules = array(),
2857
		$redirect = null,
2858
		$send_state_messages = null
2859
	) {
2860
		$jetpack = self::init();
2861
2862
		if ( is_null( $redirect ) ) {
2863
			if (
2864
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2865
			||
2866
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2867
			||
2868
				( defined( 'WP_CLI' ) && WP_CLI )
2869
			||
2870
				( defined( 'DOING_CRON' ) && DOING_CRON )
2871
			||
2872
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2873
			) {
2874
				$redirect = false;
2875
			} elseif ( is_admin() ) {
2876
				$redirect = true;
2877
			} else {
2878
				$redirect = false;
2879
			}
2880
		}
2881
2882
		if ( is_null( $send_state_messages ) ) {
2883
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2884
		}
2885
2886
		$modules = self::get_default_modules( $min_version, $max_version );
2887
		$modules = array_merge( $other_modules, $modules );
2888
2889
		// Look for standalone plugins and disable if active.
2890
2891
		$to_deactivate = array();
2892
		foreach ( $modules as $module ) {
2893
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2894
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2895
			}
2896
		}
2897
2898
		$deactivated = array();
2899
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2900
			list( $probable_file, $probable_title ) = $deactivate_me;
2901
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2902
				$deactivated[] = $module;
2903
			}
2904
		}
2905
2906
		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...
2907
			if ( $send_state_messages ) {
2908
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2909
			}
2910
2911
			if ( $redirect ) {
2912
				$url = add_query_arg(
2913
					array(
2914
						'action'   => 'activate_default_modules',
2915
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2916
					),
2917
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2918
				);
2919
				wp_safe_redirect( $url );
2920
				exit;
2921
			}
2922
		}
2923
2924
		/**
2925
		 * Fires before 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_before_activate_default_modules', $min_version, $max_version, $other_modules );
2934
2935
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2936
		if ( $send_state_messages ) {
2937
			self::restate();
2938
			self::catch_errors( true );
2939
		}
2940
2941
		$active = self::get_active_modules();
2942
2943
		foreach ( $modules as $module ) {
2944
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2945
				$active[] = $module;
2946
				self::update_active_modules( $active );
2947
				continue;
2948
			}
2949
2950
			if ( $send_state_messages && in_array( $module, $active ) ) {
2951
				$module_info = self::get_module( $module );
2952 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2953
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2954
					if ( $active_state = self::state( $state ) ) {
2955
						$active_state = explode( ',', $active_state );
2956
					} else {
2957
						$active_state = array();
2958
					}
2959
					$active_state[] = $module;
2960
					self::state( $state, implode( ',', $active_state ) );
2961
				}
2962
				continue;
2963
			}
2964
2965
			$file = self::get_module_path( $module );
2966
			if ( ! file_exists( $file ) ) {
2967
				continue;
2968
			}
2969
2970
			// we'll override this later if the plugin can be included without fatal error
2971
			if ( $redirect ) {
2972
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2973
			}
2974
2975
			if ( $send_state_messages ) {
2976
				self::state( 'error', 'module_activation_failed' );
2977
				self::state( 'module', $module );
2978
			}
2979
2980
			ob_start();
2981
			require_once $file;
2982
2983
			$active[] = $module;
2984
2985 View Code Duplication
			if ( $send_state_messages ) {
2986
2987
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2988
				if ( $active_state = self::state( $state ) ) {
2989
					$active_state = explode( ',', $active_state );
2990
				} else {
2991
					$active_state = array();
2992
				}
2993
				$active_state[] = $module;
2994
				self::state( $state, implode( ',', $active_state ) );
2995
			}
2996
2997
			self::update_active_modules( $active );
2998
2999
			ob_end_clean();
3000
		}
3001
3002
		if ( $send_state_messages ) {
3003
			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...
3004
			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...
3005
		}
3006
3007
		self::catch_errors( false );
3008
		/**
3009
		 * Fires when default modules are activated.
3010
		 *
3011
		 * @since 1.9.0
3012
		 *
3013
		 * @param string $min_version Minimum version number required to use modules.
3014
		 * @param string $max_version Maximum version number required to use modules.
3015
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3016
		 */
3017
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3018
	}
3019
3020
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3021
		/**
3022
		 * Fires before a module is activated.
3023
		 *
3024
		 * @since 2.6.0
3025
		 *
3026
		 * @param string $module Module slug.
3027
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3028
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3029
		 */
3030
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3031
3032
		$jetpack = self::init();
3033
3034
		if ( ! strlen( $module ) ) {
3035
			return false;
3036
		}
3037
3038
		if ( ! self::is_module( $module ) ) {
3039
			return false;
3040
		}
3041
3042
		// If it's already active, then don't do it again
3043
		$active = self::get_active_modules();
3044
		foreach ( $active as $act ) {
3045
			if ( $act == $module ) {
3046
				return true;
3047
			}
3048
		}
3049
3050
		$module_data = self::get_module( $module );
3051
3052
		$is_development_mode = ( new Status() )->is_development_mode();
3053
		if ( ! self::is_active() ) {
3054
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3055
				return false;
3056
			}
3057
3058
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3059
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3060
				return false;
3061
			}
3062
		}
3063
3064
		// Check and see if the old plugin is active
3065
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3066
			// Deactivate the old plugin
3067
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3068
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3069
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3070
				self::state( 'deactivated_plugins', $module );
3071
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3072
				exit;
3073
			}
3074
		}
3075
3076
		// Protect won't work with mis-configured IPs
3077
		if ( 'protect' === $module ) {
3078
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3079
			if ( ! jetpack_protect_get_ip() ) {
3080
				self::state( 'message', 'protect_misconfigured_ip' );
3081
				return false;
3082
			}
3083
		}
3084
3085
		if ( ! Jetpack_Plan::supports( $module ) ) {
3086
			return false;
3087
		}
3088
3089
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3090
		self::state( 'module', $module );
3091
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3092
3093
		self::catch_errors( true );
3094
		ob_start();
3095
		require self::get_module_path( $module );
3096
		/** This action is documented in class.jetpack.php */
3097
		do_action( 'jetpack_activate_module', $module );
3098
		$active[] = $module;
3099
		self::update_active_modules( $active );
3100
3101
		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...
3102
		ob_end_clean();
3103
		self::catch_errors( false );
3104
3105
		if ( $redirect ) {
3106
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3107
		}
3108
		if ( $exit ) {
3109
			exit;
3110
		}
3111
		return true;
3112
	}
3113
3114
	function activate_module_actions( $module ) {
3115
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3116
	}
3117
3118
	public static function deactivate_module( $module ) {
3119
		/**
3120
		 * Fires when a module is deactivated.
3121
		 *
3122
		 * @since 1.9.0
3123
		 *
3124
		 * @param string $module Module slug.
3125
		 */
3126
		do_action( 'jetpack_pre_deactivate_module', $module );
3127
3128
		$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...
3129
3130
		$active = self::get_active_modules();
3131
		$new    = array_filter( array_diff( $active, (array) $module ) );
3132
3133
		return self::update_active_modules( $new );
3134
	}
3135
3136
	public static function enable_module_configurable( $module ) {
3137
		$module = self::get_module_slug( $module );
3138
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3139
	}
3140
3141
	/**
3142
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3143
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3144
	 *
3145
	 * @param string $module Module slug
3146
	 * @return string $url module configuration URL
3147
	 */
3148
	public static function module_configuration_url( $module ) {
3149
		$module      = self::get_module_slug( $module );
3150
		$default_url = self::admin_url() . "#/settings?term=$module";
3151
		/**
3152
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3153
		 *
3154
		 * @since 6.9.0
3155
		 *
3156
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3157
		 */
3158
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3159
3160
		return $url;
3161
	}
3162
3163
	/* Installation */
3164
	public static function bail_on_activation( $message, $deactivate = true ) {
3165
		?>
3166
<!doctype html>
3167
<html>
3168
<head>
3169
<meta charset="<?php bloginfo( 'charset' ); ?>">
3170
<style>
3171
* {
3172
	text-align: center;
3173
	margin: 0;
3174
	padding: 0;
3175
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3176
}
3177
p {
3178
	margin-top: 1em;
3179
	font-size: 18px;
3180
}
3181
</style>
3182
<body>
3183
<p><?php echo esc_html( $message ); ?></p>
3184
</body>
3185
</html>
3186
		<?php
3187
		if ( $deactivate ) {
3188
			$plugins = get_option( 'active_plugins' );
3189
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3190
			$update  = false;
3191
			foreach ( $plugins as $i => $plugin ) {
3192
				if ( $plugin === $jetpack ) {
3193
					$plugins[ $i ] = false;
3194
					$update        = true;
3195
				}
3196
			}
3197
3198
			if ( $update ) {
3199
				update_option( 'active_plugins', array_filter( $plugins ) );
3200
			}
3201
		}
3202
		exit;
3203
	}
3204
3205
	/**
3206
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3207
	 *
3208
	 * @static
3209
	 */
3210
	public static function plugin_activation( $network_wide ) {
3211
		Jetpack_Options::update_option( 'activated', 1 );
3212
3213
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3214
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3215
		}
3216
3217
		if ( $network_wide ) {
3218
			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...
3219
		}
3220
3221
		// For firing one-off events (notices) immediately after activation
3222
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3223
3224
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3225
3226
		Health::on_jetpack_activated();
3227
3228
		self::plugin_initialize();
3229
	}
3230
3231
	public static function get_activation_source( $referer_url ) {
3232
3233
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3234
			return array( 'wp-cli', null );
3235
		}
3236
3237
		$referer = wp_parse_url( $referer_url );
3238
3239
		$source_type  = 'unknown';
3240
		$source_query = null;
3241
3242
		if ( ! is_array( $referer ) ) {
3243
			return array( $source_type, $source_query );
3244
		}
3245
3246
		$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...
3247
		$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...
3248
3249
		if ( isset( $referer['query'] ) ) {
3250
			parse_str( $referer['query'], $query_parts );
3251
		} else {
3252
			$query_parts = array();
3253
		}
3254
3255
		if ( $plugins_path === $referer['path'] ) {
3256
			$source_type = 'list';
3257
		} elseif ( $plugins_install_path === $referer['path'] ) {
3258
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3259
			switch ( $tab ) {
3260
				case 'popular':
3261
					$source_type = 'popular';
3262
					break;
3263
				case 'recommended':
3264
					$source_type = 'recommended';
3265
					break;
3266
				case 'favorites':
3267
					$source_type = 'favorites';
3268
					break;
3269
				case 'search':
3270
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3271
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3272
					break;
3273
				default:
3274
					$source_type = 'featured';
3275
			}
3276
		}
3277
3278
		return array( $source_type, $source_query );
3279
	}
3280
3281
	/**
3282
	 * Runs before bumping version numbers up to a new version
3283
	 *
3284
	 * @param string $version    Version:timestamp.
3285
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3286
	 */
3287
	public static function do_version_bump( $version, $old_version ) {
3288
		if ( $old_version ) { // For existing Jetpack installations.
3289
			self::send_update_modal_data();
3290
		}
3291
	}
3292
3293
	/**
3294
	 * Prepares the release post content and image data and saves it in the
3295
	 * state array. This data is used to create the update modal.
3296
	 */
3297
	public static function send_update_modal_data() {
3298
		$post_data = self::get_release_post_data();
3299
3300
		if ( ! isset( $post_data['posts'][0] ) ) {
3301
			return;
3302
		}
3303
3304
		$post = $post_data['posts'][0];
3305
3306
		$post_content = isset( $post['content'] ) ? $post['content'] : null;
3307
		if ( empty( $post_content ) ) {
3308
			return;
3309
		}
3310
3311
		// This allows us to embed videopress videos into the release post.
3312
		add_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3313
		$content = wp_kses_post( $post_content );
3314
		remove_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3315
3316
		$post_title = isset( $post['title'] ) ? $post['title'] : null;
3317
		$title      = wp_kses( $post_title, array() );
3318
3319
		$post_thumbnail = isset( $post['post_thumbnail'] ) ? $post['post_thumbnail'] : null;
3320
		if ( ! empty( $post_thumbnail ) ) {
3321
			jetpack_require_lib( 'class.jetpack-photon-image' );
3322
			$photon_image = new Jetpack_Photon_Image(
3323
				array(
3324
					'file'   => jetpack_photon_url( $post_thumbnail['URL'] ),
3325
					'width'  => $post_thumbnail['width'],
3326
					'height' => $post_thumbnail['height'],
3327
				),
3328
				$post_thumbnail['mime_type']
3329
			);
3330
			$photon_image->resize(
3331
				array(
3332
					'width'  => 600,
3333
					'height' => null,
3334
					'crop'   => false,
3335
				)
3336
			);
3337
			$post_thumbnail_url = $photon_image->get_raw_filename();
3338
		} else {
3339
			$post_thumbnail_url = null;
3340
		}
3341
3342
		$post_array = array(
3343
			'release_post_content'        => $content,
3344
			'release_post_featured_image' => $post_thumbnail_url,
3345
			'release_post_title'          => $title,
3346
		);
3347
3348
		self::state( 'message_content', $post_array );
0 ignored issues
show
Documentation introduced by
$post_array is of type array<string,?,{"release...lease_post_title":"?"}>, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

Loading history...
3855
				break;
3856
		}
3857
3858
		if ( ! $response ) {
3859
			$response = new Jetpack_Error( 'unknown_error', 'Unknown Error', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_error'.

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

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

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

Loading history...
3860
		}
3861
3862
		if ( is_wp_error( $response ) ) {
3863
			$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<Jetpack_Error>.

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

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

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

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

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

Loading history...
3865
			$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<Jetpack_Error>.

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

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

Loading history...
3866
3867
			if ( ! is_int( $status_code ) ) {
3868
				$status_code = 400;
3869
			}
3870
3871
			status_header( $status_code );
3872
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3873
		}
3874
3875
		status_header( 200 );
3876
		if ( true === $response ) {
3877
			exit;
3878
		}
3879
3880
		die( json_encode( (object) $response ) );
3881
	}
3882
3883
	/**
3884
	 * Uploads a file gotten from the global $_FILES.
3885
	 * If `$update_media_item` is true and `post_id` is defined
3886
	 * the attachment file of the media item (gotten through of the post_id)
3887
	 * will be updated instead of add a new one.
3888
	 *
3889
	 * @param  boolean $update_media_item - update media attachment
3890
	 * @return array - An array describing the uploadind files process
3891
	 */
3892
	function upload_handler( $update_media_item = false ) {
3893
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3894
			return new Jetpack_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 405.

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

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

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

Loading history...
3895
		}
3896
3897
		$user = wp_authenticate( '', '' );
3898
		if ( ! $user || is_wp_error( $user ) ) {
3899
			return new Jetpack_Error( 403, get_status_header_desc( 403 ), 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 403.

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

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

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

Loading history...
3900
		}
3901
3902
		wp_set_current_user( $user->ID );
3903
3904
		if ( ! current_user_can( 'upload_files' ) ) {
3905
			return new Jetpack_Error( 'cannot_upload_files', 'User does not have permission to upload files', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'cannot_upload_files'.

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3915
			}
3916
		}
3917
3918
		$media_keys = array_keys( $_FILES['media'] );
3919
3920
		$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...
3921
		if ( ! $token || is_wp_error( $token ) ) {
3922
			return new Jetpack_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'unknown_token'.

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

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

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

Loading history...
3923
		}
3924
3925
		$uploaded_files = array();
3926
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3927
		unset( $GLOBALS['post'] );
3928
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3929
			$file = array();
3930
			foreach ( $media_keys as $media_key ) {
3931
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3932
			}
3933
3934
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3935
3936
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3937
			if ( $hmac_provided !== $hmac_file ) {
3938
				$uploaded_files[ $index ] = (object) array(
3939
					'error'             => 'invalid_hmac',
3940
					'error_description' => 'The corresponding HMAC for this file does not match',
3941
				);
3942
				continue;
3943
			}
3944
3945
			$_FILES['.jetpack.upload.'] = $file;
3946
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3947
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3948
				$post_id = 0;
3949
			}
3950
3951
			if ( $update_media_item ) {
3952
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3953
					return new Jetpack_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to Jetpack_Error::__construct() has too many arguments starting with 'invalid_input'.

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

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

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

Loading history...
3954
				}
3955
3956
				$media_array = $_FILES['media'];
3957
3958
				$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...
3959
				$file_array['type']     = $media_array['type'][0];
3960
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3961
				$file_array['error']    = $media_array['error'][0];
3962
				$file_array['size']     = $media_array['size'][0];
3963
3964
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3965
3966
				if ( is_wp_error( $edited_media_item ) ) {
3967
					return $edited_media_item;
3968
				}
3969
3970
				$response = (object) array(
3971
					'id'   => (string) $post_id,
3972
					'file' => (string) $edited_media_item->post_title,
3973
					'url'  => (string) wp_get_attachment_url( $post_id ),
3974
					'type' => (string) $edited_media_item->post_mime_type,
3975
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3976
				);
3977
3978
				return (array) array( $response );
3979
			}
3980
3981
			$attachment_id = media_handle_upload(
3982
				'.jetpack.upload.',
3983
				$post_id,
3984
				array(),
3985
				array(
3986
					'action' => 'jetpack_upload_file',
3987
				)
3988
			);
3989
3990
			if ( ! $attachment_id ) {
3991
				$uploaded_files[ $index ] = (object) array(
3992
					'error'             => 'unknown',
3993
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3994
				);
3995
			} elseif ( is_wp_error( $attachment_id ) ) {
3996
				$uploaded_files[ $index ] = (object) array(
3997
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3998
					'error_description' => $attachment_id->get_error_message(),
3999
				);
4000
			} else {
4001
				$attachment               = get_post( $attachment_id );
4002
				$uploaded_files[ $index ] = (object) array(
4003
					'id'   => (string) $attachment_id,
4004
					'file' => $attachment->post_title,
4005
					'url'  => wp_get_attachment_url( $attachment_id ),
4006
					'type' => $attachment->post_mime_type,
4007
					'meta' => wp_get_attachment_metadata( $attachment_id ),
4008
				);
4009
				// Zip files uploads are not supported unless they are done for installation purposed
4010
				// lets delete them in case something goes wrong in this whole process
4011
				if ( 'application/zip' === $attachment->post_mime_type ) {
4012
					// Schedule a cleanup for 2 hours from now in case of failed install.
4013
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
4014
				}
4015
			}
4016
		}
4017
		if ( ! is_null( $global_post ) ) {
4018
			$GLOBALS['post'] = $global_post;
4019
		}
4020
4021
		return $uploaded_files;
4022
	}
4023
4024
	/**
4025
	 * Add help to the Jetpack page
4026
	 *
4027
	 * @since Jetpack (1.2.3)
4028
	 * @return false if not the Jetpack page
4029
	 */
4030
	function admin_help() {
4031
		$current_screen = get_current_screen();
4032
4033
		// Overview
4034
		$current_screen->add_help_tab(
4035
			array(
4036
				'id'      => 'home',
4037
				'title'   => __( 'Home', 'jetpack' ),
4038
				'content' =>
4039
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4040
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
4041
					'<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>',
4042
			)
4043
		);
4044
4045
		// Screen Content
4046
		if ( current_user_can( 'manage_options' ) ) {
4047
			$current_screen->add_help_tab(
4048
				array(
4049
					'id'      => 'settings',
4050
					'title'   => __( 'Settings', 'jetpack' ),
4051
					'content' =>
4052
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
4053
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
4054
						'<ol>' .
4055
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
4056
							'<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>' .
4057
						'</ol>' .
4058
						'<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>',
4059
				)
4060
			);
4061
		}
4062
4063
		// Help Sidebar
4064
		$support_url = Redirect::get_url( 'jetpack-support' );
4065
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
4066
		$current_screen->set_help_sidebar(
4067
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
4068
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
4069
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
4070
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
4071
		);
4072
	}
4073
4074
	function admin_menu_css() {
4075
		wp_enqueue_style( 'jetpack-icons' );
4076
	}
4077
4078
	function admin_menu_order() {
4079
		return true;
4080
	}
4081
4082 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
4083
		$jp_menu_order = array();
4084
4085
		foreach ( $menu_order as $index => $item ) {
4086
			if ( $item != 'jetpack' ) {
4087
				$jp_menu_order[] = $item;
4088
			}
4089
4090
			if ( $index == 0 ) {
4091
				$jp_menu_order[] = 'jetpack';
4092
			}
4093
		}
4094
4095
		return $jp_menu_order;
4096
	}
4097
4098
	function admin_banner_styles() {
4099
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4100
4101 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4102
			wp_register_style(
4103
				'jetpack-dops-style',
4104
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4105
				array(),
4106
				JETPACK__VERSION
4107
			);
4108
		}
4109
4110
		wp_enqueue_style(
4111
			'jetpack',
4112
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4113
			array( 'jetpack-dops-style' ),
4114
			JETPACK__VERSION . '-20121016'
4115
		);
4116
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4117
		wp_style_add_data( 'jetpack', 'suffix', $min );
4118
	}
4119
4120
	function plugin_action_links( $actions ) {
4121
4122
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4123
4124
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4125
			return array_merge(
4126
				$jetpack_home,
4127
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4128
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4129
				$actions
4130
			);
4131
		}
4132
4133
		return array_merge( $jetpack_home, $actions );
4134
	}
4135
4136
	/**
4137
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4138
	 *
4139
	 * @param string $login_url The wp-login URL.
4140
	 * @param string $redirect  URL to redirect users after logging in.
4141
	 * @since Jetpack 8.4
4142
	 * @return string
4143
	 */
4144
	public function login_url( $login_url, $redirect ) {
4145
		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...
4146
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4147
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4148
		}
4149
		return $login_url;
4150
	}
4151
4152
	/**
4153
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4154
	 *
4155
	 * @since Jetpack 8.4
4156
	 */
4157
	public function login_init() {
4158
		// phpcs:ignore WordPress.Security.NonceVerification
4159
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4160
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4161
			wp_safe_redirect(
4162
				add_query_arg(
4163
					array(
4164
						'forceInstall' => 1,
4165
						'url'          => rawurlencode( get_site_url() ),
4166
					),
4167
					// @todo provide way to go to specific calypso env.
4168
					self::get_calypso_host() . 'jetpack/connect'
4169
				)
4170
			);
4171
			exit;
4172
		}
4173
	}
4174
4175
	/*
4176
	 * Registration flow:
4177
	 * 1 - ::admin_page_load() action=register
4178
	 * 2 - ::try_registration()
4179
	 * 3 - ::register()
4180
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4181
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4182
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4183
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4184
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4185
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4186
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4187
	 *       jetpack_id, jetpack_secret, jetpack_public
4188
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4189
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4190
	 * 5 - user logs in with WP.com account
4191
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4192
	 *		- Manager::authorize()
4193
	 *		- Manager::get_token()
4194
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4195
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4196
	 *			- which responds with access_token, token_type, scope
4197
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4198
	 *		- Jetpack::activate_default_modules()
4199
	 *     		- Deactivates deprecated plugins
4200
	 *     		- Activates all default modules
4201
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4202
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4203
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4204
	 *     Done!
4205
	 */
4206
4207
	/**
4208
	 * Handles the page load events for the Jetpack admin page
4209
	 */
4210
	function admin_page_load() {
4211
		$error = false;
4212
4213
		// Make sure we have the right body class to hook stylings for subpages off of.
4214
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4215
4216
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4217
			// Should only be used in intermediate redirects to preserve state across redirects
4218
			self::restate();
4219
		}
4220
4221
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4222
			// @todo: Add validation against a known whitelist
4223
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4224
			// User clicked in the iframe to link their accounts
4225
			if ( ! self::is_user_connected() ) {
4226
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4227
4228
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4229
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4230
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4231
4232
				if ( isset( $_GET['notes_iframe'] ) ) {
4233
					$connect_url .= '&notes_iframe';
4234
				}
4235
				wp_redirect( $connect_url );
4236
				exit;
4237
			} else {
4238
				if ( ! isset( $_GET['calypso_env'] ) ) {
4239
					self::state( 'message', 'already_authorized' );
4240
					wp_safe_redirect( self::admin_url() );
4241
					exit;
4242
				} else {
4243
					$connect_url  = $this->build_connect_url( true, false, $from );
4244
					$connect_url .= '&already_authorized=true';
4245
					wp_redirect( $connect_url );
4246
					exit;
4247
				}
4248
			}
4249
		}
4250
4251
		if ( isset( $_GET['action'] ) ) {
4252
			switch ( $_GET['action'] ) {
4253
				case 'authorize':
4254
					if ( self::is_active() && self::is_user_connected() ) {
4255
						self::state( 'message', 'already_authorized' );
4256
						wp_safe_redirect( self::admin_url() );
4257
						exit;
4258
					}
4259
					self::log( 'authorize' );
4260
					$client_server = new Jetpack_Client_Server();
4261
					$client_server->client_authorize();
4262
					exit;
4263
				case 'register':
4264
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4265
						$error = 'cheatin';
4266
						break;
4267
					}
4268
					check_admin_referer( 'jetpack-register' );
4269
					self::log( 'register' );
4270
					self::maybe_set_version_option();
4271
					$registered = self::try_registration();
4272 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4273
						$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...
4274
						self::state( 'error', $error );
4275
						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...
4276
4277
						/**
4278
						 * Jetpack registration Error.
4279
						 *
4280
						 * @since 7.5.0
4281
						 *
4282
						 * @param string|int $error The error code.
4283
						 * @param \WP_Error $registered The error object.
4284
						 */
4285
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4286
						break;
4287
					}
4288
4289
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4290
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4291
4292
					/**
4293
					 * Jetpack registration Success.
4294
					 *
4295
					 * @since 7.5.0
4296
					 *
4297
					 * @param string $from 'from' GET parameter;
4298
					 */
4299
					do_action( 'jetpack_connection_register_success', $from );
4300
4301
					$url = $this->build_connect_url( true, $redirect, $from );
4302
4303
					if ( ! empty( $_GET['onboarding'] ) ) {
4304
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4305
					}
4306
4307
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4308
						$url = add_query_arg( 'auth_approved', 'true', $url );
4309
					}
4310
4311
					wp_redirect( $url );
4312
					exit;
4313
				case 'activate':
4314
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4315
						$error = 'cheatin';
4316
						break;
4317
					}
4318
4319
					$module = stripslashes( $_GET['module'] );
4320
					check_admin_referer( "jetpack_activate-$module" );
4321
					self::log( 'activate', $module );
4322
					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...
4323
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4324
					}
4325
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4326
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4327
					exit;
4328
				case 'activate_default_modules':
4329
					check_admin_referer( 'activate_default_modules' );
4330
					self::log( 'activate_default_modules' );
4331
					self::restate();
4332
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4333
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4334
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4335
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4336
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4337
					exit;
4338
				case 'disconnect':
4339
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4340
						$error = 'cheatin';
4341
						break;
4342
					}
4343
4344
					check_admin_referer( 'jetpack-disconnect' );
4345
					self::log( 'disconnect' );
4346
					self::disconnect();
4347
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4348
					exit;
4349
				case 'reconnect':
4350
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4351
						$error = 'cheatin';
4352
						break;
4353
					}
4354
4355
					check_admin_referer( 'jetpack-reconnect' );
4356
					self::log( 'reconnect' );
4357
					$this->disconnect();
4358
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4359
					exit;
4360 View Code Duplication
				case 'deactivate':
4361
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4362
						$error = 'cheatin';
4363
						break;
4364
					}
4365
4366
					$modules = stripslashes( $_GET['module'] );
4367
					check_admin_referer( "jetpack_deactivate-$modules" );
4368
					foreach ( explode( ',', $modules ) as $module ) {
4369
						self::log( 'deactivate', $module );
4370
						self::deactivate_module( $module );
4371
						self::state( 'message', 'module_deactivated' );
4372
					}
4373
					self::state( 'module', $modules );
4374
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4375
					exit;
4376
				case 'unlink':
4377
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4378
					check_admin_referer( 'jetpack-unlink' );
4379
					self::log( 'unlink' );
4380
					Connection_Manager::disconnect_user();
4381
					self::state( 'message', 'unlinked' );
4382
					if ( 'sub-unlink' == $redirect ) {
4383
						wp_safe_redirect( admin_url() );
4384
					} else {
4385
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4386
					}
4387
					exit;
4388
				case 'onboard':
4389
					if ( ! current_user_can( 'manage_options' ) ) {
4390
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4391
					} else {
4392
						self::create_onboarding_token();
4393
						$url = $this->build_connect_url( true );
4394
4395
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4396
							$url = add_query_arg( 'onboarding', $token, $url );
4397
						}
4398
4399
						$calypso_env = $this->get_calypso_env();
4400
						if ( ! empty( $calypso_env ) ) {
4401
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4402
						}
4403
4404
						wp_redirect( $url );
4405
						exit;
4406
					}
4407
					exit;
4408
				default:
4409
					/**
4410
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4411
					 *
4412
					 * @since 2.6.0
4413
					 *
4414
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4415
					 */
4416
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4417
			}
4418
		}
4419
4420
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4421
			self::activate_new_modules( true );
4422
		}
4423
4424
		$message_code = self::state( 'message' );
4425
		if ( self::state( 'optin-manage' ) ) {
4426
			$activated_manage = $message_code;
4427
			$message_code     = 'jetpack-manage';
4428
		}
4429
4430
		switch ( $message_code ) {
4431
			case 'jetpack-manage':
4432
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4433
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4434
				$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>';
4435
				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...
4436
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4437
				}
4438
				break;
4439
4440
		}
4441
4442
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4443
4444
		if ( ! empty( $deactivated_plugins ) ) {
4445
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4446
			$deactivated_titles  = array();
4447
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4448
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4449
					continue;
4450
				}
4451
4452
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4453
			}
4454
4455
			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...
4456
				if ( $this->message ) {
4457
					$this->message .= "<br /><br />\n";
4458
				}
4459
4460
				$this->message .= wp_sprintf(
4461
					_n(
4462
						'Jetpack contains the most recent version of the old %l plugin.',
4463
						'Jetpack contains the most recent versions of the old %l plugins.',
4464
						count( $deactivated_titles ),
4465
						'jetpack'
4466
					),
4467
					$deactivated_titles
4468
				);
4469
4470
				$this->message .= "<br />\n";
4471
4472
				$this->message .= _n(
4473
					'The old version has been deactivated and can be removed from your site.',
4474
					'The old versions have been deactivated and can be removed from your site.',
4475
					count( $deactivated_titles ),
4476
					'jetpack'
4477
				);
4478
			}
4479
		}
4480
4481
		$this->privacy_checks = self::state( 'privacy_checks' );
4482
4483
		if ( $this->message || $this->error || $this->privacy_checks ) {
4484
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4485
		}
4486
4487
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4488
	}
4489
4490
	function admin_notices() {
4491
4492
		if ( $this->error ) {
4493
			?>
4494
<div id="message" class="jetpack-message jetpack-err">
4495
	<div class="squeezer">
4496
		<h2>
4497
			<?php
4498
			echo wp_kses(
4499
				$this->error,
4500
				array(
4501
					'a'      => array( 'href' => array() ),
4502
					'small'  => true,
4503
					'code'   => true,
4504
					'strong' => true,
4505
					'br'     => true,
4506
					'b'      => true,
4507
				)
4508
			);
4509
			?>
4510
			</h2>
4511
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4512
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4513
<?php	endif; ?>
4514
	</div>
4515
</div>
4516
			<?php
4517
		}
4518
4519
		if ( $this->message ) {
4520
			?>
4521
<div id="message" class="jetpack-message">
4522
	<div class="squeezer">
4523
		<h2>
4524
			<?php
4525
			echo wp_kses(
4526
				$this->message,
4527
				array(
4528
					'strong' => array(),
4529
					'a'      => array( 'href' => true ),
4530
					'br'     => true,
4531
				)
4532
			);
4533
			?>
4534
			</h2>
4535
	</div>
4536
</div>
4537
			<?php
4538
		}
4539
4540
		if ( $this->privacy_checks ) :
4541
			$module_names = $module_slugs = array();
4542
4543
			$privacy_checks = explode( ',', $this->privacy_checks );
4544
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4545
			foreach ( $privacy_checks as $module_slug ) {
4546
				$module = self::get_module( $module_slug );
4547
				if ( ! $module ) {
4548
					continue;
4549
				}
4550
4551
				$module_slugs[] = $module_slug;
4552
				$module_names[] = "<strong>{$module['name']}</strong>";
4553
			}
4554
4555
			$module_slugs = join( ',', $module_slugs );
4556
			?>
4557
<div id="message" class="jetpack-message jetpack-err">
4558
	<div class="squeezer">
4559
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4560
		<p>
4561
			<?php
4562
			echo wp_kses(
4563
				wptexturize(
4564
					wp_sprintf(
4565
						_nx(
4566
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4567
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4568
							count( $privacy_checks ),
4569
							'%l = list of Jetpack module/feature names',
4570
							'jetpack'
4571
						),
4572
						$module_names
4573
					)
4574
				),
4575
				array( 'strong' => true )
4576
			);
4577
4578
			echo "\n<br />\n";
4579
4580
			echo wp_kses(
4581
				sprintf(
4582
					_nx(
4583
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4584
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4585
						count( $privacy_checks ),
4586
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4587
						'jetpack'
4588
					),
4589
					wp_nonce_url(
4590
						self::admin_url(
4591
							array(
4592
								'page'   => 'jetpack',
4593
								'action' => 'deactivate',
4594
								'module' => urlencode( $module_slugs ),
4595
							)
4596
						),
4597
						"jetpack_deactivate-$module_slugs"
4598
					),
4599
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4600
				),
4601
				array(
4602
					'a' => array(
4603
						'href'  => true,
4604
						'title' => true,
4605
					),
4606
				)
4607
			);
4608
			?>
4609
		</p>
4610
	</div>
4611
</div>
4612
			<?php
4613
endif;
4614
	}
4615
4616
	/**
4617
	 * We can't always respond to a signed XML-RPC request with a
4618
	 * helpful error message. In some circumstances, doing so could
4619
	 * leak information.
4620
	 *
4621
	 * Instead, track that the error occurred via a Jetpack_Option,
4622
	 * and send that data back in the heartbeat.
4623
	 * All this does is increment a number, but it's enough to find
4624
	 * trends.
4625
	 *
4626
	 * @param WP_Error $xmlrpc_error The error produced during
4627
	 *                               signature validation.
4628
	 */
4629
	function track_xmlrpc_error( $xmlrpc_error ) {
4630
		$code = is_wp_error( $xmlrpc_error )
4631
			? $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...
4632
			: 'should-not-happen';
4633
4634
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4635
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4636
			// No need to update the option if we already have
4637
			// this code stored.
4638
			return;
4639
		}
4640
		$xmlrpc_errors[ $code ] = true;
4641
4642
		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...
4643
	}
4644
4645
	/**
4646
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4647
	 */
4648
	function stat( $group, $detail ) {
4649
		if ( ! isset( $this->stats[ $group ] ) ) {
4650
			$this->stats[ $group ] = array();
4651
		}
4652
		$this->stats[ $group ][] = $detail;
4653
	}
4654
4655
	/**
4656
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4657
	 */
4658
	function do_stats( $method = '' ) {
4659
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4660
			foreach ( $this->stats as $group => $stats ) {
4661
				if ( is_array( $stats ) && count( $stats ) ) {
4662
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4663
					if ( 'server_side' === $method ) {
4664
						self::do_server_side_stat( $args );
4665
					} else {
4666
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4667
					}
4668
				}
4669
				unset( $this->stats[ $group ] );
4670
			}
4671
		}
4672
	}
4673
4674
	/**
4675
	 * Runs stats code for a one-off, server-side.
4676
	 *
4677
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4678
	 *
4679
	 * @return bool If it worked.
4680
	 */
4681
	static function do_server_side_stat( $args ) {
4682
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4683
		if ( is_wp_error( $response ) ) {
4684
			return false;
4685
		}
4686
4687
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4688
			return false;
4689
		}
4690
4691
		return true;
4692
	}
4693
4694
	/**
4695
	 * Builds the stats url.
4696
	 *
4697
	 * @param $args array|string The arguments to append to the URL.
4698
	 *
4699
	 * @return string The URL to be pinged.
4700
	 */
4701
	static function build_stats_url( $args ) {
4702
		$defaults = array(
4703
			'v'    => 'wpcom2',
4704
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4705
		);
4706
		$args     = wp_parse_args( $args, $defaults );
0 ignored issues
show
Documentation introduced by
$defaults is of type array<string,string,{"v"...ring","rand":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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