Completed
Push — add/implement_wizard_banner ( 2cf485...af534f )
by
unknown
14:54 queued 08:11
created

Jetpack::show_development_mode_notice()   A

Complexity

Conditions 4
Paths 8

Size

Total Lines 28

Duplication

Lines 17
Ratio 60.71 %

Importance

Changes 0
Metric Value
cc 4
nc 8
nop 0
dl 17
loc 28
rs 9.472
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_ajax_jetpack_wizard_banner', array( 'Jetpack_Wizard_Banner', 'ajax_callback' ) );
674
675
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
676
677
		/**
678
		 * These actions run checks to load additional files.
679
		 * They check for external files or plugins, so they need to run as late as possible.
680
		 */
681
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
682
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
683
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
684
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
685
686
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
687
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
688
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
689
690
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
691
692
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
693
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
694
695
		// A filter to control all just in time messages
696
		add_filter( 'jetpack_just_in_time_msgs', array( $this, 'is_active_and_not_development_mode' ), 9 );
697
698
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
699
700
		/*
701
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
702
		 * We should make sure to only do this for front end links.
703
		 */
704
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
705
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
706
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
707
708
			/*
709
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
710
			 * so they point moderation links on emails to Calypso.
711
			 */
712
			jetpack_require_lib( 'functions.wp-notify' );
713
		}
714
715
		// Hide edit post link if mobile app.
716
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
717
			add_filter( 'get_edit_post_link', '__return_empty_string' );
718
		}
719
720
		// Update the Jetpack plan from API on heartbeats.
721
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
722
723
		/**
724
		 * This is the hack to concatenate all css files into one.
725
		 * For description and reasoning see the implode_frontend_css method.
726
		 *
727
		 * Super late priority so we catch all the registered styles.
728
		 */
729
		if ( ! is_admin() ) {
730
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
731
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
732
		}
733
734
		/**
735
		 * These are sync actions that we need to keep track of for jitms
736
		 */
737
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
738
739
		// Actually push the stats on shutdown.
740
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
741
			add_action( 'shutdown', array( $this, 'push_stats' ) );
742
		}
743
744
		/*
745
		 * Load some scripts asynchronously.
746
		 */
747
		add_action( 'script_loader_tag', array( $this, 'script_add_async' ), 10, 3 );
748
749
		// Actions for Manager::authorize().
750
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
751
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
752
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
753
754
		// Filters for the Manager::get_token() urls and request body.
755
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
756
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
757
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
758
	}
759
760
	/**
761
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
762
	 * Config object.
763
	 */
764
	public function configure() {
765
		$config = new Config();
766
767
		foreach (
768
			array(
769
				'connection',
770
				'sync',
771
				'tracking',
772
				'tos',
773
			)
774
			as $feature
775
		) {
776
			$config->ensure( $feature );
777
		}
778
779
		if ( is_admin() ) {
780
			$config->ensure( 'jitm' );
781
		}
782
783
		if ( ! $this->connection_manager ) {
784
			$this->connection_manager = new Connection_Manager();
785
		}
786
787
		/*
788
		 * Load things that should only be in Network Admin.
789
		 *
790
		 * For now blow away everything else until a more full
791
		 * understanding of what is needed at the network level is
792
		 * available
793
		 */
794
		if ( is_multisite() ) {
795
			$network = Jetpack_Network::init();
796
			$network->set_connection( $this->connection_manager );
797
		}
798
799
		if ( $this->connection_manager->is_active() ) {
800
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
801
802
			Jetpack_Heartbeat::init();
803
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
804
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
805
				Jetpack_Search_Performance_Logger::init();
806
			}
807
		}
808
809
		// Initialize remote file upload request handlers.
810
		$this->add_remote_request_handlers();
811
812
		/*
813
		 * Enable enhanced handling of previewing sites in Calypso
814
		 */
815
		if ( self::is_active() ) {
816
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
817
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
818
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
819
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
820
		}
821
	}
822
823
	/**
824
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
825
	 * initialization code.
826
	 *
827
	 * @action plugins_loaded
828
	 */
829
	public function late_initialization() {
830
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
831
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
832
833
		Partner::init();
834
835
		/**
836
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
837
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
838
		 *
839
		 * @since 8.1.0
840
		 *
841
		 * @param Jetpack $jetpack the main plugin class object.
842
		 */
843
		do_action( 'jetpack_loaded', $this );
844
845
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
846
	}
847
848
	/**
849
	 * Sets up the XMLRPC request handlers.
850
	 *
851
	 * @deprecated since 7.7.0
852
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
853
	 *
854
	 * @param array                 $request_params Incoming request parameters.
855
	 * @param Boolean               $is_active      Whether the connection is currently active.
856
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
857
	 * @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...
858
	 */
859 View Code Duplication
	public function setup_xmlrpc_handlers(
860
		$request_params,
861
		$is_active,
862
		$is_signed,
863
		Jetpack_XMLRPC_Server $xmlrpc_server = null
864
	) {
865
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
866
867
		if ( ! $this->connection_manager ) {
868
			$this->connection_manager = new Connection_Manager();
869
		}
870
871
		return $this->connection_manager->setup_xmlrpc_handlers(
872
			$request_params,
873
			$is_active,
874
			$is_signed,
875
			$xmlrpc_server
876
		);
877
	}
878
879
	/**
880
	 * Initialize REST API registration connector.
881
	 *
882
	 * @deprecated since 7.7.0
883
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
884
	 */
885 View Code Duplication
	public function initialize_rest_api_registration_connector() {
886
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
887
888
		if ( ! $this->connection_manager ) {
889
			$this->connection_manager = new Connection_Manager();
890
		}
891
892
		$this->connection_manager->initialize_rest_api_registration_connector();
893
	}
894
895
	/**
896
	 * This is ported over from the manage module, which has been deprecated and baked in here.
897
	 *
898
	 * @param $domains
899
	 */
900
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
901
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
902
	}
903
904
	/**
905
	 * Return $domains, with 'wordpress.com' appended.
906
	 * This is ported over from the manage module, which has been deprecated and baked in here.
907
	 *
908
	 * @param $domains
909
	 * @return array
910
	 */
911
	function allow_wpcom_domain( $domains ) {
912
		if ( empty( $domains ) ) {
913
			$domains = array();
914
		}
915
		$domains[] = 'wordpress.com';
916
		return array_unique( $domains );
917
	}
918
919
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
920
		$post = get_post( $post_id );
921
922
		if ( empty( $post ) ) {
923
			return $default_url;
924
		}
925
926
		$post_type = $post->post_type;
927
928
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
929
		// https://en.support.wordpress.com/custom-post-types/
930
		$allowed_post_types = array(
931
			'post',
932
			'page',
933
			'jetpack-portfolio',
934
			'jetpack-testimonial',
935
		);
936
937
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
938
			return $default_url;
939
		}
940
941
		return esc_url(
942
			Redirect::get_url(
943
				'calypso-edit-' . $post_type,
944
				array(
945
					'path' => $post_id,
946
				)
947
			)
948
		);
949
	}
950
951
	function point_edit_comment_links_to_calypso( $url ) {
952
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
953
		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...
954
955
		return esc_url(
956
			Redirect::get_url(
957
				'calypso-edit-comment',
958
				array(
959
					'path' => $query_args['amp;c'],
960
				)
961
			)
962
		);
963
964
	}
965
966
	function jetpack_track_last_sync_callback( $params ) {
967
		/**
968
		 * Filter to turn off jitm caching
969
		 *
970
		 * @since 5.4.0
971
		 *
972
		 * @param bool false Whether to cache just in time messages
973
		 */
974
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
975
			return $params;
976
		}
977
978
		if ( is_array( $params ) && isset( $params[0] ) ) {
979
			$option = $params[0];
980
			if ( 'active_plugins' === $option ) {
981
				// use the cache if we can, but not terribly important if it gets evicted
982
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
983
			}
984
		}
985
986
		return $params;
987
	}
988
989 View Code Duplication
	function jetpack_connection_banner_callback() {
990
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
991
992
		if ( isset( $_REQUEST['dismissBanner'] ) ) {
993
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
994
			wp_send_json_success();
995
		}
996
997
		wp_die();
998
	}
999
1000
	/**
1001
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1002
	 * Only used in our alternate XML-RPC endpoint, where we want to
1003
	 * ensure that Core and other plugins' methods are not exposed.
1004
	 *
1005
	 * @deprecated since 7.7.0
1006
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1007
	 *
1008
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1009
	 * @return array Filtered $methods
1010
	 */
1011 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1012
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1013
1014
		if ( ! $this->connection_manager ) {
1015
			$this->connection_manager = new Connection_Manager();
1016
		}
1017
1018
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1019
	}
1020
1021
	/**
1022
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1023
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1024
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1025
	 * which is accessible via a different URI. Most of the below is copied directly
1026
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1027
	 *
1028
	 * @deprecated since 7.7.0
1029
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1030
	 */
1031 View Code Duplication
	public function alternate_xmlrpc() {
1032
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1033
1034
		if ( ! $this->connection_manager ) {
1035
			$this->connection_manager = new Connection_Manager();
1036
		}
1037
1038
		$this->connection_manager->alternate_xmlrpc();
1039
	}
1040
1041
	/**
1042
	 * The callback for the JITM ajax requests.
1043
	 *
1044
	 * @deprecated since 7.9.0
1045
	 */
1046
	function jetpack_jitm_ajax_callback() {
1047
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1048
	}
1049
1050
	/**
1051
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1052
	 */
1053
	function push_stats() {
1054
		if ( ! empty( $this->stats ) ) {
1055
			$this->do_stats( 'server_side' );
1056
		}
1057
	}
1058
1059
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1060
		$is_development_mode = ( new Status() )->is_development_mode();
1061
		switch ( $cap ) {
1062
			case 'jetpack_connect':
1063
			case 'jetpack_reconnect':
1064
				if ( $is_development_mode ) {
1065
					$caps = array( 'do_not_allow' );
1066
					break;
1067
				}
1068
				/**
1069
				 * Pass through. If it's not development mode, these should match disconnect.
1070
				 * Let users disconnect if it's development mode, just in case things glitch.
1071
				 */
1072
			case 'jetpack_disconnect':
1073
				/**
1074
				 * In multisite, can individual site admins manage their own connection?
1075
				 *
1076
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1077
				 */
1078
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1079
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1080
						/**
1081
						 * We need to update the option name -- it's terribly unclear which
1082
						 * direction the override goes.
1083
						 *
1084
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1085
						 */
1086
						$caps = array( 'do_not_allow' );
1087
						break;
1088
					}
1089
				}
1090
1091
				$caps = array( 'manage_options' );
1092
				break;
1093
			case 'jetpack_manage_modules':
1094
			case 'jetpack_activate_modules':
1095
			case 'jetpack_deactivate_modules':
1096
				$caps = array( 'manage_options' );
1097
				break;
1098
			case 'jetpack_configure_modules':
1099
				$caps = array( 'manage_options' );
1100
				break;
1101
			case 'jetpack_manage_autoupdates':
1102
				$caps = array(
1103
					'manage_options',
1104
					'update_plugins',
1105
				);
1106
				break;
1107
			case 'jetpack_network_admin_page':
1108
			case 'jetpack_network_settings_page':
1109
				$caps = array( 'manage_network_plugins' );
1110
				break;
1111
			case 'jetpack_network_sites_page':
1112
				$caps = array( 'manage_sites' );
1113
				break;
1114
			case 'jetpack_admin_page':
1115
				if ( $is_development_mode ) {
1116
					$caps = array( 'manage_options' );
1117
					break;
1118
				} else {
1119
					$caps = array( 'read' );
1120
				}
1121
				break;
1122
			case 'jetpack_connect_user':
1123
				if ( $is_development_mode ) {
1124
					$caps = array( 'do_not_allow' );
1125
					break;
1126
				}
1127
				$caps = array( 'read' );
1128
				break;
1129
		}
1130
		return $caps;
1131
	}
1132
1133
	/**
1134
	 * Require a Jetpack authentication.
1135
	 *
1136
	 * @deprecated since 7.7.0
1137
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1138
	 */
1139 View Code Duplication
	public function require_jetpack_authentication() {
1140
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1141
1142
		if ( ! $this->connection_manager ) {
1143
			$this->connection_manager = new Connection_Manager();
1144
		}
1145
1146
		$this->connection_manager->require_jetpack_authentication();
1147
	}
1148
1149
	/**
1150
	 * Load language files
1151
	 *
1152
	 * @action plugins_loaded
1153
	 */
1154
	public static function plugin_textdomain() {
1155
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1156
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1157
	}
1158
1159
	/**
1160
	 * Register assets for use in various modules and the Jetpack admin page.
1161
	 *
1162
	 * @uses wp_script_is, wp_register_script, plugins_url
1163
	 * @action wp_loaded
1164
	 * @return null
1165
	 */
1166
	public function register_assets() {
1167
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1168
			wp_register_script(
1169
				'spin',
1170
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1171
				false,
1172
				'1.3'
1173
			);
1174
		}
1175
1176 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1177
			wp_register_script(
1178
				'jquery.spin',
1179
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1180
				array( 'jquery', 'spin' ),
1181
				'1.3'
1182
			);
1183
		}
1184
1185 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1186
			wp_register_script(
1187
				'jetpack-gallery-settings',
1188
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1189
				array( 'media-views' ),
1190
				'20121225'
1191
			);
1192
		}
1193
1194 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1195
			wp_register_script(
1196
				'jetpack-twitter-timeline',
1197
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1198
				array( 'jquery' ),
1199
				'4.0.0',
1200
				true
1201
			);
1202
		}
1203
1204
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1205
			wp_register_script(
1206
				'jetpack-facebook-embed',
1207
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1208
				array(),
1209
				null,
1210
				true
1211
			);
1212
1213
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1214
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1215
			if ( ! is_numeric( $fb_app_id ) ) {
1216
				$fb_app_id = '';
1217
			}
1218
			wp_localize_script(
1219
				'jetpack-facebook-embed',
1220
				'jpfbembed',
1221
				array(
1222
					'appid'  => $fb_app_id,
1223
					'locale' => $this->get_locale(),
1224
				)
1225
			);
1226
		}
1227
1228
		/**
1229
		 * As jetpack_register_genericons is by default fired off a hook,
1230
		 * the hook may have already fired by this point.
1231
		 * So, let's just trigger it manually.
1232
		 */
1233
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1234
		jetpack_register_genericons();
1235
1236
		/**
1237
		 * Register the social logos
1238
		 */
1239
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1240
		jetpack_register_social_logos();
1241
1242 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1243
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1244
		}
1245
	}
1246
1247
	/**
1248
	 * Guess locale from language code.
1249
	 *
1250
	 * @param string $lang Language code.
1251
	 * @return string|bool
1252
	 */
1253 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1254
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1255
			return 'en_US';
1256
		}
1257
1258
		if ( ! class_exists( 'GP_Locales' ) ) {
1259
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1260
				return false;
1261
			}
1262
1263
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1264
		}
1265
1266
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1267
			// WP.com: get_locale() returns 'it'
1268
			$locale = GP_Locales::by_slug( $lang );
1269
		} else {
1270
			// Jetpack: get_locale() returns 'it_IT';
1271
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1272
		}
1273
1274
		if ( ! $locale ) {
1275
			return false;
1276
		}
1277
1278
		if ( empty( $locale->facebook_locale ) ) {
1279
			if ( empty( $locale->wp_locale ) ) {
1280
				return false;
1281
			} else {
1282
				// Facebook SDK is smart enough to fall back to en_US if a
1283
				// locale isn't supported. Since supported Facebook locales
1284
				// can fall out of sync, we'll attempt to use the known
1285
				// wp_locale value and rely on said fallback.
1286
				return $locale->wp_locale;
1287
			}
1288
		}
1289
1290
		return $locale->facebook_locale;
1291
	}
1292
1293
	/**
1294
	 * Get the locale.
1295
	 *
1296
	 * @return string|bool
1297
	 */
1298
	function get_locale() {
1299
		$locale = $this->guess_locale_from_lang( get_locale() );
1300
1301
		if ( ! $locale ) {
1302
			$locale = 'en_US';
1303
		}
1304
1305
		return $locale;
1306
	}
1307
1308
	/**
1309
	 * Return the network_site_url so that .com knows what network this site is a part of.
1310
	 *
1311
	 * @param  bool $option
1312
	 * @return string
1313
	 */
1314
	public function jetpack_main_network_site_option( $option ) {
1315
		return network_site_url();
1316
	}
1317
	/**
1318
	 * Network Name.
1319
	 */
1320
	static function network_name( $option = null ) {
1321
		global $current_site;
1322
		return $current_site->site_name;
1323
	}
1324
	/**
1325
	 * Does the network allow new user and site registrations.
1326
	 *
1327
	 * @return string
1328
	 */
1329
	static function network_allow_new_registrations( $option = null ) {
1330
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1331
	}
1332
	/**
1333
	 * Does the network allow admins to add new users.
1334
	 *
1335
	 * @return boolian
1336
	 */
1337
	static function network_add_new_users( $option = null ) {
1338
		return (bool) get_site_option( 'add_new_users' );
1339
	}
1340
	/**
1341
	 * File upload psace left per site in MB.
1342
	 *  -1 means NO LIMIT.
1343
	 *
1344
	 * @return number
1345
	 */
1346
	static function network_site_upload_space( $option = null ) {
1347
		// value in MB
1348
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1349
	}
1350
1351
	/**
1352
	 * Network allowed file types.
1353
	 *
1354
	 * @return string
1355
	 */
1356
	static function network_upload_file_types( $option = null ) {
1357
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1358
	}
1359
1360
	/**
1361
	 * Maximum file upload size set by the network.
1362
	 *
1363
	 * @return number
1364
	 */
1365
	static function network_max_upload_file_size( $option = null ) {
1366
		// value in KB
1367
		return get_site_option( 'fileupload_maxk', 300 );
1368
	}
1369
1370
	/**
1371
	 * Lets us know if a site allows admins to manage the network.
1372
	 *
1373
	 * @return array
1374
	 */
1375
	static function network_enable_administration_menus( $option = null ) {
1376
		return get_site_option( 'menu_items' );
1377
	}
1378
1379
	/**
1380
	 * If a user has been promoted to or demoted from admin, we need to clear the
1381
	 * jetpack_other_linked_admins transient.
1382
	 *
1383
	 * @since 4.3.2
1384
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1385
	 *
1386
	 * @param int    $user_id   The user ID whose role changed.
1387
	 * @param string $role      The new role.
1388
	 * @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...
1389
	 */
1390
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1391
		if ( 'administrator' == $role
1392
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1393
			|| is_null( $old_roles )
1394
		) {
1395
			delete_transient( 'jetpack_other_linked_admins' );
1396
		}
1397
	}
1398
1399
	/**
1400
	 * Checks to see if there are any other users available to become primary
1401
	 * Users must both:
1402
	 * - Be linked to wpcom
1403
	 * - Be an admin
1404
	 *
1405
	 * @return mixed False if no other users are linked, Int if there are.
1406
	 */
1407
	static function get_other_linked_admins() {
1408
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1409
1410
		if ( false === $other_linked_users ) {
1411
			$admins = get_users( array( 'role' => 'administrator' ) );
1412
			if ( count( $admins ) > 1 ) {
1413
				$available = array();
1414
				foreach ( $admins as $admin ) {
1415
					if ( self::is_user_connected( $admin->ID ) ) {
1416
						$available[] = $admin->ID;
1417
					}
1418
				}
1419
1420
				$count_connected_admins = count( $available );
1421
				if ( count( $available ) > 1 ) {
1422
					$other_linked_users = $count_connected_admins;
1423
				} else {
1424
					$other_linked_users = 0;
1425
				}
1426
			} else {
1427
				$other_linked_users = 0;
1428
			}
1429
1430
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1431
		}
1432
1433
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1434
	}
1435
1436
	/**
1437
	 * Return whether we are dealing with a multi network setup or not.
1438
	 * The reason we are type casting this is because we want to avoid the situation where
1439
	 * the result is false since when is_main_network_option return false it cases
1440
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1441
	 * database which could be set to anything as opposed to what this function returns.
1442
	 *
1443
	 * @param  bool $option
1444
	 *
1445
	 * @return boolean
1446
	 */
1447
	public function is_main_network_option( $option ) {
1448
		// return '1' or ''
1449
		return (string) (bool) self::is_multi_network();
1450
	}
1451
1452
	/**
1453
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1454
	 *
1455
	 * @param  string $option
1456
	 * @return boolean
1457
	 */
1458
	public function is_multisite( $option ) {
1459
		return (string) (bool) is_multisite();
1460
	}
1461
1462
	/**
1463
	 * Implemented since there is no core is multi network function
1464
	 * Right now there is no way to tell if we which network is the dominant network on the system
1465
	 *
1466
	 * @since  3.3
1467
	 * @return boolean
1468
	 */
1469 View Code Duplication
	public static function is_multi_network() {
1470
		global  $wpdb;
1471
1472
		// if we don't have a multi site setup no need to do any more
1473
		if ( ! is_multisite() ) {
1474
			return false;
1475
		}
1476
1477
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1478
		if ( $num_sites > 1 ) {
1479
			return true;
1480
		} else {
1481
			return false;
1482
		}
1483
	}
1484
1485
	/**
1486
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1487
	 *
1488
	 * @return null
1489
	 */
1490
	function update_jetpack_main_network_site_option() {
1491
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1492
	}
1493
	/**
1494
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1495
	 */
1496
	function update_jetpack_network_settings() {
1497
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1498
		// Only sync this info for the main network site.
1499
	}
1500
1501
	/**
1502
	 * Get back if the current site is single user site.
1503
	 *
1504
	 * @return bool
1505
	 */
1506 View Code Duplication
	public static function is_single_user_site() {
1507
		global $wpdb;
1508
1509
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1510
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1511
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1512
		}
1513
		return 1 === (int) $some_users;
1514
	}
1515
1516
	/**
1517
	 * Returns true if the site has file write access false otherwise.
1518
	 *
1519
	 * @return string ( '1' | '0' )
1520
	 **/
1521
	public static function file_system_write_access() {
1522
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1523
			require_once ABSPATH . 'wp-admin/includes/file.php';
1524
		}
1525
1526
		require_once ABSPATH . 'wp-admin/includes/template.php';
1527
1528
		$filesystem_method = get_filesystem_method();
1529
		if ( $filesystem_method === 'direct' ) {
1530
			return 1;
1531
		}
1532
1533
		ob_start();
1534
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1535
		ob_end_clean();
1536
		if ( $filesystem_credentials_are_stored ) {
1537
			return 1;
1538
		}
1539
		return 0;
1540
	}
1541
1542
	/**
1543
	 * Finds out if a site is using a version control system.
1544
	 *
1545
	 * @return string ( '1' | '0' )
1546
	 **/
1547
	public static function is_version_controlled() {
1548
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1549
		return (string) (int) Functions::is_version_controlled();
1550
	}
1551
1552
	/**
1553
	 * Determines whether the current theme supports featured images or not.
1554
	 *
1555
	 * @return string ( '1' | '0' )
1556
	 */
1557
	public static function featured_images_enabled() {
1558
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1559
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1560
	}
1561
1562
	/**
1563
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1564
	 *
1565
	 * @deprecated 4.7 use get_avatar_url instead.
1566
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1567
	 * @param int               $size Size of the avatar image
1568
	 * @param string            $default URL to a default image to use if no avatar is available
1569
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1570
	 *
1571
	 * @return array
1572
	 */
1573
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1574
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1575
		return get_avatar_url(
1576
			$id_or_email,
1577
			array(
1578
				'size'          => $size,
1579
				'default'       => $default,
1580
				'force_default' => $force_display,
1581
			)
1582
		);
1583
	}
1584
1585
	/**
1586
	 * jetpack_updates is saved in the following schema:
1587
	 *
1588
	 * array (
1589
	 *      'plugins'                       => (int) Number of plugin updates available.
1590
	 *      'themes'                        => (int) Number of theme updates available.
1591
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1592
	 *      'translations'                  => (int) Number of translation updates available.
1593
	 *      'total'                         => (int) Total of all available updates.
1594
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1595
	 * )
1596
	 *
1597
	 * @return array
1598
	 */
1599
	public static function get_updates() {
1600
		$update_data = wp_get_update_data();
1601
1602
		// Stores the individual update counts as well as the total count.
1603
		if ( isset( $update_data['counts'] ) ) {
1604
			$updates = $update_data['counts'];
1605
		}
1606
1607
		// If we need to update WordPress core, let's find the latest version number.
1608 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1609
			$cur = get_preferred_from_update_core();
1610
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1611
				$updates['wp_update_version'] = $cur->current;
1612
			}
1613
		}
1614
		return isset( $updates ) ? $updates : array();
1615
	}
1616
1617
	public static function get_update_details() {
1618
		$update_details = array(
1619
			'update_core'    => get_site_transient( 'update_core' ),
1620
			'update_plugins' => get_site_transient( 'update_plugins' ),
1621
			'update_themes'  => get_site_transient( 'update_themes' ),
1622
		);
1623
		return $update_details;
1624
	}
1625
1626
	public static function refresh_update_data() {
1627
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1628
1629
	}
1630
1631
	public static function refresh_theme_data() {
1632
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1633
	}
1634
1635
	/**
1636
	 * Is Jetpack active?
1637
	 */
1638
	public static function is_active() {
1639
		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...
1640
	}
1641
1642
	/**
1643
	 * Make an API call to WordPress.com for plan status
1644
	 *
1645
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1646
	 *
1647
	 * @return bool True if plan is updated, false if no update
1648
	 */
1649
	public static function refresh_active_plan_from_wpcom() {
1650
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1651
		return Jetpack_Plan::refresh_from_wpcom();
1652
	}
1653
1654
	/**
1655
	 * Get the plan that this Jetpack site is currently using
1656
	 *
1657
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1658
	 * @return array Active Jetpack plan details.
1659
	 */
1660
	public static function get_active_plan() {
1661
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1662
		return Jetpack_Plan::get();
1663
	}
1664
1665
	/**
1666
	 * Determine whether the active plan supports a particular feature
1667
	 *
1668
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1669
	 * @return bool True if plan supports feature, false if not.
1670
	 */
1671
	public static function active_plan_supports( $feature ) {
1672
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1673
		return Jetpack_Plan::supports( $feature );
1674
	}
1675
1676
	/**
1677
	 * Deprecated: Is Jetpack in development (offline) mode?
1678
	 *
1679
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1680
	 * and themes still use it, and we do not want to flood them with notices.
1681
	 *
1682
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1683
	 *
1684
	 * @deprecated since 8.0.
1685
	 */
1686
	public static function is_development_mode() {
1687
		return ( new Status() )->is_development_mode();
1688
	}
1689
1690
	/**
1691
	 * Whether the site is currently onboarding or not.
1692
	 * A site is considered as being onboarded if it currently has an onboarding token.
1693
	 *
1694
	 * @since 5.8
1695
	 *
1696
	 * @access public
1697
	 * @static
1698
	 *
1699
	 * @return bool True if the site is currently onboarding, false otherwise
1700
	 */
1701
	public static function is_onboarding() {
1702
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1703
	}
1704
1705
	/**
1706
	 * Determines reason for Jetpack development mode.
1707
	 */
1708
	public static function development_mode_trigger_text() {
1709
		if ( ! ( new Status() )->is_development_mode() ) {
1710
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1711
		}
1712
1713
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1714
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1715
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1716
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1717
		} else {
1718
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1719
		}
1720
1721
		return $notice;
1722
1723
	}
1724
	/**
1725
	 * Get Jetpack development mode notice text and notice class.
1726
	 *
1727
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1728
	 */
1729
	public static function show_development_mode_notice() {
1730 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1731
			$notice = sprintf(
1732
				/* translators: %s is a URL */
1733
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1734
				Redirect::get_url( 'jetpack-support-development-mode' )
1735
			);
1736
1737
			$notice .= ' ' . self::development_mode_trigger_text();
1738
1739
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1740
		}
1741
1742
		// Throw up a notice if using a development version and as for feedback.
1743
		if ( self::is_development_version() ) {
1744
			/* translators: %s is a URL */
1745
			$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' ) );
1746
1747
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1748
		}
1749
		// Throw up a notice if using staging mode
1750 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1751
			/* translators: %s is a URL */
1752
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1753
1754
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1755
		}
1756
	}
1757
1758
	/**
1759
	 * Whether Jetpack's version maps to a public release, or a development version.
1760
	 */
1761
	public static function is_development_version() {
1762
		/**
1763
		 * Allows filtering whether this is a development version of Jetpack.
1764
		 *
1765
		 * This filter is especially useful for tests.
1766
		 *
1767
		 * @since 4.3.0
1768
		 *
1769
		 * @param bool $development_version Is this a develoment version of Jetpack?
1770
		 */
1771
		return (bool) apply_filters(
1772
			'jetpack_development_version',
1773
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1774
		);
1775
	}
1776
1777
	/**
1778
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1779
	 */
1780
	public static function is_user_connected( $user_id = false ) {
1781
		return self::connection()->is_user_connected( $user_id );
1782
	}
1783
1784
	/**
1785
	 * Get the wpcom user data of the current|specified connected user.
1786
	 */
1787 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1788
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1789
		if ( ! $user_id ) {
1790
			$user_id = get_current_user_id();
1791
		}
1792
1793
		$transient_key = "jetpack_connected_user_data_$user_id";
1794
1795
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1796
			return $cached_user_data;
1797
		}
1798
1799
		$xml = new Jetpack_IXR_Client(
1800
			array(
1801
				'user_id' => $user_id,
1802
			)
1803
		);
1804
		$xml->query( 'wpcom.getUser' );
1805
		if ( ! $xml->isError() ) {
1806
			$user_data = $xml->getResponse();
1807
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1808
			return $user_data;
1809
		}
1810
1811
		return false;
1812
	}
1813
1814
	/**
1815
	 * Get the wpcom email of the current|specified connected user.
1816
	 */
1817
	public static function get_connected_user_email( $user_id = null ) {
1818
		if ( ! $user_id ) {
1819
			$user_id = get_current_user_id();
1820
		}
1821
1822
		$xml = new Jetpack_IXR_Client(
1823
			array(
1824
				'user_id' => $user_id,
1825
			)
1826
		);
1827
		$xml->query( 'wpcom.getUserEmail' );
1828
		if ( ! $xml->isError() ) {
1829
			return $xml->getResponse();
1830
		}
1831
		return false;
1832
	}
1833
1834
	/**
1835
	 * Get the wpcom email of the master user.
1836
	 */
1837
	public static function get_master_user_email() {
1838
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1839
		if ( $master_user_id ) {
1840
			return self::get_connected_user_email( $master_user_id );
1841
		}
1842
		return '';
1843
	}
1844
1845
	/**
1846
	 * Whether the current user is the connection owner.
1847
	 *
1848
	 * @deprecated since 7.7
1849
	 *
1850
	 * @return bool Whether the current user is the connection owner.
1851
	 */
1852
	public function current_user_is_connection_owner() {
1853
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1854
		return self::connection()->is_connection_owner();
1855
	}
1856
1857
	/**
1858
	 * Gets current user IP address.
1859
	 *
1860
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1861
	 *
1862
	 * @return string                  Current user IP address.
1863
	 */
1864
	public static function current_user_ip( $check_all_headers = false ) {
1865
		if ( $check_all_headers ) {
1866
			foreach ( array(
1867
				'HTTP_CF_CONNECTING_IP',
1868
				'HTTP_CLIENT_IP',
1869
				'HTTP_X_FORWARDED_FOR',
1870
				'HTTP_X_FORWARDED',
1871
				'HTTP_X_CLUSTER_CLIENT_IP',
1872
				'HTTP_FORWARDED_FOR',
1873
				'HTTP_FORWARDED',
1874
				'HTTP_VIA',
1875
			) as $key ) {
1876
				if ( ! empty( $_SERVER[ $key ] ) ) {
1877
					return $_SERVER[ $key ];
1878
				}
1879
			}
1880
		}
1881
1882
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1883
	}
1884
1885
	/**
1886
	 * Synchronize connected user role changes
1887
	 */
1888
	function user_role_change( $user_id ) {
1889
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1890
		Users::user_role_change( $user_id );
1891
	}
1892
1893
	/**
1894
	 * Loads the currently active modules.
1895
	 */
1896
	public static function load_modules() {
1897
		$is_development_mode = ( new Status() )->is_development_mode();
1898
		if (
1899
			! self::is_active()
1900
			&& ! $is_development_mode
1901
			&& ! self::is_onboarding()
1902
			&& (
1903
				! is_multisite()
1904
				|| ! get_site_option( 'jetpack_protect_active' )
1905
			)
1906
		) {
1907
			return;
1908
		}
1909
1910
		$version = Jetpack_Options::get_option( 'version' );
1911 View Code Duplication
		if ( ! $version ) {
1912
			$version = $old_version = JETPACK__VERSION . ':' . time();
1913
			/** This action is documented in class.jetpack.php */
1914
			do_action( 'updating_jetpack_version', $version, false );
1915
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1916
		}
1917
		list( $version ) = explode( ':', $version );
1918
1919
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1920
1921
		$modules_data = array();
1922
1923
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1924
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1925
			$updated_modules = array();
1926
			foreach ( $modules as $module ) {
1927
				$modules_data[ $module ] = self::get_module( $module );
1928
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1929
					continue;
1930
				}
1931
1932
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1933
					continue;
1934
				}
1935
1936
				$updated_modules[] = $module;
1937
			}
1938
1939
			$modules = array_diff( $modules, $updated_modules );
1940
		}
1941
1942
		foreach ( $modules as $index => $module ) {
1943
			// If we're in dev mode, disable modules requiring a connection
1944
			if ( $is_development_mode ) {
1945
				// Prime the pump if we need to
1946
				if ( empty( $modules_data[ $module ] ) ) {
1947
					$modules_data[ $module ] = self::get_module( $module );
1948
				}
1949
				// If the module requires a connection, but we're in local mode, don't include it.
1950
				if ( $modules_data[ $module ]['requires_connection'] ) {
1951
					continue;
1952
				}
1953
			}
1954
1955
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1956
				continue;
1957
			}
1958
1959
			if ( ! include_once self::get_module_path( $module ) ) {
1960
				unset( $modules[ $index ] );
1961
				self::update_active_modules( array_values( $modules ) );
1962
				continue;
1963
			}
1964
1965
			/**
1966
			 * Fires when a specific module is loaded.
1967
			 * The dynamic part of the hook, $module, is the module slug.
1968
			 *
1969
			 * @since 1.1.0
1970
			 */
1971
			do_action( 'jetpack_module_loaded_' . $module );
1972
		}
1973
1974
		/**
1975
		 * Fires when all the modules are loaded.
1976
		 *
1977
		 * @since 1.1.0
1978
		 */
1979
		do_action( 'jetpack_modules_loaded' );
1980
1981
		// 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.
1982
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1983
	}
1984
1985
	/**
1986
	 * Check if Jetpack's REST API compat file should be included
1987
	 *
1988
	 * @action plugins_loaded
1989
	 * @return null
1990
	 */
1991
	public function check_rest_api_compat() {
1992
		/**
1993
		 * Filters the list of REST API compat files to be included.
1994
		 *
1995
		 * @since 2.2.5
1996
		 *
1997
		 * @param array $args Array of REST API compat files to include.
1998
		 */
1999
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2000
2001
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2002
			require_once $_jetpack_rest_api_compat_include;
2003
		}
2004
	}
2005
2006
	/**
2007
	 * Gets all plugins currently active in values, regardless of whether they're
2008
	 * traditionally activated or network activated.
2009
	 *
2010
	 * @todo Store the result in core's object cache maybe?
2011
	 */
2012
	public static function get_active_plugins() {
2013
		$active_plugins = (array) get_option( 'active_plugins', array() );
2014
2015
		if ( is_multisite() ) {
2016
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2017
			// whereas active_plugins stores them in the values.
2018
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2019
			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...
2020
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2021
			}
2022
		}
2023
2024
		sort( $active_plugins );
2025
2026
		return array_unique( $active_plugins );
2027
	}
2028
2029
	/**
2030
	 * Gets and parses additional plugin data to send with the heartbeat data
2031
	 *
2032
	 * @since 3.8.1
2033
	 *
2034
	 * @return array Array of plugin data
2035
	 */
2036
	public static function get_parsed_plugin_data() {
2037
		if ( ! function_exists( 'get_plugins' ) ) {
2038
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2039
		}
2040
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2041
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2042
		$active_plugins = self::get_active_plugins();
2043
2044
		$plugins = array();
2045
		foreach ( $all_plugins as $path => $plugin_data ) {
2046
			$plugins[ $path ] = array(
2047
				'is_active' => in_array( $path, $active_plugins ),
2048
				'file'      => $path,
2049
				'name'      => $plugin_data['Name'],
2050
				'version'   => $plugin_data['Version'],
2051
				'author'    => $plugin_data['Author'],
2052
			);
2053
		}
2054
2055
		return $plugins;
2056
	}
2057
2058
	/**
2059
	 * Gets and parses theme data to send with the heartbeat data
2060
	 *
2061
	 * @since 3.8.1
2062
	 *
2063
	 * @return array Array of theme data
2064
	 */
2065
	public static function get_parsed_theme_data() {
2066
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2067
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2068
2069
		$themes = array();
2070
		foreach ( $all_themes as $slug => $theme_data ) {
2071
			$theme_headers = array();
2072
			foreach ( $header_keys as $header_key ) {
2073
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2074
			}
2075
2076
			$themes[ $slug ] = array(
2077
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2078
				'slug'            => $slug,
2079
				'theme_root'      => $theme_data->get_theme_root_uri(),
2080
				'parent'          => $theme_data->parent(),
2081
				'headers'         => $theme_headers,
2082
			);
2083
		}
2084
2085
		return $themes;
2086
	}
2087
2088
	/**
2089
	 * Checks whether a specific plugin is active.
2090
	 *
2091
	 * We don't want to store these in a static variable, in case
2092
	 * there are switch_to_blog() calls involved.
2093
	 */
2094
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2095
		return in_array( $plugin, self::get_active_plugins() );
2096
	}
2097
2098
	/**
2099
	 * Check if Jetpack's Open Graph tags should be used.
2100
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2101
	 *
2102
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2103
	 * @action plugins_loaded
2104
	 * @return null
2105
	 */
2106
	public function check_open_graph() {
2107
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2108
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2109
		}
2110
2111
		$active_plugins = self::get_active_plugins();
2112
2113
		if ( ! empty( $active_plugins ) ) {
2114
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2115
				if ( in_array( $plugin, $active_plugins ) ) {
2116
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2117
					break;
2118
				}
2119
			}
2120
		}
2121
2122
		/**
2123
		 * Allow the addition of Open Graph Meta Tags to all pages.
2124
		 *
2125
		 * @since 2.0.3
2126
		 *
2127
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2128
		 */
2129
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2130
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2131
		}
2132
	}
2133
2134
	/**
2135
	 * Check if Jetpack's Twitter tags should be used.
2136
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2137
	 *
2138
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2139
	 * @action plugins_loaded
2140
	 * @return null
2141
	 */
2142
	public function check_twitter_tags() {
2143
2144
		$active_plugins = self::get_active_plugins();
2145
2146
		if ( ! empty( $active_plugins ) ) {
2147
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2148
				if ( in_array( $plugin, $active_plugins ) ) {
2149
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2150
					break;
2151
				}
2152
			}
2153
		}
2154
2155
		/**
2156
		 * Allow Twitter Card Meta tags to be disabled.
2157
		 *
2158
		 * @since 2.6.0
2159
		 *
2160
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2161
		 */
2162
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2163
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2164
		}
2165
	}
2166
2167
	/**
2168
	 * Allows plugins to submit security reports.
2169
	 *
2170
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2171
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2172
	 * @param array  $args         See definitions above
2173
	 */
2174
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2175
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2176
	}
2177
2178
	/* Jetpack Options API */
2179
2180
	public static function get_option_names( $type = 'compact' ) {
2181
		return Jetpack_Options::get_option_names( $type );
2182
	}
2183
2184
	/**
2185
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2186
	 *
2187
	 * @param string $name    Option name
2188
	 * @param mixed  $default (optional)
2189
	 */
2190
	public static function get_option( $name, $default = false ) {
2191
		return Jetpack_Options::get_option( $name, $default );
2192
	}
2193
2194
	/**
2195
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2196
	 *
2197
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2198
	 * @param string $name  Option name
2199
	 * @param mixed  $value Option value
2200
	 */
2201
	public static function update_option( $name, $value ) {
2202
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2203
		return Jetpack_Options::update_option( $name, $value );
2204
	}
2205
2206
	/**
2207
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2208
	 *
2209
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2210
	 * @param array $array array( option name => option value, ... )
2211
	 */
2212
	public static function update_options( $array ) {
2213
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2214
		return Jetpack_Options::update_options( $array );
2215
	}
2216
2217
	/**
2218
	 * Deletes the given option.  May be passed multiple option names as an array.
2219
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2220
	 *
2221
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2222
	 * @param string|array $names
2223
	 */
2224
	public static function delete_option( $names ) {
2225
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2226
		return Jetpack_Options::delete_option( $names );
2227
	}
2228
2229
	/**
2230
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2231
	 *
2232
	 * Enters a user token into the user_tokens option
2233
	 *
2234
	 * @param int    $user_id The user id.
2235
	 * @param string $token The user token.
2236
	 * @param bool   $is_master_user Whether the user is the master user.
2237
	 * @return bool
2238
	 */
2239
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2240
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2241
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2242
	}
2243
2244
	/**
2245
	 * Returns an array of all PHP files in the specified absolute path.
2246
	 * Equivalent to glob( "$absolute_path/*.php" ).
2247
	 *
2248
	 * @param string $absolute_path The absolute path of the directory to search.
2249
	 * @return array Array of absolute paths to the PHP files.
2250
	 */
2251
	public static function glob_php( $absolute_path ) {
2252
		if ( function_exists( 'glob' ) ) {
2253
			return glob( "$absolute_path/*.php" );
2254
		}
2255
2256
		$absolute_path = untrailingslashit( $absolute_path );
2257
		$files         = array();
2258
		if ( ! $dir = @opendir( $absolute_path ) ) {
2259
			return $files;
2260
		}
2261
2262
		while ( false !== $file = readdir( $dir ) ) {
2263
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2264
				continue;
2265
			}
2266
2267
			$file = "$absolute_path/$file";
2268
2269
			if ( ! is_file( $file ) ) {
2270
				continue;
2271
			}
2272
2273
			$files[] = $file;
2274
		}
2275
2276
		closedir( $dir );
2277
2278
		return $files;
2279
	}
2280
2281
	public static function activate_new_modules( $redirect = false ) {
2282
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2283
			return;
2284
		}
2285
2286
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2287 View Code Duplication
		if ( ! $jetpack_old_version ) {
2288
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2289
			/** This action is documented in class.jetpack.php */
2290
			do_action( 'updating_jetpack_version', $version, false );
2291
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2292
		}
2293
2294
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2295
2296
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2297
			return;
2298
		}
2299
2300
		$active_modules     = self::get_active_modules();
2301
		$reactivate_modules = array();
2302
		foreach ( $active_modules as $active_module ) {
2303
			$module = self::get_module( $active_module );
2304
			if ( ! isset( $module['changed'] ) ) {
2305
				continue;
2306
			}
2307
2308
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2309
				continue;
2310
			}
2311
2312
			$reactivate_modules[] = $active_module;
2313
			self::deactivate_module( $active_module );
2314
		}
2315
2316
		$new_version = JETPACK__VERSION . ':' . time();
2317
		/** This action is documented in class.jetpack.php */
2318
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2319
		Jetpack_Options::update_options(
2320
			array(
2321
				'version'     => $new_version,
2322
				'old_version' => $jetpack_old_version,
2323
			)
2324
		);
2325
2326
		self::state( 'message', 'modules_activated' );
2327
2328
		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...
2329
2330
		if ( $redirect ) {
2331
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2332
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2333
				$page = $_GET['page'];
2334
			}
2335
2336
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2337
			exit;
2338
		}
2339
	}
2340
2341
	/**
2342
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2343
	 * Make sure to tuck away module "library" files in a sub-directory.
2344
	 */
2345
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2346
		static $modules = null;
2347
2348
		if ( ! isset( $modules ) ) {
2349
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2350
			// Use the cache if we're on the front-end and it's available...
2351
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2352
				$modules = $available_modules_option[ JETPACK__VERSION ];
2353
			} else {
2354
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2355
2356
				$modules = array();
2357
2358
				foreach ( $files as $file ) {
2359
					if ( ! $headers = self::get_module( $file ) ) {
2360
						continue;
2361
					}
2362
2363
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2364
				}
2365
2366
				Jetpack_Options::update_option(
2367
					'available_modules',
2368
					array(
2369
						JETPACK__VERSION => $modules,
2370
					)
2371
				);
2372
			}
2373
		}
2374
2375
		/**
2376
		 * Filters the array of modules available to be activated.
2377
		 *
2378
		 * @since 2.4.0
2379
		 *
2380
		 * @param array $modules Array of available modules.
2381
		 * @param string $min_version Minimum version number required to use modules.
2382
		 * @param string $max_version Maximum version number required to use modules.
2383
		 */
2384
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
2385
2386
		if ( ! $min_version && ! $max_version ) {
2387
			return array_keys( $mods );
2388
		}
2389
2390
		$r = array();
2391
		foreach ( $mods as $slug => $introduced ) {
2392
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2393
				continue;
2394
			}
2395
2396
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2397
				continue;
2398
			}
2399
2400
			$r[] = $slug;
2401
		}
2402
2403
		return $r;
2404
	}
2405
2406
	/**
2407
	 * Default modules loaded on activation.
2408
	 */
2409
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2410
		$return = array();
2411
2412
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2413
			$module_data = self::get_module( $module );
2414
2415
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2416
				case 'yes':
2417
					$return[] = $module;
2418
					break;
2419
				case 'public':
2420
					if ( Jetpack_Options::get_option( 'public' ) ) {
2421
						$return[] = $module;
2422
					}
2423
					break;
2424
				case 'no':
2425
				default:
2426
					break;
2427
			}
2428
		}
2429
		/**
2430
		 * Filters the array of default modules.
2431
		 *
2432
		 * @since 2.5.0
2433
		 *
2434
		 * @param array $return Array of default modules.
2435
		 * @param string $min_version Minimum version number required to use modules.
2436
		 * @param string $max_version Maximum version number required to use modules.
2437
		 */
2438
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
2439
	}
2440
2441
	/**
2442
	 * Checks activated modules during auto-activation to determine
2443
	 * if any of those modules are being deprecated.  If so, close
2444
	 * them out, and add any replacement modules.
2445
	 *
2446
	 * Runs at priority 99 by default.
2447
	 *
2448
	 * This is run late, so that it can still activate a module if
2449
	 * the new module is a replacement for another that the user
2450
	 * currently has active, even if something at the normal priority
2451
	 * would kibosh everything.
2452
	 *
2453
	 * @since 2.6
2454
	 * @uses jetpack_get_default_modules filter
2455
	 * @param array $modules
2456
	 * @return array
2457
	 */
2458
	function handle_deprecated_modules( $modules ) {
2459
		$deprecated_modules = array(
2460
			'debug'            => null,  // Closed out and moved to the debugger library.
2461
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2462
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2463
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2464
		);
2465
2466
		// Don't activate SSO if they never completed activating WPCC.
2467
		if ( self::is_module_active( 'wpcc' ) ) {
2468
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2469
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2470
				$deprecated_modules['wpcc'] = null;
2471
			}
2472
		}
2473
2474
		foreach ( $deprecated_modules as $module => $replacement ) {
2475
			if ( self::is_module_active( $module ) ) {
2476
				self::deactivate_module( $module );
2477
				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...
2478
					$modules[] = $replacement;
2479
				}
2480
			}
2481
		}
2482
2483
		return array_unique( $modules );
2484
	}
2485
2486
	/**
2487
	 * Checks activated plugins during auto-activation to determine
2488
	 * if any of those plugins are in the list with a corresponding module
2489
	 * that is not compatible with the plugin. The module will not be allowed
2490
	 * to auto-activate.
2491
	 *
2492
	 * @since 2.6
2493
	 * @uses jetpack_get_default_modules filter
2494
	 * @param array $modules
2495
	 * @return array
2496
	 */
2497
	function filter_default_modules( $modules ) {
2498
2499
		$active_plugins = self::get_active_plugins();
2500
2501
		if ( ! empty( $active_plugins ) ) {
2502
2503
			// For each module we'd like to auto-activate...
2504
			foreach ( $modules as $key => $module ) {
2505
				// If there are potential conflicts for it...
2506
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2507
					// For each potential conflict...
2508
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2509
						// If that conflicting plugin is active...
2510
						if ( in_array( $plugin, $active_plugins ) ) {
2511
							// Remove that item from being auto-activated.
2512
							unset( $modules[ $key ] );
2513
						}
2514
					}
2515
				}
2516
			}
2517
		}
2518
2519
		return $modules;
2520
	}
2521
2522
	/**
2523
	 * Extract a module's slug from its full path.
2524
	 */
2525
	public static function get_module_slug( $file ) {
2526
		return str_replace( '.php', '', basename( $file ) );
2527
	}
2528
2529
	/**
2530
	 * Generate a module's path from its slug.
2531
	 */
2532
	public static function get_module_path( $slug ) {
2533
		/**
2534
		 * Filters the path of a modules.
2535
		 *
2536
		 * @since 7.4.0
2537
		 *
2538
		 * @param array $return The absolute path to a module's root php file
2539
		 * @param string $slug The module slug
2540
		 */
2541
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
2542
	}
2543
2544
	/**
2545
	 * Load module data from module file. Headers differ from WordPress
2546
	 * plugin headers to avoid them being identified as standalone
2547
	 * plugins on the WordPress plugins page.
2548
	 */
2549
	public static function get_module( $module ) {
2550
		$headers = array(
2551
			'name'                      => 'Module Name',
2552
			'description'               => 'Module Description',
2553
			'sort'                      => 'Sort Order',
2554
			'recommendation_order'      => 'Recommendation Order',
2555
			'introduced'                => 'First Introduced',
2556
			'changed'                   => 'Major Changes In',
2557
			'deactivate'                => 'Deactivate',
2558
			'free'                      => 'Free',
2559
			'requires_connection'       => 'Requires Connection',
2560
			'auto_activate'             => 'Auto Activate',
2561
			'module_tags'               => 'Module Tags',
2562
			'feature'                   => 'Feature',
2563
			'additional_search_queries' => 'Additional Search Queries',
2564
			'plan_classes'              => 'Plans',
2565
		);
2566
2567
		$file = self::get_module_path( self::get_module_slug( $module ) );
2568
2569
		$mod = self::get_file_data( $file, $headers );
2570
		if ( empty( $mod['name'] ) ) {
2571
			return false;
2572
		}
2573
2574
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2575
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2576
		$mod['deactivate']           = empty( $mod['deactivate'] );
2577
		$mod['free']                 = empty( $mod['free'] );
2578
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2579
2580
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2581
			$mod['auto_activate'] = 'No';
2582
		} else {
2583
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2584
		}
2585
2586
		if ( $mod['module_tags'] ) {
2587
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2588
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2589
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2590
		} else {
2591
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2592
		}
2593
2594 View Code Duplication
		if ( $mod['plan_classes'] ) {
2595
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2596
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2597
		} else {
2598
			$mod['plan_classes'] = array( 'free' );
2599
		}
2600
2601 View Code Duplication
		if ( $mod['feature'] ) {
2602
			$mod['feature'] = explode( ',', $mod['feature'] );
2603
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2604
		} else {
2605
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2606
		}
2607
2608
		/**
2609
		 * Filters the feature array on a module.
2610
		 *
2611
		 * This filter allows you to control where each module is filtered: Recommended,
2612
		 * and the default "Other" listing.
2613
		 *
2614
		 * @since 3.5.0
2615
		 *
2616
		 * @param array   $mod['feature'] The areas to feature this module:
2617
		 *     'Recommended' shows on the main Jetpack admin screen.
2618
		 *     'Other' should be the default if no other value is in the array.
2619
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2620
		 * @param array   $mod All the currently assembled module data.
2621
		 */
2622
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
2623
2624
		/**
2625
		 * Filter the returned data about a module.
2626
		 *
2627
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2628
		 * so please be careful.
2629
		 *
2630
		 * @since 3.6.0
2631
		 *
2632
		 * @param array   $mod    The details of the requested module.
2633
		 * @param string  $module The slug of the module, e.g. sharedaddy
2634
		 * @param string  $file   The path to the module source file.
2635
		 */
2636
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
2637
	}
2638
2639
	/**
2640
	 * Like core's get_file_data implementation, but caches the result.
2641
	 */
2642
	public static function get_file_data( $file, $headers ) {
2643
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2644
		$file_name = basename( $file );
2645
2646
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2647
2648
		$file_data_option = get_transient( $cache_key );
2649
2650
		if ( ! is_array( $file_data_option ) ) {
2651
			delete_transient( $cache_key );
2652
			$file_data_option = false;
2653
		}
2654
2655
		if ( false === $file_data_option ) {
2656
			$file_data_option = array();
2657
		}
2658
2659
		$key           = md5( $file_name . serialize( $headers ) );
2660
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2661
2662
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2663
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2664
			return $file_data_option[ $key ];
2665
		}
2666
2667
		$data = get_file_data( $file, $headers );
2668
2669
		$file_data_option[ $key ] = $data;
2670
2671
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2672
2673
		return $data;
2674
	}
2675
2676
2677
	/**
2678
	 * Return translated module tag.
2679
	 *
2680
	 * @param string $tag Tag as it appears in each module heading.
2681
	 *
2682
	 * @return mixed
2683
	 */
2684
	public static function translate_module_tag( $tag ) {
2685
		return jetpack_get_module_i18n_tag( $tag );
2686
	}
2687
2688
	/**
2689
	 * Get i18n strings as a JSON-encoded string
2690
	 *
2691
	 * @return string The locale as JSON
2692
	 */
2693
	public static function get_i18n_data_json() {
2694
2695
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2696
		// JSON files with the file they should be included for. This is an md5
2697
		// of '_inc/build/admin.js'.
2698
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2699
2700
		$i18n_json =
2701
				   JETPACK__PLUGIN_DIR
2702
				   . 'languages/json/jetpack-'
2703
				   . get_user_locale()
2704
				   . '-'
2705
				   . $path_md5
2706
				   . '.json';
2707
2708
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2709
			$locale_data = @file_get_contents( $i18n_json );
2710
			if ( $locale_data ) {
2711
				return $locale_data;
2712
			}
2713
		}
2714
2715
		// Return valid empty Jed locale
2716
		return '{ "locale_data": { "messages": { "": {} } } }';
2717
	}
2718
2719
	/**
2720
	 * Add locale data setup to wp-i18n
2721
	 *
2722
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2723
	 *
2724
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2725
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2726
	 *
2727
	 * This method provides a safe way to request the setup multiple times but add the script at
2728
	 * most once.
2729
	 *
2730
	 * @since 6.7.0
2731
	 *
2732
	 * @return void
2733
	 */
2734
	public static function setup_wp_i18n_locale_data() {
2735
		static $script_added = false;
2736
		if ( ! $script_added ) {
2737
			$script_added = true;
2738
			wp_add_inline_script(
2739
				'wp-i18n',
2740
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2741
			);
2742
		}
2743
	}
2744
2745
	/**
2746
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2747
	 *
2748
	 * @since 3.9.2
2749
	 *
2750
	 * @param array $modules
2751
	 *
2752
	 * @return string|void
2753
	 */
2754
	public static function get_translated_modules( $modules ) {
2755
		foreach ( $modules as $index => $module ) {
2756
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2757
			if ( isset( $module['name'] ) ) {
2758
				$modules[ $index ]['name'] = $i18n_module['name'];
2759
			}
2760
			if ( isset( $module['description'] ) ) {
2761
				$modules[ $index ]['description']       = $i18n_module['description'];
2762
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2763
			}
2764
		}
2765
		return $modules;
2766
	}
2767
2768
	/**
2769
	 * Get a list of activated modules as an array of module slugs.
2770
	 */
2771
	public static function get_active_modules() {
2772
		$active = Jetpack_Options::get_option( 'active_modules' );
2773
2774
		if ( ! is_array( $active ) ) {
2775
			$active = array();
2776
		}
2777
2778
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2779
			$active[] = 'vaultpress';
2780
		} else {
2781
			$active = array_diff( $active, array( 'vaultpress' ) );
2782
		}
2783
2784
		// If protect is active on the main site of a multisite, it should be active on all sites.
2785
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2786
			$active[] = 'protect';
2787
		}
2788
2789
		/**
2790
		 * Allow filtering of the active modules.
2791
		 *
2792
		 * Gives theme and plugin developers the power to alter the modules that
2793
		 * are activated on the fly.
2794
		 *
2795
		 * @since 5.8.0
2796
		 *
2797
		 * @param array $active Array of active module slugs.
2798
		 */
2799
		$active = apply_filters( 'jetpack_active_modules', $active );
2800
2801
		return array_unique( $active );
2802
	}
2803
2804
	/**
2805
	 * Check whether or not a Jetpack module is active.
2806
	 *
2807
	 * @param string $module The slug of a Jetpack module.
2808
	 * @return bool
2809
	 *
2810
	 * @static
2811
	 */
2812
	public static function is_module_active( $module ) {
2813
		return in_array( $module, self::get_active_modules() );
2814
	}
2815
2816
	public static function is_module( $module ) {
2817
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2818
	}
2819
2820
	/**
2821
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2822
	 *
2823
	 * @param bool $catch True to start catching, False to stop.
2824
	 *
2825
	 * @static
2826
	 */
2827
	public static function catch_errors( $catch ) {
2828
		static $display_errors, $error_reporting;
2829
2830
		if ( $catch ) {
2831
			$display_errors  = @ini_set( 'display_errors', 1 );
2832
			$error_reporting = @error_reporting( E_ALL );
2833
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2834
		} else {
2835
			@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...
2836
			@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...
2837
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2838
		}
2839
	}
2840
2841
	/**
2842
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2843
	 */
2844
	public static function catch_errors_on_shutdown() {
2845
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2846
	}
2847
2848
	/**
2849
	 * Rewrite any string to make paths easier to read.
2850
	 *
2851
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2852
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2853
	 *
2854
	 * @param $string
2855
	 * @return mixed
2856
	 */
2857
	public static function alias_directories( $string ) {
2858
		// ABSPATH has a trailing slash.
2859
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2860
		// WP_CONTENT_DIR does not have a trailing slash.
2861
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2862
2863
		return $string;
2864
	}
2865
2866
	public static function activate_default_modules(
2867
		$min_version = false,
2868
		$max_version = false,
2869
		$other_modules = array(),
2870
		$redirect = null,
2871
		$send_state_messages = null
2872
	) {
2873
		$jetpack = self::init();
2874
2875
		if ( is_null( $redirect ) ) {
2876
			if (
2877
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2878
			||
2879
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2880
			||
2881
				( defined( 'WP_CLI' ) && WP_CLI )
2882
			||
2883
				( defined( 'DOING_CRON' ) && DOING_CRON )
2884
			||
2885
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2886
			) {
2887
				$redirect = false;
2888
			} elseif ( is_admin() ) {
2889
				$redirect = true;
2890
			} else {
2891
				$redirect = false;
2892
			}
2893
		}
2894
2895
		if ( is_null( $send_state_messages ) ) {
2896
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2897
		}
2898
2899
		$modules = self::get_default_modules( $min_version, $max_version );
2900
		$modules = array_merge( $other_modules, $modules );
2901
2902
		// Look for standalone plugins and disable if active.
2903
2904
		$to_deactivate = array();
2905
		foreach ( $modules as $module ) {
2906
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2907
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2908
			}
2909
		}
2910
2911
		$deactivated = array();
2912
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2913
			list( $probable_file, $probable_title ) = $deactivate_me;
2914
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2915
				$deactivated[] = $module;
2916
			}
2917
		}
2918
2919
		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...
2920
			if ( $send_state_messages ) {
2921
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2922
			}
2923
2924
			if ( $redirect ) {
2925
				$url = add_query_arg(
2926
					array(
2927
						'action'   => 'activate_default_modules',
2928
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2929
					),
2930
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2931
				);
2932
				wp_safe_redirect( $url );
2933
				exit;
2934
			}
2935
		}
2936
2937
		/**
2938
		 * Fires before default modules are activated.
2939
		 *
2940
		 * @since 1.9.0
2941
		 *
2942
		 * @param string $min_version Minimum version number required to use modules.
2943
		 * @param string $max_version Maximum version number required to use modules.
2944
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2945
		 */
2946
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2947
2948
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2949
		if ( $send_state_messages ) {
2950
			self::restate();
2951
			self::catch_errors( true );
2952
		}
2953
2954
		$active = self::get_active_modules();
2955
2956
		foreach ( $modules as $module ) {
2957
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2958
				$active[] = $module;
2959
				self::update_active_modules( $active );
2960
				continue;
2961
			}
2962
2963
			if ( $send_state_messages && in_array( $module, $active ) ) {
2964
				$module_info = self::get_module( $module );
2965 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2966
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2967
					if ( $active_state = self::state( $state ) ) {
2968
						$active_state = explode( ',', $active_state );
2969
					} else {
2970
						$active_state = array();
2971
					}
2972
					$active_state[] = $module;
2973
					self::state( $state, implode( ',', $active_state ) );
2974
				}
2975
				continue;
2976
			}
2977
2978
			$file = self::get_module_path( $module );
2979
			if ( ! file_exists( $file ) ) {
2980
				continue;
2981
			}
2982
2983
			// we'll override this later if the plugin can be included without fatal error
2984
			if ( $redirect ) {
2985
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2986
			}
2987
2988
			if ( $send_state_messages ) {
2989
				self::state( 'error', 'module_activation_failed' );
2990
				self::state( 'module', $module );
2991
			}
2992
2993
			ob_start();
2994
			require_once $file;
2995
2996
			$active[] = $module;
2997
2998 View Code Duplication
			if ( $send_state_messages ) {
2999
3000
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3001
				if ( $active_state = self::state( $state ) ) {
3002
					$active_state = explode( ',', $active_state );
3003
				} else {
3004
					$active_state = array();
3005
				}
3006
				$active_state[] = $module;
3007
				self::state( $state, implode( ',', $active_state ) );
3008
			}
3009
3010
			self::update_active_modules( $active );
3011
3012
			ob_end_clean();
3013
		}
3014
3015
		if ( $send_state_messages ) {
3016
			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...
3017
			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...
3018
		}
3019
3020
		self::catch_errors( false );
3021
		/**
3022
		 * Fires when default modules are activated.
3023
		 *
3024
		 * @since 1.9.0
3025
		 *
3026
		 * @param string $min_version Minimum version number required to use modules.
3027
		 * @param string $max_version Maximum version number required to use modules.
3028
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3029
		 */
3030
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3031
	}
3032
3033
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3034
		/**
3035
		 * Fires before a module is activated.
3036
		 *
3037
		 * @since 2.6.0
3038
		 *
3039
		 * @param string $module Module slug.
3040
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3041
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3042
		 */
3043
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3044
3045
		$jetpack = self::init();
3046
3047
		if ( ! strlen( $module ) ) {
3048
			return false;
3049
		}
3050
3051
		if ( ! self::is_module( $module ) ) {
3052
			return false;
3053
		}
3054
3055
		// If it's already active, then don't do it again
3056
		$active = self::get_active_modules();
3057
		foreach ( $active as $act ) {
3058
			if ( $act == $module ) {
3059
				return true;
3060
			}
3061
		}
3062
3063
		$module_data = self::get_module( $module );
3064
3065
		$is_development_mode = ( new Status() )->is_development_mode();
3066
		if ( ! self::is_active() ) {
3067
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3068
				return false;
3069
			}
3070
3071
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3072
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3073
				return false;
3074
			}
3075
		}
3076
3077
		// Check and see if the old plugin is active
3078
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3079
			// Deactivate the old plugin
3080
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3081
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3082
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3083
				self::state( 'deactivated_plugins', $module );
3084
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3085
				exit;
3086
			}
3087
		}
3088
3089
		// Protect won't work with mis-configured IPs
3090
		if ( 'protect' === $module ) {
3091
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3092
			if ( ! jetpack_protect_get_ip() ) {
3093
				self::state( 'message', 'protect_misconfigured_ip' );
3094
				return false;
3095
			}
3096
		}
3097
3098
		if ( ! Jetpack_Plan::supports( $module ) ) {
3099
			return false;
3100
		}
3101
3102
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3103
		self::state( 'module', $module );
3104
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3105
3106
		self::catch_errors( true );
3107
		ob_start();
3108
		require self::get_module_path( $module );
3109
		/** This action is documented in class.jetpack.php */
3110
		do_action( 'jetpack_activate_module', $module );
3111
		$active[] = $module;
3112
		self::update_active_modules( $active );
3113
3114
		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...
3115
		ob_end_clean();
3116
		self::catch_errors( false );
3117
3118
		if ( $redirect ) {
3119
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3120
		}
3121
		if ( $exit ) {
3122
			exit;
3123
		}
3124
		return true;
3125
	}
3126
3127
	function activate_module_actions( $module ) {
3128
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3129
	}
3130
3131
	public static function deactivate_module( $module ) {
3132
		/**
3133
		 * Fires when a module is deactivated.
3134
		 *
3135
		 * @since 1.9.0
3136
		 *
3137
		 * @param string $module Module slug.
3138
		 */
3139
		do_action( 'jetpack_pre_deactivate_module', $module );
3140
3141
		$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...
3142
3143
		$active = self::get_active_modules();
3144
		$new    = array_filter( array_diff( $active, (array) $module ) );
3145
3146
		return self::update_active_modules( $new );
3147
	}
3148
3149
	public static function enable_module_configurable( $module ) {
3150
		$module = self::get_module_slug( $module );
3151
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3152
	}
3153
3154
	/**
3155
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3156
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3157
	 *
3158
	 * @param string $module Module slug
3159
	 * @return string $url module configuration URL
3160
	 */
3161
	public static function module_configuration_url( $module ) {
3162
		$module      = self::get_module_slug( $module );
3163
		$default_url = self::admin_url() . "#/settings?term=$module";
3164
		/**
3165
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3166
		 *
3167
		 * @since 6.9.0
3168
		 *
3169
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3170
		 */
3171
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3172
3173
		return $url;
3174
	}
3175
3176
	/* Installation */
3177
	public static function bail_on_activation( $message, $deactivate = true ) {
3178
		?>
3179
<!doctype html>
3180
<html>
3181
<head>
3182
<meta charset="<?php bloginfo( 'charset' ); ?>">
3183
<style>
3184
* {
3185
	text-align: center;
3186
	margin: 0;
3187
	padding: 0;
3188
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3189
}
3190
p {
3191
	margin-top: 1em;
3192
	font-size: 18px;
3193
}
3194
</style>
3195
<body>
3196
<p><?php echo esc_html( $message ); ?></p>
3197
</body>
3198
</html>
3199
		<?php
3200
		if ( $deactivate ) {
3201
			$plugins = get_option( 'active_plugins' );
3202
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3203
			$update  = false;
3204
			foreach ( $plugins as $i => $plugin ) {
3205
				if ( $plugin === $jetpack ) {
3206
					$plugins[ $i ] = false;
3207
					$update        = true;
3208
				}
3209
			}
3210
3211
			if ( $update ) {
3212
				update_option( 'active_plugins', array_filter( $plugins ) );
3213
			}
3214
		}
3215
		exit;
3216
	}
3217
3218
	/**
3219
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3220
	 *
3221
	 * @static
3222
	 */
3223
	public static function plugin_activation( $network_wide ) {
3224
		Jetpack_Options::update_option( 'activated', 1 );
3225
3226
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3227
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3228
		}
3229
3230
		if ( $network_wide ) {
3231
			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...
3232
		}
3233
3234
		// For firing one-off events (notices) immediately after activation
3235
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3236
3237
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3238
3239
		Health::on_jetpack_activated();
3240
3241
		self::plugin_initialize();
3242
	}
3243
3244
	public static function get_activation_source( $referer_url ) {
3245
3246
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3247
			return array( 'wp-cli', null );
3248
		}
3249
3250
		$referer = wp_parse_url( $referer_url );
3251
3252
		$source_type  = 'unknown';
3253
		$source_query = null;
3254
3255
		if ( ! is_array( $referer ) ) {
3256
			return array( $source_type, $source_query );
3257
		}
3258
3259
		$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...
3260
		$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...
3261
3262
		if ( isset( $referer['query'] ) ) {
3263
			parse_str( $referer['query'], $query_parts );
3264
		} else {
3265
			$query_parts = array();
3266
		}
3267
3268
		if ( $plugins_path === $referer['path'] ) {
3269
			$source_type = 'list';
3270
		} elseif ( $plugins_install_path === $referer['path'] ) {
3271
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3272
			switch ( $tab ) {
3273
				case 'popular':
3274
					$source_type = 'popular';
3275
					break;
3276
				case 'recommended':
3277
					$source_type = 'recommended';
3278
					break;
3279
				case 'favorites':
3280
					$source_type = 'favorites';
3281
					break;
3282
				case 'search':
3283
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3284
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3285
					break;
3286
				default:
3287
					$source_type = 'featured';
3288
			}
3289
		}
3290
3291
		return array( $source_type, $source_query );
3292
	}
3293
3294
	/**
3295
	 * Runs before bumping version numbers up to a new version
3296
	 *
3297
	 * @param string $version    Version:timestamp.
3298
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3299
	 */
3300
	public static function do_version_bump( $version, $old_version ) {
3301
		if ( $old_version ) { // For existing Jetpack installations.
3302
			self::send_update_modal_data();
3303
		}
3304
	}
3305
3306
	/**
3307
	 * Prepares the release post content and image data and saves it in the
3308
	 * state array. This data is used to create the update modal.
3309
	 */
3310
	public static function send_update_modal_data() {
3311
		$post_data = self::get_release_post_data();
3312
3313
		if ( ! isset( $post_data['posts'][0] ) ) {
3314
			return;
3315
		}
3316
3317
		$post = $post_data['posts'][0];
3318
3319
		$post_content = isset( $post['content'] ) ? $post['content'] : null;
3320
		if ( empty( $post_content ) ) {
3321
			return;
3322
		}
3323
3324
		// This allows us to embed videopress videos into the release post.
3325
		add_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3326
		$content = wp_kses_post( $post_content );
3327
		remove_filter( 'wp_kses_allowed_html', array( __CLASS__, 'allow_post_embed_iframe' ), 10, 2 );
3328
3329
		$post_title = isset( $post['title'] ) ? $post['title'] : null;
3330
		$title      = wp_kses( $post_title, array() );
3331
3332
		$post_thumbnail = isset( $post['post_thumbnail'] ) ? $post['post_thumbnail'] : null;
3333
		if ( ! empty( $post_thumbnail ) ) {
3334
			jetpack_require_lib( 'class.jetpack-photon-image' );
3335
			$photon_image = new Jetpack_Photon_Image(
3336
				array(
3337
					'file'   => jetpack_photon_url( $post_thumbnail['URL'] ),
3338
					'width'  => $post_thumbnail['width'],
3339
					'height' => $post_thumbnail['height'],
3340
				),
3341
				$post_thumbnail['mime_type']
3342
			);
3343
			$photon_image->resize(
3344
				array(
3345
					'width'  => 600,
3346
					'height' => null,
3347
					'crop'   => false,
3348
				)
3349
			);
3350
			$post_thumbnail_url = $photon_image->get_raw_filename();
3351
		} else {
3352
			$post_thumbnail_url = null;
3353
		}
3354
3355
		$post_array = array(
3356
			'release_post_content'        => $content,
3357
			'release_post_featured_image' => $post_thumbnail_url,
3358
			'release_post_title'          => $title,
3359
		);
3360
3361
		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...
3362
	}
3363
3364
	/**
3365
	 * Temporarily allow post content to contain iframes, e.g. for videopress.
3366
	 *
3367
	 * @param string $tags    The tags.
3368
	 * @param string $context The context.
3369
	 */
3370
	public static function allow_post_embed_iframe( $tags, $context ) {
3371
		if ( 'post' === $context ) {
3372
			$tags['iframe'] = array(
3373
				'src'             => true,
3374
				'height'          => true,
3375
				'width'           => true,
3376
				'frameborder'     => true,
3377
				'allowfullscreen' => true,
3378
			);
3379
		}
3380
3381
		return $tags;
3382
	}
3383
3384
	/**
3385
	 * Obtains the release post from the Jetpack release post blog. A release post will be displayed in the
3386
	 * update modal when a post has a tag equal to the Jetpack version number.
3387
	 *
3388
	 * The response parameters for the post array can be found here:
3389
	 * https://developer.wordpress.com/docs/api/1.1/get/sites/%24site/posts/%24post_ID/#apidoc-response
3390
	 *
3391
	 * @return array|null Returns an associative array containing the release post data at index ['posts'][0].
3392
	 *                    Returns null if the release post data is not available.
3393
	 */
3394
	private static function get_release_post_data() {
3395
		if ( Constants::is_defined( 'TESTING_IN_JETPACK' ) && Constants::get_constant( 'TESTING_IN_JETPACK' ) ) {
3396
			return null;
3397
		}
3398
3399
		$release_post_src = add_query_arg(
3400
			array(
3401
				'order_by' => 'date',
3402
				'tag'      => JETPACK__VERSION,
3403
				'number'   => '1',
3404
			),
3405
			'https://public-api.wordpress.com/rest/v1/sites/' . JETPACK__RELEASE_POST_BLOG_SLUG . '/posts'
3406
		);
3407
3408
		$response = wp_remote_get( $release_post_src );
3409
3410
		if ( ! is_array( $response ) ) {
3411
			return null;
3412
		}
3413
3414
		return json_decode( wp_remote_retrieve_body( $response ), true );
3415
	}
3416
3417
	/**
3418
	 * Sets the internal version number and activation state.
3419
	 *
3420
	 * @static
3421
	 */
3422
	public static function plugin_initialize() {
3423
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3424
			Jetpack_Options::update_option( 'activated', 2 );
3425
		}
3426
3427 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3428
			$version = $old_version = JETPACK__VERSION . ':' . time();
3429
			/** This action is documented in class.jetpack.php */
3430
			do_action( 'updating_jetpack_version', $version, false );
3431
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3432
		}
3433
3434
		self::load_modules();
3435
3436
		Jetpack_Options::delete_option( 'do_activate' );
3437
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3438
	}
3439
3440
	/**
3441
	 * Removes all connection options
3442
	 *
3443
	 * @static
3444
	 */
3445
	public static function plugin_deactivation() {
3446
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3447
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3448
			Jetpack_Network::init()->deactivate();
3449
		} else {
3450
			self::disconnect( false );
3451
			// Jetpack_Heartbeat::init()->deactivate();
3452
		}
3453
	}
3454
3455
	/**
3456
	 * Disconnects from the Jetpack servers.
3457
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3458
	 *
3459
	 * @static
3460
	 */
3461
	public static function disconnect( $update_activated_state = true ) {
3462
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3463
		$connection = self::connection();
3464
		$connection->clean_nonces( true );
3465
3466
		// If the site is in an IDC because sync is not allowed,
3467
		// let's make sure to not disconnect the production site.
3468
		if ( ! self::validate_sync_error_idc_option() ) {
3469
			$tracking = new Tracking();
3470
			$tracking->record_user_event( 'disconnect_site', array() );
3471
3472
			$connection->disconnect_site_wpcom();
3473
		}
3474
3475
		$connection->delete_all_connection_tokens();
3476
		Jetpack_IDC::clear_all_idc_options();
3477
3478
		if ( $update_activated_state ) {
3479
			Jetpack_Options::update_option( 'activated', 4 );
3480
		}
3481
3482
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3483
			// Check then record unique disconnection if site has never been disconnected previously
3484
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3485
				$jetpack_unique_connection['disconnected'] = 1;
3486
			} else {
3487
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3488
					// track unique disconnect
3489
					$jetpack = self::init();
3490
3491
					$jetpack->stat( 'connections', 'unique-disconnect' );
3492
					$jetpack->do_stats( 'server_side' );
3493
				}
3494
				// increment number of times disconnected
3495
				$jetpack_unique_connection['disconnected'] += 1;
3496
			}
3497
3498
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3499
		}
3500
3501
		// Delete all the sync related data. Since it could be taking up space.
3502
		Sender::get_instance()->uninstall();
3503
3504
		// Disable the Heartbeat cron
3505
		Jetpack_Heartbeat::init()->deactivate();
3506
	}
3507
3508
	/**
3509
	 * Unlinks the current user from the linked WordPress.com user.
3510
	 *
3511
	 * @deprecated since 7.7
3512
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3513
	 *
3514
	 * @param Integer $user_id the user identifier.
0 ignored issues
show
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...
3515
	 * @return Boolean Whether the disconnection of the user was successful.
3516
	 */
3517
	public static function unlink_user( $user_id = null ) {
3518
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3519
		return Connection_Manager::disconnect_user( $user_id );
3520
	}
3521
3522
	/**
3523
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3524
	 */
3525
	public static function try_registration() {
3526
		$terms_of_service = new Terms_Of_Service();
3527
		// The user has agreed to the TOS at some point by now.
3528
		$terms_of_service->agree();
3529
3530
		// Let's get some testing in beta versions and such.
3531
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3532
			// Before attempting to connect, let's make sure that the domains are viable.
3533
			$domains_to_check = array_unique(
3534
				array(
3535
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
0 ignored issues
show
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...
3536
					'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...
3537
				)
3538
			);
3539
			foreach ( $domains_to_check as $domain ) {
3540
				$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...
3541
				if ( is_wp_error( $result ) ) {
3542
					return $result;
3543
				}
3544
			}
3545
		}
3546
3547
		$result = self::register();
3548
3549
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3550
		if ( ! $result || is_wp_error( $result ) ) {
3551
			return $result;
3552
		} else {
3553
			return true;
3554
		}
3555
	}
3556
3557
	/**
3558
	 * Tracking an internal event log. Try not to put too much chaff in here.
3559
	 *
3560
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3561
	 */
3562
	public static function log( $code, $data = null ) {
3563
		// only grab the latest 200 entries
3564
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3565
3566
		// Append our event to the log
3567
		$log_entry = array(
3568
			'time'    => time(),
3569
			'user_id' => get_current_user_id(),
3570
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3571
			'code'    => $code,
3572
		);
3573
		// Don't bother storing it unless we've got some.
3574
		if ( ! is_null( $data ) ) {
3575
			$log_entry['data'] = $data;
3576
		}
3577
		$log[] = $log_entry;
3578
3579
		// Try add_option first, to make sure it's not autoloaded.
3580
		// @todo: Add an add_option method to Jetpack_Options
3581
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3582
			Jetpack_Options::update_option( 'log', $log );
3583
		}
3584
3585
		/**
3586
		 * Fires when Jetpack logs an internal event.
3587
		 *
3588
		 * @since 3.0.0
3589
		 *
3590
		 * @param array $log_entry {
3591
		 *  Array of details about the log entry.
3592
		 *
3593
		 *  @param string time Time of the event.
3594
		 *  @param int user_id ID of the user who trigerred the event.
3595
		 *  @param int blog_id Jetpack Blog ID.
3596
		 *  @param string code Unique name for the event.
3597
		 *  @param string data Data about the event.
3598
		 * }
3599
		 */
3600
		do_action( 'jetpack_log_entry', $log_entry );
3601
	}
3602
3603
	/**
3604
	 * Get the internal event log.
3605
	 *
3606
	 * @param $event (string) - only return the specific log events
3607
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3608
	 *
3609
	 * @return array of log events || WP_Error for invalid params
3610
	 */
3611
	public static function get_log( $event = false, $num = false ) {
3612
		if ( $event && ! is_string( $event ) ) {
3613
			return new WP_Error( __( 'First param must be string or empty', 'jetpack' ) );
0 ignored issues
show
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...
3614
		}
3615
3616
		if ( $num && ! is_numeric( $num ) ) {
3617
			return new WP_Error( __( 'Second param must be numeric or empty', 'jetpack' ) );
0 ignored issues
show
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...
3618
		}
3619
3620
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3621
3622
		// If nothing set - act as it did before, otherwise let's start customizing the output
3623
		if ( ! $num && ! $event ) {
3624
			return $entire_log;
3625
		} else {
3626
			$entire_log = array_reverse( $entire_log );
3627
		}
3628
3629
		$custom_log_output = array();
3630
3631
		if ( $event ) {
3632
			foreach ( $entire_log as $log_event ) {
3633
				if ( $event == $log_event['code'] ) {
3634
					$custom_log_output[] = $log_event;
3635
				}
3636
			}
3637
		} else {
3638
			$custom_log_output = $entire_log;
3639
		}
3640
3641
		if ( $num ) {
3642
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3643
		}
3644
3645
		return $custom_log_output;
3646
	}
3647
3648
	/**
3649
	 * Log modification of important settings.
3650
	 */
3651
	public static function log_settings_change( $option, $old_value, $value ) {
3652
		switch ( $option ) {
3653
			case 'jetpack_sync_non_public_post_stati':
3654
				self::log( $option, $value );
3655
				break;
3656
		}
3657
	}
3658
3659
	/**
3660
	 * Return stat data for WPCOM sync
3661
	 */
3662
	public static function get_stat_data( $encode = true, $extended = true ) {
3663
		$data = Jetpack_Heartbeat::generate_stats_array();
3664
3665
		if ( $extended ) {
3666
			$additional_data = self::get_additional_stat_data();
3667
			$data            = array_merge( $data, $additional_data );
3668
		}
3669
3670
		if ( $encode ) {
3671
			return json_encode( $data );
3672
		}
3673
3674
		return $data;
3675
	}
3676
3677
	/**
3678
	 * Get additional stat data to sync to WPCOM
3679
	 */
3680
	public static function get_additional_stat_data( $prefix = '' ) {
3681
		$return[ "{$prefix}themes" ]        = self::get_parsed_theme_data();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$return was never initialized. Although not strictly required by PHP, it is generally a good practice to add $return = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

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