Completed
Push — update/show-recurring-payments... ( 106a5e...b030b6 )
by
unknown
415:44 queued 407:29
created

Jetpack::deprecated_hooks()   B

Complexity

Conditions 5
Paths 9

Size

Total Lines 257

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 5
nc 9
nop 0
dl 0
loc 257
rs 7.6888
c 0
b 0
f 0

How to fix   Long Method   

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\Plugin_Storage as Connection_Plugin_Storage;
8
use Automattic\Jetpack\Connection\Rest_Authentication as Connection_Rest_Authentication;
9
use Automattic\Jetpack\Connection\Utils as Connection_Utils;
10
use Automattic\Jetpack\Constants;
11
use Automattic\Jetpack\Device_Detection\User_Agent_Info;
12
use Automattic\Jetpack\Licensing;
13
use Automattic\Jetpack\Partner;
14
use Automattic\Jetpack\Plugin\Tracking as Plugin_Tracking;
15
use Automattic\Jetpack\Redirect;
16
use Automattic\Jetpack\Roles;
17
use Automattic\Jetpack\Status;
18
use Automattic\Jetpack\Sync\Functions;
19
use Automattic\Jetpack\Sync\Health;
20
use Automattic\Jetpack\Sync\Sender;
21
use Automattic\Jetpack\Sync\Users;
22
use Automattic\Jetpack\Terms_Of_Service;
23
use Automattic\Jetpack\Tracking;
24
25
/*
26
Options:
27
jetpack_options (array)
28
	An array of options.
29
	@see Jetpack_Options::get_option_names()
30
31
jetpack_register (string)
32
	Temporary verification secrets.
33
34
jetpack_activated (int)
35
	1: the plugin was activated normally
36
	2: the plugin was activated on this site because of a network-wide activation
37
	3: the plugin was auto-installed
38
	4: the plugin was manually disconnected (but is still installed)
39
40
jetpack_active_modules (array)
41
	Array of active module slugs.
42
43
jetpack_do_activate (bool)
44
	Flag for "activating" the plugin on sites where the activation hook never fired (auto-installs)
45
*/
46
47
require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.media.php';
48
49
class Jetpack {
50
	public $xmlrpc_server = null;
51
52
	/**
53
	 * @var array The handles of styles that are concatenated into jetpack.css.
54
	 *
55
	 * When making changes to that list, you must also update concat_list in tools/builder/frontend-css.js.
56
	 */
57
	public $concatenated_style_handles = array(
58
		'jetpack-carousel',
59
		'grunion.css',
60
		'the-neverending-homepage',
61
		'jetpack_likes',
62
		'jetpack_related-posts',
63
		'sharedaddy',
64
		'jetpack-slideshow',
65
		'presentations',
66
		'quiz',
67
		'jetpack-subscriptions',
68
		'jetpack-responsive-videos-style',
69
		'jetpack-social-menu',
70
		'tiled-gallery',
71
		'jetpack_display_posts_widget',
72
		'gravatar-profile-widget',
73
		'goodreads-widget',
74
		'jetpack_social_media_icons_widget',
75
		'jetpack-top-posts-widget',
76
		'jetpack_image_widget',
77
		'jetpack-my-community-widget',
78
		'jetpack-authors-widget',
79
		'wordads',
80
		'eu-cookie-law-style',
81
		'flickr-widget-style',
82
		'jetpack-search-widget',
83
		'jetpack-simple-payments-widget-style',
84
		'jetpack-widget-social-icons-styles',
85
		'wpcom_instagram_widget',
86
	);
87
88
	/**
89
	 * Contains all assets that have had their URL rewritten to minified versions.
90
	 *
91
	 * @var array
92
	 */
93
	static $min_assets = array();
94
95
	public $plugins_to_deactivate = array(
96
		'stats'               => array( 'stats/stats.php', 'WordPress.com Stats' ),
97
		'shortlinks'          => array( 'stats/stats.php', 'WordPress.com Stats' ),
98
		'sharedaddy'          => array( 'sharedaddy/sharedaddy.php', 'Sharedaddy' ),
99
		'twitter-widget'      => array( 'wickett-twitter-widget/wickett-twitter-widget.php', 'Wickett Twitter Widget' ),
100
		'contact-form'        => array( 'grunion-contact-form/grunion-contact-form.php', 'Grunion Contact Form' ),
101
		'contact-form'        => array( 'mullet/mullet-contact-form.php', 'Mullet Contact Form' ),
102
		'custom-css'          => array( 'safecss/safecss.php', 'WordPress.com Custom CSS' ),
103
		'random-redirect'     => array( 'random-redirect/random-redirect.php', 'Random Redirect' ),
104
		'videopress'          => array( 'video/video.php', 'VideoPress' ),
105
		'widget-visibility'   => array( 'jetpack-widget-visibility/widget-visibility.php', 'Jetpack Widget Visibility' ),
106
		'widget-visibility'   => array( 'widget-visibility-without-jetpack/widget-visibility-without-jetpack.php', 'Widget Visibility Without Jetpack' ),
107
		'sharedaddy'          => array( 'jetpack-sharing/sharedaddy.php', 'Jetpack Sharing' ),
108
		'gravatar-hovercards' => array( 'jetpack-gravatar-hovercards/gravatar-hovercards.php', 'Jetpack Gravatar Hovercards' ),
109
		'latex'               => array( 'wp-latex/wp-latex.php', 'WP LaTeX' ),
110
	);
111
112
	/**
113
	 * Map of roles we care about, and their corresponding minimum capabilities.
114
	 *
115
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::$capability_translations instead.
116
	 *
117
	 * @access public
118
	 * @static
119
	 *
120
	 * @var array
121
	 */
122
	public static $capability_translations = array(
123
		'administrator' => 'manage_options',
124
		'editor'        => 'edit_others_posts',
125
		'author'        => 'publish_posts',
126
		'contributor'   => 'edit_posts',
127
		'subscriber'    => 'read',
128
	);
129
130
	/**
131
	 * Map of modules that have conflicts with plugins and should not be auto-activated
132
	 * if the plugins are active.  Used by filter_default_modules
133
	 *
134
	 * Plugin Authors: If you'd like to prevent a single module from auto-activating,
135
	 * change `module-slug` and add this to your plugin:
136
	 *
137
	 * add_filter( 'jetpack_get_default_modules', 'my_jetpack_get_default_modules' );
138
	 * function my_jetpack_get_default_modules( $modules ) {
139
	 *     return array_diff( $modules, array( 'module-slug' ) );
140
	 * }
141
	 *
142
	 * @var array
143
	 */
144
	private $conflicting_plugins = array(
145
		'comments'           => array(
146
			'Intense Debate'                 => 'intensedebate/intensedebate.php',
147
			'Disqus'                         => 'disqus-comment-system/disqus.php',
148
			'Livefyre'                       => 'livefyre-comments/livefyre.php',
149
			'Comments Evolved for WordPress' => 'gplus-comments/comments-evolved.php',
150
			'Google+ Comments'               => 'google-plus-comments/google-plus-comments.php',
151
			'WP-SpamShield Anti-Spam'        => 'wp-spamshield/wp-spamshield.php',
152
		),
153
		'comment-likes'      => array(
154
			'Epoch' => 'epoch/plugincore.php',
155
		),
156
		'contact-form'       => array(
157
			'Contact Form 7'           => 'contact-form-7/wp-contact-form-7.php',
158
			'Gravity Forms'            => 'gravityforms/gravityforms.php',
159
			'Contact Form Plugin'      => 'contact-form-plugin/contact_form.php',
160
			'Easy Contact Forms'       => 'easy-contact-forms/easy-contact-forms.php',
161
			'Fast Secure Contact Form' => 'si-contact-form/si-contact-form.php',
162
			'Ninja Forms'              => 'ninja-forms/ninja-forms.php',
163
		),
164
		'latex'              => array(
165
			'LaTeX for WordPress'     => 'latex/latex.php',
166
			'Youngwhans Simple Latex' => 'youngwhans-simple-latex/yw-latex.php',
167
			'Easy WP LaTeX'           => 'easy-wp-latex-lite/easy-wp-latex-lite.php',
168
			'MathJax-LaTeX'           => 'mathjax-latex/mathjax-latex.php',
169
			'Enable Latex'            => 'enable-latex/enable-latex.php',
170
			'WP QuickLaTeX'           => 'wp-quicklatex/wp-quicklatex.php',
171
		),
172
		'protect'            => array(
173
			'Limit Login Attempts'              => 'limit-login-attempts/limit-login-attempts.php',
174
			'Captcha'                           => 'captcha/captcha.php',
175
			'Brute Force Login Protection'      => 'brute-force-login-protection/brute-force-login-protection.php',
176
			'Login Security Solution'           => 'login-security-solution/login-security-solution.php',
177
			'WPSecureOps Brute Force Protect'   => 'wpsecureops-bruteforce-protect/wpsecureops-bruteforce-protect.php',
178
			'BulletProof Security'              => 'bulletproof-security/bulletproof-security.php',
179
			'SiteGuard WP Plugin'               => 'siteguard/siteguard.php',
180
			'Security-protection'               => 'security-protection/security-protection.php',
181
			'Login Security'                    => 'login-security/login-security.php',
182
			'Botnet Attack Blocker'             => 'botnet-attack-blocker/botnet-attack-blocker.php',
183
			'Wordfence Security'                => 'wordfence/wordfence.php',
184
			'All In One WP Security & Firewall' => 'all-in-one-wp-security-and-firewall/wp-security.php',
185
			'iThemes Security'                  => 'better-wp-security/better-wp-security.php',
186
		),
187
		'random-redirect'    => array(
188
			'Random Redirect 2' => 'random-redirect-2/random-redirect.php',
189
		),
190
		'related-posts'      => array(
191
			'YARPP'                       => 'yet-another-related-posts-plugin/yarpp.php',
192
			'WordPress Related Posts'     => 'wordpress-23-related-posts-plugin/wp_related_posts.php',
193
			'nrelate Related Content'     => 'nrelate-related-content/nrelate-related.php',
194
			'Contextual Related Posts'    => 'contextual-related-posts/contextual-related-posts.php',
195
			'Related Posts for WordPress' => 'microkids-related-posts/microkids-related-posts.php',
196
			'outbrain'                    => 'outbrain/outbrain.php',
197
			'Shareaholic'                 => 'shareaholic/shareaholic.php',
198
			'Sexybookmarks'               => 'sexybookmarks/shareaholic.php',
199
		),
200
		'sharedaddy'         => array(
201
			'AddThis'     => 'addthis/addthis_social_widget.php',
202
			'Add To Any'  => 'add-to-any/add-to-any.php',
203
			'ShareThis'   => 'share-this/sharethis.php',
204
			'Shareaholic' => 'shareaholic/shareaholic.php',
205
		),
206
		'seo-tools'          => array(
207
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
208
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
209
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
210
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
211
			'The SEO Framework'              => 'autodescription/autodescription.php',
212
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
213
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
214
		),
215
		'verification-tools' => array(
216
			'WordPress SEO by Yoast'         => 'wordpress-seo/wp-seo.php',
217
			'WordPress SEO Premium by Yoast' => 'wordpress-seo-premium/wp-seo-premium.php',
218
			'All in One SEO Pack'            => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
219
			'All in One SEO Pack Pro'        => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
220
			'The SEO Framework'              => 'autodescription/autodescription.php',
221
			'Rank Math'                      => 'seo-by-rank-math/rank-math.php',
222
			'Slim SEO'                       => 'slim-seo/slim-seo.php',
223
		),
224
		'widget-visibility'  => array(
225
			'Widget Logic'    => 'widget-logic/widget_logic.php',
226
			'Dynamic Widgets' => 'dynamic-widgets/dynamic-widgets.php',
227
		),
228
		'sitemaps'           => array(
229
			'Google XML Sitemaps'                  => 'google-sitemap-generator/sitemap.php',
230
			'Better WordPress Google XML Sitemaps' => 'bwp-google-xml-sitemaps/bwp-simple-gxs.php',
231
			'Google XML Sitemaps for qTranslate'   => 'google-xml-sitemaps-v3-for-qtranslate/sitemap.php',
232
			'XML Sitemap & Google News feeds'      => 'xml-sitemap-feed/xml-sitemap.php',
233
			'Google Sitemap by BestWebSoft'        => 'google-sitemap-plugin/google-sitemap-plugin.php',
234
			'WordPress SEO by Yoast'               => 'wordpress-seo/wp-seo.php',
235
			'WordPress SEO Premium by Yoast'       => 'wordpress-seo-premium/wp-seo-premium.php',
236
			'All in One SEO Pack'                  => 'all-in-one-seo-pack/all_in_one_seo_pack.php',
237
			'All in One SEO Pack Pro'              => 'all-in-one-seo-pack-pro/all_in_one_seo_pack.php',
238
			'The SEO Framework'                    => 'autodescription/autodescription.php',
239
			'Sitemap'                              => 'sitemap/sitemap.php',
240
			'Simple Wp Sitemap'                    => 'simple-wp-sitemap/simple-wp-sitemap.php',
241
			'Simple Sitemap'                       => 'simple-sitemap/simple-sitemap.php',
242
			'XML Sitemaps'                         => 'xml-sitemaps/xml-sitemaps.php',
243
			'MSM Sitemaps'                         => 'msm-sitemap/msm-sitemap.php',
244
			'Rank Math'                            => 'seo-by-rank-math/rank-math.php',
245
			'Slim SEO'                             => 'slim-seo/slim-seo.php',
246
		),
247
		'lazy-images'        => array(
248
			'Lazy Load'              => 'lazy-load/lazy-load.php',
249
			'BJ Lazy Load'           => 'bj-lazy-load/bj-lazy-load.php',
250
			'Lazy Load by WP Rocket' => 'rocket-lazy-load/rocket-lazy-load.php',
251
		),
252
	);
253
254
	/**
255
	 * Plugins for which we turn off our Facebook OG Tags implementation.
256
	 *
257
	 * Note: All in One SEO Pack, All in one SEO Pack Pro, WordPress SEO by Yoast, and WordPress SEO Premium by Yoast automatically deactivate
258
	 * Jetpack's Open Graph tags via filter when their Social Meta modules are active.
259
	 *
260
	 * Plugin authors: If you'd like to prevent Jetpack's Open Graph tag generation in your plugin, you can do so via this filter:
261
	 * add_filter( 'jetpack_enable_open_graph', '__return_false' );
262
	 */
263
	private $open_graph_conflicting_plugins = array(
264
		'2-click-socialmedia-buttons/2-click-socialmedia-buttons.php',
265
		// 2 Click Social Media Buttons
266
		'add-link-to-facebook/add-link-to-facebook.php',         // Add Link to Facebook
267
		'add-meta-tags/add-meta-tags.php',                       // Add Meta Tags
268
		'complete-open-graph/complete-open-graph.php',           // Complete Open Graph
269
		'easy-facebook-share-thumbnails/esft.php',               // Easy Facebook Share Thumbnail
270
		'heateor-open-graph-meta-tags/heateor-open-graph-meta-tags.php',
271
		// Open Graph Meta Tags by Heateor
272
		'facebook/facebook.php',                                 // Facebook (official plugin)
273
		'facebook-awd/AWD_facebook.php',                         // Facebook AWD All in one
274
		'facebook-featured-image-and-open-graph-meta-tags/fb-featured-image.php',
275
		// Facebook Featured Image & OG Meta Tags
276
		'facebook-meta-tags/facebook-metatags.php',              // Facebook Meta Tags
277
		'wonderm00ns-simple-facebook-open-graph-tags/wonderm00n-open-graph.php',
278
		// Facebook Open Graph Meta Tags for WordPress
279
		'facebook-revised-open-graph-meta-tag/index.php',        // Facebook Revised Open Graph Meta Tag
280
		'facebook-thumb-fixer/_facebook-thumb-fixer.php',        // Facebook Thumb Fixer
281
		'facebook-and-digg-thumbnail-generator/facebook-and-digg-thumbnail-generator.php',
282
		// Fedmich's Facebook Open Graph Meta
283
		'network-publisher/networkpub.php',                      // Network Publisher
284
		'nextgen-facebook/nextgen-facebook.php',                 // NextGEN Facebook OG
285
		'social-networks-auto-poster-facebook-twitter-g/NextScripts_SNAP.php',
286
		// NextScripts SNAP
287
		'og-tags/og-tags.php',                                   // OG Tags
288
		'opengraph/opengraph.php',                               // Open Graph
289
		'open-graph-protocol-framework/open-graph-protocol-framework.php',
290
		// Open Graph Protocol Framework
291
		'seo-facebook-comments/seofacebook.php',                 // SEO Facebook Comments
292
		'seo-ultimate/seo-ultimate.php',                         // SEO Ultimate
293
		'sexybookmarks/sexy-bookmarks.php',                      // Shareaholic
294
		'shareaholic/sexy-bookmarks.php',                        // Shareaholic
295
		'sharepress/sharepress.php',                             // SharePress
296
		'simple-facebook-connect/sfc.php',                       // Simple Facebook Connect
297
		'social-discussions/social-discussions.php',             // Social Discussions
298
		'social-sharing-toolkit/social_sharing_toolkit.php',     // Social Sharing Toolkit
299
		'socialize/socialize.php',                               // Socialize
300
		'squirrly-seo/squirrly.php',                             // SEO by SQUIRRLY™
301
		'only-tweet-like-share-and-google-1/tweet-like-plusone.php',
302
		// Tweet, Like, Google +1 and Share
303
		'wordbooker/wordbooker.php',                             // Wordbooker
304
		'wpsso/wpsso.php',                                       // WordPress Social Sharing Optimization
305
		'wp-caregiver/wp-caregiver.php',                         // WP Caregiver
306
		'wp-facebook-like-send-open-graph-meta/wp-facebook-like-send-open-graph-meta.php',
307
		// WP Facebook Like Send & Open Graph Meta
308
		'wp-facebook-open-graph-protocol/wp-facebook-ogp.php',   // WP Facebook Open Graph protocol
309
		'wp-ogp/wp-ogp.php',                                     // WP-OGP
310
		'zoltonorg-social-plugin/zosp.php',                      // Zolton.org Social Plugin
311
		'wp-fb-share-like-button/wp_fb_share-like_widget.php',   // WP Facebook Like Button
312
		'open-graph-metabox/open-graph-metabox.php',              // Open Graph Metabox
313
		'seo-by-rank-math/rank-math.php',                        // Rank Math.
314
		'slim-seo/slim-seo.php',                                 // Slim SEO
315
	);
316
317
	/**
318
	 * Plugins for which we turn off our Twitter Cards Tags implementation.
319
	 */
320
	private $twitter_cards_conflicting_plugins = array(
321
		// 'twitter/twitter.php',                       // The official one handles this on its own.
322
		// https://github.com/twitter/wordpress/blob/master/src/Twitter/WordPress/Cards/Compatibility.php
323
			'eewee-twitter-card/index.php',              // Eewee Twitter Card
324
		'ig-twitter-cards/ig-twitter-cards.php',     // IG:Twitter Cards
325
		'jm-twitter-cards/jm-twitter-cards.php',     // JM Twitter Cards
326
		'kevinjohn-gallagher-pure-web-brilliants-social-graph-twitter-cards-extention/kevinjohn_gallagher___social_graph_twitter_output.php',
327
		// Pure Web Brilliant's Social Graph Twitter Cards Extension
328
		'twitter-cards/twitter-cards.php',           // Twitter Cards
329
		'twitter-cards-meta/twitter-cards-meta.php', // Twitter Cards Meta
330
		'wp-to-twitter/wp-to-twitter.php',           // WP to Twitter
331
		'wp-twitter-cards/twitter_cards.php',        // WP Twitter Cards
332
		'seo-by-rank-math/rank-math.php',            // Rank Math.
333
		'slim-seo/slim-seo.php',                     // Slim SEO
334
	);
335
336
	/**
337
	 * Message to display in admin_notice
338
	 *
339
	 * @var string
340
	 */
341
	public $message = '';
342
343
	/**
344
	 * Error to display in admin_notice
345
	 *
346
	 * @var string
347
	 */
348
	public $error = '';
349
350
	/**
351
	 * Modules that need more privacy description.
352
	 *
353
	 * @var string
354
	 */
355
	public $privacy_checks = '';
356
357
	/**
358
	 * Stats to record once the page loads
359
	 *
360
	 * @var array
361
	 */
362
	public $stats = array();
363
364
	/**
365
	 * Jetpack_Sync object
366
	 */
367
	public $sync;
368
369
	/**
370
	 * Verified data for JSON authorization request
371
	 */
372
	public $json_api_authorization_request = array();
373
374
	/**
375
	 * @var Automattic\Jetpack\Connection\Manager
376
	 */
377
	protected $connection_manager;
378
379
	/**
380
	 * @var string Transient key used to prevent multiple simultaneous plugin upgrades
381
	 */
382
	public static $plugin_upgrade_lock_key = 'jetpack_upgrade_lock';
383
384
	/**
385
	 * Holds an instance of Automattic\Jetpack\A8c_Mc_Stats
386
	 *
387
	 * @var Automattic\Jetpack\A8c_Mc_Stats
388
	 */
389
	public $a8c_mc_stats_instance;
390
391
	/**
392
	 * Constant for login redirect key.
393
	 *
394
	 * @var string
395
	 * @since 8.4.0
396
	 */
397
	public static $jetpack_redirect_login = 'jetpack_connect_login_redirect';
398
399
	/**
400
	 * Holds the singleton instance of this class
401
	 *
402
	 * @since 2.3.3
403
	 * @var Jetpack
404
	 */
405
	static $instance = false;
406
407
	/**
408
	 * Singleton
409
	 *
410
	 * @static
411
	 */
412
	public static function init() {
413
		if ( ! self::$instance ) {
414
			self::$instance = new Jetpack();
415
			add_action( 'plugins_loaded', array( self::$instance, 'plugin_upgrade' ) );
416
		}
417
418
		return self::$instance;
419
	}
420
421
	/**
422
	 * Must never be called statically
423
	 */
424
	function plugin_upgrade() {
425
		if ( self::is_active() ) {
426
			list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
427
			if ( JETPACK__VERSION != $version ) {
428
				// Prevent multiple upgrades at once - only a single process should trigger
429
				// an upgrade to avoid stampedes
430
				if ( false !== get_transient( self::$plugin_upgrade_lock_key ) ) {
431
					return;
432
				}
433
434
				// Set a short lock to prevent multiple instances of the upgrade
435
				set_transient( self::$plugin_upgrade_lock_key, 1, 10 );
436
437
				// check which active modules actually exist and remove others from active_modules list
438
				$unfiltered_modules = self::get_active_modules();
439
				$modules            = array_filter( $unfiltered_modules, array( 'Jetpack', 'is_module' ) );
440
				if ( array_diff( $unfiltered_modules, $modules ) ) {
441
					self::update_active_modules( $modules );
442
				}
443
444
				add_action( 'init', array( __CLASS__, 'activate_new_modules' ) );
445
446
				// Upgrade to 4.3.0
447
				if ( Jetpack_Options::get_option( 'identity_crisis_whitelist' ) ) {
448
					Jetpack_Options::delete_option( 'identity_crisis_whitelist' );
449
				}
450
451
				// Make sure Markdown for posts gets turned back on
452
				if ( ! get_option( 'wpcom_publish_posts_with_markdown' ) ) {
453
					update_option( 'wpcom_publish_posts_with_markdown', true );
454
				}
455
456
				/*
457
				 * Minileven deprecation. 8.3.0.
458
				 * Only delete options if not using
459
				 * the replacement standalone Minileven plugin.
460
				 */
461
				if (
462
					! self::is_plugin_active( 'minileven-master/minileven.php' )
463
					&& ! self::is_plugin_active( 'minileven/minileven.php' )
464
				) {
465
					if ( get_option( 'wp_mobile_custom_css' ) ) {
466
						delete_option( 'wp_mobile_custom_css' );
467
					}
468
					if ( get_option( 'wp_mobile_excerpt' ) ) {
469
						delete_option( 'wp_mobile_excerpt' );
470
					}
471
					if ( get_option( 'wp_mobile_featured_images' ) ) {
472
						delete_option( 'wp_mobile_featured_images' );
473
					}
474
					if ( get_option( 'wp_mobile_app_promos' ) ) {
475
						delete_option( 'wp_mobile_app_promos' );
476
					}
477
				}
478
479
				// Upgrade to 8.4.0.
480
				if ( Jetpack_Options::get_option( 'ab_connect_banner_green_bar' ) ) {
481
					Jetpack_Options::delete_option( 'ab_connect_banner_green_bar' );
482
				}
483
484
				// Update to 8.8.x (WordPress 5.5 Compatibility).
485
				if ( Jetpack_Options::get_option( 'autoupdate_plugins' ) ) {
486
					$updated = update_site_option(
487
						'auto_update_plugins',
488
						array_unique(
489
							array_merge(
490
								(array) Jetpack_Options::get_option( 'autoupdate_plugins', array() ),
491
								(array) get_site_option( 'auto_update_plugins', array() )
492
							)
493
						)
494
					);
495
496
					if ( $updated ) {
497
						Jetpack_Options::delete_option( 'autoupdate_plugins' );
498
					} // Should we have some type of fallback if something fails here?
499
				}
500
501
				if ( did_action( 'wp_loaded' ) ) {
502
					self::upgrade_on_load();
503
				} else {
504
					add_action(
505
						'wp_loaded',
506
						array( __CLASS__, 'upgrade_on_load' )
507
					);
508
				}
509
			}
510
		}
511
	}
512
513
	/**
514
	 * Runs upgrade routines that need to have modules loaded.
515
	 */
516
	static function upgrade_on_load() {
517
518
		// Not attempting any upgrades if jetpack_modules_loaded did not fire.
519
		// This can happen in case Jetpack has been just upgraded and is
520
		// being initialized late during the page load. In this case we wait
521
		// until the next proper admin page load with Jetpack active.
522
		if ( ! did_action( 'jetpack_modules_loaded' ) ) {
523
			delete_transient( self::$plugin_upgrade_lock_key );
524
525
			return;
526
		}
527
528
		self::maybe_set_version_option();
529
530
		if ( method_exists( 'Jetpack_Widget_Conditions', 'migrate_post_type_rules' ) ) {
531
			Jetpack_Widget_Conditions::migrate_post_type_rules();
532
		}
533
534
		if (
535
			class_exists( 'Jetpack_Sitemap_Manager' )
536
			&& version_compare( JETPACK__VERSION, '5.3', '>=' )
537
		) {
538
			do_action( 'jetpack_sitemaps_purge_data' );
539
		}
540
541
		// Delete old stats cache
542
		delete_option( 'jetpack_restapi_stats_cache' );
543
544
		delete_transient( self::$plugin_upgrade_lock_key );
545
	}
546
547
	/**
548
	 * Saves all the currently active modules to options.
549
	 * Also fires Action hooks for each newly activated and deactivated module.
550
	 *
551
	 * @param $modules Array Array of active modules to be saved in options.
552
	 *
553
	 * @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...
554
	 */
555
	static function update_active_modules( $modules ) {
556
		$current_modules      = Jetpack_Options::get_option( 'active_modules', array() );
557
		$active_modules       = self::get_active_modules();
558
		$new_active_modules   = array_diff( $modules, $current_modules );
559
		$new_inactive_modules = array_diff( $active_modules, $modules );
560
		$new_current_modules  = array_diff( array_merge( $current_modules, $new_active_modules ), $new_inactive_modules );
561
		$reindexed_modules    = array_values( $new_current_modules );
562
		$success              = Jetpack_Options::update_option( 'active_modules', array_unique( $reindexed_modules ) );
563
564
		foreach ( $new_active_modules as $module ) {
565
			/**
566
			 * Fires when a specific module is activated.
567
			 *
568
			 * @since 1.9.0
569
			 *
570
			 * @param string $module Module slug.
571
			 * @param boolean $success whether the module was activated. @since 4.2
572
			 */
573
			do_action( 'jetpack_activate_module', $module, $success );
574
			/**
575
			 * Fires when a module is activated.
576
			 * The dynamic part of the filter, $module, is the module slug.
577
			 *
578
			 * @since 1.9.0
579
			 *
580
			 * @param string $module Module slug.
581
			 */
582
			do_action( "jetpack_activate_module_$module", $module );
583
		}
584
585
		foreach ( $new_inactive_modules as $module ) {
586
			/**
587
			 * Fired after a module has been deactivated.
588
			 *
589
			 * @since 4.2.0
590
			 *
591
			 * @param string $module Module slug.
592
			 * @param boolean $success whether the module was deactivated.
593
			 */
594
			do_action( 'jetpack_deactivate_module', $module, $success );
595
			/**
596
			 * Fires when a module is deactivated.
597
			 * The dynamic part of the filter, $module, is the module slug.
598
			 *
599
			 * @since 1.9.0
600
			 *
601
			 * @param string $module Module slug.
602
			 */
603
			do_action( "jetpack_deactivate_module_$module", $module );
604
		}
605
606
		return $success;
607
	}
608
609
	static function delete_active_modules() {
610
		self::update_active_modules( array() );
611
	}
612
613
	/**
614
	 * Adds a hook to plugins_loaded at a priority that's currently the earliest
615
	 * available.
616
	 */
617
	public function add_configure_hook() {
618
		global $wp_filter;
619
620
		$current_priority = has_filter( 'plugins_loaded', array( $this, 'configure' ) );
621
		if ( false !== $current_priority ) {
622
			remove_action( 'plugins_loaded', array( $this, 'configure' ), $current_priority );
623
		}
624
625
		$taken_priorities = array_map( 'intval', array_keys( $wp_filter['plugins_loaded']->callbacks ) );
626
		sort( $taken_priorities );
627
628
		$first_priority = array_shift( $taken_priorities );
629
630
		if ( defined( 'PHP_INT_MAX' ) && $first_priority <= - PHP_INT_MAX ) {
631
			$new_priority = - PHP_INT_MAX;
632
		} else {
633
			$new_priority = $first_priority - 1;
634
		}
635
636
		add_action( 'plugins_loaded', array( $this, 'configure' ), $new_priority );
637
	}
638
639
	/**
640
	 * Constructor.  Initializes WordPress hooks
641
	 */
642
	private function __construct() {
643
		/*
644
		 * Check for and alert any deprecated hooks
645
		 */
646
		add_action( 'init', array( $this, 'deprecated_hooks' ) );
647
648
		// Note how this runs at an earlier plugin_loaded hook intentionally to accomodate for other plugins.
649
		add_action( 'plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
650
		add_action( 'network_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
651
		add_action( 'mu_plugin_loaded', array( $this, 'add_configure_hook' ), 90 );
652
		add_action( 'plugins_loaded', array( $this, 'late_initialization' ), 90 );
653
654
		add_action( 'jetpack_verify_signature_error', array( $this, 'track_xmlrpc_error' ) );
655
656
		add_filter(
657
			'jetpack_signature_check_token',
658
			array( __CLASS__, 'verify_onboarding_token' ),
659
			10,
660
			3
661
		);
662
663
		/**
664
		 * Prepare Gutenberg Editor functionality
665
		 */
666
		require_once JETPACK__PLUGIN_DIR . 'class.jetpack-gutenberg.php';
667
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'init' ) );
668
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_independent_blocks' ) );
669
		add_action( 'plugins_loaded', array( 'Jetpack_Gutenberg', 'load_extended_blocks' ), 9 );
670
		add_action( 'enqueue_block_editor_assets', array( 'Jetpack_Gutenberg', 'enqueue_block_editor_assets' ) );
671
672
		add_action( 'set_user_role', array( $this, 'maybe_clear_other_linked_admins_transient' ), 10, 3 );
673
674
		// Unlink user before deleting the user from WP.com.
675
		add_action( 'deleted_user', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
676
		add_action( 'remove_user_from_blog', array( 'Automattic\\Jetpack\\Connection\\Manager', 'disconnect_user' ), 10, 1 );
677
678
		add_action( 'jetpack_event_log', array( 'Jetpack', 'log' ), 10, 2 );
679
680
		add_filter( 'login_url', array( $this, 'login_url' ), 10, 2 );
681
		add_action( 'login_init', array( $this, 'login_init' ) );
682
683
		// Set up the REST authentication hooks.
684
		Connection_Rest_Authentication::init();
685
686
		add_action( 'admin_init', array( $this, 'admin_init' ) );
687
		add_action( 'admin_init', array( $this, 'dismiss_jetpack_notice' ) );
688
689
		add_filter( 'admin_body_class', array( $this, 'admin_body_class' ), 20 );
690
691
		add_action( 'wp_dashboard_setup', array( $this, 'wp_dashboard_setup' ) );
692
		// Filter the dashboard meta box order to swap the new one in in place of the old one.
693
		add_filter( 'get_user_option_meta-box-order_dashboard', array( $this, 'get_user_option_meta_box_order_dashboard' ) );
694
695
		// returns HTTPS support status
696
		add_action( 'wp_ajax_jetpack-recheck-ssl', array( $this, 'ajax_recheck_ssl' ) );
697
698
		add_action( 'wp_ajax_jetpack_connection_banner', array( $this, 'jetpack_connection_banner_callback' ) );
699
700
		add_action( 'wp_ajax_jetpack_wizard_banner', array( 'Jetpack_Wizard_Banner', 'ajax_callback' ) );
701
702
		add_action( 'wp_loaded', array( $this, 'register_assets' ) );
703
704
		/**
705
		 * These actions run checks to load additional files.
706
		 * They check for external files or plugins, so they need to run as late as possible.
707
		 */
708
		add_action( 'wp_head', array( $this, 'check_open_graph' ), 1 );
709
		add_action( 'web_stories_story_head', array( $this, 'check_open_graph' ), 1 );
710
		add_action( 'plugins_loaded', array( $this, 'check_twitter_tags' ), 999 );
711
		add_action( 'plugins_loaded', array( $this, 'check_rest_api_compat' ), 1000 );
712
713
		add_filter( 'plugins_url', array( 'Jetpack', 'maybe_min_asset' ), 1, 3 );
714
		add_action( 'style_loader_src', array( 'Jetpack', 'set_suffix_on_min' ), 10, 2 );
715
		add_filter( 'style_loader_tag', array( 'Jetpack', 'maybe_inline_style' ), 10, 2 );
716
717
		add_filter( 'profile_update', array( 'Jetpack', 'user_meta_cleanup' ) );
718
719
		add_filter( 'jetpack_get_default_modules', array( $this, 'filter_default_modules' ) );
720
		add_filter( 'jetpack_get_default_modules', array( $this, 'handle_deprecated_modules' ), 99 );
721
722
		// A filter to control all just in time messages
723
		add_filter( 'jetpack_just_in_time_msgs', '__return_true', 9 );
724
725
		add_filter( 'jetpack_just_in_time_msg_cache', '__return_true', 9 );
726
727
		/*
728
		 * If enabled, point edit post, page, and comment links to Calypso instead of WP-Admin.
729
		 * We should make sure to only do this for front end links.
730
		 */
731
		if ( self::get_option( 'edit_links_calypso_redirect' ) && ! is_admin() ) {
732
			add_filter( 'get_edit_post_link', array( $this, 'point_edit_post_links_to_calypso' ), 1, 2 );
733
			add_filter( 'get_edit_comment_link', array( $this, 'point_edit_comment_links_to_calypso' ), 1 );
734
735
			/*
736
			 * We'll shortcircuit wp_notify_postauthor and wp_notify_moderator pluggable functions
737
			 * so they point moderation links on emails to Calypso.
738
			 */
739
			jetpack_require_lib( 'functions.wp-notify' );
740
			add_filter( 'comment_notification_recipients', 'jetpack_notify_postauthor', 1, 2 );
741
			add_filter( 'notify_moderator', 'jetpack_notify_moderator', 1, 2 );
742
		}
743
744
		add_action(
745
			'plugins_loaded',
746
			function () {
747
				if ( User_Agent_Info::is_mobile_app() ) {
748
					add_filter( 'get_edit_post_link', '__return_empty_string' );
749
				}
750
			}
751
		);
752
753
		// Update the site's Jetpack plan and products from API on heartbeats.
754
		add_action( 'jetpack_heartbeat', array( 'Jetpack_Plan', 'refresh_from_wpcom' ) );
755
756
		/**
757
		 * This is the hack to concatenate all css files into one.
758
		 * For description and reasoning see the implode_frontend_css method.
759
		 *
760
		 * Super late priority so we catch all the registered styles.
761
		 */
762
		if ( ! is_admin() ) {
763
			add_action( 'wp_print_styles', array( $this, 'implode_frontend_css' ), -1 ); // Run first
764
			add_action( 'wp_print_footer_scripts', array( $this, 'implode_frontend_css' ), -1 ); // Run first to trigger before `print_late_styles`
765
		}
766
767
		/**
768
		 * These are sync actions that we need to keep track of for jitms
769
		 */
770
		add_filter( 'jetpack_sync_before_send_updated_option', array( $this, 'jetpack_track_last_sync_callback' ), 99 );
771
772
		// Actually push the stats on shutdown.
773
		if ( ! has_action( 'shutdown', array( $this, 'push_stats' ) ) ) {
774
			add_action( 'shutdown', array( $this, 'push_stats' ) );
775
		}
776
777
		// Actions for Manager::authorize().
778
		add_action( 'jetpack_authorize_starting', array( $this, 'authorize_starting' ) );
779
		add_action( 'jetpack_authorize_ending_linked', array( $this, 'authorize_ending_linked' ) );
780
		add_action( 'jetpack_authorize_ending_authorized', array( $this, 'authorize_ending_authorized' ) );
781
782
		// Filters for the Manager::get_token() urls and request body.
783
		add_filter( 'jetpack_token_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
784
		add_filter( 'jetpack_token_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
785
		add_filter( 'jetpack_token_request_body', array( __CLASS__, 'filter_token_request_body' ) );
786
787
		// Actions for successful reconnect.
788
		add_action( 'jetpack_reconnection_completed', array( $this, 'reconnection_completed' ) );
789
790
		// Actions for licensing.
791
		Licensing::instance()->initialize();
792
793
		// Make resources use static domain when possible.
794
		add_filter( 'jetpack_static_url', array( 'Automattic\\Jetpack\\Assets', 'staticize_subdomain' ) );
795
	}
796
797
	/**
798
	 * Before everything else starts getting initalized, we need to initialize Jetpack using the
799
	 * Config object.
800
	 */
801
	public function configure() {
802
		$config = new Config();
803
804
		foreach (
805
			array(
806
				'sync',
807
			)
808
			as $feature
809
		) {
810
			$config->ensure( $feature );
811
		}
812
813
		$config->ensure(
814
			'connection',
815
			array(
816
				'slug' => 'jetpack',
817
				'name' => 'Jetpack',
818
			)
819
		);
820
821
		if ( is_admin() ) {
822
			$config->ensure( 'jitm' );
823
		}
824
825
		if ( ! $this->connection_manager ) {
826
			$this->connection_manager = new Connection_Manager( 'jetpack' );
827
		}
828
829
		/*
830
		 * Load things that should only be in Network Admin.
831
		 *
832
		 * For now blow away everything else until a more full
833
		 * understanding of what is needed at the network level is
834
		 * available
835
		 */
836
		if ( is_multisite() ) {
837
			$network = Jetpack_Network::init();
838
			$network->set_connection( $this->connection_manager );
839
		}
840
841
		if ( $this->connection_manager->is_active() ) {
842
			add_action( 'login_form_jetpack_json_api_authorization', array( $this, 'login_form_json_api_authorization' ) );
843
844
			Jetpack_Heartbeat::init();
845
			if ( self::is_module_active( 'stats' ) && self::is_module_active( 'search' ) ) {
846
				require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-search-performance-logger.php';
847
				Jetpack_Search_Performance_Logger::init();
848
			}
849
		}
850
851
		// Initialize remote file upload request handlers.
852
		$this->add_remote_request_handlers();
853
854
		/*
855
		 * Enable enhanced handling of previewing sites in Calypso
856
		 */
857
		if ( self::is_active() ) {
858
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-iframe-embed.php';
859
			add_action( 'init', array( 'Jetpack_Iframe_Embed', 'init' ), 9, 0 );
860
			require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-keyring-service-helper.php';
861
			add_action( 'init', array( 'Jetpack_Keyring_Service_Helper', 'init' ), 9, 0 );
862
		}
863
864
		if ( ( new Tracking( $this->connection_manager ) )->should_enable_tracking( new Terms_Of_Service(), new Status() ) ) {
0 ignored issues
show
Documentation introduced by
$this->connection_manager is of type object<Automattic\Jetpack\Connection\Manager>, 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...
Documentation introduced by
new \Automattic\Jetpack\Terms_Of_Service() is of type object<Automattic\Jetpack\Terms_Of_Service>, but the function expects a object<Automattic\Jetpac...tpack\Terms_Of_Service>.

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...
Documentation introduced by
new \Automattic\Jetpack\Status() is of type object<Automattic\Jetpack\Status>, but the function expects a object<Automattic\Jetpac...omattic\Jetpack\Status>.

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...
865
			add_action( 'init', array( new Plugin_Tracking(), 'init' ) );
866
		} else {
867
			/**
868
			 * Initialize tracking right after the user agrees to the terms of service.
869
			 */
870
			add_action( 'jetpack_agreed_to_terms_of_service', array( new Plugin_Tracking(), 'init' ) );
871
		}
872
	}
873
874
	/**
875
	 * Runs on plugins_loaded. Use this to add code that needs to be executed later than other
876
	 * initialization code.
877
	 *
878
	 * @action plugins_loaded
879
	 */
880
	public function late_initialization() {
881
		add_action( 'plugins_loaded', array( 'Jetpack', 'load_modules' ), 100 );
882
883
		Partner::init();
884
885
		/**
886
		 * Fires when Jetpack is fully loaded and ready. This is the point where it's safe
887
		 * to instantiate classes from packages and namespaces that are managed by the Jetpack Autoloader.
888
		 *
889
		 * @since 8.1.0
890
		 *
891
		 * @param Jetpack $jetpack the main plugin class object.
892
		 */
893
		do_action( 'jetpack_loaded', $this );
894
895
		add_filter( 'map_meta_cap', array( $this, 'jetpack_custom_caps' ), 1, 4 );
896
	}
897
898
	/**
899
	 * Sets up the XMLRPC request handlers.
900
	 *
901
	 * @deprecated since 7.7.0
902
	 * @see Automattic\Jetpack\Connection\Manager::setup_xmlrpc_handlers()
903
	 *
904
	 * @param array                 $request_params Incoming request parameters.
905
	 * @param Boolean               $is_active      Whether the connection is currently active.
906
	 * @param Boolean               $is_signed      Whether the signature check has been successful.
907
	 * @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...
908
	 */
909 View Code Duplication
	public function setup_xmlrpc_handlers(
910
		$request_params,
911
		$is_active,
912
		$is_signed,
913
		Jetpack_XMLRPC_Server $xmlrpc_server = null
914
	) {
915
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::setup_xmlrpc_handlers' );
916
917
		if ( ! $this->connection_manager ) {
918
			$this->connection_manager = new Connection_Manager();
919
		}
920
921
		return $this->connection_manager->setup_xmlrpc_handlers(
922
			$request_params,
923
			$is_active,
924
			$is_signed,
925
			$xmlrpc_server
926
		);
927
	}
928
929
	/**
930
	 * Initialize REST API registration connector.
931
	 *
932
	 * @deprecated since 7.7.0
933
	 * @see Automattic\Jetpack\Connection\Manager::initialize_rest_api_registration_connector()
934
	 */
935 View Code Duplication
	public function initialize_rest_api_registration_connector() {
936
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::initialize_rest_api_registration_connector' );
937
938
		if ( ! $this->connection_manager ) {
939
			$this->connection_manager = new Connection_Manager();
940
		}
941
942
		$this->connection_manager->initialize_rest_api_registration_connector();
943
	}
944
945
	/**
946
	 * This is ported over from the manage module, which has been deprecated and baked in here.
947
	 *
948
	 * @param $domains
949
	 */
950
	function add_wpcom_to_allowed_redirect_hosts( $domains ) {
951
		add_filter( 'allowed_redirect_hosts', array( $this, 'allow_wpcom_domain' ) );
952
	}
953
954
	/**
955
	 * Return $domains, with 'wordpress.com' appended.
956
	 * This is ported over from the manage module, which has been deprecated and baked in here.
957
	 *
958
	 * @param $domains
959
	 * @return array
960
	 */
961
	function allow_wpcom_domain( $domains ) {
962
		if ( empty( $domains ) ) {
963
			$domains = array();
964
		}
965
		$domains[] = 'wordpress.com';
966
		return array_unique( $domains );
967
	}
968
969
	function point_edit_post_links_to_calypso( $default_url, $post_id ) {
970
		$post = get_post( $post_id );
971
972
		if ( empty( $post ) ) {
973
			return $default_url;
974
		}
975
976
		$post_type = $post->post_type;
977
978
		// Mapping the allowed CPTs on WordPress.com to corresponding paths in Calypso.
979
		// https://en.support.wordpress.com/custom-post-types/
980
		$allowed_post_types = array(
981
			'post',
982
			'page',
983
			'jetpack-portfolio',
984
			'jetpack-testimonial',
985
		);
986
987
		if ( ! in_array( $post_type, $allowed_post_types, true ) ) {
988
			return $default_url;
989
		}
990
991
		return Redirect::get_url(
992
			'calypso-edit-' . $post_type,
993
			array(
994
				'path' => $post_id,
995
			)
996
		);
997
	}
998
999
	function point_edit_comment_links_to_calypso( $url ) {
1000
		// Take the `query` key value from the URL, and parse its parts to the $query_args. `amp;c` matches the comment ID.
1001
		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...
1002
1003
		return Redirect::get_url(
1004
			'calypso-edit-comment',
1005
			array(
1006
				'path' => $query_args['amp;c'],
1007
			)
1008
		);
1009
1010
	}
1011
1012
	function jetpack_track_last_sync_callback( $params ) {
1013
		/**
1014
		 * Filter to turn off jitm caching
1015
		 *
1016
		 * @since 5.4.0
1017
		 *
1018
		 * @param bool false Whether to cache just in time messages
1019
		 */
1020
		if ( ! apply_filters( 'jetpack_just_in_time_msg_cache', false ) ) {
1021
			return $params;
1022
		}
1023
1024
		if ( is_array( $params ) && isset( $params[0] ) ) {
1025
			$option = $params[0];
1026
			if ( 'active_plugins' === $option ) {
1027
				// use the cache if we can, but not terribly important if it gets evicted
1028
				set_transient( 'jetpack_last_plugin_sync', time(), HOUR_IN_SECONDS );
1029
			}
1030
		}
1031
1032
		return $params;
1033
	}
1034
1035
	function jetpack_connection_banner_callback() {
1036
		check_ajax_referer( 'jp-connection-banner-nonce', 'nonce' );
1037
1038
		// Disable the banner dismiss functionality if the pre-connection prompt helpers filter is set.
1039
		if (
1040
			isset( $_REQUEST['dismissBanner'] ) &&
1041
			! Jetpack_Connection_Banner::force_display()
1042
		) {
1043
			Jetpack_Options::update_option( 'dismissed_connection_banner', 1 );
1044
			wp_send_json_success();
1045
		}
1046
1047
		wp_die();
1048
	}
1049
1050
	/**
1051
	 * Removes all XML-RPC methods that are not `jetpack.*`.
1052
	 * Only used in our alternate XML-RPC endpoint, where we want to
1053
	 * ensure that Core and other plugins' methods are not exposed.
1054
	 *
1055
	 * @deprecated since 7.7.0
1056
	 * @see Automattic\Jetpack\Connection\Manager::remove_non_jetpack_xmlrpc_methods()
1057
	 *
1058
	 * @param array $methods A list of registered WordPress XMLRPC methods.
1059
	 * @return array Filtered $methods
1060
	 */
1061 View Code Duplication
	public function remove_non_jetpack_xmlrpc_methods( $methods ) {
1062
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::remove_non_jetpack_xmlrpc_methods' );
1063
1064
		if ( ! $this->connection_manager ) {
1065
			$this->connection_manager = new Connection_Manager();
1066
		}
1067
1068
		return $this->connection_manager->remove_non_jetpack_xmlrpc_methods( $methods );
1069
	}
1070
1071
	/**
1072
	 * Since a lot of hosts use a hammer approach to "protecting" WordPress sites,
1073
	 * and just blanket block all requests to /xmlrpc.php, or apply other overly-sensitive
1074
	 * security/firewall policies, we provide our own alternate XML RPC API endpoint
1075
	 * which is accessible via a different URI. Most of the below is copied directly
1076
	 * from /xmlrpc.php so that we're replicating it as closely as possible.
1077
	 *
1078
	 * @deprecated since 7.7.0
1079
	 * @see Automattic\Jetpack\Connection\Manager::alternate_xmlrpc()
1080
	 */
1081 View Code Duplication
	public function alternate_xmlrpc() {
1082
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::alternate_xmlrpc' );
1083
1084
		if ( ! $this->connection_manager ) {
1085
			$this->connection_manager = new Connection_Manager();
1086
		}
1087
1088
		$this->connection_manager->alternate_xmlrpc();
1089
	}
1090
1091
	/**
1092
	 * The callback for the JITM ajax requests.
1093
	 *
1094
	 * @deprecated since 7.9.0
1095
	 */
1096
	function jetpack_jitm_ajax_callback() {
1097
		_deprecated_function( __METHOD__, 'jetpack-7.9' );
1098
	}
1099
1100
	/**
1101
	 * If there are any stats that need to be pushed, but haven't been, push them now.
1102
	 */
1103
	function push_stats() {
1104
		if ( ! empty( $this->stats ) ) {
1105
			$this->do_stats( 'server_side' );
1106
		}
1107
	}
1108
1109
	/**
1110
	 * Sets the Jetpack custom capabilities.
1111
	 *
1112
	 * @param string[] $caps    Array of the user's capabilities.
1113
	 * @param string   $cap     Capability name.
1114
	 * @param int      $user_id The user ID.
1115
	 * @param array    $args    Adds the context to the cap. Typically the object ID.
1116
	 */
1117
	public function jetpack_custom_caps( $caps, $cap, $user_id, $args ) {
1118
		$is_offline_mode = ( new Status() )->is_offline_mode();
1119
		switch ( $cap ) {
1120
			case 'jetpack_manage_modules':
1121
			case 'jetpack_activate_modules':
1122
			case 'jetpack_deactivate_modules':
1123
				$caps = array( 'manage_options' );
1124
				break;
1125
			case 'jetpack_configure_modules':
1126
				$caps = array( 'manage_options' );
1127
				break;
1128
			case 'jetpack_manage_autoupdates':
1129
				$caps = array(
1130
					'manage_options',
1131
					'update_plugins',
1132
				);
1133
				break;
1134
			case 'jetpack_network_admin_page':
1135
			case 'jetpack_network_settings_page':
1136
				$caps = array( 'manage_network_plugins' );
1137
				break;
1138
			case 'jetpack_network_sites_page':
1139
				$caps = array( 'manage_sites' );
1140
				break;
1141
			case 'jetpack_admin_page':
1142
				if ( $is_offline_mode ) {
1143
					$caps = array( 'manage_options' );
1144
					break;
1145
				} else {
1146
					$caps = array( 'read' );
1147
				}
1148
				break;
1149
		}
1150
		return $caps;
1151
	}
1152
1153
	/**
1154
	 * Require a Jetpack authentication.
1155
	 *
1156
	 * @deprecated since 7.7.0
1157
	 * @see Automattic\Jetpack\Connection\Manager::require_jetpack_authentication()
1158
	 */
1159 View Code Duplication
	public function require_jetpack_authentication() {
1160
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::require_jetpack_authentication' );
1161
1162
		if ( ! $this->connection_manager ) {
1163
			$this->connection_manager = new Connection_Manager();
1164
		}
1165
1166
		$this->connection_manager->require_jetpack_authentication();
1167
	}
1168
1169
	/**
1170
	 * Register assets for use in various modules and the Jetpack admin page.
1171
	 *
1172
	 * @uses wp_script_is, wp_register_script, plugins_url
1173
	 * @action wp_loaded
1174
	 * @return null
1175
	 */
1176
	public function register_assets() {
1177 View Code Duplication
		if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
1178
			wp_register_script(
1179
				'jetpack-gallery-settings',
1180
				Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
1181
				array( 'media-views' ),
1182
				'20121225'
1183
			);
1184
		}
1185
1186
		if ( ! wp_script_is( 'jetpack-twitter-timeline', 'registered' ) ) {
1187
			wp_register_script(
1188
				'jetpack-twitter-timeline',
1189
				Assets::get_file_url_for_environment( '_inc/build/twitter-timeline.min.js', '_inc/twitter-timeline.js' ),
1190
				array( 'jquery' ),
1191
				'4.0.0',
1192
				true
1193
			);
1194
		}
1195
1196
		if ( ! wp_script_is( 'jetpack-facebook-embed', 'registered' ) ) {
1197
			wp_register_script(
1198
				'jetpack-facebook-embed',
1199
				Assets::get_file_url_for_environment( '_inc/build/facebook-embed.min.js', '_inc/facebook-embed.js' ),
1200
				array(),
1201
				null,
1202
				true
1203
			);
1204
1205
			/** This filter is documented in modules/sharedaddy/sharing-sources.php */
1206
			$fb_app_id = apply_filters( 'jetpack_sharing_facebook_app_id', '249643311490' );
1207
			if ( ! is_numeric( $fb_app_id ) ) {
1208
				$fb_app_id = '';
1209
			}
1210
			wp_localize_script(
1211
				'jetpack-facebook-embed',
1212
				'jpfbembed',
1213
				array(
1214
					'appid'  => $fb_app_id,
1215
					'locale' => $this->get_locale(),
1216
				)
1217
			);
1218
		}
1219
1220
		/**
1221
		 * As jetpack_register_genericons is by default fired off a hook,
1222
		 * the hook may have already fired by this point.
1223
		 * So, let's just trigger it manually.
1224
		 */
1225
		require_once JETPACK__PLUGIN_DIR . '_inc/genericons.php';
1226
		jetpack_register_genericons();
1227
1228
		/**
1229
		 * Register the social logos
1230
		 */
1231
		require_once JETPACK__PLUGIN_DIR . '_inc/social-logos.php';
1232
		jetpack_register_social_logos();
1233
1234 View Code Duplication
		if ( ! wp_style_is( 'jetpack-icons', 'registered' ) ) {
1235
			wp_register_style( 'jetpack-icons', plugins_url( 'css/jetpack-icons.min.css', JETPACK__PLUGIN_FILE ), false, JETPACK__VERSION );
1236
		}
1237
	}
1238
1239
	/**
1240
	 * Guess locale from language code.
1241
	 *
1242
	 * @param string $lang Language code.
1243
	 * @return string|bool
1244
	 */
1245 View Code Duplication
	function guess_locale_from_lang( $lang ) {
1246
		if ( 'en' === $lang || 'en_US' === $lang || ! $lang ) {
1247
			return 'en_US';
1248
		}
1249
1250
		if ( ! class_exists( 'GP_Locales' ) ) {
1251
			if ( ! defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' ) || ! file_exists( JETPACK__GLOTPRESS_LOCALES_PATH ) ) {
1252
				return false;
1253
			}
1254
1255
			require JETPACK__GLOTPRESS_LOCALES_PATH;
1256
		}
1257
1258
		if ( defined( 'IS_WPCOM' ) && IS_WPCOM ) {
1259
			// WP.com: get_locale() returns 'it'
1260
			$locale = GP_Locales::by_slug( $lang );
1261
		} else {
1262
			// Jetpack: get_locale() returns 'it_IT';
1263
			$locale = GP_Locales::by_field( 'facebook_locale', $lang );
1264
		}
1265
1266
		if ( ! $locale ) {
1267
			return false;
1268
		}
1269
1270
		if ( empty( $locale->facebook_locale ) ) {
1271
			if ( empty( $locale->wp_locale ) ) {
1272
				return false;
1273
			} else {
1274
				// Facebook SDK is smart enough to fall back to en_US if a
1275
				// locale isn't supported. Since supported Facebook locales
1276
				// can fall out of sync, we'll attempt to use the known
1277
				// wp_locale value and rely on said fallback.
1278
				return $locale->wp_locale;
1279
			}
1280
		}
1281
1282
		return $locale->facebook_locale;
1283
	}
1284
1285
	/**
1286
	 * Get the locale.
1287
	 *
1288
	 * @return string|bool
1289
	 */
1290
	function get_locale() {
1291
		$locale = $this->guess_locale_from_lang( get_locale() );
1292
1293
		if ( ! $locale ) {
1294
			$locale = 'en_US';
1295
		}
1296
1297
		return $locale;
1298
	}
1299
1300
	/**
1301
	 * Return the network_site_url so that .com knows what network this site is a part of.
1302
	 *
1303
	 * @param  bool $option
1304
	 * @return string
1305
	 */
1306
	public function jetpack_main_network_site_option( $option ) {
1307
		return network_site_url();
1308
	}
1309
	/**
1310
	 * Network Name.
1311
	 */
1312
	static function network_name( $option = null ) {
1313
		global $current_site;
1314
		return $current_site->site_name;
1315
	}
1316
	/**
1317
	 * Does the network allow new user and site registrations.
1318
	 *
1319
	 * @return string
1320
	 */
1321
	static function network_allow_new_registrations( $option = null ) {
1322
		return ( in_array( get_site_option( 'registration' ), array( 'none', 'user', 'blog', 'all' ) ) ? get_site_option( 'registration' ) : 'none' );
1323
	}
1324
	/**
1325
	 * Does the network allow admins to add new users.
1326
	 *
1327
	 * @return boolian
1328
	 */
1329
	static function network_add_new_users( $option = null ) {
1330
		return (bool) get_site_option( 'add_new_users' );
1331
	}
1332
	/**
1333
	 * File upload psace left per site in MB.
1334
	 *  -1 means NO LIMIT.
1335
	 *
1336
	 * @return number
1337
	 */
1338
	static function network_site_upload_space( $option = null ) {
1339
		// value in MB
1340
		return ( get_site_option( 'upload_space_check_disabled' ) ? -1 : get_space_allowed() );
1341
	}
1342
1343
	/**
1344
	 * Network allowed file types.
1345
	 *
1346
	 * @return string
1347
	 */
1348
	static function network_upload_file_types( $option = null ) {
1349
		return get_site_option( 'upload_filetypes', 'jpg jpeg png gif' );
1350
	}
1351
1352
	/**
1353
	 * Maximum file upload size set by the network.
1354
	 *
1355
	 * @return number
1356
	 */
1357
	static function network_max_upload_file_size( $option = null ) {
1358
		// value in KB
1359
		return get_site_option( 'fileupload_maxk', 300 );
1360
	}
1361
1362
	/**
1363
	 * Lets us know if a site allows admins to manage the network.
1364
	 *
1365
	 * @return array
1366
	 */
1367
	static function network_enable_administration_menus( $option = null ) {
1368
		return get_site_option( 'menu_items' );
1369
	}
1370
1371
	/**
1372
	 * If a user has been promoted to or demoted from admin, we need to clear the
1373
	 * jetpack_other_linked_admins transient.
1374
	 *
1375
	 * @since 4.3.2
1376
	 * @since 4.4.0  $old_roles is null by default and if it's not passed, the transient is cleared.
1377
	 *
1378
	 * @param int    $user_id   The user ID whose role changed.
1379
	 * @param string $role      The new role.
1380
	 * @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...
1381
	 */
1382
	function maybe_clear_other_linked_admins_transient( $user_id, $role, $old_roles = null ) {
1383
		if ( 'administrator' == $role
1384
			|| ( is_array( $old_roles ) && in_array( 'administrator', $old_roles ) )
1385
			|| is_null( $old_roles )
1386
		) {
1387
			delete_transient( 'jetpack_other_linked_admins' );
1388
		}
1389
	}
1390
1391
	/**
1392
	 * Checks to see if there are any other users available to become primary
1393
	 * Users must both:
1394
	 * - Be linked to wpcom
1395
	 * - Be an admin
1396
	 *
1397
	 * @return mixed False if no other users are linked, Int if there are.
1398
	 */
1399
	static function get_other_linked_admins() {
1400
		$other_linked_users = get_transient( 'jetpack_other_linked_admins' );
1401
1402
		if ( false === $other_linked_users ) {
1403
			$admins = get_users( array( 'role' => 'administrator' ) );
1404
			if ( count( $admins ) > 1 ) {
1405
				$available = array();
1406
				foreach ( $admins as $admin ) {
1407
					if ( self::is_user_connected( $admin->ID ) ) {
1408
						$available[] = $admin->ID;
1409
					}
1410
				}
1411
1412
				$count_connected_admins = count( $available );
1413
				if ( count( $available ) > 1 ) {
1414
					$other_linked_users = $count_connected_admins;
1415
				} else {
1416
					$other_linked_users = 0;
1417
				}
1418
			} else {
1419
				$other_linked_users = 0;
1420
			}
1421
1422
			set_transient( 'jetpack_other_linked_admins', $other_linked_users, HOUR_IN_SECONDS );
1423
		}
1424
1425
		return ( 0 === $other_linked_users ) ? false : $other_linked_users;
1426
	}
1427
1428
	/**
1429
	 * Return whether we are dealing with a multi network setup or not.
1430
	 * The reason we are type casting this is because we want to avoid the situation where
1431
	 * the result is false since when is_main_network_option return false it cases
1432
	 * the rest the get_option( 'jetpack_is_multi_network' ); to return the value that is set in the
1433
	 * database which could be set to anything as opposed to what this function returns.
1434
	 *
1435
	 * @param  bool $option
1436
	 *
1437
	 * @return boolean
1438
	 */
1439
	public function is_main_network_option( $option ) {
1440
		// return '1' or ''
1441
		return (string) (bool) self::is_multi_network();
1442
	}
1443
1444
	/**
1445
	 * Return true if we are with multi-site or multi-network false if we are dealing with single site.
1446
	 *
1447
	 * @param  string $option
1448
	 * @return boolean
1449
	 */
1450
	public function is_multisite( $option ) {
1451
		return (string) (bool) is_multisite();
1452
	}
1453
1454
	/**
1455
	 * Implemented since there is no core is multi network function
1456
	 * Right now there is no way to tell if we which network is the dominant network on the system
1457
	 *
1458
	 * @since  3.3
1459
	 * @return boolean
1460
	 */
1461 View Code Duplication
	public static function is_multi_network() {
1462
		global  $wpdb;
1463
1464
		// if we don't have a multi site setup no need to do any more
1465
		if ( ! is_multisite() ) {
1466
			return false;
1467
		}
1468
1469
		$num_sites = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->site}" );
1470
		if ( $num_sites > 1 ) {
1471
			return true;
1472
		} else {
1473
			return false;
1474
		}
1475
	}
1476
1477
	/**
1478
	 * Trigger an update to the main_network_site when we update the siteurl of a site.
1479
	 *
1480
	 * @return null
1481
	 */
1482
	function update_jetpack_main_network_site_option() {
1483
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1484
	}
1485
	/**
1486
	 * Triggered after a user updates the network settings via Network Settings Admin Page
1487
	 */
1488
	function update_jetpack_network_settings() {
1489
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1490
		// Only sync this info for the main network site.
1491
	}
1492
1493
	/**
1494
	 * Get back if the current site is single user site.
1495
	 *
1496
	 * @return bool
1497
	 */
1498 View Code Duplication
	public static function is_single_user_site() {
1499
		global $wpdb;
1500
1501
		if ( false === ( $some_users = get_transient( 'jetpack_is_single_user' ) ) ) {
1502
			$some_users = $wpdb->get_var( "SELECT COUNT(*) FROM (SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities' LIMIT 2) AS someusers" );
1503
			set_transient( 'jetpack_is_single_user', (int) $some_users, 12 * HOUR_IN_SECONDS );
1504
		}
1505
		return 1 === (int) $some_users;
1506
	}
1507
1508
	/**
1509
	 * Returns true if the site has file write access false otherwise.
1510
	 *
1511
	 * @return string ( '1' | '0' )
1512
	 **/
1513
	public static function file_system_write_access() {
1514
		if ( ! function_exists( 'get_filesystem_method' ) ) {
1515
			require_once ABSPATH . 'wp-admin/includes/file.php';
1516
		}
1517
1518
		require_once ABSPATH . 'wp-admin/includes/template.php';
1519
1520
		$filesystem_method = get_filesystem_method();
1521
		if ( $filesystem_method === 'direct' ) {
1522
			return 1;
1523
		}
1524
1525
		ob_start();
1526
		$filesystem_credentials_are_stored = request_filesystem_credentials( self_admin_url() );
1527
		ob_end_clean();
1528
		if ( $filesystem_credentials_are_stored ) {
1529
			return 1;
1530
		}
1531
		return 0;
1532
	}
1533
1534
	/**
1535
	 * Finds out if a site is using a version control system.
1536
	 *
1537
	 * @return string ( '1' | '0' )
1538
	 **/
1539
	public static function is_version_controlled() {
1540
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Functions::is_version_controlled' );
1541
		return (string) (int) Functions::is_version_controlled();
1542
	}
1543
1544
	/**
1545
	 * Determines whether the current theme supports featured images or not.
1546
	 *
1547
	 * @return string ( '1' | '0' )
1548
	 */
1549
	public static function featured_images_enabled() {
1550
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1551
		return current_theme_supports( 'post-thumbnails' ) ? '1' : '0';
1552
	}
1553
1554
	/**
1555
	 * Wrapper for core's get_avatar_url().  This one is deprecated.
1556
	 *
1557
	 * @deprecated 4.7 use get_avatar_url instead.
1558
	 * @param int|string|object $id_or_email A user ID,  email address, or comment object
1559
	 * @param int               $size Size of the avatar image
1560
	 * @param string            $default URL to a default image to use if no avatar is available
1561
	 * @param bool              $force_display Whether to force it to return an avatar even if show_avatars is disabled
1562
	 *
1563
	 * @return array
1564
	 */
1565
	public static function get_avatar_url( $id_or_email, $size = 96, $default = '', $force_display = false ) {
1566
		_deprecated_function( __METHOD__, 'jetpack-4.7', 'get_avatar_url' );
1567
		return get_avatar_url(
1568
			$id_or_email,
1569
			array(
1570
				'size'          => $size,
1571
				'default'       => $default,
1572
				'force_default' => $force_display,
1573
			)
1574
		);
1575
	}
1576
// phpcs:disable WordPress.WP.CapitalPDangit.Misspelled
1577
	/**
1578
	 * jetpack_updates is saved in the following schema:
1579
	 *
1580
	 * array (
1581
	 *      'plugins'                       => (int) Number of plugin updates available.
1582
	 *      'themes'                        => (int) Number of theme updates available.
1583
	 *      'wordpress'                     => (int) Number of WordPress core updates available.
1584
	 *      'translations'                  => (int) Number of translation updates available.
1585
	 *      'total'                         => (int) Total of all available updates.
1586
	 *      'wp_update_version'             => (string) The latest available version of WordPress, only present if a WordPress update is needed.
1587
	 * )
1588
	 *
1589
	 * @return array
1590
	 */
1591
	public static function get_updates() {
1592
		$update_data = wp_get_update_data();
1593
1594
		// Stores the individual update counts as well as the total count.
1595
		if ( isset( $update_data['counts'] ) ) {
1596
			$updates = $update_data['counts'];
1597
		}
1598
1599
		// If we need to update WordPress core, let's find the latest version number.
1600 View Code Duplication
		if ( ! empty( $updates['wordpress'] ) ) {
1601
			$cur = get_preferred_from_update_core();
1602
			if ( isset( $cur->response ) && 'upgrade' === $cur->response ) {
1603
				$updates['wp_update_version'] = $cur->current;
1604
			}
1605
		}
1606
		return isset( $updates ) ? $updates : array();
1607
	}
1608
	// phpcs:enable
1609
1610
	public static function get_update_details() {
1611
		$update_details = array(
1612
			'update_core'    => get_site_transient( 'update_core' ),
1613
			'update_plugins' => get_site_transient( 'update_plugins' ),
1614
			'update_themes'  => get_site_transient( 'update_themes' ),
1615
		);
1616
		return $update_details;
1617
	}
1618
1619
	public static function refresh_update_data() {
1620
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1621
1622
	}
1623
1624
	public static function refresh_theme_data() {
1625
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
1626
	}
1627
1628
	/**
1629
	 * Is Jetpack active?
1630
	 * The method only checks if there's an existing token for the master user. It doesn't validate the token.
1631
	 *
1632
	 * @return bool
1633
	 */
1634
	public static function is_active() {
1635
		return self::connection()->is_active();
1636
	}
1637
1638
	/**
1639
	 * Make an API call to WordPress.com for plan status
1640
	 *
1641
	 * @deprecated 7.2.0 Use Jetpack_Plan::refresh_from_wpcom.
1642
	 *
1643
	 * @return bool True if plan is updated, false if no update
1644
	 */
1645
	public static function refresh_active_plan_from_wpcom() {
1646
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::refresh_from_wpcom' );
1647
		return Jetpack_Plan::refresh_from_wpcom();
1648
	}
1649
1650
	/**
1651
	 * Get the plan that this Jetpack site is currently using
1652
	 *
1653
	 * @deprecated 7.2.0 Use Jetpack_Plan::get.
1654
	 * @return array Active Jetpack plan details.
1655
	 */
1656
	public static function get_active_plan() {
1657
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::get' );
1658
		return Jetpack_Plan::get();
1659
	}
1660
1661
	/**
1662
	 * Determine whether the active plan supports a particular feature
1663
	 *
1664
	 * @deprecated 7.2.0 Use Jetpack_Plan::supports.
1665
	 * @return bool True if plan supports feature, false if not.
1666
	 */
1667
	public static function active_plan_supports( $feature ) {
1668
		_deprecated_function( __METHOD__, 'jetpack-7.2.0', 'Jetpack_Plan::supports' );
1669
		return Jetpack_Plan::supports( $feature );
1670
	}
1671
1672
	/**
1673
	 * Deprecated: Is Jetpack in development (offline) mode?
1674
	 *
1675
	 * This static method is being left here intentionally without the use of _deprecated_function(), as other plugins
1676
	 * and themes still use it, and we do not want to flood them with notices.
1677
	 *
1678
	 * Please use Automattic\Jetpack\Status()->is_offline_mode() instead.
1679
	 *
1680
	 * @deprecated since 8.0.
1681
	 */
1682
	public static function is_development_mode() {
1683
		return ( new Status() )->is_offline_mode();
1684
	}
1685
1686
	/**
1687
	 * Whether the site is currently onboarding or not.
1688
	 * A site is considered as being onboarded if it currently has an onboarding token.
1689
	 *
1690
	 * @since 5.8
1691
	 *
1692
	 * @access public
1693
	 * @static
1694
	 *
1695
	 * @return bool True if the site is currently onboarding, false otherwise
1696
	 */
1697
	public static function is_onboarding() {
1698
		return Jetpack_Options::get_option( 'onboarding' ) !== false;
1699
	}
1700
1701
	/**
1702
	 * Determines reason for Jetpack offline mode.
1703
	 */
1704
	public static function development_mode_trigger_text() {
1705
		$status = new Status();
1706
1707
		if ( ! $status->is_offline_mode() ) {
1708
			return __( 'Jetpack is not in Offline Mode.', 'jetpack' );
1709
		}
1710
1711
		if ( defined( 'JETPACK_DEV_DEBUG' ) && JETPACK_DEV_DEBUG ) {
1712
			$notice = __( 'The JETPACK_DEV_DEBUG constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1713
		} elseif ( defined( 'WP_LOCAL_DEV' ) && WP_LOCAL_DEV ) {
1714
			$notice = __( 'The WP_LOCAL_DEV constant is defined in wp-config.php or elsewhere.', 'jetpack' );
1715
		} elseif ( $status->is_local_site() ) {
1716
			$notice = __( 'The site URL is a known local development environment URL (e.g. http://localhost).', 'jetpack' );
1717
			/** This filter is documented in packages/status/src/class-status.php */
1718
		} elseif ( has_filter( 'jetpack_development_mode' ) && apply_filters( 'jetpack_development_mode', false ) ) { // This is a deprecated filter name.
1719
			$notice = __( 'The jetpack_development_mode filter is set to true.', 'jetpack' );
1720
		} else {
1721
			$notice = __( 'The jetpack_offline_mode filter is set to true.', 'jetpack' );
1722
		}
1723
1724
		return $notice;
1725
1726
	}
1727
	/**
1728
	 * Get Jetpack offline mode notice text and notice class.
1729
	 *
1730
	 * Mirrors the checks made in Automattic\Jetpack\Status->is_offline_mode
1731
	 */
1732
	public static function show_development_mode_notice() {
1733 View Code Duplication
		if ( ( new Status() )->is_offline_mode() ) {
1734
			$notice = sprintf(
1735
				/* translators: %s is a URL */
1736
				__( 'In <a href="%s" target="_blank">Offline Mode</a>:', 'jetpack' ),
1737
				Redirect::get_url( 'jetpack-support-development-mode' )
1738
			);
1739
1740
			$notice .= ' ' . self::development_mode_trigger_text();
1741
1742
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1743
		}
1744
1745
		// Throw up a notice if using a development version and as for feedback.
1746
		if ( self::is_development_version() ) {
1747
			/* translators: %s is a URL */
1748
			$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' ) );
1749
1750
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1751
		}
1752
		// Throw up a notice if using staging mode
1753 View Code Duplication
		if ( ( new Status() )->is_staging_site() ) {
1754
			/* translators: %s is a URL */
1755
			$notice = sprintf( __( 'You are running Jetpack on a <a href="%s" target="_blank">staging server</a>.', 'jetpack' ), Redirect::get_url( 'jetpack-support-staging-sites' ) );
1756
1757
			echo '<div class="updated" style="border-color: #f0821e;"><p>' . $notice . '</p></div>';
1758
		}
1759
	}
1760
1761
	/**
1762
	 * Whether Jetpack's version maps to a public release, or a development version.
1763
	 */
1764
	public static function is_development_version() {
1765
		/**
1766
		 * Allows filtering whether this is a development version of Jetpack.
1767
		 *
1768
		 * This filter is especially useful for tests.
1769
		 *
1770
		 * @since 4.3.0
1771
		 *
1772
		 * @param bool $development_version Is this a develoment version of Jetpack?
1773
		 */
1774
		return (bool) apply_filters(
1775
			'jetpack_development_version',
1776
			! preg_match( '/^\d+(\.\d+)+$/', Constants::get_constant( 'JETPACK__VERSION' ) )
1777
		);
1778
	}
1779
1780
	/**
1781
	 * Is a given user (or the current user if none is specified) linked to a WordPress.com user?
1782
	 */
1783
	public static function is_user_connected( $user_id = false ) {
1784
		return self::connection()->is_user_connected( $user_id );
0 ignored issues
show
Documentation introduced by
$user_id is of type boolean, but the function expects a false|integer.

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...
1785
	}
1786
1787
	/**
1788
	 * Get the wpcom user data of the current|specified connected user.
1789
	 */
1790 View Code Duplication
	public static function get_connected_user_data( $user_id = null ) {
1791
		// TODO: remove in favor of Connection_Manager->get_connected_user_data
1792
		if ( ! $user_id ) {
1793
			$user_id = get_current_user_id();
1794
		}
1795
1796
		$transient_key = "jetpack_connected_user_data_$user_id";
1797
1798
		if ( $cached_user_data = get_transient( $transient_key ) ) {
1799
			return $cached_user_data;
1800
		}
1801
1802
		$xml = new Jetpack_IXR_Client(
1803
			array(
1804
				'user_id' => $user_id,
1805
			)
1806
		);
1807
		$xml->query( 'wpcom.getUser' );
1808
		if ( ! $xml->isError() ) {
1809
			$user_data = $xml->getResponse();
1810
			set_transient( $transient_key, $xml->getResponse(), DAY_IN_SECONDS );
1811
			return $user_data;
1812
		}
1813
1814
		return false;
1815
	}
1816
1817
	/**
1818
	 * Get the wpcom email of the current|specified connected user.
1819
	 */
1820
	public static function get_connected_user_email( $user_id = null ) {
1821
		if ( ! $user_id ) {
1822
			$user_id = get_current_user_id();
1823
		}
1824
1825
		$xml = new Jetpack_IXR_Client(
1826
			array(
1827
				'user_id' => $user_id,
1828
			)
1829
		);
1830
		$xml->query( 'wpcom.getUserEmail' );
1831
		if ( ! $xml->isError() ) {
1832
			return $xml->getResponse();
1833
		}
1834
		return false;
1835
	}
1836
1837
	/**
1838
	 * Get the wpcom email of the master user.
1839
	 */
1840
	public static function get_master_user_email() {
1841
		$master_user_id = Jetpack_Options::get_option( 'master_user' );
1842
		if ( $master_user_id ) {
1843
			return self::get_connected_user_email( $master_user_id );
1844
		}
1845
		return '';
1846
	}
1847
1848
	/**
1849
	 * Whether the current user is the connection owner.
1850
	 *
1851
	 * @deprecated since 7.7
1852
	 *
1853
	 * @return bool Whether the current user is the connection owner.
1854
	 */
1855
	public function current_user_is_connection_owner() {
1856
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::is_connection_owner' );
1857
		return self::connection()->is_connection_owner();
1858
	}
1859
1860
	/**
1861
	 * Gets current user IP address.
1862
	 *
1863
	 * @param  bool $check_all_headers Check all headers? Default is `false`.
1864
	 *
1865
	 * @return string                  Current user IP address.
1866
	 */
1867
	public static function current_user_ip( $check_all_headers = false ) {
1868
		if ( $check_all_headers ) {
1869
			foreach ( array(
1870
				'HTTP_CF_CONNECTING_IP',
1871
				'HTTP_CLIENT_IP',
1872
				'HTTP_X_FORWARDED_FOR',
1873
				'HTTP_X_FORWARDED',
1874
				'HTTP_X_CLUSTER_CLIENT_IP',
1875
				'HTTP_FORWARDED_FOR',
1876
				'HTTP_FORWARDED',
1877
				'HTTP_VIA',
1878
			) as $key ) {
1879
				if ( ! empty( $_SERVER[ $key ] ) ) {
1880
					return $_SERVER[ $key ];
1881
				}
1882
			}
1883
		}
1884
1885
		return ! empty( $_SERVER['REMOTE_ADDR'] ) ? $_SERVER['REMOTE_ADDR'] : '';
1886
	}
1887
1888
	/**
1889
	 * Synchronize connected user role changes
1890
	 */
1891
	function user_role_change( $user_id ) {
1892
		_deprecated_function( __METHOD__, 'jetpack-4.2', 'Users::user_role_change()' );
1893
		Users::user_role_change( $user_id );
1894
	}
1895
1896
	/**
1897
	 * Loads the currently active modules.
1898
	 */
1899
	public static function load_modules() {
1900
		$is_offline_mode = ( new Status() )->is_offline_mode();
1901
		if (
1902
			! self::is_active()
1903
			&& ! $is_offline_mode
1904
			&& ! self::is_onboarding()
1905
			&& (
1906
				! is_multisite()
1907
				|| ! get_site_option( 'jetpack_protect_active' )
1908
			)
1909
		) {
1910
			return;
1911
		}
1912
1913
		$version = Jetpack_Options::get_option( 'version' );
1914 View Code Duplication
		if ( ! $version ) {
1915
			$version = $old_version = JETPACK__VERSION . ':' . time();
1916
			/** This action is documented in class.jetpack.php */
1917
			do_action( 'updating_jetpack_version', $version, false );
1918
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
1919
		}
1920
		list( $version ) = explode( ':', $version );
1921
1922
		$modules = array_filter( self::get_active_modules(), array( 'Jetpack', 'is_module' ) );
1923
1924
		$modules_data = array();
1925
1926
		// Don't load modules that have had "Major" changes since the stored version until they have been deactivated/reactivated through the lint check.
1927
		if ( version_compare( $version, JETPACK__VERSION, '<' ) ) {
1928
			$updated_modules = array();
1929
			foreach ( $modules as $module ) {
1930
				$modules_data[ $module ] = self::get_module( $module );
1931
				if ( ! isset( $modules_data[ $module ]['changed'] ) ) {
1932
					continue;
1933
				}
1934
1935
				if ( version_compare( $modules_data[ $module ]['changed'], $version, '<=' ) ) {
1936
					continue;
1937
				}
1938
1939
				$updated_modules[] = $module;
1940
			}
1941
1942
			$modules = array_diff( $modules, $updated_modules );
1943
		}
1944
1945
		foreach ( $modules as $index => $module ) {
1946
			// If we're in offline mode, disable modules requiring a connection.
1947
			if ( $is_offline_mode ) {
1948
				// Prime the pump if we need to
1949
				if ( empty( $modules_data[ $module ] ) ) {
1950
					$modules_data[ $module ] = self::get_module( $module );
1951
				}
1952
				// If the module requires a connection, but we're in local mode, don't include it.
1953
				if ( $modules_data[ $module ]['requires_connection'] ) {
1954
					continue;
1955
				}
1956
			}
1957
1958
			if ( did_action( 'jetpack_module_loaded_' . $module ) ) {
1959
				continue;
1960
			}
1961
1962
			if ( ! include_once self::get_module_path( $module ) ) {
1963
				unset( $modules[ $index ] );
1964
				self::update_active_modules( array_values( $modules ) );
1965
				continue;
1966
			}
1967
1968
			/**
1969
			 * Fires when a specific module is loaded.
1970
			 * The dynamic part of the hook, $module, is the module slug.
1971
			 *
1972
			 * @since 1.1.0
1973
			 */
1974
			do_action( 'jetpack_module_loaded_' . $module );
1975
		}
1976
1977
		/**
1978
		 * Fires when all the modules are loaded.
1979
		 *
1980
		 * @since 1.1.0
1981
		 */
1982
		do_action( 'jetpack_modules_loaded' );
1983
1984
		// 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.
1985
		require_once JETPACK__PLUGIN_DIR . 'modules/module-extras.php';
1986
	}
1987
1988
	/**
1989
	 * Check if Jetpack's REST API compat file should be included
1990
	 *
1991
	 * @action plugins_loaded
1992
	 * @return null
1993
	 */
1994
	public function check_rest_api_compat() {
1995
		/**
1996
		 * Filters the list of REST API compat files to be included.
1997
		 *
1998
		 * @since 2.2.5
1999
		 *
2000
		 * @param array $args Array of REST API compat files to include.
2001
		 */
2002
		$_jetpack_rest_api_compat_includes = apply_filters( 'jetpack_rest_api_compat', array() );
2003
2004
		foreach ( $_jetpack_rest_api_compat_includes as $_jetpack_rest_api_compat_include ) {
2005
			require_once $_jetpack_rest_api_compat_include;
2006
		}
2007
	}
2008
2009
	/**
2010
	 * Gets all plugins currently active in values, regardless of whether they're
2011
	 * traditionally activated or network activated.
2012
	 *
2013
	 * @todo Store the result in core's object cache maybe?
2014
	 */
2015
	public static function get_active_plugins() {
2016
		$active_plugins = (array) get_option( 'active_plugins', array() );
2017
2018
		if ( is_multisite() ) {
2019
			// Due to legacy code, active_sitewide_plugins stores them in the keys,
2020
			// whereas active_plugins stores them in the values.
2021
			$network_plugins = array_keys( get_site_option( 'active_sitewide_plugins', array() ) );
2022
			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...
2023
				$active_plugins = array_merge( $active_plugins, $network_plugins );
2024
			}
2025
		}
2026
2027
		sort( $active_plugins );
2028
2029
		return array_unique( $active_plugins );
2030
	}
2031
2032
	/**
2033
	 * Gets and parses additional plugin data to send with the heartbeat data
2034
	 *
2035
	 * @since 3.8.1
2036
	 *
2037
	 * @return array Array of plugin data
2038
	 */
2039
	public static function get_parsed_plugin_data() {
2040
		if ( ! function_exists( 'get_plugins' ) ) {
2041
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
2042
		}
2043
		/** This filter is documented in wp-admin/includes/class-wp-plugins-list-table.php */
2044
		$all_plugins    = apply_filters( 'all_plugins', get_plugins() );
2045
		$active_plugins = self::get_active_plugins();
2046
2047
		$plugins = array();
2048
		foreach ( $all_plugins as $path => $plugin_data ) {
2049
			$plugins[ $path ] = array(
2050
				'is_active' => in_array( $path, $active_plugins ),
2051
				'file'      => $path,
2052
				'name'      => $plugin_data['Name'],
2053
				'version'   => $plugin_data['Version'],
2054
				'author'    => $plugin_data['Author'],
2055
			);
2056
		}
2057
2058
		return $plugins;
2059
	}
2060
2061
	/**
2062
	 * Gets and parses theme data to send with the heartbeat data
2063
	 *
2064
	 * @since 3.8.1
2065
	 *
2066
	 * @return array Array of theme data
2067
	 */
2068
	public static function get_parsed_theme_data() {
2069
		$all_themes  = wp_get_themes( array( 'allowed' => true ) );
2070
		$header_keys = array( 'Name', 'Author', 'Version', 'ThemeURI', 'AuthorURI', 'Status', 'Tags' );
2071
2072
		$themes = array();
2073
		foreach ( $all_themes as $slug => $theme_data ) {
2074
			$theme_headers = array();
2075
			foreach ( $header_keys as $header_key ) {
2076
				$theme_headers[ $header_key ] = $theme_data->get( $header_key );
2077
			}
2078
2079
			$themes[ $slug ] = array(
2080
				'is_active_theme' => $slug == wp_get_theme()->get_template(),
2081
				'slug'            => $slug,
2082
				'theme_root'      => $theme_data->get_theme_root_uri(),
2083
				'parent'          => $theme_data->parent(),
2084
				'headers'         => $theme_headers,
2085
			);
2086
		}
2087
2088
		return $themes;
2089
	}
2090
2091
	/**
2092
	 * Checks whether a specific plugin is active.
2093
	 *
2094
	 * We don't want to store these in a static variable, in case
2095
	 * there are switch_to_blog() calls involved.
2096
	 */
2097
	public static function is_plugin_active( $plugin = 'jetpack/jetpack.php' ) {
2098
		return in_array( $plugin, self::get_active_plugins() );
2099
	}
2100
2101
	/**
2102
	 * Check if Jetpack's Open Graph tags should be used.
2103
	 * If certain plugins are active, Jetpack's og tags are suppressed.
2104
	 *
2105
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2106
	 * @action plugins_loaded
2107
	 * @return null
2108
	 */
2109
	public function check_open_graph() {
2110
		if ( in_array( 'publicize', self::get_active_modules() ) || in_array( 'sharedaddy', self::get_active_modules() ) ) {
2111
			add_filter( 'jetpack_enable_open_graph', '__return_true', 0 );
2112
		}
2113
2114
		$active_plugins = self::get_active_plugins();
2115
2116
		if ( ! empty( $active_plugins ) ) {
2117
			foreach ( $this->open_graph_conflicting_plugins as $plugin ) {
2118
				if ( in_array( $plugin, $active_plugins ) ) {
2119
					add_filter( 'jetpack_enable_open_graph', '__return_false', 99 );
2120
					break;
2121
				}
2122
			}
2123
		}
2124
2125
		/**
2126
		 * Allow the addition of Open Graph Meta Tags to all pages.
2127
		 *
2128
		 * @since 2.0.3
2129
		 *
2130
		 * @param bool false Should Open Graph Meta tags be added. Default to false.
2131
		 */
2132
		if ( apply_filters( 'jetpack_enable_open_graph', false ) ) {
2133
			require_once JETPACK__PLUGIN_DIR . 'functions.opengraph.php';
2134
		}
2135
	}
2136
2137
	/**
2138
	 * Check if Jetpack's Twitter tags should be used.
2139
	 * If certain plugins are active, Jetpack's twitter tags are suppressed.
2140
	 *
2141
	 * @uses Jetpack::get_active_modules, add_filter, get_option, apply_filters
2142
	 * @action plugins_loaded
2143
	 * @return null
2144
	 */
2145
	public function check_twitter_tags() {
2146
2147
		$active_plugins = self::get_active_plugins();
2148
2149
		if ( ! empty( $active_plugins ) ) {
2150
			foreach ( $this->twitter_cards_conflicting_plugins as $plugin ) {
2151
				if ( in_array( $plugin, $active_plugins ) ) {
2152
					add_filter( 'jetpack_disable_twitter_cards', '__return_true', 99 );
2153
					break;
2154
				}
2155
			}
2156
		}
2157
2158
		/**
2159
		 * Allow Twitter Card Meta tags to be disabled.
2160
		 *
2161
		 * @since 2.6.0
2162
		 *
2163
		 * @param bool true Should Twitter Card Meta tags be disabled. Default to true.
2164
		 */
2165
		if ( ! apply_filters( 'jetpack_disable_twitter_cards', false ) ) {
2166
			require_once JETPACK__PLUGIN_DIR . 'class.jetpack-twitter-cards.php';
2167
		}
2168
	}
2169
2170
	/**
2171
	 * Allows plugins to submit security reports.
2172
	 *
2173
	 * @param string $type         Report type (login_form, backup, file_scanning, spam)
2174
	 * @param string $plugin_file  Plugin __FILE__, so that we can pull plugin data
2175
	 * @param array  $args         See definitions above
2176
	 */
2177
	public static function submit_security_report( $type = '', $plugin_file = '', $args = array() ) {
2178
		_deprecated_function( __FUNCTION__, 'jetpack-4.2', null );
2179
	}
2180
2181
	/* Jetpack Options API */
2182
2183
	public static function get_option_names( $type = 'compact' ) {
2184
		return Jetpack_Options::get_option_names( $type );
2185
	}
2186
2187
	/**
2188
	 * Returns the requested option.  Looks in jetpack_options or jetpack_$name as appropriate.
2189
	 *
2190
	 * @param string $name    Option name
2191
	 * @param mixed  $default (optional)
2192
	 */
2193
	public static function get_option( $name, $default = false ) {
2194
		return Jetpack_Options::get_option( $name, $default );
2195
	}
2196
2197
	/**
2198
	 * Updates the single given option.  Updates jetpack_options or jetpack_$name as appropriate.
2199
	 *
2200
	 * @deprecated 3.4 use Jetpack_Options::update_option() instead.
2201
	 * @param string $name  Option name
2202
	 * @param mixed  $value Option value
2203
	 */
2204
	public static function update_option( $name, $value ) {
2205
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_option()' );
2206
		return Jetpack_Options::update_option( $name, $value );
2207
	}
2208
2209
	/**
2210
	 * Updates the multiple given options.  Updates jetpack_options and/or jetpack_$name as appropriate.
2211
	 *
2212
	 * @deprecated 3.4 use Jetpack_Options::update_options() instead.
2213
	 * @param array $array array( option name => option value, ... )
2214
	 */
2215
	public static function update_options( $array ) {
2216
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::update_options()' );
2217
		return Jetpack_Options::update_options( $array );
2218
	}
2219
2220
	/**
2221
	 * Deletes the given option.  May be passed multiple option names as an array.
2222
	 * Updates jetpack_options and/or deletes jetpack_$name as appropriate.
2223
	 *
2224
	 * @deprecated 3.4 use Jetpack_Options::delete_option() instead.
2225
	 * @param string|array $names
2226
	 */
2227
	public static function delete_option( $names ) {
2228
		_deprecated_function( __METHOD__, 'jetpack-3.4', 'Jetpack_Options::delete_option()' );
2229
		return Jetpack_Options::delete_option( $names );
2230
	}
2231
2232
	/**
2233
	 * @deprecated 8.0 Use Automattic\Jetpack\Connection\Utils::update_user_token() instead.
2234
	 *
2235
	 * Enters a user token into the user_tokens option
2236
	 *
2237
	 * @param int    $user_id The user id.
2238
	 * @param string $token The user token.
2239
	 * @param bool   $is_master_user Whether the user is the master user.
2240
	 * @return bool
2241
	 */
2242
	public static function update_user_token( $user_id, $token, $is_master_user ) {
2243
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Utils::update_user_token' );
2244
		return Connection_Utils::update_user_token( $user_id, $token, $is_master_user );
2245
	}
2246
2247
	/**
2248
	 * Returns an array of all PHP files in the specified absolute path.
2249
	 * Equivalent to glob( "$absolute_path/*.php" ).
2250
	 *
2251
	 * @param string $absolute_path The absolute path of the directory to search.
2252
	 * @return array Array of absolute paths to the PHP files.
2253
	 */
2254
	public static function glob_php( $absolute_path ) {
2255
		if ( function_exists( 'glob' ) ) {
2256
			return glob( "$absolute_path/*.php" );
2257
		}
2258
2259
		$absolute_path = untrailingslashit( $absolute_path );
2260
		$files         = array();
2261
		if ( ! $dir = @opendir( $absolute_path ) ) {
2262
			return $files;
2263
		}
2264
2265
		while ( false !== $file = readdir( $dir ) ) {
2266
			if ( '.' == substr( $file, 0, 1 ) || '.php' != substr( $file, -4 ) ) {
2267
				continue;
2268
			}
2269
2270
			$file = "$absolute_path/$file";
2271
2272
			if ( ! is_file( $file ) ) {
2273
				continue;
2274
			}
2275
2276
			$files[] = $file;
2277
		}
2278
2279
		closedir( $dir );
2280
2281
		return $files;
2282
	}
2283
2284
	public static function activate_new_modules( $redirect = false ) {
2285
		if ( ! self::is_active() && ! ( new Status() )->is_offline_mode() ) {
2286
			return;
2287
		}
2288
2289
		$jetpack_old_version = Jetpack_Options::get_option( 'version' ); // [sic]
2290 View Code Duplication
		if ( ! $jetpack_old_version ) {
2291
			$jetpack_old_version = $version = $old_version = '1.1:' . time();
2292
			/** This action is documented in class.jetpack.php */
2293
			do_action( 'updating_jetpack_version', $version, false );
2294
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
2295
		}
2296
2297
		list( $jetpack_version ) = explode( ':', $jetpack_old_version ); // [sic]
2298
2299
		if ( version_compare( JETPACK__VERSION, $jetpack_version, '<=' ) ) {
2300
			return;
2301
		}
2302
2303
		$active_modules     = self::get_active_modules();
2304
		$reactivate_modules = array();
2305
		foreach ( $active_modules as $active_module ) {
2306
			$module = self::get_module( $active_module );
2307
			if ( ! isset( $module['changed'] ) ) {
2308
				continue;
2309
			}
2310
2311
			if ( version_compare( $module['changed'], $jetpack_version, '<=' ) ) {
2312
				continue;
2313
			}
2314
2315
			$reactivate_modules[] = $active_module;
2316
			self::deactivate_module( $active_module );
2317
		}
2318
2319
		$new_version = JETPACK__VERSION . ':' . time();
2320
		/** This action is documented in class.jetpack.php */
2321
		do_action( 'updating_jetpack_version', $new_version, $jetpack_old_version );
2322
		Jetpack_Options::update_options(
2323
			array(
2324
				'version'     => $new_version,
2325
				'old_version' => $jetpack_old_version,
2326
			)
2327
		);
2328
2329
		self::state( 'message', 'modules_activated' );
2330
2331
		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...
2332
2333
		if ( $redirect ) {
2334
			$page = 'jetpack'; // make sure we redirect to either settings or the jetpack page
2335
			if ( isset( $_GET['page'] ) && in_array( $_GET['page'], array( 'jetpack', 'jetpack_modules' ) ) ) {
2336
				$page = $_GET['page'];
2337
			}
2338
2339
			wp_safe_redirect( self::admin_url( 'page=' . $page ) );
2340
			exit;
2341
		}
2342
	}
2343
2344
	/**
2345
	 * List available Jetpack modules. Simply lists .php files in /modules/.
2346
	 * Make sure to tuck away module "library" files in a sub-directory.
2347
	 */
2348
	public static function get_available_modules( $min_version = false, $max_version = false ) {
2349
		static $modules = null;
2350
2351
		if ( ! isset( $modules ) ) {
2352
			$available_modules_option = Jetpack_Options::get_option( 'available_modules', array() );
2353
			// Use the cache if we're on the front-end and it's available...
2354
			if ( ! is_admin() && ! empty( $available_modules_option[ JETPACK__VERSION ] ) ) {
2355
				$modules = $available_modules_option[ JETPACK__VERSION ];
2356
			} else {
2357
				$files = self::glob_php( JETPACK__PLUGIN_DIR . 'modules' );
2358
2359
				$modules = array();
2360
2361
				foreach ( $files as $file ) {
2362
					if ( ! $headers = self::get_module( $file ) ) {
2363
						continue;
2364
					}
2365
2366
					$modules[ self::get_module_slug( $file ) ] = $headers['introduced'];
2367
				}
2368
2369
				Jetpack_Options::update_option(
2370
					'available_modules',
2371
					array(
2372
						JETPACK__VERSION => $modules,
2373
					)
2374
				);
2375
			}
2376
		}
2377
2378
		/**
2379
		 * Filters the array of modules available to be activated.
2380
		 *
2381
		 * @since 2.4.0
2382
		 *
2383
		 * @param array $modules Array of available modules.
2384
		 * @param string $min_version Minimum version number required to use modules.
2385
		 * @param string $max_version Maximum version number required to use modules.
2386
		 */
2387
		$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...
2388
2389
		if ( ! $min_version && ! $max_version ) {
2390
			return array_keys( $mods );
2391
		}
2392
2393
		$r = array();
2394
		foreach ( $mods as $slug => $introduced ) {
2395
			if ( $min_version && version_compare( $min_version, $introduced, '>=' ) ) {
2396
				continue;
2397
			}
2398
2399
			if ( $max_version && version_compare( $max_version, $introduced, '<' ) ) {
2400
				continue;
2401
			}
2402
2403
			$r[] = $slug;
2404
		}
2405
2406
		return $r;
2407
	}
2408
2409
	/**
2410
	 * Default modules loaded on activation.
2411
	 */
2412
	public static function get_default_modules( $min_version = false, $max_version = false ) {
2413
		$return = array();
2414
2415
		foreach ( self::get_available_modules( $min_version, $max_version ) as $module ) {
2416
			$module_data = self::get_module( $module );
2417
2418
			switch ( strtolower( $module_data['auto_activate'] ) ) {
2419
				case 'yes':
2420
					$return[] = $module;
2421
					break;
2422
				case 'public':
2423
					if ( Jetpack_Options::get_option( 'public' ) ) {
2424
						$return[] = $module;
2425
					}
2426
					break;
2427
				case 'no':
2428
				default:
2429
					break;
2430
			}
2431
		}
2432
		/**
2433
		 * Filters the array of default modules.
2434
		 *
2435
		 * @since 2.5.0
2436
		 *
2437
		 * @param array $return Array of default modules.
2438
		 * @param string $min_version Minimum version number required to use modules.
2439
		 * @param string $max_version Maximum version number required to use modules.
2440
		 */
2441
		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...
2442
	}
2443
2444
	/**
2445
	 * Checks activated modules during auto-activation to determine
2446
	 * if any of those modules are being deprecated.  If so, close
2447
	 * them out, and add any replacement modules.
2448
	 *
2449
	 * Runs at priority 99 by default.
2450
	 *
2451
	 * This is run late, so that it can still activate a module if
2452
	 * the new module is a replacement for another that the user
2453
	 * currently has active, even if something at the normal priority
2454
	 * would kibosh everything.
2455
	 *
2456
	 * @since 2.6
2457
	 * @uses jetpack_get_default_modules filter
2458
	 * @param array $modules
2459
	 * @return array
2460
	 */
2461
	function handle_deprecated_modules( $modules ) {
2462
		$deprecated_modules = array(
2463
			'debug'            => null,  // Closed out and moved to the debugger library.
2464
			'wpcc'             => 'sso', // Closed out in 2.6 -- SSO provides the same functionality.
2465
			'gplus-authorship' => null,  // Closed out in 3.2 -- Google dropped support.
2466
			'minileven'        => null,  // Closed out in 8.3 -- Responsive themes are common now, and so is AMP.
2467
		);
2468
2469
		// Don't activate SSO if they never completed activating WPCC.
2470
		if ( self::is_module_active( 'wpcc' ) ) {
2471
			$wpcc_options = Jetpack_Options::get_option( 'wpcc_options' );
2472
			if ( empty( $wpcc_options ) || empty( $wpcc_options['client_id'] ) || empty( $wpcc_options['client_id'] ) ) {
2473
				$deprecated_modules['wpcc'] = null;
2474
			}
2475
		}
2476
2477
		foreach ( $deprecated_modules as $module => $replacement ) {
2478
			if ( self::is_module_active( $module ) ) {
2479
				self::deactivate_module( $module );
2480
				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...
2481
					$modules[] = $replacement;
2482
				}
2483
			}
2484
		}
2485
2486
		return array_unique( $modules );
2487
	}
2488
2489
	/**
2490
	 * Checks activated plugins during auto-activation to determine
2491
	 * if any of those plugins are in the list with a corresponding module
2492
	 * that is not compatible with the plugin. The module will not be allowed
2493
	 * to auto-activate.
2494
	 *
2495
	 * @since 2.6
2496
	 * @uses jetpack_get_default_modules filter
2497
	 * @param array $modules
2498
	 * @return array
2499
	 */
2500
	function filter_default_modules( $modules ) {
2501
2502
		$active_plugins = self::get_active_plugins();
2503
2504
		if ( ! empty( $active_plugins ) ) {
2505
2506
			// For each module we'd like to auto-activate...
2507
			foreach ( $modules as $key => $module ) {
2508
				// If there are potential conflicts for it...
2509
				if ( ! empty( $this->conflicting_plugins[ $module ] ) ) {
2510
					// For each potential conflict...
2511
					foreach ( $this->conflicting_plugins[ $module ] as $title => $plugin ) {
2512
						// If that conflicting plugin is active...
2513
						if ( in_array( $plugin, $active_plugins ) ) {
2514
							// Remove that item from being auto-activated.
2515
							unset( $modules[ $key ] );
2516
						}
2517
					}
2518
				}
2519
			}
2520
		}
2521
2522
		return $modules;
2523
	}
2524
2525
	/**
2526
	 * Extract a module's slug from its full path.
2527
	 */
2528
	public static function get_module_slug( $file ) {
2529
		return str_replace( '.php', '', basename( $file ) );
2530
	}
2531
2532
	/**
2533
	 * Generate a module's path from its slug.
2534
	 */
2535
	public static function get_module_path( $slug ) {
2536
		/**
2537
		 * Filters the path of a modules.
2538
		 *
2539
		 * @since 7.4.0
2540
		 *
2541
		 * @param array $return The absolute path to a module's root php file
2542
		 * @param string $slug The module slug
2543
		 */
2544
		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...
2545
	}
2546
2547
	/**
2548
	 * Load module data from module file. Headers differ from WordPress
2549
	 * plugin headers to avoid them being identified as standalone
2550
	 * plugins on the WordPress plugins page.
2551
	 */
2552
	public static function get_module( $module ) {
2553
		$headers = array(
2554
			'name'                      => 'Module Name',
2555
			'description'               => 'Module Description',
2556
			'sort'                      => 'Sort Order',
2557
			'recommendation_order'      => 'Recommendation Order',
2558
			'introduced'                => 'First Introduced',
2559
			'changed'                   => 'Major Changes In',
2560
			'deactivate'                => 'Deactivate',
2561
			'free'                      => 'Free',
2562
			'requires_connection'       => 'Requires Connection',
2563
			'auto_activate'             => 'Auto Activate',
2564
			'module_tags'               => 'Module Tags',
2565
			'feature'                   => 'Feature',
2566
			'additional_search_queries' => 'Additional Search Queries',
2567
			'plan_classes'              => 'Plans',
2568
		);
2569
2570
		$file = self::get_module_path( self::get_module_slug( $module ) );
2571
2572
		$mod = self::get_file_data( $file, $headers );
2573
		if ( empty( $mod['name'] ) ) {
2574
			return false;
2575
		}
2576
2577
		$mod['sort']                 = empty( $mod['sort'] ) ? 10 : (int) $mod['sort'];
2578
		$mod['recommendation_order'] = empty( $mod['recommendation_order'] ) ? 20 : (int) $mod['recommendation_order'];
2579
		$mod['deactivate']           = empty( $mod['deactivate'] );
2580
		$mod['free']                 = empty( $mod['free'] );
2581
		$mod['requires_connection']  = ( ! empty( $mod['requires_connection'] ) && 'No' == $mod['requires_connection'] ) ? false : true;
2582
2583
		if ( empty( $mod['auto_activate'] ) || ! in_array( strtolower( $mod['auto_activate'] ), array( 'yes', 'no', 'public' ) ) ) {
2584
			$mod['auto_activate'] = 'No';
2585
		} else {
2586
			$mod['auto_activate'] = (string) $mod['auto_activate'];
2587
		}
2588
2589
		if ( $mod['module_tags'] ) {
2590
			$mod['module_tags'] = explode( ',', $mod['module_tags'] );
2591
			$mod['module_tags'] = array_map( 'trim', $mod['module_tags'] );
2592
			$mod['module_tags'] = array_map( array( __CLASS__, 'translate_module_tag' ), $mod['module_tags'] );
2593
		} else {
2594
			$mod['module_tags'] = array( self::translate_module_tag( 'Other' ) );
2595
		}
2596
2597 View Code Duplication
		if ( $mod['plan_classes'] ) {
2598
			$mod['plan_classes'] = explode( ',', $mod['plan_classes'] );
2599
			$mod['plan_classes'] = array_map( 'strtolower', array_map( 'trim', $mod['plan_classes'] ) );
2600
		} else {
2601
			$mod['plan_classes'] = array( 'free' );
2602
		}
2603
2604 View Code Duplication
		if ( $mod['feature'] ) {
2605
			$mod['feature'] = explode( ',', $mod['feature'] );
2606
			$mod['feature'] = array_map( 'trim', $mod['feature'] );
2607
		} else {
2608
			$mod['feature'] = array( self::translate_module_tag( 'Other' ) );
2609
		}
2610
2611
		/**
2612
		 * Filters the feature array on a module.
2613
		 *
2614
		 * This filter allows you to control where each module is filtered: Recommended,
2615
		 * and the default "Other" listing.
2616
		 *
2617
		 * @since 3.5.0
2618
		 *
2619
		 * @param array   $mod['feature'] The areas to feature this module:
2620
		 *     'Recommended' shows on the main Jetpack admin screen.
2621
		 *     'Other' should be the default if no other value is in the array.
2622
		 * @param string  $module The slug of the module, e.g. sharedaddy.
2623
		 * @param array   $mod All the currently assembled module data.
2624
		 */
2625
		$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...
2626
2627
		/**
2628
		 * Filter the returned data about a module.
2629
		 *
2630
		 * This filter allows overriding any info about Jetpack modules. It is dangerous,
2631
		 * so please be careful.
2632
		 *
2633
		 * @since 3.6.0
2634
		 *
2635
		 * @param array   $mod    The details of the requested module.
2636
		 * @param string  $module The slug of the module, e.g. sharedaddy
2637
		 * @param string  $file   The path to the module source file.
2638
		 */
2639
		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...
2640
	}
2641
2642
	/**
2643
	 * Like core's get_file_data implementation, but caches the result.
2644
	 */
2645
	public static function get_file_data( $file, $headers ) {
2646
		// Get just the filename from $file (i.e. exclude full path) so that a consistent hash is generated
2647
		$file_name = basename( $file );
2648
2649
		$cache_key = 'jetpack_file_data_' . JETPACK__VERSION;
2650
2651
		$file_data_option = get_transient( $cache_key );
2652
2653
		if ( ! is_array( $file_data_option ) ) {
2654
			delete_transient( $cache_key );
2655
			$file_data_option = false;
2656
		}
2657
2658
		if ( false === $file_data_option ) {
2659
			$file_data_option = array();
2660
		}
2661
2662
		$key           = md5( $file_name . serialize( $headers ) );
2663
		$refresh_cache = is_admin() && isset( $_GET['page'] ) && 'jetpack' === substr( $_GET['page'], 0, 7 );
2664
2665
		// If we don't need to refresh the cache, and already have the value, short-circuit!
2666
		if ( ! $refresh_cache && isset( $file_data_option[ $key ] ) ) {
2667
			return $file_data_option[ $key ];
2668
		}
2669
2670
		$data = get_file_data( $file, $headers );
2671
2672
		$file_data_option[ $key ] = $data;
2673
2674
		set_transient( $cache_key, $file_data_option, 29 * DAY_IN_SECONDS );
2675
2676
		return $data;
2677
	}
2678
2679
	/**
2680
	 * Return translated module tag.
2681
	 *
2682
	 * @param string $tag Tag as it appears in each module heading.
2683
	 *
2684
	 * @return mixed
2685
	 */
2686
	public static function translate_module_tag( $tag ) {
2687
		return jetpack_get_module_i18n_tag( $tag );
2688
	}
2689
2690
	/**
2691
	 * Return module name translation. Uses matching string created in modules/module-headings.php.
2692
	 *
2693
	 * @since 3.9.2
2694
	 *
2695
	 * @param array $modules
2696
	 *
2697
	 * @return string|void
2698
	 */
2699
	public static function get_translated_modules( $modules ) {
2700
		foreach ( $modules as $index => $module ) {
2701
			$i18n_module = jetpack_get_module_i18n( $module['module'] );
2702
			if ( isset( $module['name'] ) ) {
2703
				$modules[ $index ]['name'] = $i18n_module['name'];
2704
			}
2705
			if ( isset( $module['description'] ) ) {
2706
				$modules[ $index ]['description']       = $i18n_module['description'];
2707
				$modules[ $index ]['short_description'] = $i18n_module['description'];
2708
			}
2709
		}
2710
		return $modules;
2711
	}
2712
2713
	/**
2714
	 * Get a list of activated modules as an array of module slugs.
2715
	 */
2716
	public static function get_active_modules() {
2717
		$active = Jetpack_Options::get_option( 'active_modules' );
2718
2719
		if ( ! is_array( $active ) ) {
2720
			$active = array();
2721
		}
2722
2723
		if ( class_exists( 'VaultPress' ) || function_exists( 'vaultpress_contact_service' ) ) {
2724
			$active[] = 'vaultpress';
2725
		} else {
2726
			$active = array_diff( $active, array( 'vaultpress' ) );
2727
		}
2728
2729
		// If protect is active on the main site of a multisite, it should be active on all sites.
2730
		if ( ! in_array( 'protect', $active ) && is_multisite() && get_site_option( 'jetpack_protect_active' ) ) {
2731
			$active[] = 'protect';
2732
		}
2733
2734
		/**
2735
		 * Allow filtering of the active modules.
2736
		 *
2737
		 * Gives theme and plugin developers the power to alter the modules that
2738
		 * are activated on the fly.
2739
		 *
2740
		 * @since 5.8.0
2741
		 *
2742
		 * @param array $active Array of active module slugs.
2743
		 */
2744
		$active = apply_filters( 'jetpack_active_modules', $active );
2745
2746
		return array_unique( $active );
2747
	}
2748
2749
	/**
2750
	 * Check whether or not a Jetpack module is active.
2751
	 *
2752
	 * @param string $module The slug of a Jetpack module.
2753
	 * @return bool
2754
	 *
2755
	 * @static
2756
	 */
2757
	public static function is_module_active( $module ) {
2758
		return in_array( $module, self::get_active_modules() );
2759
	}
2760
2761
	public static function is_module( $module ) {
2762
		return ! empty( $module ) && ! validate_file( $module, self::get_available_modules() );
2763
	}
2764
2765
	/**
2766
	 * Catches PHP errors.  Must be used in conjunction with output buffering.
2767
	 *
2768
	 * @param bool $catch True to start catching, False to stop.
2769
	 *
2770
	 * @static
2771
	 */
2772
	public static function catch_errors( $catch ) {
2773
		static $display_errors, $error_reporting;
2774
2775
		if ( $catch ) {
2776
			$display_errors  = @ini_set( 'display_errors', 1 );
2777
			$error_reporting = @error_reporting( E_ALL );
2778
			add_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2779
		} else {
2780
			@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...
2781
			@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...
2782
			remove_action( 'shutdown', array( 'Jetpack', 'catch_errors_on_shutdown' ), 0 );
2783
		}
2784
	}
2785
2786
	/**
2787
	 * Saves any generated PHP errors in ::state( 'php_errors', {errors} )
2788
	 */
2789
	public static function catch_errors_on_shutdown() {
2790
		self::state( 'php_errors', self::alias_directories( ob_get_clean() ) );
2791
	}
2792
2793
	/**
2794
	 * Rewrite any string to make paths easier to read.
2795
	 *
2796
	 * Rewrites ABSPATH (eg `/home/jetpack/wordpress/`) to ABSPATH, and if WP_CONTENT_DIR
2797
	 * is located outside of ABSPATH, rewrites that to WP_CONTENT_DIR.
2798
	 *
2799
	 * @param $string
2800
	 * @return mixed
2801
	 */
2802
	public static function alias_directories( $string ) {
2803
		// ABSPATH has a trailing slash.
2804
		$string = str_replace( ABSPATH, 'ABSPATH/', $string );
2805
		// WP_CONTENT_DIR does not have a trailing slash.
2806
		$string = str_replace( WP_CONTENT_DIR, 'WP_CONTENT_DIR', $string );
2807
2808
		return $string;
2809
	}
2810
2811
	public static function activate_default_modules(
2812
		$min_version = false,
2813
		$max_version = false,
2814
		$other_modules = array(),
2815
		$redirect = null,
2816
		$send_state_messages = null
2817
	) {
2818
		$jetpack = self::init();
2819
2820
		if ( is_null( $redirect ) ) {
2821
			if (
2822
				( defined( 'REST_REQUEST' ) && REST_REQUEST )
2823
			||
2824
				( defined( 'XMLRPC_REQUEST' ) && XMLRPC_REQUEST )
2825
			||
2826
				( defined( 'WP_CLI' ) && WP_CLI )
2827
			||
2828
				( defined( 'DOING_CRON' ) && DOING_CRON )
2829
			||
2830
				( defined( 'DOING_AJAX' ) && DOING_AJAX )
2831
			) {
2832
				$redirect = false;
2833
			} elseif ( is_admin() ) {
2834
				$redirect = true;
2835
			} else {
2836
				$redirect = false;
2837
			}
2838
		}
2839
2840
		if ( is_null( $send_state_messages ) ) {
2841
			$send_state_messages = current_user_can( 'jetpack_activate_modules' );
2842
		}
2843
2844
		$modules = self::get_default_modules( $min_version, $max_version );
2845
		$modules = array_merge( $other_modules, $modules );
2846
2847
		// Look for standalone plugins and disable if active.
2848
2849
		$to_deactivate = array();
2850
		foreach ( $modules as $module ) {
2851
			if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
2852
				$to_deactivate[ $module ] = $jetpack->plugins_to_deactivate[ $module ];
2853
			}
2854
		}
2855
2856
		$deactivated = array();
2857
		foreach ( $to_deactivate as $module => $deactivate_me ) {
2858
			list( $probable_file, $probable_title ) = $deactivate_me;
2859
			if ( Jetpack_Client_Server::deactivate_plugin( $probable_file, $probable_title ) ) {
2860
				$deactivated[] = $module;
2861
			}
2862
		}
2863
2864
		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...
2865
			if ( $send_state_messages ) {
2866
				self::state( 'deactivated_plugins', join( ',', $deactivated ) );
2867
			}
2868
2869
			if ( $redirect ) {
2870
				$url = add_query_arg(
2871
					array(
2872
						'action'   => 'activate_default_modules',
2873
						'_wpnonce' => wp_create_nonce( 'activate_default_modules' ),
2874
					),
2875
					add_query_arg( compact( 'min_version', 'max_version', 'other_modules' ), self::admin_url( 'page=jetpack' ) )
2876
				);
2877
				wp_safe_redirect( $url );
2878
				exit;
2879
			}
2880
		}
2881
2882
		/**
2883
		 * Fires before default modules are activated.
2884
		 *
2885
		 * @since 1.9.0
2886
		 *
2887
		 * @param string $min_version Minimum version number required to use modules.
2888
		 * @param string $max_version Maximum version number required to use modules.
2889
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2890
		 */
2891
		do_action( 'jetpack_before_activate_default_modules', $min_version, $max_version, $other_modules );
2892
2893
		// Check each module for fatal errors, a la wp-admin/plugins.php::activate before activating
2894
		if ( $send_state_messages ) {
2895
			self::restate();
2896
			self::catch_errors( true );
2897
		}
2898
2899
		$active = self::get_active_modules();
2900
2901
		foreach ( $modules as $module ) {
2902
			if ( did_action( "jetpack_module_loaded_$module" ) ) {
2903
				$active[] = $module;
2904
				self::update_active_modules( $active );
2905
				continue;
2906
			}
2907
2908
			if ( $send_state_messages && in_array( $module, $active ) ) {
2909
				$module_info = self::get_module( $module );
2910 View Code Duplication
				if ( ! $module_info['deactivate'] ) {
2911
					$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2912
					if ( $active_state = self::state( $state ) ) {
2913
						$active_state = explode( ',', $active_state );
2914
					} else {
2915
						$active_state = array();
2916
					}
2917
					$active_state[] = $module;
2918
					self::state( $state, implode( ',', $active_state ) );
2919
				}
2920
				continue;
2921
			}
2922
2923
			$file = self::get_module_path( $module );
2924
			if ( ! file_exists( $file ) ) {
2925
				continue;
2926
			}
2927
2928
			// we'll override this later if the plugin can be included without fatal error
2929
			if ( $redirect ) {
2930
				wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
2931
			}
2932
2933
			if ( $send_state_messages ) {
2934
				self::state( 'error', 'module_activation_failed' );
2935
				self::state( 'module', $module );
2936
			}
2937
2938
			ob_start();
2939
			require_once $file;
2940
2941
			$active[] = $module;
2942
2943 View Code Duplication
			if ( $send_state_messages ) {
2944
2945
				$state = in_array( $module, $other_modules ) ? 'reactivated_modules' : 'activated_modules';
2946
				if ( $active_state = self::state( $state ) ) {
2947
					$active_state = explode( ',', $active_state );
2948
				} else {
2949
					$active_state = array();
2950
				}
2951
				$active_state[] = $module;
2952
				self::state( $state, implode( ',', $active_state ) );
2953
			}
2954
2955
			self::update_active_modules( $active );
2956
2957
			ob_end_clean();
2958
		}
2959
2960
		if ( $send_state_messages ) {
2961
			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...
2962
			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...
2963
		}
2964
2965
		self::catch_errors( false );
2966
		/**
2967
		 * Fires when default modules are activated.
2968
		 *
2969
		 * @since 1.9.0
2970
		 *
2971
		 * @param string $min_version Minimum version number required to use modules.
2972
		 * @param string $max_version Maximum version number required to use modules.
2973
		 * @param array $other_modules Array of other modules to activate alongside the default modules.
2974
		 */
2975
		do_action( 'jetpack_activate_default_modules', $min_version, $max_version, $other_modules );
2976
	}
2977
2978
	public static function activate_module( $module, $exit = true, $redirect = true ) {
2979
		/**
2980
		 * Fires before a module is activated.
2981
		 *
2982
		 * @since 2.6.0
2983
		 *
2984
		 * @param string $module Module slug.
2985
		 * @param bool $exit Should we exit after the module has been activated. Default to true.
2986
		 * @param bool $redirect Should the user be redirected after module activation? Default to true.
2987
		 */
2988
		do_action( 'jetpack_pre_activate_module', $module, $exit, $redirect );
2989
2990
		$jetpack = self::init();
2991
2992
		if ( ! strlen( $module ) ) {
2993
			return false;
2994
		}
2995
2996
		if ( ! self::is_module( $module ) ) {
2997
			return false;
2998
		}
2999
3000
		// If it's already active, then don't do it again
3001
		$active = self::get_active_modules();
3002
		foreach ( $active as $act ) {
3003
			if ( $act == $module ) {
3004
				return true;
3005
			}
3006
		}
3007
3008
		$module_data = self::get_module( $module );
3009
3010
		$is_offline_mode = ( new Status() )->is_offline_mode();
3011
		if ( ! self::is_active() ) {
3012
			if ( ! $is_offline_mode && ! self::is_onboarding() ) {
3013
				return false;
3014
			}
3015
3016
			// If we're not connected but in offline mode, make sure the module doesn't require a connection.
3017
			if ( $is_offline_mode && $module_data['requires_connection'] ) {
3018
				return false;
3019
			}
3020
		}
3021
3022
		// Check and see if the old plugin is active
3023
		if ( isset( $jetpack->plugins_to_deactivate[ $module ] ) ) {
3024
			// Deactivate the old plugin
3025
			if ( Jetpack_Client_Server::deactivate_plugin( $jetpack->plugins_to_deactivate[ $module ][0], $jetpack->plugins_to_deactivate[ $module ][1] ) ) {
3026
				// If we deactivated the old plugin, remembere that with ::state() and redirect back to this page to activate the module
3027
				// We can't activate the module on this page load since the newly deactivated old plugin is still loaded on this page load.
3028
				self::state( 'deactivated_plugins', $module );
3029
				wp_safe_redirect( add_query_arg( 'jetpack_restate', 1 ) );
3030
				exit;
3031
			}
3032
		}
3033
3034
		// Protect won't work with mis-configured IPs
3035
		if ( 'protect' === $module ) {
3036
			include_once JETPACK__PLUGIN_DIR . 'modules/protect/shared-functions.php';
3037
			if ( ! jetpack_protect_get_ip() ) {
3038
				self::state( 'message', 'protect_misconfigured_ip' );
3039
				return false;
3040
			}
3041
		}
3042
3043
		if ( ! Jetpack_Plan::supports( $module ) ) {
3044
			return false;
3045
		}
3046
3047
		// Check the file for fatal errors, a la wp-admin/plugins.php::activate
3048
		self::state( 'module', $module );
3049
		self::state( 'error', 'module_activation_failed' ); // we'll override this later if the plugin can be included without fatal error
3050
3051
		self::catch_errors( true );
3052
		ob_start();
3053
		require self::get_module_path( $module );
3054
		/** This action is documented in class.jetpack.php */
3055
		do_action( 'jetpack_activate_module', $module );
3056
		$active[] = $module;
3057
		self::update_active_modules( $active );
3058
3059
		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...
3060
		ob_end_clean();
3061
		self::catch_errors( false );
3062
3063
		if ( $redirect ) {
3064
			wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
3065
		}
3066
		if ( $exit ) {
3067
			exit;
3068
		}
3069
		return true;
3070
	}
3071
3072
	function activate_module_actions( $module ) {
3073
		_deprecated_function( __METHOD__, 'jetpack-4.2' );
3074
	}
3075
3076
	public static function deactivate_module( $module ) {
3077
		/**
3078
		 * Fires when a module is deactivated.
3079
		 *
3080
		 * @since 1.9.0
3081
		 *
3082
		 * @param string $module Module slug.
3083
		 */
3084
		do_action( 'jetpack_pre_deactivate_module', $module );
3085
3086
		$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...
3087
3088
		$active = self::get_active_modules();
3089
		$new    = array_filter( array_diff( $active, (array) $module ) );
3090
3091
		return self::update_active_modules( $new );
3092
	}
3093
3094
	public static function enable_module_configurable( $module ) {
3095
		$module = self::get_module_slug( $module );
3096
		add_filter( 'jetpack_module_configurable_' . $module, '__return_true' );
3097
	}
3098
3099
	/**
3100
	 * Composes a module configure URL. It uses Jetpack settings search as default value
3101
	 * It is possible to redefine resulting URL by using "jetpack_module_configuration_url_$module" filter
3102
	 *
3103
	 * @param string $module Module slug
3104
	 * @return string $url module configuration URL
3105
	 */
3106
	public static function module_configuration_url( $module ) {
3107
		$module      = self::get_module_slug( $module );
3108
		$default_url = self::admin_url() . "#/settings?term=$module";
3109
		/**
3110
		 * Allows to modify configure_url of specific module to be able to redirect to some custom location.
3111
		 *
3112
		 * @since 6.9.0
3113
		 *
3114
		 * @param string $default_url Default url, which redirects to jetpack settings page.
3115
		 */
3116
		$url = apply_filters( 'jetpack_module_configuration_url_' . $module, $default_url );
3117
3118
		return $url;
3119
	}
3120
3121
	/* Installation */
3122
	public static function bail_on_activation( $message, $deactivate = true ) {
3123
		?>
3124
<!doctype html>
3125
<html>
3126
<head>
3127
<meta charset="<?php bloginfo( 'charset' ); ?>">
3128
<style>
3129
* {
3130
	text-align: center;
3131
	margin: 0;
3132
	padding: 0;
3133
	font-family: "Lucida Grande",Verdana,Arial,"Bitstream Vera Sans",sans-serif;
3134
}
3135
p {
3136
	margin-top: 1em;
3137
	font-size: 18px;
3138
}
3139
</style>
3140
<body>
3141
<p><?php echo esc_html( $message ); ?></p>
3142
</body>
3143
</html>
3144
		<?php
3145
		if ( $deactivate ) {
3146
			$plugins = get_option( 'active_plugins' );
3147
			$jetpack = plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' );
3148
			$update  = false;
3149
			foreach ( $plugins as $i => $plugin ) {
3150
				if ( $plugin === $jetpack ) {
3151
					$plugins[ $i ] = false;
3152
					$update        = true;
3153
				}
3154
			}
3155
3156
			if ( $update ) {
3157
				update_option( 'active_plugins', array_filter( $plugins ) );
3158
			}
3159
		}
3160
		exit;
3161
	}
3162
3163
	/**
3164
	 * Attached to activate_{ plugin_basename( __FILES__ ) } by register_activation_hook()
3165
	 *
3166
	 * @static
3167
	 */
3168
	public static function plugin_activation( $network_wide ) {
3169
		Jetpack_Options::update_option( 'activated', 1 );
3170
3171
		if ( version_compare( $GLOBALS['wp_version'], JETPACK__MINIMUM_WP_VERSION, '<' ) ) {
3172
			self::bail_on_activation( sprintf( __( 'Jetpack requires WordPress version %s or later.', 'jetpack' ), JETPACK__MINIMUM_WP_VERSION ) );
3173
		}
3174
3175
		if ( $network_wide ) {
3176
			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...
3177
		}
3178
3179
		// For firing one-off events (notices) immediately after activation
3180
		set_transient( 'activated_jetpack', true, 0.1 * MINUTE_IN_SECONDS );
3181
3182
		update_option( 'jetpack_activation_source', self::get_activation_source( wp_get_referer() ) );
3183
3184
		Health::on_jetpack_activated();
3185
3186
		self::plugin_initialize();
3187
	}
3188
3189
	public static function get_activation_source( $referer_url ) {
3190
3191
		if ( defined( 'WP_CLI' ) && WP_CLI ) {
3192
			return array( 'wp-cli', null );
3193
		}
3194
3195
		$referer = wp_parse_url( $referer_url );
3196
3197
		$source_type  = 'unknown';
3198
		$source_query = null;
3199
3200
		if ( ! is_array( $referer ) ) {
3201
			return array( $source_type, $source_query );
3202
		}
3203
3204
		$plugins_path         = wp_parse_url( admin_url( 'plugins.php' ), PHP_URL_PATH );
3205
		$plugins_install_path = wp_parse_url( admin_url( 'plugin-install.php' ), PHP_URL_PATH );// /wp-admin/plugin-install.php
3206
3207
		if ( isset( $referer['query'] ) ) {
3208
			parse_str( $referer['query'], $query_parts );
3209
		} else {
3210
			$query_parts = array();
3211
		}
3212
3213
		if ( $plugins_path === $referer['path'] ) {
3214
			$source_type = 'list';
3215
		} elseif ( $plugins_install_path === $referer['path'] ) {
3216
			$tab = isset( $query_parts['tab'] ) ? $query_parts['tab'] : 'featured';
3217
			switch ( $tab ) {
3218
				case 'popular':
3219
					$source_type = 'popular';
3220
					break;
3221
				case 'recommended':
3222
					$source_type = 'recommended';
3223
					break;
3224
				case 'favorites':
3225
					$source_type = 'favorites';
3226
					break;
3227
				case 'search':
3228
					$source_type  = 'search-' . ( isset( $query_parts['type'] ) ? $query_parts['type'] : 'term' );
3229
					$source_query = isset( $query_parts['s'] ) ? $query_parts['s'] : null;
3230
					break;
3231
				default:
3232
					$source_type = 'featured';
3233
			}
3234
		}
3235
3236
		return array( $source_type, $source_query );
3237
	}
3238
3239
	/**
3240
	 * Runs before bumping version numbers up to a new version
3241
	 *
3242
	 * @param string $version    Version:timestamp.
3243
	 * @param string $old_version Old Version:timestamp or false if not set yet.
3244
	 */
3245
	public static function do_version_bump( $version, $old_version ) {
3246
		if ( $old_version ) { // For existing Jetpack installations.
3247
3248
			// If a front end page is visited after the update, the 'wp' action will fire.
3249
			add_action( 'wp', 'Jetpack::set_update_modal_display' );
3250
3251
			// If an admin page is visited after the update, the 'current_screen' action will fire.
3252
			add_action( 'current_screen', 'Jetpack::set_update_modal_display' );
3253
		}
3254
	}
3255
3256
	/**
3257
	 * Sets the display_update_modal state.
3258
	 */
3259
	public static function set_update_modal_display() {
3260
		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...
3261
	}
3262
3263
	/**
3264
	 * Sets the internal version number and activation state.
3265
	 *
3266
	 * @static
3267
	 */
3268
	public static function plugin_initialize() {
3269
		if ( ! Jetpack_Options::get_option( 'activated' ) ) {
3270
			Jetpack_Options::update_option( 'activated', 2 );
3271
		}
3272
3273 View Code Duplication
		if ( ! Jetpack_Options::get_option( 'version' ) ) {
3274
			$version = $old_version = JETPACK__VERSION . ':' . time();
3275
			/** This action is documented in class.jetpack.php */
3276
			do_action( 'updating_jetpack_version', $version, false );
3277
			Jetpack_Options::update_options( compact( 'version', 'old_version' ) );
3278
		}
3279
3280
		self::load_modules();
3281
3282
		Jetpack_Options::delete_option( 'do_activate' );
3283
		Jetpack_Options::delete_option( 'dismissed_connection_banner' );
3284
	}
3285
3286
	/**
3287
	 * Removes all connection options
3288
	 *
3289
	 * @static
3290
	 */
3291
	public static function plugin_deactivation() {
3292
		require_once ABSPATH . '/wp-admin/includes/plugin.php';
3293
		$tracking = new Tracking();
3294
		$tracking->record_user_event( 'deactivate_plugin', array() );
3295
		if ( is_plugin_active_for_network( 'jetpack/jetpack.php' ) ) {
3296
			Jetpack_Network::init()->deactivate();
3297
		} else {
3298
			self::disconnect( false );
3299
			// Jetpack_Heartbeat::init()->deactivate();
3300
		}
3301
	}
3302
3303
	/**
3304
	 * Disconnects from the Jetpack servers.
3305
	 * Forgets all connection details and tells the Jetpack servers to do the same.
3306
	 *
3307
	 * @static
3308
	 */
3309
	public static function disconnect( $update_activated_state = true ) {
3310
		wp_clear_scheduled_hook( 'jetpack_clean_nonces' );
3311
3312
		$connection = self::connection();
3313
		$connection->clean_nonces( true );
3314
3315
		// If the site is in an IDC because sync is not allowed,
3316
		// let's make sure to not disconnect the production site.
3317
		if ( ! self::validate_sync_error_idc_option() ) {
3318
			$tracking = new Tracking();
3319
			$tracking->record_user_event( 'disconnect_site', array() );
3320
3321
			$connection->disconnect_site_wpcom( true );
3322
		}
3323
3324
		$connection->delete_all_connection_tokens( true );
3325
		Jetpack_IDC::clear_all_idc_options();
3326
3327
		if ( $update_activated_state ) {
3328
			Jetpack_Options::update_option( 'activated', 4 );
3329
		}
3330
3331
		if ( $jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' ) ) {
3332
			// Check then record unique disconnection if site has never been disconnected previously
3333
			if ( - 1 == $jetpack_unique_connection['disconnected'] ) {
3334
				$jetpack_unique_connection['disconnected'] = 1;
3335
			} else {
3336
				if ( 0 == $jetpack_unique_connection['disconnected'] ) {
3337
					// track unique disconnect
3338
					$jetpack = self::init();
3339
3340
					$jetpack->stat( 'connections', 'unique-disconnect' );
3341
					$jetpack->do_stats( 'server_side' );
3342
				}
3343
				// increment number of times disconnected
3344
				$jetpack_unique_connection['disconnected'] += 1;
3345
			}
3346
3347
			Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
3348
		}
3349
3350
		// Delete all the sync related data. Since it could be taking up space.
3351
		Sender::get_instance()->uninstall();
3352
3353
	}
3354
3355
	/**
3356
	 * Unlinks the current user from the linked WordPress.com user.
3357
	 *
3358
	 * @deprecated since 7.7
3359
	 * @see Automattic\Jetpack\Connection\Manager::disconnect_user()
3360
	 *
3361
	 * @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...
3362
	 * @return Boolean Whether the disconnection of the user was successful.
3363
	 */
3364
	public static function unlink_user( $user_id = null ) {
3365
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::disconnect_user' );
3366
		return Connection_Manager::disconnect_user( $user_id );
3367
	}
3368
3369
	/**
3370
	 * Attempts Jetpack registration.  If it fail, a state flag is set: @see ::admin_page_load()
3371
	 */
3372
	public static function try_registration() {
3373
		$terms_of_service = new Terms_Of_Service();
3374
		// The user has agreed to the TOS at some point by now.
3375
		$terms_of_service->agree();
3376
3377
		// Let's get some testing in beta versions and such.
3378
		if ( self::is_development_version() && defined( 'PHP_URL_HOST' ) ) {
3379
			// Before attempting to connect, let's make sure that the domains are viable.
3380
			$domains_to_check = array_unique(
3381
				array(
3382
					'siteurl' => wp_parse_url( get_site_url(), PHP_URL_HOST ),
3383
					'homeurl' => wp_parse_url( get_home_url(), PHP_URL_HOST ),
3384
				)
3385
			);
3386
			foreach ( $domains_to_check as $domain ) {
3387
				$result = self::connection()->is_usable_domain( $domain );
0 ignored issues
show
Security Bug introduced by
It seems like $domain defined by $domain on line 3386 can also be of type false; however, Automattic\Jetpack\Conne...ger::is_usable_domain() does only seem to accept string, did you maybe forget to handle an error condition?

This check looks for type mismatches where the missing type is false. This is usually indicative of an error condtion.

Consider the follow example

<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}

This function either returns a new DateTime object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned false before passing on the value to another function or method that may not be able to handle a false.

Loading history...
3388
				if ( is_wp_error( $result ) ) {
3389
					return $result;
3390
				}
3391
			}
3392
		}
3393
3394
		$result = self::register();
3395
3396
		// If there was an error with registration and the site was not registered, record this so we can show a message.
3397
		if ( ! $result || is_wp_error( $result ) ) {
3398
			return $result;
3399
		} else {
3400
			return true;
3401
		}
3402
	}
3403
3404
	/**
3405
	 * Tracking an internal event log. Try not to put too much chaff in here.
3406
	 *
3407
	 * [Everyone Loves a Log!](https://www.youtube.com/watch?v=2C7mNr5WMjA)
3408
	 */
3409
	public static function log( $code, $data = null ) {
3410
		// only grab the latest 200 entries
3411
		$log = array_slice( Jetpack_Options::get_option( 'log', array() ), -199, 199 );
3412
3413
		// Append our event to the log
3414
		$log_entry = array(
3415
			'time'    => time(),
3416
			'user_id' => get_current_user_id(),
3417
			'blog_id' => Jetpack_Options::get_option( 'id' ),
3418
			'code'    => $code,
3419
		);
3420
		// Don't bother storing it unless we've got some.
3421
		if ( ! is_null( $data ) ) {
3422
			$log_entry['data'] = $data;
3423
		}
3424
		$log[] = $log_entry;
3425
3426
		// Try add_option first, to make sure it's not autoloaded.
3427
		// @todo: Add an add_option method to Jetpack_Options
3428
		if ( ! add_option( 'jetpack_log', $log, null, 'no' ) ) {
3429
			Jetpack_Options::update_option( 'log', $log );
3430
		}
3431
3432
		/**
3433
		 * Fires when Jetpack logs an internal event.
3434
		 *
3435
		 * @since 3.0.0
3436
		 *
3437
		 * @param array $log_entry {
3438
		 *  Array of details about the log entry.
3439
		 *
3440
		 *  @param string time Time of the event.
3441
		 *  @param int user_id ID of the user who trigerred the event.
3442
		 *  @param int blog_id Jetpack Blog ID.
3443
		 *  @param string code Unique name for the event.
3444
		 *  @param string data Data about the event.
3445
		 * }
3446
		 */
3447
		do_action( 'jetpack_log_entry', $log_entry );
3448
	}
3449
3450
	/**
3451
	 * Get the internal event log.
3452
	 *
3453
	 * @param $event (string) - only return the specific log events
3454
	 * @param $num   (int)    - get specific number of latest results, limited to 200
3455
	 *
3456
	 * @return array of log events || WP_Error for invalid params
3457
	 */
3458
	public static function get_log( $event = false, $num = false ) {
3459
		if ( $event && ! is_string( $event ) ) {
3460
			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...
3461
		}
3462
3463
		if ( $num && ! is_numeric( $num ) ) {
3464
			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...
3465
		}
3466
3467
		$entire_log = Jetpack_Options::get_option( 'log', array() );
3468
3469
		// If nothing set - act as it did before, otherwise let's start customizing the output
3470
		if ( ! $num && ! $event ) {
3471
			return $entire_log;
3472
		} else {
3473
			$entire_log = array_reverse( $entire_log );
3474
		}
3475
3476
		$custom_log_output = array();
3477
3478
		if ( $event ) {
3479
			foreach ( $entire_log as $log_event ) {
3480
				if ( $event == $log_event['code'] ) {
3481
					$custom_log_output[] = $log_event;
3482
				}
3483
			}
3484
		} else {
3485
			$custom_log_output = $entire_log;
3486
		}
3487
3488
		if ( $num ) {
3489
			$custom_log_output = array_slice( $custom_log_output, 0, $num );
3490
		}
3491
3492
		return $custom_log_output;
3493
	}
3494
3495
	/**
3496
	 * Log modification of important settings.
3497
	 */
3498
	public static function log_settings_change( $option, $old_value, $value ) {
3499
		switch ( $option ) {
3500
			case 'jetpack_sync_non_public_post_stati':
3501
				self::log( $option, $value );
3502
				break;
3503
		}
3504
	}
3505
3506
	/**
3507
	 * Return stat data for WPCOM sync
3508
	 */
3509
	public static function get_stat_data( $encode = true, $extended = true ) {
3510
		$data = Jetpack_Heartbeat::generate_stats_array();
3511
3512
		if ( $extended ) {
3513
			$additional_data = self::get_additional_stat_data();
3514
			$data            = array_merge( $data, $additional_data );
3515
		}
3516
3517
		if ( $encode ) {
3518
			return json_encode( $data );
3519
		}
3520
3521
		return $data;
3522
	}
3523
3524
	/**
3525
	 * Get additional stat data to sync to WPCOM
3526
	 */
3527
	public static function get_additional_stat_data( $prefix = '' ) {
3528
		$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...
3529
		$return[ "{$prefix}plugins-extra" ] = self::get_parsed_plugin_data();
3530
		$return[ "{$prefix}users" ]         = (int) self::get_site_user_count();
3531
		$return[ "{$prefix}site-count" ]    = 0;
3532
3533
		if ( function_exists( 'get_blog_count' ) ) {
3534
			$return[ "{$prefix}site-count" ] = get_blog_count();
3535
		}
3536
		return $return;
3537
	}
3538
3539
	private static function get_site_user_count() {
3540
		global $wpdb;
3541
3542
		if ( function_exists( 'wp_is_large_network' ) ) {
3543
			if ( wp_is_large_network( 'users' ) ) {
3544
				return -1; // Not a real value but should tell us that we are dealing with a large network.
3545
			}
3546
		}
3547
		if ( false === ( $user_count = get_transient( 'jetpack_site_user_count' ) ) ) {
3548
			// It wasn't there, so regenerate the data and save the transient
3549
			$user_count = $wpdb->get_var( "SELECT COUNT(*) FROM $wpdb->usermeta WHERE meta_key = '{$wpdb->prefix}capabilities'" );
3550
			set_transient( 'jetpack_site_user_count', $user_count, DAY_IN_SECONDS );
3551
		}
3552
		return $user_count;
3553
	}
3554
3555
	/* Admin Pages */
3556
3557
	function admin_init() {
3558
		// If the plugin is not connected, display a connect message.
3559
		if (
3560
			// the plugin was auto-activated and needs its candy
3561
			Jetpack_Options::get_option_and_ensure_autoload( 'do_activate', '0' )
3562
		||
3563
			// the plugin is active, but was never activated.  Probably came from a site-wide network activation
3564
			! Jetpack_Options::get_option( 'activated' )
3565
		) {
3566
			self::plugin_initialize();
3567
		}
3568
3569
		$is_offline_mode = ( new Status() )->is_offline_mode();
3570
		if ( ! self::is_active() && ! $is_offline_mode ) {
3571
			Jetpack_Connection_Banner::init();
3572
		} elseif ( false === Jetpack_Options::get_option( 'fallback_no_verify_ssl_certs' ) ) {
3573
			// Upgrade: 1.1 -> 1.1.1
3574
			// Check and see if host can verify the Jetpack servers' SSL certificate
3575
			$args = array();
3576
			Client::_wp_remote_request( self::connection()->api_url( 'test' ), $args, true );
3577
		}
3578
3579
		Jetpack_Wizard_Banner::init();
3580
3581
		if ( current_user_can( 'manage_options' ) && ! self::permit_ssl() ) {
3582
			add_action( 'jetpack_notices', array( $this, 'alert_auto_ssl_fail' ) );
3583
		}
3584
3585
		add_action( 'load-plugins.php', array( $this, 'intercept_plugin_error_scrape_init' ) );
3586
		add_action( 'admin_enqueue_scripts', array( $this, 'admin_menu_css' ) );
3587
		add_action( 'admin_enqueue_scripts', array( $this, 'deactivate_dialog' ) );
3588
		add_filter( 'plugin_action_links_' . plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ), array( $this, 'plugin_action_links' ) );
3589
3590
		if ( self::is_active() || $is_offline_mode ) {
3591
			// Artificially throw errors in certain specific cases during plugin activation.
3592
			add_action( 'activate_plugin', array( $this, 'throw_error_on_activate_plugin' ) );
3593
		}
3594
3595
		// Add custom column in wp-admin/users.php to show whether user is linked.
3596
		add_filter( 'manage_users_columns', array( $this, 'jetpack_icon_user_connected' ) );
3597
		add_action( 'manage_users_custom_column', array( $this, 'jetpack_show_user_connected_icon' ), 10, 3 );
3598
		add_action( 'admin_print_styles', array( $this, 'jetpack_user_col_style' ) );
3599
	}
3600
3601
	function admin_body_class( $admin_body_class = '' ) {
3602
		$classes = explode( ' ', trim( $admin_body_class ) );
3603
3604
		$classes[] = self::is_active() ? 'jetpack-connected' : 'jetpack-disconnected';
3605
3606
		$admin_body_class = implode( ' ', array_unique( $classes ) );
3607
		return " $admin_body_class ";
3608
	}
3609
3610
	static function add_jetpack_pagestyles( $admin_body_class = '' ) {
3611
		return $admin_body_class . ' jetpack-pagestyles ';
3612
	}
3613
3614
	/**
3615
	 * Sometimes a plugin can activate without causing errors, but it will cause errors on the next page load.
3616
	 * This function artificially throws errors for such cases (per a specific list).
3617
	 *
3618
	 * @param string $plugin The activated plugin.
3619
	 */
3620
	function throw_error_on_activate_plugin( $plugin ) {
3621
		$active_modules = self::get_active_modules();
3622
3623
		// The Shortlinks module and the Stats plugin conflict, but won't cause errors on activation because of some function_exists() checks.
3624
		if ( function_exists( 'stats_get_api_key' ) && in_array( 'shortlinks', $active_modules ) ) {
3625
			$throw = false;
3626
3627
			// Try and make sure it really was the stats plugin
3628
			if ( ! class_exists( 'ReflectionFunction' ) ) {
3629
				if ( 'stats.php' == basename( $plugin ) ) {
3630
					$throw = true;
3631
				}
3632
			} else {
3633
				$reflection = new ReflectionFunction( 'stats_get_api_key' );
3634
				if ( basename( $plugin ) == basename( $reflection->getFileName() ) ) {
3635
					$throw = true;
3636
				}
3637
			}
3638
3639
			if ( $throw ) {
3640
				trigger_error( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), 'WordPress.com Stats' ), E_USER_ERROR );
3641
			}
3642
		}
3643
	}
3644
3645
	function intercept_plugin_error_scrape_init() {
3646
		add_action( 'check_admin_referer', array( $this, 'intercept_plugin_error_scrape' ), 10, 2 );
3647
	}
3648
3649
	function intercept_plugin_error_scrape( $action, $result ) {
3650
		if ( ! $result ) {
3651
			return;
3652
		}
3653
3654
		foreach ( $this->plugins_to_deactivate as $deactivate_me ) {
3655
			if ( "plugin-activation-error_{$deactivate_me[0]}" == $action ) {
3656
				self::bail_on_activation( sprintf( __( 'Jetpack contains the most recent version of the old &#8220;%1$s&#8221; plugin.', 'jetpack' ), $deactivate_me[1] ), false );
3657
			}
3658
		}
3659
	}
3660
3661
	/**
3662
	 * Register the remote file upload request handlers, if needed.
3663
	 *
3664
	 * @access public
3665
	 */
3666
	public function add_remote_request_handlers() {
3667
		// Remote file uploads are allowed only via AJAX requests.
3668
		if ( ! is_admin() || ! Constants::get_constant( 'DOING_AJAX' ) ) {
3669
			return;
3670
		}
3671
3672
		// Remote file uploads are allowed only for a set of specific AJAX actions.
3673
		$remote_request_actions = array(
3674
			'jetpack_upload_file',
3675
			'jetpack_update_file',
3676
		);
3677
3678
		// phpcs:ignore WordPress.Security.NonceVerification
3679
		if ( ! isset( $_POST['action'] ) || ! in_array( $_POST['action'], $remote_request_actions, true ) ) {
3680
			return;
3681
		}
3682
3683
		// Require Jetpack authentication for the remote file upload AJAX requests.
3684
		if ( ! $this->connection_manager ) {
3685
			$this->connection_manager = new Connection_Manager();
3686
		}
3687
3688
		$this->connection_manager->require_jetpack_authentication();
3689
3690
		// Register the remote file upload AJAX handlers.
3691
		foreach ( $remote_request_actions as $action ) {
3692
			add_action( "wp_ajax_nopriv_{$action}", array( $this, 'remote_request_handlers' ) );
3693
		}
3694
	}
3695
3696
	/**
3697
	 * Handler for Jetpack remote file uploads.
3698
	 *
3699
	 * @access public
3700
	 */
3701
	public function remote_request_handlers() {
3702
		$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...
3703
3704
		switch ( current_filter() ) {
3705
			case 'wp_ajax_nopriv_jetpack_upload_file':
3706
				$response = $this->upload_handler();
3707
				break;
3708
3709
			case 'wp_ajax_nopriv_jetpack_update_file':
3710
				$response = $this->upload_handler( true );
3711
				break;
3712
			default:
3713
				$response = new WP_Error( 'unknown_handler', 'Unknown Handler', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_handler'.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3725
3726
			if ( ! is_int( $status_code ) ) {
3727
				$status_code = 400;
3728
			}
3729
3730
			status_header( $status_code );
3731
			die( json_encode( (object) compact( 'error', 'error_description' ) ) );
3732
		}
3733
3734
		status_header( 200 );
3735
		if ( true === $response ) {
3736
			exit;
3737
		}
3738
3739
		die( json_encode( (object) $response ) );
3740
	}
3741
3742
	/**
3743
	 * Uploads a file gotten from the global $_FILES.
3744
	 * If `$update_media_item` is true and `post_id` is defined
3745
	 * the attachment file of the media item (gotten through of the post_id)
3746
	 * will be updated instead of add a new one.
3747
	 *
3748
	 * @param  boolean $update_media_item - update media attachment
3749
	 * @return array - An array describing the uploadind files process
3750
	 */
3751
	function upload_handler( $update_media_item = false ) {
3752
		if ( 'POST' !== strtoupper( $_SERVER['REQUEST_METHOD'] ) ) {
3753
			return new WP_Error( 405, get_status_header_desc( 405 ), 405 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 405.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Loading history...
3774
			}
3775
		}
3776
3777
		$media_keys = array_keys( $_FILES['media'] );
3778
3779
		$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...
3780
		if ( ! $token || is_wp_error( $token ) ) {
3781
			return new WP_Error( 'unknown_token', 'Unknown Jetpack token', 403 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'unknown_token'.

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

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

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

Loading history...
3782
		}
3783
3784
		$uploaded_files = array();
3785
		$global_post    = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null;
3786
		unset( $GLOBALS['post'] );
3787
		foreach ( $_FILES['media']['name'] as $index => $name ) {
3788
			$file = array();
3789
			foreach ( $media_keys as $media_key ) {
3790
				$file[ $media_key ] = $_FILES['media'][ $media_key ][ $index ];
3791
			}
3792
3793
			list( $hmac_provided, $salt ) = explode( ':', $_POST['_jetpack_file_hmac_media'][ $index ] );
3794
3795
			$hmac_file = hash_hmac_file( 'sha1', $file['tmp_name'], $salt . $token->secret );
3796
			if ( $hmac_provided !== $hmac_file ) {
3797
				$uploaded_files[ $index ] = (object) array(
3798
					'error'             => 'invalid_hmac',
3799
					'error_description' => 'The corresponding HMAC for this file does not match',
3800
				);
3801
				continue;
3802
			}
3803
3804
			$_FILES['.jetpack.upload.'] = $file;
3805
			$post_id                    = isset( $_POST['post_id'][ $index ] ) ? absint( $_POST['post_id'][ $index ] ) : 0;
3806
			if ( ! current_user_can( 'edit_post', $post_id ) ) {
3807
				$post_id = 0;
3808
			}
3809
3810
			if ( $update_media_item ) {
3811
				if ( ! isset( $post_id ) || $post_id === 0 ) {
3812
					return new WP_Error( 'invalid_input', 'Media ID must be defined.', 400 );
0 ignored issues
show
Unused Code introduced by
The call to WP_Error::__construct() has too many arguments starting with 'invalid_input'.

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

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

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

Loading history...
3813
				}
3814
3815
				$media_array = $_FILES['media'];
3816
3817
				$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...
3818
				$file_array['type']     = $media_array['type'][0];
3819
				$file_array['tmp_name'] = $media_array['tmp_name'][0];
3820
				$file_array['error']    = $media_array['error'][0];
3821
				$file_array['size']     = $media_array['size'][0];
3822
3823
				$edited_media_item = Jetpack_Media::edit_media_file( $post_id, $file_array );
3824
3825
				if ( is_wp_error( $edited_media_item ) ) {
3826
					return $edited_media_item;
3827
				}
3828
3829
				$response = (object) array(
3830
					'id'   => (string) $post_id,
3831
					'file' => (string) $edited_media_item->post_title,
3832
					'url'  => (string) wp_get_attachment_url( $post_id ),
3833
					'type' => (string) $edited_media_item->post_mime_type,
3834
					'meta' => (array) wp_get_attachment_metadata( $post_id ),
3835
				);
3836
3837
				return (array) array( $response );
3838
			}
3839
3840
			$attachment_id = media_handle_upload(
3841
				'.jetpack.upload.',
3842
				$post_id,
3843
				array(),
3844
				array(
3845
					'action' => 'jetpack_upload_file',
3846
				)
3847
			);
3848
3849
			if ( ! $attachment_id ) {
3850
				$uploaded_files[ $index ] = (object) array(
3851
					'error'             => 'unknown',
3852
					'error_description' => 'An unknown problem occurred processing the upload on the Jetpack site',
3853
				);
3854
			} elseif ( is_wp_error( $attachment_id ) ) {
3855
				$uploaded_files[ $index ] = (object) array(
3856
					'error'             => 'attachment_' . $attachment_id->get_error_code(),
3857
					'error_description' => $attachment_id->get_error_message(),
3858
				);
3859
			} else {
3860
				$attachment               = get_post( $attachment_id );
3861
				$uploaded_files[ $index ] = (object) array(
3862
					'id'   => (string) $attachment_id,
3863
					'file' => $attachment->post_title,
3864
					'url'  => wp_get_attachment_url( $attachment_id ),
3865
					'type' => $attachment->post_mime_type,
3866
					'meta' => wp_get_attachment_metadata( $attachment_id ),
3867
				);
3868
				// Zip files uploads are not supported unless they are done for installation purposed
3869
				// lets delete them in case something goes wrong in this whole process
3870
				if ( 'application/zip' === $attachment->post_mime_type ) {
3871
					// Schedule a cleanup for 2 hours from now in case of failed install.
3872
					wp_schedule_single_event( time() + 2 * HOUR_IN_SECONDS, 'upgrader_scheduled_cleanup', array( $attachment_id ) );
3873
				}
3874
			}
3875
		}
3876
		if ( ! is_null( $global_post ) ) {
3877
			$GLOBALS['post'] = $global_post;
3878
		}
3879
3880
		return $uploaded_files;
3881
	}
3882
3883
	/**
3884
	 * Add help to the Jetpack page
3885
	 *
3886
	 * @since Jetpack (1.2.3)
3887
	 * @return false if not the Jetpack page
3888
	 */
3889
	function admin_help() {
3890
		$current_screen = get_current_screen();
3891
3892
		// Overview
3893
		$current_screen->add_help_tab(
3894
			array(
3895
				'id'      => 'home',
3896
				'title'   => __( 'Home', 'jetpack' ),
3897
				'content' =>
3898
					'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3899
					'<p>' . __( 'Jetpack supercharges your self-hosted WordPress site with the awesome cloud power of WordPress.com.', 'jetpack' ) . '</p>' .
3900
					'<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>',
3901
			)
3902
		);
3903
3904
		// Screen Content
3905
		if ( current_user_can( 'manage_options' ) ) {
3906
			$current_screen->add_help_tab(
3907
				array(
3908
					'id'      => 'settings',
3909
					'title'   => __( 'Settings', 'jetpack' ),
3910
					'content' =>
3911
						'<p><strong>' . __( 'Jetpack by WordPress.com', 'jetpack' ) . '</strong></p>' .
3912
						'<p>' . __( 'You can activate or deactivate individual Jetpack modules to suit your needs.', 'jetpack' ) . '</p>' .
3913
						'<ol>' .
3914
							'<li>' . __( 'Each module has an Activate or Deactivate link so you can toggle one individually.', 'jetpack' ) . '</li>' .
3915
							'<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>' .
3916
						'</ol>' .
3917
						'<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>',
3918
				)
3919
			);
3920
		}
3921
3922
		// Help Sidebar
3923
		$support_url = Redirect::get_url( 'jetpack-support' );
3924
		$faq_url     = Redirect::get_url( 'jetpack-faq' );
3925
		$current_screen->set_help_sidebar(
3926
			'<p><strong>' . __( 'For more information:', 'jetpack' ) . '</strong></p>' .
3927
			'<p><a href="' . $faq_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack FAQ', 'jetpack' ) . '</a></p>' .
3928
			'<p><a href="' . $support_url . '" rel="noopener noreferrer" target="_blank">' . __( 'Jetpack Support', 'jetpack' ) . '</a></p>' .
3929
			'<p><a href="' . self::admin_url( array( 'page' => 'jetpack-debugger' ) ) . '">' . __( 'Jetpack Debugging Center', 'jetpack' ) . '</a></p>'
3930
		);
3931
	}
3932
3933
	function admin_menu_css() {
3934
		wp_enqueue_style( 'jetpack-icons' );
3935
	}
3936
3937
	function admin_menu_order() {
3938
		return true;
3939
	}
3940
3941
	function jetpack_menu_order( $menu_order ) {
3942
		$jp_menu_order = array();
3943
3944
		foreach ( $menu_order as $index => $item ) {
3945
			if ( $item != 'jetpack' ) {
3946
				$jp_menu_order[] = $item;
3947
			}
3948
3949
			if ( $index == 0 ) {
3950
				$jp_menu_order[] = 'jetpack';
3951
			}
3952
		}
3953
3954
		return $jp_menu_order;
3955
	}
3956
3957
	function admin_banner_styles() {
3958
		$min = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
3959
3960 View Code Duplication
		if ( ! wp_style_is( 'jetpack-dops-style' ) ) {
3961
			wp_register_style(
3962
				'jetpack-dops-style',
3963
				plugins_url( '_inc/build/admin.css', JETPACK__PLUGIN_FILE ),
3964
				array(),
3965
				JETPACK__VERSION
3966
			);
3967
		}
3968
3969
		wp_enqueue_style(
3970
			'jetpack',
3971
			plugins_url( "css/jetpack-banners{$min}.css", JETPACK__PLUGIN_FILE ),
3972
			array( 'jetpack-dops-style' ),
3973
			JETPACK__VERSION . '-20121016'
3974
		);
3975
		wp_style_add_data( 'jetpack', 'rtl', 'replace' );
3976
		wp_style_add_data( 'jetpack', 'suffix', $min );
3977
	}
3978
3979
	function plugin_action_links( $actions ) {
3980
3981
		$jetpack_home = array( 'jetpack-home' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack' ), 'Jetpack' ) );
3982
3983
		if ( current_user_can( 'jetpack_manage_modules' ) && ( self::is_active() || ( new Status() )->is_offline_mode() ) ) {
3984
			return array_merge(
3985
				$jetpack_home,
3986
				array( 'settings' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack#/settings' ), __( 'Settings', 'jetpack' ) ) ),
3987
				array( 'support' => sprintf( '<a href="%s">%s</a>', self::admin_url( 'page=jetpack-debugger ' ), __( 'Support', 'jetpack' ) ) ),
3988
				$actions
3989
			);
3990
		}
3991
3992
		return array_merge( $jetpack_home, $actions );
3993
	}
3994
3995
	/**
3996
	 * Adds the deactivation warning modal if there are other active plugins using the connection
3997
	 *
3998
	 * @param string $hook The current admin page.
3999
	 *
4000
	 * @return void
4001
	 */
4002
	public function deactivate_dialog( $hook ) {
4003
		if (
4004
			'plugins.php' === $hook
4005
			&& self::is_active()
4006
		) {
4007
4008
			$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4009
4010
			if ( count( $active_plugins_using_connection ) > 1 ) {
4011
4012
				add_thickbox();
4013
4014
				wp_register_script(
4015
					'jp-tracks',
4016
					'//stats.wp.com/w.js',
4017
					array(),
4018
					gmdate( 'YW' ),
4019
					true
4020
				);
4021
4022
				wp_register_script(
4023
					'jp-tracks-functions',
4024
					plugins_url( '_inc/lib/tracks/tracks-callables.js', JETPACK__PLUGIN_FILE ),
4025
					array( 'jp-tracks' ),
4026
					JETPACK__VERSION,
4027
					false
4028
				);
4029
4030
				wp_enqueue_script(
4031
					'jetpack-deactivate-dialog-js',
4032
					Assets::get_file_url_for_environment(
4033
						'_inc/build/jetpack-deactivate-dialog.min.js',
4034
						'_inc/jetpack-deactivate-dialog.js'
4035
					),
4036
					array( 'jquery', 'jp-tracks-functions' ),
4037
					JETPACK__VERSION,
4038
					true
4039
				);
4040
4041
				wp_localize_script(
4042
					'jetpack-deactivate-dialog-js',
4043
					'deactivate_dialog',
4044
					array(
4045
						'title'            => __( 'Deactivate Jetpack', 'jetpack' ),
4046
						'deactivate_label' => __( 'Disconnect and Deactivate', 'jetpack' ),
4047
						'tracksUserData'   => Jetpack_Tracks_Client::get_connected_user_tracks_identity(),
4048
					)
4049
				);
4050
4051
				add_action( 'admin_footer', array( $this, 'deactivate_dialog_content' ) );
4052
4053
				wp_enqueue_style( 'jetpack-deactivate-dialog', plugins_url( 'css/jetpack-deactivate-dialog.css', JETPACK__PLUGIN_FILE ), array(), JETPACK__VERSION );
4054
			}
4055
		}
4056
	}
4057
4058
	/**
4059
	 * Outputs the content of the deactivation modal
4060
	 *
4061
	 * @return void
4062
	 */
4063
	public function deactivate_dialog_content() {
4064
		$active_plugins_using_connection = Connection_Plugin_Storage::get_all();
4065
		unset( $active_plugins_using_connection['jetpack'] );
4066
		$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 4064 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...
4067
	}
4068
4069
	/**
4070
	 * Filters the login URL to include the registration flow in case the user isn't logged in.
4071
	 *
4072
	 * @param string $login_url The wp-login URL.
4073
	 * @param string $redirect  URL to redirect users after logging in.
4074
	 * @since Jetpack 8.4
4075
	 * @return string
4076
	 */
4077
	public function login_url( $login_url, $redirect ) {
4078
		parse_str( wp_parse_url( $redirect, PHP_URL_QUERY ), $redirect_parts );
4079
		if ( ! empty( $redirect_parts[ self::$jetpack_redirect_login ] ) ) {
4080
			$login_url = add_query_arg( self::$jetpack_redirect_login, 'true', $login_url );
4081
		}
4082
		return $login_url;
4083
	}
4084
4085
	/**
4086
	 * Redirects non-authenticated users to authenticate with Calypso if redirect flag is set.
4087
	 *
4088
	 * @since Jetpack 8.4
4089
	 */
4090
	public function login_init() {
4091
		// phpcs:ignore WordPress.Security.NonceVerification
4092
		if ( ! empty( $_GET[ self::$jetpack_redirect_login ] ) ) {
4093
			add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4094
			wp_safe_redirect(
4095
				add_query_arg(
4096
					array(
4097
						'forceInstall' => 1,
4098
						'url'          => rawurlencode( get_site_url() ),
4099
					),
4100
					// @todo provide way to go to specific calypso env.
4101
					self::get_calypso_host() . 'jetpack/connect'
4102
				)
4103
			);
4104
			exit;
4105
		}
4106
	}
4107
4108
	/*
4109
	 * Registration flow:
4110
	 * 1 - ::admin_page_load() action=register
4111
	 * 2 - ::try_registration()
4112
	 * 3 - ::register()
4113
	 *     - Creates jetpack_register option containing two secrets and a timestamp
4114
	 *     - Calls https://jetpack.wordpress.com/jetpack.register/1/ with
4115
	 *       siteurl, home, gmt_offset, timezone_string, site_name, secret_1, secret_2, site_lang, timeout, stats_id
4116
	 *     - That request to jetpack.wordpress.com does not immediately respond.  It first makes a request BACK to this site's
4117
	 *       xmlrpc.php?for=jetpack: RPC method: jetpack.verifyRegistration, Parameters: secret_1
4118
	 *     - The XML-RPC request verifies secret_1, deletes both secrets and responds with: secret_2
4119
	 *     - https://jetpack.wordpress.com/jetpack.register/1/ verifies that XML-RPC response (secret_2) then finally responds itself with
4120
	 *       jetpack_id, jetpack_secret, jetpack_public
4121
	 *     - ::register() then stores jetpack_options: id => jetpack_id, blog_token => jetpack_secret
4122
	 * 4 - redirect to https://wordpress.com/start/jetpack-connect
4123
	 * 5 - user logs in with WP.com account
4124
	 * 6 - remote request to this site's xmlrpc.php with action remoteAuthorize, Jetpack_XMLRPC_Server->remote_authorize
4125
	 *		- Manager::authorize()
4126
	 *		- Manager::get_token()
4127
	 *		- GET https://jetpack.wordpress.com/jetpack.token/1/ with
4128
	 *        client_id, client_secret, grant_type, code, redirect_uri:action=authorize, state, scope, user_email, user_login
4129
	 *			- which responds with access_token, token_type, scope
4130
	 *		- Manager::authorize() stores jetpack_options: user_token => access_token.$user_id
4131
	 *		- Jetpack::activate_default_modules()
4132
	 *     		- Deactivates deprecated plugins
4133
	 *     		- Activates all default modules
4134
	 *		- Responds with either error, or 'connected' for new connection, or 'linked' for additional linked users
4135
	 * 7 - For a new connection, user selects a Jetpack plan on wordpress.com
4136
	 * 8 - User is redirected back to wp-admin/index.php?page=jetpack with state:message=authorized
4137
	 *     Done!
4138
	 */
4139
4140
	/**
4141
	 * Handles the page load events for the Jetpack admin page
4142
	 */
4143
	function admin_page_load() {
4144
		$error = false;
4145
4146
		// Make sure we have the right body class to hook stylings for subpages off of.
4147
		add_filter( 'admin_body_class', array( __CLASS__, 'add_jetpack_pagestyles' ), 20 );
4148
4149
		if ( ! empty( $_GET['jetpack_restate'] ) ) {
4150
			// Should only be used in intermediate redirects to preserve state across redirects
4151
			self::restate();
4152
		}
4153
4154
		if ( isset( $_GET['connect_url_redirect'] ) ) {
4155
			// @todo: Add validation against a known allowed list.
4156
			$from = ! empty( $_GET['from'] ) ? $_GET['from'] : 'iframe';
4157
			// User clicked in the iframe to link their accounts
4158
			if ( ! self::is_user_connected() ) {
4159
				$redirect = ! empty( $_GET['redirect_after_auth'] ) ? $_GET['redirect_after_auth'] : false;
4160
4161
				add_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4162
				$connect_url = $this->build_connect_url( true, $redirect, $from );
4163
				remove_filter( 'allowed_redirect_hosts', array( &$this, 'allow_wpcom_environments' ) );
4164
4165
				if ( isset( $_GET['notes_iframe'] ) ) {
4166
					$connect_url .= '&notes_iframe';
4167
				}
4168
				wp_redirect( $connect_url );
4169
				exit;
4170
			} else {
4171
				if ( ! isset( $_GET['calypso_env'] ) ) {
4172
					self::state( 'message', 'already_authorized' );
4173
					wp_safe_redirect( self::admin_url() );
4174
					exit;
4175
				} else {
4176
					$connect_url  = $this->build_connect_url( true, false, $from );
4177
					$connect_url .= '&already_authorized=true';
4178
					wp_redirect( $connect_url );
4179
					exit;
4180
				}
4181
			}
4182
		}
4183
4184
		if ( isset( $_GET['action'] ) ) {
4185
			switch ( $_GET['action'] ) {
4186
				case 'authorize':
4187
					if ( self::is_active() && self::is_user_connected() ) {
4188
						self::state( 'message', 'already_authorized' );
4189
						wp_safe_redirect( self::admin_url() );
4190
						exit;
4191
					}
4192
					self::log( 'authorize' );
4193
					$client_server = new Jetpack_Client_Server();
4194
					$client_server->client_authorize();
4195
					exit;
4196
				case 'register':
4197
					if ( ! current_user_can( 'jetpack_connect' ) ) {
4198
						$error = 'cheatin';
4199
						break;
4200
					}
4201
					check_admin_referer( 'jetpack-register' );
4202
					self::log( 'register' );
4203
					self::maybe_set_version_option();
4204
					$registered = self::try_registration();
4205 View Code Duplication
					if ( is_wp_error( $registered ) ) {
4206
						$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...
4207
						self::state( 'error', $error );
4208
						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...
4209
4210
						/**
4211
						 * Jetpack registration Error.
4212
						 *
4213
						 * @since 7.5.0
4214
						 *
4215
						 * @param string|int $error The error code.
4216
						 * @param \WP_Error $registered The error object.
4217
						 */
4218
						do_action( 'jetpack_connection_register_fail', $error, $registered );
4219
						break;
4220
					}
4221
4222
					$from     = isset( $_GET['from'] ) ? $_GET['from'] : false;
4223
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : false;
4224
4225
					/**
4226
					 * Jetpack registration Success.
4227
					 *
4228
					 * @since 7.5.0
4229
					 *
4230
					 * @param string $from 'from' GET parameter;
4231
					 */
4232
					do_action( 'jetpack_connection_register_success', $from );
4233
4234
					$url = $this->build_connect_url( true, $redirect, $from );
4235
4236
					if ( ! empty( $_GET['onboarding'] ) ) {
4237
						$url = add_query_arg( 'onboarding', $_GET['onboarding'], $url );
4238
					}
4239
4240
					if ( ! empty( $_GET['auth_approved'] ) && 'true' === $_GET['auth_approved'] ) {
4241
						$url = add_query_arg( 'auth_approved', 'true', $url );
4242
					}
4243
4244
					wp_redirect( $url );
4245
					exit;
4246
				case 'activate':
4247
					if ( ! current_user_can( 'jetpack_activate_modules' ) ) {
4248
						$error = 'cheatin';
4249
						break;
4250
					}
4251
4252
					$module = stripslashes( $_GET['module'] );
4253
					check_admin_referer( "jetpack_activate-$module" );
4254
					self::log( 'activate', $module );
4255
					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...
4256
						self::state( 'error', sprintf( __( 'Could not activate %s', 'jetpack' ), $module ) );
4257
					}
4258
					// The following two lines will rarely happen, as Jetpack::activate_module normally exits at the end.
4259
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4260
					exit;
4261
				case 'activate_default_modules':
4262
					check_admin_referer( 'activate_default_modules' );
4263
					self::log( 'activate_default_modules' );
4264
					self::restate();
4265
					$min_version   = isset( $_GET['min_version'] ) ? $_GET['min_version'] : false;
4266
					$max_version   = isset( $_GET['max_version'] ) ? $_GET['max_version'] : false;
4267
					$other_modules = isset( $_GET['other_modules'] ) && is_array( $_GET['other_modules'] ) ? $_GET['other_modules'] : array();
4268
					self::activate_default_modules( $min_version, $max_version, $other_modules );
4269
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4270
					exit;
4271
				case 'disconnect':
4272
					if ( ! current_user_can( 'jetpack_disconnect' ) ) {
4273
						$error = 'cheatin';
4274
						break;
4275
					}
4276
4277
					check_admin_referer( 'jetpack-disconnect' );
4278
					self::log( 'disconnect' );
4279
					self::disconnect();
4280
					wp_safe_redirect( self::admin_url( 'disconnected=true' ) );
4281
					exit;
4282
				case 'reconnect':
4283
					if ( ! current_user_can( 'jetpack_reconnect' ) ) {
4284
						$error = 'cheatin';
4285
						break;
4286
					}
4287
4288
					check_admin_referer( 'jetpack-reconnect' );
4289
					self::log( 'reconnect' );
4290
					$this->disconnect();
4291
					wp_redirect( $this->build_connect_url( true, false, 'reconnect' ) );
4292
					exit;
4293 View Code Duplication
				case 'deactivate':
4294
					if ( ! current_user_can( 'jetpack_deactivate_modules' ) ) {
4295
						$error = 'cheatin';
4296
						break;
4297
					}
4298
4299
					$modules = stripslashes( $_GET['module'] );
4300
					check_admin_referer( "jetpack_deactivate-$modules" );
4301
					foreach ( explode( ',', $modules ) as $module ) {
4302
						self::log( 'deactivate', $module );
4303
						self::deactivate_module( $module );
4304
						self::state( 'message', 'module_deactivated' );
4305
					}
4306
					self::state( 'module', $modules );
4307
					wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4308
					exit;
4309
				case 'unlink':
4310
					$redirect = isset( $_GET['redirect'] ) ? $_GET['redirect'] : '';
4311
					check_admin_referer( 'jetpack-unlink' );
4312
					self::log( 'unlink' );
4313
					Connection_Manager::disconnect_user();
4314
					self::state( 'message', 'unlinked' );
4315
					if ( 'sub-unlink' == $redirect ) {
4316
						wp_safe_redirect( admin_url() );
4317
					} else {
4318
						wp_safe_redirect( self::admin_url( array( 'page' => $redirect ) ) );
4319
					}
4320
					exit;
4321
				case 'onboard':
4322
					if ( ! current_user_can( 'manage_options' ) ) {
4323
						wp_safe_redirect( self::admin_url( 'page=jetpack' ) );
4324
					} else {
4325
						self::create_onboarding_token();
4326
						$url = $this->build_connect_url( true );
4327
4328
						if ( false !== ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
4329
							$url = add_query_arg( 'onboarding', $token, $url );
4330
						}
4331
4332
						$calypso_env = $this->get_calypso_env();
4333
						if ( ! empty( $calypso_env ) ) {
4334
							$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4335
						}
4336
4337
						wp_redirect( $url );
4338
						exit;
4339
					}
4340
					exit;
4341
				default:
4342
					/**
4343
					 * Fires when a Jetpack admin page is loaded with an unrecognized parameter.
4344
					 *
4345
					 * @since 2.6.0
4346
					 *
4347
					 * @param string sanitize_key( $_GET['action'] ) Unrecognized URL parameter.
4348
					 */
4349
					do_action( 'jetpack_unrecognized_action', sanitize_key( $_GET['action'] ) );
4350
			}
4351
		}
4352
4353
		if ( ! $error = $error ? $error : self::state( 'error' ) ) {
4354
			self::activate_new_modules( true );
4355
		}
4356
4357
		$message_code = self::state( 'message' );
4358
		if ( self::state( 'optin-manage' ) ) {
4359
			$activated_manage = $message_code;
4360
			$message_code     = 'jetpack-manage';
4361
		}
4362
4363
		switch ( $message_code ) {
4364
			case 'jetpack-manage':
4365
				$sites_url = esc_url( Redirect::get_url( 'calypso-sites' ) );
4366
				// translators: %s is the URL to the "Sites" panel on wordpress.com.
4367
				$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>';
4368
				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...
4369
					$this->message .= '<br /><strong>' . __( 'Manage has been activated for you!', 'jetpack' ) . '</strong>';
4370
				}
4371
				break;
4372
4373
		}
4374
4375
		$deactivated_plugins = self::state( 'deactivated_plugins' );
4376
4377
		if ( ! empty( $deactivated_plugins ) ) {
4378
			$deactivated_plugins = explode( ',', $deactivated_plugins );
4379
			$deactivated_titles  = array();
4380
			foreach ( $deactivated_plugins as $deactivated_plugin ) {
4381
				if ( ! isset( $this->plugins_to_deactivate[ $deactivated_plugin ] ) ) {
4382
					continue;
4383
				}
4384
4385
				$deactivated_titles[] = '<strong>' . str_replace( ' ', '&nbsp;', $this->plugins_to_deactivate[ $deactivated_plugin ][1] ) . '</strong>';
4386
			}
4387
4388
			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...
4389
				if ( $this->message ) {
4390
					$this->message .= "<br /><br />\n";
4391
				}
4392
4393
				$this->message .= wp_sprintf(
4394
					_n(
4395
						'Jetpack contains the most recent version of the old %l plugin.',
4396
						'Jetpack contains the most recent versions of the old %l plugins.',
4397
						count( $deactivated_titles ),
4398
						'jetpack'
4399
					),
4400
					$deactivated_titles
4401
				);
4402
4403
				$this->message .= "<br />\n";
4404
4405
				$this->message .= _n(
4406
					'The old version has been deactivated and can be removed from your site.',
4407
					'The old versions have been deactivated and can be removed from your site.',
4408
					count( $deactivated_titles ),
4409
					'jetpack'
4410
				);
4411
			}
4412
		}
4413
4414
		$this->privacy_checks = self::state( 'privacy_checks' );
4415
4416
		if ( $this->message || $this->error || $this->privacy_checks ) {
4417
			add_action( 'jetpack_notices', array( $this, 'admin_notices' ) );
4418
		}
4419
4420
		add_filter( 'jetpack_short_module_description', 'wptexturize' );
4421
	}
4422
4423
	function admin_notices() {
4424
4425
		if ( $this->error ) {
4426
			?>
4427
<div id="message" class="jetpack-message jetpack-err">
4428
	<div class="squeezer">
4429
		<h2>
4430
			<?php
4431
			echo wp_kses(
4432
				$this->error,
4433
				array(
4434
					'a'      => array( 'href' => array() ),
4435
					'small'  => true,
4436
					'code'   => true,
4437
					'strong' => true,
4438
					'br'     => true,
4439
					'b'      => true,
4440
				)
4441
			);
4442
			?>
4443
			</h2>
4444
			<?php	if ( $desc = self::state( 'error_description' ) ) : ?>
4445
		<p><?php echo esc_html( stripslashes( $desc ) ); ?></p>
4446
<?php	endif; ?>
4447
	</div>
4448
</div>
4449
			<?php
4450
		}
4451
4452
		if ( $this->message ) {
4453
			?>
4454
<div id="message" class="jetpack-message">
4455
	<div class="squeezer">
4456
		<h2>
4457
			<?php
4458
			echo wp_kses(
4459
				$this->message,
4460
				array(
4461
					'strong' => array(),
4462
					'a'      => array( 'href' => true ),
4463
					'br'     => true,
4464
				)
4465
			);
4466
			?>
4467
			</h2>
4468
	</div>
4469
</div>
4470
			<?php
4471
		}
4472
4473
		if ( $this->privacy_checks ) :
4474
			$module_names = $module_slugs = array();
4475
4476
			$privacy_checks = explode( ',', $this->privacy_checks );
4477
			$privacy_checks = array_filter( $privacy_checks, array( 'Jetpack', 'is_module' ) );
4478
			foreach ( $privacy_checks as $module_slug ) {
4479
				$module = self::get_module( $module_slug );
4480
				if ( ! $module ) {
4481
					continue;
4482
				}
4483
4484
				$module_slugs[] = $module_slug;
4485
				$module_names[] = "<strong>{$module['name']}</strong>";
4486
			}
4487
4488
			$module_slugs = join( ',', $module_slugs );
4489
			?>
4490
<div id="message" class="jetpack-message jetpack-err">
4491
	<div class="squeezer">
4492
		<h2><strong><?php esc_html_e( 'Is this site private?', 'jetpack' ); ?></strong></h2><br />
4493
		<p>
4494
			<?php
4495
			echo wp_kses(
4496
				wptexturize(
4497
					wp_sprintf(
4498
						_nx(
4499
							"Like your site's RSS feeds, %l allows access to your posts and other content to third parties.",
4500
							"Like your site's RSS feeds, %l allow access to your posts and other content to third parties.",
4501
							count( $privacy_checks ),
4502
							'%l = list of Jetpack module/feature names',
4503
							'jetpack'
4504
						),
4505
						$module_names
4506
					)
4507
				),
4508
				array( 'strong' => true )
4509
			);
4510
4511
			echo "\n<br />\n";
4512
4513
			echo wp_kses(
4514
				sprintf(
4515
					_nx(
4516
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating this feature</a>.',
4517
						'If your site is not publicly accessible, consider <a href="%1$s" title="%2$s">deactivating these features</a>.',
4518
						count( $privacy_checks ),
4519
						'%1$s = deactivation URL, %2$s = "Deactivate {list of Jetpack module/feature names}',
4520
						'jetpack'
4521
					),
4522
					wp_nonce_url(
4523
						self::admin_url(
4524
							array(
4525
								'page'   => 'jetpack',
4526
								'action' => 'deactivate',
4527
								'module' => urlencode( $module_slugs ),
4528
							)
4529
						),
4530
						"jetpack_deactivate-$module_slugs"
4531
					),
4532
					esc_attr( wp_kses( wp_sprintf( _x( 'Deactivate %l', '%l = list of Jetpack module/feature names', 'jetpack' ), $module_names ), array() ) )
4533
				),
4534
				array(
4535
					'a' => array(
4536
						'href'  => true,
4537
						'title' => true,
4538
					),
4539
				)
4540
			);
4541
			?>
4542
		</p>
4543
	</div>
4544
</div>
4545
			<?php
4546
endif;
4547
	}
4548
4549
	/**
4550
	 * We can't always respond to a signed XML-RPC request with a
4551
	 * helpful error message. In some circumstances, doing so could
4552
	 * leak information.
4553
	 *
4554
	 * Instead, track that the error occurred via a Jetpack_Option,
4555
	 * and send that data back in the heartbeat.
4556
	 * All this does is increment a number, but it's enough to find
4557
	 * trends.
4558
	 *
4559
	 * @param WP_Error $xmlrpc_error The error produced during
4560
	 *                               signature validation.
4561
	 */
4562
	function track_xmlrpc_error( $xmlrpc_error ) {
4563
		$code = is_wp_error( $xmlrpc_error )
4564
			? $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...
4565
			: 'should-not-happen';
4566
4567
		$xmlrpc_errors = Jetpack_Options::get_option( 'xmlrpc_errors', array() );
4568
		if ( isset( $xmlrpc_errors[ $code ] ) && $xmlrpc_errors[ $code ] ) {
4569
			// No need to update the option if we already have
4570
			// this code stored.
4571
			return;
4572
		}
4573
		$xmlrpc_errors[ $code ] = true;
4574
4575
		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...
4576
	}
4577
4578
	/**
4579
	 * Initialize the jetpack stats instance only when needed
4580
	 *
4581
	 * @return void
4582
	 */
4583
	private function initialize_stats() {
4584
		if ( is_null( $this->a8c_mc_stats_instance ) ) {
4585
			$this->a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4586
		}
4587
	}
4588
4589
	/**
4590
	 * Record a stat for later output.  This will only currently output in the admin_footer.
4591
	 */
4592
	function stat( $group, $detail ) {
4593
		$this->initialize_stats();
4594
		$this->a8c_mc_stats_instance->add( $group, $detail );
4595
4596
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4597
		$this->stats = $this->a8c_mc_stats_instance->get_current_stats();
4598
	}
4599
4600
	/**
4601
	 * Load stats pixels. $group is auto-prefixed with "x_jetpack-"
4602
	 */
4603
	function do_stats( $method = '' ) {
4604
		$this->initialize_stats();
4605
		if ( 'server_side' === $method ) {
4606
			$this->a8c_mc_stats_instance->do_server_side_stats();
4607
		} else {
4608
			$this->a8c_mc_stats_instance->do_stats();
4609
		}
4610
4611
		// Keep a local copy for backward compatibility (there are some direct checks on this).
4612
		$this->stats = array();
4613
	}
4614
4615
	/**
4616
	 * Runs stats code for a one-off, server-side.
4617
	 *
4618
	 * @param $args array|string The arguments to append to the URL. Should include `x_jetpack-{$group}={$stats}` or whatever we want to store.
4619
	 *
4620
	 * @return bool If it worked.
4621
	 */
4622
	static function do_server_side_stat( $args ) {
4623
		$url                   = self::build_stats_url( $args );
4624
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4625
		return $a8c_mc_stats_instance->do_server_side_stat( $url );
4626
	}
4627
4628
	/**
4629
	 * Builds the stats url.
4630
	 *
4631
	 * @param $args array|string The arguments to append to the URL.
4632
	 *
4633
	 * @return string The URL to be pinged.
4634
	 */
4635
	static function build_stats_url( $args ) {
4636
4637
		$a8c_mc_stats_instance = new Automattic\Jetpack\A8c_Mc_Stats();
4638
		return $a8c_mc_stats_instance->build_stats_url( $args );
4639
4640
	}
4641
4642
	/**
4643
	 * Get the role of the current user.
4644
	 *
4645
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_current_user_to_role() instead.
4646
	 *
4647
	 * @access public
4648
	 * @static
4649
	 *
4650
	 * @return string|boolean Current user's role, false if not enough capabilities for any of the roles.
4651
	 */
4652
	public static function translate_current_user_to_role() {
4653
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4654
4655
		$roles = new Roles();
4656
		return $roles->translate_current_user_to_role();
4657
	}
4658
4659
	/**
4660
	 * Get the role of a particular user.
4661
	 *
4662
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_user_to_role() instead.
4663
	 *
4664
	 * @access public
4665
	 * @static
4666
	 *
4667
	 * @param \WP_User $user User object.
4668
	 * @return string|boolean User's role, false if not enough capabilities for any of the roles.
4669
	 */
4670
	public static function translate_user_to_role( $user ) {
4671
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4672
4673
		$roles = new Roles();
4674
		return $roles->translate_user_to_role( $user );
4675
	}
4676
4677
	/**
4678
	 * Get the minimum capability for a role.
4679
	 *
4680
	 * @deprecated 7.6 Use Automattic\Jetpack\Roles::translate_role_to_cap() instead.
4681
	 *
4682
	 * @access public
4683
	 * @static
4684
	 *
4685
	 * @param string $role Role name.
4686
	 * @return string|boolean Capability, false if role isn't mapped to any capabilities.
4687
	 */
4688
	public static function translate_role_to_cap( $role ) {
4689
		_deprecated_function( __METHOD__, 'jetpack-7.6.0' );
4690
4691
		$roles = new Roles();
4692
		return $roles->translate_role_to_cap( $role );
4693
	}
4694
4695
	/**
4696
	 * Sign a user role with the master access token.
4697
	 * If not specified, will default to the current user.
4698
	 *
4699
	 * @deprecated since 7.7
4700
	 * @see Automattic\Jetpack\Connection\Manager::sign_role()
4701
	 *
4702
	 * @access public
4703
	 * @static
4704
	 *
4705
	 * @param string $role    User role.
4706
	 * @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...
4707
	 * @return string Signed user role.
4708
	 */
4709
	public static function sign_role( $role, $user_id = null ) {
4710
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::sign_role' );
4711
		return self::connection()->sign_role( $role, $user_id );
4712
	}
4713
4714
	/**
4715
	 * Builds a URL to the Jetpack connection auth page
4716
	 *
4717
	 * @since 3.9.5
4718
	 *
4719
	 * @param bool        $raw If true, URL will not be escaped.
4720
	 * @param bool|string $redirect If true, will redirect back to Jetpack wp-admin landing page after connection.
4721
	 *                              If string, will be a custom redirect.
4722
	 * @param bool|string $from If not false, adds 'from=$from' param to the connect URL.
4723
	 * @param bool        $register If true, will generate a register URL regardless of the existing token, since 4.9.0
4724
	 *
4725
	 * @return string Connect URL
4726
	 */
4727
	function build_connect_url( $raw = false, $redirect = false, $from = false, $register = false ) {
4728
		$site_id    = Jetpack_Options::get_option( 'id' );
4729
		$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...
4730
4731
		if ( $register || ! $blog_token || ! $site_id ) {
4732
			$url = self::nonce_url_no_esc( self::admin_url( 'action=register' ), 'jetpack-register' );
4733
4734
			if ( ! empty( $redirect ) ) {
4735
				$url = add_query_arg(
4736
					'redirect',
4737
					urlencode( wp_validate_redirect( esc_url_raw( $redirect ) ) ),
4738
					$url
4739
				);
4740
			}
4741
4742
			if ( is_network_admin() ) {
4743
				$url = add_query_arg( 'is_multisite', network_admin_url( 'admin.php?page=jetpack-settings' ), $url );
4744
			}
4745
4746
			$calypso_env = self::get_calypso_env();
4747
4748
			if ( ! empty( $calypso_env ) ) {
4749
				$url = add_query_arg( 'calypso_env', $calypso_env, $url );
4750
			}
4751
		} else {
4752
4753
			// Let's check the existing blog token to see if we need to re-register. We only check once per minute
4754
			// because otherwise this logic can get us in to a loop.
4755
			$last_connect_url_check = (int) Jetpack_Options::get_raw_option( 'jetpack_last_connect_url_check' );
4756
			if ( ! $last_connect_url_check || ( time() - $last_connect_url_check ) > MINUTE_IN_SECONDS ) {
4757
				Jetpack_Options::update_raw_option( 'jetpack_last_connect_url_check', time() );
4758
4759
				$response = Client::wpcom_json_api_request_as_blog(
4760
					sprintf( '/sites/%d', $site_id ) . '?force=wpcom',
4761
					'1.1'
4762
				);
4763
4764
				if ( 200 !== wp_remote_retrieve_response_code( $response ) ) {
4765
4766
					// Generating a register URL instead to refresh the existing token
4767
					return $this->build_connect_url( $raw, $redirect, $from, true );
4768
				}
4769
			}
4770
4771
			$url = $this->build_authorize_url( $redirect );
0 ignored issues
show
Bug introduced by
It seems like $redirect defined by parameter $redirect on line 4727 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...
4772
		}
4773
4774
		if ( $from ) {
4775
			$url = add_query_arg( 'from', $from, $url );
4776
		}
4777
4778
		$url = $raw ? esc_url_raw( $url ) : esc_url( $url );
4779
		/**
4780
		 * Filter the URL used when connecting a user to a WordPress.com account.
4781
		 *
4782
		 * @since 8.1.0
4783
		 *
4784
		 * @param string $url Connection URL.
4785
		 * @param bool   $raw If true, URL will not be escaped.
4786
		 */
4787
		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...
4788
	}
4789
4790
	public static function build_authorize_url( $redirect = false, $iframe = false ) {
4791
4792
		add_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4793
		add_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4794
		add_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4795
4796
		if ( $iframe ) {
4797
			add_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4798
		}
4799
4800
		$c8n = self::connection();
4801
		$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...
4802
4803
		remove_filter( 'jetpack_connect_request_body', array( __CLASS__, 'filter_connect_request_body' ) );
4804
		remove_filter( 'jetpack_connect_redirect_url', array( __CLASS__, 'filter_connect_redirect_url' ) );
4805
		remove_filter( 'jetpack_connect_processing_url', array( __CLASS__, 'filter_connect_processing_url' ) );
4806
4807
		if ( $iframe ) {
4808
			remove_filter( 'jetpack_use_iframe_authorization_flow', '__return_true' );
4809
		}
4810
4811
		/**
4812
		 * Filter the URL used when authorizing a user to a WordPress.com account.
4813
		 *
4814
		 * @since 8.9.0
4815
		 *
4816
		 * @param string $url Connection URL.
4817
		 */
4818
		return apply_filters( 'jetpack_build_authorize_url', $url );
4819
	}
4820
4821
	/**
4822
	 * Filters the connection URL parameter array.
4823
	 *
4824
	 * @param array $args default URL parameters used by the package.
4825
	 * @return array the modified URL arguments array.
4826
	 */
4827
	public static function filter_connect_request_body( $args ) {
4828
		if (
4829
			Constants::is_defined( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4830
			&& include_once Constants::get_constant( 'JETPACK__GLOTPRESS_LOCALES_PATH' )
4831
		) {
4832
			$gp_locale      = GP_Locales::by_field( 'wp_locale', get_locale() );
4833
			$args['locale'] = isset( $gp_locale ) && isset( $gp_locale->slug )
4834
				? $gp_locale->slug
4835
				: '';
4836
		}
4837
4838
		$tracking        = new Tracking();
4839
		$tracks_identity = $tracking->tracks_get_identity( $args['state'] );
4840
4841
		$args = array_merge(
4842
			$args,
4843
			array(
4844
				'_ui' => $tracks_identity['_ui'],
4845
				'_ut' => $tracks_identity['_ut'],
4846
			)
4847
		);
4848
4849
		$calypso_env = self::get_calypso_env();
4850
4851
		if ( ! empty( $calypso_env ) ) {
4852
			$args['calypso_env'] = $calypso_env;
4853
		}
4854
4855
		return $args;
4856
	}
4857
4858
	/**
4859
	 * Filters the URL that will process the connection data. It can be different from the URL
4860
	 * that we send the user to after everything is done.
4861
	 *
4862
	 * @param String $processing_url the default redirect URL used by the package.
4863
	 * @return String the modified URL.
4864
	 */
4865
	public static function filter_connect_processing_url( $processing_url ) {
4866
		$processing_url = admin_url( 'admin.php?page=jetpack' ); // Making PHPCS happy.
4867
		return $processing_url;
4868
	}
4869
4870
	/**
4871
	 * Filters the redirection URL that is used for connect requests. The redirect
4872
	 * URL should return the user back to the Jetpack console.
4873
	 *
4874
	 * @param String $redirect the default redirect URL used by the package.
4875
	 * @return String the modified URL.
4876
	 */
4877
	public static function filter_connect_redirect_url( $redirect ) {
4878
		$jetpack_admin_page = esc_url_raw( admin_url( 'admin.php?page=jetpack' ) );
4879
		$redirect           = $redirect
4880
			? wp_validate_redirect( esc_url_raw( $redirect ), $jetpack_admin_page )
4881
			: $jetpack_admin_page;
4882
4883
		if ( isset( $_REQUEST['is_multisite'] ) ) {
4884
			$redirect = Jetpack_Network::init()->get_url( 'network_admin_page' );
4885
		}
4886
4887
		return $redirect;
4888
	}
4889
4890
	/**
4891
	 * This action fires at the beginning of the Manager::authorize method.
4892
	 */
4893
	public static function authorize_starting() {
4894
		$jetpack_unique_connection = Jetpack_Options::get_option( 'unique_connection' );
4895
		// Checking if site has been active/connected previously before recording unique connection.
4896
		if ( ! $jetpack_unique_connection ) {
4897
			// jetpack_unique_connection option has never been set.
4898
			$jetpack_unique_connection = array(
4899
				'connected'    => 0,
4900
				'disconnected' => 0,
4901
				'version'      => '3.6.1',
4902
			);
4903
4904
			update_option( 'jetpack_unique_connection', $jetpack_unique_connection );
4905
4906
			// Track unique connection.
4907
			$jetpack = self::init();
4908
4909
			$jetpack->stat( 'connections', 'unique-connection' );
4910
			$jetpack->do_stats( 'server_side' );
4911
		}
4912
4913
		// Increment number of times connected.
4914
		$jetpack_unique_connection['connected'] += 1;
4915
		Jetpack_Options::update_option( 'unique_connection', $jetpack_unique_connection );
4916
	}
4917
4918
	/**
4919
	 * This action fires at the end of the Manager::authorize method when a secondary user is
4920
	 * linked.
4921
	 */
4922
	public static function authorize_ending_linked() {
4923
		// Don't activate anything since we are just connecting a user.
4924
		self::state( 'message', 'linked' );
4925
	}
4926
4927
	/**
4928
	 * This action fires at the end of the Manager::authorize method when the master user is
4929
	 * authorized.
4930
	 *
4931
	 * @param array $data The request data.
4932
	 */
4933
	public static function authorize_ending_authorized( $data ) {
4934
		// If this site has been through the Jetpack Onboarding flow, delete the onboarding token.
4935
		self::invalidate_onboarding_token();
4936
4937
		// If redirect_uri is SSO, ensure SSO module is enabled.
4938
		parse_str( wp_parse_url( $data['redirect_uri'], PHP_URL_QUERY ), $redirect_options );
4939
4940
		/** This filter is documented in class.jetpack-cli.php */
4941
		$jetpack_start_enable_sso = apply_filters( 'jetpack_start_enable_sso', true );
4942
4943
		$activate_sso = (
4944
			isset( $redirect_options['action'] ) &&
4945
			'jetpack-sso' === $redirect_options['action'] &&
4946
			$jetpack_start_enable_sso
4947
		);
4948
4949
		$do_redirect_on_error = ( 'client' === $data['auth_type'] );
4950
4951
		self::handle_post_authorization_actions( $activate_sso, $do_redirect_on_error );
4952
	}
4953
4954
	/**
4955
	 * This action fires at the end of the REST_Connector connection_reconnect method when the
4956
	 * reconnect process is completed.
4957
	 * Note that this currently only happens when we don't need the user to re-authorize
4958
	 * their WP.com account, eg in cases where we are restoring a connection with
4959
	 * unhealthy blog token.
4960
	 */
4961
	public static function reconnection_completed() {
4962
		self::state( 'message', 'reconnection_completed' );
4963
	}
4964
4965
	/**
4966
	 * Get our assumed site creation date.
4967
	 * Calculated based on the earlier date of either:
4968
	 * - Earliest admin user registration date.
4969
	 * - Earliest date of post of any post type.
4970
	 *
4971
	 * @since 7.2.0
4972
	 * @deprecated since 7.8.0
4973
	 *
4974
	 * @return string Assumed site creation date and time.
4975
	 */
4976
	public static function get_assumed_site_creation_date() {
4977
		_deprecated_function( __METHOD__, 'jetpack-7.8', 'Automattic\\Jetpack\\Connection\\Manager' );
4978
		return self::connection()->get_assumed_site_creation_date();
4979
	}
4980
4981 View Code Duplication
	public static function apply_activation_source_to_args( &$args ) {
4982
		list( $activation_source_name, $activation_source_keyword ) = get_option( 'jetpack_activation_source' );
4983
4984
		if ( $activation_source_name ) {
4985
			$args['_as'] = urlencode( $activation_source_name );
4986
		}
4987
4988
		if ( $activation_source_keyword ) {
4989
			$args['_ak'] = urlencode( $activation_source_keyword );
4990
		}
4991
	}
4992
4993
	function build_reconnect_url( $raw = false ) {
4994
		$url = wp_nonce_url( self::admin_url( 'action=reconnect' ), 'jetpack-reconnect' );
4995
		return $raw ? $url : esc_url( $url );
4996
	}
4997
4998
	public static function admin_url( $args = null ) {
4999
		$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...
5000
		$url  = add_query_arg( $args, admin_url( 'admin.php' ) );
5001
		return $url;
5002
	}
5003
5004
	public static function nonce_url_no_esc( $actionurl, $action = -1, $name = '_wpnonce' ) {
5005
		$actionurl = str_replace( '&amp;', '&', $actionurl );
5006
		return add_query_arg( $name, wp_create_nonce( $action ), $actionurl );
5007
	}
5008
5009
	function dismiss_jetpack_notice() {
5010
5011
		if ( ! isset( $_GET['jetpack-notice'] ) ) {
5012
			return;
5013
		}
5014
5015
		switch ( $_GET['jetpack-notice'] ) {
5016
			case 'dismiss':
5017
				if ( check_admin_referer( 'jetpack-deactivate' ) && ! is_plugin_active_for_network( plugin_basename( JETPACK__PLUGIN_DIR . 'jetpack.php' ) ) ) {
5018
5019
					require_once ABSPATH . 'wp-admin/includes/plugin.php';
5020
					deactivate_plugins( JETPACK__PLUGIN_DIR . 'jetpack.php', false, false );
5021
					wp_safe_redirect( admin_url() . 'plugins.php?deactivate=true&plugin_status=all&paged=1&s=' );
5022
				}
5023
				break;
5024
		}
5025
	}
5026
5027
	public static function sort_modules( $a, $b ) {
5028
		if ( $a['sort'] == $b['sort'] ) {
5029
			return 0;
5030
		}
5031
5032
		return ( $a['sort'] < $b['sort'] ) ? -1 : 1;
5033
	}
5034
5035
	function ajax_recheck_ssl() {
5036
		check_ajax_referer( 'recheck-ssl', 'ajax-nonce' );
5037
		$result = self::permit_ssl( true );
5038
		wp_send_json(
5039
			array(
5040
				'enabled' => $result,
5041
				'message' => get_transient( 'jetpack_https_test_message' ),
5042
			)
5043
		);
5044
	}
5045
5046
	/* Client API */
5047
5048
	/**
5049
	 * Returns the requested Jetpack API URL
5050
	 *
5051
	 * @deprecated since 7.7
5052
	 * @return string
5053
	 */
5054
	public static function api_url( $relative_url ) {
5055
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::api_url' );
5056
		$connection = self::connection();
5057
		return $connection->api_url( $relative_url );
5058
	}
5059
5060
	/**
5061
	 * @deprecated 8.0
5062
	 *
5063
	 * Some hosts disable the OpenSSL extension and so cannot make outgoing HTTPS requests.
5064
	 * But we no longer fix "bad hosts" anyway, outbound HTTPS is required for Jetpack to function.
5065
	 */
5066
	public static function fix_url_for_bad_hosts( $url ) {
5067
		_deprecated_function( __METHOD__, 'jetpack-8.0' );
5068
		return $url;
5069
	}
5070
5071
	public static function verify_onboarding_token( $token_data, $token, $request_data ) {
5072
		// Default to a blog token.
5073
		$token_type = 'blog';
5074
5075
		// Let's see if this is onboarding. In such case, use user token type and the provided user id.
5076
		if ( isset( $request_data ) || ! empty( $_GET['onboarding'] ) ) {
5077
			if ( ! empty( $_GET['onboarding'] ) ) {
5078
				$jpo = $_GET;
5079
			} else {
5080
				$jpo = json_decode( $request_data, true );
5081
			}
5082
5083
			$jpo_token = ! empty( $jpo['onboarding']['token'] ) ? $jpo['onboarding']['token'] : null;
5084
			$jpo_user  = ! empty( $jpo['onboarding']['jpUser'] ) ? $jpo['onboarding']['jpUser'] : null;
5085
5086
			if (
5087
				isset( $jpo_user )
5088
				&& isset( $jpo_token )
5089
				&& is_email( $jpo_user )
5090
				&& ctype_alnum( $jpo_token )
5091
				&& isset( $_GET['rest_route'] )
5092
				&& self::validate_onboarding_token_action(
5093
					$jpo_token,
5094
					$_GET['rest_route']
5095
				)
5096
			) {
5097
				$jp_user = get_user_by( 'email', $jpo_user );
5098
				if ( is_a( $jp_user, 'WP_User' ) ) {
5099
					wp_set_current_user( $jp_user->ID );
5100
					$user_can = is_multisite()
5101
						? current_user_can_for_blog( get_current_blog_id(), 'manage_options' )
5102
						: current_user_can( 'manage_options' );
5103
					if ( $user_can ) {
5104
						$token_type              = 'user';
5105
						$token->external_user_id = $jp_user->ID;
5106
					}
5107
				}
5108
			}
5109
5110
			$token_data['type']    = $token_type;
5111
			$token_data['user_id'] = $token->external_user_id;
5112
		}
5113
5114
		return $token_data;
5115
	}
5116
5117
	/**
5118
	 * Create a random secret for validating onboarding payload
5119
	 *
5120
	 * @return string Secret token
5121
	 */
5122
	public static function create_onboarding_token() {
5123
		if ( false === ( $token = Jetpack_Options::get_option( 'onboarding' ) ) ) {
5124
			$token = wp_generate_password( 32, false );
5125
			Jetpack_Options::update_option( 'onboarding', $token );
5126
		}
5127
5128
		return $token;
5129
	}
5130
5131
	/**
5132
	 * Remove the onboarding token
5133
	 *
5134
	 * @return bool True on success, false on failure
5135
	 */
5136
	public static function invalidate_onboarding_token() {
5137
		return Jetpack_Options::delete_option( 'onboarding' );
5138
	}
5139
5140
	/**
5141
	 * Validate an onboarding token for a specific action
5142
	 *
5143
	 * @return boolean True if token/action pair is accepted, false if not
5144
	 */
5145
	public static function validate_onboarding_token_action( $token, $action ) {
5146
		// Compare tokens, bail if tokens do not match
5147
		if ( ! hash_equals( $token, Jetpack_Options::get_option( 'onboarding' ) ) ) {
5148
			return false;
5149
		}
5150
5151
		// List of valid actions we can take
5152
		$valid_actions = array(
5153
			'/jetpack/v4/settings',
5154
		);
5155
5156
		// Only allow valid actions.
5157
		if ( ! in_array( $action, $valid_actions ) ) {
5158
			return false;
5159
		}
5160
5161
		return true;
5162
	}
5163
5164
	/**
5165
	 * Checks to see if the URL is using SSL to connect with Jetpack
5166
	 *
5167
	 * @since 2.3.3
5168
	 * @return boolean
5169
	 */
5170
	public static function permit_ssl( $force_recheck = false ) {
5171
		// Do some fancy tests to see if ssl is being supported
5172
		if ( $force_recheck || false === ( $ssl = get_transient( 'jetpack_https_test' ) ) ) {
5173
			$message = '';
5174
			if ( 'https' !== substr( JETPACK__API_BASE, 0, 5 ) ) {
5175
				$ssl = 0;
5176
			} else {
5177
				$ssl = 1;
5178
5179
				if ( ! wp_http_supports( array( 'ssl' => true ) ) ) {
5180
					$ssl     = 0;
5181
					$message = __( 'WordPress reports no SSL support', 'jetpack' );
5182
				} else {
5183
					$response = wp_remote_get( JETPACK__API_BASE . 'test/1/' );
5184
					if ( is_wp_error( $response ) ) {
5185
						$ssl     = 0;
5186
						$message = __( 'WordPress reports no SSL support', 'jetpack' );
5187
					} elseif ( 'OK' !== wp_remote_retrieve_body( $response ) ) {
5188
						$ssl     = 0;
5189
						$message = __( 'Response was not OK: ', 'jetpack' ) . wp_remote_retrieve_body( $response );
5190
					}
5191
				}
5192
			}
5193
			set_transient( 'jetpack_https_test', $ssl, DAY_IN_SECONDS );
5194
			set_transient( 'jetpack_https_test_message', $message, DAY_IN_SECONDS );
5195
		}
5196
5197
		return (bool) $ssl;
5198
	}
5199
5200
	/*
5201
	 * Displays an admin_notice, alerting the user that outbound SSL isn't working.
5202
	 */
5203
	public function alert_auto_ssl_fail() {
5204
		if ( ! current_user_can( 'manage_options' ) ) {
5205
			return;
5206
		}
5207
5208
		$ajax_nonce = wp_create_nonce( 'recheck-ssl' );
5209
		?>
5210
5211
		<div id="jetpack-ssl-warning" class="error jp-identity-crisis">
5212
			<div class="jp-banner__content">
5213
				<h2><?php _e( 'Outbound HTTPS not working', 'jetpack' ); ?></h2>
5214
				<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>
5215
				<p>
5216
					<?php _e( 'Jetpack will re-test for HTTPS support once a day, but you can click here to try again immediately: ', 'jetpack' ); ?>
5217
					<a href="#" id="jetpack-recheck-ssl-button"><?php _e( 'Try again', 'jetpack' ); ?></a>
5218
					<span id="jetpack-recheck-ssl-output"><?php echo get_transient( 'jetpack_https_test_message' ); ?></span>
5219
				</p>
5220
				<p>
5221
					<?php
5222
					printf(
5223
						__( 'For more help, try our <a href="%1$s">connection debugger</a> or <a href="%2$s" target="_blank">troubleshooting tips</a>.', 'jetpack' ),
5224
						esc_url( self::admin_url( array( 'page' => 'jetpack-debugger' ) ) ),
5225
						esc_url( Redirect::get_url( 'jetpack-support-getting-started-troubleshooting-tips' ) )
5226
					);
5227
					?>
5228
				</p>
5229
			</div>
5230
		</div>
5231
		<style>
5232
			#jetpack-recheck-ssl-output { margin-left: 5px; color: red; }
5233
		</style>
5234
		<script type="text/javascript">
5235
			jQuery( document ).ready( function( $ ) {
5236
				$( '#jetpack-recheck-ssl-button' ).click( function( e ) {
5237
					var $this = $( this );
5238
					$this.html( <?php echo json_encode( __( 'Checking', 'jetpack' ) ); ?> );
5239
					$( '#jetpack-recheck-ssl-output' ).html( '' );
5240
					e.preventDefault();
5241
					var data = { action: 'jetpack-recheck-ssl', 'ajax-nonce': '<?php echo $ajax_nonce; ?>' };
5242
					$.post( ajaxurl, data )
5243
					  .done( function( response ) {
5244
						  if ( response.enabled ) {
5245
							  $( '#jetpack-ssl-warning' ).hide();
5246
						  } else {
5247
							  this.html( <?php echo json_encode( __( 'Try again', 'jetpack' ) ); ?> );
5248
							  $( '#jetpack-recheck-ssl-output' ).html( 'SSL Failed: ' + response.message );
5249
						  }
5250
					  }.bind( $this ) );
5251
				} );
5252
			} );
5253
		</script>
5254
5255
		<?php
5256
	}
5257
5258
	/**
5259
	 * Returns the Jetpack XML-RPC API
5260
	 *
5261
	 * @deprecated 8.0 Use Connection_Manager instead.
5262
	 * @return string
5263
	 */
5264
	public static function xmlrpc_api_url() {
5265
		_deprecated_function( __METHOD__, 'jetpack-8.0', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_api_url()' );
5266
		return self::connection()->xmlrpc_api_url();
5267
	}
5268
5269
	/**
5270
	 * Returns the connection manager object.
5271
	 *
5272
	 * @return Automattic\Jetpack\Connection\Manager
5273
	 */
5274
	public static function connection() {
5275
		$jetpack = static::init();
5276
5277
		// If the connection manager hasn't been instantiated, do that now.
5278
		if ( ! $jetpack->connection_manager ) {
5279
			$jetpack->connection_manager = new Connection_Manager( 'jetpack' );
5280
		}
5281
5282
		return $jetpack->connection_manager;
5283
	}
5284
5285
	/**
5286
	 * Creates two secret tokens and the end of life timestamp for them.
5287
	 *
5288
	 * Note these tokens are unique per call, NOT static per site for connecting.
5289
	 *
5290
	 * @since 2.6
5291
	 * @param String  $action  The action name.
5292
	 * @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...
5293
	 * @param Integer $exp     Expiration time in seconds.
5294
	 * @return array
5295
	 */
5296
	public static function generate_secrets( $action, $user_id = false, $exp = 600 ) {
5297
		return self::connection()->generate_secrets( $action, $user_id, $exp );
5298
	}
5299
5300
	public static function get_secrets( $action, $user_id ) {
5301
		$secrets = self::connection()->get_secrets( $action, $user_id );
5302
5303
		if ( Connection_Manager::SECRETS_MISSING === $secrets ) {
5304
			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...
5305
		}
5306
5307
		if ( Connection_Manager::SECRETS_EXPIRED === $secrets ) {
5308
			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...
5309
		}
5310
5311
		return $secrets;
5312
	}
5313
5314
	/**
5315
	 * @deprecated 7.5 Use Connection_Manager instead.
5316
	 *
5317
	 * @param $action
5318
	 * @param $user_id
5319
	 */
5320
	public static function delete_secrets( $action, $user_id ) {
5321
		return self::connection()->delete_secrets( $action, $user_id );
5322
	}
5323
5324
	/**
5325
	 * Builds the timeout limit for queries talking with the wpcom servers.
5326
	 *
5327
	 * Based on local php max_execution_time in php.ini
5328
	 *
5329
	 * @since 2.6
5330
	 * @return int
5331
	 * @deprecated
5332
	 **/
5333
	public function get_remote_query_timeout_limit() {
5334
		_deprecated_function( __METHOD__, 'jetpack-5.4' );
5335
		return self::get_max_execution_time();
5336
	}
5337
5338
	/**
5339
	 * Builds the timeout limit for queries talking with the wpcom servers.
5340
	 *
5341
	 * Based on local php max_execution_time in php.ini
5342
	 *
5343
	 * @since 5.4
5344
	 * @return int
5345
	 **/
5346
	public static function get_max_execution_time() {
5347
		$timeout = (int) ini_get( 'max_execution_time' );
5348
5349
		// Ensure exec time set in php.ini
5350
		if ( ! $timeout ) {
5351
			$timeout = 30;
5352
		}
5353
		return $timeout;
5354
	}
5355
5356
	/**
5357
	 * Sets a minimum request timeout, and returns the current timeout
5358
	 *
5359
	 * @since 5.4
5360
	 **/
5361 View Code Duplication
	public static function set_min_time_limit( $min_timeout ) {
5362
		$timeout = self::get_max_execution_time();
5363
		if ( $timeout < $min_timeout ) {
5364
			$timeout = $min_timeout;
5365
			set_time_limit( $timeout );
5366
		}
5367
		return $timeout;
5368
	}
5369
5370
	/**
5371
	 * Takes the response from the Jetpack register new site endpoint and
5372
	 * verifies it worked properly.
5373
	 *
5374
	 * @since 2.6
5375
	 * @deprecated since 7.7.0
5376
	 * @see Automattic\Jetpack\Connection\Manager::validate_remote_register_response()
5377
	 **/
5378
	public function validate_remote_register_response() {
5379
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::validate_remote_register_response' );
5380
	}
5381
5382
	/**
5383
	 * @return bool|WP_Error
5384
	 */
5385
	public static function register() {
5386
		$tracking = new Tracking();
5387
		$tracking->record_user_event( 'jpc_register_begin' );
5388
5389
		add_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5390
5391
		$connection   = self::connection();
5392
		$registration = $connection->register();
5393
5394
		remove_filter( 'jetpack_register_request_body', array( __CLASS__, 'filter_register_request_body' ) );
5395
5396
		if ( ! $registration || is_wp_error( $registration ) ) {
5397
			return $registration;
5398
		}
5399
5400
		return true;
5401
	}
5402
5403
	/**
5404
	 * Filters the registration request body to include tracking properties.
5405
	 *
5406
	 * @param array $properties
5407
	 * @return array amended properties.
5408
	 */
5409 View Code Duplication
	public static function filter_register_request_body( $properties ) {
5410
		$tracking        = new Tracking();
5411
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5412
5413
		return array_merge(
5414
			$properties,
5415
			array(
5416
				'_ui' => $tracks_identity['_ui'],
5417
				'_ut' => $tracks_identity['_ut'],
5418
			)
5419
		);
5420
	}
5421
5422
	/**
5423
	 * Filters the token request body to include tracking properties.
5424
	 *
5425
	 * @param array $properties
5426
	 * @return array amended properties.
5427
	 */
5428 View Code Duplication
	public static function filter_token_request_body( $properties ) {
5429
		$tracking        = new Tracking();
5430
		$tracks_identity = $tracking->tracks_get_identity( get_current_user_id() );
5431
5432
		return array_merge(
5433
			$properties,
5434
			array(
5435
				'_ui' => $tracks_identity['_ui'],
5436
				'_ut' => $tracks_identity['_ut'],
5437
			)
5438
		);
5439
	}
5440
5441
	/**
5442
	 * If the db version is showing something other that what we've got now, bump it to current.
5443
	 *
5444
	 * @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...
5445
	 */
5446
	public static function maybe_set_version_option() {
5447
		list( $version ) = explode( ':', Jetpack_Options::get_option( 'version' ) );
5448
		if ( JETPACK__VERSION != $version ) {
5449
			Jetpack_Options::update_option( 'version', JETPACK__VERSION . ':' . time() );
5450
5451
			if ( version_compare( JETPACK__VERSION, $version, '>' ) ) {
5452
				/** This action is documented in class.jetpack.php */
5453
				do_action( 'updating_jetpack_version', JETPACK__VERSION, $version );
5454
			}
5455
5456
			return true;
5457
		}
5458
		return false;
5459
	}
5460
5461
	/* Client Server API */
5462
5463
	/**
5464
	 * Loads the Jetpack XML-RPC client.
5465
	 * No longer necessary, as the XML-RPC client will be automagically loaded.
5466
	 *
5467
	 * @deprecated since 7.7.0
5468
	 */
5469
	public static function load_xml_rpc_client() {
5470
		_deprecated_function( __METHOD__, 'jetpack-7.7' );
5471
	}
5472
5473
	/**
5474
	 * Resets the saved authentication state in between testing requests.
5475
	 *
5476
	 * @deprecated since 8.9.0
5477
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::reset_saved_auth_state()
5478
	 */
5479
	public function reset_saved_auth_state() {
5480
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::reset_saved_auth_state' );
5481
		Connection_Rest_Authentication::init()->reset_saved_auth_state();
5482
	}
5483
5484
	/**
5485
	 * Verifies the signature of the current request.
5486
	 *
5487
	 * @deprecated since 7.7.0
5488
	 * @see Automattic\Jetpack\Connection\Manager::verify_xml_rpc_signature()
5489
	 *
5490
	 * @return false|array
5491
	 */
5492
	public function verify_xml_rpc_signature() {
5493
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::verify_xml_rpc_signature' );
5494
		return self::connection()->verify_xml_rpc_signature();
5495
	}
5496
5497
	/**
5498
	 * Verifies the signature of the current request.
5499
	 *
5500
	 * This function has side effects and should not be used. Instead,
5501
	 * use the memoized version `->verify_xml_rpc_signature()`.
5502
	 *
5503
	 * @deprecated since 7.7.0
5504
	 * @see Automattic\Jetpack\Connection\Manager::internal_verify_xml_rpc_signature()
5505
	 * @internal
5506
	 */
5507
	private function internal_verify_xml_rpc_signature() {
5508
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::internal_verify_xml_rpc_signature' );
5509
	}
5510
5511
	/**
5512
	 * Authenticates XML-RPC and other requests from the Jetpack Server.
5513
	 *
5514
	 * @deprecated since 7.7.0
5515
	 * @see Automattic\Jetpack\Connection\Manager::authenticate_jetpack()
5516
	 *
5517
	 * @param \WP_User|mixed $user     User object if authenticated.
5518
	 * @param string         $username Username.
5519
	 * @param string         $password Password string.
5520
	 * @return \WP_User|mixed Authenticated user or error.
5521
	 */
5522 View Code Duplication
	public function authenticate_jetpack( $user, $username, $password ) {
5523
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::authenticate_jetpack' );
5524
5525
		if ( ! $this->connection_manager ) {
5526
			$this->connection_manager = new Connection_Manager();
5527
		}
5528
5529
		return $this->connection_manager->authenticate_jetpack( $user, $username, $password );
5530
	}
5531
5532
	/**
5533
	 * Authenticates requests from Jetpack server to WP REST API endpoints.
5534
	 * Uses the existing XMLRPC request signing implementation.
5535
	 *
5536
	 * @deprecated since 8.9.0
5537
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authenticate()
5538
	 */
5539
	function wp_rest_authenticate( $user ) {
5540
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenticate' );
5541
		return Connection_Rest_Authentication::init()->wp_rest_authenticate( $user );
5542
	}
5543
5544
	/**
5545
	 * Report authentication status to the WP REST API.
5546
	 *
5547
	 * @deprecated since 8.9.0
5548
	 * @see Automattic\Jetpack\Connection\Rest_Authentication::wp_rest_authentication_errors()
5549
	 *
5550
	 * @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...
5551
	 * @return WP_Error|boolean|null {@see WP_JSON_Server::check_authentication}
5552
	 */
5553
	public function wp_rest_authentication_errors( $value ) {
5554
		_deprecated_function( __METHOD__, 'jetpack-8.9', 'Automattic\\Jetpack\\Connection\\Rest_Authentication::wp_rest_authenication_errors' );
5555
		return Connection_Rest_Authentication::init()->wp_rest_authentication_errors( $value );
5556
	}
5557
5558
	/**
5559
	 * In some setups, $HTTP_RAW_POST_DATA can be emptied during some IXR_Server paths since it is passed by reference to various methods.
5560
	 * Capture it here so we can verify the signature later.
5561
	 *
5562
	 * @deprecated since 7.7.0
5563
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_methods()
5564
	 *
5565
	 * @param array $methods XMLRPC methods.
5566
	 * @return array XMLRPC methods, with the $HTTP_RAW_POST_DATA one.
5567
	 */
5568 View Code Duplication
	public function xmlrpc_methods( $methods ) {
5569
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_methods' );
5570
5571
		if ( ! $this->connection_manager ) {
5572
			$this->connection_manager = new Connection_Manager();
5573
		}
5574
5575
		return $this->connection_manager->xmlrpc_methods( $methods );
5576
	}
5577
5578
	/**
5579
	 * Register additional public XMLRPC methods.
5580
	 *
5581
	 * @deprecated since 7.7.0
5582
	 * @see Automattic\Jetpack\Connection\Manager::public_xmlrpc_methods()
5583
	 *
5584
	 * @param array $methods Public XMLRPC methods.
5585
	 * @return array Public XMLRPC methods, with the getOptions one.
5586
	 */
5587 View Code Duplication
	public function public_xmlrpc_methods( $methods ) {
5588
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::public_xmlrpc_methods' );
5589
5590
		if ( ! $this->connection_manager ) {
5591
			$this->connection_manager = new Connection_Manager();
5592
		}
5593
5594
		return $this->connection_manager->public_xmlrpc_methods( $methods );
5595
	}
5596
5597
	/**
5598
	 * Handles a getOptions XMLRPC method call.
5599
	 *
5600
	 * @deprecated since 7.7.0
5601
	 * @see Automattic\Jetpack\Connection\Manager::jetpack_getOptions()
5602
	 *
5603
	 * @param array $args method call arguments.
5604
	 * @return array an amended XMLRPC server options array.
5605
	 */
5606 View Code Duplication
	public function jetpack_getOptions( $args ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid
5607
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::jetpack_getOptions' );
5608
5609
		if ( ! $this->connection_manager ) {
5610
			$this->connection_manager = new Connection_Manager();
5611
		}
5612
5613
		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...
5614
	}
5615
5616
	/**
5617
	 * Adds Jetpack-specific options to the output of the XMLRPC options method.
5618
	 *
5619
	 * @deprecated since 7.7.0
5620
	 * @see Automattic\Jetpack\Connection\Manager::xmlrpc_options()
5621
	 *
5622
	 * @param array $options Standard Core options.
5623
	 * @return array Amended options.
5624
	 */
5625 View Code Duplication
	public function xmlrpc_options( $options ) {
5626
		_deprecated_function( __METHOD__, 'jetpack-7.7', 'Automattic\\Jetpack\\Connection\\Manager::xmlrpc_options' );
5627
5628
		if ( ! $this->connection_manager ) {
5629
			$this->connection_manager = new Connection_Manager();
5630
		}
5631
5632
		return $this->connection_manager->xmlrpc_options( $options );
5633
	}
5634
5635
	/**
5636
	 * State is passed via cookies from one request to the next, but never to subsequent requests.
5637
	 * SET: state( $key, $value );
5638
	 * GET: $value = state( $key );
5639
	 *
5640
	 * @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...
5641
	 * @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...
5642
	 * @param bool   $restate private
5643
	 */
5644
	public static function state( $key = null, $value = null, $restate = false ) {
5645
		static $state = array();
5646
		static $path, $domain;
5647
		if ( ! isset( $path ) ) {
5648
			require_once ABSPATH . 'wp-admin/includes/plugin.php';
5649
			$admin_url = self::admin_url();
5650
			$bits      = wp_parse_url( $admin_url );
5651
5652
			if ( is_array( $bits ) ) {
5653
				$path   = ( isset( $bits['path'] ) ) ? dirname( $bits['path'] ) : null;
5654
				$domain = ( isset( $bits['host'] ) ) ? $bits['host'] : null;
5655
			} else {
5656
				$path = $domain = null;
5657
			}
5658
		}
5659
5660
		// Extract state from cookies and delete cookies
5661
		if ( isset( $_COOKIE['jetpackState'] ) && is_array( $_COOKIE['jetpackState'] ) ) {
5662
			$yum = wp_unslash( $_COOKIE['jetpackState'] );
5663
			unset( $_COOKIE['jetpackState'] );
5664
			foreach ( $yum as $k => $v ) {
0 ignored issues
show
Bug introduced by
The expression $yum of type string|array<integer,string> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

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