Completed
Push — fix/tiled-gallery-amp-mosaic-c... ( b708e7...398dc2 )
by Yaroslav
08:06
created

Jetpack::development_mode_trigger_text()   A

Complexity

Conditions 6
Paths 4

Size

Total Lines 16

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 6
nc 4
nop 0
dl 0
loc 16
rs 9.1111
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\Connection\Plugin_Storage as Connection_Plugin_Storage;
9
use Automattic\Jetpack\Constants;
10
use Automattic\Jetpack\Partner;
11
use Automattic\Jetpack\Roles;
12
use Automattic\Jetpack\Status;
13
use Automattic\Jetpack\Sync\Functions;
14
use Automattic\Jetpack\Sync\Health;
15
use Automattic\Jetpack\Sync\Sender;
16
use Automattic\Jetpack\Sync\Users;
17
use Automattic\Jetpack\Terms_Of_Service;
18
use Automattic\Jetpack\Tracking;
19
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
20
use Automattic\Jetpack\Redirect;
21
22
/*
23
Options:
24
jetpack_options (array)
25
	An array of options.
26
	@see Jetpack_Options::get_option_names()
27
28
jetpack_register (string)
29
	Temporary verification secrets.
30
31
jetpack_activated (int)
32
	1: the plugin was activated normally
33
	2: the plugin was activated on this site because of a network-wide activation
34
	3: the plugin was auto-installed
35
	4: the plugin was manually disconnected (but is still installed)
36
37
jetpack_active_modules (array)
38
	Array of active module slugs.
39
40
jetpack_do_activate (bool)
41
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
42
*/
43
44
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
45
46
class Jetpack {
47
	public $xmlrpc_server = null;
48
49
	private $rest_authentication_status = null;
50
51
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
52
53
	/**
54
	 * @var array The handles of styles that are concatenated into jetpack.css.
55
	 *
56
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
57
	 */
58
	public $concatenated_style_handles = array(
59
		'jetpack-carousel',
60
		'grunion.css',
61
		'the-neverending-homepage',
62
		'jetpack_likes',
63
		'jetpack_related-posts',
64
		'sharedaddy',
65
		'jetpack-slideshow',
66
		'presentations',
67
		'quiz',
68
		'jetpack-subscriptions',
69
		'jetpack-responsive-videos-style',
70
		'jetpack-social-menu',
71
		'tiled-gallery',
72
		'jetpack_display_posts_widget',
73
		'gravatar-profile-widget',
74
		'goodreads-widget',
75
		'jetpack_social_media_icons_widget',
76
		'jetpack-top-posts-widget',
77
		'jetpack_image_widget',
78
		'jetpack-my-community-widget',
79
		'jetpack-authors-widget',
80
		'wordads',
81
		'eu-cookie-law-style',
82
		'flickr-widget-style',
83
		'jetpack-search-widget',
84
		'jetpack-simple-payments-widget-style',
85
		'jetpack-widget-social-icons-styles',
86
	);
87
88
	/**
89
	 * Contains all assets that have had their URL rewritten to minified versions.
90
	 *
91
	 * @var array
92
	 */
93
	static $min_assets = array();
94
95
	public $plugins_to_deactivate = array(
96
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
97
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
98
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
99
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
100
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
101
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
102
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
103
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
104
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
105
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
106
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
107
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
108
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
109
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
110
	);
111
112
	/**
113
	 * Map of roles we care about, and their corresponding minimum capabilities.
114
	 *
115
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
116
	 *
117
	 * @access public
118
	 * @static
119
	 *
120
	 * @var array
121
	 */
122
	public static $capability_translations = array(
123
		'administrator' => 'manage_options',
124
		'editor'        => 'edit_others_posts',
125
		'author'        => 'publish_posts',
126
		'contributor'   => 'edit_posts',
127
		'subscriber'    => 'read',
128
	);
129
130
	/**
131
	 * Map of modules that have conflicts with plugins and should not be auto-activated
132
	 * if the plugins are active.  Used by filter_default_modules
133
	 *
134
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
135
	 * change `module-slug` and add this to your plugin:
136
	 *
137
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
138
	 * function my_jetpack_get_default_modules( $modules ) {
139
	 *     return array_diff( $modules, array( 'module-slug' ) );
140
	 * }
141
	 *
142
	 * @var array
143
	 */
144
	private $conflicting_plugins = array(
145
		'comments'           => array(
146
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
147
			'Disqus'                         => 'disqus-comment-system/disqus.php',
148
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
149
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
150
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
151
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
152
		),
153
		'comment-likes'      => array(
154
			'Epoch' => 'epoch/plugincore.php',
155
		),
156
		'contact-form'       => array(
157
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
158
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
159
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
160
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
161
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
162
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
163
		),
164
		'latex'              => array(
165
			'LaTeX for WordPress'     => 'latex/latex.php',
166
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
167
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
168
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
169
			'Enable Latex'            => 'enable-latex/enable-latex.php',
170
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
171
		),
172
		'protect'            => array(
173
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
174
			'Captcha'                           => 'captcha/captcha.php',
175
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
176
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
177
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
178
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
179
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
180
			'Security-protection'               => 'security-protection/security-protection.php',
181
			'Login Security'                    => 'login-security/login-security.php',
182
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
183
			'Wordfence Security'                => 'wordfence/wordfence.php',
184
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
185
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
186
		),
187
		'random-redirect'    => array(
188
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
189
		),
190
		'related-posts'      => array(
191
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
192
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
193
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
194
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
195
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
196
			'outbrain'                    => 'outbrain/outbrain.php',
197
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
198
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
199
		),
200
		'sharedaddy'         => array(
201
			'AddThis'     => 'addthis/addthis_social_widget.php',
202
			'Add To Any'  => 'add-to-any/add-to-any.php',
203
			'ShareThis'   => 'share-this/sharethis.php',
204
			'Shareaholic' => 'shareaholic/shareaholic.php',
205
		),
206
		'seo-tools'          => array(
207
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
208
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
209
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
210
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
211
			'The SEO Framework'              => 'autodescription/autodescription.php',
212
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
213
		),
214
		'verification-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
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
221
		),
222
		'widget-visibility'  => array(
223
			'Widget Logic'    => 'widget-logic/widget_logic.php',
224
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
225
		),
226
		'sitemaps'           => array(
227
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
228
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
229
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
230
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
231
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
232
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
233
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
234
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
235
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
236
			'The SEO Framework'                    => 'autodescription/autodescription.php',
237
			'Sitemap'                              => 'sitemap/sitemap.php',
238
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
239
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
240
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
241
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
242
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
243
		),
244
		'lazy-images'        => array(
245
			'Lazy Load'              => 'lazy-load/lazy-load.php',
246
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
247
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
248
		),
249
	);
250
251
	/**
252
	 * Plugins for which we turn off our Facebook OG Tags implementation.
253
	 *
254
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
255
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
256
	 *
257
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
258
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
259
	 */
260
	private $open_graph_conflicting_plugins = array(
261
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
262
		// 2 Click Social Media Buttons
263
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
264
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
265
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
266
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
267
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
268
		// Open Graph Meta Tags by Heateor
269
		'facebook/facebook.php',                                 // Facebook (official plugin)
270
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
271
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
272
		// Facebook Featured Image & OG Meta Tags
273
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
274
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
275
		// Facebook Open Graph Meta Tags for WordPress
276
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
277
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
278
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
279
		// Fedmich's Facebook Open Graph Meta
280
		'network-publisher/networkpub.php',                      // Network Publisher
281
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
282
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
283
		// NextScripts SNAP
284
		'og-tags/og-tags.php',                                   // OG Tags
285
		'opengraph/opengraph.php',                               // Open Graph
286
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
287
		// Open Graph Protocol Framework
288
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
289
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
290
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
291
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
292
		'sharepress/sharepress.php',                             // SharePress
293
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
294
		'social-discussions/social-discussions.php',             // Social Discussions
295
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
296
		'socialize/socialize.php',                               // Socialize
297
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
298
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
299
		// Tweet, Like, Google +1 and Share
300
		'wordbooker/wordbooker.php',                             // Wordbooker
301
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
302
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
303
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
304
		// WP Facebook Like Send & Open Graph Meta
305
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
306
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
307
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
308
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
309
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
310
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
311
	);
312
313
	/**
314
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
315
	 */
316
	private $twitter_cards_conflicting_plugins = array(
317
		// 'twitter/twitter.php',                       // The official one handles this on its own.
318
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
319
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
320
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
321
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
322
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
323
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
324
		'twitter-cards/twitter-cards.php',           // Twitter Cards
325
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
326
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
327
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
328
		'seo-by-rank-math/rank-math.php',            // Rank Math.
329
	);
330
331
	/**
332
	 * Message to display in admin_notice
333
	 *
334
	 * @var string
335
	 */
336
	public $message = '';
337
338
	/**
339
	 * Error to display in admin_notice
340
	 *
341
	 * @var string
342
	 */
343
	public $error = '';
344
345
	/**
346
	 * Modules that need more privacy description.
347
	 *
348
	 * @var string
349
	 */
350
	public $privacy_checks = '';
351
352
	/**
353
	 * Stats to record once the page loads
354
	 *
355
	 * @var array
356
	 */
357
	public $stats = array();
358
359
	/**
360
	 * Jetpack_Sync object
361
	 */
362
	public $sync;
363
364
	/**
365
	 * Verified data for JSON authorization request
366
	 */
367
	public $json_api_authorization_request = array();
368
369
	/**
370
	 * @var Automattic\Jetpack\Connection\Manager
371
	 */
372
	protected $connection_manager;
373
374
	/**
375
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
376
	 */
377
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
378
379
	/**
380
	 * Constant for login redirect key.
381
	 *
382
	 * @var string
383
	 * @since 8.4.0
384
	 */
385
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
386
387
	/**
388
	 * Holds the singleton instance of this class
389
	 *
390
	 * @since 2.3.3
391
	 * @var Jetpack
392
	 */
393
	static $instance = false;
394
395
	/**
396
	 * Singleton
397
	 *
398
	 * @static
399
	 */
400
	public static function init() {
401
		if ( ! self::$instance ) {
402
			self::$instance = new Jetpack();
403
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
404
		}
405
406
		return self::$instance;
407
	}
408
409
	/**
410
	 * Must never be called statically
411
	 */
412
	function plugin_upgrade() {
413
		if ( self::is_active() ) {
414
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
415
			if ( JETPACK__VERSION != $version ) {
416
				// Prevent multiple upgrades at once - only a single process should trigger
417
				// an upgrade to avoid stampedes
418
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
419
					return;
420
				}
421
422
				// Set a short lock to prevent multiple instances of the upgrade
423
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
424
425
				// check which active modules actually exist and remove others from active_modules list
426
				$unfiltered_modules = self::get_active_modules();
427
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
428
				if ( array_diff( $unfiltered_modules, $modules ) ) {
429
					self::update_active_modules( $modules );
430
				}
431
432
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
433
434
				// Upgrade to 4.3.0
435
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
436
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
437
				}
438
439
				// Make sure Markdown for posts gets turned back on
440
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
441
					update_option( 'wpcom_publish_posts_with_markdown', true );
442
				}
443
444
				/*
445
				 * Minileven deprecation. 8.3.0.
446
				 * Only delete options if not using
447
				 * the replacement standalone Minileven plugin.
448
				 */
449
				if (
450
					! self::is_plugin_active( 'minileven-master/minileven.php' )
451
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
452
				) {
453
					if ( get_option( 'wp_mobile_custom_css' ) ) {
454
						delete_option( 'wp_mobile_custom_css' );
455
					}
456
					if ( get_option( 'wp_mobile_excerpt' ) ) {
457
						delete_option( 'wp_mobile_excerpt' );
458
					}
459
					if ( get_option( 'wp_mobile_featured_images' ) ) {
460
						delete_option( 'wp_mobile_featured_images' );
461
					}
462
					if ( get_option( 'wp_mobile_app_promos' ) ) {
463
						delete_option( 'wp_mobile_app_promos' );
464
					}
465
				}
466
467
				// Upgrade to 8.4.0.
468
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
469
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
470
				}
471
472
				if ( did_action( 'wp_loaded' ) ) {
473
					self::upgrade_on_load();
474
				} else {
475
					add_action(
476
						'wp_loaded',
477
						array( __CLASS__, 'upgrade_on_load' )
478
					);
479
				}
480
			}
481
		}
482
	}
483
484
	/**
485
	 * Runs upgrade routines that need to have modules loaded.
486
	 */
487
	static function upgrade_on_load() {
488
489
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
490
		// This can happen in case Jetpack has been just upgraded and is
491
		// being initialized late during the page load. In this case we wait
492
		// until the next proper admin page load with Jetpack active.
493
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
494
			delete_transient( self::$plugin_upgrade_lock_key );
495
496
			return;
497
		}
498
499
		self::maybe_set_version_option();
500
501
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
502
			Jetpack_Widget_Conditions::migrate_post_type_rules();
503
		}
504
505
		if (
506
			class_exists( 'Jetpack_Sitemap_Manager' )
507
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
508
		) {
509
			do_action( 'jetpack_sitemaps_purge_data' );
510
		}
511
512
		// Delete old stats cache
513
		delete_option( 'jetpack_restapi_stats_cache' );
514
515
		delete_transient( self::$plugin_upgrade_lock_key );
516
	}
517
518
	/**
519
	 * Saves all the currently active modules to options.
520
	 * Also fires Action hooks for each newly activated and deactivated module.
521
	 *
522
	 * @param $modules Array Array of active modules to be saved in options.
523
	 *
524
	 * @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...
525
	 */
526
	static function update_active_modules( $modules ) {
527
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
528
		$active_modules       = self::get_active_modules();
529
		$new_active_modules   = array_diff( $modules, $current_modules );
530
		$new_inactive_modules = array_diff( $active_modules, $modules );
531
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
532
		$reindexed_modules    = array_values( $new_current_modules );
533
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
534
535
		foreach ( $new_active_modules as $module ) {
536
			/**
537
			 * Fires when a specific module is activated.
538
			 *
539
			 * @since 1.9.0
540
			 *
541
			 * @param string $module Module slug.
542
			 * @param boolean $success whether the module was activated. @since 4.2
543
			 */
544
			do_action( 'jetpack_activate_module', $module, $success );
545
			/**
546
			 * Fires when a module is activated.
547
			 * The dynamic part of the filter, $module, is the module slug.
548
			 *
549
			 * @since 1.9.0
550
			 *
551
			 * @param string $module Module slug.
552
			 */
553
			do_action( "jetpack_activate_module_$module", $module );
554
		}
555
556
		foreach ( $new_inactive_modules as $module ) {
557
			/**
558
			 * Fired after a module has been deactivated.
559
			 *
560
			 * @since 4.2.0
561
			 *
562
			 * @param string $module Module slug.
563
			 * @param boolean $success whether the module was deactivated.
564
			 */
565
			do_action( 'jetpack_deactivate_module', $module, $success );
566
			/**
567
			 * Fires when a module is deactivated.
568
			 * The dynamic part of the filter, $module, is the module slug.
569
			 *
570
			 * @since 1.9.0
571
			 *
572
			 * @param string $module Module slug.
573
			 */
574
			do_action( "jetpack_deactivate_module_$module", $module );
575
		}
576
577
		return $success;
578
	}
579
580
	static function delete_active_modules() {
581
		self::update_active_modules( array() );
582
	}
583
584
	/**
585
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
586
	 * available.
587
	 */
588
	public function add_configure_hook() {
589
		global $wp_filter;
590
591
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
592
		if ( false !== $current_priority ) {
593
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
594
		}
595
596
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
597
		sort( $taken_priorities );
598
599
		$first_priority = array_shift( $taken_priorities );
600
601
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
602
			$new_priority = - PHP_INT_MAX;
603
		} else {
604
			$new_priority = $first_priority - 1;
605
		}
606
607
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
608
	}
609
610
	/**
611
	 * Constructor.  Initializes WordPress hooks
612
	 */
613
	private function __construct() {
614
		/*
615
		 * Check for and alert any deprecated hooks
616
		 */
617
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
618
619
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
620
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
621
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
622
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
623
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
624
625
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
626
627
		add_filter(
628
			'jetpack_signature_check_token',
629
			array( __CLASS__, 'verify_onboarding_token' ),
630
			10,
631
			3
632
		);
633
634
		/**
635
		 * Prepare Gutenberg Editor functionality
636
		 */
637
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
638
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
639
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
640
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
641
642
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
643
644
		// Unlink user before deleting the user from WP.com.
645
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
646
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
647
648
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
649
650
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
651
		add_action( 'login_init', array( $this, 'login_init' ) );
652
653
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
654
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
655
656
		add_action( 'admin_init', array( $this, 'admin_init' ) );
657
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
658
659
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
660
661
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
662
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
663
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
664
665
		// returns HTTPS support status
666
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
667
668
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
669
670
		add_action( 'wp_ajax_jetpack_wizard_banner', array( 'Jetpack_Wizard_Banner', 'ajax_callback' ) );
671
672
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
673
674
		/**
675
		 * These actions run checks to load additional files.
676
		 * They check for external files or plugins, so they need to run as late as possible.
677
		 */
678
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
679
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
680
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
681
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
682
683
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
684
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
685
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
686
687
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
688
689
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
690
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
691
692
		// A filter to control all just in time messages
693
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
694
695
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
696
697
		/*
698
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
699
		 * We should make sure to only do this for front end links.
700
		 */
701
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
702
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
703
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
704
705
			/*
706
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
707
			 * so they point moderation links on emails to Calypso.
708
			 */
709
			jetpack_require_lib( 'functions.wp-notify' );
710
		}
711
712
		// Hide edit post link if mobile app.
713
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
714
			add_filter( 'get_edit_post_link', '__return_empty_string' );
715
		}
716
717
		// Update the Jetpack plan from API on heartbeats.
718
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
719
720
		/**
721
		 * This is the hack to concatenate all css files into one.
722
		 * For description and reasoning see the implode_frontend_css method.
723
		 *
724
		 * Super late priority so we catch all the registered styles.
725
		 */
726
		if ( ! is_admin() ) {
727
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
728
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
729
		}
730
731
		/**
732
		 * These are sync actions that we need to keep track of for jitms
733
		 */
734
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
735
736
		// Actually push the stats on shutdown.
737
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
738
			add_action( 'shutdown', array( $this, 'push_stats' ) );
739
		}
740
741
		// Actions for Manager::authorize().
742
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
743
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
744
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
745
746
		// Filters for the Manager::get_token() urls and request body.
747
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
748
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
749
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
750
	}
751
752
	/**
753
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
754
	 * Config object.
755
	 */
756
	public function configure() {
757
		$config = new Config();
758
759
		foreach (
760
			array(
761
				'sync',
762
				'tracking',
763
				'tos',
764
			)
765
			as $feature
766
		) {
767
			$config->ensure( $feature );
768
		}
769
770
		$config->ensure(
771
			'connection',
772
			array(
773
				'slug' => 'jetpack',
774
				'name' => 'Jetpack',
775
			)
776
		);
777
778
		if ( is_admin() ) {
779
			$config->ensure( 'jitm' );
780
		}
781
782
		if ( ! $this->connection_manager ) {
783
			$this->connection_manager = new Connection_Manager( 'jetpack' );
784
		}
785
786
		/*
787
		 * Load things that should only be in Network Admin.
788
		 *
789
		 * For now blow away everything else until a more full
790
		 * understanding of what is needed at the network level is
791
		 * available
792
		 */
793
		if ( is_multisite() ) {
794
			$network = Jetpack_Network::init();
795
			$network->set_connection( $this->connection_manager );
796
		}
797
798
		if ( $this->connection_manager->is_active() ) {
799
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
800
801
			Jetpack_Heartbeat::init();
802
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
803
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
804
				Jetpack_Search_Performance_Logger::init();
805
			}
806
		}
807
808
		// Initialize remote file upload request handlers.
809
		$this->add_remote_request_handlers();
810
811
		/*
812
		 * Enable enhanced handling of previewing sites in Calypso
813
		 */
814
		if ( self::is_active() ) {
815
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
816
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
817
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
818
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
819
		}
820
	}
821
822
	/**
823
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
824
	 * initialization code.
825
	 *
826
	 * @action plugins_loaded
827
	 */
828
	public function late_initialization() {
829
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
830
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
831
832
		Partner::init();
833
834
		/**
835
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
836
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
837
		 *
838
		 * @since 8.1.0
839
		 *
840
		 * @param Jetpack $jetpack the main plugin class object.
841
		 */
842
		do_action( 'jetpack_loaded', $this );
843
844
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
845
	}
846
847
	/**
848
	 * Sets up the XMLRPC request handlers.
849
	 *
850
	 * @deprecated since 7.7.0
851
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
852
	 *
853
	 * @param array                 $request_params Incoming request parameters.
854
	 * @param Boolean               $is_active      Whether the connection is currently active.
855
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
856
	 * @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...
857
	 */
858 View Code Duplication
	public function setup_xmlrpc_handlers(
859
		$request_params,
860
		$is_active,
861
		$is_signed,
862
		Jetpack_XMLRPC_Server $xmlrpc_server = null
863
	) {
864
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
865
866
		if ( ! $this->connection_manager ) {
867
			$this->connection_manager = new Connection_Manager();
868
		}
869
870
		return $this->connection_manager->setup_xmlrpc_handlers(
871
			$request_params,
872
			$is_active,
873
			$is_signed,
874
			$xmlrpc_server
875
		);
876
	}
877
878
	/**
879
	 * Initialize REST API registration connector.
880
	 *
881
	 * @deprecated since 7.7.0
882
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
883
	 */
884 View Code Duplication
	public function initialize_rest_api_registration_connector() {
885
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
886
887
		if ( ! $this->connection_manager ) {
888
			$this->connection_manager = new Connection_Manager();
889
		}
890
891
		$this->connection_manager->initialize_rest_api_registration_connector();
892
	}
893
894
	/**
895
	 * This is ported over from the manage module, which has been deprecated and baked in here.
896
	 *
897
	 * @param $domains
898
	 */
899
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
900
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
901
	}
902
903
	/**
904
	 * Return $domains, with 'wordpress.com' appended.
905
	 * This is ported over from the manage module, which has been deprecated and baked in here.
906
	 *
907
	 * @param $domains
908
	 * @return array
909
	 */
910
	function allow_wpcom_domain( $domains ) {
911
		if ( empty( $domains ) ) {
912
			$domains = array();
913
		}
914
		$domains[] = 'wordpress.com';
915
		return array_unique( $domains );
916
	}
917
918
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
919
		$post = get_post( $post_id );
920
921
		if ( empty( $post ) ) {
922
			return $default_url;
923
		}
924
925
		$post_type = $post->post_type;
926
927
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
928
		// https://en.support.wordpress.com/custom-post-types/
929
		$allowed_post_types = array(
930
			'post',
931
			'page',
932
			'jetpack-portfolio',
933
			'jetpack-testimonial',
934
		);
935
936
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
937
			return $default_url;
938
		}
939
940
		return esc_url(
941
			Redirect::get_url(
942
				'calypso-edit-' . $post_type,
943
				array(
944
					'path' => $post_id,
945
				)
946
			)
947
		);
948
	}
949
950
	function point_edit_comment_links_to_calypso( $url ) {
951
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
952
		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...
953
954
		return esc_url(
955
			Redirect::get_url(
956
				'calypso-edit-comment',
957
				array(
958
					'path' => $query_args['amp;c'],
959
				)
960
			)
961
		);
962
963
	}
964
965
	function jetpack_track_last_sync_callback( $params ) {
966
		/**
967
		 * Filter to turn off jitm caching
968
		 *
969
		 * @since 5.4.0
970
		 *
971
		 * @param bool false Whether to cache just in time messages
972
		 */
973
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
974
			return $params;
975
		}
976
977
		if ( is_array( $params ) && isset( $params[0] ) ) {
978
			$option = $params[0];
979
			if ( 'active_plugins' === $option ) {
980
				// use the cache if we can, but not terribly important if it gets evicted
981
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
982
			}
983
		}
984
985
		return $params;
986
	}
987
988
	function jetpack_connection_banner_callback() {
989
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
990
991
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
992
		if (
993
			isset( $_REQUEST['dismissBanner'] ) &&
994
			! Jetpack_Connection_Banner::force_display()
995
		) {
996
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
997
			wp_send_json_success();
998
		}
999
1000
		wp_die();
1001
	}
1002
1003
	/**
1004
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1005
	 * Only used in our alternate XML-RPC endpoint, where we want to
1006
	 * ensure that Core and other plugins' methods are not exposed.
1007
	 *
1008
	 * @deprecated since 7.7.0
1009
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1010
	 *
1011
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1012
	 * @return array Filtered $methods
1013
	 */
1014 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1015
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1016
1017
		if ( ! $this->connection_manager ) {
1018
			$this->connection_manager = new Connection_Manager();
1019
		}
1020
1021
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1022
	}
1023
1024
	/**
1025
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1026
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1027
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1028
	 * which is accessible via a different URI. Most of the below is copied directly
1029
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1030
	 *
1031
	 * @deprecated since 7.7.0
1032
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1033
	 */
1034 View Code Duplication
	public function alternate_xmlrpc() {
1035
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1036
1037
		if ( ! $this->connection_manager ) {
1038
			$this->connection_manager = new Connection_Manager();
1039
		}
1040
1041
		$this->connection_manager->alternate_xmlrpc();
1042
	}
1043
1044
	/**
1045
	 * The callback for the JITM ajax requests.
1046
	 *
1047
	 * @deprecated since 7.9.0
1048
	 */
1049
	function jetpack_jitm_ajax_callback() {
1050
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1051
	}
1052
1053
	/**
1054
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1055
	 */
1056
	function push_stats() {
1057
		if ( ! empty( $this->stats ) ) {
1058
			$this->do_stats( 'server_side' );
1059
		}
1060
	}
1061
1062
	function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1063
		$is_development_mode = ( new Status() )->is_development_mode();
1064
		switch ( $cap ) {
1065
			case 'jetpack_connect':
1066
			case 'jetpack_reconnect':
1067
				if ( $is_development_mode ) {
1068
					$caps = array( 'do_not_allow' );
1069
					break;
1070
				}
1071
				/**
1072
				 * Pass through. If it's not development mode, these should match disconnect.
1073
				 * Let users disconnect if it's development mode, just in case things glitch.
1074
				 */
1075
			case 'jetpack_disconnect':
1076
				/**
1077
				 * In multisite, can individual site admins manage their own connection?
1078
				 *
1079
				 * Ideally, this should be extracted out to a separate filter in the Jetpack_Network class.
1080
				 */
1081
				if ( is_multisite() && ! is_super_admin() && is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
1082
					if ( ! Jetpack_Network::init()->get_option( 'sub-site-connection-override' ) ) {
1083
						/**
1084
						 * We need to update the option name -- it's terribly unclear which
1085
						 * direction the override goes.
1086
						 *
1087
						 * @todo: Update the option name to `sub-sites-can-manage-own-connections`
1088
						 */
1089
						$caps = array( 'do_not_allow' );
1090
						break;
1091
					}
1092
				}
1093
1094
				$caps = array( 'manage_options' );
1095
				break;
1096
			case 'jetpack_manage_modules':
1097
			case 'jetpack_activate_modules':
1098
			case 'jetpack_deactivate_modules':
1099
				$caps = array( 'manage_options' );
1100
				break;
1101
			case 'jetpack_configure_modules':
1102
				$caps = array( 'manage_options' );
1103
				break;
1104
			case 'jetpack_manage_autoupdates':
1105
				$caps = array(
1106
					'manage_options',
1107
					'update_plugins',
1108
				);
1109
				break;
1110
			case 'jetpack_network_admin_page':
1111
			case 'jetpack_network_settings_page':
1112
				$caps = array( 'manage_network_plugins' );
1113
				break;
1114
			case 'jetpack_network_sites_page':
1115
				$caps = array( 'manage_sites' );
1116
				break;
1117
			case 'jetpack_admin_page':
1118
				if ( $is_development_mode ) {
1119
					$caps = array( 'manage_options' );
1120
					break;
1121
				} else {
1122
					$caps = array( 'read' );
1123
				}
1124
				break;
1125
			case 'jetpack_connect_user':
1126
				if ( $is_development_mode ) {
1127
					$caps = array( 'do_not_allow' );
1128
					break;
1129
				}
1130
				$caps = array( 'read' );
1131
				break;
1132
		}
1133
		return $caps;
1134
	}
1135
1136
	/**
1137
	 * Require a Jetpack authentication.
1138
	 *
1139
	 * @deprecated since 7.7.0
1140
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1141
	 */
1142 View Code Duplication
	public function require_jetpack_authentication() {
1143
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1144
1145
		if ( ! $this->connection_manager ) {
1146
			$this->connection_manager = new Connection_Manager();
1147
		}
1148
1149
		$this->connection_manager->require_jetpack_authentication();
1150
	}
1151
1152
	/**
1153
	 * Load language files
1154
	 *
1155
	 * @action plugins_loaded
1156
	 */
1157
	public static function plugin_textdomain() {
1158
		// Note to self, the third argument must not be hardcoded, to account for relocated folders.
1159
		load_plugin_textdomain( 'jetpack', false, dirname( plugin_basename( JETPACK__PLUGIN_FILE ) ) . '/languages/' );
1160
	}
1161
1162
	/**
1163
	 * Register assets for use in various modules and the Jetpack admin page.
1164
	 *
1165
	 * @uses wp_script_is, wp_register_script, plugins_url
1166
	 * @action wp_loaded
1167
	 * @return null
1168
	 */
1169
	public function register_assets() {
1170
		if ( ! wp_script_is( 'spin', 'registered' ) ) {
1171
			wp_register_script(
1172
				'spin',
1173
				Assets::get_file_url_for_environment( '_inc/build/spin.min.js', '_inc/spin.js' ),
1174
				false,
1175
				'1.3'
1176
			);
1177
		}
1178
1179 View Code Duplication
		if ( ! wp_script_is( 'jquery.spin', 'registered' ) ) {
1180
			wp_register_script(
1181
				'jquery.spin',
1182
				Assets::get_file_url_for_environment( '_inc/build/jquery.spin.min.js', '_inc/jquery.spin.js' ),
1183
				array( 'jquery', 'spin' ),
1184
				'1.3'
1185
			);
1186
		}
1187
1188 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1189
			wp_register_script(
1190
				'jetpack-gallery-settings',
1191
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1192
				array( 'media-views' ),
1193
				'20121225'
1194
			);
1195
		}
1196
1197 View Code Duplication
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1198
			wp_register_script(
1199
				'jetpack-twitter-timeline',
1200
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1201
				array( 'jquery' ),
1202
				'4.0.0',
1203
				true
1204
			);
1205
		}
1206
1207
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1208
			wp_register_script(
1209
				'jetpack-facebook-embed',
1210
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1211
				array(),
1212
				null,
1213
				true
1214
			);
1215
1216
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1217
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1218
			if ( ! is_numeric( $fb_app_id ) ) {
1219
				$fb_app_id = '';
1220
			}
1221
			wp_localize_script(
1222
				'jetpack-facebook-embed',
1223
				'jpfbembed',
1224
				array(
1225
					'appid'  => $fb_app_id,
1226
					'locale' => $this->get_locale(),
1227
				)
1228
			);
1229
		}
1230
1231
		/**
1232
		 * As jetpack_register_genericons is by default fired off a hook,
1233
		 * the hook may have already fired by this point.
1234
		 * So, let's just trigger it manually.
1235
		 */
1236
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1237
		jetpack_register_genericons();
1238
1239
		/**
1240
		 * Register the social logos
1241
		 */
1242
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1243
		jetpack_register_social_logos();
1244
1245 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1246
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1247
		}
1248
	}
1249
1250
	/**
1251
	 * Guess locale from language code.
1252
	 *
1253
	 * @param string $lang Language code.
1254
	 * @return string|bool
1255
	 */
1256 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1257
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1258
			return 'en_US';
1259
		}
1260
1261
		if ( ! class_exists( 'GP_Locales' ) ) {
1262
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1263
				return false;
1264
			}
1265
1266
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1267
		}
1268
1269
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1270
			// WP.com: get_locale() returns 'it'
1271
			$locale = GP_Locales::by_slug( $lang );
1272
		} else {
1273
			// Jetpack: get_locale() returns 'it_IT';
1274
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1275
		}
1276
1277
		if ( ! $locale ) {
1278
			return false;
1279
		}
1280
1281
		if ( empty( $locale->facebook_locale ) ) {
1282
			if ( empty( $locale->wp_locale ) ) {
1283
				return false;
1284
			} else {
1285
				// Facebook SDK is smart enough to fall back to en_US if a
1286
				// locale isn't supported. Since supported Facebook locales
1287
				// can fall out of sync, we'll attempt to use the known
1288
				// wp_locale value and rely on said fallback.
1289
				return $locale->wp_locale;
1290
			}
1291
		}
1292
1293
		return $locale->facebook_locale;
1294
	}
1295
1296
	/**
1297
	 * Get the locale.
1298
	 *
1299
	 * @return string|bool
1300
	 */
1301
	function get_locale() {
1302
		$locale = $this->guess_locale_from_lang( get_locale() );
1303
1304
		if ( ! $locale ) {
1305
			$locale = 'en_US';
1306
		}
1307
1308
		return $locale;
1309
	}
1310
1311
	/**
1312
	 * Return the network_site_url so that .com knows what network this site is a part of.
1313
	 *
1314
	 * @param  bool $option
1315
	 * @return string
1316
	 */
1317
	public function jetpack_main_network_site_option( $option ) {
1318
		return network_site_url();
1319
	}
1320
	/**
1321
	 * Network Name.
1322
	 */
1323
	static function network_name( $option = null ) {
1324
		global $current_site;
1325
		return $current_site->site_name;
1326
	}
1327
	/**
1328
	 * Does the network allow new user and site registrations.
1329
	 *
1330
	 * @return string
1331
	 */
1332
	static function network_allow_new_registrations( $option = null ) {
1333
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1334
	}
1335
	/**
1336
	 * Does the network allow admins to add new users.
1337
	 *
1338
	 * @return boolian
1339
	 */
1340
	static function network_add_new_users( $option = null ) {
1341
		return (bool) get_site_option( 'add_new_users' );
1342
	}
1343
	/**
1344
	 * File upload psace left per site in MB.
1345
	 *  -1 means NO LIMIT.
1346
	 *
1347
	 * @return number
1348
	 */
1349
	static function network_site_upload_space( $option = null ) {
1350
		// value in MB
1351
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1352
	}
1353
1354
	/**
1355
	 * Network allowed file types.
1356
	 *
1357
	 * @return string
1358
	 */
1359
	static function network_upload_file_types( $option = null ) {
1360
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1361
	}
1362
1363
	/**
1364
	 * Maximum file upload size set by the network.
1365
	 *
1366
	 * @return number
1367
	 */
1368
	static function network_max_upload_file_size( $option = null ) {
1369
		// value in KB
1370
		return get_site_option( 'fileupload_maxk', 300 );
1371
	}
1372
1373
	/**
1374
	 * Lets us know if a site allows admins to manage the network.
1375
	 *
1376
	 * @return array
1377
	 */
1378
	static function network_enable_administration_menus( $option = null ) {
1379
		return get_site_option( 'menu_items' );
1380
	}
1381
1382
	/**
1383
	 * If a user has been promoted to or demoted from admin, we need to clear the
1384
	 * jetpack_other_linked_admins transient.
1385
	 *
1386
	 * @since 4.3.2
1387
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1388
	 *
1389
	 * @param int    $user_id   The user ID whose role changed.
1390
	 * @param string $role      The new role.
1391
	 * @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...
1392
	 */
1393
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1394
		if ( 'administrator' == $role
1395
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1396
			|| is_null( $old_roles )
1397
		) {
1398
			delete_transient( 'jetpack_other_linked_admins' );
1399
		}
1400
	}
1401
1402
	/**
1403
	 * Checks to see if there are any other users available to become primary
1404
	 * Users must both:
1405
	 * - Be linked to wpcom
1406
	 * - Be an admin
1407
	 *
1408
	 * @return mixed False if no other users are linked, Int if there are.
1409
	 */
1410
	static function get_other_linked_admins() {
1411
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1412
1413
		if ( false === $other_linked_users ) {
1414
			$admins = get_users( array( 'role' => 'administrator' ) );
1415
			if ( count( $admins ) > 1 ) {
1416
				$available = array();
1417
				foreach ( $admins as $admin ) {
1418
					if ( self::is_user_connected( $admin->ID ) ) {
1419
						$available[] = $admin->ID;
1420
					}
1421
				}
1422
1423
				$count_connected_admins = count( $available );
1424
				if ( count( $available ) > 1 ) {
1425
					$other_linked_users = $count_connected_admins;
1426
				} else {
1427
					$other_linked_users = 0;
1428
				}
1429
			} else {
1430
				$other_linked_users = 0;
1431
			}
1432
1433
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1434
		}
1435
1436
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1437
	}
1438
1439
	/**
1440
	 * Return whether we are dealing with a multi network setup or not.
1441
	 * The reason we are type casting this is because we want to avoid the situation where
1442
	 * the result is false since when is_main_network_option return false it cases
1443
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1444
	 * database which could be set to anything as opposed to what this function returns.
1445
	 *
1446
	 * @param  bool $option
1447
	 *
1448
	 * @return boolean
1449
	 */
1450
	public function is_main_network_option( $option ) {
1451
		// return '1' or ''
1452
		return (string) (bool) self::is_multi_network();
1453
	}
1454
1455
	/**
1456
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1457
	 *
1458
	 * @param  string $option
1459
	 * @return boolean
1460
	 */
1461
	public function is_multisite( $option ) {
1462
		return (string) (bool) is_multisite();
1463
	}
1464
1465
	/**
1466
	 * Implemented since there is no core is multi network function
1467
	 * Right now there is no way to tell if we which network is the dominant network on the system
1468
	 *
1469
	 * @since  3.3
1470
	 * @return boolean
1471
	 */
1472 View Code Duplication
	public static function is_multi_network() {
1473
		global  $wpdb;
1474
1475
		// if we don't have a multi site setup no need to do any more
1476
		if ( ! is_multisite() ) {
1477
			return false;
1478
		}
1479
1480
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1481
		if ( $num_sites > 1 ) {
1482
			return true;
1483
		} else {
1484
			return false;
1485
		}
1486
	}
1487
1488
	/**
1489
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1490
	 *
1491
	 * @return null
1492
	 */
1493
	function update_jetpack_main_network_site_option() {
1494
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1495
	}
1496
	/**
1497
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1498
	 */
1499
	function update_jetpack_network_settings() {
1500
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1501
		// Only sync this info for the main network site.
1502
	}
1503
1504
	/**
1505
	 * Get back if the current site is single user site.
1506
	 *
1507
	 * @return bool
1508
	 */
1509 View Code Duplication
	public static function is_single_user_site() {
1510
		global $wpdb;
1511
1512
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1513
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1514
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1515
		}
1516
		return 1 === (int) $some_users;
1517
	}
1518
1519
	/**
1520
	 * Returns true if the site has file write access false otherwise.
1521
	 *
1522
	 * @return string ( '1' | '0' )
1523
	 **/
1524
	public static function file_system_write_access() {
1525
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1526
			require_once ABSPATH . 'wp-admin/includes/file.php';
1527
		}
1528
1529
		require_once ABSPATH . 'wp-admin/includes/template.php';
1530
1531
		$filesystem_method = get_filesystem_method();
1532
		if ( $filesystem_method === 'direct' ) {
1533
			return 1;
1534
		}
1535
1536
		ob_start();
1537
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1538
		ob_end_clean();
1539
		if ( $filesystem_credentials_are_stored ) {
1540
			return 1;
1541
		}
1542
		return 0;
1543
	}
1544
1545
	/**
1546
	 * Finds out if a site is using a version control system.
1547
	 *
1548
	 * @return string ( '1' | '0' )
1549
	 **/
1550
	public static function is_version_controlled() {
1551
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1552
		return (string) (int) Functions::is_version_controlled();
1553
	}
1554
1555
	/**
1556
	 * Determines whether the current theme supports featured images or not.
1557
	 *
1558
	 * @return string ( '1' | '0' )
1559
	 */
1560
	public static function featured_images_enabled() {
1561
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1562
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1563
	}
1564
1565
	/**
1566
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1567
	 *
1568
	 * @deprecated 4.7 use get_avatar_url instead.
1569
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1570
	 * @param int               $size Size of the avatar image
1571
	 * @param string            $default URL to a default image to use if no avatar is available
1572
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1573
	 *
1574
	 * @return array
1575
	 */
1576
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1577
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1578
		return get_avatar_url(
1579
			$id_or_email,
1580
			array(
1581
				'size'          => $size,
1582
				'default'       => $default,
1583
				'force_default' => $force_display,
1584
			)
1585
		);
1586
	}
1587
1588
	/**
1589
	 * jetpack_updates is saved in the following schema:
1590
	 *
1591
	 * array (
1592
	 *      'plugins'                       => (int) Number of plugin updates available.
1593
	 *      'themes'                        => (int) Number of theme updates available.
1594
	 *      'wordpress'                     => (int) Number of WordPress core updates available. // phpcs:ignore WordPress.WP.CapitalPDangit.Misspelled
1595
	 *      'translations'                  => (int) Number of translation updates available.
1596
	 *      'total'                         => (int) Total of all available updates.
1597
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1598
	 * )
1599
	 *
1600
	 * @return array
1601
	 */
1602
	public static function get_updates() {
1603
		$update_data = wp_get_update_data();
1604
1605
		// Stores the individual update counts as well as the total count.
1606
		if ( isset( $update_data['counts'] ) ) {
1607
			$updates = $update_data['counts'];
1608
		}
1609
1610
		// If we need to update WordPress core, let's find the latest version number.
1611 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1612
			$cur = get_preferred_from_update_core();
1613
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1614
				$updates['wp_update_version'] = $cur->current;
1615
			}
1616
		}
1617
		return isset( $updates ) ? $updates : array();
1618
	}
1619
1620
	public static function get_update_details() {
1621
		$update_details = array(
1622
			'update_core'    => get_site_transient( 'update_core' ),
1623
			'update_plugins' => get_site_transient( 'update_plugins' ),
1624
			'update_themes'  => get_site_transient( 'update_themes' ),
1625
		);
1626
		return $update_details;
1627
	}
1628
1629
	public static function refresh_update_data() {
1630
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1631
1632
	}
1633
1634
	public static function refresh_theme_data() {
1635
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1636
	}
1637
1638
	/**
1639
	 * Is Jetpack active?
1640
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1641
	 *
1642
	 * @return bool
1643
	 */
1644
	public static function is_active() {
1645
		return self::connection()->is_active();
1646
	}
1647
1648
	/**
1649
	 * Make an API call to WordPress.com for plan status
1650
	 *
1651
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1652
	 *
1653
	 * @return bool True if plan is updated, false if no update
1654
	 */
1655
	public static function refresh_active_plan_from_wpcom() {
1656
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1657
		return Jetpack_Plan::refresh_from_wpcom();
1658
	}
1659
1660
	/**
1661
	 * Get the plan that this Jetpack site is currently using
1662
	 *
1663
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1664
	 * @return array Active Jetpack plan details.
1665
	 */
1666
	public static function get_active_plan() {
1667
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1668
		return Jetpack_Plan::get();
1669
	}
1670
1671
	/**
1672
	 * Determine whether the active plan supports a particular feature
1673
	 *
1674
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1675
	 * @return bool True if plan supports feature, false if not.
1676
	 */
1677
	public static function active_plan_supports( $feature ) {
1678
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1679
		return Jetpack_Plan::supports( $feature );
1680
	}
1681
1682
	/**
1683
	 * Deprecated: Is Jetpack in development (offline) mode?
1684
	 *
1685
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1686
	 * and themes still use it, and we do not want to flood them with notices.
1687
	 *
1688
	 * Please use Automattic\Jetpack\Status()->is_development_mode() instead.
1689
	 *
1690
	 * @deprecated since 8.0.
1691
	 */
1692
	public static function is_development_mode() {
1693
		return ( new Status() )->is_development_mode();
1694
	}
1695
1696
	/**
1697
	 * Whether the site is currently onboarding or not.
1698
	 * A site is considered as being onboarded if it currently has an onboarding token.
1699
	 *
1700
	 * @since 5.8
1701
	 *
1702
	 * @access public
1703
	 * @static
1704
	 *
1705
	 * @return bool True if the site is currently onboarding, false otherwise
1706
	 */
1707
	public static function is_onboarding() {
1708
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1709
	}
1710
1711
	/**
1712
	 * Determines reason for Jetpack development mode.
1713
	 */
1714
	public static function development_mode_trigger_text() {
1715
		if ( ! ( new Status() )->is_development_mode() ) {
1716
			return __( 'Jetpack is not in Development Mode.', 'jetpack' );
1717
		}
1718
1719
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1720
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1721
		} elseif ( site_url() && false === strpos( site_url(), '.' ) ) {
1722
			$notice = __( 'The site URL lacking a dot (e.g. http://localhost).', 'jetpack' );
1723
		} else {
1724
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1725
		}
1726
1727
		return $notice;
1728
1729
	}
1730
	/**
1731
	 * Get Jetpack development mode notice text and notice class.
1732
	 *
1733
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_development_mode
1734
	 */
1735
	public static function show_development_mode_notice() {
1736 View Code Duplication
		if ( ( new Status() )->is_development_mode() ) {
1737
			$notice = sprintf(
1738
				/* translators: %s is a URL */
1739
				__( 'In <a href="%s" target="_blank">Development Mode</a>:', 'jetpack' ),
1740
				Redirect::get_url( 'jetpack-support-development-mode' )
1741
			);
1742
1743
			$notice .= ' ' . self::development_mode_trigger_text();
1744
1745
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1746
		}
1747
1748
		// Throw up a notice if using a development version and as for feedback.
1749
		if ( self::is_development_version() ) {
1750
			/* translators: %s is a URL */
1751
			$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' ) );
1752
1753
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1754
		}
1755
		// Throw up a notice if using staging mode
1756 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1757
			/* translators: %s is a URL */
1758
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1759
1760
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1761
		}
1762
	}
1763
1764
	/**
1765
	 * Whether Jetpack's version maps to a public release, or a development version.
1766
	 */
1767
	public static function is_development_version() {
1768
		/**
1769
		 * Allows filtering whether this is a development version of Jetpack.
1770
		 *
1771
		 * This filter is especially useful for tests.
1772
		 *
1773
		 * @since 4.3.0
1774
		 *
1775
		 * @param bool $development_version Is this a develoment version of Jetpack?
1776
		 */
1777
		return (bool) apply_filters(
1778
			'jetpack_development_version',
1779
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1780
		);
1781
	}
1782
1783
	/**
1784
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1785
	 */
1786
	public static function is_user_connected( $user_id = false ) {
1787
		return self::connection()->is_user_connected( $user_id );
1788
	}
1789
1790
	/**
1791
	 * Get the wpcom user data of the current|specified connected user.
1792
	 */
1793 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1794
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1795
		if ( ! $user_id ) {
1796
			$user_id = get_current_user_id();
1797
		}
1798
1799
		$transient_key = "jetpack_connected_user_data_$user_id";
1800
1801
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1802
			return $cached_user_data;
1803
		}
1804
1805
		$xml = new Jetpack_IXR_Client(
1806
			array(
1807
				'user_id' => $user_id,
1808
			)
1809
		);
1810
		$xml->query( 'wpcom.getUser' );
1811
		if ( ! $xml->isError() ) {
1812
			$user_data = $xml->getResponse();
1813
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1814
			return $user_data;
1815
		}
1816
1817
		return false;
1818
	}
1819
1820
	/**
1821
	 * Get the wpcom email of the current|specified connected user.
1822
	 */
1823
	public static function get_connected_user_email( $user_id = null ) {
1824
		if ( ! $user_id ) {
1825
			$user_id = get_current_user_id();
1826
		}
1827
1828
		$xml = new Jetpack_IXR_Client(
1829
			array(
1830
				'user_id' => $user_id,
1831
			)
1832
		);
1833
		$xml->query( 'wpcom.getUserEmail' );
1834
		if ( ! $xml->isError() ) {
1835
			return $xml->getResponse();
1836
		}
1837
		return false;
1838
	}
1839
1840
	/**
1841
	 * Get the wpcom email of the master user.
1842
	 */
1843
	public static function get_master_user_email() {
1844
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1845
		if ( $master_user_id ) {
1846
			return self::get_connected_user_email( $master_user_id );
1847
		}
1848
		return '';
1849
	}
1850
1851
	/**
1852
	 * Whether the current user is the connection owner.
1853
	 *
1854
	 * @deprecated since 7.7
1855
	 *
1856
	 * @return bool Whether the current user is the connection owner.
1857
	 */
1858
	public function current_user_is_connection_owner() {
1859
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1860
		return self::connection()->is_connection_owner();
1861
	}
1862
1863
	/**
1864
	 * Gets current user IP address.
1865
	 *
1866
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1867
	 *
1868
	 * @return string                  Current user IP address.
1869
	 */
1870
	public static function current_user_ip( $check_all_headers = false ) {
1871
		if ( $check_all_headers ) {
1872
			foreach ( array(
1873
				'HTTP_CF_CONNECTING_IP',
1874
				'HTTP_CLIENT_IP',
1875
				'HTTP_X_FORWARDED_FOR',
1876
				'HTTP_X_FORWARDED',
1877
				'HTTP_X_CLUSTER_CLIENT_IP',
1878
				'HTTP_FORWARDED_FOR',
1879
				'HTTP_FORWARDED',
1880
				'HTTP_VIA',
1881
			) as $key ) {
1882
				if ( ! empty( $_SERVER[ $key ] ) ) {
1883
					return $_SERVER[ $key ];
1884
				}
1885
			}
1886
		}
1887
1888
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1889
	}
1890
1891
	/**
1892
	 * Synchronize connected user role changes
1893
	 */
1894
	function user_role_change( $user_id ) {
1895
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1896
		Users::user_role_change( $user_id );
1897
	}
1898
1899
	/**
1900
	 * Loads the currently active modules.
1901
	 */
1902
	public static function load_modules() {
1903
		$is_development_mode = ( new Status() )->is_development_mode();
1904
		if (
1905
			! self::is_active()
1906
			&& ! $is_development_mode
1907
			&& ! self::is_onboarding()
1908
			&& (
1909
				! is_multisite()
1910
				|| ! get_site_option( 'jetpack_protect_active' )
1911
			)
1912
		) {
1913
			return;
1914
		}
1915
1916
		$version = Jetpack_Options::get_option( 'version' );
1917 View Code Duplication
		if ( ! $version ) {
1918
			$version = $old_version = JETPACK__VERSION . ':' . time();
1919
			/** This action is documented in class.jetpack.php */
1920
			do_action( 'updating_jetpack_version', $version, false );
1921
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1922
		}
1923
		list( $version ) = explode( ':', $version );
1924
1925
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1926
1927
		$modules_data = array();
1928
1929
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1930
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1931
			$updated_modules = array();
1932
			foreach ( $modules as $module ) {
1933
				$modules_data[ $module ] = self::get_module( $module );
1934
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1935
					continue;
1936
				}
1937
1938
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1939
					continue;
1940
				}
1941
1942
				$updated_modules[] = $module;
1943
			}
1944
1945
			$modules = array_diff( $modules, $updated_modules );
1946
		}
1947
1948
		foreach ( $modules as $index => $module ) {
1949
			// If we're in dev mode, disable modules requiring a connection
1950
			if ( $is_development_mode ) {
1951
				// Prime the pump if we need to
1952
				if ( empty( $modules_data[ $module ] ) ) {
1953
					$modules_data[ $module ] = self::get_module( $module );
1954
				}
1955
				// If the module requires a connection, but we're in local mode, don't include it.
1956
				if ( $modules_data[ $module ]['requires_connection'] ) {
1957
					continue;
1958
				}
1959
			}
1960
1961
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1962
				continue;
1963
			}
1964
1965
			if ( ! include_once self::get_module_path( $module ) ) {
1966
				unset( $modules[ $index ] );
1967
				self::update_active_modules( array_values( $modules ) );
1968
				continue;
1969
			}
1970
1971
			/**
1972
			 * Fires when a specific module is loaded.
1973
			 * The dynamic part of the hook, $module, is the module slug.
1974
			 *
1975
			 * @since 1.1.0
1976
			 */
1977
			do_action( 'jetpack_module_loaded_' . $module );
1978
		}
1979
1980
		/**
1981
		 * Fires when all the modules are loaded.
1982
		 *
1983
		 * @since 1.1.0
1984
		 */
1985
		do_action( 'jetpack_modules_loaded' );
1986
1987
		// 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.
1988
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1989
	}
1990
1991
	/**
1992
	 * Check if Jetpack's REST API compat file should be included
1993
	 *
1994
	 * @action plugins_loaded
1995
	 * @return null
1996
	 */
1997
	public function check_rest_api_compat() {
1998
		/**
1999
		 * Filters the list of REST API compat files to be included.
2000
		 *
2001
		 * @since 2.2.5
2002
		 *
2003
		 * @param array $args Array of REST API compat files to include.
2004
		 */
2005
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2006
2007
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2008
			require_once $_jetpack_rest_api_compat_include;
2009
		}
2010
	}
2011
2012
	/**
2013
	 * Gets all plugins currently active in values, regardless of whether they're
2014
	 * traditionally activated or network activated.
2015
	 *
2016
	 * @todo Store the result in core's object cache maybe?
2017
	 */
2018
	public static function get_active_plugins() {
2019
		$active_plugins = (array) get_option( 'active_plugins', array() );
2020
2021
		if ( is_multisite() ) {
2022
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2023
			// whereas active_plugins stores them in the values.
2024
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2025
			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...
2026
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2027
			}
2028
		}
2029
2030
		sort( $active_plugins );
2031
2032
		return array_unique( $active_plugins );
2033
	}
2034
2035
	/**
2036
	 * Gets and parses additional plugin data to send with the heartbeat data
2037
	 *
2038
	 * @since 3.8.1
2039
	 *
2040
	 * @return array Array of plugin data
2041
	 */
2042
	public static function get_parsed_plugin_data() {
2043
		if ( ! function_exists( 'get_plugins' ) ) {
2044
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2045
		}
2046
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2047
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2048
		$active_plugins = self::get_active_plugins();
2049
2050
		$plugins = array();
2051
		foreach ( $all_plugins as $path => $plugin_data ) {
2052
			$plugins[ $path ] = array(
2053
				'is_active' => in_array( $path, $active_plugins ),
2054
				'file'      => $path,
2055
				'name'      => $plugin_data['Name'],
2056
				'version'   => $plugin_data['Version'],
2057
				'author'    => $plugin_data['Author'],
2058
			);
2059
		}
2060
2061
		return $plugins;
2062
	}
2063
2064
	/**
2065
	 * Gets and parses theme data to send with the heartbeat data
2066
	 *
2067
	 * @since 3.8.1
2068
	 *
2069
	 * @return array Array of theme data
2070
	 */
2071
	public static function get_parsed_theme_data() {
2072
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2073
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2074
2075
		$themes = array();
2076
		foreach ( $all_themes as $slug => $theme_data ) {
2077
			$theme_headers = array();
2078
			foreach ( $header_keys as $header_key ) {
2079
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2080
			}
2081
2082
			$themes[ $slug ] = array(
2083
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2084
				'slug'            => $slug,
2085
				'theme_root'      => $theme_data->get_theme_root_uri(),
2086
				'parent'          => $theme_data->parent(),
2087
				'headers'         => $theme_headers,
2088
			);
2089
		}
2090
2091
		return $themes;
2092
	}
2093
2094
	/**
2095
	 * Checks whether a specific plugin is active.
2096
	 *
2097
	 * We don't want to store these in a static variable, in case
2098
	 * there are switch_to_blog() calls involved.
2099
	 */
2100
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2101
		return in_array( $plugin, self::get_active_plugins() );
2102
	}
2103
2104
	/**
2105
	 * Check if Jetpack's Open Graph tags should be used.
2106
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2107
	 *
2108
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2109
	 * @action plugins_loaded
2110
	 * @return null
2111
	 */
2112
	public function check_open_graph() {
2113
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2114
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2115
		}
2116
2117
		$active_plugins = self::get_active_plugins();
2118
2119
		if ( ! empty( $active_plugins ) ) {
2120
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2121
				if ( in_array( $plugin, $active_plugins ) ) {
2122
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2123
					break;
2124
				}
2125
			}
2126
		}
2127
2128
		/**
2129
		 * Allow the addition of Open Graph Meta Tags to all pages.
2130
		 *
2131
		 * @since 2.0.3
2132
		 *
2133
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2134
		 */
2135
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2136
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2137
		}
2138
	}
2139
2140
	/**
2141
	 * Check if Jetpack's Twitter tags should be used.
2142
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2143
	 *
2144
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2145
	 * @action plugins_loaded
2146
	 * @return null
2147
	 */
2148
	public function check_twitter_tags() {
2149
2150
		$active_plugins = self::get_active_plugins();
2151
2152
		if ( ! empty( $active_plugins ) ) {
2153
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2154
				if ( in_array( $plugin, $active_plugins ) ) {
2155
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2156
					break;
2157
				}
2158
			}
2159
		}
2160
2161
		/**
2162
		 * Allow Twitter Card Meta tags to be disabled.
2163
		 *
2164
		 * @since 2.6.0
2165
		 *
2166
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2167
		 */
2168
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2169
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2170
		}
2171
	}
2172
2173
	/**
2174
	 * Allows plugins to submit security reports.
2175
	 *
2176
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2177
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2178
	 * @param array  $args         See definitions above
2179
	 */
2180
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2181
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2182
	}
2183
2184
	/* Jetpack Options API */
2185
2186
	public static function get_option_names( $type = 'compact' ) {
2187
		return Jetpack_Options::get_option_names( $type );
2188
	}
2189
2190
	/**
2191
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2192
	 *
2193
	 * @param string $name    Option name
2194
	 * @param mixed  $default (optional)
2195
	 */
2196
	public static function get_option( $name, $default = false ) {
2197
		return Jetpack_Options::get_option( $name, $default );
2198
	}
2199
2200
	/**
2201
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2202
	 *
2203
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2204
	 * @param string $name  Option name
2205
	 * @param mixed  $value Option value
2206
	 */
2207
	public static function update_option( $name, $value ) {
2208
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2209
		return Jetpack_Options::update_option( $name, $value );
2210
	}
2211
2212
	/**
2213
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2214
	 *
2215
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2216
	 * @param array $array array( option name => option value, ... )
2217
	 */
2218
	public static function update_options( $array ) {
2219
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2220
		return Jetpack_Options::update_options( $array );
2221
	}
2222
2223
	/**
2224
	 * Deletes the given option.  May be passed multiple option names as an array.
2225
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2226
	 *
2227
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2228
	 * @param string|array $names
2229
	 */
2230
	public static function delete_option( $names ) {
2231
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2232
		return Jetpack_Options::delete_option( $names );
2233
	}
2234
2235
	/**
2236
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2237
	 *
2238
	 * Enters a user token into the user_tokens option
2239
	 *
2240
	 * @param int    $user_id The user id.
2241
	 * @param string $token The user token.
2242
	 * @param bool   $is_master_user Whether the user is the master user.
2243
	 * @return bool
2244
	 */
2245
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2246
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2247
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2248
	}
2249
2250
	/**
2251
	 * Returns an array of all PHP files in the specified absolute path.
2252
	 * Equivalent to glob( "$absolute_path/*.php" ).
2253
	 *
2254
	 * @param string $absolute_path The absolute path of the directory to search.
2255
	 * @return array Array of absolute paths to the PHP files.
2256
	 */
2257
	public static function glob_php( $absolute_path ) {
2258
		if ( function_exists( 'glob' ) ) {
2259
			return glob( "$absolute_path/*.php" );
2260
		}
2261
2262
		$absolute_path = untrailingslashit( $absolute_path );
2263
		$files         = array();
2264
		if ( ! $dir = @opendir( $absolute_path ) ) {
2265
			return $files;
2266
		}
2267
2268
		while ( false !== $file = readdir( $dir ) ) {
2269
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2270
				continue;
2271
			}
2272
2273
			$file = "$absolute_path/$file";
2274
2275
			if ( ! is_file( $file ) ) {
2276
				continue;
2277
			}
2278
2279
			$files[] = $file;
2280
		}
2281
2282
		closedir( $dir );
2283
2284
		return $files;
2285
	}
2286
2287
	public static function activate_new_modules( $redirect = false ) {
2288
		if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
2289
			return;
2290
		}
2291
2292
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2293 View Code Duplication
		if ( ! $jetpack_old_version ) {
2294
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2295
			/** This action is documented in class.jetpack.php */
2296
			do_action( 'updating_jetpack_version', $version, false );
2297
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2298
		}
2299
2300
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2301
2302
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2303
			return;
2304
		}
2305
2306
		$active_modules     = self::get_active_modules();
2307
		$reactivate_modules = array();
2308
		foreach ( $active_modules as $active_module ) {
2309
			$module = self::get_module( $active_module );
2310
			if ( ! isset( $module['changed'] ) ) {
2311
				continue;
2312
			}
2313
2314
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2315
				continue;
2316
			}
2317
2318
			$reactivate_modules[] = $active_module;
2319
			self::deactivate_module( $active_module );
2320
		}
2321
2322
		$new_version = JETPACK__VERSION . ':' . time();
2323
		/** This action is documented in class.jetpack.php */
2324
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2325
		Jetpack_Options::update_options(
2326
			array(
2327
				'version'     => $new_version,
2328
				'old_version' => $jetpack_old_version,
2329
			)
2330
		);
2331
2332
		self::state( 'message', 'modules_activated' );
2333
2334
		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...
2335
2336
		if ( $redirect ) {
2337
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2338
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2339
				$page = $_GET['page'];
2340
			}
2341
2342
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2343
			exit;
2344
		}
2345
	}
2346
2347
	/**
2348
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2349
	 * Make sure to tuck away module "library" files in a sub-directory.
2350
	 */
2351
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2352
		static $modules = null;
2353
2354
		if ( ! isset( $modules ) ) {
2355
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2356
			// Use the cache if we're on the front-end and it's available...
2357
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2358
				$modules = $available_modules_option[ JETPACK__VERSION ];
2359
			} else {
2360
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2361
2362
				$modules = array();
2363
2364
				foreach ( $files as $file ) {
2365
					if ( ! $headers = self::get_module( $file ) ) {
2366
						continue;
2367
					}
2368
2369
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2370
				}
2371
2372
				Jetpack_Options::update_option(
2373
					'available_modules',
2374
					array(
2375
						JETPACK__VERSION => $modules,
2376
					)
2377
				);
2378
			}
2379
		}
2380
2381
		/**
2382
		 * Filters the array of modules available to be activated.
2383
		 *
2384
		 * @since 2.4.0
2385
		 *
2386
		 * @param array $modules Array of available modules.
2387
		 * @param string $min_version Minimum version number required to use modules.
2388
		 * @param string $max_version Maximum version number required to use modules.
2389
		 */
2390
		$mods = apply_filters( 'jetpack_get_available_modules', $modules, $min_version, $max_version );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $min_version.

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

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

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

Loading history...
2391
2392
		if ( ! $min_version && ! $max_version ) {
2393
			return array_keys( $mods );
2394
		}
2395
2396
		$r = array();
2397
		foreach ( $mods as $slug => $introduced ) {
2398
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2399
				continue;
2400
			}
2401
2402
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2403
				continue;
2404
			}
2405
2406
			$r[] = $slug;
2407
		}
2408
2409
		return $r;
2410
	}
2411
2412
	/**
2413
	 * Default modules loaded on activation.
2414
	 */
2415
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2416
		$return = array();
2417
2418
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2419
			$module_data = self::get_module( $module );
2420
2421
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2422
				case 'yes':
2423
					$return[] = $module;
2424
					break;
2425
				case 'public':
2426
					if ( Jetpack_Options::get_option( 'public' ) ) {
2427
						$return[] = $module;
2428
					}
2429
					break;
2430
				case 'no':
2431
				default:
2432
					break;
2433
			}
2434
		}
2435
		/**
2436
		 * Filters the array of default modules.
2437
		 *
2438
		 * @since 2.5.0
2439
		 *
2440
		 * @param array $return Array of default modules.
2441
		 * @param string $min_version Minimum version number required to use modules.
2442
		 * @param string $max_version Maximum version number required to use modules.
2443
		 */
2444
		return apply_filters( 'jetpack_get_default_modules', $return, $min_version, $max_version );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $min_version.

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

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

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

Loading history...
2445
	}
2446
2447
	/**
2448
	 * Checks activated modules during auto-activation to determine
2449
	 * if any of those modules are being deprecated.  If so, close
2450
	 * them out, and add any replacement modules.
2451
	 *
2452
	 * Runs at priority 99 by default.
2453
	 *
2454
	 * This is run late, so that it can still activate a module if
2455
	 * the new module is a replacement for another that the user
2456
	 * currently has active, even if something at the normal priority
2457
	 * would kibosh everything.
2458
	 *
2459
	 * @since 2.6
2460
	 * @uses jetpack_get_default_modules filter
2461
	 * @param array $modules
2462
	 * @return array
2463
	 */
2464
	function handle_deprecated_modules( $modules ) {
2465
		$deprecated_modules = array(
2466
			'debug'            => null,  // Closed out and moved to the debugger library.
2467
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2468
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2469
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2470
		);
2471
2472
		// Don't activate SSO if they never completed activating WPCC.
2473
		if ( self::is_module_active( 'wpcc' ) ) {
2474
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2475
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2476
				$deprecated_modules['wpcc'] = null;
2477
			}
2478
		}
2479
2480
		foreach ( $deprecated_modules as $module => $replacement ) {
2481
			if ( self::is_module_active( $module ) ) {
2482
				self::deactivate_module( $module );
2483
				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...
2484
					$modules[] = $replacement;
2485
				}
2486
			}
2487
		}
2488
2489
		return array_unique( $modules );
2490
	}
2491
2492
	/**
2493
	 * Checks activated plugins during auto-activation to determine
2494
	 * if any of those plugins are in the list with a corresponding module
2495
	 * that is not compatible with the plugin. The module will not be allowed
2496
	 * to auto-activate.
2497
	 *
2498
	 * @since 2.6
2499
	 * @uses jetpack_get_default_modules filter
2500
	 * @param array $modules
2501
	 * @return array
2502
	 */
2503
	function filter_default_modules( $modules ) {
2504
2505
		$active_plugins = self::get_active_plugins();
2506
2507
		if ( ! empty( $active_plugins ) ) {
2508
2509
			// For each module we'd like to auto-activate...
2510
			foreach ( $modules as $key => $module ) {
2511
				// If there are potential conflicts for it...
2512
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2513
					// For each potential conflict...
2514
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2515
						// If that conflicting plugin is active...
2516
						if ( in_array( $plugin, $active_plugins ) ) {
2517
							// Remove that item from being auto-activated.
2518
							unset( $modules[ $key ] );
2519
						}
2520
					}
2521
				}
2522
			}
2523
		}
2524
2525
		return $modules;
2526
	}
2527
2528
	/**
2529
	 * Extract a module's slug from its full path.
2530
	 */
2531
	public static function get_module_slug( $file ) {
2532
		return str_replace( '.php', '', basename( $file ) );
2533
	}
2534
2535
	/**
2536
	 * Generate a module's path from its slug.
2537
	 */
2538
	public static function get_module_path( $slug ) {
2539
		/**
2540
		 * Filters the path of a modules.
2541
		 *
2542
		 * @since 7.4.0
2543
		 *
2544
		 * @param array $return The absolute path to a module's root php file
2545
		 * @param string $slug The module slug
2546
		 */
2547
		return apply_filters( 'jetpack_get_module_path', JETPACK__PLUGIN_DIR . "modules/$slug.php", $slug );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $slug.

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

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

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

Loading history...
2548
	}
2549
2550
	/**
2551
	 * Load module data from module file. Headers differ from WordPress
2552
	 * plugin headers to avoid them being identified as standalone
2553
	 * plugins on the WordPress plugins page.
2554
	 */
2555
	public static function get_module( $module ) {
2556
		$headers = array(
2557
			'name'                      => 'Module Name',
2558
			'description'               => 'Module Description',
2559
			'sort'                      => 'Sort Order',
2560
			'recommendation_order'      => 'Recommendation Order',
2561
			'introduced'                => 'First Introduced',
2562
			'changed'                   => 'Major Changes In',
2563
			'deactivate'                => 'Deactivate',
2564
			'free'                      => 'Free',
2565
			'requires_connection'       => 'Requires Connection',
2566
			'auto_activate'             => 'Auto Activate',
2567
			'module_tags'               => 'Module Tags',
2568
			'feature'                   => 'Feature',
2569
			'additional_search_queries' => 'Additional Search Queries',
2570
			'plan_classes'              => 'Plans',
2571
		);
2572
2573
		$file = self::get_module_path( self::get_module_slug( $module ) );
2574
2575
		$mod = self::get_file_data( $file, $headers );
2576
		if ( empty( $mod['name'] ) ) {
2577
			return false;
2578
		}
2579
2580
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2581
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2582
		$mod['deactivate']           = empty( $mod['deactivate'] );
2583
		$mod['free']                 = empty( $mod['free'] );
2584
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2585
2586
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2587
			$mod['auto_activate'] = 'No';
2588
		} else {
2589
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2590
		}
2591
2592
		if ( $mod['module_tags'] ) {
2593
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2594
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2595
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2596
		} else {
2597
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2598
		}
2599
2600 View Code Duplication
		if ( $mod['plan_classes'] ) {
2601
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2602
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2603
		} else {
2604
			$mod['plan_classes'] = array( 'free' );
2605
		}
2606
2607 View Code Duplication
		if ( $mod['feature'] ) {
2608
			$mod['feature'] = explode( ',', $mod['feature'] );
2609
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2610
		} else {
2611
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2612
		}
2613
2614
		/**
2615
		 * Filters the feature array on a module.
2616
		 *
2617
		 * This filter allows you to control where each module is filtered: Recommended,
2618
		 * and the default "Other" listing.
2619
		 *
2620
		 * @since 3.5.0
2621
		 *
2622
		 * @param array   $mod['feature'] The areas to feature this module:
2623
		 *     'Recommended' shows on the main Jetpack admin screen.
2624
		 *     'Other' should be the default if no other value is in the array.
2625
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2626
		 * @param array   $mod All the currently assembled module data.
2627
		 */
2628
		$mod['feature'] = apply_filters( 'jetpack_module_feature', $mod['feature'], $module, $mod );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $module.

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

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

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

Loading history...
2629
2630
		/**
2631
		 * Filter the returned data about a module.
2632
		 *
2633
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2634
		 * so please be careful.
2635
		 *
2636
		 * @since 3.6.0
2637
		 *
2638
		 * @param array   $mod    The details of the requested module.
2639
		 * @param string  $module The slug of the module, e.g. sharedaddy
2640
		 * @param string  $file   The path to the module source file.
2641
		 */
2642
		return apply_filters( 'jetpack_get_module', $mod, $module, $file );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $module.

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

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

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

Loading history...
2643
	}
2644
2645
	/**
2646
	 * Like core's get_file_data implementation, but caches the result.
2647
	 */
2648
	public static function get_file_data( $file, $headers ) {
2649
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2650
		$file_name = basename( $file );
2651
2652
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2653
2654
		$file_data_option = get_transient( $cache_key );
2655
2656
		if ( ! is_array( $file_data_option ) ) {
2657
			delete_transient( $cache_key );
2658
			$file_data_option = false;
2659
		}
2660
2661
		if ( false === $file_data_option ) {
2662
			$file_data_option = array();
2663
		}
2664
2665
		$key           = md5( $file_name . serialize( $headers ) );
2666
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2667
2668
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2669
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2670
			return $file_data_option[ $key ];
2671
		}
2672
2673
		$data = get_file_data( $file, $headers );
2674
2675
		$file_data_option[ $key ] = $data;
2676
2677
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2678
2679
		return $data;
2680
	}
2681
2682
2683
	/**
2684
	 * Return translated module tag.
2685
	 *
2686
	 * @param string $tag Tag as it appears in each module heading.
2687
	 *
2688
	 * @return mixed
2689
	 */
2690
	public static function translate_module_tag( $tag ) {
2691
		return jetpack_get_module_i18n_tag( $tag );
2692
	}
2693
2694
	/**
2695
	 * Get i18n strings as a JSON-encoded string
2696
	 *
2697
	 * @return string The locale as JSON
2698
	 */
2699
	public static function get_i18n_data_json() {
2700
2701
		// WordPress 5.0 uses md5 hashes of file paths to associate translation
2702
		// JSON files with the file they should be included for. This is an md5
2703
		// of '_inc/build/admin.js'.
2704
		$path_md5 = '1bac79e646a8bf4081a5011ab72d5807';
2705
2706
		$i18n_json =
2707
				   JETPACK__PLUGIN_DIR
2708
				   . 'languages/json/jetpack-'
2709
				   . get_user_locale()
2710
				   . '-'
2711
				   . $path_md5
2712
				   . '.json';
2713
2714
		if ( is_file( $i18n_json ) && is_readable( $i18n_json ) ) {
2715
			$locale_data = @file_get_contents( $i18n_json );
2716
			if ( $locale_data ) {
2717
				return $locale_data;
2718
			}
2719
		}
2720
2721
		// Return valid empty Jed locale
2722
		return '{ "locale_data": { "messages": { "": {} } } }';
2723
	}
2724
2725
	/**
2726
	 * Add locale data setup to wp-i18n
2727
	 *
2728
	 * Any Jetpack script that depends on wp-i18n should use this method to set up the locale.
2729
	 *
2730
	 * The locale setup depends on an adding inline script. This is error-prone and could easily
2731
	 * result in multiple additions of the same script when exactly 0 or 1 is desireable.
2732
	 *
2733
	 * This method provides a safe way to request the setup multiple times but add the script at
2734
	 * most once.
2735
	 *
2736
	 * @since 6.7.0
2737
	 *
2738
	 * @return void
2739
	 */
2740
	public static function setup_wp_i18n_locale_data() {
2741
		static $script_added = false;
2742
		if ( ! $script_added ) {
2743
			$script_added = true;
2744
			wp_add_inline_script(
2745
				'wp-i18n',
2746
				'wp.i18n.setLocaleData( ' . self::get_i18n_data_json() . ', \'jetpack\' );'
2747
			);
2748
		}
2749
	}
2750
2751
	/**
2752
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2753
	 *
2754
	 * @since 3.9.2
2755
	 *
2756
	 * @param array $modules
2757
	 *
2758
	 * @return string|void
2759
	 */
2760
	public static function get_translated_modules( $modules ) {
2761
		foreach ( $modules as $index => $module ) {
2762
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2763
			if ( isset( $module['name'] ) ) {
2764
				$modules[ $index ]['name'] = $i18n_module['name'];
2765
			}
2766
			if ( isset( $module['description'] ) ) {
2767
				$modules[ $index ]['description']       = $i18n_module['description'];
2768
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2769
			}
2770
		}
2771
		return $modules;
2772
	}
2773
2774
	/**
2775
	 * Get a list of activated modules as an array of module slugs.
2776
	 */
2777
	public static function get_active_modules() {
2778
		$active = Jetpack_Options::get_option( 'active_modules' );
2779
2780
		if ( ! is_array( $active ) ) {
2781
			$active = array();
2782
		}
2783
2784
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2785
			$active[] = 'vaultpress';
2786
		} else {
2787
			$active = array_diff( $active, array( 'vaultpress' ) );
2788
		}
2789
2790
		// If protect is active on the main site of a multisite, it should be active on all sites.
2791
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2792
			$active[] = 'protect';
2793
		}
2794
2795
		/**
2796
		 * Allow filtering of the active modules.
2797
		 *
2798
		 * Gives theme and plugin developers the power to alter the modules that
2799
		 * are activated on the fly.
2800
		 *
2801
		 * @since 5.8.0
2802
		 *
2803
		 * @param array $active Array of active module slugs.
2804
		 */
2805
		$active = apply_filters( 'jetpack_active_modules', $active );
2806
2807
		return array_unique( $active );
2808
	}
2809
2810
	/**
2811
	 * Check whether or not a Jetpack module is active.
2812
	 *
2813
	 * @param string $module The slug of a Jetpack module.
2814
	 * @return bool
2815
	 *
2816
	 * @static
2817
	 */
2818
	public static function is_module_active( $module ) {
2819
		return in_array( $module, self::get_active_modules() );
2820
	}
2821
2822
	public static function is_module( $module ) {
2823
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2824
	}
2825
2826
	/**
2827
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2828
	 *
2829
	 * @param bool $catch True to start catching, False to stop.
2830
	 *
2831
	 * @static
2832
	 */
2833
	public static function catch_errors( $catch ) {
2834
		static $display_errors, $error_reporting;
2835
2836
		if ( $catch ) {
2837
			$display_errors  = @ini_set( 'display_errors', 1 );
2838
			$error_reporting = @error_reporting( E_ALL );
2839
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2840
		} else {
2841
			@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...
2842
			@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...
2843
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2844
		}
2845
	}
2846
2847
	/**
2848
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2849
	 */
2850
	public static function catch_errors_on_shutdown() {
2851
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2852
	}
2853
2854
	/**
2855
	 * Rewrite any string to make paths easier to read.
2856
	 *
2857
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2858
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2859
	 *
2860
	 * @param $string
2861
	 * @return mixed
2862
	 */
2863
	public static function alias_directories( $string ) {
2864
		// ABSPATH has a trailing slash.
2865
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2866
		// WP_CONTENT_DIR does not have a trailing slash.
2867
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2868
2869
		return $string;
2870
	}
2871
2872
	public static function activate_default_modules(
2873
		$min_version = false,
2874
		$max_version = false,
2875
		$other_modules = array(),
2876
		$redirect = null,
2877
		$send_state_messages = null
2878
	) {
2879
		$jetpack = self::init();
2880
2881
		if ( is_null( $redirect ) ) {
2882
			if (
2883
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2884
			||
2885
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2886
			||
2887
				( defined( 'WP_CLI' ) && WP_CLI )
2888
			||
2889
				( defined( 'DOING_CRON' ) && DOING_CRON )
2890
			||
2891
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2892
			) {
2893
				$redirect = false;
2894
			} elseif ( is_admin() ) {
2895
				$redirect = true;
2896
			} else {
2897
				$redirect = false;
2898
			}
2899
		}
2900
2901
		if ( is_null( $send_state_messages ) ) {
2902
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2903
		}
2904
2905
		$modules = self::get_default_modules( $min_version, $max_version );
2906
		$modules = array_merge( $other_modules, $modules );
2907
2908
		// Look for standalone plugins and disable if active.
2909
2910
		$to_deactivate = array();
2911
		foreach ( $modules as $module ) {
2912
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2913
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2914
			}
2915
		}
2916
2917
		$deactivated = array();
2918
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2919
			list( $probable_file, $probable_title ) = $deactivate_me;
2920
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2921
				$deactivated[] = $module;
2922
			}
2923
		}
2924
2925
		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...
2926
			if ( $send_state_messages ) {
2927
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2928
			}
2929
2930
			if ( $redirect ) {
2931
				$url = add_query_arg(
2932
					array(
2933
						'action'   => 'activate_default_modules',
2934
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2935
					),
2936
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2937
				);
2938
				wp_safe_redirect( $url );
2939
				exit;
2940
			}
2941
		}
2942
2943
		/**
2944
		 * Fires before default modules are activated.
2945
		 *
2946
		 * @since 1.9.0
2947
		 *
2948
		 * @param string $min_version Minimum version number required to use modules.
2949
		 * @param string $max_version Maximum version number required to use modules.
2950
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2951
		 */
2952
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2953
2954
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2955
		if ( $send_state_messages ) {
2956
			self::restate();
2957
			self::catch_errors( true );
2958
		}
2959
2960
		$active = self::get_active_modules();
2961
2962
		foreach ( $modules as $module ) {
2963
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2964
				$active[] = $module;
2965
				self::update_active_modules( $active );
2966
				continue;
2967
			}
2968
2969
			if ( $send_state_messages && in_array( $module, $active ) ) {
2970
				$module_info = self::get_module( $module );
2971 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2972
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2973
					if ( $active_state = self::state( $state ) ) {
2974
						$active_state = explode( ',', $active_state );
2975
					} else {
2976
						$active_state = array();
2977
					}
2978
					$active_state[] = $module;
2979
					self::state( $state, implode( ',', $active_state ) );
2980
				}
2981
				continue;
2982
			}
2983
2984
			$file = self::get_module_path( $module );
2985
			if ( ! file_exists( $file ) ) {
2986
				continue;
2987
			}
2988
2989
			// we'll override this later if the plugin can be included without fatal error
2990
			if ( $redirect ) {
2991
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2992
			}
2993
2994
			if ( $send_state_messages ) {
2995
				self::state( 'error', 'module_activation_failed' );
2996
				self::state( 'module', $module );
2997
			}
2998
2999
			ob_start();
3000
			require_once $file;
3001
3002
			$active[] = $module;
3003
3004 View Code Duplication
			if ( $send_state_messages ) {
3005
3006
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
3007
				if ( $active_state = self::state( $state ) ) {
3008
					$active_state = explode( ',', $active_state );
3009
				} else {
3010
					$active_state = array();
3011
				}
3012
				$active_state[] = $module;
3013
				self::state( $state, implode( ',', $active_state ) );
3014
			}
3015
3016
			self::update_active_modules( $active );
3017
3018
			ob_end_clean();
3019
		}
3020
3021
		if ( $send_state_messages ) {
3022
			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...
3023
			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...
3024
		}
3025
3026
		self::catch_errors( false );
3027
		/**
3028
		 * Fires when default modules are activated.
3029
		 *
3030
		 * @since 1.9.0
3031
		 *
3032
		 * @param string $min_version Minimum version number required to use modules.
3033
		 * @param string $max_version Maximum version number required to use modules.
3034
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
3035
		 */
3036
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
3037
	}
3038
3039
	public static function activate_module( $module, $exit = true, $redirect = true ) {
3040
		/**
3041
		 * Fires before a module is activated.
3042
		 *
3043
		 * @since 2.6.0
3044
		 *
3045
		 * @param string $module Module slug.
3046
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
3047
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
3048
		 */
3049
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
3050
3051
		$jetpack = self::init();
3052
3053
		if ( ! strlen( $module ) ) {
3054
			return false;
3055
		}
3056
3057
		if ( ! self::is_module( $module ) ) {
3058
			return false;
3059
		}
3060
3061
		// If it's already active, then don't do it again
3062
		$active = self::get_active_modules();
3063
		foreach ( $active as $act ) {
3064
			if ( $act == $module ) {
3065
				return true;
3066
			}
3067
		}
3068
3069
		$module_data = self::get_module( $module );
3070
3071
		$is_development_mode = ( new Status() )->is_development_mode();
3072
		if ( ! self::is_active() ) {
3073
			if ( ! $is_development_mode && ! self::is_onboarding() ) {
3074
				return false;
3075
			}
3076
3077
			// If we're not connected but in development mode, make sure the module doesn't require a connection
3078
			if ( $is_development_mode && $module_data['requires_connection'] ) {
3079
				return false;
3080
			}
3081
		}
3082
3083
		// Check and see if the old plugin is active
3084
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3085
			// Deactivate the old plugin
3086
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3087
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3088
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3089
				self::state( 'deactivated_plugins', $module );
3090
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3091
				exit;
3092
			}
3093
		}
3094
3095
		// Protect won't work with mis-configured IPs
3096
		if ( 'protect' === $module ) {
3097
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3098
			if ( ! jetpack_protect_get_ip() ) {
3099
				self::state( 'message', 'protect_misconfigured_ip' );
3100
				return false;
3101
			}
3102
		}
3103
3104
		if ( ! Jetpack_Plan::supports( $module ) ) {
3105
			return false;
3106
		}
3107
3108
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3109
		self::state( 'module', $module );
3110
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3111
3112
		self::catch_errors( true );
3113
		ob_start();
3114
		require self::get_module_path( $module );
3115
		/** This action is documented in class.jetpack.php */
3116
		do_action( 'jetpack_activate_module', $module );
3117
		$active[] = $module;
3118
		self::update_active_modules( $active );
3119
3120
		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...
3121
		ob_end_clean();
3122
		self::catch_errors( false );
3123
3124
		if ( $redirect ) {
3125
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3126
		}
3127
		if ( $exit ) {
3128
			exit;
3129
		}
3130
		return true;
3131
	}
3132
3133
	function activate_module_actions( $module ) {
3134
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3135
	}
3136
3137
	public static function deactivate_module( $module ) {
3138
		/**
3139
		 * Fires when a module is deactivated.
3140
		 *
3141
		 * @since 1.9.0
3142
		 *
3143
		 * @param string $module Module slug.
3144
		 */
3145
		do_action( 'jetpack_pre_deactivate_module', $module );
3146
3147
		$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...
3148
3149
		$active = self::get_active_modules();
3150
		$new    = array_filter( array_diff( $active, (array) $module ) );
3151
3152
		return self::update_active_modules( $new );
3153
	}
3154
3155
	public static function enable_module_configurable( $module ) {
3156
		$module = self::get_module_slug( $module );
3157
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3158
	}
3159
3160
	/**
3161
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3162
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3163
	 *
3164
	 * @param string $module Module slug
3165
	 * @return string $url module configuration URL
3166
	 */
3167
	public static function module_configuration_url( $module ) {
3168
		$module      = self::get_module_slug( $module );
3169
		$default_url = self::admin_url() . "#/settings?term=$module";
3170
		/**
3171
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3172
		 *
3173
		 * @since 6.9.0
3174
		 *
3175
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3176
		 */
3177
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3178
3179
		return $url;
3180
	}
3181
3182
	/* Installation */
3183
	public static function bail_on_activation( $message, $deactivate = true ) {
3184
		?>
3185
<!doctype html>
3186
<html>
3187
<head>
3188
<meta charset="<?php bloginfo( 'charset' ); ?>">
3189
<style>
3190
* {
3191
	text-align: center;
3192
	margin: 0;
3193
	padding: 0;
3194
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3195
}
3196
p {
3197
	margin-top: 1em;
3198
	font-size: 18px;
3199
}
3200
</style>
3201
<body>
3202
<p><?php echo esc_html( $message ); ?></p>
3203
</body>
3204
</html>
3205
		<?php
3206
		if ( $deactivate ) {
3207
			$plugins = get_option( 'active_plugins' );
3208
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3209
			$update  = false;
3210
			foreach ( $plugins as $i => $plugin ) {
3211
				if ( $plugin === $jetpack ) {
3212
					$plugins[ $i ] = false;
3213
					$update        = true;
3214
				}
3215
			}
3216
3217
			if ( $update ) {
3218
				update_option( 'active_plugins', array_filter( $plugins ) );
3219
			}
3220
		}
3221
		exit;
3222
	}
3223
3224
	/**
3225
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3226
	 *
3227
	 * @static
3228
	 */
3229
	public static function plugin_activation( $network_wide ) {
3230
		Jetpack_Options::update_option( 'activated', 1 );
3231
3232
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3233
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3234
		}
3235
3236
		if ( $network_wide ) {
3237
			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...
3238
		}
3239
3240
		// For firing one-off events (notices) immediately after activation
3241
		set_transient( 'activated_jetpack', true, .1 * MINUTE_IN_SECONDS );
3242
3243
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3244
3245
		Health::on_jetpack_activated();
3246
3247
		self::plugin_initialize();
3248
	}
3249
3250
	public static function get_activation_source( $referer_url ) {
3251
3252
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3253
			return array( 'wp-cli', null );
3254
		}
3255
3256
		$referer = wp_parse_url( $referer_url );
3257
3258
		$source_type  = 'unknown';
3259
		$source_query = null;
3260
3261
		if ( ! is_array( $referer ) ) {
3262
			return array( $source_type, $source_query );
3263
		}
3264
3265
		$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...
3266
		$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...
3267
3268
		if ( isset( $referer['query'] ) ) {
3269
			parse_str( $referer['query'], $query_parts );
3270
		} else {
3271
			$query_parts = array();
3272
		}
3273
3274
		if ( $plugins_path === $referer['path'] ) {
3275
			$source_type = 'list';
3276
		} elseif ( $plugins_install_path === $referer['path'] ) {
3277
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3278
			switch ( $tab ) {
3279
				case 'popular':
3280
					$source_type = 'popular';
3281
					break;
3282
				case 'recommended':
3283
					$source_type = 'recommended';
3284
					break;
3285
				case 'favorites':
3286
					$source_type = 'favorites';
3287
					break;
3288
				case 'search':
3289
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3290
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3291
					break;
3292
				default:
3293
					$source_type = 'featured';
3294
			}
3295
		}
3296
3297
		return array( $source_type, $source_query );
3298
	}
3299
3300
	/**
3301
	 * Runs before bumping version numbers up to a new version
3302
	 *
3303
	 * @param string $version    Version:timestamp.
3304
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3305
	 */
3306
	public static function do_version_bump( $version, $old_version ) {
3307
		if ( $old_version ) { // For existing Jetpack installations.
3308
3309
			// If a front end page is visited after the update, the 'wp' action will fire.
3310
			add_action( 'wp', 'Jetpack::set_update_modal_display' );
3311
3312
			// If an admin page is visited after the update, the 'current_screen' action will fire.
3313
			add_action( 'current_screen', 'Jetpack::set_update_modal_display' );
3314
		}
3315
	}
3316
3317
	/**
3318
	 * Sets the display_update_modal state.
3319
	 */
3320
	public static function set_update_modal_display() {
3321
		self::state( 'display_update_modal', true );
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3791
			$error_description = $response->get_error_message();
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<WP_Error>.

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

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

Loading history...
3792
3793
			if ( ! is_int( $status_code ) ) {
3794
				$status_code = 400;
3795
			}
3796
3797
			status_header( $status_code );
3798
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3799
		}
3800
3801
		status_header( 200 );
3802
		if ( true === $response ) {
3803
			exit;
3804
		}
3805
3806
		die( json_encode( (object) $response ) );
3807
	}
3808
3809
	/**
3810
	 * Uploads a file gotten from the global $_FILES.
3811
	 * If `$update_media_item` is true and `post_id` is defined
3812
	 * the attachment file of the media item (gotten through of the post_id)
3813
	 * will be updated instead of add a new one.
3814
	 *
3815
	 * @param  boolean $update_media_item - update media attachment
3816
	 * @return array - An array describing the uploadind files process
3817
	 */
3818
	function upload_handler( $update_media_item = false ) {
3819
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3820
			return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 405.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3841
			}
3842
		}
3843
3844
		$media_keys = array_keys( $_FILES['media'] );
3845
3846
		$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...
3847
		if ( ! $token || is_wp_error( $token ) ) {
3848
			return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_token'.

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

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

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

Loading history...
3849
		}
3850
3851
		$uploaded_files = array();
3852
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3853
		unset( $GLOBALS['post'] );
3854
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3855
			$file = array();
3856
			foreach ( $media_keys as $media_key ) {
3857
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3858
			}
3859
3860
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3861
3862
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3863
			if ( $hmac_provided !== $hmac_file ) {
3864
				$uploaded_files[ $index ] = (object) array(
3865
					'error'             => 'invalid_hmac',
3866
					'error_description' => 'The corresponding HMAC for this file does not match',
3867
				);
3868
				continue;
3869
			}
3870
3871
			$_FILES['.jetpack.upload.'] = $file;
3872
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3873
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3874
				$post_id = 0;
3875
			}
3876
3877
			if ( $update_media_item ) {
3878
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3879
					return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'invalid_input'.

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

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

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

Loading history...
3880
				}
3881
3882
				$media_array = $_FILES['media'];
3883
3884
				$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...
3885
				$file_array['type']     = $media_array['type'][0];
3886
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3887
				$file_array['error']    = $media_array['error'][0];
3888
				$file_array['size']     = $media_array['size'][0];
3889
3890
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3891
3892
				if ( is_wp_error( $edited_media_item ) ) {
3893
					return $edited_media_item;
3894
				}
3895
3896
				$response = (object) array(
3897
					'id'   => (string) $post_id,
3898
					'file' => (string) $edited_media_item->post_title,
3899
					'url'  => (string) wp_get_attachment_url( $post_id ),
3900
					'type' => (string) $edited_media_item->post_mime_type,
3901
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3902
				);
3903
3904
				return (array) array( $response );
3905
			}
3906
3907
			$attachment_id = media_handle_upload(
3908
				'.jetpack.upload.',
3909
				$post_id,
3910
				array(),
3911
				array(
3912
					'action' => 'jetpack_upload_file',
3913
				)
3914
			);
3915
3916
			if ( ! $attachment_id ) {
3917
				$uploaded_files[ $index ] = (object) array(
3918
					'error'             => 'unknown',
3919
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3920
				);
3921
			} elseif ( is_wp_error( $attachment_id ) ) {
3922
				$uploaded_files[ $index ] = (object) array(
3923
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3924
					'error_description' => $attachment_id->get_error_message(),
3925
				);
3926
			} else {
3927
				$attachment               = get_post( $attachment_id );
3928
				$uploaded_files[ $index ] = (object) array(
3929
					'id'   => (string) $attachment_id,
3930
					'file' => $attachment->post_title,
3931
					'url'  => wp_get_attachment_url( $attachment_id ),
3932
					'type' => $attachment->post_mime_type,
3933
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3934
				);
3935
				// Zip files uploads are not supported unless they are done for installation purposed
3936
				// lets delete them in case something goes wrong in this whole process
3937
				if ( 'application/zip' === $attachment->post_mime_type ) {
3938
					// Schedule a cleanup for 2 hours from now in case of failed install.
3939
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3940
				}
3941
			}
3942
		}
3943
		if ( ! is_null( $global_post ) ) {
3944
			$GLOBALS['post'] = $global_post;
3945
		}
3946
3947
		return $uploaded_files;
3948
	}
3949
3950
	/**
3951
	 * Add help to the Jetpack page
3952
	 *
3953
	 * @since Jetpack (1.2.3)
3954
	 * @return false if not the Jetpack page
3955
	 */
3956
	function admin_help() {
3957
		$current_screen = get_current_screen();
3958
3959
		// Overview
3960
		$current_screen->add_help_tab(
3961
			array(
3962
				'id'      => 'home',
3963
				'title'   => __( 'Home', 'jetpack' ),
3964
				'content' =>
3965
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3966
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3967
					'<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>',
3968
			)
3969
		);
3970
3971
		// Screen Content
3972
		if ( current_user_can( 'manage_options' ) ) {
3973
			$current_screen->add_help_tab(
3974
				array(
3975
					'id'      => 'settings',
3976
					'title'   => __( 'Settings', 'jetpack' ),
3977
					'content' =>
3978
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3979
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3980
						'<ol>' .
3981
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3982
							'<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>' .
3983
						'</ol>' .
3984
						'<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>',
3985
				)
3986
			);
3987
		}
3988
3989
		// Help Sidebar
3990
		$support_url = Redirect::get_url( 'jetpack-support' );
3991
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
3992
		$current_screen->set_help_sidebar(
3993
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3994
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3995
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3996
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3997
		);
3998
	}
3999
4000
	function admin_menu_css() {
4001
		wp_enqueue_style( 'jetpack-icons' );
4002
	}
4003
4004
	function admin_menu_order() {
4005
		return true;
4006
	}
4007
4008 View Code Duplication
	function jetpack_menu_order( $menu_order ) {
4009
		$jp_menu_order = array();
4010
4011
		foreach ( $menu_order as $index => $item ) {
4012
			if ( $item != 'jetpack' ) {
4013
				$jp_menu_order[] = $item;
4014
			}
4015
4016
			if ( $index == 0 ) {
4017
				$jp_menu_order[] = 'jetpack';
4018
			}
4019
		}
4020
4021
		return $jp_menu_order;
4022
	}
4023
4024
	function admin_banner_styles() {
4025
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
4026
4027 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
4028
			wp_register_style(
4029
				'jetpack-dops-style',
4030
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
4031
				array(),
4032
				JETPACK__VERSION
4033
			);
4034
		}
4035
4036
		wp_enqueue_style(
4037
			'jetpack',
4038
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
4039
			array( 'jetpack-dops-style' ),
4040
			JETPACK__VERSION . '-20121016'
4041
		);
4042
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
4043
		wp_style_add_data( 'jetpack', 'suffix', $min );
4044
	}
4045
4046
	function plugin_action_links( $actions ) {
4047
4048
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
4049
4050
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_development_mode() ) ) {
4051
			return array_merge(
4052
				$jetpack_home,
4053
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
4054
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
4055
				$actions
4056
			);
4057
		}
4058
4059
		return array_merge( $jetpack_home, $actions );
4060
	}
4061
4062
	/**
4063
	 * Adds the deactivation warning modal if there are other active plugins using the connection
4064
	 *
4065
	 * @param string $hook The current admin page.
4066
	 *
4067
	 * @return void
4068
	 */
4069
	public function deactivate_dialog( $hook ) {
4070
		if (
4071
			'plugins.php' === $hook
4072
			&& self::is_active()
4073
		) {
4074
4075
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4076
4077
			if ( count( $active_plugins_using_connection ) > 1 ) {
4078
4079
				add_thickbox();
4080
4081
				wp_register_script(
4082
					'jp-tracks',
4083
					'//stats.wp.com/w.js',
4084
					array(),
4085
					gmdate( 'YW' ),
4086
					true
4087
				);
4088
4089
				wp_register_script(
4090
					'jp-tracks-functions',
4091
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
4092
					array( 'jp-tracks' ),
4093
					JETPACK__VERSION,
4094
					false
4095
				);
4096
4097
				wp_enqueue_script(
4098
					'jetpack-deactivate-dialog-js',
4099
					Assets::get_file_url_for_environment(
4100
						'_inc/build/jetpack-deactivate-dialog.min.js',
4101
						'_inc/jetpack-deactivate-dialog.js'
4102
					),
4103
					array( 'jquery', 'jp-tracks-functions' ),
4104
					JETPACK__VERSION,
4105
					true
4106
				);
4107
4108
				wp_localize_script(
4109
					'jetpack-deactivate-dialog-js',
4110
					'deactivate_dialog',
4111
					array(
4112
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4113
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4114
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4115
					)
4116
				);
4117
4118
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4119
4120
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4121
			}
4122
		}
4123
	}
4124
4125
	/**
4126
	 * Outputs the content of the deactivation modal
4127
	 *
4128
	 * @return void
4129
	 */
4130
	public function deactivate_dialog_content() {
4131
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4132
		unset( $active_plugins_using_connection['jetpack'] );
4133
		$this->load_view( 'admin/deactivation-dialog.php', $active_plugins_using_connection );
0 ignored issues
show
Bug introduced by
It seems like $active_plugins_using_connection defined by \Automattic\Jetpack\Conn...ugin_Storage::get_all() on line 4131 can also be of type object<WP_Error>; however, Jetpack::load_view() does only seem to accept array, maybe add an additional type check?

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

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

    return array();
}

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

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

Loading history...
4134
	}
4135
4136
	/**
4137
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4138
	 *
4139
	 * @param string $login_url The wp-login URL.
4140
	 * @param string $redirect  URL to redirect users after logging in.
4141
	 * @since Jetpack 8.4
4142
	 * @return string
4143
	 */
4144
	public function login_url( $login_url, $redirect ) {
4145
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
0 ignored issues
show
Unused Code introduced by
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

Loading history...
4146
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4147
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4148
		}
4149
		return $login_url;
4150
	}
4151
4152
	/**
4153
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4154
	 *
4155
	 * @since Jetpack 8.4
4156
	 */
4157
	public function login_init() {
4158
		// phpcs:ignore WordPress.Security.NonceVerification
4159
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4160
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4161
			wp_safe_redirect(
4162
				add_query_arg(
4163
					array(
4164
						'forceInstall' => 1,
4165
						'url'          => rawurlencode( get_site_url() ),
4166
					),
4167
					// @todo provide way to go to specific calypso env.
4168
					self::get_calypso_host() . 'jetpack/connect'
4169
				)
4170
			);
4171
			exit;
4172
		}
4173
	}
4174
4175
	/*
4176
	 * Registration flow:
4177
	 * 1 - ::admin_page_load() action=register
4178
	 * 2 - ::try_registration()
4179
	 * 3 - ::register()
4180
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4181
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4182
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4183
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4184
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4185
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4186
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4187
	 *       jetpack_id, jetpack_secret, jetpack_public
4188
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4189
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4190
	 * 5 - user logs in with WP.com account
4191
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4192
	 *		- Manager::authorize()
4193
	 *		- Manager::get_token()
4194
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4195
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4196
	 *			- which responds with access_token, token_type, scope
4197
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4198
	 *		- Jetpack::activate_default_modules()
4199
	 *     		- Deactivates deprecated plugins
4200
	 *     		- Activates all default modules
4201
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4202
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4203
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4204
	 *     Done!
4205
	 */
4206
4207
	/**
4208
	 * Handles the page load events for the Jetpack admin page
4209
	 */
4210
	function admin_page_load() {
4211
		$error = false;
4212
4213
		// Make sure we have the right body class to hook stylings for subpages off of.
4214
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4215
4216
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4217
			// Should only be used in intermediate redirects to preserve state across redirects
4218
			self::restate();
4219
		}
4220
4221
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4222
			// @todo: Add validation against a known allowed list.
4223
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4224
			// User clicked in the iframe to link their accounts
4225
			if ( ! self::is_user_connected() ) {
4226
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4227
4228
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4229
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4230
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4231
4232
				if ( isset( $_GET['notes_iframe'] ) ) {
4233
					$connect_url .= '&notes_iframe';
4234
				}
4235
				wp_redirect( $connect_url );
4236
				exit;
4237
			} else {
4238
				if ( ! isset( $_GET['calypso_env'] ) ) {
4239
					self::state( 'message', 'already_authorized' );
4240
					wp_safe_redirect( self::admin_url() );
4241
					exit;
4242
				} else {
4243
					$connect_url  = $this->build_connect_url( true, false, $from );
4244
					$connect_url .= '&already_authorized=true';
4245
					wp_redirect( $connect_url );
4246
					exit;
4247
				}
4248
			}
4249
		}
4250
4251
		if ( isset( $_GET['action'] ) ) {
4252
			switch ( $_GET['action'] ) {
4253
				case 'authorize':
4254
					if ( self::is_active() && self::is_user_connected() ) {
4255
						self::state( 'message', 'already_authorized' );
4256
						wp_safe_redirect( self::admin_url() );
4257
						exit;
4258
					}
4259
					self::log( 'authorize' );
4260
					$client_server = new Jetpack_Client_Server();
4261
					$client_server->client_authorize();
4262
					exit;
4263
				case 'register':
4264
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4265
						$error = 'cheatin';
4266
						break;
4267
					}
4268
					check_admin_referer( 'jetpack-register' );
4269
					self::log( 'register' );
4270
					self::maybe_set_version_option();
4271
					$registered = self::try_registration();
4272 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4273
						$error = $registered->get_error_code();
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

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

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

Loading history...
4274
						self::state( 'error', $error );
4275
						self::state( 'error', $registered->get_error_message() );
0 ignored issues
show
Bug introduced by
The method get_error_message() does not seem to exist on object<WP_Error>.

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

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

Loading history...
4276
4277
						/**
4278
						 * Jetpack registration Error.
4279
						 *
4280
						 * @since 7.5.0
4281
						 *
4282
						 * @param string|int $error The error code.
4283
						 * @param \WP_Error $registered The error object.
4284
						 */
4285
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4286
						break;
4287
					}
4288
4289
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4290
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4291
4292
					/**
4293
					 * Jetpack registration Success.
4294
					 *
4295
					 * @since 7.5.0
4296
					 *
4297
					 * @param string $from 'from' GET parameter;
4298
					 */
4299
					do_action( 'jetpack_connection_register_success', $from );
4300
4301
					$url = $this->build_connect_url( true, $redirect, $from );
4302
4303
					if ( ! empty( $_GET['onboarding'] ) ) {
4304
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4305
					}
4306
4307
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4308
						$url = add_query_arg( 'auth_approved', 'true', $url );
4309
					}
4310
4311
					wp_redirect( $url );
4312
					exit;
4313
				case 'activate':
4314
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4315
						$error = 'cheatin';
4316
						break;
4317
					}
4318
4319
					$module = stripslashes( $_GET['module'] );
4320
					check_admin_referer( "jetpack_activate-$module" );
4321
					self::log( 'activate', $module );
4322
					if ( ! self::activate_module( $module ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression self::activate_module($module) of type boolean|null is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4323
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4324
					}
4325
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4326
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4327
					exit;
4328
				case 'activate_default_modules':
4329
					check_admin_referer( 'activate_default_modules' );
4330
					self::log( 'activate_default_modules' );
4331
					self::restate();
4332
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4333
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4334
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4335
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4336
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4337
					exit;
4338
				case 'disconnect':
4339
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4340
						$error = 'cheatin';
4341
						break;
4342
					}
4343
4344
					check_admin_referer( 'jetpack-disconnect' );
4345
					self::log( 'disconnect' );
4346
					self::disconnect();
4347
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4348
					exit;
4349
				case 'reconnect':
4350
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4351
						$error = 'cheatin';
4352
						break;
4353
					}
4354
4355
					check_admin_referer( 'jetpack-reconnect' );
4356
					self::log( 'reconnect' );
4357
					$this->disconnect();
4358
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4359
					exit;
4360 View Code Duplication
				case 'deactivate':
4361
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4362
						$error = 'cheatin';
4363
						break;
4364
					}
4365
4366
					$modules = stripslashes( $_GET['module'] );
4367
					check_admin_referer( "jetpack_deactivate-$modules" );
4368
					foreach ( explode( ',', $modules ) as $module ) {
4369
						self::log( 'deactivate', $module );
4370
						self::deactivate_module( $module );
4371
						self::state( 'message', 'module_deactivated' );
4372
					}
4373
					self::state( 'module', $modules );
4374
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4375
					exit;
4376
				case 'unlink':
4377
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4378
					check_admin_referer( 'jetpack-unlink' );
4379
					self::log( 'unlink' );
4380
					Connection_Manager::disconnect_user();
4381
					self::state( 'message', 'unlinked' );
4382
					if ( 'sub-unlink' == $redirect ) {
4383
						wp_safe_redirect( admin_url() );
4384
					} else {
4385
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4386
					}
4387
					exit;
4388
				case 'onboard':
4389
					if ( ! current_user_can( 'manage_options' ) ) {
4390
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4391
					} else {
4392
						self::create_onboarding_token();
4393
						$url = $this->build_connect_url( true );
4394
4395
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4396
							$url = add_query_arg( 'onboarding', $token, $url );
4397
						}
4398
4399
						$calypso_env = $this->get_calypso_env();
4400
						if ( ! empty( $calypso_env ) ) {
4401
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4402
						}
4403
4404
						wp_redirect( $url );
4405
						exit;
4406
					}
4407
					exit;
4408
				default:
4409
					/**
4410
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4411
					 *
4412
					 * @since 2.6.0
4413
					 *
4414
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4415
					 */
4416
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4417
			}
4418
		}
4419
4420
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4421
			self::activate_new_modules( true );
4422
		}
4423
4424
		$message_code = self::state( 'message' );
4425
		if ( self::state( 'optin-manage' ) ) {
4426
			$activated_manage = $message_code;
4427
			$message_code     = 'jetpack-manage';
4428
		}
4429
4430
		switch ( $message_code ) {
4431
			case 'jetpack-manage':
4432
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4433
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4434
				$this->message = '<strong>' . sprintf( __( 'You are all set! Your site can now be managed from <a href="%s" target="_blank">wordpress.com/sites</a>.', 'jetpack' ), $sites_url ) . '</strong>';
4435
				if ( $activated_manage ) {
0 ignored issues
show
Bug introduced by
The variable $activated_manage does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
4436
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4437
				}
4438
				break;
4439
4440
		}
4441
4442
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4443
4444
		if ( ! empty( $deactivated_plugins ) ) {
4445
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4446
			$deactivated_titles  = array();
4447
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4448
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4449
					continue;
4450
				}
4451
4452
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4453
			}
4454
4455
			if ( $deactivated_titles ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $deactivated_titles of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
4456
				if ( $this->message ) {
4457
					$this->message .= "<br /><br />\n";
4458
				}
4459
4460
				$this->message .= wp_sprintf(
4461
					_n(
4462
						'Jetpack contains the most recent version of the old %l plugin.',
4463
						'Jetpack contains the most recent versions of the old %l plugins.',
4464
						count( $deactivated_titles ),
4465
						'jetpack'
4466
					),
4467
					$deactivated_titles
4468
				);
4469
4470
				$this->message .= "<br />\n";
4471
4472
				$this->message .= _n(
4473
					'The old version has been deactivated and can be removed from your site.',
4474
					'The old versions have been deactivated and can be removed from your site.',
4475
					count( $deactivated_titles ),
4476
					'jetpack'
4477
				);
4478
			}
4479
		}
4480
4481
		$this->privacy_checks = self::state( 'privacy_checks' );
4482
4483
		if ( $this->message || $this->error || $this->privacy_checks ) {
4484
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4485
		}
4486
4487
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4488
	}
4489
4490
	function admin_notices() {
4491
4492
		if ( $this->error ) {
4493
			?>
4494
<div id="message" class="jetpack-message jetpack-err">
4495
	<div class="squeezer">
4496
		<h2>
4497
			<?php
4498
			echo wp_kses(
4499
				$this->error,
4500
				array(
4501
					'a'      => array( 'href' => array() ),
4502
					'small'  => true,
4503
					'code'   => true,
4504
					'strong' => true,
4505
					'br'     => true,
4506
					'b'      => true,
4507
				)
4508
			);
4509
			?>
4510
			</h2>
4511
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4512
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4513
<?php	endif; ?>
4514
	</div>
4515
</div>
4516
			<?php
4517
		}
4518
4519
		if ( $this->message ) {
4520
			?>
4521
<div id="message" class="jetpack-message">
4522
	<div class="squeezer">
4523
		<h2>
4524
			<?php
4525
			echo wp_kses(
4526
				$this->message,
4527
				array(
4528
					'strong' => array(),
4529
					'a'      => array( 'href' => true ),
4530
					'br'     => true,
4531
				)
4532
			);
4533
			?>
4534
			</h2>
4535
	</div>
4536
</div>
4537
			<?php
4538
		}
4539
4540
		if ( $this->privacy_checks ) :
4541
			$module_names = $module_slugs = array();
4542
4543
			$privacy_checks = explode( ',', $this->privacy_checks );
4544
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4545
			foreach ( $privacy_checks as $module_slug ) {
4546
				$module = self::get_module( $module_slug );
4547
				if ( ! $module ) {
4548
					continue;
4549
				}
4550
4551
				$module_slugs[] = $module_slug;
4552
				$module_names[] = "<strong>{$module['name']}</strong>";
4553
			}
4554
4555
			$module_slugs = join( ',', $module_slugs );
4556
			?>
4557
<div id="message" class="jetpack-message jetpack-err">
4558
	<div class="squeezer">
4559
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4560
		<p>
4561
			<?php
4562
			echo wp_kses(
4563
				wptexturize(
4564
					wp_sprintf(
4565
						_nx(
4566
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4567
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4568
							count( $privacy_checks ),
4569
							'%l = list of Jetpack module/feature names',
4570
							'jetpack'
4571
						),
4572
						$module_names
4573
					)
4574
				),
4575
				array( 'strong' => true )
4576
			);
4577
4578
			echo "\n<br />\n";
4579
4580
			echo wp_kses(
4581
				sprintf(
4582
					_nx(
4583
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4584
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4585
						count( $privacy_checks ),
4586
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4587
						'jetpack'
4588
					),
4589
					wp_nonce_url(
4590
						self::admin_url(
4591
							array(
4592
								'page'   => 'jetpack',
4593
								'action' => 'deactivate',
4594
								'module' => urlencode( $module_slugs ),
4595
							)
4596
						),
4597
						"jetpack_deactivate-$module_slugs"
4598
					),
4599
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4600
				),
4601
				array(
4602
					'a' => array(
4603
						'href'  => true,
4604
						'title' => true,
4605
					),
4606
				)
4607
			);
4608
			?>
4609
		</p>
4610
	</div>
4611
</div>
4612
			<?php
4613
endif;
4614
	}
4615
4616
	/**
4617
	 * We can't always respond to a signed XML-RPC request with a
4618
	 * helpful error message. In some circumstances, doing so could
4619
	 * leak information.
4620
	 *
4621
	 * Instead, track that the error occurred via a Jetpack_Option,
4622
	 * and send that data back in the heartbeat.
4623
	 * All this does is increment a number, but it's enough to find
4624
	 * trends.
4625
	 *
4626
	 * @param WP_Error $xmlrpc_error The error produced during
4627
	 *                               signature validation.
4628
	 */
4629
	function track_xmlrpc_error( $xmlrpc_error ) {
4630
		$code = is_wp_error( $xmlrpc_error )
4631
			? $xmlrpc_error->get_error_code()
0 ignored issues
show
Bug introduced by
The method get_error_code() does not seem to exist on object<WP_Error>.

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

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

Loading history...
4632
			: 'should-not-happen';
4633
4634
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4635
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4636
			// No need to update the option if we already have
4637
			// this code stored.
4638
			return;
4639
		}
4640
		$xmlrpc_errors[ $code ] = true;
4641
4642
		Jetpack_Options::update_option( 'xmlrpc_errors', $xmlrpc_errors, false );
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4643
	}
4644
4645
	/**
4646
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4647
	 */
4648
	function stat( $group, $detail ) {
4649
		if ( ! isset( $this->stats[ $group ] ) ) {
4650
			$this->stats[ $group ] = array();
4651
		}
4652
		$this->stats[ $group ][] = $detail;
4653
	}
4654
4655
	/**
4656
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4657
	 */
4658
	function do_stats( $method = '' ) {
4659
		if ( is_array( $this->stats ) && count( $this->stats ) ) {
4660
			foreach ( $this->stats as $group => $stats ) {
4661
				if ( is_array( $stats ) && count( $stats ) ) {
4662
					$args = array( "x_jetpack-{$group}" => implode( ',', $stats ) );
4663
					if ( 'server_side' === $method ) {
4664
						self::do_server_side_stat( $args );
4665
					} else {
4666
						echo '<img src="' . esc_url( self::build_stats_url( $args ) ) . '" width="1" height="1" style="display:none;" />';
4667
					}
4668
				}
4669
				unset( $this->stats[ $group ] );
4670
			}
4671
		}
4672
	}
4673
4674
	/**
4675
	 * Runs stats code for a one-off, server-side.
4676
	 *
4677
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4678
	 *
4679
	 * @return bool If it worked.
4680
	 */
4681
	static function do_server_side_stat( $args ) {
4682
		$response = wp_remote_get( esc_url_raw( self::build_stats_url( $args ) ) );
4683
		if ( is_wp_error( $response ) ) {
4684
			return false;
4685
		}
4686
4687
		if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4688
			return false;
4689
		}
4690
4691
		return true;
4692
	}
4693
4694
	/**
4695
	 * Builds the stats url.
4696
	 *
4697
	 * @param $args array|string The arguments to append to the URL.
4698
	 *
4699
	 * @return string The URL to be pinged.
4700
	 */
4701
	static function build_stats_url( $args ) {
4702
		$defaults = array(
4703
			'v'    => 'wpcom2',
4704
			'rand' => md5( mt_rand( 0, 999 ) . time() ),
4705
		);
4706
		$args     = wp_parse_args( $args, $defaults );
0 ignored issues
show
Documentation introduced by
$defaults is of type array<string,string,{"v"...ring","rand":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4707
		/**
4708
		 * Filter the URL used as the Stats tracking pixel.
4709
		 *
4710
		 * @since 2.3.2
4711
		 *
4712
		 * @param string $url Base URL used as the Stats tracking pixel.
4713
		 */
4714
		$base_url = apply_filters(
4715
			'jetpack_stats_base_url',
4716
			'https://pixel.wp.com/g.gif'
4717
		);
4718
		$url      = add_query_arg( $args, $base_url );
4719
		return $url;
4720
	}
4721
4722
	/**
4723
	 * Get the role of the current user.
4724
	 *
4725
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4726
	 *
4727
	 * @access public
4728
	 * @static
4729
	 *
4730
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4731
	 */
4732
	public static function translate_current_user_to_role() {
4733
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4734
4735
		$roles = new Roles();
4736
		return $roles->translate_current_user_to_role();
4737
	}
4738
4739
	/**
4740
	 * Get the role of a particular user.
4741
	 *
4742
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4743
	 *
4744
	 * @access public
4745
	 * @static
4746
	 *
4747
	 * @param \WP_User $user User object.
4748
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4749
	 */
4750
	public static function translate_user_to_role( $user ) {
4751
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4752
4753
		$roles = new Roles();
4754
		return $roles->translate_user_to_role( $user );
4755
	}
4756
4757
	/**
4758
	 * Get the minimum capability for a role.
4759
	 *
4760
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4761
	 *
4762
	 * @access public
4763
	 * @static
4764
	 *
4765
	 * @param string $role Role name.
4766
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4767
	 */
4768
	public static function translate_role_to_cap( $role ) {
4769
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4770
4771
		$roles = new Roles();
4772
		return $roles->translate_role_to_cap( $role );
4773
	}
4774
4775
	/**
4776
	 * Sign a user role with the master access token.
4777
	 * If not specified, will default to the current user.
4778
	 *
4779
	 * @deprecated since 7.7
4780
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4781
	 *
4782
	 * @access public
4783
	 * @static
4784
	 *
4785
	 * @param string $role    User role.
4786
	 * @param int    $user_id ID of the user.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be integer|null?

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

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

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

Loading history...
4787
	 * @return string Signed user role.
4788
	 */
4789
	public static function sign_role( $role, $user_id = null ) {
4790
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4791
		return self::connection()->sign_role( $role, $user_id );
4792
	}
4793
4794
	/**
4795
	 * Builds a URL to the Jetpack connection auth page
4796
	 *
4797
	 * @since 3.9.5
4798
	 *
4799
	 * @param bool        $raw If true, URL will not be escaped.
4800
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4801
	 *                              If string, will be a custom redirect.
4802
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4803
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4804
	 *
4805
	 * @return string Connect URL
4806
	 */
4807
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4808
		$site_id    = Jetpack_Options::get_option( 'id' );
4809
		$blog_token = Jetpack_Data::get_access_token();
0 ignored issues
show
Deprecated Code introduced by
The method Jetpack_Data::get_access_token() has been deprecated with message: 7.5 Use Connection_Manager instead.

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

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

Loading history...
4810
4811
		if ( $register || ! $blog_token || ! $site_id ) {
4812
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4813
4814
			if ( ! empty( $redirect ) ) {
4815
				$url = add_query_arg(
4816
					'redirect',
4817
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4818
					$url
4819
				);
4820
			}
4821
4822
			if ( is_network_admin() ) {
4823
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4824
			}
4825
4826
			$calypso_env = self::get_calypso_env();
4827
4828
			if ( ! empty( $calypso_env ) ) {
4829
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4830
			}
4831
		} else {
4832
4833
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4834
			// because otherwise this logic can get us in to a loop.
4835
			$last_connect_url_check = intval( Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' ) );
4836
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4837
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4838
4839
				$response = Client::wpcom_json_api_request_as_blog(
4840
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4841
					'1.1'
4842
				);
4843
4844
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4845
4846
					// Generating a register URL instead to refresh the existing token
4847
					return $this->build_connect_url( $raw, $redirect, $from, true );
4848
				}
4849
			}
4850
4851
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4807 can also be of type string; however, Jetpack::build_authorize_url() does only seem to accept boolean, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
4852
		}
4853
4854
		if ( $from ) {
4855
			$url = add_query_arg( 'from', $from, $url );
4856
		}
4857
4858
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4859
		/**
4860
		 * Filter the URL used when connecting a user to a WordPress.com account.
4861
		 *
4862
		 * @since 8.1.0
4863
		 *
4864
		 * @param string $url Connection URL.
4865
		 * @param bool   $raw If true, URL will not be escaped.
4866
		 */
4867
		return apply_filters( 'jetpack_build_connection_url', $url, $raw );
0 ignored issues
show
Unused Code introduced by
The call to apply_filters() has too many arguments starting with $raw.

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

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

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

Loading history...
4868
	}
4869
4870
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4871
4872
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4873
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4874
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4875
4876
		if ( $iframe ) {
4877
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4878
		}
4879
4880
		$c8n = self::connection();
4881
		$url = $c8n->get_authorization_url( wp_get_current_user(), $redirect );
0 ignored issues
show
Documentation introduced by
$redirect is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
4882
4883
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4884
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4885
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4886
4887
		if ( $iframe ) {
4888
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4889
		}
4890
4891
		return $url;
4892
	}
4893
4894
	/**
4895
	 * Filters the connection URL parameter array.
4896
	 *
4897
	 * @param array $args default URL parameters used by the package.
4898
	 * @return array the modified URL arguments array.
4899
	 */
4900
	public static function filter_connect_request_body( $args ) {
4901
		if (
4902
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4903
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4904
		) {
4905
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4906
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4907
				? $gp_locale->slug
4908
				: '';
4909
		}
4910
4911
		$tracking        = new Tracking();
4912
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4913
4914
		$args = array_merge(
4915
			$args,
4916
			array(
4917
				'_ui' => $tracks_identity['_ui'],
4918
				'_ut' => $tracks_identity['_ut'],
4919
			)
4920
		);
4921
4922
		$calypso_env = self::get_calypso_env();
4923
4924
		if ( ! empty( $calypso_env ) ) {
4925
			$args['calypso_env'] = $calypso_env;
4926
		}
4927
4928
		return $args;
4929
	}
4930
4931
	/**
4932
	 * Filters the URL that will process the connection data. It can be different from the URL
4933
	 * that we send the user to after everything is done.
4934
	 *
4935
	 * @param String $processing_url the default redirect URL used by the package.
4936
	 * @return String the modified URL.
4937
	 */
4938
	public static function filter_connect_processing_url( $processing_url ) {
4939
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4940
		return $processing_url;
4941
	}
4942
4943
	/**
4944
	 * Filters the redirection URL that is used for connect requests. The redirect
4945
	 * URL should return the user back to the Jetpack console.
4946
	 *
4947
	 * @param String $redirect the default redirect URL used by the package.
4948
	 * @return String the modified URL.
4949
	 */
4950
	public static function filter_connect_redirect_url( $redirect ) {
4951
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4952
		$redirect           = $redirect
4953
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4954
			: $jetpack_admin_page;
4955
4956
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4957
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4958
		}
4959
4960
		return $redirect;
4961
	}
4962
4963
	/**
4964
	 * This action fires at the beginning of the Manager::authorize method.
4965
	 */
4966
	public static function authorize_starting() {
4967
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4968
		// Checking if site has been active/connected previously before recording unique connection.
4969
		if ( ! $jetpack_unique_connection ) {
4970
			// jetpack_unique_connection option has never been set.
4971
			$jetpack_unique_connection = array(
4972
				'connected'    => 0,
4973
				'disconnected' => 0,
4974
				'version'      => '3.6.1',
4975
			);
4976
4977
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4978
4979
			// Track unique connection.
4980
			$jetpack = self::init();
4981
4982
			$jetpack->stat( 'connections', 'unique-connection' );
4983
			$jetpack->do_stats( 'server_side' );
4984
		}
4985
4986
		// Increment number of times connected.
4987
		$jetpack_unique_connection['connected'] += 1;
4988
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4989
	}
4990
4991
	/**
4992
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4993
	 * linked.
4994
	 */
4995
	public static function authorize_ending_linked() {
4996
		// Don't activate anything since we are just connecting a user.
4997
		self::state( 'message', 'linked' );
4998
	}
4999
5000
	/**
5001
	 * This action fires at the end of the Manager::authorize method when the master user is
5002
	 * authorized.
5003
	 *
5004
	 * @param array $data The request data.
5005
	 */
5006
	public static function authorize_ending_authorized( $data ) {
5007
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
5008
		self::invalidate_onboarding_token();
5009
5010
		// If redirect_uri is SSO, ensure SSO module is enabled.
5011
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
0 ignored issues
show
Unused Code introduced by
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

Loading history...
5012
5013
		/** This filter is documented in class.jetpack-cli.php */
5014
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
5015
5016
		$activate_sso = (
5017
			isset( $redirect_options['action'] ) &&
5018
			'jetpack-sso' === $redirect_options['action'] &&
5019
			$jetpack_start_enable_sso
5020
		);
5021
5022
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
5023
5024
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
5025
	}
5026
5027
	/**
5028
	 * Get our assumed site creation date.
5029
	 * Calculated based on the earlier date of either:
5030
	 * - Earliest admin user registration date.
5031
	 * - Earliest date of post of any post type.
5032
	 *
5033
	 * @since 7.2.0
5034
	 * @deprecated since 7.8.0
5035
	 *
5036
	 * @return string Assumed site creation date and time.
5037
	 */
5038
	public static function get_assumed_site_creation_date() {
5039
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
5040
		return self::connection()->get_assumed_site_creation_date();
5041
	}
5042
5043 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
5044
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
5045
5046
		if ( $activation_source_name ) {
5047
			$args['_as'] = urlencode( $activation_source_name );
5048
		}
5049
5050
		if ( $activation_source_keyword ) {
5051
			$args['_ak'] = urlencode( $activation_source_keyword );
5052
		}
5053
	}
5054
5055
	function build_reconnect_url( $raw = false ) {
5056
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
5057
		return $raw ? $url : esc_url( $url );
5058
	}
5059
5060
	public static function admin_url( $args = null ) {
5061
		$args = wp_parse_args( $args, array( 'page' => 'jetpack' ) );
0 ignored issues
show
Documentation introduced by
array('page' => 'jetpack') is of type array<string,string,{"page":"string"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
5062
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5063
		return $url;
5064
	}
5065
5066
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5067
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5068
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5069
	}
5070
5071
	function dismiss_jetpack_notice() {
5072
5073
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5074
			return;
5075
		}
5076
5077
		switch ( $_GET['jetpack-notice'] ) {
5078
			case 'dismiss':
5079
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5080
5081
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5082
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5083
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5084
				}
5085
				break;
5086
		}
5087
	}
5088
5089
	public static function sort_modules( $a, $b ) {
5090
		if ( $a['sort'] == $b['sort'] ) {
5091
			return 0;
5092
		}
5093
5094
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5095
	}
5096
5097
	function ajax_recheck_ssl() {
5098
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5099
		$result = self::permit_ssl( true );
5100
		wp_send_json(
5101
			array(
5102
				'enabled' => $result,
5103
				'message' => get_transient( 'jetpack_https_test_message' ),
5104
			)
5105
		);
5106
	}
5107
5108
	/* Client API */
5109
5110
	/**
5111
	 * Returns the requested Jetpack API URL
5112
	 *
5113
	 * @deprecated since 7.7
5114
	 * @return string
5115
	 */
5116
	public static function api_url( $relative_url ) {
5117
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5118
		$connection = self::connection();
5119
		return $connection->api_url( $relative_url );
5120
	}
5121
5122
	/**
5123
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::fix_url_for_bad_hosts() instead.
5124
	 *
5125
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requsets
5126
	 */
5127
	public static function fix_url_for_bad_hosts( $url ) {
5128
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::fix_url_for_bad_hosts' );
5129
		return Connection_Utils::fix_url_for_bad_hosts( $url );
5130
	}
5131
5132
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5133
		// Default to a blog token.
5134
		$token_type = 'blog';
5135
5136
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5137
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5138
			if ( ! empty( $_GET['onboarding'] ) ) {
5139
				$jpo = $_GET;
5140
			} else {
5141
				$jpo = json_decode( $request_data, true );
5142
			}
5143
5144
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5145
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5146
5147
			if (
5148
				isset( $jpo_user )
5149
				&& isset( $jpo_token )
5150
				&& is_email( $jpo_user )
5151
				&& ctype_alnum( $jpo_token )
5152
				&& isset( $_GET['rest_route'] )
5153
				&& self::validate_onboarding_token_action(
5154
					$jpo_token,
5155
					$_GET['rest_route']
5156
				)
5157
			) {
5158
				$jp_user = get_user_by( 'email', $jpo_user );
5159
				if ( is_a( $jp_user, 'WP_User' ) ) {
5160
					wp_set_current_user( $jp_user->ID );
5161
					$user_can = is_multisite()
5162
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5163
						: current_user_can( 'manage_options' );
5164
					if ( $user_can ) {
5165
						$token_type              = 'user';
5166
						$token->external_user_id = $jp_user->ID;
5167
					}
5168
				}
5169
			}
5170
5171
			$token_data['type']    = $token_type;
5172
			$token_data['user_id'] = $token->external_user_id;
5173
		}
5174
5175
		return $token_data;
5176
	}
5177
5178
	/**
5179
	 * Create a random secret for validating onboarding payload
5180
	 *
5181
	 * @return string Secret token
5182
	 */
5183
	public static function create_onboarding_token() {
5184
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5185
			$token = wp_generate_password( 32, false );
5186
			Jetpack_Options::update_option( 'onboarding', $token );
5187
		}
5188
5189
		return $token;
5190
	}
5191
5192
	/**
5193
	 * Remove the onboarding token
5194
	 *
5195
	 * @return bool True on success, false on failure
5196
	 */
5197
	public static function invalidate_onboarding_token() {
5198
		return Jetpack_Options::delete_option( 'onboarding' );
5199
	}
5200
5201
	/**
5202
	 * Validate an onboarding token for a specific action
5203
	 *
5204
	 * @return boolean True if token/action pair is accepted, false if not
5205
	 */
5206
	public static function validate_onboarding_token_action( $token, $action ) {
5207
		// Compare tokens, bail if tokens do not match
5208
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5209
			return false;
5210
		}
5211
5212
		// List of valid actions we can take
5213
		$valid_actions = array(
5214
			'/jetpack/v4/settings',
5215
		);
5216
5217
		// Only allow valid actions.
5218
		if ( ! in_array( $action, $valid_actions ) ) {
5219
			return false;
5220
		}
5221
5222
		return true;
5223
	}
5224
5225
	/**
5226
	 * Checks to see if the URL is using SSL to connect with Jetpack
5227
	 *
5228
	 * @since 2.3.3
5229
	 * @return boolean
5230
	 */
5231
	public static function permit_ssl( $force_recheck = false ) {
5232
		// Do some fancy tests to see if ssl is being supported
5233
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5234
			$message = '';
5235
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5236
				$ssl = 0;
5237
			} else {
5238
				switch ( JETPACK_CLIENT__HTTPS ) {
5239
					case 'NEVER':
5240
						$ssl     = 0;
5241
						$message = __( 'JETPACK_CLIENT__HTTPS is set to NEVER', 'jetpack' );
5242
						break;
5243
					case 'ALWAYS':
5244
					case 'AUTO':
5245
					default:
5246
						$ssl = 1;
5247
						break;
5248
				}
5249
5250
				// If it's not 'NEVER', test to see
5251
				if ( $ssl ) {
5252
					if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5253
						$ssl     = 0;
5254
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5255
					} else {
5256
						$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5257
						if ( is_wp_error( $response ) ) {
5258
							$ssl     = 0;
5259
							$message = __( 'WordPress reports no SSL support', 'jetpack' );
5260
						} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5261
							$ssl     = 0;
5262
							$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5263
						}
5264
					}
5265
				}
5266
			}
5267
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5268
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5269
		}
5270
5271
		return (bool) $ssl;
5272
	}
5273
5274
	/*
5275
	 * Displays an admin_notice, alerting the user to their JETPACK_CLIENT__HTTPS constant being 'AUTO' but SSL isn't working.
5276
	 */
5277
	public function alert_auto_ssl_fail() {
5278
		if ( ! current_user_can( 'manage_options' ) ) {
5279
			return;
5280
		}
5281
5282
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5283
		?>
5284
5285
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5286
			<div class="jp-banner__content">
5287
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5288
				<p><?php _e( 'Your site could not connect to WordPress.com via HTTPS. This could be due to any number of reasons, including faulty SSL certificates, misconfigured or missing SSL libraries, or network issues.', 'jetpack' ); ?></p>
5289
				<p>
5290
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5291
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5292
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5293
				</p>
5294
				<p>
5295
					<?php
5296
					printf(
5297
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5298
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5299
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5300
					);
5301
					?>
5302
				</p>
5303
			</div>
5304
		</div>
5305
		<style>
5306
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5307
		</style>
5308
		<script type="text/javascript">
5309
			jQuery( document ).ready( function( $ ) {
5310
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5311
					var $this = $( this );
5312
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5313
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5314
					e.preventDefault();
5315
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5316
					$.post( ajaxurl, data )
5317
					  .done( function( response ) {
5318
						  if ( response.enabled ) {
5319
							  $( '#jetpack-ssl-warning' ).hide();
5320
						  } else {
5321
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5322
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5323
						  }
5324
					  }.bind( $this ) );
5325
				} );
5326
			} );
5327
		</script>
5328
5329
		<?php
5330
	}
5331
5332
	/**
5333
	 * Returns the Jetpack XML-RPC API
5334
	 *
5335
	 * @deprecated 8.0 Use Connection_Manager instead.
5336
	 * @return string
5337
	 */
5338
	public static function xmlrpc_api_url() {
5339
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5340
		return self::connection()->xmlrpc_api_url();
5341
	}
5342
5343
	/**
5344
	 * Returns the connection manager object.
5345
	 *
5346
	 * @return Automattic\Jetpack\Connection\Manager
5347
	 */
5348
	public static function connection() {
5349
		$jetpack = static::init();
5350
5351
		// If the connection manager hasn't been instantiated, do that now.
5352
		if ( ! $jetpack->connection_manager ) {
5353
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5354
		}
5355
5356
		return $jetpack->connection_manager;
5357
	}
5358
5359
	/**
5360
	 * Creates two secret tokens and the end of life timestamp for them.
5361
	 *
5362
	 * Note these tokens are unique per call, NOT static per site for connecting.
5363
	 *
5364
	 * @since 2.6
5365
	 * @param String  $action  The action name.
5366
	 * @param Integer $user_id The user identifier.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $user_id not be false|integer?

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

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

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

Loading history...
5367
	 * @param Integer $exp     Expiration time in seconds.
5368
	 * @return array
5369
	 */
5370
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5371
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5372
	}
5373
5374
	public static function get_secrets( $action, $user_id ) {
5375
		$secrets = self::connection()->get_secrets( $action, $user_id );
5376
5377
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5378
			return new WP_Error( 'verify_secrets_missing', 'Verification secrets not found' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_missing'.

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

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

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

Loading history...
5379
		}
5380
5381
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5382
			return new WP_Error( 'verify_secrets_expired', 'Verification took too long' );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'verify_secrets_expired'.

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

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

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

Loading history...
5383
		}
5384
5385
		return $secrets;
5386
	}
5387
5388
	/**
5389
	 * @deprecated 7.5 Use Connection_Manager instead.
5390
	 *
5391
	 * @param $action
5392
	 * @param $user_id
5393
	 */
5394
	public static function delete_secrets( $action, $user_id ) {
5395
		return self::connection()->delete_secrets( $action, $user_id );
5396
	}
5397
5398
	/**
5399
	 * Builds the timeout limit for queries talking with the wpcom servers.
5400
	 *
5401
	 * Based on local php max_execution_time in php.ini
5402
	 *
5403
	 * @since 2.6
5404
	 * @return int
5405
	 * @deprecated
5406
	 **/
5407
	public function get_remote_query_timeout_limit() {
5408
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5409
		return self::get_max_execution_time();
5410
	}
5411
5412
	/**
5413
	 * Builds the timeout limit for queries talking with the wpcom servers.
5414
	 *
5415
	 * Based on local php max_execution_time in php.ini
5416
	 *
5417
	 * @since 5.4
5418
	 * @return int
5419
	 **/
5420
	public static function get_max_execution_time() {
5421
		$timeout = (int) ini_get( 'max_execution_time' );
5422
5423
		// Ensure exec time set in php.ini
5424
		if ( ! $timeout ) {
5425
			$timeout = 30;
5426
		}
5427
		return $timeout;
5428
	}
5429
5430
	/**
5431
	 * Sets a minimum request timeout, and returns the current timeout
5432
	 *
5433
	 * @since 5.4
5434
	 **/
5435 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5436
		$timeout = self::get_max_execution_time();
5437
		if ( $timeout < $min_timeout ) {
5438
			$timeout = $min_timeout;
5439
			set_time_limit( $timeout );
5440
		}
5441
		return $timeout;
5442
	}
5443
5444
	/**
5445
	 * Takes the response from the Jetpack register new site endpoint and
5446
	 * verifies it worked properly.
5447
	 *
5448
	 * @since 2.6
5449
	 * @deprecated since 7.7.0
5450
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5451
	 **/
5452
	public function validate_remote_register_response() {
5453
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5454
	}
5455
5456
	/**
5457
	 * @return bool|WP_Error
5458
	 */
5459
	public static function register() {
5460
		$tracking = new Tracking();
5461
		$tracking->record_user_event( 'jpc_register_begin' );
5462
5463
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5464
5465
		$connection   = self::connection();
5466
		$registration = $connection->register();
5467
5468
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5469
5470
		if ( ! $registration || is_wp_error( $registration ) ) {
5471
			return $registration;
5472
		}
5473
5474
		return true;
5475
	}
5476
5477
	/**
5478
	 * Filters the registration request body to include tracking properties.
5479
	 *
5480
	 * @param array $properties
5481
	 * @return array amended properties.
5482
	 */
5483 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5484
		$tracking        = new Tracking();
5485
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5486
5487
		return array_merge(
5488
			$properties,
5489
			array(
5490
				'_ui' => $tracks_identity['_ui'],
5491
				'_ut' => $tracks_identity['_ut'],
5492
			)
5493
		);
5494
	}
5495
5496
	/**
5497
	 * Filters the token request body to include tracking properties.
5498
	 *
5499
	 * @param array $properties
5500
	 * @return array amended properties.
5501
	 */
5502 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5503
		$tracking        = new Tracking();
5504
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5505
5506
		return array_merge(
5507
			$properties,
5508
			array(
5509
				'_ui' => $tracks_identity['_ui'],
5510
				'_ut' => $tracks_identity['_ut'],
5511
			)
5512
		);
5513
	}
5514
5515
	/**
5516
	 * If the db version is showing something other that what we've got now, bump it to current.
5517
	 *
5518
	 * @return bool: True if the option was incorrect and updated, false if nothing happened.
0 ignored issues
show
Documentation introduced by
The doc-type bool: could not be parsed: Unknown type name "bool:" at position 0. (view supported doc-types)

This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.

Loading history...
5519
	 */
5520
	public static function maybe_set_version_option() {
5521
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5522
		if ( JETPACK__VERSION != $version ) {
5523
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5524
5525
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5526
				/** This action is documented in class.jetpack.php */
5527
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5528
			}
5529
5530
			return true;
5531
		}
5532
		return false;
5533
	}
5534
5535
	/* Client Server API */
5536
5537
	/**
5538
	 * Loads the Jetpack XML-RPC client.
5539
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5540
	 *
5541
	 * @deprecated since 7.7.0
5542
	 */
5543
	public static function load_xml_rpc_client() {
5544
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5545
	}
5546
5547
	/**
5548
	 * Resets the saved authentication state in between testing requests.
5549
	 */
5550
	public function reset_saved_auth_state() {
5551
		$this->rest_authentication_status = null;
5552
5553
		if ( ! $this->connection_manager ) {
5554
			$this->connection_manager = new Connection_Manager();
5555
		}
5556
5557
		$this->connection_manager->reset_saved_auth_state();
5558
	}
5559
5560
	/**
5561
	 * Verifies the signature of the current request.
5562
	 *
5563
	 * @deprecated since 7.7.0
5564
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5565
	 *
5566
	 * @return false|array
5567
	 */
5568
	public function verify_xml_rpc_signature() {
5569
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5570
		return self::connection()->verify_xml_rpc_signature();
5571
	}
5572
5573
	/**
5574
	 * Verifies the signature of the current request.
5575
	 *
5576
	 * This function has side effects and should not be used. Instead,
5577
	 * use the memoized version `->verify_xml_rpc_signature()`.
5578
	 *
5579
	 * @deprecated since 7.7.0
5580
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5581
	 * @internal
5582
	 */
5583
	private function internal_verify_xml_rpc_signature() {
5584
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5585
	}
5586
5587
	/**
5588
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5589
	 *
5590
	 * @deprecated since 7.7.0
5591
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5592
	 *
5593
	 * @param \WP_User|mixed $user     User object if authenticated.
5594
	 * @param string         $username Username.
5595
	 * @param string         $password Password string.
5596
	 * @return \WP_User|mixed Authenticated user or error.
5597
	 */
5598 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5599
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5600
5601
		if ( ! $this->connection_manager ) {
5602
			$this->connection_manager = new Connection_Manager();
5603
		}
5604
5605
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5606
	}
5607
5608
	// Authenticates requests from Jetpack server to WP REST API endpoints.
5609
	// Uses the existing XMLRPC request signing implementation.
5610
	function wp_rest_authenticate( $user ) {
5611
		if ( ! empty( $user ) ) {
5612
			// Another authentication method is in effect.
5613
			return $user;
5614
		}
5615
5616
		if ( ! isset( $_GET['_for'] ) || $_GET['_for'] !== 'jetpack' ) {
5617
			// Nothing to do for this authentication method.
5618
			return null;
5619
		}
5620
5621
		if ( ! isset( $_GET['token'] ) && ! isset( $_GET['signature'] ) ) {
5622
			// Nothing to do for this authentication method.
5623
			return null;
5624
		}
5625
5626
		// Ensure that we always have the request body available.  At this
5627
		// point, the WP REST API code to determine the request body has not
5628
		// run yet.  That code may try to read from 'php://input' later, but
5629
		// this can only be done once per request in PHP versions prior to 5.6.
5630
		// So we will go ahead and perform this read now if needed, and save
5631
		// the request body where both the Jetpack signature verification code
5632
		// and the WP REST API code can see it.
5633
		if ( ! isset( $GLOBALS['HTTP_RAW_POST_DATA'] ) ) {
5634
			$GLOBALS['HTTP_RAW_POST_DATA'] = file_get_contents( 'php://input' );
5635
		}
5636
		$this->HTTP_RAW_POST_DATA = $GLOBALS['HTTP_RAW_POST_DATA'];
5637
5638
		// Only support specific request parameters that have been tested and
5639
		// are known to work with signature verification.  A different method
5640
		// can be passed to the WP REST API via the '?_method=' parameter if
5641
		// needed.
5642
		if ( $_SERVER['REQUEST_METHOD'] !== 'GET' && $_SERVER['REQUEST_METHOD'] !== 'POST' ) {
5643
			$this->rest_authentication_status = new WP_Error(
5644
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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

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

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

Loading history...
5645
				__( 'This request method is not supported.', 'jetpack' ),
5646
				array( 'status' => 400 )
5647
			);
5648
			return null;
5649
		}
5650
		if ( $_SERVER['REQUEST_METHOD'] !== 'POST' && ! empty( $this->HTTP_RAW_POST_DATA ) ) {
5651
			$this->rest_authentication_status = new WP_Error(
5652
				'rest_invalid_request',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_request'.

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

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

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

Loading history...
5653
				__( 'This request method does not support body parameters.', 'jetpack' ),
5654
				array( 'status' => 400 )
5655
			);
5656
			return null;
5657
		}
5658
5659
		if ( ! $this->connection_manager ) {
5660
			$this->connection_manager = new Connection_Manager();
5661
		}
5662
5663
		$verified = $this->connection_manager->verify_xml_rpc_signature();
5664
5665
		if (
5666
			$verified &&
5667
			isset( $verified['type'] ) &&
5668
			'user' === $verified['type'] &&
5669
			! empty( $verified['user_id'] )
5670
		) {
5671
			// Authentication successful.
5672
			$this->rest_authentication_status = true;
5673
			return $verified['user_id'];
5674
		}
5675
5676
		// Something else went wrong.  Probably a signature error.
5677
		$this->rest_authentication_status = new WP_Error(
5678
			'rest_invalid_signature',
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'rest_invalid_signature'.

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

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

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

Loading history...
5679
			__( 'The request is not signed correctly.', 'jetpack' ),
5680
			array( 'status' => 400 )
5681
		);
5682
		return null;
5683
	}
5684
5685
	/**
5686
	 * Report authentication status to the WP REST API.
5687
	 *
5688
	 * @param  WP_Error|mixed $result Error from another authentication handler, null if we should handle it, or another value if not
0 ignored issues
show
Bug introduced by
There is no parameter named $result. Was it maybe removed?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.

Consider the following example. The parameter $italy is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was removed, but the annotation was not.

Loading history...
5689
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5690
	 */
5691
	public function wp_rest_authentication_errors( $value ) {
5692
		if ( $value !== null ) {
5693
			return $value;
5694
		}
5695
		return $this->rest_authentication_status;
5696
	}
5697
5698
	/**
5699
	 * Add our nonce to this request.
5700
	 *
5701
	 * @deprecated since 7.7.0
5702
	 * @see Automattic\Jetpack\Connection\Manager::add_nonce()
5703
	 *
5704
	 * @param int    $timestamp Timestamp of the request.
5705
	 * @param string $nonce     Nonce string.
5706
	 */
5707 View Code Duplication
	public function add_nonce( $timestamp, $nonce ) {
5708
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::add_nonce' );
5709
5710
		if ( ! $this->connection_manager ) {
5711
			$this->connection_manager = new Connection_Manager();
5712
		}
5713
5714
		return $this->connection_manager->add_nonce( $timestamp, $nonce );
5715
	}
5716
5717
	/**
5718
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5719
	 * Capture it here so we can verify the signature later.
5720
	 *
5721
	 * @deprecated since 7.7.0
5722
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5723
	 *
5724
	 * @param array $methods XMLRPC methods.
5725
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5726
	 */
5727 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5728
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5729
5730
		if ( ! $this->connection_manager ) {
5731
			$this->connection_manager = new Connection_Manager();
5732
		}
5733
5734
		return $this->connection_manager->xmlrpc_methods( $methods );
5735
	}
5736
5737
	/**
5738
	 * Register additional public XMLRPC methods.
5739
	 *
5740
	 * @deprecated since 7.7.0
5741
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5742
	 *
5743
	 * @param array $methods Public XMLRPC methods.
5744
	 * @return array Public XMLRPC methods, with the getOptions one.
5745
	 */
5746 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5747
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5748
5749
		if ( ! $this->connection_manager ) {
5750
			$this->connection_manager = new Connection_Manager();
5751
		}
5752
5753
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5754
	}
5755
5756
	/**
5757
	 * Handles a getOptions XMLRPC method call.
5758
	 *
5759
	 * @deprecated since 7.7.0
5760
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5761
	 *
5762
	 * @param array $args method call arguments.
5763
	 * @return array an amended XMLRPC server options array.
5764
	 */
5765 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5766
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5767
5768
		if ( ! $this->connection_manager ) {
5769
			$this->connection_manager = new Connection_Manager();
5770
		}
5771
5772
		return $this->connection_manager->jetpack_getOptions( $args );
0 ignored issues
show
Bug introduced by
The method jetpack_getOptions() does not exist on Automattic\Jetpack\Connection\Manager. Did you maybe mean jetpack_get_options()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
5773
	}
5774
5775
	/**
5776
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5777
	 *
5778
	 * @deprecated since 7.7.0
5779
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5780
	 *
5781
	 * @param array $options Standard Core options.
5782
	 * @return array Amended options.
5783
	 */
5784 View Code Duplication
	public function xmlrpc_options( $options ) {
5785
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5786
5787
		if ( ! $this->connection_manager ) {
5788
			$this->connection_manager = new Connection_Manager();
5789
		}
5790
5791
		return $this->connection_manager->xmlrpc_options( $options );
5792
	}
5793
5794
	/**
5795
	 * Cleans nonces that were saved when calling ::add_nonce.
5796
	 *
5797
	 * @deprecated since 7.7.0
5798
	 * @see Automattic\Jetpack\Connection\Manager::clean_nonces()
5799
	 *
5800
	 * @param bool $all whether to clean even non-expired nonces.
5801
	 */
5802
	public static function clean_nonces( $all = false ) {
5803
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::clean_nonces' );
5804
		return self::connection()->clean_nonces( $all );
5805
	}
5806
5807
	/**
5808
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5809
	 * SET: state( $key, $value );
5810
	 * GET: $value = state( $key );
5811
	 *
5812
	 * @param string $key
0 ignored issues
show
Documentation introduced by
Should the type for parameter $key not be string|null?

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

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

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

Loading history...
5813
	 * @param string $value
0 ignored issues
show
Documentation introduced by
Should the type for parameter $value not be string|null?

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

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

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

Loading history...
5814
	 * @param bool   $restate private
5815
	 */
5816
	public static function state( $key = null, $value = null, $restate = false ) {
5817
		static $state = array();
5818
		static $path, $domain;
5819
		if ( ! isset( $path ) ) {
5820
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5821
			$admin_url = self::admin_url();
5822
			$bits      = wp_parse_url( $admin_url );
5823
5824
			if ( is_array( $bits ) ) {
5825
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5826
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5827
			} else {
5828
				$path = $domain = null;
5829
			}
5830
		}
5831
5832
		// Extract state from cookies and delete cookies
5833
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5834
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5835
			unset( $_COOKIE['jetpackState'] );
5836
			foreach ( $yum as $k => $v ) {
5837
				if ( strlen( $v ) ) {
5838
					$state[ $k ] = $v;
5839
				}
5840
				setcookie( "jetpackState[$k]", false, 0, $path, $domain );
5841
			}
5842
		}
5843
5844
		if ( $restate ) {
5845
			foreach ( $state as $k => $v ) {
5846
				setcookie( "jetpackState[$k]", $v, 0, $path, $domain );
5847
			}
5848
			return;
5849
		}
5850
5851
		// Get a state variable.
5852
		if ( isset( $key ) && ! isset( $value ) ) {
5853
			if ( array_key_exists( $key, $state ) ) {
5854
				return $state[ $key ];
5855
			}
5856
			return null;
5857
		}
5858
5859
		// Set a state variable.
5860
		if ( isset( $key ) && isset( $value ) ) {
5861
			if ( is_array( $value ) && isset( $value[0] ) ) {
5862
				$value = $value[0];
5863
			}
5864
			$state[ $key ] = $value;
5865
			if ( ! headers_sent() ) {
5866
				if ( self::should_set_cookie( $key ) ) {
5867
					setcookie( "jetpackState[$key]", $value, 0, $path, $domain );
5868
				}
5869
			}
5870
		}
5871
	}
5872
5873
	public static function restate() {
5874
		self::state( null, null, true );
5875
	}
5876
5877
	/**
5878
	 * Determines whether the jetpackState[$key] value should be added to the
5879
	 * cookie.
5880
	 *
5881
	 * @param string $key The state key.
5882
	 *
5883
	 * @return boolean Whether the value should be added to the cookie.
5884
	 */
5885
	public static function should_set_cookie( $key ) {
5886
		global $current_screen;
5887
		$page = isset( $current_screen->base ) ? $current_screen->base : null;
5888
5889
		if ( 'toplevel_page_jetpack' === $page && 'display_update_modal' === $key ) {
5890
			return false;
5891
		}
5892
5893
		return true;
5894
	}
5895
5896
	public static function check_privacy( $file ) {
5897
		static $is_site_publicly_accessible = null;
5898
5899
		if ( is_null( $is_site_publicly_accessible ) ) {
5900
			$is_site_publicly_accessible = false;
5901
5902
			$rpc = new Jetpack_IXR_Client();
5903
5904
			$success = $rpc->query( 'jetpack.isSitePubliclyAccessible', home_url() );
5905
			if ( $success ) {
5906
				$response = $rpc->getResponse();
5907
				if ( $response ) {
5908
					$is_site_publicly_accessible = true;
5909
				}
5910
			}
5911
5912
			Jetpack_Options::update_option( 'public', (int) $is_site_publicly_accessible );
5913
		}
5914
5915
		if ( $is_site_publicly_accessible ) {
5916
			return;
5917
		}
5918
5919
		$module_slug = self::get_module_slug( $file );
5920
5921
		$privacy_checks = self::state( 'privacy_checks' );
5922
		if ( ! $privacy_checks ) {
5923
			$privacy_checks = $module_slug;
5924
		} else {
5925
			$privacy_checks .= ",$module_slug";
5926
		}
5927
5928
		self::state( 'privacy_checks', $privacy_checks );
5929
	}
5930
5931
	/**
5932
	 * Helper method for multicall XMLRPC.
5933
	 *
5934
	 * @param ...$args Args for the async_call.
5935
	 */
5936
	public static function xmlrpc_async_call( ...$args ) {
5937
		global $blog_id;
5938
		static $clients = array();
5939
5940
		$client_blog_id = is_multisite() ? $blog_id : 0;
5941
5942
		if ( ! isset( $clients[ $client_blog_id ] ) ) {
5943
			$clients[ $client_blog_id ] = new Jetpack_IXR_ClientMulticall( array( 'user_id' => JETPACK_MASTER_USER ) );
5944
			if ( function_exists( 'ignore_user_abort' ) ) {
5945
				ignore_user_abort( true );
5946
			}
5947
			add_action( 'shutdown', array( 'Jetpack', 'xmlrpc_async_call' ) );
5948
		}
5949
5950
		if ( ! empty( $args[0] ) ) {
5951
			call_user_func_array( array( $clients[ $client_blog_id ], 'addCall' ), $args );
5952
		} elseif ( is_multisite() ) {
5953
			foreach ( $clients as $client_blog_id => $client ) {
5954
				if ( ! $client_blog_id || empty( $client->calls ) ) {
5955
					continue;
5956
				}
5957
5958
				$switch_success = switch_to_blog( $client_blog_id, true );
5959
				if ( ! $switch_success ) {
5960
					continue;
5961
				}
5962
5963
				flush();
5964
				$client->query();
5965
5966
				restore_current_blog();
5967
			}
5968
		} else {
5969
			if ( isset( $clients[0] ) && ! empty( $clients[0]->calls ) ) {
5970
				flush();
5971
				$clients[0]->query();
5972
			}
5973
		}
5974
	}
5975
5976
	public static function staticize_subdomain( $url ) {
5977
5978
		// Extract hostname from URL
5979
		$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...
5980
5981
		// Explode hostname on '.'
5982
		$exploded_host = explode( '.', $host );
5983
5984
		// Retrieve the name and TLD
5985
		if ( count( $exploded_host ) > 1 ) {
5986
			$name = $exploded_host[ count( $exploded_host ) - 2 ];
5987
			$tld  = $exploded_host[ count( $exploded_host ) - 1 ];
5988
			// Rebuild domain excluding subdomains
5989
			$domain = $name . '.' . $tld;
5990
		} else {
5991
			$domain = $host;
5992
		}
5993
		// Array of Automattic domains.
5994
		$domains_allowed = array( 'wordpress.com', 'wp.com' );
5995
5996
		// Return $url if not an Automattic domain.
5997
		if ( ! in_array( $domain, $domains_allowed, true ) ) {
5998
			return $url;
5999
		}
6000
6001
		if ( is_ssl() ) {
6002
			return preg_replace( '|https?://[^/]++/|', 'https://s-ssl.wordpress.com/', $url );
6003
		}
6004
6005
		srand( crc32( basename( $url ) ) );
6006
		$static_counter = rand( 0, 2 );
6007
		srand(); // this resets everything that relies on this, like array_rand() and shuffle()
6008
6009
		return preg_replace( '|://[^/]+?/|', "://s$static_counter.wp.com/", $url );
6010
	}
6011
6012
	/* JSON API Authorization */
6013
6014
	/**
6015
	 * Handles the login action for Authorizing the JSON API
6016
	 */
6017
	function login_form_json_api_authorization() {
6018
		$this->verify_json_api_authorization_request();
6019
6020
		add_action( 'wp_login', array( &$this, 'store_json_api_authorization_token' ), 10, 2 );
6021
6022
		add_action( 'login_message', array( &$this, 'login_message_json_api_authorization' ) );
6023
		add_action( 'login_form', array( &$this, 'preserve_action_in_login_form_for_json_api_authorization' ) );
6024
		add_filter( 'site_url', array( &$this, 'post_login_form_to_signed_url' ), 10, 3 );
6025
	}
6026
6027
	// Make sure the login form is POSTed to the signed URL so we can reverify the request
6028
	function post_login_form_to_signed_url( $url, $path, $scheme ) {
6029
		if ( 'wp-login.php' !== $path || ( 'login_post' !== $scheme && 'login' !== $scheme ) ) {
6030
			return $url;
6031
		}
6032
6033
		$parsed_url = wp_parse_url( $url );
6034
		$url        = strtok( $url, '?' );
6035
		$url        = "$url?{$_SERVER['QUERY_STRING']}";
6036
		if ( ! empty( $parsed_url['query'] ) ) {
6037
			$url .= "&{$parsed_url['query']}";
6038
		}
6039
6040
		return $url;
6041
	}
6042
6043
	// Make sure the POSTed request is handled by the same action
6044
	function preserve_action_in_login_form_for_json_api_authorization() {
6045
		echo "<input type='hidden' name='action' value='jetpack_json_api_authorization' />\n";
6046
		echo "<input type='hidden' name='jetpack_json_api_original_query' value='" . esc_url( set_url_scheme( $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) . "' />\n";
6047
	}
6048
6049
	// If someone logs in to approve API access, store the Access Code in usermeta
6050
	function store_json_api_authorization_token( $user_login, $user ) {
6051
		add_filter( 'login_redirect', array( &$this, 'add_token_to_login_redirect_json_api_authorization' ), 10, 3 );
6052
		add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_public_api_domain' ) );
6053
		$token = wp_generate_password( 32, false );
6054
		update_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], $token );
6055
	}
6056
6057
	// Add public-api.wordpress.com to the safe redirect allowed list - only added when someone allows API access.
6058
	function allow_wpcom_public_api_domain( $domains ) {
6059
		$domains[] = 'public-api.wordpress.com';
6060
		return $domains;
6061
	}
6062
6063
	static function is_redirect_encoded( $redirect_url ) {
6064
		return preg_match( '/https?%3A%2F%2F/i', $redirect_url ) > 0;
6065
	}
6066
6067
	// Add all wordpress.com environments to the safe redirect allowed list.
6068
	function allow_wpcom_environments( $domains ) {
6069
		$domains[] = 'wordpress.com';
6070
		$domains[] = 'wpcalypso.wordpress.com';
6071
		$domains[] = 'horizon.wordpress.com';
6072
		$domains[] = 'calypso.localhost';
6073
		return $domains;
6074
	}
6075
6076
	// Add the Access Code details to the public-api.wordpress.com redirect
6077
	function add_token_to_login_redirect_json_api_authorization( $redirect_to, $original_redirect_to, $user ) {
6078
		return add_query_arg(
6079
			urlencode_deep(
6080
				array(
6081
					'jetpack-code'    => get_user_meta( $user->ID, 'jetpack_json_api_' . $this->json_api_authorization_request['client_id'], true ),
6082
					'jetpack-user-id' => (int) $user->ID,
6083
					'jetpack-state'   => $this->json_api_authorization_request['state'],
6084
				)
6085
			),
6086
			$redirect_to
6087
		);
6088
	}
6089
6090
6091
	/**
6092
	 * Verifies the request by checking the signature
6093
	 *
6094
	 * @since 4.6.0 Method was updated to use `$_REQUEST` instead of `$_GET` and `$_POST`. Method also updated to allow
6095
	 * passing in an `$environment` argument that overrides `$_REQUEST`. This was useful for integrating with SSO.
6096
	 *
6097
	 * @param null|array $environment
6098
	 */
6099
	function verify_json_api_authorization_request( $environment = null ) {
6100
		$environment = is_null( $environment )
6101
			? $_REQUEST
6102
			: $environment;
6103
6104
		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...
6105
		$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...
6106
		if ( ! $token || empty( $token->secret ) ) {
6107
			wp_die( __( 'You must connect your Jetpack plugin to WordPress.com to use this feature.', 'jetpack' ) );
6108
		}
6109
6110
		$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' );
6111
6112
		// Host has encoded the request URL, probably as a result of a bad http => https redirect
6113
		if ( self::is_redirect_encoded( $_GET['redirect_to'] ) ) {
6114
			/**
6115
			 * Jetpack authorisation request Error.
6116
			 *
6117
			 * @since 7.5.0
6118
			 */
6119
			do_action( 'jetpack_verify_api_authorization_request_error_double_encode' );
6120
			$die_error = sprintf(
6121
				/* translators: %s is a URL */
6122
				__( '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' ),
6123
				Redirect::get_url( 'jetpack-support-double-encoding' )
6124
			);
6125
		}
6126
6127
		$jetpack_signature = new Jetpack_Signature( $token->secret, (int) Jetpack_Options::get_option( 'time_diff' ) );
6128
6129
		if ( isset( $environment['jetpack_json_api_original_query'] ) ) {
6130
			$signature = $jetpack_signature->sign_request(
6131
				$environment['token'],
6132
				$environment['timestamp'],
6133
				$environment['nonce'],
6134
				'',
6135
				'GET',
6136
				$environment['jetpack_json_api_original_query'],
6137
				null,
6138
				true
6139
			);
6140
		} else {
6141
			$signature = $jetpack_signature->sign_current_request(
6142
				array(
6143
					'body'   => null,
6144
					'method' => 'GET',
6145
				)
6146
			);
6147
		}
6148
6149
		if ( ! $signature ) {
6150
			wp_die( $die_error );
6151
		} elseif ( is_wp_error( $signature ) ) {
6152
			wp_die( $die_error );
6153
		} elseif ( ! hash_equals( $signature, $environment['signature'] ) ) {
6154
			if ( is_ssl() ) {
6155
				// 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
6156
				$signature = $jetpack_signature->sign_current_request(
6157
					array(
6158
						'scheme' => 'http',
6159
						'body'   => null,
6160
						'method' => 'GET',
6161
					)
6162
				);
6163
				if ( ! $signature || is_wp_error( $signature ) || ! hash_equals( $signature, $environment['signature'] ) ) {
6164
					wp_die( $die_error );
6165
				}
6166
			} else {
6167
				wp_die( $die_error );
6168
			}
6169
		}
6170
6171
		$timestamp = (int) $environment['timestamp'];
6172
		$nonce     = stripslashes( (string) $environment['nonce'] );
6173
6174
		if ( ! $this->connection_manager ) {
6175
			$this->connection_manager = new Connection_Manager();
6176
		}
6177
6178
		if ( ! $this->connection_manager->add_nonce( $timestamp, $nonce ) ) {
6179
			// De-nonce the nonce, at least for 5 minutes.
6180
			// 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)
6181
			$old_nonce_time = get_option( "jetpack_nonce_{$timestamp}_{$nonce}" );
6182
			if ( $old_nonce_time < time() - 300 ) {
6183
				wp_die( __( 'The authorization process expired.  Please go back and try again.', 'jetpack' ) );
6184
			}
6185
		}
6186
6187
		$data         = json_decode( base64_decode( stripslashes( $environment['data'] ) ) );
6188
		$data_filters = array(
6189
			'state'        => 'opaque',
6190
			'client_id'    => 'int',
6191
			'client_title' => 'string',
6192
			'client_image' => 'url',
6193
		);
6194
6195
		foreach ( $data_filters as $key => $sanitation ) {
6196
			if ( ! isset( $data->$key ) ) {
6197
				wp_die( $die_error );
6198
			}
6199
6200
			switch ( $sanitation ) {
6201
				case 'int':
6202
					$this->json_api_authorization_request[ $key ] = (int) $data->$key;
6203
					break;
6204
				case 'opaque':
6205
					$this->json_api_authorization_request[ $key ] = (string) $data->$key;
6206
					break;
6207
				case 'string':
6208
					$this->json_api_authorization_request[ $key ] = wp_kses( (string) $data->$key, array() );
6209
					break;
6210
				case 'url':
6211
					$this->json_api_authorization_request[ $key ] = esc_url_raw( (string) $data->$key );
6212
					break;
6213
			}
6214
		}
6215
6216
		if ( empty( $this->json_api_authorization_request['client_id'] ) ) {
6217
			wp_die( $die_error );
6218
		}
6219
	}
6220
6221
	function login_message_json_api_authorization( $message ) {
6222
		return '<p class="message">' . sprintf(
6223
			esc_html__( '%s wants to access your site&#8217;s data.  Log in to authorize that access.', 'jetpack' ),
6224
			'<strong>' . esc_html( $this->json_api_authorization_request['client_title'] ) . '</strong>'
6225
		) . '<img src="' . esc_url( $this->json_api_authorization_request['client_image'] ) . '" /></p>';
6226
	}
6227
6228
	/**
6229
	 * Get $content_width, but with a <s>twist</s> filter.
6230
	 */
6231
	public static function get_content_width() {
6232
		$content_width = ( isset( $GLOBALS['content_width'] ) && is_numeric( $GLOBALS['content_width'] ) )
6233
			? $GLOBALS['content_width']
6234
			: false;
6235
		/**
6236
		 * Filter the Content Width value.
6237
		 *
6238
		 * @since 2.2.3
6239
		 *
6240
		 * @param string $content_width Content Width value.
6241
		 */
6242
		return apply_filters( 'jetpack_content_width', $content_width );
6243
	}
6244
6245
	/**
6246
	 * Pings the WordPress.com Mirror Site for the specified options.
6247
	 *
6248
	 * @param string|array $option_names The option names to request from the WordPress.com Mirror Site
6249
	 *
6250
	 * @return array An associative array of the option values as stored in the WordPress.com Mirror Site
6251
	 */
6252
	public function get_cloud_site_options( $option_names ) {
6253
		$option_names = array_filter( (array) $option_names, 'is_string' );
6254
6255
		$xml = new Jetpack_IXR_Client( array( 'user_id' => JETPACK_MASTER_USER ) );
6256
		$xml->query( 'jetpack.fetchSiteOptions', $option_names );
6257
		if ( $xml->isError() ) {
6258
			return array(
6259
				'error_code' => $xml->getErrorCode(),
6260
				'error_msg'  => $xml->getErrorMessage(),
6261
			);
6262
		}
6263
		$cloud_site_options = $xml->getResponse();
6264
6265
		return $cloud_site_options;
6266
	}
6267
6268
	/**
6269
	 * Checks if the site is currently in an identity crisis.
6270
	 *
6271
	 * @return array|bool Array of options that are in a crisis, or false if everything is OK.
6272
	 */
6273
	public static function check_identity_crisis() {
6274
		if ( ! self::is_active() || ( new Status() )->is_development_mode() || ! self::validate_sync_error_idc_option() ) {
6275
			return false;
6276
		}
6277
6278
		return Jetpack_Options::get_option( 'sync_error_idc' );
6279
	}
6280
6281
	/**
6282
	 * Checks whether the home and siteurl specifically are allowed.
6283
	 * Written so that we don't have re-check $key and $value params every time
6284
	 * we want to check if this site is allowed, for example in footer.php
6285
	 *
6286
	 * @since  3.8.0
6287
	 * @return bool True = already allowed False = not on the allowed list.
6288
	 */
6289
	public static function is_staging_site() {
6290
		_deprecated_function( 'Jetpack::is_staging_site', 'jetpack-8.1', '/Automattic/Jetpack/Status->is_staging_site' );
6291
		return ( new Status() )->is_staging_site();
6292
	}
6293
6294
	/**
6295
	 * Checks whether the sync_error_idc option is valid or not, and if not, will do cleanup.
6296
	 *
6297
	 * @since 4.4.0
6298
	 * @since 5.4.0 Do not call get_sync_error_idc_option() unless site is in IDC
6299
	 *
6300
	 * @return bool
6301
	 */
6302
	public static function validate_sync_error_idc_option() {
6303
		$is_valid = false;
6304
6305
		$idc_allowed = get_transient( 'jetpack_idc_allowed' );
6306
		if ( false === $idc_allowed ) {
6307
			$response = wp_remote_get( 'https://jetpack.com/is-idc-allowed/' );
6308
			if ( 200 === (int) wp_remote_retrieve_response_code( $response ) ) {
6309
				$json               = json_decode( wp_remote_retrieve_body( $response ) );
6310
				$idc_allowed        = isset( $json, $json->result ) && $json->result ? '1' : '0';
6311
				$transient_duration = HOUR_IN_SECONDS;
6312
			} else {
6313
				// If the request failed for some reason, then assume IDC is allowed and set shorter transient.
6314
				$idc_allowed        = '1';
6315
				$transient_duration = 5 * MINUTE_IN_SECONDS;
6316
			}
6317
6318
			set_transient( 'jetpack_idc_allowed', $idc_allowed, $transient_duration );
6319
		}
6320
6321
		// Is the site opted in and does the stored sync_error_idc option match what we now generate?
6322
		$sync_error = Jetpack_Options::get_option( 'sync_error_idc' );
6323
		if ( $idc_allowed && $sync_error && self::sync_idc_optin() ) {
6324
			$local_options = self::get_sync_error_idc_option();
6325
			// Ensure all values are set.
6326
			if ( isset( $sync_error['home'] ) && isset( $local_options['home'] ) && isset( $sync_error['siteurl'] ) && isset( $local_options['siteurl'] ) ) {
6327
				if ( $sync_error['home'] === $local_options['home'] && $sync_error['siteurl'] === $local_options['siteurl'] ) {
6328
					$is_valid = true;
6329
				}
6330
			}
6331
		}
6332
6333
		/**
6334
		 * Filters whether the sync_error_idc option is valid.
6335
		 *
6336
		 * @since 4.4.0
6337
		 *
6338
		 * @param bool $is_valid If the sync_error_idc is valid or not.
6339
		 */
6340
		$is_valid = (bool) apply_filters( 'jetpack_sync_error_idc_validation', $is_valid );
6341
6342
		if ( ! $idc_allowed || ( ! $is_valid && $sync_error ) ) {
6343
			// Since the option exists, and did not validate, delete it
6344
			Jetpack_Options::delete_option( 'sync_error_idc' );
6345
		}
6346
6347
		return $is_valid;
6348
	}
6349
6350
	/**
6351
	 * Normalizes a url by doing three things:
6352
	 *  - Strips protocol
6353
	 *  - Strips www
6354
	 *  - Adds a trailing slash
6355
	 *
6356
	 * @since 4.4.0
6357
	 * @param string $url
6358
	 * @return WP_Error|string
6359
	 */
6360
	public static function normalize_url_protocol_agnostic( $url ) {
6361
		$parsed_url = wp_parse_url( trailingslashit( esc_url_raw( $url ) ) );
6362
		if ( ! $parsed_url || empty( $parsed_url['host'] ) || empty( $parsed_url['path'] ) ) {
6363
			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...
6364
		}
6365
6366
		// Strip www and protocols
6367
		$url = preg_replace( '/^www\./i', '', $parsed_url['host'] . $parsed_url['path'] );
6368
		return $url;
6369
	}
6370
6371
	/**
6372
	 * Gets the value that is to be saved in the jetpack_sync_error_idc option.
6373
	 *
6374
	 * @since 4.4.0
6375
	 * @since 5.4.0 Add transient since home/siteurl retrieved directly from DB
6376
	 *
6377
	 * @param array $response
6378
	 * @return array Array of the local urls, wpcom urls, and error code
6379
	 */
6380
	public static function get_sync_error_idc_option( $response = array() ) {
6381
		// Since the local options will hit the database directly, store the values
6382
		// in a transient to allow for autoloading and caching on subsequent views.
6383
		$local_options = get_transient( 'jetpack_idc_local' );
6384
		if ( false === $local_options ) {
6385
			$local_options = array(
6386
				'home'    => Functions::home_url(),
6387
				'siteurl' => Functions::site_url(),
6388
			);
6389
			set_transient( 'jetpack_idc_local', $local_options, MINUTE_IN_SECONDS );
6390
		}
6391
6392
		$options = array_merge( $local_options, $response );
6393
6394
		$returned_values = array();
6395
		foreach ( $options as $key => $option ) {
6396
			if ( 'error_code' === $key ) {
6397
				$returned_values[ $key ] = $option;
6398
				continue;
6399
			}
6400
6401
			if ( is_wp_error( $normalized_url = self::normalize_url_protocol_agnostic( $option ) ) ) {
6402
				continue;
6403
			}
6404
6405
			$returned_values[ $key ] = $normalized_url;
6406
		}
6407
6408
		set_transient( 'jetpack_idc_option', $returned_values, MINUTE_IN_SECONDS );
6409
6410
		return $returned_values;
6411
	}
6412
6413
	/**
6414
	 * Returns the value of the jetpack_sync_idc_optin filter, or constant.
6415
	 * If set to true, the site will be put into staging mode.
6416
	 *
6417
	 * @since 4.3.2
6418
	 * @return bool
6419
	 */
6420
	public static function sync_idc_optin() {
6421
		if ( Constants::is_defined( 'JETPACK_SYNC_IDC_OPTIN' ) ) {
6422
			$default = Constants::get_constant( 'JETPACK_SYNC_IDC_OPTIN' );
6423
		} else {
6424
			$default = ! Constants::is_defined( 'SUNRISE' ) && ! is_multisite();
6425
		}
6426
6427
		/**
6428
		 * Allows sites to opt in to IDC mitigation which blocks the site from syncing to WordPress.com when the home
6429
		 * URL or site URL do not match what WordPress.com expects. The default value is either false, or the value of
6430
		 * JETPACK_SYNC_IDC_OPTIN constant if set.
6431
		 *
6432
		 * @since 4.3.2
6433
		 *
6434
		 * @param bool $default Whether the site is opted in to IDC mitigation.
6435
		 */
6436
		return (bool) apply_filters( 'jetpack_sync_idc_optin', $default );
6437
	}
6438
6439
	/**
6440
	 * Maybe Use a .min.css stylesheet, maybe not.
6441
	 *
6442
	 * Hooks onto `plugins_url` filter at priority 1, and accepts all 3 args.
6443
	 */
6444
	public static function maybe_min_asset( $url, $path, $plugin ) {
6445
		// Short out on things trying to find actual paths.
6446
		if ( ! $path || empty( $plugin ) ) {
6447
			return $url;
6448
		}
6449
6450
		$path = ltrim( $path, '/' );
6451
6452
		// Strip out the abspath.
6453
		$base = dirname( plugin_basename( $plugin ) );
6454
6455
		// Short out on non-Jetpack assets.
6456
		if ( 'jetpack/' !== substr( $base, 0, 8 ) ) {
6457
			return $url;
6458
		}
6459
6460
		// File name parsing.
6461
		$file              = "{$base}/{$path}";
6462
		$full_path         = JETPACK__PLUGIN_DIR . substr( $file, 8 );
6463
		$file_name         = substr( $full_path, strrpos( $full_path, '/' ) + 1 );
6464
		$file_name_parts_r = array_reverse( explode( '.', $file_name ) );
6465
		$extension         = array_shift( $file_name_parts_r );
6466
6467
		if ( in_array( strtolower( $extension ), array( 'css', 'js' ) ) ) {
6468
			// Already pointing at the minified version.
6469
			if ( 'min' === $file_name_parts_r[0] ) {
6470
				return $url;
6471
			}
6472
6473
			$min_full_path = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $full_path );
6474
			if ( file_exists( $min_full_path ) ) {
6475
				$url = preg_replace( "#\.{$extension}$#", ".min.{$extension}", $url );
6476
				// If it's a CSS file, stash it so we can set the .min suffix for rtl-ing.
6477
				if ( 'css' === $extension ) {
6478
					$key                      = str_replace( JETPACK__PLUGIN_DIR, 'jetpack/', $min_full_path );
6479
					self::$min_assets[ $key ] = $path;
6480
				}
6481
			}
6482
		}
6483
6484
		return $url;
6485
	}
6486
6487
	/**
6488
	 * If the asset is minified, let's flag .min as the suffix.
6489
	 *
6490
	 * Attached to `style_loader_src` filter.
6491
	 *
6492
	 * @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...
6493
	 * @param string $handle The registered handle of the script in question.
6494
	 * @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...
6495
	 */
6496
	public static function set_suffix_on_min( $src, $handle ) {
6497
		if ( false === strpos( $src, '.min.css' ) ) {
6498
			return $src;
6499
		}
6500
6501
		if ( ! empty( self::$min_assets ) ) {
6502
			foreach ( self::$min_assets as $file => $path ) {
6503
				if ( false !== strpos( $src, $file ) ) {
6504
					wp_style_add_data( $handle, 'suffix', '.min' );
6505
					return $src;
6506
				}
6507
			}
6508
		}
6509
6510
		return $src;
6511
	}
6512
6513
	/**
6514
	 * Maybe inlines a stylesheet.
6515
	 *
6516
	 * If you'd like to inline a stylesheet instead of printing a link to it,
6517
	 * wp_style_add_data( 'handle', 'jetpack-inline', true );
6518
	 *
6519
	 * Attached to `style_loader_tag` filter.
6520
	 *
6521
	 * @param string $tag The tag that would link to the external asset.
6522
	 * @param string $handle The registered handle of the script in question.
6523
	 *
6524
	 * @return string
6525
	 */
6526
	public static function maybe_inline_style( $tag, $handle ) {
6527
		global $wp_styles;
6528
		$item = $wp_styles->registered[ $handle ];
6529
6530
		if ( ! isset( $item->extra['jetpack-inline'] ) || ! $item->extra['jetpack-inline'] ) {
6531
			return $tag;
6532
		}
6533
6534
		if ( preg_match( '# href=\'([^\']+)\' #i', $tag, $matches ) ) {
6535
			$href = $matches[1];
6536
			// Strip off query string
6537
			if ( $pos = strpos( $href, '?' ) ) {
6538
				$href = substr( $href, 0, $pos );
6539
			}
6540
			// Strip off fragment
6541
			if ( $pos = strpos( $href, '#' ) ) {
6542
				$href = substr( $href, 0, $pos );
6543
			}
6544
		} else {
6545
			return $tag;
6546
		}
6547
6548
		$plugins_dir = plugin_dir_url( JETPACK__PLUGIN_FILE );
6549
		if ( $plugins_dir !== substr( $href, 0, strlen( $plugins_dir ) ) ) {
6550
			return $tag;
6551
		}
6552
6553
		// If this stylesheet has a RTL version, and the RTL version replaces normal...
6554
		if ( isset( $item->extra['rtl'] ) && 'replace' === $item->extra['rtl'] && is_rtl() ) {
6555
			// And this isn't the pass that actually deals with the RTL version...
6556
			if ( false === strpos( $tag, " id='$handle-rtl-css' " ) ) {
6557
				// Short out, as the RTL version will deal with it in a moment.
6558
				return $tag;
6559
			}
6560
		}
6561
6562
		$file = JETPACK__PLUGIN_DIR . substr( $href, strlen( $plugins_dir ) );
6563
		$css  = self::absolutize_css_urls( file_get_contents( $file ), $href );
6564
		if ( $css ) {
6565
			$tag = "<!-- Inline {$item->handle} -->\r\n";
6566
			if ( empty( $item->extra['after'] ) ) {
6567
				wp_add_inline_style( $handle, $css );
6568
			} else {
6569
				array_unshift( $item->extra['after'], $css );
6570
				wp_style_add_data( $handle, 'after', $item->extra['after'] );
6571
			}
6572
		}
6573
6574
		return $tag;
6575
	}
6576
6577
	/**
6578
	 * Loads a view file from the views
6579
	 *
6580
	 * Data passed in with the $data parameter will be available in the
6581
	 * template file as $data['value']
6582
	 *
6583
	 * @param string $template - Template file to load
6584
	 * @param array  $data - Any data to pass along to the template
6585
	 * @return boolean - If template file was found
6586
	 **/
6587
	public function load_view( $template, $data = array() ) {
6588
		$views_dir = JETPACK__PLUGIN_DIR . 'views/';
6589
6590
		if ( file_exists( $views_dir . $template ) ) {
6591
			require_once $views_dir . $template;
6592
			return true;
6593
		}
6594
6595
		error_log( "Jetpack: Unable to find view file $views_dir$template" );
6596
		return false;
6597
	}
6598
6599
	/**
6600
	 * Throws warnings for deprecated hooks to be removed from Jetpack
6601
	 */
6602
	public function deprecated_hooks() {
6603
		global $wp_filter;
6604
6605
		/*
6606
		 * Format:
6607
		 * deprecated_filter_name => replacement_name
6608
		 *
6609
		 * If there is no replacement, use null for replacement_name
6610
		 */
6611
		$deprecated_list = array(
6612
			'jetpack_bail_on_shortcode'                    => 'jetpack_shortcodes_to_include',
6613
			'wpl_sharing_2014_1'                           => null,
6614
			'jetpack-tools-to-include'                     => 'jetpack_tools_to_include',
6615
			'jetpack_identity_crisis_options_to_check'     => null,
6616
			'update_option_jetpack_single_user_site'       => null,
6617
			'audio_player_default_colors'                  => null,
6618
			'add_option_jetpack_featured_images_enabled'   => null,
6619
			'add_option_jetpack_update_details'            => null,
6620
			'add_option_jetpack_updates'                   => null,
6621
			'add_option_jetpack_network_name'              => null,
6622
			'add_option_jetpack_network_allow_new_registrations' => null,
6623
			'add_option_jetpack_network_add_new_users'     => null,
6624
			'add_option_jetpack_network_site_upload_space' => null,
6625
			'add_option_jetpack_network_upload_file_types' => null,
6626
			'add_option_jetpack_network_enable_administration_menus' => null,
6627
			'add_option_jetpack_is_multi_site'             => null,
6628
			'add_option_jetpack_is_main_network'           => null,
6629
			'add_option_jetpack_main_network_site'         => null,
6630
			'jetpack_sync_all_registered_options'          => null,
6631
			'jetpack_has_identity_crisis'                  => 'jetpack_sync_error_idc_validation',
6632
			'jetpack_is_post_mailable'                     => null,
6633
			'jetpack_seo_site_host'                        => null,
6634
			'jetpack_installed_plugin'                     => 'jetpack_plugin_installed',
6635
			'jetpack_holiday_snow_option_name'             => null,
6636
			'jetpack_holiday_chance_of_snow'               => null,
6637
			'jetpack_holiday_snow_js_url'                  => null,
6638
			'jetpack_is_holiday_snow_season'               => null,
6639
			'jetpack_holiday_snow_option_updated'          => null,
6640
			'jetpack_holiday_snowing'                      => null,
6641
			'jetpack_sso_auth_cookie_expirtation'          => 'jetpack_sso_auth_cookie_expiration',
6642
			'jetpack_cache_plans'                          => null,
6643
			'jetpack_updated_theme'                        => 'jetpack_updated_themes',
6644
			'jetpack_lazy_images_skip_image_with_atttributes' => 'jetpack_lazy_images_skip_image_with_attributes',
6645
			'jetpack_enable_site_verification'             => null,
6646
			'can_display_jetpack_manage_notice'            => null,
6647
			// Removed in Jetpack 7.3.0
6648
			'atd_load_scripts'                             => null,
6649
			'atd_http_post_timeout'                        => null,
6650
			'atd_http_post_error'                          => null,
6651
			'atd_service_domain'                           => null,
6652
			'jetpack_widget_authors_exclude'               => 'jetpack_widget_authors_params',
6653
			// Removed in Jetpack 7.9.0
6654
			'jetpack_pwa_manifest'                         => null,
6655
			'jetpack_pwa_background_color'                 => null,
6656
			// Removed in Jetpack 8.3.0.
6657
			'jetpack_check_mobile'                         => null,
6658
			'jetpack_mobile_stylesheet'                    => null,
6659
			'jetpack_mobile_template'                      => null,
6660
			'mobile_reject_mobile'                         => null,
6661
			'mobile_force_mobile'                          => null,
6662
			'mobile_app_promo_download'                    => null,
6663
			'mobile_setup'                                 => null,
6664
			'jetpack_mobile_footer_before'                 => null,
6665
			'wp_mobile_theme_footer'                       => null,
6666
			'minileven_credits'                            => null,
6667
			'jetpack_mobile_header_before'                 => null,
6668
			'jetpack_mobile_header_after'                  => null,
6669
			'jetpack_mobile_theme_menu'                    => null,
6670
			'minileven_show_featured_images'               => null,
6671
			'minileven_attachment_size'                    => null,
6672
		);
6673
6674
		// This is a silly loop depth. Better way?
6675
		foreach ( $deprecated_list as $hook => $hook_alt ) {
6676
			if ( has_action( $hook ) ) {
6677
				foreach ( $wp_filter[ $hook ] as $func => $values ) {
6678
					foreach ( $values as $hooked ) {
6679
						if ( is_callable( $hooked['function'] ) ) {
6680
							$function_name = $hooked['function'];
6681
						} else {
6682
							$function_name = 'an anonymous function';
6683
						}
6684
						_deprecated_function( $hook . ' used for ' . $function_name, null, $hook_alt );
6685
					}
6686
				}
6687
			}
6688
		}
6689
	}
6690
6691
	/**
6692
	 * Converts any url in a stylesheet, to the correct absolute url.
6693
	 *
6694
	 * Considerations:
6695
	 *  - Normal, relative URLs     `feh.png`
6696
	 *  - Data URLs                 `data:image/gif;base64,eh129ehiuehjdhsa==`
6697
	 *  - Schema-agnostic URLs      `//domain.com/feh.png`
6698
	 *  - Absolute URLs             `http://domain.com/feh.png`
6699
	 *  - Domain root relative URLs `/feh.png`
6700
	 *
6701
	 * @param $css string: The raw CSS -- should be read in directly from the file.
6702
	 * @param $css_file_url : The URL that the file can be accessed at, for calculating paths from.
6703
	 *
6704
	 * @return mixed|string
6705
	 */
6706
	public static function absolutize_css_urls( $css, $css_file_url ) {
6707
		$pattern = '#url\((?P<path>[^)]*)\)#i';
6708
		$css_dir = dirname( $css_file_url );
6709
		$p       = wp_parse_url( $css_dir );
6710
		$domain  = sprintf(
6711
			'%1$s//%2$s%3$s%4$s',
6712
			isset( $p['scheme'] ) ? "{$p['scheme']}:" : '',
6713
			isset( $p['user'], $p['pass'] ) ? "{$p['user']}:{$p['pass']}@" : '',
6714
			$p['host'],
6715
			isset( $p['port'] ) ? ":{$p['port']}" : ''
6716
		);
6717
6718
		if ( preg_match_all( $pattern, $css, $matches, PREG_SET_ORDER ) ) {
6719
			$find = $replace = array();
6720
			foreach ( $matches as $match ) {
6721
				$url = trim( $match['path'], "'\" \t" );
6722
6723
				// If this is a data url, we don't want to mess with it.
6724
				if ( 'data:' === substr( $url, 0, 5 ) ) {
6725
					continue;
6726
				}
6727
6728
				// If this is an absolute or protocol-agnostic url,
6729
				// we don't want to mess with it.
6730
				if ( preg_match( '#^(https?:)?//#i', $url ) ) {
6731
					continue;
6732
				}
6733
6734
				switch ( substr( $url, 0, 1 ) ) {
6735
					case '/':
6736
						$absolute = $domain . $url;
6737
						break;
6738
					default:
6739
						$absolute = $css_dir . '/' . $url;
6740
				}
6741
6742
				$find[]    = $match[0];
6743
				$replace[] = sprintf( 'url("%s")', $absolute );
6744
			}
6745
			$css = str_replace( $find, $replace, $css );
6746
		}
6747
6748
		return $css;
6749
	}
6750
6751
	/**
6752
	 * This methods removes all of the registered css files on the front end
6753
	 * from Jetpack in favor of using a single file. In effect "imploding"
6754
	 * all the files into one file.
6755
	 *
6756
	 * Pros:
6757
	 * - Uses only ONE css asset connection instead of 15
6758
	 * - Saves a minimum of 56k
6759
	 * - Reduces server load
6760
	 * - Reduces time to first painted byte
6761
	 *
6762
	 * Cons:
6763
	 * - Loads css for ALL modules. However all selectors are prefixed so it
6764
	 *      should not cause any issues with themes.
6765
	 * - Plugins/themes dequeuing styles no longer do anything. See
6766
	 *      jetpack_implode_frontend_css filter for a workaround
6767
	 *
6768
	 * For some situations developers may wish to disable css imploding and
6769
	 * instead operate in legacy mode where each file loads seperately and
6770
	 * can be edited individually or dequeued. This can be accomplished with
6771
	 * the following line:
6772
	 *
6773
	 * add_filter( 'jetpack_implode_frontend_css', '__return_false' );
6774
	 *
6775
	 * @since 3.2
6776
	 **/
6777
	public function implode_frontend_css( $travis_test = false ) {
6778
		$do_implode = true;
6779
		if ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) {
6780
			$do_implode = false;
6781
		}
6782
6783
		// Do not implode CSS when the page loads via the AMP plugin.
6784
		if ( Jetpack_AMP_Support::is_amp_request() ) {
6785
			$do_implode = false;
6786
		}
6787
6788
		/**
6789
		 * Allow CSS to be concatenated into a single jetpack.css file.
6790
		 *
6791
		 * @since 3.2.0
6792
		 *
6793
		 * @param bool $do_implode Should CSS be concatenated? Default to true.
6794
		 */
6795
		$do_implode = apply_filters( 'jetpack_implode_frontend_css', $do_implode );
6796
6797
		// Do not use the imploded file when default behavior was altered through the filter
6798
		if ( ! $do_implode ) {
6799
			return;
6800
		}
6801
6802
		// We do not want to use the imploded file in dev mode, or if not connected
6803
		if ( ( new Status() )->is_development_mode() || ! self::is_active() ) {
6804
			if ( ! $travis_test ) {
6805
				return;
6806
			}
6807
		}
6808
6809
		// Do not use the imploded file if sharing css was dequeued via the sharing settings screen
6810
		if ( get_option( 'sharedaddy_disable_resources' ) ) {
6811
			return;
6812
		}
6813
6814
		/*
6815
		 * Now we assume Jetpack is connected and able to serve the single
6816
		 * file.
6817
		 *
6818
		 * In the future there will be a check here to serve the file locally
6819
		 * or potentially from the Jetpack CDN
6820
		 *
6821
		 * For now:
6822
		 * - Enqueue a single imploded css file
6823
		 * - Zero out the style_loader_tag for the bundled ones
6824
		 * - Be happy, drink scotch
6825
		 */
6826
6827
		add_filter( 'style_loader_tag', array( $this, 'concat_remove_style_loader_tag' ), 10, 2 );
6828
6829
		$version = self::is_development_version() ? filemtime( JETPACK__PLUGIN_DIR . 'css/jetpack.css' ) : JETPACK__VERSION;
6830
6831
		wp_enqueue_style( 'jetpack_css', plugins_url( 'css/jetpack.css', __FILE__ ), array(), $version );
6832
		wp_style_add_data( 'jetpack_css', 'rtl', 'replace' );
6833
	}
6834
6835
	function concat_remove_style_loader_tag( $tag, $handle ) {
6836
		if ( in_array( $handle, $this->concatenated_style_handles ) ) {
6837
			$tag = '';
6838
			if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
6839
				$tag = '<!-- `' . esc_html( $handle ) . "` is included in the concatenated jetpack.css -->\r\n";
6840
			}
6841
		}
6842
6843
		return $tag;
6844
	}
6845
6846
	/**
6847
	 * @deprecated
6848
	 * @see Automattic\Jetpack\Assets\add_aync_script
6849
	 */
6850
	public function script_add_async( $tag, $handle, $src ) {
6851
		_deprecated_function( __METHOD__, 'jetpack-8.6.0' );
6852
	}
6853
6854
	/*
6855
	 * Check the heartbeat data
6856
	 *
6857
	 * Organizes the heartbeat data by severity.  For example, if the site
6858
	 * is in an ID crisis, it will be in the $filtered_data['bad'] array.
6859
	 *
6860
	 * Data will be added to "caution" array, if it either:
6861
	 *  - Out of date Jetpack version
6862
	 *  - Out of date WP version
6863
	 *  - Out of date PHP version
6864
	 *
6865
	 * $return array $filtered_data
6866
	 */
6867
	public static function jetpack_check_heartbeat_data() {
6868
		$raw_data = Jetpack_Heartbeat::generate_stats_array();
6869
6870
		$good    = array();
6871
		$caution = array();
6872
		$bad     = array();
6873
6874
		foreach ( $raw_data as $stat => $value ) {
6875
6876
			// Check jetpack version
6877
			if ( 'version' == $stat ) {
6878
				if ( version_compare( $value, JETPACK__VERSION, '<' ) ) {
6879
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__VERSION;
6880
					continue;
6881
				}
6882
			}
6883
6884
			// Check WP version
6885
			if ( 'wp-version' == $stat ) {
6886
				if ( version_compare( $value, JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
6887
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_WP_VERSION;
6888
					continue;
6889
				}
6890
			}
6891
6892
			// Check PHP version
6893
			if ( 'php-version' == $stat ) {
6894
				if ( version_compare( PHP_VERSION, JETPACK__MINIMUM_PHP_VERSION, '<' ) ) {
6895
					$caution[ $stat ] = $value . ' - min supported is ' . JETPACK__MINIMUM_PHP_VERSION;
6896
					continue;
6897
				}
6898
			}
6899
6900
			// Check ID crisis
6901
			if ( 'identitycrisis' == $stat ) {
6902
				if ( 'yes' == $value ) {
6903
					$bad[ $stat ] = $value;
6904
					continue;
6905
				}
6906
			}
6907
6908
			// The rest are good :)
6909
			$good[ $stat ] = $value;
6910
		}
6911
6912
		$filtered_data = array(
6913
			'good'    => $good,
6914
			'caution' => $caution,
6915
			'bad'     => $bad,
6916
		);
6917
6918
		return $filtered_data;
6919
	}
6920
6921
6922
	/*
6923
	 * This method is used to organize all options that can be reset
6924
	 * without disconnecting Jetpack.
6925
	 *
6926
	 * It is used in class.jetpack-cli.php to reset options
6927
	 *
6928
	 * @since 5.4.0 Logic moved to Jetpack_Options class. Method left in Jetpack class for backwards compat.
6929
	 *
6930
	 * @return array of options to delete.
6931
	 */
6932
	public static function get_jetpack_options_for_reset() {
6933
		return Jetpack_Options::get_options_for_reset();
6934
	}
6935
6936
	/*
6937
	 * Strip http:// or https:// from a url, replaces forward slash with ::,
6938
	 * so we can bring them directly to their site in calypso.
6939
	 *
6940
	 * @param string | url
6941
	 * @return string | url without the guff
6942
	 */
6943 View Code Duplication
	public static function build_raw_urls( $url ) {
6944
		$strip_http = '/.*?:\/\//i';
6945
		$url        = preg_replace( $strip_http, '', $url );
6946
		$url        = str_replace( '/', '::', $url );
6947
		return $url;
6948
	}
6949
6950
	/**
6951
	 * Stores and prints out domains to prefetch for page speed optimization.
6952
	 *
6953
	 * @param mixed $new_urls
6954
	 */
6955
	public static function dns_prefetch( $new_urls = null ) {
6956
		static $prefetch_urls = array();
6957
		if ( empty( $new_urls ) && ! empty( $prefetch_urls ) ) {
6958
			echo "\r\n";
6959
			foreach ( $prefetch_urls as $this_prefetch_url ) {
6960
				printf( "<link rel='dns-prefetch' href='%s'/>\r\n", esc_attr( $this_prefetch_url ) );
6961
			}
6962
		} elseif ( ! empty( $new_urls ) ) {
6963
			if ( ! has_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) ) ) {
6964
				add_action( 'wp_head', array( __CLASS__, __FUNCTION__ ) );
6965
			}
6966
			foreach ( (array) $new_urls as $this_new_url ) {
6967
				$prefetch_urls[] = strtolower( untrailingslashit( preg_replace( '#^https?://#i', '//', $this_new_url ) ) );
6968
			}
6969
			$prefetch_urls = array_unique( $prefetch_urls );
6970
		}
6971
	}
6972
6973
	public function wp_dashboard_setup() {
6974
		if ( self::is_active() ) {
6975
			add_action( 'jetpack_dashboard_widget', array( __CLASS__, 'dashboard_widget_footer' ), 999 );
6976
		}
6977
6978
		if ( has_action( 'jetpack_dashboard_widget' ) ) {
6979
			$jetpack_logo = new Jetpack_Logo();
6980
			$widget_title = sprintf(
6981
				wp_kses(
6982
					/* translators: Placeholder is a Jetpack logo. */
6983
					__( 'Stats <span>by %s</span>', 'jetpack' ),
6984
					array( 'span' => array() )
6985
				),
6986
				$jetpack_logo->get_jp_emblem( true )
6987
			);
6988
6989
			wp_add_dashboard_widget(
6990
				'jetpack_summary_widget',
6991
				$widget_title,
6992
				array( __CLASS__, 'dashboard_widget' )
6993
			);
6994
			wp_enqueue_style( 'jetpack-dashboard-widget', plugins_url( 'css/dashboard-widget.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
6995
			wp_style_add_data( 'jetpack-dashboard-widget', 'rtl', 'replace' );
6996
6997
			// If we're inactive and not in development mode, sort our box to the top.
6998
			if ( ! self::is_active() && ! ( new Status() )->is_development_mode() ) {
6999
				global $wp_meta_boxes;
7000
7001
				$dashboard = $wp_meta_boxes['dashboard']['normal']['core'];
7002
				$ours      = array( 'jetpack_summary_widget' => $dashboard['jetpack_summary_widget'] );
7003
7004
				$wp_meta_boxes['dashboard']['normal']['core'] = array_merge( $ours, $dashboard );
7005
			}
7006
		}
7007
	}
7008
7009
	/**
7010
	 * @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...
7011
	 * @return mixed
7012
	 */
7013
	function get_user_option_meta_box_order_dashboard( $sorted ) {
7014
		if ( ! is_array( $sorted ) ) {
7015
			return $sorted;
7016
		}
7017
7018
		foreach ( $sorted as $box_context => $ids ) {
7019
			if ( false === strpos( $ids, 'dashboard_stats' ) ) {
7020
				// If the old id isn't anywhere in the ids, don't bother exploding and fail out.
7021
				continue;
7022
			}
7023
7024
			$ids_array = explode( ',', $ids );
7025
			$key       = array_search( 'dashboard_stats', $ids_array );
7026
7027
			if ( false !== $key ) {
7028
				// If we've found that exact value in the option (and not `google_dashboard_stats` for example)
7029
				$ids_array[ $key ]      = 'jetpack_summary_widget';
7030
				$sorted[ $box_context ] = implode( ',', $ids_array );
7031
				// We've found it, stop searching, and just return.
7032
				break;
7033
			}
7034
		}
7035
7036
		return $sorted;
7037
	}
7038
7039
	public static function dashboard_widget() {
7040
		/**
7041
		 * Fires when the dashboard is loaded.
7042
		 *
7043
		 * @since 3.4.0
7044
		 */
7045
		do_action( 'jetpack_dashboard_widget' );
7046
	}
7047
7048
	public static function dashboard_widget_footer() {
7049
		?>
7050
		<footer>
7051
7052
		<div class="protect">
7053
			<h3><?php esc_html_e( 'Brute force attack protection', 'jetpack' ); ?></h3>
7054
			<?php if ( self::is_module_active( 'protect' ) ) : ?>
7055
				<p class="blocked-count">
7056
					<?php echo number_format_i18n( get_site_option( 'jetpack_protect_blocked_attempts', 0 ) ); ?>
7057
				</p>
7058
				<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>
7059
			<?php elseif ( current_user_can( 'jetpack_activate_modules' ) && ! ( new Status() )->is_development_mode() ) : ?>
7060
				<a href="
7061
				<?php
7062
				echo esc_url(
7063
					wp_nonce_url(
7064
						self::admin_url(
7065
							array(
7066
								'action' => 'activate',
7067
								'module' => 'protect',
7068
							)
7069
						),
7070
						'jetpack_activate-protect'
7071
					)
7072
				);
7073
				?>
7074
							" class="button button-jetpack" title="<?php esc_attr_e( 'Protect helps to keep you secure from brute-force login attacks.', 'jetpack' ); ?>">
7075
					<?php esc_html_e( 'Activate brute force attack protection', 'jetpack' ); ?>
7076
				</a>
7077
			<?php else : ?>
7078
				<?php esc_html_e( 'Brute force attack protection is inactive.', 'jetpack' ); ?>
7079
			<?php endif; ?>
7080
		</div>
7081
7082
		<div class="akismet">
7083
			<h3><?php esc_html_e( 'Anti-spam', 'jetpack' ); ?></h3>
7084
			<?php if ( is_plugin_active( 'akismet/akismet.php' ) ) : ?>
7085
				<p class="blocked-count">
7086
					<?php echo number_format_i18n( get_option( 'akismet_spam_count', 0 ) ); ?>
7087
				</p>
7088
				<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>
7089
			<?php elseif ( current_user_can( 'activate_plugins' ) && ! is_wp_error( validate_plugin( 'akismet/akismet.php' ) ) ) : ?>
7090
				<a href="
7091
				<?php
7092
				echo esc_url(
7093
					wp_nonce_url(
7094
						add_query_arg(
7095
							array(
7096
								'action' => 'activate',
7097
								'plugin' => 'akismet/akismet.php',
7098
							),
7099
							admin_url( 'plugins.php' )
7100
						),
7101
						'activate-plugin_akismet/akismet.php'
7102
					)
7103
				);
7104
				?>
7105
							" class="button button-jetpack">
7106
					<?php esc_html_e( 'Activate Anti-spam', 'jetpack' ); ?>
7107
				</a>
7108
			<?php else : ?>
7109
				<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>
7110
			<?php endif; ?>
7111
		</div>
7112
7113
		</footer>
7114
		<?php
7115
	}
7116
7117
	/*
7118
	 * Adds a "blank" column in the user admin table to display indication of user connection.
7119
	 */
7120
	function jetpack_icon_user_connected( $columns ) {
7121
		$columns['user_jetpack'] = '';
7122
		return $columns;
7123
	}
7124
7125
	/*
7126
	 * Show Jetpack icon if the user is linked.
7127
	 */
7128
	function jetpack_show_user_connected_icon( $val, $col, $user_id ) {
7129
		if ( 'user_jetpack' == $col && self::is_user_connected( $user_id ) ) {
7130
			$jetpack_logo = new Jetpack_Logo();
7131
			$emblem_html  = sprintf(
7132
				'<a title="%1$s" class="jp-emblem-user-admin">%2$s</a>',
7133
				esc_attr__( 'This user is linked and ready to fly with Jetpack.', 'jetpack' ),
7134
				$jetpack_logo->get_jp_emblem()
7135
			);
7136
			return $emblem_html;
7137
		}
7138
7139
		return $val;
7140
	}
7141
7142
	/*
7143
	 * Style the Jetpack user column
7144
	 */
7145
	function jetpack_user_col_style() {
7146
		global $current_screen;
7147
		if ( ! empty( $current_screen->base ) && 'users' == $current_screen->base ) {
7148
			?>
7149
			<style>
7150
				.fixed .column-user_jetpack {
7151
					width: 21px;
7152
				}
7153
				.jp-emblem-user-admin svg {
7154
					width: 20px;
7155
					height: 20px;
7156
				}
7157
				.jp-emblem-user-admin path {
7158
					fill: #00BE28;
7159
				}
7160
			</style>
7161
			<?php
7162
		}
7163
	}
7164
7165
	/**
7166
	 * Checks if Akismet is active and working.
7167
	 *
7168
	 * We dropped support for Akismet 3.0 with Jetpack 6.1.1 while introducing a check for an Akismet valid key
7169
	 * that implied usage of methods present since more recent version.
7170
	 * See https://github.com/Automattic/jetpack/pull/9585
7171
	 *
7172
	 * @since  5.1.0
7173
	 *
7174
	 * @return bool True = Akismet available. False = Aksimet not available.
7175
	 */
7176
	public static function is_akismet_active() {
7177
		static $status = null;
7178
7179
		if ( ! is_null( $status ) ) {
7180
			return $status;
7181
		}
7182
7183
		// Check if a modern version of Akismet is active.
7184
		if ( ! method_exists( 'Akismet', 'http_post' ) ) {
7185
			$status = false;
7186
			return $status;
7187
		}
7188
7189
		// Make sure there is a key known to Akismet at all before verifying key.
7190
		$akismet_key = Akismet::get_api_key();
7191
		if ( ! $akismet_key ) {
7192
			$status = false;
7193
			return $status;
7194
		}
7195
7196
		// Possible values: valid, invalid, failure via Akismet. false if no status is cached.
7197
		$akismet_key_state = get_transient( 'jetpack_akismet_key_is_valid' );
7198
7199
		// 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.
7200
		$recheck = ( is_admin() || ( defined( 'REST_REQUEST' ) && REST_REQUEST ) ) && 'valid' !== $akismet_key_state;
7201
		// We cache the result of the Akismet key verification for ten minutes.
7202
		if ( ! $akismet_key_state || $recheck ) {
7203
			$akismet_key_state = Akismet::verify_key( $akismet_key );
7204
			set_transient( 'jetpack_akismet_key_is_valid', $akismet_key_state, 10 * MINUTE_IN_SECONDS );
7205
		}
7206
7207
		$status = 'valid' === $akismet_key_state;
7208
7209
		return $status;
7210
	}
7211
7212
	/**
7213
	 * @deprecated
7214
	 *
7215
	 * @see Automattic\Jetpack\Sync\Modules\Users::is_function_in_backtrace
7216
	 */
7217
	public static function is_function_in_backtrace() {
7218
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
7219
	}
7220
7221
	/**
7222
	 * Given a minified path, and a non-minified path, will return
7223
	 * a minified or non-minified file URL based on whether SCRIPT_DEBUG is set and truthy.
7224
	 *
7225
	 * Both `$min_base` and `$non_min_base` are expected to be relative to the
7226
	 * root Jetpack directory.
7227
	 *
7228
	 * @since 5.6.0
7229
	 *
7230
	 * @param string $min_path
7231
	 * @param string $non_min_path
7232
	 * @return string The URL to the file
7233
	 */
7234
	public static function get_file_url_for_environment( $min_path, $non_min_path ) {
7235
		return Assets::get_file_url_for_environment( $min_path, $non_min_path );
7236
	}
7237
7238
	/**
7239
	 * Checks for whether Jetpack Backup is enabled.
7240
	 * Will return true if the state of Backup is anything except "unavailable".
7241
	 *
7242
	 * @return bool|int|mixed
7243
	 */
7244
	public static function is_rewind_enabled() {
7245
		if ( ! self::is_active() ) {
7246
			return false;
7247
		}
7248
7249
		$rewind_enabled = get_transient( 'jetpack_rewind_enabled' );
7250
		if ( false === $rewind_enabled ) {
7251
			jetpack_require_lib( 'class.core-rest-api-endpoints' );
7252
			$rewind_data    = (array) Jetpack_Core_Json_Api_Endpoints::rewind_data();
7253
			$rewind_enabled = ( ! is_wp_error( $rewind_data )
7254
				&& ! empty( $rewind_data['state'] )
7255
				&& 'active' === $rewind_data['state'] )
7256
				? 1
7257
				: 0;
7258
7259
			set_transient( 'jetpack_rewind_enabled', $rewind_enabled, 10 * MINUTE_IN_SECONDS );
7260
		}
7261
		return $rewind_enabled;
7262
	}
7263
7264
	/**
7265
	 * Return Calypso environment value; used for developing Jetpack and pairing
7266
	 * it with different Calypso enrionments, such as localhost.
7267
	 *
7268
	 * @since 7.4.0
7269
	 *
7270
	 * @return string Calypso environment
7271
	 */
7272
	public static function get_calypso_env() {
7273
		if ( isset( $_GET['calypso_env'] ) ) {
7274
			return sanitize_key( $_GET['calypso_env'] );
7275
		}
7276
7277
		if ( getenv( 'CALYPSO_ENV' ) ) {
7278
			return sanitize_key( getenv( 'CALYPSO_ENV' ) );
7279
		}
7280
7281
		if ( defined( 'CALYPSO_ENV' ) && CALYPSO_ENV ) {
7282
			return sanitize_key( CALYPSO_ENV );
7283
		}
7284
7285
		return '';
7286
	}
7287
7288
	/**
7289
	 * Returns the hostname with protocol for Calypso.
7290
	 * Used for developing Jetpack with Calypso.
7291
	 *
7292
	 * @since 8.4.0
7293
	 *
7294
	 * @return string Calypso host.
7295
	 */
7296
	public static function get_calypso_host() {
7297
		$calypso_env = self::get_calypso_env();
7298
		switch ( $calypso_env ) {
7299
			case 'development':
7300
				return 'http://calypso.localhost:3000/';
7301
			case 'wpcalypso':
7302
				return 'https://wpcalypso.wordpress.com/';
7303
			case 'horizon':
7304
				return 'https://horizon.wordpress.com/';
7305
			default:
7306
				return 'https://wordpress.com/';
7307
		}
7308
	}
7309
7310
	/**
7311
	 * Checks whether or not TOS has been agreed upon.
7312
	 * Will return true if a user has clicked to register, or is already connected.
7313
	 */
7314
	public static function jetpack_tos_agreed() {
7315
		_deprecated_function( 'Jetpack::jetpack_tos_agreed', 'Jetpack 7.9.0', '\Automattic\Jetpack\Terms_Of_Service->has_agreed' );
7316
7317
		$terms_of_service = new Terms_Of_Service();
7318
		return $terms_of_service->has_agreed();
7319
7320
	}
7321
7322
	/**
7323
	 * Handles activating default modules as well general cleanup for the new connection.
7324
	 *
7325
	 * @param boolean $activate_sso                 Whether to activate the SSO module when activating default modules.
7326
	 * @param boolean $redirect_on_activation_error Whether to redirect on activation error.
7327
	 * @param boolean $send_state_messages          Whether to send state messages.
7328
	 * @return void
7329
	 */
7330
	public static function handle_post_authorization_actions(
7331
		$activate_sso = false,
7332
		$redirect_on_activation_error = false,
7333
		$send_state_messages = true
7334
	) {
7335
		$other_modules = $activate_sso
7336
			? array( 'sso' )
7337
			: array();
7338
7339
		if ( $active_modules = Jetpack_Options::get_option( 'active_modules' ) ) {
7340
			self::delete_active_modules();
7341
7342
			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...
7343
		} else {
7344
			self::activate_default_modules( false, false, $other_modules, $redirect_on_activation_error, $send_state_messages );
7345
		}
7346
7347
		// Since this is a fresh connection, be sure to clear out IDC options
7348
		Jetpack_IDC::clear_all_idc_options();
7349
7350
		if ( $send_state_messages ) {
7351
			self::state( 'message', 'authorized' );
7352
		}
7353
	}
7354
7355
	/**
7356
	 * Returns a boolean for whether backups UI should be displayed or not.
7357
	 *
7358
	 * @return bool Should backups UI be displayed?
7359
	 */
7360
	public static function show_backups_ui() {
7361
		/**
7362
		 * Whether UI for backups should be displayed.
7363
		 *
7364
		 * @since 6.5.0
7365
		 *
7366
		 * @param bool $show_backups Should UI for backups be displayed? True by default.
7367
		 */
7368
		return self::is_plugin_active( 'vaultpress/vaultpress.php' ) || apply_filters( 'jetpack_show_backups', true );
7369
	}
7370
7371
	/*
7372
	 * Deprecated manage functions
7373
	 */
7374
	function prepare_manage_jetpack_notice() {
7375
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7376
	}
7377
	function manage_activate_screen() {
7378
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7379
	}
7380
	function admin_jetpack_manage_notice() {
7381
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7382
	}
7383
	function opt_out_jetpack_manage_url() {
7384
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7385
	}
7386
	function opt_in_jetpack_manage_url() {
7387
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7388
	}
7389
	function opt_in_jetpack_manage_notice() {
7390
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7391
	}
7392
	function can_display_jetpack_manage_notice() {
7393
		_deprecated_function( __METHOD__, 'jetpack-7.3' );
7394
	}
7395
7396
	/**
7397
	 * Clean leftoveruser meta.
7398
	 *
7399
	 * Delete Jetpack-related user meta when it is no longer needed.
7400
	 *
7401
	 * @since 7.3.0
7402
	 *
7403
	 * @param int $user_id User ID being updated.
7404
	 */
7405
	public static function user_meta_cleanup( $user_id ) {
7406
		$meta_keys = array(
7407
			// AtD removed from Jetpack 7.3
7408
			'AtD_options',
7409
			'AtD_check_when',
7410
			'AtD_guess_lang',
7411
			'AtD_ignored_phrases',
7412
		);
7413
7414
		foreach ( $meta_keys as $meta_key ) {
7415
			if ( get_user_meta( $user_id, $meta_key ) ) {
7416
				delete_user_meta( $user_id, $meta_key );
7417
			}
7418
		}
7419
	}
7420
7421
	/**
7422
	 * Checks if a Jetpack site is both active and not in development.
7423
	 *
7424
	 * This is a DRY function to avoid repeating `Jetpack::is_active && ! Automattic\Jetpack\Status->is_development_mode`.
7425
	 *
7426
	 * @return bool True if Jetpack is active and not in development.
7427
	 */
7428
	public static function is_active_and_not_development_mode() {
7429
		if ( ! self::is_active() || ( new Status() )->is_development_mode() ) {
7430
			return false;
7431
		}
7432
		return true;
7433
	}
7434
7435
	/**
7436
	 * Returns the list of products that we have available for purchase.
7437
	 */
7438
	public static function get_products_for_purchase() {
7439
		$products = array();
7440
		if ( ! is_multisite() ) {
7441
			$products[] = array(
7442
				'key'               => 'backup',
7443
				'title'             => __( 'Jetpack Backup', 'jetpack' ),
7444
				'short_description' => __( 'Always-on backups ensure you never lose your site.', 'jetpack' ),
7445
				'learn_more'        => __( 'Which backup option is best for me?', 'jetpack' ),
7446
				'description'       => __( 'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.', 'jetpack' ),
7447
				'options_label'     => __( 'Select a backup option:', 'jetpack' ),
7448
				'options'           => array(
7449
					array(
7450
						'type'        => 'daily',
7451
						'slug'        => 'jetpack-backup-daily',
7452
						'key'         => 'jetpack_backup_daily',
7453
						'name'        => __( 'Daily Backups', 'jetpack' ),
7454
						'description' => __( 'Your data is being securely backed up daily.', 'jetpack' ),
7455
					),
7456
					array(
7457
						'type'        => 'realtime',
7458
						'slug'        => 'jetpack-backup-realtime',
7459
						'key'         => 'jetpack_backup_realtime',
7460
						'name'        => __( 'Real-Time Backups', 'jetpack' ),
7461
						'description' => __( 'Your data is being securely backed up as you edit.', 'jetpack' ),
7462
					),
7463
				),
7464
				'default_option'    => 'realtime',
7465
				'show_promotion'    => true,
7466
				'discount_percent'  => 70,
7467
				'included_in_plans' => array( 'personal-plan', 'premium-plan', 'business-plan', 'daily-backup-plan', 'realtime-backup-plan' ),
7468
			);
7469
7470
			$products[] = array(
7471
				'key'               => 'scan',
7472
				'title'             => __( 'Jetpack Scan', 'jetpack' ),
7473
				'short_description' => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7474
				'learn_more'        => __( 'Learn More', 'jetpack' ),
7475
				'description'       => __( 'Automatic scanning and one-click fixes keep your site one step ahead of security threats.', 'jetpack' ),
7476
				'show_promotion'    => true,
7477
				'discount_percent'  => 30,
7478
				'options'           => array(
7479
					array(
7480
						'type'      => 'scan',
7481
						'slug'      => 'jetpack-scan',
7482
						'key'       => 'jetpack_scan',
7483
						'name'      => __( 'Daily Scan', 'jetpack' ),
7484
					),
7485
				),
7486
				'default_option'    => 'scan',
7487
				'included_in_plans' => array( 'premium-plan', 'business-plan', 'scan-plan' ),
7488
			);
7489
		}
7490
7491
		$products[] = array(
7492
			'key'               => 'search',
7493
			'title'             => __( 'Jetpack Search', 'jetpack' ),
7494
			'short_description' => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7495
			'learn_more'        => __( 'Learn More', 'jetpack' ),
7496
			'description'       => __( 'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.', 'jetpack' ),
7497
			'label_popup'  		=> __( 'Records are all posts, pages, custom post types, and other types of content indexed by Jetpack Search.' ),
7498
			'options'           => array(
7499
				array(
7500
					'type'      => 'search',
7501
					'slug'      => 'jetpack-search',
7502
					'key'       => 'jetpack_search',
7503
					'name'      => __( 'Search', 'jetpack' ),
7504
				),
7505
			),
7506
			'tears'             => array(),
7507
			'default_option'    => 'search',
7508
			'show_promotion'    => false,
7509
			'included_in_plans' => array( 'search-plan' ),
7510
		);
7511
7512
		return $products;
7513
	}
7514
}
7515