Completed
Push — add/stats-package ( 873a22...c3aabb )
by
unknown
230:03 queued 222:25
created

Jetpack::point_edit_post_links_to_calypso()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 31

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 3
nc 3
nop 2
dl 0
loc 31
rs 9.424
c 0
b 0
f 0
1
<?php
2
use Automattic\Jetpack\Assets;
3
use Automattic\Jetpack\Assets\Logo as Jetpack_Logo;
4
use Automattic\Jetpack\Config;
5
use Automattic\Jetpack\Connection\Client;
6
use Automattic\Jetpack\Connection\Manager as Connection_Manager;
7
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
8
use Automattic\Jetpack\Connection\Plugin_Storage as Connection_Plugin_Storage;
9
use Automattic\Jetpack\Constants;
10
use Automattic\Jetpack\Partner;
11
use Automattic\Jetpack\Roles;
12
use Automattic\Jetpack\Status;
13
use Automattic\Jetpack\Sync\Functions;
14
use Automattic\Jetpack\Sync\Health;
15
use Automattic\Jetpack\Sync\Sender;
16
use Automattic\Jetpack\Sync\Users;
17
use Automattic\Jetpack\Terms_Of_Service;
18
use Automattic\Jetpack\Tracking;
19
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
20
use Automattic\Jetpack\Redirect;
21
22
/*
23
Options:
24
jetpack_options (array)
25
	An array of options.
26
	@see Jetpack_Options::get_option_names()
27
28
jetpack_register (string)
29
	Temporary verification secrets.
30
31
jetpack_activated (int)
32
	1: the plugin was activated normally
33
	2: the plugin was activated on this site because of a network-wide activation
34
	3: the plugin was auto-installed
35
	4: the plugin was manually disconnected (but is still installed)
36
37
jetpack_active_modules (array)
38
	Array of active module slugs.
39
40
jetpack_do_activate (bool)
41
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
42
*/
43
44
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
45
46
class Jetpack {
47
	public $xmlrpc_server = null;
48
49
	private $rest_authentication_status = null;
50
51
	public $HTTP_RAW_POST_DATA = null; // copy of $GLOBALS['HTTP_RAW_POST_DATA']
52
53
	/**
54
	 * @var array The handles of styles that are concatenated into jetpack.css.
55
	 *
56
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
57
	 */
58
	public $concatenated_style_handles = array(
59
		'jetpack-carousel',
60
		'grunion.css',
61
		'the-neverending-homepage',
62
		'jetpack_likes',
63
		'jetpack_related-posts',
64
		'sharedaddy',
65
		'jetpack-slideshow',
66
		'presentations',
67
		'quiz',
68
		'jetpack-subscriptions',
69
		'jetpack-responsive-videos-style',
70
		'jetpack-social-menu',
71
		'tiled-gallery',
72
		'jetpack_display_posts_widget',
73
		'gravatar-profile-widget',
74
		'goodreads-widget',
75
		'jetpack_social_media_icons_widget',
76
		'jetpack-top-posts-widget',
77
		'jetpack_image_widget',
78
		'jetpack-my-community-widget',
79
		'jetpack-authors-widget',
80
		'wordads',
81
		'eu-cookie-law-style',
82
		'flickr-widget-style',
83
		'jetpack-search-widget',
84
		'jetpack-simple-payments-widget-style',
85
		'jetpack-widget-social-icons-styles',
86
	);
87
88
	/**
89
	 * Contains all assets that have had their URL rewritten to minified versions.
90
	 *
91
	 * @var array
92
	 */
93
	static $min_assets = array();
94
95
	public $plugins_to_deactivate = array(
96
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
97
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
98
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
99
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
100
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
101
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
102
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
103
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
104
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
105
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
106
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
107
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
108
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
109
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
110
	);
111
112
	/**
113
	 * Map of roles we care about, and their corresponding minimum capabilities.
114
	 *
115
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
116
	 *
117
	 * @access public
118
	 * @static
119
	 *
120
	 * @var array
121
	 */
122
	public static $capability_translations = array(
123
		'administrator' => 'manage_options',
124
		'editor'        => 'edit_others_posts',
125
		'author'        => 'publish_posts',
126
		'contributor'   => 'edit_posts',
127
		'subscriber'    => 'read',
128
	);
129
130
	/**
131
	 * Map of modules that have conflicts with plugins and should not be auto-activated
132
	 * if the plugins are active.  Used by filter_default_modules
133
	 *
134
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
135
	 * change `module-slug` and add this to your plugin:
136
	 *
137
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
138
	 * function my_jetpack_get_default_modules( $modules ) {
139
	 *     return array_diff( $modules, array( 'module-slug' ) );
140
	 * }
141
	 *
142
	 * @var array
143
	 */
144
	private $conflicting_plugins = array(
145
		'comments'           => array(
146
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
147
			'Disqus'                         => 'disqus-comment-system/disqus.php',
148
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
149
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
150
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
151
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
152
		),
153
		'comment-likes'      => array(
154
			'Epoch' => 'epoch/plugincore.php',
155
		),
156
		'contact-form'       => array(
157
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
158
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
159
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
160
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
161
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
162
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
163
		),
164
		'latex'              => array(
165
			'LaTeX for WordPress'     => 'latex/latex.php',
166
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
167
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
168
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
169
			'Enable Latex'            => 'enable-latex/enable-latex.php',
170
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
171
		),
172
		'protect'            => array(
173
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
174
			'Captcha'                           => 'captcha/captcha.php',
175
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
176
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
177
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
178
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
179
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
180
			'Security-protection'               => 'security-protection/security-protection.php',
181
			'Login Security'                    => 'login-security/login-security.php',
182
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
183
			'Wordfence Security'                => 'wordfence/wordfence.php',
184
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
185
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
186
		),
187
		'random-redirect'    => array(
188
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
189
		),
190
		'related-posts'      => array(
191
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
192
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
193
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
194
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
195
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
196
			'outbrain'                    => 'outbrain/outbrain.php',
197
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
198
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
199
		),
200
		'sharedaddy'         => array(
201
			'AddThis'     => 'addthis/addthis_social_widget.php',
202
			'Add To Any'  => 'add-to-any/add-to-any.php',
203
			'ShareThis'   => 'share-this/sharethis.php',
204
			'Shareaholic' => 'shareaholic/shareaholic.php',
205
		),
206
		'seo-tools'          => array(
207
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
208
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
209
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
210
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
211
			'The SEO Framework'              => 'autodescription/autodescription.php',
212
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
213
		),
214
		'verification-tools' => array(
215
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
216
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
217
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
218
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
219
			'The SEO Framework'              => 'autodescription/autodescription.php',
220
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
221
		),
222
		'widget-visibility'  => array(
223
			'Widget Logic'    => 'widget-logic/widget_logic.php',
224
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
225
		),
226
		'sitemaps'           => array(
227
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
228
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
229
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
230
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
231
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
232
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
233
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
234
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
235
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
236
			'The SEO Framework'                    => 'autodescription/autodescription.php',
237
			'Sitemap'                              => 'sitemap/sitemap.php',
238
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
239
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
240
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
241
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
242
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
243
		),
244
		'lazy-images'        => array(
245
			'Lazy Load'              => 'lazy-load/lazy-load.php',
246
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
247
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
248
		),
249
	);
250
251
	/**
252
	 * Plugins for which we turn off our Facebook OG Tags implementation.
253
	 *
254
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
255
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
256
	 *
257
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
258
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
259
	 */
260
	private $open_graph_conflicting_plugins = array(
261
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
262
		// 2 Click Social Media Buttons
263
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
264
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
265
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
266
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
267
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
268
		// Open Graph Meta Tags by Heateor
269
		'facebook/facebook.php',                                 // Facebook (official plugin)
270
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
271
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
272
		// Facebook Featured Image & OG Meta Tags
273
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
274
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
275
		// Facebook Open Graph Meta Tags for WordPress
276
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
277
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
278
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
279
		// Fedmich's Facebook Open Graph Meta
280
		'network-publisher/networkpub.php',                      // Network Publisher
281
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
282
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
283
		// NextScripts SNAP
284
		'og-tags/og-tags.php',                                   // OG Tags
285
		'opengraph/opengraph.php',                               // Open Graph
286
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
287
		// Open Graph Protocol Framework
288
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
289
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
290
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
291
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
292
		'sharepress/sharepress.php',                             // SharePress
293
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
294
		'social-discussions/social-discussions.php',             // Social Discussions
295
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
296
		'socialize/socialize.php',                               // Socialize
297
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
298
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
299
		// Tweet, Like, Google +1 and Share
300
		'wordbooker/wordbooker.php',                             // Wordbooker
301
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
302
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
303
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
304
		// WP Facebook Like Send & Open Graph Meta
305
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
306
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
307
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
308
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
309
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
310
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
311
	);
312
313
	/**
314
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
315
	 */
316
	private $twitter_cards_conflicting_plugins = array(
317
		// 'twitter/twitter.php',                       // The official one handles this on its own.
318
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
319
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
320
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
321
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
322
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
323
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
324
		'twitter-cards/twitter-cards.php',           // Twitter Cards
325
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
326
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
327
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
328
		'seo-by-rank-math/rank-math.php',            // Rank Math.
329
	);
330
331
	/**
332
	 * Message to display in admin_notice
333
	 *
334
	 * @var string
335
	 */
336
	public $message = '';
337
338
	/**
339
	 * Error to display in admin_notice
340
	 *
341
	 * @var string
342
	 */
343
	public $error = '';
344
345
	/**
346
	 * Modules that need more privacy description.
347
	 *
348
	 * @var string
349
	 */
350
	public $privacy_checks = '';
351
352
	/**
353
	 * Stats to record once the page loads
354
	 *
355
	 * @var array
356
	 */
357
	public $stats = array();
358
359
	/**
360
	 * Jetpack_Sync object
361
	 */
362
	public $sync;
363
364
	/**
365
	 * Verified data for JSON authorization request
366
	 */
367
	public $json_api_authorization_request = array();
368
369
	/**
370
	 * @var Automattic\Jetpack\Connection\Manager
371
	 */
372
	protected $connection_manager;
373
374
	/**
375
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
376
	 */
377
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
378
379
	/**
380
	 * Constant for login redirect key.
381
	 *
382
	 * @var string
383
	 * @since 8.4.0
384
	 */
385
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
386
387
	/**
388
	 * Holds the singleton instance of this class
389
	 *
390
	 * @since 2.3.3
391
	 * @var Jetpack
392
	 */
393
	static $instance = false;
394
395
	/**
396
	 * Singleton
397
	 *
398
	 * @static
399
	 */
400
	public static function init() {
401
		if ( ! self::$instance ) {
402
			self::$instance = new Jetpack();
403
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
404
		}
405
406
		return self::$instance;
407
	}
408
409
	/**
410
	 * Must never be called statically
411
	 */
412
	function plugin_upgrade() {
413
		if ( self::is_active() ) {
414
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
415
			if ( JETPACK__VERSION != $version ) {
416
				// Prevent multiple upgrades at once - only a single process should trigger
417
				// an upgrade to avoid stampedes
418
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
419
					return;
420
				}
421
422
				// Set a short lock to prevent multiple instances of the upgrade
423
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
424
425
				// check which active modules actually exist and remove others from active_modules list
426
				$unfiltered_modules = self::get_active_modules();
427
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
428
				if ( array_diff( $unfiltered_modules, $modules ) ) {
429
					self::update_active_modules( $modules );
430
				}
431
432
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
433
434
				// Upgrade to 4.3.0
435
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
436
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
437
				}
438
439
				// Make sure Markdown for posts gets turned back on
440
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
441
					update_option( 'wpcom_publish_posts_with_markdown', true );
442
				}
443
444
				/*
445
				 * Minileven deprecation. 8.3.0.
446
				 * Only delete options if not using
447
				 * the replacement standalone Minileven plugin.
448
				 */
449
				if (
450
					! self::is_plugin_active( 'minileven-master/minileven.php' )
451
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
452
				) {
453
					if ( get_option( 'wp_mobile_custom_css' ) ) {
454
						delete_option( 'wp_mobile_custom_css' );
455
					}
456
					if ( get_option( 'wp_mobile_excerpt' ) ) {
457
						delete_option( 'wp_mobile_excerpt' );
458
					}
459
					if ( get_option( 'wp_mobile_featured_images' ) ) {
460
						delete_option( 'wp_mobile_featured_images' );
461
					}
462
					if ( get_option( 'wp_mobile_app_promos' ) ) {
463
						delete_option( 'wp_mobile_app_promos' );
464
					}
465
				}
466
467
				// Upgrade to 8.4.0.
468
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
469
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
470
				}
471
472
				if ( did_action( 'wp_loaded' ) ) {
473
					self::upgrade_on_load();
474
				} else {
475
					add_action(
476
						'wp_loaded',
477
						array( __CLASS__, 'upgrade_on_load' )
478
					);
479
				}
480
			}
481
		}
482
	}
483
484
	/**
485
	 * Runs upgrade routines that need to have modules loaded.
486
	 */
487
	static function upgrade_on_load() {
488
489
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
490
		// This can happen in case Jetpack has been just upgraded and is
491
		// being initialized late during the page load. In this case we wait
492
		// until the next proper admin page load with Jetpack active.
493
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
494
			delete_transient( self::$plugin_upgrade_lock_key );
495
496
			return;
497
		}
498
499
		self::maybe_set_version_option();
500
501
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
502
			Jetpack_Widget_Conditions::migrate_post_type_rules();
503
		}
504
505
		if (
506
			class_exists( 'Jetpack_Sitemap_Manager' )
507
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
508
		) {
509
			do_action( 'jetpack_sitemaps_purge_data' );
510
		}
511
512
		// Delete old stats cache
513
		delete_option( 'jetpack_restapi_stats_cache' );
514
515
		delete_transient( self::$plugin_upgrade_lock_key );
516
	}
517
518
	/**
519
	 * Saves all the currently active modules to options.
520
	 * Also fires Action hooks for each newly activated and deactivated module.
521
	 *
522
	 * @param $modules Array Array of active modules to be saved in options.
523
	 *
524
	 * @return $success bool true for success, false for failure.
0 ignored issues
show
Documentation introduced by
The doc-type $success could not be parsed: Unknown type name "$success" at position 0. (view supported doc-types)

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

Loading history...
525
	 */
526
	static function update_active_modules( $modules ) {
527
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
528
		$active_modules       = self::get_active_modules();
529
		$new_active_modules   = array_diff( $modules, $current_modules );
530
		$new_inactive_modules = array_diff( $active_modules, $modules );
531
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
532
		$reindexed_modules    = array_values( $new_current_modules );
533
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
534
535
		foreach ( $new_active_modules as $module ) {
536
			/**
537
			 * Fires when a specific module is activated.
538
			 *
539
			 * @since 1.9.0
540
			 *
541
			 * @param string $module Module slug.
542
			 * @param boolean $success whether the module was activated. @since 4.2
543
			 */
544
			do_action( 'jetpack_activate_module', $module, $success );
545
			/**
546
			 * Fires when a module is activated.
547
			 * The dynamic part of the filter, $module, is the module slug.
548
			 *
549
			 * @since 1.9.0
550
			 *
551
			 * @param string $module Module slug.
552
			 */
553
			do_action( "jetpack_activate_module_$module", $module );
554
		}
555
556
		foreach ( $new_inactive_modules as $module ) {
557
			/**
558
			 * Fired after a module has been deactivated.
559
			 *
560
			 * @since 4.2.0
561
			 *
562
			 * @param string $module Module slug.
563
			 * @param boolean $success whether the module was deactivated.
564
			 */
565
			do_action( 'jetpack_deactivate_module', $module, $success );
566
			/**
567
			 * Fires when a module is deactivated.
568
			 * The dynamic part of the filter, $module, is the module slug.
569
			 *
570
			 * @since 1.9.0
571
			 *
572
			 * @param string $module Module slug.
573
			 */
574
			do_action( "jetpack_deactivate_module_$module", $module );
575
		}
576
577
		return $success;
578
	}
579
580
	static function delete_active_modules() {
581
		self::update_active_modules( array() );
582
	}
583
584
	/**
585
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
586
	 * available.
587
	 */
588
	public function add_configure_hook() {
589
		global $wp_filter;
590
591
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
592
		if ( false !== $current_priority ) {
593
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
594
		}
595
596
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
597
		sort( $taken_priorities );
598
599
		$first_priority = array_shift( $taken_priorities );
600
601
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
602
			$new_priority = - PHP_INT_MAX;
603
		} else {
604
			$new_priority = $first_priority - 1;
605
		}
606
607
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
608
	}
609
610
	/**
611
	 * Constructor.  Initializes WordPress hooks
612
	 */
613
	private function __construct() {
614
		/*
615
		 * Check for and alert any deprecated hooks
616
		 */
617
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
618
619
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
620
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
621
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
622
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
623
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
624
625
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
626
627
		add_filter(
628
			'jetpack_signature_check_token',
629
			array( __CLASS__, 'verify_onboarding_token' ),
630
			10,
631
			3
632
		);
633
634
		/**
635
		 * Prepare Gutenberg Editor functionality
636
		 */
637
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
638
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
639
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
640
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
641
642
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
643
644
		// Unlink user before deleting the user from WP.com.
645
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
646
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
647
648
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
649
650
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
651
		add_action( 'login_init', array( $this, 'login_init' ) );
652
653
		add_filter( 'determine_current_user', array( $this, 'wp_rest_authenticate' ) );
654
		add_filter( 'rest_authentication_errors', array( $this, 'wp_rest_authentication_errors' ) );
655
656
		add_action( 'admin_init', array( $this, 'admin_init' ) );
657
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
658
659
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
660
661
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
662
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
663
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
664
665
		// returns HTTPS support status
666
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
667
668
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
669
670
		add_action( 'wp_ajax_jetpack_wizard_banner', array( 'Jetpack_Wizard_Banner', 'ajax_callback' ) );
671
672
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
673
674
		/**
675
		 * These actions run checks to load additional files.
676
		 * They check for external files or plugins, so they need to run as late as possible.
677
		 */
678
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
679
		add_action( 'amp_story_head', array( $this, 'check_open_graph' ), 1 );
680
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
681
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
682
683
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
684
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
685
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
686
687
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
688
689
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
690
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
691
692
		// A filter to control all just in time messages
693
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
694
695
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
696
697
		/*
698
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
699
		 * We should make sure to only do this for front end links.
700
		 */
701
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
702
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
703
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
704
705
			/*
706
			 * We'll override wp_notify_postauthor and wp_notify_moderator pluggable functions
707
			 * so they point moderation links on emails to Calypso.
708
			 */
709
			jetpack_require_lib( 'functions.wp-notify' );
710
		}
711
712
		// Hide edit post link if mobile app.
713
		if ( Jetpack_User_Agent_Info::is_mobile_app() ) {
714
			add_filter( 'get_edit_post_link', '__return_empty_string' );
715
		}
716
717
		// Update the Jetpack plan from API on heartbeats.
718
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
719
720
		/**
721
		 * This is the hack to concatenate all css files into one.
722
		 * For description and reasoning see the implode_frontend_css method.
723
		 *
724
		 * Super late priority so we catch all the registered styles.
725
		 */
726
		if ( ! is_admin() ) {
727
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
728
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
729
		}
730
731
		/**
732
		 * These are sync actions that we need to keep track of for jitms
733
		 */
734
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
735
736
		// Actually push the stats on shutdown.
737
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
738
			add_action( 'shutdown', array( $this, 'push_stats' ) );
739
		}
740
741
		// Actions for Manager::authorize().
742
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
743
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
744
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
745
746
		// Filters for the Manager::get_token() urls and request body.
747
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
748
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
749
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
750
	}
751
752
	/**
753
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
754
	 * Config object.
755
	 */
756
	public function configure() {
757
		$config = new Config();
758
759
		foreach (
760
			array(
761
				'sync',
762
				'tracking',
763
				'tos',
764
			)
765
			as $feature
766
		) {
767
			$config->ensure( $feature );
768
		}
769
770
		$config->ensure(
771
			'connection',
772
			array(
773
				'slug' => 'jetpack',
774
				'name' => 'Jetpack',
775
			)
776
		);
777
778
		if ( is_admin() ) {
779
			$config->ensure( 'jitm' );
780
		}
781
782
		if ( ! $this->connection_manager ) {
783
			$this->connection_manager = new Connection_Manager( 'jetpack' );
784
		}
785
786
		/*
787
		 * Load things that should only be in Network Admin.
788
		 *
789
		 * For now blow away everything else until a more full
790
		 * understanding of what is needed at the network level is
791
		 * available
792
		 */
793
		if ( is_multisite() ) {
794
			$network = Jetpack_Network::init();
795
			$network->set_connection( $this->connection_manager );
796
		}
797
798
		if ( $this->connection_manager->is_active() ) {
799
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
800
801
			Jetpack_Heartbeat::init();
802
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
803
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
804
				Jetpack_Search_Performance_Logger::init();
805
			}
806
		}
807
808
		// Initialize remote file upload request handlers.
809
		$this->add_remote_request_handlers();
810
811
		/*
812
		 * Enable enhanced handling of previewing sites in Calypso
813
		 */
814
		if ( self::is_active() ) {
815
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
816
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
817
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
818
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
819
		}
820
	}
821
822
	/**
823
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
824
	 * initialization code.
825
	 *
826
	 * @action plugins_loaded
827
	 */
828
	public function late_initialization() {
829
		add_action( 'plugins_loaded', array( 'Jetpack', 'plugin_textdomain' ), 99 );
830
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
831
832
		Partner::init();
833
834
		/**
835
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
836
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
837
		 *
838
		 * @since 8.1.0
839
		 *
840
		 * @param Jetpack $jetpack the main plugin class object.
841
		 */
842
		do_action( 'jetpack_loaded', $this );
843
844
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
845
	}
846
847
	/**
848
	 * Sets up the XMLRPC request handlers.
849
	 *
850
	 * @deprecated since 7.7.0
851
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
852
	 *
853
	 * @param array                 $request_params Incoming request parameters.
854
	 * @param Boolean               $is_active      Whether the connection is currently active.
855
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
856
	 * @param Jetpack_XMLRPC_Server $xmlrpc_server  (optional) An instance of the server to use instead of instantiating a new one.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $xmlrpc_server not be null|Jetpack_XMLRPC_Server?

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

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

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

Loading history...
857
	 */
858 View Code Duplication
	public function setup_xmlrpc_handlers(
859
		$request_params,
860
		$is_active,
861
		$is_signed,
862
		Jetpack_XMLRPC_Server $xmlrpc_server = null
863
	) {
864
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
865
866
		if ( ! $this->connection_manager ) {
867
			$this->connection_manager = new Connection_Manager();
868
		}
869
870
		return $this->connection_manager->setup_xmlrpc_handlers(
871
			$request_params,
872
			$is_active,
873
			$is_signed,
874
			$xmlrpc_server
875
		);
876
	}
877
878
	/**
879
	 * Initialize REST API registration connector.
880
	 *
881
	 * @deprecated since 7.7.0
882
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
883
	 */
884 View Code Duplication
	public function initialize_rest_api_registration_connector() {
885
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
886
887
		if ( ! $this->connection_manager ) {
888
			$this->connection_manager = new Connection_Manager();
889
		}
890
891
		$this->connection_manager->initialize_rest_api_registration_connector();
892
	}
893
894
	/**
895
	 * This is ported over from the manage module, which has been deprecated and baked in here.
896
	 *
897
	 * @param $domains
898
	 */
899
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
900
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
901
	}
902
903
	/**
904
	 * Return $domains, with 'wordpress.com' appended.
905
	 * This is ported over from the manage module, which has been deprecated and baked in here.
906
	 *
907
	 * @param $domains
908
	 * @return array
909
	 */
910
	function allow_wpcom_domain( $domains ) {
911
		if ( empty( $domains ) ) {
912
			$domains = array();
913
		}
914
		$domains[] = 'wordpress.com';
915
		return array_unique( $domains );
916
	}
917
918
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
919
		$post = get_post( $post_id );
920
921
		if ( empty( $post ) ) {
922
			return $default_url;
923
		}
924
925
		$post_type = $post->post_type;
926
927
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
928
		// https://en.support.wordpress.com/custom-post-types/
929
		$allowed_post_types = array(
930
			'post',
931
			'page',
932
			'jetpack-portfolio',
933
			'jetpack-testimonial',
934
		);
935
936
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
937
			return $default_url;
938
		}
939
940
		return esc_url(
941
			Redirect::get_url(
942
				'calypso-edit-' . $post_type,
943
				array(
944
					'path' => $post_id,
945
				)
946
			)
947
		);
948
	}
949
950
	function point_edit_comment_links_to_calypso( $url ) {
951
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
952
		wp_parse_str( wp_parse_url( $url, PHP_URL_QUERY ), $query_args );
0 ignored issues
show
Bug introduced by
The variable $query_args does not exist. Did you forget to declare it?

This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug.

Loading history...
Unused Code introduced by
The call to wp_parse_url() has too many arguments starting with PHP_URL_QUERY.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3769
3770
			if ( ! is_int( $status_code ) ) {
3771
				$status_code = 400;
3772
			}
3773
3774
			status_header( $status_code );
3775
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3776
		}
3777
3778
		status_header( 200 );
3779
		if ( true === $response ) {
3780
			exit;
3781
		}
3782
3783
		die( json_encode( (object) $response ) );
3784
	}
3785
3786
	/**
3787
	 * Uploads a file gotten from the global $_FILES.
3788
	 * If `$update_media_item` is true and `post_id` is defined
3789
	 * the attachment file of the media item (gotten through of the post_id)
3790
	 * will be updated instead of add a new one.
3791
	 *
3792
	 * @param  boolean $update_media_item - update media attachment
3793
	 * @return array - An array describing the uploadind files process
3794
	 */
3795
	function upload_handler( $update_media_item = false ) {
3796
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3797
			return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 405.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3818
			}
3819
		}
3820
3821
		$media_keys = array_keys( $_FILES['media'] );
3822
3823
		$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...
3824
		if ( ! $token || is_wp_error( $token ) ) {
3825
			return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_token'.

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

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

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

Loading history...
3826
		}
3827
3828
		$uploaded_files = array();
3829
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3830
		unset( $GLOBALS['post'] );
3831
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3832
			$file = array();
3833
			foreach ( $media_keys as $media_key ) {
3834
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3835
			}
3836
3837
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3838
3839
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3840
			if ( $hmac_provided !== $hmac_file ) {
3841
				$uploaded_files[ $index ] = (object) array(
3842
					'error'             => 'invalid_hmac',
3843
					'error_description' => 'The corresponding HMAC for this file does not match',
3844
				);
3845
				continue;
3846
			}
3847
3848
			$_FILES['.jetpack.upload.'] = $file;
3849
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3850
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3851
				$post_id = 0;
3852
			}
3853
3854
			if ( $update_media_item ) {
3855
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3856
					return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'invalid_input'.

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

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

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

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

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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