Completed
Push — update/use-jetpack-status-pack... ( 9b36d9 )
by
unknown
10:15 queued 02:30
created

Jetpack::do_stats()   A

Complexity

Conditions 2
Paths 2

Size

Total Lines 11

Duplication

Lines 0
Ratio 0 %

Importance

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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