Completed
Push — fix/flickr-shortcode ( 3e5712...02d728 )
by
unknown
24:33 queued 14:33
created

Jetpack::plugin_upgrade()   F

Complexity

Conditions 15
Paths 547

Size

Total Lines 71

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 15
nc 547
nop 0
dl 0
loc 71
rs 2.3791
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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